pub enum ScriptFunctionCall {
Show 42 variants AddCurrencyToAccount { currency: TypeTag, }, AddRecoveryRotationCapability { recovery_address: AccountAddress, }, AddValidatorAndReconfigure { sliding_nonce: u64, validator_name: Vec<u8, Global>, validator_address: AccountAddress, }, AddVaspDomain { address: AccountAddress, domain: Vec<u8, Global>, }, BurnTxnFees { coin_type: TypeTag, }, BurnWithAmount { token: TypeTag, sliding_nonce: u64, preburn_address: AccountAddress, amount: u64, }, CancelBurnWithAmount { token: TypeTag, preburn_address: AccountAddress, amount: u64, }, CreateChildVaspAccount { coin_type: TypeTag, child_address: AccountAddress, auth_key_prefix: Vec<u8, Global>, add_all_currencies: bool, child_initial_balance: u64, }, CreateDesignatedDealer { currency: TypeTag, sliding_nonce: u64, addr: AccountAddress, auth_key_prefix: Vec<u8, Global>, human_name: Vec<u8, Global>, add_all_currencies: bool, }, CreateParentVaspAccount { coin_type: TypeTag, sliding_nonce: u64, new_account_address: AccountAddress, auth_key_prefix: Vec<u8, Global>, human_name: Vec<u8, Global>, add_all_currencies: bool, }, CreateRecoveryAddress {}, CreateValidatorAccount { sliding_nonce: u64, new_account_address: AccountAddress, auth_key_prefix: Vec<u8, Global>, human_name: Vec<u8, Global>, }, CreateValidatorOperatorAccount { sliding_nonce: u64, new_account_address: AccountAddress, auth_key_prefix: Vec<u8, Global>, human_name: Vec<u8, Global>, }, CreateVaspDomains {}, ForceExpire { shift_amount: u64, }, FreezeAccount { sliding_nonce: u64, to_freeze_account: AccountAddress, }, InitializeDiemConsensusConfig { sliding_nonce: u64, }, OptInToCrsn { crsn_size: u64, }, PeerToPeerBySigners { currency: TypeTag, amount: u64, metadata: Vec<u8, Global>, }, PeerToPeerWithMetadata { currency: TypeTag, payee: AccountAddress, amount: u64, metadata: Vec<u8, Global>, metadata_signature: Vec<u8, Global>, }, Preburn { token: TypeTag, amount: u64, }, PublishSharedEd25519PublicKey { public_key: Vec<u8, Global>, }, RegisterValidatorConfig { validator_account: AccountAddress, consensus_pubkey: Vec<u8, Global>, validator_network_addresses: Vec<u8, Global>, fullnode_network_addresses: Vec<u8, Global>, }, RemoveValidatorAndReconfigure { sliding_nonce: u64, validator_name: Vec<u8, Global>, validator_address: AccountAddress, }, RemoveVaspDomain { address: AccountAddress, domain: Vec<u8, Global>, }, RotateAuthenticationKey { new_key: Vec<u8, Global>, }, RotateAuthenticationKeyWithNonce { sliding_nonce: u64, new_key: Vec<u8, Global>, }, RotateAuthenticationKeyWithNonceAdmin { sliding_nonce: u64, new_key: Vec<u8, Global>, }, RotateAuthenticationKeyWithRecoveryAddress { recovery_address: AccountAddress, to_recover: AccountAddress, new_key: Vec<u8, Global>, }, RotateDualAttestationInfo { new_url: Vec<u8, Global>, new_key: Vec<u8, Global>, }, RotateSharedEd25519PublicKey { public_key: Vec<u8, Global>, }, SetGasConstants { sliding_nonce: u64, global_memory_per_byte_cost: u64, global_memory_per_byte_write_cost: u64, min_transaction_gas_units: u64, large_transaction_cutoff: u64, intrinsic_gas_per_byte: u64, maximum_number_of_gas_units: u64, min_price_per_gas_unit: u64, max_price_per_gas_unit: u64, max_transaction_size_in_bytes: u64, gas_unit_scaling_factor: u64, default_account_size: u64, }, SetValidatorConfigAndReconfigure { validator_account: AccountAddress, consensus_pubkey: Vec<u8, Global>, validator_network_addresses: Vec<u8, Global>, fullnode_network_addresses: Vec<u8, Global>, }, SetValidatorOperator { operator_name: Vec<u8, Global>, operator_account: AccountAddress, }, SetValidatorOperatorWithNonceAdmin { sliding_nonce: u64, operator_name: Vec<u8, Global>, operator_account: AccountAddress, }, TieredMint { coin_type: TypeTag, sliding_nonce: u64, designated_dealer_address: AccountAddress, mint_amount: u64, tier_index: u64, }, UnfreezeAccount { sliding_nonce: u64, to_unfreeze_account: AccountAddress, }, UpdateDiemConsensusConfig { sliding_nonce: u64, config: Vec<u8, Global>, }, UpdateDiemVersion { sliding_nonce: u64, major: u64, }, UpdateDualAttestationLimit { sliding_nonce: u64, new_micro_xdx_limit: u64, }, UpdateExchangeRate { currency: TypeTag, sliding_nonce: u64, new_exchange_rate_numerator: u64, new_exchange_rate_denominator: u64, }, UpdateMintingAbility { currency: TypeTag, allow_minting: bool, },
}
Expand description

Structured representation of a call into a known Move script function.

impl ScriptFunctionCall {
    pub fn encode(self) -> TransactionPayload { .. }
    pub fn decode(&TransactionPayload) -> Option<ScriptFunctionCall> { .. }
}

Variants§

§

AddCurrencyToAccount

Fields

§currency: TypeTag

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

NameTypeDescription
CurrencyTypeThe Move type for the Currency being added to the sending account of the transaction. Currency must be an already-registered currency on-chain.
accountsignerThe signer of the sending account of the transaction.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Currency is not a registered currency on-chain.
Errors::INVALID_ARGUMENTDiemAccount::EROLE_CANT_STORE_BALANCEThe sending account’s role does not permit balances.
Errors::ALREADY_PUBLISHEDDiemAccount::EADD_EXISTING_CURRENCYA balance for Currency is already published under the sending account.
  • AccountCreationScripts::create_child_vasp_account
  • AccountCreationScripts::create_parent_vasp_account
  • PaymentScripts::peer_to_peer_with_metadata
§

AddRecoveryRotationCapability

Fields

§recovery_address: AccountAddress

Summary

Stores the sending accounts ability to rotate its authentication key with a designated recovery account. Both the sending and recovery accounts need to belong to the same VASP and both be VASP accounts. After this transaction both the sending account and the specified recovery account can rotate the sender account’s authentication key.

Technical Description

Adds the DiemAccount::KeyRotationCapability for the sending account (to_recover_account) to the RecoveryAddress::RecoveryAddress resource under recovery_address. After this transaction has been executed successfully the account at recovery_address and the to_recover_account may rotate the authentication key of to_recover_account (the sender of this transaction).

The sending account of this transaction (to_recover_account) must not have previously given away its unique key rotation capability, and must be a VASP account. The account at recovery_address must also be a VASP account belonging to the same VASP as the to_recover_account. Additionally the account at recovery_address must have already initialized itself as a recovery account address using the AccountAdministrationScripts::create_recovery_address transaction script.

The sending account’s (to_recover_account) key rotation capability is removed in this transaction and stored in the RecoveryAddress::RecoveryAddress resource stored under the account at recovery_address.

Parameters

NameTypeDescription
to_recover_accountsignerThe signer of the sending account of this transaction.
recovery_addressaddressThe account address where the to_recover_account’s DiemAccount::KeyRotationCapability will be stored.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDto_recover_account has already delegated/extracted its DiemAccount::KeyRotationCapability.
Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_address does not have a RecoveryAddress resource published under it.
Errors::INVALID_ARGUMENTRecoveryAddress::EINVALID_KEY_ROTATION_DELEGATIONto_recover_account and recovery_address do not belong to the same VASP.
Errors::LIMIT_EXCEEDED RecoveryAddress::EMAX_KEYS_REGISTEREDRecoveryAddress::MAX_REGISTERED_KEYS have already been registered with this recovery_address.
  • AccountAdministrationScripts::create_recovery_address
  • AccountAdministrationScripts::rotate_authentication_key_with_recovery_address
§

AddValidatorAndReconfigure

Fields

§sliding_nonce: u64
§validator_name: Vec<u8, Global>
§validator_address: AccountAddress

Summary

Adds a validator account to the validator set, and triggers a reconfiguration of the system to admit the account to the validator set for the system. This transaction can only be successfully called by the Diem Root account.

Technical Description

This script adds the account at validator_address to the validator set. This transaction emits a DiemConfig::NewEpochEvent event and triggers a reconfiguration. Once the reconfiguration triggered by this script’s execution has been performed, the account at the validator_address is considered to be a validator in the network.

This transaction script will fail if the validator_address address is already in the validator set or does not have a ValidatorConfig::ValidatorConfig resource already published under it.

Parameters

NameTypeDescription
dr_accountsignerThe signer of the sending account of this transaction. Must be the Diem Root signer.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
validator_namevector<u8>ASCII-encoded human name for the validator. Must match the human name in the ValidatorConfig::ValidatorConfig for the validator.
validator_addressaddressThe validator account address to be added to the validator set.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under dr_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTThe sending account is not the Diem Root account.
Errors::REQUIRES_ROLERoles::EDIEM_ROOTThe sending account is not the Diem Root account.
00The provided validator_name does not match the already-recorded human name for the validator.
Errors::INVALID_ARGUMENTDiemSystem::EINVALID_PROSPECTIVE_VALIDATORThe validator to be added does not have a ValidatorConfig::ValidatorConfig resource published under it, or its config field is empty.
Errors::INVALID_ARGUMENTDiemSystem::EALREADY_A_VALIDATORThe validator_address account is already a registered validator.
Errors::INVALID_STATEDiemConfig::EINVALID_BLOCK_TIMEAn invalid time value was encountered in reconfiguration. Unlikely to occur.
Errors::LIMIT_EXCEEDEDDiemSystem::EMAX_VALIDATORSThe validator set is already at its maximum size. The validator could not be added.
  • AccountCreationScripts::create_validator_account
  • AccountCreationScripts::create_validator_operator_account
  • ValidatorAdministrationScripts::register_validator_config
  • ValidatorAdministrationScripts::remove_validator_and_reconfigure
  • ValidatorAdministrationScripts::set_validator_operator
  • ValidatorAdministrationScripts::set_validator_operator_with_nonce_admin
  • ValidatorAdministrationScripts::set_validator_config_and_reconfigure
§

AddVaspDomain

Fields

§domain: Vec<u8, Global>

Summary

Add a VASP domain to parent VASP account. The transaction can only be sent by the Treasury Compliance account.

Technical Description

Adds a VASPDomain::VASPDomain to the domains field of the VASPDomain::VASPDomains resource published under the account at address.

Parameters

NameTypeDescription
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.
addressaddressThe address of the parent VASP account that will have have domain added to its domains.
domainvector<u8>The domain to be added.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_account is not the Treasury Compliance account.
Errors::NOT_PUBLISHEDVASPDomain::EVASP_DOMAIN_MANAGERThe VASPDomain::VASPDomainManager resource is not yet published under the Treasury Compliance account.
Errors::NOT_PUBLISHEDVASPDomain::EVASP_DOMAINS_NOT_PUBLISHEDaddress does not have a VASPDomain::VASPDomains resource published under it.
Errors::INVALID_ARGUMENTVASPDomain::EDOMAIN_ALREADY_EXISTSThe domain already exists in the list of VASPDomain::VASPDomains in the VASPDomain::VASPDomains resource published under address.
Errors::INVALID_ARGUMENTVASPDomain::EINVALID_VASP_DOMAINThe domain is greater in length than VASPDomain::DOMAIN_LENGTH.
§

BurnTxnFees

Fields

§coin_type: TypeTag

Summary

Burns the transaction fees collected in the CoinType currency so that the Diem association may reclaim the backing coins off-chain. May only be sent by the Treasury Compliance account.

Technical Description

Burns the transaction fees collected in CoinType so that the association may reclaim the backing coins. Once this transaction has executed successfully all transaction fees that will have been collected in CoinType since the last time this script was called with that specific currency. Both balance and preburn fields in the TransactionFee::TransactionFee<CoinType> resource published under the 0xB1E55ED account address will have a value of 0 after the successful execution of this script.

Events

The successful execution of this transaction will emit a Diem::BurnEvent on the event handle held in the Diem::CurrencyInfo<CoinType> resource’s burn_events published under 0xA550C18.

Parameters

NameTypeDescription
CoinTypeTypeThe Move type for the CoinType being added to the sending account of the transaction. CoinType must be an already-registered currency on-chain.
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
Errors::NOT_PUBLISHEDTransactionFee::ETRANSACTION_FEECoinType is not an accepted transaction fee currency.
Errors::INVALID_ARGUMENTDiem::ECOINThe collected fees in CoinType are zero.
  • TreasuryComplianceScripts::burn_with_amount
  • TreasuryComplianceScripts::cancel_burn_with_amount
§

BurnWithAmount

Fields

§token: TypeTag
§sliding_nonce: u64
§preburn_address: AccountAddress
§amount: u64

Summary

Burns the coins held in a preburn resource in the preburn queue at the specified preburn address, which are equal to the amount specified in the transaction. Finds the first relevant outstanding preburn request with matching amount and removes the contained coins from the system. The sending account must be the Treasury Compliance account. The account that holds the preburn queue resource will normally be a Designated Dealer, but there are no enforced requirements that it be one.

Technical Description

This transaction permanently destroys all the coins of Token type stored in the Diem::Preburn<Token> resource published under the preburn_address account address.

This transaction will only succeed if the sending account has a Diem::BurnCapability<Token>, and a Diem::Preburn<Token> resource exists under preburn_address, with a non-zero to_burn field. After the successful execution of this transaction the total_value field in the Diem::CurrencyInfo<Token> resource published under 0xA550C18 will be decremented by the value of the to_burn field of the preburn resource under preburn_address immediately before this transaction, and the to_burn field of the preburn resource will have a zero value.

Events

The successful execution of this transaction will emit a Diem::BurnEvent on the event handle held in the Diem::CurrencyInfo<Token> resource’s burn_events published under 0xA550C18.

Parameters

NameTypeDescription
TokenTypeThe Move type for the Token currency being burned. Token must be an already-registered currency on-chain.
tc_accountsignerThe signer of the sending account of this transaction, must have a burn capability for Token published under it.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
preburn_addressaddressThe address where the coins to-be-burned are currently held.
amountu64The amount to be burned.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending account does not have a Diem::BurnCapability<Token> published under it.
Errors::INVALID_STATEDiem::EPREBURN_NOT_FOUNDThe Diem::PreburnQueue<Token> resource under preburn_address does not contain a preburn request with a value matching amount.
Errors::NOT_PUBLISHEDDiem::EPREBURN_QUEUEThe account at preburn_address does not have a Diem::PreburnQueue<Token> resource published under it.
Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Token is not a registered currency on-chain.
  • TreasuryComplianceScripts::burn_txn_fees
  • TreasuryComplianceScripts::cancel_burn_with_amount
  • TreasuryComplianceScripts::preburn
§

CancelBurnWithAmount

Fields

§token: TypeTag
§preburn_address: AccountAddress
§amount: u64

Summary

Cancels and returns the coins held in the preburn area under preburn_address, which are equal to the amount specified in the transaction. Finds the first preburn resource with the matching amount and returns the funds to the preburn_address’s balance. Can only be successfully sent by an account with Treasury Compliance role.

Technical Description

Cancels and returns all coins held in the Diem::Preburn<Token> resource under the preburn_address and return the funds to the preburn_address account’s DiemAccount::Balance<Token>. The transaction must be sent by an account with a Diem::BurnCapability<Token> resource published under it. The account at preburn_address must have a Diem::Preburn<Token> resource published under it, and its value must be nonzero. The transaction removes the entire balance held in the Diem::Preburn<Token> resource, and returns it back to the account’s DiemAccount::Balance<Token> under preburn_address. Due to this, the account at preburn_address must already have a balance in the Token currency published before this script is called otherwise the transaction will fail.

Events

The successful execution of this transaction will emit:

  • A Diem::CancelBurnEvent on the event handle held in the Diem::CurrencyInfo<Token> resource’s burn_events published under 0xA550C18.
  • A DiemAccount::ReceivedPaymentEvent on the preburn_address’s DiemAccount::DiemAccount received_events event handle with both the payer and payee being preburn_address.

Parameters

NameTypeDescription
TokenTypeThe Move type for the Token currenty that burning is being cancelled for. Token must be an already-registered currency on-chain.
accountsignerThe signer of the sending account of this transaction, must have a burn capability for Token published under it.
preburn_addressaddressThe address where the coins to-be-burned are currently held.
amountu64The amount to be cancelled.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending account does not have a Diem::BurnCapability<Token> published under it.
Errors::INVALID_STATEDiem::EPREBURN_NOT_FOUNDThe Diem::PreburnQueue<Token> resource under preburn_address does not contain a preburn request with a value matching amount.
Errors::NOT_PUBLISHEDDiem::EPREBURN_QUEUEThe account at preburn_address does not have a Diem::PreburnQueue<Token> resource published under it.
Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Token is not a registered currency on-chain.
Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEThe account at preburn_address doesn’t have a balance resource for Token.
Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSThe depositing of the funds held in the prebun area would exceed the account’s account limits.
Errors::INVALID_STATEDualAttestation::EPAYEE_COMPLIANCE_KEY_NOT_SETThe account does not have a compliance key set on it but dual attestion checking was performed.
  • TreasuryComplianceScripts::burn_txn_fees
  • TreasuryComplianceScripts::burn_with_amount
  • TreasuryComplianceScripts::preburn
§

CreateChildVaspAccount

Fields

§coin_type: TypeTag
§child_address: AccountAddress
§auth_key_prefix: Vec<u8, Global>
§add_all_currencies: bool
§child_initial_balance: u64

Summary

Creates a Child VASP account with its parent being the sending account of the transaction. The sender of the transaction must be a Parent VASP account.

Technical Description

Creates a ChildVASP account for the sender parent_vasp at child_address with a balance of child_initial_balance in CoinType and an initial authentication key of auth_key_prefix | child_address. Authentication key prefixes, and how to construct them from an ed25519 public key is described here.

If add_all_currencies is true, the child address will have a zero balance in all available currencies in the system.

The new account will be a child account of the transaction sender, which must be a Parent VASP account. The child account will be recorded against the limit of child accounts of the creating Parent VASP account.

Events

Successful execution will emit:

  • A DiemAccount::CreateAccountEvent with the created field being child_address, and the rold_id field being Roles::CHILD_VASP_ROLE_ID. This is emitted on the DiemAccount::AccountOperationsCapability creation_events handle.

Successful execution with a child_initial_balance greater than zero will additionaly emit:

  • A DiemAccount::SentPaymentEvent with the payee field being child_address. This is emitted on the Parent VASP’s DiemAccount::DiemAccount sent_events handle.
  • A DiemAccount::ReceivedPaymentEvent with the payer field being the Parent VASP’s address. This is emitted on the new Child VASPS’s DiemAccount::DiemAccount received_events handle.

Parameters

NameTypeDescription
CoinTypeTypeThe Move type for the CoinType that the child account should be created with. CoinType must be an already-registered currency on-chain.
parent_vaspsignerThe reference of the sending account. Must be a Parent VASP account.
child_addressaddressAddress of the to-be-created Child VASP account.
auth_key_prefixvector<u8>The authentication key prefix that will be used initially for the newly created account.
add_all_currenciesboolWhether to publish balance resources for all known currencies when the account is created.
child_initial_balanceu64The initial balance in CoinType to give the child account when it’s created.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYThe auth_key_prefix was not of length 32.
Errors::REQUIRES_ROLERoles::EPARENT_VASPThe sending account wasn’t a Parent VASP account.
Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe child_address address is already taken.
Errors::LIMIT_EXCEEDEDVASP::ETOO_MANY_CHILDRENThe sending account has reached the maximum number of allowed child accounts.
Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe CoinType is not a registered currency on-chain.
Errors::INVALID_STATEDiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTEDThe withdrawal capability for the sending account has already been extracted.
Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYThe sending account doesn’t have a balance in CoinType.
Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEThe sending account doesn’t have at least child_initial_balance of CoinType balance.
Errors::INVALID_ARGUMENTDiemAccount::ECANNOT_CREATE_AT_VM_RESERVEDThe child_address is the reserved address 0x0.
  • AccountCreationScripts::create_parent_vasp_account
  • AccountAdministrationScripts::add_currency_to_account
  • AccountAdministrationScripts::rotate_authentication_key
  • AccountAdministrationScripts::add_recovery_rotation_capability
  • AccountAdministrationScripts::create_recovery_address
§

CreateDesignatedDealer

Fields

§currency: TypeTag
§sliding_nonce: u64
§auth_key_prefix: Vec<u8, Global>
§human_name: Vec<u8, Global>
§add_all_currencies: bool

Summary

Creates a Designated Dealer account with the provided information, and initializes it with default mint tiers. The transaction can only be sent by the Treasury Compliance account.

Technical Description

Creates an account with the Designated Dealer role at addr with authentication key auth_key_prefix | addr and a 0 balance of type Currency. If add_all_currencies is true, 0 balances for all available currencies in the system will also be added. This can only be invoked by an account with the TreasuryCompliance role. Authentication keys, prefixes, and how to construct them from an ed25519 public key are described here.

At the time of creation the account is also initialized with default mint tiers of (500_000, 5000_000, 50_000_000, 500_000_000), and preburn areas for each currency that is added to the account.

Events

Successful execution will emit:

  • A DiemAccount::CreateAccountEvent with the created field being addr, and the rold_id field being Roles::DESIGNATED_DEALER_ROLE_ID. This is emitted on the DiemAccount::AccountOperationsCapability creation_events handle.

Parameters

NameTypeDescription
CurrencyTypeThe Move type for the Currency that the Designated Dealer should be initialized with. Currency must be an already-registered currency on-chain.
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
addraddressAddress of the to-be-created Designated Dealer account.
auth_key_prefixvector<u8>The authentication key prefix that will be used initially for the newly created account.
human_namevector<u8>ASCII-encoded human name for the Designated Dealer.
add_all_currenciesboolWhether to publish preburn, balance, and tier info resources for all known (SCS) currencies or just Currency when the account is created.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under tc_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Currency is not a registered currency on-chain.
Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe addr address is already taken.
  • TreasuryComplianceScripts::tiered_mint
  • PaymentScripts::peer_to_peer_with_metadata
  • AccountAdministrationScripts::rotate_dual_attestation_info
§

CreateParentVaspAccount

Fields

§coin_type: TypeTag
§sliding_nonce: u64
§new_account_address: AccountAddress
§auth_key_prefix: Vec<u8, Global>
§human_name: Vec<u8, Global>
§add_all_currencies: bool

Summary

Creates a Parent VASP account with the specified human name. Must be called by the Treasury Compliance account.

Technical Description

Creates an account with the Parent VASP role at address with authentication key auth_key_prefix | new_account_address and a 0 balance of type CoinType. If add_all_currencies is true, 0 balances for all available currencies in the system will also be added. This can only be invoked by an TreasuryCompliance account. sliding_nonce is a unique nonce for operation, see SlidingNonce for details. Authentication keys, prefixes, and how to construct them from an ed25519 public key are described here.

Events

Successful execution will emit:

  • A DiemAccount::CreateAccountEvent with the created field being new_account_address, and the rold_id field being Roles::PARENT_VASP_ROLE_ID. This is emitted on the DiemAccount::AccountOperationsCapability creation_events handle.

Parameters

NameTypeDescription
CoinTypeTypeThe Move type for the CoinType currency that the Parent VASP account should be initialized with. CoinType must be an already-registered currency on-chain.
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
new_account_addressaddressAddress of the to-be-created Parent VASP account.
auth_key_prefixvector<u8>The authentication key prefix that will be used initially for the newly created account.
human_namevector<u8>ASCII-encoded human name for the Parent VASP.
add_all_currenciesboolWhether to publish balance resources for all known currencies when the account is created.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under tc_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe CoinType is not a registered currency on-chain.
Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe new_account_address address is already taken.
  • AccountCreationScripts::create_child_vasp_account
  • AccountAdministrationScripts::add_currency_to_account
  • AccountAdministrationScripts::rotate_authentication_key
  • AccountAdministrationScripts::add_recovery_rotation_capability
  • AccountAdministrationScripts::create_recovery_address
  • AccountAdministrationScripts::rotate_dual_attestation_info
§

CreateRecoveryAddress

Fields

Summary

Initializes the sending account as a recovery address that may be used by other accounts belonging to the same VASP as account. The sending account must be a VASP account, and can be either a child or parent VASP account. Multiple recovery addresses can exist for a single VASP, but accounts in each must be disjoint.

Technical Description

Publishes a RecoveryAddress::RecoveryAddress resource under account. It then extracts the DiemAccount::KeyRotationCapability for account and adds it to the resource. After the successful execution of this transaction other accounts may add their key rotation to this resource so that account may be used as a recovery account for those accounts.

Parameters

NameTypeDescription
accountsignerThe signer of the sending account of the transaction.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccount has already delegated/extracted its DiemAccount::KeyRotationCapability.
Errors::INVALID_ARGUMENTRecoveryAddress::ENOT_A_VASPaccount is not a VASP account.
Errors::INVALID_ARGUMENTRecoveryAddress::EKEY_ROTATION_DEPENDENCY_CYCLEA key rotation recovery cycle would be created by adding account’s key rotation capability.
Errors::ALREADY_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSA RecoveryAddress::RecoveryAddress resource has already been published under account.
  • Script::add_recovery_rotation_capability
  • Script::rotate_authentication_key_with_recovery_address
§

CreateValidatorAccount

Fields

§sliding_nonce: u64
§new_account_address: AccountAddress
§auth_key_prefix: Vec<u8, Global>
§human_name: Vec<u8, Global>

Summary

Creates a Validator account. This transaction can only be sent by the Diem Root account.

Technical Description

Creates an account with a Validator role at new_account_address, with authentication key auth_key_prefix | new_account_address. It publishes a ValidatorConfig::ValidatorConfig resource with empty config, and operator_account fields. The human_name field of the ValidatorConfig::ValidatorConfig is set to the passed in human_name. This script does not add the validator to the validator set or the system, but only creates the account. Authentication keys, prefixes, and how to construct them from an ed25519 public key are described here.

Events

Successful execution will emit:

  • A DiemAccount::CreateAccountEvent with the created field being new_account_address, and the rold_id field being Roles::VALIDATOR_ROLE_ID. This is emitted on the DiemAccount::AccountOperationsCapability creation_events handle.

Parameters

NameTypeDescription
dr_accountsignerThe signer of the sending account of this transaction. Must be the Diem Root signer.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
new_account_addressaddressAddress of the to-be-created Validator account.
auth_key_prefixvector<u8>The authentication key prefix that will be used initially for the newly created account.
human_namevector<u8>ASCII-encoded human name for the validator.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under dr_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTThe sending account is not the Diem Root account.
Errors::REQUIRES_ROLERoles::EDIEM_ROOTThe sending account is not the Diem Root account.
Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe new_account_address address is already taken.
  • AccountCreationScripts::create_validator_operator_account
  • ValidatorAdministrationScripts::add_validator_and_reconfigure
  • ValidatorAdministrationScripts::register_validator_config
  • ValidatorAdministrationScripts::remove_validator_and_reconfigure
  • ValidatorAdministrationScripts::set_validator_operator
  • ValidatorAdministrationScripts::set_validator_operator_with_nonce_admin
  • ValidatorAdministrationScripts::set_validator_config_and_reconfigure
§

CreateValidatorOperatorAccount

Fields

§sliding_nonce: u64
§new_account_address: AccountAddress
§auth_key_prefix: Vec<u8, Global>
§human_name: Vec<u8, Global>

Summary

Creates a Validator Operator account. This transaction can only be sent by the Diem Root account.

Technical Description

Creates an account with a Validator Operator role at new_account_address, with authentication key auth_key_prefix | new_account_address. It publishes a ValidatorOperatorConfig::ValidatorOperatorConfig resource with the specified human_name. This script does not assign the validator operator to any validator accounts but only creates the account. Authentication key prefixes, and how to construct them from an ed25519 public key are described here.

Events

Successful execution will emit:

  • A DiemAccount::CreateAccountEvent with the created field being new_account_address, and the rold_id field being Roles::VALIDATOR_OPERATOR_ROLE_ID. This is emitted on the DiemAccount::AccountOperationsCapability creation_events handle.

Parameters

NameTypeDescription
dr_accountsignerThe signer of the sending account of this transaction. Must be the Diem Root signer.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
new_account_addressaddressAddress of the to-be-created Validator account.
auth_key_prefixvector<u8>The authentication key prefix that will be used initially for the newly created account.
human_namevector<u8>ASCII-encoded human name for the validator.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under dr_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTThe sending account is not the Diem Root account.
Errors::REQUIRES_ROLERoles::EDIEM_ROOTThe sending account is not the Diem Root account.
Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe new_account_address address is already taken.
  • AccountCreationScripts::create_validator_account
  • ValidatorAdministrationScripts::add_validator_and_reconfigure
  • ValidatorAdministrationScripts::register_validator_config
  • ValidatorAdministrationScripts::remove_validator_and_reconfigure
  • ValidatorAdministrationScripts::set_validator_operator
  • ValidatorAdministrationScripts::set_validator_operator_with_nonce_admin
  • ValidatorAdministrationScripts::set_validator_config_and_reconfigure
§

CreateVaspDomains

Fields

Summary

Publishes a VASPDomain::VASPDomains resource under a parent VASP account. The sending account must be a parent VASP account.

Technical Description

Publishes a VASPDomain::VASPDomains resource under account. The The VASPDomain::VASPDomains resource’s domains field is a vector of VASPDomain, and will be empty on at the end of processing this transaction.

Parameters

NameTypeDescription
accountsignerThe signer of the sending account of the transaction.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::ALREADY_PUBLISHEDVASPDomain::EVASP_DOMAINSA VASPDomain::VASPDomains resource has already been published under account.
Errors::REQUIRES_ROLERoles::EPARENT_VASPThe sending account was not a parent VASP account.
§

ForceExpire

Fields

§shift_amount: u64

Summary

Shifts the window held by the CRSN resource published under account by shift_amount. This will expire all unused slots in the CRSN at the time of processing that are less than shift_amount. The exact semantics are defined in DIP-168.

Technical Description

This shifts the slots in the published CRSN::CRSN resource under account by shift_amount, and increments the CRSN’s min_nonce field by shift_amount as well. After this, it will shift the window over any set bits. It is important to note that the sequence nonce of the sending transaction must still lie within the range of the window in order for this transaction to be processed successfully.

Parameters

NameTypeDescription
accountsignerThe signer of the sending account of the transaction.
shift_amountu64The amount to shift the window in the CRSN under account.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::INVALID_STATECRSN::ENO_CRSNA CRSN::CRSN resource is not published under account.
§

FreezeAccount

Fields

§sliding_nonce: u64
§to_freeze_account: AccountAddress

Summary

Freezes the account at address. The sending account of this transaction must be the Treasury Compliance account. The account being frozen cannot be the Diem Root or Treasury Compliance account. After the successful execution of this transaction no transactions may be sent from the frozen account, and the frozen account may not send or receive coins.

Technical Description

Sets the AccountFreezing::FreezingBit to true and emits a AccountFreezing::FreezeAccountEvent. The transaction sender must be the Treasury Compliance account, but the account at to_freeze_account must not be either 0xA550C18 (the Diem Root address), or 0xB1E55ED (the Treasury Compliance address). Note that this is a per-account property e.g., freezing a Parent VASP will not effect the status any of its child accounts and vice versa.

Events

Successful execution of this transaction will emit a AccountFreezing::FreezeAccountEvent on the freeze_event_handle held in the AccountFreezing::FreezeEventsHolder resource published under 0xA550C18 with the frozen_address being the to_freeze_account.

Parameters

NameTypeDescription
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
to_freeze_accountaddressThe account address to be frozen.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under tc_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
Errors::INVALID_ARGUMENTAccountFreezing::ECANNOT_FREEZE_TCto_freeze_account was the Treasury Compliance account (0xB1E55ED).
Errors::INVALID_ARGUMENTAccountFreezing::ECANNOT_FREEZE_DIEM_ROOTto_freeze_account was the Diem Root account (0xA550C18).
  • TreasuryComplianceScripts::unfreeze_account
§

InitializeDiemConsensusConfig

Fields

§sliding_nonce: u64

Summary

Initializes the Diem consensus config that is stored on-chain. This transaction can only be sent from the Diem Root account.

Technical Description

Initializes the DiemConsensusConfig on-chain config to empty and allows future updates from DiemRoot via update_diem_consensus_config. This doesn’t emit a DiemConfig::NewEpochEvent.

Parameters

NameTypeDescription
accountsignerSigner of the sending account. Must be the Diem Root account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccount is not the Diem Root account.
§

OptInToCrsn

Fields

§crsn_size: u64

Summary

Publishes a CRSN resource under account and opts the account in to concurrent transaction processing. Upon successful execution of this script, all further transactions sent from this account will be ordered and processed according to DIP-168.

Technical Description

This publishes a CRSN::CRSN resource under account with crsn_size number of slots. All slots will be initialized to the empty (unused) state, and the CRSN resource’s min_nonce field will be set to the transaction’s sequence number + 1.

Parameters

NameTypeDescription
accountsignerThe signer of the sending account of the transaction.
crsn_sizeu64The the number of slots the published CRSN will have.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::INVALID_STATECRSN::EHAS_CRSNA CRSN::CRSN resource was already published under account.
Errors::INVALID_ARGUMENTCRSN::EZERO_SIZE_CRSNThe crsn_size was zero.
§

PeerToPeerBySigners

Fields

§currency: TypeTag
§amount: u64
§metadata: Vec<u8, Global>

Summary

Transfers a given number of coins in a specified currency from one account to another by multi-agent transaction. Transfers over a specified amount defined on-chain that are between two different VASPs, or other accounts that have opted-in will be subject to on-chain checks to ensure the receiver has agreed to receive the coins. This transaction can be sent by any account that can hold a balance, and to any account that can hold a balance. Both accounts must hold balances in the currency being transacted.

Technical Description

Transfers amount coins of type Currency from payer to payee with (optional) associated metadata. Dual attestation is not applied to this script as payee is also a signer of the transaction. Standardized metadata BCS format can be found in diem_types::transaction::metadata::Metadata.

Events

Successful execution of this script emits two events:

  • A DiemAccount::SentPaymentEvent on payer’s DiemAccount::DiemAccount sent_events handle; and
  • A DiemAccount::ReceivedPaymentEvent on payee’s DiemAccount::DiemAccount received_events handle.

Parameters

NameTypeDescription
CurrencyTypeThe Move type for the Currency being sent in this transaction. Currency must be an already-registered currency on-chain.
payersignerThe signer of the sending account that coins are being transferred from.
payeesignerThe signer of the receiving account that the coins are being transferred to.
metadatavector<u8>Optional metadata about this payment.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYpayer doesn’t hold a balance in Currency.
Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamount is greater than payer’s balance in Currency.
Errors::INVALID_ARGUMENTDiemAccount::ECOIN_DEPOSIT_IS_ZEROamount is zero.
Errors::NOT_PUBLISHEDDiemAccount::EPAYEE_DOES_NOT_EXISTNo account exists at the payee address.
Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEAn account exists at payee, but it does not accept payments in Currency.
Errors::INVALID_STATEAccountFreezing::EACCOUNT_FROZENThe payee account is frozen.
Errors::LIMIT_EXCEEDEDDiemAccount::EWITHDRAWAL_EXCEEDS_LIMITSpayer has exceeded its daily withdrawal limits for the backing coins of XDX.
Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSpayee has exceeded its daily deposit limits for XDX.
  • AccountCreationScripts::create_child_vasp_account
  • AccountCreationScripts::create_parent_vasp_account
  • AccountAdministrationScripts::add_currency_to_account
  • PaymentScripts::peer_to_peer_with_metadata
§

PeerToPeerWithMetadata

Fields

§currency: TypeTag
§amount: u64
§metadata: Vec<u8, Global>
§metadata_signature: Vec<u8, Global>

Summary

Transfers a given number of coins in a specified currency from one account to another. Transfers over a specified amount defined on-chain that are between two different VASPs, or other accounts that have opted-in will be subject to on-chain checks to ensure the receiver has agreed to receive the coins. This transaction can be sent by any account that can hold a balance, and to any account that can hold a balance. Both accounts must hold balances in the currency being transacted.

Technical Description

Transfers amount coins of type Currency from payer to payee with (optional) associated metadata and an (optional) metadata_signature on the message of the form metadata | Signer::address_of(payer) | amount | DualAttestation::DOMAIN_SEPARATOR, that has been signed by the payee’s private key associated with the compliance_public_key held in the payee’s DualAttestation::Credential. Both the Signer::address_of(payer) and amount fields in the metadata_signature must be BCS-encoded bytes, and | denotes concatenation. The metadata and metadata_signature parameters are only required if amount >= DualAttestation::get_cur_microdiem_limit XDX and payer and payee are distinct VASPs. However, a transaction sender can opt in to dual attestation even when it is not required (e.g., a DesignatedDealer -> VASP payment) by providing a non-empty metadata_signature. Standardized metadata BCS format can be found in diem_types::transaction::metadata::Metadata.

Events

Successful execution of this script emits two events:

  • A DiemAccount::SentPaymentEvent on payer’s DiemAccount::DiemAccount sent_events handle; and
  • A DiemAccount::ReceivedPaymentEvent on payee’s DiemAccount::DiemAccount received_events handle.

Parameters

NameTypeDescription
CurrencyTypeThe Move type for the Currency being sent in this transaction. Currency must be an already-registered currency on-chain.
payersignerThe signer of the sending account that coins are being transferred from.
payeeaddressThe address of the account the coins are being transferred to.
metadatavector<u8>Optional metadata about this payment.
metadata_signaturevector<u8>Optional signature over metadata and payment information. See

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYpayer doesn’t hold a balance in Currency.
Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamount is greater than payer’s balance in Currency.
Errors::INVALID_ARGUMENTDiemAccount::ECOIN_DEPOSIT_IS_ZEROamount is zero.
Errors::NOT_PUBLISHEDDiemAccount::EPAYEE_DOES_NOT_EXISTNo account exists at the payee address.
Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEAn account exists at payee, but it does not accept payments in Currency.
Errors::INVALID_STATEAccountFreezing::EACCOUNT_FROZENThe payee account is frozen.
Errors::INVALID_ARGUMENTDualAttestation::EMALFORMED_METADATA_SIGNATUREmetadata_signature is not 64 bytes.
Errors::INVALID_ARGUMENTDualAttestation::EINVALID_METADATA_SIGNATUREmetadata_signature does not verify on the against the payee's DualAttestation::Credential compliance_public_key public key.
Errors::LIMIT_EXCEEDEDDiemAccount::EWITHDRAWAL_EXCEEDS_LIMITSpayer has exceeded its daily withdrawal limits for the backing coins of XDX.
Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSpayee has exceeded its daily deposit limits for XDX.
  • AccountCreationScripts::create_child_vasp_account
  • AccountCreationScripts::create_parent_vasp_account
  • AccountAdministrationScripts::add_currency_to_account
  • PaymentScripts::peer_to_peer_by_signers
§

Preburn

Fields

§token: TypeTag
§amount: u64

Summary

Moves a specified number of coins in a given currency from the account’s balance to its preburn area after which the coins may be burned. This transaction may be sent by any account that holds a balance and preburn area in the specified currency.

Technical Description

Moves the specified amount of coins in Token currency from the sending account’s DiemAccount::Balance<Token> to the Diem::Preburn<Token> published under the same account. account must have both of these resources published under it at the start of this transaction in order for it to execute successfully.

Events

Successful execution of this script emits two events:

  • DiemAccount::SentPaymentEvent on account’s DiemAccount::DiemAccount sent_events handle with the payee and payer fields being account’s address; and
  • A Diem::PreburnEvent with Token’s currency code on the Diem::CurrencyInfo<Token’s preburn_events handle for Token and with preburn_address set to account’s address.

Parameters

NameTypeDescription
TokenTypeThe Move type for the Token currency being moved to the preburn area. Token must be an already-registered currency on-chain.
accountsignerThe signer of the sending account.
amountu64The amount in Token to be moved to the preburn area.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Token is not a registered currency on-chain.
Errors::INVALID_STATEDiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTEDThe withdrawal capability for account has already been extracted.
Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamount is greater than payer’s balance in Token.
Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYaccount doesn’t hold a balance in Token.
Errors::NOT_PUBLISHEDDiem::EPREBURNaccount doesn’t have a Diem::Preburn<Token> resource published under it.
Errors::INVALID_STATEDiem::EPREBURN_OCCUPIEDThe value field in the Diem::Preburn<Token> resource under the sender is non-zero.
Errors::NOT_PUBLISHEDRoles::EROLE_IDThe account did not have a role assigned to it.
Errors::REQUIRES_ROLERoles::EDESIGNATED_DEALERThe account did not have the role of DesignatedDealer.
  • TreasuryComplianceScripts::cancel_burn_with_amount
  • TreasuryComplianceScripts::burn_with_amount
  • TreasuryComplianceScripts::burn_txn_fees
§

PublishSharedEd25519PublicKey

Fields

§public_key: Vec<u8, Global>

Summary

Rotates the authentication key of the sending account to the newly-specified ed25519 public key and publishes a new shared authentication key derived from that public key under the sender’s account. Any account can send this transaction.

Technical Description

Rotates the authentication key of the sending account to the authentication key derived from public_key and publishes a SharedEd25519PublicKey::SharedEd25519PublicKey resource containing the 32-byte ed25519 public_key and the DiemAccount::KeyRotationCapability for account under account.

Parameters

NameTypeDescription
accountsignerThe signer of the sending account of the transaction.
public_keyvector<u8>A valid 32-byte Ed25519 public key for account’s authentication key to be rotated to and stored.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccount has already delegated/extracted its DiemAccount::KeyRotationCapability resource.
Errors::ALREADY_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYThe SharedEd25519PublicKey::SharedEd25519PublicKey resource is already published under account.
Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_key is an invalid ed25519 public key.
  • AccountAdministrationScripts::rotate_shared_ed25519_public_key
§

RegisterValidatorConfig

Fields

§validator_account: AccountAddress
§consensus_pubkey: Vec<u8, Global>
§validator_network_addresses: Vec<u8, Global>
§fullnode_network_addresses: Vec<u8, Global>

Summary

Updates a validator’s configuration. This does not reconfigure the system and will not update the configuration in the validator set that is seen by other validators in the network. Can only be successfully sent by a Validator Operator account that is already registered with a validator.

Technical Description

This updates the fields with corresponding names held in the ValidatorConfig::ValidatorConfig config resource held under validator_account. It does not emit a DiemConfig::NewEpochEvent so the copy of this config held in the validator set will not be updated, and the changes are only “locally” under the validator_account account address.

Parameters

NameTypeDescription
validator_operator_accountsignerSigner of the sending account. Must be the registered validator operator for the validator at validator_address.
validator_accountaddressThe address of the validator’s ValidatorConfig::ValidatorConfig resource being updated.
consensus_pubkeyvector<u8>New Ed25519 public key to be used in the updated ValidatorConfig::ValidatorConfig.
validator_network_addressesvector<u8>New set of validator_network_addresses to be used in the updated ValidatorConfig::ValidatorConfig.
fullnode_network_addressesvector<u8>New set of fullnode_network_addresses to be used in the updated ValidatorConfig::ValidatorConfig.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_address does not have a ValidatorConfig::ValidatorConfig resource published under it.
Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_account is not the registered operator for the validator at validator_address.
Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkey is not a valid ed25519 public key.
  • AccountCreationScripts::create_validator_account
  • AccountCreationScripts::create_validator_operator_account
  • ValidatorAdministrationScripts::add_validator_and_reconfigure
  • ValidatorAdministrationScripts::remove_validator_and_reconfigure
  • ValidatorAdministrationScripts::set_validator_operator
  • ValidatorAdministrationScripts::set_validator_operator_with_nonce_admin
  • ValidatorAdministrationScripts::set_validator_config_and_reconfigure
§

RemoveValidatorAndReconfigure

Fields

§sliding_nonce: u64
§validator_name: Vec<u8, Global>
§validator_address: AccountAddress

Summary

This script removes a validator account from the validator set, and triggers a reconfiguration of the system to remove the validator from the system. This transaction can only be successfully called by the Diem Root account.

Technical Description

This script removes the account at validator_address from the validator set. This transaction emits a DiemConfig::NewEpochEvent event. Once the reconfiguration triggered by this event has been performed, the account at validator_address is no longer considered to be a validator in the network. This transaction will fail if the validator at validator_address is not in the validator set.

Parameters

NameTypeDescription
dr_accountsignerThe signer of the sending account of this transaction. Must be the Diem Root signer.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
validator_namevector<u8>ASCII-encoded human name for the validator. Must match the human name in the ValidatorConfig::ValidatorConfig for the validator.
validator_addressaddressThe validator account address to be removed from the validator set.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under dr_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEThe sending account is not the Diem Root account or Treasury Compliance account
00The provided validator_name does not match the already-recorded human name for the validator.
Errors::INVALID_ARGUMENTDiemSystem::ENOT_AN_ACTIVE_VALIDATORThe validator to be removed is not in the validator set.
Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTThe sending account is not the Diem Root account.
Errors::REQUIRES_ROLERoles::EDIEM_ROOTThe sending account is not the Diem Root account.
Errors::INVALID_STATEDiemConfig::EINVALID_BLOCK_TIMEAn invalid time value was encountered in reconfiguration. Unlikely to occur.
  • AccountCreationScripts::create_validator_account
  • AccountCreationScripts::create_validator_operator_account
  • ValidatorAdministrationScripts::register_validator_config
  • ValidatorAdministrationScripts::add_validator_and_reconfigure
  • ValidatorAdministrationScripts::set_validator_operator
  • ValidatorAdministrationScripts::set_validator_operator_with_nonce_admin
  • ValidatorAdministrationScripts::set_validator_config_and_reconfigure
§

RemoveVaspDomain

Fields

§domain: Vec<u8, Global>

Summary

Remove a VASP domain from parent VASP account. The transaction can only be sent by the Treasury Compliance account.

Technical Description

Removes a VASPDomain::VASPDomain from the domains field of the VASPDomain::VASPDomains resource published under account with address.

Parameters

NameTypeDescription
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.
addressaddressThe address of parent VASP account that will update its domains.
domainvector<u8>The domain name.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_account is not the Treasury Compliance account.
Errors::NOT_PUBLISHEDVASPDomain::EVASP_DOMAIN_MANAGERThe VASPDomain::VASPDomainManager resource is not yet published under the Treasury Compliance account.
Errors::NOT_PUBLISHEDVASPDomain::EVASP_DOMAINS_NOT_PUBLISHEDaddress does not have a VASPDomain::VASPDomains resource published under it.
Errors::INVALID_ARGUMENTVASPDomain::EINVALID_VASP_DOMAINThe domain is greater in length than VASPDomain::DOMAIN_LENGTH.
Errors::INVALID_ARGUMENTVASPDomain::EVASP_DOMAIN_NOT_FOUNDThe domain does not exist in the list of VASPDomain::VASPDomains in the VASPDomain::VASPDomains resource published under address.
§

RotateAuthenticationKey

Fields

§new_key: Vec<u8, Global>

Summary

Rotates the account’s authentication key to the supplied new authentication key. May be sent by any account.

Technical Description

Rotate the account’s DiemAccount::DiemAccount authentication_key field to new_key. new_key must be a valid authentication key that corresponds to an ed25519 public key as described here, and account must not have previously delegated its DiemAccount::KeyRotationCapability.

Parameters

NameTypeDescription
accountsignerSigner of the sending account of the transaction.
new_keyvector<u8>New authentication key to be used for account.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccount has already delegated/extracted its DiemAccount::KeyRotationCapability.
Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_key was an invalid length.
  • AccountAdministrationScripts::rotate_authentication_key_with_nonce
  • AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin
  • AccountAdministrationScripts::rotate_authentication_key_with_recovery_address
§

RotateAuthenticationKeyWithNonce

Fields

§sliding_nonce: u64
§new_key: Vec<u8, Global>

Summary

Rotates the sender’s authentication key to the supplied new authentication key. May be sent by any account that has a sliding nonce resource published under it (usually this is Treasury Compliance or Diem Root accounts).

Technical Description

Rotates the account’s DiemAccount::DiemAccount authentication_key field to new_key. new_key must be a valid authentication key that corresponds to an ed25519 public key as described here, and account must not have previously delegated its DiemAccount::KeyRotationCapability.

Parameters

NameTypeDescription
accountsignerSigner of the sending account of the transaction.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
new_keyvector<u8>New authentication key to be used for account.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccount has already delegated/extracted its DiemAccount::KeyRotationCapability.
Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_key was an invalid length.
  • AccountAdministrationScripts::rotate_authentication_key
  • AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin
  • AccountAdministrationScripts::rotate_authentication_key_with_recovery_address
§

RotateAuthenticationKeyWithNonceAdmin

Fields

§sliding_nonce: u64
§new_key: Vec<u8, Global>

Summary

Rotates the specified account’s authentication key to the supplied new authentication key. May only be sent by the Diem Root account as a write set transaction.

Technical Description

Rotate the account’s DiemAccount::DiemAccount authentication_key field to new_key. new_key must be a valid authentication key that corresponds to an ed25519 public key as described here, and account must not have previously delegated its DiemAccount::KeyRotationCapability.

Parameters

NameTypeDescription
dr_accountsignerThe signer of the sending account of the write set transaction. May only be the Diem Root signer.
accountsignerSigner of account specified in the execute_as field of the write set transaction.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction for Diem Root.
new_keyvector<u8>New authentication key to be used for account.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under dr_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce in dr_account is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce in dr_account is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce in dr_account has been previously recorded.
Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccount has already delegated/extracted its DiemAccount::KeyRotationCapability.
Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_key was an invalid length.
  • AccountAdministrationScripts::rotate_authentication_key
  • AccountAdministrationScripts::rotate_authentication_key_with_nonce
  • AccountAdministrationScripts::rotate_authentication_key_with_recovery_address
§

RotateAuthenticationKeyWithRecoveryAddress

Fields

§recovery_address: AccountAddress
§to_recover: AccountAddress
§new_key: Vec<u8, Global>

Summary

Rotates the authentication key of a specified account that is part of a recovery address to a new authentication key. Only used for accounts that are part of a recovery address (see AccountAdministrationScripts::add_recovery_rotation_capability for account restrictions).

Technical Description

Rotates the authentication key of the to_recover account to new_key using the DiemAccount::KeyRotationCapability stored in the RecoveryAddress::RecoveryAddress resource published under recovery_address. new_key must be a valide authentication key as described here. This transaction can be sent either by the to_recover account, or by the account where the RecoveryAddress::RecoveryAddress resource is published that contains to_recover’s DiemAccount::KeyRotationCapability.

Parameters

NameTypeDescription
accountsignerSigner of the sending account of the transaction.
recovery_addressaddressAddress where RecoveryAddress::RecoveryAddress that holds to_recover’s DiemAccount::KeyRotationCapability is published.
to_recoveraddressThe address of the account whose authentication key will be updated.
new_keyvector<u8>New authentication key to be used for the account at the to_recover address.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_address does not have a RecoveryAddress::RecoveryAddress resource published under it.
Errors::INVALID_ARGUMENTRecoveryAddress::ECANNOT_ROTATE_KEYThe address of account is not recovery_address or to_recover.
Errors::INVALID_ARGUMENTRecoveryAddress::EACCOUNT_NOT_RECOVERABLEto_recover’s DiemAccount::KeyRotationCapability is not in the RecoveryAddress::RecoveryAddress resource published under recovery_address.
Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_key was an invalid length.
  • AccountAdministrationScripts::rotate_authentication_key
  • AccountAdministrationScripts::rotate_authentication_key_with_nonce
  • AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin
§

RotateDualAttestationInfo

Fields

§new_url: Vec<u8, Global>
§new_key: Vec<u8, Global>

Summary

Updates the url used for off-chain communication, and the public key used to verify dual attestation on-chain. Transaction can be sent by any account that has dual attestation information published under it. In practice the only such accounts are Designated Dealers and Parent VASPs.

Technical Description

Updates the base_url and compliance_public_key fields of the DualAttestation::Credential resource published under account. The new_key must be a valid ed25519 public key.

Events

Successful execution of this transaction emits two events:

  • A DualAttestation::ComplianceKeyRotationEvent containing the new compliance public key, and the blockchain time at which the key was updated emitted on the DualAttestation::Credential compliance_key_rotation_events handle published under account; and
  • A DualAttestation::BaseUrlRotationEvent containing the new base url to be used for off-chain communication, and the blockchain time at which the url was updated emitted on the DualAttestation::Credential base_url_rotation_events handle published under account.

Parameters

NameTypeDescription
accountsignerSigner of the sending account of the transaction.
new_urlvector<u8>ASCII-encoded url to be used for off-chain communication with account.
new_keyvector<u8>New ed25519 public key to be used for on-chain dual attestation checking.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDDualAttestation::ECREDENTIALA DualAttestation::Credential resource is not published under account.
Errors::INVALID_ARGUMENTDualAttestation::EINVALID_PUBLIC_KEYnew_key is not a valid ed25519 public key.
  • AccountCreationScripts::create_parent_vasp_account
  • AccountCreationScripts::create_designated_dealer
  • AccountAdministrationScripts::rotate_dual_attestation_info
§

RotateSharedEd25519PublicKey

Fields

§public_key: Vec<u8, Global>

Summary

Rotates the authentication key in a SharedEd25519PublicKey. This transaction can be sent by any account that has previously published a shared ed25519 public key using AccountAdministrationScripts::publish_shared_ed25519_public_key.

Technical Description

public_key must be a valid ed25519 public key. This transaction first rotates the public key stored in account’s SharedEd25519PublicKey::SharedEd25519PublicKey resource to public_key, after which it rotates the account’s authentication key to the new authentication key derived from public_key as defined here using the DiemAccount::KeyRotationCapability stored in account’s SharedEd25519PublicKey::SharedEd25519PublicKey.

Parameters

NameTypeDescription
accountsignerThe signer of the sending account of the transaction.
public_keyvector<u8>32-byte Ed25519 public key.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYA SharedEd25519PublicKey::SharedEd25519PublicKey resource is not published under account.
Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_key is an invalid ed25519 public key.
  • AccountAdministrationScripts::publish_shared_ed25519_public_key
§

SetGasConstants

Fields

§sliding_nonce: u64
§global_memory_per_byte_cost: u64
§global_memory_per_byte_write_cost: u64
§min_transaction_gas_units: u64
§large_transaction_cutoff: u64
§intrinsic_gas_per_byte: u64
§maximum_number_of_gas_units: u64
§min_price_per_gas_unit: u64
§max_price_per_gas_unit: u64
§max_transaction_size_in_bytes: u64
§gas_unit_scaling_factor: u64
§default_account_size: u64

Summary

Updates the gas constants stored on chain and used by the VM for gas metering. This transaction can only be sent from the Diem Root account.

Technical Description

Updates the on-chain config holding the DiemVMConfig and emits a DiemConfig::NewEpochEvent to trigger a reconfiguration of the system.

Parameters

NameTypeDescription
accountsignerSigner of the sending account. Must be the Diem Root account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
global_memory_per_byte_costu64The new cost to read global memory per-byte to be used for gas metering.
global_memory_per_byte_write_costu64The new cost to write global memory per-byte to be used for gas metering.
min_transaction_gas_unitsu64The new flat minimum amount of gas required for any transaction.
large_transaction_cutoffu64The new size over which an additional charge will be assessed for each additional byte.
intrinsic_gas_per_byteu64The new number of units of gas that to be charged per-byte over the new large_transaction_cutoff.
maximum_number_of_gas_unitsu64The new maximum number of gas units that can be set in a transaction.
min_price_per_gas_unitu64The new minimum gas price that can be set for a transaction.
max_price_per_gas_unitu64The new maximum gas price that can be set for a transaction.
max_transaction_size_in_bytesu64The new maximum size of a transaction that can be processed.
gas_unit_scaling_factoru64The new scaling factor to use when scaling between external and internal gas units.
default_account_sizeu64The new default account size to use when assessing final costs for reads and writes to global storage.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::INVALID_ARGUMENTDiemVMConfig::EGAS_CONSTANT_INCONSISTENCYThe provided gas constants are inconsistent.
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccount is not the Diem Root account.
§

SetValidatorConfigAndReconfigure

Fields

§validator_account: AccountAddress
§consensus_pubkey: Vec<u8, Global>
§validator_network_addresses: Vec<u8, Global>
§fullnode_network_addresses: Vec<u8, Global>

Summary

Updates a validator’s configuration, and triggers a reconfiguration of the system to update the validator set with this new validator configuration. Can only be successfully sent by a Validator Operator account that is already registered with a validator.

Technical Description

This updates the fields with corresponding names held in the ValidatorConfig::ValidatorConfig config resource held under validator_account. It then emits a DiemConfig::NewEpochEvent to trigger a reconfiguration of the system. This reconfiguration will update the validator set on-chain with the updated ValidatorConfig::ValidatorConfig.

Parameters

NameTypeDescription
validator_operator_accountsignerSigner of the sending account. Must be the registered validator operator for the validator at validator_address.
validator_accountaddressThe address of the validator’s ValidatorConfig::ValidatorConfig resource being updated.
consensus_pubkeyvector<u8>New Ed25519 public key to be used in the updated ValidatorConfig::ValidatorConfig.
validator_network_addressesvector<u8>New set of validator_network_addresses to be used in the updated ValidatorConfig::ValidatorConfig.
fullnode_network_addressesvector<u8>New set of fullnode_network_addresses to be used in the updated ValidatorConfig::ValidatorConfig.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_address does not have a ValidatorConfig::ValidatorConfig resource published under it.
Errors::REQUIRES_ROLERoles::EVALIDATOR_OPERATORvalidator_operator_account does not have a Validator Operator role.
Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_account is not the registered operator for the validator at validator_address.
Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkey is not a valid ed25519 public key.
Errors::INVALID_STATEDiemConfig::EINVALID_BLOCK_TIMEAn invalid time value was encountered in reconfiguration. Unlikely to occur.
  • AccountCreationScripts::create_validator_account
  • AccountCreationScripts::create_validator_operator_account
  • ValidatorAdministrationScripts::add_validator_and_reconfigure
  • ValidatorAdministrationScripts::remove_validator_and_reconfigure
  • ValidatorAdministrationScripts::set_validator_operator
  • ValidatorAdministrationScripts::set_validator_operator_with_nonce_admin
  • ValidatorAdministrationScripts::register_validator_config
§

SetValidatorOperator

Fields

§operator_name: Vec<u8, Global>
§operator_account: AccountAddress

Summary

Sets the validator operator for a validator in the validator’s configuration resource “locally” and does not reconfigure the system. Changes from this transaction will not picked up by the system until a reconfiguration of the system is triggered. May only be sent by an account with Validator role.

Technical Description

Sets the account at operator_account address and with the specified human_name as an operator for the sending validator account. The account at operator_account address must have a Validator Operator role and have a ValidatorOperatorConfig::ValidatorOperatorConfig resource published under it. The sending account must be a Validator and have a ValidatorConfig::ValidatorConfig resource published under it. This script does not emit a DiemConfig::NewEpochEvent and no reconfiguration of the system is initiated by this script.

Parameters

NameTypeDescription
accountsignerThe signer of the sending account of the transaction.
operator_namevector<u8>Validator operator’s human name.
operator_accountaddressAddress of the validator operator account to be added as the account validator’s operator.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIGThe ValidatorOperatorConfig::ValidatorOperatorConfig resource is not published under operator_account.
00The human_name field of the ValidatorOperatorConfig::ValidatorOperatorConfig resource under operator_account does not match the provided human_name.
Errors::REQUIRES_ROLERoles::EVALIDATORaccount does not have a Validator account role.
Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_account does not have a ValidatorOperatorConfig::ValidatorOperatorConfig resource.
Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfig is not published under account.
  • AccountCreationScripts::create_validator_account
  • AccountCreationScripts::create_validator_operator_account
  • ValidatorAdministrationScripts::register_validator_config
  • ValidatorAdministrationScripts::remove_validator_and_reconfigure
  • ValidatorAdministrationScripts::add_validator_and_reconfigure
  • ValidatorAdministrationScripts::set_validator_operator_with_nonce_admin
  • ValidatorAdministrationScripts::set_validator_config_and_reconfigure
§

SetValidatorOperatorWithNonceAdmin

Fields

§sliding_nonce: u64
§operator_name: Vec<u8, Global>
§operator_account: AccountAddress

Summary

Sets the validator operator for a validator in the validator’s configuration resource “locally” and does not reconfigure the system. Changes from this transaction will not picked up by the system until a reconfiguration of the system is triggered. May only be sent by the Diem Root account as a write set transaction.

Technical Description

Sets the account at operator_account address and with the specified human_name as an operator for the validator account. The account at operator_account address must have a Validator Operator role and have a ValidatorOperatorConfig::ValidatorOperatorConfig resource published under it. The account represented by the account signer must be a Validator and have a ValidatorConfig::ValidatorConfig resource published under it. No reconfiguration of the system is initiated by this script.

Parameters

NameTypeDescription
dr_accountsignerSigner of the sending account of the write set transaction. May only be the Diem Root signer.
accountsignerSigner of account specified in the execute_as field of the write set transaction.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction for Diem Root.
operator_namevector<u8>Validator operator’s human name.
operator_accountaddressAddress of the validator operator account to be added as the account validator’s operator.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under dr_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce in dr_account is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce in dr_account is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce in dr_account has been previously recorded.
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEThe sending account is not the Diem Root account or Treasury Compliance account
Errors::NOT_PUBLISHEDValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIGThe ValidatorOperatorConfig::ValidatorOperatorConfig resource is not published under operator_account.
00The human_name field of the ValidatorOperatorConfig::ValidatorOperatorConfig resource under operator_account does not match the provided human_name.
Errors::REQUIRES_ROLERoles::EVALIDATORaccount does not have a Validator account role.
Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_account does not have a ValidatorOperatorConfig::ValidatorOperatorConfig resource.
Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfig is not published under account.
  • AccountCreationScripts::create_validator_account
  • AccountCreationScripts::create_validator_operator_account
  • ValidatorAdministrationScripts::register_validator_config
  • ValidatorAdministrationScripts::remove_validator_and_reconfigure
  • ValidatorAdministrationScripts::add_validator_and_reconfigure
  • ValidatorAdministrationScripts::set_validator_operator
  • ValidatorAdministrationScripts::set_validator_config_and_reconfigure
§

TieredMint

Fields

§coin_type: TypeTag
§sliding_nonce: u64
§designated_dealer_address: AccountAddress
§mint_amount: u64
§tier_index: u64

Summary

Mints a specified number of coins in a currency to a Designated Dealer. The sending account must be the Treasury Compliance account, and coins can only be minted to a Designated Dealer account.

Technical Description

Mints mint_amount of coins in the CoinType currency to Designated Dealer account at designated_dealer_address. The tier_index parameter specifies which tier should be used to check verify the off-chain approval policy, and is based in part on the on-chain tier values for the specific Designated Dealer, and the number of CoinType coins that have been minted to the dealer over the past 24 hours. Every Designated Dealer has 4 tiers for each currency that they support. The sending tc_account must be the Treasury Compliance account, and the receiver an authorized Designated Dealer account.

Events

Successful execution of the transaction will emit two events:

  • A Diem::MintEvent with the amount and currency code minted is emitted on the mint_event_handle in the stored Diem::CurrencyInfo<CoinType> resource stored under 0xA550C18; and
  • A DesignatedDealer::ReceivedMintEvent with the amount, currency code, and Designated Dealer’s address is emitted on the mint_event_handle in the stored DesignatedDealer::Dealer resource published under the designated_dealer_address.

Parameters

NameTypeDescription
CoinTypeTypeThe Move type for the CoinType being minted. CoinType must be an already-registered currency on-chain.
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
designated_dealer_addressaddressThe address of the Designated Dealer account being minted to.
mint_amountu64The number of coins to be minted.
tier_indexu64[Deprecated] The mint tier index to use for the Designated Dealer account. Will be ignored

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under tc_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_account is not the Treasury Compliance account.
Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_account is not the Treasury Compliance account.
Errors::INVALID_ARGUMENTDesignatedDealer::EINVALID_MINT_AMOUNTmint_amount is zero.
Errors::NOT_PUBLISHEDDesignatedDealer::EDEALERDesignatedDealer::Dealer or DesignatedDealer::TierInfo<CoinType> resource does not exist at designated_dealer_address.
Errors::REQUIRES_CAPABILITYDiem::EMINT_CAPABILITYtc_account does not have a Diem::MintCapability<CoinType> resource published under it.
Errors::INVALID_STATEDiem::EMINTING_NOT_ALLOWEDMinting is not currently allowed for CoinType coins.
Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSThe depositing of the funds would exceed the account’s account limits.
  • AccountCreationScripts::create_designated_dealer
  • PaymentScripts::peer_to_peer_with_metadata
  • AccountAdministrationScripts::rotate_dual_attestation_info
§

UnfreezeAccount

Fields

§sliding_nonce: u64
§to_unfreeze_account: AccountAddress

Summary

Unfreezes the account at address. The sending account of this transaction must be the Treasury Compliance account. After the successful execution of this transaction transactions may be sent from the previously frozen account, and coins may be sent and received.

Technical Description

Sets the AccountFreezing::FreezingBit to false and emits a AccountFreezing::UnFreezeAccountEvent. The transaction sender must be the Treasury Compliance account. Note that this is a per-account property so unfreezing a Parent VASP will not effect the status any of its child accounts and vice versa.

Events

Successful execution of this script will emit a AccountFreezing::UnFreezeAccountEvent with the unfrozen_address set the to_unfreeze_account’s address.

Parameters

NameTypeDescription
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
to_unfreeze_accountaddressThe account address to be frozen.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account.
  • TreasuryComplianceScripts::freeze_account
§

UpdateDiemConsensusConfig

Fields

§sliding_nonce: u64
§config: Vec<u8, Global>

Summary

Updates the Diem consensus config that is stored on-chain and is used by the Consensus. This transaction can only be sent from the Diem Root account.

Technical Description

Updates the DiemConsensusConfig on-chain config and emits a DiemConfig::NewEpochEvent to trigger a reconfiguration of the system.

Parameters

NameTypeDescription
accountsignerSigner of the sending account. Must be the Diem Root account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
configvector<u8>The serialized bytes of consensus config.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccount is not the Diem Root account.
§

UpdateDiemVersion

Fields

§sliding_nonce: u64
§major: u64

Summary

Updates the Diem major version that is stored on-chain and is used by the VM. This transaction can only be sent from the Diem Root account.

Technical Description

Updates the DiemVersion on-chain config and emits a DiemConfig::NewEpochEvent to trigger a reconfiguration of the system. The major version that is passed in must be strictly greater than the current major version held on-chain. The VM reads this information and can use it to preserve backwards compatibility with previous major versions of the VM.

Parameters

NameTypeDescription
accountsignerSigner of the sending account. Must be the Diem Root account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
majoru64The major version of the VM to be used from this transaction on.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccount is not the Diem Root account.
Errors::INVALID_ARGUMENTDiemVersion::EINVALID_MAJOR_VERSION_NUMBERmajor is less-than or equal to the current major version stored on-chain.
§

UpdateDualAttestationLimit

Fields

§sliding_nonce: u64
§new_micro_xdx_limit: u64

Summary

Update the dual attestation limit on-chain. Defined in terms of micro-XDX. The transaction can only be sent by the Treasury Compliance account. After this transaction all inter-VASP payments over this limit must be checked for dual attestation.

Technical Description

Updates the micro_xdx_limit field of the DualAttestation::Limit resource published under 0xA550C18. The amount is set in micro-XDX.

Parameters

NameTypeDescription
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for this transaction.
new_micro_xdx_limitu64The new dual attestation limit to be used on-chain.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under tc_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_account is not the Treasury Compliance account.
  • TreasuryComplianceScripts::update_exchange_rate
  • TreasuryComplianceScripts::update_minting_ability
§

UpdateExchangeRate

Fields

§currency: TypeTag
§sliding_nonce: u64
§new_exchange_rate_numerator: u64
§new_exchange_rate_denominator: u64

Summary

Update the rough on-chain exchange rate between a specified currency and XDX (as a conversion to micro-XDX). The transaction can only be sent by the Treasury Compliance account. After this transaction the updated exchange rate will be used for normalization of gas prices, and for dual attestation checking.

Technical Description

Updates the on-chain exchange rate from the given Currency to micro-XDX. The exchange rate is given by new_exchange_rate_numerator/new_exchange_rate_denominator.

Parameters

NameTypeDescription
CurrencyTypeThe Move type for the Currency whose exchange rate is being updated. Currency must be an already-registered currency on-chain.
tc_accountsignerThe signer of the sending account of this transaction. Must be the Treasury Compliance account.
sliding_nonceu64The sliding_nonce (see: SlidingNonce) to be used for the transaction.
new_exchange_rate_numeratoru64The numerator for the new to micro-XDX exchange rate for Currency.
new_exchange_rate_denominatoru64The denominator for the new to micro-XDX exchange rate for Currency.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonce resource is not published under tc_account.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonce is too old and it’s impossible to determine if it’s duplicated or not.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonce is too far in the future.
Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonce has been previously recorded.
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_account is not the Treasury Compliance account.
Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_account is not the Treasury Compliance account.
Errors::INVALID_ARGUMENTFixedPoint32::EDENOMINATORnew_exchange_rate_denominator is zero.
Errors::INVALID_ARGUMENTFixedPoint32::ERATIO_OUT_OF_RANGEThe quotient is unrepresentable as a FixedPoint32.
Errors::LIMIT_EXCEEDEDFixedPoint32::ERATIO_OUT_OF_RANGEThe quotient is unrepresentable as a FixedPoint32.
  • TreasuryComplianceScripts::update_dual_attestation_limit
  • TreasuryComplianceScripts::update_minting_ability
§

UpdateMintingAbility

Fields

§currency: TypeTag
§allow_minting: bool

Summary

Script to allow or disallow minting of new coins in a specified currency. This transaction can only be sent by the Treasury Compliance account. Turning minting off for a currency will have no effect on coins already in circulation, and coins may still be removed from the system.

Technical Description

This transaction sets the can_mint field of the Diem::CurrencyInfo<Currency> resource published under 0xA550C18 to the value of allow_minting. Minting of coins if allowed if this field is set to true and minting of new coins in Currency is disallowed otherwise. This transaction needs to be sent by the Treasury Compliance account.

Parameters

NameTypeDescription
CurrencyTypeThe Move type for the Currency whose minting ability is being updated. Currency must be an already-registered currency on-chain.
accountsignerSigner of the sending account. Must be the Diem Root account.
allow_mintingboolWhether to allow minting of new coins in Currency.

Common Abort Conditions

Error CategoryError ReasonDescription
Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_account is not the Treasury Compliance account.
Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOCurrency is not a registered currency on-chain.
  • TreasuryComplianceScripts::update_dual_attestation_limit
  • TreasuryComplianceScripts::update_exchange_rate

Implementations§

§

impl ScriptFunctionCall

pub fn encode(self) -> TransactionPayload

Build a Diem TransactionPayload from a structured object ScriptFunctionCall.

pub fn decode(payload: &TransactionPayload) -> Option<ScriptFunctionCall>

Try to recognize a Diem TransactionPayload and convert it into a structured object ScriptFunctionCall.

Trait Implementations§

§

impl Arbitrary for ScriptFunctionCall

§

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.
§

type Strategy = TupleUnion<((u32, Arc<Map<<TypeTag as Arbitrary>::Strategy, fn(_: TypeTag) -> ScriptFunctionCall>>), (u32, Arc<Map<<AccountAddress as Arbitrary>::Strategy, fn(_: AccountAddress) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy), fn(_: (u64, Vec<u8, Global>, AccountAddress)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (AccountAddress, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<<TypeTag as Arbitrary>::Strategy, fn(_: TypeTag) -> ScriptFunctionCall>>), (u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy), fn(_: (TypeTag, u64, AccountAddress, u64)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy), fn(_: (TypeTag, AccountAddress, u64)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <bool as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy), fn(_: (TypeTag, AccountAddress, Vec<u8, Global>, bool, u64)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <bool as Arbitrary>::Strategy), fn(_: (TypeTag, u64, AccountAddress, Vec<u8, Global>, Vec<u8, Global>, bool)) -> ScriptFunctionCall>>), (u32, Arc<TupleUnion<((u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <bool as Arbitrary>::Strategy), fn(_: (TypeTag, u64, AccountAddress, Vec<u8, Global>, Vec<u8, Global>, bool)) -> ScriptFunctionCall>>), (u32, Arc<fn() -> ScriptFunctionCall>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (u64, AccountAddress, Vec<u8, Global>, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (u64, AccountAddress, Vec<u8, Global>, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<fn() -> ScriptFunctionCall>), (u32, Arc<Map<<u64 as Arbitrary>::Strategy, fn(_: u64) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy), fn(_: (u64, AccountAddress)) -> ScriptFunctionCall>>), (u32, Arc<Map<<u64 as Arbitrary>::Strategy, fn(_: u64) -> ScriptFunctionCall>>), (u32, Arc<Map<<u64 as Arbitrary>::Strategy, fn(_: u64) -> ScriptFunctionCall>>), (u32, Arc<TupleUnion<((u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (TypeTag, u64, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (TypeTag, AccountAddress, u64, Vec<u8, Global>, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy), fn(_: (TypeTag, u64)) -> ScriptFunctionCall>>), (u32, Arc<Map<<Vec<u8, Global> as Arbitrary>::Strategy, fn(_: Vec<u8, Global>) -> ScriptFunctionCall>>), (u32, Arc<Map<(<AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (AccountAddress, Vec<u8, Global>, Vec<u8, Global>, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy), fn(_: (u64, Vec<u8, Global>, AccountAddress)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (AccountAddress, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<<Vec<u8, Global> as Arbitrary>::Strategy, fn(_: Vec<u8, Global>) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (u64, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<TupleUnion<((u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (u64, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<AccountAddress as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (AccountAddress, AccountAddress, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (Vec<u8, Global>, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<<Vec<u8, Global> as Arbitrary>::Strategy, fn(_: Vec<u8, Global>) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, (<u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy)), fn(_: (u64, u64, u64, u64, u64, u64, u64, u64, u64, (u64, u64, u64))) -> ScriptFunctionCall>>), (u32, Arc<Map<(<AccountAddress as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (AccountAddress, Vec<u8, Global>, Vec<u8, Global>, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<Vec<u8, Global> as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy), fn(_: (Vec<u8, Global>, AccountAddress)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy), fn(_: (u64, Vec<u8, Global>, AccountAddress)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy), fn(_: (TypeTag, u64, AccountAddress, u64, u64)) -> ScriptFunctionCall>>), (u32, Arc<TupleUnion<((u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <AccountAddress as Arbitrary>::Strategy), fn(_: (u64, AccountAddress)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <Vec<u8, Global> as Arbitrary>::Strategy), fn(_: (u64, Vec<u8, Global>)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy), fn(_: (u64, u64)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy), fn(_: (u64, u64)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy, <u64 as Arbitrary>::Strategy), fn(_: (TypeTag, u64, u64, u64)) -> ScriptFunctionCall>>), (u32, Arc<Map<(<TypeTag as Arbitrary>::Strategy, <bool as Arbitrary>::Strategy), fn(_: (TypeTag, bool)) -> ScriptFunctionCall>>))>>))>>))>>))>>))>

The type of Strategy used to generate values of type Self.
§

fn arbitrary_with( _top: <ScriptFunctionCall as Arbitrary>::Parameters ) -> <ScriptFunctionCall as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more
§

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more
§

impl Clone for ScriptFunctionCall

§

fn clone(&self) -> ScriptFunctionCall

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ScriptFunctionCall

§

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

Formats the value using the given formatter. Read more
§

impl PartialEq<ScriptFunctionCall> for ScriptFunctionCall

§

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

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

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 PartialOrd<ScriptFunctionCall> for ScriptFunctionCall

§

fn partial_cmp(&self, other: &ScriptFunctionCall) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl StructuralPartialEq for ScriptFunctionCall

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more