## 1. Project Overview & Quickstart (inkonchain/docs) ## File: README.md [](https://x.com/inkonchain) # InkChain Documentation App An advanced, streamlined documentation platform built with Next.js and Nextra for InkChain. ## 🚀 Build & Run 1. **Build Docker image**: ```bash docker build -t docs . ``` 2. **Run Docker container**: ```bash docker run -p 3000:3000 docs ``` ## 📋 Requirements * **Node.js**: v20.11.0 or higher ## 📖 Overview This is a documentation application powered by [Nextra](https://nextra.site/) and built on [Next.js](https://nextjs.org/). Nextra simplifies the creation of documentation sites, allowing us to leverage the **Pages Router** for efficient navigation and routing. Currently, due to compatibility limitations, we have not yet upgraded to the App Router. ## 🏁 Getting Started To get started with local development: 1. **Clone the repository** 2. **Install dependencies**: ```bash pnpm install ``` 3. **Start development server**: ```bash pnpm run dev ``` ## 🛠 Tooling Our development setup includes multiple tools to maintain high-quality code and documentation: * **[CSpell](https://cspell.org/)**: Real-time spell checking to maintain documentation accuracy. * **[Remark](https://remark.js.org/)**: Processes and renders Markdown content with added plugins. * **[ESLint](https://eslint.org/)**: Ensures code quality by catching potential issues. * **[Prettier](https://prettier.io/)**: Enforces consistent code formatting. * **[Tailwind CSS](https://tailwindcss.com/)**: Utility-first CSS framework for fast, responsive UI development. ## đŸšĻ CI/CD Pipeline Our CI/CD setup utilizes GitHub Actions to run automated checks on every pull request (PR): * **js-lint**: Ensures proper JavaScript code formatting with ESLint. * **md-lint**: Checks Markdown code formatting with Remark. * **format**: Enforces consistent code style with Prettier. * **spell-check**: Uses CSpell to verify correct spelling in the documentation. For any unique terms (e.g., "InkChain"), add them to the [`./cspell/project-words.txt`](./cspell/project-words.txt) file to whitelist. ## 🌐 Feature Branch Deployment For every new PR, our CI/CD pipeline deploys a temporary environment via **AWS Amplify**. This real-time deployment enables live testing and review of changes before merging, ensuring a smoother workflow. The deployment URL is automatically provided within the PR checks, allowing team members to interact with new features. ## 🚀 Production Deployment The `main` branch is configured for automatic continuous deployment via **AWS Amplify**. Every merge triggers a new build and deployment, ensuring that the latest version of the documentation is available to users without manual intervention. --- ## File: src/content/shared/_badges.mdx # Badges ## Welcome To Ink > Awarded for bridging Ethereum to Ink. To bridge Ethereum, you can use the `L1StandardBridge` on the sepolia network crafted for Ink. There are two ways to do it: ### Gelato Bridge app The app provides a very simple UI to deposit or withdraw SepoliaETH from and to Sepolia Ink. Here is the app: [https://testnet-bridge.gelato.network/bridge/ink-sepolia](https://testnet-bridge.gelato.network/bridge/ink-sepolia) Connect your wallet, select the amount to transfer, and that's it! ### Directly calling the contract You can call the `bridgeETH` method in the contract here: [https://sepolia.etherscan.io/address/0xC0d337f71aD19a8f17a1b297cDb3a86c5EEf9Eec#writeProxyContract](https://sepolia.etherscan.io/address/0xC0d337f71aD19a8f17a1b297cDb3a86c5EEf9Eec#writeProxyContract) For instance, if you want to bridge 1 Sepolia ETH into 1 Sepolia "Ink" ETH: 1. Connect your Wallet using the "Connect to Wallet" button 2. Expand the `bridgeETH` method and enter `bridgeETH: 1` 3. Enter `_minGasLimit: 1000` (or whatever suits you) 4. Enter `_extraData: 0x00` 5. Click "Write", then validate the transaction in MetaMask, then sign it to complete the transaction. ## Wrapped ETH > Awarded for wrapping Ethereum into WETH. To create Wrapped ETH tokens (WETH), you can interact with the `deposit` method in the contract here: [https://explorer-sepolia.inkonchain.com/token/0x47d1f931eaff721549cc0ad57da81729baa8b4b2?tab=write\_contract](https://explorer-sepolia.inkonchain.com/token/0x47d1f931eaff721549cc0ad57da81729baa8b4b2?tab=write_contract) 1. Connect your Wallet using the button 2. Expand the `deposit` method and enter `Send native ETH: 10 000 000 000 000 000`. * This is equivalent to 0.01 ETH, adjust as needed 3. Click "Write", then validate the transaction in MetaMask, then sign it to complete the transaction. If you want the token to appear in MetaMask, click on the MetaMask button at the top of the page ## ERC20 Interactions > Awarded for minting, sending, and receiving ERC20 tokens. *coming soon* ## NFT Interactions > Awarded for minting, sending, and receiving NFTs. *coming soon* ## Faucet User > Awarded for using the Ink faucet. Get here: [https://mystery-faucet.inkonchain.com/](https://mystery-faucet.inkonchain.com/) Enter your address, enter the captcha, that's it! ## Smart Contract Deployer > Awarded for deploying a smart contract. *coming soon* --- ## File: src/content/shared/block-explorers-content.mdx ## Blockscout Blockscout is a universal block explorer providing detailed chain information and tools for debugging smart contracts and transactions. Visit the [Blockscout Docs](https://docs.blockscout.com/) for details. ###### Supported Networks * Ink Sepolia: [https://explorer-sepolia.inkonchain.com/](https://explorer-sepolia.inkonchain.com/) * API: [https://explorer-sepolia.inkonchain.com/api](https://explorer-sepolia.inkonchain.com/api) ###### Verifying Smart Contract Code on Blockscout * Please see [this tutorial](/build/tutorials/verify-smart-contract) ## Routescan Routescan is a unified explorer for over 54 blockchains. ###### Supported Networks * Ink Sepolia: [https://sepolia.inkonscan.xyz/](https://sepolia.inkonscan.xyz/) * API: [https://sepolia.inkonscan.xyz/documentation/api-swagger](https://sepolia.inkonscan.xyz/documentation/api-swagger) --- ## File: src/content/shared/bridges-content.mdx import { Callout } from 'nextra/components' # Bridges These bridges provide different interfaces to the canonical smart contracts that facilitate migrating ETH from one chain to another. Transaction times vary based on network congestion and gas fees. Please ensure you have enough ETH in your wallet to cover transaction fees. ##### How to use 1. Visit the bridge and connect your wallet. 2. Choose Sepolia as your source and Ink as the destination. 3. Input the amount of assets you want to bridge. 4. Confirm and sign the transaction with your wallet. 5. Once the bridging is complete, the assets will appear in your wallet on Ink. ## Gelato bridge Bridge: [https://bridge-gel-sepolia.inkonchain.com/](https://bridge-gel-sepolia.inkonchain.com/) ## Ink Bridge Bridge: [https://inkonchain.com/bridge](https://inkonchain.com/bridge) ## Brid.gg Bridge: [https://testnet.brid.gg/](https://testnet.brid.gg/) ## Superbridge Bridge: [https://superbridge.app/](https://superbridge.app/) (enable testnet in settings) --- ## File: src/content/shared/community-content.mdx import { URLS } from "@/utils/urls"; # Get Support Join the Ink community, vibe with fellow developers and get support: - Join the Ink Telegram for announcements: [Join Telegram](https://t.me/inkonchain) --- ## File: src/content/shared/crosschain-content.mdx # Crosschain Infrastructure ## Wormhole Wormhole is an interoperability platform powering multichain apps and bridges. * Wormhole currently supports Ink Sepolia. --- ## File: src/content/shared/faucets-content.mdx # Faucets Get Sepolia ETH on Ink from these faucets below! Alternatively, you can [bridge](https://inkonchain.com/bridge) testnet funds to Ink. ## [Ink](https://inkonchain.com/faucet) Our in-house faucet provides a quick and easy way to acquire testnet ETH. ## [Optimism Superchain Faucet](https://console.optimism.io/faucet) The Superchain Faucet provides testnet ETH for Ink and all other OP chains. Sign in to claim 0.10 test ETH on 1 network every 24 hours or verify your onchain identity for more tokens. ## [QuickNode](https://faucet.quicknode.com/drip) Use QuickNode Faucet to claim Ink Sepolia for testnet ETH for free - one drip per network every 12 hours. ## [Gelato](https://faucet-gel-sepolia.inkonchain.com) Gelato's Faucet uses Cloudflare authentication and drops up to 0.3 Ink Sepolia ETH every 12 hours. ## [Tenderly](https://tenderly.co/?mtm_campaign=ext-docs&mtm_kwd=ink) Tenderly's [Unlimited Faucet](https://docs.tenderly.co/virtual-testnets/unlimited-faucet?mtm_campaign=ext-docs&mtm_kwd=ink) allows you to mint native and ERC20 tokens for development and testing on Virtual TestNets. The unlimited faucet is part of the [Admin RPC](https://docs.tenderly.co/virtual-testnets/admin-rpc?mtm_campaign=ext-docs&mtm_kwd=ink), a collection of cheat-codes allowing full customization of the network. --- ## File: src/content/shared/multisig-content.mdx # Multisig ## Safe Ink hosts [Safe](https://docs.safe.global/home/what-is-safe)'s technology to bring digital ownership of accounts to everyone by building universal and open contract standards for the custody of digital assets, data, and identity. Using Safe you can: * Manage customizable non-custodial wallets supporting multisignatures for individuals and teams * Perform financial management of onchain assets incl. ERC20s, ERC721s and ETH * Access your safe using Web, Mobile and Desktop apps. * Safe also features access to DeFi, open source code, batch transactions, modular extensions, gasless signatures and more. **Supported Networks** * [Ink Mainnet](https://app.safe.global/new-safe/load?chain=ink) * [Ink Sepolia](https://safe.optimism.io/welcome/accounts?chain=ink-sepolia) ## 2. Official Technical Reference & Guides (inkonchain/docs) ## File: README.md [](https://x.com/inkonchain) # InkChain Documentation App An advanced, streamlined documentation platform built with Next.js and Nextra for InkChain. ## 🚀 Build & Run 1. **Build Docker image**: ```bash docker build -t docs . ``` 2. **Run Docker container**: ```bash docker run -p 3000:3000 docs ``` ## 📋 Requirements * **Node.js**: v20.11.0 or higher ## 📖 Overview This is a documentation application powered by [Nextra](https://nextra.site/) and built on [Next.js](https://nextjs.org/). Nextra simplifies the creation of documentation sites, allowing us to leverage the **Pages Router** for efficient navigation and routing. Currently, due to compatibility limitations, we have not yet upgraded to the App Router. ## 🏁 Getting Started To get started with local development: 1. **Clone the repository** 2. **Install dependencies**: ```bash pnpm install ``` 3. **Start development server**: ```bash pnpm run dev ``` ## 🛠 Tooling Our development setup includes multiple tools to maintain high-quality code and documentation: * **[CSpell](https://cspell.org/)**: Real-time spell checking to maintain documentation accuracy. * **[Remark](https://remark.js.org/)**: Processes and renders Markdown content with added plugins. * **[ESLint](https://eslint.org/)**: Ensures code quality by catching potential issues. * **[Prettier](https://prettier.io/)**: Enforces consistent code formatting. * **[Tailwind CSS](https://tailwindcss.com/)**: Utility-first CSS framework for fast, responsive UI development. ## đŸšĻ CI/CD Pipeline Our CI/CD setup utilizes GitHub Actions to run automated checks on every pull request (PR): * **js-lint**: Ensures proper JavaScript code formatting with ESLint. * **md-lint**: Checks Markdown code formatting with Remark. * **format**: Enforces consistent code style with Prettier. * **spell-check**: Uses CSpell to verify correct spelling in the documentation. For any unique terms (e.g., "InkChain"), add them to the [`./cspell/project-words.txt`](./cspell/project-words.txt) file to whitelist. ## 🌐 Feature Branch Deployment For every new PR, our CI/CD pipeline deploys a temporary environment via **AWS Amplify**. This real-time deployment enables live testing and review of changes before merging, ensuring a smoother workflow. The deployment URL is automatically provided within the PR checks, allowing team members to interact with new features. ## 🚀 Production Deployment The `main` branch is configured for automatic continuous deployment via **AWS Amplify**. Every merge triggers a new build and deployment, ensuring that the latest version of the documentation is available to users without manual intervention. --- ## File: src/content/shared/_badges.mdx # Badges ## Welcome To Ink > Awarded for bridging Ethereum to Ink. To bridge Ethereum, you can use the `L1StandardBridge` on the sepolia network crafted for Ink. There are two ways to do it: ### Gelato Bridge app The app provides a very simple UI to deposit or withdraw SepoliaETH from and to Sepolia Ink. Here is the app: [https://testnet-bridge.gelato.network/bridge/ink-sepolia](https://testnet-bridge.gelato.network/bridge/ink-sepolia) Connect your wallet, select the amount to transfer, and that's it! ### Directly calling the contract You can call the `bridgeETH` method in the contract here: [https://sepolia.etherscan.io/address/0xC0d337f71aD19a8f17a1b297cDb3a86c5EEf9Eec#writeProxyContract](https://sepolia.etherscan.io/address/0xC0d337f71aD19a8f17a1b297cDb3a86c5EEf9Eec#writeProxyContract) For instance, if you want to bridge 1 Sepolia ETH into 1 Sepolia "Ink" ETH: 1. Connect your Wallet using the "Connect to Wallet" button 2. Expand the `bridgeETH` method and enter `bridgeETH: 1` 3. Enter `_minGasLimit: 1000` (or whatever suits you) 4. Enter `_extraData: 0x00` 5. Click "Write", then validate the transaction in MetaMask, then sign it to complete the transaction. ## Wrapped ETH > Awarded for wrapping Ethereum into WETH. To create Wrapped ETH tokens (WETH), you can interact with the `deposit` method in the contract here: [https://explorer-sepolia.inkonchain.com/token/0x47d1f931eaff721549cc0ad57da81729baa8b4b2?tab=write\_contract](https://explorer-sepolia.inkonchain.com/token/0x47d1f931eaff721549cc0ad57da81729baa8b4b2?tab=write_contract) 1. Connect your Wallet using the button 2. Expand the `deposit` method and enter `Send native ETH: 10 000 000 000 000 000`. * This is equivalent to 0.01 ETH, adjust as needed 3. Click "Write", then validate the transaction in MetaMask, then sign it to complete the transaction. If you want the token to appear in MetaMask, click on the MetaMask button at the top of the page ## ERC20 Interactions > Awarded for minting, sending, and receiving ERC20 tokens. *coming soon* ## NFT Interactions > Awarded for minting, sending, and receiving NFTs. *coming soon* ## Faucet User > Awarded for using the Ink faucet. Get here: [https://mystery-faucet.inkonchain.com/](https://mystery-faucet.inkonchain.com/) Enter your address, enter the captcha, that's it! ## Smart Contract Deployer > Awarded for deploying a smart contract. *coming soon* --- ## File: src/content/shared/block-explorers-content.mdx ## Blockscout Blockscout is a universal block explorer providing detailed chain information and tools for debugging smart contracts and transactions. Visit the [Blockscout Docs](https://docs.blockscout.com/) for details. ###### Supported Networks * Ink Sepolia: [https://explorer-sepolia.inkonchain.com/](https://explorer-sepolia.inkonchain.com/) * API: [https://explorer-sepolia.inkonchain.com/api](https://explorer-sepolia.inkonchain.com/api) ###### Verifying Smart Contract Code on Blockscout * Please see [this tutorial](/build/tutorials/verify-smart-contract) ## Routescan Routescan is a unified explorer for over 54 blockchains. ###### Supported Networks * Ink Sepolia: [https://sepolia.inkonscan.xyz/](https://sepolia.inkonscan.xyz/) * API: [https://sepolia.inkonscan.xyz/documentation/api-swagger](https://sepolia.inkonscan.xyz/documentation/api-swagger) --- ## File: src/content/shared/bridges-content.mdx import { Callout } from 'nextra/components' # Bridges These bridges provide different interfaces to the canonical smart contracts that facilitate migrating ETH from one chain to another. Transaction times vary based on network congestion and gas fees. Please ensure you have enough ETH in your wallet to cover transaction fees. ##### How to use 1. Visit the bridge and connect your wallet. 2. Choose Sepolia as your source and Ink as the destination. 3. Input the amount of assets you want to bridge. 4. Confirm and sign the transaction with your wallet. 5. Once the bridging is complete, the assets will appear in your wallet on Ink. ## Gelato bridge Bridge: [https://bridge-gel-sepolia.inkonchain.com/](https://bridge-gel-sepolia.inkonchain.com/) ## Ink Bridge Bridge: [https://inkonchain.com/bridge](https://inkonchain.com/bridge) ## Brid.gg Bridge: [https://testnet.brid.gg/](https://testnet.brid.gg/) ## Superbridge Bridge: [https://superbridge.app/](https://superbridge.app/) (enable testnet in settings) --- ## File: src/content/shared/community-content.mdx import { URLS } from "@/utils/urls"; # Get Support Join the Ink community, vibe with fellow developers and get support: - Join the Ink Telegram for announcements: [Join Telegram](https://t.me/inkonchain) --- ## File: src/content/shared/crosschain-content.mdx # Crosschain Infrastructure ## Wormhole Wormhole is an interoperability platform powering multichain apps and bridges. * Wormhole currently supports Ink Sepolia. --- ## File: src/content/shared/faucets-content.mdx # Faucets Get Sepolia ETH on Ink from these faucets below! Alternatively, you can [bridge](https://inkonchain.com/bridge) testnet funds to Ink. ## [Ink](https://inkonchain.com/faucet) Our in-house faucet provides a quick and easy way to acquire testnet ETH. ## [Optimism Superchain Faucet](https://console.optimism.io/faucet) The Superchain Faucet provides testnet ETH for Ink and all other OP chains. Sign in to claim 0.10 test ETH on 1 network every 24 hours or verify your onchain identity for more tokens. ## [QuickNode](https://faucet.quicknode.com/drip) Use QuickNode Faucet to claim Ink Sepolia for testnet ETH for free - one drip per network every 12 hours. ## [Gelato](https://faucet-gel-sepolia.inkonchain.com) Gelato's Faucet uses Cloudflare authentication and drops up to 0.3 Ink Sepolia ETH every 12 hours. ## [Tenderly](https://tenderly.co/?mtm_campaign=ext-docs&mtm_kwd=ink) Tenderly's [Unlimited Faucet](https://docs.tenderly.co/virtual-testnets/unlimited-faucet?mtm_campaign=ext-docs&mtm_kwd=ink) allows you to mint native and ERC20 tokens for development and testing on Virtual TestNets. The unlimited faucet is part of the [Admin RPC](https://docs.tenderly.co/virtual-testnets/admin-rpc?mtm_campaign=ext-docs&mtm_kwd=ink), a collection of cheat-codes allowing full customization of the network. --- ## File: src/content/shared/multisig-content.mdx # Multisig ## Safe Ink hosts [Safe](https://docs.safe.global/home/what-is-safe)'s technology to bring digital ownership of accounts to everyone by building universal and open contract standards for the custody of digital assets, data, and identity. Using Safe you can: * Manage customizable non-custodial wallets supporting multisignatures for individuals and teams * Perform financial management of onchain assets incl. ERC20s, ERC721s and ETH * Access your safe using Web, Mobile and Desktop apps. * Safe also features access to DeFi, open source code, batch transactions, modular extensions, gasless signatures and more. **Supported Networks** * [Ink Mainnet](https://app.safe.global/new-safe/load?chain=ink) * [Ink Sepolia](https://safe.optimism.io/welcome/accounts?chain=ink-sepolia)