Skip to content

Commit

Permalink
Add Mainnet Docs (#83)
Browse files Browse the repository at this point in the history
  • Loading branch information
sambukowski authored Oct 28, 2024
1 parent 7e483a8 commit 31d1fa3
Show file tree
Hide file tree
Showing 6 changed files with 188 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,15 @@ function sidebar() {
text: 'Flame',
collapsed: true,
items: [
{ text: 'Flame - Testnet', link: '/flame/flame-testnet.md' },
{ text: 'Flame - Devnet', link: '/flame/flame-devnet.md' },
{ text: 'On Testnet', link: '/flame/flame-testnet.md' },
{ text: 'On Devnet', link: '/flame/flame-devnet.md' },
]
},
{
text: 'Networks',
collapsed: true,
items: [
{ text: 'Astria Mainnet Alpha', link: '/networks/mainnet-alpha.md' },
{ text: 'Astria Dawn Testnet', link: '/networks/testnet.md' },
{ text: 'Astria Dusk Devnet', link: '/networks/devnet.md' },
{ text: 'Local Network', link: '/networks/local.md' },
Expand Down
63 changes: 63 additions & 0 deletions docs/config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
export const siteConfig = {
flame: {
mainnet: {
info: {
network_name: "astria",
chain_id: "253368190",
// for rpc url set in the dawn/dusk sections below
// for explorer url set in the dawn/dusk sections below
native_asset: "transfer/channel-0/utia",
currency_symbol: "TIA",
},
bridging: {
ibc_celestia_to_astria: "channel-48",
ibc_astria_to_celestia: "channel-0",
ibc_nobel_to_astria: "channel-104",
ibc_astria_to_nobel: "channel-1",
sequencer_celestia_address: "astria13vptdafyttpmlwppt0s844efey2cpc0mevy92p",
sequencer_nobel_address: "astria1eg8hhey0n4untdvqqdvlyl0e7zx8wfca48kglh",
flame_tia_address: "0xB086557f9B5F6fAe5081CC5850BE94e62B1dDE57",
flame_usdc_address: "N/A",
},
},
dawn: {
info: {
network_name: "dawn-1",
Expand Down Expand Up @@ -37,6 +57,49 @@ export const siteConfig = {
},
},
},
mainnet: {
flame_rpc: "https://rpc.flame.astria.org",
flame_explorer: "https://explorer.flame.astria.org",
sequencer_rpc: "https://rpc.astria.org/",
sequencer_grpc: "https://grpc.astria.org/",
sequencer_explorer: "https://astrotrek.io/",
celestia_signer_address: "celestia1ldf3mhs0z5h5effkkyvc5scpy0xah00t98xfml",
celenium_signer_link: "https://celenium.io/address/celestia1ldf3mhs0z5h5effkkyvc5scpy0xah00t98xfml?tab=transactions",
celestia_namespace: "0000000000000000000000000000000000005bb944ec2fd3ae9c22f6",
celenium_namespace_link: "https://celenium.io/namespace/0000000000000000000000000000000000005bb944ec2fd3ae9c22f6?tab=Blobs",
// services
conductor_version: "v1.0.0",
conductor_release: "https://github.com/astriaorg/astria/releases/tag/conductor-v1.0.0",
conductor_repo: "https://github.com/astriaorg/astria/tree/main/crates/astria-conductor",
composer_version: "v1.0.0",
composer_release: "https://github.com/astriaorg/astria/releases/tag/composer-v1.0.0",
composer_repo: "https://github.com/astriaorg/astria/tree/main/crates/astria-composer",
sequencer_relayer_version: "v1.0.0",
sequencer_relayer_release: "https://github.com/astriaorg/astria/releases/tag/sequencer-relayer-v1.0.0",
sequencer_relayer_repo: "https://github.com/astriaorg/astria/tree/main/crates/astria-sequencer-relayer",
sequencer_version: "v1.0.0",
sequencer_release: "https://github.com/astriaorg/astria/releases/tag/sequencer-v1.0.0",
sequencer_repo: "https://github.com/astriaorg/astria/tree/main/crates/astria-sequencer",
flame_version: "v0.16.0",
flame_release: "https://github.com/astriaorg/astria-geth/releases/tag/v0.16.0",
flame_repo: "https://github.com/astriaorg/astria-geth",
cometbft_version: "v0.38.11",
cometbft_release: "https://github.com/cometbft/cometbft/releases/tag/v0.38.11",
cometbft_repo: "https://github.com/cometbft/cometbft",
// deployments
descriptorProxyAddress: "N/A",
multicall2Address: "N/A",
nftPositionDescriptorAddress: "N/A",
nftPositionManagerAddress: "N/A",
proxyAdminAddress: "N/A",
quoterV2Address: "N/A",
swapRouter02Address: "N/A",
tickLensAddress: "N/A",
v3CoreFactoryAddress: "N/A",
v3MigratorAddress: "N/A",
v3StakerAddress: "N/A",
weth9Address: "N/A",
},
dawn: {
num: 1,
flame_rpc: "https://rpc.flame.dawn-1.astria.org",
Expand Down
2 changes: 1 addition & 1 deletion docs/flame/flame-devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { siteConfig } from '../config.js'
const config = siteConfig
</script>

# Flame
# Flame on Devnet

Flame is the EVM for Celestia Native DeFi. The information below is specifically
for Flame running on the Astria `dusk-{{config.dusk.num}}` Devnet.
Expand Down
91 changes: 91 additions & 0 deletions docs/flame/flame-mainnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<!-- markdownlint-disable MD041 MD033 -->

<script setup>
import { siteConfig } from '../config.js'

const config = siteConfig
</script>

# Flame on Mainnet

Flame is the EVM for Celestia Native DeFi. The information below is specifically
for Flame running on the Astria Mainnet.

## EVM Information

| Property | Value |
|-----|-----|
| Network Name | `{{config.flame.mainnet.info.network_name}}` |
| Chain ID | `{{config.flame.mainnet.info.chain_id}}` |
| RPC URL | <a :href="config.mainnet.flame_rpc" target="_blank" rel="noopener noreferrer">{{config.mainnet.flame_rpc}}</a> |
| Flame EVM Block Explorer | <a :href="config.mainnet.flame_explorer" target="_blank" rel="noopener noreferrer">{{config.mainnet.flame_explorer}}</a> |
| Native sequencer Asset | `{{config.flame.mainnet.info.native_asset}}` |
| Currency Symbol | `{{config.flame.mainnet.info.currency_symbol}}` |

## Bridging

| Property | Value |
|-----|-----|
| IBC Channel: mocha-4 -> dawn-1 | `{{config.flame.mainnet.bridging.ibc_celestia_to_astria}}` |
| IBC Channel: dawn-1 -> mocha-4 | `{{config.flame.mainnet.bridging.ibc_astria_to_celestia}}` |
| IBC Channel: grand-1 -> dawn-1 | `{{config.flame.mainnet.bridging.ibc_nobel_to_astria}}` |
| IBC Channel: dawn-1 -> grand-1 | `{{config.flame.mainnet.bridging.ibc_astria_to_nobel}}` |
| Astria Sequencer TIA Bridge Address | `{{config.flame.mainnet.bridging.sequencer_celestia_address}}` |
| Astria Sequencer USDC Bridge Address | `{{config.flame.mainnet.bridging.sequencer_nobel_address}}` |
| Flame TIA Withdrawal Address| `{{config.flame.mainnet.bridging.flame_tia_address}}` |
| Flame USDC Withdrawal Address| `{{config.flame.mainnet.bridging.flame_usdc_address}}` |

## Adding to Metamask

Follow Metamask's official documentation to [manually add a custom network.](https://support.metamask.io/hc/en-us/articles/360043227612-How-to-add-a-custom-network-RPC#h_01G63GGJ83DGDRCS2ZWXM37CV5)

Your settings should be the following:

| Property | Value |
| --- | --- |
| Network Name | `{{config.flame.mainnet.info.network_name}}` |
| New RPC URL | <a :href="config.mainnet.flame_rpc" target="_blank" rel="noopener noreferrer">{{config.mainnet.flame_rpc}}</a> |
| Chain ID | `{{config.flame.mainnet.info.chain_id}}` |
| Currency symbol | `{{config.flame.mainnet.info.currency_symbol}}` |
| Block Explorer | <a :href="config.mainnet.flame_explorer" target="_blank" rel="noopener noreferrer">{{config.mainnet.flame_explorer}}</a> |

## Uniswap V3

| Name | Address |
|---|---|
| Descriptor Proxy Address | `{{config.mainnet.descriptorProxyAddress}}` |
| Multicall 2 Address | `{{config.mainnet.multicall2Address}}` |
| nft Position Descriptor Address | `{{config.mainnet.nftPositionDescriptorAddress}}` |
| nft Position Manager Address | `{{config.mainnet.nftPositionManagerAddress}}` |
| Proxy Admin Address | `{{config.mainnet.proxyAdminAddress}}` |
| Quoter V2 Address | `{{config.mainnet.quoterV2Address}}` |
| Swap Router 02 Address | `{{config.mainnet.swapRouter02Address}}` |
| Tick Lens Address | `{{config.mainnet.tickLensAddress}}` |
| v3 Core Factory Address | `{{config.mainnet.v3CoreFactoryAddress}}` |
| v3 Migrator Address | `{{config.mainnet.v3MigratorAddress}}` |
| v3 Staker Address | `{{config.mainnet.v3StakerAddress}}` |
| weth9 Address | `{{config.mainnet.weth9Address}}` |

## Using Cast

Set your `ETH_RPC_URL`:

```bash
export ETH_RPC_URL=https://rpc.flame.astria.org
```

```bash
export REC_ADDR=<SOME_ADDRESS>
```

```bash
cast balance $REC_ADDR
```

```bash
cast send $REC_ADDR --value 10000000000000000000 --private-key <PRIVATE-KEY>
```

```bash
cast balance $REC_ADDR
```
2 changes: 1 addition & 1 deletion docs/flame/flame-testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { siteConfig } from '../config.js'
const config = siteConfig
</script>

# Flame
# Flame on Testnet

Flame is the EVM for Celestia Native DeFi. The information below is specifically
for Flame running on the Astria `dawn-{{config.dawn.num}}` Testnet.
Expand Down
29 changes: 29 additions & 0 deletions docs/networks/mainnet-alpha.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- markdownlint-disable MD041 MD033 -->

<script setup>
import { siteConfig } from '../config.js'

const mainnet = siteConfig.mainnet
</script>

# Astria Mainnet Alpha

## Mainnet Endpoints

| Name | Endpoint |
|---|---|
| Sequencer RPC | <a :href="mainnet.sequencer_rpc" target="_blank" rel="noopener noreferrer">{{mainnet.sequencer_rpc}}</a> |
| Sequencer gRPC | <a :href="mainnet.sequencer_grpc" target="_blank" rel="noopener noreferrer">{{mainnet.sequencer_grpc}}</a> |
| Sequencer Block Explorer | <a :href="mainnet.sequencer_explorer" target="_blank" rel="noopener noreferrer">{{mainnet.sequencer_explorer}}</a> |
| Celestia Signer | <a :href="mainnet.celenium_signer_link" target="_blank" rel="noopener noreferrer">{{mainnet.celestia_signer_address}}</a> |
| Celestia Mainnet Namespace | <a :href="mainnet.celenium_namespace_link" target="_blank" rel="noopener noreferrer">{{mainnet.celestia_namespace}}</a> |

## Mainnet Service Versions

| Service Name | Version | Source |
|---|---|---|
| Astria Conductor | <a :href="mainnet.conductor_release" target="_blank" rel="noopener noreferrer">{{mainnet.conductor_version}}</a> | <a :href="mainnet.conductor_repo" target="_blank" rel="noopener noreferrer">repo</a> |
| Astria Composer | <a :href="mainnet.composer_release" target="_blank" rel="noopener noreferrer">{{mainnet.composer_version}}</a> | <a :href="mainnet.composer_repo" target="_blank" rel="noopener noreferrer">repo</a> |
| Astria Sequencer-relayer | <a :href="mainnet.sequencer_relayer_release" target="_blank" rel="noopener noreferrer">{{mainnet.sequencer_relayer_version}}</a> | <a :href="mainnet.sequencer_relayer_repo" target="_blank" rel="noopener noreferrer">repo</a> |
| Astria Sequencer | <a :href="mainnet.sequencer_release" target="_blank" rel="noopener noreferrer">{{mainnet.sequencer_version}}</a> | <a :href="mainnet.sequencer_repo" target="_blank" rel="noopener noreferrer">repo</a> |
| CometBFT | <a :href="mainnet.cometbft_release" target="_blank" rel="noopener noreferrer">{{mainnet.cometbft_version}}</a> | <a :href="mainnet.cometbft_repo" target="_blank" rel="noopener noreferrer">repo</a> |

0 comments on commit 31d1fa3

Please sign in to comment.