Skip to content

Commit

Permalink
V3 docs (#416)
Browse files Browse the repository at this point in the history
* modify xcm sdk usage page

* -wip- mrl sdk docs

* -wip- how to use mrl

* -wip- use mrl pag4e

* -wip- mrl reference

* -wip- xcm reference docs

* -wip- reference adjustments

* -wip- contribute pages

* -wip- contribute xcm

* add comment

* contribute mrl page

* fix references

* move mrl config to MRL interfaces

* handle most TODOs

* fix link

* add Asset routes docs

* move MoonChain interfaces to MRL file

* -wip- adapt home page with MRL package and delete old pages

* adjust sizing home page

* changes after final review

* fix lint error

* Update mkdocs/docs/contribute/mrl.md

Co-authored-by: Richard <[email protected]>

* Update mkdocs/docs/example-usage/xcm.md

Co-authored-by: elmar <[email protected]>

* Update mkdocs/docs/example-usage/xcm.md

Co-authored-by: elmar <[email protected]>

* Update mkdocs/docs/contribute/mrl.md

Co-authored-by: Richard <[email protected]>

* change cloning to forking and fix linting

* specify that chain keys are allowed

* adjust type logic to prevent function duplication and Type casting in Mrl Asset Routes

* fixes in docs and in imports

---------

Co-authored-by: Richard <[email protected]>
Co-authored-by: elmar <[email protected]>
  • Loading branch information
3 people authored Jan 24, 2025
1 parent 34d1b39 commit 55e3dfb
Show file tree
Hide file tree
Showing 25 changed files with 4,934 additions and 3,636 deletions.
2 changes: 1 addition & 1 deletion examples/mrl-simple/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ import {
moonbaseAlpha,
peaqAlphanet,
} from '@moonbeam-network/xcm-config';
import type { EvmSigner } from '@moonbeam-network/xcm-sdk';
import { type Asset, EvmChain, Parachain } from '@moonbeam-network/xcm-types';
import { Keyring } from '@polkadot/api';
import { cryptoWaitReady } from '@polkadot/util-crypto';
import { http, type Address, createWalletClient } from 'viem';
import { privateKeyToAccount } from 'viem/accounts';
import type { EvmSigner } from '../../packages/sdk/build';

const { EVM_PRIVATE_KEY, POLKADOT_PRIVATE_KEY } = process.env;

Expand Down
3 changes: 2 additions & 1 deletion examples/mrl-simple/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"@moonbeam-network/mrl": "workspace:*",
"@moonbeam-network/xcm-config": "workspace:*",
"@moonbeam-network/xcm-types": "workspace:*",
"@moonbeam-network/xcm-utils": "workspace:*"
"@moonbeam-network/xcm-utils": "workspace:*",
"@moonbeam-network/xcm-sdk": "workspace:*"
},
"devDependencies": {
"bun": "^1.1.31"
Expand Down
5 changes: 3 additions & 2 deletions mkdocs/docs/.pages
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
nav:
- 'index.md'
- 'SDK Reference': 'reference'
- 'Using the XCM SDK': 'example-usage.md'
- 'Contribute': 'contribute.md'
- 'Using the SDK': 'example-usage'
- 'Contribute': 'contribute'

Loading

0 comments on commit 55e3dfb

Please sign in to comment.