Class MultisigWallet

Contract

MultisigWallet

Hierarchy

BaseContract
- MultisigWallet

Constructors

constructor

new MultisigWallet(params: IInitParams): MultisigWallet
Initialization of the MultisigWallet Contract This is a wrapper of the solidity smart contract
Parameters
- params: IInitParams
  
  The core parameters passed into the constructor
Returns MultisigWallet
Overrides BaseContract.constructor
- Defined in ../../packages/multsig-wallet/src/contract.ts:35

Properties

contract

contract: Contract

`Protected` hasSigner

hasSigner: boolean

`Protected` signer

signer: Wallet

`Static` MAX_OWNER_COUNT

MAX_OWNER_COUNT: number = 50

Methods

addOwner

addOwner(params: IAddress): Promise<ContractReceipt>
Wrapper for addOwner Functionality on the Multisig Wallet Add Owner is a function that can only be called by itself This function allows an EOA to submit a transaction via the Multisig Wallet to edit itself

Function
addOwner

Returns
Contract Receipt
Parameters
- params: IAddress
Returns Promise<ContractReceipt>
- Defined in ../../packages/multsig-wallet/src/contract.ts:79

changeRequirement

changeRequirement(params: IRequirement): Promise<ContractReceipt>
Wrapper for changeRequirement Functionality on the Multisig Wallet changeRequirement is a function that can only be called by itself This function allows an EOA to submit a transaction via the Multisig Wallet to edit itself

Function
changeRequirement

Returns
Contract Receipt
Parameters
- params: IRequirement
Returns Promise<ContractReceipt>
- Defined in ../../packages/multsig-wallet/src/contract.ts:158

checkSigner

checkSigner(): void
Returns void
Inherited from BaseContract.checkSigner
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/base_contract.d.ts:22

confirmTransaction

confirmTransaction(params: ITransactionId): Promise<ContractReceipt>
Wrapper for confirmTransaction Functionality on the Multisig Wallet confirmTransaction is the primary function that all "changes" are finalized through This function allows an EOA to confirm a transaction via the Multisig Wallet This would be used when someone else proposes a transaction

Function
submitTransaction

Returns
Contract Receipt
Parameters
- params: ITransactionId
Returns Promise<ContractReceipt>
- Defined in ../../packages/multsig-wallet/src/contract.ts:231

createNewWallet

createNewWallet(params: ICreateNewWallet): Promise<Contract>
Custom Function Utilizes the MultisigWallet Bytecode and Abi to deploy a new Multisig Wallet on a SKALE Chain Valid Requirements are checked on the client in order to help guide deployment

Function
createNewWallet

Returns
Smart Contract Instance. The address can be derived from it.
Parameters
- params: ICreateNewWallet
Returns Promise<Contract>
- Defined in ../../packages/multsig-wallet/src/contract.ts:56

executeTransaction

executeTransaction(params: ITransactionId): Promise<ContractReceipt>
Wrapper for executeTransaction Functionality on the Multisig Wallet executeTransaction is the function called to execute a transaction that has a valid number of confirmations This function allows an EOA to execute and submit a transaction to be picked up by the network This would be used after "enough" signers have confirmed

Function
executeTransaction

Returns
Contract Receipt
Parameters
- params: ITransactionId
Returns Promise<ContractReceipt>
- Defined in ../../packages/multsig-wallet/src/contract.ts:250

getConfirmationCount

getConfirmationCount(params: ITransactionId): Promise<BigNumber>
Gets confirmation count for a transaction by id

Function
getConfirmationCount

Returns
Number of Confirmations
Parameters
- params: ITransactionId
Returns Promise<BigNumber>
- Defined in ../../packages/multsig-wallet/src/contract.ts:301

getConfirmations

getConfirmations(params: ITransactionId): Promise<string[]>
Gets List of Owners Who Confirmed a Transaction

Function
getConfirmations

Returns
List of Owners
Parameters
- params: ITransactionId
Returns Promise<string[]>
- Defined in ../../packages/multsig-wallet/src/contract.ts:345

getEventNames

getEventNames(__namedParameters: {
nameOnly?: boolean;
}): string[]
Parameters
- __namedParameters: {
  nameOnly?: boolean;
  }
  - Optional nameOnly?: boolean
Returns string[]
Inherited from BaseContract.getEventNames
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/base_contract.d.ts:24

getOwners

getOwners(): Promise<string[]>
Get Multisig Wallet Owners

Function
getOwners

Returns
List of Owners

Returns Promise<string[]>
- Defined in ../../packages/multsig-wallet/src/contract.ts:330

getRequired

getRequired(): Promise<number>
Gets Total # of Signers Needed to Confirm a Transaction

Function
getRequired

Returns
Number of Confirmations Needed

Returns Promise<number>
- Defined in ../../packages/multsig-wallet/src/contract.ts:407

getTransaction

getTransaction(params: ITransactionId): Promise<ITransaction>
Gets Data from a Transaction

Function
getTransaction

Returns
Transaction Data
Parameters
- params: ITransactionId
Returns Promise<ITransaction>
- Defined in ../../packages/multsig-wallet/src/contract.ts:390

getTransactionCount

getTransactionCount(params: ITransactionCount): Promise<BigNumber>
Get Transaction Count

Function
getTransactionCount

Returns
Number of Txs
Parameters
- params: ITransactionCount
Returns Promise<BigNumber>
- Defined in ../../packages/multsig-wallet/src/contract.ts:316

getTransactionIds

getTransactionIds(params: ITransactionIds): Promise<BigNumber[]>
Gets Transaction Ids within the given range and of type

Function
getTransactionIds

Returns
List of Tx Ids
Parameters
- params: ITransactionIds
Returns Promise<BigNumber[]>
- Defined in ../../packages/multsig-wallet/src/contract.ts:360

isConfirmed

isConfirmed(params: ITransactionId): Promise<boolean>
Checks if transaction is confirmed

Function
isConfirmed

Returns
Is Tx Confirmed
Parameters
- params: ITransactionId
Returns Promise<boolean>
- Defined in ../../packages/multsig-wallet/src/contract.ts:286

isOwner

isOwner(params: IAddress): Promise<boolean>
Checks whether address is owner of multisig

Function
isOwner

Returns
True if Owner
Parameters
- params: IAddress
Returns Promise<boolean>
- Defined in ../../packages/multsig-wallet/src/contract.ts:375

onlyWalletFunction

onlyWalletFunction(params: IOnlyWalletFunction): BytesLike
Private function that is used to generate encoded data that can be used for multisig execution This is a custom function with custom types that is built specifically for the predeployed multisig This increases type safety on the client side where as calling this manualy could result in a higher chance of mispelling funciton names or encoded data with negative results

Function
onlyWalletFunction

Returns
Contract Receipt
Parameters
- params: IOnlyWalletFunction
Returns BytesLike
- Defined in ../../packages/multsig-wallet/src/contract.ts:268

removeOwner

removeOwner(params: IAddress): Promise<ContractReceipt>
Wrapper for removeOwner Functionality on the Multisig Wallet Remove Owner is a function that can only be called by itself This function allows an EOA to submit a transaction via the Multisig Wallet to edit itself

Function
removeOwner

Returns
Contract Receipt
Parameters
- params: IAddress
Returns Promise<ContractReceipt>
- Defined in ../../packages/multsig-wallet/src/contract.ts:105

replaceOwner

replaceOwner(params: IReplaceOwner): Promise<ContractReceipt>
Wrapper for replaceOwner Functionality on the Multisig Wallet Replace Owner is a function that can only be called by itself This function allows an EOA to submit a transaction via the Multisig Wallet to edit itself

Function
replaceOwner

Returns
Contract Receipt
Parameters
- params: IReplaceOwner
Returns Promise<ContractReceipt>
- Defined in ../../packages/multsig-wallet/src/contract.ts:131

setSigner

setSigner(__namedParameters: {
signer: Wallet;
}): void
Parameters
- __namedParameters: {
  signer: Wallet;
  }
  - signer: Wallet
Returns void
Inherited from BaseContract.setSigner
- Defined in ../../node_modules/@skaleproject/utils/lib/contracts/base_contract.d.ts:27

submitTransaction

submitTransaction(params: IBaseTransaction): Promise<ContractReceipt>
Wrapper for submitTransaction Functionality on the Multisig Wallet submitTransaction is the primary function that all "changes" are made through This function allows an EOA to submit a transaction via the Multisig Wallet to edit itself

Function
submitTransaction

Returns
Contract Receipt
Parameters
- params: IBaseTransaction
Returns Promise<ContractReceipt>
- Defined in ../../packages/multsig-wallet/src/contract.ts:208

`Private` validRequirement

validRequirement(params: ICreateNewWallet): void
Private
Internal Function to check if the request is a valid requirement This is used for the custom create new multisigwallet function

Function
validRequirement

Returns
Parameters
- params: ICreateNewWallet
Returns void
- Defined in ../../packages/multsig-wallet/src/contract.ts:183

Class MultisigWallet

Contract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: IInitParams

Returns MultisigWallet

Properties

contract

Protected hasSigner

Protected signer

Static MAX_OWNER_COUNT

Methods

addOwner

Function

Returns

Parameters

params: IAddress

Returns Promise<ContractReceipt>

changeRequirement

Function

Returns

Parameters

params: IRequirement

Returns Promise<ContractReceipt>

checkSigner

Returns void

confirmTransaction

Function

Returns

Parameters

params: ITransactionId

Returns Promise<ContractReceipt>

createNewWallet

Function

Returns

Parameters

params: ICreateNewWallet

Returns Promise<Contract>

executeTransaction

Function

Returns

Parameters

params: ITransactionId

Returns Promise<ContractReceipt>

getConfirmationCount

Function

Returns

Parameters

params: ITransactionId

Returns Promise<BigNumber>

getConfirmations

Function

Returns

Parameters

params: ITransactionId

Returns Promise<string[]>

getEventNames

Parameters

__namedParameters: { nameOnly?: boolean; }

Optional nameOnly?: boolean

Returns string[]

getOwners

Function

Returns

Returns Promise<string[]>

getRequired

Function

Returns

Returns Promise<number>

getTransaction

Function

Returns

Parameters

params: ITransactionId

`Protected` hasSigner

`Protected` signer

`Static` MAX_OWNER_COUNT

__namedParameters: {
nameOnly?: boolean;
}

`Optional` nameOnly?: boolean

__namedParameters: {
signer: Wallet;
}

`Private` validRequirement