Skip to content

chore(xrpl): remove token instance registration script & update guides #1064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 9, 2025
Merged

chore(xrpl): remove token instance registration script & update guides #1064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cb899d
chore(xrpl): remove register-token-instance script
k4m4 Oct 1, 2025
57fab00
chore(docs): remove token instance registration step from XRPL guides
k4m4 Oct 1, 2025
f2769a6
Merge branch 'main' into chore/remove-xrpl-register-token-instance
isi8787 Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions xrpl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,20 +474,6 @@ Here's an example:
ts-node xrpl/register-remote-token.js -e devnet-amplifier -n xrpl-dev --tokenId d059cbf3cf520f4d96064e094cb5e8fbb501bc4744034a5ca840dc2beb658aaa --currency FOO
```

### Register Token Instance

Add support for bridging a token from/to some remote chain. Decimals should be set to the decimal representation of the relevant token on the given remote chain.

```bash
ts-node xrpl/register-token-instance.js -e <env> -n <chain-name> --tokenId <token-id> --sourceChain <source-chain> --decimals <token-decimals>
```

Here's an example:

```bash
ts-node xrpl/register-token-instance.js -e devnet-amplifier -n xrpl-dev --tokenId fc00a5a83e7c6814a85ba59222e35a15a3c2b45b318b3c837e5c4aafc0b301ca --sourceChain xrpl-evm-devnet --decimals 6
```

### Register Token Metadata

Register an XRPL token's metadata on ITS Hub.
Expand Down
12 changes: 1 addition & 11 deletions xrpl/docs/deploy-local-token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,17 +144,7 @@ Note that manual executation of the proof might be necessary if relayer fails to
ts-node evm/gateway.js -n <destination chain> --action execute --messageId $MESSAGE_ID --sourceChain axelar --sourceAddress <itsHubAddress> --destination <destination gateway contract address> --payload 0x$PAYLOAD
```

### 8. Token Instance Registration

Once both legs of the remote token deployment have succeeded, register the token instance
to enable bridging this newly-deployed token between XRPL and the remote destination chain.
Note that XRPL tokens are always deployed to remote chains with `15` decimals of precision.

```bash
ts-node xrpl/register-token-instance.js --tokenId $TOKEN_ID --sourceChain $DESTINATION_CHAIN --decimals 15
```

Repeat steps 4-8 for every `DESTINATION_CHAIN` that you want the XRPL token to be deployed to.
Repeat steps 4-7 for every `DESTINATION_CHAIN` that you want the XRPL token to be deployed to.

## Cross-Chain Transfer Testing

Expand Down
11 changes: 0 additions & 11 deletions xrpl/docs/deploy-remote-token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,6 @@ Once the first leg of the remote token deployment has succeeded, register the re
ts-node xrpl/register-remote-token.js -n $DESTINATION_CHAIN --tokenId $TOKEN_ID --currency $XRPL_CURRENCY_CODE
```

### 3. XRPL Token Instance Registration

Finally, register the token instance on the `XRPLGateway` contract to enable transferring this newly-deployed token between the remote source chain and XRPL.

```bash
ts-node xrpl/register-token-instance.js -n $DESTINATION_CHAIN --tokenId $TOKEN_ID --sourceChain $SOURCE_CHAIN --decimals $DECIMALS
```

To be able to transfer this token from the XRPL directly to other chains where the token has been deployed to,
re-run the token instance registration script, passing the relevant chain as source chain and the decimals that the token has been deployed with on that chain.

## Cross-Chain Transfer Testing

To test the newly deployed token, refer to [2025-02-v.1.0.0.md](../../releases/xrpl/2025-02-v.1.0.0.md).
Expand Down
13 changes: 2 additions & 11 deletions xrpl/docs/link-token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,22 +142,13 @@ GAS_FEE=
ts-node evm/interchainTokenFactory.js -n $SOURCE_CHAIN --action linkToken --destinationChain $DESTINATION_CHAIN --destinationTokenAddress $XRPL_TOKEN_ADDRESS --tokenManagerType $TOKEN_MANAGER_TYPE --linkParams $OPERATOR --salt $SALT --gasValue $GAS_FEE
```

### 6. XRPL Token Instance Registration

**_NOTE:_**
The decimal precision of `15` is hardcoded to avoid double scaling between the XRPL contracts and ITS Hub. Future release of XRPL contracts will use the ITS Hub instance directly.

```bash
ts-node xrpl/register-token-instance.js -n $DESTINATION_CHAIN --tokenId $TOKEN_ID --sourceChain $SOURCE_CHAIN --decimals 15
```

### 7. XRPL Remote Token Registration
### 6. XRPL Remote Token Registration

```bash
ts-node xrpl/register-remote-token.js -n $DESTINATION_CHAIN --tokenId $TOKEN_ID --currency $XRPL_CURRENCY_CODE
```

## 8. Grant Mint Role to Token Manager
## 7. Grant Mint Role to Token Manager

After linking is complete, if you selected the `MintBurn` token manager type, then it is necessary to
grant the token manager minting and burning permissions. Since this logic is token-specific, you'll need to determine the right method to execute for your token.
Expand Down
56 changes: 0 additions & 56 deletions xrpl/register-token-instance.js
View file
Open in desktop

This file was deleted.