status-im
/
nim-ethers
mirror of https://github.com/status-im/nim-ethers.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Formatting

This commit is contained in:
Mark Spanbroek 2023-07-04 15:44:07 +02:00 committed by markspanbroek
parent 842bf4d0a2
commit d7b7f67afb
1 changed files with 33 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
ethers/erc20.nim
View File

@ -17,36 +17,46 @@ type
spender* {.indexed.}: Address spender* {.indexed.}: Address
value*: UInt256 value*: UInt256
method name*(erc20: Erc20Token): string {.base, contract, view.} method name*(token: Erc20Token): string {.base, contract, view.}
## Returns the name of the token. ## Returns the name of the token.
method symbol*(token: Erc20Token): string {.base, contract, view.} method symbol*(token: Erc20Token): string {.base, contract, view.}
## Returns the symbol of the token, usually a shorter version of the name. ## Returns the symbol of the token, usually a shorter version of the name.
method decimals*(token: Erc20Token): uint8 {.base, contract, view.} method decimals*(token: Erc20Token): uint8 {.base, contract, view.}
## Returns the number of decimals used to get its user representation. ## Returns the number of decimals used to get its user representation.
## For example, if `decimals` equals `2`, a balance of `505` tokens should ## For example, if `decimals` equals `2`, a balance of `505` tokens should
## be displayed to a user as `5.05` (`505 / 10 ** 2`). ## be displayed to a user as `5.05` (`505 / 10 ** 2`).
method totalSupply*(erc20: Erc20Token): UInt256 {.base, contract, view.} method totalSupply*(token: Erc20Token): UInt256 {.base, contract, view.}
## Returns the amount of tokens in existence. ## Returns the amount of tokens in existence.
method balanceOf*(erc20: Erc20Token, account: Address): UInt256 {.base, contract, view.} method balanceOf*(token: Erc20Token,
## Returns the amount of tokens owned by `account`. account: Address): UInt256 {.base, contract, view.}
## Returns the amount of tokens owned by `account`.
method allowance*(erc20: Erc20Token, owner, spender: Address): UInt256 {.base, contract, view.} method allowance*(token: Erc20Token,
## Returns the remaining number of tokens that `spender` will be allowed owner: Address,
## to spend on behalf of `owner` through {transferFrom}. This is zero by default. spender: Address): UInt256 {.base, contract, view.}
## ## Returns the remaining number of tokens that `spender` will be allowed
## This value changes when {approve} or {transferFrom} are called. ## to spend on behalf of `owner` through {transferFrom}. This is zero by
## default.
##
## This value changes when {approve} or {transferFrom} are called.
method transfer*(erc20: Erc20Token, recipient: Address, amount: UInt256) {.base, contract.} method transfer*(token: Erc20Token,
## Moves `amount` tokens from the caller's account to `recipient`. recipient: Address,
amount: UInt256) {.base, contract.}
## Moves `amount` tokens from the caller's account to `recipient`.
method approve*(token: Erc20Token, spender: Address, amount: UInt256) {.base, contract.} method approve*(token: Erc20Token,
## Sets `amount` as the allowance of `spender` over the caller's tokens. spender: Address,
amount: UInt256) {.base, contract.}
method transferFrom*(erc20: Erc20Token, spender: Address, recipient: Address, amount: UInt256) {.base, contract.} ## Sets `amount` as the allowance of `spender` over the caller's tokens.
## Moves `amount` tokens from `from` to `to` using the allowance
## mechanism. `amount` is then deducted from the caller's allowance.
method transferFrom*(token: Erc20Token,
spender: Address,
recipient: Address,
amount: UInt256) {.base, contract.}
## Moves `amount` tokens from `from` to `to` using the allowance
## mechanism. `amount` is then deducted from the caller's allowance.