lib.ft4.core.accounts.strategies.transfer

Types

account_creation_state

Allows to discern what was the last action on an accountcreationtransfer.

account_creation_transfer

Represents a transfer that had a non-existing recipient, for which at least one rule was

fee_asset

Represents an asset that will be paid for a new account registration

module_args

The configuration defined in the chromia.yml file.

module_args_list_element

The moduleargs for this module accept a list of multiple entries. This represents

pending_transfer_expiration_state

Status of a transfer that was made to a non-existing account for its creation.

pending_transfer_filter

When querying for pending transfers, this can be used to filter responses.

Functions

collect_pooled_assets

Moves the assets from the pool account where they were stored to the newly registered

do_transfer

Sends all assets that were sent to the pool account for a registration to the actual account

ensure_chain_fee_account

Returns the fee account for this chain, creating it if needed.

ensure_chain_pool_account

Returns the pool account for this chain, creating it if needed.

ensure_fee_account

Returns the fee account for a chain, creating it if needed. This function should not

ensure_pool_account

Returns the pool account for a chain, creating it if needed. This function should not

filter_account_creation_transfer

Utility for getpendingtransferstrategies. Returns whether an

find_allowed_assets

Finds all assets that a certain sender on a certain chain can send to the specified account

find_allowed_rules

Returns all rules on this chain that can be used to register an account given the parameters

get_allowed_assets

Retrieves a list of assets that are allowed for account creation on this chain, given the

get_config

Retrieves all rules following which a transfer can be used to register a new account.

get_pending_transfer_strategies

Retrieves all accountcreationtransfers that are pending (that is, not recalled nor

get_transfer_rules

Returns a list of rules representing all conditions under which assets can be transferred

has_create_transfer_timed_out

Checks whether the transfer has timed out. This means the transfer would have satisfied

has_pending_create_account_transfer_for_strategy

Returns whether a certain pending accountcreationtransfer exists, which means that

has_tx_expired

Utility function which returns whether a transaction has expired, given the rule it was

is_asset_amount_allowed

Utility function which returns whether a rule allows a certain amount of an asset to be sent

is_blockchain_allowed

Utility function which returns whether a rule allows a certain blockchainrid as sender.

is_recipient_allowed

Utility function which returns whether a rule allows a certain account ID as recipient.

is_sender_allowed

Utility function which returns whether a rule allows a certain account ID as sender.

is_strategy_active

Utility function which returns whether a rule allows a certain registration strategy.

is_value_allowed

Utility function which returns whether a value is allowed by a certain allowlist.

parse_fee_asset

Parses a dictionary retrieved from the moduleargs of a module and returns the

parse_fee_assets

Parses the moduleargs for a module, where the value contained is a list of feeassets.

pool_assets

This method ensures that a rule exists for the transfer defined by the parameters passed,

pool_assets_with_rules

Creates an accountcreationtransfer entity given its parameters.

recall_transfer

Marks a specific accountcreationtransfer that has expired as recalled.

required_signers

Returns the required signers for a registeraccount operation in

resolve_allowed_assets

Finds all assets that a certain rule allows for account registration.

resolve_fee_assets

Parses a list of feeassets, and returns a map of all the ones that could be mapped to

Properties

_CONFIG_ERROR_TEXT_TEMPLATE

A starting string for configuration errors in strategies using payments

ACCOUNT_TYPE_POOL

Constant that represents the account type used to temporarily store assets of transfers

ACCOUNT_TYPE_FEE

Constant that represent the account type used to store fees charged during account