Class: ReadErc20
A base class for read-only models.
Hierarchy
-
↳
ReadErc20
Implements
Constructors
constructor
• new ReadErc20(«destructured»
): ReadErc20
Parameters
Name | Type |
---|---|
«destructured» | ReadErc20Options |
Returns
Overrides
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:11
Properties
contract
• contract: CachedReadContract
<readonly [{ inputs
: readonly [{ internalType
: "address"
; name
: "owner"
; type
: "address"
}, { internalType
: "address"
; name
: "spender"
; type
: "address"
}] ; name
: "allowance"
; outputs
: readonly [{ internalType
: "uint256"
; name
: ""
; type
: "uint256"
}] ; stateMutability
: "view"
; type
: "function"
}, { inputs
: readonly [{ internalType
: "address"
; name
: "spender"
; type
: "address"
}, { internalType
: "uint256"
; name
: "amount"
; type
: "uint256"
}] ; name
: "approve"
; outputs
: readonly [{ internalType
: "bool"
; name
: ""
; type
: "bool"
}] ; stateMutability
: "nonpayable"
; type
: "function"
}, { inputs
: readonly [{ internalType
: "address"
; name
: "account"
; type
: "address"
}] ; name
: "balanceOf"
; outputs
: readonly [{ internalType
: "uint256"
; name
: ""
; type
: "uint256"
}] ; stateMutability
: "view"
; type
: "function"
}, { inputs
: readonly [] ; name
: "decimals"
; outputs
: readonly [{ internalType
: "uint8"
; name
: ""
; type
: "uint8"
}] ; stateMutability
: "view"
; type
: "function"
}, { inputs
: readonly [] ; name
: "name"
; outputs
: readonly [{ internalType
: "string"
; name
: ""
; type
: "string"
}] ; stateMutability
: "view"
; type
: "function"
}, { inputs
: readonly [] ; name
: "symbol"
; outputs
: readonly [{ internalType
: "string"
; name
: ""
; type
: "string"
}] ; stateMutability
: "view"
; type
: "function"
}, { inputs
: readonly [] ; name
: "totalSupply"
; outputs
: readonly [{ internalType
: "uint256"
; name
: ""
; type
: "uint256"
}] ; stateMutability
: "view"
; type
: "function"
}, { inputs
: readonly [{ internalType
: "address"
; name
: "to"
; type
: "address"
}, { internalType
: "uint256"
; name
: "amount"
; type
: "uint256"
}] ; name
: "transfer"
; outputs
: readonly [{ internalType
: "bool"
; name
: ""
; type
: "bool"
}] ; stateMutability
: "nonpayable"
; type
: "function"
}, { inputs
: readonly [{ internalType
: "address"
; name
: "from"
; type
: "address"
}, { internalType
: "address"
; name
: "to"
; type
: "address"
}, { internalType
: "uint256"
; name
: "amount"
; type
: "uint256"
}] ; name
: "transferFrom"
; outputs
: readonly [{ internalType
: "bool"
; name
: ""
; type
: "bool"
}] ; stateMutability
: "nonpayable"
; type
: "function"
}, { anonymous
: false
; inputs
: readonly [{ indexed
: true
; internalType
: "address"
; name
: "owner"
; type
: "address"
}, { indexed
: true
; internalType
: "address"
; name
: "spender"
; type
: "address"
}, { indexed
: false
; internalType
: "uint256"
; name
: "value"
; type
: "uint256"
}] ; name
: "Approval"
; type
: "event"
}, { anonymous
: false
; inputs
: readonly [{ indexed
: true
; internalType
: "address"
; name
: "from"
; type
: "address"
}, { indexed
: true
; internalType
: "address"
; name
: "to"
; type
: "address"
}, { indexed
: false
; internalType
: "uint256"
; name
: "value"
; type
: "uint256"
}] ; name
: "Transfer"
; type
: "event"
}]>
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:9
contractFactory
• contractFactory: ReadContractFactory
Implementation of
Inherited from
Defined in
packages/hyperdrive-js-core/src/model/ReadModel.ts:29
name
• name: string
Implementation of
Inherited from
Defined in
packages/hyperdrive-js-core/src/model/ReadModel.ts:27
network
• network: Network
Implementation of
Inherited from
Defined in
packages/hyperdrive-js-core/src/model/ReadModel.ts:28
Accessors
address
• get
address(): `0x${string}`
Returns
`0x${string}`
Implementation of
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:28
namespace
• get
namespace(): undefined
| string
Returns
undefined
| string
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:31
Methods
getAllowance
▸ getAllowance(«destructured»
): Promise
<bigint
>
Get the spending allowance of a given spender for a given owner of this token.
Parameters
Name | Type |
---|---|
«destructured» | Object |
› options? | ContractReadOptions |
› owner | `0x${string}` |
› spender | `0x${string}` |
Returns
Promise
<bigint
>
Implementation of
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:47
getBalanceOf
▸ getBalanceOf(«destructured»
): Promise
<bigint
>
Get the token balance of a given address
Parameters
Name | Type |
---|---|
«destructured» | Object |
› account | `0x${string}` |
› options? | ContractReadOptions |
Returns
Promise
<bigint
>
Implementation of
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:59
getDecimals
▸ getDecimals(): Promise
<number
>
Get the number of decimal places this token uses.
Returns
Promise
<number
>
Implementation of
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:43
getName
▸ getName(): Promise
<string
>
Get the name of this token
Returns
Promise
<string
>
Implementation of
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:35
getSymbol
▸ getSymbol(): Promise
<string
>
Get the symbol for this token.
Returns
Promise
<string
>
Implementation of
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:39
getTotalSupply
▸ getTotalSupply(options?
): Promise
<bigint
>
Get the total supply of the token.
Parameters
Name | Type |
---|---|
options? | ContractReadOptions |
Returns
Promise
<bigint
>
Defined in
packages/hyperdrive-js-core/src/token/erc20/ReadErc20.ts:72