diff --git a/assets/SeiLogo.png b/assets/SeiLogo.png new file mode 100644 index 0000000000..eccd8f45d1 Binary files /dev/null and b/assets/SeiLogo.png differ diff --git a/readme.md b/readme.md index 4732226abc..154df17a9d 100644 --- a/readme.md +++ b/readme.md @@ -1,76 +1,13 @@ -# seichain -**seichain** is a blockchain built using Cosmos SDK and Tendermint and created with [Starport](https://starport.com). - -## Get started -You may use starport to run the chain, but typically we have our own customizations that require using an internal tool (seid). Both methods are shown below. -### Starport - -``` -starport chain serve -``` - -`serve` command installs dependencies, builds, initializes, and starts your blockchain in development. - -### Internal tool -First build the tool -``` -make install -``` - -If you've run the chain before, you may have leftover cruft. Run the following to reset the state. -``` -seid unsafe-reset-all -``` - -Next, initialize the chain. This creates the genesis field: -``` -seid init {moniker} --chain-id sei-chain -``` - -Finally, start the chain: -``` -seid start -``` - +# Sei -### Configure +![Banner!](assets/SeiLogo.png) -Your blockchain in development can be configured with `config.yml`. To learn more, see the [Starport docs](https://docs.starport.com). +Sei Network is the first orderbook-specific L1 blockchain. The chain emphasizes reliability, security and high throughput above all else, enabling an entirely new echelon of ultra-high performance DeFi products built on top. Sei's on-chain CLOB and matching engine provides deep liquidity and price-time-priority matching for traders and apps. Apps built on Sei benefit from built-in orderbook infrastructure, deep liquidity, and a fully decentralized matching service. Users benefit from this exchange model with the ability to select price, size, and direction of their trades coupled with MEV protection. -### Web Frontend - -Starport has scaffolded a Vue.js-based web app in the `vue` directory. Run the following commands to install dependencies and start the app: - -``` -cd vue -npm install -npm run serve -``` - -The frontend app is built using the `@starport/vue` and `@starport/vuex` packages. For details, see the [monorepo for Starport front-end development](https://github.com/tendermint/vue). - -## Release -To release a new version of your blockchain, create and push a new tag with `v` prefix. A new draft release with the configured targets will be created. - -``` -git tag v0.1 -git push origin v0.1 -``` - -After a draft release is created, make your final changes from the release page and publish it. - -### Install -To install the latest version of your blockchain node's binary, execute the following command on your machine: - -``` -curl https://get.starport.com/sei-protocol/sei-chain@latest! | sudo bash -``` -`sei-protocol/sei-chain` should match the `username` and `repo_name` of the Github repository to which the source code was pushed. Learn more about [the install process](https://github.com/allinbits/starport-installer). +# seichain +**seichain** is a blockchain built using Cosmos SDK and Tendermint. It is built using the Cosmos SDK and Tendermint core, and features a built-in central limit orderbook (CLOB) module. Decentralized applications building on Sei can build on top of the CLOB, and other Cosmos-based blockchains can leverage Sei's CLOB as a shared liquidity hub and create markets for any asset. Sei Shared Liquidity Model -## Learn more +Designed with developers and users in mind, Sei serves as the infrastructure and shared liquidity hub for the next generation of DeFi. Apps can easily plug-and-play to trade on Sei orderbook infrastructure and access pooled liquidity from other apps. To prioritize developer experience, Sei Network has integrated the wasmd module to support CosmWasm smart contracts. -- [Starport](https://starport.com) -- [Tutorials](https://docs.starport.com/guide) -- [Starport docs](https://docs.starport.com) -- [Cosmos SDK docs](https://docs.cosmos.network) -- [Developer Chat](https://discord.gg/H6wGTY8sxw) +## Get started +Please refer to technical documentation to get started: https://docs.seinetwork.io/ diff --git a/x/README.md b/x/README.md new file mode 100644 index 0000000000..06110ccb29 --- /dev/null +++ b/x/README.md @@ -0,0 +1,6 @@ +# Sei modules + +Sei implements the following custom modules: +* `dex` - +* `epoch` - +* `oracle` - \ No newline at end of file diff --git a/x/dex/README.md b/x/dex/README.md new file mode 100644 index 0000000000..f5d1761781 --- /dev/null +++ b/x/dex/README.md @@ -0,0 +1 @@ +# Dex \ No newline at end of file diff --git a/x/epoch/README.md b/x/epoch/README.md new file mode 100644 index 0000000000..1417634b34 --- /dev/null +++ b/x/epoch/README.md @@ -0,0 +1 @@ +# Epoch \ No newline at end of file diff --git a/x/oracle/README.md b/x/oracle/README.md new file mode 100644 index 0000000000..1d05ecc39e --- /dev/null +++ b/x/oracle/README.md @@ -0,0 +1 @@ +# Oracle \ No newline at end of file