# lib.ft4.core.assets · FT4 Rell API · Chromia Docs (concept)

> Types asset An asset represents anything that is fungible. It can be more than money, asset_filter Filter used for the query getassetsfiltered to fetch ass

Source: https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/

PACKAGE

# lib.ft4.core.assets

On this page

* [Types](#types)
* [Functions](#functions)
* [Properties](#properties)

## Types

[asset](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/asset/)
:   An asset represents anything that is fungible. It can be more than money,

[asset\_filter](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/asset_filter/)
:   Filter used for the query getassetsfiltered to fetch assets based on selected criteria

[balance](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/balance/)
:   Represents an account's holdings of a certain asset.

[balance\_filter](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/balance_filter/)
:   Filter used for the query getbalancesfiltered to fetch balances based on selected criteria

[crosschain\_transfer\_history\_entry](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/crosschain_transfer_history_entry/)
:   Represents the cross-chain movement of an asset on the origin or target chain.

[crosschain\_transfer\_history\_entry\_filter](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/crosschain_transfer_history_entry_filter/)
:   Filter used for the query getcrosschaintransferhistoryentriesfiltered to fetch balances entries on selected criteria

[filter](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/filter/)
:   Filter used in queries, which allows to fetch only one direction of transfer

[transfer\_detail](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/transfer_detail/)
:   Details about a transfer. It contains a limited set of information that can be used to

[transfer\_history\_entry](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/transfer_history_entry/)
:   Represents the movement of an asset in or out of an account.

[transfer\_history\_entry\_filter](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/transfer_history_entry_filter/)
:   Filter used for the query gettransferhistoryentriesfiltered to fetch entries based on selected criteria

[transfer\_type](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/transfer_type/)
:   The type of a transfer, used for filtering in queries

## Functions

[Asset](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/-asset/)
:   Returns the asset with the specified id as an entity.

[after\_burn](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/after_burn/)
:   Extendable function that allows the developer to add more functionality to the

[after\_mint](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/after_mint/)
:   Extendable function that allows the developer to add more functionality to the

[after\_transfer](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/after_transfer/)
:   Extendable function that allows the developer to add more functionality to the

[before\_burn](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/before_burn/)
:   Extendable function that allows the developer to add more functionality to the

[before\_mint](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/before_mint/)
:   Extendable function that allows the developer to add more functionality to the

[before\_transfer](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/before_transfer/)
:   Extendable function that allows the developer to add more functionality to the

[create\_on\_internal\_transfer](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/create_on_internal_transfer/)
:   Extendable function that defines how to create an account when an on-chain transfer to a

[deduct\_balance](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/deduct_balance/)
:   Removes a certain amount of money from an account. It does NOT update total supply,

[extract\_data\_from\_transfer\_history\_entry](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/extract_data_from_transfer_history_entry/)
:   Maps an entry's info into a readable format for the frontend

[extract\_data\_from\_transfer\_history\_list](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/extract_data_from_transfer_history_list/)
:   Takes a list of transfer history entries and builds a page that can be returned

[extract\_details\_from\_account\_creation\_transfer](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/extract_details_from_account_creation_transfer/)
:   Analogous to extractdetailsfromtransferhistoryentry, but extracts data from the

[extract\_details\_from\_crosschain\_transfer\_history\_entry](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/extract_details_from_crosschain_transfer_history_entry/)
:   Maps a crosschaintransferhistoryentry to a transferdetail object.

[extract\_details\_from\_transfer\_history\_entry](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/extract_details_from_transfer_history_entry/)
:   Maps a transferhistoryentry to a transferdetail object.

[extract\_operation\_name](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/extract_operation_name/)
:   Extracts the name of the operation that caused the transfer to happen.

[format\_amount\_with\_decimals](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/format_amount_with_decimals/)
:   Creates a readable string representing the amount of tokens, given the raw

[get\_all\_assets](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_all_assets/)
:   Retrieves all registered assets, paginated.

[get\_asset\_balance](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_asset_balance/)
:   Returns how much of an asset the account holds.

[get\_asset\_balances](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_asset_balances/)
:   Retrieves all asset balances for a certain account.

[get\_asset\_details\_for\_crosschain\_registration](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_asset_details_for_crosschain_registration/)
:   Outputs the details of an asset in a format that is used by other chains to register

[get\_assets\_by\_type](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_assets_by_type/)
:   Retrieves all assets of a specified type, paginated.

[get\_assets\_filtered](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_assets_filtered/)
:   Retrieves all assets based on the selected filter of assetfilter, paginated

[get\_balances\_filtered](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_balances_filtered/)
:   Retrieves all balances based on the selected filter of balancefilter, paginated

[get\_crosschain\_transfer\_history\_entries\_filtered](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_crosschain_transfer_history_entries_filtered/)
:   Retrieves all crosschain transfer history entries based on the provided filtering, paginated

[get\_paginated\_asset\_balances](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_paginated_asset_balances/)
:   Retrieves all the balances of a certain account, paginated.

[get\_paginated\_assets\_by\_name](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_paginated_assets_by_name/)
:   Retrieves all assets with the given name, paginated.

[get\_paginated\_assets\_by\_symbol](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_paginated_assets_by_symbol/)
:   Retrieves all assets with the given symbol, paginated.

[get\_paginated\_transfers](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_paginated_transfers/)
:   Fetches all transfers, allowing filtering in multiple ways. Paginated.

[get\_transfer\_details](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_transfer_details/)
:   Returns a transferdetail object for each transferentry that was registered during

[get\_transfer\_details\_by\_asset](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_transfer_details_by_asset/)
:   Same as gettransferdetails, but restricts the results to transfer entries related

[get\_transfer\_history\_entries\_filtered](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/get_transfer_history_entries_filtered/)
:   Fetches all transfer history entries allowing filtering in multiple ways, paginated.

[increase\_balance](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/increase_balance/)
:   Adds a certain amount of money to an account. It does NOT update total supply, extra

[is\_create\_on\_internal\_transfer\_enabled](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/is_create_on_internal_transfer_enabled/)
:   Extendable function that defines whether on-chain transfers towards an account that doesn't

[map\_asset](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/map_asset/)
:   Maps an asset's info into a readable format for the frontend.

[map\_balance](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/map_balance/)
:   Maps an balance info into a readable format for the frontend.

[parse\_icon\_url](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/parse_icon_url/)
:   Tests whether an asset icon URL is invalid. It will not try to resolve the URL, but it will

[recall\_on\_internal\_transfer](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/recall_on_internal_transfer/)
:   Extendable function that defines how to recall a transfer that was erroneously made

[require\_zero\_exclusive\_asset\_amount\_limits](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/require_zero_exclusive_asset_amount_limits/)
:   Ensures that an asset amount is in the interval (0; 2^256) (exclusive)

[validate\_asset\_decimals](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/validate_asset_decimals/)
:   Ensures that decimals are in the interval 0; 78 (inclusive)

[validate\_asset\_id](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/validate_asset_id/)
:   Ensures that the ID has exactly 32 bytes

[validate\_asset\_name](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/validate_asset_name/)
:   Ensures that the text input is at most 1024 characters long.

[validate\_asset\_symbol](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/validate_asset_symbol/)
:   Ensures that the text input is at most 1024 characters long.

[validate\_asset\_type](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/validate_asset_type/)
:   Ensures that the text input is not empty and at most 1024 characters long.

[validate\_asset\_uniqueness\_resolver](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/validate_asset_uniqueness_resolver/)
:   Ensures that the asset uniqueness resolver is at most 1024 bytes long.

## Properties

[ASSET\_TYPE\_FT4](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/-a-s-s-e-t_-t-y-p-e_-f-t4/)
:   The type of fungible assets. By default, assets created with this library will have

[max\_asset\_amount](https://docs.chromia.com/pages/ft4-rell/-f-t4-library/lib.ft4.core.assets/max_asset_amount/)
:   The maximum value that should ever be represented when talking about assets.

[View this page on docs.chromia.com](https://docs.chromia.com/pages/ft4-rell/-f-t4%20-library/lib.ft4.core.assets/index.html)Generated API reference, mirrored from the live docs
