@celo/contractkit › "kit" › ContractKit

Class: ContractKit

Hierarchy

  • ContractKit

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

+ new ContractKit(connection: Connection): ContractKit

Defined in packages/sdk/contractkit/src/kit.ts:114

Parameters:

Name Type
connection Connection

Returns: ContractKit

Properties

Readonly _web3Contracts

• _web3Contracts: Web3ContractCache

Defined in packages/sdk/contractkit/src/kit.ts:107

factory for core contract's native web3 wrappers

Readonly celoTokens

• celoTokens: CeloTokens

Defined in packages/sdk/contractkit/src/kit.ts:111

helper for interacting with CELO & stable tokens

Readonly connection

• connection: Connection

Defined in packages/sdk/contractkit/src/kit.ts:116

Readonly contracts

• contracts: WrapperCache

Defined in packages/sdk/contractkit/src/kit.ts:109

factory for core contract's kit wrappers

gasPriceSuggestionMultiplier

• gasPriceSuggestionMultiplier: number = 5

Defined in packages/sdk/contractkit/src/kit.ts:114

Readonly registry

• registry: AddressRegistry

Defined in packages/sdk/contractkit/src/kit.ts:105

core contract's address registry

Accessors

defaultAccount

• get defaultAccount(): Address | undefined

Defined in packages/sdk/contractkit/src/kit.ts:266

Returns: Address | undefined

• set defaultAccount(address: Address | undefined): void

Defined in packages/sdk/contractkit/src/kit.ts:262

Parameters:

Name Type
address Address | undefined

Returns: void

defaultFeeCurrency

• get defaultFeeCurrency(): undefined | string

Defined in packages/sdk/contractkit/src/kit.ts:290

Returns: undefined | string

• set defaultFeeCurrency(address: Address | undefined): void

Defined in packages/sdk/contractkit/src/kit.ts:286

Parameters:

Name Type
address Address | undefined

Returns: void

gasInflationFactor

• get gasInflationFactor(): number

Defined in packages/sdk/contractkit/src/kit.ts:274

Returns: number

• set gasInflationFactor(factor: number): void

Defined in packages/sdk/contractkit/src/kit.ts:270

Parameters:

Name Type
factor number

Returns: void

gasPrice

• get gasPrice(): number

Defined in packages/sdk/contractkit/src/kit.ts:282

Returns: number

• set gasPrice(price: number): void

Defined in packages/sdk/contractkit/src/kit.ts:278

Parameters:

Name Type
price number

Returns: void

web3

• get web3(): Web3‹›

Defined in packages/sdk/contractkit/src/kit.ts:328

Returns: Web3‹›

Methods

addAccount

▸ addAccount(privateKey: string): void

Defined in packages/sdk/contractkit/src/kit.ts:258

Parameters:

Name Type
privateKey string

Returns: void

fillGasPrice

▸ fillGasPrice(tx: CeloTx): Promise‹CeloTx›

Defined in packages/sdk/contractkit/src/kit.ts:302

Parameters:

Name Type
tx CeloTx

Returns: Promise‹CeloTx›

getEpochNumberOfBlock

▸ getEpochNumberOfBlock(blockNumber: number): Promise‹number›

Defined in packages/sdk/contractkit/src/kit.ts:243

Parameters:

Name Type
blockNumber number

Returns: Promise‹number›

getEpochSize

▸ getEpochSize(): Promise‹number›

Defined in packages/sdk/contractkit/src/kit.ts:216

Returns: Promise‹number›

getFirstBlockNumberForEpoch

▸ getFirstBlockNumberForEpoch(epochNumber: number): Promise‹number›

Defined in packages/sdk/contractkit/src/kit.ts:223

Parameters:

Name Type
epochNumber number

Returns: Promise‹number›

getHumanReadableNetworkConfig

▸ getHumanReadableNetworkConfig(): Promise‹NetworkConfig | Record‹never, unknown››

Defined in packages/sdk/contractkit/src/kit.ts:191

Returns: Promise‹NetworkConfig | Record‹never, unknown››

getLastBlockNumberForEpoch

▸ getLastBlockNumberForEpoch(epochNumber: number): Promise‹number›

Defined in packages/sdk/contractkit/src/kit.ts:233

Parameters:

Name Type
epochNumber number

Returns: Promise‹number›

getNetworkConfig

▸ getNetworkConfig(humanReadable: boolean): Promise‹NetworkConfig | Record‹CeloContract & "exchanges" & "stableTokens", unknown››

Defined in packages/sdk/contractkit/src/kit.ts:144

Parameters:

Name Type Default
humanReadable boolean false

Returns: Promise‹NetworkConfig | Record‹CeloContract & "exchanges" & "stableTokens", unknown››

getTotalBalance

▸ getTotalBalance(address: string): Promise‹AccountBalance›

Defined in packages/sdk/contractkit/src/kit.ts:127

Parameters:

Name Type
address string

Returns: Promise‹AccountBalance›

getWallet

▸ getWallet(): undefined | ReadOnlyWallet

Defined in packages/sdk/contractkit/src/kit.ts:123

Returns: undefined | ReadOnlyWallet

isListening

▸ isListening(): Promise‹boolean›

Defined in packages/sdk/contractkit/src/kit.ts:294

Returns: Promise‹boolean›

isSyncing

▸ isSyncing(): Promise‹boolean›

Defined in packages/sdk/contractkit/src/kit.ts:298

Returns: Promise‹boolean›

sendTransaction

▸ sendTransaction(tx: CeloTx): Promise‹TransactionResult›

Defined in packages/sdk/contractkit/src/kit.ts:309

Parameters:

Name Type
tx CeloTx

Returns: Promise‹TransactionResult›

sendTransactionObject

▸ sendTransactionObject(txObj: CeloTxObject‹any›, tx?: Omit‹CeloTx, "data"›): Promise‹TransactionResult›

Defined in packages/sdk/contractkit/src/kit.ts:313

Parameters:

Name Type
txObj CeloTxObject‹any›
tx? Omit‹CeloTx, "data"›

Returns: Promise‹TransactionResult›

setFeeCurrency

▸ setFeeCurrency(tokenContract: CeloTokenContract): Promise‹void›

Defined in packages/sdk/contractkit/src/kit.ts:197

Set CeloToken to use to pay for gas fees

Parameters:

Name Type Description
tokenContract CeloTokenContract CELO (GoldToken) or a supported StableToken contract

Returns: Promise‹void›

signTypedData

▸ signTypedData(signer: string, typedData: EIP712TypedData): Promise‹Signature›

Defined in packages/sdk/contractkit/src/kit.ts:320

Parameters:

Name Type
signer string
typedData EIP712TypedData

Returns: Promise‹Signature›

stop

▸ stop(): void

Defined in packages/sdk/contractkit/src/kit.ts:324

Returns: void

updateGasPriceInConnectionLayer

▸ updateGasPriceInConnectionLayer(currency: Address): Promise‹void›

Defined in packages/sdk/contractkit/src/kit.ts:209

Parameters:

Name Type
currency Address

Returns: Promise‹void›