Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Topics on accounts and wallets #497

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open

Topics on accounts and wallets #497

wants to merge 25 commits into from

Conversation

timothymcmackin
Copy link
Collaborator

@timothymcmackin timothymcmackin commented Dec 30, 2024

opentezos doesn't have this kind of info so this PR adds it to the new Using section, intended for Tezos consumers.

Preview:

@timothymcmackin timothymcmackin self-assigned this Dec 30, 2024
Copy link

vercel bot commented Dec 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-staging ✅ Ready (Inspect) Visit Preview Jan 3, 2025 5:47pm

Copy link
Contributor

@germanD germanD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM modulo threads

docs/developing/wallet-setup.md Outdated Show resolved Hide resolved
Comment on lines 17 to 21
- [Temple](https://templewallet.com/) mobile application and browser extension
- [Umami](https://umamiwallet.com/) standalone application for Windows, MacOS, and Linux
- [Kukai](https://wallet.kukai.app/) federated identity application, which uses accounts linked to other accounts such as email or social media accounts
- [Trust](https://trustwallet.com/tezos-wallet) mobile application and browser extension
- [Ledger](https://www.ledger.com/) hardware wallets
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, we might want to list Airgap as well? https://airgap.it/#download

They have a rather unique approach for a cold/hot wallet.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to get into airgap vault/wallet here but I added it to the list.

docs/using/user-accounts.md Outdated Show resolved Hide resolved
docs/using/user-accounts.md Show resolved Hide resolved
docs/using/user-accounts.md Outdated Show resolved Hide resolved
Comment on lines 68 to 69
Many wallet applications provide a recovery code that you can use to restore the account if you lose the wallet application or the device that it is on.
You must also keep this recovery phrase secret.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we are mixing two concepts here:

  • Recovery phrases / secret keys associated associated with an account (or the many accounts that can be derived from that key pair)
  • Other recovery/ backup mechanisms supported by Wallet apps (e.g. Ledger recover)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about this:

Many wallet applications provide a way to recover the account if you lose the wallet application or the device that it is on. You must also keep this recovery information secret.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be worth it, I think, to briefly list these main recovery modes, which are wallet seed phrases, private keys of addresses, and "other proprietary systems". It's obvious to us, but perhaps less so for our readers.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed this to:

Many wallet applications provide a way to recover the account if you lose the wallet application or the device that it is on. Some wallets provide recovery codes in the form of a series of words, others recreate accounts from private keys, and others have proprietary recovery methods. You must also keep this recovery information secret.

docs/using/wallets.md Outdated Show resolved Hide resolved

If you need funds for transaction fees on the test network, you can get them for free from the faucet, as described in [Funding a wallet](/developing/wallet-setup#funding-a-wallet).

After you approve the transaction and wait a minute or two, you can see it in your wallet's history and on the block explorer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is outdated. You should see your transaction in less than 20 seconds now

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed mention of time; I don't want to get into block confirmation here and there may be more time before the explorer shows it.

Comment on lines 14 to 19
- Showing the tokens that an account holds
- Providing information on the value of tokens
- Buying, selling, and exchanging tokens
- Showing the transaction history of an account

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other things supported:

  • batching! We should highlight this as we don't use it enough

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added "Batching multiple transactions to save on transaction fees"

docs/using/wallets.md Outdated Show resolved Hide resolved
timothymcmackin and others added 15 commits January 2, 2025 13:03
Co-authored-by: Germán Delbianco <germanD@users.noreply.github.com>
Co-authored-by: Germán Delbianco <germanD@users.noreply.github.com>
Co-authored-by: Germán Delbianco <germanD@users.noreply.github.com>
Co-authored-by: Germán Delbianco <germanD@users.noreply.github.com>
Co-authored-by: Germán Delbianco <germanD@users.noreply.github.com>
Co-authored-by: Germán Delbianco <germanD@users.noreply.github.com>
@timothymcmackin
Copy link
Collaborator Author

Tests are failing because of this issue: #500

docs/using/user-accounts.md Outdated Show resolved Hide resolved
docs/using/user-accounts.md Outdated Show resolved Hide resolved
date: 31 December 2024
---

Wallets are tools that manage accounts on blockchains like Tezos.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe briefly state what accounts serve for, in the first place:

Suggested change
Wallets are tools that manage accounts on blockchains like Tezos.
Wallets are tools that manage accounts on blockchains like Tezos, allowing you to hold and use tokens such as tez.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is tricky because it's not the wallet that stores the tez, technically speaking, but that's how people think of it. Is this an oversimplification or an appropriate simplification to make for new users?

How about this?

Wallets are tools that manage accounts on blockchains like Tezos. Their primary purpose is to store an account's private key securely and encrypt (or "sign") transactions with that key without exposing the key. As described in Accounts, these accounts can hold and use tokens such as tez, the native token of Tezos.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, but the point is to state earlier what accounts are for, without requiring to read the other page. Perhaps just shuffling the phrases in your suggestion:

Wallets are tools to easily and safely manage accounts on blockchains like Tezos. Accounts (see link) serve to hold and use tokens such as tez, the native token of Tezos. The primary purpose of wallets is to store an account's private key securely and encrypt (or "sign") transactions with that key without exposing the key.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, reworded the introduction.

docs/using/wallets.md Outdated Show resolved Hide resolved
docs/using/wallets.md Outdated Show resolved Hide resolved
docs/developing/wallet-setup.md Outdated Show resolved Hide resolved
docs/using/wallets.md Outdated Show resolved Hide resolved
docs/using/wallets.md Outdated Show resolved Hide resolved
Co-authored-by: NicNomadic <148877430+NicNomadic@users.noreply.github.com>
timothymcmackin and others added 2 commits January 3, 2025 09:21
Co-authored-by: NicNomadic <148877430+NicNomadic@users.noreply.github.com>
@timothymcmackin timothymcmackin changed the title First draft of topics on accounts and wallets Topics on accounts and wallets Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants