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

[DOC] add aptos wallet adapter docs #5812

Merged
merged 15 commits into from
Dec 9, 2022
Merged

[DOC] add aptos wallet adapter docs #5812

merged 15 commits into from
Dec 9, 2022

Conversation

0xmaayan
Copy link
Contributor

@0xmaayan 0xmaayan commented Dec 7, 2022

Description

Adds documentation for Aptos Wallet Adapter under the "BUILD APPS" section

Test Plan

Copy link
Contributor

@clay-aptos clay-aptos left a comment

Choose a reason for hiding this comment

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

This looks great, Maayan. Please give me until tomorrow EOD to review.

npm install @aptos-labs/wallet-adapter-react
```

Import dependencies.
Copy link
Contributor

Choose a reason for hiding this comment

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

How import dependencies?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

maybe a title should fit better here, fixed it

On the App.jsx file, Import the installed wallets.

```js
import { AptosWallet } from "some-aptos-wallet-package";
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we give them an actual example to accompany some-aptos-wallet-package here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Contributor

@clay-aptos clay-aptos left a comment

Choose a reason for hiding this comment

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

Great work, @0xmaayan ! I made some edits directly to the files. And I included one TODO asking for how to import dependencies. Once that is resolved, this LGTM. Thanks again!

@0xmaayan 0xmaayan force-pushed the wallet_adapter_docs branch from c1d4851 to db2784f Compare December 9, 2022 01:01

# Aptos Wallet Adapter

Aptos provides an [Aptos Wallet Adapter](https://github.com/aptos-labs/aptos-wallet-adapter) monorepo for wallet and dapps creators to ease development and ensure a smooth process in building projects on the Aptos network.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Aptos provides an [Aptos Wallet Adapter](https://github.com/aptos-labs/aptos-wallet-adapter) monorepo for wallet and dapps creators to ease development and ensure a smooth process in building projects on the Aptos network.
We provide an [Aptos Wallet Adapter](https://github.com/aptos-labs/aptos-wallet-adapter) for wallet and dapps creators to ease development and ensure a smooth process in building projects on the Aptos network.


Aptos provides an [Aptos Wallet Adapter](https://github.com/aptos-labs/aptos-wallet-adapter) monorepo for wallet and dapps creators to ease development and ensure a smooth process in building projects on the Aptos network.

The Aptos Wallet Adapter acts as a service between dapps and wallets and exposes APIs for dapps to interact with the wallets by following our [Wallet Standard](../guides/wallet-standard).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The Aptos Wallet Adapter acts as a service between dapps and wallets and exposes APIs for dapps to interact with the wallets by following our [Wallet Standard](../guides/wallet-standard).
The Aptos Wallet Adapter acts as a service between dapps and wallets and exposes APIs for dapps to interact with wallets following our [Wallet Standard](../guides/wallet-standard). This in turns allows dapps to support many wallets with minimal integration efforts.


# Aptos Wallet Adapter

Aptos provides an [Aptos Wallet Adapter](https://github.com/aptos-labs/aptos-wallet-adapter) monorepo for wallet and dapps creators to ease development and ensure a smooth process in building projects on the Aptos network.
Copy link
Contributor

Choose a reason for hiding this comment

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

these paragraphs don't really describe the problem that the wallet adapter is addressing...

  1. There are a lot of wallets in the ecosystem
  2. Supporting each one is a burden but not supporting them is risky for projects
  3. Integration with wallets can be a complex process that requires a lot of testing

A wallet adapter solves these pain points....

or something

Copy link
Contributor Author

@0xmaayan 0xmaayan Dec 9, 2022

Choose a reason for hiding this comment

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

we explain it here in details, https://github.com/aptos-labs/aptos-core/pull/5812/files#diff-28a8dc8c00ae95b5f3d12241e42fbdcaf8e022df85c141d748d8de3cb2113001R8-R23

but we can also add some on that page! maybe benefits for both wallets and dapps

@0xmaayan
Copy link
Contributor Author

0xmaayan commented Dec 9, 2022

Copy link
Contributor

@clay-aptos clay-aptos left a comment

Choose a reason for hiding this comment

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

Thank you, Maayan! This LGTM with some small changes I made directly. Thanks again!

@0xmaayan 0xmaayan force-pushed the wallet_adapter_docs branch from 494b3ee to 783ae28 Compare December 9, 2022 19:19
@0xmaayan 0xmaayan enabled auto-merge (squash) December 9, 2022 19:19
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@0xmaayan 0xmaayan merged commit 367519a into main Dec 9, 2022
@0xmaayan 0xmaayan deleted the wallet_adapter_docs branch December 9, 2022 19:57
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2022

✅ Forge suite compat success on testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 968af5b35e2f360023f28fa06b661569e5987f02

Compatibility test results for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 968af5b35e2f360023f28fa06b661569e5987f02 (PR)
1. Check liveness of validators at old version: testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b
compatibility::simple-validator-upgrade::liveness-check : 7695 TPS, 5274 ms latency, 8300 ms p99 latency,no expired txns
2. Upgrading first Validator to new version: 968af5b35e2f360023f28fa06b661569e5987f02
compatibility::simple-validator-upgrade::single-validator-upgrade : 4328 TPS, 8958 ms latency, 12200 ms p99 latency,no expired txns
3. Upgrading rest of first batch to new version: 968af5b35e2f360023f28fa06b661569e5987f02
compatibility::simple-validator-upgrade::half-validator-upgrade : 4606 TPS, 9139 ms latency, 12400 ms p99 latency,no expired txns
4. upgrading second batch to new version: 968af5b35e2f360023f28fa06b661569e5987f02
compatibility::simple-validator-upgrade::rest-validator-upgrade : 6196 TPS, 6134 ms latency, 10000 ms p99 latency,no expired txns
5. check swarm health
Compatibility test for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 968af5b35e2f360023f28fa06b661569e5987f02 passed
Test Ok

@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2022

✅ Forge suite land_blocking success on 968af5b35e2f360023f28fa06b661569e5987f02

performance benchmark with full nodes : 6101 TPS, 6501 ms latency, 10500 ms p99 latency,no expired txns
Test Ok

areshand pushed a commit to areshand/aptos-core-1 that referenced this pull request Dec 18, 2022
* [DOC] add aptos wallet adapter docs

* [DOC] add aptos wallet adapter docs

* [DOC] add aptos wallet adapter docs

* import image and baseUrl components

* add missing link

* rename image files

* add words to dict file

* Make direct edits to Wallet Adapter concept

* Make direct edits to Wallet Adapter for Dapps doc

* Edit Wallet Adapter for Wallets directly

* Fix order of new dictionary entries

* address feedback

* add context on the adapter

* Make small edits directly

Co-authored-by: Clay Murphy <114445310+clay-aptos@users.noreply.github.com>
@Markuze Markuze mentioned this pull request Dec 26, 2022
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.

3 participants