docs(website): add hackathon docs and update contract docs (#13593)

taikoxyz · Apr 13, 2023 · c86f2cd · c86f2cd
1 parent 0927c89
commit c86f2cd
Show file tree

Hide file tree

Showing 24 changed files with 126 additions and 6 deletions.
diff --git a/packages/protocol/solidity-docgen/templates/contract.hbs b/packages/protocol/solidity-docgen/templates/contract.hbs
@@ -1,3 +1,7 @@
+---
+title: {{name}}
+---
+
 {{>common}}
 
 {{#each items}}

diff --git a/packages/website/pages/docs/guides/receive-tokens.mdx b/packages/website/pages/docs/guides/receive-tokens.mdx
@@ -1,8 +1,10 @@
-import { Steps } from "nextra-theme-docs";
+import { Callout, Steps } from "nextra-theme-docs";
 
-This guide will help you receive testnet tokens from the faucet(s).
+<Callout type="info" emoji="ℹ️">
+The HORSE token and BLL token are both dummy test tokens that are used for testing the bridge and swap.
+</Callout>
 
-> The HORSE token and BLL token are both dummy test tokens that are used for testing the bridge and swap.
+This guide will help you receive testnet tokens from the faucet(s).
 
 ## Prerequisites
 

diff --git a/packages/website/pages/docs/guides/swap-tokens.mdx b/packages/website/pages/docs/guides/swap-tokens.mdx
@@ -1,8 +1,10 @@
-import { Steps } from "nextra-theme-docs";
+import { Callout, Steps } from "nextra-theme-docs";
 
-This guide will help you interact with Swap, which is a fork of Uniswap v2 which Taiko has deployed only for testing purposes.
+<Callout type="info" emoji="ℹ️">
+The HORSE token and BLL token are both dummy test tokens that are used for testing the bridge and swap.
+</Callout>
 
-> The HORSE token and BLL token are both dummy test tokens that are used for testing the bridge and swap.
+This guide will help you interact with Swap, which is a fork of Uniswap v2 which Taiko has deployed only for testing purposes.
 
 ## Prerequisites
 

diff --git a/packages/website/pages/docs/reference/_meta.json b/packages/website/pages/docs/reference/_meta.json
@@ -10,5 +10,8 @@
   },
   "rpc-configuration": {
     "title": "RPC configuration"
+  },
+  "ethglobal-tokyo-reference": {
+    "title": "ETHGlobal Tokyo reference"
   }
 }
diff --git a/packages/website/pages/docs/reference/contract-documentation/L1/ProofVerifier.md b/packages/website/pages/docs/reference/contract-documentation/L1/ProofVerifier.md
@@ -1,3 +1,7 @@
+---
+title: IProofVerifier
+---
+
 ## IProofVerifier
 
 ### verifyZKP

diff --git a/...ges/website/pages/docs/reference/contract-documentation/L1/TaikoCustomErrors.md b/...ges/website/pages/docs/reference/contract-documentation/L1/TaikoCustomErrors.md
@@ -1,3 +1,7 @@
+---
+title: TaikoCustomErrors
+---
+
 ## TaikoCustomErrors
 
 ### L1_0_FEE_BASE

diff --git a/packages/website/pages/docs/reference/contract-documentation/L1/TaikoData.md b/packages/website/pages/docs/reference/contract-documentation/L1/TaikoData.md
@@ -1,3 +1,7 @@
+---
+title: TaikoData
+---
+
 ## TaikoData
 
 ### Config

diff --git a/packages/website/pages/docs/reference/contract-documentation/L1/TaikoEvents.md b/packages/website/pages/docs/reference/contract-documentation/L1/TaikoEvents.md
@@ -1,3 +1,7 @@
+---
+title: TaikoEvents
+---
+
 ## TaikoEvents
 
 ### BlockVerified

diff --git a/packages/website/pages/docs/reference/contract-documentation/L1/TaikoL1.md b/packages/website/pages/docs/reference/contract-documentation/L1/TaikoL1.md
@@ -1,3 +1,7 @@
+---
+title: TaikoL1
+---
+
 ## TaikoL1
 
 ### state

diff --git a/packages/website/pages/docs/reference/contract-documentation/L1/TaikoToken.md b/packages/website/pages/docs/reference/contract-documentation/L1/TaikoToken.md
@@ -1,3 +1,7 @@
+---
+title: TaikoToken
+---
+
 ## TaikoToken
 
 _This is Taiko's governance and fee token._

diff --git a/packages/website/pages/docs/reference/contract-documentation/L2/TaikoL2.md b/packages/website/pages/docs/reference/contract-documentation/L2/TaikoL2.md
@@ -1,3 +1,7 @@
+---
+title: TaikoL2
+---
+
 ## TaikoL2
 
 ### latestSyncedL1Height

diff --git a/packages/website/pages/docs/reference/contract-documentation/bridge/Bridge.md b/packages/website/pages/docs/reference/contract-documentation/bridge/Bridge.md
@@ -1,3 +1,7 @@
+---
+title: Bridge
+---
+
 ## Bridge
 
 Bridge contract which is deployed on both L1 and L2. Mostly a thin wrapper

diff --git a/...ages/website/pages/docs/reference/contract-documentation/bridge/BridgeErrors.md b/...ages/website/pages/docs/reference/contract-documentation/bridge/BridgeErrors.md
@@ -1,3 +1,7 @@
+---
+title: BridgeErrors
+---
+
 ## BridgeErrors
 
 ### B_CANNOT_RECEIVE

diff --git a/...ages/website/pages/docs/reference/contract-documentation/bridge/BridgedERC20.md b/...ages/website/pages/docs/reference/contract-documentation/bridge/BridgedERC20.md
@@ -1,3 +1,7 @@
+---
+title: BridgedERC20
+---
+
 ## BridgedERC20
 
 ### srcToken

diff --git a/packages/website/pages/docs/reference/contract-documentation/bridge/EtherVault.md b/packages/website/pages/docs/reference/contract-documentation/bridge/EtherVault.md
@@ -1,3 +1,7 @@
+---
+title: EtherVault
+---
+
 ## EtherVault
 
 EtherVault is a special vault contract that:

diff --git a/packages/website/pages/docs/reference/contract-documentation/bridge/IBridge.md b/packages/website/pages/docs/reference/contract-documentation/bridge/IBridge.md
@@ -1,3 +1,7 @@
+---
+title: IBridge
+---
+
 ## IBridge
 
 Bridge interface.

diff --git a/packages/website/pages/docs/reference/contract-documentation/bridge/TokenVault.md b/packages/website/pages/docs/reference/contract-documentation/bridge/TokenVault.md
@@ -1,3 +1,7 @@
+---
+title: TokenVault
+---
+
 ## TokenVault
 
 This vault holds all ERC20 tokens (but not Ether) that users have deposited.

diff --git a/...s/website/pages/docs/reference/contract-documentation/common/AddressResolver.md b/...s/website/pages/docs/reference/contract-documentation/common/AddressResolver.md
@@ -1,3 +1,7 @@
+---
+title: AddressResolver
+---
+
 ## AddressResolver
 
 This abstract contract provides a name-to-address lookup. Under the hood,

diff --git a/...s/website/pages/docs/reference/contract-documentation/common/IAddressManager.md b/...s/website/pages/docs/reference/contract-documentation/common/IAddressManager.md
@@ -1,3 +1,7 @@
+---
+title: IAddressManager
+---
+
 ## IAddressManager
 
 Interface to set and get an address for a name.

diff --git a/packages/website/pages/docs/reference/contract-documentation/common/IHeaderSync.md b/packages/website/pages/docs/reference/contract-documentation/common/IHeaderSync.md
@@ -1,3 +1,7 @@
+---
+title: IHeaderSync
+---
+
 ## IHeaderSync
 
 Interface implemented by both the TaikoL1 and TaikoL2 contracts. It exposes

diff --git a/...es/website/pages/docs/reference/contract-documentation/common/IMintableERC20.md b/...es/website/pages/docs/reference/contract-documentation/common/IMintableERC20.md
@@ -1,3 +1,7 @@
+---
+title: IMintableERC20
+---
+
 ## IMintableERC20
 
 ### mint

diff --git a/...es/website/pages/docs/reference/contract-documentation/signal/ISignalService.md b/...es/website/pages/docs/reference/contract-documentation/signal/ISignalService.md
@@ -1,3 +1,7 @@
+---
+title: ISignalService
+---
+
 ## ISignalService
 
 ### sendSignal

diff --git a/...ges/website/pages/docs/reference/contract-documentation/signal/SignalService.md b/...ges/website/pages/docs/reference/contract-documentation/signal/SignalService.md
@@ -1,3 +1,7 @@
+---
+title: SignalService
+---
+
 ## SignalService
 
 ### SignalProof

diff --git a/packages/website/pages/docs/reference/ethglobal-tokyo-reference.mdx b/packages/website/pages/docs/reference/ethglobal-tokyo-reference.mdx
@@ -0,0 +1,33 @@
+This is the ETHGlobal Tokyo hackathon testnet reference page.
+
+## Network configuration
+
+| Network | Chain ID | RPC URL                           | WS URL                           | Symbol | Block Explorer URL                     |
+| ------- | -------- | --------------------------------- | -------------------------------- | ------ | -------------------------------------- |
+| Sepolia | 11155111 | https://rpc.sepolia.org           | N/A (can try Alchemy or Infura)  | ETH    | https://sepolia.etherscan.io/          |
+| Taiko   | 167002   | https://l2rpc.hackathon.taiko.xyz | https://l2ws.hackathon.taiko.xyz | ETH    | https://l2explorer.hackathon.taiko.xyz |
+
+## Faucets
+
+| Network | Faucet URL                                                       |
+| ------- | ---------------------------------------------------------------- |
+| Sepolia | https://taiko.xyz/docs/guides/receive-tokens#receive-sepolia-eth |
+| Taiko   | https://l2faucet.hackathon.taiko.xyz                             |
+
+## Contract addresses
+
+> **NOTE:** If there is a missing contract address you are looking for or are interested in, please reach out to the Taiko team on the ETH Global Tokyo Discord.
+
+### Sepolia L1
+
+| Contract name | Address                                                                                                                       |
+| ------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| SignalService | [0x11013a48Ad87a528D23CdA25D2C34D7dbDA6b46b](https://sepolia.etherscan.io/address/0x11013a48Ad87a528D23CdA25D2C34D7dbDA6b46b) |
+| TaikoL1       | [0x1Dd84563dAD23791f35111EefB3e28f709451526](https://sepolia.etherscan.io/address/0x1Dd84563dAD23791f35111EefB3e28f709451526) |
+
+### Taiko L2
+
+| Contract name | Address                                                                                                                                 |
+| ------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| SignalService | [0x0000777700000000000000000000000000000007](https://l2explorer.hackathon.taiko.xyz/address/0x0000777700000000000000000000000000000007) |
+| TaikoL2       | [0x0000777700000000000000000000000000000001](https://l2explorer.hackathon.taiko.xyz/address/0x0000777700000000000000000000000000000001) |