@celo/contractkit › "wrappers/Reserve" › ReserveWrapper

Class: ReserveWrapper

Contract for handling reserve for stable currencies

Hierarchy

• BaseWrapper‹Reserve›

↳ ReserveWrapper

Index

Constructors

• constructor

Properties

• dailySpendingRatio
• eventTypes
• events
• frozenReserveGoldDays
• frozenReserveGoldStartBalance
• frozenReserveGoldStartDay
• getAssetAllocationSymbols
• getAssetAllocationWeights
• getOrComputeTobinTax
• getOtherReserveAddresses
• getReserveCeloBalance
• getReserveGoldBalance
• getUnfrozenBalance
• getUnfrozenReserveCeloBalance
• isOtherReserveAddress
• isSpender
• methodIds
• tobinTaxStalenessThreshold
• transferGold

Accessors

• address

Methods

• getConfig
• getPastEvents
• getSpenders
• version

Constructors

constructor

+ new ReserveWrapper(kit: ContractKit, contract: Reserve): ReserveWrapper

Inherited from BaseWrapper.constructor

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:30

Parameters:

Name	Type
kit	ContractKit
contract	Reserve

Returns: ReserveWrapper

Properties

dailySpendingRatio

• dailySpendingRatio: function = proxyCall( this.contract.methods.getDailySpendingRatio, undefined, fixidityValueToBigNumber )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:33

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

eventTypes

• eventTypes: EventsEnum‹T› = Object.keys(this.events).reduce>( (acc, key) => ({ ...acc, [key]: key }), {} as any )

Inherited from BaseWrapper.eventTypes

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:61

---

events

• events: Reserve["events"] = this.contract.events

Inherited from BaseWrapper.events

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:59

---

frozenReserveGoldDays

• frozenReserveGoldDays: function = proxyCall( this.contract.methods.frozenReserveGoldDays, undefined, valueToBigNumber )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:51

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

frozenReserveGoldStartBalance

• frozenReserveGoldStartBalance: function = proxyCall( this.contract.methods.frozenReserveGoldStartBalance, undefined, valueToBigNumber )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:41

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

frozenReserveGoldStartDay

• frozenReserveGoldStartDay: function = proxyCall( this.contract.methods.frozenReserveGoldStartDay, undefined, valueToBigNumber )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:46

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getAssetAllocationSymbols

• getAssetAllocationSymbols: function = proxyCall( this.contract.methods.getAssetAllocationSymbols, undefined, (symbols) => symbols.map(this.kit.web3.utils.hexToAscii) )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:71

notice Returns a list of token symbols that have been allocated.

returns An array of token symbols that have been allocated.

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getAssetAllocationWeights

• getAssetAllocationWeights: function = proxyCall( this.contract.methods.getAssetAllocationWeights, undefined, (weights) => weights.map(valueToBigNumber) )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:61

notice Returns a list of weights used for the allocation of reserve assets.

returns An array of a list of weights used for the allocation of reserve assets.

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getOrComputeTobinTax

• getOrComputeTobinTax: function = proxySend(this.kit, this.contract.methods.getOrComputeTobinTax)

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:40

Type declaration:

▸ (...args: InputArgs): CeloTransactionObject‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getOtherReserveAddresses

• getOtherReserveAddresses: function = proxyCall(this.contract.methods.getOtherReserveAddresses)

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:115

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getReserveCeloBalance

• getReserveCeloBalance: function = this.getReserveGoldBalance

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:90

notice Returns the amount of CELO included in the reserve

returns The CELO amount included in the reserve.

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getReserveGoldBalance

• getReserveGoldBalance: function = proxyCall( this.contract.methods.getReserveGoldBalance, undefined, valueToBigNumber )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:80

alias {getReserveCeloBalance}

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getUnfrozenBalance

• getUnfrozenBalance: function = proxyCall( this.contract.methods.getUnfrozenBalance, undefined, valueToBigNumber )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:97

notice Returns the amount of unfrozen CELO in the Reserve contract.

see {getUnfrozenReserveCeloBalance}

returns amount in wei

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

getUnfrozenReserveCeloBalance

• getUnfrozenReserveCeloBalance: function = proxyCall( this.contract.methods.getUnfrozenReserveGoldBalance, undefined, valueToBigNumber )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:109

notice Returns the amount of unfrozen CELO included in the reserve contract and in other reserve addresses.

see {getUnfrozenBalance}

returns amount in wei

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

isOtherReserveAddress

• isOtherReserveAddress: function = proxyCall(this.contract.methods.isOtherReserveAddress)

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:130

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

isSpender

• isSpender: function = proxyCall(this.contract.methods.isSpender)

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:38

Type declaration:

▸ (account: string): Promise‹boolean›

Parameters:

Name	Type
account	string

---

methodIds

• methodIds: Record‹keyof T["methods"], string› = Object.keys(this.contract.methods).reduce, string>>( (acc, method: Methods) => { const methodABI = this.contract.options.jsonInterface.find((item) => item.name === method)

  acc[method] =
    methodABI === undefined
      ? '0x'
      : this.kit.connection.getAbiCoder().encodeFunctionSignature(methodABI)

  return acc
},
{} as any

)

Inherited from BaseWrapper.methodIds

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:66

---

tobinTaxStalenessThreshold

• tobinTaxStalenessThreshold: function = proxyCall( this.contract.methods.tobinTaxStalenessThreshold, undefined, valueToBigNumber )

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:28

Query Tobin tax staleness threshold parameter.

returns Current Tobin tax staleness threshold.

Type declaration:

▸ (...args: InputArgs): Promise‹Output›

Parameters:

Name	Type
...args	InputArgs

---

transferGold

• transferGold: function = proxySend(this.kit, this.contract.methods.transferGold)

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:39

Type declaration:

▸ (...args: InputArgs): CeloTransactionObject‹Output›

Parameters:

Name	Type
...args	InputArgs

Accessors

address

• get address(): string

Inherited from BaseWrapper.address

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:35

Contract address

Returns: string

Methods

getConfig

▸ getConfig(): Promise‹ReserveConfig›

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:120

Returns current configuration parameters.

Returns: Promise‹ReserveConfig›

---

getPastEvents

▸ getPastEvents(event: Events‹Reserve›, options: PastEventOptions): Promise‹EventLog[]›

Inherited from BaseWrapper.getPastEvents

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:55

Contract getPastEvents

Parameters:

Name	Type
event	Events‹Reserve›
options	PastEventOptions

Returns: Promise‹EventLog[]›

---

getSpenders

▸ getSpenders(): Promise‹Address[]›

Defined in packages/sdk/contractkit/src/wrappers/Reserve.ts:132

Returns: Promise‹Address[]›

---

version

▸ version(): Promise‹NonNullable‹T["methods"] extends object ? ContractVersion<> : never››

Inherited from BaseWrapper.version

Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:39

Returns: Promise‹NonNullable‹T["methods"] extends object ? ContractVersion<> : never››