diff --git a/content/evm/_meta.js b/content/evm/_meta.js index b6764347..1d7ab786 100644 --- a/content/evm/_meta.js +++ b/content/evm/_meta.js @@ -55,26 +55,7 @@ export default { type: 'separator', title: 'sei-js Library' }, - 'seijs-introduction': { - title: 'Introduction to sei-js', - href: 'https://sei-js.docs.sei.io/introduction' - }, - 'scaffold-sei': { - title: 'Scaffold Sei', - href: 'https://sei-js.docs.sei.io/create-sei/welcome' - }, - 'mcp-server-seijs': { - title: 'MCP Server', - href: 'https://sei-js.docs.sei.io/mcp-server/introduction' - }, - 'sei-x402': { - title: 'X402', - href: 'https://sei-js.docs.sei.io/x402/introduction' - }, - 'seijs-ledger': { - title: 'Ledger', - href: 'https://sei-js.docs.sei.io/ledger/introduction' - }, + 'sei-js': '@sei-js SDK', '-- Ecosystem Tutorials': { type: 'separator', @@ -104,5 +85,5 @@ export default { type: 'separator', title: 'Hardware Wallets' }, - 'ledger-ethers': 'Using Ledger with Ethers' + 'ledger-ethers': 'Ledger Hardware Wallet' }; diff --git a/content/evm/sei-js/_meta.js b/content/evm/sei-js/_meta.js new file mode 100644 index 00000000..ba03498a --- /dev/null +++ b/content/evm/sei-js/_meta.js @@ -0,0 +1,4 @@ +export default { + index: 'Introduction', + 'create-sei': 'Scaffold Sei' +}; diff --git a/content/evm/sei-js/create-sei.mdx b/content/evm/sei-js/create-sei.mdx new file mode 100644 index 00000000..7e28e0cf --- /dev/null +++ b/content/evm/sei-js/create-sei.mdx @@ -0,0 +1,108 @@ +--- +title: 'Scaffold Sei' +description: 'CLI tool for scaffolding production-ready Sei applications with pre-configured templates' +keywords: ['create-sei', 'scaffold', 'cli', 'sei', 'nextjs', 'wagmi', 'viem', 'template'] +--- + +import { Callout, Steps, Tabs } from 'nextra/components'; + +# Scaffold Sei + +`@sei-js/create-sei` is a CLI tool that scaffolds production-ready Sei dApps in seconds. Quickly spin up templates with Next.js, modern wallet integration, and TypeScript support. + +```bash +npx @sei-js/create-sei app --name my-sei-app +``` + +Every generated project includes wallet connections, contract interactions, TypeScript, Tailwind CSS, Mantine UI, Biome for formatting, and responsive layouts — no additional setup required. + +## Quick Start + +You don't need to install `@sei-js/create-sei` globally. Use it directly with npx or pnpm: + + + ```bash npx @sei-js/create-sei app --name my-sei-app ``` + ```bash pnpm create @sei-js/create-sei app --name my-sei-app ``` + + +## Interactive Setup + + + +### Run the CLI + +Execute the create-sei command with your project name: + +```bash +npx @sei-js/create-sei app +``` + +### Install and run + +```bash +cd my-sei-app +npm install +npm run dev +``` + +### Start building + +The CLI automatically configures TypeScript, Next.js, Tailwind CSS, Biome formatting, Mantine UI components, and Git initialization. + + + +### CLI Options + +| Command | Description | +| ----------------------- | ----------------------------------------------------- | +| `app` | Create a new Sei dApp | +| `app --name ` | Specify a project name (must be a valid package name) | +| `app --extension ` | Add an optional extension to your project | +| `list-extensions` | List available extensions | + +## Default Template + +The default template creates a **Next.js + Wagmi (EVM)** application — a production-ready Next.js app with Wagmi for type-safe Ethereum wallet connections and blockchain interactions. Includes built-in support for MetaMask, WalletConnect, Coinbase Wallet, and other popular wallets. + +**Tech Stack:** Next.js 14, Wagmi v2, Viem, TanStack Query, Tailwind CSS + +```bash +npx @sei-js/create-sei app --name my-sei-app +``` + +## Extensions + +Enhance your project with additional functionality using extensions. + +### List Available Extensions + +```bash +npx @sei-js/create-sei list-extensions +``` + +### Precompiles Extension + +Add Sei precompile contract integration with examples for querying native blockchain data like token supply, staking info, and governance proposals. + +```bash +npx @sei-js/create-sei app --name my-sei-precompile-app --extension precompiles +``` + +Includes Bank precompile, Staking precompile, and Governance precompile examples. + +## What's Included + +After running the CLI, you'll have a fully configured Sei dApp ready for development: + +- **Project structure** — Organized file structure with components, hooks, and utilities +- **Wallet integration** — Pre-configured wallet connections and hooks +- **Development tools** — TypeScript, Biome, Mantine UI, and Tailwind CSS with sensible defaults +- **Sei network integration** — Built-in network configuration and contract interaction examples + +**Prerequisites:** Node.js v18 or higher is required. Use `node --version` to verify your installation. + +## Troubleshooting + +- **Node version conflicts** — Use `nvm use` to switch to the correct Node.js version +- **Permission errors** — Avoid using `sudo` with npm. Use `nvm` or fix npm permissions +- **Network timeouts** — Try switching to a different registry: `npm config set registry https://registry.npmjs.org/` diff --git a/content/evm/sei-js/index.mdx b/content/evm/sei-js/index.mdx new file mode 100644 index 00000000..9eef803f --- /dev/null +++ b/content/evm/sei-js/index.mdx @@ -0,0 +1,82 @@ +--- +title: '@sei-js SDK' +description: 'A complete TypeScript SDK for building decentralized applications on Sei Network' +keywords: ['sei-js', 'typescript', 'sdk', 'sei network', 'evm', 'precompiles', 'wallet', 'mcp'] +--- + +import { Callout, Cards } from 'nextra/components'; + +# @sei-js SDK + +@sei-js is the complete TypeScript SDK for building applications on Sei Network. Whether you're creating DeFi protocols, NFT marketplaces, or blockchain games, @sei-js provides everything you need to ship faster. + +**Works with your favorite tools:** Sei is fully EVM-compatible, so you can use Viem, Ethers.js, Foundry, Hardhat, and all your existing Ethereum development tools without any changes. @sei-js extends these tools with Sei-specific features like precompiled contracts and optimized wallet connections. + +@sei-js is open source. Contribute at [github.com/sei-protocol/sei-js](https://github.com/sei-protocol/sei-js). + +## Why @sei-js? + +- **Complete TypeScript support** — Full type safety for every function, contract interaction, and API response. Catch errors at compile time. +- **Production ready** — Battle-tested components used by major applications in the Sei ecosystem. +- **Optimized for Sei** — Take advantage of Sei's fast finality, low gas fees, and native features. + +## Package Ecosystem + +### [@sei-js/precompiles](/evm/precompiles) + +Access Sei's precompiled contracts directly from your EVM applications. Interact with native blockchain functions for staking, governance, IBC, and more. + +```bash +npm install @sei-js/precompiles +``` + +### [@sei-js/create-sei](/evm/sei-js/create-sei) + +Bootstrap new Sei projects with pre-configured templates and tooling. Scaffold production-ready dApps in seconds. + +```bash +npx @sei-js/create-sei app +``` + +### [@sei-js/sei-global-wallet](/evm/sei-global-wallet) + +Connect to any Sei-compatible wallet using the EIP-6963 standard. Provides a cross-application embedded wallet experience with social login. + +```bash +npm install @sei-js/sei-global-wallet +``` + +### [@sei-js/ledger](/evm/ledger-ethers) + +Secure transaction signing with Ledger hardware wallets. Provides TypeScript helper functions for the SEI Ledger app. + +```bash +npm install @sei-js/ledger +``` + +### [@sei-js/mcp-server](/evm/ai-tooling/mcp-server) + +Teach Claude, Cursor, Windsurf, or any LLM to interact with the Sei blockchain through the Model Context Protocol. + +```bash +npx @sei-js/mcp-server +``` + +## Quick Start + +Generate a new Sei application using the CLI tool: + +```bash +npx @sei-js/create-sei app +cd app +npm install +npm run dev +``` + +This creates a production-ready project with TypeScript, wallet connections, and Sei network integration out of the box. See the [Scaffold Sei](/evm/sei-js/create-sei) page for details on available templates and options. + +## Community & Support + +- [GitHub Discussions](https://github.com/sei-protocol/sei-js/discussions) — Ask questions and discuss features +- [Discord](https://discord.gg/sei) — Join the Sei developer community +- [GitHub Issues](https://github.com/sei-protocol/sei-js/issues) — Report bugs and request features