Skip to content

Commit f649b1b

Browse files
inkjesseinkjesse
authored
Merge pull request #117 from inkonchain/docs/joel-devdocs-updates
Docs/joel devdocs updates
2 parents 1109949 + edb2735 commit f649b1b

16 files changed

+103
-26
lines changed

‎cspell/project-words.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,8 @@ synergizing
9191
vewy
9292
scawy
9393
Brid
94-
Rabby
94+
Rabby
95+
Protofire
96+
Zerodev
97+
Permissionless
98+
Crosschain

‎src/pages/_meta.json

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,34 @@
7777
"display": "children"
7878
},
7979

80-
"+++ Building on Ink": {
80+
"+++ Build on Ink": {
8181
"title": "",
8282
"type": "separator"
8383
},
84-
"--- Building on Ink": {
85-
"title": "Building on Ink",
84+
"--- Build on Ink": {
85+
"title": "Build on Ink",
8686
"type": "separator"
8787
},
8888
"build": {
89-
"title": "Building on Ink",
89+
"title": "Build on Ink",
90+
"display": "children"
91+
},
92+
"status": {
93+
"title": "Status Page",
94+
"href": "https://status.inkonchain.com/",
95+
"newWindow": true
96+
},
97+
98+
"+++ Use Ink": {
99+
"title": "",
100+
"type": "separator"
101+
},
102+
"--- Use Ink": {
103+
"title": "Use Ink",
104+
"type": "separator"
105+
},
106+
"use-ink": {
107+
"title": "Use Ink",
90108
"display": "children"
91109
},
92110

@@ -107,21 +125,10 @@
107125
"header_inkubator": {
108126
"title": "Inkubator"
109127
},
128+
"contributing": {
129+
"title": "Contribution Guide"
130+
},
110131
"header_developer_waitlist": {
111132
"title": "Developer Waitlist"
112-
},
113-
"status": {
114-
"title": "Status",
115-
"href": "https://status.inkonchain.com/",
116-
"newWindow": true
117-
},
118-
"discord_invite": {
119-
"title": "Community (coming soon)"
120-
},
121-
"inkubator": {
122-
"title": "Inkubator (coming soon)"
123-
},
124-
"developer_waitlist": {
125-
"title": "Developer Waitlist (coming soon)"
126133
}
127134
}

‎src/pages/build/_meta.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@
55
"run-an-ink-node": "Running Ink Nodes",
66
"fees": "Fees",
77
"tools": "Tools",
8-
"useful-data": "Useful Data"
9-
}
8+
"useful-data": "Useful Information",
9+
"faq": "FAQ"
10+
}

‎src/pages/build/faq.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Frequently Asked Questions
2+
3+
###### What makes Ink different?
4+
Ink closely integrates with the products and services of Kraken, one of crypto's longest running exchanges with a reputation for security and support. Ink has a dedicated focus on DeFi in the context of Kraken's mission which is to help all humans achieve financial liberty.

‎src/pages/build/tools/_meta.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
"block-explorers": "Block Explorers",
88
"indexers": "Indexers",
99
"subgraphs": "Subgraphs",
10-
"oracles": "Oracles",
1110
"vrf": "VRF",
1211
"tooling": "Tooling"
1312
}

‎src/pages/build/tools/account-abstraction.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Account Abstraction Solutions
2+
3+
- Safe (Protofire)
4+
- Zerodev

‎src/pages/build/tools/block-explorers.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Blockscout
2+
3+
Blockscout is a universal block explorer providing detailed chain information and tools for debugging smart contracts and transactions:
4+
- Comprehensive views for blocks, transactions, addresses, tokens and all onchain data.
5+
- L1-to-L2 and L2-to-L1 transaction views.
6+
- Verify and interact with smart contract source code.
7+
- Advanced charts and statistics
8+
9+
Visit the [Blockscout Docs](https://docs.blockscout.com/) for details.
10+
11+
###### Supported Networks
12+
- Ink Sepolia: https://explorer-sepolia.inkonchain.com/
13+
14+
###### Verifying Smart Contract Code on Blockscout
15+
- Please see [this page](/build/tutorials/verify-smart-contract)

‎src/pages/build/tutorials/_meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"test": "Test"
2+
"deploy-smart-contract": "Deploying a Smart Contract",
3+
"verify-smart-contract": "Verifying a Smart Contract"
34
}

‎src/pages/build/tutorials/verify-smart-contract.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Verifying your Smart Contract
2+
3+
In order for your deployed smart contract(s) to be human-readable on block explorers like Blockscout they must be verified. Verification is highly recommended to increase trust in your code and dapp.
4+
5+
Smart contracts can be [verified through the Blockscout UI](https://docs.blockscout.com/devs/verification/blockscout-ui) or a [host of other methods](https://docs.blockscout.com/devs/verification).
6+

‎src/pages/build/useful-data/_meta.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
"network-information": "Network Information",
33
"ink-contracts": "Ink Contracts",
44
"bridged-token-addresses": "Bridged Token Addresses",
5-
"compare-ink-eth": "Ink & Ethereum"
6-
}
5+
"compare-ink-eth": "Ink & Ethereum",
6+
"security": "Chain Security"
7+
}

‎src/pages/build/useful-data/security.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## How is Ink Secured?
2+
3+
Ink is built on and secured by the Optimism Stack (the totality of Optimism L2 infrastructure) as well as Kraken's own infrastructure.
4+
5+
Ink's chain is part of a network of chains called the Optimism Superchain. This infrastructure enables chains to share security, communicate with each other (including bridging) and benefit from a range of features from core updates and decentralized governance.
6+
7+
Ink forms an integral part of Kraken's established support and security framework, designed to provide a smooth and safe onchain user experience while benefiting from deep integration with the exchange's products and services.
8+
9+
###### The Superchain
10+
The upgrade of the Optimism Stack to the Superchain introduces a number of crucial improvements to strengthen the Optimism L2 ecosystem, including but not limited to:
11+
- Permissionless proposals for withdrawals of funds: previously only an appointed "proposer" could submit withdrawals - with the Superchain upgrade anyone can now submit proposals on demand.
12+
- Configurable sequencers: previously chains built on Optimism could not choose a custom sequencer - this is possible with the Superchain upgrade and is a necessary step towards sequencer decentralization.
13+
- The chain safety and liveness built into the Superchain bridge security model enable users to migrate away from a misbehaving sequencer if needed.
14+
15+
###### Upgrades to the Superchain
16+
A decentralized security council exists to shepherd upgrades to the OP Stack. It can also emergency pause the bridge if needed, which would result in the perpetual pausing of withdrawals and bridge upgrades. The freezing of funds is preferred over the loss of funds should e.g. the private keys of the council be compromised in a worst-case scenario; this is also known as the safety-over-liveness design principle.
17+
18+
A frozen bridge can be mitigated through an L1 soft fork. Anyone may propose such a fork provided they also put up a bond. While this mechanism may imply systemic risk to Ethereum (as L1) it is meant to act as a deterrent and unlikely to ever be used.
19+
20+
For further information please see the [Optimism documentation](https://docs.optimism.io/stack/explainer).

‎src/pages/use-ink/_meta.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"bridges": "Bridges",
3+
"crosschain": "Crosschain",
4+
"multisig": "Multisig"
5+
}

‎src/pages/use-ink/bridges.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Bridges
2+
3+
- Canonical bridges (Gelato)
4+
- Brid.gg

‎src/pages/use-ink/crosschain.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Crosschain Infrastructure
2+
3+
- Wormhole

‎src/pages/use-ink/multisig.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Multisig Solutions
2+
3+
- Safe (Protofire)

‎src/utils/urls.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export const URLS = {
33
statusPageUrl: "https://status.optimism.io/",
44
faucetUrl: "https://app.optimism.io/faucet",
55
inkubatorUrl: "https://inkonchain.com/inkubator",
6-
discordUrl: "https://discord.com/invite/inkchain",
6+
discordUrl: "https://discord.com/invite/inkonchain",
77
repositoryUrl: "https://github.com/inkonchain/docs",
88
developerWailistUrl: "https://inkonchain.com",
99
feedbackUrl: "https://inkonchain.com",

0 commit comments

Comments
 (0)