Skip to content

Commit

Permalink
Fix docs links and update block explorers (#69)
Browse files Browse the repository at this point in the history
* Adjusted formatting on various pages in docs, fixed small typos, fixed some broken links

* Changed button styles

* reorder block explorers

* update wallets section

* not devnet

* tokenfactory details

* closing

---------

Co-authored-by: Carson <[email protected]>
  • Loading branch information
mj850 and codebycarson authored May 27, 2024
1 parent c1a0fbd commit 69c0e89
Show file tree
Hide file tree
Showing 30 changed files with 184 additions and 102 deletions.
11 changes: 6 additions & 5 deletions components/EvmWalletConnect/CustomConnectButton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ import { ConnectButton } from "@rainbow-me/rainbowkit";
import styled from 'styled-components';

const CustomButton = styled.button`
background: #001B2A; /* Dark color */
border: none;
color: #ECDEDE; /* Light color */
background: black; /* Dark color */
border: white solid 1px;
color: white; /* Light color */
padding: 0.5rem 1rem;
font-size: 1rem;
cursor: pointer;
Expand All @@ -19,8 +19,9 @@ box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);
font-family: 'Inter', sans-serif;
&:hover {
color: #001B2A; /* Dark color */
background: #ECDEDE; /* Light color */
color: black; /* Dark color */
background: white; /* Light color */
border: black solid 1px;
}
`;

Expand Down
9 changes: 7 additions & 2 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,17 @@
"dev-gas": "Gas",
"dev-smart-contracts": "Smart Contracts",
"dev-frontend-dapps": "Frontend dApps",
"dev-ecosystem-providers": "Ecosystem & Providers",
"dev-tutorials": "Tutorials",
"dev-node": "Nodes",
"dev-validators": "Validators",
"dev-advanced-concepts": "Advanced Concepts",
"dev-resources": "Resources",
"-- Resources": {
"type": "separator",
"title": "Resources"
},
"dev-ecosystem-providers": "Ecosystem & Providers",
"resources-resources": "Resources",
"resources-tools-and-resources": "Tools",
"landing": {
"title": "Back to Sei ↗",
"type": "page",
Expand Down
3 changes: 2 additions & 1 deletion pages/dev-advanced-concepts/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@
"hd-path-coin-types": "HD Path & Coin Types",
"proposals": "Proposals",
"evm-rpc-endpoints": "EVM RPC Endpoints",
"interoperability": "Interoperability"
"interoperability": "Interoperability",
"differences-with-ethereum": "Differences from Ethereum"
}
5 changes: 5 additions & 0 deletions pages/dev-chains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,25 @@ The `pacific-1` chain is the mainnet of the Sei blockchain. It is the live, prod

- **Purpose**: Production environment for live applications.
- **Chain ID**: `pacific-1`
- **EVM Chain ID**: `1329` or `0x531`


- #### **Testnet**

The `atlantic-2` chain is the testnet of the Sei blockchain. It is used for testing and development purposes. Developers can deploy and test their dApps and smart contracts in a controlled environment that simulates the mainnet conditions. This chain is crucial for ensuring that applications work as expected before going live.

- **Purpose**: Testing and development environment.
- **Chain ID**: `atlantic-2`
- **EVM Chain ID**: `1328` or `0x530`


- #### **Devnet**

The `arctic-1` chain is the devnet of the Sei blockchain. It serves as a development network for early-stage testing and experimentation. This chain is typically used by developers to test new features, perform integration testing, and develop prototypes in an isolated environment.

- **Purpose**: Early-stage development and experimentation.
- **Chain ID**: `arctic-1`
- **EVM Chain ID**: `713715` or `0xAE3F3`

- #### **Local Chains**

Expand Down
15 changes: 11 additions & 4 deletions pages/dev-ecosystem-providers/bridges.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,18 @@

Bridges facilitate cross-chain transfers and interoperability between different blockchains. Key bridges for Sei are:

- **Squid**: Enables one-click cross-chain swaps across various EVM blockchains.
## **Squid**:
Enables one-click cross-chain swaps across various EVM blockchains.
- [Squid](https://blockworks.co/news/squid-one-click-cross-chain-swaps-cosmos)
- **Wormhole**: A popular bridge for transferring assets across multiple blockchains.

## **Wormhole**:
A popular bridge for transferring assets across multiple blockchains.
- [Wormhole](https://wormholenetwork.com/)
- **Axelar**: Provides secure cross-chain communication for Web3.

## **Axelar**:
Provides secure cross-chain communication for Web3.
- [Axelar](https://axelar.network/)
- **Stargate (coming soon)**: Facilitates seamless cross-chain transactions.

## **Stargate (coming soon)**:
Facilitates seamless cross-chain transactions.
- [Stargate](https://stargate.finance/)
13 changes: 9 additions & 4 deletions pages/dev-ecosystem-providers/centralized-exchanges.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

Centralized exchanges enable users to trade Sei tokens with ease. Some major exchanges supporting Sei are:

- **Coinbase**: [Coinbase](https://www.coinbase.com/)
- **Binance**: [Binance](https://www.binance.com/)
- **KuCoin**: [KuCoin](https://www.kucoin.com/)
- And more
## **Coinbase**:
[Coinbase](https://www.coinbase.com/)

## **Binance**:
[Binance](https://www.binance.com/)

## **KuCoin**:
[KuCoin](https://www.kucoin.com/)
### And more
2 changes: 1 addition & 1 deletion pages/dev-ecosystem-providers/ecosystem-map.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

For a comprehensive view of the Sei ecosystem and its various providers, refer to the ecosystem map.

- [Ecosystem Map](https://www.sei.io/ecosystem)
## [Sei Ecosystem Map](https://www.sei.io/ecosystem)
30 changes: 25 additions & 5 deletions pages/dev-ecosystem-providers/explorers.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
import { Tabs } from "nextra/components";

# Explorers

Blockchain explorers allow users to view transactions, blocks, and other network activities. Here are the main explorers for Sei:

- **SeiTrace**: A comprehensive explorer for tracking transactions and activities on the Sei blockchain.
- [SeiTrace](https://seitrace.com/)
- **SeiScan**: Provides detailed views of the Sei mainnet and testnets.
- [Pacific-1 (Mainnet)](https://www.seiscan.app/pacific-1)
- [Atlantic-2 (Testnet)](https://www.seiscan.app/atlantic-2)
## Sei Explorers

<Tabs items={["devnet (arctic-1)", "testnet (atlantic-2)", "mainnet (pacific-1)"]}>
<Tabs.Tab>
- [Seistream](https://devnet.seistream.app/)
- [Seitrace](https://seitrace.com/?chain=arctic-1)

</Tabs.Tab>
<Tabs.Tab>

- [Seistream](https://testnet.seistream.app/)
- [Seitrace](https://seitrace.com/?chain=atlantic-2)
- [Seiscan](https://www.seiscan.app/atlantic-2)

</Tabs.Tab>
<Tabs.Tab>

- [Seistream](https://seistream.app/)
- [Seitrace](https://seitrace.com/?chain=pacific-1)
- [Seiscan](https://www.seiscan.app/pacific-1)

</Tabs.Tab>
</Tabs>
9 changes: 6 additions & 3 deletions pages/dev-ecosystem-providers/faucets.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Faucets

Faucets provide free tokens to developers for testing purposes. Sei offers faucets for its testnets:
Faucets provide free tokens to developers for testing purposes. Sei offers faucets for testnet and devnet:

- **Sei App Faucet**: Available for the Atlantic-2 and Arctic-1 testnets.
## **Sei App Faucet**:
Available for the Atlantic-2 and Arctic-1 networks.
- [Atlantic-2 Faucet](https://atlantic-2.app.sei.io/faucet)
- [Arctic-1 Faucet](https://arctic-1.app.sei.io/faucet)
- Compass wallet: This wallet has integrated a faucet directly into the wallet for a very easy user experience.

## **Compass wallet**:
This wallet has integrated a faucet directly into the wallet for a very easy user experience.
6 changes: 4 additions & 2 deletions pages/dev-ecosystem-providers/indexers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

Indexers collect and organize blockchain data, making it easier to query and analyze. Key indexers for Sei include:

- **Flipside**: Provides detailed blockchain analytics and insights.
## **Flipside**:
Provides detailed blockchain analytics and insights.
- [Flipside](https://flipsidecrypto.xyz/)

- **The Graph (EVM only)**: Allows for querying blockchain data using GraphQL.
## **The Graph (EVM only)**:
Allows for querying blockchain data using GraphQL.
- [The Graph](https://thegraph.com/)
5 changes: 3 additions & 2 deletions pages/dev-ecosystem-providers/nfts.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# NFT’s

Lighthouse and Webump help with minting and managing of NFTs.
The following providers provide helpful tools for creating and managing NFT projects on Sei.

- **Lighthouse/Webump**
## **Lighthouse/Webump**
Lighthouse is a helpful tool for creating NFT projects.
- [Link](https://webump.xyz/)
2 changes: 1 addition & 1 deletion pages/dev-ecosystem-providers/oracles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

Oracles provide external data to smart contracts, enabling more dynamic and responsive applications. Notable oracles for Sei include:

- **Pyth**
## **Pyth**
- [Pyth Documentation](https://docs.pyth.network/home)
12 changes: 9 additions & 3 deletions pages/dev-ecosystem-providers/rpc-providers.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# RPC Providers

RPC providers offer endpoints for developers to interact with the Sei blockchain. Some notable providers include:
RPC providers offer endpoints for developers to interact with the Sei blockchain, archive nodes, genesis files, and more. Some notable providers include:

- **Rhino**: Provides robust RPC services for seamless blockchain interactions.
## **Rhino**:
Provides robust RPC services for seamless blockchain interactions.
- [Rhino](https://rhinostake.com/#)

- **Quicknode**: A a trusted infrastructure partner for the Sei network, providing developers with powerful APIs and dedicated support to streamline their blockchain applications.
## **Quicknode**:
A trusted infrastructure partner for the Sei network, providing developers with powerful APIs and dedicated support to streamline their blockchain applications.
- [Quicknode](https://www.quicknode.com/)

## **Polkachu**:
Offers RPC/REST/gRPC, snapshot, genesis files, and more.
- [Polkachu](https://polkachu.com/networks/sei)
6 changes: 4 additions & 2 deletions pages/dev-ecosystem-providers/wallets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

Wallets are essential for managing assets and interacting with the Sei blockchain. Here are some recommended wallets:

- **Compass**: A Sei native wallet designed for seamless interaction with the Sei blockchain with both Cosmos and EVM support.
## **Compass**:
A Sei native wallet designed for seamless interaction with the Sei blockchain with both Cosmos and EVM support.
- [Compass Wallet](https://compasswallet.io/)

- **MetaMask**: A widely-used EVM-compatible wallet that supports custom chain configurations for Sei.
## **MetaMask**:
A widely-used EVM-compatible wallet that supports custom chain configurations for Sei.
- [MetaMask](https://metamask.io/)
2 changes: 1 addition & 1 deletion pages/dev-intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Sei provides precompile contracts that facilitate many common Cosmos calls via t
- **Bank Module**: For managing native token transfers (usei, Token Factory, IBC denoms).
- **Staking**: For delegating and managing delegations for both validators and delegators.
- **Governance**: For stakers and validators to participate in [governance](/general-governance) processes.
- **Oracles**: Access to native price feeder and the [broad provider ecosystem](/dev-ecosystem-providers/oracles).
- **Oracles**: Access to native price feeder and the [broad provider ecosystem](./dev-ecosystem-providers/oracles.mdx).
- **And More**

### Cross-Chain Token Functionality
Expand Down
2 changes: 1 addition & 1 deletion pages/dev-node/join-a-network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ rm -rf /root/.sei/config/genesis.json
Note: This step is not needed for fresh nodes.
```
### Update Configurations
Set up rpc servers for primary and secondary endpoints. You can use one of the RPC endpoints from the [RPC providers](../dev-ecosystem-providers/rpc-providers.mdx ) page.
Set up rpc servers for primary and secondary endpoints. You can use one of the RPC endpoints from the [RPC providers](../resources-tools-and-resources.mdx) page.
Set up trust height and trust hash. Each snapshot is created at a certain block height, and best practice here is to set the trust height to be earlier than the latest snapshot block height to avoid backward verifications.

#### Example: set trust height and hash to be the block height 10,000 earlier
Expand Down
5 changes: 0 additions & 5 deletions pages/dev-resources/_meta.json

This file was deleted.

2 changes: 1 addition & 1 deletion pages/dev-token-standards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Fungible tokens are digital assets that are interchangeable with one another and
- **ERC20**: The ERC20 standard defines a common set of rules for fungible tokens on EVM-based blockchains. These tokens can be transferred, approved, and queried using standard functions.
- **CW20**: The CW20 standard is the Cosmos equivalent of ERC20, providing similar functionalities for tokens on Cosmos-based blockchains.
- **Interoperability and Pointer Contracts**: Pointer contracts enable interoperability between ERC20 and CW20 tokens, allowing for seamless interaction between the two standards.
- [Pointer Contracts Documentation](https://v2.docs.sei.io/interoperability/pointer-contracts)
- [Pointer Contracts Documentation](/dev-tutorials/pointer-contracts)
- **Pointer Contract Registry**: A registry that keeps track of pointer contracts to facilitate interoperability.

### NFTs
Expand Down
4 changes: 2 additions & 2 deletions pages/dev-tutorials/evm-cli-tutorial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
You can query or send transactions to Sei easily via CLI once you have the `seid` command installed (see [Installing Seid](./installing-seid))

## Queries
If the machine you run these commands from are not running a node of the network, you'll need to append `--node http://url-to-sei-cosmos-rpc` to your command. Refer to the [Tools and Resources](../dev-resources/tools-and-resources.mdx) page for a list of RPC endpoints.
If the machine you run these commands from are not running a node of the network, you'll need to append `--node http://url-to-sei-cosmos-rpc` to your command. Refer to the [Tools and Resources](../resources-tools-and-resources.mdx) page for a list of RPC endpoints.

- `seid q evm sei-addr [some EVM address]`: Gets the associated Sei address of the queried EVM address, if it exists on-chain.
- `seid q evm evm-addr [some Sei address]`: Gets the associated EVM address of the queried Sei address, if it exists on-chain.
Expand All @@ -14,7 +14,7 @@ For "NATIVE" type, `pointee` would be the native denom name instead.
## Transactions
Sending transactions via CLI requires you to have keys added via `seid keys add`. You can then specify the key you want to use by appending `--from=[key name]` to your command.

If the machine you run these commands from are not a node of the network, you'd need to append `--evm-rpc http://url-to-sei-evm-rpc` to your command. Refer to the [Tools and Resources](../dev-resources/tools-and-resources.mdx) page for a list of RPC endpoints.
If the machine you run these commands from are not a node of the network, you'd need to append `--evm-rpc http://url-to-sei-evm-rpc` to your command. Refer to the [Tools and Resources](../resources-tools-and-resources.mdx) page for a list of RPC endpoints.

- `seid tx evm associate-address`: Associates the Sei address and EVM address on-chain for the sending key.
- `seid tx evm send [to EVM address] [amount in wei]`: Sends native tokens to the target EVM address.
Expand Down
3 changes: 3 additions & 0 deletions pages/dev-tutorials/pointer-contracts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -201,3 +201,6 @@ seid tx evm register-evm-pointer CW721 $CW721_TOKEN_ADDRESS --from=$SENDER --cha
- `--gas`: Specifies the maximum amount of gas that can be consumed by the transaction.
- `--fees`: Indicates the transaction fee.
- `--node`: Points to the specific Sei node RPC URL you're connecting to for transaction submission.

### For TokenFactory Tokens
Refer to the [Tokenfactory tutorial](./tokenfactory-tutorial.mdx) for details on how to create a tokenfactory denom and an associated pointer contract.
49 changes: 48 additions & 1 deletion pages/dev-tutorials/tokenfactory-tutorial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,51 @@ Understanding these arguments will help you execute the commands more confidentl
For detailed descriptions of these arguments, use `seid help` in the CLI.
</Callout>

## Updating Token Metadata

When creating a token, it is important to specify details regarding the denom amounts and aliases so your token can be correctly parsed on wallets and explorers.

### 1. Create Token Metadata file
Create a token metadata `json` file. The file below is an example metadata file for the Sei token.
```json
{
"name": "sei",
"description": "The native token of Sei.",
"denom_units": [
{
"denom": "usei",
"exponent": 0,
"aliases": [
"microsei"
],
},
{
"denom": "msei",
"exponent": 3,
"aliases": [
"millisei"
]
},
{
"denom": "sei",
"exponent": 6,
}
],
"base": "usei",
"display": "sei",
}
```

The `base` field denotes the smallest denom that this token can be represented in.
Note that if you intend to create a [pointer contract](#create-pointer-contract), the `denom_units` with the largest exponent will be used as the display denom. (`sei` in this case).

### 2. Set token metadata using seid
```sh
seid tx tokenfactory set-denom-metadata $METADATA_FILE --fees 20000usei -b block -y --from $ADDR
```

Replace `$METADATA_FILE` with the path to your metadata file created in step 1. and `$ADDR` with the address of the token admin.

## Minting Tokens

```bash copy
Expand Down Expand Up @@ -109,7 +154,7 @@ seid tx evm deploy-erc20 $DENOM $NAME $SYMBOL $DECIMAL --from=$ACCOUNT --evm-rpc
**Parameters**

- `DENOM`: The denomination of the token for which you want to create an ERC20 pointer. This should match the TokenFactory token you created.
- `DENOM`: The name you wish to assign to your ERC20 pointer token. It should match the name of the TokenFactory token.
- `NAME`: The name you wish to assign to your ERC20 pointer token. It should match the name of the TokenFactory token.
- `SYMBOL`: The symbol for your ERC20 pointer token. It should correspond with the symbol of the TokenFactory token.
- `DECIMAL`: The number of decimals for your ERC20 pointer token. This should align with the decimals of the TokenFactory token (typically 6).

Expand All @@ -120,6 +165,8 @@ seid tx evm deploy-erc20 $DENOM $NAME $SYMBOL $DECIMAL --from=$ACCOUNT --evm-rpc

Executing this command creates an ERC20 token and outputs the contract address. This token is linked to the TokenFactory token, meaning any activities involving this ERC20 token will also reflect on the state of the TokenFactory token and vice versa.

Note that if you wish to specify denoms on your ERC20 tokens, you will need to [set the token metadata](#updating-token-metadata) for the base tokenfactory token. The denom with the largest exponent will be used.

<Callout type="info">
Learn more about EVM interoperability and pointer contracts
[here](../interoperability/overview.mdx).
Expand Down
2 changes: 1 addition & 1 deletion pages/general-governance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ No, once you cast your vote, it is final and cannot be changed.
The minimum deposit required is 3500 Sei, but proposals can have higher thresholds for expedited processing.

**How do I view active proposals and vote results?**
Active proposals and vote results can be viewed on the [Sei App](https://app.sei.io/staking) or by querying the blockchain directly.
Active proposals and vote results can be viewed on the [Seiscan](https://www.seiscan.app/pacific-1/proposals) or by querying the blockchain directly using `seid`.
2 changes: 1 addition & 1 deletion pages/general-staking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Sei protocol incentivizes validators and delegators with staking rewards fro

Staking on Sei can be done through the Sei App, via the `seid` CLI, or even through REST or RPC calls.

- **Sei App**: [Staking](https://app.sei.io/staking)
- **Sei App**: [Staking](https://app.sei.io/stake)
- **seid CLI**: `seid tx staking [command] [flags]`
- **REST/RPC**: `GET/POST /staking/*`

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,7 @@ To support your development and testing efforts, we provide a range of public RP
node](/running-a-sei-node).
</Callout>

<Tabs items={["arctic-1 (EVM devnet)"]}>
<Tabs.Tab>

| Sei Native RPC Url | EVM RPC Url | Websocket Url |
| :--------------------------------- | :------------------------------------ | :--------------------------------- |
| https://rpc-arctic-1.sei-apis.com/ | https://evm-rpc-arctic-1.sei-apis.com | wss://evm-ws-arctic-1.sei-apis.com |

</Tabs.Tab>
</Tabs>

For more endpoint options, please visit our [chain registry](https://github.com/sei-protocol/chain-registry/blob/main/chains.json).
Please visit our [chain registry](https://github.com/sei-protocol/chain-registry/blob/main/chains.json) for an updated list of RPC endpoints.

## Other Important Contracts
<Tabs items={["Wrapped Sei", "LayerZero Endpoint", "USDC", "CW20 Pointer Code for ERC20", "CW721 Pointer Code for ERC721"]}>
Expand Down
Loading

0 comments on commit 69c0e89

Please sign in to comment.