Skip to content

Commit

Permalink
feat : update readme and test code
Browse files Browse the repository at this point in the history
  • Loading branch information
SonYoungsung committed Feb 26, 2024
1 parent 21c89a5 commit 6ed1568
Show file tree
Hide file tree
Showing 5 changed files with 25,425 additions and 25,333 deletions.
21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ npm install tokamak-multichain
```javascript
import { MultiChainSDK } from 'tokamak-multichain'

const sdk = new MultiChainSDK({
const TokamakSDK = new MultiChainSDK({
chainId: 55004,
})
const tokenList = sdk.tokens
const tokenList = TokamakSDK.tokens
// Output the structure of the tokenList
console.log('Token List:', tokenList)
console.log('Token List : ', tokenList)

/*
The structure of the tokenList
tokenList = [
Token List : [
{
chainId: 55004,
address: '0x7c6b91D9Be155A6Db01f749217d76fF02A7227F2',
Expand Down Expand Up @@ -89,7 +89,7 @@ console.log('L2Messenger : ', L2Messenger)

You can try out the tokamak-multichain package in an online environment using CodeSandbox. Click the button below to open the project in CodeSandbox:

[![Open in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/devbox/example-tokamak-multichain-v799tz?file=%2Findex.js%3A14%2C1&layout=%257B%2522sidebarPanel%2522%253A%2522EXPLORER%2522%252C%2522rootPanelGroup%2522%253A%257B%2522direction%2522%253A%2522horizontal%2522%252C%2522contentType%2522%253A%2522UNKNOWN%2522%252C%2522type%2522%253A%2522PANEL_GROUP%2522%252C%2522id%2522%253A%2522ROOT_LAYOUT%2522%252C%2522panels%2522%253A%255B%257B%2522type%2522%253A%2522PANEL_GROUP%2522%252C%2522contentType%2522%253A%2522UNKNOWN%2522%252C%2522direction%2522%253A%2522vertical%2522%252C%2522id%2522%253A%2522clru959b30006356ke6yf2s5n%2522%252C%2522sizes%2522%253A%255B70%252C30%255D%252C%2522panels%2522%253A%255B%257B%2522type%2522%253A%2522PANEL_GROUP%2522%252C%2522contentType%2522%253A%2522EDITOR%2522%252C%2522direction%2522%253A%2522horizontal%2522%252C%2522id%2522%253A%2522EDITOR%2522%252C%2522panels%2522%253A%255B%257B%2522type%2522%253A%2522PANEL%2522%252C%2522contentType%2522%253A%2522EDITOR%2522%252C%2522id%2522%253A%2522clru959b20002356kacumgm7l%2522%257D%255D%257D%252C%257B%2522type%2522%253A%2522PANEL_GROUP%2522%252C%2522contentType%2522%253A%2522SHELLS%2522%252C%2522direction%2522%253A%2522horizontal%2522%252C%2522id%2522%253A%2522SHELLS%2522%252C%2522panels%2522%253A%255B%257B%2522type%2522%253A%2522PANEL%2522%252C%2522contentType%2522%253A%2522SHELLS%2522%252C%2522id%2522%253A%2522clru959b20004356ku66ul83r%2522%257D%255D%252C%2522sizes%2522%253A%255B100%255D%257D%255D%257D%252C%257B%2522type%2522%253A%2522PANEL_GROUP%2522%252C%2522contentType%2522%253A%2522DEVTOOLS%2522%252C%2522direction%2522%253A%2522vertical%2522%252C%2522id%2522%253A%2522DEVTOOLS%2522%252C%2522panels%2522%253A%255B%257B%2522type%2522%253A%2522PANEL%2522%252C%2522contentType%2522%253A%2522DEVTOOLS%2522%252C%2522id%2522%253A%2522clru959b20005356k70xqu7d7%2522%257D%255D%252C%2522sizes%2522%253A%255B100%255D%257D%255D%252C%2522sizes%2522%253A%255B50%252C50%255D%257D%252C%2522tabbedPanels%2522%253A%257B%2522clru959b20002356kacumgm7l%2522%253A%257B%2522id%2522%253A%2522clru959b20002356kacumgm7l%2522%252C%2522activeTabId%2522%253A%2522clru98zes0002356kujrtt06c%2522%252C%2522tabs%2522%253A%255B%257B%2522id%2522%253A%2522clru959b20001356kb3l80m92%2522%252C%2522mode%2522%253A%2522permanent%2522%252C%2522type%2522%253A%2522FILE%2522%252C%2522filepath%2522%253A%2522%252FREADME.md%2522%252C%2522state%2522%253A%2522IDLE%2522%257D%252C%257B%2522id%2522%253A%2522clru98zes0002356kujrtt06c%2522%252C%2522mode%2522%253A%2522permanent%2522%252C%2522type%2522%253A%2522FILE%2522%252C%2522initialSelections%2522%253A%255B%257B%2522startLineNumber%2522%253A14%252C%2522startColumn%2522%253A1%252C%2522endLineNumber%2522%253A14%252C%2522endColumn%2522%253A1%257D%255D%252C%2522filepath%2522%253A%2522%252Findex.js%2522%252C%2522state%2522%253A%2522IDLE%2522%257D%252C%257B%2522type%2522%253A%2522FILE%2522%252C%2522filepath%2522%253A%2522%252Fnode_modules%252F%2522%252C%2522id%2522%253A%2522clruaiz6200q5356kt0buyfh5%2522%252C%2522mode%2522%253A%2522permanent%2522%252C%2522state%2522%253A%2522IDLE%2522%257D%255D%257D%252C%2522clru959b20005356k70xqu7d7%2522%253A%257B%2522id%2522%253A%2522clru959b20005356k70xqu7d7%2522%252C%2522tabs%2522%253A%255B%257B%2522id%2522%253A%2522clru959b20003356k6t2j46og%2522%252C%2522mode%2522%253A%2522permanent%2522%252C%2522type%2522%253A%2522TASK_LOG%2522%252C%2522taskId%2522%253A%2522start%2522%257D%255D%252C%2522activeTabId%2522%253A%2522clru959b20003356k6t2j46og%2522%257D%252C%2522clru959b20004356ku66ul83r%2522%253A%257B%2522id%2522%253A%2522clru959b20004356ku66ul83r%2522%252C%2522activeTabId%2522%253A%2522clru9vsue00c3356k9vbq1dfk%2522%252C%2522tabs%2522%253A%255B%257B%2522id%2522%253A%2522clru9vsue00c3356k9vbq1dfk%2522%252C%2522mode%2522%253A%2522permanent%2522%252C%2522type%2522%253A%2522TERMINAL%2522%252C%2522shellId%2522%253A%2522clru9vu6p00jbdqg62mi5dg8y%2522%257D%255D%257D%257D%252C%2522showDevtools%2522%253Atrue%252C%2522showShells%2522%253Atrue%252C%2522showSidebar%2522%253Atrue%252C%2522sidebarPanelSize%2522%253A15%257D)
[![Open in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/live/943669f4-e3cb-4ef7-96ad-e5ac2efc0202?file=%2Findex.js%3A5%2C23)

This CodeSandbox project includes a basic setup with the @titan/sdk package. You can explore and experiment with the functionalities in a live environment.

Expand All @@ -98,17 +98,6 @@ This CodeSandbox project includes a basic setup with the @titan/sdk package. You
- If you want to add a token or change to the token list, refer to [the contracts documentation](https://github.com/tokamak-network/tokamak-multichain/blob/main/tokens/README.md).
- If you want to add a contract or change to the contract list, refer to [the tokens documentation](https://github.com/tokamak-network/tokamak-multichain/blob/main/contracts/README.md).

## Directory Structure

```
├── contracts:
├── tokens:
├── bin:
├── test:
├── src
│ ├──
```

## Production branch

The production branch is "main". This branch holds the codebase for the most recent "stable" releases. Any changes made to the main branch are initially integrated from the develop branch.
Expand Down
Loading

0 comments on commit 6ed1568

Please sign in to comment.