Struct ProposalBuilder

pub struct ProposalBuilder<'i, A> { /* private fields */ }

A builder for creating a Proposal.

Implementations

impl<'i, F> ProposalBuilder<'i, BorrowAction<F>>

pub fn borrow(self, object_id: ObjectID) -> ProposalBuilder<'i, BorrowAction<F>>

Adds an object to the list of objects that will be borrowed when executing this action.

pub fn borrow_objects<I>( self, objects: I, ) -> ProposalBuilder<'i, BorrowAction<F>>

where I: IntoIterator<Item = ObjectID>,

Adds many objects. See BorrowAction::borrow_object for more details.

pub fn with_intent<F1>( self, intent_fn: F1, ) -> ProposalBuilder<'i, BorrowAction<F1>>

where F1: FnOnce(&mut ProgrammableTransactionBuilder, &HashMap<ObjectID, (Argument, IotaObjectData)>),

Specifies how to use the borrowed assets. This is only useful if the sender of this transaction has enough voting power to execute this proposal right-away.

impl ProposalBuilder<'_, ConfigChange>

pub fn threshold(self, threshold: u64) -> ProposalBuilder<'_, ConfigChange>

Sets a new value for the identity’s threshold.

pub fn add_controller( self, address: IotaAddress, voting_power: u64, ) -> ProposalBuilder<'_, ConfigChange>

Makes address address a new controller with voting power voting_power.

pub fn add_multiple_controllers<I>( self, controllers: I, ) -> ProposalBuilder<'_, ConfigChange>

where I: IntoIterator<Item = (IotaAddress, u64)>,

Adds multiple controllers. See ProposalBuilder::add_controller.

pub fn remove_controller( self, controller_id: ObjectID, ) -> ProposalBuilder<'_, ConfigChange>

Removes an existing controller.

pub fn remove_multiple_controllers<I>( self, controllers: I, ) -> ProposalBuilder<'_, ConfigChange>

where I: IntoIterator<Item = ObjectID>,

Removes many controllers.

impl<'i, F> ProposalBuilder<'i, ControllerExecution<F>>

pub fn with_intent<F1>( self, intent_fn: F1, ) -> ProposalBuilder<'i, ControllerExecution<F1>>

where F1: FnOnce(&mut ProgrammableTransactionBuilder, &Argument),

Specifies how the borrowed ControllerCap should be used in the transaction. This is only useful if the controller creating this proposal has enough voting power to carry out it out immediately.

impl ProposalBuilder<'_, SendAction>

pub fn object( self, object_id: ObjectID, recipient: IotaAddress, ) -> ProposalBuilder<'_, SendAction>

Adds one object to the list of objects to send.

pub fn objects<I>(self, objects: I) -> ProposalBuilder<'_, SendAction>

where I: IntoIterator<Item = (ObjectID, IotaAddress)>,

Adds multiple objects to the list of objects to send.

impl<'i, A> ProposalBuilder<'i, A>

pub fn expiration_epoch(self, exp: u64) -> ProposalBuilder<'i, A>

Sets the expiration epoch for the Proposal.

pub async fn finish<'c, S>( self, client: &'c IdentityClient<S>, ) -> Result<impl ResultingTransactionT + use<'i, 'c, S, A>, Error>

where 'i: 'c, Proposal<A>: ProposalT<Action = A>, S: Signer<IotaKeySignature> + Sync, A: 'c,

Creates a Proposal with the provided arguments. If forbid_chained_execution is set to true, the Proposal won’t be executed even if creator alone has enough voting power.

Trait Implementations

impl<'i, A> Debug for ProposalBuilder<'i, A>

where A: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<A> Deref for ProposalBuilder<'_, A>

type Target = A

The resulting type after dereferencing.

fn deref(&self) -> &<ProposalBuilder<'_, A> as Deref>::Target

Dereferences the value.

impl<A> DerefMut for ProposalBuilder<'_, A>

fn deref_mut(&mut self) -> &mut <ProposalBuilder<'_, A> as Deref>::Target

Mutably dereferences the value.