@vapi-network/core 0.2.3 → 0.5.0

package/dist/keystore.d.ts

@@ -48,21 +48,86 @@ declare const keystoreSchema: z.ZodObject<{
         }, z.core.$strip>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+declare const keystoreV3Schema: z.ZodObject<{
+    version: z.ZodLiteral<3>;
+    address: z.ZodString;
+    keys: z.ZodObject<{
+        evm: z.ZodObject<{
+            type: z.ZodLiteral<"secp256k1">;
+            address: z.ZodString;
+            path: z.ZodString;
+        }, z.core.$strip>;
+        solana: z.ZodOptional<z.ZodObject<{
+            type: z.ZodLiteral<"ed25519">;
+            address: z.ZodString;
+            path: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    crypto: z.ZodObject<{
+        cipher: z.ZodLiteral<"aes-256-gcm">;
+        ciphertext: z.ZodString;
+        iv: z.ZodString;
+        authTag: z.ZodString;
+        kdf: z.ZodLiteral<"scrypt">;
+        salt: z.ZodString;
+        kdfParams: z.ZodObject<{
+            n: z.ZodLiteral<number>;
+            r: z.ZodLiteral<8>;
+            p: z.ZodLiteral<1>;
+            dkLen: z.ZodLiteral<32>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
 export type VapiKeystore = z.infer<typeof keystoreSchema>;
+/** Keystore version 3: one BIP-39 recovery phrase behind both accounts. */
+export type VapiKeystoreV3 = z.infer<typeof keystoreV3Schema>;
 export type LegacyVapiKeystore = z.infer<typeof legacyKeystoreSchema>;
 /** @deprecated Use VapiKeystore. */
 export type AgentCashKeystore = VapiKeystore;
 export type VapiPaymentAccount = ReturnType<typeof privateKeyToAccount> & {
     readonly solana?: KeyPairSigner;
 };
+export type CreateKeystoreOptions = {
+    enableSolana?: boolean;
+    /** Restore an existing wallet instead of generating a new phrase. */
+    phrase?: string;
+};
 export declare class KeystoreError extends Error {
     constructor(message: string, options?: ErrorOptions);
 }
 export declare function encryptPrivateKey(privateKey: Hex, passphrase: string): Promise<VapiKeystore>;
-export declare function decryptPrivateKey(keystore: VapiKeystore, passphrase: string): Promise<Hex>;
-export declare function createKeystore(passphrase: string, path?: string, options?: {
-    enableSolana?: boolean;
+/** Published only through `@vapi-network/core/secrets`. */
+export declare function decryptPrivateKey(keystore: VapiKeystore | VapiKeystoreV3, passphrase: string): Promise<Hex>;
+/**
+ * Creates a version 3 keystore: both accounts come from one BIP-39 recovery
+ * phrase, so the wallet can be restored in MetaMask, Rabby or Phantom from the
+ * words alone. The phrase is returned once and never written anywhere.
+ *
+ * Published only through `@vapi-network/core/secrets`.
+ */
+export declare function createKeystoreWithPhrase(passphrase: string, path?: string, options?: CreateKeystoreOptions): Promise<{
+    account: VapiPaymentAccount;
+    recoveryPhrase: string;
+}>;
+/**
+ * Wraps a private key the user already holds in a version 2 keystore, for
+ * `vapi import --key`. Such a wallet has no recovery phrase, so `vapi backup`
+ * keeps pointing at `vapi export-key` for it.
+ */
+export declare function createKeystoreFromPrivateKey(passphrase: string, path: string | undefined, options: {
+    privateKey: string;
 }): Promise<VapiPaymentAccount>;
+/** The shape every wallet import accepts: 0x and 32 bytes of hexadecimal. */
+export declare function validatePrivateKey(value: string): Hex;
+/**
+ * Re-seals the keystore under a new passphrase: fresh salt and IV, the same
+ * keys, the same addresses, and the same atomic write as every other keystore
+ * change. A version 1 file becomes version 2, the upgrade `unlockKeystore`
+ * already performs.
+ */
+export declare function changeKeystorePassphrase(oldPassphrase: string, newPassphrase: string, path?: string): Promise<VapiPaymentAccount>;
+/** `createKeystoreWithPhrase` for callers that do not show the phrase. */
+export declare function createKeystore(passphrase: string, path?: string, options?: CreateKeystoreOptions): Promise<VapiPaymentAccount>;
 export declare function unlockKeystore(passphrase: string, path?: string): Promise<VapiPaymentAccount>;
 /**
  * The stored address, read without the passphrase. Only the encrypted key
@@ -70,6 +135,12 @@ export declare function unlockKeystore(passphrase: string, path?: string): Promi
  * to replace. Returns undefined for a missing or unreadable keystore.
  */
 export declare function readKeystoreAddress(path?: string): Promise<string | undefined>;
+/**
+ * The stored format version, read without the passphrase, so a command can say
+ * why a version 1 or 2 wallet has no recovery phrase. Undefined for a missing
+ * or unreadable keystore.
+ */
+export declare function readKeystoreVersion(path?: string): Promise<number | undefined>;
 export type ExportedVapiKeys = {
     evm: {
         address: string;
@@ -85,12 +156,31 @@ export type ExportedVapiKeys = {
  * for the EVM key, and the base58 64-byte Ed25519 secret key for Solana. Only
  * `vapi export-key` may call this, and it must never write the result anywhere
  * but the caller's stdout.
+ *
+ * Published only through `@vapi-network/core/secrets`.
  */
 export declare function exportKeystoreKeys(passphrase: string, path?: string): Promise<ExportedVapiKeys>;
-/** Lazily adds a locally generated Ed25519 seed without replacing the EVM key. */
+/**
+ * Adds the Solana account. A version 3 wallet derives it from the recovery
+ * phrase it already has; older files get a locally generated Ed25519 seed,
+ * which the EVM key never replaces.
+ */
 export declare function enableSolanaKey(passphrase: string, path?: string): Promise<VapiPaymentAccount>;
+/**
+ * The 12 or 24 words behind a version 3 wallet, for `vapi backup`. Callers must
+ * print it to the user and nowhere else. Older keystores have no phrase.
+ *
+ * Published only through `@vapi-network/core/secrets`.
+ */
+export declare function exportRecoveryPhrase(passphrase: string, path?: string): Promise<string>;
 export declare function getKeystorePassphrase(options?: {
     confirm?: boolean;
 }): Promise<string>;
+/**
+ * Reads one line from the terminal without echoing it, for passphrases,
+ * recovery phrases, and private keys. The prompt goes to stderr so stdout stays
+ * a clean channel, and the secret never reaches the terminal's scrollback.
+ */
+export declare function promptForSecret(prompt: string, noTerminalHint?: string): Promise<string>;
 export {};
 //# sourceMappingURL=keystore.d.ts.map

package/dist/keystore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keystore.d.ts","sourceRoot":"","sources":["../src/keystore.ts"],"names":[],"mappings":"AAKA,OAAO,EAIL,KAAK,aAAa,EACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAsB,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AA0BhC,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;iBAIxB,CAAC;AAEH,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgBlB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAC1D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AACtE,oCAAoC;AACpC,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAE7C,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,GAAG;IACxE,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAaF,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAIpD;AAyBD,wBAAsB,iBAAiB,CACrC,UAAU,EAAE,GAAG,EACf,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,YAAY,CAAC,CAEvB;AA6CD,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAEhG;AAsDD,wBAAsB,cAAc,CAClC,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,EAC9B,OAAO,GAAE;IAAE,YAAY,CAAC,EAAE,OAAO,CAAA;CAAO,GACvC,OAAO,CAAC,kBAAkB,CAAC,CA2B7B;AAED,wBAAsB,cAAc,CAClC,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,GAC7B,OAAO,CAAC,kBAAkB,CAAC,CAmB7B;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,SAA0B,GAC7B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAgB7B;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,GAAG,CAAA;KAAE,CAAC;IAC1C,MAAM,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CACjD,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CA4B3B;AAED,kFAAkF;AAClF,wBAAsB,eAAe,CACnC,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,GAC7B,OAAO,CAAC,kBAAkB,CAAC,CAqB7B;AAwDD,wBAAsB,qBAAqB,CAAC,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAoB5F"}
+{"version":3,"file":"keystore.d.ts","sourceRoot":"","sources":["../src/keystore.ts"],"names":[],"mappings":"AAKA,OAAO,EAIL,KAAK,aAAa,EACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAqChC,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;iBAIxB,CAAC;AAEH,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgBlB,CAAC;AAEH,QAAA,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAkBpB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAC1D,2EAA2E;AAC3E,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC9D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AACtE,oCAAoC;AACpC,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAE7C,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,GAAG;IACxE,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAqBF,MAAM,MAAM,qBAAqB,GAAG;IAClC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAIpD;AAyBD,wBAAsB,iBAAiB,CACrC,UAAU,EAAE,GAAG,EACf,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,YAAY,CAAC,CAEvB;AAyGD,2DAA2D;AAC3D,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,YAAY,GAAG,cAAc,EACvC,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,GAAG,CAAC,CAEd;AAiGD;;;;;;GAMG;AACH,wBAAsB,wBAAwB,CAC5C,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,EAC9B,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC;IAAE,OAAO,EAAE,kBAAkB,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAE,CAAC,CAqBlE;AAmBD;;;;GAIG;AACH,wBAAsB,4BAA4B,CAChD,UAAU,EAAE,MAAM,EAClB,IAAI,oBAA0B,EAC9B,OAAO,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,GAC9B,OAAO,CAAC,kBAAkB,CAAC,CAM7B;AAED,6EAA6E;AAC7E,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAQrD;AAED;;;;;GAKG;AACH,wBAAsB,wBAAwB,CAC5C,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,IAAI,SAA0B,GAC7B,OAAO,CAAC,kBAAkB,CAAC,CAwB7B;AAED,0EAA0E;AAC1E,wBAAsB,cAAc,CAClC,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,EAC9B,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,kBAAkB,CAAC,CAE7B;AAED,wBAAsB,cAAc,CAClC,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,GAC7B,OAAO,CAAC,kBAAkB,CAAC,CAc7B;AAeD;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,SAA0B,GAC7B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAG7B;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,IAAI,SAA0B,GAC7B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAG7B;AAkBD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,GAAG,CAAA;KAAE,CAAC;IAC1C,MAAM,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CACjD,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,kBAAkB,CACtC,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,GAC7B,OAAO,CAAC,gBAAgB,CAAC,CAmB3B;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CACnC,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,GAC7B,OAAO,CAAC,kBAAkB,CAAC,CA0B7B;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,UAAU,EAAE,MAAM,EAClB,IAAI,SAA0B,GAC7B,OAAO,CAAC,MAAM,CAAC,CAajB;AA8DD,wBAAsB,qBAAqB,CAAC,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAoB5F;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA6C9F"}