From 922c0763aa8a549aaf2d24e08dd2e62134fce53e Mon Sep 17 00:00:00 2001 From: ink-victor <171172553+ink-victor@users.noreply.github.com> Date: Fri, 13 Dec 2024 11:49:07 -0500 Subject: [PATCH] feat: update docs content --- next-env.d.ts | 2 +- src/components/TestnetDisclaimer.tsx | 11 ++ src/content/shared/faucets-content.mdx | 35 ++--- src/pages/_meta.json | 2 +- src/pages/build/_meta.json | 6 +- src/pages/build/getting-started.mdx | 24 +++- src/pages/build/run-an-ink-node.mdx | 124 ------------------ .../deploying-a-smart-contract/foundry.mdx | 7 +- .../deploying-a-smart-contract/hardhat.mdx | 10 +- .../deploying-a-smart-contract/remix.mdx | 29 ++-- src/pages/build/useful-info.mdx | 10 -- src/pages/general/_meta.json | 14 +- src/pages/general/bridge.mdx | 3 - src/pages/general/connect-wallet.mdx | 73 ++++------- src/pages/general/faucet.mdx | 3 - src/pages/general/network-information.mdx | 46 ++++--- src/pages/general/support.mdx | 12 +- src/pages/tools/_meta.json | 4 +- src/pages/tools/account-abstraction.mdx | 35 ++--- src/pages/tools/block-explorers.mdx | 20 ++- src/pages/tools/bridges.mdx | 49 ++++++- src/pages/tools/crosschain.mdx | 16 ++- src/pages/tools/rpc.mdx | 106 +++++++++++++++ src/pages/tools/rpcs.mdx | 38 ------ src/pages/useful-information/_meta.json | 10 +- src/pages/useful-information/contracts.mdx | 112 ++++++++++++++++ .../useful-information/ink-contracts.mdx | 68 ---------- 27 files changed, 464 insertions(+), 405 deletions(-) create mode 100644 src/components/TestnetDisclaimer.tsx delete mode 100644 src/pages/build/run-an-ink-node.mdx delete mode 100644 src/pages/build/useful-info.mdx delete mode 100644 src/pages/general/bridge.mdx delete mode 100644 src/pages/general/faucet.mdx create mode 100644 src/pages/tools/rpc.mdx delete mode 100644 src/pages/tools/rpcs.mdx create mode 100644 src/pages/useful-information/contracts.mdx delete mode 100644 src/pages/useful-information/ink-contracts.mdx diff --git a/next-env.d.ts b/next-env.d.ts index a4a7b3f5..52e831b4 100644 --- a/next-env.d.ts +++ b/next-env.d.ts @@ -2,4 +2,4 @@ /// // NOTE: This file should not be edited -// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information. +// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information. diff --git a/src/components/TestnetDisclaimer.tsx b/src/components/TestnetDisclaimer.tsx new file mode 100644 index 00000000..f9602eb5 --- /dev/null +++ b/src/components/TestnetDisclaimer.tsx @@ -0,0 +1,11 @@ +import { Callout } from "nextra/components"; + +export const TestnetDisclaimer = () => { + return ( + + This guide currently references Ink Sepolia (testnet) however it can be + used for Ink mainnet as well. Please be sure to change the necessary + parameters based on your network of choice. + + ); +}; diff --git a/src/content/shared/faucets-content.mdx b/src/content/shared/faucets-content.mdx index e8af22b6..94bc3384 100644 --- a/src/content/shared/faucets-content.mdx +++ b/src/content/shared/faucets-content.mdx @@ -1,32 +1,19 @@ - ## Faucets +# Faucets -Get sepolia ETH from these faucets so you can fund your wallet to send transactions and deploy contracts on Ink Sepolia. You can also [bridge](/quick-start/faucets#bridging-funds-to-ink-sepolia) testnet funds to Ink. +Get sepolia ETH on Ink from these faucets so you can fund your wallet to send transactions and deploy contracts on Ink Sepolia. You can also [bridge](/quick-start/faucets#bridging-funds-to-ink-sepolia) testnet funds to Ink. + +### [Ink](https://inkonchain.com/faucet) -###### Ink Our in house faucet provides a quick and easy way to acquire testnet ETH. - - https://inkonchain.com/faucet -###### Optimism Superchain 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. - - https://console.optimism.io/faucet -###### QuickNode -Use QuickNode Faucet to claim Ink Sepolia for testnet ETH for free - one drip per network every 12 hours. - - https://faucet.quicknode.com/drip -###### Gelato -Gelato's Faucet uses Cloudflare authentication and drops up to 0.3 Ink Sepolia ETH every 12 hours. - - https://faucet-gel-sepolia.inkonchain.com -## Bridging funds to Ink Sepolia +### [Optimism Superchain Faucet](https://console.optimism.io/faucet) -If you need an alternative to the above faucets you can choose to bridge ETH onto Ink Sepolia. +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) -1. Get sepolia ETH by using your wallet with one of the existing faucets on the Ethereum Sepolia network: +Use QuickNode Faucet to claim Ink Sepolia for testnet ETH for free - one drip per network every 12 hours. -* [https://console.optimism.io/faucet](https://console.optimism.io/faucet) -* [https://www.alchemy.com/faucets/ethereum-sepolia](https://www.alchemy.com/faucets/ethereum-sepolia) -* [https://faucet.quicknode.com/ethereum/sepolia](https://faucet.quicknode.com/ethereum/sepolia) -* [https://cloud.google.com/application/web3/faucet/ethereum/sepolia](https://cloud.google.com/application/web3/faucet/ethereum/sepolia) +### [Gelato](https://faucet-gel-sepolia.inkonchain.com) -2. Transfer your ETH to . -- This is the [`L1StandardBridge Contract`](https://eth-sepolia.blockscout.com/address/0x33f60714BbD74d62b66D79213C348614DE51901C). -- This contract will help you send your ETH from Sepolia to Ink Sepolia. -- Once the transaction is confirmed you will quickly receive Ink ETH in your wallet. +Gelato's Faucet uses Cloudflare authentication and drops up to 0.3 Ink Sepolia ETH every 12 hours. diff --git a/src/pages/_meta.json b/src/pages/_meta.json index f9a7c4fd..71a878ae 100644 --- a/src/pages/_meta.json +++ b/src/pages/_meta.json @@ -118,4 +118,4 @@ "pagination": false } } -} \ No newline at end of file +} diff --git a/src/pages/build/_meta.json b/src/pages/build/_meta.json index 48b59881..1ed0125f 100644 --- a/src/pages/build/_meta.json +++ b/src/pages/build/_meta.json @@ -1,7 +1,11 @@ { "getting-started": "Getting Started", "onchain-clients": "Onchain Clients", - "run-an-ink-node": "Running Ink Nodes", + "run-an-ink-node": { + "title": "Running Ink Nodes", + "href": "https://github.com/inkonchain/node", + "newWindow": true + }, "transaction-fees": "Transaction Fees", "ink-kit": "Ink Kit", "tutorials": "Tutorials" diff --git a/src/pages/build/getting-started.mdx b/src/pages/build/getting-started.mdx index a5f27a79..7cdb48df 100644 --- a/src/pages/build/getting-started.mdx +++ b/src/pages/build/getting-started.mdx @@ -1,3 +1,23 @@ -# Getting Started +import { Callout, Checkbox } from "nextra/components"; -## TODO +# What do I Need to Start Developing on Ink? + +To start developing on Ink, you'll need: + +✓ An IDE (integrated developer environment) like [Visual Studio Code](https://code.visualstudio.com/), [Cursor](https://cursor.sh/), or [Remix](https://remix.ethereum.org/) to write smart contracts in solidity. + +✓ A wallet that holds ETH such as [Kraken Wallet](https://www.kraken.com/wallet), [MetaMask](https://metamask.io/), or [Rainbow](https://rainbow.me/). + +- We suggest having at least 0.01 ETH for standard deployments on Ink. +- You can request Ink Sepolia ETH using our [Faucets](/tools/faucets). + +✓ We recommend using a development framework like [Foundry](https://book.getfoundry.sh/) or [Hardhat](https://hardhat.org/) + +- [Guide to deploy a contract using Foundry](/build/tutorials/deploying-a-smart-contract/foundry) +- [Guide to deploy a contract using Hardhat](/build/tutorials/deploying-a-smart-contract/hardhat) +- [Guide to deploy a contract using Remix](/build/tutorials/deploying-a-smart-contract/remix) + + + Try out InkGPT! Blaze through the docs and get deployed in no time with our + new AI assistant. + diff --git a/src/pages/build/run-an-ink-node.mdx b/src/pages/build/run-an-ink-node.mdx deleted file mode 100644 index aea957e3..00000000 --- a/src/pages/build/run-an-ink-node.mdx +++ /dev/null @@ -1,124 +0,0 @@ -import { Callout } from 'nextra/components' - -# Running an Ink Node - -Welcome to the [Ink Node] setup tutorial. Follow these steps to deploy and sync your own node efficiently. - -## Tutorial Goals - -By the end of this guide, you will: - -- Successfully deploy an [Ink Node]. -- Ensure your node is in sync with the network. - -## Before You Begin - - -Running a node is resource-intensive and time-consuming. Make sure you have a clear purpose for setting up your node. - -For those starting out and needing an RPC URL, our free endpoints are available: - -- **Mainnet**: `not available yet` -- **Testnet (Sepolia)**: `https://rpc-gel-sepolia.inkonchain.com/` - -**Note:** These RPCs are rate-limited and unsuitable for production applications. - - - -Don't want to run your own node? [QuickNode](https://www.quicknode.com/chains/ink) offers managed Ink nodes with APIs, tools, and an easy-to-use control panel. - - -### System Requirements - -To run a node, your system should meet these minimum specifications: - -- 8-Core CPU -- 16 GB RAM or more -- Locally attached NVMe SSD with sufficient storage: - - **Full Node:** Minimum 3TB recommended - - **Archive Node:** Minimum 12TB recommended - - -Chain data grows continuously with network activity. We recommend monitoring your storage usage and planning for additional capacity over time. - - -Running an archive node will require significantly more resources. For optimal performance with higher RPC traffic, consider scaling up CPU and RAM beyond the minimum specifications. - -### Software Prerequisites - -Ensure [Docker] is installed and running on your machine. Familiarity with [Docker] is assumed. - -### Sepolia L1 RPC URL - -To run the Sepolia Ink node, it's required to bring your own L1 Sepolia Node. We suggest using [QuickNode](https://www.quicknode.com/) for this purpose. - -To set up a node on [QuickNode](https://www.quicknode.com/), follow these steps: - -1. Create an account if you don’t have one. -2. Log in and select the option to create an endpoint. -3. Select ETH, then choose Sepolia, and click on Continue. -4. You’ll see a few add-ons; some are free and use your credits (these credits are added if your account is new). -5. After selecting add-ons, click on Create Endpoint. You’ll receive both Beacon and RPC URLs. - -## Step-by-Step Guide - -1. **Clone the Repository:** [Ink Node repository](https://github.com/inkonchain/node). - -2. **Run Setup Script:** - ```sh - ./setup.sh - ``` - -3. **Start the Node:** - ```sh - docker compose up # --build to force rebuild the images - ``` - - -Syncing your node may take several days. Monitor usage and plan accordingly. - - -## Verifying Sync Status - -### Using op-node API - -Check the sync status using the `optimism_syncStatus` method: -```sh -curl -X POST -H "Content-Type: application/json" --data \ - '{"jsonrpc":"2.0","method":"optimism_syncStatus","params":[],"id":1}' \ - http://localhost:9545 | jq -``` - -### Using op-geth API - -To verify if your node is fully synced, use the `eth_blockNumber` method: -```sh -curl http://localhost:8545 -X POST \ - -H "Content-Type: application/json" \ - --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params": [],"id":1}' | jq -r .result | sed 's/^0x//' | awk '{printf "%d\n", "0x" $0}'; -``` - -A synced node will display the latest block number as seen on the [block explorer](https://explorer-sepolia.inkonchain.com/). - -### Comparing with Ink Public RPC - -Compare your local node's finalized block with the public RPC block: -```sh -local_block=$(curl -s -X POST http://localhost:8545 -H "Content-Type: application/json" \ - --data '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["finalized", false],"id":1}' \ - | jq -r .result.number | sed 's/^0x//' | awk '{printf "%d\n", "0x" $0}'); \ -public_rpc_block=$(curl -s -X POST https://rpc-gel-sepolia.inkonchain.com/ -H "Content-Type: application/json" \ - --data '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["finalized", false],"id":1}' \ - | jq -r .result.number | sed 's/^0x//' | awk '{printf "%d\n", "0x" $0}'); \ -echo -e "Local finalized block: $local_block\nRemote finalized block: $public_rpc_block" -``` - -A synced node will have equal local and remote finalized blocks: -```text -Local finalized block: 4449608 -Remote finalized block: 4449608 -``` - -[docker]: https://www.docker.com/ -[ink node]: https://github.com/inkonchain/node -[repo]: https://github.com/inkonchain/node diff --git a/src/pages/build/tutorials/deploying-a-smart-contract/foundry.mdx b/src/pages/build/tutorials/deploying-a-smart-contract/foundry.mdx index 07773dc7..da4ea397 100644 --- a/src/pages/build/tutorials/deploying-a-smart-contract/foundry.mdx +++ b/src/pages/build/tutorials/deploying-a-smart-contract/foundry.mdx @@ -1,6 +1,7 @@ -import CopyableCode from '@/components/CopyableCode' +import CopyableCode from "@/components/CopyableCode"; +import { TestnetDisclaimer } from "@/components/TestnetDisclaimer"; -# Getting Started with Foundry on INK +# Deploying a Smart Contract with Foundry This guide will walk you through setting up a new project using Foundry, a blazing fast toolkit for Ethereum application development written in Rust. @@ -183,3 +184,5 @@ inksepolia = "${INKSEPOLIA_RPC_URL}" ## Next Steps - Check out [Get Foundry Book](https://book.getfoundry.sh/) for more information on Foundry. + + diff --git a/src/pages/build/tutorials/deploying-a-smart-contract/hardhat.mdx b/src/pages/build/tutorials/deploying-a-smart-contract/hardhat.mdx index 6336608c..3ddd5349 100644 --- a/src/pages/build/tutorials/deploying-a-smart-contract/hardhat.mdx +++ b/src/pages/build/tutorials/deploying-a-smart-contract/hardhat.mdx @@ -1,4 +1,6 @@ -# Getting Started with Hardhat on INK +import { TestnetDisclaimer } from "@/components/TestnetDisclaimer"; + +# Deploying a Smart Contract with Hardhat This guide will walk you through setting up a new project using Hardhat, a popular development environment for Ethereum software. @@ -53,7 +55,7 @@ pragma solidity ^0.8.19; contract InkContract { string public greeting = "Hello, Ink!"; - + function setGreeting(string memory _greeting) public { greeting = _greeting; } @@ -155,7 +157,7 @@ main() }); ``` -Deploy to INK Sepolia testnet: +Deploy to Ink Sepolia testnet: ```bash npx hardhat run scripts/deploy.js --network inksepolia @@ -202,3 +204,5 @@ npx hardhat node ## Next Steps - Explore [Hardhat Documentation](https://hardhat.org/docs) for more features + + diff --git a/src/pages/build/tutorials/deploying-a-smart-contract/remix.mdx b/src/pages/build/tutorials/deploying-a-smart-contract/remix.mdx index cdce2838..0647ab40 100644 --- a/src/pages/build/tutorials/deploying-a-smart-contract/remix.mdx +++ b/src/pages/build/tutorials/deploying-a-smart-contract/remix.mdx @@ -1,8 +1,9 @@ -import { Callout } from 'nextra/components' +import { Callout } from "nextra/components"; +import { TestnetDisclaimer } from "@/components/TestnetDisclaimer"; -# Getting Started with Remix IDE on INK +# Deploying a Smart Contract with Remix -This guide will walk you through deploying a smart contract on INK using Remix IDE, a popular browser-based development environment for Ethereum smart contracts. +This guide will walk you through deploying a smart contract on Ink using Remix IDE, a popular browser-based development environment for Ethereum smart contracts. ## What is Remix? @@ -24,12 +25,13 @@ pragma solidity ^0.8.19; contract InkContract { string public greeting = "Hello, Ink!"; - + function setGreeting(string memory _greeting) public { greeting = _greeting; } } ``` + ![inkContract.sol](src/images/remix_deploy_1.png) ## Compiling Your Contract @@ -41,18 +43,18 @@ contract InkContract { ![inkContract.sol](src/images/remix_deploy_2.png) -## Connecting to INK Network +## Connecting to Ink Network 1. On the left sidebar, click the `Deploy & run transactions` tab (represented by a deployment arrow icon ▶️) 2. In the `ENVIRONMENT` dropdown: - If you see `Injected Provider`, select it - If not visible, click `Customize this list...` in dropdown - In the opened "Environment Explorer" window, under "Deploy using a Browser Extension" section, select `Injected Provider - [WALLET_NAME]`, where [WALLET_NAME] is your connected Web3 wallet (e.g., MetaMask, Rabby) -3. Configure your preferred Web3 wallet with INK Sepolia network details: - - Network Name: INK Sepolia +3. Configure your preferred Web3 wallet with Ink Sepolia network details: + - Network Name: Ink Sepolia - RPC URL: https://rpc-gel-sepolia.inkonchain.com/ - Chain ID: 763373 - - Currency Symbol: INK + - Currency Symbol: Ink - Block Explorer URL: https://explorer-sepolia.inkonchain.com/ Most modern Web3 wallets will allow you to add custom networks through their settings. Look for options like `Add Network`, `Custom RPC`, or `Networks` in your wallet's interface. @@ -62,11 +64,13 @@ Most modern Web3 wallets will allow you to add custom networks through their set ## Deploying Your Contract 1. Before deploying, ensure: - - Your Web3 wallet is connected to INK Sepolia network + + - Your Web3 wallet is connected to Ink Sepolia network - You have sufficient ETH for deployment - Your wallet is connected to Remix IDE (accept the connection prompt if shown) 2. In the "Deploy & Run Transactions" tab: + - Select `InkContract` from the `CONTRACT` dropdown - Click `Deploy` - A popup from your wallet will appear - review and confirm the transaction @@ -91,7 +95,7 @@ Most modern Web3 wallets will allow you to add custom networks through their set See also the respective [tutorial](/build/tutorials/verify-smart-contract). -1. Go to [INK Blockscout](https://explorer-sepolia.inkonchain.com) +1. Go to [Ink Blockscout](https://explorer-sepolia.inkonchain.com) 2. Find your contract by its address 3. Click `Verify & Publish` 4. Fill in the verification details: @@ -102,7 +106,8 @@ See also the respective [tutorial](/build/tutorials/verify-smart-contract). - Click `Verify & Publish` - Make sure to verify whether optimization is on or off in Remix Compiler's Advanced Configuration as this can affect verification success. + Make sure to verify whether optimization is on or off in Remix Compiler's + Advanced Configuration as this can affect verification success. ## Tips and Best Practices @@ -123,3 +128,5 @@ See also the respective [tutorial](/build/tutorials/verify-smart-contract). - Explore [Remix Documentation](https://remix-ide.readthedocs.io/) for advanced features - Learn about [Solidity](https://docs.soliditylang.org/) programming + + diff --git a/src/pages/build/useful-info.mdx b/src/pages/build/useful-info.mdx deleted file mode 100644 index 677ef7cd..00000000 --- a/src/pages/build/useful-info.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# Useful Information - -Welcome to the useful information section! Here you'll find important references and data for building on Ink - -## Available Resources - -- [Network Information](/general/network-information) -- [Ink Contracts](/useful-information/ink-contracts) -- [Ink Token Contracts](/useful-information/ink-token-contracts) -- [Chain Security](/useful-information/chain-security) diff --git a/src/pages/general/_meta.json b/src/pages/general/_meta.json index 7fca67a9..ce47cc48 100644 --- a/src/pages/general/_meta.json +++ b/src/pages/general/_meta.json @@ -1,8 +1,8 @@ { - "about": "About Ink", - "network-information": "Network Information", - "connect-wallet": "Connect Wallet", - "bridge": "Bridge", - "faucet": "Faucet", - "support": "Support" -} \ No newline at end of file + "about": "About Ink", + "network-information": "Network Information", + "connect-wallet": "Connect Wallet", + "bridge": { "title": "Bridge", "href": "/tools/bridges" }, + "faucet": { "title": "Faucet", "href": "/tools/faucets" }, + "support": "Support" +} diff --git a/src/pages/general/bridge.mdx b/src/pages/general/bridge.mdx deleted file mode 100644 index 8fb1d53c..00000000 --- a/src/pages/general/bridge.mdx +++ /dev/null @@ -1,3 +0,0 @@ -import { BridgesContentWrapper } from '@/components/BridgesContentWrapper' - - diff --git a/src/pages/general/connect-wallet.mdx b/src/pages/general/connect-wallet.mdx index 2175684b..581e73fc 100644 --- a/src/pages/general/connect-wallet.mdx +++ b/src/pages/general/connect-wallet.mdx @@ -2,70 +2,41 @@ import { Callout } from "nextra/components"; import CopyableCode from "@/components/CopyableCode"; import { AddNetworkButton } from "../../components/AddNetworkButton"; -# Get Connected +## Connect Wallet -The button below will add the Ink Sepolia network to your wallet: +## Automatically add Ink to your wallet -## Network Information +_copy_ -| Field | Information | -| -------------------------------- | -------------------------------------------------------------- | -| Network Name | Ink Sepolia | -| Description | Ink's public testnet | -| RPC Endpoint (HTTPS) (primary) | | -| RPC Endpoint (WSS) (primary) | | -| RPC Endpoint (HTTPS) (secondary) | | -| RPC Endpoint (WSS) (secondary) | | -| Chain ID | 763373 | -| Currency Symbol | ETH | -| Block Explorer | https://explorer-sepolia.inkonchain.com | +--- -Additional RPC endpoints can be found [here](/build/tools/rpcs). +## Kraken Wallet -## What do I Need to Start Developing on Ink? +Insert copy -1. An IDE (integrated developer environment) like [Visual Studio Code](https://code.visualstudio.com/), [Cursor](https://www.cursor.com), or [Remix](https://remix.ethereum.org/) to write smart contracts in solidity. -1. A wallet that holds ETH such as [Kraken Wallet](https://www.kraken.com/wallet), [MetaMask](https://metamask.io/), or [Rainbow](https://rainbow.me/). - - We suggest having at least 0.01 ETH for standard deployments on Ink. - - You can request Ink Sepolia ETH using our [Faucets](/quick-start/faucets). -1. We recommend using a development framework like [Foundry](https://book.getfoundry.sh/) or [Hardhat](https://hardhat.org/) - - [Guide to deploy a contract using Foundry](/build/tutorials/deploying-a-smart-contract/foundry) - - [Guide to deploy a contract using Hardhat](/build/tutorials/deploying-a-smart-contract/hardhat) - - [Guide to deploy a contract using Remix](/build/tutorials/deploying-a-smart-contract/remix) +--- - - Try out [InkGPT](https://chatgpt.com/g/g-ef8AAM6s4-inkkit-assistant)! Blaze - through the docs and get deployed in no time with our new AI assistant. - +## MetaMask -## Connecting to Ink +Insert copy -### Connecting MetaMask Wallet to Ink Sepolia (Testnet) +--- -** Click the button at the top of the page to add the network to your wallet ** +## Rainbow -To manually add Ink Sepolia as a custom network do following: +Insert copy - 1. Open your MetaMask browser extension. - 2. Open the network selection dropdown menu by clicking the dropdown button at the top left of the extension. - 3. Click the "+ Add network" button at the bottom. - 4. A new window should open. Click "Add a network manually" at the bottom of the list. - 5. In the dialog that appears, enter the information listed in [Network Information](#network-information). See screenshot below. - 6. Click "Save". - 7. When clicking on the network selection dropdown you can now select Ink Sepolia to connect to. +--- -Next: get some [testnet ETH](/quick-start/faucets) from our faucets! +## Mainnet -![Tux, the Linux mascot](../../images/add_network.png) - -###### Fund your Wallet - -Get testnet Ether (ETH) from these faucets so you can fund your wallet to send transactions and deploy contracts on Ink Sepolia. - -Check out faucets [here](/quick-start/faucets). Alternatively, you can [bridge](/quick-start/faucets#bridging-funds-to-ink-sepolia) testnet funds. - -## What Next? - -Check out the [tutorials](/build/tutorials/deploying-a-smart-contract/foundry) to learn how to deploy contracts on Ink and more! +| Field | Information | +| ------------------------------ | -------------------- | +| Network Name | Ink | +| Description | Ink's public mainnet | +| RPC Endpoint (HTTPS) (primary) | coming soon | +| Chain ID | coming soon | +| Currency Symbol | ETH | +| Block Explorer | coming soon | diff --git a/src/pages/general/faucet.mdx b/src/pages/general/faucet.mdx deleted file mode 100644 index dba2fbea..00000000 --- a/src/pages/general/faucet.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Faucets - -## TODO diff --git a/src/pages/general/network-information.mdx b/src/pages/general/network-information.mdx index 954e76f4..c1174ddc 100644 --- a/src/pages/general/network-information.mdx +++ b/src/pages/general/network-information.mdx @@ -1,19 +1,35 @@ -import CopyableCode from '@/components/CopyableCode' +import CopyableCode from "@/components/CopyableCode"; -# Network information +# Network Information -| Field | Information | -| -------------------------------- | ---------------------------------------------------------------------------------- | -| Network Name | Ink sepolia | -| Description | Ink's public testnet | -| RPC Endpoint (HTTPS) (primary) | | -| RPC Endpoint (WSS) (primary) | | -| RPC Endpoint (HTTPS) (secondary) | | -| RPC Endpoint (WSS) (secondary) | | -| Chain ID | 763373 | -| Currency Symbol | ETH | -| Block Explorer | https://explorer-sepolia.inkonchain.com | +## Mainnet -## Alternative Endpoints +| Field | Information | +| -------------------------------- | -------------------- | +| Network Name | Ink | +| Description | Ink's public mainnet | +| RPC Endpoint (HTTPS) (primary) | coming soon | +| RPC Endpoint (WSS) (primary) | coming soon | +| RPC Endpoint (HTTPS) (secondary) | coming soon | +| RPC Endpoint (WSS) (secondary) | coming soon | +| Chain ID | coming soon | +| Currency Symbol | ETH | +| Block Explorer | coming soon | -See [RPCs](/build/tools/rpcs). +--- + +## Testnet + +| Field | Information | +| -------------------------------- | --------------------------------------------------------------- | +| Network Name | Ink Sepolia | +| Description | Ink's public testnet | +| RPC Endpoint (HTTPS) (primary) | | +| RPC Endpoint (WSS) (primary) | | +| RPC Endpoint (HTTPS) (secondary) | | +| RPC Endpoint (WSS) (secondary) | | +| Chain ID | 763373 | +| Currency Symbol | ETH | +| Block Explorer | | + +Click [here](/tools/rpc) for a list of vendors offering private RPC endpoints. diff --git a/src/pages/general/support.mdx b/src/pages/general/support.mdx index 817e0563..ead9559b 100644 --- a/src/pages/general/support.mdx +++ b/src/pages/general/support.mdx @@ -1,3 +1,11 @@ -import { CommunityContentWrapper } from '@/components/CommunityContentWrapper' +import { URLS } from "@/utils/urls"; - +# Support + +At Ink, we're here to help everyone, builders and users alike. + +Please don't hesitate to reach out to us via any of our channels listed below. + +- [Discord](http://discord.gg/inkonchain) +- [Telegram](https://t.me/inkonchain) +- [Twitter](https://x.com/inkonchain) diff --git a/src/pages/tools/_meta.json b/src/pages/tools/_meta.json index 71e6b61a..02844191 100644 --- a/src/pages/tools/_meta.json +++ b/src/pages/tools/_meta.json @@ -7,7 +7,7 @@ "indexers": "Indexers", "multisig": "Multisig", "oracles": "Oracles", - "rpcs": "RPCs", + "rpc": "RPC", "security": "Security", "vrf": "VRF" -} \ No newline at end of file +} diff --git a/src/pages/tools/account-abstraction.mdx b/src/pages/tools/account-abstraction.mdx index ed461288..9924a291 100644 --- a/src/pages/tools/account-abstraction.mdx +++ b/src/pages/tools/account-abstraction.mdx @@ -1,36 +1,19 @@ -# Account Abstraction Solutions +# Account Abstraction -## ZeroDev -ZeroDev is a chain abstracted smart account for building user-friendly Web3 experiences. Leveraging ERC-4337, it offers you the ability to enable flexible authentication, sponsor gas and bundle transactions for users. +## [ZeroDev](https://dashboard.zerodev.app/) -- ZeroDev for Ink Sepolia can be accessed through the ZeroDev dashboard: https://dashboard.zerodev.app/ -- ZeroDev documentation can be found [here](https://docs.zerodev.app/). +ZeroDev is a chain abstracted smart account for building user-friendly Web3 experiences. Leveraging ERC-4337, it offers you the ability to enable flexible authentication, sponsor gas and bundle transactions for users. Check out ZeroDevs [docs](https://docs.zerodev.app/) to learn more. **Supported Networks**: -- Ink Sepolia - -## Safe -Deployed by the Protofire team, you can access Safe’s modular smart account infrastructure and account abstraction tooling. -**Supported Networks**: +- Ink Mainnet - Ink Sepolia +## Safe -## What is Account Abstraction? - -Ethereum and EVM-based blockchains currently operate with two types of accounts: Externally Owned Accounts (EOAs) and smart contract accounts. EOAs are what users use when interacting with their wallets and the blockchain. Smart contract accounts are controlled by code that was deployed onchain. - -### Limitations of EOAs - -While EOAs are extremely common they come with some drawbacks. For example: - -* You have to pay fees whenever you do something onchain, which means you can't do anything if your account (EOA) doesn't have ETH in it. -* Your EOA is secured by a private key, which can be stolen or lost -* You can't build smart logic around EOAs like e.g. automatic payments. - -### The Solution: Account Abstraction +Access Safe’s full suite of tooling including modular smart account infrastructure and account abstraction SDK. -Account Abstraction (AA) is a solution that: +**Supported Networks**: -* Enables you to build logic around EOAs, making them smarter and more secure. For example, with AA you can make sure there are additional recovery options when you lose access to your account. -* AA also increases the possibilities of what you can do with an account, like building a multi-factor authentication mechanism around it and improving UX by managing fee payments in the background. +- Ink Mainnet +- [Ink Sepolia](https://safe.optimism.io/welcome/accounts?chain=ink-sepolia) diff --git a/src/pages/tools/block-explorers.mdx b/src/pages/tools/block-explorers.mdx index 6dcfe342..cf2adb44 100644 --- a/src/pages/tools/block-explorers.mdx +++ b/src/pages/tools/block-explorers.mdx @@ -1,3 +1,19 @@ -import { BlockExplorersContentWrapper } from '@/components/BlockExplorersContentWrapper' +# Block Explorer - +## [Blockscout](https://explorer.inkonchain.com/) + +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 Mainnet](https://explorer.inkonchain.com/) +- [Ink Sepolia](https://explorer-sepolia.inkonchain.com/) + +## [Routescan](https://inkonscan.xyz/) + +Routescan is a unified explorer for over 54 blockchains. + +###### Supported Networks + +- [Ink Mainnet](https://inkonscan.xyz/) **_tentative_** +- [Ink Sepolia](https://sepolia.inkonscan.xyz/) diff --git a/src/pages/tools/bridges.mdx b/src/pages/tools/bridges.mdx index 8fb1d53c..f6a9f1b7 100644 --- a/src/pages/tools/bridges.mdx +++ b/src/pages/tools/bridges.mdx @@ -1,3 +1,48 @@ -import { BridgesContentWrapper } from '@/components/BridgesContentWrapper' +import { Callout } from "nextra/components"; - +# Bridges + + + Transaction times vary based on network congestion and gas fees. Please ensure + you have enough ETH in your wallet to cover transaction fees. + + +## [Across](https://across.io) + +Using a network of solvers, Across allows users to seemlessly bridge from L1 to L2 and back without the 7 day waiting period. + +**Supported Networks** + +- Ink Mainnet +- Ink Sepolia + +## [Brid.gg](https://brid.gg/) + +Brid.gg provides a seemless bridging experience with XYZ. + +**Supported Networks** + +- Ink Mainnet +- Ink Sepolia + +## [Superbridge](https://superbridge.app/) + +Superbridge provides a seemless bridging experience with XYZ. + +**Supported Networks** + +- Ink Mainnet +- Ink Sepolia + +## [Gelato](http://bridge-gel.inkonchain.com/) + +**Supported Networks** + +- Ink Mainnet +- Ink Sepolia + +## Ink + +**Supported Networks** + +- [Ink Sepolia](https://inkonchain.com/bridge) diff --git a/src/pages/tools/crosschain.mdx b/src/pages/tools/crosschain.mdx index bfa2a9e1..40720ee0 100644 --- a/src/pages/tools/crosschain.mdx +++ b/src/pages/tools/crosschain.mdx @@ -1,3 +1,15 @@ -import { CrosschainContentWrapper } from '@/components/CrosschainContentWrapper' +# Crosschain Infrastructure - +## [LayerZero](https://docs.layerzero.network/v2/home/getting-started/what-is-layerzero) + +**Supported Networks** + +- Ink Mainnet +- Ink Sepolia + +## [Wormhole](https://wormhole.com/docs/) + +**Supported Networks** + +- Ink Mainnet (coming soon) +- Ink Sepolia diff --git a/src/pages/tools/rpc.mdx b/src/pages/tools/rpc.mdx new file mode 100644 index 00000000..4d178cf5 --- /dev/null +++ b/src/pages/tools/rpc.mdx @@ -0,0 +1,106 @@ +import { Callout } from "nextra/components"; +import CopyableCode from "@/components/CopyableCode"; + +# RPC + +## [Gelato](https://gelato.network) + +Gelato provides public and private RPC endpoints for Ink, along with websocket support. + +**Supported Networks** + +- Ink (mainnet) +- Ink Sepolia (testnet) + +## [QuickNode](https://www.quicknode.com) + +QuickNode provides public and private RPC endpoints for Ink, along with websocket support and a suite of tools to help you ship. + +**Supported Networks** + +- Ink (mainnet) +- Ink Sepolia (testnet) + + + Need a managed node solution? + [QuickNode](https://www.quicknode.com/chains/ink) offers Ink nodes with APIs, + tools, and an easy-to-use control panel. + + +## [Tenderly](https://tenderly.co) + +Tenderly provides robust RPC infrastructure with advanced debugging capabilities and comprehensive monitoring tools. + +**Supported Networks** + +- Ink (mainnet) +- Ink Sepolia (testnet) + + + Looking for advanced debugging tools? + [Tenderly](https://tenderly.co/networks/ink) provides detailed transaction + insights and monitoring capabilities for Ink. + + +
+
+
+ +# Public Endpoints + +To access Ink Sepolia (testnet) and Ink (mainnet), you can choose from several RPC providers. Each provider offers reliable infrastructure with different features and capabilities. + + + Interested in running your own node? Check out [our + tutorial](/build/run-an-ink-node). + + +### 1. Gelato + +Gelato provides high-performance, globally distributed RPC endpoints with automatic failover. + +#### Ink (mainnet) + +- HTTPS: +- Websocket: + +#### Ink Sepolia + +- HTTPS: +- Websocket: + +--- + +### 2. Tenderly + +Tenderly provides robust RPC endpoints with detailed transaction debugging capabilities. + +#### Ink (mainnet) + +- HTTPS: +- Websocket: + +#### Ink Sepolia + +- HTTPS: +- Websocket: + +### 3. QuickNode + +QuickNode provides public and private RPC endpoints for Ink, along with websocket support and a suite of tools to help you ship. + +#### Ink (mainnet) + +- HTTPS: +- Websocket: + +#### Ink Sepolia + +- HTTPS: +- Websocket: + + + Need a managed node solution? + [QuickNode](https://www.quicknode.com/chains/ink) offers private Ink nodes + with APIs, tools, and an easy-to-use control panel. + diff --git a/src/pages/tools/rpcs.mdx b/src/pages/tools/rpcs.mdx deleted file mode 100644 index 92424a09..00000000 --- a/src/pages/tools/rpcs.mdx +++ /dev/null @@ -1,38 +0,0 @@ -import { Callout } from 'nextra/components' -import CopyableCode from '@/components/CopyableCode' - - - Interested in running your own node? Check out [our tutorial](/build/run-an-ink-node). - - -## Public Endpoints (Ink Sepolia) -To access Ink Sepolia, feel free to use one of the public endpoints below: - -###### Gelato -- HTTPS: -- Websocket: - -###### QuickNode -- HTTPS: -- Websocket: - -###### Tenderly -- HTTPS: -- Websocket: - - -## Gelato -Gelato provides public and private RPC endpoints for Ink, along with websocket support. - -**Supported Networks** -- Ink Sepolia - -## QuickNode -QuickNode provides public and private RPC endpoints for Ink, along with websocket support and a suite of tools to help you ship. - -**Supported Networks** -- Ink Sepolia - - -Need a managed node solution? [QuickNode](https://www.quicknode.com/chains/ink) offers Ink nodes with APIs, tools, and an easy-to-use control panel. - diff --git a/src/pages/useful-information/_meta.json b/src/pages/useful-information/_meta.json index e82051bf..a5b28062 100644 --- a/src/pages/useful-information/_meta.json +++ b/src/pages/useful-information/_meta.json @@ -1,6 +1,6 @@ { - "ink-contracts": "Ink Contracts", - "ink-token-contracts": "Ink Token Contracts", - "chain-security": "Chain Security", - "the-superchain": "The Superchain" -} \ No newline at end of file + "contracts": "Contracts", + "ink-token-contracts": "Ink Token Contracts", + "chain-security": "Chain Security", + "the-superchain": "The Superchain" +} diff --git a/src/pages/useful-information/contracts.mdx b/src/pages/useful-information/contracts.mdx new file mode 100644 index 00000000..2c2c7cd8 --- /dev/null +++ b/src/pages/useful-information/contracts.mdx @@ -0,0 +1,112 @@ +import { Callout } from "nextra/components"; +import CopyableCode from "@/components/CopyableCode"; + +# Ink Contract Addresses + +### Ink L2 Contract Addresses + +#### Ink Mainnet + +| Contract Name | Contract Address | +| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| L2CrossDomainMessenger | | +| L2StandardBridge | | +| OptimismMintableERC20Factory | | +| GasPriceOracle | | +| L2ToL1MessagePasser | | +| L2ERC721Bridge | | +| OptimismMintableERC721Factory | | +| ProxyAdmin | | +| BaseFeeVault | | +| L1FeeVault | | +| SequencerFeeVault | | +| EAS | | +| SchemaRegistry | | +| WETH9 | | + + + These addresses are predeterministic and the same on Ink Sepolia- see + [documentation](https://specs.optimism.io/protocol/predeploys.html). + + +### L1 Contract Addresses + +#### Ethereum Mainnet + +| Contract Name | Contract Address | +| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ProxyAdmin | | +| SystemConfig | | +| AddressManager | | +| L1ERC721Bridge | | +| OptimismPortal | | +| L1StandardBridge | | +| DisputeGameFactory | | +| AnchorStateRegistry | | +| L1CrossDomainMessenger | | +| DelayedWETHPermissionedGame | | +| OptimismMintableERC20Factory | | + +#### Sepolia + +| Contract Name | Contract Address | +| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ProxyAdmin | | +| SystemConfig | | +| AddressManager | | +| L1ERC721Bridge | | +| OptimismPortal | | +| L1StandardBridge | | +| DisputeGameFactory | | +| AnchorStateRegistry | | +| L1CrossDomainMessenger | | +| DelayedWETHPermissionedGame | | +| OptimismMintableERC20Factory | | + +### Pre Installs + +#### Ink Mainnet + +| Contract Name | Contract Address | +| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Safe | | +| SafeL2 | | +| MultiSend | | +| MultiSendCallOnly | | +| SafeSingletonFactory | | +| Multicall3 | | +| Create2Deployer | | +| CreateX | | +| Arachnid's Deterministic Deployment Proxy | | +| Permit2 | | +| ERC-4337 v0.6.0 EntryPoint | | +| ERC-4337 v0.6.0 SenderCreator | | +| ERC-4337 v0.7.0 EntryPoint | | +| ERC-4337 v0.7.0 SenderCreator | | + +For more information on these preinstalls, take a look at the [Optimism Specs](https://specs.optimism.io/protocol/preinstalls.html). + +#### Ink Sepolia + +| Contract Name | Contract Address | +| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Safe | | +| SafeL2 | | +| MultiSend | | +| MultiSendCallOnly | | +| SafeSingletonFactory | | +| Multicall3 | | +| Create2Deployer | | +| CreateX | | +| Arachnid's Deterministic Deployment Proxy | | +| Permit2 | | +| ERC-4337 v0.6.0 EntryPoint | | +| ERC-4337 v0.6.0 SenderCreator | | +| ERC-4337 v0.7.0 EntryPoint | | +| ERC-4337 v0.7.0 SenderCreator | | + +## Contract Deployments - Instructions for Developers + +###### Contract Verification + +Please see [how to verify contracts](/build/tutorials/verify-smart-contract). diff --git a/src/pages/useful-information/ink-contracts.mdx b/src/pages/useful-information/ink-contracts.mdx deleted file mode 100644 index a7dedc52..00000000 --- a/src/pages/useful-information/ink-contracts.mdx +++ /dev/null @@ -1,68 +0,0 @@ -import { Callout } from 'nextra/components' -import CopyableCode from '@/components/CopyableCode' - -# Contract Addresses - -## Utility Contracts - -| Contract Name | Contract Address | -| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| WETH9 | | -| Multicall3 | | -| Multicall2 | | -| Multicall | | -| MultiSend | | -| MultiSendCallOnly | | -| Safe | | -| SafeL2 | | -| SafeSingletonFactory | | -| Create2Deployer | | -| CreateX | | -| Arachnid's Deterministic Deployment Proxy | | -| Permit2 | | -| ERC-4337 v0.6.0 EntryPoint | | -| ERC-4337 v0.6.0 SenderCreator | | -| ERC-4337 v0.7.0 EntryPoint | | -| ERC-4337 v0.7.0 SenderCreator | | - -For more information on these preinstalls, take a look at the [Optimism Specs](https://specs.optimism.io/protocol/preinstalls.html). - -## Ink Testnet Contracts - - - These addresses are pre-determined by Optimism - see [documentation](https://specs.optimism.io/protocol/predeploys.html). - - -| Contract Name | Contract Address | -| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| L2CrossDomainMessenger | | -| L2StandardBridge | | -| OptimismMintableERC20Factory | | -| GasPriceOracle | | -| L2ToL1MessagePasser | | -| L2ERC721Bridge | | -| OptimismMintableERC721Factory | | -| ProxyAdmin | | -| BaseFeeVault | | -| L1FeeVault | | - -## L1 Testnet Contracts (Sepolia) - -| Contract Name | Contract Address | -| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------| -| L1StandardBridge | | -| ProxyAdmin | | -| SystemConfig | | -| AddressManager | | -| L1ERC721Bridge | | -| OptimismPortal | | -| DisputeGameFactory | | -| AnchorStateRegistry | | -| L1CrossDomainMessenger | | -| DelayedWETHPermissionedGame | | -| OptimismMintableERC20Factory | | - -## Contract Deployments - Instructions for Developers - -###### Contract Verification -Please see [how to verify contracts](/build/tutorials/verify-smart-contract).