Enum pallet_bitcoin_vaults::pallet::Call

pub enum Call<T: Config> {
    set_xpub {
        xpub: BoundedVec<u8, T::XPubLen>,
    },
    remove_xpub {},
    create_vault {
        threshold: u32,
        description: BoundedVec<u8, T::VaultDescriptionMaxLen>,
        include_owner_as_cosigner: bool,
        cosigners: BoundedVec<T::AccountId, T::MaxCosignersPerVault>,
    },
    remove_vault {
        vault_id: [u8; 32],
    },
    propose {
        vault_id: [u8; 32],
        recipient_address: BoundedVec<u8, T::XPubLen>,
        amount_in_sats: u64,
        description: BoundedVec<u8, T::VaultDescriptionMaxLen>,
    },
    remove_proposal {
        proposal_id: [u8; 32],
    },
    set_bdk_url {
        new_url: BoundedVec<u8, ConstU32<32>>,
    },
    save_psbt {
        proposal_id: [u8; 32],
        signature_payload: BoundedVec<u8, T::PSBTMaxLen>,
    },
    finalize_psbt {
        proposal_id: [u8; 32],
        broadcast: bool,
    },
    broadcast_psbt {
        proposal_id: [u8; 32],
    },
    create_proof {
        vault_id: [u8; 32],
        message: Description<T>,
        psbt: PSBT<T>,
    },
    save_proof_psbt {
        vault_id: [u8; 32],
        psbt: PSBT<T>,
    },
    finalize_proof {
        vault_id: [u8; 32],
        psbt: PSBT<T>,
    },
    kill_storage {},
    ocw_insert_descriptors {
        payload: VaultsPayload<T::Public>,
        signature: T::Signature,
    },
    ocw_insert_psbts {
        payload: ProposalsPayload<T::Public>,
        signature: T::Signature,
    },
    ocw_finalize_psbts {
        payload: ProposalsPayload<T::Public>,
        signature: T::Signature,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

set_xpub

Fields

xpub: BoundedVec<u8, T::XPubLen>

XPub insertion

This extrinsic inserts a user-defined xpub as well as in the pallet storage.

Parameters:

• xpub: Extended public key, it can be sent with or without fingerprint/derivation path

Considerations

• The origin must be Signed and the sender must have sufficient funds free for the transaction fee.
• This extrinsic cannot handle a xpub update (yet). if it needs to be updated, remove it first and insert a new one.

remove_xpub

Fields

Xpub removal

Removes the linked xpub from the account which signs the transaction. The xpub will be removed from both the pallet storage and identity registration.

This tx does not takes any parameters.

create_vault

Fields

threshold: u32

description: BoundedVec<u8, T::VaultDescriptionMaxLen>

include_owner_as_cosigner: bool

cosigners: BoundedVec<T::AccountId, T::MaxCosignersPerVault>

Vault insertion

Inserts the vault on chain. Meant to be used by an offchain worker.

Parameters:

• threshold: The number of signatures needed for a proposal to be approved/finalized
• description: A small definition. What will the vault be used for?
• include_owner_as_cosigner: Add automatically the owner as cosigner
• cosigners: The other accounts that will participate in vault proposals.

Considerations

• Do not include the vault owner on the cosigners list.

remove_vault

Fields

vault_id: [u8; 32]

Vault removal

Tries to remove vault and all its proposals, only the owner can call this extrinsic.

Parameters:

• vault_id: the vault to be removed with all its proposals

Considerations:

• Only the vault owner can perform this extrinsic

propose

Fields

vault_id: [u8; 32]

recipient_address: BoundedVec<u8, T::XPubLen>

amount_in_sats: u64

description: BoundedVec<u8, T::VaultDescriptionMaxLen>

Vault transaction proposal

Inserts a proposal on the specified vault.

Parameters:

• vault_id: the vault identifier in which the proposal will be inserted
• recipient_address: Mainnet address to which the funds will be send
• amount_in_sats: Amount to send in satoshis.
• description: The reason for the proposal, why do you are proposing this?.

Considerations

• Please ensure the recipient address is a valid mainnet address.

remove_proposal

Fields

proposal_id: [u8; 32]

Proposal removal

Tries to remove a specified proposal. Only the user who created the proposal can remove it.

Parameters:

• proposal_id: the proposal identifier

set_bdk_url

Fields

new_url: BoundedVec<u8, ConstU32<32>>

BDK URL insertion

Changes the BDK-services endpoint, useful for pointing to the btc mainnet or testnet

Parameters:

• new_url: The new endpoint to which all the bdk related requests will be sent.

Considerations

• Ensure the new url is valid.
• The url has a maximum length of 32 bytes

save_psbt

Fields

proposal_id: [u8; 32]

signature_payload: BoundedVec<u8, T::PSBTMaxLen>

PSBT signature insertion

Stores the signature for a PSBT proposal

Parameters:

• proposal_id: the proposal identifier
• signature_payload: a blob of psbt bytes, resulting from a external wallet

Considerations

• If successful, this process cannot be undone
• A user can only sign a proposal once

finalize_psbt

Fields

proposal_id: [u8; 32]

broadcast: bool

Finalize PSBT

Queries a proposal to be finalized generating a tx_id in the process, it can also be broadcasted if specified.

Parameters:

• proposal_id: the proposal identifier
• broadcast: A boolean flag

Considerations

• If successful, this process cannot be undone
• The proposal must have a valid PSBT
• Any vault member can perform this extrinsic

broadcast_psbt

Fields

proposal_id: [u8; 32]

Broadcast PSBT

Queries a proposal to be broadcasted in case it wasn’t on the finalization step.

Parameters:

• proposal_id: the vault identifier in which the proposal will be inserted

Considerations

• If successful, this process cannot be undone
• The proposal must be finalized already
• Any vault member can perform this extrinsic

create_proof

Fields

vault_id: [u8; 32]

message: Description<T>

psbt: PSBT<T>

Create Proof of Reserve

Stores a PoR for a defined vault.

Parameters:

• vault_id: the vault identifier in which the proof will be inserted
• message: the message to be taken into account to generate the PoR PSBT
• psbt: the psbt generated from bdk

Considerations:

• Any vault member can perform this extrinsic
• A vault can only have a PoR at a time.

save_proof_psbt

Fields

vault_id: [u8; 32]

psbt: PSBT<T>

Save Proof of reserve PSBT

Updates the PoR with a new PSBT

Parameters

• vault_id: the vault identifier in which the proof is
• psbt: the new psbt to insert, the signer will be linked to it.

Considerations:

• Any vault member can perform this extrinsic
• A vault signer can only sabe its PSBT once.

finalize_proof

Fields

vault_id: [u8; 32]

psbt: PSBT<T>

Finalize proof of reserve

Updates the PoR with the final PSBT

Parameters

• vault_id: the vault identifier in which the proof is
• psbt: the new psbt to insert, the signer will be linked to it.

Considerations:

• Any vault member can perform this extrinsic
• A vault signer can only sabe its PSBT once.

kill_storage

Fields

Kill almost all storage

Use with caution!

Can only be called by root and removes All vaults and proposals

ocw_insert_descriptors

Fields

payload: VaultsPayload<T::Public>

signature: T::Signature

Extrinsic to insert a valid vault descriptor

Meant to be unsigned with signed payload and used by an offchain worker

ocw_insert_psbts

Fields

payload: ProposalsPayload<T::Public>

signature: T::Signature

Extrinsic to insert a valid proposal PSBT

Meant to be unsigned with signed payload and used by an offchain worker

ocw_finalize_psbts

Fields

payload: ProposalsPayload<T::Public>

signature: T::Signature

Extrinsic to insert a valid proposal TX_ID

Meant to be unsigned with signed payload and used by an offchain worker

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_set_xpub(xpub: BoundedVec<u8, T::XPubLen>) -> Self

Create a call with the variant set_xpub.

pub fn new_call_variant_remove_xpub() -> Self

Create a call with the variant remove_xpub.

pub fn new_call_variant_create_vault( threshold: u32, description: BoundedVec<u8, T::VaultDescriptionMaxLen>, include_owner_as_cosigner: bool, cosigners: BoundedVec<T::AccountId, T::MaxCosignersPerVault> ) -> Self

Create a call with the variant create_vault.

pub fn new_call_variant_remove_vault(vault_id: [u8; 32]) -> Self

Create a call with the variant remove_vault.

pub fn new_call_variant_propose( vault_id: [u8; 32], recipient_address: BoundedVec<u8, T::XPubLen>, amount_in_sats: u64, description: BoundedVec<u8, T::VaultDescriptionMaxLen> ) -> Self

Create a call with the variant propose.

pub fn new_call_variant_remove_proposal(proposal_id: [u8; 32]) -> Self

Create a call with the variant remove_proposal.

pub fn new_call_variant_set_bdk_url( new_url: BoundedVec<u8, ConstU32<32>> ) -> Self

Create a call with the variant set_bdk_url.

pub fn new_call_variant_save_psbt( proposal_id: [u8; 32], signature_payload: BoundedVec<u8, T::PSBTMaxLen> ) -> Self

Create a call with the variant save_psbt.

pub fn new_call_variant_finalize_psbt( proposal_id: [u8; 32], broadcast: bool ) -> Self

Create a call with the variant finalize_psbt.

pub fn new_call_variant_broadcast_psbt(proposal_id: [u8; 32]) -> Self

Create a call with the variant broadcast_psbt.

pub fn new_call_variant_create_proof( vault_id: [u8; 32], message: Description<T>, psbt: PSBT<T> ) -> Self

Create a call with the variant create_proof.

pub fn new_call_variant_save_proof_psbt( vault_id: [u8; 32], psbt: PSBT<T> ) -> Self

Create a call with the variant save_proof_psbt.

pub fn new_call_variant_finalize_proof( vault_id: [u8; 32], psbt: PSBT<T> ) -> Self

Create a call with the variant finalize_proof.

pub fn new_call_variant_kill_storage() -> Self

Create a call with the variant kill_storage.

pub fn new_call_variant_ocw_insert_descriptors( payload: VaultsPayload<T::Public>, signature: T::Signature ) -> Self

Create a call with the variant ocw_insert_descriptors.

pub fn new_call_variant_ocw_insert_psbts( payload: ProposalsPayload<T::Public>, signature: T::Signature ) -> Self

Create a call with the variant ocw_insert_psbts.

pub fn new_call_variant_ocw_finalize_psbts( payload: ProposalsPayload<T::Public>, signature: T::Signature ) -> Self

Create a call with the variant ocw_finalize_psbts.

Trait Implementations

impl<T: Config> Clone for Call<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Config> Debug for Call<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names.

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

👎Deprecated: Trait has moved to frame_support::dispatch

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq<Call<T>> for Call<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> TypeInfo for Call<T>where PhantomData<(T,)>: TypeInfo + 'static, BoundedVec<u8, T::XPubLen>: TypeInfo + 'static, BoundedVec<u8, T::VaultDescriptionMaxLen>: TypeInfo + 'static, BoundedVec<T::AccountId, T::MaxCosignersPerVault>: TypeInfo + 'static, BoundedVec<u8, T::PSBTMaxLen>: TypeInfo + 'static, Description<T>: TypeInfo + 'static, PSBT<T>: TypeInfo + 'static, VaultsPayload<T::Public>: TypeInfo + 'static, T::Signature: TypeInfo + 'static, ProposalsPayload<T::Public>: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

fn dispatch_bypass_filter( self, origin: Self::RuntimeOrigin ) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike<Call<T>> for Call<T>

impl<T: Config> Eq for Call<T>