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

Param	Type	Default
params	MultisigPluginInstallParams
[network]	Networkish	"mainnet"

MultisigClientDecoding

Decoding module for the SDK AddressList Client

Kind: global class

• MultisigClientDecoding
  • .addAddressesAction(data) ⇒ Array.<string>
  • .removeAddressesAction(data) ⇒ Array.<string>
  • .updateMultisigVotingSettings(data) ⇒ MultisigVotingSettings
  • .findInterface(data) ⇒ InterfaceParams | null

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

Decodes a list of addresses from an encoded add members action

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

Param	Type
data	Uint8Array

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

Decodes a list of addresses from an encoded remove members action

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

Param	Type
data	Uint8Array

multisigClientDecoding.updateMultisigVotingSettings(data) ⇒ MultisigVotingSettings

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

Kind: instance method of MultisigClientDecoding
Returns: MultisigVotingSettings

Param	Type
data	Uint8Array

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

Param	Type
data	Uint8Array

MultisigClientEncoding

Encoding module for the SDK Multisig Client

Kind: global class

• MultisigClientEncoding
  • instance
    • .addAddressesAction(params) ⇒ Array.<DaoAction>
    • .removeAddressesAction(params) ⇒ Array.<DaoAction>
    • .updateMultisigVotingSettings(params) ⇒ DaoAction
  • static
    • .getPluginInstallItem(params, network) ⇒ PluginInstallItem

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>

Param	Type
params	AddAddressesParams

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>

Param	Type
params	RemoveAddressesParams

multisigClientEncoding.updateMultisigVotingSettings(params) ⇒ DaoAction

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

Kind: instance method of MultisigClientEncoding
Returns: DaoAction

Param	Type
params	UpdateMultisigVotingSettingsParams

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

Param	Type
params	MultisigPluginInstallParams
network	Networkish

MultisigClientEstimation

Estimation module the SDK Address List Client

Kind: global class

• MultisigClientEstimation
  • .createProposal(params) ⇒ Promise.<GasFeeEstimation>
  • .approveProposal(params) ⇒ Promise.<GasFeeEstimation>
  • .executeProposal(proposalId) ⇒ Promise.<GasFeeEstimation>
  • .prepareUpdate(params) ⇒ Promise.<GasFeeEstimation>

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

Estimates the gas fee of creating a proposal on the plugin

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

Param	Type
params	CreateMultisigProposalParams

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

Estimates the gas fee of approving a proposal

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

Param	Type
params	ApproveMultisigProposalParams

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

Estimates the gas fee of executing a proposal

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

Param	Type
proposalId	string

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

Estimates the gas fee of preparing an update

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

Param	Type
params	MultisigPluginPrepareUpdateParams

MultisigClientMethods

Methods module the SDK Address List Client

Kind: global class

• MultisigClientMethods
  • .createProposal(params) ⇒ AsyncGenerator.<ProposalCreationStepValue>
  • .pinMetadata(params) ⇒ Promise.<string>
  • .approveProposal(params) ⇒ AsyncGenerator.<ApproveProposalStepValue>
  • .executeProposal(proposalId) ⇒ AsyncGenerator.<ExecuteMultisigProposalStepValue>
  • .prepareInstallation(params) ⇒ AsyncGenerator.<PrepareInstallationStepValue>
  • .prepareUpdate(params) ⇒ AsyncGenerator.<PrepareUpdateStepValue>
  • .canApprove(addressOrEns) ⇒ Promise.<boolean>
  • .canExecute(proposalId) ⇒ Promise.<boolean>
  • .getVotingSettings(addressOrEns, blockNumber) ⇒ Promise.<MultisigVotingSettings>
  • .getMembers(params) ⇒ Promise.<Array.<string>>
  • .getProposal(proposalId) ⇒ Promise.<(MultisigProposal|null)>
  • .getProposals(params) ⇒ Promise.<Array.<MultisigProposalListItem>>
  • .isMember(params) ⇒ boolean

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

Creates a new proposal on the given multisig plugin contract

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

Param	Type
params	CreateMultisigProposalParams

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

Pins a metadata object into IPFS and retruns the generated hash

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

Param	Type
params	ProposalMetadata

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

Allow a wallet in the multisig give approval to a proposal

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

Param	Type
params	ApproveMultisigProposalParams

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

Allow a wallet in the multisig give approval to a proposal

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

Param	Type
proposalId	string

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

Prepares the installation of a multisig plugin in a given dao

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

Param	Type
params	MultisigPluginPrepareInstallationParams

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

Prepares the update of a multisig plugin in a given dao

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

Param	Type
params	MultisigPluginPrepareUpdateParams

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>

Param	Type
addressOrEns	string

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

Checks whether the current proposal can be executed

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

Param	Type
proposalId	string

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

Returns the voting settings

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

Param	Type
addressOrEns	string
blockNumber	number

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

returns the members of the multisig

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

Param	Type	Description
params	MembersQueryParams	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)>

Param	Type
proposalId	string

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>>

Param	Type	Description
params	ProposalQueryParams	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.

Param	Description
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.