diff --git a/packages/docs/pages/users/_meta.json b/packages/docs/pages/users/_meta.json index be2a0abe..8e4d2466 100644 --- a/packages/docs/pages/users/_meta.json +++ b/packages/docs/pages/users/_meta.json @@ -7,5 +7,6 @@ "governance": "Governance", "public-goods-funding": "Public Goods Funding (PGF)", "ibc": "IBC transfers", - "query": "Querying the Chain" + "query": "Querying the Chain", + "namadillo": "Using Namadillo" } \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo.mdx b/packages/docs/pages/users/namadillo.mdx new file mode 100644 index 00000000..b7273373 --- /dev/null +++ b/packages/docs/pages/users/namadillo.mdx @@ -0,0 +1,21 @@ +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). + + +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 a links to a list of vetted Namadillo instances hosted by community members at https://namada.net/apps#interfaces. + + +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 new file mode 100644 index 00000000..9d0e8e85 --- /dev/null +++ b/packages/docs/pages/users/namadillo/_meta.json @@ -0,0 +1,8 @@ +{ + "overview": "Getting Started", + "staking": "Staking", + "governance": "Governance", + "masp": "Shielding Assets (MASP)", + "ibc": "IBC Transfers", + "transfer": "Transfers Within Namada" +} \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo/governance.mdx b/packages/docs/pages/users/namadillo/governance.mdx new file mode 100644 index 00000000..640ad83e --- /dev/null +++ b/packages/docs/pages/users/namadillo/governance.mdx @@ -0,0 +1,48 @@ +import { Callout, Steps } from 'nextra-theme-docs' + +# Governance + +You can view and vote on governance proposals from Namadillo. + +## 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. +![proposal-overview](../../../public/images/namadillo/governance-overview.png) + +## Voting on Goverance 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. + + +Follow these steps to vote on governance proposals using Namadillo: + + +### Select proposal +From the main Governance page, click on the "Ongoing" proposal you wish to vote on to bring up the proposal details (below). + +![proposal-details](../../../public/images/namadillo/proposal-details.png) +*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 + +### 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 +and click 'Confirm'. The Keychain browser extension will show you another popup prompting you to confirm the signing of your transaction by entering your +account password. After entering your password, your vote transaction will be submitted to the chain. Namadillo will display a small +info box in the top right corner of the page to show that your transaction is being processed and, after roughly 10 seconds, whether it was accepted. +![vote1](../../../public/images/namadillo/vote1.png) +*Voting transaction dialogs* + +### View and/or change your vote +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* + \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo/ibc.mdx b/packages/docs/pages/users/namadillo/ibc.mdx new file mode 100644 index 00000000..58a7203e --- /dev/null +++ b/packages/docs/pages/users/namadillo/ibc.mdx @@ -0,0 +1,10 @@ +import { Callout } from 'nextra-theme-docs' + +# IBC Transfers with 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). + \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo/masp.mdx b/packages/docs/pages/users/namadillo/masp.mdx new file mode 100644 index 00000000..9be712f5 --- /dev/null +++ b/packages/docs/pages/users/namadillo/masp.mdx @@ -0,0 +1,10 @@ +import { Callout } from 'nextra-theme-docs' + +# Shielding Assets with 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). + \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo/overview.mdx b/packages/docs/pages/users/namadillo/overview.mdx new file mode 100644 index 00000000..354f80a0 --- /dev/null +++ b/packages/docs/pages/users/namadillo/overview.mdx @@ -0,0 +1,71 @@ +import { Callout, Steps } from 'nextra-theme-docs' + +# Namadillo Overview + + +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 a links to a list of vetted Namadillo instances hosted by community members at https://namada.net/apps#interfaces. + + +## Getting started with Namadillo + +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. + + +### Navigate to Namadillo +Navigate to one of the hosted Namadillo instances at https://namada.net/apps#interfaces. + +### Connect the extension +In the top right corner of Namadillo, click the **Connect Keychain** button to begin using Namadillo. You will be asked by the extension +to approve the connection, which will allow Namadillo to see **non-secret** information about your account (such as your public key and addresses). + +*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) +*Click either button marked 'Connect Keychain'* + +![Connecting 2](../../../public/images/namadillo/connect2.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 +**Settings** (the gear icon), then **Connected Sites**. (Make sure you're opening the settings in the extension itself, not the Namadillo webpage.) + + + + +### Setting the RPC/Indexer endpoints (Optional) +Namadillo relies on three endpoints to access up-to-date info on the state of the chain: an *RPC*, an *Indexer*, and a *MASP Indexer*. +Typically, these services are operated by the same provider as Namadillo itself and correctly configured by default, so there is no need for you +as a user to worry about these values. + +However, if you wish to change any of these endpoints, or simply view the currently configured values, you can do so in the Namadillo settings. Click +the **Settings** (gear icon) in the top right of the webpage and choose **Advanced** to view or change them. + +### Troubleshooting +If Namadillo is not displaying your balance correctly or connecting to the extension, try +these steps in order: +1. *Perform a hard refresh of the Namadillo page:* press **Ctrl**+**Shift**+**Refresh** button (Windows) or **Cmd**+**Shift**+**Reload** button (Mac). +2. *Repeat the connection process:* Open the extension settings and disconnect from Namadillo as explained [here](#connect-the-extension). Then perform a hard refresh +as explained in Step 1 and re-connect the extension. +3. *Manually set the Chain-Id*: open the extension by clicking its icon in the browser toolbar, and click the gear icon to open the +**Settings** menu. Select **Network** and enter the correct Chain-Id and click **Submit**; then refresh. Afterwards, perform a hard refresh as +explained in Step 1. + +### A note on 'Reveal PK' transactions +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) +*Example of a staking transaction with Reveal PK message* \ No newline at end of file diff --git a/packages/docs/pages/users/namadillo/staking.mdx b/packages/docs/pages/users/namadillo/staking.mdx new file mode 100644 index 00000000..8ee3cafe --- /dev/null +++ b/packages/docs/pages/users/namadillo/staking.mdx @@ -0,0 +1,38 @@ +import { Callout, Steps } from 'nextra-theme-docs' + +# Staking with Namadillo + +You can stake using Namadillo and the Namada Keychain browser extension, including support for Ledger hardware wallets. + + +### Open the staking dashboard +From the left panel, select 'Staking' **(1, below)**. You should see your available NAM balance displayed in the top-center, under +'Available NAM to stake' **(2, below)**. (If your balance is different than expected, check that the correct account is active in the +browser extension). +![Step 1](../../../public/images/namadillo/stake1.png) +*Namadillo Staking dashboard* + +### Choose your validators +Click on 'Stake' **(either button marked 3, above)**; this will open a new dialog in which you can enter the amounts you wish to stake with each validator **(4, below)**. +You can stake with multiple validators in a single action. Click 'Stake' again **(5, below)** when you're ready. +![Step 2](../../../public/images/namadillo/stake2.png) +*Staking to multiple validators at once* + +### Confirm the staking transaction(s) +You will be asked to confirm your transaction so it can be signed and submitted to the chain. The dialog will look slightly different +depending on whether you're using a Ledger device with the extension or not. +- Extension only users: You will be prompted to approve the transaction in a pop-up, then prompted to enter your Keychain password. +- Extension + Ledger users: You will be prompted to approve the transaction in a pop-up. Instead of being prompted for your password, you will be asked to confirm the transaction on your Ledger device. +![Step 3](../../../public/images/namadillo/stake3a.png) +*Confirmation dialog, depending on whether you're using a Ledger to sign* + +### Await the result +You will see a grey dialog box in the top right corner of Namadillo notifying that the transaction is being processed. +After roughly 10 seconds you will be informed if your transaction was successful. +![Step 4](../../../public/images/namadillo/stake4.png) + + + +Remember that any staking transactions require two epochs (on mainnet) after being accepted on chain before taking effect. +See the section on [Staking](../../users/delegators.mdx) for more info. + diff --git a/packages/docs/pages/users/namadillo/transfer.mdx b/packages/docs/pages/users/namadillo/transfer.mdx new file mode 100644 index 00000000..8785cb1a --- /dev/null +++ b/packages/docs/pages/users/namadillo/transfer.mdx @@ -0,0 +1,10 @@ +import { Callout } from 'nextra-theme-docs' + +# Shielded and Transparent Transfers with 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). + \ 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 f6a7b8f0..eac2ff50 100644 --- a/packages/docs/pages/users/wallet/hardware-wallet.mdx +++ b/packages/docs/pages/users/wallet/hardware-wallet.mdx @@ -83,27 +83,27 @@ Click the 'Connect Keychain' button in the top right corner and approve the conn ### Navigate to the staking dashboard From the left panel, select 'Staking' **(1, below)**. You should see your available NAM balance displayed in the top-center, under 'Available NAM to stake' **(2, below)**. (If your balance is different than expected, check that the correct account is active in the browser extension). -![Step 1](../../../public/images/stake1.png) +![Step 1](../../../public/images/namadillo/stake1.png) *Namadillo Staking dashboard* ### Stake your tokens Click on 'Stake' **(either button marked 3, above)**; this will open a new dialog in which you can enter the amounts you wish to stake with each validator **(4, below)**. You can stake with multiple validators in a single action. Click 'Stake' again **(5, below)** when you're ready. -![Step 2](../../../public/images/stake2.png) +![Step 2](../../../public/images/namadillo/stake2.png) *Staking to multiple validators at once* ### Approve the transaction You will be prompted to approve the transaction in a pop-up. After confirming, you will also be asked to confirm the transaction on your Ledger device. -![Step 3](../../../public/images/stake3.png) +![Step 3](../../../public/images/namadillo/stake3.png) ### Wait for confirmation You will see a grey dialog box in the top right corner of Namadillo notifying that the transaction is being processed. After roughly 10 seconds you will be informed if your transaction was successful. -![Step 4](../../../public/images/stake4.png) +![Step 4](../../../public/images/namadillo/stake4.png) ##### Worth noting: 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)**. -![Step 5](../../../public/images/stake5.png) +![Step 5](../../../public/images/namadillo/stake5.png) *Example of a staking transaction with Reveal PK message* ## Using the Ledger app with the CLI You can use your Ledger to sign transactions from the Namada CLI. diff --git a/packages/docs/public/images/namadillo/connect1.png b/packages/docs/public/images/namadillo/connect1.png new file mode 100644 index 00000000..12640cb2 Binary files /dev/null and b/packages/docs/public/images/namadillo/connect1.png differ diff --git a/packages/docs/public/images/namadillo/connect2.png b/packages/docs/public/images/namadillo/connect2.png new file mode 100644 index 00000000..9f2ebd43 Binary files /dev/null and b/packages/docs/public/images/namadillo/connect2.png differ diff --git a/packages/docs/public/images/namadillo/governance-overview.png b/packages/docs/public/images/namadillo/governance-overview.png new file mode 100644 index 00000000..9c32d64d Binary files /dev/null and b/packages/docs/public/images/namadillo/governance-overview.png differ diff --git a/packages/docs/public/images/namadillo/overview.png b/packages/docs/public/images/namadillo/overview.png new file mode 100644 index 00000000..266f243d Binary files /dev/null and b/packages/docs/public/images/namadillo/overview.png differ diff --git a/packages/docs/public/images/namadillo/proposal-details.png b/packages/docs/public/images/namadillo/proposal-details.png new file mode 100644 index 00000000..281210c7 Binary files /dev/null and b/packages/docs/public/images/namadillo/proposal-details.png differ diff --git a/packages/docs/public/images/stake1.png b/packages/docs/public/images/namadillo/stake1.png similarity index 100% rename from packages/docs/public/images/stake1.png rename to packages/docs/public/images/namadillo/stake1.png diff --git a/packages/docs/public/images/stake2.png b/packages/docs/public/images/namadillo/stake2.png similarity index 100% rename from packages/docs/public/images/stake2.png rename to packages/docs/public/images/namadillo/stake2.png diff --git a/packages/docs/public/images/stake3.png b/packages/docs/public/images/namadillo/stake3.png similarity index 100% rename from packages/docs/public/images/stake3.png rename to packages/docs/public/images/namadillo/stake3.png diff --git a/packages/docs/public/images/namadillo/stake3a.png b/packages/docs/public/images/namadillo/stake3a.png new file mode 100644 index 00000000..2e45ea2e Binary files /dev/null and b/packages/docs/public/images/namadillo/stake3a.png differ diff --git a/packages/docs/public/images/stake4.png b/packages/docs/public/images/namadillo/stake4.png similarity index 100% rename from packages/docs/public/images/stake4.png rename to packages/docs/public/images/namadillo/stake4.png diff --git a/packages/docs/public/images/stake5.png b/packages/docs/public/images/namadillo/stake5.png similarity index 100% rename from packages/docs/public/images/stake5.png rename to packages/docs/public/images/namadillo/stake5.png diff --git a/packages/docs/public/images/namadillo/vote1.png b/packages/docs/public/images/namadillo/vote1.png new file mode 100644 index 00000000..54b371ae Binary files /dev/null and b/packages/docs/public/images/namadillo/vote1.png differ diff --git a/packages/docs/public/images/namadillo/vote2.png b/packages/docs/public/images/namadillo/vote2.png new file mode 100644 index 00000000..4a89c1c5 Binary files /dev/null and b/packages/docs/public/images/namadillo/vote2.png differ