diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 820853ed..7734eebb 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -51,6 +51,9 @@ export default defineConfig({ { icon: "github", link: "https://github.com/astriaorg" }, { icon: "twitter", link: "https://twitter.com/AstriaOrg" }, ], + }, + vite: { + assetsInclude: ['**/*.mp4'] } }) @@ -158,7 +161,7 @@ function sidebar() { { text: 'APIs', link: '/developer/apis.md', - }, + } ] }, { diff --git a/docs/bridging/assets/bridge-clip-1-select-starting-wallet.mp4 b/docs/bridging/assets/bridge-clip-1-select-starting-wallet.mp4 new file mode 100644 index 00000000..8282a9ff Binary files /dev/null and b/docs/bridging/assets/bridge-clip-1-select-starting-wallet.mp4 differ diff --git a/docs/bridging/assets/bridge-clip-2-select-evm-wallet.mp4 b/docs/bridging/assets/bridge-clip-2-select-evm-wallet.mp4 new file mode 100644 index 00000000..e3a03207 Binary files /dev/null and b/docs/bridging/assets/bridge-clip-2-select-evm-wallet.mp4 differ diff --git a/docs/bridging/assets/bridge-clip-3-confirm-flame-in-evm-wallet.mp4 b/docs/bridging/assets/bridge-clip-3-confirm-flame-in-evm-wallet.mp4 new file mode 100644 index 00000000..c7da1ac6 Binary files /dev/null and b/docs/bridging/assets/bridge-clip-3-confirm-flame-in-evm-wallet.mp4 differ diff --git a/docs/bridging/assets/bridge-clip-4-set-deposit-amount.mp4 b/docs/bridging/assets/bridge-clip-4-set-deposit-amount.mp4 new file mode 100644 index 00000000..13e3632c Binary files /dev/null and b/docs/bridging/assets/bridge-clip-4-set-deposit-amount.mp4 differ diff --git a/docs/bridging/assets/withdrawal-clip-1-set-starting-wallet.mp4 b/docs/bridging/assets/withdrawal-clip-1-set-starting-wallet.mp4 new file mode 100644 index 00000000..cc9f7b9f Binary files /dev/null and b/docs/bridging/assets/withdrawal-clip-1-set-starting-wallet.mp4 differ diff --git a/docs/bridging/assets/withdrawal-clip-2-select-keplr-wallet.mp4 b/docs/bridging/assets/withdrawal-clip-2-select-keplr-wallet.mp4 new file mode 100644 index 00000000..af79f3ce Binary files /dev/null and b/docs/bridging/assets/withdrawal-clip-2-select-keplr-wallet.mp4 differ diff --git a/docs/bridging/assets/withdrawal-clip-3-approve-tx.mp4 b/docs/bridging/assets/withdrawal-clip-3-approve-tx.mp4 new file mode 100644 index 00000000..71de4322 Binary files /dev/null and b/docs/bridging/assets/withdrawal-clip-3-approve-tx.mp4 differ diff --git a/docs/bridging/bridge-ui.md b/docs/bridging/bridge-ui.md index f6d3689b..9f3a53b9 100644 --- a/docs/bridging/bridge-ui.md +++ b/docs/bridging/bridge-ui.md @@ -1,9 +1,20 @@ # Use the Astria Bridge UI @@ -40,16 +51,48 @@ Wallet](https://www.coinbase.com/wallet). ## Bridge to Flame -1. Confirm that the Bridge UI is set to **Deposit**. -2. Select your desired starting network and connect your Keplr wallet -3. Select Flame as the destination and connect your EVM wallet. -4. Set an amount. -5. Click `Deposit`. +### 1. Go to the [Astria Bridge UI](https://bridge.astria.org/) + +### 2. Confirm that the Bridge UI is set to **Deposit** + +### 3. Select your desired starting network and connect your Keplr wallet + +Celestia is used in this example. + + + +### 4. Select Flame as the destination and connect your EVM wallet + + + +### 5. Confirm Flame is selected in Metamask + +If Flame is not present in you wallet, you can [add it +here](../flame/flame-mainnet-alpha#adding-to-metamask). + + + +### 6. Set a deposit amount and approve the transaction + + ## Withdraw from Flame -1. Confirm that the Bridge UI is set to **Withdraw**. -2. Select Flame as the starting network and connect your EVM wallet. -3. Select your desired destination network and connect your Keplr wallet. -4. Set an amount. -5. Click `Withdraw`. +### 1. Go to the [Astria Bridge UI](https://bridge.astria.org/) + +### 2. Set the Bridge UI to **Withdraw** and Connect your EVM Wallet + +Metamask is used in this example. If Flame is not present in your wallet, you +can [add it here](../flame/flame-mainnet-alpha#adding-to-metamask). + + + +### 3. Select your desired destination network and connect your Keplr wallet + +Celestia is used in this example. + + + +### 4. Set a withdrawal amount and approve the transaction + + diff --git a/docs/developer/astria-cli/astria-cli-commands.md b/docs/developer/astria-cli/astria-cli-commands.md index a9a2dc78..dcb87fb4 100644 --- a/docs/developer/astria-cli/astria-cli-commands.md +++ b/docs/developer/astria-cli/astria-cli-commands.md @@ -341,7 +341,7 @@ astria-cli sequencer transfer [OPTIONS] --amount --private-key --min-signers --max-signers --secret-key-package-path --public-key-package-path diff --git a/docs/developer/astria-go/astria-go-commands.md b/docs/developer/astria-go/astria-go-commands.md index d8aa3527..ba92aac1 100644 --- a/docs/developer/astria-go/astria-go-commands.md +++ b/docs/developer/astria-go/astria-go-commands.md @@ -238,13 +238,13 @@ astria-go sequencer balance [address] [flags] |---|---|---|---| | `--json` | bool | `ASTRIA_GO_JSON` | Output an account's balances in JSON format. | | `--network` | string | `ASTRIA_GO_NETWORK` | Configure the values to target a specific network. (default "dawn") | -| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to retrieve the balance from. (default "https://rpc.sequencer.dawn-1.astria.org") | +| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to retrieve the balance from. | ## `sequencer block` Get sequencer block at specified height. -### Usage +### Usage ```bash astria-go sequencer block [height] [flags] @@ -256,7 +256,7 @@ astria-go sequencer block [height] [flags] |---|---|---|---| | `--json` | bool | `ASTRIA_GO_JSON` | Output an account's balances in JSON format. | | `--network` | string | `ASTRIA_GO_NETWORK` | Configure the values to target a specific network. (default "dawn") | -| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to retrieve the balance from. (default "https://rpc.sequencer.dawn-1.astria.org") | +| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to retrieve the balance from. | ## `sequencer blockheight` @@ -274,7 +274,7 @@ astria-go sequencer blockheight [flags] |---|---|---|---| | `--json` | bool | `ASTRIA_GO_JSON` | Output an account's balances in JSON format. | | `--network` | string | `ASTRIA_GO_NETWORK` | Configure the values to target a specific network. (default "dawn") | -| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to retrieve the balance from. (default "https://rpc.sequencer.dawn-1.astria.org") | +| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to retrieve the balance from. | ## `sequencer bridge` @@ -309,7 +309,7 @@ astria-go sequencer bridge init [rollup-id] [flags] | `--network` | string | `ASTRIA_GO_NETWORK` | Configure the values to target a specific network. (default "dawn") | | `--privkey` | string | `ASTRIA_GO_PRIVKEY` | The private key of the bridge account. | | `-c`, `--sequencer-chain-id` | string | `ASTRIA_GO_SEQUENCER_CHAIN_ID` | The chain ID of the sequencer. (default "dawn-1") | -| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to init bridge account (default "https://rpc.sequencer.dawn-1.astria.org") | +| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to init bridge account. | | `--sudo-address` | string | `ASTRIA_GO_SUDO_ADDRESS` | Set the sudo address to use for the bridge account. The address of the sender is used if this is not set. | | `--withdrawer-address` | string | `ASTRIA_GO_WITHDRAWER_ADDRESS` | Set the withdrawer address to use for the bridge account. The address of the sender is used if this is not set. | @@ -336,7 +336,7 @@ astria-go sequencer bridge lock [address] [amount] [destination-chain-address] [ | `--network` | string | `ASTRIA_GO_NETWORK` | Configure the values to target a specific network. (default "dawn") | | `--privkey` | string | `ASTRIA_GO_PRIVKEY` | The private key of the bridge account. | | `-c`, `--sequencer-chain-id` | string | `ASTRIA_GO_SEQUENCER_CHAIN_ID` | The chain ID of the sequencer. (default "dawn-1") | -| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to init bridge account (default "https://rpc.sequencer.dawn-1.astria.org") | +| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to init bridge account. | | `--sudo-address` | string | `ASTRIA_GO_SUDO_ADDRESS` | Set the sudo address to use for the bridge account. The address of the sender is used if this is not set. | | `--withdrawer-address` | string | `ASTRIA_GO_WITHDRAWER_ADDRESS` | Set the withdrawer address to use for the bridge account. The address of the sender is used if this is not set. | @@ -394,7 +394,7 @@ Ibc Transfer tokens from a sequencer account to another chain account. | `--network` | string | `ASTRIA_GO_NETWORK` | Configure the values to target a specific network. (default "dawn") | | `--privkey` | string | `ASTRIA_GO_PRIVKEY` | The private key of the bridge account. | | `-c`, `--sequencer-chain-id` | string | `ASTRIA_GO_SEQUENCER_CHAIN_ID` | The chain ID of the sequencer. (default "dawn-1") | -| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to init bridge account (default "https://rpc.sequencer.dawn-1.astria.org") | +| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to init bridge account. | ## `sequencer nonce` @@ -412,7 +412,7 @@ astria-go sequencer nonce [address] [flags] |---|---|---|---| | `--json` | bool | `ASTRIA_GO_JSON` | Output in JSON format. | | `--network` | string | `ASTRIA_GO_NETWORK` | Configure the values to target a specific network. (default "dawn") | -| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer. (default "https://rpc.sequencer.dawn-1.astria.org") | +| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer. | ## `sequencer setkey` @@ -447,4 +447,4 @@ astria-go sequencer transfer [amount] [to] [flags] | `--network` | string | `ASTRIA_GO_NETWORK` | Configure the values to target a specific network. (default "dawn") | | `--privkey` | string | `ASTRIA_GO_PRIVKEY` | The private key of the bridge account. | | `-c`, `--sequencer-chain-id` | string | `ASTRIA_GO_SEQUENCER_CHAIN_ID` | The chain ID of the sequencer. (default "dawn-1") | -| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to init bridge account (default "https://rpc.sequencer.dawn-1.astria.org") | +| `-u`, `--sequencer-url` | string | `ASTRIA_GO_SEQUENCER_URL` | The URL of the sequencer to init bridge account. | diff --git a/docs/tutorials/run-local-rollup-and-sequencer.md b/docs/tutorials/run-local-rollup-and-sequencer.md index cfcf307b..41364764 100644 --- a/docs/tutorials/run-local-rollup-and-sequencer.md +++ b/docs/tutorials/run-local-rollup-and-sequencer.md @@ -29,9 +29,9 @@ Create a new genesis account for your Geth rollup: cast w new ``` -Open the `dev/geth-genesis-local.json` file in the `astria-geth` repo and update the -`"alloc"` account with the new address you just created, as well as updating the -`"chainId"` and `"astriaRollupName"` to something of your choosing: +Open the `dev/geth-genesis-local.json` file in the `astria-geth` repo and update +the `"alloc"` account with the new address you just created, as well as updating +the `"chainId"` and `"astriaRollupName"` to something of your choosing: ```json{4-5,8} {