Module diem.stdlib
Expand source code
# pyre-strict
from dataclasses import dataclass
import typing
from diem import serde_types as st
from diem import diem_types
class ScriptCall:
"""Structured representation of a call into a known Move script."""
pass
@dataclass(frozen=True)
class ScriptCall__AddCurrencyToAccount(ScriptCall):
"""# Summary
Adds a zero `Currency` balance to the sending `account`.
This will enable `account` to
send, receive, and hold `Diem::Diem<Currency>` coins. This transaction can be
successfully sent by any account that is allowed to hold balances
(e.g., VASP, Designated Dealer).
# Technical Description
After the successful execution of this transaction the sending account will have a
`DiemAccount::Balance<Currency>` resource with zero balance published under it. Only
accounts that can hold balances can send this transaction, the sending account cannot
already have a `DiemAccount::Balance<Currency>` published under it.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` being added to the sending account of the transaction. `Currency` must be an already-registered currency on-chain. |
| `account` | `&signer` | The signer of the sending account of the transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EROLE_CANT_STORE_BALANCE` | The sending `account`'s role does not permit balances. |
| `Errors::ALREADY_PUBLISHED` | `DiemAccount::EADD_EXISTING_CURRENCY` | A balance for `Currency` is already published under the sending `account`. |
# Related Scripts
* `Script::create_child_vasp_account`
* `Script::create_parent_vasp_account`
* `Script::peer_to_peer_with_metadata`
"""
currency: diem_types.TypeTag
@dataclass(frozen=True)
class ScriptCall__AddRecoveryRotationCapability(ScriptCall):
"""# 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 `Script::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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `to_recover_account` | `&signer` | The signer reference of the sending account of this transaction. |
| `recovery_address` | `address` | The account address where the `to_recover_account`'s `DiemAccount::KeyRotationCapability` will be stored. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `to_recover_account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EINVALID_KEY_ROTATION_DELEGATION` | `to_recover_account` and `recovery_address` do not belong to the same VASP. |
| `Errors::LIMIT_EXCEEDED` | ` RecoveryAddress::EMAX_KEYS_REGISTERED` | `RecoveryAddress::MAX_REGISTERED_KEYS` have already been registered with this `recovery_address`. |
# Related Scripts
* `Script::create_recovery_address`
* `Script::rotate_authentication_key_with_recovery_address`
"""
recovery_address: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptCall__AddValidatorAndReconfigure(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. |
| `validator_address` | `address` | The validator account address to be added to the validator set. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::EINVALID_PROSPECTIVE_VALIDATOR` | The validator to be added does not have a `ValidatorConfig::ValidatorConfig` resource published under it, or its `config` field is empty. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::EALREADY_A_VALIDATOR` | The `validator_address` account is already a registered validator. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
sliding_nonce: st.uint64
validator_name: bytes
validator_address: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptCall__Burn(ScriptCall):
"""# Summary
Burns all coins held in the preburn resource at the specified
preburn address and removes them from the system.
The sending account must
be the Treasury Compliance account.
The account that holds the preburn 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currency being burned. `Token` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction, must have a burn capability for `Token` published under it. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `preburn_address` | `address` | The address where the coins to-be-burned are currently held. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | The account at `preburn_address` does not have a `Diem::Preburn<Token>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_EMPTY` | The `Diem::Preburn<Token>` resource is empty (has a value of 0). |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. |
# Related Scripts
* `Script::burn_txn_fees`
* `Script::cancel_burn`
* `Script::preburn`
"""
token: diem_types.TypeTag
sliding_nonce: st.uint64
preburn_address: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptCall__BurnTxnFees(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` being added to the sending account of the transaction. `CoinType` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `TransactionFee::ETRANSACTION_FEE` | `CoinType` is not an accepted transaction fee currency. |
| `Errors::INVALID_ARGUMENT` | `Diem::ECOIN` | The collected fees in `CoinType` are zero. |
# Related Scripts
* `Script::burn`
* `Script::cancel_burn`
"""
coin_type: diem_types.TypeTag
@dataclass(frozen=True)
class ScriptCall__CancelBurn(ScriptCall):
"""# Summary
Cancels and returns all coins held in the preburn area under
`preburn_address` 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currenty that burning is being cancelled for. `Token` must be an already-registered currency on-chain. |
| `account` | `&signer` | The signer reference of the sending account of this transaction, must have a burn capability for `Token` published under it. |
| `preburn_address` | `address` | The address where the coins to-be-burned are currently held. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | The account at `preburn_address` does not have a `Diem::Preburn<Token>` resource published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | The value held in the preburn resource was zero. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | The account at `preburn_address` doesn't have a balance resource for `Token`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds held in the prebun area would exceed the `account`'s account limits. |
| `Errors::INVALID_STATE` | `DualAttestation::EPAYEE_COMPLIANCE_KEY_NOT_SET` | The `account` does not have a compliance key set on it but dual attestion checking was performed. |
# Related Scripts
* `Script::burn_txn_fees`
* `Script::burn`
* `Script::preburn`
"""
token: diem_types.TypeTag
preburn_address: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptCall__CreateChildVaspAccount(ScriptCall):
"""# 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`.
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 with a `child_initial_balance` greater than zero will emit:
* A `DiemAccount::SentPaymentEvent` with the `payer` field being the Parent VASP's address,
and 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,
and payee field being `child_address`. This is emitted on the new Child VASPS's
`DiemAccount::DiemAccount` `received_events` handle.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` that the child account should be created with. `CoinType` must be an already-registered currency on-chain. |
| `parent_vasp` | `&signer` | The signer reference of the sending account. Must be a Parent VASP account. |
| `child_address` | `address` | Address of the to-be-created Child VASP account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. |
| `child_initial_balance` | `u64` | The initial balance in `CoinType` to give the child account when it's created. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | The `auth_key_prefix` was not of length 32. |
| `Errors::REQUIRES_ROLE` | `Roles::EPARENT_VASP` | The sending account wasn't a Parent VASP account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `child_address` address is already taken. |
| `Errors::LIMIT_EXCEEDED` | `VASP::ETOO_MANY_CHILDREN` | The sending account has reached the maximum number of allowed child accounts. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. |
| `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for the sending account has already been extracted. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | The sending account doesn't have a balance in `CoinType`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | The sending account doesn't have at least `child_initial_balance` of `CoinType` balance. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECANNOT_CREATE_AT_VM_RESERVED` | The `child_address` is the reserved address 0x0. |
# Related Scripts
* `Script::create_parent_vasp_account`
* `Script::add_currency_to_account`
* `Script::rotate_authentication_key`
* `Script::add_recovery_rotation_capability`
* `Script::create_recovery_address`
"""
coin_type: diem_types.TypeTag
child_address: diem_types.AccountAddress
auth_key_prefix: bytes
add_all_currencies: bool
child_initial_balance: st.uint64
@dataclass(frozen=True)
class ScriptCall__CreateDesignatedDealer(ScriptCall):
"""# 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.
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.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` that the Designated Dealer should be initialized with. `Currency` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `addr` | `address` | Address of the to-be-created Designated Dealer account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the Designated Dealer. |
| `add_all_currencies` | `bool` | Whether 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 Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `addr` address is already taken. |
# Related Scripts
* `Script::tiered_mint`
* `Script::peer_to_peer_with_metadata`
* `Script::rotate_dual_attestation_info`
"""
currency: diem_types.TypeTag
sliding_nonce: st.uint64
addr: diem_types.AccountAddress
auth_key_prefix: bytes
human_name: bytes
add_all_currencies: bool
@dataclass(frozen=True)
class ScriptCall__CreateParentVaspAccount(ScriptCall):
"""# 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.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The 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_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Parent VASP account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the Parent VASP. |
| `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `Script::create_child_vasp_account`
* `Script::add_currency_to_account`
* `Script::rotate_authentication_key`
* `Script::add_recovery_rotation_capability`
* `Script::create_recovery_address`
* `Script::rotate_dual_attestation_info`
"""
coin_type: diem_types.TypeTag
sliding_nonce: st.uint64
new_account_address: diem_types.AccountAddress
auth_key_prefix: bytes
human_name: bytes
add_all_currencies: bool
@dataclass(frozen=True)
class ScriptCall__CreateRecoveryAddress(ScriptCall):
"""# Summary
Initializes the sending account as a recovery address that may be used by
the VASP that it belongs to.
The sending account must be a 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | The signer of the sending account of the transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ENOT_A_VASP` | `account` is not a VASP account. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EKEY_ROTATION_DEPENDENCY_CYCLE` | A key rotation recovery cycle would be created by adding `account`'s key rotation capability. |
| `Errors::ALREADY_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | A `RecoveryAddress::RecoveryAddress` resource has already been published under `account`. |
# Related Scripts
* `Script::add_recovery_rotation_capability`
* `Script::rotate_authentication_key_with_recovery_address`
"""
pass
@dataclass(frozen=True)
class ScriptCall__CreateValidatorAccount(ScriptCall):
"""# 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.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Validator account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `Script::add_validator_and_reconfigure`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
sliding_nonce: st.uint64
new_account_address: diem_types.AccountAddress
auth_key_prefix: bytes
human_name: bytes
@dataclass(frozen=True)
class ScriptCall__CreateValidatorOperatorAccount(ScriptCall):
"""# 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.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Validator account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `Script::create_validator_account`
* `Script::add_validator_and_reconfigure`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
sliding_nonce: st.uint64
new_account_address: diem_types.AccountAddress
auth_key_prefix: bytes
human_name: bytes
@dataclass(frozen=True)
class ScriptCall__FreezeAccount(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `to_freeze_account` | `address` | The account address to be frozen. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_TC` | `to_freeze_account` was the Treasury Compliance account (`0xB1E55ED`). |
| `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_DIEM_ROOT` | `to_freeze_account` was the Diem Root account (`0xA550C18`). |
# Related Scripts
* `Script::unfreeze_account`
"""
sliding_nonce: st.uint64
to_freeze_account: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptCall__PeerToPeerWithMetadata(ScriptCall):
"""# 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
`metadata` | `Signer::address_of(payer)` | `amount` | `DualAttestation::DOMAIN_SEPARATOR`.
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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` being sent in this transaction. `Currency` must be an already-registered currency on-chain. |
| `payer` | `&signer` | The signer reference of the sending account that coins are being transferred from. |
| `payee` | `address` | The address of the account the coins are being transferred to. |
| `metadata` | `vector<u8>` | Optional metadata about this payment. |
| `metadata_signature` | `vector<u8>` | Optional signature over `metadata` and payment information. See |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `payer` doesn't hold a balance in `Currency`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Currency`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | `amount` is zero. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYEE_DOES_NOT_EXIST` | No account exists at the `payee` address. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | An account exists at `payee`, but it does not accept payments in `Currency`. |
| `Errors::INVALID_STATE` | `AccountFreezing::EACCOUNT_FROZEN` | The `payee` account is frozen. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EMALFORMED_METADATA_SIGNATURE` | `metadata_signature` is not 64 bytes. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_METADATA_SIGNATURE` | `metadata_signature` does not verify on the against the `payee'`s `DualAttestation::Credential` `compliance_public_key` public key. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EWITHDRAWAL_EXCEEDS_LIMITS` | `payer` has exceeded its daily withdrawal limits for the backing coins of XDX. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | `payee` has exceeded its daily deposit limits for XDX. |
# Related Scripts
* `Script::create_child_vasp_account`
* `Script::create_parent_vasp_account`
* `Script::add_currency_to_account`
"""
currency: diem_types.TypeTag
payee: diem_types.AccountAddress
amount: st.uint64
metadata: bytes
metadata_signature: bytes
@dataclass(frozen=True)
class ScriptCall__Preburn(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currency being moved to the preburn area. `Token` must be an already-registered currency on-chain. |
| `account` | `&signer` | The signer reference of the sending account. |
| `amount` | `u64` | The amount in `Token` to be moved to the preburn area. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Token` is not a registered currency on-chain. |
| `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for `account` has already been extracted. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Token`. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `account` doesn't hold a balance in `Token`. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | `account` doesn't have a `Diem::Preburn<Token>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_OCCUPIED` | The `value` field in the `Diem::Preburn<Token>` resource under the sender is non-zero. |
| `Errors::NOT_PUBLISHED` | `Roles::EROLE_ID` | The `account` did not have a role assigned to it. |
| `Errors::REQUIRES_ROLE` | `Roles::EDESIGNATED_DEALER` | The `account` did not have the role of DesignatedDealer. |
# Related Scripts
* `Script::cancel_burn`
* `Script::burn`
* `Script::burn_txn_fees`
"""
token: diem_types.TypeTag
amount: st.uint64
@dataclass(frozen=True)
class ScriptCall__PublishSharedEd25519PublicKey(ScriptCall):
"""# Summary
Rotates the authentication key of the sending account to the
newly-specified public key and publishes a new shared authentication key
under the sender's account.
Any account can send this transaction.
# Technical Description
Rotates the authentication key of the sending account to `public_key`,
and publishes a `SharedEd25519PublicKey::SharedEd25519PublicKey` resource
containing the 32-byte ed25519 `public_key` and the `DiemAccount::KeyRotationCapability` for
`account` under `account`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | The signer reference of the sending account of the transaction. |
| `public_key` | `vector<u8>` | 32-byte Ed25519 public key for `account`' authentication key to be rotated to and stored. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability` resource. |
| `Errors::ALREADY_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | The `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is already published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. |
# Related Scripts
* `Script::rotate_shared_ed25519_public_key`
"""
public_key: bytes
@dataclass(frozen=True)
class ScriptCall__RegisterValidatorConfig(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `validator_operator_account` | `&signer` | Signer reference of the sending account. Must be the registered validator operator for the validator at `validator_address`. |
| `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. |
| `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::add_validator_and_reconfigure`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
validator_account: diem_types.AccountAddress
consensus_pubkey: bytes
validator_network_addresses: bytes
fullnode_network_addresses: bytes
@dataclass(frozen=True)
class ScriptCall__RemoveValidatorAndReconfigure(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. |
| `validator_address` | `address` | The validator account address to be removed from the validator set. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account |
| 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::ENOT_AN_ACTIVE_VALIDATOR` | The validator to be removed is not in the validator set. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::add_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
sliding_nonce: st.uint64
validator_name: bytes
validator_address: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptCall__RotateAuthenticationKey(ScriptCall):
"""# Summary
Rotates the transaction sender'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 ed25519 public key, and `account` must not have previously delegated
its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account of the transaction. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `Script::rotate_authentication_key_with_nonce`
* `Script::rotate_authentication_key_with_nonce_admin`
* `Script::rotate_authentication_key_with_recovery_address`
"""
new_key: bytes
@dataclass(frozen=True)
class ScriptCall__RotateAuthenticationKeyWithNonce(ScriptCall):
"""# 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 ed25519 public key, and `account` must not have previously delegated
its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account of the transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `Script::rotate_authentication_key`
* `Script::rotate_authentication_key_with_nonce_admin`
* `Script::rotate_authentication_key_with_recovery_address`
"""
sliding_nonce: st.uint64
new_key: bytes
@dataclass(frozen=True)
class ScriptCall__RotateAuthenticationKeyWithNonceAdmin(ScriptCall):
"""# 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 ed25519 public key, and `account` must not have previously delegated
its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of the write set transaction. May only be the Diem Root signer. |
| `account` | `&signer` | Signer reference of account specified in the `execute_as` field of the write set transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `Script::rotate_authentication_key`
* `Script::rotate_authentication_key_with_nonce`
* `Script::rotate_authentication_key_with_recovery_address`
"""
sliding_nonce: st.uint64
new_key: bytes
@dataclass(frozen=True)
class ScriptCall__RotateAuthenticationKeyWithRecoveryAddress(ScriptCall):
"""# 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
`Script::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`. 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account of the transaction. |
| `recovery_address` | `address` | Address where `RecoveryAddress::RecoveryAddress` that holds `to_recover`'s `DiemAccount::KeyRotationCapability` is published. |
| `to_recover` | `address` | The address of the account whose authentication key will be updated. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for the account at the `to_recover` address. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress::RecoveryAddress` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ECANNOT_ROTATE_KEY` | The address of `account` is not `recovery_address` or `to_recover`. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EACCOUNT_NOT_RECOVERABLE` | `to_recover`'s `DiemAccount::KeyRotationCapability` is not in the `RecoveryAddress::RecoveryAddress` resource published under `recovery_address`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `Script::rotate_authentication_key`
* `Script::rotate_authentication_key_with_nonce`
* `Script::rotate_authentication_key_with_nonce_admin`
"""
recovery_address: diem_types.AccountAddress
to_recover: diem_types.AccountAddress
new_key: bytes
@dataclass(frozen=True)
class ScriptCall__RotateDualAttestationInfo(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account of the transaction. |
| `new_url` | `vector<u8>` | ASCII-encoded url to be used for off-chain communication with `account`. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for on-chain dual attestation checking. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `DualAttestation::ECREDENTIAL` | A `DualAttestation::Credential` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_PUBLIC_KEY` | `new_key` is not a valid ed25519 public key. |
# Related Scripts
* `Script::create_parent_vasp_account`
* `Script::create_designated_dealer`
* `Script::rotate_dual_attestation_info`
"""
new_url: bytes
new_key: bytes
@dataclass(frozen=True)
class ScriptCall__RotateSharedEd25519PublicKey(ScriptCall):
"""# 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
`Script::publish_shared_ed25519_public_key`.
# Technical Description
This first rotates the public key stored in `account`'s
`SharedEd25519PublicKey::SharedEd25519PublicKey` resource to `public_key`, after which it
rotates the authentication key using the capability stored in `account`'s
`SharedEd25519PublicKey::SharedEd25519PublicKey` to a new value derived from `public_key`
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | The signer reference of the sending account of the transaction. |
| `public_key` | `vector<u8>` | 32-byte Ed25519 public key. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | A `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. |
# Related Scripts
* `Script::publish_shared_ed25519_public_key`
"""
public_key: bytes
@dataclass(frozen=True)
class ScriptCall__SetValidatorConfigAndReconfigure(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `validator_operator_account` | `&signer` | Signer reference of the sending account. Must be the registered validator operator for the validator at `validator_address`. |
| `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. |
| `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR_OPERATOR` | `validator_operator_account` does not have a Validator Operator role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::add_validator_and_reconfigure`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::register_validator_config`
"""
validator_account: diem_types.AccountAddress
consensus_pubkey: bytes
validator_network_addresses: bytes
fullnode_network_addresses: bytes
@dataclass(frozen=True)
class ScriptCall__SetValidatorOperator(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | The signer reference of the sending account of the transaction. |
| `operator_name` | `vector<u8>` | Validator operator's human name. |
| `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. |
| 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::add_validator_and_reconfigure`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
operator_name: bytes
operator_account: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptCall__SetValidatorOperatorWithNonceAdmin(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of the write set transaction. May only be the Diem Root signer. |
| `account` | `&signer` | Signer reference of account specified in the `execute_as` field of the write set transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. |
| `operator_name` | `vector<u8>` | Validator operator's human name. |
| `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account |
| `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. |
| 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::add_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_config_and_reconfigure`
"""
sliding_nonce: st.uint64
operator_name: bytes
operator_account: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptCall__TieredMint(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` being minted. `CoinType` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `designated_dealer_address` | `address` | The address of the Designated Dealer account being minted to. |
| `mint_amount` | `u64` | The number of coins to be minted. |
| `tier_index` | `u64` | The mint tier index to use for the Designated Dealer account. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_MINT_AMOUNT` | `mint_amount` is zero. |
| `Errors::NOT_PUBLISHED` | `DesignatedDealer::EDEALER` | `DesignatedDealer::Dealer` or `DesignatedDealer::TierInfo<CoinType>` resource does not exist at `designated_dealer_address`. |
| `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_TIER_INDEX` | The `tier_index` is out of bounds. |
| `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_AMOUNT_FOR_TIER` | `mint_amount` exceeds the maximum allowed amount for `tier_index`. |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EMINT_CAPABILITY` | `tc_account` does not have a `Diem::MintCapability<CoinType>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EMINTING_NOT_ALLOWED` | Minting is not currently allowed for `CoinType` coins. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds would exceed the `account`'s account limits. |
# Related Scripts
* `Script::create_designated_dealer`
* `Script::peer_to_peer_with_metadata`
* `Script::rotate_dual_attestation_info`
"""
coin_type: diem_types.TypeTag
sliding_nonce: st.uint64
designated_dealer_address: diem_types.AccountAddress
mint_amount: st.uint64
tier_index: st.uint64
@dataclass(frozen=True)
class ScriptCall__UnfreezeAccount(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `to_unfreeze_account` | `address` | The account address to be frozen. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
# Related Scripts
* `Script::freeze_account`
"""
sliding_nonce: st.uint64
to_unfreeze_account: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptCall__UpdateDiemVersion(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `major` | `u64` | The `major` version of the VM to be used from this transaction on. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
| `Errors::INVALID_ARGUMENT` | `DiemVersion::EINVALID_MAJOR_VERSION_NUMBER` | `major` is less-than or equal to the current major version stored on-chain. |
"""
sliding_nonce: st.uint64
major: st.uint64
@dataclass(frozen=True)
class ScriptCall__UpdateDualAttestationLimit(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_micro_xdx_limit` | `u64` | The new dual attestation limit to be used on-chain. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
# Related Scripts
* `Script::update_exchange_rate`
* `Script::update_minting_ability`
"""
sliding_nonce: st.uint64
new_micro_xdx_limit: st.uint64
@dataclass(frozen=True)
class ScriptCall__UpdateExchangeRate(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` whose exchange rate is being updated. `Currency` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for the transaction. |
| `new_exchange_rate_numerator` | `u64` | The numerator for the new to micro-XDX exchange rate for `Currency`. |
| `new_exchange_rate_denominator` | `u64` | The denominator for the new to micro-XDX exchange rate for `Currency`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `FixedPoint32::EDENOMINATOR` | `new_exchange_rate_denominator` is zero. |
| `Errors::INVALID_ARGUMENT` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. |
| `Errors::LIMIT_EXCEEDED` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. |
# Related Scripts
* `Script::update_dual_attestation_limit`
* `Script::update_minting_ability`
"""
currency: diem_types.TypeTag
sliding_nonce: st.uint64
new_exchange_rate_numerator: st.uint64
new_exchange_rate_denominator: st.uint64
@dataclass(frozen=True)
class ScriptCall__UpdateMintingAbility(ScriptCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` whose minting ability is being updated. `Currency` must be an already-registered currency on-chain. |
| `account` | `&signer` | Signer reference of the sending account. Must be the Diem Root account. |
| `allow_minting` | `bool` | Whether to allow minting of new coins in `Currency`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | `Currency` is not a registered currency on-chain. |
# Related Scripts
* `Script::update_dual_attestation_limit`
* `Script::update_exchange_rate`
"""
currency: diem_types.TypeTag
allow_minting: bool
class ScriptFunctionCall:
"""Structured representation of a call into a known Move script function."""
pass
@dataclass(frozen=True)
class ScriptFunctionCall__AddCurrencyToAccount(ScriptFunctionCall):
"""# Summary
Adds a zero `Currency` balance to the sending `account`.
This will enable `account` to
send, receive, and hold `Diem::Diem<Currency>` coins. This transaction can be
successfully sent by any account that is allowed to hold balances
(e.g., VASP, Designated Dealer).
# Technical Description
After the successful execution of this transaction the sending account will have a
`DiemAccount::Balance<Currency>` resource with zero balance published under it. Only
accounts that can hold balances can send this transaction, the sending account cannot
already have a `DiemAccount::Balance<Currency>` published under it.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` being added to the sending account of the transaction. `Currency` must be an already-registered currency on-chain. |
| `account` | `signer` | The signer of the sending account of the transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EROLE_CANT_STORE_BALANCE` | The sending `account`'s role does not permit balances. |
| `Errors::ALREADY_PUBLISHED` | `DiemAccount::EADD_EXISTING_CURRENCY` | A balance for `Currency` is already published under the sending `account`. |
# Related Scripts
* `AccountCreationScripts::create_child_vasp_account`
* `AccountCreationScripts::create_parent_vasp_account`
* `PaymentScripts::peer_to_peer_with_metadata`
"""
currency: diem_types.TypeTag
@dataclass(frozen=True)
class ScriptFunctionCall__AddRecoveryRotationCapability(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `to_recover_account` | `signer` | The signer of the sending account of this transaction. |
| `recovery_address` | `address` | The account address where the `to_recover_account`'s `DiemAccount::KeyRotationCapability` will be stored. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `to_recover_account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EINVALID_KEY_ROTATION_DELEGATION` | `to_recover_account` and `recovery_address` do not belong to the same VASP. |
| `Errors::LIMIT_EXCEEDED` | ` RecoveryAddress::EMAX_KEYS_REGISTERED` | `RecoveryAddress::MAX_REGISTERED_KEYS` have already been registered with this `recovery_address`. |
# Related Scripts
* `AccountAdministrationScripts::create_recovery_address`
* `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address`
"""
recovery_address: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptFunctionCall__AddValidatorAndReconfigure(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. |
| `validator_address` | `address` | The validator account address to be added to the validator set. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::EINVALID_PROSPECTIVE_VALIDATOR` | The validator to be added does not have a `ValidatorConfig::ValidatorConfig` resource published under it, or its `config` field is empty. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::EALREADY_A_VALIDATOR` | The `validator_address` account is already a registered validator. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
| `Errors::LIMIT_EXCEEDED` | `DiemSystem::EMAX_VALIDATORS` | The validator set is already at its maximum size. The validator could not be added. |
# Related Scripts
* `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`
"""
sliding_nonce: st.uint64
validator_name: bytes
validator_address: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptFunctionCall__BurnTxnFees(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` being added to the sending account of the transaction. `CoinType` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `TransactionFee::ETRANSACTION_FEE` | `CoinType` is not an accepted transaction fee currency. |
| `Errors::INVALID_ARGUMENT` | `Diem::ECOIN` | The collected fees in `CoinType` are zero. |
# Related Scripts
* `TreasuryComplianceScripts::burn_with_amount`
* `TreasuryComplianceScripts::cancel_burn_with_amount`
"""
coin_type: diem_types.TypeTag
@dataclass(frozen=True)
class ScriptFunctionCall__BurnWithAmount(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currency being burned. `Token` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction, must have a burn capability for `Token` published under it. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `preburn_address` | `address` | The address where the coins to-be-burned are currently held. |
| `amount` | `u64` | The amount to be burned. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_NOT_FOUND` | The `Diem::PreburnQueue<Token>` resource under `preburn_address` does not contain a preburn request with a value matching `amount`. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN_QUEUE` | The account at `preburn_address` does not have a `Diem::PreburnQueue<Token>` resource published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. |
# Related Scripts
* `TreasuryComplianceScripts::burn_txn_fees`
* `TreasuryComplianceScripts::cancel_burn_with_amount`
* `TreasuryComplianceScripts::preburn`
"""
token: diem_types.TypeTag
sliding_nonce: st.uint64
preburn_address: diem_types.AccountAddress
amount: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__CancelBurnWithAmount(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currenty that burning is being cancelled for. `Token` must be an already-registered currency on-chain. |
| `account` | `signer` | The signer of the sending account of this transaction, must have a burn capability for `Token` published under it. |
| `preburn_address` | `address` | The address where the coins to-be-burned are currently held. |
| `amount` | `u64` | The amount to be cancelled. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_NOT_FOUND` | The `Diem::PreburnQueue<Token>` resource under `preburn_address` does not contain a preburn request with a value matching `amount`. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN_QUEUE` | The account at `preburn_address` does not have a `Diem::PreburnQueue<Token>` resource published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | The account at `preburn_address` doesn't have a balance resource for `Token`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds held in the prebun area would exceed the `account`'s account limits. |
| `Errors::INVALID_STATE` | `DualAttestation::EPAYEE_COMPLIANCE_KEY_NOT_SET` | The `account` does not have a compliance key set on it but dual attestion checking was performed. |
# Related Scripts
* `TreasuryComplianceScripts::burn_txn_fees`
* `TreasuryComplianceScripts::burn_with_amount`
* `TreasuryComplianceScripts::preburn`
"""
token: diem_types.TypeTag
preburn_address: diem_types.AccountAddress
amount: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__CreateChildVaspAccount(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` that the child account should be created with. `CoinType` must be an already-registered currency on-chain. |
| `parent_vasp` | `signer` | The reference of the sending account. Must be a Parent VASP account. |
| `child_address` | `address` | Address of the to-be-created Child VASP account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. |
| `child_initial_balance` | `u64` | The initial balance in `CoinType` to give the child account when it's created. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | The `auth_key_prefix` was not of length 32. |
| `Errors::REQUIRES_ROLE` | `Roles::EPARENT_VASP` | The sending account wasn't a Parent VASP account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `child_address` address is already taken. |
| `Errors::LIMIT_EXCEEDED` | `VASP::ETOO_MANY_CHILDREN` | The sending account has reached the maximum number of allowed child accounts. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. |
| `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for the sending account has already been extracted. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | The sending account doesn't have a balance in `CoinType`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | The sending account doesn't have at least `child_initial_balance` of `CoinType` balance. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECANNOT_CREATE_AT_VM_RESERVED` | The `child_address` is the reserved address 0x0. |
# Related Scripts
* `AccountCreationScripts::create_parent_vasp_account`
* `AccountAdministrationScripts::add_currency_to_account`
* `AccountAdministrationScripts::rotate_authentication_key`
* `AccountAdministrationScripts::add_recovery_rotation_capability`
* `AccountAdministrationScripts::create_recovery_address`
"""
coin_type: diem_types.TypeTag
child_address: diem_types.AccountAddress
auth_key_prefix: bytes
add_all_currencies: bool
child_initial_balance: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__CreateDesignatedDealer(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` that the Designated Dealer should be initialized with. `Currency` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `addr` | `address` | Address of the to-be-created Designated Dealer account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the Designated Dealer. |
| `add_all_currencies` | `bool` | Whether 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 Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `addr` address is already taken. |
# Related Scripts
* `TreasuryComplianceScripts::tiered_mint`
* `PaymentScripts::peer_to_peer_with_metadata`
* `AccountAdministrationScripts::rotate_dual_attestation_info`
"""
currency: diem_types.TypeTag
sliding_nonce: st.uint64
addr: diem_types.AccountAddress
auth_key_prefix: bytes
human_name: bytes
add_all_currencies: bool
@dataclass(frozen=True)
class ScriptFunctionCall__CreateParentVaspAccount(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The 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_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Parent VASP account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the Parent VASP. |
| `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `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`
"""
coin_type: diem_types.TypeTag
sliding_nonce: st.uint64
new_account_address: diem_types.AccountAddress
auth_key_prefix: bytes
human_name: bytes
add_all_currencies: bool
@dataclass(frozen=True)
class ScriptFunctionCall__CreateRecoveryAddress(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | The signer of the sending account of the transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ENOT_A_VASP` | `account` is not a VASP account. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EKEY_ROTATION_DEPENDENCY_CYCLE` | A key rotation recovery cycle would be created by adding `account`'s key rotation capability. |
| `Errors::ALREADY_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | A `RecoveryAddress::RecoveryAddress` resource has already been published under `account`. |
# Related Scripts
* `Script::add_recovery_rotation_capability`
* `Script::rotate_authentication_key_with_recovery_address`
"""
pass
@dataclass(frozen=True)
class ScriptFunctionCall__CreateValidatorAccount(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Validator account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `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`
"""
sliding_nonce: st.uint64
new_account_address: diem_types.AccountAddress
auth_key_prefix: bytes
human_name: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__CreateValidatorOperatorAccount(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Validator account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `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`
"""
sliding_nonce: st.uint64
new_account_address: diem_types.AccountAddress
auth_key_prefix: bytes
human_name: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__FreezeAccount(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `to_freeze_account` | `address` | The account address to be frozen. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_TC` | `to_freeze_account` was the Treasury Compliance account (`0xB1E55ED`). |
| `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_DIEM_ROOT` | `to_freeze_account` was the Diem Root account (`0xA550C18`). |
# Related Scripts
* `TreasuryComplianceScripts::unfreeze_account`
"""
sliding_nonce: st.uint64
to_freeze_account: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptFunctionCall__InitializeDiemConsensusConfig(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
"""
sliding_nonce: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__PeerToPeerWithMetadata(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` being sent in this transaction. `Currency` must be an already-registered currency on-chain. |
| `payer` | `signer` | The signer of the sending account that coins are being transferred from. |
| `payee` | `address` | The address of the account the coins are being transferred to. |
| `metadata` | `vector<u8>` | Optional metadata about this payment. |
| `metadata_signature` | `vector<u8>` | Optional signature over `metadata` and payment information. See |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `payer` doesn't hold a balance in `Currency`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Currency`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | `amount` is zero. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYEE_DOES_NOT_EXIST` | No account exists at the `payee` address. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | An account exists at `payee`, but it does not accept payments in `Currency`. |
| `Errors::INVALID_STATE` | `AccountFreezing::EACCOUNT_FROZEN` | The `payee` account is frozen. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EMALFORMED_METADATA_SIGNATURE` | `metadata_signature` is not 64 bytes. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_METADATA_SIGNATURE` | `metadata_signature` does not verify on the against the `payee'`s `DualAttestation::Credential` `compliance_public_key` public key. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EWITHDRAWAL_EXCEEDS_LIMITS` | `payer` has exceeded its daily withdrawal limits for the backing coins of XDX. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | `payee` has exceeded its daily deposit limits for XDX. |
# Related Scripts
* `AccountCreationScripts::create_child_vasp_account`
* `AccountCreationScripts::create_parent_vasp_account`
* `AccountAdministrationScripts::add_currency_to_account`
"""
currency: diem_types.TypeTag
payee: diem_types.AccountAddress
amount: st.uint64
metadata: bytes
metadata_signature: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__Preburn(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currency being moved to the preburn area. `Token` must be an already-registered currency on-chain. |
| `account` | `signer` | The signer of the sending account. |
| `amount` | `u64` | The amount in `Token` to be moved to the preburn area. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Token` is not a registered currency on-chain. |
| `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for `account` has already been extracted. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Token`. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `account` doesn't hold a balance in `Token`. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | `account` doesn't have a `Diem::Preburn<Token>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_OCCUPIED` | The `value` field in the `Diem::Preburn<Token>` resource under the sender is non-zero. |
| `Errors::NOT_PUBLISHED` | `Roles::EROLE_ID` | The `account` did not have a role assigned to it. |
| `Errors::REQUIRES_ROLE` | `Roles::EDESIGNATED_DEALER` | The `account` did not have the role of DesignatedDealer. |
# Related Scripts
* `TreasuryComplianceScripts::cancel_burn_with_amount`
* `TreasuryComplianceScripts::burn_with_amount`
* `TreasuryComplianceScripts::burn_txn_fees`
"""
token: diem_types.TypeTag
amount: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__PublishSharedEd25519PublicKey(ScriptFunctionCall):
"""# 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`](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys)
and publishes a `SharedEd25519PublicKey::SharedEd25519PublicKey` resource
containing the 32-byte ed25519 `public_key` and the `DiemAccount::KeyRotationCapability` for
`account` under `account`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | The signer of the sending account of the transaction. |
| `public_key` | `vector<u8>` | A valid 32-byte Ed25519 public key for `account`'s authentication key to be rotated to and stored. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability` resource. |
| `Errors::ALREADY_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | The `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is already published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. |
# Related Scripts
* `AccountAdministrationScripts::rotate_shared_ed25519_public_key`
"""
public_key: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__RegisterValidatorConfig(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `validator_operator_account` | `signer` | Signer of the sending account. Must be the registered validator operator for the validator at `validator_address`. |
| `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. |
| `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. |
# Related Scripts
* `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`
"""
validator_account: diem_types.AccountAddress
consensus_pubkey: bytes
validator_network_addresses: bytes
fullnode_network_addresses: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__RemoveValidatorAndReconfigure(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. |
| `validator_address` | `address` | The validator account address to be removed from the validator set. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account |
| 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::ENOT_AN_ACTIVE_VALIDATOR` | The validator to be removed is not in the validator set. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `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`
"""
sliding_nonce: st.uint64
validator_name: bytes
validator_address: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptFunctionCall__RotateAuthenticationKey(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys),
and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account of the transaction. |
| `new_key` | `vector<u8>` | New authentication key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin`
* `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address`
"""
new_key: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__RotateAuthenticationKeyWithNonce(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys),
and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account of the transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_key` | `vector<u8>` | New authentication key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `AccountAdministrationScripts::rotate_authentication_key`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin`
* `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address`
"""
sliding_nonce: st.uint64
new_key: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__RotateAuthenticationKeyWithNonceAdmin(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys),
and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of the write set transaction. May only be the Diem Root signer. |
| `account` | `signer` | Signer of account specified in the `execute_as` field of the write set transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. |
| `new_key` | `vector<u8>` | New authentication key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `AccountAdministrationScripts::rotate_authentication_key`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce`
* `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address`
"""
sliding_nonce: st.uint64
new_key: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__RotateAuthenticationKeyWithRecoveryAddress(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account of the transaction. |
| `recovery_address` | `address` | Address where `RecoveryAddress::RecoveryAddress` that holds `to_recover`'s `DiemAccount::KeyRotationCapability` is published. |
| `to_recover` | `address` | The address of the account whose authentication key will be updated. |
| `new_key` | `vector<u8>` | New authentication key to be used for the account at the `to_recover` address. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress::RecoveryAddress` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ECANNOT_ROTATE_KEY` | The address of `account` is not `recovery_address` or `to_recover`. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EACCOUNT_NOT_RECOVERABLE` | `to_recover`'s `DiemAccount::KeyRotationCapability` is not in the `RecoveryAddress::RecoveryAddress` resource published under `recovery_address`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `AccountAdministrationScripts::rotate_authentication_key`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin`
"""
recovery_address: diem_types.AccountAddress
to_recover: diem_types.AccountAddress
new_key: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__RotateDualAttestationInfo(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account of the transaction. |
| `new_url` | `vector<u8>` | ASCII-encoded url to be used for off-chain communication with `account`. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for on-chain dual attestation checking. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `DualAttestation::ECREDENTIAL` | A `DualAttestation::Credential` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_PUBLIC_KEY` | `new_key` is not a valid ed25519 public key. |
# Related Scripts
* `AccountCreationScripts::create_parent_vasp_account`
* `AccountCreationScripts::create_designated_dealer`
* `AccountAdministrationScripts::rotate_dual_attestation_info`
"""
new_url: bytes
new_key: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__RotateSharedEd25519PublicKey(ScriptFunctionCall):
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys)
using the `DiemAccount::KeyRotationCapability` stored in `account`'s `SharedEd25519PublicKey::SharedEd25519PublicKey`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | The signer of the sending account of the transaction. |
| `public_key` | `vector<u8>` | 32-byte Ed25519 public key. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | A `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. |
# Related Scripts
* `AccountAdministrationScripts::publish_shared_ed25519_public_key`
"""
public_key: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__SetGasConstants(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `global_memory_per_byte_cost` | `u64` | The new cost to read global memory per-byte to be used for gas metering. |
| `global_memory_per_byte_write_cost` | `u64` | The new cost to write global memory per-byte to be used for gas metering. |
| `min_transaction_gas_units` | `u64` | The new flat minimum amount of gas required for any transaction. |
| `large_transaction_cutoff` | `u64` | The new size over which an additional charge will be assessed for each additional byte. |
| `intrinsic_gas_per_byte` | `u64` | The new number of units of gas that to be charged per-byte over the new `large_transaction_cutoff`. |
| `maximum_number_of_gas_units` | `u64` | The new maximum number of gas units that can be set in a transaction. |
| `min_price_per_gas_unit` | `u64` | The new minimum gas price that can be set for a transaction. |
| `max_price_per_gas_unit` | `u64` | The new maximum gas price that can be set for a transaction. |
| `max_transaction_size_in_bytes` | `u64` | The new maximum size of a transaction that can be processed. |
| `gas_unit_scaling_factor` | `u64` | The new scaling factor to use when scaling between external and internal gas units. |
| `default_account_size` | `u64` | The new default account size to use when assessing final costs for reads and writes to global storage. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_ARGUMENT` | `DiemVMConfig::EGAS_CONSTANT_INCONSISTENCY` | The provided gas constants are inconsistent. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
"""
sliding_nonce: st.uint64
global_memory_per_byte_cost: st.uint64
global_memory_per_byte_write_cost: st.uint64
min_transaction_gas_units: st.uint64
large_transaction_cutoff: st.uint64
intrinsic_gas_per_byte: st.uint64
maximum_number_of_gas_units: st.uint64
min_price_per_gas_unit: st.uint64
max_price_per_gas_unit: st.uint64
max_transaction_size_in_bytes: st.uint64
gas_unit_scaling_factor: st.uint64
default_account_size: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__SetValidatorConfigAndReconfigure(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `validator_operator_account` | `signer` | Signer of the sending account. Must be the registered validator operator for the validator at `validator_address`. |
| `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. |
| `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR_OPERATOR` | `validator_operator_account` does not have a Validator Operator role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `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`
"""
validator_account: diem_types.AccountAddress
consensus_pubkey: bytes
validator_network_addresses: bytes
fullnode_network_addresses: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__SetValidatorOperator(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | The signer of the sending account of the transaction. |
| `operator_name` | `vector<u8>` | Validator operator's human name. |
| `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. |
| 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. |
# Related Scripts
* `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`
"""
operator_name: bytes
operator_account: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptFunctionCall__SetValidatorOperatorWithNonceAdmin(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | Signer of the sending account of the write set transaction. May only be the Diem Root signer. |
| `account` | `signer` | Signer of account specified in the `execute_as` field of the write set transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. |
| `operator_name` | `vector<u8>` | Validator operator's human name. |
| `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account |
| `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. |
| 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. |
# Related Scripts
* `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`
"""
sliding_nonce: st.uint64
operator_name: bytes
operator_account: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptFunctionCall__TieredMint(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` being minted. `CoinType` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `designated_dealer_address` | `address` | The address of the Designated Dealer account being minted to. |
| `mint_amount` | `u64` | The number of coins to be minted. |
| `tier_index` | `u64` | [Deprecated] The mint tier index to use for the Designated Dealer account. Will be ignored |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_MINT_AMOUNT` | `mint_amount` is zero. |
| `Errors::NOT_PUBLISHED` | `DesignatedDealer::EDEALER` | `DesignatedDealer::Dealer` or `DesignatedDealer::TierInfo<CoinType>` resource does not exist at `designated_dealer_address`. |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EMINT_CAPABILITY` | `tc_account` does not have a `Diem::MintCapability<CoinType>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EMINTING_NOT_ALLOWED` | Minting is not currently allowed for `CoinType` coins. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds would exceed the `account`'s account limits. |
# Related Scripts
* `AccountCreationScripts::create_designated_dealer`
* `PaymentScripts::peer_to_peer_with_metadata`
* `AccountAdministrationScripts::rotate_dual_attestation_info`
"""
coin_type: diem_types.TypeTag
sliding_nonce: st.uint64
designated_dealer_address: diem_types.AccountAddress
mint_amount: st.uint64
tier_index: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__UnfreezeAccount(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `to_unfreeze_account` | `address` | The account address to be frozen. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
# Related Scripts
* `TreasuryComplianceScripts::freeze_account`
"""
sliding_nonce: st.uint64
to_unfreeze_account: diem_types.AccountAddress
@dataclass(frozen=True)
class ScriptFunctionCall__UpdateDiemConsensusConfig(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `config` | `vector<u8>` | The serialized bytes of consensus config. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
"""
sliding_nonce: st.uint64
config: bytes
@dataclass(frozen=True)
class ScriptFunctionCall__UpdateDiemVersion(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `major` | `u64` | The `major` version of the VM to be used from this transaction on. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
| `Errors::INVALID_ARGUMENT` | `DiemVersion::EINVALID_MAJOR_VERSION_NUMBER` | `major` is less-than or equal to the current major version stored on-chain. |
"""
sliding_nonce: st.uint64
major: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__UpdateDualAttestationLimit(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_micro_xdx_limit` | `u64` | The new dual attestation limit to be used on-chain. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
# Related Scripts
* `TreasuryComplianceScripts::update_exchange_rate`
* `TreasuryComplianceScripts::update_minting_ability`
"""
sliding_nonce: st.uint64
new_micro_xdx_limit: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__UpdateExchangeRate(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` whose exchange rate is being updated. `Currency` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for the transaction. |
| `new_exchange_rate_numerator` | `u64` | The numerator for the new to micro-XDX exchange rate for `Currency`. |
| `new_exchange_rate_denominator` | `u64` | The denominator for the new to micro-XDX exchange rate for `Currency`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `FixedPoint32::EDENOMINATOR` | `new_exchange_rate_denominator` is zero. |
| `Errors::INVALID_ARGUMENT` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. |
| `Errors::LIMIT_EXCEEDED` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. |
# Related Scripts
* `TreasuryComplianceScripts::update_dual_attestation_limit`
* `TreasuryComplianceScripts::update_minting_ability`
"""
currency: diem_types.TypeTag
sliding_nonce: st.uint64
new_exchange_rate_numerator: st.uint64
new_exchange_rate_denominator: st.uint64
@dataclass(frozen=True)
class ScriptFunctionCall__UpdateMintingAbility(ScriptFunctionCall):
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` whose minting ability is being updated. `Currency` must be an already-registered currency on-chain. |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `allow_minting` | `bool` | Whether to allow minting of new coins in `Currency`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | `Currency` is not a registered currency on-chain. |
# Related Scripts
* `TreasuryComplianceScripts::update_dual_attestation_limit`
* `TreasuryComplianceScripts::update_exchange_rate`
"""
currency: diem_types.TypeTag
allow_minting: bool
from diem.bcs import deserialize as bcs_deserialize, serialize as bcs_serialize
from diem.diem_types import (
Script,
ScriptFunction,
TransactionPayload,
TransactionPayload__ScriptFunction,
Identifier,
ModuleId,
TypeTag,
AccountAddress,
TransactionArgument,
TransactionArgument__Bool,
TransactionArgument__U8,
TransactionArgument__U64,
TransactionArgument__U128,
TransactionArgument__Address,
TransactionArgument__U8Vector,
)
def encode_script(call: ScriptCall) -> Script:
"""Build a Diem `Script` from a structured object `ScriptCall`."""
helper = TRANSACTION_SCRIPT_ENCODER_MAP[call.__class__]
return helper(call)
def encode_script_function(call: ScriptFunctionCall) -> TransactionPayload:
"""Build a Diem `ScriptFunction` `TransactionPayload` from a structured object `ScriptFunctionCall`."""
helper = SCRIPT_FUNCTION_ENCODER_MAP[call.__class__]
return helper(call)
def decode_script(script: Script) -> ScriptCall:
"""Try to recognize a Diem `Script` and convert it into a structured object `ScriptCall`."""
helper = TRANSACTION_SCRIPT_DECODER_MAP.get(script.code)
if helper is None:
raise ValueError("Unknown script bytecode")
return helper(script)
def decode_script_function_payload(payload: TransactionPayload) -> ScriptFunctionCall:
"""Try to recognize a Diem `TransactionPayload` and convert it into a structured object `ScriptFunctionCall`."""
if not isinstance(payload, TransactionPayload__ScriptFunction):
raise ValueError("Unexpected transaction payload")
script = payload.value
helper = SCRIPT_FUNCTION_DECODER_MAP.get(script.module.name.value + script.function.value)
if helper is None:
raise ValueError("Unknown script bytecode")
return helper(script)
def encode_add_currency_to_account_script(currency: TypeTag) -> Script:
"""# Summary
Adds a zero `Currency` balance to the sending `account`.
This will enable `account` to
send, receive, and hold `Diem::Diem<Currency>` coins. This transaction can be
successfully sent by any account that is allowed to hold balances
(e.g., VASP, Designated Dealer).
# Technical Description
After the successful execution of this transaction the sending account will have a
`DiemAccount::Balance<Currency>` resource with zero balance published under it. Only
accounts that can hold balances can send this transaction, the sending account cannot
already have a `DiemAccount::Balance<Currency>` published under it.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` being added to the sending account of the transaction. `Currency` must be an already-registered currency on-chain. |
| `account` | `&signer` | The signer of the sending account of the transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EROLE_CANT_STORE_BALANCE` | The sending `account`'s role does not permit balances. |
| `Errors::ALREADY_PUBLISHED` | `DiemAccount::EADD_EXISTING_CURRENCY` | A balance for `Currency` is already published under the sending `account`. |
# Related Scripts
* `Script::create_child_vasp_account`
* `Script::create_parent_vasp_account`
* `Script::peer_to_peer_with_metadata`
"""
return Script(
code=ADD_CURRENCY_TO_ACCOUNT_CODE,
ty_args=[currency],
args=[],
)
def encode_add_currency_to_account_script_function(currency: TypeTag) -> TransactionPayload:
"""# Summary
Adds a zero `Currency` balance to the sending `account`.
This will enable `account` to
send, receive, and hold `Diem::Diem<Currency>` coins. This transaction can be
successfully sent by any account that is allowed to hold balances
(e.g., VASP, Designated Dealer).
# Technical Description
After the successful execution of this transaction the sending account will have a
`DiemAccount::Balance<Currency>` resource with zero balance published under it. Only
accounts that can hold balances can send this transaction, the sending account cannot
already have a `DiemAccount::Balance<Currency>` published under it.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` being added to the sending account of the transaction. `Currency` must be an already-registered currency on-chain. |
| `account` | `signer` | The signer of the sending account of the transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EROLE_CANT_STORE_BALANCE` | The sending `account`'s role does not permit balances. |
| `Errors::ALREADY_PUBLISHED` | `DiemAccount::EADD_EXISTING_CURRENCY` | A balance for `Currency` is already published under the sending `account`. |
# Related Scripts
* `AccountCreationScripts::create_child_vasp_account`
* `AccountCreationScripts::create_parent_vasp_account`
* `PaymentScripts::peer_to_peer_with_metadata`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("add_currency_to_account"),
ty_args=[currency],
args=[],
)
)
def encode_add_recovery_rotation_capability_script(recovery_address: AccountAddress) -> Script:
"""# 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 `Script::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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `to_recover_account` | `&signer` | The signer reference of the sending account of this transaction. |
| `recovery_address` | `address` | The account address where the `to_recover_account`'s `DiemAccount::KeyRotationCapability` will be stored. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `to_recover_account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EINVALID_KEY_ROTATION_DELEGATION` | `to_recover_account` and `recovery_address` do not belong to the same VASP. |
| `Errors::LIMIT_EXCEEDED` | ` RecoveryAddress::EMAX_KEYS_REGISTERED` | `RecoveryAddress::MAX_REGISTERED_KEYS` have already been registered with this `recovery_address`. |
# Related Scripts
* `Script::create_recovery_address`
* `Script::rotate_authentication_key_with_recovery_address`
"""
return Script(
code=ADD_RECOVERY_ROTATION_CAPABILITY_CODE,
ty_args=[],
args=[TransactionArgument__Address(value=recovery_address)],
)
def encode_add_recovery_rotation_capability_script_function(recovery_address: AccountAddress) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `to_recover_account` | `signer` | The signer of the sending account of this transaction. |
| `recovery_address` | `address` | The account address where the `to_recover_account`'s `DiemAccount::KeyRotationCapability` will be stored. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `to_recover_account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EINVALID_KEY_ROTATION_DELEGATION` | `to_recover_account` and `recovery_address` do not belong to the same VASP. |
| `Errors::LIMIT_EXCEEDED` | ` RecoveryAddress::EMAX_KEYS_REGISTERED` | `RecoveryAddress::MAX_REGISTERED_KEYS` have already been registered with this `recovery_address`. |
# Related Scripts
* `AccountAdministrationScripts::create_recovery_address`
* `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("add_recovery_rotation_capability"),
ty_args=[],
args=[encode_address_argument(recovery_address)],
)
)
def encode_add_validator_and_reconfigure_script(
sliding_nonce: st.uint64, validator_name: bytes, validator_address: AccountAddress
) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. |
| `validator_address` | `address` | The validator account address to be added to the validator set. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::EINVALID_PROSPECTIVE_VALIDATOR` | The validator to be added does not have a `ValidatorConfig::ValidatorConfig` resource published under it, or its `config` field is empty. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::EALREADY_A_VALIDATOR` | The `validator_address` account is already a registered validator. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
return Script(
code=ADD_VALIDATOR_AND_RECONFIGURE_CODE,
ty_args=[],
args=[
TransactionArgument__U64(value=sliding_nonce),
TransactionArgument__U8Vector(value=validator_name),
TransactionArgument__Address(value=validator_address),
],
)
def encode_add_validator_and_reconfigure_script_function(
sliding_nonce: st.uint64, validator_name: bytes, validator_address: AccountAddress
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. |
| `validator_address` | `address` | The validator account address to be added to the validator set. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::EINVALID_PROSPECTIVE_VALIDATOR` | The validator to be added does not have a `ValidatorConfig::ValidatorConfig` resource published under it, or its `config` field is empty. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::EALREADY_A_VALIDATOR` | The `validator_address` account is already a registered validator. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
| `Errors::LIMIT_EXCEEDED` | `DiemSystem::EMAX_VALIDATORS` | The validator set is already at its maximum size. The validator could not be added. |
# Related Scripts
* `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`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("ValidatorAdministrationScripts"),
),
function=Identifier("add_validator_and_reconfigure"),
ty_args=[],
args=[
encode_u64_argument(sliding_nonce),
encode_u8vector_argument(validator_name),
encode_address_argument(validator_address),
],
)
)
def encode_burn_script(token: TypeTag, sliding_nonce: st.uint64, preburn_address: AccountAddress) -> Script:
"""# Summary
Burns all coins held in the preburn resource at the specified
preburn address and removes them from the system.
The sending account must
be the Treasury Compliance account.
The account that holds the preburn 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currency being burned. `Token` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction, must have a burn capability for `Token` published under it. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `preburn_address` | `address` | The address where the coins to-be-burned are currently held. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | The account at `preburn_address` does not have a `Diem::Preburn<Token>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_EMPTY` | The `Diem::Preburn<Token>` resource is empty (has a value of 0). |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. |
# Related Scripts
* `Script::burn_txn_fees`
* `Script::cancel_burn`
* `Script::preburn`
"""
return Script(
code=BURN_CODE,
ty_args=[token],
args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=preburn_address)],
)
def encode_burn_txn_fees_script(coin_type: TypeTag) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` being added to the sending account of the transaction. `CoinType` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `TransactionFee::ETRANSACTION_FEE` | `CoinType` is not an accepted transaction fee currency. |
| `Errors::INVALID_ARGUMENT` | `Diem::ECOIN` | The collected fees in `CoinType` are zero. |
# Related Scripts
* `Script::burn`
* `Script::cancel_burn`
"""
return Script(
code=BURN_TXN_FEES_CODE,
ty_args=[coin_type],
args=[],
)
def encode_burn_txn_fees_script_function(coin_type: TypeTag) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` being added to the sending account of the transaction. `CoinType` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `TransactionFee::ETRANSACTION_FEE` | `CoinType` is not an accepted transaction fee currency. |
| `Errors::INVALID_ARGUMENT` | `Diem::ECOIN` | The collected fees in `CoinType` are zero. |
# Related Scripts
* `TreasuryComplianceScripts::burn_with_amount`
* `TreasuryComplianceScripts::cancel_burn_with_amount`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("burn_txn_fees"),
ty_args=[coin_type],
args=[],
)
)
def encode_burn_with_amount_script_function(
token: TypeTag, sliding_nonce: st.uint64, preburn_address: AccountAddress, amount: st.uint64
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currency being burned. `Token` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction, must have a burn capability for `Token` published under it. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `preburn_address` | `address` | The address where the coins to-be-burned are currently held. |
| `amount` | `u64` | The amount to be burned. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_NOT_FOUND` | The `Diem::PreburnQueue<Token>` resource under `preburn_address` does not contain a preburn request with a value matching `amount`. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN_QUEUE` | The account at `preburn_address` does not have a `Diem::PreburnQueue<Token>` resource published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. |
# Related Scripts
* `TreasuryComplianceScripts::burn_txn_fees`
* `TreasuryComplianceScripts::cancel_burn_with_amount`
* `TreasuryComplianceScripts::preburn`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("burn_with_amount"),
ty_args=[token],
args=[
encode_u64_argument(sliding_nonce),
encode_address_argument(preburn_address),
encode_u64_argument(amount),
],
)
)
def encode_cancel_burn_script(token: TypeTag, preburn_address: AccountAddress) -> Script:
"""# Summary
Cancels and returns all coins held in the preburn area under
`preburn_address` 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currenty that burning is being cancelled for. `Token` must be an already-registered currency on-chain. |
| `account` | `&signer` | The signer reference of the sending account of this transaction, must have a burn capability for `Token` published under it. |
| `preburn_address` | `address` | The address where the coins to-be-burned are currently held. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | The account at `preburn_address` does not have a `Diem::Preburn<Token>` resource published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | The value held in the preburn resource was zero. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | The account at `preburn_address` doesn't have a balance resource for `Token`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds held in the prebun area would exceed the `account`'s account limits. |
| `Errors::INVALID_STATE` | `DualAttestation::EPAYEE_COMPLIANCE_KEY_NOT_SET` | The `account` does not have a compliance key set on it but dual attestion checking was performed. |
# Related Scripts
* `Script::burn_txn_fees`
* `Script::burn`
* `Script::preburn`
"""
return Script(
code=CANCEL_BURN_CODE,
ty_args=[token],
args=[TransactionArgument__Address(value=preburn_address)],
)
def encode_cancel_burn_with_amount_script_function(
token: TypeTag, preburn_address: AccountAddress, amount: st.uint64
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currenty that burning is being cancelled for. `Token` must be an already-registered currency on-chain. |
| `account` | `signer` | The signer of the sending account of this transaction, must have a burn capability for `Token` published under it. |
| `preburn_address` | `address` | The address where the coins to-be-burned are currently held. |
| `amount` | `u64` | The amount to be cancelled. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_NOT_FOUND` | The `Diem::PreburnQueue<Token>` resource under `preburn_address` does not contain a preburn request with a value matching `amount`. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN_QUEUE` | The account at `preburn_address` does not have a `Diem::PreburnQueue<Token>` resource published under it. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | The account at `preburn_address` doesn't have a balance resource for `Token`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds held in the prebun area would exceed the `account`'s account limits. |
| `Errors::INVALID_STATE` | `DualAttestation::EPAYEE_COMPLIANCE_KEY_NOT_SET` | The `account` does not have a compliance key set on it but dual attestion checking was performed. |
# Related Scripts
* `TreasuryComplianceScripts::burn_txn_fees`
* `TreasuryComplianceScripts::burn_with_amount`
* `TreasuryComplianceScripts::preburn`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("cancel_burn_with_amount"),
ty_args=[token],
args=[encode_address_argument(preburn_address), encode_u64_argument(amount)],
)
)
def encode_create_child_vasp_account_script(
coin_type: TypeTag,
child_address: AccountAddress,
auth_key_prefix: bytes,
add_all_currencies: bool,
child_initial_balance: st.uint64,
) -> Script:
"""# 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`.
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 with a `child_initial_balance` greater than zero will emit:
* A `DiemAccount::SentPaymentEvent` with the `payer` field being the Parent VASP's address,
and 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,
and payee field being `child_address`. This is emitted on the new Child VASPS's
`DiemAccount::DiemAccount` `received_events` handle.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` that the child account should be created with. `CoinType` must be an already-registered currency on-chain. |
| `parent_vasp` | `&signer` | The signer reference of the sending account. Must be a Parent VASP account. |
| `child_address` | `address` | Address of the to-be-created Child VASP account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. |
| `child_initial_balance` | `u64` | The initial balance in `CoinType` to give the child account when it's created. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | The `auth_key_prefix` was not of length 32. |
| `Errors::REQUIRES_ROLE` | `Roles::EPARENT_VASP` | The sending account wasn't a Parent VASP account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `child_address` address is already taken. |
| `Errors::LIMIT_EXCEEDED` | `VASP::ETOO_MANY_CHILDREN` | The sending account has reached the maximum number of allowed child accounts. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. |
| `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for the sending account has already been extracted. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | The sending account doesn't have a balance in `CoinType`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | The sending account doesn't have at least `child_initial_balance` of `CoinType` balance. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECANNOT_CREATE_AT_VM_RESERVED` | The `child_address` is the reserved address 0x0. |
# Related Scripts
* `Script::create_parent_vasp_account`
* `Script::add_currency_to_account`
* `Script::rotate_authentication_key`
* `Script::add_recovery_rotation_capability`
* `Script::create_recovery_address`
"""
return Script(
code=CREATE_CHILD_VASP_ACCOUNT_CODE,
ty_args=[coin_type],
args=[
TransactionArgument__Address(value=child_address),
TransactionArgument__U8Vector(value=auth_key_prefix),
TransactionArgument__Bool(value=add_all_currencies),
TransactionArgument__U64(value=child_initial_balance),
],
)
def encode_create_child_vasp_account_script_function(
coin_type: TypeTag,
child_address: AccountAddress,
auth_key_prefix: bytes,
add_all_currencies: bool,
child_initial_balance: st.uint64,
) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` that the child account should be created with. `CoinType` must be an already-registered currency on-chain. |
| `parent_vasp` | `signer` | The reference of the sending account. Must be a Parent VASP account. |
| `child_address` | `address` | Address of the to-be-created Child VASP account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. |
| `child_initial_balance` | `u64` | The initial balance in `CoinType` to give the child account when it's created. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | The `auth_key_prefix` was not of length 32. |
| `Errors::REQUIRES_ROLE` | `Roles::EPARENT_VASP` | The sending account wasn't a Parent VASP account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `child_address` address is already taken. |
| `Errors::LIMIT_EXCEEDED` | `VASP::ETOO_MANY_CHILDREN` | The sending account has reached the maximum number of allowed child accounts. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. |
| `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for the sending account has already been extracted. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | The sending account doesn't have a balance in `CoinType`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | The sending account doesn't have at least `child_initial_balance` of `CoinType` balance. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECANNOT_CREATE_AT_VM_RESERVED` | The `child_address` is the reserved address 0x0. |
# Related Scripts
* `AccountCreationScripts::create_parent_vasp_account`
* `AccountAdministrationScripts::add_currency_to_account`
* `AccountAdministrationScripts::rotate_authentication_key`
* `AccountAdministrationScripts::add_recovery_rotation_capability`
* `AccountAdministrationScripts::create_recovery_address`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountCreationScripts"),
),
function=Identifier("create_child_vasp_account"),
ty_args=[coin_type],
args=[
encode_address_argument(child_address),
encode_u8vector_argument(auth_key_prefix),
encode_bool_argument(add_all_currencies),
encode_u64_argument(child_initial_balance),
],
)
)
def encode_create_designated_dealer_script(
currency: TypeTag,
sliding_nonce: st.uint64,
addr: AccountAddress,
auth_key_prefix: bytes,
human_name: bytes,
add_all_currencies: bool,
) -> Script:
"""# 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.
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.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` that the Designated Dealer should be initialized with. `Currency` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `addr` | `address` | Address of the to-be-created Designated Dealer account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the Designated Dealer. |
| `add_all_currencies` | `bool` | Whether 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 Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `addr` address is already taken. |
# Related Scripts
* `Script::tiered_mint`
* `Script::peer_to_peer_with_metadata`
* `Script::rotate_dual_attestation_info`
"""
return Script(
code=CREATE_DESIGNATED_DEALER_CODE,
ty_args=[currency],
args=[
TransactionArgument__U64(value=sliding_nonce),
TransactionArgument__Address(value=addr),
TransactionArgument__U8Vector(value=auth_key_prefix),
TransactionArgument__U8Vector(value=human_name),
TransactionArgument__Bool(value=add_all_currencies),
],
)
def encode_create_designated_dealer_script_function(
currency: TypeTag,
sliding_nonce: st.uint64,
addr: AccountAddress,
auth_key_prefix: bytes,
human_name: bytes,
add_all_currencies: bool,
) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` that the Designated Dealer should be initialized with. `Currency` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `addr` | `address` | Address of the to-be-created Designated Dealer account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the Designated Dealer. |
| `add_all_currencies` | `bool` | Whether 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 Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `addr` address is already taken. |
# Related Scripts
* `TreasuryComplianceScripts::tiered_mint`
* `PaymentScripts::peer_to_peer_with_metadata`
* `AccountAdministrationScripts::rotate_dual_attestation_info`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountCreationScripts"),
),
function=Identifier("create_designated_dealer"),
ty_args=[currency],
args=[
encode_u64_argument(sliding_nonce),
encode_address_argument(addr),
encode_u8vector_argument(auth_key_prefix),
encode_u8vector_argument(human_name),
encode_bool_argument(add_all_currencies),
],
)
)
def encode_create_parent_vasp_account_script(
coin_type: TypeTag,
sliding_nonce: st.uint64,
new_account_address: AccountAddress,
auth_key_prefix: bytes,
human_name: bytes,
add_all_currencies: bool,
) -> Script:
"""# 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.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The 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_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Parent VASP account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the Parent VASP. |
| `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `Script::create_child_vasp_account`
* `Script::add_currency_to_account`
* `Script::rotate_authentication_key`
* `Script::add_recovery_rotation_capability`
* `Script::create_recovery_address`
* `Script::rotate_dual_attestation_info`
"""
return Script(
code=CREATE_PARENT_VASP_ACCOUNT_CODE,
ty_args=[coin_type],
args=[
TransactionArgument__U64(value=sliding_nonce),
TransactionArgument__Address(value=new_account_address),
TransactionArgument__U8Vector(value=auth_key_prefix),
TransactionArgument__U8Vector(value=human_name),
TransactionArgument__Bool(value=add_all_currencies),
],
)
def encode_create_parent_vasp_account_script_function(
coin_type: TypeTag,
sliding_nonce: st.uint64,
new_account_address: AccountAddress,
auth_key_prefix: bytes,
human_name: bytes,
add_all_currencies: bool,
) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The 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_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Parent VASP account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the Parent VASP. |
| `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `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`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountCreationScripts"),
),
function=Identifier("create_parent_vasp_account"),
ty_args=[coin_type],
args=[
encode_u64_argument(sliding_nonce),
encode_address_argument(new_account_address),
encode_u8vector_argument(auth_key_prefix),
encode_u8vector_argument(human_name),
encode_bool_argument(add_all_currencies),
],
)
)
def encode_create_recovery_address_script() -> Script:
"""# Summary
Initializes the sending account as a recovery address that may be used by
the VASP that it belongs to.
The sending account must be a 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | The signer of the sending account of the transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ENOT_A_VASP` | `account` is not a VASP account. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EKEY_ROTATION_DEPENDENCY_CYCLE` | A key rotation recovery cycle would be created by adding `account`'s key rotation capability. |
| `Errors::ALREADY_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | A `RecoveryAddress::RecoveryAddress` resource has already been published under `account`. |
# Related Scripts
* `Script::add_recovery_rotation_capability`
* `Script::rotate_authentication_key_with_recovery_address`
"""
return Script(
code=CREATE_RECOVERY_ADDRESS_CODE,
ty_args=[],
args=[],
)
def encode_create_recovery_address_script_function() -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | The signer of the sending account of the transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ENOT_A_VASP` | `account` is not a VASP account. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EKEY_ROTATION_DEPENDENCY_CYCLE` | A key rotation recovery cycle would be created by adding `account`'s key rotation capability. |
| `Errors::ALREADY_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | A `RecoveryAddress::RecoveryAddress` resource has already been published under `account`. |
# Related Scripts
* `Script::add_recovery_rotation_capability`
* `Script::rotate_authentication_key_with_recovery_address`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("create_recovery_address"),
ty_args=[],
args=[],
)
)
def encode_create_validator_account_script(
sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes
) -> Script:
"""# 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.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Validator account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `Script::add_validator_and_reconfigure`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
return Script(
code=CREATE_VALIDATOR_ACCOUNT_CODE,
ty_args=[],
args=[
TransactionArgument__U64(value=sliding_nonce),
TransactionArgument__Address(value=new_account_address),
TransactionArgument__U8Vector(value=auth_key_prefix),
TransactionArgument__U8Vector(value=human_name),
],
)
def encode_create_validator_account_script_function(
sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes
) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Validator account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `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`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountCreationScripts"),
),
function=Identifier("create_validator_account"),
ty_args=[],
args=[
encode_u64_argument(sliding_nonce),
encode_address_argument(new_account_address),
encode_u8vector_argument(auth_key_prefix),
encode_u8vector_argument(human_name),
],
)
)
def encode_create_validator_operator_account_script(
sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes
) -> Script:
"""# 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.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Validator account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `Script::create_validator_account`
* `Script::add_validator_and_reconfigure`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
return Script(
code=CREATE_VALIDATOR_OPERATOR_ACCOUNT_CODE,
ty_args=[],
args=[
TransactionArgument__U64(value=sliding_nonce),
TransactionArgument__Address(value=new_account_address),
TransactionArgument__U8Vector(value=auth_key_prefix),
TransactionArgument__U8Vector(value=human_name),
],
)
def encode_create_validator_operator_account_script_function(
sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes
) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_account_address` | `address` | Address of the to-be-created Validator account. |
| `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. |
| `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. |
# Related Scripts
* `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`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountCreationScripts"),
),
function=Identifier("create_validator_operator_account"),
ty_args=[],
args=[
encode_u64_argument(sliding_nonce),
encode_address_argument(new_account_address),
encode_u8vector_argument(auth_key_prefix),
encode_u8vector_argument(human_name),
],
)
)
def encode_freeze_account_script(sliding_nonce: st.uint64, to_freeze_account: AccountAddress) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `to_freeze_account` | `address` | The account address to be frozen. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_TC` | `to_freeze_account` was the Treasury Compliance account (`0xB1E55ED`). |
| `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_DIEM_ROOT` | `to_freeze_account` was the Diem Root account (`0xA550C18`). |
# Related Scripts
* `Script::unfreeze_account`
"""
return Script(
code=FREEZE_ACCOUNT_CODE,
ty_args=[],
args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=to_freeze_account)],
)
def encode_freeze_account_script_function(
sliding_nonce: st.uint64, to_freeze_account: AccountAddress
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `to_freeze_account` | `address` | The account address to be frozen. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_TC` | `to_freeze_account` was the Treasury Compliance account (`0xB1E55ED`). |
| `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_DIEM_ROOT` | `to_freeze_account` was the Diem Root account (`0xA550C18`). |
# Related Scripts
* `TreasuryComplianceScripts::unfreeze_account`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("freeze_account"),
ty_args=[],
args=[encode_u64_argument(sliding_nonce), encode_address_argument(to_freeze_account)],
)
)
def encode_initialize_diem_consensus_config_script_function(sliding_nonce: st.uint64) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("SystemAdministrationScripts"),
),
function=Identifier("initialize_diem_consensus_config"),
ty_args=[],
args=[encode_u64_argument(sliding_nonce)],
)
)
def encode_peer_to_peer_with_metadata_script(
currency: TypeTag, payee: AccountAddress, amount: st.uint64, metadata: bytes, metadata_signature: bytes
) -> Script:
"""# 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
`metadata` | `Signer::address_of(payer)` | `amount` | `DualAttestation::DOMAIN_SEPARATOR`.
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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` being sent in this transaction. `Currency` must be an already-registered currency on-chain. |
| `payer` | `&signer` | The signer reference of the sending account that coins are being transferred from. |
| `payee` | `address` | The address of the account the coins are being transferred to. |
| `metadata` | `vector<u8>` | Optional metadata about this payment. |
| `metadata_signature` | `vector<u8>` | Optional signature over `metadata` and payment information. See |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `payer` doesn't hold a balance in `Currency`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Currency`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | `amount` is zero. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYEE_DOES_NOT_EXIST` | No account exists at the `payee` address. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | An account exists at `payee`, but it does not accept payments in `Currency`. |
| `Errors::INVALID_STATE` | `AccountFreezing::EACCOUNT_FROZEN` | The `payee` account is frozen. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EMALFORMED_METADATA_SIGNATURE` | `metadata_signature` is not 64 bytes. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_METADATA_SIGNATURE` | `metadata_signature` does not verify on the against the `payee'`s `DualAttestation::Credential` `compliance_public_key` public key. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EWITHDRAWAL_EXCEEDS_LIMITS` | `payer` has exceeded its daily withdrawal limits for the backing coins of XDX. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | `payee` has exceeded its daily deposit limits for XDX. |
# Related Scripts
* `Script::create_child_vasp_account`
* `Script::create_parent_vasp_account`
* `Script::add_currency_to_account`
"""
return Script(
code=PEER_TO_PEER_WITH_METADATA_CODE,
ty_args=[currency],
args=[
TransactionArgument__Address(value=payee),
TransactionArgument__U64(value=amount),
TransactionArgument__U8Vector(value=metadata),
TransactionArgument__U8Vector(value=metadata_signature),
],
)
def encode_peer_to_peer_with_metadata_script_function(
currency: TypeTag, payee: AccountAddress, amount: st.uint64, metadata: bytes, metadata_signature: bytes
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` being sent in this transaction. `Currency` must be an already-registered currency on-chain. |
| `payer` | `signer` | The signer of the sending account that coins are being transferred from. |
| `payee` | `address` | The address of the account the coins are being transferred to. |
| `metadata` | `vector<u8>` | Optional metadata about this payment. |
| `metadata_signature` | `vector<u8>` | Optional signature over `metadata` and payment information. See |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `payer` doesn't hold a balance in `Currency`. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Currency`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | `amount` is zero. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYEE_DOES_NOT_EXIST` | No account exists at the `payee` address. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | An account exists at `payee`, but it does not accept payments in `Currency`. |
| `Errors::INVALID_STATE` | `AccountFreezing::EACCOUNT_FROZEN` | The `payee` account is frozen. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EMALFORMED_METADATA_SIGNATURE` | `metadata_signature` is not 64 bytes. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_METADATA_SIGNATURE` | `metadata_signature` does not verify on the against the `payee'`s `DualAttestation::Credential` `compliance_public_key` public key. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EWITHDRAWAL_EXCEEDS_LIMITS` | `payer` has exceeded its daily withdrawal limits for the backing coins of XDX. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | `payee` has exceeded its daily deposit limits for XDX. |
# Related Scripts
* `AccountCreationScripts::create_child_vasp_account`
* `AccountCreationScripts::create_parent_vasp_account`
* `AccountAdministrationScripts::add_currency_to_account`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("PaymentScripts")
),
function=Identifier("peer_to_peer_with_metadata"),
ty_args=[currency],
args=[
encode_address_argument(payee),
encode_u64_argument(amount),
encode_u8vector_argument(metadata),
encode_u8vector_argument(metadata_signature),
],
)
)
def encode_preburn_script(token: TypeTag, amount: st.uint64) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currency being moved to the preburn area. `Token` must be an already-registered currency on-chain. |
| `account` | `&signer` | The signer reference of the sending account. |
| `amount` | `u64` | The amount in `Token` to be moved to the preburn area. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Token` is not a registered currency on-chain. |
| `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for `account` has already been extracted. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Token`. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `account` doesn't hold a balance in `Token`. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | `account` doesn't have a `Diem::Preburn<Token>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_OCCUPIED` | The `value` field in the `Diem::Preburn<Token>` resource under the sender is non-zero. |
| `Errors::NOT_PUBLISHED` | `Roles::EROLE_ID` | The `account` did not have a role assigned to it. |
| `Errors::REQUIRES_ROLE` | `Roles::EDESIGNATED_DEALER` | The `account` did not have the role of DesignatedDealer. |
# Related Scripts
* `Script::cancel_burn`
* `Script::burn`
* `Script::burn_txn_fees`
"""
return Script(
code=PREBURN_CODE,
ty_args=[token],
args=[TransactionArgument__U64(value=amount)],
)
def encode_preburn_script_function(token: TypeTag, amount: st.uint64) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Token` | Type | The Move type for the `Token` currency being moved to the preburn area. `Token` must be an already-registered currency on-chain. |
| `account` | `signer` | The signer of the sending account. |
| `amount` | `u64` | The amount in `Token` to be moved to the preburn area. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Token` is not a registered currency on-chain. |
| `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for `account` has already been extracted. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Token`. |
| `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `account` doesn't hold a balance in `Token`. |
| `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | `account` doesn't have a `Diem::Preburn<Token>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EPREBURN_OCCUPIED` | The `value` field in the `Diem::Preburn<Token>` resource under the sender is non-zero. |
| `Errors::NOT_PUBLISHED` | `Roles::EROLE_ID` | The `account` did not have a role assigned to it. |
| `Errors::REQUIRES_ROLE` | `Roles::EDESIGNATED_DEALER` | The `account` did not have the role of DesignatedDealer. |
# Related Scripts
* `TreasuryComplianceScripts::cancel_burn_with_amount`
* `TreasuryComplianceScripts::burn_with_amount`
* `TreasuryComplianceScripts::burn_txn_fees`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("preburn"),
ty_args=[token],
args=[encode_u64_argument(amount)],
)
)
def encode_publish_shared_ed25519_public_key_script(public_key: bytes) -> Script:
"""# Summary
Rotates the authentication key of the sending account to the
newly-specified public key and publishes a new shared authentication key
under the sender's account.
Any account can send this transaction.
# Technical Description
Rotates the authentication key of the sending account to `public_key`,
and publishes a `SharedEd25519PublicKey::SharedEd25519PublicKey` resource
containing the 32-byte ed25519 `public_key` and the `DiemAccount::KeyRotationCapability` for
`account` under `account`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | The signer reference of the sending account of the transaction. |
| `public_key` | `vector<u8>` | 32-byte Ed25519 public key for `account`' authentication key to be rotated to and stored. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability` resource. |
| `Errors::ALREADY_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | The `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is already published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. |
# Related Scripts
* `Script::rotate_shared_ed25519_public_key`
"""
return Script(
code=PUBLISH_SHARED_ED25519_PUBLIC_KEY_CODE,
ty_args=[],
args=[TransactionArgument__U8Vector(value=public_key)],
)
def encode_publish_shared_ed25519_public_key_script_function(public_key: bytes) -> TransactionPayload:
"""# 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`](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys)
and publishes a `SharedEd25519PublicKey::SharedEd25519PublicKey` resource
containing the 32-byte ed25519 `public_key` and the `DiemAccount::KeyRotationCapability` for
`account` under `account`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | The signer of the sending account of the transaction. |
| `public_key` | `vector<u8>` | A valid 32-byte Ed25519 public key for `account`'s authentication key to be rotated to and stored. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability` resource. |
| `Errors::ALREADY_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | The `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is already published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. |
# Related Scripts
* `AccountAdministrationScripts::rotate_shared_ed25519_public_key`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("publish_shared_ed25519_public_key"),
ty_args=[],
args=[encode_u8vector_argument(public_key)],
)
)
def encode_register_validator_config_script(
validator_account: AccountAddress,
consensus_pubkey: bytes,
validator_network_addresses: bytes,
fullnode_network_addresses: bytes,
) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `validator_operator_account` | `&signer` | Signer reference of the sending account. Must be the registered validator operator for the validator at `validator_address`. |
| `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. |
| `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::add_validator_and_reconfigure`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
return Script(
code=REGISTER_VALIDATOR_CONFIG_CODE,
ty_args=[],
args=[
TransactionArgument__Address(value=validator_account),
TransactionArgument__U8Vector(value=consensus_pubkey),
TransactionArgument__U8Vector(value=validator_network_addresses),
TransactionArgument__U8Vector(value=fullnode_network_addresses),
],
)
def encode_register_validator_config_script_function(
validator_account: AccountAddress,
consensus_pubkey: bytes,
validator_network_addresses: bytes,
fullnode_network_addresses: bytes,
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `validator_operator_account` | `signer` | Signer of the sending account. Must be the registered validator operator for the validator at `validator_address`. |
| `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. |
| `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. |
# Related Scripts
* `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`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("ValidatorAdministrationScripts"),
),
function=Identifier("register_validator_config"),
ty_args=[],
args=[
encode_address_argument(validator_account),
encode_u8vector_argument(consensus_pubkey),
encode_u8vector_argument(validator_network_addresses),
encode_u8vector_argument(fullnode_network_addresses),
],
)
)
def encode_remove_validator_and_reconfigure_script(
sliding_nonce: st.uint64, validator_name: bytes, validator_address: AccountAddress
) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. |
| `validator_address` | `address` | The validator account address to be removed from the validator set. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account |
| 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::ENOT_AN_ACTIVE_VALIDATOR` | The validator to be removed is not in the validator set. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::add_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
return Script(
code=REMOVE_VALIDATOR_AND_RECONFIGURE_CODE,
ty_args=[],
args=[
TransactionArgument__U64(value=sliding_nonce),
TransactionArgument__U8Vector(value=validator_name),
TransactionArgument__Address(value=validator_address),
],
)
def encode_remove_validator_and_reconfigure_script_function(
sliding_nonce: st.uint64, validator_name: bytes, validator_address: AccountAddress
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. |
| `validator_address` | `address` | The validator account address to be removed from the validator set. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account |
| 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. |
| `Errors::INVALID_ARGUMENT` | `DiemSystem::ENOT_AN_ACTIVE_VALIDATOR` | The validator to be removed is not in the validator set. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `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`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("ValidatorAdministrationScripts"),
),
function=Identifier("remove_validator_and_reconfigure"),
ty_args=[],
args=[
encode_u64_argument(sliding_nonce),
encode_u8vector_argument(validator_name),
encode_address_argument(validator_address),
],
)
)
def encode_rotate_authentication_key_script(new_key: bytes) -> Script:
"""# Summary
Rotates the transaction sender'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 ed25519 public key, and `account` must not have previously delegated
its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account of the transaction. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `Script::rotate_authentication_key_with_nonce`
* `Script::rotate_authentication_key_with_nonce_admin`
* `Script::rotate_authentication_key_with_recovery_address`
"""
return Script(
code=ROTATE_AUTHENTICATION_KEY_CODE,
ty_args=[],
args=[TransactionArgument__U8Vector(value=new_key)],
)
def encode_rotate_authentication_key_script_function(new_key: bytes) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys),
and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account of the transaction. |
| `new_key` | `vector<u8>` | New authentication key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin`
* `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("rotate_authentication_key"),
ty_args=[],
args=[encode_u8vector_argument(new_key)],
)
)
def encode_rotate_authentication_key_with_nonce_script(sliding_nonce: st.uint64, new_key: bytes) -> Script:
"""# 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 ed25519 public key, and `account` must not have previously delegated
its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account of the transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `Script::rotate_authentication_key`
* `Script::rotate_authentication_key_with_nonce_admin`
* `Script::rotate_authentication_key_with_recovery_address`
"""
return Script(
code=ROTATE_AUTHENTICATION_KEY_WITH_NONCE_CODE,
ty_args=[],
args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U8Vector(value=new_key)],
)
def encode_rotate_authentication_key_with_nonce_script_function(
sliding_nonce: st.uint64, new_key: bytes
) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys),
and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account of the transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_key` | `vector<u8>` | New authentication key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `AccountAdministrationScripts::rotate_authentication_key`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin`
* `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("rotate_authentication_key_with_nonce"),
ty_args=[],
args=[encode_u64_argument(sliding_nonce), encode_u8vector_argument(new_key)],
)
)
def encode_rotate_authentication_key_with_nonce_admin_script(sliding_nonce: st.uint64, new_key: bytes) -> Script:
"""# 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 ed25519 public key, and `account` must not have previously delegated
its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of the write set transaction. May only be the Diem Root signer. |
| `account` | `&signer` | Signer reference of account specified in the `execute_as` field of the write set transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `Script::rotate_authentication_key`
* `Script::rotate_authentication_key_with_nonce`
* `Script::rotate_authentication_key_with_recovery_address`
"""
return Script(
code=ROTATE_AUTHENTICATION_KEY_WITH_NONCE_ADMIN_CODE,
ty_args=[],
args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U8Vector(value=new_key)],
)
def encode_rotate_authentication_key_with_nonce_admin_script_function(
sliding_nonce: st.uint64, new_key: bytes
) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys),
and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | The signer of the sending account of the write set transaction. May only be the Diem Root signer. |
| `account` | `signer` | Signer of account specified in the `execute_as` field of the write set transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. |
| `new_key` | `vector<u8>` | New authentication key to be used for `account`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. |
| `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `AccountAdministrationScripts::rotate_authentication_key`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce`
* `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("rotate_authentication_key_with_nonce_admin"),
ty_args=[],
args=[encode_u64_argument(sliding_nonce), encode_u8vector_argument(new_key)],
)
)
def encode_rotate_authentication_key_with_recovery_address_script(
recovery_address: AccountAddress, to_recover: AccountAddress, new_key: bytes
) -> Script:
"""# 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
`Script::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`. 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account of the transaction. |
| `recovery_address` | `address` | Address where `RecoveryAddress::RecoveryAddress` that holds `to_recover`'s `DiemAccount::KeyRotationCapability` is published. |
| `to_recover` | `address` | The address of the account whose authentication key will be updated. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for the account at the `to_recover` address. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress::RecoveryAddress` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ECANNOT_ROTATE_KEY` | The address of `account` is not `recovery_address` or `to_recover`. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EACCOUNT_NOT_RECOVERABLE` | `to_recover`'s `DiemAccount::KeyRotationCapability` is not in the `RecoveryAddress::RecoveryAddress` resource published under `recovery_address`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `Script::rotate_authentication_key`
* `Script::rotate_authentication_key_with_nonce`
* `Script::rotate_authentication_key_with_nonce_admin`
"""
return Script(
code=ROTATE_AUTHENTICATION_KEY_WITH_RECOVERY_ADDRESS_CODE,
ty_args=[],
args=[
TransactionArgument__Address(value=recovery_address),
TransactionArgument__Address(value=to_recover),
TransactionArgument__U8Vector(value=new_key),
],
)
def encode_rotate_authentication_key_with_recovery_address_script_function(
recovery_address: AccountAddress, to_recover: AccountAddress, new_key: bytes
) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys).
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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account of the transaction. |
| `recovery_address` | `address` | Address where `RecoveryAddress::RecoveryAddress` that holds `to_recover`'s `DiemAccount::KeyRotationCapability` is published. |
| `to_recover` | `address` | The address of the account whose authentication key will be updated. |
| `new_key` | `vector<u8>` | New authentication key to be used for the account at the `to_recover` address. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress::RecoveryAddress` resource published under it. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ECANNOT_ROTATE_KEY` | The address of `account` is not `recovery_address` or `to_recover`. |
| `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EACCOUNT_NOT_RECOVERABLE` | `to_recover`'s `DiemAccount::KeyRotationCapability` is not in the `RecoveryAddress::RecoveryAddress` resource published under `recovery_address`. |
| `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. |
# Related Scripts
* `AccountAdministrationScripts::rotate_authentication_key`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce`
* `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("rotate_authentication_key_with_recovery_address"),
ty_args=[],
args=[
encode_address_argument(recovery_address),
encode_address_argument(to_recover),
encode_u8vector_argument(new_key),
],
)
)
def encode_rotate_dual_attestation_info_script(new_url: bytes, new_key: bytes) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account of the transaction. |
| `new_url` | `vector<u8>` | ASCII-encoded url to be used for off-chain communication with `account`. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for on-chain dual attestation checking. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `DualAttestation::ECREDENTIAL` | A `DualAttestation::Credential` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_PUBLIC_KEY` | `new_key` is not a valid ed25519 public key. |
# Related Scripts
* `Script::create_parent_vasp_account`
* `Script::create_designated_dealer`
* `Script::rotate_dual_attestation_info`
"""
return Script(
code=ROTATE_DUAL_ATTESTATION_INFO_CODE,
ty_args=[],
args=[TransactionArgument__U8Vector(value=new_url), TransactionArgument__U8Vector(value=new_key)],
)
def encode_rotate_dual_attestation_info_script_function(new_url: bytes, new_key: bytes) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account of the transaction. |
| `new_url` | `vector<u8>` | ASCII-encoded url to be used for off-chain communication with `account`. |
| `new_key` | `vector<u8>` | New ed25519 public key to be used for on-chain dual attestation checking. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `DualAttestation::ECREDENTIAL` | A `DualAttestation::Credential` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_PUBLIC_KEY` | `new_key` is not a valid ed25519 public key. |
# Related Scripts
* `AccountCreationScripts::create_parent_vasp_account`
* `AccountCreationScripts::create_designated_dealer`
* `AccountAdministrationScripts::rotate_dual_attestation_info`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("rotate_dual_attestation_info"),
ty_args=[],
args=[encode_u8vector_argument(new_url), encode_u8vector_argument(new_key)],
)
)
def encode_rotate_shared_ed25519_public_key_script(public_key: bytes) -> Script:
"""# 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
`Script::publish_shared_ed25519_public_key`.
# Technical Description
This first rotates the public key stored in `account`'s
`SharedEd25519PublicKey::SharedEd25519PublicKey` resource to `public_key`, after which it
rotates the authentication key using the capability stored in `account`'s
`SharedEd25519PublicKey::SharedEd25519PublicKey` to a new value derived from `public_key`
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | The signer reference of the sending account of the transaction. |
| `public_key` | `vector<u8>` | 32-byte Ed25519 public key. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | A `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. |
# Related Scripts
* `Script::publish_shared_ed25519_public_key`
"""
return Script(
code=ROTATE_SHARED_ED25519_PUBLIC_KEY_CODE,
ty_args=[],
args=[TransactionArgument__U8Vector(value=public_key)],
)
def encode_rotate_shared_ed25519_public_key_script_function(public_key: bytes) -> TransactionPayload:
"""# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys)
using the `DiemAccount::KeyRotationCapability` stored in `account`'s `SharedEd25519PublicKey::SharedEd25519PublicKey`.
# Parameters
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | The signer of the sending account of the transaction. |
| `public_key` | `vector<u8>` | 32-byte Ed25519 public key. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | A `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. |
# Related Scripts
* `AccountAdministrationScripts::publish_shared_ed25519_public_key`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("AccountAdministrationScripts"),
),
function=Identifier("rotate_shared_ed25519_public_key"),
ty_args=[],
args=[encode_u8vector_argument(public_key)],
)
)
def encode_set_gas_constants_script_function(
sliding_nonce: st.uint64,
global_memory_per_byte_cost: st.uint64,
global_memory_per_byte_write_cost: st.uint64,
min_transaction_gas_units: st.uint64,
large_transaction_cutoff: st.uint64,
intrinsic_gas_per_byte: st.uint64,
maximum_number_of_gas_units: st.uint64,
min_price_per_gas_unit: st.uint64,
max_price_per_gas_unit: st.uint64,
max_transaction_size_in_bytes: st.uint64,
gas_unit_scaling_factor: st.uint64,
default_account_size: st.uint64,
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `global_memory_per_byte_cost` | `u64` | The new cost to read global memory per-byte to be used for gas metering. |
| `global_memory_per_byte_write_cost` | `u64` | The new cost to write global memory per-byte to be used for gas metering. |
| `min_transaction_gas_units` | `u64` | The new flat minimum amount of gas required for any transaction. |
| `large_transaction_cutoff` | `u64` | The new size over which an additional charge will be assessed for each additional byte. |
| `intrinsic_gas_per_byte` | `u64` | The new number of units of gas that to be charged per-byte over the new `large_transaction_cutoff`. |
| `maximum_number_of_gas_units` | `u64` | The new maximum number of gas units that can be set in a transaction. |
| `min_price_per_gas_unit` | `u64` | The new minimum gas price that can be set for a transaction. |
| `max_price_per_gas_unit` | `u64` | The new maximum gas price that can be set for a transaction. |
| `max_transaction_size_in_bytes` | `u64` | The new maximum size of a transaction that can be processed. |
| `gas_unit_scaling_factor` | `u64` | The new scaling factor to use when scaling between external and internal gas units. |
| `default_account_size` | `u64` | The new default account size to use when assessing final costs for reads and writes to global storage. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::INVALID_ARGUMENT` | `DiemVMConfig::EGAS_CONSTANT_INCONSISTENCY` | The provided gas constants are inconsistent. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("SystemAdministrationScripts"),
),
function=Identifier("set_gas_constants"),
ty_args=[],
args=[
encode_u64_argument(sliding_nonce),
encode_u64_argument(global_memory_per_byte_cost),
encode_u64_argument(global_memory_per_byte_write_cost),
encode_u64_argument(min_transaction_gas_units),
encode_u64_argument(large_transaction_cutoff),
encode_u64_argument(intrinsic_gas_per_byte),
encode_u64_argument(maximum_number_of_gas_units),
encode_u64_argument(min_price_per_gas_unit),
encode_u64_argument(max_price_per_gas_unit),
encode_u64_argument(max_transaction_size_in_bytes),
encode_u64_argument(gas_unit_scaling_factor),
encode_u64_argument(default_account_size),
],
)
)
def encode_set_validator_config_and_reconfigure_script(
validator_account: AccountAddress,
consensus_pubkey: bytes,
validator_network_addresses: bytes,
fullnode_network_addresses: bytes,
) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `validator_operator_account` | `&signer` | Signer reference of the sending account. Must be the registered validator operator for the validator at `validator_address`. |
| `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. |
| `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR_OPERATOR` | `validator_operator_account` does not have a Validator Operator role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::add_validator_and_reconfigure`
* `Script::remove_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::register_validator_config`
"""
return Script(
code=SET_VALIDATOR_CONFIG_AND_RECONFIGURE_CODE,
ty_args=[],
args=[
TransactionArgument__Address(value=validator_account),
TransactionArgument__U8Vector(value=consensus_pubkey),
TransactionArgument__U8Vector(value=validator_network_addresses),
TransactionArgument__U8Vector(value=fullnode_network_addresses),
],
)
def encode_set_validator_config_and_reconfigure_script_function(
validator_account: AccountAddress,
consensus_pubkey: bytes,
validator_network_addresses: bytes,
fullnode_network_addresses: bytes,
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `validator_operator_account` | `signer` | Signer of the sending account. Must be the registered validator operator for the validator at `validator_address`. |
| `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. |
| `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
| `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR_OPERATOR` | `validator_operator_account` does not have a Validator Operator role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. |
| `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. |
# Related Scripts
* `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`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("ValidatorAdministrationScripts"),
),
function=Identifier("set_validator_config_and_reconfigure"),
ty_args=[],
args=[
encode_address_argument(validator_account),
encode_u8vector_argument(consensus_pubkey),
encode_u8vector_argument(validator_network_addresses),
encode_u8vector_argument(fullnode_network_addresses),
],
)
)
def encode_set_validator_operator_script(operator_name: bytes, operator_account: AccountAddress) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | The signer reference of the sending account of the transaction. |
| `operator_name` | `vector<u8>` | Validator operator's human name. |
| `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. |
| 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::add_validator_and_reconfigure`
* `Script::set_validator_operator_with_nonce_admin`
* `Script::set_validator_config_and_reconfigure`
"""
return Script(
code=SET_VALIDATOR_OPERATOR_CODE,
ty_args=[],
args=[TransactionArgument__U8Vector(value=operator_name), TransactionArgument__Address(value=operator_account)],
)
def encode_set_validator_operator_script_function(
operator_name: bytes, operator_account: AccountAddress
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | The signer of the sending account of the transaction. |
| `operator_name` | `vector<u8>` | Validator operator's human name. |
| `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. |
| 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. |
# Related Scripts
* `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`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("ValidatorAdministrationScripts"),
),
function=Identifier("set_validator_operator"),
ty_args=[],
args=[encode_u8vector_argument(operator_name), encode_address_argument(operator_account)],
)
)
def encode_set_validator_operator_with_nonce_admin_script(
sliding_nonce: st.uint64, operator_name: bytes, operator_account: AccountAddress
) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `&signer` | The signer reference of the sending account of the write set transaction. May only be the Diem Root signer. |
| `account` | `&signer` | Signer reference of account specified in the `execute_as` field of the write set transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. |
| `operator_name` | `vector<u8>` | Validator operator's human name. |
| `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account |
| `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. |
| 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. |
# Related Scripts
* `Script::create_validator_account`
* `Script::create_validator_operator_account`
* `Script::register_validator_config`
* `Script::remove_validator_and_reconfigure`
* `Script::add_validator_and_reconfigure`
* `Script::set_validator_operator`
* `Script::set_validator_config_and_reconfigure`
"""
return Script(
code=SET_VALIDATOR_OPERATOR_WITH_NONCE_ADMIN_CODE,
ty_args=[],
args=[
TransactionArgument__U64(value=sliding_nonce),
TransactionArgument__U8Vector(value=operator_name),
TransactionArgument__Address(value=operator_account),
],
)
def encode_set_validator_operator_with_nonce_admin_script_function(
sliding_nonce: st.uint64, operator_name: bytes, operator_account: AccountAddress
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `dr_account` | `signer` | Signer of the sending account of the write set transaction. May only be the Diem Root signer. |
| `account` | `signer` | Signer of account specified in the `execute_as` field of the write set transaction. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. |
| `operator_name` | `vector<u8>` | Validator operator's human name. |
| `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account |
| `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. |
| 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. |
| `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. |
| `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. |
| `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. |
# Related Scripts
* `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`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("ValidatorAdministrationScripts"),
),
function=Identifier("set_validator_operator_with_nonce_admin"),
ty_args=[],
args=[
encode_u64_argument(sliding_nonce),
encode_u8vector_argument(operator_name),
encode_address_argument(operator_account),
],
)
)
def encode_tiered_mint_script(
coin_type: TypeTag,
sliding_nonce: st.uint64,
designated_dealer_address: AccountAddress,
mint_amount: st.uint64,
tier_index: st.uint64,
) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` being minted. `CoinType` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `designated_dealer_address` | `address` | The address of the Designated Dealer account being minted to. |
| `mint_amount` | `u64` | The number of coins to be minted. |
| `tier_index` | `u64` | The mint tier index to use for the Designated Dealer account. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_MINT_AMOUNT` | `mint_amount` is zero. |
| `Errors::NOT_PUBLISHED` | `DesignatedDealer::EDEALER` | `DesignatedDealer::Dealer` or `DesignatedDealer::TierInfo<CoinType>` resource does not exist at `designated_dealer_address`. |
| `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_TIER_INDEX` | The `tier_index` is out of bounds. |
| `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_AMOUNT_FOR_TIER` | `mint_amount` exceeds the maximum allowed amount for `tier_index`. |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EMINT_CAPABILITY` | `tc_account` does not have a `Diem::MintCapability<CoinType>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EMINTING_NOT_ALLOWED` | Minting is not currently allowed for `CoinType` coins. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds would exceed the `account`'s account limits. |
# Related Scripts
* `Script::create_designated_dealer`
* `Script::peer_to_peer_with_metadata`
* `Script::rotate_dual_attestation_info`
"""
return Script(
code=TIERED_MINT_CODE,
ty_args=[coin_type],
args=[
TransactionArgument__U64(value=sliding_nonce),
TransactionArgument__Address(value=designated_dealer_address),
TransactionArgument__U64(value=mint_amount),
TransactionArgument__U64(value=tier_index),
],
)
def encode_tiered_mint_script_function(
coin_type: TypeTag,
sliding_nonce: st.uint64,
designated_dealer_address: AccountAddress,
mint_amount: st.uint64,
tier_index: st.uint64,
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `CoinType` | Type | The Move type for the `CoinType` being minted. `CoinType` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `designated_dealer_address` | `address` | The address of the Designated Dealer account being minted to. |
| `mint_amount` | `u64` | The number of coins to be minted. |
| `tier_index` | `u64` | [Deprecated] The mint tier index to use for the Designated Dealer account. Will be ignored |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_MINT_AMOUNT` | `mint_amount` is zero. |
| `Errors::NOT_PUBLISHED` | `DesignatedDealer::EDEALER` | `DesignatedDealer::Dealer` or `DesignatedDealer::TierInfo<CoinType>` resource does not exist at `designated_dealer_address`. |
| `Errors::REQUIRES_CAPABILITY` | `Diem::EMINT_CAPABILITY` | `tc_account` does not have a `Diem::MintCapability<CoinType>` resource published under it. |
| `Errors::INVALID_STATE` | `Diem::EMINTING_NOT_ALLOWED` | Minting is not currently allowed for `CoinType` coins. |
| `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds would exceed the `account`'s account limits. |
# Related Scripts
* `AccountCreationScripts::create_designated_dealer`
* `PaymentScripts::peer_to_peer_with_metadata`
* `AccountAdministrationScripts::rotate_dual_attestation_info`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("tiered_mint"),
ty_args=[coin_type],
args=[
encode_u64_argument(sliding_nonce),
encode_address_argument(designated_dealer_address),
encode_u64_argument(mint_amount),
encode_u64_argument(tier_index),
],
)
)
def encode_unfreeze_account_script(sliding_nonce: st.uint64, to_unfreeze_account: AccountAddress) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `to_unfreeze_account` | `address` | The account address to be frozen. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
# Related Scripts
* `Script::freeze_account`
"""
return Script(
code=UNFREEZE_ACCOUNT_CODE,
ty_args=[],
args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=to_unfreeze_account)],
)
def encode_unfreeze_account_script_function(
sliding_nonce: st.uint64, to_unfreeze_account: AccountAddress
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `to_unfreeze_account` | `address` | The account address to be frozen. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. |
# Related Scripts
* `TreasuryComplianceScripts::freeze_account`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("unfreeze_account"),
ty_args=[],
args=[encode_u64_argument(sliding_nonce), encode_address_argument(to_unfreeze_account)],
)
)
def encode_update_diem_consensus_config_script_function(sliding_nonce: st.uint64, config: bytes) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `config` | `vector<u8>` | The serialized bytes of consensus config. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("SystemAdministrationScripts"),
),
function=Identifier("update_diem_consensus_config"),
ty_args=[],
args=[encode_u64_argument(sliding_nonce), encode_u8vector_argument(config)],
)
)
def encode_update_diem_version_script(sliding_nonce: st.uint64, major: st.uint64) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `&signer` | Signer reference of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `major` | `u64` | The `major` version of the VM to be used from this transaction on. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
| `Errors::INVALID_ARGUMENT` | `DiemVersion::EINVALID_MAJOR_VERSION_NUMBER` | `major` is less-than or equal to the current major version stored on-chain. |
"""
return Script(
code=UPDATE_DIEM_VERSION_CODE,
ty_args=[],
args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U64(value=major)],
)
def encode_update_diem_version_script_function(sliding_nonce: st.uint64, major: st.uint64) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `major` | `u64` | The `major` version of the VM to be used from this transaction on. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. |
| `Errors::INVALID_ARGUMENT` | `DiemVersion::EINVALID_MAJOR_VERSION_NUMBER` | `major` is less-than or equal to the current major version stored on-chain. |
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("SystemAdministrationScripts"),
),
function=Identifier("update_diem_version"),
ty_args=[],
args=[encode_u64_argument(sliding_nonce), encode_u64_argument(major)],
)
)
def encode_update_dual_attestation_limit_script(sliding_nonce: st.uint64, new_micro_xdx_limit: st.uint64) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_micro_xdx_limit` | `u64` | The new dual attestation limit to be used on-chain. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
# Related Scripts
* `Script::update_exchange_rate`
* `Script::update_minting_ability`
"""
return Script(
code=UPDATE_DUAL_ATTESTATION_LIMIT_CODE,
ty_args=[],
args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U64(value=new_micro_xdx_limit)],
)
def encode_update_dual_attestation_limit_script_function(
sliding_nonce: st.uint64, new_micro_xdx_limit: st.uint64
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. |
| `new_micro_xdx_limit` | `u64` | The new dual attestation limit to be used on-chain. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
# Related Scripts
* `TreasuryComplianceScripts::update_exchange_rate`
* `TreasuryComplianceScripts::update_minting_ability`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("update_dual_attestation_limit"),
ty_args=[],
args=[encode_u64_argument(sliding_nonce), encode_u64_argument(new_micro_xdx_limit)],
)
)
def encode_update_exchange_rate_script(
currency: TypeTag,
sliding_nonce: st.uint64,
new_exchange_rate_numerator: st.uint64,
new_exchange_rate_denominator: st.uint64,
) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` whose exchange rate is being updated. `Currency` must be an already-registered currency on-chain. |
| `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for the transaction. |
| `new_exchange_rate_numerator` | `u64` | The numerator for the new to micro-XDX exchange rate for `Currency`. |
| `new_exchange_rate_denominator` | `u64` | The denominator for the new to micro-XDX exchange rate for `Currency`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `FixedPoint32::EDENOMINATOR` | `new_exchange_rate_denominator` is zero. |
| `Errors::INVALID_ARGUMENT` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. |
| `Errors::LIMIT_EXCEEDED` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. |
# Related Scripts
* `Script::update_dual_attestation_limit`
* `Script::update_minting_ability`
"""
return Script(
code=UPDATE_EXCHANGE_RATE_CODE,
ty_args=[currency],
args=[
TransactionArgument__U64(value=sliding_nonce),
TransactionArgument__U64(value=new_exchange_rate_numerator),
TransactionArgument__U64(value=new_exchange_rate_denominator),
],
)
def encode_update_exchange_rate_script_function(
currency: TypeTag,
sliding_nonce: st.uint64,
new_exchange_rate_numerator: st.uint64,
new_exchange_rate_denominator: st.uint64,
) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` whose exchange rate is being updated. `Currency` must be an already-registered currency on-chain. |
| `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. |
| `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for the transaction. |
| `new_exchange_rate_numerator` | `u64` | The numerator for the new to micro-XDX exchange rate for `Currency`. |
| `new_exchange_rate_denominator` | `u64` | The denominator for the new to micro-XDX exchange rate for `Currency`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. |
| `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::INVALID_ARGUMENT` | `FixedPoint32::EDENOMINATOR` | `new_exchange_rate_denominator` is zero. |
| `Errors::INVALID_ARGUMENT` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. |
| `Errors::LIMIT_EXCEEDED` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. |
# Related Scripts
* `TreasuryComplianceScripts::update_dual_attestation_limit`
* `TreasuryComplianceScripts::update_minting_ability`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("update_exchange_rate"),
ty_args=[currency],
args=[
encode_u64_argument(sliding_nonce),
encode_u64_argument(new_exchange_rate_numerator),
encode_u64_argument(new_exchange_rate_denominator),
],
)
)
def encode_update_minting_ability_script(currency: TypeTag, allow_minting: bool) -> Script:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` whose minting ability is being updated. `Currency` must be an already-registered currency on-chain. |
| `account` | `&signer` | Signer reference of the sending account. Must be the Diem Root account. |
| `allow_minting` | `bool` | Whether to allow minting of new coins in `Currency`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | `Currency` is not a registered currency on-chain. |
# Related Scripts
* `Script::update_dual_attestation_limit`
* `Script::update_exchange_rate`
"""
return Script(
code=UPDATE_MINTING_ABILITY_CODE,
ty_args=[currency],
args=[TransactionArgument__Bool(value=allow_minting)],
)
def encode_update_minting_ability_script_function(currency: TypeTag, allow_minting: bool) -> TransactionPayload:
"""# 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
| Name | Type | Description |
| ------ | ------ | ------------- |
| `Currency` | Type | The Move type for the `Currency` whose minting ability is being updated. `Currency` must be an already-registered currency on-chain. |
| `account` | `signer` | Signer of the sending account. Must be the Diem Root account. |
| `allow_minting` | `bool` | Whether to allow minting of new coins in `Currency`. |
# Common Abort Conditions
| Error Category | Error Reason | Description |
| ---------------- | -------------- | ------------- |
| `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. |
| `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | `Currency` is not a registered currency on-chain. |
# Related Scripts
* `TreasuryComplianceScripts::update_dual_attestation_limit`
* `TreasuryComplianceScripts::update_exchange_rate`
"""
return TransactionPayload__ScriptFunction(
value=ScriptFunction(
module=ModuleId(
address=AccountAddress.from_hex("00000000000000000000000000000001"),
name=Identifier("TreasuryComplianceScripts"),
),
function=Identifier("update_minting_ability"),
ty_args=[currency],
args=[encode_bool_argument(allow_minting)],
)
)
def decode_add_currency_to_account_script(script: Script) -> ScriptCall:
return ScriptCall__AddCurrencyToAccount(
currency=script.ty_args[0],
)
def decode_add_currency_to_account_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__AddCurrencyToAccount(
currency=script.ty_args[0],
)
def decode_add_recovery_rotation_capability_script(script: Script) -> ScriptCall:
return ScriptCall__AddRecoveryRotationCapability(
recovery_address=decode_address_argument(script.args[0]),
)
def decode_add_recovery_rotation_capability_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__AddRecoveryRotationCapability(
recovery_address=bcs_deserialize(script.args[0], AccountAddress)[0],
)
def decode_add_validator_and_reconfigure_script(script: Script) -> ScriptCall:
return ScriptCall__AddValidatorAndReconfigure(
sliding_nonce=decode_u64_argument(script.args[0]),
validator_name=decode_u8vector_argument(script.args[1]),
validator_address=decode_address_argument(script.args[2]),
)
def decode_add_validator_and_reconfigure_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__AddValidatorAndReconfigure(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
validator_name=bcs_deserialize(script.args[1], bytes)[0],
validator_address=bcs_deserialize(script.args[2], AccountAddress)[0],
)
def decode_burn_script(script: Script) -> ScriptCall:
return ScriptCall__Burn(
token=script.ty_args[0],
sliding_nonce=decode_u64_argument(script.args[0]),
preburn_address=decode_address_argument(script.args[1]),
)
def decode_burn_txn_fees_script(script: Script) -> ScriptCall:
return ScriptCall__BurnTxnFees(
coin_type=script.ty_args[0],
)
def decode_burn_txn_fees_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__BurnTxnFees(
coin_type=script.ty_args[0],
)
def decode_burn_with_amount_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__BurnWithAmount(
token=script.ty_args[0],
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
preburn_address=bcs_deserialize(script.args[1], AccountAddress)[0],
amount=bcs_deserialize(script.args[2], st.uint64)[0],
)
def decode_cancel_burn_script(script: Script) -> ScriptCall:
return ScriptCall__CancelBurn(
token=script.ty_args[0],
preburn_address=decode_address_argument(script.args[0]),
)
def decode_cancel_burn_with_amount_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__CancelBurnWithAmount(
token=script.ty_args[0],
preburn_address=bcs_deserialize(script.args[0], AccountAddress)[0],
amount=bcs_deserialize(script.args[1], st.uint64)[0],
)
def decode_create_child_vasp_account_script(script: Script) -> ScriptCall:
return ScriptCall__CreateChildVaspAccount(
coin_type=script.ty_args[0],
child_address=decode_address_argument(script.args[0]),
auth_key_prefix=decode_u8vector_argument(script.args[1]),
add_all_currencies=decode_bool_argument(script.args[2]),
child_initial_balance=decode_u64_argument(script.args[3]),
)
def decode_create_child_vasp_account_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__CreateChildVaspAccount(
coin_type=script.ty_args[0],
child_address=bcs_deserialize(script.args[0], AccountAddress)[0],
auth_key_prefix=bcs_deserialize(script.args[1], bytes)[0],
add_all_currencies=bcs_deserialize(script.args[2], bool)[0],
child_initial_balance=bcs_deserialize(script.args[3], st.uint64)[0],
)
def decode_create_designated_dealer_script(script: Script) -> ScriptCall:
return ScriptCall__CreateDesignatedDealer(
currency=script.ty_args[0],
sliding_nonce=decode_u64_argument(script.args[0]),
addr=decode_address_argument(script.args[1]),
auth_key_prefix=decode_u8vector_argument(script.args[2]),
human_name=decode_u8vector_argument(script.args[3]),
add_all_currencies=decode_bool_argument(script.args[4]),
)
def decode_create_designated_dealer_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__CreateDesignatedDealer(
currency=script.ty_args[0],
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
addr=bcs_deserialize(script.args[1], AccountAddress)[0],
auth_key_prefix=bcs_deserialize(script.args[2], bytes)[0],
human_name=bcs_deserialize(script.args[3], bytes)[0],
add_all_currencies=bcs_deserialize(script.args[4], bool)[0],
)
def decode_create_parent_vasp_account_script(script: Script) -> ScriptCall:
return ScriptCall__CreateParentVaspAccount(
coin_type=script.ty_args[0],
sliding_nonce=decode_u64_argument(script.args[0]),
new_account_address=decode_address_argument(script.args[1]),
auth_key_prefix=decode_u8vector_argument(script.args[2]),
human_name=decode_u8vector_argument(script.args[3]),
add_all_currencies=decode_bool_argument(script.args[4]),
)
def decode_create_parent_vasp_account_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__CreateParentVaspAccount(
coin_type=script.ty_args[0],
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
new_account_address=bcs_deserialize(script.args[1], AccountAddress)[0],
auth_key_prefix=bcs_deserialize(script.args[2], bytes)[0],
human_name=bcs_deserialize(script.args[3], bytes)[0],
add_all_currencies=bcs_deserialize(script.args[4], bool)[0],
)
def decode_create_recovery_address_script(_script: Script) -> ScriptCall:
return ScriptCall__CreateRecoveryAddress()
def decode_create_recovery_address_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__CreateRecoveryAddress()
def decode_create_validator_account_script(script: Script) -> ScriptCall:
return ScriptCall__CreateValidatorAccount(
sliding_nonce=decode_u64_argument(script.args[0]),
new_account_address=decode_address_argument(script.args[1]),
auth_key_prefix=decode_u8vector_argument(script.args[2]),
human_name=decode_u8vector_argument(script.args[3]),
)
def decode_create_validator_account_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__CreateValidatorAccount(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
new_account_address=bcs_deserialize(script.args[1], AccountAddress)[0],
auth_key_prefix=bcs_deserialize(script.args[2], bytes)[0],
human_name=bcs_deserialize(script.args[3], bytes)[0],
)
def decode_create_validator_operator_account_script(script: Script) -> ScriptCall:
return ScriptCall__CreateValidatorOperatorAccount(
sliding_nonce=decode_u64_argument(script.args[0]),
new_account_address=decode_address_argument(script.args[1]),
auth_key_prefix=decode_u8vector_argument(script.args[2]),
human_name=decode_u8vector_argument(script.args[3]),
)
def decode_create_validator_operator_account_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__CreateValidatorOperatorAccount(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
new_account_address=bcs_deserialize(script.args[1], AccountAddress)[0],
auth_key_prefix=bcs_deserialize(script.args[2], bytes)[0],
human_name=bcs_deserialize(script.args[3], bytes)[0],
)
def decode_freeze_account_script(script: Script) -> ScriptCall:
return ScriptCall__FreezeAccount(
sliding_nonce=decode_u64_argument(script.args[0]),
to_freeze_account=decode_address_argument(script.args[1]),
)
def decode_freeze_account_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__FreezeAccount(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
to_freeze_account=bcs_deserialize(script.args[1], AccountAddress)[0],
)
def decode_initialize_diem_consensus_config_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__InitializeDiemConsensusConfig(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
)
def decode_peer_to_peer_with_metadata_script(script: Script) -> ScriptCall:
return ScriptCall__PeerToPeerWithMetadata(
currency=script.ty_args[0],
payee=decode_address_argument(script.args[0]),
amount=decode_u64_argument(script.args[1]),
metadata=decode_u8vector_argument(script.args[2]),
metadata_signature=decode_u8vector_argument(script.args[3]),
)
def decode_peer_to_peer_with_metadata_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__PeerToPeerWithMetadata(
currency=script.ty_args[0],
payee=bcs_deserialize(script.args[0], AccountAddress)[0],
amount=bcs_deserialize(script.args[1], st.uint64)[0],
metadata=bcs_deserialize(script.args[2], bytes)[0],
metadata_signature=bcs_deserialize(script.args[3], bytes)[0],
)
def decode_preburn_script(script: Script) -> ScriptCall:
return ScriptCall__Preburn(
token=script.ty_args[0],
amount=decode_u64_argument(script.args[0]),
)
def decode_preburn_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__Preburn(
token=script.ty_args[0],
amount=bcs_deserialize(script.args[0], st.uint64)[0],
)
def decode_publish_shared_ed25519_public_key_script(script: Script) -> ScriptCall:
return ScriptCall__PublishSharedEd25519PublicKey(
public_key=decode_u8vector_argument(script.args[0]),
)
def decode_publish_shared_ed25519_public_key_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__PublishSharedEd25519PublicKey(
public_key=bcs_deserialize(script.args[0], bytes)[0],
)
def decode_register_validator_config_script(script: Script) -> ScriptCall:
return ScriptCall__RegisterValidatorConfig(
validator_account=decode_address_argument(script.args[0]),
consensus_pubkey=decode_u8vector_argument(script.args[1]),
validator_network_addresses=decode_u8vector_argument(script.args[2]),
fullnode_network_addresses=decode_u8vector_argument(script.args[3]),
)
def decode_register_validator_config_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__RegisterValidatorConfig(
validator_account=bcs_deserialize(script.args[0], AccountAddress)[0],
consensus_pubkey=bcs_deserialize(script.args[1], bytes)[0],
validator_network_addresses=bcs_deserialize(script.args[2], bytes)[0],
fullnode_network_addresses=bcs_deserialize(script.args[3], bytes)[0],
)
def decode_remove_validator_and_reconfigure_script(script: Script) -> ScriptCall:
return ScriptCall__RemoveValidatorAndReconfigure(
sliding_nonce=decode_u64_argument(script.args[0]),
validator_name=decode_u8vector_argument(script.args[1]),
validator_address=decode_address_argument(script.args[2]),
)
def decode_remove_validator_and_reconfigure_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__RemoveValidatorAndReconfigure(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
validator_name=bcs_deserialize(script.args[1], bytes)[0],
validator_address=bcs_deserialize(script.args[2], AccountAddress)[0],
)
def decode_rotate_authentication_key_script(script: Script) -> ScriptCall:
return ScriptCall__RotateAuthenticationKey(
new_key=decode_u8vector_argument(script.args[0]),
)
def decode_rotate_authentication_key_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__RotateAuthenticationKey(
new_key=bcs_deserialize(script.args[0], bytes)[0],
)
def decode_rotate_authentication_key_with_nonce_script(script: Script) -> ScriptCall:
return ScriptCall__RotateAuthenticationKeyWithNonce(
sliding_nonce=decode_u64_argument(script.args[0]),
new_key=decode_u8vector_argument(script.args[1]),
)
def decode_rotate_authentication_key_with_nonce_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__RotateAuthenticationKeyWithNonce(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
new_key=bcs_deserialize(script.args[1], bytes)[0],
)
def decode_rotate_authentication_key_with_nonce_admin_script(script: Script) -> ScriptCall:
return ScriptCall__RotateAuthenticationKeyWithNonceAdmin(
sliding_nonce=decode_u64_argument(script.args[0]),
new_key=decode_u8vector_argument(script.args[1]),
)
def decode_rotate_authentication_key_with_nonce_admin_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__RotateAuthenticationKeyWithNonceAdmin(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
new_key=bcs_deserialize(script.args[1], bytes)[0],
)
def decode_rotate_authentication_key_with_recovery_address_script(script: Script) -> ScriptCall:
return ScriptCall__RotateAuthenticationKeyWithRecoveryAddress(
recovery_address=decode_address_argument(script.args[0]),
to_recover=decode_address_argument(script.args[1]),
new_key=decode_u8vector_argument(script.args[2]),
)
def decode_rotate_authentication_key_with_recovery_address_script_function(
script: TransactionPayload,
) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__RotateAuthenticationKeyWithRecoveryAddress(
recovery_address=bcs_deserialize(script.args[0], AccountAddress)[0],
to_recover=bcs_deserialize(script.args[1], AccountAddress)[0],
new_key=bcs_deserialize(script.args[2], bytes)[0],
)
def decode_rotate_dual_attestation_info_script(script: Script) -> ScriptCall:
return ScriptCall__RotateDualAttestationInfo(
new_url=decode_u8vector_argument(script.args[0]),
new_key=decode_u8vector_argument(script.args[1]),
)
def decode_rotate_dual_attestation_info_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__RotateDualAttestationInfo(
new_url=bcs_deserialize(script.args[0], bytes)[0],
new_key=bcs_deserialize(script.args[1], bytes)[0],
)
def decode_rotate_shared_ed25519_public_key_script(script: Script) -> ScriptCall:
return ScriptCall__RotateSharedEd25519PublicKey(
public_key=decode_u8vector_argument(script.args[0]),
)
def decode_rotate_shared_ed25519_public_key_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__RotateSharedEd25519PublicKey(
public_key=bcs_deserialize(script.args[0], bytes)[0],
)
def decode_set_gas_constants_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__SetGasConstants(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
global_memory_per_byte_cost=bcs_deserialize(script.args[1], st.uint64)[0],
global_memory_per_byte_write_cost=bcs_deserialize(script.args[2], st.uint64)[0],
min_transaction_gas_units=bcs_deserialize(script.args[3], st.uint64)[0],
large_transaction_cutoff=bcs_deserialize(script.args[4], st.uint64)[0],
intrinsic_gas_per_byte=bcs_deserialize(script.args[5], st.uint64)[0],
maximum_number_of_gas_units=bcs_deserialize(script.args[6], st.uint64)[0],
min_price_per_gas_unit=bcs_deserialize(script.args[7], st.uint64)[0],
max_price_per_gas_unit=bcs_deserialize(script.args[8], st.uint64)[0],
max_transaction_size_in_bytes=bcs_deserialize(script.args[9], st.uint64)[0],
gas_unit_scaling_factor=bcs_deserialize(script.args[10], st.uint64)[0],
default_account_size=bcs_deserialize(script.args[11], st.uint64)[0],
)
def decode_set_validator_config_and_reconfigure_script(script: Script) -> ScriptCall:
return ScriptCall__SetValidatorConfigAndReconfigure(
validator_account=decode_address_argument(script.args[0]),
consensus_pubkey=decode_u8vector_argument(script.args[1]),
validator_network_addresses=decode_u8vector_argument(script.args[2]),
fullnode_network_addresses=decode_u8vector_argument(script.args[3]),
)
def decode_set_validator_config_and_reconfigure_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__SetValidatorConfigAndReconfigure(
validator_account=bcs_deserialize(script.args[0], AccountAddress)[0],
consensus_pubkey=bcs_deserialize(script.args[1], bytes)[0],
validator_network_addresses=bcs_deserialize(script.args[2], bytes)[0],
fullnode_network_addresses=bcs_deserialize(script.args[3], bytes)[0],
)
def decode_set_validator_operator_script(script: Script) -> ScriptCall:
return ScriptCall__SetValidatorOperator(
operator_name=decode_u8vector_argument(script.args[0]),
operator_account=decode_address_argument(script.args[1]),
)
def decode_set_validator_operator_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__SetValidatorOperator(
operator_name=bcs_deserialize(script.args[0], bytes)[0],
operator_account=bcs_deserialize(script.args[1], AccountAddress)[0],
)
def decode_set_validator_operator_with_nonce_admin_script(script: Script) -> ScriptCall:
return ScriptCall__SetValidatorOperatorWithNonceAdmin(
sliding_nonce=decode_u64_argument(script.args[0]),
operator_name=decode_u8vector_argument(script.args[1]),
operator_account=decode_address_argument(script.args[2]),
)
def decode_set_validator_operator_with_nonce_admin_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__SetValidatorOperatorWithNonceAdmin(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
operator_name=bcs_deserialize(script.args[1], bytes)[0],
operator_account=bcs_deserialize(script.args[2], AccountAddress)[0],
)
def decode_tiered_mint_script(script: Script) -> ScriptCall:
return ScriptCall__TieredMint(
coin_type=script.ty_args[0],
sliding_nonce=decode_u64_argument(script.args[0]),
designated_dealer_address=decode_address_argument(script.args[1]),
mint_amount=decode_u64_argument(script.args[2]),
tier_index=decode_u64_argument(script.args[3]),
)
def decode_tiered_mint_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__TieredMint(
coin_type=script.ty_args[0],
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
designated_dealer_address=bcs_deserialize(script.args[1], AccountAddress)[0],
mint_amount=bcs_deserialize(script.args[2], st.uint64)[0],
tier_index=bcs_deserialize(script.args[3], st.uint64)[0],
)
def decode_unfreeze_account_script(script: Script) -> ScriptCall:
return ScriptCall__UnfreezeAccount(
sliding_nonce=decode_u64_argument(script.args[0]),
to_unfreeze_account=decode_address_argument(script.args[1]),
)
def decode_unfreeze_account_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__UnfreezeAccount(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
to_unfreeze_account=bcs_deserialize(script.args[1], AccountAddress)[0],
)
def decode_update_diem_consensus_config_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__UpdateDiemConsensusConfig(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
config=bcs_deserialize(script.args[1], bytes)[0],
)
def decode_update_diem_version_script(script: Script) -> ScriptCall:
return ScriptCall__UpdateDiemVersion(
sliding_nonce=decode_u64_argument(script.args[0]),
major=decode_u64_argument(script.args[1]),
)
def decode_update_diem_version_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__UpdateDiemVersion(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
major=bcs_deserialize(script.args[1], st.uint64)[0],
)
def decode_update_dual_attestation_limit_script(script: Script) -> ScriptCall:
return ScriptCall__UpdateDualAttestationLimit(
sliding_nonce=decode_u64_argument(script.args[0]),
new_micro_xdx_limit=decode_u64_argument(script.args[1]),
)
def decode_update_dual_attestation_limit_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__UpdateDualAttestationLimit(
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
new_micro_xdx_limit=bcs_deserialize(script.args[1], st.uint64)[0],
)
def decode_update_exchange_rate_script(script: Script) -> ScriptCall:
return ScriptCall__UpdateExchangeRate(
currency=script.ty_args[0],
sliding_nonce=decode_u64_argument(script.args[0]),
new_exchange_rate_numerator=decode_u64_argument(script.args[1]),
new_exchange_rate_denominator=decode_u64_argument(script.args[2]),
)
def decode_update_exchange_rate_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__UpdateExchangeRate(
currency=script.ty_args[0],
sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0],
new_exchange_rate_numerator=bcs_deserialize(script.args[1], st.uint64)[0],
new_exchange_rate_denominator=bcs_deserialize(script.args[2], st.uint64)[0],
)
def decode_update_minting_ability_script(script: Script) -> ScriptCall:
return ScriptCall__UpdateMintingAbility(
currency=script.ty_args[0],
allow_minting=decode_bool_argument(script.args[0]),
)
def decode_update_minting_ability_script_function(script: TransactionPayload) -> ScriptFunctionCall:
if not isinstance(script, ScriptFunction):
raise ValueError("Unexpected transaction payload")
return ScriptFunctionCall__UpdateMintingAbility(
currency=script.ty_args[0],
allow_minting=bcs_deserialize(script.args[0], bool)[0],
)
ADD_CURRENCY_TO_ACCOUNT_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x02\x03\x02\x06\x04\x08\x02\x05\x0a\x07\x07\x11\x19\x08\x2a\x10\x00\x00\x00\x01\x00\x01\x01\x01\x00\x02\x01\x06\x0c\x00\x01\x09\x00\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0c\x61\x64\x64\x5f\x63\x75\x72\x72\x65\x6e\x63\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x00\x01\x03\x0b\x00\x38\x00\x02"
ADD_RECOVERY_ROTATION_CAPABILITY_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x04\x02\x04\x04\x03\x08\x0a\x05\x12\x0f\x07\x21\x6a\x08\x8b\x01\x10\x00\x00\x00\x01\x00\x02\x01\x00\x00\x03\x00\x01\x00\x01\x04\x02\x03\x00\x01\x06\x0c\x01\x08\x00\x02\x08\x00\x05\x00\x02\x06\x0c\x05\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0f\x52\x65\x63\x6f\x76\x65\x72\x79\x41\x64\x64\x72\x65\x73\x73\x15\x4b\x65\x79\x52\x6f\x74\x61\x74\x69\x6f\x6e\x43\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1f\x65\x78\x74\x72\x61\x63\x74\x5f\x6b\x65\x79\x5f\x72\x6f\x74\x61\x74\x69\x6f\x6e\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x17\x61\x64\x64\x5f\x72\x6f\x74\x61\x74\x69\x6f\x6e\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x04\x03\x05\x0b\x00\x11\x00\x0a\x01\x11\x01\x02"
ADD_VALIDATOR_AND_RECONFIGURE_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x06\x03\x06\x0f\x05\x15\x18\x07\x2d\x5b\x08\x88\x01\x10\x00\x00\x00\x01\x00\x02\x01\x03\x00\x01\x00\x02\x04\x02\x03\x00\x00\x05\x04\x01\x00\x02\x06\x0c\x03\x00\x01\x05\x01\x0a\x02\x02\x06\x0c\x05\x04\x06\x0c\x03\x0a\x02\x05\x02\x01\x03\x0a\x44\x69\x65\x6d\x53\x79\x73\x74\x65\x6d\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x0f\x56\x61\x6c\x69\x64\x61\x74\x6f\x72\x43\x6f\x6e\x66\x69\x67\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x0e\x67\x65\x74\x5f\x68\x75\x6d\x61\x6e\x5f\x6e\x61\x6d\x65\x0d\x61\x64\x64\x5f\x76\x61\x6c\x69\x64\x61\x74\x6f\x72\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x05\x06\x12\x0a\x00\x0a\x01\x11\x00\x0a\x03\x11\x01\x0b\x02\x21\x0c\x04\x0b\x04\x03\x0e\x0b\x00\x01\x06\x00\x00\x00\x00\x00\x00\x00\x00\x27\x0b\x00\x0a\x03\x11\x02\x02"
BURN_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x04\x03\x04\x0b\x04\x0f\x02\x05\x11\x11\x07\x22\x2d\x08\x4f\x10\x00\x00\x00\x01\x01\x02\x00\x01\x00\x00\x03\x02\x01\x01\x01\x01\x04\x02\x06\x0c\x03\x00\x02\x06\x0c\x05\x03\x06\x0c\x03\x05\x01\x09\x00\x04\x44\x69\x65\x6d\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x04\x62\x75\x72\x6e\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x03\x01\x07\x0a\x00\x0a\x01\x11\x00\x0b\x00\x0a\x02\x38\x00\x02"
BURN_TXN_FEES_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x02\x03\x02\x06\x04\x08\x02\x05\x0a\x07\x07\x11\x19\x08\x2a\x10\x00\x00\x00\x01\x00\x01\x01\x01\x00\x02\x01\x06\x0c\x00\x01\x09\x00\x0e\x54\x72\x61\x6e\x73\x61\x63\x74\x69\x6f\x6e\x46\x65\x65\x09\x62\x75\x72\x6e\x5f\x66\x65\x65\x73\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x00\x01\x03\x0b\x00\x38\x00\x02"
CANCEL_BURN_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x02\x03\x02\x06\x04\x08\x02\x05\x0a\x08\x07\x12\x18\x08\x2a\x10\x00\x00\x00\x01\x00\x01\x01\x01\x00\x02\x02\x06\x0c\x05\x00\x01\x09\x00\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0b\x63\x61\x6e\x63\x65\x6c\x5f\x62\x75\x72\x6e\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x00\x01\x04\x0b\x00\x0a\x01\x38\x00\x02"
CREATE_CHILD_VASP_ACCOUNT_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x08\x01\x00\x02\x02\x02\x04\x03\x06\x16\x04\x1c\x04\x05\x20\x23\x07\x43\x7a\x08\xbd\x01\x10\x06\xcd\x01\x04\x00\x00\x00\x01\x01\x00\x00\x02\x00\x01\x01\x01\x00\x03\x02\x03\x00\x00\x04\x04\x01\x01\x01\x00\x05\x03\x01\x00\x00\x06\x02\x06\x04\x06\x0c\x05\x0a\x02\x01\x00\x01\x06\x0c\x01\x08\x00\x05\x06\x08\x00\x05\x03\x0a\x02\x0a\x02\x05\x06\x0c\x05\x0a\x02\x01\x03\x01\x09\x00\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x12\x57\x69\x74\x68\x64\x72\x61\x77\x43\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x19\x63\x72\x65\x61\x74\x65\x5f\x63\x68\x69\x6c\x64\x5f\x76\x61\x73\x70\x5f\x61\x63\x63\x6f\x75\x6e\x74\x1b\x65\x78\x74\x72\x61\x63\x74\x5f\x77\x69\x74\x68\x64\x72\x61\x77\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x08\x70\x61\x79\x5f\x66\x72\x6f\x6d\x1b\x72\x65\x73\x74\x6f\x72\x65\x5f\x77\x69\x74\x68\x64\x72\x61\x77\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x0a\x02\x01\x00\x01\x01\x05\x03\x19\x0a\x00\x0a\x01\x0b\x02\x0a\x03\x38\x00\x0a\x04\x06\x00\x00\x00\x00\x00\x00\x00\x00\x24\x03\x0a\x05\x16\x0b\x00\x11\x01\x0c\x05\x0e\x05\x0a\x01\x0a\x04\x07\x00\x07\x00\x38\x01\x0b\x05\x11\x03\x05\x18\x0b\x00\x01\x02"
CREATE_DESIGNATED_DEALER_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x04\x03\x04\x0b\x04\x0f\x02\x05\x11\x1b\x07\x2c\x48\x08\x74\x10\x00\x00\x00\x01\x01\x02\x00\x01\x00\x00\x03\x02\x01\x01\x01\x01\x04\x02\x06\x0c\x03\x00\x05\x06\x0c\x05\x0a\x02\x0a\x02\x01\x06\x06\x0c\x03\x05\x0a\x02\x0a\x02\x01\x01\x09\x00\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x18\x63\x72\x65\x61\x74\x65\x5f\x64\x65\x73\x69\x67\x6e\x61\x74\x65\x64\x5f\x64\x65\x61\x6c\x65\x72\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x03\x01\x0a\x0a\x00\x0a\x01\x11\x00\x0b\x00\x0a\x02\x0b\x03\x0b\x04\x0a\x05\x38\x00\x02"
CREATE_PARENT_VASP_ACCOUNT_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x04\x03\x04\x0b\x04\x0f\x02\x05\x11\x1b\x07\x2c\x4a\x08\x76\x10\x00\x00\x00\x01\x01\x02\x00\x01\x00\x00\x03\x02\x01\x01\x01\x01\x04\x02\x06\x0c\x03\x00\x05\x06\x0c\x05\x0a\x02\x0a\x02\x01\x06\x06\x0c\x03\x05\x0a\x02\x0a\x02\x01\x01\x09\x00\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x1a\x63\x72\x65\x61\x74\x65\x5f\x70\x61\x72\x65\x6e\x74\x5f\x76\x61\x73\x70\x5f\x61\x63\x63\x6f\x75\x6e\x74\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x03\x01\x0a\x0a\x00\x0a\x01\x11\x00\x0b\x00\x0a\x02\x0b\x03\x0b\x04\x0a\x05\x38\x00\x02"
CREATE_RECOVERY_ADDRESS_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x04\x02\x04\x04\x03\x08\x0a\x05\x12\x0c\x07\x1e\x5a\x08\x78\x10\x00\x00\x00\x01\x00\x02\x01\x00\x00\x03\x00\x01\x00\x01\x04\x02\x03\x00\x01\x06\x0c\x01\x08\x00\x02\x06\x0c\x08\x00\x00\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0f\x52\x65\x63\x6f\x76\x65\x72\x79\x41\x64\x64\x72\x65\x73\x73\x15\x4b\x65\x79\x52\x6f\x74\x61\x74\x69\x6f\x6e\x43\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1f\x65\x78\x74\x72\x61\x63\x74\x5f\x6b\x65\x79\x5f\x72\x6f\x74\x61\x74\x69\x6f\x6e\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x07\x70\x75\x62\x6c\x69\x73\x68\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x03\x05\x0a\x00\x0b\x00\x11\x00\x11\x01\x02"
CREATE_VALIDATOR_ACCOUNT_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x04\x03\x04\x0a\x05\x0e\x16\x07\x24\x48\x08\x6c\x10\x00\x00\x00\x01\x01\x02\x00\x01\x00\x00\x03\x02\x01\x00\x02\x06\x0c\x03\x00\x04\x06\x0c\x05\x0a\x02\x0a\x02\x05\x06\x0c\x03\x05\x0a\x02\x0a\x02\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x18\x63\x72\x65\x61\x74\x65\x5f\x76\x61\x6c\x69\x64\x61\x74\x6f\x72\x5f\x61\x63\x63\x6f\x75\x6e\x74\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x03\x01\x09\x0a\x00\x0a\x01\x11\x00\x0b\x00\x0a\x02\x0b\x03\x0b\x04\x11\x01\x02"
CREATE_VALIDATOR_OPERATOR_ACCOUNT_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x04\x03\x04\x0a\x05\x0e\x16\x07\x24\x51\x08\x75\x10\x00\x00\x00\x01\x01\x02\x00\x01\x00\x00\x03\x02\x01\x00\x02\x06\x0c\x03\x00\x04\x06\x0c\x05\x0a\x02\x0a\x02\x05\x06\x0c\x03\x05\x0a\x02\x0a\x02\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x21\x63\x72\x65\x61\x74\x65\x5f\x76\x61\x6c\x69\x64\x61\x74\x6f\x72\x5f\x6f\x70\x65\x72\x61\x74\x6f\x72\x5f\x61\x63\x63\x6f\x75\x6e\x74\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x03\x01\x09\x0a\x00\x0a\x01\x11\x00\x0b\x00\x0a\x02\x0b\x03\x0b\x04\x11\x01\x02"
FREEZE_ACCOUNT_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x04\x03\x04\x0a\x05\x0e\x0e\x07\x1c\x42\x08\x5e\x10\x00\x00\x00\x01\x00\x02\x00\x01\x00\x01\x03\x02\x01\x00\x02\x06\x0c\x05\x00\x02\x06\x0c\x03\x03\x06\x0c\x03\x05\x0f\x41\x63\x63\x6f\x75\x6e\x74\x46\x72\x65\x65\x7a\x69\x6e\x67\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x0e\x66\x72\x65\x65\x7a\x65\x5f\x61\x63\x63\x6f\x75\x6e\x74\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x03\x01\x07\x0a\x00\x0a\x01\x11\x01\x0b\x00\x0a\x02\x11\x00\x02"
PEER_TO_PEER_WITH_METADATA_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x07\x01\x00\x02\x02\x02\x04\x03\x06\x10\x04\x16\x02\x05\x18\x1d\x07\x35\x60\x08\x95\x01\x10\x00\x00\x00\x01\x01\x00\x00\x02\x00\x01\x00\x00\x03\x02\x03\x01\x01\x00\x04\x01\x03\x00\x01\x05\x01\x06\x0c\x01\x08\x00\x05\x06\x08\x00\x05\x03\x0a\x02\x0a\x02\x00\x05\x06\x0c\x05\x03\x0a\x02\x0a\x02\x01\x09\x00\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x12\x57\x69\x74\x68\x64\x72\x61\x77\x43\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1b\x65\x78\x74\x72\x61\x63\x74\x5f\x77\x69\x74\x68\x64\x72\x61\x77\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x08\x70\x61\x79\x5f\x66\x72\x6f\x6d\x1b\x72\x65\x73\x74\x6f\x72\x65\x5f\x77\x69\x74\x68\x64\x72\x61\x77\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x04\x01\x0c\x0b\x00\x11\x00\x0c\x05\x0e\x05\x0a\x01\x0a\x02\x0b\x03\x0b\x04\x38\x00\x0b\x05\x11\x02\x02"
PREBURN_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x07\x01\x00\x02\x02\x02\x04\x03\x06\x10\x04\x16\x02\x05\x18\x15\x07\x2d\x5f\x08\x8c\x01\x10\x00\x00\x00\x01\x01\x00\x00\x02\x00\x01\x00\x00\x03\x02\x03\x01\x01\x00\x04\x01\x03\x00\x01\x05\x01\x06\x0c\x01\x08\x00\x03\x06\x0c\x06\x08\x00\x03\x00\x02\x06\x0c\x03\x01\x09\x00\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x12\x57\x69\x74\x68\x64\x72\x61\x77\x43\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1b\x65\x78\x74\x72\x61\x63\x74\x5f\x77\x69\x74\x68\x64\x72\x61\x77\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x07\x70\x72\x65\x62\x75\x72\x6e\x1b\x72\x65\x73\x74\x6f\x72\x65\x5f\x77\x69\x74\x68\x64\x72\x61\x77\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x04\x01\x0a\x0a\x00\x11\x00\x0c\x02\x0b\x00\x0e\x02\x0a\x01\x38\x00\x0b\x02\x11\x02\x02"
PUBLISH_SHARED_ED25519_PUBLIC_KEY_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x02\x03\x02\x05\x05\x07\x06\x07\x0d\x1f\x08\x2c\x10\x00\x00\x00\x01\x00\x01\x00\x02\x06\x0c\x0a\x02\x00\x16\x53\x68\x61\x72\x65\x64\x45\x64\x32\x35\x35\x31\x39\x50\x75\x62\x6c\x69\x63\x4b\x65\x79\x07\x70\x75\x62\x6c\x69\x73\x68\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x01\x04\x0b\x00\x0b\x01\x11\x00\x02"
REGISTER_VALIDATOR_CONFIG_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x02\x03\x02\x05\x05\x07\x0b\x07\x12\x1b\x08\x2d\x10\x00\x00\x00\x01\x00\x01\x00\x05\x06\x0c\x05\x0a\x02\x0a\x02\x0a\x02\x00\x0f\x56\x61\x6c\x69\x64\x61\x74\x6f\x72\x43\x6f\x6e\x66\x69\x67\x0a\x73\x65\x74\x5f\x63\x6f\x6e\x66\x69\x67\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x01\x07\x0b\x00\x0a\x01\x0b\x02\x0b\x03\x0b\x04\x11\x00\x02"
REMOVE_VALIDATOR_AND_RECONFIGURE_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x06\x03\x06\x0f\x05\x15\x18\x07\x2d\x5e\x08\x8b\x01\x10\x00\x00\x00\x01\x00\x02\x01\x03\x00\x01\x00\x02\x04\x02\x03\x00\x00\x05\x04\x01\x00\x02\x06\x0c\x03\x00\x01\x05\x01\x0a\x02\x02\x06\x0c\x05\x04\x06\x0c\x03\x0a\x02\x05\x02\x01\x03\x0a\x44\x69\x65\x6d\x53\x79\x73\x74\x65\x6d\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x0f\x56\x61\x6c\x69\x64\x61\x74\x6f\x72\x43\x6f\x6e\x66\x69\x67\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x0e\x67\x65\x74\x5f\x68\x75\x6d\x61\x6e\x5f\x6e\x61\x6d\x65\x10\x72\x65\x6d\x6f\x76\x65\x5f\x76\x61\x6c\x69\x64\x61\x74\x6f\x72\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x05\x06\x12\x0a\x00\x0a\x01\x11\x00\x0a\x03\x11\x01\x0b\x02\x21\x0c\x04\x0b\x04\x03\x0e\x0b\x00\x01\x06\x00\x00\x00\x00\x00\x00\x00\x00\x27\x0b\x00\x0a\x03\x11\x02\x02"
ROTATE_AUTHENTICATION_KEY_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x02\x02\x02\x04\x03\x06\x0f\x05\x15\x12\x07\x27\x7c\x08\xa3\x01\x10\x00\x00\x00\x01\x01\x00\x00\x02\x00\x01\x00\x00\x03\x01\x02\x00\x00\x04\x03\x02\x00\x01\x06\x0c\x01\x08\x00\x00\x02\x06\x08\x00\x0a\x02\x02\x06\x0c\x0a\x02\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x15\x4b\x65\x79\x52\x6f\x74\x61\x74\x69\x6f\x6e\x43\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1f\x65\x78\x74\x72\x61\x63\x74\x5f\x6b\x65\x79\x5f\x72\x6f\x74\x61\x74\x69\x6f\x6e\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1f\x72\x65\x73\x74\x6f\x72\x65\x5f\x6b\x65\x79\x5f\x72\x6f\x74\x61\x74\x69\x6f\x6e\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x19\x72\x6f\x74\x61\x74\x65\x5f\x61\x75\x74\x68\x65\x6e\x74\x69\x63\x61\x74\x69\x6f\x6e\x5f\x6b\x65\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x04\x01\x09\x0b\x00\x11\x00\x0c\x02\x0e\x02\x0b\x01\x11\x02\x0b\x02\x11\x01\x02"
ROTATE_AUTHENTICATION_KEY_WITH_NONCE_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x04\x02\x04\x04\x03\x08\x14\x05\x1c\x17\x07\x33\x9f\x01\x08\xd2\x01\x10\x00\x00\x00\x01\x00\x03\x01\x00\x01\x02\x00\x01\x00\x00\x04\x02\x03\x00\x00\x05\x03\x01\x00\x00\x06\x04\x01\x00\x02\x06\x0c\x03\x00\x01\x06\x0c\x01\x08\x00\x02\x06\x08\x00\x0a\x02\x03\x06\x0c\x03\x0a\x02\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x15\x4b\x65\x79\x52\x6f\x74\x61\x74\x69\x6f\x6e\x43\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1f\x65\x78\x74\x72\x61\x63\x74\x5f\x6b\x65\x79\x5f\x72\x6f\x74\x61\x74\x69\x6f\x6e\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1f\x72\x65\x73\x74\x6f\x72\x65\x5f\x6b\x65\x79\x5f\x72\x6f\x74\x61\x74\x69\x6f\x6e\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x19\x72\x6f\x74\x61\x74\x65\x5f\x61\x75\x74\x68\x65\x6e\x74\x69\x63\x61\x74\x69\x6f\x6e\x5f\x6b\x65\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x05\x03\x0c\x0a\x00\x0a\x01\x11\x00\x0b\x00\x11\x01\x0c\x03\x0e\x03\x0b\x02\x11\x03\x0b\x03\x11\x02\x02"
ROTATE_AUTHENTICATION_KEY_WITH_NONCE_ADMIN_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x04\x02\x04\x04\x03\x08\x14\x05\x1c\x19\x07\x35\x9f\x01\x08\xd4\x01\x10\x00\x00\x00\x01\x00\x03\x01\x00\x01\x02\x00\x01\x00\x00\x04\x02\x03\x00\x00\x05\x03\x01\x00\x00\x06\x04\x01\x00\x02\x06\x0c\x03\x00\x01\x06\x0c\x01\x08\x00\x02\x06\x08\x00\x0a\x02\x04\x06\x0c\x06\x0c\x03\x0a\x02\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x15\x4b\x65\x79\x52\x6f\x74\x61\x74\x69\x6f\x6e\x43\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1f\x65\x78\x74\x72\x61\x63\x74\x5f\x6b\x65\x79\x5f\x72\x6f\x74\x61\x74\x69\x6f\x6e\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x1f\x72\x65\x73\x74\x6f\x72\x65\x5f\x6b\x65\x79\x5f\x72\x6f\x74\x61\x74\x69\x6f\x6e\x5f\x63\x61\x70\x61\x62\x69\x6c\x69\x74\x79\x19\x72\x6f\x74\x61\x74\x65\x5f\x61\x75\x74\x68\x65\x6e\x74\x69\x63\x61\x74\x69\x6f\x6e\x5f\x6b\x65\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x05\x03\x0c\x0b\x00\x0a\x02\x11\x00\x0b\x01\x11\x01\x0c\x04\x0e\x04\x0b\x03\x11\x03\x0b\x04\x11\x02\x02"
ROTATE_AUTHENTICATION_KEY_WITH_RECOVERY_ADDRESS_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x02\x03\x02\x05\x05\x07\x08\x07\x0f\x2a\x08\x39\x10\x00\x00\x00\x01\x00\x01\x00\x04\x06\x0c\x05\x05\x0a\x02\x00\x0f\x52\x65\x63\x6f\x76\x65\x72\x79\x41\x64\x64\x72\x65\x73\x73\x19\x72\x6f\x74\x61\x74\x65\x5f\x61\x75\x74\x68\x65\x6e\x74\x69\x63\x61\x74\x69\x6f\x6e\x5f\x6b\x65\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x01\x06\x0b\x00\x0a\x01\x0a\x02\x0b\x03\x11\x00\x02"
ROTATE_DUAL_ATTESTATION_INFO_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x02\x03\x02\x0a\x05\x0c\x0d\x07\x19\x3d\x08\x56\x10\x00\x00\x00\x01\x00\x01\x00\x00\x02\x00\x01\x00\x02\x06\x0c\x0a\x02\x00\x03\x06\x0c\x0a\x02\x0a\x02\x0f\x44\x75\x61\x6c\x41\x74\x74\x65\x73\x74\x61\x74\x69\x6f\x6e\x0f\x72\x6f\x74\x61\x74\x65\x5f\x62\x61\x73\x65\x5f\x75\x72\x6c\x1c\x72\x6f\x74\x61\x74\x65\x5f\x63\x6f\x6d\x70\x6c\x69\x61\x6e\x63\x65\x5f\x70\x75\x62\x6c\x69\x63\x5f\x6b\x65\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x02\x01\x07\x0a\x00\x0b\x01\x11\x00\x0b\x00\x0b\x02\x11\x01\x02"
ROTATE_SHARED_ED25519_PUBLIC_KEY_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x02\x03\x02\x05\x05\x07\x06\x07\x0d\x22\x08\x2f\x10\x00\x00\x00\x01\x00\x01\x00\x02\x06\x0c\x0a\x02\x00\x16\x53\x68\x61\x72\x65\x64\x45\x64\x32\x35\x35\x31\x39\x50\x75\x62\x6c\x69\x63\x4b\x65\x79\x0a\x72\x6f\x74\x61\x74\x65\x5f\x6b\x65\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x01\x04\x0b\x00\x0b\x01\x11\x00\x02"
SET_VALIDATOR_CONFIG_AND_RECONFIGURE_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x04\x03\x04\x0a\x05\x0e\x0f\x07\x1d\x44\x08\x61\x10\x00\x00\x00\x01\x01\x02\x00\x01\x00\x00\x03\x02\x01\x00\x05\x06\x0c\x05\x0a\x02\x0a\x02\x0a\x02\x00\x02\x06\x0c\x05\x0a\x44\x69\x65\x6d\x53\x79\x73\x74\x65\x6d\x0f\x56\x61\x6c\x69\x64\x61\x74\x6f\x72\x43\x6f\x6e\x66\x69\x67\x0a\x73\x65\x74\x5f\x63\x6f\x6e\x66\x69\x67\x1d\x75\x70\x64\x61\x74\x65\x5f\x63\x6f\x6e\x66\x69\x67\x5f\x61\x6e\x64\x5f\x72\x65\x63\x6f\x6e\x66\x69\x67\x75\x72\x65\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x01\x0a\x0a\x00\x0a\x01\x0b\x02\x0b\x03\x0b\x04\x11\x00\x0b\x00\x0a\x01\x11\x01\x02"
SET_VALIDATOR_OPERATOR_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x04\x03\x04\x0a\x05\x0e\x13\x07\x21\x44\x08\x65\x10\x00\x00\x00\x01\x01\x02\x00\x01\x00\x00\x03\x02\x03\x00\x01\x05\x01\x0a\x02\x02\x06\x0c\x05\x00\x03\x06\x0c\x0a\x02\x05\x02\x01\x03\x0f\x56\x61\x6c\x69\x64\x61\x74\x6f\x72\x43\x6f\x6e\x66\x69\x67\x17\x56\x61\x6c\x69\x64\x61\x74\x6f\x72\x4f\x70\x65\x72\x61\x74\x6f\x72\x43\x6f\x6e\x66\x69\x67\x0e\x67\x65\x74\x5f\x68\x75\x6d\x61\x6e\x5f\x6e\x61\x6d\x65\x0c\x73\x65\x74\x5f\x6f\x70\x65\x72\x61\x74\x6f\x72\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x04\x05\x0f\x0a\x02\x11\x00\x0b\x01\x21\x0c\x03\x0b\x03\x03\x0b\x0b\x00\x01\x06\x00\x00\x00\x00\x00\x00\x00\x00\x27\x0b\x00\x0a\x02\x11\x01\x02"
SET_VALIDATOR_OPERATOR_WITH_NONCE_ADMIN_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x06\x03\x06\x0f\x05\x15\x1a\x07\x2f\x67\x08\x96\x01\x10\x00\x00\x00\x01\x00\x02\x00\x03\x00\x01\x00\x02\x04\x02\x03\x00\x01\x05\x04\x01\x00\x02\x06\x0c\x03\x00\x01\x05\x01\x0a\x02\x02\x06\x0c\x05\x05\x06\x0c\x06\x0c\x03\x0a\x02\x05\x02\x01\x03\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x0f\x56\x61\x6c\x69\x64\x61\x74\x6f\x72\x43\x6f\x6e\x66\x69\x67\x17\x56\x61\x6c\x69\x64\x61\x74\x6f\x72\x4f\x70\x65\x72\x61\x74\x6f\x72\x43\x6f\x6e\x66\x69\x67\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x0e\x67\x65\x74\x5f\x68\x75\x6d\x61\x6e\x5f\x6e\x61\x6d\x65\x0c\x73\x65\x74\x5f\x6f\x70\x65\x72\x61\x74\x6f\x72\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x05\x06\x12\x0b\x00\x0a\x02\x11\x00\x0a\x04\x11\x01\x0b\x03\x21\x0c\x05\x0b\x05\x03\x0e\x0b\x01\x01\x06\x00\x00\x00\x00\x00\x00\x00\x00\x27\x0b\x01\x0a\x04\x11\x02\x02"
TIERED_MINT_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x04\x03\x04\x0b\x04\x0f\x02\x05\x11\x15\x07\x26\x3b\x08\x61\x10\x00\x00\x00\x01\x01\x02\x00\x01\x00\x00\x03\x02\x01\x01\x01\x01\x04\x02\x06\x0c\x03\x00\x04\x06\x0c\x05\x03\x03\x05\x06\x0c\x03\x05\x03\x03\x01\x09\x00\x0b\x44\x69\x65\x6d\x41\x63\x63\x6f\x75\x6e\x74\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x0b\x74\x69\x65\x72\x65\x64\x5f\x6d\x69\x6e\x74\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x03\x01\x09\x0a\x00\x0a\x01\x11\x00\x0b\x00\x0a\x02\x0a\x03\x0a\x04\x38\x00\x02"
UNFREEZE_ACCOUNT_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x04\x03\x04\x0a\x05\x0e\x0e\x07\x1c\x44\x08\x60\x10\x00\x00\x00\x01\x00\x02\x00\x01\x00\x01\x03\x02\x01\x00\x02\x06\x0c\x05\x00\x02\x06\x0c\x03\x03\x06\x0c\x03\x05\x0f\x41\x63\x63\x6f\x75\x6e\x74\x46\x72\x65\x65\x7a\x69\x6e\x67\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x10\x75\x6e\x66\x72\x65\x65\x7a\x65\x5f\x61\x63\x63\x6f\x75\x6e\x74\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x03\x01\x07\x0a\x00\x0a\x01\x11\x01\x0b\x00\x0a\x02\x11\x00\x02"
UPDATE_DIEM_VERSION_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x04\x03\x04\x0a\x05\x0e\x0a\x07\x18\x33\x08\x4b\x10\x00\x00\x00\x01\x00\x02\x00\x01\x00\x01\x03\x00\x01\x00\x02\x06\x0c\x03\x00\x03\x06\x0c\x03\x03\x0b\x44\x69\x65\x6d\x56\x65\x72\x73\x69\x6f\x6e\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x03\x73\x65\x74\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x02\x01\x07\x0a\x00\x0a\x01\x11\x01\x0b\x00\x0a\x02\x11\x00\x02"
UPDATE_DUAL_ATTESTATION_LIMIT_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x05\x01\x00\x04\x03\x04\x0a\x05\x0e\x0a\x07\x18\x47\x08\x5f\x10\x00\x00\x00\x01\x00\x02\x00\x01\x00\x01\x03\x00\x01\x00\x02\x06\x0c\x03\x00\x03\x06\x0c\x03\x03\x0f\x44\x75\x61\x6c\x41\x74\x74\x65\x73\x74\x61\x74\x69\x6f\x6e\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x13\x73\x65\x74\x5f\x6d\x69\x63\x72\x6f\x64\x69\x65\x6d\x5f\x6c\x69\x6d\x69\x74\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x02\x01\x07\x0a\x00\x0a\x01\x11\x01\x0b\x00\x0a\x02\x11\x00\x02"
UPDATE_EXCHANGE_RATE_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x07\x01\x00\x06\x02\x06\x04\x03\x0a\x10\x04\x1a\x02\x05\x1c\x19\x07\x35\x63\x08\x98\x01\x10\x00\x00\x00\x01\x00\x02\x01\x01\x02\x00\x01\x03\x00\x01\x00\x02\x04\x02\x03\x00\x00\x05\x04\x03\x01\x01\x02\x06\x02\x03\x03\x01\x08\x00\x02\x06\x0c\x03\x00\x02\x06\x0c\x08\x00\x04\x06\x0c\x03\x03\x03\x01\x09\x00\x04\x44\x69\x65\x6d\x0c\x46\x69\x78\x65\x64\x50\x6f\x69\x6e\x74\x33\x32\x0c\x53\x6c\x69\x64\x69\x6e\x67\x4e\x6f\x6e\x63\x65\x14\x63\x72\x65\x61\x74\x65\x5f\x66\x72\x6f\x6d\x5f\x72\x61\x74\x69\x6f\x6e\x61\x6c\x15\x72\x65\x63\x6f\x72\x64\x5f\x6e\x6f\x6e\x63\x65\x5f\x6f\x72\x5f\x61\x62\x6f\x72\x74\x18\x75\x70\x64\x61\x74\x65\x5f\x78\x64\x78\x5f\x65\x78\x63\x68\x61\x6e\x67\x65\x5f\x72\x61\x74\x65\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x05\x01\x0b\x0a\x00\x0a\x01\x11\x01\x0a\x02\x0a\x03\x11\x00\x0c\x04\x0b\x00\x0b\x04\x38\x00\x02"
UPDATE_MINTING_ABILITY_CODE = b"\xa1\x1c\xeb\x0b\x01\x00\x00\x00\x06\x01\x00\x02\x03\x02\x06\x04\x08\x02\x05\x0a\x08\x07\x12\x1c\x08\x2e\x10\x00\x00\x00\x01\x00\x01\x01\x01\x00\x02\x02\x06\x0c\x01\x00\x01\x09\x00\x04\x44\x69\x65\x6d\x16\x75\x70\x64\x61\x74\x65\x5f\x6d\x69\x6e\x74\x69\x6e\x67\x5f\x61\x62\x69\x6c\x69\x74\x79\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x01\x01\x00\x01\x04\x0b\x00\x0a\x01\x38\x00\x02"
# pyre-ignore
TRANSACTION_SCRIPT_ENCODER_MAP: typing.Dict[typing.Type[ScriptCall], typing.Callable[[ScriptCall], Script]] = {
ScriptCall__AddCurrencyToAccount: encode_add_currency_to_account_script,
ScriptCall__AddRecoveryRotationCapability: encode_add_recovery_rotation_capability_script,
ScriptCall__AddValidatorAndReconfigure: encode_add_validator_and_reconfigure_script,
ScriptCall__Burn: encode_burn_script,
ScriptCall__BurnTxnFees: encode_burn_txn_fees_script,
ScriptCall__CancelBurn: encode_cancel_burn_script,
ScriptCall__CreateChildVaspAccount: encode_create_child_vasp_account_script,
ScriptCall__CreateDesignatedDealer: encode_create_designated_dealer_script,
ScriptCall__CreateParentVaspAccount: encode_create_parent_vasp_account_script,
ScriptCall__CreateRecoveryAddress: encode_create_recovery_address_script,
ScriptCall__CreateValidatorAccount: encode_create_validator_account_script,
ScriptCall__CreateValidatorOperatorAccount: encode_create_validator_operator_account_script,
ScriptCall__FreezeAccount: encode_freeze_account_script,
ScriptCall__PeerToPeerWithMetadata: encode_peer_to_peer_with_metadata_script,
ScriptCall__Preburn: encode_preburn_script,
ScriptCall__PublishSharedEd25519PublicKey: encode_publish_shared_ed25519_public_key_script,
ScriptCall__RegisterValidatorConfig: encode_register_validator_config_script,
ScriptCall__RemoveValidatorAndReconfigure: encode_remove_validator_and_reconfigure_script,
ScriptCall__RotateAuthenticationKey: encode_rotate_authentication_key_script,
ScriptCall__RotateAuthenticationKeyWithNonce: encode_rotate_authentication_key_with_nonce_script,
ScriptCall__RotateAuthenticationKeyWithNonceAdmin: encode_rotate_authentication_key_with_nonce_admin_script,
ScriptCall__RotateAuthenticationKeyWithRecoveryAddress: encode_rotate_authentication_key_with_recovery_address_script,
ScriptCall__RotateDualAttestationInfo: encode_rotate_dual_attestation_info_script,
ScriptCall__RotateSharedEd25519PublicKey: encode_rotate_shared_ed25519_public_key_script,
ScriptCall__SetValidatorConfigAndReconfigure: encode_set_validator_config_and_reconfigure_script,
ScriptCall__SetValidatorOperator: encode_set_validator_operator_script,
ScriptCall__SetValidatorOperatorWithNonceAdmin: encode_set_validator_operator_with_nonce_admin_script,
ScriptCall__TieredMint: encode_tiered_mint_script,
ScriptCall__UnfreezeAccount: encode_unfreeze_account_script,
ScriptCall__UpdateDiemVersion: encode_update_diem_version_script,
ScriptCall__UpdateDualAttestationLimit: encode_update_dual_attestation_limit_script,
ScriptCall__UpdateExchangeRate: encode_update_exchange_rate_script,
ScriptCall__UpdateMintingAbility: encode_update_minting_ability_script,
}
# pyre-ignore
SCRIPT_FUNCTION_ENCODER_MAP: typing.Dict[
typing.Type[ScriptFunctionCall], typing.Callable[[ScriptFunctionCall], TransactionPayload]
] = {
ScriptFunctionCall__AddCurrencyToAccount: encode_add_currency_to_account_script_function,
ScriptFunctionCall__AddRecoveryRotationCapability: encode_add_recovery_rotation_capability_script_function,
ScriptFunctionCall__AddValidatorAndReconfigure: encode_add_validator_and_reconfigure_script_function,
ScriptFunctionCall__BurnTxnFees: encode_burn_txn_fees_script_function,
ScriptFunctionCall__BurnWithAmount: encode_burn_with_amount_script_function,
ScriptFunctionCall__CancelBurnWithAmount: encode_cancel_burn_with_amount_script_function,
ScriptFunctionCall__CreateChildVaspAccount: encode_create_child_vasp_account_script_function,
ScriptFunctionCall__CreateDesignatedDealer: encode_create_designated_dealer_script_function,
ScriptFunctionCall__CreateParentVaspAccount: encode_create_parent_vasp_account_script_function,
ScriptFunctionCall__CreateRecoveryAddress: encode_create_recovery_address_script_function,
ScriptFunctionCall__CreateValidatorAccount: encode_create_validator_account_script_function,
ScriptFunctionCall__CreateValidatorOperatorAccount: encode_create_validator_operator_account_script_function,
ScriptFunctionCall__FreezeAccount: encode_freeze_account_script_function,
ScriptFunctionCall__InitializeDiemConsensusConfig: encode_initialize_diem_consensus_config_script_function,
ScriptFunctionCall__PeerToPeerWithMetadata: encode_peer_to_peer_with_metadata_script_function,
ScriptFunctionCall__Preburn: encode_preburn_script_function,
ScriptFunctionCall__PublishSharedEd25519PublicKey: encode_publish_shared_ed25519_public_key_script_function,
ScriptFunctionCall__RegisterValidatorConfig: encode_register_validator_config_script_function,
ScriptFunctionCall__RemoveValidatorAndReconfigure: encode_remove_validator_and_reconfigure_script_function,
ScriptFunctionCall__RotateAuthenticationKey: encode_rotate_authentication_key_script_function,
ScriptFunctionCall__RotateAuthenticationKeyWithNonce: encode_rotate_authentication_key_with_nonce_script_function,
ScriptFunctionCall__RotateAuthenticationKeyWithNonceAdmin: encode_rotate_authentication_key_with_nonce_admin_script_function,
ScriptFunctionCall__RotateAuthenticationKeyWithRecoveryAddress: encode_rotate_authentication_key_with_recovery_address_script_function,
ScriptFunctionCall__RotateDualAttestationInfo: encode_rotate_dual_attestation_info_script_function,
ScriptFunctionCall__RotateSharedEd25519PublicKey: encode_rotate_shared_ed25519_public_key_script_function,
ScriptFunctionCall__SetGasConstants: encode_set_gas_constants_script_function,
ScriptFunctionCall__SetValidatorConfigAndReconfigure: encode_set_validator_config_and_reconfigure_script_function,
ScriptFunctionCall__SetValidatorOperator: encode_set_validator_operator_script_function,
ScriptFunctionCall__SetValidatorOperatorWithNonceAdmin: encode_set_validator_operator_with_nonce_admin_script_function,
ScriptFunctionCall__TieredMint: encode_tiered_mint_script_function,
ScriptFunctionCall__UnfreezeAccount: encode_unfreeze_account_script_function,
ScriptFunctionCall__UpdateDiemConsensusConfig: encode_update_diem_consensus_config_script_function,
ScriptFunctionCall__UpdateDiemVersion: encode_update_diem_version_script_function,
ScriptFunctionCall__UpdateDualAttestationLimit: encode_update_dual_attestation_limit_script_function,
ScriptFunctionCall__UpdateExchangeRate: encode_update_exchange_rate_script_function,
ScriptFunctionCall__UpdateMintingAbility: encode_update_minting_ability_script_function,
}
TRANSACTION_SCRIPT_DECODER_MAP: typing.Dict[bytes, typing.Callable[[Script], ScriptCall]] = {
ADD_CURRENCY_TO_ACCOUNT_CODE: decode_add_currency_to_account_script,
ADD_RECOVERY_ROTATION_CAPABILITY_CODE: decode_add_recovery_rotation_capability_script,
ADD_VALIDATOR_AND_RECONFIGURE_CODE: decode_add_validator_and_reconfigure_script,
BURN_CODE: decode_burn_script,
BURN_TXN_FEES_CODE: decode_burn_txn_fees_script,
CANCEL_BURN_CODE: decode_cancel_burn_script,
CREATE_CHILD_VASP_ACCOUNT_CODE: decode_create_child_vasp_account_script,
CREATE_DESIGNATED_DEALER_CODE: decode_create_designated_dealer_script,
CREATE_PARENT_VASP_ACCOUNT_CODE: decode_create_parent_vasp_account_script,
CREATE_RECOVERY_ADDRESS_CODE: decode_create_recovery_address_script,
CREATE_VALIDATOR_ACCOUNT_CODE: decode_create_validator_account_script,
CREATE_VALIDATOR_OPERATOR_ACCOUNT_CODE: decode_create_validator_operator_account_script,
FREEZE_ACCOUNT_CODE: decode_freeze_account_script,
PEER_TO_PEER_WITH_METADATA_CODE: decode_peer_to_peer_with_metadata_script,
PREBURN_CODE: decode_preburn_script,
PUBLISH_SHARED_ED25519_PUBLIC_KEY_CODE: decode_publish_shared_ed25519_public_key_script,
REGISTER_VALIDATOR_CONFIG_CODE: decode_register_validator_config_script,
REMOVE_VALIDATOR_AND_RECONFIGURE_CODE: decode_remove_validator_and_reconfigure_script,
ROTATE_AUTHENTICATION_KEY_CODE: decode_rotate_authentication_key_script,
ROTATE_AUTHENTICATION_KEY_WITH_NONCE_CODE: decode_rotate_authentication_key_with_nonce_script,
ROTATE_AUTHENTICATION_KEY_WITH_NONCE_ADMIN_CODE: decode_rotate_authentication_key_with_nonce_admin_script,
ROTATE_AUTHENTICATION_KEY_WITH_RECOVERY_ADDRESS_CODE: decode_rotate_authentication_key_with_recovery_address_script,
ROTATE_DUAL_ATTESTATION_INFO_CODE: decode_rotate_dual_attestation_info_script,
ROTATE_SHARED_ED25519_PUBLIC_KEY_CODE: decode_rotate_shared_ed25519_public_key_script,
SET_VALIDATOR_CONFIG_AND_RECONFIGURE_CODE: decode_set_validator_config_and_reconfigure_script,
SET_VALIDATOR_OPERATOR_CODE: decode_set_validator_operator_script,
SET_VALIDATOR_OPERATOR_WITH_NONCE_ADMIN_CODE: decode_set_validator_operator_with_nonce_admin_script,
TIERED_MINT_CODE: decode_tiered_mint_script,
UNFREEZE_ACCOUNT_CODE: decode_unfreeze_account_script,
UPDATE_DIEM_VERSION_CODE: decode_update_diem_version_script,
UPDATE_DUAL_ATTESTATION_LIMIT_CODE: decode_update_dual_attestation_limit_script,
UPDATE_EXCHANGE_RATE_CODE: decode_update_exchange_rate_script,
UPDATE_MINTING_ABILITY_CODE: decode_update_minting_ability_script,
}
SCRIPT_FUNCTION_DECODER_MAP: typing.Dict[str, typing.Callable[[TransactionPayload], ScriptFunctionCall]] = {
"AccountAdministrationScriptsadd_currency_to_account": decode_add_currency_to_account_script_function,
"AccountAdministrationScriptsadd_recovery_rotation_capability": decode_add_recovery_rotation_capability_script_function,
"ValidatorAdministrationScriptsadd_validator_and_reconfigure": decode_add_validator_and_reconfigure_script_function,
"TreasuryComplianceScriptsburn_txn_fees": decode_burn_txn_fees_script_function,
"TreasuryComplianceScriptsburn_with_amount": decode_burn_with_amount_script_function,
"TreasuryComplianceScriptscancel_burn_with_amount": decode_cancel_burn_with_amount_script_function,
"AccountCreationScriptscreate_child_vasp_account": decode_create_child_vasp_account_script_function,
"AccountCreationScriptscreate_designated_dealer": decode_create_designated_dealer_script_function,
"AccountCreationScriptscreate_parent_vasp_account": decode_create_parent_vasp_account_script_function,
"AccountAdministrationScriptscreate_recovery_address": decode_create_recovery_address_script_function,
"AccountCreationScriptscreate_validator_account": decode_create_validator_account_script_function,
"AccountCreationScriptscreate_validator_operator_account": decode_create_validator_operator_account_script_function,
"TreasuryComplianceScriptsfreeze_account": decode_freeze_account_script_function,
"SystemAdministrationScriptsinitialize_diem_consensus_config": decode_initialize_diem_consensus_config_script_function,
"PaymentScriptspeer_to_peer_with_metadata": decode_peer_to_peer_with_metadata_script_function,
"TreasuryComplianceScriptspreburn": decode_preburn_script_function,
"AccountAdministrationScriptspublish_shared_ed25519_public_key": decode_publish_shared_ed25519_public_key_script_function,
"ValidatorAdministrationScriptsregister_validator_config": decode_register_validator_config_script_function,
"ValidatorAdministrationScriptsremove_validator_and_reconfigure": decode_remove_validator_and_reconfigure_script_function,
"AccountAdministrationScriptsrotate_authentication_key": decode_rotate_authentication_key_script_function,
"AccountAdministrationScriptsrotate_authentication_key_with_nonce": decode_rotate_authentication_key_with_nonce_script_function,
"AccountAdministrationScriptsrotate_authentication_key_with_nonce_admin": decode_rotate_authentication_key_with_nonce_admin_script_function,
"AccountAdministrationScriptsrotate_authentication_key_with_recovery_address": decode_rotate_authentication_key_with_recovery_address_script_function,
"AccountAdministrationScriptsrotate_dual_attestation_info": decode_rotate_dual_attestation_info_script_function,
"AccountAdministrationScriptsrotate_shared_ed25519_public_key": decode_rotate_shared_ed25519_public_key_script_function,
"SystemAdministrationScriptsset_gas_constants": decode_set_gas_constants_script_function,
"ValidatorAdministrationScriptsset_validator_config_and_reconfigure": decode_set_validator_config_and_reconfigure_script_function,
"ValidatorAdministrationScriptsset_validator_operator": decode_set_validator_operator_script_function,
"ValidatorAdministrationScriptsset_validator_operator_with_nonce_admin": decode_set_validator_operator_with_nonce_admin_script_function,
"TreasuryComplianceScriptstiered_mint": decode_tiered_mint_script_function,
"TreasuryComplianceScriptsunfreeze_account": decode_unfreeze_account_script_function,
"SystemAdministrationScriptsupdate_diem_consensus_config": decode_update_diem_consensus_config_script_function,
"SystemAdministrationScriptsupdate_diem_version": decode_update_diem_version_script_function,
"TreasuryComplianceScriptsupdate_dual_attestation_limit": decode_update_dual_attestation_limit_script_function,
"TreasuryComplianceScriptsupdate_exchange_rate": decode_update_exchange_rate_script_function,
"TreasuryComplianceScriptsupdate_minting_ability": decode_update_minting_ability_script_function,
}
def encode_bool_argument(arg: bool) -> bytes:
return bcs_serialize(arg, bool)
def encode_u64_argument(arg: st.uint64) -> bytes:
return bcs_serialize(arg, st.uint64)
def encode_address_argument(arg: AccountAddress) -> bytes:
return arg.bcs_serialize()
def encode_u8vector_argument(arg: bytes) -> bytes:
return bcs_serialize(arg, bytes)
def decode_bool_argument(arg: TransactionArgument) -> bool:
if not isinstance(arg, TransactionArgument__Bool):
raise ValueError("Was expecting a Bool argument")
return arg.value
def decode_u64_argument(arg: TransactionArgument) -> st.uint64:
if not isinstance(arg, TransactionArgument__U64):
raise ValueError("Was expecting a U64 argument")
return arg.value
def decode_address_argument(arg: TransactionArgument) -> AccountAddress:
if not isinstance(arg, TransactionArgument__Address):
raise ValueError("Was expecting a Address argument")
return arg.value
def decode_u8vector_argument(arg: TransactionArgument) -> bytes:
if not isinstance(arg, TransactionArgument__U8Vector):
raise ValueError("Was expecting a U8Vector argument")
return arg.valueFunctions
def decode_add_currency_to_account_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_add_currency_to_account_script(script: Script) -> ScriptCall: return ScriptCall__AddCurrencyToAccount( currency=script.ty_args[0], ) def decode_add_currency_to_account_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_add_currency_to_account_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__AddCurrencyToAccount( currency=script.ty_args[0], ) def decode_add_recovery_rotation_capability_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_add_recovery_rotation_capability_script(script: Script) -> ScriptCall: return ScriptCall__AddRecoveryRotationCapability( recovery_address=decode_address_argument(script.args[0]), ) def decode_add_recovery_rotation_capability_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_add_recovery_rotation_capability_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__AddRecoveryRotationCapability( recovery_address=bcs_deserialize(script.args[0], AccountAddress)[0], ) def decode_add_validator_and_reconfigure_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_add_validator_and_reconfigure_script(script: Script) -> ScriptCall: return ScriptCall__AddValidatorAndReconfigure( sliding_nonce=decode_u64_argument(script.args[0]), validator_name=decode_u8vector_argument(script.args[1]), validator_address=decode_address_argument(script.args[2]), ) def decode_add_validator_and_reconfigure_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_add_validator_and_reconfigure_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__AddValidatorAndReconfigure( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], validator_name=bcs_deserialize(script.args[1], bytes)[0], validator_address=bcs_deserialize(script.args[2], AccountAddress)[0], ) def decode_address_argument(arg: TransactionArgument) ‑> AccountAddress-
Expand source code
def decode_address_argument(arg: TransactionArgument) -> AccountAddress: if not isinstance(arg, TransactionArgument__Address): raise ValueError("Was expecting a Address argument") return arg.value def decode_bool_argument(arg: TransactionArgument) ‑> bool-
Expand source code
def decode_bool_argument(arg: TransactionArgument) -> bool: if not isinstance(arg, TransactionArgument__Bool): raise ValueError("Was expecting a Bool argument") return arg.value def decode_burn_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_burn_script(script: Script) -> ScriptCall: return ScriptCall__Burn( token=script.ty_args[0], sliding_nonce=decode_u64_argument(script.args[0]), preburn_address=decode_address_argument(script.args[1]), ) def decode_burn_txn_fees_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_burn_txn_fees_script(script: Script) -> ScriptCall: return ScriptCall__BurnTxnFees( coin_type=script.ty_args[0], ) def decode_burn_txn_fees_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_burn_txn_fees_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__BurnTxnFees( coin_type=script.ty_args[0], ) def decode_burn_with_amount_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_burn_with_amount_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__BurnWithAmount( token=script.ty_args[0], sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], preburn_address=bcs_deserialize(script.args[1], AccountAddress)[0], amount=bcs_deserialize(script.args[2], st.uint64)[0], ) def decode_cancel_burn_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_cancel_burn_script(script: Script) -> ScriptCall: return ScriptCall__CancelBurn( token=script.ty_args[0], preburn_address=decode_address_argument(script.args[0]), ) def decode_cancel_burn_with_amount_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_cancel_burn_with_amount_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__CancelBurnWithAmount( token=script.ty_args[0], preburn_address=bcs_deserialize(script.args[0], AccountAddress)[0], amount=bcs_deserialize(script.args[1], st.uint64)[0], ) def decode_create_child_vasp_account_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_create_child_vasp_account_script(script: Script) -> ScriptCall: return ScriptCall__CreateChildVaspAccount( coin_type=script.ty_args[0], child_address=decode_address_argument(script.args[0]), auth_key_prefix=decode_u8vector_argument(script.args[1]), add_all_currencies=decode_bool_argument(script.args[2]), child_initial_balance=decode_u64_argument(script.args[3]), ) def decode_create_child_vasp_account_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_create_child_vasp_account_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__CreateChildVaspAccount( coin_type=script.ty_args[0], child_address=bcs_deserialize(script.args[0], AccountAddress)[0], auth_key_prefix=bcs_deserialize(script.args[1], bytes)[0], add_all_currencies=bcs_deserialize(script.args[2], bool)[0], child_initial_balance=bcs_deserialize(script.args[3], st.uint64)[0], ) def decode_create_designated_dealer_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_create_designated_dealer_script(script: Script) -> ScriptCall: return ScriptCall__CreateDesignatedDealer( currency=script.ty_args[0], sliding_nonce=decode_u64_argument(script.args[0]), addr=decode_address_argument(script.args[1]), auth_key_prefix=decode_u8vector_argument(script.args[2]), human_name=decode_u8vector_argument(script.args[3]), add_all_currencies=decode_bool_argument(script.args[4]), ) def decode_create_designated_dealer_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_create_designated_dealer_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__CreateDesignatedDealer( currency=script.ty_args[0], sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], addr=bcs_deserialize(script.args[1], AccountAddress)[0], auth_key_prefix=bcs_deserialize(script.args[2], bytes)[0], human_name=bcs_deserialize(script.args[3], bytes)[0], add_all_currencies=bcs_deserialize(script.args[4], bool)[0], ) def decode_create_parent_vasp_account_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_create_parent_vasp_account_script(script: Script) -> ScriptCall: return ScriptCall__CreateParentVaspAccount( coin_type=script.ty_args[0], sliding_nonce=decode_u64_argument(script.args[0]), new_account_address=decode_address_argument(script.args[1]), auth_key_prefix=decode_u8vector_argument(script.args[2]), human_name=decode_u8vector_argument(script.args[3]), add_all_currencies=decode_bool_argument(script.args[4]), ) def decode_create_parent_vasp_account_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_create_parent_vasp_account_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__CreateParentVaspAccount( coin_type=script.ty_args[0], sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], new_account_address=bcs_deserialize(script.args[1], AccountAddress)[0], auth_key_prefix=bcs_deserialize(script.args[2], bytes)[0], human_name=bcs_deserialize(script.args[3], bytes)[0], add_all_currencies=bcs_deserialize(script.args[4], bool)[0], ) def decode_create_recovery_address_script(_script: Script) ‑> ScriptCall-
Expand source code
def decode_create_recovery_address_script(_script: Script) -> ScriptCall: return ScriptCall__CreateRecoveryAddress() def decode_create_recovery_address_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_create_recovery_address_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__CreateRecoveryAddress() def decode_create_validator_account_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_create_validator_account_script(script: Script) -> ScriptCall: return ScriptCall__CreateValidatorAccount( sliding_nonce=decode_u64_argument(script.args[0]), new_account_address=decode_address_argument(script.args[1]), auth_key_prefix=decode_u8vector_argument(script.args[2]), human_name=decode_u8vector_argument(script.args[3]), ) def decode_create_validator_account_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_create_validator_account_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__CreateValidatorAccount( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], new_account_address=bcs_deserialize(script.args[1], AccountAddress)[0], auth_key_prefix=bcs_deserialize(script.args[2], bytes)[0], human_name=bcs_deserialize(script.args[3], bytes)[0], ) def decode_create_validator_operator_account_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_create_validator_operator_account_script(script: Script) -> ScriptCall: return ScriptCall__CreateValidatorOperatorAccount( sliding_nonce=decode_u64_argument(script.args[0]), new_account_address=decode_address_argument(script.args[1]), auth_key_prefix=decode_u8vector_argument(script.args[2]), human_name=decode_u8vector_argument(script.args[3]), ) def decode_create_validator_operator_account_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_create_validator_operator_account_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__CreateValidatorOperatorAccount( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], new_account_address=bcs_deserialize(script.args[1], AccountAddress)[0], auth_key_prefix=bcs_deserialize(script.args[2], bytes)[0], human_name=bcs_deserialize(script.args[3], bytes)[0], ) def decode_freeze_account_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_freeze_account_script(script: Script) -> ScriptCall: return ScriptCall__FreezeAccount( sliding_nonce=decode_u64_argument(script.args[0]), to_freeze_account=decode_address_argument(script.args[1]), ) def decode_freeze_account_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_freeze_account_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__FreezeAccount( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], to_freeze_account=bcs_deserialize(script.args[1], AccountAddress)[0], ) def decode_initialize_diem_consensus_config_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_initialize_diem_consensus_config_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__InitializeDiemConsensusConfig( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], ) def decode_peer_to_peer_with_metadata_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_peer_to_peer_with_metadata_script(script: Script) -> ScriptCall: return ScriptCall__PeerToPeerWithMetadata( currency=script.ty_args[0], payee=decode_address_argument(script.args[0]), amount=decode_u64_argument(script.args[1]), metadata=decode_u8vector_argument(script.args[2]), metadata_signature=decode_u8vector_argument(script.args[3]), ) def decode_peer_to_peer_with_metadata_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_peer_to_peer_with_metadata_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__PeerToPeerWithMetadata( currency=script.ty_args[0], payee=bcs_deserialize(script.args[0], AccountAddress)[0], amount=bcs_deserialize(script.args[1], st.uint64)[0], metadata=bcs_deserialize(script.args[2], bytes)[0], metadata_signature=bcs_deserialize(script.args[3], bytes)[0], ) def decode_preburn_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_preburn_script(script: Script) -> ScriptCall: return ScriptCall__Preburn( token=script.ty_args[0], amount=decode_u64_argument(script.args[0]), ) def decode_preburn_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_preburn_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__Preburn( token=script.ty_args[0], amount=bcs_deserialize(script.args[0], st.uint64)[0], ) -
Expand source code
def decode_publish_shared_ed25519_public_key_script(script: Script) -> ScriptCall: return ScriptCall__PublishSharedEd25519PublicKey( public_key=decode_u8vector_argument(script.args[0]), ) -
Expand source code
def decode_publish_shared_ed25519_public_key_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__PublishSharedEd25519PublicKey( public_key=bcs_deserialize(script.args[0], bytes)[0], ) def decode_register_validator_config_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_register_validator_config_script(script: Script) -> ScriptCall: return ScriptCall__RegisterValidatorConfig( validator_account=decode_address_argument(script.args[0]), consensus_pubkey=decode_u8vector_argument(script.args[1]), validator_network_addresses=decode_u8vector_argument(script.args[2]), fullnode_network_addresses=decode_u8vector_argument(script.args[3]), ) def decode_register_validator_config_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_register_validator_config_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__RegisterValidatorConfig( validator_account=bcs_deserialize(script.args[0], AccountAddress)[0], consensus_pubkey=bcs_deserialize(script.args[1], bytes)[0], validator_network_addresses=bcs_deserialize(script.args[2], bytes)[0], fullnode_network_addresses=bcs_deserialize(script.args[3], bytes)[0], ) def decode_remove_validator_and_reconfigure_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_remove_validator_and_reconfigure_script(script: Script) -> ScriptCall: return ScriptCall__RemoveValidatorAndReconfigure( sliding_nonce=decode_u64_argument(script.args[0]), validator_name=decode_u8vector_argument(script.args[1]), validator_address=decode_address_argument(script.args[2]), ) def decode_remove_validator_and_reconfigure_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_remove_validator_and_reconfigure_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__RemoveValidatorAndReconfigure( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], validator_name=bcs_deserialize(script.args[1], bytes)[0], validator_address=bcs_deserialize(script.args[2], AccountAddress)[0], ) def decode_rotate_authentication_key_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_rotate_authentication_key_script(script: Script) -> ScriptCall: return ScriptCall__RotateAuthenticationKey( new_key=decode_u8vector_argument(script.args[0]), ) def decode_rotate_authentication_key_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_rotate_authentication_key_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__RotateAuthenticationKey( new_key=bcs_deserialize(script.args[0], bytes)[0], ) def decode_rotate_authentication_key_with_nonce_admin_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_rotate_authentication_key_with_nonce_admin_script(script: Script) -> ScriptCall: return ScriptCall__RotateAuthenticationKeyWithNonceAdmin( sliding_nonce=decode_u64_argument(script.args[0]), new_key=decode_u8vector_argument(script.args[1]), ) def decode_rotate_authentication_key_with_nonce_admin_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_rotate_authentication_key_with_nonce_admin_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__RotateAuthenticationKeyWithNonceAdmin( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], new_key=bcs_deserialize(script.args[1], bytes)[0], ) def decode_rotate_authentication_key_with_nonce_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_rotate_authentication_key_with_nonce_script(script: Script) -> ScriptCall: return ScriptCall__RotateAuthenticationKeyWithNonce( sliding_nonce=decode_u64_argument(script.args[0]), new_key=decode_u8vector_argument(script.args[1]), ) def decode_rotate_authentication_key_with_nonce_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_rotate_authentication_key_with_nonce_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__RotateAuthenticationKeyWithNonce( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], new_key=bcs_deserialize(script.args[1], bytes)[0], ) def decode_rotate_authentication_key_with_recovery_address_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_rotate_authentication_key_with_recovery_address_script(script: Script) -> ScriptCall: return ScriptCall__RotateAuthenticationKeyWithRecoveryAddress( recovery_address=decode_address_argument(script.args[0]), to_recover=decode_address_argument(script.args[1]), new_key=decode_u8vector_argument(script.args[2]), ) def decode_rotate_authentication_key_with_recovery_address_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_rotate_authentication_key_with_recovery_address_script_function( script: TransactionPayload, ) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__RotateAuthenticationKeyWithRecoveryAddress( recovery_address=bcs_deserialize(script.args[0], AccountAddress)[0], to_recover=bcs_deserialize(script.args[1], AccountAddress)[0], new_key=bcs_deserialize(script.args[2], bytes)[0], ) def decode_rotate_dual_attestation_info_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_rotate_dual_attestation_info_script(script: Script) -> ScriptCall: return ScriptCall__RotateDualAttestationInfo( new_url=decode_u8vector_argument(script.args[0]), new_key=decode_u8vector_argument(script.args[1]), ) def decode_rotate_dual_attestation_info_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_rotate_dual_attestation_info_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__RotateDualAttestationInfo( new_url=bcs_deserialize(script.args[0], bytes)[0], new_key=bcs_deserialize(script.args[1], bytes)[0], ) -
Expand source code
def decode_rotate_shared_ed25519_public_key_script(script: Script) -> ScriptCall: return ScriptCall__RotateSharedEd25519PublicKey( public_key=decode_u8vector_argument(script.args[0]), ) -
Expand source code
def decode_rotate_shared_ed25519_public_key_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__RotateSharedEd25519PublicKey( public_key=bcs_deserialize(script.args[0], bytes)[0], ) def decode_script(script: Script) ‑> ScriptCall-
Try to recognize a Diem
Scriptand convert it into a structured objectScriptCall.Expand source code
def decode_script(script: Script) -> ScriptCall: """Try to recognize a Diem `Script` and convert it into a structured object `ScriptCall`.""" helper = TRANSACTION_SCRIPT_DECODER_MAP.get(script.code) if helper is None: raise ValueError("Unknown script bytecode") return helper(script) def decode_script_function_payload(payload: TransactionPayload) ‑> ScriptFunctionCall-
Try to recognize a Diem
TransactionPayloadand convert it into a structured objectScriptFunctionCall.Expand source code
def decode_script_function_payload(payload: TransactionPayload) -> ScriptFunctionCall: """Try to recognize a Diem `TransactionPayload` and convert it into a structured object `ScriptFunctionCall`.""" if not isinstance(payload, TransactionPayload__ScriptFunction): raise ValueError("Unexpected transaction payload") script = payload.value helper = SCRIPT_FUNCTION_DECODER_MAP.get(script.module.name.value + script.function.value) if helper is None: raise ValueError("Unknown script bytecode") return helper(script) def decode_set_gas_constants_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_set_gas_constants_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__SetGasConstants( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], global_memory_per_byte_cost=bcs_deserialize(script.args[1], st.uint64)[0], global_memory_per_byte_write_cost=bcs_deserialize(script.args[2], st.uint64)[0], min_transaction_gas_units=bcs_deserialize(script.args[3], st.uint64)[0], large_transaction_cutoff=bcs_deserialize(script.args[4], st.uint64)[0], intrinsic_gas_per_byte=bcs_deserialize(script.args[5], st.uint64)[0], maximum_number_of_gas_units=bcs_deserialize(script.args[6], st.uint64)[0], min_price_per_gas_unit=bcs_deserialize(script.args[7], st.uint64)[0], max_price_per_gas_unit=bcs_deserialize(script.args[8], st.uint64)[0], max_transaction_size_in_bytes=bcs_deserialize(script.args[9], st.uint64)[0], gas_unit_scaling_factor=bcs_deserialize(script.args[10], st.uint64)[0], default_account_size=bcs_deserialize(script.args[11], st.uint64)[0], ) def decode_set_validator_config_and_reconfigure_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_set_validator_config_and_reconfigure_script(script: Script) -> ScriptCall: return ScriptCall__SetValidatorConfigAndReconfigure( validator_account=decode_address_argument(script.args[0]), consensus_pubkey=decode_u8vector_argument(script.args[1]), validator_network_addresses=decode_u8vector_argument(script.args[2]), fullnode_network_addresses=decode_u8vector_argument(script.args[3]), ) def decode_set_validator_config_and_reconfigure_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_set_validator_config_and_reconfigure_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__SetValidatorConfigAndReconfigure( validator_account=bcs_deserialize(script.args[0], AccountAddress)[0], consensus_pubkey=bcs_deserialize(script.args[1], bytes)[0], validator_network_addresses=bcs_deserialize(script.args[2], bytes)[0], fullnode_network_addresses=bcs_deserialize(script.args[3], bytes)[0], ) def decode_set_validator_operator_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_set_validator_operator_script(script: Script) -> ScriptCall: return ScriptCall__SetValidatorOperator( operator_name=decode_u8vector_argument(script.args[0]), operator_account=decode_address_argument(script.args[1]), ) def decode_set_validator_operator_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_set_validator_operator_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__SetValidatorOperator( operator_name=bcs_deserialize(script.args[0], bytes)[0], operator_account=bcs_deserialize(script.args[1], AccountAddress)[0], ) def decode_set_validator_operator_with_nonce_admin_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_set_validator_operator_with_nonce_admin_script(script: Script) -> ScriptCall: return ScriptCall__SetValidatorOperatorWithNonceAdmin( sliding_nonce=decode_u64_argument(script.args[0]), operator_name=decode_u8vector_argument(script.args[1]), operator_account=decode_address_argument(script.args[2]), ) def decode_set_validator_operator_with_nonce_admin_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_set_validator_operator_with_nonce_admin_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__SetValidatorOperatorWithNonceAdmin( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], operator_name=bcs_deserialize(script.args[1], bytes)[0], operator_account=bcs_deserialize(script.args[2], AccountAddress)[0], ) def decode_tiered_mint_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_tiered_mint_script(script: Script) -> ScriptCall: return ScriptCall__TieredMint( coin_type=script.ty_args[0], sliding_nonce=decode_u64_argument(script.args[0]), designated_dealer_address=decode_address_argument(script.args[1]), mint_amount=decode_u64_argument(script.args[2]), tier_index=decode_u64_argument(script.args[3]), ) def decode_tiered_mint_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_tiered_mint_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__TieredMint( coin_type=script.ty_args[0], sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], designated_dealer_address=bcs_deserialize(script.args[1], AccountAddress)[0], mint_amount=bcs_deserialize(script.args[2], st.uint64)[0], tier_index=bcs_deserialize(script.args[3], st.uint64)[0], ) def decode_u64_argument(arg: TransactionArgument) ‑> numpy.uint64-
Expand source code
def decode_u64_argument(arg: TransactionArgument) -> st.uint64: if not isinstance(arg, TransactionArgument__U64): raise ValueError("Was expecting a U64 argument") return arg.value def decode_u8vector_argument(arg: TransactionArgument) ‑> bytes-
Expand source code
def decode_u8vector_argument(arg: TransactionArgument) -> bytes: if not isinstance(arg, TransactionArgument__U8Vector): raise ValueError("Was expecting a U8Vector argument") return arg.value def decode_unfreeze_account_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_unfreeze_account_script(script: Script) -> ScriptCall: return ScriptCall__UnfreezeAccount( sliding_nonce=decode_u64_argument(script.args[0]), to_unfreeze_account=decode_address_argument(script.args[1]), ) def decode_unfreeze_account_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_unfreeze_account_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__UnfreezeAccount( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], to_unfreeze_account=bcs_deserialize(script.args[1], AccountAddress)[0], ) def decode_update_diem_consensus_config_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_update_diem_consensus_config_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__UpdateDiemConsensusConfig( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], config=bcs_deserialize(script.args[1], bytes)[0], ) def decode_update_diem_version_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_update_diem_version_script(script: Script) -> ScriptCall: return ScriptCall__UpdateDiemVersion( sliding_nonce=decode_u64_argument(script.args[0]), major=decode_u64_argument(script.args[1]), ) def decode_update_diem_version_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_update_diem_version_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__UpdateDiemVersion( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], major=bcs_deserialize(script.args[1], st.uint64)[0], ) def decode_update_dual_attestation_limit_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_update_dual_attestation_limit_script(script: Script) -> ScriptCall: return ScriptCall__UpdateDualAttestationLimit( sliding_nonce=decode_u64_argument(script.args[0]), new_micro_xdx_limit=decode_u64_argument(script.args[1]), ) def decode_update_dual_attestation_limit_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_update_dual_attestation_limit_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__UpdateDualAttestationLimit( sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], new_micro_xdx_limit=bcs_deserialize(script.args[1], st.uint64)[0], ) def decode_update_exchange_rate_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_update_exchange_rate_script(script: Script) -> ScriptCall: return ScriptCall__UpdateExchangeRate( currency=script.ty_args[0], sliding_nonce=decode_u64_argument(script.args[0]), new_exchange_rate_numerator=decode_u64_argument(script.args[1]), new_exchange_rate_denominator=decode_u64_argument(script.args[2]), ) def decode_update_exchange_rate_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_update_exchange_rate_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__UpdateExchangeRate( currency=script.ty_args[0], sliding_nonce=bcs_deserialize(script.args[0], st.uint64)[0], new_exchange_rate_numerator=bcs_deserialize(script.args[1], st.uint64)[0], new_exchange_rate_denominator=bcs_deserialize(script.args[2], st.uint64)[0], ) def decode_update_minting_ability_script(script: Script) ‑> ScriptCall-
Expand source code
def decode_update_minting_ability_script(script: Script) -> ScriptCall: return ScriptCall__UpdateMintingAbility( currency=script.ty_args[0], allow_minting=decode_bool_argument(script.args[0]), ) def decode_update_minting_ability_script_function(script: TransactionPayload) ‑> ScriptFunctionCall-
Expand source code
def decode_update_minting_ability_script_function(script: TransactionPayload) -> ScriptFunctionCall: if not isinstance(script, ScriptFunction): raise ValueError("Unexpected transaction payload") return ScriptFunctionCall__UpdateMintingAbility( currency=script.ty_args[0], allow_minting=bcs_deserialize(script.args[0], bool)[0], ) def encode_add_currency_to_account_script(currency: TypeTag) ‑> Script-
Summary
Adds a zero
Currencybalance to the sendingaccount.This will enable
accountto send, receive, and holdDiem::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 aDiemAccount::Balance<Currency>published under it.Parameters
Name Type Description CurrencyType The Move type for the Currencybeing added to the sending account of the transaction.Currencymust be an already-registered currency on-chain.account&signerThe signer of the sending account of the transaction. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Currencyis 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 Currencyis already published under the sendingaccount.Related Scripts
Script::create_child_vasp_accountScript::create_parent_vasp_accountScript::peer_to_peer_with_metadata
Expand source code
def encode_add_currency_to_account_script(currency: TypeTag) -> Script: """# Summary Adds a zero `Currency` balance to the sending `account`. This will enable `account` to send, receive, and hold `Diem::Diem<Currency>` coins. This transaction can be successfully sent by any account that is allowed to hold balances (e.g., VASP, Designated Dealer). # Technical Description After the successful execution of this transaction the sending account will have a `DiemAccount::Balance<Currency>` resource with zero balance published under it. Only accounts that can hold balances can send this transaction, the sending account cannot already have a `DiemAccount::Balance<Currency>` published under it. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` being added to the sending account of the transaction. `Currency` must be an already-registered currency on-chain. | | `account` | `&signer` | The signer of the sending account of the transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EROLE_CANT_STORE_BALANCE` | The sending `account`'s role does not permit balances. | | `Errors::ALREADY_PUBLISHED` | `DiemAccount::EADD_EXISTING_CURRENCY` | A balance for `Currency` is already published under the sending `account`. | # Related Scripts * `Script::create_child_vasp_account` * `Script::create_parent_vasp_account` * `Script::peer_to_peer_with_metadata` """ return Script( code=ADD_CURRENCY_TO_ACCOUNT_CODE, ty_args=[currency], args=[], ) def encode_add_currency_to_account_script_function(currency: TypeTag) ‑> TransactionPayload-
Summary
Adds a zero
Currencybalance to the sendingaccount.This will enable
accountto send, receive, and holdDiem::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 aDiemAccount::Balance<Currency>published under it.Parameters
Name Type Description CurrencyType The Move type for the Currencybeing added to the sending account of the transaction.Currencymust be an already-registered currency on-chain.accountsignerThe signer of the sending account of the transaction. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Currencyis 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 Currencyis already published under the sendingaccount.Related Scripts
AccountCreationScripts::create_child_vasp_accountAccountCreationScripts::create_parent_vasp_accountPaymentScripts::peer_to_peer_with_metadata
Expand source code
def encode_add_currency_to_account_script_function(currency: TypeTag) -> TransactionPayload: """# Summary Adds a zero `Currency` balance to the sending `account`. This will enable `account` to send, receive, and hold `Diem::Diem<Currency>` coins. This transaction can be successfully sent by any account that is allowed to hold balances (e.g., VASP, Designated Dealer). # Technical Description After the successful execution of this transaction the sending account will have a `DiemAccount::Balance<Currency>` resource with zero balance published under it. Only accounts that can hold balances can send this transaction, the sending account cannot already have a `DiemAccount::Balance<Currency>` published under it. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` being added to the sending account of the transaction. `Currency` must be an already-registered currency on-chain. | | `account` | `signer` | The signer of the sending account of the transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EROLE_CANT_STORE_BALANCE` | The sending `account`'s role does not permit balances. | | `Errors::ALREADY_PUBLISHED` | `DiemAccount::EADD_EXISTING_CURRENCY` | A balance for `Currency` is already published under the sending `account`. | # Related Scripts * `AccountCreationScripts::create_child_vasp_account` * `AccountCreationScripts::create_parent_vasp_account` * `PaymentScripts::peer_to_peer_with_metadata` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("add_currency_to_account"), ty_args=[currency], args=[], ) ) def encode_add_recovery_rotation_capability_script(recovery_address: AccountAddress) ‑> Script-
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::KeyRotationCapabilityfor the sending account (to_recover_account) to theRecoveryAddress::RecoveryAddressresource underrecovery_address. After this transaction has been executed successfully the account atrecovery_addressand theto_recover_accountmay rotate the authentication key ofto_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 atrecovery_addressmust also be a VASP account belonging to the same VASP as theto_recover_account. Additionally the account atrecovery_addressmust have already initialized itself as a recovery account address using theScript::create_recovery_addresstransaction script.The sending account's (
to_recover_account) key rotation capability is removed in this transaction and stored in theRecoveryAddress::RecoveryAddressresource stored under the account atrecovery_address.Parameters
Name Type Description to_recover_account&signerThe signer reference of the sending account of this transaction. recovery_addressaddressThe account address where the to_recover_account'sDiemAccount::KeyRotationCapabilitywill be stored.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDto_recover_accounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_addressdoes not have aRecoveryAddressresource published under it.Errors::INVALID_ARGUMENTRecoveryAddress::EINVALID_KEY_ROTATION_DELEGATIONto_recover_accountandrecovery_addressdo not belong to the same VASP.Errors::LIMIT_EXCEEDEDRecoveryAddress::EMAX_KEYS_REGISTEREDRecoveryAddress::MAX_REGISTERED_KEYShave already been registered with thisrecovery_address.Related Scripts
Script::create_recovery_addressScript::rotate_authentication_key_with_recovery_address
Expand source code
def encode_add_recovery_rotation_capability_script(recovery_address: AccountAddress) -> Script: """# 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 `Script::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 | Name | Type | Description | | ------ | ------ | ------------- | | `to_recover_account` | `&signer` | The signer reference of the sending account of this transaction. | | `recovery_address` | `address` | The account address where the `to_recover_account`'s `DiemAccount::KeyRotationCapability` will be stored. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `to_recover_account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress` resource published under it. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EINVALID_KEY_ROTATION_DELEGATION` | `to_recover_account` and `recovery_address` do not belong to the same VASP. | | `Errors::LIMIT_EXCEEDED` | ` RecoveryAddress::EMAX_KEYS_REGISTERED` | `RecoveryAddress::MAX_REGISTERED_KEYS` have already been registered with this `recovery_address`. | # Related Scripts * `Script::create_recovery_address` * `Script::rotate_authentication_key_with_recovery_address` """ return Script( code=ADD_RECOVERY_ROTATION_CAPABILITY_CODE, ty_args=[], args=[TransactionArgument__Address(value=recovery_address)], ) def encode_add_recovery_rotation_capability_script_function(recovery_address: AccountAddress) ‑> TransactionPayload-
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::KeyRotationCapabilityfor the sending account (to_recover_account) to theRecoveryAddress::RecoveryAddressresource underrecovery_address. After this transaction has been executed successfully the account atrecovery_addressand theto_recover_accountmay rotate the authentication key ofto_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 atrecovery_addressmust also be a VASP account belonging to the same VASP as theto_recover_account. Additionally the account atrecovery_addressmust have already initialized itself as a recovery account address using theAccountAdministrationScripts::create_recovery_addresstransaction script.The sending account's (
to_recover_account) key rotation capability is removed in this transaction and stored in theRecoveryAddress::RecoveryAddressresource stored under the account atrecovery_address.Parameters
Name Type Description to_recover_accountsignerThe signer of the sending account of this transaction. recovery_addressaddressThe account address where the to_recover_account'sDiemAccount::KeyRotationCapabilitywill be stored.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDto_recover_accounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_addressdoes not have aRecoveryAddressresource published under it.Errors::INVALID_ARGUMENTRecoveryAddress::EINVALID_KEY_ROTATION_DELEGATIONto_recover_accountandrecovery_addressdo not belong to the same VASP.Errors::LIMIT_EXCEEDEDRecoveryAddress::EMAX_KEYS_REGISTEREDRecoveryAddress::MAX_REGISTERED_KEYShave already been registered with thisrecovery_address.Related Scripts
AccountAdministrationScripts::create_recovery_addressAccountAdministrationScripts::rotate_authentication_key_with_recovery_address
Expand source code
def encode_add_recovery_rotation_capability_script_function(recovery_address: AccountAddress) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `to_recover_account` | `signer` | The signer of the sending account of this transaction. | | `recovery_address` | `address` | The account address where the `to_recover_account`'s `DiemAccount::KeyRotationCapability` will be stored. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `to_recover_account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress` resource published under it. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EINVALID_KEY_ROTATION_DELEGATION` | `to_recover_account` and `recovery_address` do not belong to the same VASP. | | `Errors::LIMIT_EXCEEDED` | ` RecoveryAddress::EMAX_KEYS_REGISTERED` | `RecoveryAddress::MAX_REGISTERED_KEYS` have already been registered with this `recovery_address`. | # Related Scripts * `AccountAdministrationScripts::create_recovery_address` * `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("add_recovery_rotation_capability"), ty_args=[], args=[encode_address_argument(recovery_address)], ) ) def encode_add_validator_and_reconfigure_script(sliding_nonce: numpy.uint64, validator_name: bytes, validator_address: AccountAddress) ‑> Script-
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_addressto the validator set. This transaction emits aDiemConfig::NewEpochEventevent and triggers a reconfiguration. Once the reconfiguration triggered by this script's execution has been performed, the account at thevalidator_addressis considered to be a validator in the network.This transaction script will fail if the
validator_addressaddress is already in the validator set or does not have aValidatorConfig::ValidatorConfigresource already published under it.Parameters
Name Type Description dr_account&signerThe signer reference 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::ValidatorConfigfor the validator.validator_addressaddressThe validator account address to be added to the validator set. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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. 0 0 The provided validator_namedoes 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::ValidatorConfigresource published under it, or itsconfigfield is empty.Errors::INVALID_ARGUMENTDiemSystem::EALREADY_A_VALIDATORThe validator_addressaccount is already a registered validator.Errors::INVALID_STATEDiemConfig::EINVALID_BLOCK_TIMEAn invalid time value was encountered in reconfiguration. Unlikely to occur. Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::register_validator_configScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
def encode_add_validator_and_reconfigure_script( sliding_nonce: st.uint64, validator_name: bytes, validator_address: AccountAddress ) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. | | `validator_address` | `address` | The validator account address to be added to the validator set. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::EINVALID_PROSPECTIVE_VALIDATOR` | The validator to be added does not have a `ValidatorConfig::ValidatorConfig` resource published under it, or its `config` field is empty. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::EALREADY_A_VALIDATOR` | The `validator_address` account is already a registered validator. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ return Script( code=ADD_VALIDATOR_AND_RECONFIGURE_CODE, ty_args=[], args=[ TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U8Vector(value=validator_name), TransactionArgument__Address(value=validator_address), ], ) def encode_add_validator_and_reconfigure_script_function(sliding_nonce: numpy.uint64, validator_name: bytes, validator_address: AccountAddress) ‑> TransactionPayload-
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_addressto the validator set. This transaction emits aDiemConfig::NewEpochEventevent and triggers a reconfiguration. Once the reconfiguration triggered by this script's execution has been performed, the account at thevalidator_addressis considered to be a validator in the network.This transaction script will fail if the
validator_addressaddress is already in the validator set or does not have aValidatorConfig::ValidatorConfigresource already published under it.Parameters
Name Type Description 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::ValidatorConfigfor the validator.validator_addressaddressThe validator account address to be added to the validator set. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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. 0 0 The provided validator_namedoes 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::ValidatorConfigresource published under it, or itsconfigfield is empty.Errors::INVALID_ARGUMENTDiemSystem::EALREADY_A_VALIDATORThe validator_addressaccount 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. Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
def encode_add_validator_and_reconfigure_script_function( sliding_nonce: st.uint64, validator_name: bytes, validator_address: AccountAddress ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. | | `validator_address` | `address` | The validator account address to be added to the validator set. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::EINVALID_PROSPECTIVE_VALIDATOR` | The validator to be added does not have a `ValidatorConfig::ValidatorConfig` resource published under it, or its `config` field is empty. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::EALREADY_A_VALIDATOR` | The `validator_address` account is already a registered validator. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | | `Errors::LIMIT_EXCEEDED` | `DiemSystem::EMAX_VALIDATORS` | The validator set is already at its maximum size. The validator could not be added. | # Related Scripts * `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` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("ValidatorAdministrationScripts"), ), function=Identifier("add_validator_and_reconfigure"), ty_args=[], args=[ encode_u64_argument(sliding_nonce), encode_u8vector_argument(validator_name), encode_address_argument(validator_address), ], ) ) def encode_address_argument(arg: AccountAddress) ‑> bytes-
Expand source code
def encode_address_argument(arg: AccountAddress) -> bytes: return arg.bcs_serialize() def encode_bool_argument(arg: bool) ‑> bytes-
Expand source code
def encode_bool_argument(arg: bool) -> bytes: return bcs_serialize(arg, bool) def encode_burn_script(token: TypeTag, sliding_nonce: numpy.uint64, preburn_address: AccountAddress) ‑> Script-
Summary
Burns all coins held in the preburn resource at the specified preburn address and removes them from the system.
The sending account must be the Treasury Compliance account. The account that holds the preburn 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
Tokentype stored in theDiem::Preburn<Token>resource published under thepreburn_addressaccount address.This transaction will only succeed if the sending
accounthas aDiem::BurnCapability<Token>, and aDiem::Preburn<Token>resource exists underpreburn_address, with a non-zeroto_burnfield. After the successful execution of this transaction thetotal_valuefield in theDiem::CurrencyInfo<Token>resource published under0xA550C18will be decremented by the value of theto_burnfield of the preburn resource underpreburn_addressimmediately before this transaction, and theto_burnfield of the preburn resource will have a zero value.Events
The successful execution of this transaction will emit a
Diem::BurnEventon the event handle held in theDiem::CurrencyInfo<Token>resource'sburn_eventspublished under0xA550C18.Parameters
Name Type Description TokenType The Move type for the Tokencurrency being burned.Tokenmust be an already-registered currency on-chain.tc_account&signerThe signer reference of the sending account of this transaction, must have a burn capability for Tokenpublished 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. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending accountdoes not have aDiem::BurnCapability<Token>published under it.Errors::NOT_PUBLISHEDDiem::EPREBURNThe account at preburn_addressdoes not have aDiem::Preburn<Token>resource published under it.Errors::INVALID_STATEDiem::EPREBURN_EMPTYThe Diem::Preburn<Token>resource is empty (has a value of 0).Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Tokenis not a registered currency on-chain.Related Scripts
Script::burn_txn_feesScript::cancel_burnScript::preburn
Expand source code
def encode_burn_script(token: TypeTag, sliding_nonce: st.uint64, preburn_address: AccountAddress) -> Script: """# Summary Burns all coins held in the preburn resource at the specified preburn address and removes them from the system. The sending account must be the Treasury Compliance account. The account that holds the preburn 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currency being burned. `Token` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction, must have a burn capability for `Token` published under it. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `preburn_address` | `address` | The address where the coins to-be-burned are currently held. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | The account at `preburn_address` does not have a `Diem::Preburn<Token>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_EMPTY` | The `Diem::Preburn<Token>` resource is empty (has a value of 0). | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. | # Related Scripts * `Script::burn_txn_fees` * `Script::cancel_burn` * `Script::preburn` """ return Script( code=BURN_CODE, ty_args=[token], args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=preburn_address)], ) def encode_burn_txn_fees_script(coin_type: TypeTag) ‑> Script-
Summary
Burns the transaction fees collected in the
CoinTypecurrency 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
CoinTypeso that the association may reclaim the backing coins. Once this transaction has executed successfully all transaction fees that will have been collected inCoinTypesince the last time this script was called with that specific currency. Bothbalanceandpreburnfields in theTransactionFee::TransactionFee<CoinType>resource published under the0xB1E55EDaccount 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::BurnEventon the event handle held in theDiem::CurrencyInfo<CoinType>resource'sburn_eventspublished under0xA550C18.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypebeing added to the sending account of the transaction.CoinTypemust be an already-registered currency on-chain.tc_account&signerThe signer reference of the sending account of this transaction. Must be the Treasury Compliance account. Common Abort Conditions
Error Category Error Reason Description Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account. Errors::NOT_PUBLISHEDTransactionFee::ETRANSACTION_FEECoinTypeis not an accepted transaction fee currency.Errors::INVALID_ARGUMENTDiem::ECOINThe collected fees in CoinTypeare zero.Related Scripts
Script::burnScript::cancel_burn
Expand source code
def encode_burn_txn_fees_script(coin_type: TypeTag) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` being added to the sending account of the transaction. `CoinType` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `TransactionFee::ETRANSACTION_FEE` | `CoinType` is not an accepted transaction fee currency. | | `Errors::INVALID_ARGUMENT` | `Diem::ECOIN` | The collected fees in `CoinType` are zero. | # Related Scripts * `Script::burn` * `Script::cancel_burn` """ return Script( code=BURN_TXN_FEES_CODE, ty_args=[coin_type], args=[], ) def encode_burn_txn_fees_script_function(coin_type: TypeTag) ‑> TransactionPayload-
Summary
Burns the transaction fees collected in the
CoinTypecurrency 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
CoinTypeso that the association may reclaim the backing coins. Once this transaction has executed successfully all transaction fees that will have been collected inCoinTypesince the last time this script was called with that specific currency. Bothbalanceandpreburnfields in theTransactionFee::TransactionFee<CoinType>resource published under the0xB1E55EDaccount 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::BurnEventon the event handle held in theDiem::CurrencyInfo<CoinType>resource'sburn_eventspublished under0xA550C18.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypebeing added to the sending account of the transaction.CoinTypemust 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 Category Error Reason Description Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account. Errors::NOT_PUBLISHEDTransactionFee::ETRANSACTION_FEECoinTypeis not an accepted transaction fee currency.Errors::INVALID_ARGUMENTDiem::ECOINThe collected fees in CoinTypeare zero.Related Scripts
TreasuryComplianceScripts::burn_with_amountTreasuryComplianceScripts::cancel_burn_with_amount
Expand source code
def encode_burn_txn_fees_script_function(coin_type: TypeTag) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` being added to the sending account of the transaction. `CoinType` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `TransactionFee::ETRANSACTION_FEE` | `CoinType` is not an accepted transaction fee currency. | | `Errors::INVALID_ARGUMENT` | `Diem::ECOIN` | The collected fees in `CoinType` are zero. | # Related Scripts * `TreasuryComplianceScripts::burn_with_amount` * `TreasuryComplianceScripts::cancel_burn_with_amount` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("burn_txn_fees"), ty_args=[coin_type], args=[], ) ) def encode_burn_with_amount_script_function(token: TypeTag, sliding_nonce: numpy.uint64, preburn_address: AccountAddress, amount: numpy.uint64) ‑> TransactionPayload-
Summary
Burns the coins held in a preburn resource in the preburn queue at the specified preburn address, which are equal to the
amountspecified 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
Tokentype stored in theDiem::Preburn<Token>resource published under thepreburn_addressaccount address.This transaction will only succeed if the sending
accounthas aDiem::BurnCapability<Token>, and aDiem::Preburn<Token>resource exists underpreburn_address, with a non-zeroto_burnfield. After the successful execution of this transaction thetotal_valuefield in theDiem::CurrencyInfo<Token>resource published under0xA550C18will be decremented by the value of theto_burnfield of the preburn resource underpreburn_addressimmediately before this transaction, and theto_burnfield of the preburn resource will have a zero value.Events
The successful execution of this transaction will emit a
Diem::BurnEventon the event handle held in theDiem::CurrencyInfo<Token>resource'sburn_eventspublished under0xA550C18.Parameters
Name Type Description TokenType The Move type for the Tokencurrency being burned.Tokenmust be an already-registered currency on-chain.tc_accountsignerThe signer of the sending account of this transaction, must have a burn capability for Tokenpublished 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending accountdoes not have aDiem::BurnCapability<Token>published under it.Errors::INVALID_STATEDiem::EPREBURN_NOT_FOUNDThe Diem::PreburnQueue<Token>resource underpreburn_addressdoes not contain a preburn request with a value matchingamount.Errors::NOT_PUBLISHEDDiem::EPREBURN_QUEUEThe account at preburn_addressdoes not have aDiem::PreburnQueue<Token>resource published under it.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Tokenis not a registered currency on-chain.Related Scripts
TreasuryComplianceScripts::burn_txn_feesTreasuryComplianceScripts::cancel_burn_with_amountTreasuryComplianceScripts::preburn
Expand source code
def encode_burn_with_amount_script_function( token: TypeTag, sliding_nonce: st.uint64, preburn_address: AccountAddress, amount: st.uint64 ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currency being burned. `Token` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction, must have a burn capability for `Token` published under it. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `preburn_address` | `address` | The address where the coins to-be-burned are currently held. | | `amount` | `u64` | The amount to be burned. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_NOT_FOUND` | The `Diem::PreburnQueue<Token>` resource under `preburn_address` does not contain a preburn request with a value matching `amount`. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN_QUEUE` | The account at `preburn_address` does not have a `Diem::PreburnQueue<Token>` resource published under it. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. | # Related Scripts * `TreasuryComplianceScripts::burn_txn_fees` * `TreasuryComplianceScripts::cancel_burn_with_amount` * `TreasuryComplianceScripts::preburn` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("burn_with_amount"), ty_args=[token], args=[ encode_u64_argument(sliding_nonce), encode_address_argument(preburn_address), encode_u64_argument(amount), ], ) ) def encode_cancel_burn_script(token: TypeTag, preburn_address: AccountAddress) ‑> Script-
Summary
Cancels and returns all coins held in the preburn area under
preburn_addressand returns the funds to thepreburn_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 thepreburn_addressand return the funds to thepreburn_addressaccount'sDiemAccount::Balance<Token>. The transaction must be sent by anaccountwith aDiem::BurnCapability<Token>resource published under it. The account atpreburn_addressmust have aDiem::Preburn<Token>resource published under it, and its value must be nonzero. The transaction removes the entire balance held in theDiem::Preburn<Token>resource, and returns it back to the account'sDiemAccount::Balance<Token>underpreburn_address. Due to this, the account atpreburn_addressmust already have a balance in theTokencurrency published before this script is called otherwise the transaction will fail.Events
The successful execution of this transaction will emit: * A
Diem::CancelBurnEventon the event handle held in theDiem::CurrencyInfo<Token>resource'sburn_eventspublished under0xA550C18. * ADiemAccount::ReceivedPaymentEventon thepreburn_address'sDiemAccount::DiemAccountreceived_eventsevent handle with both thepayerandpayeebeingpreburn_address.Parameters
Name Type Description TokenType The Move type for the Tokencurrenty that burning is being cancelled for.Tokenmust be an already-registered currency on-chain.account&signerThe signer reference of the sending account of this transaction, must have a burn capability for Tokenpublished under it.preburn_addressaddressThe address where the coins to-be-burned are currently held. Common Abort Conditions
Error Category Error Reason Description Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending accountdoes not have aDiem::BurnCapability<Token>published under it.Errors::NOT_PUBLISHEDDiem::EPREBURNThe account at preburn_addressdoes not have aDiem::Preburn<Token>resource published under it.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Tokenis not a registered currency on-chain.Errors::INVALID_ARGUMENTDiemAccount::ECOIN_DEPOSIT_IS_ZEROThe value held in the preburn resource was zero. Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEThe account at preburn_addressdoesn't have a balance resource forToken.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 accountdoes not have a compliance key set on it but dual attestion checking was performed.Related Scripts
Script::burn_txn_feesScript::burnScript::preburn
Expand source code
def encode_cancel_burn_script(token: TypeTag, preburn_address: AccountAddress) -> Script: """# Summary Cancels and returns all coins held in the preburn area under `preburn_address` 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currenty that burning is being cancelled for. `Token` must be an already-registered currency on-chain. | | `account` | `&signer` | The signer reference of the sending account of this transaction, must have a burn capability for `Token` published under it. | | `preburn_address` | `address` | The address where the coins to-be-burned are currently held. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | The account at `preburn_address` does not have a `Diem::Preburn<Token>` resource published under it. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | The value held in the preburn resource was zero. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | The account at `preburn_address` doesn't have a balance resource for `Token`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds held in the prebun area would exceed the `account`'s account limits. | | `Errors::INVALID_STATE` | `DualAttestation::EPAYEE_COMPLIANCE_KEY_NOT_SET` | The `account` does not have a compliance key set on it but dual attestion checking was performed. | # Related Scripts * `Script::burn_txn_fees` * `Script::burn` * `Script::preburn` """ return Script( code=CANCEL_BURN_CODE, ty_args=[token], args=[TransactionArgument__Address(value=preburn_address)], ) def encode_cancel_burn_with_amount_script_function(token: TypeTag, preburn_address: AccountAddress, amount: numpy.uint64) ‑> TransactionPayload-
Summary
Cancels and returns the coins held in the preburn area under
preburn_address, which are equal to theamountspecified 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 thepreburn_addressand return the funds to thepreburn_addressaccount'sDiemAccount::Balance<Token>. The transaction must be sent by anaccountwith aDiem::BurnCapability<Token>resource published under it. The account atpreburn_addressmust have aDiem::Preburn<Token>resource published under it, and its value must be nonzero. The transaction removes the entire balance held in theDiem::Preburn<Token>resource, and returns it back to the account'sDiemAccount::Balance<Token>underpreburn_address. Due to this, the account atpreburn_addressmust already have a balance in theTokencurrency published before this script is called otherwise the transaction will fail.Events
The successful execution of this transaction will emit: * A
Diem::CancelBurnEventon the event handle held in theDiem::CurrencyInfo<Token>resource'sburn_eventspublished under0xA550C18. * ADiemAccount::ReceivedPaymentEventon thepreburn_address'sDiemAccount::DiemAccountreceived_eventsevent handle with both thepayerandpayeebeingpreburn_address.Parameters
Name Type Description TokenType The Move type for the Tokencurrenty that burning is being cancelled for.Tokenmust be an already-registered currency on-chain.accountsignerThe signer of the sending account of this transaction, must have a burn capability for Tokenpublished under it.preburn_addressaddressThe address where the coins to-be-burned are currently held. amountu64The amount to be cancelled. Common Abort Conditions
Error Category Error Reason Description Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending accountdoes not have aDiem::BurnCapability<Token>published under it.Errors::INVALID_STATEDiem::EPREBURN_NOT_FOUNDThe Diem::PreburnQueue<Token>resource underpreburn_addressdoes not contain a preburn request with a value matchingamount.Errors::NOT_PUBLISHEDDiem::EPREBURN_QUEUEThe account at preburn_addressdoes not have aDiem::PreburnQueue<Token>resource published under it.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Tokenis not a registered currency on-chain.Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEThe account at preburn_addressdoesn't have a balance resource forToken.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 accountdoes not have a compliance key set on it but dual attestion checking was performed.Related Scripts
TreasuryComplianceScripts::burn_txn_feesTreasuryComplianceScripts::burn_with_amountTreasuryComplianceScripts::preburn
Expand source code
def encode_cancel_burn_with_amount_script_function( token: TypeTag, preburn_address: AccountAddress, amount: st.uint64 ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currenty that burning is being cancelled for. `Token` must be an already-registered currency on-chain. | | `account` | `signer` | The signer of the sending account of this transaction, must have a burn capability for `Token` published under it. | | `preburn_address` | `address` | The address where the coins to-be-burned are currently held. | | `amount` | `u64` | The amount to be cancelled. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_NOT_FOUND` | The `Diem::PreburnQueue<Token>` resource under `preburn_address` does not contain a preburn request with a value matching `amount`. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN_QUEUE` | The account at `preburn_address` does not have a `Diem::PreburnQueue<Token>` resource published under it. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | The account at `preburn_address` doesn't have a balance resource for `Token`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds held in the prebun area would exceed the `account`'s account limits. | | `Errors::INVALID_STATE` | `DualAttestation::EPAYEE_COMPLIANCE_KEY_NOT_SET` | The `account` does not have a compliance key set on it but dual attestion checking was performed. | # Related Scripts * `TreasuryComplianceScripts::burn_txn_fees` * `TreasuryComplianceScripts::burn_with_amount` * `TreasuryComplianceScripts::preburn` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("cancel_burn_with_amount"), ty_args=[token], args=[encode_address_argument(preburn_address), encode_u64_argument(amount)], ) ) def encode_create_child_vasp_account_script(coin_type: TypeTag, child_address: AccountAddress, auth_key_prefix: bytes, add_all_currencies: bool, child_initial_balance: numpy.uint64) ‑> Script-
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
ChildVASPaccount for the senderparent_vaspatchild_addresswith a balance ofchild_initial_balanceinCoinTypeand an initial authentication key ofauth_key_prefix | child_address.If
add_all_currenciesis 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 with a
child_initial_balancegreater than zero will emit: * ADiemAccount::SentPaymentEventwith thepayerfield being the Parent VASP's address, and payee field beingchild_address. This is emitted on the Parent VASP'sDiemAccount::DiemAccountsent_eventshandle. * ADiemAccount::ReceivedPaymentEventwith thepayerfield being the Parent VASP's address, and payee field beingchild_address. This is emitted on the new Child VASPS'sDiemAccount::DiemAccountreceived_eventshandle.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypethat the child account should be created with.CoinTypemust be an already-registered currency on-chain.parent_vasp&signerThe signer 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 CoinTypeto give the child account when it's created.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYThe auth_key_prefixwas not of length 32.Errors::REQUIRES_ROLERoles::EPARENT_VASPThe sending account wasn't a Parent VASP account. Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe child_addressaddress 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 CoinTypeis 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_balanceofCoinTypebalance.Errors::INVALID_ARGUMENTDiemAccount::ECANNOT_CREATE_AT_VM_RESERVEDThe child_addressis the reserved address 0x0.Related Scripts
Script::create_parent_vasp_accountScript::add_currency_to_accountScript::rotate_authentication_keyScript::add_recovery_rotation_capabilityScript::create_recovery_address
Expand source code
def encode_create_child_vasp_account_script( coin_type: TypeTag, child_address: AccountAddress, auth_key_prefix: bytes, add_all_currencies: bool, child_initial_balance: st.uint64, ) -> Script: """# 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`. 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 with a `child_initial_balance` greater than zero will emit: * A `DiemAccount::SentPaymentEvent` with the `payer` field being the Parent VASP's address, and 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, and payee field being `child_address`. This is emitted on the new Child VASPS's `DiemAccount::DiemAccount` `received_events` handle. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` that the child account should be created with. `CoinType` must be an already-registered currency on-chain. | | `parent_vasp` | `&signer` | The signer reference of the sending account. Must be a Parent VASP account. | | `child_address` | `address` | Address of the to-be-created Child VASP account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. | | `child_initial_balance` | `u64` | The initial balance in `CoinType` to give the child account when it's created. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | The `auth_key_prefix` was not of length 32. | | `Errors::REQUIRES_ROLE` | `Roles::EPARENT_VASP` | The sending account wasn't a Parent VASP account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `child_address` address is already taken. | | `Errors::LIMIT_EXCEEDED` | `VASP::ETOO_MANY_CHILDREN` | The sending account has reached the maximum number of allowed child accounts. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. | | `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for the sending account has already been extracted. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | The sending account doesn't have a balance in `CoinType`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | The sending account doesn't have at least `child_initial_balance` of `CoinType` balance. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECANNOT_CREATE_AT_VM_RESERVED` | The `child_address` is the reserved address 0x0. | # Related Scripts * `Script::create_parent_vasp_account` * `Script::add_currency_to_account` * `Script::rotate_authentication_key` * `Script::add_recovery_rotation_capability` * `Script::create_recovery_address` """ return Script( code=CREATE_CHILD_VASP_ACCOUNT_CODE, ty_args=[coin_type], args=[ TransactionArgument__Address(value=child_address), TransactionArgument__U8Vector(value=auth_key_prefix), TransactionArgument__Bool(value=add_all_currencies), TransactionArgument__U64(value=child_initial_balance), ], ) def encode_create_child_vasp_account_script_function(coin_type: TypeTag, child_address: AccountAddress, auth_key_prefix: bytes, add_all_currencies: bool, child_initial_balance: numpy.uint64) ‑> TransactionPayload-
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
ChildVASPaccount for the senderparent_vaspatchild_addresswith a balance ofchild_initial_balanceinCoinTypeand an initial authentication key ofauth_key_prefix | child_address. Authentication key prefixes, and how to construct them from an ed25519 public key is described here.If
add_all_currenciesis 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::CreateAccountEventwith thecreatedfield beingchild_address, and therold_idfield beingRoles::CHILD_VASP_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Successful execution with a
child_initial_balancegreater than zero will additionaly emit: * ADiemAccount::SentPaymentEventwith thepayeefield beingchild_address. This is emitted on the Parent VASP'sDiemAccount::DiemAccountsent_eventshandle. * ADiemAccount::ReceivedPaymentEventwith thepayerfield being the Parent VASP's address. This is emitted on the new Child VASPS'sDiemAccount::DiemAccountreceived_eventshandle.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypethat the child account should be created with.CoinTypemust 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 CoinTypeto give the child account when it's created.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYThe auth_key_prefixwas not of length 32.Errors::REQUIRES_ROLERoles::EPARENT_VASPThe sending account wasn't a Parent VASP account. Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe child_addressaddress 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 CoinTypeis 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_balanceofCoinTypebalance.Errors::INVALID_ARGUMENTDiemAccount::ECANNOT_CREATE_AT_VM_RESERVEDThe child_addressis the reserved address 0x0.Related Scripts
AccountCreationScripts::create_parent_vasp_accountAccountAdministrationScripts::add_currency_to_accountAccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::add_recovery_rotation_capabilityAccountAdministrationScripts::create_recovery_address
Expand source code
def encode_create_child_vasp_account_script_function( coin_type: TypeTag, child_address: AccountAddress, auth_key_prefix: bytes, add_all_currencies: bool, child_initial_balance: st.uint64, ) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` that the child account should be created with. `CoinType` must be an already-registered currency on-chain. | | `parent_vasp` | `signer` | The reference of the sending account. Must be a Parent VASP account. | | `child_address` | `address` | Address of the to-be-created Child VASP account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. | | `child_initial_balance` | `u64` | The initial balance in `CoinType` to give the child account when it's created. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | The `auth_key_prefix` was not of length 32. | | `Errors::REQUIRES_ROLE` | `Roles::EPARENT_VASP` | The sending account wasn't a Parent VASP account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `child_address` address is already taken. | | `Errors::LIMIT_EXCEEDED` | `VASP::ETOO_MANY_CHILDREN` | The sending account has reached the maximum number of allowed child accounts. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. | | `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for the sending account has already been extracted. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | The sending account doesn't have a balance in `CoinType`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | The sending account doesn't have at least `child_initial_balance` of `CoinType` balance. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECANNOT_CREATE_AT_VM_RESERVED` | The `child_address` is the reserved address 0x0. | # Related Scripts * `AccountCreationScripts::create_parent_vasp_account` * `AccountAdministrationScripts::add_currency_to_account` * `AccountAdministrationScripts::rotate_authentication_key` * `AccountAdministrationScripts::add_recovery_rotation_capability` * `AccountAdministrationScripts::create_recovery_address` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountCreationScripts"), ), function=Identifier("create_child_vasp_account"), ty_args=[coin_type], args=[ encode_address_argument(child_address), encode_u8vector_argument(auth_key_prefix), encode_bool_argument(add_all_currencies), encode_u64_argument(child_initial_balance), ], ) ) def encode_create_designated_dealer_script(currency: TypeTag, sliding_nonce: numpy.uint64, addr: AccountAddress, auth_key_prefix: bytes, human_name: bytes, add_all_currencies: bool) ‑> Script-
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
addrwith authentication keyauth_key_prefix|addrand a 0 balance of typeCurrency. Ifadd_all_currenciesis 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.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.
Parameters
Name Type Description CurrencyType The Move type for the Currencythat the Designated Dealer should be initialized with.Currencymust be an already-registered currency on-chain.tc_account&signerThe signer reference 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 Currencywhen the account is created.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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 Currencyis not a registered currency on-chain.Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe addraddress is already taken.Related Scripts
Script::tiered_mintScript::peer_to_peer_with_metadataScript::rotate_dual_attestation_info
Expand source code
def encode_create_designated_dealer_script( currency: TypeTag, sliding_nonce: st.uint64, addr: AccountAddress, auth_key_prefix: bytes, human_name: bytes, add_all_currencies: bool, ) -> Script: """# 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. 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. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` that the Designated Dealer should be initialized with. `Currency` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `addr` | `address` | Address of the to-be-created Designated Dealer account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the Designated Dealer. | | `add_all_currencies` | `bool` | Whether 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 Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `addr` address is already taken. | # Related Scripts * `Script::tiered_mint` * `Script::peer_to_peer_with_metadata` * `Script::rotate_dual_attestation_info` """ return Script( code=CREATE_DESIGNATED_DEALER_CODE, ty_args=[currency], args=[ TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=addr), TransactionArgument__U8Vector(value=auth_key_prefix), TransactionArgument__U8Vector(value=human_name), TransactionArgument__Bool(value=add_all_currencies), ], ) def encode_create_designated_dealer_script_function(currency: TypeTag, sliding_nonce: numpy.uint64, addr: AccountAddress, auth_key_prefix: bytes, human_name: bytes, add_all_currencies: bool) ‑> TransactionPayload-
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
addrwith authentication keyauth_key_prefix|addrand a 0 balance of typeCurrency. Ifadd_all_currenciesis 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::CreateAccountEventwith thecreatedfield beingaddr, and therold_idfield beingRoles::DESIGNATED_DEALER_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Parameters
Name Type Description CurrencyType The Move type for the Currencythat the Designated Dealer should be initialized with.Currencymust 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 Currencywhen the account is created.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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 Currencyis not a registered currency on-chain.Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe addraddress is already taken.Related Scripts
TreasuryComplianceScripts::tiered_mintPaymentScripts::peer_to_peer_with_metadataAccountAdministrationScripts::rotate_dual_attestation_info
Expand source code
def encode_create_designated_dealer_script_function( currency: TypeTag, sliding_nonce: st.uint64, addr: AccountAddress, auth_key_prefix: bytes, human_name: bytes, add_all_currencies: bool, ) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` that the Designated Dealer should be initialized with. `Currency` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `addr` | `address` | Address of the to-be-created Designated Dealer account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the Designated Dealer. | | `add_all_currencies` | `bool` | Whether 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 Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `addr` address is already taken. | # Related Scripts * `TreasuryComplianceScripts::tiered_mint` * `PaymentScripts::peer_to_peer_with_metadata` * `AccountAdministrationScripts::rotate_dual_attestation_info` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountCreationScripts"), ), function=Identifier("create_designated_dealer"), ty_args=[currency], args=[ encode_u64_argument(sliding_nonce), encode_address_argument(addr), encode_u8vector_argument(auth_key_prefix), encode_u8vector_argument(human_name), encode_bool_argument(add_all_currencies), ], ) ) def encode_create_parent_vasp_account_script(coin_type: TypeTag, sliding_nonce: numpy.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes, add_all_currencies: bool) ‑> Script-
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
addresswith authentication keyauth_key_prefix|new_account_addressand a 0 balance of typeCoinType. Ifadd_all_currenciesis true, 0 balances for all available currencies in the system will also be added. This can only be invoked by an TreasuryCompliance account.sliding_nonceis a unique nonce for operation, seeSlidingNoncefor details.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypecurrency that the Parent VASP account should be initialized with.CoinTypemust be an already-registered currency on-chain.tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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 CoinTypeis not a registered currency on-chain.Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe new_account_addressaddress is already taken.Related Scripts
Script::create_child_vasp_accountScript::add_currency_to_accountScript::rotate_authentication_keyScript::add_recovery_rotation_capabilityScript::create_recovery_addressScript::rotate_dual_attestation_info
Expand source code
def encode_create_parent_vasp_account_script( coin_type: TypeTag, sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes, add_all_currencies: bool, ) -> Script: """# 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. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The 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_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Parent VASP account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the Parent VASP. | | `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `Script::create_child_vasp_account` * `Script::add_currency_to_account` * `Script::rotate_authentication_key` * `Script::add_recovery_rotation_capability` * `Script::create_recovery_address` * `Script::rotate_dual_attestation_info` """ return Script( code=CREATE_PARENT_VASP_ACCOUNT_CODE, ty_args=[coin_type], args=[ TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=new_account_address), TransactionArgument__U8Vector(value=auth_key_prefix), TransactionArgument__U8Vector(value=human_name), TransactionArgument__Bool(value=add_all_currencies), ], ) def encode_create_parent_vasp_account_script_function(coin_type: TypeTag, sliding_nonce: numpy.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes, add_all_currencies: bool) ‑> TransactionPayload-
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
addresswith authentication keyauth_key_prefix|new_account_addressand a 0 balance of typeCoinType. Ifadd_all_currenciesis true, 0 balances for all available currencies in the system will also be added. This can only be invoked by an TreasuryCompliance account.sliding_nonceis a unique nonce for operation, seeSlidingNoncefor details. Authentication keys, prefixes, and how to construct them from an ed25519 public key are described here.Events
Successful execution will emit: * A
DiemAccount::CreateAccountEventwith thecreatedfield beingnew_account_address, and therold_idfield beingRoles::PARENT_VASP_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypecurrency that the Parent VASP account should be initialized with.CoinTypemust 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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 CoinTypeis not a registered currency on-chain.Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe new_account_addressaddress is already taken.Related Scripts
AccountCreationScripts::create_child_vasp_accountAccountAdministrationScripts::add_currency_to_accountAccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::add_recovery_rotation_capabilityAccountAdministrationScripts::create_recovery_addressAccountAdministrationScripts::rotate_dual_attestation_info
Expand source code
def encode_create_parent_vasp_account_script_function( coin_type: TypeTag, sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes, add_all_currencies: bool, ) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). # 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The 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_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Parent VASP account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the Parent VASP. | | `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `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` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountCreationScripts"), ), function=Identifier("create_parent_vasp_account"), ty_args=[coin_type], args=[ encode_u64_argument(sliding_nonce), encode_address_argument(new_account_address), encode_u8vector_argument(auth_key_prefix), encode_u8vector_argument(human_name), encode_bool_argument(add_all_currencies), ], ) ) def encode_create_recovery_address_script() ‑> Script-
Summary
Initializes the sending account as a recovery address that may be used by the VASP that it belongs to.
The sending account must be a VASP account. Multiple recovery addresses can exist for a single VASP, but accounts in each must be disjoint.
Technical Description
Publishes a
RecoveryAddress::RecoveryAddressresource underaccount. It then extracts theDiemAccount::KeyRotationCapabilityforaccountand adds it to the resource. After the successful execution of this transaction other accounts may add their key rotation to this resource so thataccountmay be used as a recovery account for those accounts.Parameters
Name Type Description account&signerThe signer of the sending account of the transaction. Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTRecoveryAddress::ENOT_A_VASPaccountis 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::RecoveryAddressresource has already been published underaccount.Related Scripts
Script::add_recovery_rotation_capabilityScript::rotate_authentication_key_with_recovery_address
Expand source code
def encode_create_recovery_address_script() -> Script: """# Summary Initializes the sending account as a recovery address that may be used by the VASP that it belongs to. The sending account must be a 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | The signer of the sending account of the transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ENOT_A_VASP` | `account` is not a VASP account. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EKEY_ROTATION_DEPENDENCY_CYCLE` | A key rotation recovery cycle would be created by adding `account`'s key rotation capability. | | `Errors::ALREADY_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | A `RecoveryAddress::RecoveryAddress` resource has already been published under `account`. | # Related Scripts * `Script::add_recovery_rotation_capability` * `Script::rotate_authentication_key_with_recovery_address` """ return Script( code=CREATE_RECOVERY_ADDRESS_CODE, ty_args=[], args=[], ) def encode_create_recovery_address_script_function() ‑> TransactionPayload-
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::RecoveryAddressresource underaccount. It then extracts theDiemAccount::KeyRotationCapabilityforaccountand adds it to the resource. After the successful execution of this transaction other accounts may add their key rotation to this resource so thataccountmay be used as a recovery account for those accounts.Parameters
Name Type Description accountsignerThe signer of the sending account of the transaction. Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTRecoveryAddress::ENOT_A_VASPaccountis 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::RecoveryAddressresource has already been published underaccount.Related Scripts
Script::add_recovery_rotation_capabilityScript::rotate_authentication_key_with_recovery_address
Expand source code
def encode_create_recovery_address_script_function() -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | The signer of the sending account of the transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ENOT_A_VASP` | `account` is not a VASP account. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EKEY_ROTATION_DEPENDENCY_CYCLE` | A key rotation recovery cycle would be created by adding `account`'s key rotation capability. | | `Errors::ALREADY_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | A `RecoveryAddress::RecoveryAddress` resource has already been published under `account`. | # Related Scripts * `Script::add_recovery_rotation_capability` * `Script::rotate_authentication_key_with_recovery_address` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("create_recovery_address"), ty_args=[], args=[], ) ) def encode_create_validator_account_script(sliding_nonce: numpy.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes) ‑> Script-
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 keyauth_key_prefix|new_account_address. It publishes aValidatorConfig::ValidatorConfigresource with emptyconfig, andoperator_accountfields. Thehuman_namefield of theValidatorConfig::ValidatorConfigis set to the passed inhuman_name. This script does not add the validator to the validator set or the system, but only creates the account.Parameters
Name Type Description dr_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_addressaddress is already taken.Related Scripts
Script::add_validator_and_reconfigureScript::create_validator_operator_accountScript::register_validator_configScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
def encode_create_validator_account_script( sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes ) -> Script: """# 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. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Validator account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `Script::add_validator_and_reconfigure` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ return Script( code=CREATE_VALIDATOR_ACCOUNT_CODE, ty_args=[], args=[ TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=new_account_address), TransactionArgument__U8Vector(value=auth_key_prefix), TransactionArgument__U8Vector(value=human_name), ], ) def encode_create_validator_account_script_function(sliding_nonce: numpy.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes) ‑> TransactionPayload-
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 keyauth_key_prefix|new_account_address. It publishes aValidatorConfig::ValidatorConfigresource with emptyconfig, andoperator_accountfields. Thehuman_namefield of theValidatorConfig::ValidatorConfigis set to the passed inhuman_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::CreateAccountEventwith thecreatedfield beingnew_account_address, and therold_idfield beingRoles::VALIDATOR_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_addressaddress is already taken.Related Scripts
AccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
def encode_create_validator_account_script_function( sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes ) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). # 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Validator account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `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` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountCreationScripts"), ), function=Identifier("create_validator_account"), ty_args=[], args=[ encode_u64_argument(sliding_nonce), encode_address_argument(new_account_address), encode_u8vector_argument(auth_key_prefix), encode_u8vector_argument(human_name), ], ) ) def encode_create_validator_operator_account_script(sliding_nonce: numpy.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes) ‑> Script-
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 keyauth_key_prefix|new_account_address. It publishes aValidatorOperatorConfig::ValidatorOperatorConfigresource with the specifiedhuman_name. This script does not assign the validator operator to any validator accounts but only creates the account.Parameters
Name Type Description dr_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_addressaddress is already taken.Related Scripts
Script::create_validator_accountScript::add_validator_and_reconfigureScript::register_validator_configScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
def encode_create_validator_operator_account_script( sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes ) -> Script: """# 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. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Validator account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `Script::create_validator_account` * `Script::add_validator_and_reconfigure` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ return Script( code=CREATE_VALIDATOR_OPERATOR_ACCOUNT_CODE, ty_args=[], args=[ TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=new_account_address), TransactionArgument__U8Vector(value=auth_key_prefix), TransactionArgument__U8Vector(value=human_name), ], ) def encode_create_validator_operator_account_script_function(sliding_nonce: numpy.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes) ‑> TransactionPayload-
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 keyauth_key_prefix|new_account_address. It publishes aValidatorOperatorConfig::ValidatorOperatorConfigresource with the specifiedhuman_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::CreateAccountEventwith thecreatedfield beingnew_account_address, and therold_idfield beingRoles::VALIDATOR_OPERATOR_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_addressaddress is already taken.Related Scripts
AccountCreationScripts::create_validator_accountValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
def encode_create_validator_operator_account_script_function( sliding_nonce: st.uint64, new_account_address: AccountAddress, auth_key_prefix: bytes, human_name: bytes ) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). # 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Validator account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `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` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountCreationScripts"), ), function=Identifier("create_validator_operator_account"), ty_args=[], args=[ encode_u64_argument(sliding_nonce), encode_address_argument(new_account_address), encode_u8vector_argument(auth_key_prefix), encode_u8vector_argument(human_name), ], ) ) def encode_freeze_account_script(sliding_nonce: numpy.uint64, to_freeze_account: AccountAddress) ‑> Script-
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::FreezingBittotrueand emits aAccountFreezing::FreezeAccountEvent. The transaction sender must be the Treasury Compliance account, but the account atto_freeze_accountmust not be either0xA550C18(the Diem Root address), or0xB1E55ED(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::FreezeAccountEventon thefreeze_event_handleheld in theAccountFreezing::FreezeEventsHolderresource published under0xA550C18with thefrozen_addressbeing theto_freeze_account.Parameters
Name Type Description tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_accountwas the Treasury Compliance account (0xB1E55ED).Errors::INVALID_ARGUMENTAccountFreezing::ECANNOT_FREEZE_DIEM_ROOTto_freeze_accountwas the Diem Root account (0xA550C18).Related Scripts
Script::unfreeze_account
Expand source code
def encode_freeze_account_script(sliding_nonce: st.uint64, to_freeze_account: AccountAddress) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `to_freeze_account` | `address` | The account address to be frozen. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_TC` | `to_freeze_account` was the Treasury Compliance account (`0xB1E55ED`). | | `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_DIEM_ROOT` | `to_freeze_account` was the Diem Root account (`0xA550C18`). | # Related Scripts * `Script::unfreeze_account` """ return Script( code=FREEZE_ACCOUNT_CODE, ty_args=[], args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=to_freeze_account)], ) def encode_freeze_account_script_function(sliding_nonce: numpy.uint64, to_freeze_account: AccountAddress) ‑> TransactionPayload-
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::FreezingBittotrueand emits aAccountFreezing::FreezeAccountEvent. The transaction sender must be the Treasury Compliance account, but the account atto_freeze_accountmust not be either0xA550C18(the Diem Root address), or0xB1E55ED(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::FreezeAccountEventon thefreeze_event_handleheld in theAccountFreezing::FreezeEventsHolderresource published under0xA550C18with thefrozen_addressbeing theto_freeze_account.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_accountwas the Treasury Compliance account (0xB1E55ED).Errors::INVALID_ARGUMENTAccountFreezing::ECANNOT_FREEZE_DIEM_ROOTto_freeze_accountwas the Diem Root account (0xA550C18).Related Scripts
TreasuryComplianceScripts::unfreeze_account
Expand source code
def encode_freeze_account_script_function( sliding_nonce: st.uint64, to_freeze_account: AccountAddress ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `to_freeze_account` | `address` | The account address to be frozen. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_TC` | `to_freeze_account` was the Treasury Compliance account (`0xB1E55ED`). | | `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_DIEM_ROOT` | `to_freeze_account` was the Diem Root account (`0xA550C18`). | # Related Scripts * `TreasuryComplianceScripts::unfreeze_account` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("freeze_account"), ty_args=[], args=[encode_u64_argument(sliding_nonce), encode_address_argument(to_freeze_account)], ) ) def encode_initialize_diem_consensus_config_script_function(sliding_nonce: numpy.uint64) ‑> TransactionPayload-
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
DiemConsensusConfigon-chain config to empty and allows future updates from DiemRoot viaupdate_diem_consensus_config. This doesn't emit aDiemConfig::NewEpochEvent.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Expand source code
def encode_initialize_diem_consensus_config_script_function(sliding_nonce: st.uint64) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("SystemAdministrationScripts"), ), function=Identifier("initialize_diem_consensus_config"), ty_args=[], args=[encode_u64_argument(sliding_nonce)], ) ) def encode_peer_to_peer_with_metadata_script(currency: TypeTag, payee: AccountAddress, amount: numpy.uint64, metadata: bytes, metadata_signature: bytes) ‑> Script-
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
amountcoins of typeCurrencyfrompayertopayeewith (optional) associatedmetadataand an (optional)metadata_signatureon the messagemetadata|Signer::address_of(payer)|amount|DualAttestation::DOMAIN_SEPARATOR. Themetadataandmetadata_signatureparameters are only required ifamount>=DualAttestation::get_cur_microdiem_limitXDX andpayerandpayeeare 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-emptymetadata_signature. StandardizedmetadataBCS format can be found indiem_types::transaction::metadata::Metadata.Events
Successful execution of this script emits two events: * A
DiemAccount::SentPaymentEventonpayer'sDiemAccount::DiemAccountsent_eventshandle; and * ADiemAccount::ReceivedPaymentEventonpayee'sDiemAccount::DiemAccountreceived_eventshandle.Parameters
Name Type Description CurrencyType The Move type for the Currencybeing sent in this transaction.Currencymust be an already-registered currency on-chain.payer&signerThe signer reference 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 metadataand payment information. SeeCommon Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYpayerdoesn't hold a balance inCurrency.Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamountis greater thanpayer's balance inCurrency.Errors::INVALID_ARGUMENTDiemAccount::ECOIN_DEPOSIT_IS_ZEROamountis zero.Errors::NOT_PUBLISHEDDiemAccount::EPAYEE_DOES_NOT_EXISTNo account exists at the payeeaddress.Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEAn account exists at payee, but it does not accept payments inCurrency.Errors::INVALID_STATEAccountFreezing::EACCOUNT_FROZENThe payeeaccount is frozen.Errors::INVALID_ARGUMENTDualAttestation::EMALFORMED_METADATA_SIGNATUREmetadata_signatureis not 64 bytes.Errors::INVALID_ARGUMENTDualAttestation::EINVALID_METADATA_SIGNATUREmetadata_signaturedoes not verify on the against thepayee'sDualAttestation::Credentialcompliance_public_keypublic key.Errors::LIMIT_EXCEEDEDDiemAccount::EWITHDRAWAL_EXCEEDS_LIMITSpayerhas exceeded its daily withdrawal limits for the backing coins of XDX.Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSpayeehas exceeded its daily deposit limits for XDX.Related Scripts
Script::create_child_vasp_accountScript::create_parent_vasp_accountScript::add_currency_to_account
Expand source code
def encode_peer_to_peer_with_metadata_script( currency: TypeTag, payee: AccountAddress, amount: st.uint64, metadata: bytes, metadata_signature: bytes ) -> Script: """# 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 `metadata` | `Signer::address_of(payer)` | `amount` | `DualAttestation::DOMAIN_SEPARATOR`. 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` being sent in this transaction. `Currency` must be an already-registered currency on-chain. | | `payer` | `&signer` | The signer reference of the sending account that coins are being transferred from. | | `payee` | `address` | The address of the account the coins are being transferred to. | | `metadata` | `vector<u8>` | Optional metadata about this payment. | | `metadata_signature` | `vector<u8>` | Optional signature over `metadata` and payment information. See | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `payer` doesn't hold a balance in `Currency`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Currency`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | `amount` is zero. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYEE_DOES_NOT_EXIST` | No account exists at the `payee` address. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | An account exists at `payee`, but it does not accept payments in `Currency`. | | `Errors::INVALID_STATE` | `AccountFreezing::EACCOUNT_FROZEN` | The `payee` account is frozen. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EMALFORMED_METADATA_SIGNATURE` | `metadata_signature` is not 64 bytes. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_METADATA_SIGNATURE` | `metadata_signature` does not verify on the against the `payee'`s `DualAttestation::Credential` `compliance_public_key` public key. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EWITHDRAWAL_EXCEEDS_LIMITS` | `payer` has exceeded its daily withdrawal limits for the backing coins of XDX. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | `payee` has exceeded its daily deposit limits for XDX. | # Related Scripts * `Script::create_child_vasp_account` * `Script::create_parent_vasp_account` * `Script::add_currency_to_account` """ return Script( code=PEER_TO_PEER_WITH_METADATA_CODE, ty_args=[currency], args=[ TransactionArgument__Address(value=payee), TransactionArgument__U64(value=amount), TransactionArgument__U8Vector(value=metadata), TransactionArgument__U8Vector(value=metadata_signature), ], ) def encode_peer_to_peer_with_metadata_script_function(currency: TypeTag, payee: AccountAddress, amount: numpy.uint64, metadata: bytes, metadata_signature: bytes) ‑> TransactionPayload-
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
amountcoins of typeCurrencyfrompayertopayeewith (optional) associatedmetadataand an (optional)metadata_signatureon the message of the formmetadata|Signer::address_of(payer)|amount|DualAttestation::DOMAIN_SEPARATOR, that has been signed by thepayee's private key associated with thecompliance_public_keyheld in thepayee'sDualAttestation::Credential. Both theSigner::address_of(payer)andamountfields in themetadata_signaturemust be BCS-encoded bytes, and|denotes concatenation. Themetadataandmetadata_signatureparameters are only required ifamount>=DualAttestation::get_cur_microdiem_limitXDX andpayerandpayeeare 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-emptymetadata_signature. StandardizedmetadataBCS format can be found indiem_types::transaction::metadata::Metadata.Events
Successful execution of this script emits two events: * A
DiemAccount::SentPaymentEventonpayer'sDiemAccount::DiemAccountsent_eventshandle; and * ADiemAccount::ReceivedPaymentEventonpayee'sDiemAccount::DiemAccountreceived_eventshandle.Parameters
Name Type Description CurrencyType The Move type for the Currencybeing sent in this transaction.Currencymust 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 metadataand payment information. SeeCommon Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYpayerdoesn't hold a balance inCurrency.Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamountis greater thanpayer's balance inCurrency.Errors::INVALID_ARGUMENTDiemAccount::ECOIN_DEPOSIT_IS_ZEROamountis zero.Errors::NOT_PUBLISHEDDiemAccount::EPAYEE_DOES_NOT_EXISTNo account exists at the payeeaddress.Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEAn account exists at payee, but it does not accept payments inCurrency.Errors::INVALID_STATEAccountFreezing::EACCOUNT_FROZENThe payeeaccount is frozen.Errors::INVALID_ARGUMENTDualAttestation::EMALFORMED_METADATA_SIGNATUREmetadata_signatureis not 64 bytes.Errors::INVALID_ARGUMENTDualAttestation::EINVALID_METADATA_SIGNATUREmetadata_signaturedoes not verify on the against thepayee'sDualAttestation::Credentialcompliance_public_keypublic key.Errors::LIMIT_EXCEEDEDDiemAccount::EWITHDRAWAL_EXCEEDS_LIMITSpayerhas exceeded its daily withdrawal limits for the backing coins of XDX.Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSpayeehas exceeded its daily deposit limits for XDX.Related Scripts
AccountCreationScripts::create_child_vasp_accountAccountCreationScripts::create_parent_vasp_accountAccountAdministrationScripts::add_currency_to_account
Expand source code
def encode_peer_to_peer_with_metadata_script_function( currency: TypeTag, payee: AccountAddress, amount: st.uint64, metadata: bytes, metadata_signature: bytes ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` being sent in this transaction. `Currency` must be an already-registered currency on-chain. | | `payer` | `signer` | The signer of the sending account that coins are being transferred from. | | `payee` | `address` | The address of the account the coins are being transferred to. | | `metadata` | `vector<u8>` | Optional metadata about this payment. | | `metadata_signature` | `vector<u8>` | Optional signature over `metadata` and payment information. See | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `payer` doesn't hold a balance in `Currency`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Currency`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | `amount` is zero. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYEE_DOES_NOT_EXIST` | No account exists at the `payee` address. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | An account exists at `payee`, but it does not accept payments in `Currency`. | | `Errors::INVALID_STATE` | `AccountFreezing::EACCOUNT_FROZEN` | The `payee` account is frozen. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EMALFORMED_METADATA_SIGNATURE` | `metadata_signature` is not 64 bytes. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_METADATA_SIGNATURE` | `metadata_signature` does not verify on the against the `payee'`s `DualAttestation::Credential` `compliance_public_key` public key. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EWITHDRAWAL_EXCEEDS_LIMITS` | `payer` has exceeded its daily withdrawal limits for the backing coins of XDX. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | `payee` has exceeded its daily deposit limits for XDX. | # Related Scripts * `AccountCreationScripts::create_child_vasp_account` * `AccountCreationScripts::create_parent_vasp_account` * `AccountAdministrationScripts::add_currency_to_account` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("PaymentScripts") ), function=Identifier("peer_to_peer_with_metadata"), ty_args=[currency], args=[ encode_address_argument(payee), encode_u64_argument(amount), encode_u8vector_argument(metadata), encode_u8vector_argument(metadata_signature), ], ) ) def encode_preburn_script(token: TypeTag, amount: numpy.uint64) ‑> Script-
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
amountof coins inTokencurrency from the sendingaccount'sDiemAccount::Balance<Token>to theDiem::Preburn<Token>published under the sameaccount.accountmust 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::SentPaymentEventonaccount'sDiemAccount::DiemAccountsent_eventshandle with thepayeeandpayerfields beingaccount's address; and * ADiem::PreburnEventwithToken's currency code on theDiem::CurrencyInfo<Token'spreburn_eventshandle forTokenand withpreburn_addressset toaccount's address.Parameters
Name Type Description TokenType The Move type for the Tokencurrency being moved to the preburn area.Tokenmust be an already-registered currency on-chain.account&signerThe signer reference of the sending account. amountu64The amount in Tokento be moved to the preburn area.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Tokenis not a registered currency on-chain.Errors::INVALID_STATEDiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTEDThe withdrawal capability for accounthas already been extracted.Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamountis greater thanpayer's balance inToken.Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYaccountdoesn't hold a balance inToken.Errors::NOT_PUBLISHEDDiem::EPREBURNaccountdoesn't have aDiem::Preburn<Token>resource published under it.Errors::INVALID_STATEDiem::EPREBURN_OCCUPIEDThe valuefield in theDiem::Preburn<Token>resource under the sender is non-zero.Errors::NOT_PUBLISHEDRoles::EROLE_IDThe accountdid not have a role assigned to it.Errors::REQUIRES_ROLERoles::EDESIGNATED_DEALERThe accountdid not have the role of DesignatedDealer.Related Scripts
Script::cancel_burnScript::burnScript::burn_txn_fees
Expand source code
def encode_preburn_script(token: TypeTag, amount: st.uint64) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currency being moved to the preburn area. `Token` must be an already-registered currency on-chain. | | `account` | `&signer` | The signer reference of the sending account. | | `amount` | `u64` | The amount in `Token` to be moved to the preburn area. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Token` is not a registered currency on-chain. | | `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for `account` has already been extracted. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Token`. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `account` doesn't hold a balance in `Token`. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | `account` doesn't have a `Diem::Preburn<Token>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_OCCUPIED` | The `value` field in the `Diem::Preburn<Token>` resource under the sender is non-zero. | | `Errors::NOT_PUBLISHED` | `Roles::EROLE_ID` | The `account` did not have a role assigned to it. | | `Errors::REQUIRES_ROLE` | `Roles::EDESIGNATED_DEALER` | The `account` did not have the role of DesignatedDealer. | # Related Scripts * `Script::cancel_burn` * `Script::burn` * `Script::burn_txn_fees` """ return Script( code=PREBURN_CODE, ty_args=[token], args=[TransactionArgument__U64(value=amount)], ) def encode_preburn_script_function(token: TypeTag, amount: numpy.uint64) ‑> TransactionPayload-
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
amountof coins inTokencurrency from the sendingaccount'sDiemAccount::Balance<Token>to theDiem::Preburn<Token>published under the sameaccount.accountmust 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::SentPaymentEventonaccount'sDiemAccount::DiemAccountsent_eventshandle with thepayeeandpayerfields beingaccount's address; and * ADiem::PreburnEventwithToken's currency code on theDiem::CurrencyInfo<Token'spreburn_eventshandle forTokenand withpreburn_addressset toaccount's address.Parameters
Name Type Description TokenType The Move type for the Tokencurrency being moved to the preburn area.Tokenmust be an already-registered currency on-chain.accountsignerThe signer of the sending account. amountu64The amount in Tokento be moved to the preburn area.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Tokenis not a registered currency on-chain.Errors::INVALID_STATEDiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTEDThe withdrawal capability for accounthas already been extracted.Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamountis greater thanpayer's balance inToken.Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYaccountdoesn't hold a balance inToken.Errors::NOT_PUBLISHEDDiem::EPREBURNaccountdoesn't have aDiem::Preburn<Token>resource published under it.Errors::INVALID_STATEDiem::EPREBURN_OCCUPIEDThe valuefield in theDiem::Preburn<Token>resource under the sender is non-zero.Errors::NOT_PUBLISHEDRoles::EROLE_IDThe accountdid not have a role assigned to it.Errors::REQUIRES_ROLERoles::EDESIGNATED_DEALERThe accountdid not have the role of DesignatedDealer.Related Scripts
TreasuryComplianceScripts::cancel_burn_with_amountTreasuryComplianceScripts::burn_with_amountTreasuryComplianceScripts::burn_txn_fees
Expand source code
def encode_preburn_script_function(token: TypeTag, amount: st.uint64) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currency being moved to the preburn area. `Token` must be an already-registered currency on-chain. | | `account` | `signer` | The signer of the sending account. | | `amount` | `u64` | The amount in `Token` to be moved to the preburn area. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Token` is not a registered currency on-chain. | | `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for `account` has already been extracted. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Token`. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `account` doesn't hold a balance in `Token`. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | `account` doesn't have a `Diem::Preburn<Token>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_OCCUPIED` | The `value` field in the `Diem::Preburn<Token>` resource under the sender is non-zero. | | `Errors::NOT_PUBLISHED` | `Roles::EROLE_ID` | The `account` did not have a role assigned to it. | | `Errors::REQUIRES_ROLE` | `Roles::EDESIGNATED_DEALER` | The `account` did not have the role of DesignatedDealer. | # Related Scripts * `TreasuryComplianceScripts::cancel_burn_with_amount` * `TreasuryComplianceScripts::burn_with_amount` * `TreasuryComplianceScripts::burn_txn_fees` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("preburn"), ty_args=[token], args=[encode_u64_argument(amount)], ) ) -
Summary
Rotates the authentication key of the sending account to the newly-specified public key and publishes a new shared authentication key under the sender's account.
Any account can send this transaction.
Technical Description
Rotates the authentication key of the sending account to
public_key, and publishes aSharedEd25519PublicKey::SharedEd25519PublicKeyresource containing the 32-byte ed25519public_keyand theDiemAccount::KeyRotationCapabilityforaccountunderaccount.Parameters
Name Type Description account&signerThe signer reference of the sending account of the transaction. public_keyvector<u8>32-byte Ed25519 public key for account' authentication key to be rotated to and stored.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapabilityresource.Errors::ALREADY_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYThe SharedEd25519PublicKey::SharedEd25519PublicKeyresource is already published underaccount.Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_keyis an invalid ed25519 public key.Related Scripts
Script::rotate_shared_ed25519_public_key
Expand source code
def encode_publish_shared_ed25519_public_key_script(public_key: bytes) -> Script: """# Summary Rotates the authentication key of the sending account to the newly-specified public key and publishes a new shared authentication key under the sender's account. Any account can send this transaction. # Technical Description Rotates the authentication key of the sending account to `public_key`, and publishes a `SharedEd25519PublicKey::SharedEd25519PublicKey` resource containing the 32-byte ed25519 `public_key` and the `DiemAccount::KeyRotationCapability` for `account` under `account`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | The signer reference of the sending account of the transaction. | | `public_key` | `vector<u8>` | 32-byte Ed25519 public key for `account`' authentication key to be rotated to and stored. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability` resource. | | `Errors::ALREADY_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | The `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is already published under `account`. | | `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. | # Related Scripts * `Script::rotate_shared_ed25519_public_key` """ return Script( code=PUBLISH_SHARED_ED25519_PUBLIC_KEY_CODE, ty_args=[], args=[TransactionArgument__U8Vector(value=public_key)], ) -
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_keyand publishes aSharedEd25519PublicKey::SharedEd25519PublicKeyresource containing the 32-byte ed25519public_keyand theDiemAccount::KeyRotationCapabilityforaccountunderaccount.Parameters
Name Type Description 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 Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapabilityresource.Errors::ALREADY_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYThe SharedEd25519PublicKey::SharedEd25519PublicKeyresource is already published underaccount.Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_keyis an invalid ed25519 public key.Related Scripts
AccountAdministrationScripts::rotate_shared_ed25519_public_key
Expand source code
def encode_publish_shared_ed25519_public_key_script_function(public_key: bytes) -> TransactionPayload: """# 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`](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys) and publishes a `SharedEd25519PublicKey::SharedEd25519PublicKey` resource containing the 32-byte ed25519 `public_key` and the `DiemAccount::KeyRotationCapability` for `account` under `account`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | The signer of the sending account of the transaction. | | `public_key` | `vector<u8>` | A valid 32-byte Ed25519 public key for `account`'s authentication key to be rotated to and stored. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability` resource. | | `Errors::ALREADY_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | The `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is already published under `account`. | | `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. | # Related Scripts * `AccountAdministrationScripts::rotate_shared_ed25519_public_key` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("publish_shared_ed25519_public_key"), ty_args=[], args=[encode_u8vector_argument(public_key)], ) ) def encode_register_validator_config_script(validator_account: AccountAddress, consensus_pubkey: bytes, validator_network_addresses: bytes, fullnode_network_addresses: bytes) ‑> Script-
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::ValidatorConfigconfig resource held undervalidator_account. It does not emit aDiemConfig::NewEpochEventso the copy of this config held in the validator set will not be updated, and the changes are only "locally" under thevalidator_accountaccount address.Parameters
Name Type Description validator_operator_account&signerSigner reference of the sending account. Must be the registered validator operator for the validator at validator_address.validator_accountaddressThe address of the validator's ValidatorConfig::ValidatorConfigresource 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_addressesto be used in the updatedValidatorConfig::ValidatorConfig.fullnode_network_addressesvector<u8>New set of fullnode_network_addressesto be used in the updatedValidatorConfig::ValidatorConfig.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_addressdoes not have aValidatorConfig::ValidatorConfigresource published under it.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_accountis not the registered operator for the validator atvalidator_address.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkeyis not a valid ed25519 public key.Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::add_validator_and_reconfigureScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
def encode_register_validator_config_script( validator_account: AccountAddress, consensus_pubkey: bytes, validator_network_addresses: bytes, fullnode_network_addresses: bytes, ) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `validator_operator_account` | `&signer` | Signer reference of the sending account. Must be the registered validator operator for the validator at `validator_address`. | | `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. | | `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::add_validator_and_reconfigure` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ return Script( code=REGISTER_VALIDATOR_CONFIG_CODE, ty_args=[], args=[ TransactionArgument__Address(value=validator_account), TransactionArgument__U8Vector(value=consensus_pubkey), TransactionArgument__U8Vector(value=validator_network_addresses), TransactionArgument__U8Vector(value=fullnode_network_addresses), ], ) def encode_register_validator_config_script_function(validator_account: AccountAddress, consensus_pubkey: bytes, validator_network_addresses: bytes, fullnode_network_addresses: bytes) ‑> TransactionPayload-
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::ValidatorConfigconfig resource held undervalidator_account. It does not emit aDiemConfig::NewEpochEventso the copy of this config held in the validator set will not be updated, and the changes are only "locally" under thevalidator_accountaccount address.Parameters
Name Type Description 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::ValidatorConfigresource 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_addressesto be used in the updatedValidatorConfig::ValidatorConfig.fullnode_network_addressesvector<u8>New set of fullnode_network_addressesto be used in the updatedValidatorConfig::ValidatorConfig.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_addressdoes not have aValidatorConfig::ValidatorConfigresource published under it.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_accountis not the registered operator for the validator atvalidator_address.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkeyis not a valid ed25519 public key.Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
def encode_register_validator_config_script_function( validator_account: AccountAddress, consensus_pubkey: bytes, validator_network_addresses: bytes, fullnode_network_addresses: bytes, ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `validator_operator_account` | `signer` | Signer of the sending account. Must be the registered validator operator for the validator at `validator_address`. | | `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. | | `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. | # Related Scripts * `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` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("ValidatorAdministrationScripts"), ), function=Identifier("register_validator_config"), ty_args=[], args=[ encode_address_argument(validator_account), encode_u8vector_argument(consensus_pubkey), encode_u8vector_argument(validator_network_addresses), encode_u8vector_argument(fullnode_network_addresses), ], ) ) def encode_remove_validator_and_reconfigure_script(sliding_nonce: numpy.uint64, validator_name: bytes, validator_address: AccountAddress) ‑> Script-
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_addressfrom the validator set. This transaction emits aDiemConfig::NewEpochEventevent. Once the reconfiguration triggered by this event has been performed, the account atvalidator_addressis no longer considered to be a validator in the network. This transaction will fail if the validator atvalidator_addressis not in the validator set.Parameters
Name Type Description dr_account&signerThe signer reference 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::ValidatorConfigfor the validator.validator_addressaddressThe validator account address to be removed from the validator set. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEThe sending account is not the Diem Root account or Treasury Compliance account 0 0 The provided validator_namedoes 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. Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::register_validator_configScript::add_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
def encode_remove_validator_and_reconfigure_script( sliding_nonce: st.uint64, validator_name: bytes, validator_address: AccountAddress ) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. | | `validator_address` | `address` | The validator account address to be removed from the validator set. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account | | 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::ENOT_AN_ACTIVE_VALIDATOR` | The validator to be removed is not in the validator set. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::add_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ return Script( code=REMOVE_VALIDATOR_AND_RECONFIGURE_CODE, ty_args=[], args=[ TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U8Vector(value=validator_name), TransactionArgument__Address(value=validator_address), ], ) def encode_remove_validator_and_reconfigure_script_function(sliding_nonce: numpy.uint64, validator_name: bytes, validator_address: AccountAddress) ‑> TransactionPayload-
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_addressfrom the validator set. This transaction emits aDiemConfig::NewEpochEventevent. Once the reconfiguration triggered by this event has been performed, the account atvalidator_addressis no longer considered to be a validator in the network. This transaction will fail if the validator atvalidator_addressis not in the validator set.Parameters
Name Type Description 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::ValidatorConfigfor the validator.validator_addressaddressThe validator account address to be removed from the validator set. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEThe sending account is not the Diem Root account or Treasury Compliance account 0 0 The provided validator_namedoes 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. Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
def encode_remove_validator_and_reconfigure_script_function( sliding_nonce: st.uint64, validator_name: bytes, validator_address: AccountAddress ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. | | `validator_address` | `address` | The validator account address to be removed from the validator set. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account | | 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::ENOT_AN_ACTIVE_VALIDATOR` | The validator to be removed is not in the validator set. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `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` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("ValidatorAdministrationScripts"), ), function=Identifier("remove_validator_and_reconfigure"), ty_args=[], args=[ encode_u64_argument(sliding_nonce), encode_u8vector_argument(validator_name), encode_address_argument(validator_address), ], ) ) def encode_rotate_authentication_key_script(new_key: bytes) ‑> Script-
Summary
Rotates the transaction sender's authentication key to the supplied new authentication key.
May be sent by any account.
Technical Description
Rotate the
account'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid ed25519 public key, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description account&signerSigner reference of the sending account of the transaction. new_keyvector<u8>New ed25519 public key to be used for account.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
Script::rotate_authentication_key_with_nonceScript::rotate_authentication_key_with_nonce_adminScript::rotate_authentication_key_with_recovery_address
Expand source code
def encode_rotate_authentication_key_script(new_key: bytes) -> Script: """# Summary Rotates the transaction sender'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 ed25519 public key, and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account of the transaction. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `Script::rotate_authentication_key_with_nonce` * `Script::rotate_authentication_key_with_nonce_admin` * `Script::rotate_authentication_key_with_recovery_address` """ return Script( code=ROTATE_AUTHENTICATION_KEY_CODE, ty_args=[], args=[TransactionArgument__U8Vector(value=new_key)], ) def encode_rotate_authentication_key_script_function(new_key: bytes) ‑> TransactionPayload-
Summary
Rotates the
account's authentication key to the supplied new authentication key.May be sent by any account.
Technical Description
Rotate the
account'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid authentication key that corresponds to an ed25519 public key as described here, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description accountsignerSigner of the sending account of the transaction. new_keyvector<u8>New authentication key to be used for account.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
AccountAdministrationScripts::rotate_authentication_key_with_nonceAccountAdministrationScripts::rotate_authentication_key_with_nonce_adminAccountAdministrationScripts::rotate_authentication_key_with_recovery_address
Expand source code
def encode_rotate_authentication_key_script_function(new_key: bytes) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys), and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account of the transaction. | | `new_key` | `vector<u8>` | New authentication key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `AccountAdministrationScripts::rotate_authentication_key_with_nonce` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin` * `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("rotate_authentication_key"), ty_args=[], args=[encode_u8vector_argument(new_key)], ) ) def encode_rotate_authentication_key_with_nonce_admin_script(sliding_nonce: numpy.uint64, new_key: bytes) ‑> Script-
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'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid ed25519 public key, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description dr_account&signerThe signer reference of the sending account of the write set transaction. May only be the Diem Root signer. account&signerSigner reference of account specified in the execute_asfield of the write set transaction.sliding_nonceu64The sliding_nonce(see:SlidingNonce) to be used for this transaction for Diem Root.new_keyvector<u8>New ed25519 public key to be used for account.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceindr_accountis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceindr_accountis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonceindr_accounthas been previously recorded.Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
Script::rotate_authentication_keyScript::rotate_authentication_key_with_nonceScript::rotate_authentication_key_with_recovery_address
Expand source code
def encode_rotate_authentication_key_with_nonce_admin_script(sliding_nonce: st.uint64, new_key: bytes) -> Script: """# 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 ed25519 public key, and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of the write set transaction. May only be the Diem Root signer. | | `account` | `&signer` | Signer reference of account specified in the `execute_as` field of the write set transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `Script::rotate_authentication_key` * `Script::rotate_authentication_key_with_nonce` * `Script::rotate_authentication_key_with_recovery_address` """ return Script( code=ROTATE_AUTHENTICATION_KEY_WITH_NONCE_ADMIN_CODE, ty_args=[], args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U8Vector(value=new_key)], ) def encode_rotate_authentication_key_with_nonce_admin_script_function(sliding_nonce: numpy.uint64, new_key: bytes) ‑> TransactionPayload-
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'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid authentication key that corresponds to an ed25519 public key as described here, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description 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_asfield 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceindr_accountis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceindr_accountis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonceindr_accounthas been previously recorded.Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
AccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::rotate_authentication_key_with_nonceAccountAdministrationScripts::rotate_authentication_key_with_recovery_address
Expand source code
def encode_rotate_authentication_key_with_nonce_admin_script_function( sliding_nonce: st.uint64, new_key: bytes ) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys), and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of the write set transaction. May only be the Diem Root signer. | | `account` | `signer` | Signer of account specified in the `execute_as` field of the write set transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. | | `new_key` | `vector<u8>` | New authentication key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `AccountAdministrationScripts::rotate_authentication_key` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce` * `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("rotate_authentication_key_with_nonce_admin"), ty_args=[], args=[encode_u64_argument(sliding_nonce), encode_u8vector_argument(new_key)], ) ) def encode_rotate_authentication_key_with_nonce_script(sliding_nonce: numpy.uint64, new_key: bytes) ‑> Script-
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'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid ed25519 public key, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description account&signerSigner reference of the sending account of the transaction. sliding_nonceu64The sliding_nonce(see:SlidingNonce) to be used for this transaction.new_keyvector<u8>New ed25519 public key to be used for account.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
Script::rotate_authentication_keyScript::rotate_authentication_key_with_nonce_adminScript::rotate_authentication_key_with_recovery_address
Expand source code
def encode_rotate_authentication_key_with_nonce_script(sliding_nonce: st.uint64, new_key: bytes) -> Script: """# 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 ed25519 public key, and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account of the transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `Script::rotate_authentication_key` * `Script::rotate_authentication_key_with_nonce_admin` * `Script::rotate_authentication_key_with_recovery_address` """ return Script( code=ROTATE_AUTHENTICATION_KEY_WITH_NONCE_CODE, ty_args=[], args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U8Vector(value=new_key)], ) def encode_rotate_authentication_key_with_nonce_script_function(sliding_nonce: numpy.uint64, new_key: bytes) ‑> TransactionPayload-
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'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid authentication key that corresponds to an ed25519 public key as described here, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
AccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::rotate_authentication_key_with_nonce_adminAccountAdministrationScripts::rotate_authentication_key_with_recovery_address
Expand source code
def encode_rotate_authentication_key_with_nonce_script_function( sliding_nonce: st.uint64, new_key: bytes ) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys), and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account of the transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_key` | `vector<u8>` | New authentication key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `AccountAdministrationScripts::rotate_authentication_key` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin` * `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("rotate_authentication_key_with_nonce"), ty_args=[], args=[encode_u64_argument(sliding_nonce), encode_u8vector_argument(new_key)], ) ) def encode_rotate_authentication_key_with_recovery_address_script(recovery_address: AccountAddress, to_recover: AccountAddress, new_key: bytes) ‑> Script-
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
Script::add_recovery_rotation_capabilityfor account restrictions).Technical Description
Rotates the authentication key of the
to_recoveraccount tonew_keyusing theDiemAccount::KeyRotationCapabilitystored in theRecoveryAddress::RecoveryAddressresource published underrecovery_address. This transaction can be sent either by theto_recoveraccount, or by the account where theRecoveryAddress::RecoveryAddressresource is published that containsto_recover'sDiemAccount::KeyRotationCapability.Parameters
Name Type Description account&signerSigner reference of the sending account of the transaction. recovery_addressaddressAddress where RecoveryAddress::RecoveryAddressthat holdsto_recover'sDiemAccount::KeyRotationCapabilityis published.to_recoveraddressThe address of the account whose authentication key will be updated. new_keyvector<u8>New ed25519 public key to be used for the account at the to_recoveraddress.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_addressdoes not have aRecoveryAddress::RecoveryAddressresource published under it.Errors::INVALID_ARGUMENTRecoveryAddress::ECANNOT_ROTATE_KEYThe address of accountis notrecovery_addressorto_recover.Errors::INVALID_ARGUMENTRecoveryAddress::EACCOUNT_NOT_RECOVERABLEto_recover'sDiemAccount::KeyRotationCapabilityis not in theRecoveryAddress::RecoveryAddressresource published underrecovery_address.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
Script::rotate_authentication_keyScript::rotate_authentication_key_with_nonceScript::rotate_authentication_key_with_nonce_admin
Expand source code
def encode_rotate_authentication_key_with_recovery_address_script( recovery_address: AccountAddress, to_recover: AccountAddress, new_key: bytes ) -> Script: """# 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 `Script::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`. 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account of the transaction. | | `recovery_address` | `address` | Address where `RecoveryAddress::RecoveryAddress` that holds `to_recover`'s `DiemAccount::KeyRotationCapability` is published. | | `to_recover` | `address` | The address of the account whose authentication key will be updated. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for the account at the `to_recover` address. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress::RecoveryAddress` resource published under it. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ECANNOT_ROTATE_KEY` | The address of `account` is not `recovery_address` or `to_recover`. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EACCOUNT_NOT_RECOVERABLE` | `to_recover`'s `DiemAccount::KeyRotationCapability` is not in the `RecoveryAddress::RecoveryAddress` resource published under `recovery_address`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `Script::rotate_authentication_key` * `Script::rotate_authentication_key_with_nonce` * `Script::rotate_authentication_key_with_nonce_admin` """ return Script( code=ROTATE_AUTHENTICATION_KEY_WITH_RECOVERY_ADDRESS_CODE, ty_args=[], args=[ TransactionArgument__Address(value=recovery_address), TransactionArgument__Address(value=to_recover), TransactionArgument__U8Vector(value=new_key), ], ) def encode_rotate_authentication_key_with_recovery_address_script_function(recovery_address: AccountAddress, to_recover: AccountAddress, new_key: bytes) ‑> TransactionPayload-
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_capabilityfor account restrictions).Technical Description
Rotates the authentication key of the
to_recoveraccount tonew_keyusing theDiemAccount::KeyRotationCapabilitystored in theRecoveryAddress::RecoveryAddressresource published underrecovery_address.new_keymust be a valide authentication key as described here. This transaction can be sent either by theto_recoveraccount, or by the account where theRecoveryAddress::RecoveryAddressresource is published that containsto_recover'sDiemAccount::KeyRotationCapability.Parameters
Name Type Description accountsignerSigner of the sending account of the transaction. recovery_addressaddressAddress where RecoveryAddress::RecoveryAddressthat holdsto_recover'sDiemAccount::KeyRotationCapabilityis 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_recoveraddress.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_addressdoes not have aRecoveryAddress::RecoveryAddressresource published under it.Errors::INVALID_ARGUMENTRecoveryAddress::ECANNOT_ROTATE_KEYThe address of accountis notrecovery_addressorto_recover.Errors::INVALID_ARGUMENTRecoveryAddress::EACCOUNT_NOT_RECOVERABLEto_recover'sDiemAccount::KeyRotationCapabilityis not in theRecoveryAddress::RecoveryAddressresource published underrecovery_address.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
AccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::rotate_authentication_key_with_nonceAccountAdministrationScripts::rotate_authentication_key_with_nonce_admin
Expand source code
def encode_rotate_authentication_key_with_recovery_address_script_function( recovery_address: AccountAddress, to_recover: AccountAddress, new_key: bytes ) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account of the transaction. | | `recovery_address` | `address` | Address where `RecoveryAddress::RecoveryAddress` that holds `to_recover`'s `DiemAccount::KeyRotationCapability` is published. | | `to_recover` | `address` | The address of the account whose authentication key will be updated. | | `new_key` | `vector<u8>` | New authentication key to be used for the account at the `to_recover` address. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress::RecoveryAddress` resource published under it. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ECANNOT_ROTATE_KEY` | The address of `account` is not `recovery_address` or `to_recover`. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EACCOUNT_NOT_RECOVERABLE` | `to_recover`'s `DiemAccount::KeyRotationCapability` is not in the `RecoveryAddress::RecoveryAddress` resource published under `recovery_address`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `AccountAdministrationScripts::rotate_authentication_key` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("rotate_authentication_key_with_recovery_address"), ty_args=[], args=[ encode_address_argument(recovery_address), encode_address_argument(to_recover), encode_u8vector_argument(new_key), ], ) ) def encode_rotate_dual_attestation_info_script(new_url: bytes, new_key: bytes) ‑> Script-
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_urlandcompliance_public_keyfields of theDualAttestation::Credentialresource published underaccount. Thenew_keymust be a valid ed25519 public key.Events
Successful execution of this transaction emits two events: * A
DualAttestation::ComplianceKeyRotationEventcontaining the new compliance public key, and the blockchain time at which the key was updated emitted on theDualAttestation::Credentialcompliance_key_rotation_eventshandle published underaccount; and * ADualAttestation::BaseUrlRotationEventcontaining the new base url to be used for off-chain communication, and the blockchain time at which the url was updated emitted on theDualAttestation::Credentialbase_url_rotation_eventshandle published underaccount.Parameters
Name Type Description account&signerSigner reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDDualAttestation::ECREDENTIALA DualAttestation::Credentialresource is not published underaccount.Errors::INVALID_ARGUMENTDualAttestation::EINVALID_PUBLIC_KEYnew_keyis not a valid ed25519 public key.Related Scripts
Script::create_parent_vasp_accountScript::create_designated_dealerScript::rotate_dual_attestation_info
Expand source code
def encode_rotate_dual_attestation_info_script(new_url: bytes, new_key: bytes) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account of the transaction. | | `new_url` | `vector<u8>` | ASCII-encoded url to be used for off-chain communication with `account`. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for on-chain dual attestation checking. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `DualAttestation::ECREDENTIAL` | A `DualAttestation::Credential` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_PUBLIC_KEY` | `new_key` is not a valid ed25519 public key. | # Related Scripts * `Script::create_parent_vasp_account` * `Script::create_designated_dealer` * `Script::rotate_dual_attestation_info` """ return Script( code=ROTATE_DUAL_ATTESTATION_INFO_CODE, ty_args=[], args=[TransactionArgument__U8Vector(value=new_url), TransactionArgument__U8Vector(value=new_key)], ) def encode_rotate_dual_attestation_info_script_function(new_url: bytes, new_key: bytes) ‑> TransactionPayload-
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_urlandcompliance_public_keyfields of theDualAttestation::Credentialresource published underaccount. Thenew_keymust be a valid ed25519 public key.Events
Successful execution of this transaction emits two events: * A
DualAttestation::ComplianceKeyRotationEventcontaining the new compliance public key, and the blockchain time at which the key was updated emitted on theDualAttestation::Credentialcompliance_key_rotation_eventshandle published underaccount; and * ADualAttestation::BaseUrlRotationEventcontaining the new base url to be used for off-chain communication, and the blockchain time at which the url was updated emitted on theDualAttestation::Credentialbase_url_rotation_eventshandle published underaccount.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDDualAttestation::ECREDENTIALA DualAttestation::Credentialresource is not published underaccount.Errors::INVALID_ARGUMENTDualAttestation::EINVALID_PUBLIC_KEYnew_keyis not a valid ed25519 public key.Related Scripts
AccountCreationScripts::create_parent_vasp_accountAccountCreationScripts::create_designated_dealerAccountAdministrationScripts::rotate_dual_attestation_info
Expand source code
def encode_rotate_dual_attestation_info_script_function(new_url: bytes, new_key: bytes) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account of the transaction. | | `new_url` | `vector<u8>` | ASCII-encoded url to be used for off-chain communication with `account`. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for on-chain dual attestation checking. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `DualAttestation::ECREDENTIAL` | A `DualAttestation::Credential` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_PUBLIC_KEY` | `new_key` is not a valid ed25519 public key. | # Related Scripts * `AccountCreationScripts::create_parent_vasp_account` * `AccountCreationScripts::create_designated_dealer` * `AccountAdministrationScripts::rotate_dual_attestation_info` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("rotate_dual_attestation_info"), ty_args=[], args=[encode_u8vector_argument(new_url), encode_u8vector_argument(new_key)], ) ) -
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
Script::publish_shared_ed25519_public_key.Technical Description
This first rotates the public key stored in
account'sSharedEd25519PublicKey::SharedEd25519PublicKeyresource topublic_key, after which it rotates the authentication key using the capability stored inaccount'sSharedEd25519PublicKey::SharedEd25519PublicKeyto a new value derived frompublic_keyParameters
Name Type Description account&signerThe signer reference of the sending account of the transaction. public_keyvector<u8>32-byte Ed25519 public key. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYA SharedEd25519PublicKey::SharedEd25519PublicKeyresource is not published underaccount.Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_keyis an invalid ed25519 public key.Related Scripts
Script::publish_shared_ed25519_public_key
Expand source code
def encode_rotate_shared_ed25519_public_key_script(public_key: bytes) -> Script: """# 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 `Script::publish_shared_ed25519_public_key`. # Technical Description This first rotates the public key stored in `account`'s `SharedEd25519PublicKey::SharedEd25519PublicKey` resource to `public_key`, after which it rotates the authentication key using the capability stored in `account`'s `SharedEd25519PublicKey::SharedEd25519PublicKey` to a new value derived from `public_key` # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | The signer reference of the sending account of the transaction. | | `public_key` | `vector<u8>` | 32-byte Ed25519 public key. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | A `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. | # Related Scripts * `Script::publish_shared_ed25519_public_key` """ return Script( code=ROTATE_SHARED_ED25519_PUBLIC_KEY_CODE, ty_args=[], args=[TransactionArgument__U8Vector(value=public_key)], ) -
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_keymust be a valid ed25519 public key. This transaction first rotates the public key stored inaccount'sSharedEd25519PublicKey::SharedEd25519PublicKeyresource topublic_key, after which it rotates theaccount's authentication key to the new authentication key derived frompublic_keyas defined here using theDiemAccount::KeyRotationCapabilitystored inaccount'sSharedEd25519PublicKey::SharedEd25519PublicKey.Parameters
Name Type Description accountsignerThe signer of the sending account of the transaction. public_keyvector<u8>32-byte Ed25519 public key. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYA SharedEd25519PublicKey::SharedEd25519PublicKeyresource is not published underaccount.Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_keyis an invalid ed25519 public key.Related Scripts
AccountAdministrationScripts::publish_shared_ed25519_public_key
Expand source code
def encode_rotate_shared_ed25519_public_key_script_function(public_key: bytes) -> TransactionPayload: """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys) using the `DiemAccount::KeyRotationCapability` stored in `account`'s `SharedEd25519PublicKey::SharedEd25519PublicKey`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | The signer of the sending account of the transaction. | | `public_key` | `vector<u8>` | 32-byte Ed25519 public key. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | A `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. | # Related Scripts * `AccountAdministrationScripts::publish_shared_ed25519_public_key` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("AccountAdministrationScripts"), ), function=Identifier("rotate_shared_ed25519_public_key"), ty_args=[], args=[encode_u8vector_argument(public_key)], ) ) def encode_script(call: ScriptCall) ‑> Script-
Build a Diem
Scriptfrom a structured objectScriptCall.Expand source code
def encode_script(call: ScriptCall) -> Script: """Build a Diem `Script` from a structured object `ScriptCall`.""" helper = TRANSACTION_SCRIPT_ENCODER_MAP[call.__class__] return helper(call) def encode_script_function(call: ScriptFunctionCall) ‑> TransactionPayload-
Build a Diem
ScriptFunctionTransactionPayloadfrom a structured objectScriptFunctionCall.Expand source code
def encode_script_function(call: ScriptFunctionCall) -> TransactionPayload: """Build a Diem `ScriptFunction` `TransactionPayload` from a structured object `ScriptFunctionCall`.""" helper = SCRIPT_FUNCTION_ENCODER_MAP[call.__class__] return helper(call) def encode_set_gas_constants_script_function(sliding_nonce: numpy.uint64, global_memory_per_byte_cost: numpy.uint64, global_memory_per_byte_write_cost: numpy.uint64, min_transaction_gas_units: numpy.uint64, large_transaction_cutoff: numpy.uint64, intrinsic_gas_per_byte: numpy.uint64, maximum_number_of_gas_units: numpy.uint64, min_price_per_gas_unit: numpy.uint64, max_price_per_gas_unit: numpy.uint64, max_transaction_size_in_bytes: numpy.uint64, gas_unit_scaling_factor: numpy.uint64, default_account_size: numpy.uint64) ‑> TransactionPayload-
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
DiemVMConfigand emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system.Parameters
Name Type Description 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 Category Error Reason Description Errors::INVALID_ARGUMENTDiemVMConfig::EGAS_CONSTANT_INCONSISTENCYThe provided gas constants are inconsistent. Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Expand source code
def encode_set_gas_constants_script_function( sliding_nonce: st.uint64, global_memory_per_byte_cost: st.uint64, global_memory_per_byte_write_cost: st.uint64, min_transaction_gas_units: st.uint64, large_transaction_cutoff: st.uint64, intrinsic_gas_per_byte: st.uint64, maximum_number_of_gas_units: st.uint64, min_price_per_gas_unit: st.uint64, max_price_per_gas_unit: st.uint64, max_transaction_size_in_bytes: st.uint64, gas_unit_scaling_factor: st.uint64, default_account_size: st.uint64, ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `global_memory_per_byte_cost` | `u64` | The new cost to read global memory per-byte to be used for gas metering. | | `global_memory_per_byte_write_cost` | `u64` | The new cost to write global memory per-byte to be used for gas metering. | | `min_transaction_gas_units` | `u64` | The new flat minimum amount of gas required for any transaction. | | `large_transaction_cutoff` | `u64` | The new size over which an additional charge will be assessed for each additional byte. | | `intrinsic_gas_per_byte` | `u64` | The new number of units of gas that to be charged per-byte over the new `large_transaction_cutoff`. | | `maximum_number_of_gas_units` | `u64` | The new maximum number of gas units that can be set in a transaction. | | `min_price_per_gas_unit` | `u64` | The new minimum gas price that can be set for a transaction. | | `max_price_per_gas_unit` | `u64` | The new maximum gas price that can be set for a transaction. | | `max_transaction_size_in_bytes` | `u64` | The new maximum size of a transaction that can be processed. | | `gas_unit_scaling_factor` | `u64` | The new scaling factor to use when scaling between external and internal gas units. | | `default_account_size` | `u64` | The new default account size to use when assessing final costs for reads and writes to global storage. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_ARGUMENT` | `DiemVMConfig::EGAS_CONSTANT_INCONSISTENCY` | The provided gas constants are inconsistent. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("SystemAdministrationScripts"), ), function=Identifier("set_gas_constants"), ty_args=[], args=[ encode_u64_argument(sliding_nonce), encode_u64_argument(global_memory_per_byte_cost), encode_u64_argument(global_memory_per_byte_write_cost), encode_u64_argument(min_transaction_gas_units), encode_u64_argument(large_transaction_cutoff), encode_u64_argument(intrinsic_gas_per_byte), encode_u64_argument(maximum_number_of_gas_units), encode_u64_argument(min_price_per_gas_unit), encode_u64_argument(max_price_per_gas_unit), encode_u64_argument(max_transaction_size_in_bytes), encode_u64_argument(gas_unit_scaling_factor), encode_u64_argument(default_account_size), ], ) ) def encode_set_validator_config_and_reconfigure_script(validator_account: AccountAddress, consensus_pubkey: bytes, validator_network_addresses: bytes, fullnode_network_addresses: bytes) ‑> Script-
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::ValidatorConfigconfig resource held undervalidator_account. It then emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system. This reconfiguration will update the validator set on-chain with the updatedValidatorConfig::ValidatorConfig.Parameters
Name Type Description validator_operator_account&signerSigner reference of the sending account. Must be the registered validator operator for the validator at validator_address.validator_accountaddressThe address of the validator's ValidatorConfig::ValidatorConfigresource 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_addressesto be used in the updatedValidatorConfig::ValidatorConfig.fullnode_network_addressesvector<u8>New set of fullnode_network_addressesto be used in the updatedValidatorConfig::ValidatorConfig.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_addressdoes not have aValidatorConfig::ValidatorConfigresource published under it.Errors::REQUIRES_ROLERoles::EVALIDATOR_OPERATORvalidator_operator_accountdoes not have a Validator Operator role.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_accountis not the registered operator for the validator atvalidator_address.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkeyis not a valid ed25519 public key.Errors::INVALID_STATEDiemConfig::EINVALID_BLOCK_TIMEAn invalid time value was encountered in reconfiguration. Unlikely to occur. Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::add_validator_and_reconfigureScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::register_validator_config
Expand source code
def encode_set_validator_config_and_reconfigure_script( validator_account: AccountAddress, consensus_pubkey: bytes, validator_network_addresses: bytes, fullnode_network_addresses: bytes, ) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `validator_operator_account` | `&signer` | Signer reference of the sending account. Must be the registered validator operator for the validator at `validator_address`. | | `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. | | `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR_OPERATOR` | `validator_operator_account` does not have a Validator Operator role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::add_validator_and_reconfigure` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::register_validator_config` """ return Script( code=SET_VALIDATOR_CONFIG_AND_RECONFIGURE_CODE, ty_args=[], args=[ TransactionArgument__Address(value=validator_account), TransactionArgument__U8Vector(value=consensus_pubkey), TransactionArgument__U8Vector(value=validator_network_addresses), TransactionArgument__U8Vector(value=fullnode_network_addresses), ], ) def encode_set_validator_config_and_reconfigure_script_function(validator_account: AccountAddress, consensus_pubkey: bytes, validator_network_addresses: bytes, fullnode_network_addresses: bytes) ‑> TransactionPayload-
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::ValidatorConfigconfig resource held undervalidator_account. It then emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system. This reconfiguration will update the validator set on-chain with the updatedValidatorConfig::ValidatorConfig.Parameters
Name Type Description 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::ValidatorConfigresource 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_addressesto be used in the updatedValidatorConfig::ValidatorConfig.fullnode_network_addressesvector<u8>New set of fullnode_network_addressesto be used in the updatedValidatorConfig::ValidatorConfig.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_addressdoes not have aValidatorConfig::ValidatorConfigresource published under it.Errors::REQUIRES_ROLERoles::EVALIDATOR_OPERATORvalidator_operator_accountdoes not have a Validator Operator role.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_accountis not the registered operator for the validator atvalidator_address.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkeyis not a valid ed25519 public key.Errors::INVALID_STATEDiemConfig::EINVALID_BLOCK_TIMEAn invalid time value was encountered in reconfiguration. Unlikely to occur. Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::register_validator_config
Expand source code
def encode_set_validator_config_and_reconfigure_script_function( validator_account: AccountAddress, consensus_pubkey: bytes, validator_network_addresses: bytes, fullnode_network_addresses: bytes, ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `validator_operator_account` | `signer` | Signer of the sending account. Must be the registered validator operator for the validator at `validator_address`. | | `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. | | `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR_OPERATOR` | `validator_operator_account` does not have a Validator Operator role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `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` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("ValidatorAdministrationScripts"), ), function=Identifier("set_validator_config_and_reconfigure"), ty_args=[], args=[ encode_address_argument(validator_account), encode_u8vector_argument(consensus_pubkey), encode_u8vector_argument(validator_network_addresses), encode_u8vector_argument(fullnode_network_addresses), ], ) ) def encode_set_validator_operator_script(operator_name: bytes, operator_account: AccountAddress) ‑> Script-
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_accountaddress and with the specifiedhuman_nameas an operator for the sending validator account. The account atoperator_accountaddress must have a Validator Operator role and have aValidatorOperatorConfig::ValidatorOperatorConfigresource published under it. The sendingaccountmust be a Validator and have aValidatorConfig::ValidatorConfigresource published under it. This script does not emit aDiemConfig::NewEpochEventand no reconfiguration of the system is initiated by this script.Parameters
Name Type Description account&signerThe signer reference 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 accountvalidator's operator.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIGThe ValidatorOperatorConfig::ValidatorOperatorConfigresource is not published underoperator_account.0 0 The human_namefield of theValidatorOperatorConfig::ValidatorOperatorConfigresource underoperator_accountdoes not match the providedhuman_name.Errors::REQUIRES_ROLERoles::EVALIDATORaccountdoes not have a Validator account role.Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_accountdoes not have aValidatorOperatorConfig::ValidatorOperatorConfigresource.Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfigis not published underaccount.Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::register_validator_configScript::remove_validator_and_reconfigureScript::add_validator_and_reconfigureScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
def encode_set_validator_operator_script(operator_name: bytes, operator_account: AccountAddress) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | The signer reference of the sending account of the transaction. | | `operator_name` | `vector<u8>` | Validator operator's human name. | | `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. | | 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::add_validator_and_reconfigure` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ return Script( code=SET_VALIDATOR_OPERATOR_CODE, ty_args=[], args=[TransactionArgument__U8Vector(value=operator_name), TransactionArgument__Address(value=operator_account)], ) def encode_set_validator_operator_script_function(operator_name: bytes, operator_account: AccountAddress) ‑> TransactionPayload-
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_accountaddress and with the specifiedhuman_nameas an operator for the sending validator account. The account atoperator_accountaddress must have a Validator Operator role and have aValidatorOperatorConfig::ValidatorOperatorConfigresource published under it. The sendingaccountmust be a Validator and have aValidatorConfig::ValidatorConfigresource published under it. This script does not emit aDiemConfig::NewEpochEventand no reconfiguration of the system is initiated by this script.Parameters
Name Type Description 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 accountvalidator's operator.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIGThe ValidatorOperatorConfig::ValidatorOperatorConfigresource is not published underoperator_account.0 0 The human_namefield of theValidatorOperatorConfig::ValidatorOperatorConfigresource underoperator_accountdoes not match the providedhuman_name.Errors::REQUIRES_ROLERoles::EVALIDATORaccountdoes not have a Validator account role.Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_accountdoes not have aValidatorOperatorConfig::ValidatorOperatorConfigresource.Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfigis not published underaccount.Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
def encode_set_validator_operator_script_function( operator_name: bytes, operator_account: AccountAddress ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | The signer of the sending account of the transaction. | | `operator_name` | `vector<u8>` | Validator operator's human name. | | `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. | | 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. | # Related Scripts * `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` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("ValidatorAdministrationScripts"), ), function=Identifier("set_validator_operator"), ty_args=[], args=[encode_u8vector_argument(operator_name), encode_address_argument(operator_account)], ) ) def encode_set_validator_operator_with_nonce_admin_script(sliding_nonce: numpy.uint64, operator_name: bytes, operator_account: AccountAddress) ‑> Script-
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_accountaddress and with the specifiedhuman_nameas an operator for the validatoraccount. The account atoperator_accountaddress must have a Validator Operator role and have aValidatorOperatorConfig::ValidatorOperatorConfigresource published under it. The account represented by theaccountsigner must be a Validator and have aValidatorConfig::ValidatorConfigresource published under it. No reconfiguration of the system is initiated by this script.Parameters
Name Type Description dr_account&signerThe signer reference of the sending account of the write set transaction. May only be the Diem Root signer. account&signerSigner reference of account specified in the execute_asfield 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 accountvalidator's operator.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceindr_accountis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceindr_accountis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonceindr_accounthas 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::ValidatorOperatorConfigresource is not published underoperator_account.0 0 The human_namefield of theValidatorOperatorConfig::ValidatorOperatorConfigresource underoperator_accountdoes not match the providedhuman_name.Errors::REQUIRES_ROLERoles::EVALIDATORaccountdoes not have a Validator account role.Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_accountdoes not have aValidatorOperatorConfig::ValidatorOperatorConfigresource.Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfigis not published underaccount.Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::register_validator_configScript::remove_validator_and_reconfigureScript::add_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_config_and_reconfigure
Expand source code
def encode_set_validator_operator_with_nonce_admin_script( sliding_nonce: st.uint64, operator_name: bytes, operator_account: AccountAddress ) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of the write set transaction. May only be the Diem Root signer. | | `account` | `&signer` | Signer reference of account specified in the `execute_as` field of the write set transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. | | `operator_name` | `vector<u8>` | Validator operator's human name. | | `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account | | `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. | | 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::add_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_config_and_reconfigure` """ return Script( code=SET_VALIDATOR_OPERATOR_WITH_NONCE_ADMIN_CODE, ty_args=[], args=[ TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U8Vector(value=operator_name), TransactionArgument__Address(value=operator_account), ], ) def encode_set_validator_operator_with_nonce_admin_script_function(sliding_nonce: numpy.uint64, operator_name: bytes, operator_account: AccountAddress) ‑> TransactionPayload-
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_accountaddress and with the specifiedhuman_nameas an operator for the validatoraccount. The account atoperator_accountaddress must have a Validator Operator role and have aValidatorOperatorConfig::ValidatorOperatorConfigresource published under it. The account represented by theaccountsigner must be a Validator and have aValidatorConfig::ValidatorConfigresource published under it. No reconfiguration of the system is initiated by this script.Parameters
Name Type Description 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_asfield 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 accountvalidator's operator.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceindr_accountis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceindr_accountis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonceindr_accounthas 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::ValidatorOperatorConfigresource is not published underoperator_account.0 0 The human_namefield of theValidatorOperatorConfig::ValidatorOperatorConfigresource underoperator_accountdoes not match the providedhuman_name.Errors::REQUIRES_ROLERoles::EVALIDATORaccountdoes not have a Validator account role.Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_accountdoes not have aValidatorOperatorConfig::ValidatorOperatorConfigresource.Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfigis not published underaccount.Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
def encode_set_validator_operator_with_nonce_admin_script_function( sliding_nonce: st.uint64, operator_name: bytes, operator_account: AccountAddress ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | Signer of the sending account of the write set transaction. May only be the Diem Root signer. | | `account` | `signer` | Signer of account specified in the `execute_as` field of the write set transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. | | `operator_name` | `vector<u8>` | Validator operator's human name. | | `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account | | `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. | | 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. | # Related Scripts * `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` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("ValidatorAdministrationScripts"), ), function=Identifier("set_validator_operator_with_nonce_admin"), ty_args=[], args=[ encode_u64_argument(sliding_nonce), encode_u8vector_argument(operator_name), encode_address_argument(operator_account), ], ) ) def encode_tiered_mint_script(coin_type: TypeTag, sliding_nonce: numpy.uint64, designated_dealer_address: AccountAddress, mint_amount: numpy.uint64, tier_index: numpy.uint64) ‑> Script-
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_amountof coins in theCoinTypecurrency to Designated Dealer account atdesignated_dealer_address. Thetier_indexparameter 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 ofCoinTypecoins 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 sendingtc_accountmust 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::MintEventwith the amount and currency code minted is emitted on themint_event_handlein the storedDiem::CurrencyInfo<CoinType>resource stored under0xA550C18; and * ADesignatedDealer::ReceivedMintEventwith the amount, currency code, and Designated Dealer's address is emitted on themint_event_handlein the storedDesignatedDealer::Dealerresource published under thedesignated_dealer_address.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypebeing minted.CoinTypemust be an already-registered currency on-chain.tc_account&signerThe signer reference 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_indexu64The mint tier index to use for the Designated Dealer account. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::INVALID_ARGUMENTDesignatedDealer::EINVALID_MINT_AMOUNTmint_amountis zero.Errors::NOT_PUBLISHEDDesignatedDealer::EDEALERDesignatedDealer::DealerorDesignatedDealer::TierInfo<CoinType>resource does not exist atdesignated_dealer_address.Errors::INVALID_ARGUMENTDesignatedDealer::EINVALID_TIER_INDEXThe tier_indexis out of bounds.Errors::INVALID_ARGUMENTDesignatedDealer::EINVALID_AMOUNT_FOR_TIERmint_amountexceeds the maximum allowed amount fortier_index.Errors::REQUIRES_CAPABILITYDiem::EMINT_CAPABILITYtc_accountdoes not have aDiem::MintCapability<CoinType>resource published under it.Errors::INVALID_STATEDiem::EMINTING_NOT_ALLOWEDMinting is not currently allowed for CoinTypecoins.Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSThe depositing of the funds would exceed the account's account limits.Related Scripts
Script::create_designated_dealerScript::peer_to_peer_with_metadataScript::rotate_dual_attestation_info
Expand source code
def encode_tiered_mint_script( coin_type: TypeTag, sliding_nonce: st.uint64, designated_dealer_address: AccountAddress, mint_amount: st.uint64, tier_index: st.uint64, ) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` being minted. `CoinType` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `designated_dealer_address` | `address` | The address of the Designated Dealer account being minted to. | | `mint_amount` | `u64` | The number of coins to be minted. | | `tier_index` | `u64` | The mint tier index to use for the Designated Dealer account. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_MINT_AMOUNT` | `mint_amount` is zero. | | `Errors::NOT_PUBLISHED` | `DesignatedDealer::EDEALER` | `DesignatedDealer::Dealer` or `DesignatedDealer::TierInfo<CoinType>` resource does not exist at `designated_dealer_address`. | | `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_TIER_INDEX` | The `tier_index` is out of bounds. | | `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_AMOUNT_FOR_TIER` | `mint_amount` exceeds the maximum allowed amount for `tier_index`. | | `Errors::REQUIRES_CAPABILITY` | `Diem::EMINT_CAPABILITY` | `tc_account` does not have a `Diem::MintCapability<CoinType>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EMINTING_NOT_ALLOWED` | Minting is not currently allowed for `CoinType` coins. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds would exceed the `account`'s account limits. | # Related Scripts * `Script::create_designated_dealer` * `Script::peer_to_peer_with_metadata` * `Script::rotate_dual_attestation_info` """ return Script( code=TIERED_MINT_CODE, ty_args=[coin_type], args=[ TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=designated_dealer_address), TransactionArgument__U64(value=mint_amount), TransactionArgument__U64(value=tier_index), ], ) def encode_tiered_mint_script_function(coin_type: TypeTag, sliding_nonce: numpy.uint64, designated_dealer_address: AccountAddress, mint_amount: numpy.uint64, tier_index: numpy.uint64) ‑> TransactionPayload-
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_amountof coins in theCoinTypecurrency to Designated Dealer account atdesignated_dealer_address. Thetier_indexparameter 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 ofCoinTypecoins 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 sendingtc_accountmust 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::MintEventwith the amount and currency code minted is emitted on themint_event_handlein the storedDiem::CurrencyInfo<CoinType>resource stored under0xA550C18; and * ADesignatedDealer::ReceivedMintEventwith the amount, currency code, and Designated Dealer's address is emitted on themint_event_handlein the storedDesignatedDealer::Dealerresource published under thedesignated_dealer_address.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypebeing minted.CoinTypemust 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::INVALID_ARGUMENTDesignatedDealer::EINVALID_MINT_AMOUNTmint_amountis zero.Errors::NOT_PUBLISHEDDesignatedDealer::EDEALERDesignatedDealer::DealerorDesignatedDealer::TierInfo<CoinType>resource does not exist atdesignated_dealer_address.Errors::REQUIRES_CAPABILITYDiem::EMINT_CAPABILITYtc_accountdoes not have aDiem::MintCapability<CoinType>resource published under it.Errors::INVALID_STATEDiem::EMINTING_NOT_ALLOWEDMinting is not currently allowed for CoinTypecoins.Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSThe depositing of the funds would exceed the account's account limits.Related Scripts
AccountCreationScripts::create_designated_dealerPaymentScripts::peer_to_peer_with_metadataAccountAdministrationScripts::rotate_dual_attestation_info
Expand source code
def encode_tiered_mint_script_function( coin_type: TypeTag, sliding_nonce: st.uint64, designated_dealer_address: AccountAddress, mint_amount: st.uint64, tier_index: st.uint64, ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` being minted. `CoinType` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `designated_dealer_address` | `address` | The address of the Designated Dealer account being minted to. | | `mint_amount` | `u64` | The number of coins to be minted. | | `tier_index` | `u64` | [Deprecated] The mint tier index to use for the Designated Dealer account. Will be ignored | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_MINT_AMOUNT` | `mint_amount` is zero. | | `Errors::NOT_PUBLISHED` | `DesignatedDealer::EDEALER` | `DesignatedDealer::Dealer` or `DesignatedDealer::TierInfo<CoinType>` resource does not exist at `designated_dealer_address`. | | `Errors::REQUIRES_CAPABILITY` | `Diem::EMINT_CAPABILITY` | `tc_account` does not have a `Diem::MintCapability<CoinType>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EMINTING_NOT_ALLOWED` | Minting is not currently allowed for `CoinType` coins. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds would exceed the `account`'s account limits. | # Related Scripts * `AccountCreationScripts::create_designated_dealer` * `PaymentScripts::peer_to_peer_with_metadata` * `AccountAdministrationScripts::rotate_dual_attestation_info` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("tiered_mint"), ty_args=[coin_type], args=[ encode_u64_argument(sliding_nonce), encode_address_argument(designated_dealer_address), encode_u64_argument(mint_amount), encode_u64_argument(tier_index), ], ) ) def encode_u64_argument(arg: numpy.uint64) ‑> bytes-
Expand source code
def encode_u64_argument(arg: st.uint64) -> bytes: return bcs_serialize(arg, st.uint64) def encode_u8vector_argument(arg: bytes) ‑> bytes-
Expand source code
def encode_u8vector_argument(arg: bytes) -> bytes: return bcs_serialize(arg, bytes) def encode_unfreeze_account_script(sliding_nonce: numpy.uint64, to_unfreeze_account: AccountAddress) ‑> Script-
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::FreezingBittofalseand emits aAccountFreezing::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::UnFreezeAccountEventwith theunfrozen_addressset theto_unfreeze_account's address.Parameters
Name Type Description tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account. Related Scripts
Script::freeze_account
Expand source code
def encode_unfreeze_account_script(sliding_nonce: st.uint64, to_unfreeze_account: AccountAddress) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `to_unfreeze_account` | `address` | The account address to be frozen. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | # Related Scripts * `Script::freeze_account` """ return Script( code=UNFREEZE_ACCOUNT_CODE, ty_args=[], args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__Address(value=to_unfreeze_account)], ) def encode_unfreeze_account_script_function(sliding_nonce: numpy.uint64, to_unfreeze_account: AccountAddress) ‑> TransactionPayload-
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::FreezingBittofalseand emits aAccountFreezing::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::UnFreezeAccountEventwith theunfrozen_addressset theto_unfreeze_account's address.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account. Related Scripts
TreasuryComplianceScripts::freeze_account
Expand source code
def encode_unfreeze_account_script_function( sliding_nonce: st.uint64, to_unfreeze_account: AccountAddress ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `to_unfreeze_account` | `address` | The account address to be frozen. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | # Related Scripts * `TreasuryComplianceScripts::freeze_account` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("unfreeze_account"), ty_args=[], args=[encode_u64_argument(sliding_nonce), encode_address_argument(to_unfreeze_account)], ) ) def encode_update_diem_consensus_config_script_function(sliding_nonce: numpy.uint64, config: bytes) ‑> TransactionPayload-
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
DiemConsensusConfigon-chain config and emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Expand source code
def encode_update_diem_consensus_config_script_function(sliding_nonce: st.uint64, config: bytes) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `config` | `vector<u8>` | The serialized bytes of consensus config. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("SystemAdministrationScripts"), ), function=Identifier("update_diem_consensus_config"), ty_args=[], args=[encode_u64_argument(sliding_nonce), encode_u8vector_argument(config)], ) ) def encode_update_diem_version_script(sliding_nonce: numpy.uint64, major: numpy.uint64) ‑> Script-
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
DiemVersionon-chain config and emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system. Themajorversion 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
Name Type Description account&signerSigner reference of the sending account. Must be the Diem Root account. sliding_nonceu64The sliding_nonce(see:SlidingNonce) to be used for this transaction.majoru64The majorversion of the VM to be used from this transaction on.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Errors::INVALID_ARGUMENTDiemVersion::EINVALID_MAJOR_VERSION_NUMBERmajoris less-than or equal to the current major version stored on-chain.Expand source code
def encode_update_diem_version_script(sliding_nonce: st.uint64, major: st.uint64) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `major` | `u64` | The `major` version of the VM to be used from this transaction on. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | | `Errors::INVALID_ARGUMENT` | `DiemVersion::EINVALID_MAJOR_VERSION_NUMBER` | `major` is less-than or equal to the current major version stored on-chain. | """ return Script( code=UPDATE_DIEM_VERSION_CODE, ty_args=[], args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U64(value=major)], ) def encode_update_diem_version_script_function(sliding_nonce: numpy.uint64, major: numpy.uint64) ‑> TransactionPayload-
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
DiemVersionon-chain config and emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system. Themajorversion 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
Name Type Description accountsignerSigner of the sending account. Must be the Diem Root account. sliding_nonceu64The sliding_nonce(see:SlidingNonce) to be used for this transaction.majoru64The majorversion of the VM to be used from this transaction on.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Errors::INVALID_ARGUMENTDiemVersion::EINVALID_MAJOR_VERSION_NUMBERmajoris less-than or equal to the current major version stored on-chain.Expand source code
def encode_update_diem_version_script_function(sliding_nonce: st.uint64, major: st.uint64) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `major` | `u64` | The `major` version of the VM to be used from this transaction on. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | | `Errors::INVALID_ARGUMENT` | `DiemVersion::EINVALID_MAJOR_VERSION_NUMBER` | `major` is less-than or equal to the current major version stored on-chain. | """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("SystemAdministrationScripts"), ), function=Identifier("update_diem_version"), ty_args=[], args=[encode_u64_argument(sliding_nonce), encode_u64_argument(major)], ) ) def encode_update_dual_attestation_limit_script(sliding_nonce: numpy.uint64, new_micro_xdx_limit: numpy.uint64) ‑> Script-
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_limitfield of theDualAttestation::Limitresource published under0xA550C18. The amount is set in micro-XDX.Parameters
Name Type Description tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Related Scripts
Script::update_exchange_rateScript::update_minting_ability
Expand source code
def encode_update_dual_attestation_limit_script(sliding_nonce: st.uint64, new_micro_xdx_limit: st.uint64) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_micro_xdx_limit` | `u64` | The new dual attestation limit to be used on-chain. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | # Related Scripts * `Script::update_exchange_rate` * `Script::update_minting_ability` """ return Script( code=UPDATE_DUAL_ATTESTATION_LIMIT_CODE, ty_args=[], args=[TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U64(value=new_micro_xdx_limit)], ) def encode_update_dual_attestation_limit_script_function(sliding_nonce: numpy.uint64, new_micro_xdx_limit: numpy.uint64) ‑> TransactionPayload-
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_limitfield of theDualAttestation::Limitresource published under0xA550C18. The amount is set in micro-XDX.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Related Scripts
TreasuryComplianceScripts::update_exchange_rateTreasuryComplianceScripts::update_minting_ability
Expand source code
def encode_update_dual_attestation_limit_script_function( sliding_nonce: st.uint64, new_micro_xdx_limit: st.uint64 ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_micro_xdx_limit` | `u64` | The new dual attestation limit to be used on-chain. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | # Related Scripts * `TreasuryComplianceScripts::update_exchange_rate` * `TreasuryComplianceScripts::update_minting_ability` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("update_dual_attestation_limit"), ty_args=[], args=[encode_u64_argument(sliding_nonce), encode_u64_argument(new_micro_xdx_limit)], ) ) def encode_update_exchange_rate_script(currency: TypeTag, sliding_nonce: numpy.uint64, new_exchange_rate_numerator: numpy.uint64, new_exchange_rate_denominator: numpy.uint64) ‑> Script-
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
Currencyto micro-XDX. The exchange rate is given bynew_exchange_rate_numerator/new_exchange_rate_denominator.Parameters
Name Type Description CurrencyType The Move type for the Currencywhose exchange rate is being updated.Currencymust be an already-registered currency on-chain.tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::INVALID_ARGUMENTFixedPoint32::EDENOMINATORnew_exchange_rate_denominatoris 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.Related Scripts
Script::update_dual_attestation_limitScript::update_minting_ability
Expand source code
def encode_update_exchange_rate_script( currency: TypeTag, sliding_nonce: st.uint64, new_exchange_rate_numerator: st.uint64, new_exchange_rate_denominator: st.uint64, ) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` whose exchange rate is being updated. `Currency` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for the transaction. | | `new_exchange_rate_numerator` | `u64` | The numerator for the new to micro-XDX exchange rate for `Currency`. | | `new_exchange_rate_denominator` | `u64` | The denominator for the new to micro-XDX exchange rate for `Currency`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `FixedPoint32::EDENOMINATOR` | `new_exchange_rate_denominator` is zero. | | `Errors::INVALID_ARGUMENT` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. | | `Errors::LIMIT_EXCEEDED` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. | # Related Scripts * `Script::update_dual_attestation_limit` * `Script::update_minting_ability` """ return Script( code=UPDATE_EXCHANGE_RATE_CODE, ty_args=[currency], args=[ TransactionArgument__U64(value=sliding_nonce), TransactionArgument__U64(value=new_exchange_rate_numerator), TransactionArgument__U64(value=new_exchange_rate_denominator), ], ) def encode_update_exchange_rate_script_function(currency: TypeTag, sliding_nonce: numpy.uint64, new_exchange_rate_numerator: numpy.uint64, new_exchange_rate_denominator: numpy.uint64) ‑> TransactionPayload-
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
Currencyto micro-XDX. The exchange rate is given bynew_exchange_rate_numerator/new_exchange_rate_denominator.Parameters
Name Type Description CurrencyType The Move type for the Currencywhose exchange rate is being updated.Currencymust 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::INVALID_ARGUMENTFixedPoint32::EDENOMINATORnew_exchange_rate_denominatoris 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.Related Scripts
TreasuryComplianceScripts::update_dual_attestation_limitTreasuryComplianceScripts::update_minting_ability
Expand source code
def encode_update_exchange_rate_script_function( currency: TypeTag, sliding_nonce: st.uint64, new_exchange_rate_numerator: st.uint64, new_exchange_rate_denominator: st.uint64, ) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` whose exchange rate is being updated. `Currency` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for the transaction. | | `new_exchange_rate_numerator` | `u64` | The numerator for the new to micro-XDX exchange rate for `Currency`. | | `new_exchange_rate_denominator` | `u64` | The denominator for the new to micro-XDX exchange rate for `Currency`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `FixedPoint32::EDENOMINATOR` | `new_exchange_rate_denominator` is zero. | | `Errors::INVALID_ARGUMENT` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. | | `Errors::LIMIT_EXCEEDED` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. | # Related Scripts * `TreasuryComplianceScripts::update_dual_attestation_limit` * `TreasuryComplianceScripts::update_minting_ability` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("update_exchange_rate"), ty_args=[currency], args=[ encode_u64_argument(sliding_nonce), encode_u64_argument(new_exchange_rate_numerator), encode_u64_argument(new_exchange_rate_denominator), ], ) ) def encode_update_minting_ability_script(currency: TypeTag, allow_minting: bool) ‑> Script-
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_mintfield of theDiem::CurrencyInfo<Currency>resource published under0xA550C18to the value ofallow_minting. Minting of coins if allowed if this field is set totrueand minting of new coins inCurrencyis disallowed otherwise. This transaction needs to be sent by the Treasury Compliance account.Parameters
Name Type Description CurrencyType The Move type for the Currencywhose minting ability is being updated.Currencymust be an already-registered currency on-chain.account&signerSigner reference of the sending account. Must be the Diem Root account. allow_mintingboolWhether to allow minting of new coins in Currency.Common Abort Conditions
Error Category Error Reason Description Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOCurrencyis not a registered currency on-chain.Related Scripts
Script::update_dual_attestation_limitScript::update_exchange_rate
Expand source code
def encode_update_minting_ability_script(currency: TypeTag, allow_minting: bool) -> Script: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` whose minting ability is being updated. `Currency` must be an already-registered currency on-chain. | | `account` | `&signer` | Signer reference of the sending account. Must be the Diem Root account. | | `allow_minting` | `bool` | Whether to allow minting of new coins in `Currency`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | `Currency` is not a registered currency on-chain. | # Related Scripts * `Script::update_dual_attestation_limit` * `Script::update_exchange_rate` """ return Script( code=UPDATE_MINTING_ABILITY_CODE, ty_args=[currency], args=[TransactionArgument__Bool(value=allow_minting)], ) def encode_update_minting_ability_script_function(currency: TypeTag, allow_minting: bool) ‑> TransactionPayload-
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_mintfield of theDiem::CurrencyInfo<Currency>resource published under0xA550C18to the value ofallow_minting. Minting of coins if allowed if this field is set totrueand minting of new coins inCurrencyis disallowed otherwise. This transaction needs to be sent by the Treasury Compliance account.Parameters
Name Type Description CurrencyType The Move type for the Currencywhose minting ability is being updated.Currencymust 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 Category Error Reason Description Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOCurrencyis not a registered currency on-chain.Related Scripts
TreasuryComplianceScripts::update_dual_attestation_limitTreasuryComplianceScripts::update_exchange_rate
Expand source code
def encode_update_minting_ability_script_function(currency: TypeTag, allow_minting: bool) -> TransactionPayload: """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` whose minting ability is being updated. `Currency` must be an already-registered currency on-chain. | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `allow_minting` | `bool` | Whether to allow minting of new coins in `Currency`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | `Currency` is not a registered currency on-chain. | # Related Scripts * `TreasuryComplianceScripts::update_dual_attestation_limit` * `TreasuryComplianceScripts::update_exchange_rate` """ return TransactionPayload__ScriptFunction( value=ScriptFunction( module=ModuleId( address=AccountAddress.from_hex("00000000000000000000000000000001"), name=Identifier("TreasuryComplianceScripts"), ), function=Identifier("update_minting_ability"), ty_args=[currency], args=[encode_bool_argument(allow_minting)], ) )
Classes
class ScriptCall-
Structured representation of a call into a known Move script.
Expand source code
class ScriptCall: """Structured representation of a call into a known Move script.""" passSubclasses
- ScriptCall__AddCurrencyToAccount
- ScriptCall__AddRecoveryRotationCapability
- ScriptCall__AddValidatorAndReconfigure
- ScriptCall__Burn
- ScriptCall__BurnTxnFees
- ScriptCall__CancelBurn
- ScriptCall__CreateChildVaspAccount
- ScriptCall__CreateDesignatedDealer
- ScriptCall__CreateParentVaspAccount
- ScriptCall__CreateRecoveryAddress
- ScriptCall__CreateValidatorAccount
- ScriptCall__CreateValidatorOperatorAccount
- ScriptCall__FreezeAccount
- ScriptCall__PeerToPeerWithMetadata
- ScriptCall__Preburn
- ScriptCall__PublishSharedEd25519PublicKey
- ScriptCall__RegisterValidatorConfig
- ScriptCall__RemoveValidatorAndReconfigure
- ScriptCall__RotateAuthenticationKey
- ScriptCall__RotateAuthenticationKeyWithNonce
- ScriptCall__RotateAuthenticationKeyWithNonceAdmin
- ScriptCall__RotateAuthenticationKeyWithRecoveryAddress
- ScriptCall__RotateDualAttestationInfo
- ScriptCall__RotateSharedEd25519PublicKey
- ScriptCall__SetValidatorConfigAndReconfigure
- ScriptCall__SetValidatorOperator
- ScriptCall__SetValidatorOperatorWithNonceAdmin
- ScriptCall__TieredMint
- ScriptCall__UnfreezeAccount
- ScriptCall__UpdateDiemVersion
- ScriptCall__UpdateDualAttestationLimit
- ScriptCall__UpdateExchangeRate
- ScriptCall__UpdateMintingAbility
class ScriptCall__AddCurrencyToAccount (currency:Â TypeTag)-
Summary
Adds a zero
Currencybalance to the sendingaccount.This will enable
accountto send, receive, and holdDiem::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 aDiemAccount::Balance<Currency>published under it.Parameters
Name Type Description CurrencyType The Move type for the Currencybeing added to the sending account of the transaction.Currencymust be an already-registered currency on-chain.account&signerThe signer of the sending account of the transaction. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Currencyis 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 Currencyis already published under the sendingaccount.Related Scripts
Script::create_child_vasp_accountScript::create_parent_vasp_accountScript::peer_to_peer_with_metadata
Expand source code
@dataclass(frozen=True) class ScriptCall__AddCurrencyToAccount(ScriptCall): """# Summary Adds a zero `Currency` balance to the sending `account`. This will enable `account` to send, receive, and hold `Diem::Diem<Currency>` coins. This transaction can be successfully sent by any account that is allowed to hold balances (e.g., VASP, Designated Dealer). # Technical Description After the successful execution of this transaction the sending account will have a `DiemAccount::Balance<Currency>` resource with zero balance published under it. Only accounts that can hold balances can send this transaction, the sending account cannot already have a `DiemAccount::Balance<Currency>` published under it. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` being added to the sending account of the transaction. `Currency` must be an already-registered currency on-chain. | | `account` | `&signer` | The signer of the sending account of the transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EROLE_CANT_STORE_BALANCE` | The sending `account`'s role does not permit balances. | | `Errors::ALREADY_PUBLISHED` | `DiemAccount::EADD_EXISTING_CURRENCY` | A balance for `Currency` is already published under the sending `account`. | # Related Scripts * `Script::create_child_vasp_account` * `Script::create_parent_vasp_account` * `Script::peer_to_peer_with_metadata` """ currency: diem_types.TypeTagAncestors
Class variables
var currency :Â TypeTag
class ScriptCall__AddRecoveryRotationCapability (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::KeyRotationCapabilityfor the sending account (to_recover_account) to theRecoveryAddress::RecoveryAddressresource underrecovery_address. After this transaction has been executed successfully the account atrecovery_addressand theto_recover_accountmay rotate the authentication key ofto_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 atrecovery_addressmust also be a VASP account belonging to the same VASP as theto_recover_account. Additionally the account atrecovery_addressmust have already initialized itself as a recovery account address using theScript::create_recovery_addresstransaction script.The sending account's (
to_recover_account) key rotation capability is removed in this transaction and stored in theRecoveryAddress::RecoveryAddressresource stored under the account atrecovery_address.Parameters
Name Type Description to_recover_account&signerThe signer reference of the sending account of this transaction. recovery_addressaddressThe account address where the to_recover_account'sDiemAccount::KeyRotationCapabilitywill be stored.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDto_recover_accounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_addressdoes not have aRecoveryAddressresource published under it.Errors::INVALID_ARGUMENTRecoveryAddress::EINVALID_KEY_ROTATION_DELEGATIONto_recover_accountandrecovery_addressdo not belong to the same VASP.Errors::LIMIT_EXCEEDEDRecoveryAddress::EMAX_KEYS_REGISTEREDRecoveryAddress::MAX_REGISTERED_KEYShave already been registered with thisrecovery_address.Related Scripts
Script::create_recovery_addressScript::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptCall__AddRecoveryRotationCapability(ScriptCall): """# 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 `Script::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 | Name | Type | Description | | ------ | ------ | ------------- | | `to_recover_account` | `&signer` | The signer reference of the sending account of this transaction. | | `recovery_address` | `address` | The account address where the `to_recover_account`'s `DiemAccount::KeyRotationCapability` will be stored. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `to_recover_account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress` resource published under it. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EINVALID_KEY_ROTATION_DELEGATION` | `to_recover_account` and `recovery_address` do not belong to the same VASP. | | `Errors::LIMIT_EXCEEDED` | ` RecoveryAddress::EMAX_KEYS_REGISTERED` | `RecoveryAddress::MAX_REGISTERED_KEYS` have already been registered with this `recovery_address`. | # Related Scripts * `Script::create_recovery_address` * `Script::rotate_authentication_key_with_recovery_address` """ recovery_address: diem_types.AccountAddressAncestors
Class variables
var recovery_address :Â AccountAddress
class ScriptCall__AddValidatorAndReconfigure (sliding_nonce:Â numpy.uint64, validator_name:Â bytes, 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_addressto the validator set. This transaction emits aDiemConfig::NewEpochEventevent and triggers a reconfiguration. Once the reconfiguration triggered by this script's execution has been performed, the account at thevalidator_addressis considered to be a validator in the network.This transaction script will fail if the
validator_addressaddress is already in the validator set or does not have aValidatorConfig::ValidatorConfigresource already published under it.Parameters
Name Type Description dr_account&signerThe signer reference 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::ValidatorConfigfor the validator.validator_addressaddressThe validator account address to be added to the validator set. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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. 0 0 The provided validator_namedoes 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::ValidatorConfigresource published under it, or itsconfigfield is empty.Errors::INVALID_ARGUMENTDiemSystem::EALREADY_A_VALIDATORThe validator_addressaccount is already a registered validator.Errors::INVALID_STATEDiemConfig::EINVALID_BLOCK_TIMEAn invalid time value was encountered in reconfiguration. Unlikely to occur. Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::register_validator_configScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptCall__AddValidatorAndReconfigure(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. | | `validator_address` | `address` | The validator account address to be added to the validator set. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::EINVALID_PROSPECTIVE_VALIDATOR` | The validator to be added does not have a `ValidatorConfig::ValidatorConfig` resource published under it, or its `config` field is empty. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::EALREADY_A_VALIDATOR` | The `validator_address` account is already a registered validator. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ sliding_nonce: st.uint64 validator_name: bytes validator_address: diem_types.AccountAddressAncestors
Class variables
var sliding_nonce :Â numpy.uint64var validator_address :Â AccountAddressvar validator_name :Â bytes
class ScriptCall__Burn (token:Â TypeTag, sliding_nonce:Â numpy.uint64, preburn_address:Â AccountAddress)-
Summary
Burns all coins held in the preburn resource at the specified preburn address and removes them from the system.
The sending account must be the Treasury Compliance account. The account that holds the preburn 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
Tokentype stored in theDiem::Preburn<Token>resource published under thepreburn_addressaccount address.This transaction will only succeed if the sending
accounthas aDiem::BurnCapability<Token>, and aDiem::Preburn<Token>resource exists underpreburn_address, with a non-zeroto_burnfield. After the successful execution of this transaction thetotal_valuefield in theDiem::CurrencyInfo<Token>resource published under0xA550C18will be decremented by the value of theto_burnfield of the preburn resource underpreburn_addressimmediately before this transaction, and theto_burnfield of the preburn resource will have a zero value.Events
The successful execution of this transaction will emit a
Diem::BurnEventon the event handle held in theDiem::CurrencyInfo<Token>resource'sburn_eventspublished under0xA550C18.Parameters
Name Type Description TokenType The Move type for the Tokencurrency being burned.Tokenmust be an already-registered currency on-chain.tc_account&signerThe signer reference of the sending account of this transaction, must have a burn capability for Tokenpublished 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. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending accountdoes not have aDiem::BurnCapability<Token>published under it.Errors::NOT_PUBLISHEDDiem::EPREBURNThe account at preburn_addressdoes not have aDiem::Preburn<Token>resource published under it.Errors::INVALID_STATEDiem::EPREBURN_EMPTYThe Diem::Preburn<Token>resource is empty (has a value of 0).Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Tokenis not a registered currency on-chain.Related Scripts
Script::burn_txn_feesScript::cancel_burnScript::preburn
Expand source code
@dataclass(frozen=True) class ScriptCall__Burn(ScriptCall): """# Summary Burns all coins held in the preburn resource at the specified preburn address and removes them from the system. The sending account must be the Treasury Compliance account. The account that holds the preburn 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currency being burned. `Token` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction, must have a burn capability for `Token` published under it. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `preburn_address` | `address` | The address where the coins to-be-burned are currently held. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | The account at `preburn_address` does not have a `Diem::Preburn<Token>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_EMPTY` | The `Diem::Preburn<Token>` resource is empty (has a value of 0). | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. | # Related Scripts * `Script::burn_txn_fees` * `Script::cancel_burn` * `Script::preburn` """ token: diem_types.TypeTag sliding_nonce: st.uint64 preburn_address: diem_types.AccountAddressAncestors
Class variables
var preburn_address :Â AccountAddressvar sliding_nonce :Â numpy.uint64var token :Â TypeTag
class ScriptCall__BurnTxnFees (coin_type:Â TypeTag)-
Summary
Burns the transaction fees collected in the
CoinTypecurrency 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
CoinTypeso that the association may reclaim the backing coins. Once this transaction has executed successfully all transaction fees that will have been collected inCoinTypesince the last time this script was called with that specific currency. Bothbalanceandpreburnfields in theTransactionFee::TransactionFee<CoinType>resource published under the0xB1E55EDaccount 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::BurnEventon the event handle held in theDiem::CurrencyInfo<CoinType>resource'sburn_eventspublished under0xA550C18.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypebeing added to the sending account of the transaction.CoinTypemust be an already-registered currency on-chain.tc_account&signerThe signer reference of the sending account of this transaction. Must be the Treasury Compliance account. Common Abort Conditions
Error Category Error Reason Description Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account. Errors::NOT_PUBLISHEDTransactionFee::ETRANSACTION_FEECoinTypeis not an accepted transaction fee currency.Errors::INVALID_ARGUMENTDiem::ECOINThe collected fees in CoinTypeare zero.Related Scripts
Script::burnScript::cancel_burn
Expand source code
@dataclass(frozen=True) class ScriptCall__BurnTxnFees(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` being added to the sending account of the transaction. `CoinType` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `TransactionFee::ETRANSACTION_FEE` | `CoinType` is not an accepted transaction fee currency. | | `Errors::INVALID_ARGUMENT` | `Diem::ECOIN` | The collected fees in `CoinType` are zero. | # Related Scripts * `Script::burn` * `Script::cancel_burn` """ coin_type: diem_types.TypeTagAncestors
Class variables
var coin_type :Â TypeTag
class ScriptCall__CancelBurn (token:Â TypeTag, preburn_address:Â AccountAddress)-
Summary
Cancels and returns all coins held in the preburn area under
preburn_addressand returns the funds to thepreburn_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 thepreburn_addressand return the funds to thepreburn_addressaccount'sDiemAccount::Balance<Token>. The transaction must be sent by anaccountwith aDiem::BurnCapability<Token>resource published under it. The account atpreburn_addressmust have aDiem::Preburn<Token>resource published under it, and its value must be nonzero. The transaction removes the entire balance held in theDiem::Preburn<Token>resource, and returns it back to the account'sDiemAccount::Balance<Token>underpreburn_address. Due to this, the account atpreburn_addressmust already have a balance in theTokencurrency published before this script is called otherwise the transaction will fail.Events
The successful execution of this transaction will emit: * A
Diem::CancelBurnEventon the event handle held in theDiem::CurrencyInfo<Token>resource'sburn_eventspublished under0xA550C18. * ADiemAccount::ReceivedPaymentEventon thepreburn_address'sDiemAccount::DiemAccountreceived_eventsevent handle with both thepayerandpayeebeingpreburn_address.Parameters
Name Type Description TokenType The Move type for the Tokencurrenty that burning is being cancelled for.Tokenmust be an already-registered currency on-chain.account&signerThe signer reference of the sending account of this transaction, must have a burn capability for Tokenpublished under it.preburn_addressaddressThe address where the coins to-be-burned are currently held. Common Abort Conditions
Error Category Error Reason Description Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending accountdoes not have aDiem::BurnCapability<Token>published under it.Errors::NOT_PUBLISHEDDiem::EPREBURNThe account at preburn_addressdoes not have aDiem::Preburn<Token>resource published under it.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Tokenis not a registered currency on-chain.Errors::INVALID_ARGUMENTDiemAccount::ECOIN_DEPOSIT_IS_ZEROThe value held in the preburn resource was zero. Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEThe account at preburn_addressdoesn't have a balance resource forToken.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 accountdoes not have a compliance key set on it but dual attestion checking was performed.Related Scripts
Script::burn_txn_feesScript::burnScript::preburn
Expand source code
@dataclass(frozen=True) class ScriptCall__CancelBurn(ScriptCall): """# Summary Cancels and returns all coins held in the preburn area under `preburn_address` 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currenty that burning is being cancelled for. `Token` must be an already-registered currency on-chain. | | `account` | `&signer` | The signer reference of the sending account of this transaction, must have a burn capability for `Token` published under it. | | `preburn_address` | `address` | The address where the coins to-be-burned are currently held. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | The account at `preburn_address` does not have a `Diem::Preburn<Token>` resource published under it. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | The value held in the preburn resource was zero. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | The account at `preburn_address` doesn't have a balance resource for `Token`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds held in the prebun area would exceed the `account`'s account limits. | | `Errors::INVALID_STATE` | `DualAttestation::EPAYEE_COMPLIANCE_KEY_NOT_SET` | The `account` does not have a compliance key set on it but dual attestion checking was performed. | # Related Scripts * `Script::burn_txn_fees` * `Script::burn` * `Script::preburn` """ token: diem_types.TypeTag preburn_address: diem_types.AccountAddressAncestors
Class variables
var preburn_address :Â AccountAddressvar token :Â TypeTag
class ScriptCall__CreateChildVaspAccount (coin_type:Â TypeTag, child_address:Â AccountAddress, auth_key_prefix:Â bytes, add_all_currencies:Â bool, child_initial_balance:Â numpy.uint64)-
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
ChildVASPaccount for the senderparent_vaspatchild_addresswith a balance ofchild_initial_balanceinCoinTypeand an initial authentication key ofauth_key_prefix | child_address.If
add_all_currenciesis 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 with a
child_initial_balancegreater than zero will emit: * ADiemAccount::SentPaymentEventwith thepayerfield being the Parent VASP's address, and payee field beingchild_address. This is emitted on the Parent VASP'sDiemAccount::DiemAccountsent_eventshandle. * ADiemAccount::ReceivedPaymentEventwith thepayerfield being the Parent VASP's address, and payee field beingchild_address. This is emitted on the new Child VASPS'sDiemAccount::DiemAccountreceived_eventshandle.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypethat the child account should be created with.CoinTypemust be an already-registered currency on-chain.parent_vasp&signerThe signer 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 CoinTypeto give the child account when it's created.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYThe auth_key_prefixwas not of length 32.Errors::REQUIRES_ROLERoles::EPARENT_VASPThe sending account wasn't a Parent VASP account. Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe child_addressaddress 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 CoinTypeis 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_balanceofCoinTypebalance.Errors::INVALID_ARGUMENTDiemAccount::ECANNOT_CREATE_AT_VM_RESERVEDThe child_addressis the reserved address 0x0.Related Scripts
Script::create_parent_vasp_accountScript::add_currency_to_accountScript::rotate_authentication_keyScript::add_recovery_rotation_capabilityScript::create_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptCall__CreateChildVaspAccount(ScriptCall): """# 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`. 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 with a `child_initial_balance` greater than zero will emit: * A `DiemAccount::SentPaymentEvent` with the `payer` field being the Parent VASP's address, and 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, and payee field being `child_address`. This is emitted on the new Child VASPS's `DiemAccount::DiemAccount` `received_events` handle. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` that the child account should be created with. `CoinType` must be an already-registered currency on-chain. | | `parent_vasp` | `&signer` | The signer reference of the sending account. Must be a Parent VASP account. | | `child_address` | `address` | Address of the to-be-created Child VASP account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. | | `child_initial_balance` | `u64` | The initial balance in `CoinType` to give the child account when it's created. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | The `auth_key_prefix` was not of length 32. | | `Errors::REQUIRES_ROLE` | `Roles::EPARENT_VASP` | The sending account wasn't a Parent VASP account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `child_address` address is already taken. | | `Errors::LIMIT_EXCEEDED` | `VASP::ETOO_MANY_CHILDREN` | The sending account has reached the maximum number of allowed child accounts. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. | | `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for the sending account has already been extracted. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | The sending account doesn't have a balance in `CoinType`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | The sending account doesn't have at least `child_initial_balance` of `CoinType` balance. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECANNOT_CREATE_AT_VM_RESERVED` | The `child_address` is the reserved address 0x0. | # Related Scripts * `Script::create_parent_vasp_account` * `Script::add_currency_to_account` * `Script::rotate_authentication_key` * `Script::add_recovery_rotation_capability` * `Script::create_recovery_address` """ coin_type: diem_types.TypeTag child_address: diem_types.AccountAddress auth_key_prefix: bytes add_all_currencies: bool child_initial_balance: st.uint64Ancestors
Class variables
var add_all_currencies :Â boolvar auth_key_prefix :Â bytesvar child_address :Â AccountAddressvar child_initial_balance :Â numpy.uint64var coin_type :Â TypeTag
class ScriptCall__CreateDesignatedDealer (currency:Â TypeTag, sliding_nonce:Â numpy.uint64, addr:Â AccountAddress, auth_key_prefix:Â bytes, human_name:Â bytes, 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
addrwith authentication keyauth_key_prefix|addrand a 0 balance of typeCurrency. Ifadd_all_currenciesis 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.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.
Parameters
Name Type Description CurrencyType The Move type for the Currencythat the Designated Dealer should be initialized with.Currencymust be an already-registered currency on-chain.tc_account&signerThe signer reference 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 Currencywhen the account is created.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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 Currencyis not a registered currency on-chain.Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe addraddress is already taken.Related Scripts
Script::tiered_mintScript::peer_to_peer_with_metadataScript::rotate_dual_attestation_info
Expand source code
@dataclass(frozen=True) class ScriptCall__CreateDesignatedDealer(ScriptCall): """# 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. 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. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` that the Designated Dealer should be initialized with. `Currency` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `addr` | `address` | Address of the to-be-created Designated Dealer account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the Designated Dealer. | | `add_all_currencies` | `bool` | Whether 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 Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `addr` address is already taken. | # Related Scripts * `Script::tiered_mint` * `Script::peer_to_peer_with_metadata` * `Script::rotate_dual_attestation_info` """ currency: diem_types.TypeTag sliding_nonce: st.uint64 addr: diem_types.AccountAddress auth_key_prefix: bytes human_name: bytes add_all_currencies: boolAncestors
Class variables
var add_all_currencies :Â boolvar addr :Â AccountAddressvar auth_key_prefix :Â bytesvar currency :Â TypeTagvar human_name :Â bytesvar sliding_nonce :Â numpy.uint64
class ScriptCall__CreateParentVaspAccount (coin_type:Â TypeTag, sliding_nonce:Â numpy.uint64, new_account_address:Â AccountAddress, auth_key_prefix:Â bytes, human_name:Â bytes, 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
addresswith authentication keyauth_key_prefix|new_account_addressand a 0 balance of typeCoinType. Ifadd_all_currenciesis true, 0 balances for all available currencies in the system will also be added. This can only be invoked by an TreasuryCompliance account.sliding_nonceis a unique nonce for operation, seeSlidingNoncefor details.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypecurrency that the Parent VASP account should be initialized with.CoinTypemust be an already-registered currency on-chain.tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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 CoinTypeis not a registered currency on-chain.Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe new_account_addressaddress is already taken.Related Scripts
Script::create_child_vasp_accountScript::add_currency_to_accountScript::rotate_authentication_keyScript::add_recovery_rotation_capabilityScript::create_recovery_addressScript::rotate_dual_attestation_info
Expand source code
@dataclass(frozen=True) class ScriptCall__CreateParentVaspAccount(ScriptCall): """# 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. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The 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_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Parent VASP account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the Parent VASP. | | `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `Script::create_child_vasp_account` * `Script::add_currency_to_account` * `Script::rotate_authentication_key` * `Script::add_recovery_rotation_capability` * `Script::create_recovery_address` * `Script::rotate_dual_attestation_info` """ coin_type: diem_types.TypeTag sliding_nonce: st.uint64 new_account_address: diem_types.AccountAddress auth_key_prefix: bytes human_name: bytes add_all_currencies: boolAncestors
Class variables
var add_all_currencies :Â boolvar auth_key_prefix :Â bytesvar coin_type :Â TypeTagvar human_name :Â bytesvar new_account_address :Â AccountAddressvar sliding_nonce :Â numpy.uint64
class ScriptCall__CreateRecoveryAddress-
Summary
Initializes the sending account as a recovery address that may be used by the VASP that it belongs to.
The sending account must be a VASP account. Multiple recovery addresses can exist for a single VASP, but accounts in each must be disjoint.
Technical Description
Publishes a
RecoveryAddress::RecoveryAddressresource underaccount. It then extracts theDiemAccount::KeyRotationCapabilityforaccountand adds it to the resource. After the successful execution of this transaction other accounts may add their key rotation to this resource so thataccountmay be used as a recovery account for those accounts.Parameters
Name Type Description account&signerThe signer of the sending account of the transaction. Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTRecoveryAddress::ENOT_A_VASPaccountis 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::RecoveryAddressresource has already been published underaccount.Related Scripts
Script::add_recovery_rotation_capabilityScript::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptCall__CreateRecoveryAddress(ScriptCall): """# Summary Initializes the sending account as a recovery address that may be used by the VASP that it belongs to. The sending account must be a 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | The signer of the sending account of the transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ENOT_A_VASP` | `account` is not a VASP account. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EKEY_ROTATION_DEPENDENCY_CYCLE` | A key rotation recovery cycle would be created by adding `account`'s key rotation capability. | | `Errors::ALREADY_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | A `RecoveryAddress::RecoveryAddress` resource has already been published under `account`. | # Related Scripts * `Script::add_recovery_rotation_capability` * `Script::rotate_authentication_key_with_recovery_address` """ passAncestors
class ScriptCall__CreateValidatorAccount (sliding_nonce:Â numpy.uint64, new_account_address:Â AccountAddress, auth_key_prefix:Â bytes, human_name:Â bytes)-
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 keyauth_key_prefix|new_account_address. It publishes aValidatorConfig::ValidatorConfigresource with emptyconfig, andoperator_accountfields. Thehuman_namefield of theValidatorConfig::ValidatorConfigis set to the passed inhuman_name. This script does not add the validator to the validator set or the system, but only creates the account.Parameters
Name Type Description dr_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_addressaddress is already taken.Related Scripts
Script::add_validator_and_reconfigureScript::create_validator_operator_accountScript::register_validator_configScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptCall__CreateValidatorAccount(ScriptCall): """# 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. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Validator account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `Script::add_validator_and_reconfigure` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ sliding_nonce: st.uint64 new_account_address: diem_types.AccountAddress auth_key_prefix: bytes human_name: bytesAncestors
Class variables
var auth_key_prefix :Â bytesvar human_name :Â bytesvar new_account_address :Â AccountAddressvar sliding_nonce :Â numpy.uint64
class ScriptCall__CreateValidatorOperatorAccount (sliding_nonce:Â numpy.uint64, new_account_address:Â AccountAddress, auth_key_prefix:Â bytes, human_name:Â bytes)-
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 keyauth_key_prefix|new_account_address. It publishes aValidatorOperatorConfig::ValidatorOperatorConfigresource with the specifiedhuman_name. This script does not assign the validator operator to any validator accounts but only creates the account.Parameters
Name Type Description dr_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_addressaddress is already taken.Related Scripts
Script::create_validator_accountScript::add_validator_and_reconfigureScript::register_validator_configScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptCall__CreateValidatorOperatorAccount(ScriptCall): """# 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. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Validator account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `Script::create_validator_account` * `Script::add_validator_and_reconfigure` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ sliding_nonce: st.uint64 new_account_address: diem_types.AccountAddress auth_key_prefix: bytes human_name: bytesAncestors
Class variables
var auth_key_prefix :Â bytesvar human_name :Â bytesvar new_account_address :Â AccountAddressvar sliding_nonce :Â numpy.uint64
class ScriptCall__FreezeAccount (sliding_nonce:Â numpy.uint64, 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::FreezingBittotrueand emits aAccountFreezing::FreezeAccountEvent. The transaction sender must be the Treasury Compliance account, but the account atto_freeze_accountmust not be either0xA550C18(the Diem Root address), or0xB1E55ED(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::FreezeAccountEventon thefreeze_event_handleheld in theAccountFreezing::FreezeEventsHolderresource published under0xA550C18with thefrozen_addressbeing theto_freeze_account.Parameters
Name Type Description tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_accountwas the Treasury Compliance account (0xB1E55ED).Errors::INVALID_ARGUMENTAccountFreezing::ECANNOT_FREEZE_DIEM_ROOTto_freeze_accountwas the Diem Root account (0xA550C18).Related Scripts
Script::unfreeze_account
Expand source code
@dataclass(frozen=True) class ScriptCall__FreezeAccount(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `to_freeze_account` | `address` | The account address to be frozen. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_TC` | `to_freeze_account` was the Treasury Compliance account (`0xB1E55ED`). | | `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_DIEM_ROOT` | `to_freeze_account` was the Diem Root account (`0xA550C18`). | # Related Scripts * `Script::unfreeze_account` """ sliding_nonce: st.uint64 to_freeze_account: diem_types.AccountAddressAncestors
Class variables
var sliding_nonce :Â numpy.uint64var to_freeze_account :Â AccountAddress
class ScriptCall__PeerToPeerWithMetadata (currency:Â TypeTag, payee:Â AccountAddress, amount:Â numpy.uint64, metadata:Â bytes, metadata_signature:Â bytes)-
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
amountcoins of typeCurrencyfrompayertopayeewith (optional) associatedmetadataand an (optional)metadata_signatureon the messagemetadata|Signer::address_of(payer)|amount|DualAttestation::DOMAIN_SEPARATOR. Themetadataandmetadata_signatureparameters are only required ifamount>=DualAttestation::get_cur_microdiem_limitXDX andpayerandpayeeare 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-emptymetadata_signature. StandardizedmetadataBCS format can be found indiem_types::transaction::metadata::Metadata.Events
Successful execution of this script emits two events: * A
DiemAccount::SentPaymentEventonpayer'sDiemAccount::DiemAccountsent_eventshandle; and * ADiemAccount::ReceivedPaymentEventonpayee'sDiemAccount::DiemAccountreceived_eventshandle.Parameters
Name Type Description CurrencyType The Move type for the Currencybeing sent in this transaction.Currencymust be an already-registered currency on-chain.payer&signerThe signer reference 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 metadataand payment information. SeeCommon Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYpayerdoesn't hold a balance inCurrency.Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamountis greater thanpayer's balance inCurrency.Errors::INVALID_ARGUMENTDiemAccount::ECOIN_DEPOSIT_IS_ZEROamountis zero.Errors::NOT_PUBLISHEDDiemAccount::EPAYEE_DOES_NOT_EXISTNo account exists at the payeeaddress.Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEAn account exists at payee, but it does not accept payments inCurrency.Errors::INVALID_STATEAccountFreezing::EACCOUNT_FROZENThe payeeaccount is frozen.Errors::INVALID_ARGUMENTDualAttestation::EMALFORMED_METADATA_SIGNATUREmetadata_signatureis not 64 bytes.Errors::INVALID_ARGUMENTDualAttestation::EINVALID_METADATA_SIGNATUREmetadata_signaturedoes not verify on the against thepayee'sDualAttestation::Credentialcompliance_public_keypublic key.Errors::LIMIT_EXCEEDEDDiemAccount::EWITHDRAWAL_EXCEEDS_LIMITSpayerhas exceeded its daily withdrawal limits for the backing coins of XDX.Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSpayeehas exceeded its daily deposit limits for XDX.Related Scripts
Script::create_child_vasp_accountScript::create_parent_vasp_accountScript::add_currency_to_account
Expand source code
@dataclass(frozen=True) class ScriptCall__PeerToPeerWithMetadata(ScriptCall): """# 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 `metadata` | `Signer::address_of(payer)` | `amount` | `DualAttestation::DOMAIN_SEPARATOR`. 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` being sent in this transaction. `Currency` must be an already-registered currency on-chain. | | `payer` | `&signer` | The signer reference of the sending account that coins are being transferred from. | | `payee` | `address` | The address of the account the coins are being transferred to. | | `metadata` | `vector<u8>` | Optional metadata about this payment. | | `metadata_signature` | `vector<u8>` | Optional signature over `metadata` and payment information. See | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `payer` doesn't hold a balance in `Currency`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Currency`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | `amount` is zero. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYEE_DOES_NOT_EXIST` | No account exists at the `payee` address. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | An account exists at `payee`, but it does not accept payments in `Currency`. | | `Errors::INVALID_STATE` | `AccountFreezing::EACCOUNT_FROZEN` | The `payee` account is frozen. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EMALFORMED_METADATA_SIGNATURE` | `metadata_signature` is not 64 bytes. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_METADATA_SIGNATURE` | `metadata_signature` does not verify on the against the `payee'`s `DualAttestation::Credential` `compliance_public_key` public key. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EWITHDRAWAL_EXCEEDS_LIMITS` | `payer` has exceeded its daily withdrawal limits for the backing coins of XDX. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | `payee` has exceeded its daily deposit limits for XDX. | # Related Scripts * `Script::create_child_vasp_account` * `Script::create_parent_vasp_account` * `Script::add_currency_to_account` """ currency: diem_types.TypeTag payee: diem_types.AccountAddress amount: st.uint64 metadata: bytes metadata_signature: bytesAncestors
Class variables
var amount :Â numpy.uint64var currency :Â TypeTagvar metadata :Â bytesvar metadata_signature :Â bytesvar payee :Â AccountAddress
class ScriptCall__Preburn (token:Â TypeTag, amount:Â numpy.uint64)-
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
amountof coins inTokencurrency from the sendingaccount'sDiemAccount::Balance<Token>to theDiem::Preburn<Token>published under the sameaccount.accountmust 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::SentPaymentEventonaccount'sDiemAccount::DiemAccountsent_eventshandle with thepayeeandpayerfields beingaccount's address; and * ADiem::PreburnEventwithToken's currency code on theDiem::CurrencyInfo<Token'spreburn_eventshandle forTokenand withpreburn_addressset toaccount's address.Parameters
Name Type Description TokenType The Move type for the Tokencurrency being moved to the preburn area.Tokenmust be an already-registered currency on-chain.account&signerThe signer reference of the sending account. amountu64The amount in Tokento be moved to the preburn area.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Tokenis not a registered currency on-chain.Errors::INVALID_STATEDiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTEDThe withdrawal capability for accounthas already been extracted.Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamountis greater thanpayer's balance inToken.Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYaccountdoesn't hold a balance inToken.Errors::NOT_PUBLISHEDDiem::EPREBURNaccountdoesn't have aDiem::Preburn<Token>resource published under it.Errors::INVALID_STATEDiem::EPREBURN_OCCUPIEDThe valuefield in theDiem::Preburn<Token>resource under the sender is non-zero.Errors::NOT_PUBLISHEDRoles::EROLE_IDThe accountdid not have a role assigned to it.Errors::REQUIRES_ROLERoles::EDESIGNATED_DEALERThe accountdid not have the role of DesignatedDealer.Related Scripts
Script::cancel_burnScript::burnScript::burn_txn_fees
Expand source code
@dataclass(frozen=True) class ScriptCall__Preburn(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currency being moved to the preburn area. `Token` must be an already-registered currency on-chain. | | `account` | `&signer` | The signer reference of the sending account. | | `amount` | `u64` | The amount in `Token` to be moved to the preburn area. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Token` is not a registered currency on-chain. | | `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for `account` has already been extracted. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Token`. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `account` doesn't hold a balance in `Token`. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | `account` doesn't have a `Diem::Preburn<Token>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_OCCUPIED` | The `value` field in the `Diem::Preburn<Token>` resource under the sender is non-zero. | | `Errors::NOT_PUBLISHED` | `Roles::EROLE_ID` | The `account` did not have a role assigned to it. | | `Errors::REQUIRES_ROLE` | `Roles::EDESIGNATED_DEALER` | The `account` did not have the role of DesignatedDealer. | # Related Scripts * `Script::cancel_burn` * `Script::burn` * `Script::burn_txn_fees` """ token: diem_types.TypeTag amount: st.uint64Ancestors
Class variables
var amount :Â numpy.uint64var token :Â TypeTag
-
Summary
Rotates the authentication key of the sending account to the newly-specified public key and publishes a new shared authentication key under the sender's account.
Any account can send this transaction.
Technical Description
Rotates the authentication key of the sending account to
public_key, and publishes aSharedEd25519PublicKey::SharedEd25519PublicKeyresource containing the 32-byte ed25519public_keyand theDiemAccount::KeyRotationCapabilityforaccountunderaccount.Parameters
Name Type Description account&signerThe signer reference of the sending account of the transaction. public_keyvector<u8>32-byte Ed25519 public key for account' authentication key to be rotated to and stored.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapabilityresource.Errors::ALREADY_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYThe SharedEd25519PublicKey::SharedEd25519PublicKeyresource is already published underaccount.Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_keyis an invalid ed25519 public key.Related Scripts
Script::rotate_shared_ed25519_public_key
Expand source code
@dataclass(frozen=True) class ScriptCall__PublishSharedEd25519PublicKey(ScriptCall): """# Summary Rotates the authentication key of the sending account to the newly-specified public key and publishes a new shared authentication key under the sender's account. Any account can send this transaction. # Technical Description Rotates the authentication key of the sending account to `public_key`, and publishes a `SharedEd25519PublicKey::SharedEd25519PublicKey` resource containing the 32-byte ed25519 `public_key` and the `DiemAccount::KeyRotationCapability` for `account` under `account`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | The signer reference of the sending account of the transaction. | | `public_key` | `vector<u8>` | 32-byte Ed25519 public key for `account`' authentication key to be rotated to and stored. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability` resource. | | `Errors::ALREADY_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | The `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is already published under `account`. | | `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. | # Related Scripts * `Script::rotate_shared_ed25519_public_key` """ public_key: bytesAncestors
Class variables
class ScriptCall__RegisterValidatorConfig (validator_account:Â AccountAddress, consensus_pubkey:Â bytes, validator_network_addresses:Â bytes, fullnode_network_addresses:Â bytes)-
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::ValidatorConfigconfig resource held undervalidator_account. It does not emit aDiemConfig::NewEpochEventso the copy of this config held in the validator set will not be updated, and the changes are only "locally" under thevalidator_accountaccount address.Parameters
Name Type Description validator_operator_account&signerSigner reference of the sending account. Must be the registered validator operator for the validator at validator_address.validator_accountaddressThe address of the validator's ValidatorConfig::ValidatorConfigresource 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_addressesto be used in the updatedValidatorConfig::ValidatorConfig.fullnode_network_addressesvector<u8>New set of fullnode_network_addressesto be used in the updatedValidatorConfig::ValidatorConfig.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_addressdoes not have aValidatorConfig::ValidatorConfigresource published under it.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_accountis not the registered operator for the validator atvalidator_address.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkeyis not a valid ed25519 public key.Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::add_validator_and_reconfigureScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptCall__RegisterValidatorConfig(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `validator_operator_account` | `&signer` | Signer reference of the sending account. Must be the registered validator operator for the validator at `validator_address`. | | `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. | | `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::add_validator_and_reconfigure` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ validator_account: diem_types.AccountAddress consensus_pubkey: bytes validator_network_addresses: bytes fullnode_network_addresses: bytesAncestors
Class variables
var consensus_pubkey :Â bytesvar fullnode_network_addresses :Â bytesvar validator_account :Â AccountAddressvar validator_network_addresses :Â bytes
class ScriptCall__RemoveValidatorAndReconfigure (sliding_nonce:Â numpy.uint64, validator_name:Â bytes, 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_addressfrom the validator set. This transaction emits aDiemConfig::NewEpochEventevent. Once the reconfiguration triggered by this event has been performed, the account atvalidator_addressis no longer considered to be a validator in the network. This transaction will fail if the validator atvalidator_addressis not in the validator set.Parameters
Name Type Description dr_account&signerThe signer reference 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::ValidatorConfigfor the validator.validator_addressaddressThe validator account address to be removed from the validator set. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEThe sending account is not the Diem Root account or Treasury Compliance account 0 0 The provided validator_namedoes 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. Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::register_validator_configScript::add_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptCall__RemoveValidatorAndReconfigure(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. | | `validator_address` | `address` | The validator account address to be removed from the validator set. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account | | 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::ENOT_AN_ACTIVE_VALIDATOR` | The validator to be removed is not in the validator set. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::add_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ sliding_nonce: st.uint64 validator_name: bytes validator_address: diem_types.AccountAddressAncestors
Class variables
var sliding_nonce :Â numpy.uint64var validator_address :Â AccountAddressvar validator_name :Â bytes
class ScriptCall__RotateAuthenticationKey (new_key:Â bytes)-
Summary
Rotates the transaction sender's authentication key to the supplied new authentication key.
May be sent by any account.
Technical Description
Rotate the
account'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid ed25519 public key, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description account&signerSigner reference of the sending account of the transaction. new_keyvector<u8>New ed25519 public key to be used for account.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
Script::rotate_authentication_key_with_nonceScript::rotate_authentication_key_with_nonce_adminScript::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptCall__RotateAuthenticationKey(ScriptCall): """# Summary Rotates the transaction sender'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 ed25519 public key, and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account of the transaction. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `Script::rotate_authentication_key_with_nonce` * `Script::rotate_authentication_key_with_nonce_admin` * `Script::rotate_authentication_key_with_recovery_address` """ new_key: bytesAncestors
Class variables
var new_key :Â bytes
class ScriptCall__RotateAuthenticationKeyWithNonce (sliding_nonce:Â numpy.uint64, new_key:Â bytes)-
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'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid ed25519 public key, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description account&signerSigner reference of the sending account of the transaction. sliding_nonceu64The sliding_nonce(see:SlidingNonce) to be used for this transaction.new_keyvector<u8>New ed25519 public key to be used for account.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
Script::rotate_authentication_keyScript::rotate_authentication_key_with_nonce_adminScript::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptCall__RotateAuthenticationKeyWithNonce(ScriptCall): """# 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 ed25519 public key, and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account of the transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `Script::rotate_authentication_key` * `Script::rotate_authentication_key_with_nonce_admin` * `Script::rotate_authentication_key_with_recovery_address` """ sliding_nonce: st.uint64 new_key: bytesAncestors
Class variables
var new_key :Â bytesvar sliding_nonce :Â numpy.uint64
class ScriptCall__RotateAuthenticationKeyWithNonceAdmin (sliding_nonce:Â numpy.uint64, new_key:Â bytes)-
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'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid ed25519 public key, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description dr_account&signerThe signer reference of the sending account of the write set transaction. May only be the Diem Root signer. account&signerSigner reference of account specified in the execute_asfield of the write set transaction.sliding_nonceu64The sliding_nonce(see:SlidingNonce) to be used for this transaction for Diem Root.new_keyvector<u8>New ed25519 public key to be used for account.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceindr_accountis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceindr_accountis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonceindr_accounthas been previously recorded.Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
Script::rotate_authentication_keyScript::rotate_authentication_key_with_nonceScript::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptCall__RotateAuthenticationKeyWithNonceAdmin(ScriptCall): """# 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 ed25519 public key, and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of the write set transaction. May only be the Diem Root signer. | | `account` | `&signer` | Signer reference of account specified in the `execute_as` field of the write set transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `Script::rotate_authentication_key` * `Script::rotate_authentication_key_with_nonce` * `Script::rotate_authentication_key_with_recovery_address` """ sliding_nonce: st.uint64 new_key: bytesAncestors
Class variables
var new_key :Â bytesvar sliding_nonce :Â numpy.uint64
class ScriptCall__RotateAuthenticationKeyWithRecoveryAddress (recovery_address:Â AccountAddress, to_recover:Â AccountAddress, new_key:Â bytes)-
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
Script::add_recovery_rotation_capabilityfor account restrictions).Technical Description
Rotates the authentication key of the
to_recoveraccount tonew_keyusing theDiemAccount::KeyRotationCapabilitystored in theRecoveryAddress::RecoveryAddressresource published underrecovery_address. This transaction can be sent either by theto_recoveraccount, or by the account where theRecoveryAddress::RecoveryAddressresource is published that containsto_recover'sDiemAccount::KeyRotationCapability.Parameters
Name Type Description account&signerSigner reference of the sending account of the transaction. recovery_addressaddressAddress where RecoveryAddress::RecoveryAddressthat holdsto_recover'sDiemAccount::KeyRotationCapabilityis published.to_recoveraddressThe address of the account whose authentication key will be updated. new_keyvector<u8>New ed25519 public key to be used for the account at the to_recoveraddress.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_addressdoes not have aRecoveryAddress::RecoveryAddressresource published under it.Errors::INVALID_ARGUMENTRecoveryAddress::ECANNOT_ROTATE_KEYThe address of accountis notrecovery_addressorto_recover.Errors::INVALID_ARGUMENTRecoveryAddress::EACCOUNT_NOT_RECOVERABLEto_recover'sDiemAccount::KeyRotationCapabilityis not in theRecoveryAddress::RecoveryAddressresource published underrecovery_address.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
Script::rotate_authentication_keyScript::rotate_authentication_key_with_nonceScript::rotate_authentication_key_with_nonce_admin
Expand source code
@dataclass(frozen=True) class ScriptCall__RotateAuthenticationKeyWithRecoveryAddress(ScriptCall): """# 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 `Script::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`. 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account of the transaction. | | `recovery_address` | `address` | Address where `RecoveryAddress::RecoveryAddress` that holds `to_recover`'s `DiemAccount::KeyRotationCapability` is published. | | `to_recover` | `address` | The address of the account whose authentication key will be updated. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for the account at the `to_recover` address. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress::RecoveryAddress` resource published under it. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ECANNOT_ROTATE_KEY` | The address of `account` is not `recovery_address` or `to_recover`. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EACCOUNT_NOT_RECOVERABLE` | `to_recover`'s `DiemAccount::KeyRotationCapability` is not in the `RecoveryAddress::RecoveryAddress` resource published under `recovery_address`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `Script::rotate_authentication_key` * `Script::rotate_authentication_key_with_nonce` * `Script::rotate_authentication_key_with_nonce_admin` """ recovery_address: diem_types.AccountAddress to_recover: diem_types.AccountAddress new_key: bytesAncestors
Class variables
var new_key :Â bytesvar recovery_address :Â AccountAddressvar to_recover :Â AccountAddress
class ScriptCall__RotateDualAttestationInfo (new_url:Â bytes, new_key:Â bytes)-
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_urlandcompliance_public_keyfields of theDualAttestation::Credentialresource published underaccount. Thenew_keymust be a valid ed25519 public key.Events
Successful execution of this transaction emits two events: * A
DualAttestation::ComplianceKeyRotationEventcontaining the new compliance public key, and the blockchain time at which the key was updated emitted on theDualAttestation::Credentialcompliance_key_rotation_eventshandle published underaccount; and * ADualAttestation::BaseUrlRotationEventcontaining the new base url to be used for off-chain communication, and the blockchain time at which the url was updated emitted on theDualAttestation::Credentialbase_url_rotation_eventshandle published underaccount.Parameters
Name Type Description account&signerSigner reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDDualAttestation::ECREDENTIALA DualAttestation::Credentialresource is not published underaccount.Errors::INVALID_ARGUMENTDualAttestation::EINVALID_PUBLIC_KEYnew_keyis not a valid ed25519 public key.Related Scripts
Script::create_parent_vasp_accountScript::create_designated_dealerScript::rotate_dual_attestation_info
Expand source code
@dataclass(frozen=True) class ScriptCall__RotateDualAttestationInfo(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account of the transaction. | | `new_url` | `vector<u8>` | ASCII-encoded url to be used for off-chain communication with `account`. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for on-chain dual attestation checking. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `DualAttestation::ECREDENTIAL` | A `DualAttestation::Credential` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_PUBLIC_KEY` | `new_key` is not a valid ed25519 public key. | # Related Scripts * `Script::create_parent_vasp_account` * `Script::create_designated_dealer` * `Script::rotate_dual_attestation_info` """ new_url: bytes new_key: bytesAncestors
Class variables
var new_key :Â bytesvar new_url :Â bytes
-
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
Script::publish_shared_ed25519_public_key.Technical Description
This first rotates the public key stored in
account'sSharedEd25519PublicKey::SharedEd25519PublicKeyresource topublic_key, after which it rotates the authentication key using the capability stored inaccount'sSharedEd25519PublicKey::SharedEd25519PublicKeyto a new value derived frompublic_keyParameters
Name Type Description account&signerThe signer reference of the sending account of the transaction. public_keyvector<u8>32-byte Ed25519 public key. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYA SharedEd25519PublicKey::SharedEd25519PublicKeyresource is not published underaccount.Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_keyis an invalid ed25519 public key.Related Scripts
Script::publish_shared_ed25519_public_key
Expand source code
@dataclass(frozen=True) class ScriptCall__RotateSharedEd25519PublicKey(ScriptCall): """# 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 `Script::publish_shared_ed25519_public_key`. # Technical Description This first rotates the public key stored in `account`'s `SharedEd25519PublicKey::SharedEd25519PublicKey` resource to `public_key`, after which it rotates the authentication key using the capability stored in `account`'s `SharedEd25519PublicKey::SharedEd25519PublicKey` to a new value derived from `public_key` # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | The signer reference of the sending account of the transaction. | | `public_key` | `vector<u8>` | 32-byte Ed25519 public key. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | A `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. | # Related Scripts * `Script::publish_shared_ed25519_public_key` """ public_key: bytesAncestors
Class variables
class ScriptCall__SetValidatorConfigAndReconfigure (validator_account:Â AccountAddress, consensus_pubkey:Â bytes, validator_network_addresses:Â bytes, fullnode_network_addresses:Â bytes)-
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::ValidatorConfigconfig resource held undervalidator_account. It then emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system. This reconfiguration will update the validator set on-chain with the updatedValidatorConfig::ValidatorConfig.Parameters
Name Type Description validator_operator_account&signerSigner reference of the sending account. Must be the registered validator operator for the validator at validator_address.validator_accountaddressThe address of the validator's ValidatorConfig::ValidatorConfigresource 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_addressesto be used in the updatedValidatorConfig::ValidatorConfig.fullnode_network_addressesvector<u8>New set of fullnode_network_addressesto be used in the updatedValidatorConfig::ValidatorConfig.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_addressdoes not have aValidatorConfig::ValidatorConfigresource published under it.Errors::REQUIRES_ROLERoles::EVALIDATOR_OPERATORvalidator_operator_accountdoes not have a Validator Operator role.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_accountis not the registered operator for the validator atvalidator_address.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkeyis not a valid ed25519 public key.Errors::INVALID_STATEDiemConfig::EINVALID_BLOCK_TIMEAn invalid time value was encountered in reconfiguration. Unlikely to occur. Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::add_validator_and_reconfigureScript::remove_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_operator_with_nonce_adminScript::register_validator_config
Expand source code
@dataclass(frozen=True) class ScriptCall__SetValidatorConfigAndReconfigure(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `validator_operator_account` | `&signer` | Signer reference of the sending account. Must be the registered validator operator for the validator at `validator_address`. | | `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. | | `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR_OPERATOR` | `validator_operator_account` does not have a Validator Operator role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::add_validator_and_reconfigure` * `Script::remove_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_operator_with_nonce_admin` * `Script::register_validator_config` """ validator_account: diem_types.AccountAddress consensus_pubkey: bytes validator_network_addresses: bytes fullnode_network_addresses: bytesAncestors
Class variables
var consensus_pubkey :Â bytesvar fullnode_network_addresses :Â bytesvar validator_account :Â AccountAddressvar validator_network_addresses :Â bytes
class ScriptCall__SetValidatorOperator (operator_name:Â bytes, 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_accountaddress and with the specifiedhuman_nameas an operator for the sending validator account. The account atoperator_accountaddress must have a Validator Operator role and have aValidatorOperatorConfig::ValidatorOperatorConfigresource published under it. The sendingaccountmust be a Validator and have aValidatorConfig::ValidatorConfigresource published under it. This script does not emit aDiemConfig::NewEpochEventand no reconfiguration of the system is initiated by this script.Parameters
Name Type Description account&signerThe signer reference 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 accountvalidator's operator.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIGThe ValidatorOperatorConfig::ValidatorOperatorConfigresource is not published underoperator_account.0 0 The human_namefield of theValidatorOperatorConfig::ValidatorOperatorConfigresource underoperator_accountdoes not match the providedhuman_name.Errors::REQUIRES_ROLERoles::EVALIDATORaccountdoes not have a Validator account role.Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_accountdoes not have aValidatorOperatorConfig::ValidatorOperatorConfigresource.Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfigis not published underaccount.Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::register_validator_configScript::remove_validator_and_reconfigureScript::add_validator_and_reconfigureScript::set_validator_operator_with_nonce_adminScript::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptCall__SetValidatorOperator(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | The signer reference of the sending account of the transaction. | | `operator_name` | `vector<u8>` | Validator operator's human name. | | `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. | | 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::add_validator_and_reconfigure` * `Script::set_validator_operator_with_nonce_admin` * `Script::set_validator_config_and_reconfigure` """ operator_name: bytes operator_account: diem_types.AccountAddressAncestors
Class variables
var operator_account :Â AccountAddressvar operator_name :Â bytes
class ScriptCall__SetValidatorOperatorWithNonceAdmin (sliding_nonce:Â numpy.uint64, operator_name:Â bytes, 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_accountaddress and with the specifiedhuman_nameas an operator for the validatoraccount. The account atoperator_accountaddress must have a Validator Operator role and have aValidatorOperatorConfig::ValidatorOperatorConfigresource published under it. The account represented by theaccountsigner must be a Validator and have aValidatorConfig::ValidatorConfigresource published under it. No reconfiguration of the system is initiated by this script.Parameters
Name Type Description dr_account&signerThe signer reference of the sending account of the write set transaction. May only be the Diem Root signer. account&signerSigner reference of account specified in the execute_asfield 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 accountvalidator's operator.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceindr_accountis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceindr_accountis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonceindr_accounthas 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::ValidatorOperatorConfigresource is not published underoperator_account.0 0 The human_namefield of theValidatorOperatorConfig::ValidatorOperatorConfigresource underoperator_accountdoes not match the providedhuman_name.Errors::REQUIRES_ROLERoles::EVALIDATORaccountdoes not have a Validator account role.Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_accountdoes not have aValidatorOperatorConfig::ValidatorOperatorConfigresource.Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfigis not published underaccount.Related Scripts
Script::create_validator_accountScript::create_validator_operator_accountScript::register_validator_configScript::remove_validator_and_reconfigureScript::add_validator_and_reconfigureScript::set_validator_operatorScript::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptCall__SetValidatorOperatorWithNonceAdmin(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `&signer` | The signer reference of the sending account of the write set transaction. May only be the Diem Root signer. | | `account` | `&signer` | Signer reference of account specified in the `execute_as` field of the write set transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. | | `operator_name` | `vector<u8>` | Validator operator's human name. | | `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account | | `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. | | 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. | # Related Scripts * `Script::create_validator_account` * `Script::create_validator_operator_account` * `Script::register_validator_config` * `Script::remove_validator_and_reconfigure` * `Script::add_validator_and_reconfigure` * `Script::set_validator_operator` * `Script::set_validator_config_and_reconfigure` """ sliding_nonce: st.uint64 operator_name: bytes operator_account: diem_types.AccountAddressAncestors
Class variables
var operator_account :Â AccountAddressvar operator_name :Â bytesvar sliding_nonce :Â numpy.uint64
class ScriptCall__TieredMint (coin_type:Â TypeTag, sliding_nonce:Â numpy.uint64, designated_dealer_address:Â AccountAddress, mint_amount:Â numpy.uint64, tier_index:Â numpy.uint64)-
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_amountof coins in theCoinTypecurrency to Designated Dealer account atdesignated_dealer_address. Thetier_indexparameter 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 ofCoinTypecoins 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 sendingtc_accountmust 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::MintEventwith the amount and currency code minted is emitted on themint_event_handlein the storedDiem::CurrencyInfo<CoinType>resource stored under0xA550C18; and * ADesignatedDealer::ReceivedMintEventwith the amount, currency code, and Designated Dealer's address is emitted on themint_event_handlein the storedDesignatedDealer::Dealerresource published under thedesignated_dealer_address.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypebeing minted.CoinTypemust be an already-registered currency on-chain.tc_account&signerThe signer reference 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_indexu64The mint tier index to use for the Designated Dealer account. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::INVALID_ARGUMENTDesignatedDealer::EINVALID_MINT_AMOUNTmint_amountis zero.Errors::NOT_PUBLISHEDDesignatedDealer::EDEALERDesignatedDealer::DealerorDesignatedDealer::TierInfo<CoinType>resource does not exist atdesignated_dealer_address.Errors::INVALID_ARGUMENTDesignatedDealer::EINVALID_TIER_INDEXThe tier_indexis out of bounds.Errors::INVALID_ARGUMENTDesignatedDealer::EINVALID_AMOUNT_FOR_TIERmint_amountexceeds the maximum allowed amount fortier_index.Errors::REQUIRES_CAPABILITYDiem::EMINT_CAPABILITYtc_accountdoes not have aDiem::MintCapability<CoinType>resource published under it.Errors::INVALID_STATEDiem::EMINTING_NOT_ALLOWEDMinting is not currently allowed for CoinTypecoins.Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSThe depositing of the funds would exceed the account's account limits.Related Scripts
Script::create_designated_dealerScript::peer_to_peer_with_metadataScript::rotate_dual_attestation_info
Expand source code
@dataclass(frozen=True) class ScriptCall__TieredMint(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` being minted. `CoinType` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `designated_dealer_address` | `address` | The address of the Designated Dealer account being minted to. | | `mint_amount` | `u64` | The number of coins to be minted. | | `tier_index` | `u64` | The mint tier index to use for the Designated Dealer account. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_MINT_AMOUNT` | `mint_amount` is zero. | | `Errors::NOT_PUBLISHED` | `DesignatedDealer::EDEALER` | `DesignatedDealer::Dealer` or `DesignatedDealer::TierInfo<CoinType>` resource does not exist at `designated_dealer_address`. | | `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_TIER_INDEX` | The `tier_index` is out of bounds. | | `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_AMOUNT_FOR_TIER` | `mint_amount` exceeds the maximum allowed amount for `tier_index`. | | `Errors::REQUIRES_CAPABILITY` | `Diem::EMINT_CAPABILITY` | `tc_account` does not have a `Diem::MintCapability<CoinType>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EMINTING_NOT_ALLOWED` | Minting is not currently allowed for `CoinType` coins. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds would exceed the `account`'s account limits. | # Related Scripts * `Script::create_designated_dealer` * `Script::peer_to_peer_with_metadata` * `Script::rotate_dual_attestation_info` """ coin_type: diem_types.TypeTag sliding_nonce: st.uint64 designated_dealer_address: diem_types.AccountAddress mint_amount: st.uint64 tier_index: st.uint64Ancestors
Class variables
var coin_type :Â TypeTagvar designated_dealer_address :Â AccountAddressvar mint_amount :Â numpy.uint64var sliding_nonce :Â numpy.uint64var tier_index :Â numpy.uint64
class ScriptCall__UnfreezeAccount (sliding_nonce:Â numpy.uint64, 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::FreezingBittofalseand emits aAccountFreezing::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::UnFreezeAccountEventwith theunfrozen_addressset theto_unfreeze_account's address.Parameters
Name Type Description tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account. Related Scripts
Script::freeze_account
Expand source code
@dataclass(frozen=True) class ScriptCall__UnfreezeAccount(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `to_unfreeze_account` | `address` | The account address to be frozen. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | # Related Scripts * `Script::freeze_account` """ sliding_nonce: st.uint64 to_unfreeze_account: diem_types.AccountAddressAncestors
Class variables
var sliding_nonce :Â numpy.uint64var to_unfreeze_account :Â AccountAddress
class ScriptCall__UpdateDiemVersion (sliding_nonce:Â numpy.uint64, major:Â numpy.uint64)-
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
DiemVersionon-chain config and emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system. Themajorversion 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
Name Type Description account&signerSigner reference of the sending account. Must be the Diem Root account. sliding_nonceu64The sliding_nonce(see:SlidingNonce) to be used for this transaction.majoru64The majorversion of the VM to be used from this transaction on.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Errors::INVALID_ARGUMENTDiemVersion::EINVALID_MAJOR_VERSION_NUMBERmajoris less-than or equal to the current major version stored on-chain.Expand source code
@dataclass(frozen=True) class ScriptCall__UpdateDiemVersion(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `&signer` | Signer reference of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `major` | `u64` | The `major` version of the VM to be used from this transaction on. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | | `Errors::INVALID_ARGUMENT` | `DiemVersion::EINVALID_MAJOR_VERSION_NUMBER` | `major` is less-than or equal to the current major version stored on-chain. | """ sliding_nonce: st.uint64 major: st.uint64Ancestors
Class variables
var major :Â numpy.uint64var sliding_nonce :Â numpy.uint64
class ScriptCall__UpdateDualAttestationLimit (sliding_nonce:Â numpy.uint64, new_micro_xdx_limit:Â numpy.uint64)-
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_limitfield of theDualAttestation::Limitresource published under0xA550C18. The amount is set in micro-XDX.Parameters
Name Type Description tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Related Scripts
Script::update_exchange_rateScript::update_minting_ability
Expand source code
@dataclass(frozen=True) class ScriptCall__UpdateDualAttestationLimit(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_micro_xdx_limit` | `u64` | The new dual attestation limit to be used on-chain. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | # Related Scripts * `Script::update_exchange_rate` * `Script::update_minting_ability` """ sliding_nonce: st.uint64 new_micro_xdx_limit: st.uint64Ancestors
Class variables
var new_micro_xdx_limit :Â numpy.uint64var sliding_nonce :Â numpy.uint64
class ScriptCall__UpdateExchangeRate (currency:Â TypeTag, sliding_nonce:Â numpy.uint64, new_exchange_rate_numerator:Â numpy.uint64, new_exchange_rate_denominator:Â numpy.uint64)-
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
Currencyto micro-XDX. The exchange rate is given bynew_exchange_rate_numerator/new_exchange_rate_denominator.Parameters
Name Type Description CurrencyType The Move type for the Currencywhose exchange rate is being updated.Currencymust be an already-registered currency on-chain.tc_account&signerThe signer reference 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::INVALID_ARGUMENTFixedPoint32::EDENOMINATORnew_exchange_rate_denominatoris 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.Related Scripts
Script::update_dual_attestation_limitScript::update_minting_ability
Expand source code
@dataclass(frozen=True) class ScriptCall__UpdateExchangeRate(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` whose exchange rate is being updated. `Currency` must be an already-registered currency on-chain. | | `tc_account` | `&signer` | The signer reference of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for the transaction. | | `new_exchange_rate_numerator` | `u64` | The numerator for the new to micro-XDX exchange rate for `Currency`. | | `new_exchange_rate_denominator` | `u64` | The denominator for the new to micro-XDX exchange rate for `Currency`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `FixedPoint32::EDENOMINATOR` | `new_exchange_rate_denominator` is zero. | | `Errors::INVALID_ARGUMENT` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. | | `Errors::LIMIT_EXCEEDED` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. | # Related Scripts * `Script::update_dual_attestation_limit` * `Script::update_minting_ability` """ currency: diem_types.TypeTag sliding_nonce: st.uint64 new_exchange_rate_numerator: st.uint64 new_exchange_rate_denominator: st.uint64Ancestors
Class variables
var currency :Â TypeTagvar new_exchange_rate_denominator :Â numpy.uint64var new_exchange_rate_numerator :Â numpy.uint64var sliding_nonce :Â numpy.uint64
class ScriptCall__UpdateMintingAbility (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_mintfield of theDiem::CurrencyInfo<Currency>resource published under0xA550C18to the value ofallow_minting. Minting of coins if allowed if this field is set totrueand minting of new coins inCurrencyis disallowed otherwise. This transaction needs to be sent by the Treasury Compliance account.Parameters
Name Type Description CurrencyType The Move type for the Currencywhose minting ability is being updated.Currencymust be an already-registered currency on-chain.account&signerSigner reference of the sending account. Must be the Diem Root account. allow_mintingboolWhether to allow minting of new coins in Currency.Common Abort Conditions
Error Category Error Reason Description Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOCurrencyis not a registered currency on-chain.Related Scripts
Script::update_dual_attestation_limitScript::update_exchange_rate
Expand source code
@dataclass(frozen=True) class ScriptCall__UpdateMintingAbility(ScriptCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` whose minting ability is being updated. `Currency` must be an already-registered currency on-chain. | | `account` | `&signer` | Signer reference of the sending account. Must be the Diem Root account. | | `allow_minting` | `bool` | Whether to allow minting of new coins in `Currency`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | `Currency` is not a registered currency on-chain. | # Related Scripts * `Script::update_dual_attestation_limit` * `Script::update_exchange_rate` """ currency: diem_types.TypeTag allow_minting: boolAncestors
Class variables
var allow_minting :Â boolvar currency :Â TypeTag
class ScriptFunctionCall-
Structured representation of a call into a known Move script function.
Expand source code
class ScriptFunctionCall: """Structured representation of a call into a known Move script function.""" passSubclasses
- ScriptFunctionCall__AddCurrencyToAccount
- ScriptFunctionCall__AddRecoveryRotationCapability
- ScriptFunctionCall__AddValidatorAndReconfigure
- ScriptFunctionCall__BurnTxnFees
- ScriptFunctionCall__BurnWithAmount
- ScriptFunctionCall__CancelBurnWithAmount
- ScriptFunctionCall__CreateChildVaspAccount
- ScriptFunctionCall__CreateDesignatedDealer
- ScriptFunctionCall__CreateParentVaspAccount
- ScriptFunctionCall__CreateRecoveryAddress
- ScriptFunctionCall__CreateValidatorAccount
- ScriptFunctionCall__CreateValidatorOperatorAccount
- ScriptFunctionCall__FreezeAccount
- ScriptFunctionCall__InitializeDiemConsensusConfig
- ScriptFunctionCall__PeerToPeerWithMetadata
- ScriptFunctionCall__Preburn
- ScriptFunctionCall__PublishSharedEd25519PublicKey
- ScriptFunctionCall__RegisterValidatorConfig
- ScriptFunctionCall__RemoveValidatorAndReconfigure
- ScriptFunctionCall__RotateAuthenticationKey
- ScriptFunctionCall__RotateAuthenticationKeyWithNonce
- ScriptFunctionCall__RotateAuthenticationKeyWithNonceAdmin
- ScriptFunctionCall__RotateAuthenticationKeyWithRecoveryAddress
- ScriptFunctionCall__RotateDualAttestationInfo
- ScriptFunctionCall__RotateSharedEd25519PublicKey
- ScriptFunctionCall__SetGasConstants
- ScriptFunctionCall__SetValidatorConfigAndReconfigure
- ScriptFunctionCall__SetValidatorOperator
- ScriptFunctionCall__SetValidatorOperatorWithNonceAdmin
- ScriptFunctionCall__TieredMint
- ScriptFunctionCall__UnfreezeAccount
- ScriptFunctionCall__UpdateDiemConsensusConfig
- ScriptFunctionCall__UpdateDiemVersion
- ScriptFunctionCall__UpdateDualAttestationLimit
- ScriptFunctionCall__UpdateExchangeRate
- ScriptFunctionCall__UpdateMintingAbility
class ScriptFunctionCall__AddCurrencyToAccount (currency:Â TypeTag)-
Summary
Adds a zero
Currencybalance to the sendingaccount.This will enable
accountto send, receive, and holdDiem::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 aDiemAccount::Balance<Currency>published under it.Parameters
Name Type Description CurrencyType The Move type for the Currencybeing added to the sending account of the transaction.Currencymust be an already-registered currency on-chain.accountsignerThe signer of the sending account of the transaction. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Currencyis 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 Currencyis already published under the sendingaccount.Related Scripts
AccountCreationScripts::create_child_vasp_accountAccountCreationScripts::create_parent_vasp_accountPaymentScripts::peer_to_peer_with_metadata
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__AddCurrencyToAccount(ScriptFunctionCall): """# Summary Adds a zero `Currency` balance to the sending `account`. This will enable `account` to send, receive, and hold `Diem::Diem<Currency>` coins. This transaction can be successfully sent by any account that is allowed to hold balances (e.g., VASP, Designated Dealer). # Technical Description After the successful execution of this transaction the sending account will have a `DiemAccount::Balance<Currency>` resource with zero balance published under it. Only accounts that can hold balances can send this transaction, the sending account cannot already have a `DiemAccount::Balance<Currency>` published under it. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` being added to the sending account of the transaction. `Currency` must be an already-registered currency on-chain. | | `account` | `signer` | The signer of the sending account of the transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EROLE_CANT_STORE_BALANCE` | The sending `account`'s role does not permit balances. | | `Errors::ALREADY_PUBLISHED` | `DiemAccount::EADD_EXISTING_CURRENCY` | A balance for `Currency` is already published under the sending `account`. | # Related Scripts * `AccountCreationScripts::create_child_vasp_account` * `AccountCreationScripts::create_parent_vasp_account` * `PaymentScripts::peer_to_peer_with_metadata` """ currency: diem_types.TypeTagAncestors
Class variables
var currency :Â TypeTag
class ScriptFunctionCall__AddRecoveryRotationCapability (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::KeyRotationCapabilityfor the sending account (to_recover_account) to theRecoveryAddress::RecoveryAddressresource underrecovery_address. After this transaction has been executed successfully the account atrecovery_addressand theto_recover_accountmay rotate the authentication key ofto_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 atrecovery_addressmust also be a VASP account belonging to the same VASP as theto_recover_account. Additionally the account atrecovery_addressmust have already initialized itself as a recovery account address using theAccountAdministrationScripts::create_recovery_addresstransaction script.The sending account's (
to_recover_account) key rotation capability is removed in this transaction and stored in theRecoveryAddress::RecoveryAddressresource stored under the account atrecovery_address.Parameters
Name Type Description to_recover_accountsignerThe signer of the sending account of this transaction. recovery_addressaddressThe account address where the to_recover_account'sDiemAccount::KeyRotationCapabilitywill be stored.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDto_recover_accounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_addressdoes not have aRecoveryAddressresource published under it.Errors::INVALID_ARGUMENTRecoveryAddress::EINVALID_KEY_ROTATION_DELEGATIONto_recover_accountandrecovery_addressdo not belong to the same VASP.Errors::LIMIT_EXCEEDEDRecoveryAddress::EMAX_KEYS_REGISTEREDRecoveryAddress::MAX_REGISTERED_KEYShave already been registered with thisrecovery_address.Related Scripts
AccountAdministrationScripts::create_recovery_addressAccountAdministrationScripts::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__AddRecoveryRotationCapability(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `to_recover_account` | `signer` | The signer of the sending account of this transaction. | | `recovery_address` | `address` | The account address where the `to_recover_account`'s `DiemAccount::KeyRotationCapability` will be stored. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `to_recover_account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress` resource published under it. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EINVALID_KEY_ROTATION_DELEGATION` | `to_recover_account` and `recovery_address` do not belong to the same VASP. | | `Errors::LIMIT_EXCEEDED` | ` RecoveryAddress::EMAX_KEYS_REGISTERED` | `RecoveryAddress::MAX_REGISTERED_KEYS` have already been registered with this `recovery_address`. | # Related Scripts * `AccountAdministrationScripts::create_recovery_address` * `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address` """ recovery_address: diem_types.AccountAddressAncestors
Class variables
var recovery_address :Â AccountAddress
class ScriptFunctionCall__AddValidatorAndReconfigure (sliding_nonce:Â numpy.uint64, validator_name:Â bytes, 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_addressto the validator set. This transaction emits aDiemConfig::NewEpochEventevent and triggers a reconfiguration. Once the reconfiguration triggered by this script's execution has been performed, the account at thevalidator_addressis considered to be a validator in the network.This transaction script will fail if the
validator_addressaddress is already in the validator set or does not have aValidatorConfig::ValidatorConfigresource already published under it.Parameters
Name Type Description 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::ValidatorConfigfor the validator.validator_addressaddressThe validator account address to be added to the validator set. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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. 0 0 The provided validator_namedoes 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::ValidatorConfigresource published under it, or itsconfigfield is empty.Errors::INVALID_ARGUMENTDiemSystem::EALREADY_A_VALIDATORThe validator_addressaccount 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. Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__AddValidatorAndReconfigure(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. | | `validator_address` | `address` | The validator account address to be added to the validator set. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::EINVALID_PROSPECTIVE_VALIDATOR` | The validator to be added does not have a `ValidatorConfig::ValidatorConfig` resource published under it, or its `config` field is empty. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::EALREADY_A_VALIDATOR` | The `validator_address` account is already a registered validator. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | | `Errors::LIMIT_EXCEEDED` | `DiemSystem::EMAX_VALIDATORS` | The validator set is already at its maximum size. The validator could not be added. | # Related Scripts * `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` """ sliding_nonce: st.uint64 validator_name: bytes validator_address: diem_types.AccountAddressAncestors
Class variables
var sliding_nonce :Â numpy.uint64var validator_address :Â AccountAddressvar validator_name :Â bytes
class ScriptFunctionCall__BurnTxnFees (coin_type:Â TypeTag)-
Summary
Burns the transaction fees collected in the
CoinTypecurrency 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
CoinTypeso that the association may reclaim the backing coins. Once this transaction has executed successfully all transaction fees that will have been collected inCoinTypesince the last time this script was called with that specific currency. Bothbalanceandpreburnfields in theTransactionFee::TransactionFee<CoinType>resource published under the0xB1E55EDaccount 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::BurnEventon the event handle held in theDiem::CurrencyInfo<CoinType>resource'sburn_eventspublished under0xA550C18.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypebeing added to the sending account of the transaction.CoinTypemust 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 Category Error Reason Description Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account. Errors::NOT_PUBLISHEDTransactionFee::ETRANSACTION_FEECoinTypeis not an accepted transaction fee currency.Errors::INVALID_ARGUMENTDiem::ECOINThe collected fees in CoinTypeare zero.Related Scripts
TreasuryComplianceScripts::burn_with_amountTreasuryComplianceScripts::cancel_burn_with_amount
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__BurnTxnFees(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` being added to the sending account of the transaction. `CoinType` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `TransactionFee::ETRANSACTION_FEE` | `CoinType` is not an accepted transaction fee currency. | | `Errors::INVALID_ARGUMENT` | `Diem::ECOIN` | The collected fees in `CoinType` are zero. | # Related Scripts * `TreasuryComplianceScripts::burn_with_amount` * `TreasuryComplianceScripts::cancel_burn_with_amount` """ coin_type: diem_types.TypeTagAncestors
Class variables
var coin_type :Â TypeTag
class ScriptFunctionCall__BurnWithAmount (token:Â TypeTag, sliding_nonce:Â numpy.uint64, preburn_address:Â AccountAddress, amount:Â numpy.uint64)-
Summary
Burns the coins held in a preburn resource in the preburn queue at the specified preburn address, which are equal to the
amountspecified 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
Tokentype stored in theDiem::Preburn<Token>resource published under thepreburn_addressaccount address.This transaction will only succeed if the sending
accounthas aDiem::BurnCapability<Token>, and aDiem::Preburn<Token>resource exists underpreburn_address, with a non-zeroto_burnfield. After the successful execution of this transaction thetotal_valuefield in theDiem::CurrencyInfo<Token>resource published under0xA550C18will be decremented by the value of theto_burnfield of the preburn resource underpreburn_addressimmediately before this transaction, and theto_burnfield of the preburn resource will have a zero value.Events
The successful execution of this transaction will emit a
Diem::BurnEventon the event handle held in theDiem::CurrencyInfo<Token>resource'sburn_eventspublished under0xA550C18.Parameters
Name Type Description TokenType The Move type for the Tokencurrency being burned.Tokenmust be an already-registered currency on-chain.tc_accountsignerThe signer of the sending account of this transaction, must have a burn capability for Tokenpublished 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending accountdoes not have aDiem::BurnCapability<Token>published under it.Errors::INVALID_STATEDiem::EPREBURN_NOT_FOUNDThe Diem::PreburnQueue<Token>resource underpreburn_addressdoes not contain a preburn request with a value matchingamount.Errors::NOT_PUBLISHEDDiem::EPREBURN_QUEUEThe account at preburn_addressdoes not have aDiem::PreburnQueue<Token>resource published under it.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Tokenis not a registered currency on-chain.Related Scripts
TreasuryComplianceScripts::burn_txn_feesTreasuryComplianceScripts::cancel_burn_with_amountTreasuryComplianceScripts::preburn
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__BurnWithAmount(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currency being burned. `Token` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction, must have a burn capability for `Token` published under it. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `preburn_address` | `address` | The address where the coins to-be-burned are currently held. | | `amount` | `u64` | The amount to be burned. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_NOT_FOUND` | The `Diem::PreburnQueue<Token>` resource under `preburn_address` does not contain a preburn request with a value matching `amount`. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN_QUEUE` | The account at `preburn_address` does not have a `Diem::PreburnQueue<Token>` resource published under it. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. | # Related Scripts * `TreasuryComplianceScripts::burn_txn_fees` * `TreasuryComplianceScripts::cancel_burn_with_amount` * `TreasuryComplianceScripts::preburn` """ token: diem_types.TypeTag sliding_nonce: st.uint64 preburn_address: diem_types.AccountAddress amount: st.uint64Ancestors
Class variables
var amount :Â numpy.uint64var preburn_address :Â AccountAddressvar sliding_nonce :Â numpy.uint64var token :Â TypeTag
class ScriptFunctionCall__CancelBurnWithAmount (token:Â TypeTag, preburn_address:Â AccountAddress, amount:Â numpy.uint64)-
Summary
Cancels and returns the coins held in the preburn area under
preburn_address, which are equal to theamountspecified 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 thepreburn_addressand return the funds to thepreburn_addressaccount'sDiemAccount::Balance<Token>. The transaction must be sent by anaccountwith aDiem::BurnCapability<Token>resource published under it. The account atpreburn_addressmust have aDiem::Preburn<Token>resource published under it, and its value must be nonzero. The transaction removes the entire balance held in theDiem::Preburn<Token>resource, and returns it back to the account'sDiemAccount::Balance<Token>underpreburn_address. Due to this, the account atpreburn_addressmust already have a balance in theTokencurrency published before this script is called otherwise the transaction will fail.Events
The successful execution of this transaction will emit: * A
Diem::CancelBurnEventon the event handle held in theDiem::CurrencyInfo<Token>resource'sburn_eventspublished under0xA550C18. * ADiemAccount::ReceivedPaymentEventon thepreburn_address'sDiemAccount::DiemAccountreceived_eventsevent handle with both thepayerandpayeebeingpreburn_address.Parameters
Name Type Description TokenType The Move type for the Tokencurrenty that burning is being cancelled for.Tokenmust be an already-registered currency on-chain.accountsignerThe signer of the sending account of this transaction, must have a burn capability for Tokenpublished under it.preburn_addressaddressThe address where the coins to-be-burned are currently held. amountu64The amount to be cancelled. Common Abort Conditions
Error Category Error Reason Description Errors::REQUIRES_CAPABILITYDiem::EBURN_CAPABILITYThe sending accountdoes not have aDiem::BurnCapability<Token>published under it.Errors::INVALID_STATEDiem::EPREBURN_NOT_FOUNDThe Diem::PreburnQueue<Token>resource underpreburn_addressdoes not contain a preburn request with a value matchingamount.Errors::NOT_PUBLISHEDDiem::EPREBURN_QUEUEThe account at preburn_addressdoes not have aDiem::PreburnQueue<Token>resource published under it.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe specified Tokenis not a registered currency on-chain.Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEThe account at preburn_addressdoesn't have a balance resource forToken.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 accountdoes not have a compliance key set on it but dual attestion checking was performed.Related Scripts
TreasuryComplianceScripts::burn_txn_feesTreasuryComplianceScripts::burn_with_amountTreasuryComplianceScripts::preburn
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__CancelBurnWithAmount(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currenty that burning is being cancelled for. `Token` must be an already-registered currency on-chain. | | `account` | `signer` | The signer of the sending account of this transaction, must have a burn capability for `Token` published under it. | | `preburn_address` | `address` | The address where the coins to-be-burned are currently held. | | `amount` | `u64` | The amount to be cancelled. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_CAPABILITY` | `Diem::EBURN_CAPABILITY` | The sending `account` does not have a `Diem::BurnCapability<Token>` published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_NOT_FOUND` | The `Diem::PreburnQueue<Token>` resource under `preburn_address` does not contain a preburn request with a value matching `amount`. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN_QUEUE` | The account at `preburn_address` does not have a `Diem::PreburnQueue<Token>` resource published under it. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The specified `Token` is not a registered currency on-chain. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | The account at `preburn_address` doesn't have a balance resource for `Token`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds held in the prebun area would exceed the `account`'s account limits. | | `Errors::INVALID_STATE` | `DualAttestation::EPAYEE_COMPLIANCE_KEY_NOT_SET` | The `account` does not have a compliance key set on it but dual attestion checking was performed. | # Related Scripts * `TreasuryComplianceScripts::burn_txn_fees` * `TreasuryComplianceScripts::burn_with_amount` * `TreasuryComplianceScripts::preburn` """ token: diem_types.TypeTag preburn_address: diem_types.AccountAddress amount: st.uint64Ancestors
Class variables
var amount :Â numpy.uint64var preburn_address :Â AccountAddressvar token :Â TypeTag
class ScriptFunctionCall__CreateChildVaspAccount (coin_type:Â TypeTag, child_address:Â AccountAddress, auth_key_prefix:Â bytes, add_all_currencies:Â bool, child_initial_balance:Â numpy.uint64)-
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
ChildVASPaccount for the senderparent_vaspatchild_addresswith a balance ofchild_initial_balanceinCoinTypeand an initial authentication key ofauth_key_prefix | child_address. Authentication key prefixes, and how to construct them from an ed25519 public key is described here.If
add_all_currenciesis 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::CreateAccountEventwith thecreatedfield beingchild_address, and therold_idfield beingRoles::CHILD_VASP_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Successful execution with a
child_initial_balancegreater than zero will additionaly emit: * ADiemAccount::SentPaymentEventwith thepayeefield beingchild_address. This is emitted on the Parent VASP'sDiemAccount::DiemAccountsent_eventshandle. * ADiemAccount::ReceivedPaymentEventwith thepayerfield being the Parent VASP's address. This is emitted on the new Child VASPS'sDiemAccount::DiemAccountreceived_eventshandle.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypethat the child account should be created with.CoinTypemust 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 CoinTypeto give the child account when it's created.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYThe auth_key_prefixwas not of length 32.Errors::REQUIRES_ROLERoles::EPARENT_VASPThe sending account wasn't a Parent VASP account. Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe child_addressaddress 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 CoinTypeis 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_balanceofCoinTypebalance.Errors::INVALID_ARGUMENTDiemAccount::ECANNOT_CREATE_AT_VM_RESERVEDThe child_addressis the reserved address 0x0.Related Scripts
AccountCreationScripts::create_parent_vasp_accountAccountAdministrationScripts::add_currency_to_accountAccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::add_recovery_rotation_capabilityAccountAdministrationScripts::create_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__CreateChildVaspAccount(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` that the child account should be created with. `CoinType` must be an already-registered currency on-chain. | | `parent_vasp` | `signer` | The reference of the sending account. Must be a Parent VASP account. | | `child_address` | `address` | Address of the to-be-created Child VASP account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. | | `child_initial_balance` | `u64` | The initial balance in `CoinType` to give the child account when it's created. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | The `auth_key_prefix` was not of length 32. | | `Errors::REQUIRES_ROLE` | `Roles::EPARENT_VASP` | The sending account wasn't a Parent VASP account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `child_address` address is already taken. | | `Errors::LIMIT_EXCEEDED` | `VASP::ETOO_MANY_CHILDREN` | The sending account has reached the maximum number of allowed child accounts. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. | | `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for the sending account has already been extracted. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | The sending account doesn't have a balance in `CoinType`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | The sending account doesn't have at least `child_initial_balance` of `CoinType` balance. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECANNOT_CREATE_AT_VM_RESERVED` | The `child_address` is the reserved address 0x0. | # Related Scripts * `AccountCreationScripts::create_parent_vasp_account` * `AccountAdministrationScripts::add_currency_to_account` * `AccountAdministrationScripts::rotate_authentication_key` * `AccountAdministrationScripts::add_recovery_rotation_capability` * `AccountAdministrationScripts::create_recovery_address` """ coin_type: diem_types.TypeTag child_address: diem_types.AccountAddress auth_key_prefix: bytes add_all_currencies: bool child_initial_balance: st.uint64Ancestors
Class variables
var add_all_currencies :Â boolvar auth_key_prefix :Â bytesvar child_address :Â AccountAddressvar child_initial_balance :Â numpy.uint64var coin_type :Â TypeTag
class ScriptFunctionCall__CreateDesignatedDealer (currency:Â TypeTag, sliding_nonce:Â numpy.uint64, addr:Â AccountAddress, auth_key_prefix:Â bytes, human_name:Â bytes, 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
addrwith authentication keyauth_key_prefix|addrand a 0 balance of typeCurrency. Ifadd_all_currenciesis 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::CreateAccountEventwith thecreatedfield beingaddr, and therold_idfield beingRoles::DESIGNATED_DEALER_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Parameters
Name Type Description CurrencyType The Move type for the Currencythat the Designated Dealer should be initialized with.Currencymust 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 Currencywhen the account is created.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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 Currencyis not a registered currency on-chain.Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe addraddress is already taken.Related Scripts
TreasuryComplianceScripts::tiered_mintPaymentScripts::peer_to_peer_with_metadataAccountAdministrationScripts::rotate_dual_attestation_info
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__CreateDesignatedDealer(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` that the Designated Dealer should be initialized with. `Currency` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `addr` | `address` | Address of the to-be-created Designated Dealer account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the Designated Dealer. | | `add_all_currencies` | `bool` | Whether 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 Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Currency` is not a registered currency on-chain. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `addr` address is already taken. | # Related Scripts * `TreasuryComplianceScripts::tiered_mint` * `PaymentScripts::peer_to_peer_with_metadata` * `AccountAdministrationScripts::rotate_dual_attestation_info` """ currency: diem_types.TypeTag sliding_nonce: st.uint64 addr: diem_types.AccountAddress auth_key_prefix: bytes human_name: bytes add_all_currencies: boolAncestors
Class variables
var add_all_currencies :Â boolvar addr :Â AccountAddressvar auth_key_prefix :Â bytesvar currency :Â TypeTagvar human_name :Â bytesvar sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__CreateParentVaspAccount (coin_type:Â TypeTag, sliding_nonce:Â numpy.uint64, new_account_address:Â AccountAddress, auth_key_prefix:Â bytes, human_name:Â bytes, 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
addresswith authentication keyauth_key_prefix|new_account_addressand a 0 balance of typeCoinType. Ifadd_all_currenciesis true, 0 balances for all available currencies in the system will also be added. This can only be invoked by an TreasuryCompliance account.sliding_nonceis a unique nonce for operation, seeSlidingNoncefor details. Authentication keys, prefixes, and how to construct them from an ed25519 public key are described here.Events
Successful execution will emit: * A
DiemAccount::CreateAccountEventwith thecreatedfield beingnew_account_address, and therold_idfield beingRoles::PARENT_VASP_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypecurrency that the Parent VASP account should be initialized with.CoinTypemust 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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 CoinTypeis not a registered currency on-chain.Errors::ALREADY_PUBLISHEDRoles::EROLE_IDThe new_account_addressaddress is already taken.Related Scripts
AccountCreationScripts::create_child_vasp_accountAccountAdministrationScripts::add_currency_to_accountAccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::add_recovery_rotation_capabilityAccountAdministrationScripts::create_recovery_addressAccountAdministrationScripts::rotate_dual_attestation_info
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__CreateParentVaspAccount(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). # 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The 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_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Parent VASP account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the Parent VASP. | | `add_all_currencies` | `bool` | Whether to publish balance resources for all known currencies when the account is created. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `CoinType` is not a registered currency on-chain. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `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` """ coin_type: diem_types.TypeTag sliding_nonce: st.uint64 new_account_address: diem_types.AccountAddress auth_key_prefix: bytes human_name: bytes add_all_currencies: boolAncestors
Class variables
var add_all_currencies :Â boolvar auth_key_prefix :Â bytesvar coin_type :Â TypeTagvar human_name :Â bytesvar new_account_address :Â AccountAddressvar sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__CreateRecoveryAddress-
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::RecoveryAddressresource underaccount. It then extracts theDiemAccount::KeyRotationCapabilityforaccountand adds it to the resource. After the successful execution of this transaction other accounts may add their key rotation to this resource so thataccountmay be used as a recovery account for those accounts.Parameters
Name Type Description accountsignerThe signer of the sending account of the transaction. Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTRecoveryAddress::ENOT_A_VASPaccountis 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::RecoveryAddressresource has already been published underaccount.Related Scripts
Script::add_recovery_rotation_capabilityScript::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__CreateRecoveryAddress(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | The signer of the sending account of the transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ENOT_A_VASP` | `account` is not a VASP account. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EKEY_ROTATION_DEPENDENCY_CYCLE` | A key rotation recovery cycle would be created by adding `account`'s key rotation capability. | | `Errors::ALREADY_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | A `RecoveryAddress::RecoveryAddress` resource has already been published under `account`. | # Related Scripts * `Script::add_recovery_rotation_capability` * `Script::rotate_authentication_key_with_recovery_address` """ passAncestors
class ScriptFunctionCall__CreateValidatorAccount (sliding_nonce:Â numpy.uint64, new_account_address:Â AccountAddress, auth_key_prefix:Â bytes, human_name:Â bytes)-
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 keyauth_key_prefix|new_account_address. It publishes aValidatorConfig::ValidatorConfigresource with emptyconfig, andoperator_accountfields. Thehuman_namefield of theValidatorConfig::ValidatorConfigis set to the passed inhuman_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::CreateAccountEventwith thecreatedfield beingnew_account_address, and therold_idfield beingRoles::VALIDATOR_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_addressaddress is already taken.Related Scripts
AccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__CreateValidatorAccount(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). # 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Validator account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `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` """ sliding_nonce: st.uint64 new_account_address: diem_types.AccountAddress auth_key_prefix: bytes human_name: bytesAncestors
Class variables
var auth_key_prefix :Â bytesvar human_name :Â bytesvar new_account_address :Â AccountAddressvar sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__CreateValidatorOperatorAccount (sliding_nonce:Â numpy.uint64, new_account_address:Â AccountAddress, auth_key_prefix:Â bytes, human_name:Â bytes)-
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 keyauth_key_prefix|new_account_address. It publishes aValidatorOperatorConfig::ValidatorOperatorConfigresource with the specifiedhuman_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::CreateAccountEventwith thecreatedfield beingnew_account_address, and therold_idfield beingRoles::VALIDATOR_OPERATOR_ROLE_ID. This is emitted on theDiemAccount::AccountOperationsCapabilitycreation_eventshandle.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_addressaddress is already taken.Related Scripts
AccountCreationScripts::create_validator_accountValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__CreateValidatorOperatorAccount(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). # 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_account_address` | `address` | Address of the to-be-created Validator account. | | `auth_key_prefix` | `vector<u8>` | The authentication key prefix that will be used initially for the newly created account. | | `human_name` | `vector<u8>` | ASCII-encoded human name for the validator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::ALREADY_PUBLISHED` | `Roles::EROLE_ID` | The `new_account_address` address is already taken. | # Related Scripts * `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` """ sliding_nonce: st.uint64 new_account_address: diem_types.AccountAddress auth_key_prefix: bytes human_name: bytesAncestors
Class variables
var auth_key_prefix :Â bytesvar human_name :Â bytesvar new_account_address :Â AccountAddressvar sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__FreezeAccount (sliding_nonce:Â numpy.uint64, 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::FreezingBittotrueand emits aAccountFreezing::FreezeAccountEvent. The transaction sender must be the Treasury Compliance account, but the account atto_freeze_accountmust not be either0xA550C18(the Diem Root address), or0xB1E55ED(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::FreezeAccountEventon thefreeze_event_handleheld in theAccountFreezing::FreezeEventsHolderresource published under0xA550C18with thefrozen_addressbeing theto_freeze_account.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas 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_accountwas the Treasury Compliance account (0xB1E55ED).Errors::INVALID_ARGUMENTAccountFreezing::ECANNOT_FREEZE_DIEM_ROOTto_freeze_accountwas the Diem Root account (0xA550C18).Related Scripts
TreasuryComplianceScripts::unfreeze_account
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__FreezeAccount(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `to_freeze_account` | `address` | The account address to be frozen. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_TC` | `to_freeze_account` was the Treasury Compliance account (`0xB1E55ED`). | | `Errors::INVALID_ARGUMENT` | `AccountFreezing::ECANNOT_FREEZE_DIEM_ROOT` | `to_freeze_account` was the Diem Root account (`0xA550C18`). | # Related Scripts * `TreasuryComplianceScripts::unfreeze_account` """ sliding_nonce: st.uint64 to_freeze_account: diem_types.AccountAddressAncestors
Class variables
var sliding_nonce :Â numpy.uint64var to_freeze_account :Â AccountAddress
class ScriptFunctionCall__InitializeDiemConsensusConfig (sliding_nonce:Â numpy.uint64)-
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
DiemConsensusConfigon-chain config to empty and allows future updates from DiemRoot viaupdate_diem_consensus_config. This doesn't emit aDiemConfig::NewEpochEvent.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__InitializeDiemConsensusConfig(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | """ sliding_nonce: st.uint64Ancestors
Class variables
var sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__PeerToPeerWithMetadata (currency:Â TypeTag, payee:Â AccountAddress, amount:Â numpy.uint64, metadata:Â bytes, metadata_signature:Â bytes)-
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
amountcoins of typeCurrencyfrompayertopayeewith (optional) associatedmetadataand an (optional)metadata_signatureon the message of the formmetadata|Signer::address_of(payer)|amount|DualAttestation::DOMAIN_SEPARATOR, that has been signed by thepayee's private key associated with thecompliance_public_keyheld in thepayee'sDualAttestation::Credential. Both theSigner::address_of(payer)andamountfields in themetadata_signaturemust be BCS-encoded bytes, and|denotes concatenation. Themetadataandmetadata_signatureparameters are only required ifamount>=DualAttestation::get_cur_microdiem_limitXDX andpayerandpayeeare 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-emptymetadata_signature. StandardizedmetadataBCS format can be found indiem_types::transaction::metadata::Metadata.Events
Successful execution of this script emits two events: * A
DiemAccount::SentPaymentEventonpayer'sDiemAccount::DiemAccountsent_eventshandle; and * ADiemAccount::ReceivedPaymentEventonpayee'sDiemAccount::DiemAccountreceived_eventshandle.Parameters
Name Type Description CurrencyType The Move type for the Currencybeing sent in this transaction.Currencymust 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 metadataand payment information. SeeCommon Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYpayerdoesn't hold a balance inCurrency.Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamountis greater thanpayer's balance inCurrency.Errors::INVALID_ARGUMENTDiemAccount::ECOIN_DEPOSIT_IS_ZEROamountis zero.Errors::NOT_PUBLISHEDDiemAccount::EPAYEE_DOES_NOT_EXISTNo account exists at the payeeaddress.Errors::INVALID_ARGUMENTDiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPEAn account exists at payee, but it does not accept payments inCurrency.Errors::INVALID_STATEAccountFreezing::EACCOUNT_FROZENThe payeeaccount is frozen.Errors::INVALID_ARGUMENTDualAttestation::EMALFORMED_METADATA_SIGNATUREmetadata_signatureis not 64 bytes.Errors::INVALID_ARGUMENTDualAttestation::EINVALID_METADATA_SIGNATUREmetadata_signaturedoes not verify on the against thepayee'sDualAttestation::Credentialcompliance_public_keypublic key.Errors::LIMIT_EXCEEDEDDiemAccount::EWITHDRAWAL_EXCEEDS_LIMITSpayerhas exceeded its daily withdrawal limits for the backing coins of XDX.Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSpayeehas exceeded its daily deposit limits for XDX.Related Scripts
AccountCreationScripts::create_child_vasp_accountAccountCreationScripts::create_parent_vasp_accountAccountAdministrationScripts::add_currency_to_account
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__PeerToPeerWithMetadata(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` being sent in this transaction. `Currency` must be an already-registered currency on-chain. | | `payer` | `signer` | The signer of the sending account that coins are being transferred from. | | `payee` | `address` | The address of the account the coins are being transferred to. | | `metadata` | `vector<u8>` | Optional metadata about this payment. | | `metadata_signature` | `vector<u8>` | Optional signature over `metadata` and payment information. See | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `payer` doesn't hold a balance in `Currency`. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Currency`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::ECOIN_DEPOSIT_IS_ZERO` | `amount` is zero. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYEE_DOES_NOT_EXIST` | No account exists at the `payee` address. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EPAYEE_CANT_ACCEPT_CURRENCY_TYPE` | An account exists at `payee`, but it does not accept payments in `Currency`. | | `Errors::INVALID_STATE` | `AccountFreezing::EACCOUNT_FROZEN` | The `payee` account is frozen. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EMALFORMED_METADATA_SIGNATURE` | `metadata_signature` is not 64 bytes. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_METADATA_SIGNATURE` | `metadata_signature` does not verify on the against the `payee'`s `DualAttestation::Credential` `compliance_public_key` public key. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EWITHDRAWAL_EXCEEDS_LIMITS` | `payer` has exceeded its daily withdrawal limits for the backing coins of XDX. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | `payee` has exceeded its daily deposit limits for XDX. | # Related Scripts * `AccountCreationScripts::create_child_vasp_account` * `AccountCreationScripts::create_parent_vasp_account` * `AccountAdministrationScripts::add_currency_to_account` """ currency: diem_types.TypeTag payee: diem_types.AccountAddress amount: st.uint64 metadata: bytes metadata_signature: bytesAncestors
Class variables
var amount :Â numpy.uint64var currency :Â TypeTagvar metadata :Â bytesvar metadata_signature :Â bytesvar payee :Â AccountAddress
class ScriptFunctionCall__Preburn (token:Â TypeTag, amount:Â numpy.uint64)-
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
amountof coins inTokencurrency from the sendingaccount'sDiemAccount::Balance<Token>to theDiem::Preburn<Token>published under the sameaccount.accountmust 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::SentPaymentEventonaccount'sDiemAccount::DiemAccountsent_eventshandle with thepayeeandpayerfields beingaccount's address; and * ADiem::PreburnEventwithToken's currency code on theDiem::CurrencyInfo<Token'spreburn_eventshandle forTokenand withpreburn_addressset toaccount's address.Parameters
Name Type Description TokenType The Move type for the Tokencurrency being moved to the preburn area.Tokenmust be an already-registered currency on-chain.accountsignerThe signer of the sending account. amountu64The amount in Tokento be moved to the preburn area.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOThe Tokenis not a registered currency on-chain.Errors::INVALID_STATEDiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTEDThe withdrawal capability for accounthas already been extracted.Errors::LIMIT_EXCEEDEDDiemAccount::EINSUFFICIENT_BALANCEamountis greater thanpayer's balance inToken.Errors::NOT_PUBLISHEDDiemAccount::EPAYER_DOESNT_HOLD_CURRENCYaccountdoesn't hold a balance inToken.Errors::NOT_PUBLISHEDDiem::EPREBURNaccountdoesn't have aDiem::Preburn<Token>resource published under it.Errors::INVALID_STATEDiem::EPREBURN_OCCUPIEDThe valuefield in theDiem::Preburn<Token>resource under the sender is non-zero.Errors::NOT_PUBLISHEDRoles::EROLE_IDThe accountdid not have a role assigned to it.Errors::REQUIRES_ROLERoles::EDESIGNATED_DEALERThe accountdid not have the role of DesignatedDealer.Related Scripts
TreasuryComplianceScripts::cancel_burn_with_amountTreasuryComplianceScripts::burn_with_amountTreasuryComplianceScripts::burn_txn_fees
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__Preburn(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Token` | Type | The Move type for the `Token` currency being moved to the preburn area. `Token` must be an already-registered currency on-chain. | | `account` | `signer` | The signer of the sending account. | | `amount` | `u64` | The amount in `Token` to be moved to the preburn area. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | The `Token` is not a registered currency on-chain. | | `Errors::INVALID_STATE` | `DiemAccount::EWITHDRAWAL_CAPABILITY_ALREADY_EXTRACTED` | The withdrawal capability for `account` has already been extracted. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EINSUFFICIENT_BALANCE` | `amount` is greater than `payer`'s balance in `Token`. | | `Errors::NOT_PUBLISHED` | `DiemAccount::EPAYER_DOESNT_HOLD_CURRENCY` | `account` doesn't hold a balance in `Token`. | | `Errors::NOT_PUBLISHED` | `Diem::EPREBURN` | `account` doesn't have a `Diem::Preburn<Token>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EPREBURN_OCCUPIED` | The `value` field in the `Diem::Preburn<Token>` resource under the sender is non-zero. | | `Errors::NOT_PUBLISHED` | `Roles::EROLE_ID` | The `account` did not have a role assigned to it. | | `Errors::REQUIRES_ROLE` | `Roles::EDESIGNATED_DEALER` | The `account` did not have the role of DesignatedDealer. | # Related Scripts * `TreasuryComplianceScripts::cancel_burn_with_amount` * `TreasuryComplianceScripts::burn_with_amount` * `TreasuryComplianceScripts::burn_txn_fees` """ token: diem_types.TypeTag amount: st.uint64Ancestors
Class variables
var amount :Â numpy.uint64var token :Â TypeTag
-
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_keyand publishes aSharedEd25519PublicKey::SharedEd25519PublicKeyresource containing the 32-byte ed25519public_keyand theDiemAccount::KeyRotationCapabilityforaccountunderaccount.Parameters
Name Type Description 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 Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapabilityresource.Errors::ALREADY_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYThe SharedEd25519PublicKey::SharedEd25519PublicKeyresource is already published underaccount.Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_keyis an invalid ed25519 public key.Related Scripts
AccountAdministrationScripts::rotate_shared_ed25519_public_key
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__PublishSharedEd25519PublicKey(ScriptFunctionCall): """# 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`](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys) and publishes a `SharedEd25519PublicKey::SharedEd25519PublicKey` resource containing the 32-byte ed25519 `public_key` and the `DiemAccount::KeyRotationCapability` for `account` under `account`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | The signer of the sending account of the transaction. | | `public_key` | `vector<u8>` | A valid 32-byte Ed25519 public key for `account`'s authentication key to be rotated to and stored. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability` resource. | | `Errors::ALREADY_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | The `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is already published under `account`. | | `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. | # Related Scripts * `AccountAdministrationScripts::rotate_shared_ed25519_public_key` """ public_key: bytesAncestors
Class variables
class ScriptFunctionCall__RegisterValidatorConfig (validator_account:Â AccountAddress, consensus_pubkey:Â bytes, validator_network_addresses:Â bytes, fullnode_network_addresses:Â bytes)-
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::ValidatorConfigconfig resource held undervalidator_account. It does not emit aDiemConfig::NewEpochEventso the copy of this config held in the validator set will not be updated, and the changes are only "locally" under thevalidator_accountaccount address.Parameters
Name Type Description 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::ValidatorConfigresource 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_addressesto be used in the updatedValidatorConfig::ValidatorConfig.fullnode_network_addressesvector<u8>New set of fullnode_network_addressesto be used in the updatedValidatorConfig::ValidatorConfig.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_addressdoes not have aValidatorConfig::ValidatorConfigresource published under it.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_accountis not the registered operator for the validator atvalidator_address.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkeyis not a valid ed25519 public key.Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__RegisterValidatorConfig(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `validator_operator_account` | `signer` | Signer of the sending account. Must be the registered validator operator for the validator at `validator_address`. | | `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. | | `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. | # Related Scripts * `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` """ validator_account: diem_types.AccountAddress consensus_pubkey: bytes validator_network_addresses: bytes fullnode_network_addresses: bytesAncestors
Class variables
var consensus_pubkey :Â bytesvar fullnode_network_addresses :Â bytesvar validator_account :Â AccountAddressvar validator_network_addresses :Â bytes
class ScriptFunctionCall__RemoveValidatorAndReconfigure (sliding_nonce:Â numpy.uint64, validator_name:Â bytes, 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_addressfrom the validator set. This transaction emits aDiemConfig::NewEpochEventevent. Once the reconfiguration triggered by this event has been performed, the account atvalidator_addressis no longer considered to be a validator in the network. This transaction will fail if the validator atvalidator_addressis not in the validator set.Parameters
Name Type Description 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::ValidatorConfigfor the validator.validator_addressaddressThe validator account address to be removed from the validator set. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEThe sending account is not the Diem Root account or Treasury Compliance account 0 0 The provided validator_namedoes 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. Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__RemoveValidatorAndReconfigure(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of this transaction. Must be the Diem Root signer. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `validator_name` | `vector<u8>` | ASCII-encoded human name for the validator. Must match the human name in the `ValidatorConfig::ValidatorConfig` for the validator. | | `validator_address` | `address` | The validator account address to be removed from the validator set. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account | | 0 | 0 | The provided `validator_name` does not match the already-recorded human name for the validator. | | `Errors::INVALID_ARGUMENT` | `DiemSystem::ENOT_AN_ACTIVE_VALIDATOR` | The validator to be removed is not in the validator set. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::REQUIRES_ROLE` | `Roles::EDIEM_ROOT` | The sending account is not the Diem Root account. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `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` """ sliding_nonce: st.uint64 validator_name: bytes validator_address: diem_types.AccountAddressAncestors
Class variables
var sliding_nonce :Â numpy.uint64var validator_address :Â AccountAddressvar validator_name :Â bytes
class ScriptFunctionCall__RotateAuthenticationKey (new_key:Â bytes)-
Summary
Rotates the
account's authentication key to the supplied new authentication key.May be sent by any account.
Technical Description
Rotate the
account'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid authentication key that corresponds to an ed25519 public key as described here, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description accountsignerSigner of the sending account of the transaction. new_keyvector<u8>New authentication key to be used for account.Common Abort Conditions
Error Category Error Reason Description Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
AccountAdministrationScripts::rotate_authentication_key_with_nonceAccountAdministrationScripts::rotate_authentication_key_with_nonce_adminAccountAdministrationScripts::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__RotateAuthenticationKey(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys), and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account of the transaction. | | `new_key` | `vector<u8>` | New authentication key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `AccountAdministrationScripts::rotate_authentication_key_with_nonce` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin` * `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address` """ new_key: bytesAncestors
Class variables
var new_key :Â bytes
class ScriptFunctionCall__RotateAuthenticationKeyWithNonce (sliding_nonce:Â numpy.uint64, new_key:Â bytes)-
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'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid authentication key that corresponds to an ed25519 public key as described here, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
AccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::rotate_authentication_key_with_nonce_adminAccountAdministrationScripts::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__RotateAuthenticationKeyWithNonce(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys), and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account of the transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_key` | `vector<u8>` | New authentication key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `AccountAdministrationScripts::rotate_authentication_key` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin` * `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address` """ sliding_nonce: st.uint64 new_key: bytesAncestors
Class variables
var new_key :Â bytesvar sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__RotateAuthenticationKeyWithNonceAdmin (sliding_nonce:Â numpy.uint64, new_key:Â bytes)-
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'sDiemAccount::DiemAccountauthentication_keyfield tonew_key.new_keymust be a valid authentication key that corresponds to an ed25519 public key as described here, andaccountmust not have previously delegated itsDiemAccount::KeyRotationCapability.Parameters
Name Type Description 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_asfield 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceindr_accountis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceindr_accountis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonceindr_accounthas been previously recorded.Errors::INVALID_STATEDiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTEDaccounthas already delegated/extracted itsDiemAccount::KeyRotationCapability.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
AccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::rotate_authentication_key_with_nonceAccountAdministrationScripts::rotate_authentication_key_with_recovery_address
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__RotateAuthenticationKeyWithNonceAdmin(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys), and `account` must not have previously delegated its `DiemAccount::KeyRotationCapability`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | The signer of the sending account of the write set transaction. May only be the Diem Root signer. | | `account` | `signer` | Signer of account specified in the `execute_as` field of the write set transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. | | `new_key` | `vector<u8>` | New authentication key to be used for `account`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. | | `Errors::INVALID_STATE` | `DiemAccount::EKEY_ROTATION_CAPABILITY_ALREADY_EXTRACTED` | `account` has already delegated/extracted its `DiemAccount::KeyRotationCapability`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `AccountAdministrationScripts::rotate_authentication_key` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce` * `AccountAdministrationScripts::rotate_authentication_key_with_recovery_address` """ sliding_nonce: st.uint64 new_key: bytesAncestors
Class variables
var new_key :Â bytesvar sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__RotateAuthenticationKeyWithRecoveryAddress (recovery_address:Â AccountAddress, to_recover:Â AccountAddress, new_key:Â bytes)-
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_capabilityfor account restrictions).Technical Description
Rotates the authentication key of the
to_recoveraccount tonew_keyusing theDiemAccount::KeyRotationCapabilitystored in theRecoveryAddress::RecoveryAddressresource published underrecovery_address.new_keymust be a valide authentication key as described here. This transaction can be sent either by theto_recoveraccount, or by the account where theRecoveryAddress::RecoveryAddressresource is published that containsto_recover'sDiemAccount::KeyRotationCapability.Parameters
Name Type Description accountsignerSigner of the sending account of the transaction. recovery_addressaddressAddress where RecoveryAddress::RecoveryAddressthat holdsto_recover'sDiemAccount::KeyRotationCapabilityis 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_recoveraddress.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDRecoveryAddress::ERECOVERY_ADDRESSrecovery_addressdoes not have aRecoveryAddress::RecoveryAddressresource published under it.Errors::INVALID_ARGUMENTRecoveryAddress::ECANNOT_ROTATE_KEYThe address of accountis notrecovery_addressorto_recover.Errors::INVALID_ARGUMENTRecoveryAddress::EACCOUNT_NOT_RECOVERABLEto_recover'sDiemAccount::KeyRotationCapabilityis not in theRecoveryAddress::RecoveryAddressresource published underrecovery_address.Errors::INVALID_ARGUMENTDiemAccount::EMALFORMED_AUTHENTICATION_KEYnew_keywas an invalid length.Related Scripts
AccountAdministrationScripts::rotate_authentication_keyAccountAdministrationScripts::rotate_authentication_key_with_nonceAccountAdministrationScripts::rotate_authentication_key_with_nonce_admin
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__RotateAuthenticationKeyWithRecoveryAddress(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys). 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account of the transaction. | | `recovery_address` | `address` | Address where `RecoveryAddress::RecoveryAddress` that holds `to_recover`'s `DiemAccount::KeyRotationCapability` is published. | | `to_recover` | `address` | The address of the account whose authentication key will be updated. | | `new_key` | `vector<u8>` | New authentication key to be used for the account at the `to_recover` address. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `RecoveryAddress::ERECOVERY_ADDRESS` | `recovery_address` does not have a `RecoveryAddress::RecoveryAddress` resource published under it. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::ECANNOT_ROTATE_KEY` | The address of `account` is not `recovery_address` or `to_recover`. | | `Errors::INVALID_ARGUMENT` | `RecoveryAddress::EACCOUNT_NOT_RECOVERABLE` | `to_recover`'s `DiemAccount::KeyRotationCapability` is not in the `RecoveryAddress::RecoveryAddress` resource published under `recovery_address`. | | `Errors::INVALID_ARGUMENT` | `DiemAccount::EMALFORMED_AUTHENTICATION_KEY` | `new_key` was an invalid length. | # Related Scripts * `AccountAdministrationScripts::rotate_authentication_key` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce` * `AccountAdministrationScripts::rotate_authentication_key_with_nonce_admin` """ recovery_address: diem_types.AccountAddress to_recover: diem_types.AccountAddress new_key: bytesAncestors
Class variables
var new_key :Â bytesvar recovery_address :Â AccountAddressvar to_recover :Â AccountAddress
class ScriptFunctionCall__RotateDualAttestationInfo (new_url:Â bytes, new_key:Â bytes)-
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_urlandcompliance_public_keyfields of theDualAttestation::Credentialresource published underaccount. Thenew_keymust be a valid ed25519 public key.Events
Successful execution of this transaction emits two events: * A
DualAttestation::ComplianceKeyRotationEventcontaining the new compliance public key, and the blockchain time at which the key was updated emitted on theDualAttestation::Credentialcompliance_key_rotation_eventshandle published underaccount; and * ADualAttestation::BaseUrlRotationEventcontaining the new base url to be used for off-chain communication, and the blockchain time at which the url was updated emitted on theDualAttestation::Credentialbase_url_rotation_eventshandle published underaccount.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDDualAttestation::ECREDENTIALA DualAttestation::Credentialresource is not published underaccount.Errors::INVALID_ARGUMENTDualAttestation::EINVALID_PUBLIC_KEYnew_keyis not a valid ed25519 public key.Related Scripts
AccountCreationScripts::create_parent_vasp_accountAccountCreationScripts::create_designated_dealerAccountAdministrationScripts::rotate_dual_attestation_info
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__RotateDualAttestationInfo(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account of the transaction. | | `new_url` | `vector<u8>` | ASCII-encoded url to be used for off-chain communication with `account`. | | `new_key` | `vector<u8>` | New ed25519 public key to be used for on-chain dual attestation checking. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `DualAttestation::ECREDENTIAL` | A `DualAttestation::Credential` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `DualAttestation::EINVALID_PUBLIC_KEY` | `new_key` is not a valid ed25519 public key. | # Related Scripts * `AccountCreationScripts::create_parent_vasp_account` * `AccountCreationScripts::create_designated_dealer` * `AccountAdministrationScripts::rotate_dual_attestation_info` """ new_url: bytes new_key: bytesAncestors
Class variables
var new_key :Â bytesvar new_url :Â bytes
-
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_keymust be a valid ed25519 public key. This transaction first rotates the public key stored inaccount'sSharedEd25519PublicKey::SharedEd25519PublicKeyresource topublic_key, after which it rotates theaccount's authentication key to the new authentication key derived frompublic_keyas defined here using theDiemAccount::KeyRotationCapabilitystored inaccount'sSharedEd25519PublicKey::SharedEd25519PublicKey.Parameters
Name Type Description accountsignerThe signer of the sending account of the transaction. public_keyvector<u8>32-byte Ed25519 public key. Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSharedEd25519PublicKey::ESHARED_KEYA SharedEd25519PublicKey::SharedEd25519PublicKeyresource is not published underaccount.Errors::INVALID_ARGUMENTSharedEd25519PublicKey::EMALFORMED_PUBLIC_KEYpublic_keyis an invalid ed25519 public key.Related Scripts
AccountAdministrationScripts::publish_shared_ed25519_public_key
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__RotateSharedEd25519PublicKey(ScriptFunctionCall): """# 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](https://developers.diem.com/docs/core/accounts/#addresses-authentication-keys-and-cryptographic-keys) using the `DiemAccount::KeyRotationCapability` stored in `account`'s `SharedEd25519PublicKey::SharedEd25519PublicKey`. # Parameters | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | The signer of the sending account of the transaction. | | `public_key` | `vector<u8>` | 32-byte Ed25519 public key. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SharedEd25519PublicKey::ESHARED_KEY` | A `SharedEd25519PublicKey::SharedEd25519PublicKey` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SharedEd25519PublicKey::EMALFORMED_PUBLIC_KEY` | `public_key` is an invalid ed25519 public key. | # Related Scripts * `AccountAdministrationScripts::publish_shared_ed25519_public_key` """ public_key: bytesAncestors
Class variables
class ScriptFunctionCall__SetGasConstants (sliding_nonce:Â numpy.uint64, global_memory_per_byte_cost:Â numpy.uint64, global_memory_per_byte_write_cost:Â numpy.uint64, min_transaction_gas_units:Â numpy.uint64, large_transaction_cutoff:Â numpy.uint64, intrinsic_gas_per_byte:Â numpy.uint64, maximum_number_of_gas_units:Â numpy.uint64, min_price_per_gas_unit:Â numpy.uint64, max_price_per_gas_unit:Â numpy.uint64, max_transaction_size_in_bytes:Â numpy.uint64, gas_unit_scaling_factor:Â numpy.uint64, default_account_size:Â numpy.uint64)-
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
DiemVMConfigand emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system.Parameters
Name Type Description 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 Category Error Reason Description Errors::INVALID_ARGUMENTDiemVMConfig::EGAS_CONSTANT_INCONSISTENCYThe provided gas constants are inconsistent. Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__SetGasConstants(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `global_memory_per_byte_cost` | `u64` | The new cost to read global memory per-byte to be used for gas metering. | | `global_memory_per_byte_write_cost` | `u64` | The new cost to write global memory per-byte to be used for gas metering. | | `min_transaction_gas_units` | `u64` | The new flat minimum amount of gas required for any transaction. | | `large_transaction_cutoff` | `u64` | The new size over which an additional charge will be assessed for each additional byte. | | `intrinsic_gas_per_byte` | `u64` | The new number of units of gas that to be charged per-byte over the new `large_transaction_cutoff`. | | `maximum_number_of_gas_units` | `u64` | The new maximum number of gas units that can be set in a transaction. | | `min_price_per_gas_unit` | `u64` | The new minimum gas price that can be set for a transaction. | | `max_price_per_gas_unit` | `u64` | The new maximum gas price that can be set for a transaction. | | `max_transaction_size_in_bytes` | `u64` | The new maximum size of a transaction that can be processed. | | `gas_unit_scaling_factor` | `u64` | The new scaling factor to use when scaling between external and internal gas units. | | `default_account_size` | `u64` | The new default account size to use when assessing final costs for reads and writes to global storage. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::INVALID_ARGUMENT` | `DiemVMConfig::EGAS_CONSTANT_INCONSISTENCY` | The provided gas constants are inconsistent. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | """ sliding_nonce: st.uint64 global_memory_per_byte_cost: st.uint64 global_memory_per_byte_write_cost: st.uint64 min_transaction_gas_units: st.uint64 large_transaction_cutoff: st.uint64 intrinsic_gas_per_byte: st.uint64 maximum_number_of_gas_units: st.uint64 min_price_per_gas_unit: st.uint64 max_price_per_gas_unit: st.uint64 max_transaction_size_in_bytes: st.uint64 gas_unit_scaling_factor: st.uint64 default_account_size: st.uint64Ancestors
Class variables
var default_account_size :Â numpy.uint64var gas_unit_scaling_factor :Â numpy.uint64var global_memory_per_byte_cost :Â numpy.uint64var global_memory_per_byte_write_cost :Â numpy.uint64var intrinsic_gas_per_byte :Â numpy.uint64var large_transaction_cutoff :Â numpy.uint64var max_price_per_gas_unit :Â numpy.uint64var max_transaction_size_in_bytes :Â numpy.uint64var maximum_number_of_gas_units :Â numpy.uint64var min_price_per_gas_unit :Â numpy.uint64var min_transaction_gas_units :Â numpy.uint64var sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__SetValidatorConfigAndReconfigure (validator_account:Â AccountAddress, consensus_pubkey:Â bytes, validator_network_addresses:Â bytes, fullnode_network_addresses:Â bytes)-
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::ValidatorConfigconfig resource held undervalidator_account. It then emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system. This reconfiguration will update the validator set on-chain with the updatedValidatorConfig::ValidatorConfig.Parameters
Name Type Description 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::ValidatorConfigresource 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_addressesto be used in the updatedValidatorConfig::ValidatorConfig.fullnode_network_addressesvector<u8>New set of fullnode_network_addressesto be used in the updatedValidatorConfig::ValidatorConfig.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGvalidator_addressdoes not have aValidatorConfig::ValidatorConfigresource published under it.Errors::REQUIRES_ROLERoles::EVALIDATOR_OPERATORvalidator_operator_accountdoes not have a Validator Operator role.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_TRANSACTION_SENDERvalidator_operator_accountis not the registered operator for the validator atvalidator_address.Errors::INVALID_ARGUMENTValidatorConfig::EINVALID_CONSENSUS_KEYconsensus_pubkeyis not a valid ed25519 public key.Errors::INVALID_STATEDiemConfig::EINVALID_BLOCK_TIMEAn invalid time value was encountered in reconfiguration. Unlikely to occur. Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::register_validator_config
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__SetValidatorConfigAndReconfigure(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `validator_operator_account` | `signer` | Signer of the sending account. Must be the registered validator operator for the validator at `validator_address`. | | `validator_account` | `address` | The address of the validator's `ValidatorConfig::ValidatorConfig` resource being updated. | | `consensus_pubkey` | `vector<u8>` | New Ed25519 public key to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `validator_network_addresses` | `vector<u8>` | New set of `validator_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | | `fullnode_network_addresses` | `vector<u8>` | New set of `fullnode_network_addresses` to be used in the updated `ValidatorConfig::ValidatorConfig`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | `validator_address` does not have a `ValidatorConfig::ValidatorConfig` resource published under it. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR_OPERATOR` | `validator_operator_account` does not have a Validator Operator role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_TRANSACTION_SENDER` | `validator_operator_account` is not the registered operator for the validator at `validator_address`. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::EINVALID_CONSENSUS_KEY` | `consensus_pubkey` is not a valid ed25519 public key. | | `Errors::INVALID_STATE` | `DiemConfig::EINVALID_BLOCK_TIME` | An invalid time value was encountered in reconfiguration. Unlikely to occur. | # Related Scripts * `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` """ validator_account: diem_types.AccountAddress consensus_pubkey: bytes validator_network_addresses: bytes fullnode_network_addresses: bytesAncestors
Class variables
var consensus_pubkey :Â bytesvar fullnode_network_addresses :Â bytesvar validator_account :Â AccountAddressvar validator_network_addresses :Â bytes
class ScriptFunctionCall__SetValidatorOperator (operator_name:Â bytes, 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_accountaddress and with the specifiedhuman_nameas an operator for the sending validator account. The account atoperator_accountaddress must have a Validator Operator role and have aValidatorOperatorConfig::ValidatorOperatorConfigresource published under it. The sendingaccountmust be a Validator and have aValidatorConfig::ValidatorConfigresource published under it. This script does not emit aDiemConfig::NewEpochEventand no reconfiguration of the system is initiated by this script.Parameters
Name Type Description 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 accountvalidator's operator.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIGThe ValidatorOperatorConfig::ValidatorOperatorConfigresource is not published underoperator_account.0 0 The human_namefield of theValidatorOperatorConfig::ValidatorOperatorConfigresource underoperator_accountdoes not match the providedhuman_name.Errors::REQUIRES_ROLERoles::EVALIDATORaccountdoes not have a Validator account role.Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_accountdoes not have aValidatorOperatorConfig::ValidatorOperatorConfigresource.Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfigis not published underaccount.Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operator_with_nonce_adminValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__SetValidatorOperator(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | The signer of the sending account of the transaction. | | `operator_name` | `vector<u8>` | Validator operator's human name. | | `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. | | 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. | # Related Scripts * `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` """ operator_name: bytes operator_account: diem_types.AccountAddressAncestors
Class variables
var operator_account :Â AccountAddressvar operator_name :Â bytes
class ScriptFunctionCall__SetValidatorOperatorWithNonceAdmin (sliding_nonce:Â numpy.uint64, operator_name:Â bytes, 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_accountaddress and with the specifiedhuman_nameas an operator for the validatoraccount. The account atoperator_accountaddress must have a Validator Operator role and have aValidatorOperatorConfig::ValidatorOperatorConfigresource published under it. The account represented by theaccountsigner must be a Validator and have aValidatorConfig::ValidatorConfigresource published under it. No reconfiguration of the system is initiated by this script.Parameters
Name Type Description 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_asfield 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 accountvalidator's operator.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underdr_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceindr_accountis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceindr_accountis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_nonceindr_accounthas 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::ValidatorOperatorConfigresource is not published underoperator_account.0 0 The human_namefield of theValidatorOperatorConfig::ValidatorOperatorConfigresource underoperator_accountdoes not match the providedhuman_name.Errors::REQUIRES_ROLERoles::EVALIDATORaccountdoes not have a Validator account role.Errors::INVALID_ARGUMENTValidatorConfig::ENOT_A_VALIDATOR_OPERATORThe account at operator_accountdoes not have aValidatorOperatorConfig::ValidatorOperatorConfigresource.Errors::NOT_PUBLISHEDValidatorConfig::EVALIDATOR_CONFIGA ValidatorConfig::ValidatorConfigis not published underaccount.Related Scripts
AccountCreationScripts::create_validator_accountAccountCreationScripts::create_validator_operator_accountValidatorAdministrationScripts::register_validator_configValidatorAdministrationScripts::remove_validator_and_reconfigureValidatorAdministrationScripts::add_validator_and_reconfigureValidatorAdministrationScripts::set_validator_operatorValidatorAdministrationScripts::set_validator_config_and_reconfigure
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__SetValidatorOperatorWithNonceAdmin(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `dr_account` | `signer` | Signer of the sending account of the write set transaction. May only be the Diem Root signer. | | `account` | `signer` | Signer of account specified in the `execute_as` field of the write set transaction. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction for Diem Root. | | `operator_name` | `vector<u8>` | Validator operator's human name. | | `operator_account` | `address` | Address of the validator operator account to be added as the `account` validator's operator. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `dr_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` in `dr_account` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` in `dr_account` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` in` dr_account` has been previously recorded. | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | The sending account is not the Diem Root account or Treasury Compliance account | | `Errors::NOT_PUBLISHED` | `ValidatorOperatorConfig::EVALIDATOR_OPERATOR_CONFIG` | The `ValidatorOperatorConfig::ValidatorOperatorConfig` resource is not published under `operator_account`. | | 0 | 0 | The `human_name` field of the `ValidatorOperatorConfig::ValidatorOperatorConfig` resource under `operator_account` does not match the provided `human_name`. | | `Errors::REQUIRES_ROLE` | `Roles::EVALIDATOR` | `account` does not have a Validator account role. | | `Errors::INVALID_ARGUMENT` | `ValidatorConfig::ENOT_A_VALIDATOR_OPERATOR` | The account at `operator_account` does not have a `ValidatorOperatorConfig::ValidatorOperatorConfig` resource. | | `Errors::NOT_PUBLISHED` | `ValidatorConfig::EVALIDATOR_CONFIG` | A `ValidatorConfig::ValidatorConfig` is not published under `account`. | # Related Scripts * `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` """ sliding_nonce: st.uint64 operator_name: bytes operator_account: diem_types.AccountAddressAncestors
Class variables
var operator_account :Â AccountAddressvar operator_name :Â bytesvar sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__TieredMint (coin_type:Â TypeTag, sliding_nonce:Â numpy.uint64, designated_dealer_address:Â AccountAddress, mint_amount:Â numpy.uint64, tier_index:Â numpy.uint64)-
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_amountof coins in theCoinTypecurrency to Designated Dealer account atdesignated_dealer_address. Thetier_indexparameter 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 ofCoinTypecoins 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 sendingtc_accountmust 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::MintEventwith the amount and currency code minted is emitted on themint_event_handlein the storedDiem::CurrencyInfo<CoinType>resource stored under0xA550C18; and * ADesignatedDealer::ReceivedMintEventwith the amount, currency code, and Designated Dealer's address is emitted on themint_event_handlein the storedDesignatedDealer::Dealerresource published under thedesignated_dealer_address.Parameters
Name Type Description CoinTypeType The Move type for the CoinTypebeing minted.CoinTypemust 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::INVALID_ARGUMENTDesignatedDealer::EINVALID_MINT_AMOUNTmint_amountis zero.Errors::NOT_PUBLISHEDDesignatedDealer::EDEALERDesignatedDealer::DealerorDesignatedDealer::TierInfo<CoinType>resource does not exist atdesignated_dealer_address.Errors::REQUIRES_CAPABILITYDiem::EMINT_CAPABILITYtc_accountdoes not have aDiem::MintCapability<CoinType>resource published under it.Errors::INVALID_STATEDiem::EMINTING_NOT_ALLOWEDMinting is not currently allowed for CoinTypecoins.Errors::LIMIT_EXCEEDEDDiemAccount::EDEPOSIT_EXCEEDS_LIMITSThe depositing of the funds would exceed the account's account limits.Related Scripts
AccountCreationScripts::create_designated_dealerPaymentScripts::peer_to_peer_with_metadataAccountAdministrationScripts::rotate_dual_attestation_info
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__TieredMint(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `CoinType` | Type | The Move type for the `CoinType` being minted. `CoinType` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `designated_dealer_address` | `address` | The address of the Designated Dealer account being minted to. | | `mint_amount` | `u64` | The number of coins to be minted. | | `tier_index` | `u64` | [Deprecated] The mint tier index to use for the Designated Dealer account. Will be ignored | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `DesignatedDealer::EINVALID_MINT_AMOUNT` | `mint_amount` is zero. | | `Errors::NOT_PUBLISHED` | `DesignatedDealer::EDEALER` | `DesignatedDealer::Dealer` or `DesignatedDealer::TierInfo<CoinType>` resource does not exist at `designated_dealer_address`. | | `Errors::REQUIRES_CAPABILITY` | `Diem::EMINT_CAPABILITY` | `tc_account` does not have a `Diem::MintCapability<CoinType>` resource published under it. | | `Errors::INVALID_STATE` | `Diem::EMINTING_NOT_ALLOWED` | Minting is not currently allowed for `CoinType` coins. | | `Errors::LIMIT_EXCEEDED` | `DiemAccount::EDEPOSIT_EXCEEDS_LIMITS` | The depositing of the funds would exceed the `account`'s account limits. | # Related Scripts * `AccountCreationScripts::create_designated_dealer` * `PaymentScripts::peer_to_peer_with_metadata` * `AccountAdministrationScripts::rotate_dual_attestation_info` """ coin_type: diem_types.TypeTag sliding_nonce: st.uint64 designated_dealer_address: diem_types.AccountAddress mint_amount: st.uint64 tier_index: st.uint64Ancestors
Class variables
var coin_type :Â TypeTagvar designated_dealer_address :Â AccountAddressvar mint_amount :Â numpy.uint64var sliding_nonce :Â numpy.uint64var tier_index :Â numpy.uint64
class ScriptFunctionCall__UnfreezeAccount (sliding_nonce:Â numpy.uint64, 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::FreezingBittofalseand emits aAccountFreezing::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::UnFreezeAccountEventwith theunfrozen_addressset theto_unfreeze_account's address.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEThe sending account is not the Treasury Compliance account. Related Scripts
TreasuryComplianceScripts::freeze_account
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__UnfreezeAccount(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `to_unfreeze_account` | `address` | The account address to be frozen. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | The sending account is not the Treasury Compliance account. | # Related Scripts * `TreasuryComplianceScripts::freeze_account` """ sliding_nonce: st.uint64 to_unfreeze_account: diem_types.AccountAddressAncestors
Class variables
var sliding_nonce :Â numpy.uint64var to_unfreeze_account :Â AccountAddress
class ScriptFunctionCall__UpdateDiemConsensusConfig (sliding_nonce:Â numpy.uint64, config:Â bytes)-
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
DiemConsensusConfigon-chain config and emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__UpdateDiemConsensusConfig(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `config` | `vector<u8>` | The serialized bytes of consensus config. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | """ sliding_nonce: st.uint64 config: bytesAncestors
Class variables
var config :Â bytesvar sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__UpdateDiemVersion (sliding_nonce:Â numpy.uint64, major:Â numpy.uint64)-
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
DiemVersionon-chain config and emits aDiemConfig::NewEpochEventto trigger a reconfiguration of the system. Themajorversion 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
Name Type Description accountsignerSigner of the sending account. Must be the Diem Root account. sliding_nonceu64The sliding_nonce(see:SlidingNonce) to be used for this transaction.majoru64The majorversion of the VM to be used from this transaction on.Common Abort Conditions
Error Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published underaccount.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::EDIEM_ROOTaccountis not the Diem Root account.Errors::INVALID_ARGUMENTDiemVersion::EINVALID_MAJOR_VERSION_NUMBERmajoris less-than or equal to the current major version stored on-chain.Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__UpdateDiemVersion(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `major` | `u64` | The `major` version of the VM to be used from this transaction on. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::EDIEM_ROOT` | `account` is not the Diem Root account. | | `Errors::INVALID_ARGUMENT` | `DiemVersion::EINVALID_MAJOR_VERSION_NUMBER` | `major` is less-than or equal to the current major version stored on-chain. | """ sliding_nonce: st.uint64 major: st.uint64Ancestors
Class variables
var major :Â numpy.uint64var sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__UpdateDualAttestationLimit (sliding_nonce:Â numpy.uint64, new_micro_xdx_limit:Â numpy.uint64)-
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_limitfield of theDualAttestation::Limitresource published under0xA550C18. The amount is set in micro-XDX.Parameters
Name Type Description 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Related Scripts
TreasuryComplianceScripts::update_exchange_rateTreasuryComplianceScripts::update_minting_ability
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__UpdateDualAttestationLimit(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for this transaction. | | `new_micro_xdx_limit` | `u64` | The new dual attestation limit to be used on-chain. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | # Related Scripts * `TreasuryComplianceScripts::update_exchange_rate` * `TreasuryComplianceScripts::update_minting_ability` """ sliding_nonce: st.uint64 new_micro_xdx_limit: st.uint64Ancestors
Class variables
var new_micro_xdx_limit :Â numpy.uint64var sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__UpdateExchangeRate (currency:Â TypeTag, sliding_nonce:Â numpy.uint64, new_exchange_rate_numerator:Â numpy.uint64, new_exchange_rate_denominator:Â numpy.uint64)-
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
Currencyto micro-XDX. The exchange rate is given bynew_exchange_rate_numerator/new_exchange_rate_denominator.Parameters
Name Type Description CurrencyType The Move type for the Currencywhose exchange rate is being updated.Currencymust 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 Category Error Reason Description Errors::NOT_PUBLISHEDSlidingNonce::ESLIDING_NONCEA SlidingNonceresource is not published undertc_account.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_OLDThe sliding_nonceis too old and it's impossible to determine if it's duplicated or not.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_TOO_NEWThe sliding_nonceis too far in the future.Errors::INVALID_ARGUMENTSlidingNonce::ENONCE_ALREADY_RECORDEDThe sliding_noncehas been previously recorded.Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::REQUIRES_ROLERoles::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::INVALID_ARGUMENTFixedPoint32::EDENOMINATORnew_exchange_rate_denominatoris 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.Related Scripts
TreasuryComplianceScripts::update_dual_attestation_limitTreasuryComplianceScripts::update_minting_ability
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__UpdateExchangeRate(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` whose exchange rate is being updated. `Currency` must be an already-registered currency on-chain. | | `tc_account` | `signer` | The signer of the sending account of this transaction. Must be the Treasury Compliance account. | | `sliding_nonce` | `u64` | The `sliding_nonce` (see: `SlidingNonce`) to be used for the transaction. | | `new_exchange_rate_numerator` | `u64` | The numerator for the new to micro-XDX exchange rate for `Currency`. | | `new_exchange_rate_denominator` | `u64` | The denominator for the new to micro-XDX exchange rate for `Currency`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::NOT_PUBLISHED` | `SlidingNonce::ESLIDING_NONCE` | A `SlidingNonce` resource is not published under `tc_account`. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_OLD` | The `sliding_nonce` is too old and it's impossible to determine if it's duplicated or not. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_TOO_NEW` | The `sliding_nonce` is too far in the future. | | `Errors::INVALID_ARGUMENT` | `SlidingNonce::ENONCE_ALREADY_RECORDED` | The `sliding_nonce` has been previously recorded. | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::REQUIRES_ROLE` | `Roles::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::INVALID_ARGUMENT` | `FixedPoint32::EDENOMINATOR` | `new_exchange_rate_denominator` is zero. | | `Errors::INVALID_ARGUMENT` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. | | `Errors::LIMIT_EXCEEDED` | `FixedPoint32::ERATIO_OUT_OF_RANGE` | The quotient is unrepresentable as a `FixedPoint32`. | # Related Scripts * `TreasuryComplianceScripts::update_dual_attestation_limit` * `TreasuryComplianceScripts::update_minting_ability` """ currency: diem_types.TypeTag sliding_nonce: st.uint64 new_exchange_rate_numerator: st.uint64 new_exchange_rate_denominator: st.uint64Ancestors
Class variables
var currency :Â TypeTagvar new_exchange_rate_denominator :Â numpy.uint64var new_exchange_rate_numerator :Â numpy.uint64var sliding_nonce :Â numpy.uint64
class ScriptFunctionCall__UpdateMintingAbility (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_mintfield of theDiem::CurrencyInfo<Currency>resource published under0xA550C18to the value ofallow_minting. Minting of coins if allowed if this field is set totrueand minting of new coins inCurrencyis disallowed otherwise. This transaction needs to be sent by the Treasury Compliance account.Parameters
Name Type Description CurrencyType The Move type for the Currencywhose minting ability is being updated.Currencymust 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 Category Error Reason Description Errors::REQUIRES_ADDRESSCoreAddresses::ETREASURY_COMPLIANCEtc_accountis not the Treasury Compliance account.Errors::NOT_PUBLISHEDDiem::ECURRENCY_INFOCurrencyis not a registered currency on-chain.Related Scripts
TreasuryComplianceScripts::update_dual_attestation_limitTreasuryComplianceScripts::update_exchange_rate
Expand source code
@dataclass(frozen=True) class ScriptFunctionCall__UpdateMintingAbility(ScriptFunctionCall): """# 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 | Name | Type | Description | | ------ | ------ | ------------- | | `Currency` | Type | The Move type for the `Currency` whose minting ability is being updated. `Currency` must be an already-registered currency on-chain. | | `account` | `signer` | Signer of the sending account. Must be the Diem Root account. | | `allow_minting` | `bool` | Whether to allow minting of new coins in `Currency`. | # Common Abort Conditions | Error Category | Error Reason | Description | | ---------------- | -------------- | ------------- | | `Errors::REQUIRES_ADDRESS` | `CoreAddresses::ETREASURY_COMPLIANCE` | `tc_account` is not the Treasury Compliance account. | | `Errors::NOT_PUBLISHED` | `Diem::ECURRENCY_INFO` | `Currency` is not a registered currency on-chain. | # Related Scripts * `TreasuryComplianceScripts::update_dual_attestation_limit` * `TreasuryComplianceScripts::update_exchange_rate` """ currency: diem_types.TypeTag allow_minting: boolAncestors
Class variables
var allow_minting :Â boolvar currency :Â TypeTag