@vaultum/sdk 0.1.5

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 ADDED
@@ -0,0 +1,56 @@
1
+ # Vaultum SDK
2
+
3
+ TypeScript SDK for the Vaultum smart wallet platform.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @vaultum/sdk
9
+ # or
10
+ pnpm add @vaultum/sdk
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ```typescript
16
+ import { VaultumClient } from '@vaultum/sdk';
17
+
18
+ const client = new VaultumClient({
19
+ baseURL: 'https://api.vaultum.app',
20
+ bearer: 'your-auth-token',
21
+ chain: 'sepolia', // default chain
22
+ });
23
+
24
+ // Create an account
25
+ const account = await client.createAccount({
26
+ sessionKeyAddress: '0x...',
27
+ owners: ['0x...', '0x...'],
28
+ threshold: 2,
29
+ });
30
+
31
+ // Submit a UserOperation
32
+ const result = await client.submit(userOp);
33
+
34
+ // Wait for confirmation
35
+ const confirmed = await client.waitForOperation(result.id);
36
+ ```
37
+
38
+ ## Core Features
39
+
40
+ - Account creation and verification
41
+ - UserOperation submission and tracking
42
+ - Multi-sig proposal workflow
43
+ - Session key management
44
+ - Spending limits
45
+ - Allowlist management
46
+ - Social recovery
47
+ - Cross-chain governance
48
+ - Settlement/paymaster integration
49
+
50
+ ## API Reference
51
+
52
+ See the [TypeScript definitions](./src/types.ts) for complete type information.
53
+
54
+ ## License
55
+
56
+ MIT