Skip to content

Commit 4f098a3

Browse files
authored
Merge pull request #449 from anoma/ian/update-namadillo
Ian/update namadillo
2 parents f2db4e9 + 2aa2739 commit 4f098a3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+271
-270
lines changed

packages/docs/pages/users/namadillo.mdx

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,12 @@ import { Callout } from 'nextra-theme-docs'
33
# Namadillo
44

55
<Callout type='info'>
6-
Namada mainnet will launch with most functionality aside from staking and governance disabled, gradually enabling features in stages (via governance proposals) over the first
7-
few weeks. Therefore, some sections of Namadillo will not be accessible immediately after launch until its respective functionality has been activated on mainnet.
8-
9-
Until then, you can experiment with all aspects of Namadillo on [testnet](../networks/testnets.mdx).
6+
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
7+
until the respective functionality is enabled on mainnet; however, you can experiment with all aspects of Namadillo on [testnet](../networks/testnets.mdx).
108
</Callout>
119

12-
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),
13-
you can stake, vote in governance, shield and unshield assets, and send transparent, shielded, and IBC token transfers.
10+
Namadillo is a web-based front-end for Namada developed by Heliax. Using Namadillo, along with the [Namada Keychain browser extension](../users/keychain.mdx),
11+
you can stake, vote in governance, deposit and withdraw assets via IBC, and earn shielded rewards.
1412

1513
<Callout emoji='😎'>
1614
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
2018
</Callout>
2119

2220
This section of the docs provides step-by-step instructions for using the various features of Namadillo.
23-
24-
![overview](../../public/images/namadillo/overview.png)
Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
{
22
"overview": "Getting Started",
33
"staking": "Staking",
4-
"governance": "Governance",
5-
"masp": "Shielding Assets (MASP)",
4+
"assets": "Managing Your Assets",
5+
"shield": "Shielding Assets",
6+
"unshield": "Unshielding Assets",
67
"ibc": "IBC Transfers",
78
"transfer": "Transfers Within Namada",
9+
"governance": "Governance",
10+
"history": "History",
811
"troubleshooting": "Troubleshooting"
912
}
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import { Callout } from 'nextra-theme-docs'
2+
3+
# Managing Your Assets
4+
5+
The **Manage Assets** panel of Namadillo gives a complete view of the shielded and transparent assets in your currently selected account.
6+
7+
## Transparent Assets View
8+
![transparent assets view](../../../public/images/namadillo/transparent-assets.png)
9+
10+
- **1** - The currently selected account.
11+
- **2** - The combined value of all your transparent and shielded assets, in USD.
12+
- **3** - The value of your transparent assets, in USD.
13+
- **4** - All of your transparent assets, and their balances (in both tokens and USD value).
14+
- **5** - Your currently staked balance (for NAM only).
15+
16+
## Shielded Assets View
17+
![shielded assets view](../../../public/images/namadillo/shielded-assets.png)
18+
19+
- **1** - The currently selected account.
20+
- **2** - The value of your shielded assets, in USD.
21+
- **3** - All of your shielded assets, and their balances (in both tokens and USD value).
22+
- **4** - The estimated Shielded Rewards you will earn from your shielded assets in the next 24 hours.

packages/docs/pages/users/namadillo/governance.mdx

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,17 @@ Detailed information on how the governance system works at the protocol-level ca
77

88
## Governance Info
99
By selecting 'Governance' from the left sidebar of Namadillo **(see below)**, you can get an overview of current, upcoming, and past
10-
governance proposals. By clicking on a listed proposal, you can bring up further details about that proposal.
10+
governance proposals. By clicking on a listed proposal, you can bring up further details about that proposal.
11+
1112
![proposal-overview](../../../public/images/namadillo/governance-overview.png)
1213

13-
## Voting on Goverance Proposals
14+
## Voting on Governance Proposals
1415
<Callout type="info">
15-
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
16-
be able to vote on any governance proposals. See the section on [Staking](./staking.mdx) for instructions on how to stake tokens.
16+
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
17+
be able to vote on governance. See the section on [Staking](./staking.mdx) for instructions on how to stake tokens.
1718
</Callout>
1819

19-
Follow these steps to vote on governance proposals using Namadillo:
20+
To vote on governance proposals using Namadillo:
2021

2122
<Steps>
2223
### Select proposal
@@ -26,12 +27,12 @@ From the main Governance page, click on the "Ongoing" proposal you wish to vote
2627
*Proposal detail view*
2728

2829
In this view, you can see:
29-
1. The proposal title and ID
30-
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)
31-
3. The time remaining in the voting period
32-
4. The proposal abstract and description (Click 'Show More' to see the full desctiption)
33-
5. Proposal details such as the proposing address and the voting start, end, and activation epochs
34-
6. The current vote tally and turnout
30+
1. The proposal title and ID.
31+
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).
32+
3. The time remaining in the voting period.
33+
4. The proposal abstract and description (Click 'Show More' to see the full description).
34+
5. Proposal details such as the proposing address and the voting start, end, and activation epochs.
35+
6. The current vote tally and turnout.
3536

3637
### Submit your vote
3738
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
4546
If your vote has been registered on-chain, Namadillo will update its display with your vote **(1, below)**. If the voting period is still
4647
ongoing, you can change your vote by clicking the 'Edit Vote' button **(2, below)** and repeating the voting process.
4748
![vote2](../../../public/images/namadillo/vote2.png)
48-
*You can change your vote as long as the propoal is still ongoing*
49+
*You can change your vote as long as the proposal is still ongoing*
4950
</Steps>
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import { Callout } from 'nextra-theme-docs'
2+
3+
# Transaction History
4+
5+
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
6+
transaction type.
7+
8+
<Callout type='info'>
9+
Cross-chain shielded transactions are only visible on the Namadillo where they were created.
10+
</Callout>
11+
12+
![History dialog](../../../public/images/namadillo/history.png)
13+
*The Transaction History view*
Lines changed: 45 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,64 @@
11
import { Callout, Steps } from 'nextra-theme-docs'
22

3-
# IBC Transfers with Namadillo
3+
# IBC Transfers
44

5-
Learn more about IBC on Namada beyond Namadillo [here](../ibc.mdx).
5+
If you're looking for information on IBC operations using the Namada CLI, please see [here](../ibc.mdx).
66

77
You can connect Namadillo to your [Keplr wallet](https://www.keplr.app/) to transfer assets between Namada and IBC compatible chains, such as
8-
*Osmosis* and the *Cosmos Hub*. Namadillo supports both transparent and shielded IBC transfers.
8+
*Osmosis* and the *Cosmos Hub*. Namadillo supports transparent and shielded IBC deposits and withdrawals.
99

10-
- **Transparent IBC transfers:** Transfers between a transparent (`tnam...`) address and another chain. After receiving
11-
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
12-
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
13-
transparent address to both send and receive assets over IBC.
14-
- **Shielded IBC transfers:** Transfers between a shielded (`znam...`) address and another chain.
15-
These transfers move immediately to/from your shielded balance without needing to pass through your transparent address first. This
16-
[reduces](../../introduction/privacy.mdx) the chances of leaking information about your on-chain activity.
10+
## Connecting to Keplr
1711

18-
When using Namadillo, you can only use your shielded address to receive assets. (To send them over
19-
IBC, you must first unshield them.)
12+
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.
2013

21-
## Connecting To Keplr
22-
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.
14+
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
15+
and you'll see a Keplr icon at the top of Namadillo.
2316

24-
[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
25-
to and from your existing Keplr accounts.
17+
![Keplr connect](../../../public/images/namadillo/keplr-connect.png)
18+
*Connecting Keplr to Namadillo*
2619

27-
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,
28-
please refer to https://help.keplr.app/start.
20+
![Keplr connected](../../../public/images/namadillo/keplr-connect-2.png)
21+
*Keplr connection visible in top bar*
2922

30-
Once you've installed Keplr and created or imported an account on the source chain, follow these steps to connect Keplr with Namadillo:
23+
## Deposit (IBC Transfers to Namada)
3124

32-
1. Click *IBC Transfer* in the left sidebar of Namadillo **(1)** to open the IBC panel.
33-
2. Click *Connect Wallet* **(2)**.
34-
3. Click *Approve* in Keplr when the *Requesting Connection* **(3)** popup appears
25+
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
26+
Keplr to Namadillo (see above). Keplr is needed to sign the IBC transaction on the source chain.
3527

36-
![Connect Keplr](../../../public/images/namadillo/keplr.png)
37-
*Connecting your Keplr wallet to Namadillo*
28+
To deposit IBC assets into Namada, do the following:
29+
1. Select **IBC Transfer** in the left sidebar of Namadillo, and select the **Deposit** tab from the top of the view.
30+
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
31+
and you'll see a Keplr icon at the top of Namadillo.
32+
3. Select the source chain/asset and amount you wish to deposit.
33+
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
34+
the receiving address will automatically be filled with your transparent or shielded address, respectively.
35+
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.
3836

39-
## Sending IBC Transfers 'To Namada' (from another chain)
40-
You can bring assets from another chain to your Namada shielded or transparent balance; think of this as 'depositing' assets from other chains into
41-
Namada.
37+
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
38+
in the [History](./history.mdx) section.
4239

43-
Begin by selecting '*To Namada*' **(1)** in the *IBC Transfer* section and follow these steps:
40+
<Callout type="info">
41+
Making a shielded deposit from the **IBC Transfer** section is equivalent to selecting **Shield Assets** and then **IBC Shield** from the topbar. See
42+
the [Shielding Assets](./shield.mdx) section for more details, including important information on Shielded Rewards.
43+
</Callout>
4444

45-
![Ibc in details](../../../public/images/namadillo/ibc-in1.png)
46-
*Making an IBC transfer into Namada (i.e. Depositing assets)*
45+
## Withdraw (IBC Transfers from Namada)
4746

48-
<Steps>
49-
### Enter the transfer details
50-
- **(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
51-
on the sending chain will be read from Keplr and displayed here.
52-
- **(3)**: Click to select the asset you wish to transfer.
53-
- **(4)**: Enter the amount to transfer.
54-
- **(5)**: Click to specify whether to send the asset to your shielded or transparent address.
55-
- **(6)**: Your receiving address will be automatically filled from the Keychain extension. If you selected *Shielded* directly above, this will show
56-
your shielded address; if you selected *Transparent* it will show your transparent address. The address shown will match the currently selected account
57-
in the Keychain extension.
58-
- **(7)**: The transaction fee for this transfer -- note that fees are paid in the asset being transferred.
59-
- **(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.
47+
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
48+
receiver address with your Keplr address on the destination chain. However, you can also proceed without Keplr by manually entering the receiver address.
6049

61-
### Click 'Submit' and approve your transaction
62-
After entering the required transfer info, click *Submit*, at which point you'll be prompted to approve the transaction.
50+
To withdraw IBC assets from Namada, do the following:
51+
1. Select **IBC Transfer** in the left sidebar of Namadillo, and select the **Withdraw** tab from the top of the view.
52+
2. Select the destination chain/asset and amount you wish to unshield.
53+
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
54+
the sender address will automatically be filled with your transparent or shielded address, respectively.
55+
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.
56+
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
57+
**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
58+
with *osmo...* if the destination chain is *Osmosis*).
59+
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.
6360

64-
Note that when IBC transferring assets to Namada, you'll be asked to confirm the transaction in Keplr (not Namada Keychain).
65-
66-
![IBC in confirm](../../../public/images/namadillo/ibc-in2.png)
67-
*Confirming the transaction in Keplr*
68-
</Steps>
69-
70-
## Sending IBC Transfers 'From Namada' (to another chain)
71-
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
72-
address -- if you wish to transfer shielded assets, you must unshield them first.
73-
74-
Begin by selecting '*From Namada*' **(1)** in the *IBC Transfer* section and follow these steps:
75-
76-
![IBC out details](../../../public/images/namadillo/ibc-out1.png)
77-
*IBC Transferring assets out of Namada*
78-
79-
<Steps>
80-
### Enter the transfer details
81-
- **(2)**: Your transparent address (from which the transfer is being sent). This is automatically filled from the Keychain extension based on your
82-
currently selected account. Note that outgoing IBC transfers using Namadillo cannot be made from a shielded account.
83-
- **(3)**: Click to select the asset you wish to transfer.
84-
- **(4)**: Enter the amount to transfer.
85-
- **(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.
86-
(See below for more details.)
87-
- **(6)**: Click here to select the destination chain.
88-
- **(7)**: The transaction fee for this transfer -- note that fees are paid in NAM.
89-
- **(8)**: When you've chosen an asset, amount, destination chain, and receiving address, click *Submit* to begin the transfer.
90-
91-
**Setting a custom receiver address:**
92-
By selecting *Custom Address*, you can send assets to an address not in your Keplr wallet. Choosing this option also (optionally) lets you attach
93-
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
94-
address should have an *osmo* prefix.
95-
96-
97-
![IBC custom receiver](../../../public/images/namadillo/ibc-out2.png)
98-
99-
### Click 'Submit' and approve your transaction
100-
After entering the required transfer info, click *Submit*. You'll be prompted to approve the transaction and it will begin processing. When the transfer
101-
has completed, the status will update to show *Transfer Completed*.
102-
</Steps>
61+
<Callout type="info">
62+
Withdrawing a shielded asset from the **IBC Transfer** section is equivalent to selecting **Unshield** and then **IBC Unshield** from the topbar. See
63+
the [Unshielding Assets](./unshield.mdx) section for more details, including important information on failed transactions and refund addresses.
64+
</Callout>

0 commit comments

Comments
 (0)