@aptos-labs/wallet-adapter-core 8.2.0 → 8.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +181 -5
- package/dist/WalletCore.d.ts.map +1 -1
- package/dist/index.js +201 -28
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +191 -26
- package/dist/index.mjs.map +1 -1
- package/dist/registry.d.ts +3 -1
- package/dist/registry.d.ts.map +1 -1
- package/dist/utils/types.d.ts +1 -1
- package/dist/utils/types.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/package.json +4 -5
- package/src/WalletCore.ts +8 -4
- package/src/registry.ts +192 -20
- package/src/utils/helpers.ts +1 -1
- package/src/utils/types.ts +0 -1
- package/src/version.ts +1 -1
package/README.md
CHANGED
|
@@ -1,13 +1,189 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @aptos-labs/wallet-adapter-core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Core functionality for the Aptos Wallet Adapter. This package provides the foundation for wallet management, state handling, and interaction with AIP-62 compatible wallets on the Aptos blockchain.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
The wallet-adapter-core package handles:
|
|
8
|
+
|
|
9
|
+
- **Wallet Detection**: Automatically detects AIP-62 standard compatible wallets installed in the browser
|
|
10
|
+
- **Connection Management**: Connect, disconnect, and manage wallet sessions
|
|
11
|
+
- **Transaction Signing**: Sign messages, transactions, and submit transactions to the network
|
|
12
|
+
- **Network Management**: Handle network changes and multi-network support
|
|
13
|
+
- **Event System**: Subscribe to wallet, account, and network change events
|
|
14
|
+
- **State Management**: Centralized state for connected wallet, account, and network information
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install @aptos-labs/wallet-adapter-core
|
|
20
|
+
# or
|
|
21
|
+
pnpm add @aptos-labs/wallet-adapter-core
|
|
22
|
+
# or
|
|
23
|
+
yarn add @aptos-labs/wallet-adapter-core
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Peer Dependencies:**
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npm install @aptos-labs/ts-sdk
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Usage
|
|
33
|
+
|
|
34
|
+
### Basic Setup
|
|
6
35
|
|
|
7
36
|
```ts
|
|
8
37
|
import { WalletCore } from "@aptos-labs/wallet-adapter-core";
|
|
38
|
+
import { Network } from "@aptos-labs/ts-sdk";
|
|
9
39
|
|
|
10
|
-
|
|
40
|
+
// Create wallet core instance
|
|
41
|
+
const walletCore = new WalletCore(
|
|
42
|
+
[], // Optional: array of wallet names to opt-in (empty = all wallets)
|
|
43
|
+
{ network: Network.MAINNET }, // Optional: dapp configuration
|
|
44
|
+
false, // Optional: disable telemetry (default: false)
|
|
45
|
+
["Petra Web"] // Optional: wallets to hide from display
|
|
46
|
+
);
|
|
47
|
+
|
|
48
|
+
// Get available wallets
|
|
49
|
+
const wallets = walletCore.wallets;
|
|
50
|
+
const notDetectedWallets = walletCore.notDetectedWallets;
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Connecting to a Wallet
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
// Connect to a wallet by name
|
|
57
|
+
await walletCore.connect("Petra");
|
|
11
58
|
|
|
12
|
-
|
|
59
|
+
// Check connection status
|
|
60
|
+
if (walletCore.isConnected()) {
|
|
61
|
+
console.log("Connected account:", walletCore.account);
|
|
62
|
+
console.log("Connected network:", walletCore.network);
|
|
63
|
+
}
|
|
13
64
|
```
|
|
65
|
+
|
|
66
|
+
### Signing Messages
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
const signedMessage = await walletCore.signMessage({
|
|
70
|
+
message: "Hello, Aptos!",
|
|
71
|
+
nonce: "random-nonce-123",
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
console.log("Signature:", signedMessage.signature);
|
|
75
|
+
console.log("Full message:", signedMessage.fullMessage);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Signing and Submitting Transactions
|
|
79
|
+
|
|
80
|
+
```ts
|
|
81
|
+
const result = await walletCore.signAndSubmitTransaction({
|
|
82
|
+
data: {
|
|
83
|
+
function: "0x1::aptos_account::transfer",
|
|
84
|
+
typeArguments: [],
|
|
85
|
+
functionArguments: [recipientAddress, amount],
|
|
86
|
+
},
|
|
87
|
+
});
|
|
88
|
+
|
|
89
|
+
console.log("Transaction hash:", result.hash);
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Listening to Events
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
// Account change event
|
|
96
|
+
walletCore.on("accountChange", (account) => {
|
|
97
|
+
console.log("Account changed:", account);
|
|
98
|
+
});
|
|
99
|
+
|
|
100
|
+
// Network change event
|
|
101
|
+
walletCore.on("networkChange", (network) => {
|
|
102
|
+
console.log("Network changed:", network);
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
// Disconnect event
|
|
106
|
+
walletCore.on("disconnect", () => {
|
|
107
|
+
console.log("Wallet disconnected");
|
|
108
|
+
});
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Disconnecting
|
|
112
|
+
|
|
113
|
+
```ts
|
|
114
|
+
await walletCore.disconnect();
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## API Reference
|
|
118
|
+
|
|
119
|
+
### WalletCore
|
|
120
|
+
|
|
121
|
+
The main class that manages wallet state and interactions.
|
|
122
|
+
|
|
123
|
+
#### Constructor
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
new WalletCore(
|
|
127
|
+
optInWallets?: ReadonlyArray<AvailableWallets>,
|
|
128
|
+
dappConfig?: DappConfig,
|
|
129
|
+
disableTelemetry?: boolean,
|
|
130
|
+
hideWallets?: ReadonlyArray<AvailableWallets>
|
|
131
|
+
)
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
#### Properties
|
|
135
|
+
|
|
136
|
+
| Property | Type | Description |
|
|
137
|
+
|----------|------|-------------|
|
|
138
|
+
| `wallet` | `AptosWallet \| null` | Currently connected wallet |
|
|
139
|
+
| `account` | `AccountInfo \| null` | Currently connected account |
|
|
140
|
+
| `network` | `NetworkInfo \| null` | Currently connected network |
|
|
141
|
+
| `wallets` | `ReadonlyArray<AptosWallet>` | List of detected wallets |
|
|
142
|
+
| `hiddenWallets` | `ReadonlyArray<AdapterWallet>` | List of hidden wallets |
|
|
143
|
+
| `notDetectedWallets` | `ReadonlyArray<AdapterNotDetectedWallet>` | List of not-detected wallets |
|
|
144
|
+
|
|
145
|
+
#### Methods
|
|
146
|
+
|
|
147
|
+
| Method | Description |
|
|
148
|
+
|--------|-------------|
|
|
149
|
+
| `connect(walletName)` | Connect to a wallet |
|
|
150
|
+
| `disconnect()` | Disconnect from current wallet |
|
|
151
|
+
| `signMessage(input)` | Sign a message |
|
|
152
|
+
| `signTransaction(args)` | Sign a transaction |
|
|
153
|
+
| `signAndSubmitTransaction(input)` | Sign and submit a transaction |
|
|
154
|
+
| `changeNetwork(network)` | Request network change |
|
|
155
|
+
| `signIn(args)` | Sign in with SIWA (Sign In With Aptos) |
|
|
156
|
+
| `isConnected()` | Check if wallet is connected |
|
|
157
|
+
|
|
158
|
+
#### Events
|
|
159
|
+
|
|
160
|
+
| Event | Payload | Description |
|
|
161
|
+
|-------|---------|-------------|
|
|
162
|
+
| `connect` | `AccountInfo` | Emitted when wallet connects |
|
|
163
|
+
| `disconnect` | - | Emitted when wallet disconnects |
|
|
164
|
+
| `accountChange` | `AccountInfo` | Emitted when account changes |
|
|
165
|
+
| `networkChange` | `NetworkInfo` | Emitted when network changes |
|
|
166
|
+
|
|
167
|
+
## DappConfig
|
|
168
|
+
|
|
169
|
+
Configuration options for the wallet adapter:
|
|
170
|
+
|
|
171
|
+
```ts
|
|
172
|
+
interface DappConfig {
|
|
173
|
+
network: Network;
|
|
174
|
+
transactionSubmitter?: TransactionSubmitter;
|
|
175
|
+
aptosApiKeys?: Partial<Record<Network, string>>;
|
|
176
|
+
aptosConnectDappId?: string;
|
|
177
|
+
aptosConnect?: AptosConnectWalletConfig;
|
|
178
|
+
crossChainWallets?: boolean;
|
|
179
|
+
}
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
## Related Packages
|
|
183
|
+
|
|
184
|
+
- [`@aptos-labs/wallet-adapter-react`](../wallet-adapter-react) - React hooks and context provider
|
|
185
|
+
- [`@aptos-labs/ts-sdk`](https://github.com/aptos-labs/aptos-ts-sdk) - Aptos TypeScript SDK
|
|
186
|
+
|
|
187
|
+
## License
|
|
188
|
+
|
|
189
|
+
Apache-2.0
|
package/dist/WalletCore.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WalletCore.d.ts","sourceRoot":"","sources":["../src/WalletCore.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,EAEL,oBAAoB,EACpB,iBAAiB,EAEjB,0BAA0B,EAC1B,OAAO,EAEP,0BAA0B,EAC1B,oBAAoB,EACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,WAAW,EAIX,mCAAmC,EAMnC,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAEhF,YAAY,EACV,WAAW,EACX,WAAW,EACX,mCAAmC,EACnC,8BAA8B,EAC9B,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,6BAA6B,CAAC;AACrC,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,+BAA+B,EAC/B,0BAA0B,EAC1B,0BAA0B,EAC1B,OAAO,EACP,YAAY,EACZ,cAAc,EACd,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAsB5B,OAAO,EAAmC,gBAAgB,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"WalletCore.d.ts","sourceRoot":"","sources":["../src/WalletCore.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,EAEL,oBAAoB,EACpB,iBAAiB,EAEjB,0BAA0B,EAC1B,OAAO,EAEP,0BAA0B,EAC1B,oBAAoB,EACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,WAAW,EAIX,mCAAmC,EAMnC,WAAW,EACX,WAAW,EACX,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAEhF,YAAY,EACV,WAAW,EACX,WAAW,EACX,mCAAmC,EACnC,8BAA8B,EAC9B,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,6BAA6B,CAAC;AACrC,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,+BAA+B,EAC/B,0BAA0B,EAC1B,0BAA0B,EAC1B,OAAO,EACP,YAAY,EACZ,cAAc,EACd,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAsB5B,OAAO,EAAmC,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAmBhF,OAAO,EACL,gBAAgB,EAEhB,oBAAoB,EACrB,MAAM,eAAe,CAAC;AAGvB,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG;IACxC,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,iEAAiE;IACjE,cAAc,CAAC,EAAE,aAAa,CAAC;CAChC,CAAC;AAGF,MAAM,MAAM,wBAAwB,GAAG,IAAI,CACzC,aAAa,EACb,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,CAC/C,GAAG;IACF,UAAU,EAAE,gBAAgB,CAAC,WAAW,CAAC;CAC1C,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,YAAY,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAChD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;IACzD;;OAEG;IACH,UAAU,CAAC,EAAE;QACX,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB;IACvC,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,GAAG,IAAI,CAAC;IAC3C,UAAU,IAAI,IAAI,CAAC;IACnB,oBAAoB,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IACnD,0BAA0B,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IACzD,8BAA8B,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IACxE,aAAa,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,GAAG,IAAI,CAAC;IACjD,aAAa,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG;IAE9D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,qBAAa,UAAW,SAAQ,YAAY,CAAC,gBAAgB,CAAC;IAE5D,OAAO,CAAC,OAAO,CAA8B;IAG7C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAuB;IAGnD,OAAO,CAAC,iBAAiB,CAAuB;IAGhD,OAAO,CAAC,8BAA8B,CAAkC;IAGxE,OAAO,CAAC,wBAAwB,CAAuB;IAGvD,OAAO,CAAC,QAAQ,CAA4B;IAG5C,OAAO,CAAC,UAAU,CAAkB;IAGpC,OAAO,CAAC,WAAW,CAAkB;IAGrC,OAAO,CAAC,QAAQ,CAAmC;IAGnD,OAAO,CAAC,WAAW,CAAyB;IAG5C,OAAO,CAAC,aAAa,CAAuC;IAG5D,OAAO,CAAC,YAAY,CAAuC;IAG3D,OAAO,CAAC,iBAAiB,CAAkB;IAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAoB;gBAGtC,YAAY,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,EAC9C,UAAU,CAAC,EAAE,UAAU,EACvB,gBAAgB,CAAC,EAAE,OAAO,EAC1B,WAAW,GAAE,aAAa,CAAC,gBAAgB,CAAiB;IAuB9D,OAAO,CAAC,+BAA+B;IAmBvC;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IA4ChC;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAoBjC,OAAO,CAAC,mBAAmB;IAQ3B,OAAO,CAAC,yCAAyC;IAwCjD;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,wBAAwB,GAAG,OAAO;IAYxE;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,aAAa,GAAG,wBAAwB,GAAG,OAAO;IAOrE,OAAO,CAAC,WAAW;IAWnB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAU1B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;OAEG;YACW,UAAU;IAyBxB;;;;;;;OAOG;IACH,OAAO,CAAC,SAAS;IAQjB;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,GAAG,IAAI;IAI3C;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,GAAG,IAAI;IAI7C;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,GAAG,IAAI;IAI7C;;;;OAIG;IACH,WAAW,IAAI,OAAO;IAItB;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAAC,WAAW,CAAC,CAExC;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,aAAa,CAAC,aAAa,CAAC,CAEhD;IAED,IAAI,kBAAkB,IAAI,aAAa,CAAC,wBAAwB,CAAC,CAEhE;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,WAAW,GAAG,IAAI,CAO/B;IAED;;;;;OAKG;IACH,IAAI,OAAO,IAAI,WAAW,GAAG,IAAI,CAMhC;IAED;;;;;OAKG;IACH,IAAI,OAAO,IAAI,WAAW,GAAG,IAAI,CAMhC;IAED;;;;OAIG;IACG,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IAiEzD;;;;;;;;;OASG;IACG,MAAM,CAAC,IAAI,EAAE;QACjB,KAAK,EAAE,gBAAgB,CAAC;QACxB,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAoC9B;;;;;;;;OAQG;YACW,aAAa;IA0B3B;;;;;;OAMG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAajC;;;;;OAKG;IACG,wBAAwB,CAC5B,gBAAgB,EAAE,oBAAoB,GACrC,OAAO,CAAC,mCAAmC,CAAC;IA+G/C;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,IAAI,EAAE;QAC1B,oBAAoB,EAAE,iBAAiB,GAAG,oBAAoB,CAAC;QAC/D,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,GAAG,OAAO,CAAC;QACV,aAAa,EAAE,oBAAoB,CAAC;QACpC,cAAc,EAAE,UAAU,CAAC;KAC5B,CAAC;IAyGF;;;;;;;OAOG;IACG,WAAW,CACf,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,sBAAsB,CAAC;IAkBlC;;;;;OAKG;IACG,iBAAiB,CACrB,WAAW,EAAE,0BAA0B,GACtC,OAAO,CAAC,0BAA0B,CAAC;IA+BtC;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBtC;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBtC;;;;;OAKG;IACG,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAsCxE;;;;OAIG;IACG,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC;CAoC7E"}
|