Skip to content

SPK Token

Overview

SPK is the governance token of Spark. You can read more about the token here.

Supported Networks and Token Addresses

NetworkTokenAddress
EthereumSPK0xc20059e0317DE91738d13af027DfC4a50781b066

Contract Details

Variables

  • name: Spark
  • symbol: SPK
  • version: 1
  • decimals: 18
  • totalSupply: An unsigned integer representing the total supply of the token. It keeps track of the total number of tokens in circulation.
  • balanceOf: A mapping that associates an address with its corresponding token balance. It allows for looking up the balance of a specific address.
  • allowance: A nested mapping that associates an owner address with a spender address and their approved token allowance. It allows an owner to specify how many tokens a specific spender is allowed to transfer on their behalf.
  • nonces: A mapping that associates an address with its corresponding permit nonce. It is used for the EIP712 permit functionality, allowing an address to sign permit messages with a unique nonce.

ERC20 token functionality

The contract implements the functions specified in the ERC-20 interface.

  • transfer: Transfers a specified amount of tokens from the caller's address to the specified recipient's address. It returns a boolean value indicating the success of the transfer.
  • transferFrom: Transfers a specified amount of tokens from the from address to the to address. The transfer must be allowed by the from address by calling the approve function or by setting an allowance. It returns a boolean value indicating the success of the transfer.
  • approve: Sets an allowance for a specific spender to spend a certain amount of tokens on behalf of the caller. It returns a boolean value indicating the success of the approval.
  • increaseAllowance: Increases the allowance granted to a specific spender by adding the addedValue to the current allowance. It returns a boolean value indicating the success of the operation.
  • decreaseAllowance: Decreases the allowance granted to a specific spender by subtracting the subtractedValue from the current allowance. It returns a boolean value indicating the success of the operation.
  • permit: This function allows the owner to approve a permit for the spender to spend a specific amount of tokens on their behalf, using a signature for authorization.

Upgradeability

The contract is not upgradeable.

Events emitted

  • Approval: This event is emitted when an approval is set for a specific address. It indicates that the owner has approved the spender to spend a certain amount of tokens.
  • Deposit: This event is emitted when a deposit is made into the Savings USDC contract. It indicates the sender, the owner of the deposited assets, the amount of assets deposited, and the corresponding shares minted.
  • Transfer: This event is emitted when tokens are transferred from one address to another. It indicates the amount of tokens transferred and the addresses involved in the transfer.
  • Withdraw: This event is emitted when a withdrawal is made from the Savings USDC contract. It indicates the sender, the receiver of the withdrawn assets, the owner of the withdrawn shares, the amount of assets withdrawn, and the corresponding shares burned.

Additional resources