-
Notifications
You must be signed in to change notification settings - Fork 48
docs(registry): add registry docs and monorepo doc updates #307
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.
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
Draft
codebycarson
wants to merge
1
commit into
main
Choose a base branch
from
pr/registry-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,59 @@ | ||||||
| --- | ||||||
| title: "Introduction" | ||||||
| description: "@sei-js/registry provides typed constants for Sei chain info, tokens, networks, IBC channels, and gas configuration" | ||||||
| icon: "database" | ||||||
| --- | ||||||
|
|
||||||
| ## Overview | ||||||
|
|
||||||
| The `@sei-js/registry` package provides fully typed TypeScript constants sourced from the official [Sei chain registry](https://github.com/sei-protocol/chain-registry) and the community [asset list](https://github.com/Sei-Public-Goods/sei-assetlist). Use it to access chain metadata, network endpoints, token lists, IBC channel info, and gas configuration without hardcoding values. | ||||||
|
|
||||||
| ## Key Exports | ||||||
|
|
||||||
| | Export | Description | | ||||||
| |---|---| | ||||||
| | `CHAIN_IDS` | Mainnet, testnet, and devnet chain ID strings | | ||||||
| | `CHAIN_INFO` | Core chain metadata (bech32 prefix, slip44, fee token, supported wallets) | | ||||||
| | `NETWORKS` | Network configs with RPC, REST, gRPC, EVM, and WebSocket endpoints | | ||||||
| | `TOKEN_LIST` | Community-maintained token list per network | | ||||||
| | `IBC_INFO` | IBC channel configurations per network | | ||||||
| | `GAS_INFO` | Gas denomination and pricing per network | | ||||||
|
Comment on lines
+13
to
+20
|
||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| <CodeGroup> | ||||||
|
|
||||||
| ```bash npm | ||||||
| npm install @sei-js/registry | ||||||
| ``` | ||||||
|
|
||||||
| ```bash yarn | ||||||
| yarn add @sei-js/registry | ||||||
| ``` | ||||||
|
|
||||||
| ```bash pnpm | ||||||
| pnpm add @sei-js/registry | ||||||
| ``` | ||||||
|
|
||||||
| ```bash bun | ||||||
| bun add @sei-js/registry | ||||||
| ``` | ||||||
|
|
||||||
| </CodeGroup> | ||||||
|
|
||||||
| ## Quick Example | ||||||
|
|
||||||
| ```typescript | ||||||
| import { CHAIN_IDS, NETWORKS, TOKEN_LIST } from "@sei-js/registry"; | ||||||
|
|
||||||
| // Get the mainnet chain ID | ||||||
| console.log(CHAIN_IDS.mainnet); // "pacific-1" | ||||||
|
|
||||||
| // Access mainnet RPC endpoints | ||||||
| const mainnet = NETWORKS["pacific-1"]; | ||||||
| console.log(mainnet.rpc[0].url); | ||||||
|
|
||||||
| // Find the SEI token on mainnet | ||||||
| const sei = TOKEN_LIST["pacific-1"].find((t) => t.symbol === "sei"); | ||||||
|
||||||
| const sei = TOKEN_LIST["pacific-1"].find((t) => t.symbol === "sei"); | |
| const sei = TOKEN_LIST["pacific-1"].find((t) => t.symbol === "SEI"); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new Testing section uses
pnpmcommands, but the Prerequisites section above still instructsyarn installand claims Yarn is the package manager. Since the repopackageManagerispnpm@9.0.0, these instructions are now contradictory. Align the prerequisites/install/build/test commands on a single package manager (or document both explicitly).