Skip to content

Commit 922c076

Browse files
committed
feat: update docs content
1 parent 9a57955 commit 922c076

27 files changed

+464
-405
lines changed

next-env.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
/// <reference types="next/image-types/global" />
33

44
// NOTE: This file should not be edited
5-
// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
5+
// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.

src/components/TestnetDisclaimer.tsx

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { Callout } from "nextra/components";
2+
3+
export const TestnetDisclaimer = () => {
4+
return (
5+
<Callout type="info" emoji="ℹ️">
6+
This guide currently references Ink Sepolia (testnet) however it can be
7+
used for Ink mainnet as well. Please be sure to change the necessary
8+
parameters based on your network of choice.
9+
</Callout>
10+
);
11+
};
+11-24
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,19 @@
1-
## Faucets
1+
# Faucets
22

3-
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.
3+
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.
4+
5+
### [Ink](https://inkonchain.com/faucet)
46

5-
###### Ink
67
Our in house faucet provides a quick and easy way to acquire testnet ETH.
7-
- https://inkonchain.com/faucet
8-
###### Optimism Superchain Faucet
9-
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.
10-
- https://console.optimism.io/faucet
11-
###### QuickNode
12-
Use QuickNode Faucet to claim Ink Sepolia for testnet ETH for free - one drip per network every 12 hours.
13-
- https://faucet.quicknode.com/drip
14-
###### Gelato
15-
Gelato's Faucet uses Cloudflare authentication and drops up to 0.3 Ink Sepolia ETH every 12 hours.
16-
- https://faucet-gel-sepolia.inkonchain.com
178

18-
## Bridging funds to Ink Sepolia
9+
### [Optimism Superchain Faucet](https://console.optimism.io/faucet)
1910

20-
If you need an alternative to the above faucets you can choose to bridge ETH onto Ink Sepolia.
11+
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.
12+
13+
### [QuickNode](https://faucet.quicknode.com/drip)
2114

22-
1. Get sepolia ETH by using your wallet with one of the existing faucets on the Ethereum Sepolia network:
15+
Use QuickNode Faucet to claim Ink Sepolia for testnet ETH for free - one drip per network every 12 hours.
2316

24-
* [https://console.optimism.io/faucet](https://console.optimism.io/faucet)
25-
* [https://www.alchemy.com/faucets/ethereum-sepolia](https://www.alchemy.com/faucets/ethereum-sepolia)
26-
* [https://faucet.quicknode.com/ethereum/sepolia](https://faucet.quicknode.com/ethereum/sepolia)
27-
* [https://cloud.google.com/application/web3/faucet/ethereum/sepolia](https://cloud.google.com/application/web3/faucet/ethereum/sepolia)
17+
### [Gelato](https://faucet-gel-sepolia.inkonchain.com)
2818

29-
2. Transfer your ETH to <CopyableCode code="0x33f60714bbd74d62b66d79213c348614de51901c" />.
30-
- This is the [`L1StandardBridge Contract`](https://eth-sepolia.blockscout.com/address/0x33f60714BbD74d62b66D79213C348614DE51901C).
31-
- This contract will help you send your ETH from Sepolia to Ink Sepolia.
32-
- Once the transaction is confirmed you will quickly receive Ink ETH in your wallet.
19+
Gelato's Faucet uses Cloudflare authentication and drops up to 0.3 Ink Sepolia ETH every 12 hours.

src/pages/_meta.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,4 +118,4 @@
118118
"pagination": false
119119
}
120120
}
121-
}
121+
}

src/pages/build/_meta.json

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
{
22
"getting-started": "Getting Started",
33
"onchain-clients": "Onchain Clients",
4-
"run-an-ink-node": "Running Ink Nodes",
4+
"run-an-ink-node": {
5+
"title": "Running Ink Nodes",
6+
"href": "https://github.com/inkonchain/node",
7+
"newWindow": true
8+
},
59
"transaction-fees": "Transaction Fees",
610
"ink-kit": "Ink Kit",
711
"tutorials": "Tutorials"

src/pages/build/getting-started.mdx

+22-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1-
# Getting Started
1+
import { Callout, Checkbox } from "nextra/components";
22

3-
## TODO
3+
# What do I Need to Start Developing on Ink?
4+
5+
To start developing on Ink, you'll need:
6+
7+
✓ 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.
8+
9+
✓ A wallet that holds ETH such as [Kraken Wallet](https://www.kraken.com/wallet), [MetaMask](https://metamask.io/), or [Rainbow](https://rainbow.me/).
10+
11+
- We suggest having at least 0.01 ETH for standard deployments on Ink.
12+
- You can request Ink Sepolia ETH using our [Faucets](/tools/faucets).
13+
14+
✓ We recommend using a development framework like [Foundry](https://book.getfoundry.sh/) or [Hardhat](https://hardhat.org/)
15+
16+
- [Guide to deploy a contract using Foundry](/build/tutorials/deploying-a-smart-contract/foundry)
17+
- [Guide to deploy a contract using Hardhat](/build/tutorials/deploying-a-smart-contract/hardhat)
18+
- [Guide to deploy a contract using Remix](/build/tutorials/deploying-a-smart-contract/remix)
19+
20+
<Callout type="info" emoji="ℹ️">
21+
Try out InkGPT! Blaze through the docs and get deployed in no time with our
22+
new AI assistant.
23+
</Callout>

src/pages/build/run-an-ink-node.mdx

-124
This file was deleted.

src/pages/build/tutorials/deploying-a-smart-contract/foundry.mdx

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
import CopyableCode from '@/components/CopyableCode'
1+
import CopyableCode from "@/components/CopyableCode";
2+
import { TestnetDisclaimer } from "@/components/TestnetDisclaimer";
23

3-
# Getting Started with Foundry on INK
4+
# Deploying a Smart Contract with Foundry
45

56
This guide will walk you through setting up a new project using Foundry, a blazing fast toolkit for Ethereum application development written in Rust.
67

@@ -183,3 +184,5 @@ inksepolia = "${INKSEPOLIA_RPC_URL}"
183184
## Next Steps
184185

185186
- Check out [Get Foundry Book](https://book.getfoundry.sh/) for more information on Foundry.
187+
188+
<TestnetDisclaimer />

src/pages/build/tutorials/deploying-a-smart-contract/hardhat.mdx

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Getting Started with Hardhat on INK
1+
import { TestnetDisclaimer } from "@/components/TestnetDisclaimer";
2+
3+
# Deploying a Smart Contract with Hardhat
24

35
This guide will walk you through setting up a new project using Hardhat, a popular development environment for Ethereum software.
46

@@ -53,7 +55,7 @@ pragma solidity ^0.8.19;
5355
5456
contract InkContract {
5557
string public greeting = "Hello, Ink!";
56-
58+
5759
function setGreeting(string memory _greeting) public {
5860
greeting = _greeting;
5961
}
@@ -155,7 +157,7 @@ main()
155157
});
156158
```
157159

158-
Deploy to INK Sepolia testnet:
160+
Deploy to Ink Sepolia testnet:
159161

160162
```bash
161163
npx hardhat run scripts/deploy.js --network inksepolia
@@ -202,3 +204,5 @@ npx hardhat node
202204
## Next Steps
203205

204206
- Explore [Hardhat Documentation](https://hardhat.org/docs) for more features
207+
208+
<TestnetDisclaimer />

src/pages/build/tutorials/deploying-a-smart-contract/remix.mdx

+18-11
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
import { Callout } from 'nextra/components'
1+
import { Callout } from "nextra/components";
2+
import { TestnetDisclaimer } from "@/components/TestnetDisclaimer";
23

3-
# Getting Started with Remix IDE on INK
4+
# Deploying a Smart Contract with Remix
45

5-
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.
6+
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.
67

78
## What is Remix?
89

@@ -24,12 +25,13 @@ pragma solidity ^0.8.19;
2425
2526
contract InkContract {
2627
string public greeting = "Hello, Ink!";
27-
28+
2829
function setGreeting(string memory _greeting) public {
2930
greeting = _greeting;
3031
}
3132
}
3233
```
34+
3335
![inkContract.sol](src/images/remix_deploy_1.png)
3436

3537
## Compiling Your Contract
@@ -41,18 +43,18 @@ contract InkContract {
4143

4244
![inkContract.sol](src/images/remix_deploy_2.png)
4345

44-
## Connecting to INK Network
46+
## Connecting to Ink Network
4547

4648
1. On the left sidebar, click the `Deploy & run transactions` tab (represented by a deployment arrow icon ▶️)
4749
2. In the `ENVIRONMENT` dropdown:
4850
- If you see `Injected Provider`, select it
4951
- If not visible, click `Customize this list...` in dropdown
5052
- 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)
51-
3. Configure your preferred Web3 wallet with INK Sepolia network details:
52-
- Network Name: INK Sepolia
53+
3. Configure your preferred Web3 wallet with Ink Sepolia network details:
54+
- Network Name: Ink Sepolia
5355
- RPC URL: https://rpc-gel-sepolia.inkonchain.com/
5456
- Chain ID: 763373
55-
- Currency Symbol: INK
57+
- Currency Symbol: Ink
5658
- Block Explorer URL: https://explorer-sepolia.inkonchain.com/
5759

5860
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
6264
## Deploying Your Contract
6365

6466
1. Before deploying, ensure:
65-
- Your Web3 wallet is connected to INK Sepolia network
67+
68+
- Your Web3 wallet is connected to Ink Sepolia network
6669
- You have sufficient ETH for deployment
6770
- Your wallet is connected to Remix IDE (accept the connection prompt if shown)
6871

6972
2. In the "Deploy & Run Transactions" tab:
73+
7074
- Select `InkContract` from the `CONTRACT` dropdown
7175
- Click `Deploy`
7276
- 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
9195

9296
See also the respective [tutorial](/build/tutorials/verify-smart-contract).
9397

94-
1. Go to [INK Blockscout](https://explorer-sepolia.inkonchain.com)
98+
1. Go to [Ink Blockscout](https://explorer-sepolia.inkonchain.com)
9599
2. Find your contract by its address
96100
3. Click `Verify & Publish`
97101
4. Fill in the verification details:
@@ -102,7 +106,8 @@ See also the respective [tutorial](/build/tutorials/verify-smart-contract).
102106
- Click `Verify & Publish`
103107

104108
<Callout emoji="">
105-
Make sure to verify whether optimization is on or off in Remix Compiler's Advanced Configuration as this can affect verification success.
109+
Make sure to verify whether optimization is on or off in Remix Compiler's
110+
Advanced Configuration as this can affect verification success.
106111
</Callout>
107112

108113
## Tips and Best Practices
@@ -123,3 +128,5 @@ See also the respective [tutorial](/build/tutorials/verify-smart-contract).
123128

124129
- Explore [Remix Documentation](https://remix-ide.readthedocs.io/) for advanced features
125130
- Learn about [Solidity](https://docs.soliditylang.org/) programming
131+
132+
<TestnetDisclaimer />

src/pages/build/useful-info.mdx

-10
This file was deleted.

src/pages/general/_meta.json

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"about": "About Ink",
3-
"network-information": "Network Information",
4-
"connect-wallet": "Connect Wallet",
5-
"bridge": "Bridge",
6-
"faucet": "Faucet",
7-
"support": "Support"
8-
}
2+
"about": "About Ink",
3+
"network-information": "Network Information",
4+
"connect-wallet": "Connect Wallet",
5+
"bridge": { "title": "Bridge", "href": "/tools/bridges" },
6+
"faucet": { "title": "Faucet", "href": "/tools/faucets" },
7+
"support": "Support"
8+
}

0 commit comments

Comments
 (0)