Function diem_sdk::transaction_builder::stdlib::encode_add_currency_to_account_script_function

pub fn encode_add_currency_to_account_script_function(
    currency: TypeTag
) -> TransactionPayload

Summary

Adds a zero Currency balance to the sending account. This will enable account to send, receive, and hold Diem::Diem<Currency> coins. This transaction can be successfully sent by any account that is allowed to hold balances (e.g., VASP, Designated Dealer).

Technical Description

After the successful execution of this transaction the sending account will have a DiemAccount::Balance<Currency> resource with zero balance published under it. Only accounts that can hold balances can send this transaction, the sending account cannot already have a DiemAccount::Balance<Currency> published under it.

Parameters

Name	Type	Description
Currency	Type	The Move type for the Currency being added to the sending account of the transaction. Currency must be an already-registered currency on-chain.
account	signer	The signer of the sending account of the transaction.

Common Abort Conditions

Error Category	Error Reason	Description
Errors::NOT_PUBLISHED	Diem::ECURRENCY_INFO	The Currency is not a registered currency on-chain.
Errors::INVALID_ARGUMENT	DiemAccount::EROLE_CANT_STORE_BALANCE	The sending account’s role does not permit balances.
Errors::ALREADY_PUBLISHED	DiemAccount::EADD_EXISTING_CURRENCY	A balance for Currency is already published under the sending account.

Related Scripts

• AccountCreationScripts::create_child_vasp_account
• AccountCreationScripts::create_parent_vasp_account
• PaymentScripts::peer_to_peer_with_metadata