@celo/contractkit › "web3-contract-cache" › Web3ContractCache

Class: Web3ContractCache

Native Web3 contracts factory and cache.

Exposes accessors to all CeloContract web3 contracts.

Mostly a private cache, kit users would normally use a contract wrapper

Hierarchy

  • Web3ContractCache

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Web3ContractCache(kit: ContractKit): Web3ContractCache

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:84

Parameters:

Name Type
kit ContractKit

Returns: Web3ContractCache

Properties

Readonly kit

• kit: ContractKit

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:86

Methods

getAccounts

▸ getAccounts(): Promise‹Accounts‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:87

Returns: Promise‹Accounts‹››

getAttestations

▸ getAttestations(): Promise‹Attestations‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:90

Returns: Promise‹Attestations‹››

getBlockchainParameters

▸ getBlockchainParameters(): Promise‹BlockchainParameters‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:93

Returns: Promise‹BlockchainParameters‹››

getContract

▸ getContract<C>(contract: C, address?: undefined | string): Promise‹NonNullable‹ContractCacheMap[C]››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:172

Get native web3 contract wrapper

Type parameters:

▪ C: keyof typeof ContractFactories

Parameters:

Name Type
contract C
address? undefined | string

Returns: Promise‹NonNullable‹ContractCacheMap[C]››

getDoubleSigningSlasher

▸ getDoubleSigningSlasher(): Promise‹DoubleSigningSlasher‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:96

Returns: Promise‹DoubleSigningSlasher‹››

getDowntimeSlasher

▸ getDowntimeSlasher(): Promise‹DowntimeSlasher‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:99

Returns: Promise‹DowntimeSlasher‹››

getElection

▸ getElection(): Promise‹Election‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:102

Returns: Promise‹Election‹››

getEpochRewards

▸ getEpochRewards(): Promise‹EpochRewards‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:105

Returns: Promise‹EpochRewards‹››

getErc20

▸ getErc20(address: string): Promise‹Ierc20‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:108

Parameters:

Name Type
address string

Returns: Promise‹Ierc20‹››

getEscrow

▸ getEscrow(): Promise‹Escrow‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:111

Returns: Promise‹Escrow‹››

getExchange

▸ getExchange(stableToken: StableToken): Promise‹Exchange‹› | ExchangeEur‹› | ExchangeBrl‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:114

Parameters:

Name Type Default
stableToken StableToken StableToken.cUSD

Returns: Promise‹Exchange‹› | ExchangeEur‹› | ExchangeBrl‹››

getFeeCurrencyWhitelist

▸ getFeeCurrencyWhitelist(): Promise‹FeeCurrencyWhitelist‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:117

Returns: Promise‹FeeCurrencyWhitelist‹››

getFreezer

▸ getFreezer(): Promise‹Freezer‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:120

Returns: Promise‹Freezer‹››

getGasPriceMinimum

▸ getGasPriceMinimum(): Promise‹GasPriceMinimum‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:123

Returns: Promise‹GasPriceMinimum‹››

getGoldToken

▸ getGoldToken(): Promise‹GoldToken‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:126

Returns: Promise‹GoldToken‹››

getGovernance

▸ getGovernance(): Promise‹Governance‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:129

Returns: Promise‹Governance‹››

getGrandaMento

▸ getGrandaMento(): Promise‹GrandaMento‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:132

Returns: Promise‹GrandaMento‹››

getLockedGold

▸ getLockedGold(): Promise‹LockedGold‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:135

Returns: Promise‹LockedGold‹››

getMetaTransactionWallet

▸ getMetaTransactionWallet(address: string): Promise‹MetaTransactionWallet‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:138

Parameters:

Name Type
address string

Returns: Promise‹MetaTransactionWallet‹››

getMetaTransactionWalletDeployer

▸ getMetaTransactionWalletDeployer(address: string): Promise‹MetaTransactionWalletDeployer‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:141

Parameters:

Name Type
address string

Returns: Promise‹MetaTransactionWalletDeployer‹››

getMultiSig

▸ getMultiSig(address: string): Promise‹MultiSig‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:144

Parameters:

Name Type
address string

Returns: Promise‹MultiSig‹››

getRandom

▸ getRandom(): Promise‹Random‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:147

Returns: Promise‹Random‹››

getRegistry

▸ getRegistry(): Promise‹Registry‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:150

Returns: Promise‹Registry‹››

getReserve

▸ getReserve(): Promise‹Reserve‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:153

Returns: Promise‹Reserve‹››

getSortedOracles

▸ getSortedOracles(): Promise‹SortedOracles‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:156

Returns: Promise‹SortedOracles‹››

getStableToken

▸ getStableToken(stableToken: StableToken): Promise‹StableToken‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:159

Parameters:

Name Type Default
stableToken StableToken StableToken.cUSD

Returns: Promise‹StableToken‹››

getTransferWhitelist

▸ getTransferWhitelist(): Promise‹TransferWhitelist‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:162

Returns: Promise‹TransferWhitelist‹››

getValidators

▸ getValidators(): Promise‹Validators‹››

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:165

Returns: Promise‹Validators‹››

invalidateContract

▸ invalidateContract<C>(contract: C): void

Defined in packages/sdk/contractkit/src/web3-contract-cache.ts:186

Type parameters:

▪ C: keyof typeof ContractFactories

Parameters:

Name Type
contract C

Returns: void