Class ERC20

Hierarchy

Model<ERC20Methods>
- ERC20

Implements

Deployable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ERC20(web3Connection: Web3Connection | Web3ConnectionOptions, contractAddress?: string): ERC20

Overrides Model.constructor
- Defined in src/models/erc20.ts:12
Parameters
- web3Connection: Web3Connection | Web3ConnectionOptions
- Optional contractAddress: string
Returns ERC20

Properties

Protected _contract

_contract: Web3Contract<ERC20Methods, any>

Private _decimals

_decimals: number = 0

Private _ownable

_ownable: Ownable

Readonly abi

abi: AbiItem[]

Optional Readonly contractAddress

contractAddress?: string

Accessors

account

get account(): Account

Inherited from Model.account
- Defined in src/base/model.ts:48
Returns the Account associated with this connection

Returns Account

Protected connection

get connection(): Web3Connection

Inherited from Model.connection
- Defined in src/base/model.ts:38
Pointer to the Web3Connection assigned to this contract class

Returns Web3Connection

contract

get contract(): Web3Contract<Methods, any>

Inherited from Model.contract
- Defined in src/base/model.ts:21
Returns the Web3Contract class representing this contract

Returns Web3Contract<Methods, any>

decimals

get decimals(): number

- Defined in src/models/erc20.ts:19
Returns number

ownable

get ownable(): Ownable

- Defined in src/models/erc20.ts:20
Returns Ownable

web3

get web3(): default

Inherited from Model.web3
- Defined in src/base/model.ts:43
Returns the Web3 class assigned to this connection

Returns default

Methods

allowance

allowance(owner: string, spender: string): Promise<string>

- Defined in src/models/erc20.ts:67
Parameters
- owner: string
- spender: string
Returns Promise<string>

approve

approve(address: string, amount: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc20.ts:75
Parameters
- address: string
- amount: string | number
Returns Promise<TransactionReceipt<any>>

callTx

callTx<ReturnData>(method: ContractCallMethod<ReturnData>): Promise<ReturnData>

Inherited from Model.callTx
- Defined in src/base/model.ts:93
Return a property value from the contract

Type Parameters
- ReturnData = any
Parameters
- method: ContractCallMethod<ReturnData>
Returns Promise<ReturnData>

connect

connect(): Promise<boolean>

Inherited from Model.connect
- Defined in src/base/model.ts:72
Alias for Web3Connection.connect(); Will load contract if success

Returns Promise<boolean>

Protected deploy

deploy(deployOptions: DeployOptions, account?: Account): Promise<TransactionReceipt<any>>

Inherited from Model.deploy
- Defined in src/base/model.ts:147
Deploy the loaded abi contract

Parameters
- deployOptions: DeployOptions
- Optional account: Account
Returns Promise<TransactionReceipt<any>>

deployJsonAbi

deployJsonAbi(name: string, symbol: string, cap: string | number, distributionAddress: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/erc20.ts:81
Parameters
- name: string
- symbol: string
- cap: string | number
- distributionAddress: string
Returns Promise<TransactionReceipt<any>>

getTokenAmount

getTokenAmount(address: string): Promise<string>

- Defined in src/models/erc20.ts:48
Parameters
- address: string
Returns Promise<string>

increaseAllowance

increaseAllowance(address: string, amount: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc20.ts:62
Parameters
- address: string
- amount: string | number
Returns Promise<TransactionReceipt<any>>

isApproved

isApproved(spenderAddress?: string, amount: string | number): Promise<boolean>

- Defined in src/models/erc20.ts:71
Parameters
- spenderAddress: string = ...
- amount: string | number
Returns Promise<boolean>

loadAbi

loadAbi(): void

Inherited from Model.loadAbi
- Defined in src/base/model.ts:53
Permissive way of initializing the contract, used primarily for deploys. Prefer to use loadContract

Returns void

loadContract

loadContract(): Promise<void>

Overrides Model.loadContract
- Defined in src/models/erc20.ts:27
Preferred way of initializing and loading a contract

Returns Promise<void>

mint

mint(receiver: string, amount: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc20.ts:93
Parameters
- receiver: string
- amount: number
Returns Promise<TransactionReceipt<any>>

name

name(): Promise<string>

- Defined in src/models/erc20.ts:36
Returns Promise<string>

sendTx

sendTx(method: ContractSendMethod, value?: any): Promise<TransactionReceipt<any>>

Inherited from Model.sendTx
- Defined in src/base/model.ts:100
Interact with, or change a value of, a property on the contract

Parameters
- method: ContractSendMethod
- Optional value: any
Returns Promise<TransactionReceipt<any>>

sendUnsignedTx

sendUnsignedTx(method: ContractSendMethod, value?: any, __namedParameters?: Partial<Web3ConnectionOptions>): Promise<TransactionReceipt<any>>

Inherited from Model.sendUnsignedTx
- Defined in src/base/model.ts:118
Send unsigned transaction

Parameters
- method: ContractSendMethod
- Optional value: any
- __namedParameters: Partial<Web3ConnectionOptions> = {}
Returns Promise<TransactionReceipt<any>>

start

start(): Promise<void>

Overrides Model.start
- Defined in src/models/erc20.ts:22
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

symbol

symbol(): Promise<string>

- Defined in src/models/erc20.ts:40
Returns Promise<string>

totalSupply

totalSupply(): Promise<string>

- Defined in src/models/erc20.ts:44
Returns Promise<string>

transferFrom

transferFrom(owner: string, receiver: string, amount: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc20.ts:57
Parameters
- owner: string
- receiver: string
- amount: string | number
Returns Promise<TransactionReceipt<any>>

transferTokenAmount

transferTokenAmount(toAddress: string, amount: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc20.ts:52
Parameters
- toAddress: string
- amount: string | number
Returns Promise<TransactionReceipt<any>>

Generated using TypeDoc