@celo/contractkit › "wrappers/Escrow" › EscrowWrapper
Class: EscrowWrapper
Contract for handling reserve for stable currencies
Hierarchy
- BaseWrapper‹Escrow›
↳ EscrowWrapper
Index
Constructors
Properties
- escrowedPayments
- eventTypes
- events
- getReceivedPaymentIds
- getSentPaymentIds
- methodIds
- receivedPaymentIds
- revoke
- sentPaymentIds
- transfer
- withdraw
Accessors
Methods
Constructors
constructor
+ new EscrowWrapper(kit
: ContractKit, contract
: Escrow): EscrowWrapper
Inherited from BaseWrapper.constructor
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:30
Parameters:
Name | Type |
---|---|
kit |
ContractKit |
contract |
Escrow |
Returns: EscrowWrapper
Properties
escrowedPayments
• escrowedPayments: function = proxyCall(this.contract.methods.escrowedPayments)
Defined in packages/sdk/contractkit/src/wrappers/Escrow.ts:8
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
eventTypes
• eventTypes: EventsEnum‹T› = Object.keys(this.events).reduce
Inherited from BaseWrapper.eventTypes
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:61
events
• events: Escrow["events"] = this.contract.events
Inherited from BaseWrapper.events
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:59
getReceivedPaymentIds
• getReceivedPaymentIds: function = proxyCall(this.contract.methods.getReceivedPaymentIds)
Defined in packages/sdk/contractkit/src/wrappers/Escrow.ts:14
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
getSentPaymentIds
• getSentPaymentIds: function = proxyCall(this.contract.methods.getSentPaymentIds)
Defined in packages/sdk/contractkit/src/wrappers/Escrow.ts:16
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
methodIds
• methodIds: Record‹keyof T["methods"], string› = Object.keys(this.contract.methods).reduce
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
receivedPaymentIds
• receivedPaymentIds: function = proxyCall(this.contract.methods.receivedPaymentIds)
Defined in packages/sdk/contractkit/src/wrappers/Escrow.ts:10
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
revoke
• revoke: function = proxySend(this.kit, this.contract.methods.revoke)
Defined in packages/sdk/contractkit/src/wrappers/Escrow.ts:22
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
sentPaymentIds
• sentPaymentIds: function = proxyCall(this.contract.methods.sentPaymentIds)
Defined in packages/sdk/contractkit/src/wrappers/Escrow.ts:12
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
transfer
• transfer: function = proxySend(this.kit, this.contract.methods.transfer)
Defined in packages/sdk/contractkit/src/wrappers/Escrow.ts:18
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
withdraw
• withdraw: function = proxySend(this.kit, this.contract.methods.withdraw)
Defined in packages/sdk/contractkit/src/wrappers/Escrow.ts:20
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
getPastEvents
▸ getPastEvents(event
: Events‹Escrow›, 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‹Escrow› |
options |
PastEventOptions |
Returns: Promise‹EventLog[]›
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››