@celo/contractkit › "wrappers/MultiSig" › MultiSigWrapper
Class: MultiSigWrapper
Contract for handling multisig actions
Hierarchy
- BaseWrapper‹MultiSig›
↳ MultiSigWrapper
Index
Constructors
Properties
- eventTypes
- events
- getInternalRequired
- getOwners
- getRequired
- getTransactionCount
- isowner
- methodIds
- replaceOwner
- totalTransactionCount
Accessors
Methods
- getPastEvents
- getTransaction
- getTransactionDataByContent
- getTransactions
- submitOrConfirmTransaction
- version
Constructors
constructor
+ new MultiSigWrapper(kit
: ContractKit, contract
: MultiSig): MultiSigWrapper
Inherited from BaseWrapper.constructor
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:30
Parameters:
Name | Type |
---|---|
kit |
ContractKit |
contract |
MultiSig |
Returns: MultiSigWrapper
Properties
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: MultiSig["events"] = this.contract.events
Inherited from BaseWrapper.events
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:59
getInternalRequired
• getInternalRequired: function = proxyCall( this.contract.methods.internalRequired, undefined, valueToBigNumber )
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:64
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
getOwners
• getOwners: function = proxyCall(this.contract.methods.getOwners)
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:62
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
getRequired
• getRequired: function = proxyCall(this.contract.methods.required, undefined, valueToBigNumber)
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:63
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
getTransactionCount
• getTransactionCount: function = proxyCall(this.contract.methods.getTransactionCount, undefined, valueToInt)
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:70
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
isowner
• isowner: function = proxyCall(this.contract.methods.isOwner)
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:61
Type declaration:
▸ (owner
: Address): Promise‹boolean›
Parameters:
Name | Type |
---|---|
owner |
Address |
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
replaceOwner
• replaceOwner: function = proxySend( this.kit, this.contract.methods.replaceOwner, tupleParser(stringIdentity, stringIdentity) )
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:71
Type declaration:
▸ (owner
: Address, newOwner
: Address): CeloTransactionObject‹void›
Parameters:
Name | Type |
---|---|
owner |
Address |
newOwner |
Address |
totalTransactionCount
• totalTransactionCount: function = proxyCall(this.contract.methods.transactionCount, undefined, valueToInt)
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:69
Type declaration:
▸ (...args
: InputArgs): Promise‹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‹MultiSig›, 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‹MultiSig› |
options |
PastEventOptions |
Returns: Promise‹EventLog[]›
getTransaction
▸ getTransaction(i
: number): Promise‹TransactionData›
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:94
Parameters:
Name | Type |
---|---|
i |
number |
Returns: Promise‹TransactionData›
getTransactionDataByContent
▸ getTransactionDataByContent(destination
: string, txo
: CeloTxObject‹any›, value
: BigNumber.Value): Promise‹undefined | TransactionData›
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:77
Parameters:
Name | Type | Default |
---|---|---|
destination |
string | - |
txo |
CeloTxObject‹any› | - |
value |
BigNumber.Value | 0 |
Returns: Promise‹undefined | TransactionData›
getTransactions
▸ getTransactions(): Promise‹TransactionData[]›
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:113
Returns: Promise‹TransactionData[]›
submitOrConfirmTransaction
▸ submitOrConfirmTransaction(destination
: string, txObject
: CeloTxObject‹any›, value
: string): Promise‹CeloTransactionObject‹void› | CeloTransactionObject‹string››
Defined in packages/sdk/contractkit/src/wrappers/MultiSig.ts:33
Allows an owner to submit and confirm a transaction.
If an unexecuted transaction matching txObject
exists on the multisig, adds a confirmation to that tx ID.
Otherwise, submits the txObject
to the multisig and add confirmation.
Parameters:
Name | Type | Default |
---|---|---|
destination |
string | - |
txObject |
CeloTxObject‹any› | - |
value |
string | "0" |
Returns: Promise‹CeloTransactionObject‹void› | CeloTransactionObject‹string››
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››