Module proposals

Contains the operations of proposals.

Structs

AccessSubIdentity

An action for accessing an OnChainIdentity that is owned by another OnChainIdentity.

AccessSubIdentityBuilder

A builder structure that eases the creation of an AccessSubIdentityTx.

AccessSubIdentityBuilderError

Error type returned by AccessSubIdentityBuilder::finish.

AccessSubIdentityError

Error type returned by executing an AccessSubIdentityTx.

AccessSubIdentityTx

[Transaction] that allows a controller of identity to access sub_identity by borrowing one of identity’s token over it.

ApproveProposal

A transaction to approve a Proposal.

BorrowAction

Action used to borrow in transaction OnChainIdentity’s assets.

BorrowActionWithIntent

A BorrowAction coupled with a user-provided function to describe how the borrowed assets shall be used.

ConfigChange

Proposal action that modifies an OnChainIdentity’s configuration - e.g:

ControllerExecution

Borrow an OnChainIdentity’s controller capability to exert control on a sub-owned identity.

ControllerExecutionWithIntent

A ControllerExecution action coupled with a user-provided function to describe how the borrowed identity’s controller capability will be used.

CreateProposal

A transaction to create a Proposal.

EmptyTx

A type implenting [Transansaction] that doesn’t return anything meaningful.

ExecuteProposal

A transaction to execute a Proposal.

ProposalBuilder

A builder for creating a Proposal.

SendAction

An action used to transfer [crate::migration::OnChainIdentity]-owned assets to other addresses.

UnrelatedIdentities

Error type that is returned when attempting to access an Identity sub_identity that is not controlled by identity.

UpdateDidDocument

Proposal’s action for updating a DID Document.

Upgrade

Action for upgrading the version of an on-chain identity to the package’s version.

UserDrivenTx

A transaction that requires user input in order to be executed.

Enums

AccessSubIdentityBuilderErrorKind

Kind of failure that might happen when consuming an AccessSubIdentityBuilder.

ProposedTxResult

The result of attempting to perform an action on an Identity. This action can either be executed right away - when the executing controller has enough voting power to do so - or it can be pending, waiting for other controllers’ approvals.

Traits

BorrowIntentFnT

Instances of BorrowIntentFnT can be used as user-provided function to describe how a borrowed assets shall be used.

ControllerIntentFnT

Instances of ControllerIntentFnT can be used as user-provided function to describe how a borrowed identity’s controller capability will be used.

ProposalT

Interface that allows the creation and execution of an OnChainIdentity’s Proposals.

SubAccessFnT

Trait describing the function used to define what operation to perform on a sub-identity.

Type Aliases

BorrowIntentFn

Boxed dynamic trait object of {@link BorrowIntentFnT}

ControllerIntentFn

Boxed dynamic trait object of {@link ControllerIntentFnT}

ProposalResult

The result of creating a Proposal. When a Proposal is executed in the same transaction as its creation, a ProposalResult::Executed is returned. ProposalResult::Pending otherwise.