Skip to content

Commit

Permalink
change cloning to forking and fix linting
Browse files Browse the repository at this point in the history
  • Loading branch information
mmaurello committed Jan 23, 2025
1 parent a8bc147 commit 76e8769
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
23 changes: 11 additions & 12 deletions mkdocs/docs/contribute/mrl.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ template: tutorial.html

## Get Started

To contribute to the MRL SDK, you'll first need to clone the GitHub repository:
To contribute to the MRL SDK, you'll first need to fork the [GitHub repository](https://github.com/moonbeam-foundation/xcm-sdk){target=\_blank}, and then clone the repository to your local machine.

```bash
git clone git@github.com:moonbeam-foundation/mrl.git
git clone https://github.com/YOUR_GITHUB_USERNAME/xcm-sdk.git
```

Then, install dependencies:
Expand All @@ -30,9 +30,9 @@ The next step to support an asset integration is to add chain information for th

To add a chain, take the following steps:

1. Open the `xcm-sdk/packages/config/src/chains.ts` file
2. Add your asset to the list of imported assets from the assets configuration file (`./assets.ts`)
3. Create a new variable for each chain if an entry doesn't already exist. You'll need to create a [Chain Object](../reference/xcm.md#the-chain-object), providing metadata related to the chain
1. Open the `xcm-sdk/packages/config/src/chains.ts` file
2. Add your asset to the list of imported assets from the assets configuration file (`./assets.ts`)
3. Create a new variable for each chain if an entry doesn't already exist. You'll need to create a [Chain Object](../reference/xcm.md#the-chain-object), providing metadata related to the chain

=== "Parachain"

Expand All @@ -48,9 +48,7 @@ To add a chain, take the following steps:
parachainId: INSERT_PARACHAIN_ID,
ss58Format: INSERT_SS58_FORMAT,
ws: ['INSERT_WSS_ENDPOINTS'],
})

;
});
```

=== "EVM Parachain"
Expand All @@ -69,7 +67,7 @@ To add a chain, take the following steps:
ss58Format: INSERT_SS58_FORMAT,
rpc: 'INSERT_RPC_ENDPOINT',
ws: ['INSERT_WSS_ENDPOINTS'],
})
});
```

=== "EVM Chain"
Expand All @@ -87,7 +85,7 @@ To add a chain, take the following steps:
wh: {
name: 'INSERT_WORMHOLE_NAME',
}, // Optional - if using Wormhole for MRL
})
});
```

For example, this is the configuration for adding the Ethereum chain:
Expand All @@ -108,7 +106,7 @@ To add a chain, take the following steps:
});
```

4. Add the newly created chain to the `chainsList` array at the end of the file
4. Add the newly created chain to the `chainsList` array at the end of the file

!!! note
Chains are listed in alphabetical order. Please make sure you follow this order when adding new chains.
Expand Down Expand Up @@ -165,6 +163,7 @@ Note that the asset we're using is different in each chain, `usdt` in Ethereum a
## Configure a Chain Route

### Prerequisites

These steps are the same as the [XCM SDK](./xcm.md#configure-a-chain-route){target=\_blank}, but you'll need to create the builders for the MRL routes as well. So you'll need to know which pallet, method and provider you're using for the MRL routes.
Also, you'll need to know the [type of transfer](../reference/mrl.md#transfer-types){target=\_blank} you're using, as the builders will be different depending on the type of transfer.

Expand Down Expand Up @@ -377,4 +376,4 @@ export const hydrationRoutes = new MrlChainRoutes({
});
```

And that's it! You now know how to add new assets and chains and configure the chains that an asset can be sent to and from. To ensure that you've properly set everything up, read on to the next section.
And that's it! You now know how to add new assets and chains and configure the chains that an asset can be sent to and from. To ensure that you've properly set everything up, read on to the next section.
4 changes: 2 additions & 2 deletions mkdocs/docs/contribute/xcm.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ template: tutorial.html

## Get Started

To contribute to the XCM SDK, you'll first need to clone the GitHub repository:
To contribute to the XCM SDK, you'll first need to fork the [GitHub repository](https://github.com/moonbeam-foundation/xcm-sdk){target=\_blank}, and then clone the repository to your local machine.

```bash
git clone git@github.com:moonbeam-foundation/xcm-sdk.git
git clone https://github.com/YOUR_GITHUB_USERNAME/xcm-sdk.git
```

Then, install dependencies:
Expand Down

0 comments on commit 76e8769

Please sign in to comment.