Skip to content

Commit

Permalink
Add Mainnet Alpha Docs (#88)
Browse files Browse the repository at this point in the history
Co-authored-by: Josh Bowen <[email protected]>
Co-authored-by: Josh Bowen <[email protected]>
  • Loading branch information
3 people authored Oct 30, 2024
1 parent 31d1fa3 commit b4b61c6
Show file tree
Hide file tree
Showing 7 changed files with 133 additions and 24 deletions.
1 change: 1 addition & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ function sidebar() {
text: 'Flame',
collapsed: true,
items: [
{ text: 'On Mainnet Alpha', link: '/flame/flame-mainnet-alpha.md' },
{ text: 'On Testnet', link: '/flame/flame-testnet.md' },
{ text: 'On Devnet', link: '/flame/flame-devnet.md' },
]
Expand Down
42 changes: 25 additions & 17 deletions docs/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ export const siteConfig = {
flame: {
mainnet: {
info: {
network_name: "astria",
network_name: "Flame",
chain_id: "253368190",
// for rpc url set in the dawn/dusk sections below
// for explorer url set in the dawn/dusk sections below
Expand All @@ -12,12 +12,20 @@ export const siteConfig = {
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",
ibc_noble_to_astria: "channel-104",
ibc_astria_to_noble: "channel-1",
ibc_osmosis_to_astria: "channel-85486",
ibc_astria_to_osmosis: "channel-2",
ibc_stride_to_astria: "channel-285",
ibc_astria_to_stride: "channel-3",
sequencer_celestia_address: "astria13vptdafyttpmlwppt0s844efey2cpc0mevy92p",
sequencer_nobel_address: "astria1eg8hhey0n4untdvqqdvlyl0e7zx8wfca48kglh",
sequencer_noble_address: "astria1eg8hhey0n4untdvqqdvlyl0e7zx8wfca48kglh",
sequencer_milktia_address: "astria1kgxhyhvynhcwwrylkzzx6q3a8rn3tuvasxvuy8",
sequencer_sttia_address: "astria1dllx9d9karss9ca8le25a4vqhf67a67d5d4l6r",
flame_tia_address: "0xB086557f9B5F6fAe5081CC5850BE94e62B1dDE57",
flame_usdc_address: "N/A",
flame_usdc_address: "0x3f65144F387f6545bF4B19a1B39C94231E1c849F",
flame_milktia_address: "0xcbb93e854AA4EF5Db51c3b094F28952eF0dC67bE",
flame_sttia_address: "0xdf941D092b10FF07eAb44bD174dEe915c13FECcd",
},
},
dawn: {
Expand Down Expand Up @@ -87,18 +95,18 @@ export const siteConfig = {
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",
descriptorProxyAddress: "0x7c7B695e0043647FAaf8F2D1B4E521E2261E8802",
multicall2Address: "0x86AceBA84efCb6cd03939186A598141a33260436",
nftPositionDescriptorAddress: "0x3d197d029C28Ea982feDAB1B7f6Be26FA7B338Df",
nftPositionManagerAddress: "0x1dAfd262A228571125f36f1a1333389dB0444edA",
proxyAdminAddress: "0xE1dD432a94F72da79AD1B3410C16b999463300e9",
quoterV2Address: "0x066c175fb0B8B4D1c4c2F89796Ba17D916a86eAD",
swapRouter02Address: "0x29bBaFf21695fA41e446c4f37c07C699d9f08021",
tickLensAddress: "0x8d9a1428683a003F1686e47640D721293a27432d",
v3CoreFactoryAddress: "0xE1EE203f374EE6CA6B72420844796c7acDf16A8b",
v3MigratorAddress: "0x65F23e6C7eAdd8824f944773c4BED3016d5E24FC",
v3StakerAddress: "0xE9fA9ceb079Fc208003BE7C2112E7A9afF7C8015",
weth9Address: "0x61B7794B6A0Cc383B367c327B91E5Ba85915a071",
},
dawn: {
num: 1,
Expand Down
6 changes: 3 additions & 3 deletions docs/flame/flame-devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,16 @@ Your settings should be the following:
|---|---|
| Descriptor Proxy Address | `{{config.dusk.descriptorProxyAddress}}` |
| Multicall 2 Address | `{{config.dusk.multicall2Address}}` |
| nft Position Descriptor Address | `{{config.dusk.nftPositionDescriptorAddress}}` |
| nft Position Manager Address | `{{config.dusk.nftPositionManagerAddress}}` |
| NFT Position Descriptor Address | `{{config.dusk.nftPositionDescriptorAddress}}` |
| NFT Position Manager Address | `{{config.dusk.nftPositionManagerAddress}}` |
| Proxy Admin Address | `{{config.dusk.proxyAdminAddress}}` |
| Quoter V2 Address | `{{config.dusk.quoterV2Address}}` |
| Swap Router 02 Address | `{{config.dusk.swapRouter02Address}}` |
| Tick Lens Address | `{{config.dusk.tickLensAddress}}` |
| v3 Core Factory Address | `{{config.dusk.v3CoreFactoryAddress}}` |
| v3 Migrator Address | `{{config.dusk.v3MigratorAddress}}` |
| v3 Staker Address | `{{config.dusk.v3StakerAddress}}` |
| weth9 Address | `{{config.dusk.weth9Address}}` |
| wTIA9 Address | `{{config.dusk.weth9Address}}` |

## Using Cast

Expand Down
100 changes: 100 additions & 0 deletions docs/flame/flame-mainnet-alpha.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<!-- 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}}` |

## 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> |

## Bridging

### [bridge.astria.org](https://bridge.astria.org)

![Bridge UI](/bridge-ui-screen.png)

### Celestia (IBC)

| Property | Value |
|-----|-----|
| Supported Asset | `TIA` |
| `celestia` -> `astria` | `{{config.flame.mainnet.bridging.ibc_celestia_to_astria}}` |
| `astria` -> `celestia` | `{{config.flame.mainnet.bridging.ibc_astria_to_celestia}}` |
| Astria Sequencer TIA Bridge Address | `{{config.flame.mainnet.bridging.sequencer_celestia_address}}` |
| Flame TIA Withdrawal Address| `{{config.flame.mainnet.bridging.flame_tia_address}}` |

### Noble (IBC)

| Property | Value |
|-----|-----|
| Supported Asset | `USDC` |
| `noble` -> `astria` | `{{config.flame.mainnet.bridging.ibc_noble_to_astria}}` |
| `astria` -> `noble` | `{{config.flame.mainnet.bridging.ibc_astria_to_noble}}` |
| Astria Sequencer USDC Bridge Address | `{{config.flame.mainnet.bridging.sequencer_noble_address}}` |
| Flame USDC Withdrawal Address| `{{config.flame.mainnet.bridging.flame_usdc_address}}` |

### Osmosis (IBC)

| Property | Value |
|-----|-----|
| Supported Asset | `milkTIA` |
| `osmosis` -> `astria` | `{{config.flame.mainnet.bridging.ibc_osmosis_to_astria}}` |
| `astria` -> `osmosis` | `{{config.flame.mainnet.bridging.ibc_astria_to_osmosis}}` |
| Astria Sequencer USDC Bridge Address | `{{config.flame.mainnet.bridging.sequencer_milktia_address}}` |
| Flame USDC Withdrawal Address| `{{config.flame.mainnet.bridging.flame_milktia_address}}` |

### Stride (IBC)

| Property | Value |
|-----|-----|
| Supported Asset | `stTIA` |
| `stride` -> `astria` | `{{config.flame.mainnet.bridging.ibc_stride_to_astria}}` |
| `astria` -> `stride` | `{{config.flame.mainnet.bridging.ibc_astria_to_stride}}` |
| Astria Sequencer USDC Bridge Address | `{{config.flame.mainnet.bridging.sequencer_sttia_address}}` |
| Flame USDC Withdrawal Address| `{{config.flame.mainnet.bridging.flame_sttia_address}}` |

## 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}}` |
| wTIA9 Address | `{{config.mainnet.weth9Address}}` |
6 changes: 3 additions & 3 deletions docs/flame/flame-testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,16 @@ Your settings should be the following:
|---|---|
| Descriptor Proxy Address | `{{config.dawn.descriptorProxyAddress}}` |
| Multicall 2 Address | `{{config.dawn.multicall2Address}}` |
| nft Position Descriptor Address | `{{config.dawn.nftPositionDescriptorAddress}}` |
| nft Position Manager Address | `{{config.dawn.nftPositionManagerAddress}}` |
| NFT Position Descriptor Address | `{{config.dawn.nftPositionDescriptorAddress}}` |
| NFT Position Manager Address | `{{config.dawn.nftPositionManagerAddress}}` |
| Proxy Admin Address | `{{config.dawn.proxyAdminAddress}}` |
| Quoter V2 Address | `{{config.dawn.quoterV2Address}}` |
| Swap Router 02 Address | `{{config.dawn.swapRouter02Address}}` |
| Tick Lens Address | `{{config.dawn.tickLensAddress}}` |
| v3 Core Factory Address | `{{config.dawn.v3CoreFactoryAddress}}` |
| v3 Migrator Address | `{{config.dawn.v3MigratorAddress}}` |
| v3 Staker Address | `{{config.dawn.v3StakerAddress}}` |
| weth9 Address | `{{config.dawn.weth9Address}}` |
| wTIA9 Address | `{{config.dawn.weth9Address}}` |

## Using Cast

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ hero:
features:
- title: Flame
details: Flame is the EVM for Celestia-Native DeFi, powered by Astria.
link: /flame/flame-testnet
link: /flame/flame-mainnet-alpha
icon: <svg width="196" height="196" viewBox="-58 0 300 196" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M186.485 162.553L169.906 133.459C161.191 133.887 127.047 131.435 116.669 116.052C113.471 111.31 111.772 105.926 111.72 100.532C111.601 88.254 120.953 74.7222 133.843 74.4682C142.664 74.2944 152.067 80.969 152.129 90.155C152.148 92.9897 151.184 95.7127 149.788 98.1452L162.413 120.313C171.286 112.953 176.421 101.777 176.466 90.155C176.556 67.1271 155.368 49.4711 133.523 49.8191C127.006 49.923 120.62 51.5138 114.781 54.4912C110.641 31.1499 98.9635 8.88515 93.8893 0L77.3166 29.094C81.066 35.0003 91.2816 55.8828 91.3474 72.6442C91.4058 87.5082 79.7997 100.344 64.6792 100.344C53.4083 100.344 42.3331 92.7478 42.1529 80.4268C42.0575 73.8975 45.1736 67.5856 51.4658 65.2701C53.0783 64.68 55.5098 64.4011 57.1991 64.4011L69.8238 42.2336C51.6618 35.2782 29.9689 43.6587 21.7758 61.8458C13.0386 81.2367 19.6188 104.938 37.1071 116.765C19.1139 132.097 5.83021 153.642 0.749634 162.585H33.895C41.6115 147.382 58.3203 124.882 76.8943 124.48C91.0157 124.175 103.255 134.835 104.594 149.225C105.087 154.387 103.558 159.44 100.294 163.448C96.893 167.619 91.5767 170.482 86.1725 170.475C80.8882 170.469 76.6535 167.019 74.1173 162.579H48.8616C51.8045 180.763 67.8792 195.119 86.1725 195.116C98.788 195.114 111.051 188.954 119.049 179.136C125.038 171.782 128.455 162.819 128.935 153.447C151.081 161.664 176.273 162.566 186.485 162.553Z" fill="white"/><path d="M186.485 162.553L169.906 133.459C161.191 133.887 127.047 131.435 116.669 116.052C113.471 111.31 111.772 105.926 111.72 100.532C111.601 88.254 120.953 74.7222 133.843 74.4682C142.664 74.2944 152.067 80.969 152.129 90.155C152.148 92.9897 151.184 95.7127 149.788 98.1452L162.413 120.313C171.286 112.953 176.421 101.777 176.466 90.155C176.556 67.1271 155.368 49.4711 133.523 49.8191C127.006 49.923 120.62 51.5138 114.781 54.4912C110.641 31.1499 98.9635 8.88515 93.8893 0L77.3166 29.094C81.066 35.0003 91.2816 55.8828 91.3474 72.6442C91.4058 87.5082 79.7997 100.344 64.6792 100.344C53.4083 100.344 42.3331 92.7478 42.1529 80.4268C42.0575 73.8975 45.1736 67.5856 51.4658 65.2701C53.0783 64.68 55.5098 64.4011 57.1991 64.4011L69.8238 42.2336C51.6618 35.2782 29.9689 43.6587 21.7758 61.8458C13.0386 81.2367 19.6188 104.938 37.1071 116.765C19.1139 132.097 5.83021 153.642 0.749634 162.585H33.895C41.6115 147.382 58.3203 124.882 76.8943 124.48C91.0157 124.175 103.255 134.835 104.594 149.225C105.087 154.387 103.558 159.44 100.294 163.448C96.893 167.619 91.5767 170.482 86.1725 170.475C80.8882 170.469 76.6535 167.019 74.1173 162.579H48.8616C51.8045 180.763 67.8792 195.119 86.1725 195.116C98.788 195.114 111.051 188.954 119.049 179.136C125.038 171.782 128.455 162.819 128.935 153.447C151.081 161.664 176.273 162.566 186.485 162.553Z" fill="url(#paint0_linear_133_15)"/><defs><linearGradient id="paint0_linear_133_15" x1="147.373" y1="1.28041e-07" x2="148.961" y2="195.113" gradientUnits="userSpaceOnUse"><stop stop-color="#B99985"/><stop offset="0.259829" stop-color="#D29A50"/>=<stop offset="0.476861" stop-color="#D06E18"/><stop offset="0.766321" stop-color="#CB513F"/><stop offset="0.995979" stop-color="#A42121"/></linearGradient></defs></svg>

- title: Learn
Expand Down
Binary file added docs/public/bridge-ui-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b4b61c6

Please sign in to comment.