From 71f9b1b78732090f187857e74877b37a58c429e8 Mon Sep 17 00:00:00 2001 From: Philip Su Date: Tue, 16 Jan 2024 16:31:23 -0800 Subject: [PATCH 1/2] Add user and dev content --- .gitignore | 1 + pages/_meta.json | 7 ++--- pages/index.mdx | 12 ++------ pages/overview.mdx | 9 +++++- pages/tools-and-integrations/_meta.json | 10 +++++++ .../block-explorers.mdx | 28 +++++++++++++++++++ pages/tools-and-integrations/faucets.mdx | 3 ++ pages/using-sei/satori.mdx | 3 -- 8 files changed, 55 insertions(+), 18 deletions(-) create mode 100644 pages/tools-and-integrations/_meta.json create mode 100644 pages/tools-and-integrations/block-explorers.mdx create mode 100644 pages/tools-and-integrations/faucets.mdx delete mode 100644 pages/using-sei/satori.mdx diff --git a/.gitignore b/.gitignore index f74c7818..36836d54 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .next node_modules +.idea/* diff --git a/pages/_meta.json b/pages/_meta.json index 8f399382..75127a6f 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -6,15 +6,14 @@ }, "overview": "Overview", "-- For Users": { - "type": "separator", - "title": "For Users" + "title": "For Users", + "type": "separator" }, - "using-sei": "Using Sei", + "tools-and-integrations": "Tools and Integrations", "-- For Devs": { "type": "separator", "title": "For Devs" }, - "get-started": "Get Started", "landing": { "title": "Back to Sei ↗", "type": "page", diff --git a/pages/index.mdx b/pages/index.mdx index 058465cb..e9591d75 100644 --- a/pages/index.mdx +++ b/pages/index.mdx @@ -1,11 +1,3 @@ -# Introduction - -Welcome to Nextra! This is a basic docs template. You can use it as a starting point for your own project :) +# Introducting Sei -## What is Nextra? - -A **simple**, **powerful** and **flexible** site generation framework with everything you love from Next.js. - -## Documentation - -The documentation is available at [https://nextra.site](https://nextra.site). +Sei is a general purpose, open-source Layer 1 blockchain specialized for the exchange of digital assets. Leveraging a novel consensus and technical breakthroughs, Sei is the fastest blockchain in the industry. \ No newline at end of file diff --git a/pages/overview.mdx b/pages/overview.mdx index b58c16c8..c6ff5a9a 100644 --- a/pages/overview.mdx +++ b/pages/overview.mdx @@ -1,3 +1,10 @@ # About Sei +(TODO) Sei is a general purpose, open-source Layer 1 blockchain specialized for the exchange of digital assets. Leveraging a novel consensus and technical breakthroughs, Sei is the fastest blockchain in the industry. -Sei is a general purpose, open-source Layer 1 blockchain specialized for the exchange of digital assets. Leveraging a novel consensus and technical breakthroughs, Sei is the fastest blockchain in the industry. +# What Sei offers +(TODO) Sei is the fastest chain to finality - point blank - with a lower bound of 300ms +Twin-turbo consensus - achieves industry-leading performance +One of the only chains to conduct market-based parallelization +Native matching engine that exchange teams can leverage +Frontrunning protection - combats malicious frontrunning that is rampant in other ecosystems +Sei has only one value prop: exchange apps - whether it’s a NFT marketplace or gaming economy- will offer the best user experience by building on Sei. For more detailed information on technical innovations, please read the whitepaper. diff --git a/pages/tools-and-integrations/_meta.json b/pages/tools-and-integrations/_meta.json new file mode 100644 index 00000000..975765ea --- /dev/null +++ b/pages/tools-and-integrations/_meta.json @@ -0,0 +1,10 @@ +{ + "block-explorers": { + "type": "page", + "title": "Block Explorers" + }, + "faucets": { + "type": "page", + "title": "Faucets" + } +} diff --git a/pages/tools-and-integrations/block-explorers.mdx b/pages/tools-and-integrations/block-explorers.mdx new file mode 100644 index 00000000..ee574152 --- /dev/null +++ b/pages/tools-and-integrations/block-explorers.mdx @@ -0,0 +1,28 @@ +# Block Explorers + +Block explorers offer tools for viewing and interacting with the network including: +1. Transaction Tracking: View and track individual transactions on the blockchain. This includes information such as transaction hashes, input and output data, amounts transferred and fees +2. Block Information: Provide detailed information about blocks, including block height, timestamp, size, and the transactions included in each block. +3. Address Queries: Look up specific wallet addresses to see their balances and transaction history +4. Network Statistics: Statistics and analytics about the blockchain network, such as the total number of blocks, transaction throughput, network hash rate, and current difficulty. +5. Smart Contract Interaction: Display information about smart contract deployments and interactions, including the code of the contract and executed actions. + + +**Devnet** + +Here are a few devnet explorers: + +TODO + + +**Testnet** + +Here are a few testnet explorers: + +- https://testnet-explorer.brocha.in/SEI%20Atlantic%202 +- https://www.seiscan.app/atlantic-2 + +**Mainnet** + +- https://www.seiscan.app/pacific-1 +- https://sei.explorers.guru/ \ No newline at end of file diff --git a/pages/tools-and-integrations/faucets.mdx b/pages/tools-and-integrations/faucets.mdx new file mode 100644 index 00000000..50844703 --- /dev/null +++ b/pages/tools-and-integrations/faucets.mdx @@ -0,0 +1,3 @@ +# Faucets + +TODO \ No newline at end of file diff --git a/pages/using-sei/satori.mdx b/pages/using-sei/satori.mdx deleted file mode 100644 index 46eb19fd..00000000 --- a/pages/using-sei/satori.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Satori - -Satori (悟り) is a Japanese Buddhist term for awakening, "comprehension; understanding". From 45f0764ade24f0425b3cfb5ca9a056aa246e461c Mon Sep 17 00:00:00 2001 From: Philip Su Date: Wed, 17 Jan 2024 11:18:37 -0800 Subject: [PATCH 2/2] Add user and dev content --- pages/_meta.json | 12 ++++- .../block-explorers.mdx | 0 .../introduction.mdx | 44 +++++++++++++++ .../{tools-and-integrations => }/faucets.mdx | 0 pages/get-started.mdx | 3 -- pages/interacting-with-sei.mdx | 16 ++++++ pages/node-configuration.mdx | 54 +++++++++++++++++++ pages/running-a-sei-node.mdx | 13 +++++ pages/setting-up-a-wallet.mdx | 13 +++++ pages/tools-and-integrations/_meta.json | 10 ---- 10 files changed, 151 insertions(+), 14 deletions(-) rename pages/{tools-and-integrations => }/block-explorers.mdx (100%) create mode 100644 pages/deploy-your-first-nft-contract/introduction.mdx rename pages/{tools-and-integrations => }/faucets.mdx (100%) delete mode 100644 pages/get-started.mdx create mode 100644 pages/interacting-with-sei.mdx create mode 100644 pages/node-configuration.mdx create mode 100644 pages/running-a-sei-node.mdx create mode 100644 pages/setting-up-a-wallet.mdx delete mode 100644 pages/tools-and-integrations/_meta.json diff --git a/pages/_meta.json b/pages/_meta.json index 75127a6f..8d134e74 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -9,11 +9,21 @@ "title": "For Users", "type": "separator" }, - "tools-and-integrations": "Tools and Integrations", + "block-explorers":"Block Explorers", + "faucets": "Faucets", + "setting-up-a-wallet":" Setting Up a Wallet", + "interacting-with-sei": "Interacting With Sei", "-- For Devs": { "type": "separator", "title": "For Devs" }, + "running-a-sei-node": "Running a Sei Node", + "deploy-your-first-nft-contract": "Deploy Your First NFT Contract", + "-- Advanced": { + "type": "separator", + "title": "Advanced" + }, + "node-configuration": "Node Configuration", "landing": { "title": "Back to Sei ↗", "type": "page", diff --git a/pages/tools-and-integrations/block-explorers.mdx b/pages/block-explorers.mdx similarity index 100% rename from pages/tools-and-integrations/block-explorers.mdx rename to pages/block-explorers.mdx diff --git a/pages/deploy-your-first-nft-contract/introduction.mdx b/pages/deploy-your-first-nft-contract/introduction.mdx new file mode 100644 index 00000000..719b2e35 --- /dev/null +++ b/pages/deploy-your-first-nft-contract/introduction.mdx @@ -0,0 +1,44 @@ +import Image from 'next/image' +import colonyNFT from './colony.png' +import seiyanNFT from './seiyan.png' + +# Introduction +In this tutorial we'll be going over how to create an NFT contract on Sei + +## What are NFTs? +NFT stands for Non-Fungible Token. Unlike cryptocurrencies like Bitcoin or Ethereum, which are fungible and can be +exchanged on a one-to-one basis, NFTs are unique digital assets. This uniqueness means that one NFT cannot be +exchanged on a like-for-like basis with another, making each NFT distinct and irreplaceable. + +
+ colonyNFT + seiyanNFT +
+ + +## Characteristics of NFTs +**Uniqueness and Scarcity:** Each NFT has a digital signature that makes it impossible for NFTs to be exchanged for or +equal to one another (hence, non-fungible). Artists can create a scarcity of their art by issuing a limited number of +NFTs. + +**Ownership and Provenance:** NFTs can be used to represent ownership of a specific item. They contain built-in +authentication, which serves as proof of ownership. Collectors value those “digital bragging rights” almost more than +the item itself. + +**Interoperability:** NFTs can be bought, sold, and traded across various platforms and marketplaces, as long as those +platforms support the same standards used to create the NFT (e.g., ERC-721 and ERC-1155 on the Ethereum blockchain). + +## Use Cases of NFTs +- Digital Art: One of the most prominent uses of NFTs is in digital art. Artists can tokenize their work to sell it as +NFTs, which has opened a new market for digital creators. +- Collectibles: NFTs are being used for digital collectibles, such as digital trading cards or rare items in video +games. +- Music and Entertainment: Musicians and entertainers are using NFTs to tokenize their work, from albums to concert +tickets. + +## How Do NFTs Work? +**Minting:** The process of creating an NFT is called minting. It involves uploading content to a blockchain network and +turning it into a part of the blockchain. + +**Buying and Selling:** NFTs are typically bought and sold on specialized marketplaces. When you buy an NFT, you receive +a token that proves your ownership of a 'one-of-a-kind' piece of digital content. \ No newline at end of file diff --git a/pages/tools-and-integrations/faucets.mdx b/pages/faucets.mdx similarity index 100% rename from pages/tools-and-integrations/faucets.mdx rename to pages/faucets.mdx diff --git a/pages/get-started.mdx b/pages/get-started.mdx deleted file mode 100644 index f9ae6fab..00000000 --- a/pages/get-started.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Get Started - -Use this beginner-friendly guide to start building on Sei. diff --git a/pages/interacting-with-sei.mdx b/pages/interacting-with-sei.mdx new file mode 100644 index 00000000..cbed0811 --- /dev/null +++ b/pages/interacting-with-sei.mdx @@ -0,0 +1,16 @@ +# Interacting with Sei + +## Acquiring Sei tokens +There are numerous ways to acquire Sei tokens to start interactingw ith the chain. Below are some common ways: + +- Centralized exchanges (CEXes) like [Coinbase](https://www.coinbase.com/), [Binance](https://binance.com/), +[KuCoin](https://www.coingecko.com/en/exchanges/kucoin) and [Karken](https://www.kraken.com) +- Decentralized Exchanges (DEXes) like [Astroport](https://astroport.fi/) and [Osmosis](https://osmosis.zone/) +- Bridge assets over from another chain using [Sei app](https://app.sei.io/bridge) or IBC + +## Common Apps +Below are a few popular apps. For a full list, please see the Ecosystem page (TODO): + +- [Astroport](https://astroport.fi/): dex +- [Silo](https://app.silostaking.io/): liquid staking +- [Pallet Exchange](https://pallet.exchange/): NFT marketplace diff --git a/pages/node-configuration.mdx b/pages/node-configuration.mdx new file mode 100644 index 00000000..b889aef4 --- /dev/null +++ b/pages/node-configuration.mdx @@ -0,0 +1,54 @@ +# Node Configuration + +## Node types +There are a few node types that can be run on Sei network which serve a variety of purposes. These include: + +- **rpc / full nodes:** these nodes are generally used for querying data or interacting with the chain. They maintain +some state but not since genesis. The default settings will run rpc / full nodes. +- **archive nodes:** maintain full state of the blockchain from genesis. Generally requires large disks. To enable this +type of node, set `min-retain-blocks=0` and `pruning="nothing"` in your `app.toml` +- **state sync nodes:** provide snapshot data for other nodes to use to bootstrap onto the chain. To enable this type +of node, set `enable=true` under the `[statesync]` section in `config.toml` +- **validator nodes:** provide security to the chain by proposing and signing blocks. To enable this type of node, set +`mode=validator` in `config.toml`. Note that because Sei is proof-of-stake, you must have enough delegation to join the +active set + + +## Commonly Used Ports +Seid uses the following TCP ports. Toggle their settings to match your environment. + +- `26656`: The default port for the P2P protocol. This port is used to communicate with other nodes and must be open to +join a network. +- `1317`: The default port for interacting with the Seid API server for HTTP RESTful requests. This allows applications +and services to interact with the `seid` instance through RPC. +- `26660`: The default port for interacting with the Prometheus database, which can be used to monitor the environment. +In the default configuration, this port is not open. +- `26657`: The default port for the RPC protocol. Because this port is used for querying and sending transactions, it +must be open for serving queries from `seid`. + +These ports are all customizable in `$HOME/.sei/config/config.toml` and `$HOME/.sei/config/app/toml` discussed in the later sections along with other fields. + + +## Systemd File Template +``` +[Unit] +Description=Sei Node +After=network.target + +[Service] +User= +Type=simple +ExecStart=/seid start --chain-id +Restart=always +# wait 30 seconds before restarting the service after it has failed. +RestartSec=30 +# wait up to 30 seconds for the service to stop gracefully when it is being stopped. +TimeoutStopSec=30 +# send the SIGINT signal (equivalent to pressing Ctrl-C) to the service process when it is being stopped +# giving it a chance to shut down gracefully. +KillSignal=SIGINT +LimitNOFILE=65535 + +[Install] +WantedBy=multi-user.target +``` diff --git a/pages/running-a-sei-node.mdx b/pages/running-a-sei-node.mdx new file mode 100644 index 00000000..5ea3c63c --- /dev/null +++ b/pages/running-a-sei-node.mdx @@ -0,0 +1,13 @@ +# Running a Sei RPC node +A full Sei node is a fundamental building block of the Sei Blockchain. It consists of a local copy of the blockchain, +including its history and state. Running a full node is essential for participating in network operations like +validating transactions, joining consensus, and broadcasting events to other network participants. + +## System Configuration +| CPU Cores | RAM | Disk | +| ----------- | ----------- | ----------- | +|16 cores | 64GB | 1TB NVMe | + +## Quick start +There is a setup script that runs a lot of the basic setup to easily get you started running an RPC node. If you are an +advanced user, please see [Advanced | Node Configurations](../node-configuration) \ No newline at end of file diff --git a/pages/setting-up-a-wallet.mdx b/pages/setting-up-a-wallet.mdx new file mode 100644 index 00000000..28d4ac66 --- /dev/null +++ b/pages/setting-up-a-wallet.mdx @@ -0,0 +1,13 @@ +# Setting up a wallet + +## Installing a wallet + +You can use Sei with any of the following native wallets: + +- [Compass](https://compasswallet.io/) +- [Fin](https://finwallet.com/) + +Alternatively, if you would like to use an existing Metamask wallet, you can use the button below to connect to +the Sei network + +TODO \ No newline at end of file diff --git a/pages/tools-and-integrations/_meta.json b/pages/tools-and-integrations/_meta.json deleted file mode 100644 index 975765ea..00000000 --- a/pages/tools-and-integrations/_meta.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "block-explorers": { - "type": "page", - "title": "Block Explorers" - }, - "faucets": { - "type": "page", - "title": "Faucets" - } -}