Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
martin0995 authored Sep 2, 2024
1 parent 4934c3f commit 403c96f
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,17 @@ Edit the `config.js` file to include the chain IDs, contract addresses, and RPC
forge compile
```

## Deployment

To deploy the smart contracts:

```bash
npm run deploy
```

- You will be prompted to select the **`source`** and **`target`** chains for deployment
- The deployed contract addresses will be saved and updated in `deploy-config/contracts.json`

## Verify Token Attestation

Before initiating a cross-chain token transfer, it's recommended to check if the desired token is attested on the target chain. This ensures that the token can be successfully transferred.
Expand All @@ -64,17 +75,6 @@ Before initiating a cross-chain token transfer, it's recommended to check if the

The script will inform you if the token has been attested on the target chain, providing the wrapped token address if it exists.

## Deployment

To deploy the smart contracts:

```bash
npm run deploy
```

- You will be prompted to select the **`source`** and **`target`** chains for deployment.
- The deployed contract addresses will be saved and updated in `deploy-config/contracts.json`.

## Token Transfer

To initiate a token transfer across chains:
Expand All @@ -83,8 +83,8 @@ To initiate a token transfer across chains:
npm run transfer
```

- You will be prompted to select the **`source`** and **`target`** chains for the transfer.
- Provide the token address, recipient address on the target chain, and the amount to transfer.
- You will be prompted to select the **`source`** and **`target`** chains for the transfer
- Provide the token address, recipient address on the target chain, and the amount to transfer

## Recommended Test Setup: Transfer USDC

Expand Down

0 comments on commit 403c96f

Please sign in to comment.