From 83f26ad528b1fcbcbf1d11e25a87dadf895cc16c Mon Sep 17 00:00:00 2001 From: iskay Date: Thu, 12 Sep 2024 14:19:14 +0200 Subject: [PATCH 1/4] update keychain and namadillo names --- packages/docs/pages/users/wallet.mdx | 2 +- packages/docs/pages/users/wallet/_meta.json | 2 +- .../pages/users/wallet/hardware-wallet.mdx | 13 +++-- .../docs/pages/users/wallet/web-wallet.mdx | 55 +++++++++++-------- 4 files changed, 41 insertions(+), 31 deletions(-) diff --git a/packages/docs/pages/users/wallet.mdx b/packages/docs/pages/users/wallet.mdx index d6a61ff0..5f5c4f2f 100644 --- a/packages/docs/pages/users/wallet.mdx +++ b/packages/docs/pages/users/wallet.mdx @@ -15,5 +15,5 @@ To read more about addresses, see [An introduction to Namada addresses](./transp Check out the different options to generate a wallet: - [File System Wallet](./wallet/file-system-wallet.mdx) -- [Web Wallet](./wallet/web-wallet.mdx) +- [Namada Keychain (browser extension)](./wallet/web-wallet.mdx) - [Hardware Wallet](./wallet/hardware-wallet.mdx) diff --git a/packages/docs/pages/users/wallet/_meta.json b/packages/docs/pages/users/wallet/_meta.json index 16673639..a56086ac 100644 --- a/packages/docs/pages/users/wallet/_meta.json +++ b/packages/docs/pages/users/wallet/_meta.json @@ -1,5 +1,5 @@ { "file-system-wallet": "File system wallet", - "web-wallet": "Web wallet", + "web-wallet": "Keychain (browser extension)", "hardware-wallet": "Hardware wallet" } diff --git a/packages/docs/pages/users/wallet/hardware-wallet.mdx b/packages/docs/pages/users/wallet/hardware-wallet.mdx index 21f55ca2..3e19ab4d 100644 --- a/packages/docs/pages/users/wallet/hardware-wallet.mdx +++ b/packages/docs/pages/users/wallet/hardware-wallet.mdx @@ -8,7 +8,7 @@ The Namada Ledger app is still in active development, and the version available See the installation instructions below if you'd like to sideload an updated development version of the app onto your device for testing purposes. -Both Namada's web wallet extension and the Namada CLI are compatible with the [Ledger](https://www.ledger.com/) hardware wallet. +Both the [Namada Keychain](./web-wallet.mdx) browser extension and the Namada CLI are compatible with the [Ledger](https://www.ledger.com/) hardware wallet. This guide will walk you through the process of setting up your Ledger device to work with Namada. ## Prerequisites @@ -40,14 +40,17 @@ Scroll down until you find Namada in the list, and select the newest version fro -## Using the Ledger app with the browser extension +## Using a Ledger with Namada Keychain (browser extension) + +You can use the Ledger app with the Namada Keychain browser extension to sign transactions in front-end web apps. See the +[Namada Keychain](./web-wallet.mdx) page for general installation and usage instructions. ### Importing (deriving) your Ledger address Before any other operations with the Ledger, we will want to derive an address and public key and add them to the extension ([web wallet](./web-wallet.mdx)) under an alias for convenience. To derive your address using a Ledger: -### Open Extension and click `Add keys` +### Open Namada Keychain and click `Add keys` ### Click `Connect hardware wallet` @@ -64,7 +67,7 @@ Give your account an easy to remember name. ### Display your address/public key -To display your Ledger address/public key, first open the extension. Find your Ledger account in the list, click the `⋮` icon (three vertical dots) and select 'View keys'. +To display your Ledger address/public key, first open Namada Keychain. Find your Ledger account in the list, click the `⋮` icon (three vertical dots) and select 'View keys'. ### Signing a transaction To sign a transaction from a front-end app (such as [Namadillo](./../../integrating-with-namada/interface.mdx)), follow these steps: @@ -73,7 +76,7 @@ To sign a transaction from a front-end app (such as [Namadillo](./../../integrat ### Connect your device and open the Namada app ### Set your Ledger as the active account -Open the extension and click the checkbox next to your Ledger account to set it as the active account. +Open the Namada Keychain and click the checkbox next to your Ledger account to set it as the active account. ### Perform your transaction diff --git a/packages/docs/pages/users/wallet/web-wallet.mdx b/packages/docs/pages/users/wallet/web-wallet.mdx index 82b78c68..4af7b60b 100644 --- a/packages/docs/pages/users/wallet/web-wallet.mdx +++ b/packages/docs/pages/users/wallet/web-wallet.mdx @@ -1,30 +1,37 @@ import { Callout } from 'nextra-theme-docs' import { Steps } from 'nextra-theme-docs' -# Web Wallet +# Namada Keychain (browser extension) -## Namada Extension -You can use the [Namada Extension](https://namada.net/extension) to manage your keys within your browser. By connecting the extension with +{/* Uncomment below when onboarding site is ready */} + +{/* + +Video guides for installing and using the Namada Keychain are available [here](https://namada-keychain.net). + +*/} + +You can use the [Namada Keychain](https://namada.net/extension) browser extension to manage your keys within your browser. By connecting Namada Keychain with web apps built for Namada, you can send or recieve tokens, make IBC transfers, or perform other actions such as voting on governance proposals. ## Installation -The extension is currently available on the [Chrome web store](https://chromewebstore.google.com/detail/namada-extension/hnebcbhjpeejiclgbohcijljcnjdofek), with Firefox support coming soon. +The Namada Keychain extension is currently available on the [Chrome web store](https://chromewebstore.google.com/detail/namada-extension/hnebcbhjpeejiclgbohcijljcnjdofek), with Firefox support coming soon. ## Set-up -After adding the extension to Chrome, follow these steps to create a new wallet: +After adding Namada Keychain to your browser, follow these steps to create a new wallet: ### Click 'Launch Initial Set-up' ### Add or create keys -You can choose 'Import existing keys' to import an existing wallet from your twelve word mnemonic. You can also use a Ledger hardware wallet -- see [here](./hardware-wallet.mdx) +You can choose 'Import existing keys' to import an existing wallet from your 12 or 24 word mnemonic, or raw private key. You can also use a Ledger hardware wallet; see [here](./hardware-wallet.mdx) for further instructions. Click 'Create new keys' and verify that you have read and understood the message to proceed. ### Safely store your mnemonic -You will be shown your recovery mnemonic and asked to confirm that you have written it down. +You will be shown your recovery mnemonic and asked to confirm that you have written it down. You can choose between a 12 or 24 word mnemonic using the toggle at the top. Write your mnemonic down and store it safely offline. @@ -33,10 +40,10 @@ It will allow you to recover your account. Without it, you risk losing access to ### Create and safely store your password -You will also be asked to create a password for the extension. Write down this password -- you will need to enter it regularly when using the extension. +You will also be asked to create a password for your Namada Keychain. Write down this password; you will need to enter it regularly when using Namada Keychain. -If you lose your password, you will lose access to the extension. +If you lose your password, you will lose access to your keys stored in Namada Keychain. Remember: there's no 'recover password with email' option! @@ -45,34 +52,34 @@ Remember: there's no 'recover password with email' option! Your wallet is ready to use. -## Using the Extension -The extension itself only provides key management functionality. To send or receive tokens, you will need to navigate to a compatible -web app (such as [namada-interface](https://github.com/anoma/namada-interface)) and connect the extension to the site. +## Using Namada Keychain +The Namada Keychain extension itself only provides key management functionality. To send or receive tokens, you will need to navigate to a compatible +web app (such as [Namadillo](https://github.com/anoma/namada-interface)) and approve a connection to Namada Keychain from the site. -Here's how to use the extension with Namada-Interface: +Here's how to use Namada Keychain with Namadillo: -### Set the network in the extension -Open the extension and click the 'gear' icon in the top right, then select 'Network'. +### Set the network in Namada Keychain +Open Namada Keychain and click the 'gear' icon in the top right, then select 'Network'. Enter a valid chain-id and rpc url for the chain you wish to transact on, and click 'Submit'. -### Navigate to the Namada-interface site -The Namada-interface for the [Campfire testnet](../../networks/testnets/campfire.mdx) is hosted at [https://interface.luminara.icu](https://interface.luminara.icu). After mainnet -has launched, a list of hosted Interfaces will be found [here](../../networks/mainnets.mdx). +### Navigate to a hosted instance of Namadillo +The Namadillo instance for the [Campfire testnet](../../networks/testnets/campfire.mdx) is hosted at [https://interface.luminara.icu](https://interface.luminara.icu). After mainnet +has launched, a list of hosted Namadillo instances will be found [here](../../networks/mainnets.mdx). -### Connect the extension -Click 'Connect to Namada Extension' and approve when prompted. You should see your wallet balance displayed on the page. +### Connect Namada Keychain +Click the 'Connect Extension' button and approve when prompted. If everything is configured correctly, you should now see your wallet balance displayed on the page. ### Interact -Once connected, you can use the Interface to make transfers or stake with a validator (Note: some functionality may be missing on testnet). -Whenever you submit a transaction to the chain, you will be prompted to enter your password to allow the extension to sign using your private key. +Once connected, you can use Namadillo to make transfers or stake with a validator (Note: some functionality may be missing on testnet). +Whenever you submit a transaction to the chain, you will be prompted to enter your password to allow Namada Keychain to sign using your private key. ### Disconnect -If you wish to disconnect (remove permissions) from a site, you can do so in the Settings menu of the extension, under 'Connected Sites'. +If you wish to disconnect (remove permissions) from a site, you can do so in the Settings menu of Namada Keychain, under 'Connected Sites'. ## Using a hardware wallet (Ledger) See the [hardware wallet](./hardware-wallet.mdx) page for instructions on installing the Namada Ledger app and using it -with the extension. \ No newline at end of file +with Namada Keychain. \ No newline at end of file From ba8e800079e72d0130569cb60dbe3805a243d547 Mon Sep 17 00:00:00 2001 From: iskay Date: Thu, 12 Sep 2024 17:33:59 +0200 Subject: [PATCH 2/4] more name updates --- .../docs/pages/integrating-with-namada/interface.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/docs/pages/integrating-with-namada/interface.mdx b/packages/docs/pages/integrating-with-namada/interface.mdx index 3977c081..7b2de7ce 100644 --- a/packages/docs/pages/integrating-with-namada/interface.mdx +++ b/packages/docs/pages/integrating-with-namada/interface.mdx @@ -1,8 +1,8 @@ # Namada Interface ## Front end development with Namada -The [namada-interface repository](https://github.com/anoma/namada-interface) is a monorepo which contains the Namada browser extension -and associated Namada-Interface web app. It's a great resource for developers wishing to understand how to incorporate the Namada SDK +The [namada-interface repository](https://github.com/anoma/namada-interface) is a monorepo which contains the Namada Keychain browser extension +and associated Namadillo web app. It's a great resource for developers wishing to understand how to incorporate the Namada SDK into their front-end applications. ### Installing from source (for development and experiment purposes) @@ -11,18 +11,18 @@ into their front-end applications. 1. Follow the instructions for the [testnets](../networks/testnets.mdx) to connect to a testnet or [set up a local node](../operators/networks/local-network.mdx). 2. Figure out where the base directory is stored and save its location as a variable such as `export BASE_DIR=`. You can follow [these docs](../networks/testnets/migrating-testnets.mdx) to save this variable. Go ahead and save the chain id as a variable as well. You can find the chain id by running `cat $BASE_DIR/global-config.toml`. Save this chain-id to the variable `export CHAIN_ID=`. -3. You will need to edit the CometBFT config in order to allow the web wallet to connect to your node. +3. You will need to edit the CometBFT config in order to allow Namadillo to connect to your node. The CometBFT config will be located in `$BASE_DIR/$CHAIN_ID/cometbft/config/config.toml`. You will need to change the `cors_allowed_origins` field to `["*"]`. You can do this by running ```shell copy sed -i 's/cors_allowed_origins = \[\]/cors_allowed_origins = ["*"]/' \ $BASE_DIR/$CHAIN_ID/cometbft/config/config.toml ``` -#### Setting up the extension +#### Setting up the Namada Keychain extension 1. Clone the [namada-interface repository](https://github.com/anoma/namada-interface). 2. Follow the installation instructions in `README.md`. -3. `cd` into the `namada-interface/apps/extension` directory and run `yarn start:chrome`. This will build the extension and place it in the `namada-interface/apps/extension/build` directory. It also starts the dev server which will watch for changes. -4. `cd` into the `namada-interface/apps/namada-interface` directory and run `yarn dev:local` in order to launch a local instance of the web wallet. +3. `cd` into the `namada-interface/apps/extension` directory and run `yarn start:chrome`. This will build the Namada Keychain extension and place it in the `namada-interface/apps/extension/build` directory. It also starts the dev server which will watch for changes. +4. `cd` into the `namada-interface/apps/namadillo` directory and run `yarn dev:local` in order to launch a local instance of Namadillo. 4. Add the extension to the browser. For example, in Chrome, you can go to `chrome://extensions/` and click `Load unpacked` and select the `namada-interface/apps/extension/build/chrome/` folder. ## Receiving tokens From a6ffec90ea4e51a8e99cf9d4fc91dd31e4335985 Mon Sep 17 00:00:00 2001 From: brentstone Date: Sat, 14 Sep 2024 16:24:18 +0200 Subject: [PATCH 3/4] edits to interface page --- .../pages/integrating-with-namada/interface.mdx | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/packages/docs/pages/integrating-with-namada/interface.mdx b/packages/docs/pages/integrating-with-namada/interface.mdx index 7b2de7ce..6652cbfd 100644 --- a/packages/docs/pages/integrating-with-namada/interface.mdx +++ b/packages/docs/pages/integrating-with-namada/interface.mdx @@ -1,21 +1,22 @@ # Namada Interface ## Front end development with Namada -The [namada-interface repository](https://github.com/anoma/namada-interface) is a monorepo which contains the Namada Keychain browser extension +The [namada-interface repository](https://github.com/anoma/namada-interface) is a monorepo that contains the Namada Keychain browser extension and associated Namadillo web app. It's a great resource for developers wishing to understand how to incorporate the Namada SDK into their front-end applications. ### Installing from source (for development and experiment purposes) #### Connect to a testnet or run a local node -1. Follow the instructions for the [testnets](../networks/testnets.mdx) to connect to a testnet or [set up a local node](../operators/networks/local-network.mdx). -2. Figure out where the base directory is stored and save its location as a variable such as `export BASE_DIR=`. - You can follow [these docs](../networks/testnets/migrating-testnets.mdx) to save this variable. Go ahead and save the chain id as a variable as well. You can find the chain id by running `cat $BASE_DIR/global-config.toml`. Save this chain-id to the variable `export CHAIN_ID=`. +1. Follow the instructions for the [testnets](../networks/testnets.mdx) to connect to a testnet or [set up a local node](../networks/starting-network/local-network.mdx). +2. Figure out where the base directory is stored and save its location in an environment variable with something like `export BASE_DIR=`. + You can follow [these docs](../networks/testnets/migrating-testnets.mdx) to save this variable. Consider saving the chain ID as an environment variable as well. + You can find the chain ID by running `cat $BASE_DIR/global-config.toml`. Save this chain-id to the environment variable `export CHAIN_ID=`. 3. You will need to edit the CometBFT config in order to allow Namadillo to connect to your node. - The CometBFT config will be located in `$BASE_DIR/$CHAIN_ID/cometbft/config/config.toml`. You will need to change the `cors_allowed_origins` field to `["*"]`. You can do this by running + The CometBFT config will be located in `$BASE_DIR/$CHAIN_ID//config.toml`. You will need to change the `cors_allowed_origins` field to `["*"]`. You can do this by running ```shell copy sed -i 's/cors_allowed_origins = \[\]/cors_allowed_origins = ["*"]/' \ - $BASE_DIR/$CHAIN_ID/cometbft/config/config.toml + $BASE_DIR/$CHAIN_ID/config.toml ``` #### Setting up the Namada Keychain extension @@ -26,9 +27,9 @@ into their front-end applications. 4. Add the extension to the browser. For example, in Chrome, you can go to `chrome://extensions/` and click `Load unpacked` and select the `namada-interface/apps/extension/build/chrome/` folder. ## Receiving tokens -You can show the address of any account by pressing the `Receive` button in the initial view under the "Total Balances" tab. You can copy the address by clicking the copy icon next to the address. +You can show the address of any account by pressing the `Receive` button in the initial view under the `Total Balances` tab. You can copy the address by clicking the copy icon next to the address. This will also display a QR code that can be scanned by a mobile wallet. ## Sending Transactions -In order to send transactions, you can press the `Send` button in the initial view under the "Total Balances" tab. This will open a modal that will allow you to send tokens to any account, from any account in your wallet that has a positive balance. +In order to send transactions, you can press the `Send` button in the initial view under the `Total Balances` tab. This will open a modal that will allow you to send tokens to any account, from any account in your wallet that has a positive balance. From 19f369b3e21094f5438c745607867e479b9865b6 Mon Sep 17 00:00:00 2001 From: brentstone Date: Sat, 14 Sep 2024 17:10:01 +0200 Subject: [PATCH 4/4] edits after review comments --- .../pages/integrating-with-namada/interface.mdx | 13 +++++-------- .../docs/pages/users/wallet/hardware-wallet.mdx | 4 ++++ 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/packages/docs/pages/integrating-with-namada/interface.mdx b/packages/docs/pages/integrating-with-namada/interface.mdx index 6652cbfd..cffc80cc 100644 --- a/packages/docs/pages/integrating-with-namada/interface.mdx +++ b/packages/docs/pages/integrating-with-namada/interface.mdx @@ -22,14 +22,11 @@ into their front-end applications. #### Setting up the Namada Keychain extension 1. Clone the [namada-interface repository](https://github.com/anoma/namada-interface). 2. Follow the installation instructions in `README.md`. -3. `cd` into the `namada-interface/apps/extension` directory and run `yarn start:chrome`. This will build the Namada Keychain extension and place it in the `namada-interface/apps/extension/build` directory. It also starts the dev server which will watch for changes. -4. `cd` into the `namada-interface/apps/namadillo` directory and run `yarn dev:local` in order to launch a local instance of Namadillo. +3. `cd` into the `namada-interface/apps/extension` directory and run `yarn start:chrome`. This will build the Namada Keychain extension and place it in `namada-interface/apps/extension/build/chrome`. It also starts the dev server which will watch for changes. +4. `cd` into the `namada-interface/apps/namadillo` directory and run `yarn dev` in order to launch a local instance of Namadillo. 4. Add the extension to the browser. For example, in Chrome, you can go to `chrome://extensions/` and click `Load unpacked` and select the `namada-interface/apps/extension/build/chrome/` folder. ## Receiving tokens -You can show the address of any account by pressing the `Receive` button in the initial view under the `Total Balances` tab. You can copy the address by clicking the copy icon next to the address. -This will also display a QR code that can be scanned by a mobile wallet. - -## Sending Transactions - -In order to send transactions, you can press the `Send` button in the initial view under the `Total Balances` tab. This will open a modal that will allow you to send tokens to any account, from any account in your wallet that has a positive balance. +You can show the address of the current account by hovering over the account name in the top right corner. Clicking it will copy it to the clipboard. +You can copy the address by clicking the copy icon next to the address. +This will also display a QR code that can be scanned by a mobile wallet. \ No newline at end of file diff --git a/packages/docs/pages/users/wallet/hardware-wallet.mdx b/packages/docs/pages/users/wallet/hardware-wallet.mdx index 3e19ab4d..e068a732 100644 --- a/packages/docs/pages/users/wallet/hardware-wallet.mdx +++ b/packages/docs/pages/users/wallet/hardware-wallet.mdx @@ -45,6 +45,10 @@ Scroll down until you find Namada in the list, and select the newest version fro You can use the Ledger app with the Namada Keychain browser extension to sign transactions in front-end web apps. See the [Namada Keychain](./web-wallet.mdx) page for general installation and usage instructions. + +Disclaimer: this will oly work on Chrome-enabled browsers at the moment. + + ### Importing (deriving) your Ledger address Before any other operations with the Ledger, we will want to derive an address and public key and add them to the extension ([web wallet](./web-wallet.mdx)) under an alias for convenience. To derive your address using a Ledger: