Struct polymesh_api::polymesh::api::bridge::BridgeCallApi

pub struct BridgeCallApi<'api> { /* private fields */ }

Implementations

impl<'api> BridgeCallApi<'api>

pub fn change_controller(&self, controller: AccountId) -> Result<WrappedCall>

Changes the controller account as admin.

Errors

• BadAdmin if origin is not Self::admin() account.

pub fn change_admin(&self, admin: AccountId) -> Result<WrappedCall>

Changes the bridge admin key.

Errors

• BadAdmin if origin is not Self::admin() account.

pub fn change_timelock(&self, timelock: u32) -> Result<WrappedCall>

Changes the timelock period.

Errors

• BadAdmin if origin is not Self::admin() account.

pub fn freeze(&self) -> Result<WrappedCall>

Freezes transaction handling in the bridge module if it is not already frozen. When the bridge is frozen, attempted transactions get postponed instead of getting handled.

Errors

• BadAdmin if origin is not Self::admin() account.

pub fn unfreeze(&self) -> Result<WrappedCall>

Unfreezes transaction handling in the bridge module if it is frozen.

Errors

• BadAdmin if origin is not Self::admin() account.

pub fn change_bridge_limit( &self, amount: u128, duration: u32 ) -> Result<WrappedCall>

Changes the bridge limits.

Errors

• BadAdmin if origin is not Self::admin() account.
• DivisionByZero if duration is zero.

pub fn change_bridge_exempted( &self, exempted: Vec<(IdentityId, bool)> ) -> Result<WrappedCall>

Changes the bridge limit exempted list.

Errors

• BadAdmin if origin is not Self::admin() account.

pub fn force_handle_bridge_tx( &self, bridge_tx: BridgeTx<AccountId> ) -> Result<WrappedCall>

Forces handling a transaction by bypassing the bridge limit and timelock.

Errors

• BadAdmin if origin is not Self::admin() account.
• NoValidCdd if bridge_tx.recipient does not have a valid CDD claim.

pub fn batch_propose_bridge_tx( &self, bridge_txs: Vec<BridgeTx<AccountId>> ) -> Result<WrappedCall>

Proposes a vector of bridge transactions. The vector is processed until the first proposal which causes an error, in which case the error is returned and the rest of proposals are not processed.

Errors

• ControllerNotSet if Controllers was not set.

Weight

500_000_000 + 7_000_000 * bridge_txs.len()

pub fn propose_bridge_tx( &self, bridge_tx: BridgeTx<AccountId> ) -> Result<WrappedCall>

Proposes a bridge transaction, which amounts to making a multisig proposal for the bridge transaction if the transaction is new or approving an existing proposal if the transaction has already been proposed.

Errors

• ControllerNotSet if Controllers was not set.

pub fn handle_bridge_tx( &self, bridge_tx: BridgeTx<AccountId> ) -> Result<WrappedCall>

Handles an approved bridge transaction proposal.

Errors

• BadCaller if origin is not Self::controller or Self::admin.
• TimelockedTx if the transaction status is Timelocked.
• ProposalAlreadyHandled if the transaction status is Handled.

pub fn freeze_txs( &self, bridge_txs: Vec<BridgeTx<AccountId>> ) -> Result<WrappedCall>

Freezes given bridge transactions. If any bridge txn is already handled then this function will just ignore it and process next one.

Errors

• BadAdmin if origin is not Self::admin() account.

Weight

400_000_000 + 2_000_000 * bridge_txs.len()

pub fn unfreeze_txs( &self, bridge_txs: Vec<BridgeTx<AccountId>> ) -> Result<WrappedCall>

Unfreezes given bridge transactions. If any bridge txn is already handled then this function will just ignore it and process next one.

Errors

• BadAdmin if origin is not Self::admin() account.

Weight

400_000_000 + 7_000_000 * bridge_txs.len()

pub fn handle_scheduled_bridge_tx( &self, bridge_tx: BridgeTx<AccountId> ) -> Result<WrappedCall>

Root callable extrinsic, used as an internal call to handle a scheduled timelocked bridge transaction.

Errors

• BadOrigin if origin is not root.
• ProposalAlreadyHandled if transaction status is Handled.
• FrozenTx if transaction status is Frozen.

pub fn add_freeze_admin(&self, freeze_admin: AccountId) -> Result<WrappedCall>

Add a freeze admin.

Errors

• BadAdmin if origin is not Self::admin() account.

pub fn remove_freeze_admin( &self, freeze_admin: AccountId ) -> Result<WrappedCall>

Remove a freeze admin.

Errors

• BadAdmin if origin is not Self::admin() account.

pub fn remove_txs( &self, bridge_txs: Vec<BridgeTx<AccountId>> ) -> Result<WrappedCall>

Remove given bridge transactions.

Errors

• BadAdmin if origin is not Self::admin() account.
• NotFrozen if a tx in bridge_txs is not frozen.

Trait Implementations

impl<'api> Clone for BridgeCallApi<'api>

fn clone(&self) -> BridgeCallApi<'api>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'api> From<&'api Api> for BridgeCallApi<'api>

fn from(api: &'api Api) -> Self

Converts to this type from the input type.