@open-wallet-standard/core 0.3.0 → 0.3.2

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 (2) hide show
  1. package/README.md +104 -0
  2. package/package.json +7 -6
package/README.md ADDED
@@ -0,0 +1,104 @@
1
+ # @open-wallet-standard/core
2
+
3
+ Secure signing and wallet management for every chain. One vault, one interface — keys never leave your machine.
4
+
5
+ [![npm](https://img.shields.io/npm/v/@open-wallet-standard/core)](https://www.npmjs.com/package/@open-wallet-standard/core)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/open-wallet-standard/core/blob/main/LICENSE)
7
+
8
+ ## Why OWS
9
+
10
+ - **Zero key exposure.** Private keys are encrypted at rest, decrypted only inside an isolated signing process. Agents and LLMs never see raw key material.
11
+ - **Every chain, one interface.** EVM, Solana, Bitcoin, Cosmos, Tron, TON — all first-class. CAIP-2/CAIP-10 addressing abstracts away chain-specific details.
12
+ - **Policy before signing.** A pre-signing policy engine gates every operation — spending limits, allowlists, chain restrictions — before any key is touched.
13
+ - **Built for agents.** MCP server, native SDK, and CLI. A wallet created by one tool works in every other.
14
+
15
+ ## Install
16
+
17
+ ```bash
18
+ npm install @open-wallet-standard/core # Node.js SDK
19
+ npm install -g @open-wallet-standard/core # Node.js SDK + CLI (provides `ows` command)
20
+ ```
21
+
22
+ The package is **fully self-contained** — it embeds the Rust core via native FFI. Installing globally with `-g` also provides the `ows` CLI.
23
+
24
+ ## Quick Start
25
+
26
+ ```javascript
27
+ import { createWallet, signMessage } from "@open-wallet-standard/core";
28
+
29
+ const wallet = createWallet("agent-treasury");
30
+ // => accounts for EVM, Solana, BTC, Cosmos, Tron, TON
31
+
32
+ const sig = signMessage("agent-treasury", "evm", "hello");
33
+ console.log(sig.signature);
34
+ ```
35
+
36
+ ### CLI
37
+
38
+ ```bash
39
+ # Create a wallet (derives addresses for all supported chains)
40
+ ows wallet create --name "agent-treasury"
41
+
42
+ # Sign a message
43
+ ows sign message --wallet agent-treasury --chain evm --message "hello"
44
+
45
+ # Sign a transaction
46
+ ows sign tx --wallet agent-treasury --chain evm --tx-hex "deadbeef..."
47
+ ```
48
+
49
+ ## Supported Chains
50
+
51
+ | Chain | Curve | Address Format | Derivation Path |
52
+ |-------|-------|----------------|-----------------|
53
+ | EVM (Ethereum, Polygon, etc.) | secp256k1 | EIP-55 checksummed | `m/44'/60'/0'/0/0` |
54
+ | Solana | Ed25519 | base58 | `m/44'/501'/0'/0'` |
55
+ | Bitcoin | secp256k1 | BIP-84 bech32 | `m/84'/0'/0'/0/0` |
56
+ | Cosmos | secp256k1 | bech32 | `m/44'/118'/0'/0/0` |
57
+ | Tron | secp256k1 | base58check | `m/44'/195'/0'/0/0` |
58
+ | TON | Ed25519 | raw/bounceable | `m/44'/607'/0'` |
59
+
60
+ ## CLI Reference
61
+
62
+ | Command | Description |
63
+ |---------|-------------|
64
+ | `ows wallet create` | Create a new wallet with addresses for all chains |
65
+ | `ows wallet list` | List all wallets in the vault |
66
+ | `ows wallet info` | Show vault path and supported chains |
67
+ | `ows sign message` | Sign a message with chain-specific formatting |
68
+ | `ows sign tx` | Sign a raw transaction |
69
+ | `ows mnemonic generate` | Generate a BIP-39 mnemonic phrase |
70
+ | `ows mnemonic derive` | Derive an address from a mnemonic |
71
+ | `ows update` | Update ows and bindings |
72
+ | `ows uninstall` | Remove ows from the system |
73
+
74
+ ## Architecture
75
+
76
+ ```
77
+ Agent / CLI / App
78
+ │
79
+ │ OWS Interface (MCP / SDK / CLI)
80
+ ▼
81
+ ┌─────────────────────┐
82
+ │ Access Layer │ 1. Agent calls ows.sign()
83
+ │ ┌────────────────┐ │ 2. Policy engine evaluates
84
+ │ │ Policy Engine │ │ 3. Enclave decrypts key
85
+ │ │ (pre-signing) │ │ 4. Transaction signed
86
+ │ └───────┬────────┘ │ 5. Key wiped from memory
87
+ │ ┌───────▼────────┐ │ 6. Signature returned
88
+ │ │ Signing Enclave │ │
89
+ │ │ (isolated proc) │ │ The agent NEVER sees
90
+ │ └───────┬────────┘ │ the private key.
91
+ │ ┌───────▼────────┐ │
92
+ │ │ Wallet Vault │ │
93
+ │ │ ~/.ows/wallets/ │ │
94
+ │ └────────────────┘ │
95
+ └─────────────────────┘
96
+ ```
97
+
98
+ ## Documentation
99
+
100
+ The full spec and docs are available at [openwallet.sh](https://openwallet.sh) and in the [GitHub repo](https://github.com/open-wallet-standard/core).
101
+
102
+ ## License
103
+
104
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-wallet-standard/core",
3
- "version": "0.3.0",
3
+ "version": "0.3.2",
4
4
  "description": "Node.js native bindings for the Open Wallet Standard",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
@@ -31,15 +31,16 @@
31
31
  "@napi-rs/cli": "^2.18.0"
32
32
  },
33
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"
34
+ "@open-wallet-standard/core-linux-x64-gnu": "0.3.2",
35
+ "@open-wallet-standard/core-linux-arm64-gnu": "0.3.2",
36
+ "@open-wallet-standard/core-darwin-x64": "0.3.2",
37
+ "@open-wallet-standard/core-darwin-arm64": "0.3.2"
38
38
  },
39
39
  "license": "MIT",
40
40
  "files": [
41
41
  "index.js",
42
42
  "index.d.ts",
43
- "bin/ows"
43
+ "bin/ows",
44
+ "README.md"
44
45
  ]
45
46
  }