Class StakingContract

Hierarchy

Model<StakingContractMethods>
- StakingContract

Implements

Constructors

constructor

new StakingContract(web3Connection: Web3Connection | Web3ConnectionOptions, contractAddress?: string, stakeTokenAddress?: string, collectiblesAddress?: string): StakingContract

Overrides Model.constructor
- Defined in src/models/staking-contract.ts:20
Parameters
- web3Connection: Web3Connection | Web3ConnectionOptions
- Optional contractAddress: string
- Optional stakeTokenAddress: string
- Optional collectiblesAddress: string
Returns StakingContract

Properties

Protected _contract

_contract: Web3Contract<StakingContractMethods, any>

Private _erc20

_erc20: ERC20

Private _erc721

_erc721: ERC721Collectibles

Private _ownable

_ownable: Ownable

Private _pausable

_pausable: Pausable

Readonly abi

abi: AbiItem[]

Optional Readonly collectiblesAddress

collectiblesAddress?: string

Optional Readonly contractAddress

contractAddress?: string

Optional Readonly stakeTokenAddress

stakeTokenAddress?: 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>

erc20

get erc20(): ERC20

- Defined in src/models/staking-contract.ts:34
Returns ERC20

erc721

get erc721(): ERC721Collectibles

- Defined in src/models/staking-contract.ts:35
Returns ERC721Collectibles

ownable

get ownable(): Ownable

Implementation of IsOwnable.ownable
- Defined in src/models/staking-contract.ts:33
Returns Ownable

pausable

get pausable(): Pausable

Implementation of IsPausable.pausable
- Defined in src/models/staking-contract.ts:32
Returns Pausable

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

approveERC20Transfer

approveERC20Transfer(): Promise<TransactionReceipt<any>>

- Defined in src/models/staking-contract.ts:157
Returns Promise<TransactionReceipt<any>>

availableTokens

availableTokens(): Promise<string>

- Defined in src/models/staking-contract.ts:89
Returns Promise<string>

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>

createProduct

createProduct(_startDate: number, _endDate: number, _totalMaxAmount: string | number, _individualMinimumAmount: string | number, _individualMaximumAmount: string | number, _APR: number, _lockedUntilFinalization: boolean): Promise<TransactionReceipt<any>>

- Defined in src/models/staking-contract.ts:105
Parameters
- _startDate: number
- _endDate: number
- _totalMaxAmount: string | number
- _individualMinimumAmount: string | number
- _individualMaximumAmount: string | number
- _APR: number
- _lockedUntilFinalization: boolean
Returns Promise<TransactionReceipt<any>>

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(stakeTokenAddress: string, collectiblesAddress?: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/staking-contract.ts:64
Parameters
- stakeTokenAddress: string
- collectiblesAddress: string = nativeZeroAddress
Returns Promise<TransactionReceipt<any>>

depositAPRTokens

depositAPRTokens(amount: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/staking-contract.ts:161
Parameters
- amount: string | number
Returns Promise<TransactionReceipt<any>>

erc20Address

erc20Address(): Promise<string>

- Defined in src/models/staking-contract.ts:73
Returns Promise<string>

futureLockedTokens

futureLockedTokens(): Promise<string>

- Defined in src/models/staking-contract.ts:85
Returns Promise<string>

getAPRAmount

getAPRAmount(_APR: number, _startDate: number, _endDate: number, _amount: string | number): Promise<string>

- Defined in src/models/staking-contract.ts:126
Parameters
- _APR: number
- _startDate: number
- _endDate: number
- _amount: string | number
Returns Promise<string>

getAllProducts

getAllProducts(): Promise<StakingProduct[]>

- Defined in src/models/staking-contract.ts:165
Returns Promise<StakingProduct[]>

getAllSubscriptions

getAllSubscriptions(): Promise<StakingSubscription[]>

- Defined in src/models/staking-contract.ts:184
Returns Promise<StakingSubscription[]>

getMySubscriptions

getMySubscriptions(_address: string): Promise<string[]>

- Defined in src/models/staking-contract.ts:139
Parameters
- _address: string
Returns Promise<string[]>

getProduct

getProduct(_product_id: number): Promise<StakingProduct>

- Defined in src/models/staking-contract.ts:152
Parameters
- _product_id: number
Returns Promise<StakingProduct>

getProductIds

getProductIds(): Promise<number[]>

- Defined in src/models/staking-contract.ts:135
Returns Promise<number[]>

getSubscription

getSubscription(_subscription_id: number, _product_id: number): Promise<StakingSubscription>

- Defined in src/models/staking-contract.ts:148
Parameters
- _subscription_id: number
- _product_id: number
Returns Promise<StakingSubscription>

getTokenAmount

getTokenAmount(address: string): Promise<string>

- Defined in src/models/staking-contract.ts:77
Parameters
- address: string
Returns Promise<string>

getTotalProductsAPRAmount

getTotalProductsAPRAmount(): Promise<string>

- Defined in src/models/staking-contract.ts:175
Returns Promise<string>

heldTokens

heldTokens(): Promise<string>

- Defined in src/models/staking-contract.ts:81
Returns Promise<string>

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/staking-contract.ts:38
Preferred way of initializing and loading a contract

Returns Promise<void>

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/staking-contract.ts:59
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

subscribeProduct

subscribeProduct(_product_id: number, _amount: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/staking-contract.ts:93
Parameters
- _product_id: number
- _amount: string | number
Returns Promise<TransactionReceipt<any>>

withdrawSubscription

withdrawSubscription(_product_id: number, _subscription_id: number): Promise<TransactionReceipt<any>>

- Defined in src/models/staking-contract.ts:144
Parameters
- _product_id: number
- _subscription_id: number
Returns Promise<TransactionReceipt<any>>

Generated using TypeDoc