Skip to main content

multisig

Classes

MultisigClient

Provider a generic client with high level methods to manage and interact an Address List Voting plugin installed in a DAO

MultisigClientDecoding

Decoding module for the SDK AddressList Client

MultisigClientEncoding

Encoding module for the SDK Multisig Client

MultisigClientEstimation

Estimation module the SDK Address List Client

MultisigClientMethods

Methods module the SDK Address List Client

MultisigClient

Provider a generic client with high level methods to manage and interact an Address List Voting plugin installed in a DAO

Kind: global class

MultisigClient.getPluginInstallItem(params, [network]) ⇒ PluginInstallItem

Computes the parameters to be given when creating the DAO, so that the plugin is configured

Kind: static method of MultisigClient
Returns: PluginInstallItem

ParamTypeDefault
paramsMultisigPluginInstallParams
[network]Networkish"mainnet"

MultisigClientDecoding

Decoding module for the SDK AddressList Client

Kind: global class

multisigClientDecoding.addAddressesAction(data) ⇒ Array.<string>

Decodes a list of addresses from an encoded add members action

Kind: instance method of MultisigClientDecoding
Returns: Array.<string>

ParamType
dataUint8Array

multisigClientDecoding.removeAddressesAction(data) ⇒ Array.<string>

Decodes a list of addresses from an encoded remove members action

Kind: instance method of MultisigClientDecoding
Returns: Array.<string>

ParamType
dataUint8Array

multisigClientDecoding.updateMultisigVotingSettings(data) ⇒ MultisigVotingSettings

Decodes a list of min approvals from an encoded update min approval action

Kind: instance method of MultisigClientDecoding
Returns: MultisigVotingSettings

ParamType
dataUint8Array

multisigClientDecoding.findInterface(data) ⇒ InterfaceParams | null

Returns the decoded function info given the encoded data of an action

Kind: instance method of MultisigClientDecoding
Returns: InterfaceParams | null

ParamType
dataUint8Array

MultisigClientEncoding

Encoding module for the SDK Multisig Client

Kind: global class

multisigClientEncoding.addAddressesAction(params) ⇒ Array.<DaoAction>

Computes the parameters to be given when creating a proposal that updates the governance configuration

Kind: instance method of MultisigClientEncoding
Returns: Array.<DaoAction>

ParamType
paramsAddAddressesParams

multisigClientEncoding.removeAddressesAction(params) ⇒ Array.<DaoAction>

Computes the parameters to be given when creating a proposal that adds addresses to address list

Kind: instance method of MultisigClientEncoding
Returns: Array.<DaoAction>

ParamType
paramsRemoveAddressesParams

multisigClientEncoding.updateMultisigVotingSettings(params) ⇒ DaoAction

Computes the parameters to be given when creating a proposal updates multisig settings

Kind: instance method of MultisigClientEncoding
Returns: DaoAction

ParamType
paramsUpdateMultisigVotingSettingsParams

MultisigClientEncoding.getPluginInstallItem(params, network) ⇒ PluginInstallItem

Computes the parameters to be given when creating the DAO, so that the plugin is configured

Kind: static method of MultisigClientEncoding
Returns: PluginInstallItem

ParamType
paramsMultisigPluginInstallParams
networkNetworkish

MultisigClientEstimation

Estimation module the SDK Address List Client

Kind: global class

multisigClientEstimation.createProposal(params) ⇒ Promise.<GasFeeEstimation>

Estimates the gas fee of creating a proposal on the plugin

Kind: instance method of MultisigClientEstimation
Returns: Promise.<GasFeeEstimation>

ParamType
paramsCreateMultisigProposalParams

multisigClientEstimation.approveProposal(params) ⇒ Promise.<GasFeeEstimation>

Estimates the gas fee of approving a proposal

Kind: instance method of MultisigClientEstimation
Returns: Promise.<GasFeeEstimation>

ParamType
paramsApproveMultisigProposalParams

multisigClientEstimation.executeProposal(proposalId) ⇒ Promise.<GasFeeEstimation>

Estimates the gas fee of executing a proposal

Kind: instance method of MultisigClientEstimation
Returns: Promise.<GasFeeEstimation>

ParamType
proposalIdstring

multisigClientEstimation.prepareUpdate(params) ⇒ Promise.<GasFeeEstimation>

Estimates the gas fee of preparing an update

Kind: instance method of MultisigClientEstimation
Returns: Promise.<GasFeeEstimation>

ParamType
paramsMultisigPluginPrepareUpdateParams

MultisigClientMethods

Methods module the SDK Address List Client

Kind: global class

multisigClientMethods.createProposal(params) ⇒ AsyncGenerator.<ProposalCreationStepValue>

Creates a new proposal on the given multisig plugin contract

Kind: instance method of MultisigClientMethods
Returns: AsyncGenerator.<ProposalCreationStepValue>

ParamType
paramsCreateMultisigProposalParams

multisigClientMethods.pinMetadata(params) ⇒ Promise.<string>

Pins a metadata object into IPFS and retruns the generated hash

Kind: instance method of MultisigClientMethods
Returns: Promise.<string>

ParamType
paramsProposalMetadata

multisigClientMethods.approveProposal(params) ⇒ AsyncGenerator.<ApproveProposalStepValue>

Allow a wallet in the multisig give approval to a proposal

Kind: instance method of MultisigClientMethods
Returns: AsyncGenerator.<ApproveProposalStepValue>

ParamType
paramsApproveMultisigProposalParams

multisigClientMethods.executeProposal(proposalId) ⇒ AsyncGenerator.<ExecuteMultisigProposalStepValue>

Allow a wallet in the multisig give approval to a proposal

Kind: instance method of MultisigClientMethods
Returns: AsyncGenerator.<ExecuteMultisigProposalStepValue>

ParamType
proposalIdstring

multisigClientMethods.prepareInstallation(params) ⇒ AsyncGenerator.<PrepareInstallationStepValue>

Prepares the installation of a multisig plugin in a given dao

Kind: instance method of MultisigClientMethods
Returns: AsyncGenerator.<PrepareInstallationStepValue>

ParamType
paramsMultisigPluginPrepareInstallationParams

multisigClientMethods.prepareUpdate(params) ⇒ AsyncGenerator.<PrepareUpdateStepValue>

Prepares the update of a multisig plugin in a given dao

Kind: instance method of MultisigClientMethods
Returns: AsyncGenerator.<PrepareUpdateStepValue>

ParamType
paramsMultisigPluginPrepareUpdateParams

multisigClientMethods.canApprove(addressOrEns) ⇒ Promise.<boolean>

Checks whether the current proposal can be approved by the given address

Kind: instance method of MultisigClientMethods
Returns: Promise.<boolean>

ParamType
addressOrEnsstring

multisigClientMethods.canExecute(proposalId) ⇒ Promise.<boolean>

Checks whether the current proposal can be executed

Kind: instance method of MultisigClientMethods
Returns: Promise.<boolean>

ParamType
proposalIdstring

multisigClientMethods.getVotingSettings(addressOrEns, blockNumber) ⇒ Promise.<MultisigVotingSettings>

Returns the voting settings

Kind: instance method of MultisigClientMethods
Returns: Promise.<MultisigVotingSettings>

ParamType
addressOrEnsstring
blockNumbernumber

multisigClientMethods.getMembers(params) ⇒ Promise.<Array.<string>>

returns the members of the multisig

Kind: instance method of MultisigClientMethods
Returns: Promise.<Array.<string>>

ParamTypeDescription
paramsMembersQueryParams
  • pluginAddress
    • blockNumber
    • limit = 10
    • skip = 0
    • direction = SortDirection.ASC
    • sortBy = MembersSortBy.ADDRESS

multisigClientMethods.getProposal(proposalId) ⇒ Promise.<(MultisigProposal|null)>

Returns the details of the given proposal

Kind: instance method of MultisigClientMethods
Returns: Promise.<(MultisigProposal|null)>

ParamType
proposalIdstring

multisigClientMethods.getProposals(params) ⇒ Promise.<Array.<MultisigProposalListItem>>

Returns a list of proposals on the Plugin, filtered by the given criteria

Kind: instance method of MultisigClientMethods
Returns: Promise.<Array.<MultisigProposalListItem>>

ParamTypeDescription
paramsProposalQueryParams
  • daoAddressOrEns - limit = 10 - status - skip = 0 - direction = SortDirection.ASC - sortBy = ProposalSortBy.CREATED_AT

multisigClientMethods.isMember(params) ⇒ boolean

Checks if a given address is a member of the tokenVoting contract.

Kind: instance method of MultisigClientMethods
Returns: boolean - A boolean indicating whether the address is a member or not.

ParamDescription
params

The parameters for the isMember method.

params.pluginAddress

The address of the plugin.

params.address

The address to check.

params.blockNumber

The block number for specifying a specific block.

© 2024