https://github.com/onekeyhq/aptos-wallet-adapter
https://github.com/onekeyhq/aptos-wallet-adapter
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/onekeyhq/aptos-wallet-adapter
- Owner: OneKeyHQ
- License: other
- Created: 2024-01-05T01:37:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-22T04:39:38.000Z (about 1 year ago)
- Last Synced: 2025-04-22T06:31:08.836Z (about 1 year ago)
- Language: TypeScript
- Size: 676 KB
- Stars: 1
- Watchers: 9
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# OneKey wallet for wallet builders to interact with the Aptos Wallet Adapter
This repo provides wallet builders a pre-made class with all required wallet functionality following the [wallet standard](https://aptos.dev/standards/wallets) for easy and fast development to interact with the [Aptos Wallet Adapter](https://github.com/aptos-labs/aptos-wallet-adapter)
---
### Usage
- `fork` this repo
- run `npm install` or `yarn install`
- Run tests with `npm run test` - all tests should pass
At this point, you have a ready wallet class with all required properties and functions to integrate with the Aptos Wallet Adapter.
### Publish as a Package
Next step is to publish your wallet as a npm package so dapps can install it as a dependency.
- Make sure to update `package.json` name, description, author and any other properties.
- Run `npm install` then `npm run build` - a `dist` folder should be available
- (optional) Run `npm publish --dry-run` to see what would get published (make sure there is a `dist` folder)
Creating and publishing scoped public packages
https://docs.npmjs.com/creating-and-publishing-scoped-public-packages
Creating and publishing unscoped public packages
https://docs.npmjs.com/creating-and-publishing-unscoped-public-packages
### Add your name to the wallets list
Once the package is published, you can create a PR against the [aptos-wallet-adapter](https://github.com/aptos-labs/aptos-wallet-adapter) repo and add your wallet name as a url to the npm package to the [supported wallet list](https://github.com/aptos-labs/aptos-wallet-adapter#supported-wallet-packages) on the README file.
---
> **_Note:_** if your wallet provides function that is not included, you should open a PR against [aptos-wallet-adapter](https://github.com/aptos-labs/aptos-wallet-adapter) in the [core package](https://github.com/aptos-labs/aptos-wallet-adapter/blob/main/packages/wallet-adapter-core/src/WalletCore.ts) so it would support this functionality.
> You can take a look at the `signTransaction` on the wallet [core package](https://github.com/aptos-labs/aptos-wallet-adapter/blob/main/packages/wallet-adapter-core/src/WalletCore.ts)