Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Wizdave97 committed Oct 11, 2024
1 parent 7dddf4c commit c895449
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions modules/ismp/pallets/token-gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ This allows standalone chains or parachains make asset transfers to and from EVM

## Overview

The Pallet allows the [`AdminOrigin`](https://docs.rs/pallet-ismp/latest/pallet_ismp/pallet/trait.Config.html#associatedtype.AdminOrigin) configured in [`pallet-ismp`](https://docs.rs/pallet-ismp/latest/pallet_ismp) to dispatch calls for registering asset Ids
and also requesting the token gateway addresses from Hyperbridge.
The Pallet allows the [`AdminOrigin`](https://docs.rs/pallet-ismp/latest/pallet_ismp/pallet/trait.Config.html#associatedtype.AdminOrigin) configured in [`pallet-ismp`](https://docs.rs/pallet-ismp/latest/pallet_ismp) to dispatch calls for registering asset Ids.

## Adding to Runtime

Expand Down Expand Up @@ -67,12 +66,12 @@ The pallet requires some setting up before the teleport function is available fo

## Dispatchable Functions

- `teleport` - This function is used to bridge assets to through Hyperbridge.
- `teleport` - This function is used to bridge assets through Hyperbridge.
- `set_token_gateway_addresses` - This call allows the `AdminOrigin` origin to set the token gateway address for EVM chains.
- `create_erc6160_asset` - This call dispatches a request to Hyperbridge to create multi chain native assets on token gateway deployments

## Asset creation
When creating assets, the metadata needs to be set, the account set as the admin is the pallet account, depending on the fungibles implementation,
When creating assets, the metadata needs to be set, the account set as the asset owner is the pallet account, depending on the fungibles implementation,
funding the pallet account might be required for the asset creation to succeed.

## License
Expand Down

0 comments on commit c895449

Please sign in to comment.