- ContractKit
- addAccount
- fillGasPrice
- getEpochNumberOfBlock
- getEpochSize
- getFirstBlockNumberForEpoch
- getHumanReadableNetworkConfig
- getLastBlockNumberForEpoch
- getNetworkConfig
- getTotalBalance
- getWallet
- isListening
- isSyncing
- sendTransaction
- sendTransactionObject
- setFeeCurrency
- signTypedData
- stop
- updateGasPriceInConnectionLayer
+ new ContractKit(connection
: Connection): ContractKit
Defined in contractkit/src/kit.ts:86
Parameters:
Name | Type |
---|---|
connection |
Connection |
Returns: ContractKit
• _web3Contracts: Web3ContractCache
Defined in contractkit/src/kit.ts:81
factory for core contract's native web3 wrappers
• connection: Connection
Defined in contractkit/src/kit.ts:88
• contracts: WrapperCache
Defined in contractkit/src/kit.ts:83
factory for core contract's kit wrappers
• gasPriceSuggestionMultiplier: number = 5
Defined in contractkit/src/kit.ts:86
• registry: AddressRegistry
Defined in contractkit/src/kit.ts:79
core contract's address registry
• get defaultAccount(): Address | undefined
Defined in contractkit/src/kit.ts:290
Returns: Address | undefined
• set defaultAccount(address
: Address | undefined): void
Defined in contractkit/src/kit.ts:286
Parameters:
Name | Type |
---|---|
address |
Address | undefined |
Returns: void
• get defaultFeeCurrency(): undefined | string
Defined in contractkit/src/kit.ts:314
Returns: undefined | string
• set defaultFeeCurrency(address
: Address | undefined): void
Defined in contractkit/src/kit.ts:310
Parameters:
Name | Type |
---|---|
address |
Address | undefined |
Returns: void
• get gasInflationFactor(): number
Defined in contractkit/src/kit.ts:298
Returns: number
• set gasInflationFactor(factor
: number): void
Defined in contractkit/src/kit.ts:294
Parameters:
Name | Type |
---|---|
factor |
number |
Returns: void
• get gasPrice(): number
Defined in contractkit/src/kit.ts:306
Returns: number
• set gasPrice(price
: number): void
Defined in contractkit/src/kit.ts:302
Parameters:
Name | Type |
---|---|
price |
number |
Returns: void
• get web3(): Web3‹›
Defined in contractkit/src/kit.ts:352
Returns: Web3‹›
▸ addAccount(privateKey
: string): void
Defined in contractkit/src/kit.ts:282
Parameters:
Name | Type |
---|---|
privateKey |
string |
Returns: void
▸ fillGasPrice(tx
: CeloTx): Promise‹CeloTx›
Defined in contractkit/src/kit.ts:326
Parameters:
Name | Type |
---|---|
tx |
CeloTx |
Returns: Promise‹CeloTx›
▸ getEpochNumberOfBlock(blockNumber
: number): Promise‹number›
Defined in contractkit/src/kit.ts:267
Parameters:
Name | Type |
---|---|
blockNumber |
number |
Returns: Promise‹number›
▸ getEpochSize(): Promise‹number›
Defined in contractkit/src/kit.ts:240
Returns: Promise‹number›
▸ getFirstBlockNumberForEpoch(epochNumber
: number): Promise‹number›
Defined in contractkit/src/kit.ts:247
Parameters:
Name | Type |
---|---|
epochNumber |
number |
Returns: Promise‹number›
▸ getHumanReadableNetworkConfig(): Promise‹object›
Defined in contractkit/src/kit.ts:171
Returns: Promise‹object›
▸ getLastBlockNumberForEpoch(epochNumber
: number): Promise‹number›
Defined in contractkit/src/kit.ts:257
Parameters:
Name | Type |
---|---|
epochNumber |
number |
Returns: Promise‹number›
▸ getNetworkConfig(): Promise‹NetworkConfig›
Defined in contractkit/src/kit.ts:120
Returns: Promise‹NetworkConfig›
▸ getTotalBalance(address
: string): Promise‹AccountBalance›
Defined in contractkit/src/kit.ts:98
Parameters:
Name | Type |
---|---|
address |
string |
Returns: Promise‹AccountBalance›
▸ getWallet(): undefined | ReadOnlyWallet
Defined in contractkit/src/kit.ts:94
Returns: undefined | ReadOnlyWallet
▸ isListening(): Promise‹boolean›
Defined in contractkit/src/kit.ts:318
Returns: Promise‹boolean›
▸ isSyncing(): Promise‹boolean›
Defined in contractkit/src/kit.ts:322
Returns: Promise‹boolean›
▸ sendTransaction(tx
: CeloTx): Promise‹TransactionResult›
Defined in contractkit/src/kit.ts:333
Parameters:
Name | Type |
---|---|
tx |
CeloTx |
Returns: Promise‹TransactionResult›
▸ sendTransactionObject(txObj
: CeloTxObject‹any›, tx?
: Omit‹CeloTx, "data"›): Promise‹TransactionResult›
Defined in contractkit/src/kit.ts:337
Parameters:
Name | Type |
---|---|
txObj |
CeloTxObject‹any› |
tx? |
Omit‹CeloTx, "data"› |
Returns: Promise‹TransactionResult›
▸ setFeeCurrency(token
: CeloToken): Promise‹void›
Defined in contractkit/src/kit.ts:223
Set CeloToken to use to pay for gas fees
Parameters:
Name | Type | Description |
---|---|---|
token |
CeloToken | cUSD (StableToken) or CELO (GoldToken) |
Returns: Promise‹void›
▸ signTypedData(signer
: string, typedData
: EIP712TypedData): Promise‹Signature›
Defined in contractkit/src/kit.ts:344
Parameters:
Name | Type |
---|---|
signer |
string |
typedData |
EIP712TypedData |
Returns: Promise‹Signature›
▸ stop(): void
Defined in contractkit/src/kit.ts:348
Returns: void
▸ updateGasPriceInConnectionLayer(currency
: Address): Promise‹void›
Defined in contractkit/src/kit.ts:233
Parameters:
Name | Type |
---|---|
currency |
Address |
Returns: Promise‹void›