@vaultkeepr/smart-account 0.1.1 → 0.1.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 +42 -0
  2. package/package.json +17 -8
package/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # @vaultkeepr/smart-account
2
+
3
+ ERC-4337 account abstraction for VaultKeepR: Kernel smart account with Pimlico paymaster. Universal module for Web, Extension, iOS, and Android.
4
+
5
+ Identity can be derived from the master password (on-device, no seed phrase exposure) or from an existing signer.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm install @vaultkeepr/smart-account
11
+ ```
12
+
13
+ Requires `@vaultkeepr/core` and `@vaultkeepr/logger`.
14
+
15
+ > This package ships as TypeScript source (`main`/`exports` point at `src/index.ts`) — consume it through your bundler.
16
+
17
+ ## Usage
18
+
19
+ ```ts
20
+ import {
21
+ getIdentityAddress,
22
+ initIdentityFromPassword,
23
+ isIdentityConnected,
24
+ } from "@vaultkeepr/smart-account";
25
+
26
+ await initIdentityFromPassword(password, salt);
27
+ if (isIdentityConnected()) {
28
+ const address = getIdentityAddress(); // smart account address
29
+ }
30
+ ```
31
+
32
+ Alternative: `initIdentityFromSigner(signer)` when a wallet is already connected; `clearIdentity()` wipes in-memory state.
33
+
34
+ Modules: `identity.ts` (identity lifecycle), `kernel.ts` (Kernel account), `owner.ts` + `secretKey.ts` (signer derivation), `onChainSync.ts` (vault pointer writes), `cidRegistry.ts` (`VaultKeeperCidRegistry` bindings).
35
+
36
+ ## Security notes
37
+
38
+ The chain stores location pointers only — never keys. Signatures for on-chain writes go through the user's smart account.
39
+
40
+ Repository: [VaultKeepR/vaultkeepr-public](https://github.com/VaultKeepR/vaultkeepr-public) · Site: [vaultkeepr.xyz](https://vaultkeepr.xyz)
41
+
42
+ MIT licensed.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vaultkeepr/smart-account",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "ERC-4337 Smart Account (Kernel) with Pimlico Paymaster — universal module for Web, Extension, iOS, and Android",
5
5
  "license": "MIT",
6
6
  "main": "./src/index.ts",
@@ -14,24 +14,33 @@
14
14
  }
15
15
  },
16
16
  "dependencies": {
17
- "@vaultkeepr/logger": "0.1.1",
18
- "@vaultkeepr/core": "0.1.1"
17
+ "@vaultkeepr/core": "0.1.3",
18
+ "@vaultkeepr/logger": "0.1.2"
19
19
  },
20
20
  "peerDependencies": {
21
21
  "permissionless": ">=0.3.0",
22
- "viem": ">=2.0.0",
23
- "react": "^18.0.0 || ^19.0.0"
22
+ "react": "^18.0.0 || ^19.0.0",
23
+ "viem": ">=2.0.0"
24
24
  },
25
25
  "devDependencies": {
26
+ "@types/react": "^19.0.0",
27
+ "react": "^19.2.0",
26
28
  "tsup": "^8.3.5",
27
29
  "typescript": "^5.6.3",
28
- "vitest": "^4.1.11",
29
- "react": "^19.2.0",
30
- "@types/react": "^19.0.0"
30
+ "vitest": "^4.1.11"
31
31
  },
32
32
  "files": [
33
33
  "dist"
34
34
  ],
35
+ "repository": {
36
+ "type": "git",
37
+ "url": "git+https://github.com/VaultKeepR/vaultkeepr-public.git",
38
+ "directory": "packages/smart-account"
39
+ },
40
+ "homepage": "https://vaultkeepr.xyz",
41
+ "bugs": {
42
+ "url": "https://github.com/VaultKeepR/vaultkeepr-public/issues"
43
+ },
35
44
  "scripts": {
36
45
  "build": "tsup src/index.ts --format cjs,esm --dts",
37
46
  "clean": "rm -rf dist",