@open-wallet-standard/core 0.3.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.
Files changed (4) hide show
  1. package/bin/ows +77 -0
  2. package/index.d.ts +62 -0
  3. package/index.js +327 -0
  4. package/package.json +45 -0
package/bin/ows ADDED
@@ -0,0 +1,77 @@
1
+ #!/usr/bin/env node
2
+
3
+ const { execFileSync } = require("child_process");
4
+ const { existsSync } = require("fs");
5
+ const { join } = require("path");
6
+ const { platform, arch } = process;
7
+
8
+ const PLATFORM_MAP = {
9
+ "darwin-arm64": {
10
+ pkg: "@open-wallet-standard/core-darwin-arm64",
11
+ bin: "ows",
12
+ },
13
+ "darwin-x64": {
14
+ pkg: "@open-wallet-standard/core-darwin-x64",
15
+ bin: "ows",
16
+ },
17
+ "linux-x64": {
18
+ pkg: "@open-wallet-standard/core-linux-x64-gnu",
19
+ bin: "ows",
20
+ },
21
+ "linux-arm64": {
22
+ pkg: "@open-wallet-standard/core-linux-arm64-gnu",
23
+ bin: "ows",
24
+ },
25
+ };
26
+
27
+ const key = `${platform}-${arch}`;
28
+ const entry = PLATFORM_MAP[key];
29
+
30
+ if (!entry) {
31
+ console.error(
32
+ `ows: unsupported platform ${platform}-${arch}. ` +
33
+ `Install the CLI manually: https://openwallet.sh`
34
+ );
35
+ process.exit(1);
36
+ }
37
+
38
+ // Try to find the binary in the platform-specific optional dependency
39
+ let binPath;
40
+
41
+ // 1. Check inside node_modules (normal npm install)
42
+ try {
43
+ const pkgDir = require.resolve(`${entry.pkg}/package.json`);
44
+ binPath = join(pkgDir, "..", entry.bin);
45
+ } catch {}
46
+
47
+ // 2. Check local npm/ directory (development / monorepo)
48
+ if (!binPath || !existsSync(binPath)) {
49
+ const localDir = join(
50
+ __dirname,
51
+ "..",
52
+ "npm",
53
+ entry.pkg.split("/").pop(),
54
+ entry.bin
55
+ );
56
+ if (existsSync(localDir)) {
57
+ binPath = localDir;
58
+ }
59
+ }
60
+
61
+ if (!binPath || !existsSync(binPath)) {
62
+ console.error(
63
+ `ows: CLI binary not found for ${platform}-${arch}.\n` +
64
+ `The platform package ${entry.pkg} may not be installed.\n` +
65
+ `Install the CLI manually: https://openwallet.sh`
66
+ );
67
+ process.exit(1);
68
+ }
69
+
70
+ try {
71
+ execFileSync(binPath, process.argv.slice(2), { stdio: "inherit" });
72
+ } catch (e) {
73
+ if (e.status !== undefined) {
74
+ process.exit(e.status);
75
+ }
76
+ throw e;
77
+ }
package/index.d.ts ADDED
@@ -0,0 +1,62 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+
4
+ /* auto-generated by NAPI-RS */
5
+
6
+ /** A single account within a wallet (one per chain family). */
7
+ export interface AccountInfo {
8
+ chainId: string
9
+ address: string
10
+ derivationPath: string
11
+ }
12
+ /** Wallet information returned by create/import/list/get operations. */
13
+ export interface WalletInfo {
14
+ id: string
15
+ name: string
16
+ accounts: Array<AccountInfo>
17
+ createdAt: string
18
+ }
19
+ /** Result from a signing operation. */
20
+ export interface SignResult {
21
+ signature: string
22
+ recoveryId?: number
23
+ }
24
+ /** Result from a sign-and-send operation. */
25
+ export interface SendResult {
26
+ txHash: string
27
+ }
28
+ /** Generate a new BIP-39 mnemonic phrase. */
29
+ export declare function generateMnemonic(words?: number | undefined | null): string
30
+ /** Derive an address from a mnemonic for the given chain. */
31
+ export declare function deriveAddress(mnemonic: string, chain: string, index?: number | undefined | null): string
32
+ /** Create a new universal wallet (derives addresses for all chains). */
33
+ export declare function createWallet(name: string, passphrase?: string | undefined | null, words?: number | undefined | null, vaultPathOpt?: string | undefined | null): WalletInfo
34
+ /** Import a wallet from a mnemonic phrase (derives addresses for all chains). */
35
+ export declare function importWalletMnemonic(name: string, mnemonic: string, passphrase?: string | undefined | null, index?: number | undefined | null, vaultPathOpt?: string | undefined | null): WalletInfo
36
+ /**
37
+ * Import a wallet from a hex-encoded private key.
38
+ * All 6 chains are supported: the provided key is used for its curve's chains,
39
+ * and a random key is generated for the other curve.
40
+ * The optional `chain` parameter specifies the key's source chain (e.g. "evm", "solana")
41
+ * to determine which curve it uses. Defaults to "evm" (secp256k1).
42
+ *
43
+ * Alternatively, provide explicit keys for each curve via `secp256k1Key` and `ed25519Key`.
44
+ * When both are given, `privateKeyHex` and `chain` are ignored.
45
+ */
46
+ export declare function importWalletPrivateKey(name: string, privateKeyHex: string, passphrase?: string | undefined | null, vaultPathOpt?: string | undefined | null, chain?: string | undefined | null, secp256K1Key?: string | undefined | null, ed25519Key?: string | undefined | null): WalletInfo
47
+ /** List all wallets in the vault. */
48
+ export declare function listWallets(vaultPathOpt?: string | undefined | null): Array<WalletInfo>
49
+ /** Get a single wallet by name or ID. */
50
+ export declare function getWallet(nameOrId: string, vaultPathOpt?: string | undefined | null): WalletInfo
51
+ /** Delete a wallet from the vault. */
52
+ export declare function deleteWallet(nameOrId: string, vaultPathOpt?: string | undefined | null): void
53
+ /** Export a wallet's secret (mnemonic or private key). */
54
+ export declare function exportWallet(nameOrId: string, passphrase?: string | undefined | null, vaultPathOpt?: string | undefined | null): string
55
+ /** Rename a wallet. */
56
+ export declare function renameWallet(nameOrId: string, newName: string, vaultPathOpt?: string | undefined | null): void
57
+ /** Sign a transaction. Returns hex-encoded signature. */
58
+ export declare function signTransaction(wallet: string, chain: string, txHex: string, passphrase?: string | undefined | null, index?: number | undefined | null, vaultPathOpt?: string | undefined | null): SignResult
59
+ /** Sign a message. Returns hex-encoded signature. */
60
+ export declare function signMessage(wallet: string, chain: string, message: string, passphrase?: string | undefined | null, encoding?: string | undefined | null, index?: number | undefined | null, vaultPathOpt?: string | undefined | null): SignResult
61
+ /** Sign and broadcast a transaction. Returns the transaction hash. */
62
+ export declare function signAndSend(wallet: string, chain: string, txHex: string, passphrase?: string | undefined | null, index?: number | undefined | null, rpcUrl?: string | undefined | null, vaultPathOpt?: string | undefined | null): SendResult
package/index.js ADDED
@@ -0,0 +1,327 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /* prettier-ignore */
4
+
5
+ /* auto-generated by NAPI-RS */
6
+
7
+ const { existsSync, readFileSync } = require('fs')
8
+ const { join } = require('path')
9
+
10
+ const { platform, arch } = process
11
+
12
+ let nativeBinding = null
13
+ let localFileExisted = false
14
+ let loadError = null
15
+
16
+ function isMusl() {
17
+ // For Node 10
18
+ if (!process.report || typeof process.report.getReport !== 'function') {
19
+ try {
20
+ const lddPath = require('child_process').execSync('which ldd').toString().trim()
21
+ return readFileSync(lddPath, 'utf8').includes('musl')
22
+ } catch (e) {
23
+ return true
24
+ }
25
+ } else {
26
+ const { glibcVersionRuntime } = process.report.getReport().header
27
+ return !glibcVersionRuntime
28
+ }
29
+ }
30
+
31
+ switch (platform) {
32
+ case 'android':
33
+ switch (arch) {
34
+ case 'arm64':
35
+ localFileExisted = existsSync(join(__dirname, 'ows-node.android-arm64.node'))
36
+ try {
37
+ if (localFileExisted) {
38
+ nativeBinding = require('./ows-node.android-arm64.node')
39
+ } else {
40
+ nativeBinding = require('@open-wallet-standard/core-android-arm64')
41
+ }
42
+ } catch (e) {
43
+ loadError = e
44
+ }
45
+ break
46
+ case 'arm':
47
+ localFileExisted = existsSync(join(__dirname, 'ows-node.android-arm-eabi.node'))
48
+ try {
49
+ if (localFileExisted) {
50
+ nativeBinding = require('./ows-node.android-arm-eabi.node')
51
+ } else {
52
+ nativeBinding = require('@open-wallet-standard/core-android-arm-eabi')
53
+ }
54
+ } catch (e) {
55
+ loadError = e
56
+ }
57
+ break
58
+ default:
59
+ throw new Error(`Unsupported architecture on Android ${arch}`)
60
+ }
61
+ break
62
+ case 'win32':
63
+ switch (arch) {
64
+ case 'x64':
65
+ localFileExisted = existsSync(
66
+ join(__dirname, 'ows-node.win32-x64-msvc.node')
67
+ )
68
+ try {
69
+ if (localFileExisted) {
70
+ nativeBinding = require('./ows-node.win32-x64-msvc.node')
71
+ } else {
72
+ nativeBinding = require('@open-wallet-standard/core-win32-x64-msvc')
73
+ }
74
+ } catch (e) {
75
+ loadError = e
76
+ }
77
+ break
78
+ case 'ia32':
79
+ localFileExisted = existsSync(
80
+ join(__dirname, 'ows-node.win32-ia32-msvc.node')
81
+ )
82
+ try {
83
+ if (localFileExisted) {
84
+ nativeBinding = require('./ows-node.win32-ia32-msvc.node')
85
+ } else {
86
+ nativeBinding = require('@open-wallet-standard/core-win32-ia32-msvc')
87
+ }
88
+ } catch (e) {
89
+ loadError = e
90
+ }
91
+ break
92
+ case 'arm64':
93
+ localFileExisted = existsSync(
94
+ join(__dirname, 'ows-node.win32-arm64-msvc.node')
95
+ )
96
+ try {
97
+ if (localFileExisted) {
98
+ nativeBinding = require('./ows-node.win32-arm64-msvc.node')
99
+ } else {
100
+ nativeBinding = require('@open-wallet-standard/core-win32-arm64-msvc')
101
+ }
102
+ } catch (e) {
103
+ loadError = e
104
+ }
105
+ break
106
+ default:
107
+ throw new Error(`Unsupported architecture on Windows: ${arch}`)
108
+ }
109
+ break
110
+ case 'darwin':
111
+ localFileExisted = existsSync(join(__dirname, 'ows-node.darwin-universal.node'))
112
+ try {
113
+ if (localFileExisted) {
114
+ nativeBinding = require('./ows-node.darwin-universal.node')
115
+ } else {
116
+ nativeBinding = require('@open-wallet-standard/core-darwin-universal')
117
+ }
118
+ break
119
+ } catch {}
120
+ switch (arch) {
121
+ case 'x64':
122
+ localFileExisted = existsSync(join(__dirname, 'ows-node.darwin-x64.node'))
123
+ try {
124
+ if (localFileExisted) {
125
+ nativeBinding = require('./ows-node.darwin-x64.node')
126
+ } else {
127
+ nativeBinding = require('@open-wallet-standard/core-darwin-x64')
128
+ }
129
+ } catch (e) {
130
+ loadError = e
131
+ }
132
+ break
133
+ case 'arm64':
134
+ localFileExisted = existsSync(
135
+ join(__dirname, 'ows-node.darwin-arm64.node')
136
+ )
137
+ try {
138
+ if (localFileExisted) {
139
+ nativeBinding = require('./ows-node.darwin-arm64.node')
140
+ } else {
141
+ nativeBinding = require('@open-wallet-standard/core-darwin-arm64')
142
+ }
143
+ } catch (e) {
144
+ loadError = e
145
+ }
146
+ break
147
+ default:
148
+ throw new Error(`Unsupported architecture on macOS: ${arch}`)
149
+ }
150
+ break
151
+ case 'freebsd':
152
+ if (arch !== 'x64') {
153
+ throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
154
+ }
155
+ localFileExisted = existsSync(join(__dirname, 'ows-node.freebsd-x64.node'))
156
+ try {
157
+ if (localFileExisted) {
158
+ nativeBinding = require('./ows-node.freebsd-x64.node')
159
+ } else {
160
+ nativeBinding = require('@open-wallet-standard/core-freebsd-x64')
161
+ }
162
+ } catch (e) {
163
+ loadError = e
164
+ }
165
+ break
166
+ case 'linux':
167
+ switch (arch) {
168
+ case 'x64':
169
+ if (isMusl()) {
170
+ localFileExisted = existsSync(
171
+ join(__dirname, 'ows-node.linux-x64-musl.node')
172
+ )
173
+ try {
174
+ if (localFileExisted) {
175
+ nativeBinding = require('./ows-node.linux-x64-musl.node')
176
+ } else {
177
+ nativeBinding = require('@open-wallet-standard/core-linux-x64-musl')
178
+ }
179
+ } catch (e) {
180
+ loadError = e
181
+ }
182
+ } else {
183
+ localFileExisted = existsSync(
184
+ join(__dirname, 'ows-node.linux-x64-gnu.node')
185
+ )
186
+ try {
187
+ if (localFileExisted) {
188
+ nativeBinding = require('./ows-node.linux-x64-gnu.node')
189
+ } else {
190
+ nativeBinding = require('@open-wallet-standard/core-linux-x64-gnu')
191
+ }
192
+ } catch (e) {
193
+ loadError = e
194
+ }
195
+ }
196
+ break
197
+ case 'arm64':
198
+ if (isMusl()) {
199
+ localFileExisted = existsSync(
200
+ join(__dirname, 'ows-node.linux-arm64-musl.node')
201
+ )
202
+ try {
203
+ if (localFileExisted) {
204
+ nativeBinding = require('./ows-node.linux-arm64-musl.node')
205
+ } else {
206
+ nativeBinding = require('@open-wallet-standard/core-linux-arm64-musl')
207
+ }
208
+ } catch (e) {
209
+ loadError = e
210
+ }
211
+ } else {
212
+ localFileExisted = existsSync(
213
+ join(__dirname, 'ows-node.linux-arm64-gnu.node')
214
+ )
215
+ try {
216
+ if (localFileExisted) {
217
+ nativeBinding = require('./ows-node.linux-arm64-gnu.node')
218
+ } else {
219
+ nativeBinding = require('@open-wallet-standard/core-linux-arm64-gnu')
220
+ }
221
+ } catch (e) {
222
+ loadError = e
223
+ }
224
+ }
225
+ break
226
+ case 'arm':
227
+ if (isMusl()) {
228
+ localFileExisted = existsSync(
229
+ join(__dirname, 'ows-node.linux-arm-musleabihf.node')
230
+ )
231
+ try {
232
+ if (localFileExisted) {
233
+ nativeBinding = require('./ows-node.linux-arm-musleabihf.node')
234
+ } else {
235
+ nativeBinding = require('@open-wallet-standard/core-linux-arm-musleabihf')
236
+ }
237
+ } catch (e) {
238
+ loadError = e
239
+ }
240
+ } else {
241
+ localFileExisted = existsSync(
242
+ join(__dirname, 'ows-node.linux-arm-gnueabihf.node')
243
+ )
244
+ try {
245
+ if (localFileExisted) {
246
+ nativeBinding = require('./ows-node.linux-arm-gnueabihf.node')
247
+ } else {
248
+ nativeBinding = require('@open-wallet-standard/core-linux-arm-gnueabihf')
249
+ }
250
+ } catch (e) {
251
+ loadError = e
252
+ }
253
+ }
254
+ break
255
+ case 'riscv64':
256
+ if (isMusl()) {
257
+ localFileExisted = existsSync(
258
+ join(__dirname, 'ows-node.linux-riscv64-musl.node')
259
+ )
260
+ try {
261
+ if (localFileExisted) {
262
+ nativeBinding = require('./ows-node.linux-riscv64-musl.node')
263
+ } else {
264
+ nativeBinding = require('@open-wallet-standard/core-linux-riscv64-musl')
265
+ }
266
+ } catch (e) {
267
+ loadError = e
268
+ }
269
+ } else {
270
+ localFileExisted = existsSync(
271
+ join(__dirname, 'ows-node.linux-riscv64-gnu.node')
272
+ )
273
+ try {
274
+ if (localFileExisted) {
275
+ nativeBinding = require('./ows-node.linux-riscv64-gnu.node')
276
+ } else {
277
+ nativeBinding = require('@open-wallet-standard/core-linux-riscv64-gnu')
278
+ }
279
+ } catch (e) {
280
+ loadError = e
281
+ }
282
+ }
283
+ break
284
+ case 's390x':
285
+ localFileExisted = existsSync(
286
+ join(__dirname, 'ows-node.linux-s390x-gnu.node')
287
+ )
288
+ try {
289
+ if (localFileExisted) {
290
+ nativeBinding = require('./ows-node.linux-s390x-gnu.node')
291
+ } else {
292
+ nativeBinding = require('@open-wallet-standard/core-linux-s390x-gnu')
293
+ }
294
+ } catch (e) {
295
+ loadError = e
296
+ }
297
+ break
298
+ default:
299
+ throw new Error(`Unsupported architecture on Linux: ${arch}`)
300
+ }
301
+ break
302
+ default:
303
+ throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
304
+ }
305
+
306
+ if (!nativeBinding) {
307
+ if (loadError) {
308
+ throw loadError
309
+ }
310
+ throw new Error(`Failed to load native binding`)
311
+ }
312
+
313
+ const { generateMnemonic, deriveAddress, createWallet, importWalletMnemonic, importWalletPrivateKey, listWallets, getWallet, deleteWallet, exportWallet, renameWallet, signTransaction, signMessage, signAndSend } = nativeBinding
314
+
315
+ module.exports.generateMnemonic = generateMnemonic
316
+ module.exports.deriveAddress = deriveAddress
317
+ module.exports.createWallet = createWallet
318
+ module.exports.importWalletMnemonic = importWalletMnemonic
319
+ module.exports.importWalletPrivateKey = importWalletPrivateKey
320
+ module.exports.listWallets = listWallets
321
+ module.exports.getWallet = getWallet
322
+ module.exports.deleteWallet = deleteWallet
323
+ module.exports.exportWallet = exportWallet
324
+ module.exports.renameWallet = renameWallet
325
+ module.exports.signTransaction = signTransaction
326
+ module.exports.signMessage = signMessage
327
+ module.exports.signAndSend = signAndSend
package/package.json ADDED
@@ -0,0 +1,45 @@
1
+ {
2
+ "name": "@open-wallet-standard/core",
3
+ "version": "0.3.0",
4
+ "description": "Node.js native bindings for the Open Wallet Standard",
5
+ "main": "index.js",
6
+ "types": "index.d.ts",
7
+ "bin": {
8
+ "ows": "bin/ows"
9
+ },
10
+ "napi": {
11
+ "name": "ows-node",
12
+ "triples": {
13
+ "defaults": false,
14
+ "additional": [
15
+ "x86_64-apple-darwin",
16
+ "aarch64-apple-darwin",
17
+ "x86_64-unknown-linux-gnu",
18
+ "aarch64-unknown-linux-gnu"
19
+ ]
20
+ }
21
+ },
22
+ "scripts": {
23
+ "artifacts": "napi artifacts",
24
+ "build": "napi build --platform --release",
25
+ "build:debug": "napi build --platform",
26
+ "prepublishOnly": "napi build --platform --release",
27
+ "publish:all": "node publish.mjs",
28
+ "test": "node --test __test__/index.spec.mjs"
29
+ },
30
+ "devDependencies": {
31
+ "@napi-rs/cli": "^2.18.0"
32
+ },
33
+ "optionalDependencies": {
34
+ "@open-wallet-standard/core-linux-x64-gnu": "0.3.0",
35
+ "@open-wallet-standard/core-linux-arm64-gnu": "0.3.0",
36
+ "@open-wallet-standard/core-darwin-x64": "0.3.0",
37
+ "@open-wallet-standard/core-darwin-arm64": "0.3.0"
38
+ },
39
+ "license": "MIT",
40
+ "files": [
41
+ "index.js",
42
+ "index.d.ts",
43
+ "bin/ows"
44
+ ]
45
+ }