Skip to content

Commit

Permalink
feat: update docs content
Browse files Browse the repository at this point in the history
  • Loading branch information
ink-victor committed Dec 13, 2024
1 parent 9a57955 commit 922c076
Show file tree
Hide file tree
Showing 27 changed files with 464 additions and 405 deletions.
2 changes: 1 addition & 1 deletion next-env.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// 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.
11 changes: 11 additions & 0 deletions src/components/TestnetDisclaimer.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Callout } from "nextra/components";

export const TestnetDisclaimer = () => {
return (
<Callout type="info" emoji="ℹ️">
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.
</Callout>
);
};
35 changes: 11 additions & 24 deletions src/content/shared/faucets-content.mdx
Original file line number Diff line number Diff line change
@@ -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 <CopyableCode code="0x33f60714bbd74d62b66d79213c348614de51901c" />.
- 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.
2 changes: 1 addition & 1 deletion src/pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,4 @@
"pagination": false
}
}
}
}
6 changes: 5 additions & 1 deletion src/pages/build/_meta.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
24 changes: 22 additions & 2 deletions src/pages/build/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -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)

<Callout type="info" emoji="ℹ️">
Try out InkGPT! Blaze through the docs and get deployed in no time with our
new AI assistant.
</Callout>
124 changes: 0 additions & 124 deletions src/pages/build/run-an-ink-node.mdx

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -183,3 +184,5 @@ inksepolia = "${INKSEPOLIA_RPC_URL}"
## Next Steps

- Check out [Get Foundry Book](https://book.getfoundry.sh/) for more information on Foundry.

<TestnetDisclaimer />
10 changes: 7 additions & 3 deletions src/pages/build/tutorials/deploying-a-smart-contract/hardhat.mdx
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -53,7 +55,7 @@ pragma solidity ^0.8.19;
contract InkContract {
string public greeting = "Hello, Ink!";
function setGreeting(string memory _greeting) public {
greeting = _greeting;
}
Expand Down Expand Up @@ -155,7 +157,7 @@ main()
});
```

Deploy to INK Sepolia testnet:
Deploy to Ink Sepolia testnet:

```bash
npx hardhat run scripts/deploy.js --network inksepolia
Expand Down Expand Up @@ -202,3 +204,5 @@ npx hardhat node
## Next Steps

- Explore [Hardhat Documentation](https://hardhat.org/docs) for more features

<TestnetDisclaimer />
29 changes: 18 additions & 11 deletions src/pages/build/tutorials/deploying-a-smart-contract/remix.mdx
Original file line number Diff line number Diff line change
@@ -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?

Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -102,7 +106,8 @@ See also the respective [tutorial](/build/tutorials/verify-smart-contract).
- Click `Verify & Publish`

<Callout emoji="">
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.
</Callout>

## Tips and Best Practices
Expand All @@ -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

<TestnetDisclaimer />
10 changes: 0 additions & 10 deletions src/pages/build/useful-info.mdx

This file was deleted.

14 changes: 7 additions & 7 deletions src/pages/general/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"about": "About Ink",
"network-information": "Network Information",
"connect-wallet": "Connect Wallet",
"bridge": "Bridge",
"faucet": "Faucet",
"support": "Support"
}
"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"
}
Loading

0 comments on commit 922c076

Please sign in to comment.