From 0fd71d87d45081537735558f2ac7070ca842044c Mon Sep 17 00:00:00 2001 From: CAPtheorem <79423264+CAPtheorem@users.noreply.github.com> Date: Sun, 8 May 2022 14:49:07 -0700 Subject: [PATCH] Docs in monorepo DO NOT MERGE (#145) * add docs to monorepo * random updates * add images * GitBook: [#2] No subject * GitBook: [#3] No subject * Update README.md * update TOC * Update README.md * Update README.md * restructure * Update SUMMARY.md * work1 * work2 * Update 001_how-to-bridge.md * work3 * work4 * work5 * work6 * Update 000_developer_start.md * work 7 * work 8 * Update 000_developer_start.md * Update 000_developer_start.md * work9 * work10 * Update xdomain-tx-status.md * Update xdomain-tx-status.md * more cleanup * Update SUMMARY.md * Update README.md * Update README.md * work 11 * Update AWS_lambda_setup.md * work 12 * Update README.md * work 13 * work 14 * update links * work 15 * work 16 * Update README.md * Update README.md * work 16 * Update 001_how-to-bridge.md (#134) Co-authored-by: Gian-Bobarino <100376939+Gian-Bobarino@users.noreply.github.com> * Update 001_how-to-bridge.md * work 17 * work 18 * Update developer-start.md * work 19 * Update faq.md * work 19 * Update xdomain-tx-status.md * Update xdomain-tx-status.md * work 20 * work 21 * Update README.md * Update SUMMARY.md * work 21 * work 22 * work 22 * instructions for adding new tokens * Update fee docs (#136) * docs: cleanup bridge docs (#137) * cleanup bridge docs * fix link * work 22 * Update README.md * Update README.md * Update README.md * Update README.md * work 23 * Update price-feeds.md * work 24 * work 25 * Update README.md * Update README.md * Update README.md * Update README.md * Update price-feeds.md * Update price-feeds.md * Update price-feeds.md * work 26 * Update README.md * work 27 * work 29 * Update README.md * work 29 * Update documentation.md * Update documentation.md * add turing overview * Update turing.md * Update turing.md * Update turing.md * Update turing.md * work 30 * Update network-parameters.md * update network parameters * update network addresses * Update network-parameters.md * update structure * Update network-parameters.md Co-authored-by: Boba Lab Co-authored-by: Riedl Kevin, Bsc Co-authored-by: Gian-Bobarino <100376939+Gian-Bobarino@users.noreply.github.com> Co-authored-by: Boyuan-Chen <46272347+Boyuan-Chen@users.noreply.github.com> Co-authored-by: Souradeep Das --- SUMMARY.md | 4 +-- boba_documentation/developer/json-rpc-api.md | 6 ++++ .../developer/network-parameters.md | 28 +++++++++++-------- .../contracts/deployments/mainnet/README.md | 13 --------- .../contracts/deployments/rinkeby/README.md | 15 +--------- 5 files changed, 24 insertions(+), 42 deletions(-) diff --git a/SUMMARY.md b/SUMMARY.md index 36bf488e56..19defae9f0 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -27,7 +27,7 @@ * [Sending ETH to L2](boba\_examples/init-fund-l2/README.md) * [Adding a new ERC20 to Boba](boba\_documentation/developer/add-new-token.md) * [Fees](boba\_documentation/developer/fee-scheme.md) - * [Contract Addresses](boba\_documentation/developer/network-parameters.md) + * [Contract Addresses Boba/ETH](boba\_documentation/developer/network-parameters.md) * [xDomain Transaction Status](boba\_documentation/developer/xdomain-tx-status.md) * [Verifying Contracts](boba\_documentation/developer/verify-smart-contracts.md) * [Using The Graph](packages/boba/subgraph/README.md) @@ -42,8 +42,6 @@ * [Using the Fast Token Bridge](boba\_documentation/developer/bridge-l1-and-l2/fast-bridge.md) * [Other](packages/README.md) - * [Boba Mainnet Addresses](packages/contracts/deployments/mainnet/README.md) - * [Boba Rinkeby Addresses](packages/contracts/deployments/rinkeby/README.md) * [Liquidity Pools](packages/boba/contracts/contracts/LP/README.md) * [Boba NFT Bridges](packages/boba/contracts/contracts/bridges/README.md) * [Boba Straw Price Feed Oracle](packages/boba/contracts/contracts/oracle/README.md) diff --git a/boba_documentation/developer/json-rpc-api.md b/boba_documentation/developer/json-rpc-api.md index de369f33af..6536d29be0 100644 --- a/boba_documentation/developer/json-rpc-api.md +++ b/boba_documentation/developer/json-rpc-api.md @@ -1,6 +1,8 @@ + Boba Network shares the same [JSON-RPC API (opens new window)](https://eth.wiki/json-rpc/API) as Ethereum. Some new custom methods have been introduced and some other have been made unsupported for operation. ### Custom JSON-RPC methods + #### `eth_getBlockRange` DEPRECATION NOTICE @@ -25,6 +27,7 @@ An array of `block` objects. See [`eth_getBlockByHash` (opens new window)](https // Request curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"eth_getBlockRange","params":["0x1", "0x2", false],"id":1}' + // Result { "jsonrpc":"2.0", @@ -105,6 +108,7 @@ None // Request curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"rollup_getInfo","params":[],"id":1}' + // Result { "jsonrpc":"2.0", @@ -146,6 +150,7 @@ None // Request curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"rollup_gasPrices","params":[],"id":1}' + // Result { "jsonrpc":"2.0", @@ -240,6 +245,7 @@ curl -X POST -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","metho "result": "0x5208" // 21000 } ``` + ### Unsupported JSON-RPC methods #### `eth_getAccounts` diff --git a/boba_documentation/developer/network-parameters.md b/boba_documentation/developer/network-parameters.md index f556507064..6da4b75323 100644 --- a/boba_documentation/developer/network-parameters.md +++ b/boba_documentation/developer/network-parameters.md @@ -1,36 +1,40 @@ --- -description: A collection of links to get started on Boba +description: A collection of links and addresses to get started on Boba-Ethereum --- -# Rinkeby Links +# Rinkeby (28) + +## Rinkeby Addresses + +For **primary network contracts and addresses** see [packages/contracts/deployments/rinkeby/README.md](../../packages/contracts/deployments/rinkeby/README.md) + +For **secondary addresses**, such as L2 Tokens, Messengers, and the DAO, please see the [Rinkeby address registration dump](../../packages/boba/register/addresses/addressesRinkeby_0x93A96D6A5beb1F661cf052722A1424CDDA3e9418.json). ## Rinkeby Links and Endpoints | | | | --------------- | ---------------------------------------------------------------------------------------- | -| Rinkeby RPC | [https://rinkeby.boba.network](https://rinkeby.boba.network) | | Rinkeby ChainID | 28 | +| Rinkeby RPC | [https://rinkeby.boba.network](https://rinkeby.boba.network) | | Gateway | [https://gateway.rinkeby.boba.network](https://gateway.rinkeby.boba.network) | | Blockexplorer | [https://blockexplorer.rinkeby.boba.network](https://blockexplorer.rinkeby.boba.network) | -| Websocket | [wss://wss.rinkeby-v2.boba.network](wss://wss.rinkeby-v2.boba.network) | +| Websocket | [wss://wss.rinkeby.boba.network](wss://wss.rinkeby.boba.network) | -## Rinkeby Contract Addresses +# Mainnet (288) -For all current addresses, please see [the address registration dump](../../packages/boba/register/addresses). +## Mainnet Addresses -# Mainnet Links +For **primary network contracts and addresses** see [packages/contracts/deployments/mainnet/README.md](../../packages/contracts/deployments/mainnet/README.md) + +For **secondary addresses**, such as L2 Tokens, Messengers, and the DAO, please see the [Mainnet address registration dump](../../packages/boba/register/addresses/addressesMainnet_0x8376ac6C3f73a25Dd994E0b0669ca7ee0C02F089.json). ## Mainnet Links and Endpoints | | | | ----------------- | -------------------------------------------------------------------------------- | +| Mainnet ChainID | 288 | | Mainnet RPC Read | [https://lightning-replica.boba.network](https://lightning-replica.boba.network) | | Mainnet Write RPC | [https://mainnet.boba.network](https://mainnet.boba.network) | -| Mainnet ChainID | 288 | | Gateway | [https://gateway.boba.network](https://gateway.boba.network) | | Blockexplorer | [https://blockexplorer.boba.network](https://blockexplorer.boba.network) | | Websocket | [wss://ws.mainnet.boba.network](wss://wss.mainnet.boba.network) | - -## Mainnet Contract and Token Addresses - -For all current addresses, please see [the address registration dump](../../packages/boba/register/addresses). \ No newline at end of file diff --git a/packages/contracts/deployments/mainnet/README.md b/packages/contracts/deployments/mainnet/README.md index f25e82a09a..0ce789f24b 100644 --- a/packages/contracts/deployments/mainnet/README.md +++ b/packages/contracts/deployments/mainnet/README.md @@ -3,19 +3,6 @@ - **Chain ID**: 288 - **Public RPC**: https://mainnet.boba.network - **Block Explorer**: https://blockexplorer.boba.network -## Layer 1 Contracts - - - - - -
- -

Contract

-		 - -

Address

-
## Layer 2 Contracts diff --git a/packages/contracts/deployments/rinkeby/README.md b/packages/contracts/deployments/rinkeby/README.md index 2c7d0cc6bc..210cd94ad7 100644 --- a/packages/contracts/deployments/rinkeby/README.md +++ b/packages/contracts/deployments/rinkeby/README.md @@ -1,21 +1,8 @@ # Boba Rinkeby (public testnet) ## Network Info - **Chain ID**: 28 -- **Public RPC**: https://rinkeby.boba.netwokr +- **Public RPC**: https://rinkeby.boba.network - **Block Explorer**: https://blockexplorer.rinkeby.boba.network -## Layer 1 Contracts -
- - - - -
- -

Contract

-		 - -

Address

-
## Layer 2 Contracts