diff --git a/packages/docs/pages/users/namadillo.mdx b/packages/docs/pages/users/namadillo.mdx index b524b27b..d8d84399 100644 --- a/packages/docs/pages/users/namadillo.mdx +++ b/packages/docs/pages/users/namadillo.mdx @@ -3,14 +3,12 @@ import { Callout } from 'nextra-theme-docs' # Namadillo -Namada mainnet will launch with most functionality aside from staking and governance disabled, gradually enabling features in stages (via governance proposals) over the first -few weeks. Therefore, some sections of Namadillo will not be accessible immediately after launch until its respective functionality has been activated on mainnet. - -Until then, you can experiment with all aspects of Namadillo on [testnet](../networks/testnets.mdx). +Namada mainnet will gradually enable features in stages. Check https://namada.net/mainnet-launch for more info! Some sections of Namadillo will not be accessible +until the respective functionality is enabled on mainnet; however, you can experiment with all aspects of Namadillo on [testnet](../networks/testnets.mdx). -Namadillo is a web-based front-end for Namada developed by Heliax. Using Namadillo, along with the [Namada Keychain browser extension](./wallet/web-wallet.mdx), -you can stake, vote in governance, shield and unshield assets, and send transparent, shielded, and IBC token transfers. +Namadillo is a web-based front-end for Namada developed by Heliax. Using Namadillo, along with the [Namada Keychain browser extension](../users/keychain.mdx), +you can stake, vote in governance, deposit and withdraw assets via IBC, and earn shielded rewards. You can find links to many different Namadillo instances hosted by community members in the following places: @@ -20,5 +18,3 @@ You can find links to many different Namadillo instances hosted by community mem This section of the docs provides step-by-step instructions for using the various features of Namadillo. - -![overview](../../public/images/namadillo/overview.png) diff --git a/packages/docs/pages/users/namadillo/_meta.json b/packages/docs/pages/users/namadillo/_meta.json index fa38f851..48e7e8c1 100644 --- a/packages/docs/pages/users/namadillo/_meta.json +++ b/packages/docs/pages/users/namadillo/_meta.json @@ -1,9 +1,12 @@ { "overview": "Getting Started", "staking": "Staking", - "governance": "Governance", - "masp": "Shielding Assets (MASP)", + "assets": "Managing Your Assets", + "shield": "Shielding Assets", + "unshield": "Unshielding Assets", "ibc": "IBC Transfers", "transfer": "Transfers Within Namada", + "governance": "Governance", + "history": "History", "troubleshooting": "Troubleshooting" } \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo/assets.mdx b/packages/docs/pages/users/namadillo/assets.mdx new file mode 100644 index 00000000..403c72c6 --- /dev/null +++ b/packages/docs/pages/users/namadillo/assets.mdx @@ -0,0 +1,22 @@ +import { Callout } from 'nextra-theme-docs' + +# Managing Your Assets + +The **Manage Assets** panel of Namadillo gives a complete view of the shielded and transparent assets in your currently selected account. + +## Transparent Assets View +![transparent assets view](../../../public/images/namadillo/transparent-assets.png) + +- **1** - The currently selected account. +- **2** - The combined value of all your transparent and shielded assets, in USD. +- **3** - The value of your transparent assets, in USD. +- **4** - All of your transparent assets, and their balances (in both tokens and USD value). +- **5** - Your currently staked balance (for NAM only). + +## Shielded Assets View +![shielded assets view](../../../public/images/namadillo/shielded-assets.png) + +- **1** - The currently selected account. +- **2** - The value of your shielded assets, in USD. +- **3** - All of your shielded assets, and their balances (in both tokens and USD value). +- **4** - The estimated Shielded Rewards you will earn from your shielded assets in the next 24 hours. diff --git a/packages/docs/pages/users/namadillo/governance.mdx b/packages/docs/pages/users/namadillo/governance.mdx index 0bf580b4..1f4e192e 100644 --- a/packages/docs/pages/users/namadillo/governance.mdx +++ b/packages/docs/pages/users/namadillo/governance.mdx @@ -7,16 +7,17 @@ Detailed information on how the governance system works at the protocol-level ca ## Governance Info By selecting 'Governance' from the left sidebar of Namadillo **(see below)**, you can get an overview of current, upcoming, and past -governance proposals. By clicking on a listed proposal, you can bring up further details about that proposal. +governance proposals. By clicking on a listed proposal, you can bring up further details about that proposal. + ![proposal-overview](../../../public/images/namadillo/governance-overview.png) -## Voting on Goverance Proposals +## Voting on Governance Proposals -Remember that your voting power is equal to your staked tokens (not your total balance)! If you haven't staked any tokens, you will not -be able to vote on any governance proposals. See the section on [Staking](./staking.mdx) for instructions on how to stake tokens. +Remember that your voting power is equal to your staked tokens (not your total balance!) If you haven't staked any tokens with a validator, you won't +be able to vote on governance. See the section on [Staking](./staking.mdx) for instructions on how to stake tokens. -Follow these steps to vote on governance proposals using Namadillo: +To vote on governance proposals using Namadillo: ### Select proposal @@ -26,12 +27,12 @@ From the main Governance page, click on the "Ongoing" proposal you wish to vote *Proposal detail view* In this view, you can see: -1. The proposal title and ID -2. The type of proposal, and -- if any -- the attached WASM code. (The pictured proposal is 'Default' type and has no WASM code, meaning it is text-only) -3. The time remaining in the voting period -4. The proposal abstract and description (Click 'Show More' to see the full desctiption) -5. Proposal details such as the proposing address and the voting start, end, and activation epochs -6. The current vote tally and turnout +1. The proposal title and ID. +2. The type of proposal, and -- if any -- the attached WASM code. (The pictured proposal is 'Default' type and has no WASM code, meaning it is text-only). +3. The time remaining in the voting period. +4. The proposal abstract and description (Click 'Show More' to see the full description). +5. Proposal details such as the proposing address and the voting start, end, and activation epochs. +6. The current vote tally and turnout. ### Submit your vote Click the 'Vote' button **(7, in the above image)**. A pop-up dialog will ask you how you wish to vote -- 'yay', 'nay', or 'abstain' -- select your vote @@ -45,5 +46,5 @@ info box in the top right corner of the page to show that your transaction is be If your vote has been registered on-chain, Namadillo will update its display with your vote **(1, below)**. If the voting period is still ongoing, you can change your vote by clicking the 'Edit Vote' button **(2, below)** and repeating the voting process. ![vote2](../../../public/images/namadillo/vote2.png) -*You can change your vote as long as the propoal is still ongoing* +*You can change your vote as long as the proposal is still ongoing* \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo/history.mdx b/packages/docs/pages/users/namadillo/history.mdx new file mode 100644 index 00000000..0f3c7db0 --- /dev/null +++ b/packages/docs/pages/users/namadillo/history.mdx @@ -0,0 +1,13 @@ +import { Callout } from 'nextra-theme-docs' + +# Transaction History + +To view your transaction history, select ** History** from the left sidebar. This will open the *Transaction History* view, as shown in the image below. You can filter your history by +transaction type. + + +Cross-chain shielded transactions are only visible on the Namadillo where they were created. + + +![History dialog](../../../public/images/namadillo/history.png) +*The Transaction History view* diff --git a/packages/docs/pages/users/namadillo/ibc.mdx b/packages/docs/pages/users/namadillo/ibc.mdx index e054c8ab..df1e8d3c 100644 --- a/packages/docs/pages/users/namadillo/ibc.mdx +++ b/packages/docs/pages/users/namadillo/ibc.mdx @@ -1,102 +1,64 @@ import { Callout, Steps } from 'nextra-theme-docs' -# IBC Transfers with Namadillo +# IBC Transfers -Learn more about IBC on Namada beyond Namadillo [here](../ibc.mdx). +If you're looking for information on IBC operations using the Namada CLI, please see [here](../ibc.mdx). You can connect Namadillo to your [Keplr wallet](https://www.keplr.app/) to transfer assets between Namada and IBC compatible chains, such as -*Osmosis* and the *Cosmos Hub*. Namadillo supports both transparent and shielded IBC transfers. +*Osmosis* and the *Cosmos Hub*. Namadillo supports transparent and shielded IBC deposits and withdrawals. -- **Transparent IBC transfers:** Transfers between a transparent (`tnam...`) address and another chain. After receiving -assets to your transparent address, they will be added to your transparent balance. You can (optionally) shield them at a later time. But as always, keep in -mind that a third party can view all balances and transactions of any transparent address at any point in the chain's history. You can use your -transparent address to both send and receive assets over IBC. -- **Shielded IBC transfers:** Transfers between a shielded (`znam...`) address and another chain. -These transfers move immediately to/from your shielded balance without needing to pass through your transparent address first. This -[reduces](../../introduction/privacy.mdx) the chances of leaking information about your on-chain activity. +## Connecting to Keplr -When using Namadillo, you can only use your shielded address to receive assets. (To send them over -IBC, you must first unshield them.) +This section assumes you have already installed Keplr and created or imported an account. For help getting started with Keplr, please refer to https://help.keplr.app/start. -## Connecting To Keplr -To send IBC assets to Namada, you will need an account on the source chain (e.g. *Osmosis*, *Cosmos Hub*, etc.) containing the assets you wish to send. +To connect Keplr to Namadillo, click the **Connect Wallet** button while creating an IBC transfer and approve the connection request. When properly connected, your Keplr wallet address will be displayed +and you'll see a Keplr icon at the top of Namadillo. -[Keplr wallet](https://www.keplr.app/) is the most widely used wallet app for Cosmos SDK chains. Namadillo has Keplr integration to allow IBC transfers -to and from your existing Keplr accounts. +![Keplr connect](../../../public/images/namadillo/keplr-connect.png) +*Connecting Keplr to Namadillo* -This rest of this section assumes you have already created and funded an account on the source chain using Keplr. For help getting started with Keplr, -please refer to https://help.keplr.app/start. +![Keplr connected](../../../public/images/namadillo/keplr-connect-2.png) +*Keplr connection visible in top bar* -Once you've installed Keplr and created or imported an account on the source chain, follow these steps to connect Keplr with Namadillo: +## Deposit (IBC Transfers to Namada) -1. Click *IBC Transfer* in the left sidebar of Namadillo **(1)** to open the IBC panel. -2. Click *Connect Wallet* **(2)**. -3. Click *Approve* in Keplr when the *Requesting Connection* **(3)** popup appears +In order to deposit IBC assets into Namada, you must first install Keplr, create or import an account, and fund it on the source chain. Then, connect +Keplr to Namadillo (see above). Keplr is needed to sign the IBC transaction on the source chain. -![Connect Keplr](../../../public/images/namadillo/keplr.png) -*Connecting your Keplr wallet to Namadillo* +To deposit IBC assets into Namada, do the following: +1. Select **IBC Transfer** in the left sidebar of Namadillo, and select the **Deposit** tab from the top of the view. +2. Connect your Keplr wallet by clicking the **Connect Wallet** button and approving the connection request. Once connected, your Keplr wallet address will be displayed +and you'll see a Keplr icon at the top of Namadillo. +3. Select the source chain/asset and amount you wish to deposit. +4. Use the toggle button to select whether you wish to make a transparent or shielded deposit. Depending on your choice, the color scheme of the interface will change and +the receiving address will automatically be filled with your transparent or shielded address, respectively. +5. Click **Submit** to begin. Approve the transaction via your Keplr wallet. After a few seconds, you should see a confirmation dialog with the details of your IBC transfer. -## Sending IBC Transfers 'To Namada' (from another chain) -You can bring assets from another chain to your Namada shielded or transparent balance; think of this as 'depositing' assets from other chains into -Namada. +After depositing assets, you'll be able to see them in the [Manage Assets](./assets.mdx) section of Namadillo. You'll also be able to see the transaction +in the [History](./history.mdx) section. -Begin by selecting '*To Namada*' **(1)** in the *IBC Transfer* section and follow these steps: + +Making a shielded deposit from the **IBC Transfer** section is equivalent to selecting **Shield Assets** and then **IBC Shield** from the topbar. See +the [Shielding Assets](./shield.mdx) section for more details, including important information on Shielded Rewards. + -![Ibc in details](../../../public/images/namadillo/ibc-in1.png) -*Making an IBC transfer into Namada (i.e. Depositing assets)* +## Withdraw (IBC Transfers from Namada) - -### Enter the transfer details -- **(2)**: Click to select the *network you wish to bring assets from* (e.g. Osmosis, Cosmos Hub, etc.). Once you've selected a network, your address -on the sending chain will be read from Keplr and displayed here. -- **(3)**: Click to select the asset you wish to transfer. -- **(4)**: Enter the amount to transfer. -- **(5)**: Click to specify whether to send the asset to your shielded or transparent address. -- **(6)**: Your receiving address will be automatically filled from the Keychain extension. If you selected *Shielded* directly above, this will show -your shielded address; if you selected *Transparent* it will show your transparent address. The address shown will match the currently selected account -in the Keychain extension. -- **(7)**: The transaction fee for this transfer -- note that fees are paid in the asset being transferred. -- **(8)**: When you've chosen a source network, asset, amount, and whether to send to your shielded or transparent address, click *Submit* to begin the transfer. +When withdrawing IBC assets from Namada, you may wish to install and connect Keplr as discussed above. This will allow you to automatically fill the +receiver address with your Keplr address on the destination chain. However, you can also proceed without Keplr by manually entering the receiver address. -### Click 'Submit' and approve your transaction -After entering the required transfer info, click *Submit*, at which point you'll be prompted to approve the transaction. +To withdraw IBC assets from Namada, do the following: +1. Select **IBC Transfer** in the left sidebar of Namadillo, and select the **Withdraw** tab from the top of the view. +2. Select the destination chain/asset and amount you wish to unshield. +3. Use the toggle button to select whether you wish to make a transparent or shielded withdrawal. Depending on your choice, the color scheme of the interface will change and +the sender address will automatically be filled with your transparent or shielded address, respectively. +4. You can either connect your Keplr wallet or manually enter a destination address. To connect your Keplr wallet, click **Connect Wallet** and approve the connection request. +Once connected, your Keplr address will be displayed and you'll see a Keplr icon at the top of Namadillo. To manually enter a destination address, click the +**Custom Address** toggle and enter the address in the text field. Remember that the receiver address must be a valid address on the destination chain (e.g. an address beginning +with *osmo...* if the destination chain is *Osmosis*). +5. Click **Submit** to begin. Approve the transaction via Namada Keychain. After a few seconds, you will see a confirmation dialog with the details of your IBC transfer. -Note that when IBC transferring assets to Namada, you'll be asked to confirm the transaction in Keplr (not Namada Keychain). - -![IBC in confirm](../../../public/images/namadillo/ibc-in2.png) -*Confirming the transaction in Keplr* - - -## Sending IBC Transfers 'From Namada' (to another chain) -You can also transfer assets (including, but not limited to, NAM) to another chain. Remember that you can only make outgoing IBC transfers from your transparent -address -- if you wish to transfer shielded assets, you must unshield them first. - -Begin by selecting '*From Namada*' **(1)** in the *IBC Transfer* section and follow these steps: - -![IBC out details](../../../public/images/namadillo/ibc-out1.png) -*IBC Transferring assets out of Namada* - - -### Enter the transfer details -- **(2)**: Your transparent address (from which the transfer is being sent). This is automatically filled from the Keychain extension based on your -currently selected account. Note that outgoing IBC transfers using Namadillo cannot be made from a shielded account. -- **(3)**: Click to select the asset you wish to transfer. -- **(4)**: Enter the amount to transfer. -- **(5)**: Select *My Address* to automatically set the receiver to your Keplr address on the destination chain. Select *Custom Address* to enter a different address. -(See below for more details.) -- **(6)**: Click here to select the destination chain. -- **(7)**: The transaction fee for this transfer -- note that fees are paid in NAM. -- **(8)**: When you've chosen an asset, amount, destination chain, and receiving address, click *Submit* to begin the transfer. - -**Setting a custom receiver address:** -By selecting *Custom Address*, you can send assets to an address not in your Keplr wallet. Choosing this option also (optionally) lets you attach -a memo to the transaction. *Make sure the receiver is a valid address on the destination chain* -- e.g. if the destination chain is *Osmosis*, the -address should have an *osmo* prefix. - - -![IBC custom receiver](../../../public/images/namadillo/ibc-out2.png) - -### Click 'Submit' and approve your transaction -After entering the required transfer info, click *Submit*. You'll be prompted to approve the transaction and it will begin processing. When the transfer -has completed, the status will update to show *Transfer Completed*. - + +Withdrawing a shielded asset from the **IBC Transfer** section is equivalent to selecting **Unshield** and then **IBC Unshield** from the topbar. See +the [Unshielding Assets](./unshield.mdx) section for more details, including important information on failed transactions and refund addresses. + diff --git a/packages/docs/pages/users/namadillo/masp.mdx b/packages/docs/pages/users/namadillo/masp.mdx deleted file mode 100644 index 9be0567d..00000000 --- a/packages/docs/pages/users/namadillo/masp.mdx +++ /dev/null @@ -1,92 +0,0 @@ -import { Callout, Steps } from 'nextra-theme-docs' - -# Shielding Assets with Namadillo - -Learn more about the shielded pool on Namada beyond Namadillo [here](../shielded-accounts.mdx). - -One of Namada's flagship features is the ability to move your assets into the **Multi-Asset Shielded Pool** (*a.k.a.* the -*MASP* or *Shielded Pool*). Moving assets into the pool to your shielded balance is referred to as *shielding*, and moving assets out of the pool to your transparent balance -is referred to as *unshielding*. By holding eligible assets in the MASP you'll earn rewards in the form of *NAM*, which will automatically -be added to your shielded balance each epoch. - -You can use the *MASP* tab of Namadillo to manage your shielded assets and rewards, including: -- viewing your current asset balances -- shielding and unshielding assets -- viewing your estimated shielded rewards per epoch - -You can also transfer shielded assets from your shielded account to another shielded recipient (*i.e.* a **Shielded Transfer**) in Namadillo's *Transfer* tab. -For instructions on the steps to make a shielded transfer using Namadillo, refer to the [Transfer](./transfer.mdx) section of this guide. - -## Shielded Assets (MASP) Dashboard -Select **MASP** from Namadillo's left sidebar to open the dashboard **(below)**. On the dashboard, you can see: -- **(1)** and **(2)**: Your total shielded balance and shielded NAM balances, respectively. -- **(3)**: Your estimated shielded rewards per epoch. -- **(4)**: A list of all your currently owned shielded assets. -- **(5)**: Click any of the buttons marked **Shield Assets** to shield an asset, moving it from your transparent balance to your shielded balance. -- **(6)**: Click the **Unshield** button beside any of your shielded assets to unshield some or all of that asset - -![MASP dashboard](../../../public/images/namadillo/shield1.png) -*Clicking 'MASP' in the left sidebar lets you manage your shielded assets* - -## Shielding Assets -From the Shielded Assets (MASP) Dashboard, follow these steps to shield an asset: - -### Click any of the buttons marked 'Shield Assets' -This will open the Shielding dialog as shown below. - -### Choose an asset type and amount -Your transparent and shielded addresses will be automatically entered based on your active account in the Keychain browser extension. -First, check that they match the expected values. If not, open the Keychain extension to switch to the correct account. - -- **(1)**: Click here to select an asset type. -- **(2)**: Enter the amount you wish to shield here. -- **(3)**: After choosing an asset and amount, click **Submit** to begin shielding. - -![Shielding step 2](../../../public/images/namadillo/shield2.png) -*Choosing the asset and amount to shield* - -### Click 'Submit' and approve your transaction -After entering the required info, click **Submit**. You will be prompted by the extension to approve the transaction; if you're using -a Ledger, you will be prompted to confirm on the device, otherwise you will be prompted to enter your password. **Note: it may take slightly longer -to construct the shielding transaction and show the confirmation dialog compared with other transaction types.** - -After confirming, an animation will play to show that your shielding transaction is being processed. After roughly 10 seconds, the display will update -with *Shielded Transfer Complete* as in the following image: - -![Shielding step 3](../../../public/images/namadillo/shield3.png) -*Shielding transaction confirmation* - - -## Unshielding Assets -The process for unshielding assets is very similar to shielding them. - - -### Find your current shielded assets -Click **MASP** in Namadillo's sidebar to open the MASP dashboard, and find the list of your current shielded assets in the **Shielded Overview** section. - -### Click 'Unshield' -Click the button marked **Unshield** beside the asset you wish to unshield. This will open the Unshield dialog, where your selected asset type, shielded address and transparent -address will all be automatically entered. You will need to enter the amount you wish to unshield and click 'Submit' when you're ready. - -![Unshielding](../../../public/images/namadillo/unshield.png) -*Unshielding an asset* - -### Click 'Submit' and approve your transaction -Follow the prompts to approve your transaction and wait for it to process, as explained in the previous section on -[shielding](#click-submit-and-approve-your-transaction). - - -## Viewing your estimated Shielded Rewards -Shielded rewards accrue each MASP epoch based on the amount of assets you have shielded, and are automatically added to your shielded *NAM* balance. You can -view an estimate of your expected rewards per epoch both in the **MASP** and **Overview** (homepage) sections of Namadillo. - -On mainnet, one MASP epoch is equal to four epochs (that is, 24 hours). - - -**Note:** your actual shielded rewards will depend on the total asset amounts held in the MASP by all users. Therefore, the number shown is only an estimate. - - - -Not all asset types will earn shielded rewards at the same rate; you can view the reward rate of each shielded asset in the **MASP dashboard** in the -**Shielded Overview** section, which contains a list of your current shielded assets. Check the column named **SSR Rate** for the reward rate of eligible assets (if no rate is listed, -that asset is not eligible for shielded rewards). diff --git a/packages/docs/pages/users/namadillo/overview.mdx b/packages/docs/pages/users/namadillo/overview.mdx index 31e3f9e5..75cc6b74 100644 --- a/packages/docs/pages/users/namadillo/overview.mdx +++ b/packages/docs/pages/users/namadillo/overview.mdx @@ -1,29 +1,12 @@ import { Callout, Steps } from 'nextra-theme-docs' -# Namadillo Overview +# Getting Started - -Namada mainnet will launch with most functionality aside from staking and governance disabled, gradually enabling features in stages (via governance proposals) over the first -few weeks. Therefore, some sections of Namadillo will not be accessible immediately after launch until its respective functionality has been activated on mainnet. - -Until then, you can experiment with all aspects of Namadillo on [testnet](../networks/testnets.mdx). - - -Namadillo is a web-based front-end for Namada developed by Heliax. Using Namadillo, along with the [Namada Keychain browser extension](./wallet/web-wallet.mdx), -you can stake, vote in governance, shield and unshield assets, and send transparent, shielded, and IBC token transfers. - - -You can find links to many different Namadillo instances hosted by community members in the following places: -- On [namada.net](https://namada.net/apps#interfaces) -- On [namada.community](https://namada.community/infra/interfaces), the primary knowledge base for all community infra and services -- In the [namada-ecosystem github repo](https://github.com/Luminara-Hub/namada-ecosystem/tree/main/user-and-dev-tools) in an `interfaces.json` - - -## Getting started with Namadillo +Before using Namadillo, you'll want to install the [Namada Keychain browser extension](https://chromewebstore.google.com/detail/namada-keychain/hnebcbhjpeejiclgbohcijljcnjdofek), which will let you manage your keys (accounts) and +sign transactions. The [Namada Keychain section](../../users/keychain.mdx) of these docs has instructions for installing the extension and creating a new account, or you can +check out https://namada.help for video walkthroughs. For the pages in this section, we assume you've already installed the extension and completed the initial setup. -Before using Namadillo, you will need to install the [Namada Keychain browser extension](../wallet/web-wallet.mdx) and -follow the steps for initial setup, including setting a password and creating a new account. See the section in the docs [here](../wallet/web-wallet.mdx) for detailed -instructions. +## Connecting to Namadillo ### Navigate to Namadillo @@ -36,10 +19,10 @@ to approve the connection, which will allow Namadillo to see **non-secret** info *Note:* If you do not see a button marked 'Connect Keychain', you haven't installed the [Namada Keychain browser extension](../../users/wallet/web-wallet.mdx) yet. -![Connecting 1](../../../public/images/namadillo/connect1.png) +![Connecting 1](../../../public/images/namadillo/connect-1.png) *Click either button marked 'Connect Keychain'* -![Connecting 2](../../../public/images/namadillo/connect2.png) +![Connecting 2](../../../public/images/namadillo/connect-2.png) *Approve the connection request* You can disconnect from a site at any time in the extension by clicking on the extension icon in your browser bar to open it, and selecting @@ -70,5 +53,5 @@ explained in Step 1. Whenever you're submitting a transaction of any kind for the first time from an address, you'll also see a 'Reveal PK' (Reveal Public Key) transaction automatically bundled with your other transaction(s) **(6, below)**. These are part of the Namada protocol, but as a user you don't need to worry about it; Namadillo will automatically insert these when required. -![Reveal PK](../../../public/images/namadillo/stake5.png) +![Reveal PK](../../../public/images/namadillo/sign-1.png) *Example of a staking transaction with Reveal PK message* \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo/shield.mdx b/packages/docs/pages/users/namadillo/shield.mdx new file mode 100644 index 00000000..ed083ebd --- /dev/null +++ b/packages/docs/pages/users/namadillo/shield.mdx @@ -0,0 +1,70 @@ +import { Callout, Steps } from 'nextra-theme-docs' + +# Shielding Assets + + +You can learn more about Namada's Shielded Pool (aka: the MASP) and its features [here](../shielded-accounts.mdx). + + +You can shield assets (both NAM and IBC assets from other chains) in Namada's Shielded Pool using Namadillo. For certain IBC assets, you will also earn Shielded Rewards (see below for more details). + +To begin shielding, click the **Shield Assets** button in the Namadillo's topbar, and then choose between *IBC Shield* or *Internal Shield*. + +- **IBC Shield**: Deposit assets from another chain (using IBC) directly into your shielded balance. +- **Internal Shield**: Shield assets you already hold in your transparent Namada balance. + +![Shield assets](../../../public/images/namadillo/action-buttons.png) +![Shielding choices](../../../public/images/namadillo/shield-choice.png) + +## IBC Shielding +Before you can begin IBC shielding, you'll need to have installed [Keplr wallet](https://www.keplr.app/) and funded an account on the source chain. + +For help getting started with Keplr, please refer to https://help.keplr.app/start. + +Once you're ready to begin IBC shielding, do the following: + +1. Click the **Shield Assets** button in the Namadillo's topbar and select **IBC Shield**. +2. Connect your Keplr wallet by clicking the **Connect Wallet** button and approving the connection request. When properly connected, your Keplr wallet address will be displayed +and you'll see a Keplr icon at the top of Namadillo. +3. Select the source chain/asset and amount you wish to shield. +4. The **Shielded** toggle should be already selected by default and your Namada shielded address will be displayed. If not, select the **Shielded** toggle now. +5. Click **Submit** to begin. Approve the transaction via your Keplr wallet. After a few seconds, you should see a confirmation dialog with the details of your shielding transaction. + +![Keplr connect](../../../public/images/namadillo/keplr-connect.png) +*Connecting Keplr to Namadillo* + +![IBC shielding](../../../public/images/namadillo/ibc-shield.png) +*IBC shielding* + +## Internal Shielding +Before you can begin internal shielding, you'll need to already hold some assets in your transparent balance on Namada. You can shield both NAM and IBC assets. + +To begin internal shielding, do the following: + +1. Click the **Shield Assets** button in the Namadillo's topbar and select **Internal Shield**. +2. Select the asset and amount you wish to shield. +3. Click **Submit** to begin. Approve the transaction via Namada Keychain. After a few seconds, you should see a confirmation dialog with the details of your shielding transaction. + +![Internal shielding](../../../public/images/namadillo/int-shield.png) +*Internal shielding* + +## Viewing your Shielded Assets and Shielded Rewards +After you've shielded assets, you'll be able to view them in the [Manage Assets](./assets.mdx) section of Namadillo (which can be selected from the left sidebar). + +Certain assets are eligible for Shielded Rewards. By holding these assets in your shielded balance, you'll earn rewards in the form of NAM every 24 hours. The determination +of which assets are eligible for Shielded Rewards and the reward rate for each asset is determined by on-chain governance. + +You can see which assets will earn Shielded Rewards in a few different ways: +- In Namadillo: if an asset's estimated rewards are 0, it is not eligible for Shielded Rewards. +- Also in Namadillo: by visiting the **Internal Shield** page, the right sidebar will display a list of assets that are eligible for Shielded Rewards and their annual inflation rate. +- By visiting the [Namada Metrics Dashboard](https://metrics.namada.net) or the [Reward Simulator](https://rewardsim.luminara.icu). + +In the [Manage Assets](./assets.mdx), you'll see a list of your shielded assets and an estimate of your expected Shielded Rewards for the next 24 hours. + + +- Your actual Shielded Rewards for an asset will depend on the total amount of that asset held in the Shielded Pool by all users. +- Assets may earn rewards at different rates. The rate for each asset is determined by on-chain governance. +- To incentivize deposits, the reward rate for each asset is highest when there is a low amount of that asset held in the Shielded Pool, tapering off as the amount approaches +that asset's *Target Locked Amount*. Shielding assets with a low amount in the Shielded Pool is a good strategy to maximize your rewards. +- Due to the dynamic nature of the rewards calculation, the expected rewards displayed in Namadillo are estimates only. + diff --git a/packages/docs/pages/users/namadillo/staking.mdx b/packages/docs/pages/users/namadillo/staking.mdx index 8ee3cafe..3369de6a 100644 --- a/packages/docs/pages/users/namadillo/staking.mdx +++ b/packages/docs/pages/users/namadillo/staking.mdx @@ -1,8 +1,11 @@ import { Callout, Steps } from 'nextra-theme-docs' -# Staking with Namadillo +# Staking in Namadillo -You can stake using Namadillo and the Namada Keychain browser extension, including support for Ledger hardware wallets. +In the **Staking** panel of Namadillo, you can stake, unstake, redelegate, and claim your staking rewards. You can also view your staking positions and see the status of +your unbonding requests. + +You can safely stake NAM in a Ledger hardware wallet, since Namada Keychain features full Ledger support. ### Open the staking dashboard diff --git a/packages/docs/pages/users/namadillo/transfer.mdx b/packages/docs/pages/users/namadillo/transfer.mdx index d787e3dc..16cd724d 100644 --- a/packages/docs/pages/users/namadillo/transfer.mdx +++ b/packages/docs/pages/users/namadillo/transfer.mdx @@ -1,26 +1,19 @@ import { Callout, Steps } from 'nextra-theme-docs' -# Shielded and Transparent Transfers with Namadillo +# Transfers Within Namada Learn more about Namada shielded accounts [here](../shielded-accounts.mdx) and transparent accounts [here](../transparent-accounts.mdx) beyond Namadillo. - -Namada mainnet will launch with most functionality aside from staking and governance disabled, gradually enabling features in stages (via governance proposals) over the first -few weeks. Therefore, some sections of Namadillo will not be accessible immediately after launch until its respective functionality has been activated on mainnet. - -Until then, you can experiment with all aspects of Namadillo on [testnet](../networks/testnets.mdx). - - -Namadillo supports both shielded and transparent transfers of NAM and any other token asset. +You can send NAM or any other asset from one Namada address to another. There are two types of transfers you can send using Namadillo: - **Shielded Transfers:** Are sent from one shielded (`znam...`) address to another. This helps prevent third-parties from knowing the details of your -transactions\*. +transactions (see Note below). - **Transparent Transfers:** Are sent from one transparent (`tnam...`) address to another. A third party viewing the transaction will be able to see the sending address, receiving address, token and amount. Remember that a third party can view the balances and transaction history of any transparent address at any point in the chain's history. -**\* Note:** while shielded transfers keep your transaction details secure within the protocol itself, be careful not to leak extra information that could allow others to make inferences about +**Note:** while shielded transfers keep your transaction details secure within the protocol itself, be careful not to leak extra information that could allow others to make inferences about your activity based on your usage patterns. Consider the analogy of borrowing books from a library. If you regularly borrow books on a very specific topic, and only a few people are interested in that topic, others might start guessing @@ -30,36 +23,15 @@ See [this section](../../introduction/privacy.mdx) for more information and best ## Sending a transfer - -### Select 'Transfer' from the left sidebar -This will open the *Transfer* dialog, as shown in the image below. - -### Choose the transfer type (Shielded/Transparent) -Click the toggle **(marked 1, in the below image)** to switch between shielded and transparent transfers. - -### Enter the transfer info -First, check that the sending address displayed near the top of the dialog is the one you expect. If not, open the Keychain extension to switch between your -accounts. - -![Transfer dialog](../../../public/images/namadillo/transfer1.png) -*The Transfer dialog for sending both shielded and transparent transfers* - -- **(2)**: Your sending address (automatically filled from the Keychain extension). -- **(3)**: Click here to choose the asset you wish to send. -- **(4)**: Enter the amount you wish to send here. -- **(5)**: Enter the recipient address here. If you've selected shielded transfer, the recipient must be a `znam` (shielded) address. -If you've selected transparent transfer, the recipient must be a `tnam` (transparent) address. -- **(6)**: (Optionally) enter the memo here. If you're sending (depositing) to a centralized exchange, you are often required by the exchange to -attach a specific memo in order for your transfer to be processed correctly. Check with your exchange to see what they require. -- **(7)**: Click to submit your transfer after filling in the required info. - -### Click 'Submit' and approve your transaction -After entering the required transfer info, click **Submit**. You will be prompted by the extension to approve the transaction; if you're using -a Ledger, you will be prompted to confirm on the device, otherwise you will be prompted to enter your password. - -After confirming, you'll see a grey dialog box in the top right corner of Namadillo to let you know that your transaction has been submitted -and is being processed. After roughly 10 seconds, you will see either a green or red dialog box to let you know if your transaction was approved. -![Submit Transfer](../../../public/images/namadillo/transfer2.png) -*Completing the transfer* - \ No newline at end of file +To send a transfer using Namadillo, do the following: +1. Select 'Transfer' from the left sidebar, or click the **Transfer** button in the top bar. +2. Using the toggle, select whether you want to send a shielded or transparent transfer. Depending on your choice, the color of the interface will change and either your +shielded or transparent address will be automatically filled in as the sending address. +3. Select the asset and amount you wish to send. +4. Enter the recipient address in the text field. If you're sending a shielded transfer, the recipient must be a `znam` (shielded) address. If you're sending a transparent transfer, the +recipient must be a `tnam` (transparent) address. +5. Click **Submit** to begin. Approve the transaction via your Namada Keychain. After a few seconds, you should see a confirmation dialog with the details of your transfer. + +![Transfer dialog](../../../public/images/namadillo/transfer.png) +*Sending a transparent transfer* diff --git a/packages/docs/pages/users/namadillo/troubleshooting.mdx b/packages/docs/pages/users/namadillo/troubleshooting.mdx index 4289ed90..fe7266cf 100644 --- a/packages/docs/pages/users/namadillo/troubleshooting.mdx +++ b/packages/docs/pages/users/namadillo/troubleshooting.mdx @@ -2,15 +2,15 @@ ### Try Another Namadillo Host Namadillo has been envisioned as a decentralized front-end, and there are multiple instances of the app running on different servers, hosted and operated by various teams and members of the community. If you're experiencing issues with one -host, the first course of action should be to try another instance listed on either the [Namada Apps page](https://namada.net/apps) or the [Luminara Community Site](https://www.namada.community/infra/interfaces). +host, the first course of action should be to try another instance listed on either the [Namada Apps page](https://namada.net/start#interfaces) or the [Luminara Community Site](https://www.namada.community/infra/interfaces). -### 'Transaction Exceeds its Gas Limit' Error +### 'Transaction Exceeds Its Gas Limit' Error If you see the error message 'Transaction exceeds its gas limit' when trying to make a transaction (see below), it means that the transaction you're trying to send requires more gas to process than you have provided. Usually, Namadillo will automatically calculate the required gas for a transaction, but in some cases you may need to manually adjust the gas amount. To manually set the gas amount for a transaction, look for the clickable 'Transaction Fee' text when preparing to send a transaction. This will open a dialog -where you can choose the token with which to pay the fee, and enter the desired gas amount. For most transactions, a gas amount equal to *50000* (0.05 NAM) will be sufficient. +where you can choose the token with which to pay the fee, and enter the desired gas amount. For most transactions, a gas amount equal to `50000` (0.05 NAM) will be sufficient. However, if you're batching multiple transactions together (such as claiming rewards when you've staked to multiple validators) you may need to increase this value. ![Gas limit error](../../../public/images/namadillo/gas.png) \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo/unshield.mdx b/packages/docs/pages/users/namadillo/unshield.mdx new file mode 100644 index 00000000..c89a052d --- /dev/null +++ b/packages/docs/pages/users/namadillo/unshield.mdx @@ -0,0 +1,68 @@ +import { Callout, Steps } from 'nextra-theme-docs' + +# Unshielding Assets + + +You can learn more about Namada's Shielded Pool (aka: the MASP) and its features [here](../shielded-accounts.mdx). + + +To begin unshielding, click the **Unshield** button in the Namadillo's topbar, and then choose between *IBC Unshield* or *Internal Unshield*. + +- **IBC Unshield**: Withdraw assets directly from your shielded balance to another IBC connected chain. +- **Internal Unshield**: Withdraw assets from your shielded balance to your transparent balance on Namada. + +![Unshield assets](../../../public/images/namadillo/action-buttons.png) +![Shielding choices](../../../public/images/namadillo/unshield-choice.png) + +## IBC Unshielding +Before you begin, you may wish to install [Keplr wallet](https://www.keplr.app/) and complete the initial setup process to generate an address +on the destination chain. This will allow you to connect Keplr and auto-fill your wallet address as the destination. However, you can +also proceed without Keplr and manually enter a destination address. + +For help getting started with Keplr, please refer to https://help.keplr.app/start. + +Once you're ready to begin IBC unshielding, follow these steps: + +1. Click the **Unshield** button in the Namadillo's topbar and select **IBC Unshield**. +2. Select the destination chain/asset and amount you wish to unshield. +3. The **Shielded** toggle should be already selected by default and your Namada shielded address will be displayed. If not, select the **Shielded** toggle now. +4. You can either connect your Keplr wallet or manually enter a destination address. To connect your Keplr wallet, click the **Connect Wallet** button and approve the connection request. +Once connected, your Keplr wallet address will be displayed and you'll see a Keplr icon at the top of Namadillo. If you'd like to manually enter a destination address, click the +**Custom Address** toggle and enter the address in the text field. +5. Click **Submit** to begin. Approve the transaction via Namada Keychain. After a few seconds, you should see a confirmation dialog with the details of your unshielding transaction. + +![IBC unshielding](../../../public/images/namadillo/ibc-unshield.png) +*IBC unshielding* + +## Internal Unshielding +Before you can begin internal unshielding, you must hold one or more assets in your shielded balance on Namada. + +To begin internal unshielding, follow these steps: + +1. Click the **Unshield** button in the Namadillo's topbar and select **Internal Unshield**. +2. Select the asset and amount you wish to unshield. +3. Click **Submit** to begin. Approve the transaction via Namada Keychain. After a few seconds, you should see a confirmation dialog with the details of your unshielding transaction. + +![Internal unshielding](../../../public/images/namadillo/int-unshield.png) +*Internal unshielding* + +## Failed Transactions and Refund Addresses +Sometimes, due to issues on the destination chain or IBC relayers, your unshielding transaction may fail or timeout. When this happens, your tokens will be returned to you. +However, since it's not possible for them to be returned directly to your shielded address, a **refund account** will automatically be generated in Namada Keychain to +receive your tokens in its transparent balance. + +To view your refund account and refunded assets, make sure the toggle switch **Display refund addresses** is enabled and then +select the refund account in Namada Keychain as you would any other account. It's recommended to transfer the refunded assets to +one of your other accounts as soon as possible. + +![Refund account](../../../public/images/namadillo/refund-1.png) +*Displaying refund accounts (make sure the toggle switch is enabled)* + +![Refund address](../../../public/images/namadillo/refund-2.png) +*Selecting the refund account will display its address and private key* + + +Be aware that since the refund account is automatically generated upon need, you cannot restore it later from a seed phrase. You can, if you wish, view and backup its private key in +order to restore it in that manner. However, for simplicity it's better to treat this as a disposable account and transfer the refunded assets to one of your other accounts +as soon as possible, deleting the refund account after doing so. + diff --git a/packages/docs/public/images/namadillo/action-buttons.png b/packages/docs/public/images/namadillo/action-buttons.png new file mode 100644 index 00000000..055e5d1b Binary files /dev/null and b/packages/docs/public/images/namadillo/action-buttons.png differ diff --git a/packages/docs/public/images/namadillo/connect-1.png b/packages/docs/public/images/namadillo/connect-1.png new file mode 100644 index 00000000..cd6c8a93 Binary files /dev/null and b/packages/docs/public/images/namadillo/connect-1.png differ diff --git a/packages/docs/public/images/namadillo/connect-2.png b/packages/docs/public/images/namadillo/connect-2.png new file mode 100644 index 00000000..bd9f7711 Binary files /dev/null and b/packages/docs/public/images/namadillo/connect-2.png differ diff --git a/packages/docs/public/images/namadillo/connect1.png b/packages/docs/public/images/namadillo/connect1.png deleted file mode 100644 index 12640cb2..00000000 Binary files a/packages/docs/public/images/namadillo/connect1.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/connect2.png b/packages/docs/public/images/namadillo/connect2.png deleted file mode 100644 index 9f2ebd43..00000000 Binary files a/packages/docs/public/images/namadillo/connect2.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/history.png b/packages/docs/public/images/namadillo/history.png new file mode 100644 index 00000000..2f7ece4b Binary files /dev/null and b/packages/docs/public/images/namadillo/history.png differ diff --git a/packages/docs/public/images/namadillo/ibc-in1.png b/packages/docs/public/images/namadillo/ibc-in1.png deleted file mode 100644 index 15d5640d..00000000 Binary files a/packages/docs/public/images/namadillo/ibc-in1.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/ibc-in2.png b/packages/docs/public/images/namadillo/ibc-in2.png deleted file mode 100644 index d5bebd98..00000000 Binary files a/packages/docs/public/images/namadillo/ibc-in2.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/ibc-out1.png b/packages/docs/public/images/namadillo/ibc-out1.png deleted file mode 100644 index 82b39502..00000000 Binary files a/packages/docs/public/images/namadillo/ibc-out1.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/ibc-out2.png b/packages/docs/public/images/namadillo/ibc-out2.png deleted file mode 100644 index c027a357..00000000 Binary files a/packages/docs/public/images/namadillo/ibc-out2.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/ibc-shield.png b/packages/docs/public/images/namadillo/ibc-shield.png new file mode 100644 index 00000000..6c4971eb Binary files /dev/null and b/packages/docs/public/images/namadillo/ibc-shield.png differ diff --git a/packages/docs/public/images/namadillo/ibc-unshield.png b/packages/docs/public/images/namadillo/ibc-unshield.png new file mode 100644 index 00000000..9d484f74 Binary files /dev/null and b/packages/docs/public/images/namadillo/ibc-unshield.png differ diff --git a/packages/docs/public/images/namadillo/int-shield.png b/packages/docs/public/images/namadillo/int-shield.png new file mode 100644 index 00000000..6e5fb200 Binary files /dev/null and b/packages/docs/public/images/namadillo/int-shield.png differ diff --git a/packages/docs/public/images/namadillo/int-unshield.png b/packages/docs/public/images/namadillo/int-unshield.png new file mode 100644 index 00000000..1e84664a Binary files /dev/null and b/packages/docs/public/images/namadillo/int-unshield.png differ diff --git a/packages/docs/public/images/namadillo/keplr-connect-2.png b/packages/docs/public/images/namadillo/keplr-connect-2.png new file mode 100644 index 00000000..e4d859fc Binary files /dev/null and b/packages/docs/public/images/namadillo/keplr-connect-2.png differ diff --git a/packages/docs/public/images/namadillo/keplr-connect.png b/packages/docs/public/images/namadillo/keplr-connect.png new file mode 100644 index 00000000..a631e7f1 Binary files /dev/null and b/packages/docs/public/images/namadillo/keplr-connect.png differ diff --git a/packages/docs/public/images/namadillo/keplr.png b/packages/docs/public/images/namadillo/keplr.png deleted file mode 100644 index d7f843f1..00000000 Binary files a/packages/docs/public/images/namadillo/keplr.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/overview.png b/packages/docs/public/images/namadillo/overview.png deleted file mode 100644 index 266f243d..00000000 Binary files a/packages/docs/public/images/namadillo/overview.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/refund-1.png b/packages/docs/public/images/namadillo/refund-1.png new file mode 100644 index 00000000..18106536 Binary files /dev/null and b/packages/docs/public/images/namadillo/refund-1.png differ diff --git a/packages/docs/public/images/namadillo/refund-2.png b/packages/docs/public/images/namadillo/refund-2.png new file mode 100644 index 00000000..072ab573 Binary files /dev/null and b/packages/docs/public/images/namadillo/refund-2.png differ diff --git a/packages/docs/public/images/namadillo/shield-choice.png b/packages/docs/public/images/namadillo/shield-choice.png new file mode 100644 index 00000000..f9f0a044 Binary files /dev/null and b/packages/docs/public/images/namadillo/shield-choice.png differ diff --git a/packages/docs/public/images/namadillo/shield1.png b/packages/docs/public/images/namadillo/shield1.png deleted file mode 100644 index f67d5a21..00000000 Binary files a/packages/docs/public/images/namadillo/shield1.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/shield2.png b/packages/docs/public/images/namadillo/shield2.png deleted file mode 100644 index b07d9e17..00000000 Binary files a/packages/docs/public/images/namadillo/shield2.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/shield3.png b/packages/docs/public/images/namadillo/shield3.png deleted file mode 100644 index 21be221e..00000000 Binary files a/packages/docs/public/images/namadillo/shield3.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/shielded-assets.png b/packages/docs/public/images/namadillo/shielded-assets.png new file mode 100644 index 00000000..0422eb9e Binary files /dev/null and b/packages/docs/public/images/namadillo/shielded-assets.png differ diff --git a/packages/docs/public/images/namadillo/sign-1.png b/packages/docs/public/images/namadillo/sign-1.png new file mode 100644 index 00000000..b908e353 Binary files /dev/null and b/packages/docs/public/images/namadillo/sign-1.png differ diff --git a/packages/docs/public/images/namadillo/transfer.png b/packages/docs/public/images/namadillo/transfer.png new file mode 100644 index 00000000..1db4727b Binary files /dev/null and b/packages/docs/public/images/namadillo/transfer.png differ diff --git a/packages/docs/public/images/namadillo/transfer1.png b/packages/docs/public/images/namadillo/transfer1.png deleted file mode 100644 index e67e6842..00000000 Binary files a/packages/docs/public/images/namadillo/transfer1.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/transfer2.png b/packages/docs/public/images/namadillo/transfer2.png deleted file mode 100644 index b16c7889..00000000 Binary files a/packages/docs/public/images/namadillo/transfer2.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/transparent-assets.png b/packages/docs/public/images/namadillo/transparent-assets.png new file mode 100644 index 00000000..b3ad06ac Binary files /dev/null and b/packages/docs/public/images/namadillo/transparent-assets.png differ diff --git a/packages/docs/public/images/namadillo/unshield-choice.png b/packages/docs/public/images/namadillo/unshield-choice.png new file mode 100644 index 00000000..d55854d0 Binary files /dev/null and b/packages/docs/public/images/namadillo/unshield-choice.png differ diff --git a/packages/docs/public/images/namadillo/unshield.png b/packages/docs/public/images/namadillo/unshield.png deleted file mode 100644 index 7ef2989a..00000000 Binary files a/packages/docs/public/images/namadillo/unshield.png and /dev/null differ diff --git a/packages/docs/public/images/namadillo/vote1.png b/packages/docs/public/images/namadillo/vote1.png index 54b371ae..ceefc8ea 100644 Binary files a/packages/docs/public/images/namadillo/vote1.png and b/packages/docs/public/images/namadillo/vote1.png differ