Module pallet_transfer_allowlist::pallet

The pallet module in each FRAME pallet hosts the most important items needed to construct this pallet.

The main components of this pallet are:

• Pallet, which implements all of the dispatchable extrinsics of the pallet, among other public functions.
  • The subset of the functions that are dispatchable can be identified either in the dispatchables module or in the Call enum.
• storage_types, which contains the list of all types that are representing a storage item. Otherwise, all storage items are listed among Type Definitions.
• Config, which contains the configuration trait of this pallet.
• Event and Error, which are listed among the Enums.

Re-exports

• pub use __tt_error_token_1 as tt_error_token;
• pub use __tt_default_parts_7 as tt_default_parts;
• pub use __tt_extra_parts_7 as tt_extra_parts;

Modules

• dispatchables
  Auto-generated docs-only module listing all defined dispatchables for this pallet.
• storage_types
  Auto-generated docs-only module listing all (public and private) defined storage types for this pallet.

Structs

• AllowanceDetails
  Struct to define when a transfer should be allowed from the sender, receiver, and currency combination. Transfer allowed time set by range of block numbers Defaults to allowed_at starting at 0, and blocked_at ending at MAX block value as per Default impl. Current block must be between allowed at and blocked at for transfer to be approved if allowance for sender/currency/receiver present.
• AllowanceMetadata
  Metadata values used to track and manage Allowances for a sending Account/Currency combination. contains the number of allowances/presence of existing allowances for said combination, as well as whether a delay is set for the allowance to take effect, and if–and then when–a delay is modifiable.
• Pallet
  The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Enums

• Call
  Contains a variant per dispatchable extrinsic that this pallet has.
• Error
  The Error enum of this pallet.
• Event
  The Event enum of this pallet
• HoldReason
  A reason for this pallet placing a hold on funds.

Constants

• STORAGE_VERSION
  The current storage version.

Traits

• Config
  Configuration trait of this pallet.

Type Aliases

• AccountCurrencyTransferAllowance
  Storage item for allowances specified for a sending account, currency type and receiving location
• AccountCurrencyTransferCountDelay
  Storage item containing number of allowances set, delay for sending account/currency, and block number delay is modifiable at. Contains an instance of AllowanceMetadata with allowance count as u64, current_delay as Option<BlockNumberFor<T>>, and modifiable_at as Option<BlockNumberFor<T>>. If a delay is set, but no allowances have been created, allowance_count will be set to 0. A double map is used here as we need to know whether there is a restriction set for the account and currency in the case where there is no allowance for destination location. Using an StorageNMap would not allow us to look up whether there was a restriction for the sending account and currency, given that:
• AllowanceDetailsOf
  AllowanceDetails where BlockNumber is of type BlockNumberFor<T>
• DepositBalanceOf
  Balance type for the reserve/deposit made when creating an Allowance
• ModuleDeprecated
  Type alias to Pallet, to be used by construct_runtime.
• ReasonOf
  Resons for holding as defined by the fungible::hold::Inspect trait