@bsv/sdk 1.6.8 → 1.6.9

package/dist/types/src/transaction/chaintrackers/__tests/WhatsOnChainChainTracker.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WhatsOnChainChainTracker.test.d.ts","sourceRoot":"","sources":["../../../../../../src/transaction/chaintrackers/__tests/WhatsOnChainChainTracker.test.ts"],"names":[],"mappings":""}

package/dist/types/src/wallet/ScriptTemplateSABPPP.d.ts

@@ -0,0 +1,25 @@
+import { LockingScript, P2PKH, PrivateKey, Script, ScriptTemplate, Transaction, UnlockingScript } from "@bsv/sdk";
+import { sdk } from "./";
+export interface ScriptTemplateParamsSABPPP {
+    derivationPrefix?: string;
+    derivationSuffix?: string;
+    keyDeriver: sdk.KeyDeriverApi;
+}
+export declare const brc29ProtocolID: sdk.WalletProtocol;
+export declare class ScriptTemplateSABPPP implements ScriptTemplate {
+    params: ScriptTemplateParamsSABPPP;
+    p2pkh: P2PKH;
+    constructor(params: ScriptTemplateParamsSABPPP);
+    getKeyID(): string;
+    getKeyDeriver(privKey: PrivateKey | sdk.HexString): sdk.KeyDeriverApi;
+    lock(lockerPrivKey: string, unlockerPubKey: string): LockingScript;
+    unlock(unlockerPrivKey: string, lockerPubKey: string, sourceSatoshis?: number, lockingScript?: Script): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: (tx?: Transaction, inputIndex?: number) => Promise<number>;
+    };
+    /**
+     * P2PKH unlock estimateLength is a constant
+     */
+    unlockLength: number;
+}
+//# sourceMappingURL=ScriptTemplateSABPPP.d.ts.map

package/dist/types/src/wallet/ScriptTemplateSABPPP.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScriptTemplateSABPPP.d.ts","sourceRoot":"","sources":["../../../../src/wallet/ScriptTemplateSABPPP.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAClH,OAAO,EAAE,GAAG,EAAE,MAAM,IAAI,CAAC;AAEzB,MAAM,WAAW,0BAA0B;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,UAAU,EAAE,GAAG,CAAC,aAAa,CAAA;CAChC;AAED,eAAO,MAAM,eAAe,EAAE,GAAG,CAAC,cAAoC,CAAA;AAEtE,qBAAa,oBAAqB,YAAW,cAAc;IAGpC,MAAM,EAAE,0BAA0B;IAFrD,KAAK,EAAE,KAAK,CAAA;gBAEO,MAAM,EAAE,0BAA0B;IAOrD,QAAQ;IAER,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,aAAa;IAQrE,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,aAAa;IAMlE,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAC/F;QACE,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;QACxE,cAAc,EAAE,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;KAC9E;IAML;;OAEG;IACH,YAAY,SAAM;CAErB"}

package/dist/types/src/wallet/WalletSigner.d.ts

@@ -0,0 +1,110 @@
+import { AbortActionArgs, AbortActionResult, AcquireCertificateArgs, AcquireCertificateResult, Base64String, BasketStringUnder300Bytes, Byte, CertificateFieldNameUnder50Bytes, CreateActionArgs, CreateActionResult, CreateHmacArgs, CreateSignatureArgs, DiscoverByAttributesArgs, DiscoverByIdentityKeyArgs, DiscoverCertificatesResult, GetPublicKeyArgs, HexString, InternalizeActionArgs, InternalizeActionResult, ListActionsArgs, ListActionsResult, ListCertificatesArgs, ListCertificatesResult, ListOutputsArgs, ListOutputsResult, OutpointString, PositiveInteger, ProveCertificateArgs, ProveCertificateResult, PubKeyHex, RelinquishCertificateArgs, RevealCounterpartyKeyLinkageArgs, RevealCounterpartyKeyLinkageResult, RevealSpecificKeyLinkageArgs, RevealSpecificKeyLinkageResult, SignActionArgs, SignActionResult, VerifyHmacArgs, VerifySignatureArgs, VersionString7To30Bytes, Wallet, WalletDecryptArgs, WalletEncryptArgs, WalletCertificate } from './Wallet.interfaces.js';
+import KeyDeriver from './KeyDeriver.js';
+import { PrivateKey } from '../primitives/index.js';
+import ProtoWallet from './ProtoWallet.js';
+import { BeefParty } from 'mod.js';
+interface WalletStorage {
+    storageIdentityKey: string;
+    syncWith(foreignPeer: WalletStorage): Promise<void>;
+    listActions(args: ListActionsArgs): Promise<ListActionsResult>;
+    internalizeAction(args: InternalizeActionArgs): Promise<InternalizeActionResult>;
+    listOutputs(args: ListOutputsArgs): Promise<ListOutputsResult>;
+    getHeight(): Promise<PositiveInteger>;
+    getHeaderForHeight(args: {
+        height: PositiveInteger;
+    }): Promise<{
+        header: HexString;
+    }>;
+    relinquishOutput(args: {
+        basket: BasketStringUnder300Bytes;
+        output: OutpointString;
+    }): Promise<void>;
+    listCertificates(args: ListCertificatesArgs): Promise<ListCertificatesResult>;
+    findMasterKeyringForCertificate(type: Base64String, serialNumber: Base64String): Promise<Record<CertificateFieldNameUnder50Bytes, Base64String>>;
+    storeCertificateAndMasterKeyring(certificate: WalletCertificate, keyring: Record<CertificateFieldNameUnder50Bytes, Base64String>): Promise<void>;
+    relinquishCertificate(args: RelinquishCertificateArgs): Promise<void>;
+}
+/**
+ * A WalletSigner is a structure that fulfills the Wallet interface, capable of performing all foundational cryptographic operations. It can derive keys, create signatures, facilitate encryption and HMAC operations, and reveal key linkages. However, ProtoWallet does not create transactions, manage outputs, interact with the blockchain, enable the management of identity certificates, or store any data.
+ */
+export default class WalletSigner implements Wallet {
+    keyDeriver: KeyDeriver;
+    network: 'mainnet' | 'testnet';
+    activeStorageProvider: WalletStorage;
+    auxiliaryStorageProviders: WalletStorage[];
+    proto: ProtoWallet;
+    syncAfterWrite: boolean;
+    privilegedError: string;
+    beef: BeefParty;
+    storageParty: string;
+    userParty: string;
+    constructor(rootKey: PrivateKey | 'anyone', storageProviders: WalletStorage[], network?: 'mainnet' | 'testnet', syncAfterWrite?: boolean, KeyDeriverClass?: typeof KeyDeriver);
+    private syncPrimaryStorageToAuxiliary;
+    createAction(args: CreateActionArgs): Promise<CreateActionResult>;
+    signAction(args: SignActionArgs): Promise<SignActionResult>;
+    abortAction(args: AbortActionArgs): Promise<AbortActionResult>;
+    listActions(args: ListActionsArgs): Promise<ListActionsResult>;
+    internalizeAction(args: InternalizeActionArgs): Promise<InternalizeActionResult>;
+    listOutputs(args: ListOutputsArgs): Promise<ListOutputsResult>;
+    relinquishOutput(args: {
+        basket: BasketStringUnder300Bytes;
+        output: OutpointString;
+    }): Promise<{
+        relinquished: true;
+    }>;
+    getPublicKey(args: GetPublicKeyArgs): Promise<{
+        publicKey: PubKeyHex;
+    }>;
+    revealCounterpartyKeyLinkage(args: RevealCounterpartyKeyLinkageArgs): Promise<RevealCounterpartyKeyLinkageResult>;
+    revealSpecificKeyLinkage(args: RevealSpecificKeyLinkageArgs): Promise<RevealSpecificKeyLinkageResult>;
+    encrypt(args: WalletEncryptArgs): Promise<{
+        ciphertext: Byte[];
+    }>;
+    decrypt(args: WalletDecryptArgs): Promise<{
+        plaintext: Byte[];
+    }>;
+    createHmac(args: CreateHmacArgs): Promise<{
+        hmac: Byte[];
+    }>;
+    verifyHmac(args: VerifyHmacArgs): Promise<{
+        valid: true;
+    }>;
+    createSignature(args: CreateSignatureArgs): Promise<{
+        signature: Byte[];
+    }>;
+    verifySignature(args: VerifySignatureArgs): Promise<{
+        valid: true;
+    }>;
+    acquireCertificate(args: AcquireCertificateArgs): Promise<AcquireCertificateResult>;
+    listCertificates(args: ListCertificatesArgs): Promise<ListCertificatesResult>;
+    proveCertificate(args: ProveCertificateArgs): Promise<ProveCertificateResult>;
+    relinquishCertificate(args: RelinquishCertificateArgs): Promise<{
+        relinquished: true;
+    }>;
+    discoverByIdentityKey(args: DiscoverByIdentityKeyArgs): Promise<DiscoverCertificatesResult>;
+    discoverByAttributes(args: DiscoverByAttributesArgs): Promise<DiscoverCertificatesResult>;
+    isAuthenticated(args: {}): Promise<{
+        authenticated: boolean;
+    }>;
+    waitForAuthentication(args: {}): Promise<{
+        authenticated: true;
+    }>;
+    getHeight(args: {}): Promise<{
+        height: PositiveInteger;
+    }>;
+    getHeaderForHeight(args: {
+        height: PositiveInteger;
+    }): Promise<{
+        header: HexString;
+    }>;
+    getNetwork(args: {}): Promise<{
+        network: 'mainnet' | 'testnet';
+    }>;
+    getVersion(args: {}): Promise<{
+        version: VersionString7To30Bytes;
+    }>;
+    private getKnownTxids;
+    private getClientChangeKeyPair;
+}
+export {};
+//# sourceMappingURL=WalletSigner.d.ts.map

package/dist/types/src/wallet/WalletSigner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WalletSigner.d.ts","sourceRoot":"","sources":["../../../../src/wallet/WalletSigner.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,EACxB,YAAY,EACZ,yBAAyB,EAIzB,IAAI,EACJ,gCAAgC,EAChC,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EAEnB,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAG1B,gBAAgB,EAChB,SAAS,EACT,qBAAqB,EACrB,uBAAuB,EAIvB,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EAEjB,cAAc,EAEd,eAAe,EAKf,oBAAoB,EACpB,sBAAsB,EACtB,SAAS,EACT,yBAAyB,EACzB,gCAAgC,EAChC,kCAAkC,EAClC,4BAA4B,EAC5B,8BAA8B,EAG9B,cAAc,EACd,gBAAgB,EAEhB,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACvB,MAAM,EACN,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,UAAU,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,UAAU,EAAuE,MAAM,wBAAwB,CAAA;AAExH,OAAO,WAAW,MAAM,kBAAkB,CAAA;AAC1C,OAAO,EAAsH,SAAS,EAAE,MAAM,QAAQ,CAAA;AAItJ,UAAU,aAAa;IACrB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,WAAW,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACnD,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAC9D,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAA;IAChF,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAC9D,SAAS,IAAI,OAAO,CAAC,eAAe,CAAC,CAAA;IACrC,kBAAkB,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,eAAe,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC,CAAA;IACrF,gBAAgB,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,yBAAyB,CAAC;QAAC,MAAM,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpG,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAC7E,+BAA+B,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,gCAAgC,EAAE,YAAY,CAAC,CAAC,CAAA;IAChJ,gCAAgC,CAAC,WAAW,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,gCAAgC,EAAE,YAAY,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAChJ,qBAAqB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACtE;AAUD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,MAAM;IACjD,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,SAAS,GAAG,SAAS,CAAA;IAC9B,qBAAqB,EAAE,aAAa,CAAA;IACpC,yBAAyB,EAAE,aAAa,EAAE,CAAA;IAC1C,KAAK,EAAE,WAAW,CAAA;IAClB,cAAc,EAAE,OAAO,CAAA;IACvB,eAAe,EAAE,MAAM,CACkG;IAEzH,IAAI,EAAE,SAAS,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;gBAGf,OAAO,EAAE,UAAU,GAAG,QAAQ,EAC9B,gBAAgB,EAAE,aAAa,EAAE,EACjC,OAAO,GAAE,SAAS,GAAG,SAAqB,EAC1C,cAAc,GAAE,OAAe,EAC/B,eAAe,oBAAa;YAehB,6BAA6B;IAUrC,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA2BjE,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI3D,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9D,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIpE,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAIhF,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIxD,gBAAgB,CAAC,IAAI,EAAE;QAC3B,MAAM,EAAE,yBAAyB,CAAA;QACjC,MAAM,EAAE,cAAc,CAAA;KACvB,GAAG,OAAO,CAAC;QAAE,YAAY,EAAE,IAAI,CAAA;KAAE,CAAC;IAQ7B,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,SAAS,CAAA;KAAE,CAAC;IAIvE,4BAA4B,CAAC,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,kCAAkC,CAAC;IAIjH,wBAAwB,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAIrG,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC;QAAE,UAAU,EAAE,IAAI,EAAE,CAAA;KAAE,CAAC;IAIjE,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,IAAI,EAAE,CAAA;KAAE,CAAC;IAIhE,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,EAAE,CAAA;KAAE,CAAC;IAI3D,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,IAAI,CAAA;KAAE,CAAC;IAI1D,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,IAAI,EAAE,CAAA;KAAE,CAAC;IAI1E,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,IAAI,CAAA;KAAE,CAAC;IAIpE,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAoFnF,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAI7E,gBAAgB,CACpB,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,sBAAsB,CAAC;IA4B5B,qBAAqB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC;QAAE,YAAY,EAAE,IAAI,CAAA;KAAE,CAAC;IAQvF,qBAAqB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAK3F,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAKzF,eAAe,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,CAAC;IAI9D,qBAAqB,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC;QAAE,aAAa,EAAE,IAAI,CAAA;KAAE,CAAC;IAIjE,SAAS,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,eAAe,CAAA;KAAE,CAAC;IAKzD,kBAAkB,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,eAAe,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC;IAIrF,UAAU,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,SAAS,GAAG,SAAS,CAAA;KAAE,CAAC;IAIjE,UAAU,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,uBAAuB,CAAA;KAAE,CAAC;IAKzE,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,sBAAsB;CAO/B"}

package/dist/types/src/wallet/__tests/CachedKeyDeriver.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CachedKeyDeriver.test.d.ts.map

package/dist/types/src/wallet/__tests/CachedKeyDeriver.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CachedKeyDeriver.test.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/__tests/CachedKeyDeriver.test.ts"],"names":[],"mappings":""}

package/dist/types/src/wallet/__tests/KeyDeriver.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=KeyDeriver.test.d.ts.map

package/dist/types/src/wallet/__tests/KeyDeriver.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyDeriver.test.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/__tests/KeyDeriver.test.ts"],"names":[],"mappings":""}

package/dist/types/src/wallet/__tests/ProtoWallet.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ProtoWallet.test.d.ts.map

package/dist/types/src/wallet/__tests/ProtoWallet.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProtoWallet.test.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/__tests/ProtoWallet.test.ts"],"names":[],"mappings":""}

package/dist/types/src/wallet/createActionSdk.d.ts

@@ -0,0 +1,8 @@
+import { Transaction } from "@bsv/sdk";
+import { PendingSignAction } from "./utilityHelpers.js";
+import WalletSigner from './WalletSigner.js';
+import { sdk } from './sdk';
+export declare function createActionSdk(signer: WalletSigner, vargs: sdk.ValidCreateActionArgs): Promise<sdk.CreateActionResult>;
+export declare function completeSignedTransaction(prior: PendingSignAction, spends: Record<number, sdk.SignActionSpend>, signer: WalletSigner): Promise<Transaction>;
+export declare function processActionSdk(prior: PendingSignAction | undefined, signer: WalletSigner, vargs: sdk.ValidProcessActionArgs): Promise<sdk.SendWithResult[] | undefined>;
+//# sourceMappingURL=createActionSdk.d.ts.map

package/dist/types/src/wallet/createActionSdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createActionSdk.d.ts","sourceRoot":"","sources":["../../../../src/wallet/createActionSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,WAAW,EAAoB,MAAM,UAAU,CAAA;AAChE,OAAO,EAAkC,iBAAiB,EAAqC,MAAM,qBAAqB,CAAA;AAC1H,OAAO,YAAY,MAAM,mBAAmB,CAAA;AAE5C,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAE3B,wBAAsB,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,CAAC,qBAAqB,GACtF,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAuBpC;AAqDD,wBAAsB,yBAAyB,CAC3C,KAAK,EAAE,iBAAiB,EACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,eAAe,CAAC,EAC3C,MAAM,EAAE,YAAY,GAElB,OAAO,CAAC,WAAW,CAAC,CA+CzB;AAkBD,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,iBAAiB,GAAG,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,CAAC,sBAAsB,GAC9H,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,SAAS,CAAC,CAe9C"}

package/dist/types/src/wallet/sdk/CachedKeyDeriver.d.ts

@@ -0,0 +1,94 @@
+import { PrivateKey, PublicKey, SymmetricKey } from '@bsv/sdk';
+import { Counterparty } from './KeyDeriver';
+import { WalletProtocol } from './Wallet.interfaces';
+/**
+ * A cached version of KeyDeriver that caches the results of key derivation methods.
+ * This is useful for optimizing performance when the same keys are derived multiple times.
+ * It supports configurable cache size with sane defaults and maintains cache entries using LRU (Least Recently Used) eviction policy.
+ */
+export default class CachedKeyDeriver {
+    private readonly keyDeriver;
+    private readonly cache;
+    private readonly maxCacheSize;
+    /**
+       * Initializes the CachedKeyDeriver instance with a root private key and optional cache settings.
+       * @param {PrivateKey | 'anyone'} rootKey - The root private key or the string 'anyone'.
+       * @param {Object} [options] - Optional settings for the cache.
+       * @param {number} [options.maxCacheSize=1000] - The maximum number of entries to store in the cache.
+       */
+    constructor(rootKey: PrivateKey | 'anyone', options?: {
+        maxCacheSize?: number;
+    });
+    /**
+       * Derives a public key based on protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {boolean} [forSelf=false] - Whether deriving for self.
+       * @returns {PublicKey} - The derived public key.
+       */
+    derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf?: boolean): PublicKey;
+    /**
+       * Derives a private key based on protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PrivateKey} - The derived private key.
+       */
+    derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey;
+    /**
+       * Derives a symmetric key based on protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {SymmetricKey} - The derived symmetric key.
+       * @throws {Error} - Throws an error if attempting to derive a symmetric key for 'anyone'.
+       */
+    deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey;
+    /**
+       * Reveals the shared secret between the root key and the counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {number[]} - The shared secret as a number array.
+       * @throws {Error} - Throws an error if attempting to reveal a shared secret for 'self'.
+       */
+    revealCounterpartySecret(counterparty: Counterparty): number[];
+    /**
+       * Reveals the specific key association for a given protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {number[]} - The specific key association as a number array.
+       */
+    revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[];
+    /**
+       * Generates a unique cache key based on the method name and input parameters.
+       * @param {string} methodName - The name of the method.
+       * @param {...any} args - The arguments passed to the method.
+       * @returns {string} - The generated cache key.
+       */
+    private generateCacheKey;
+    /**
+       * Serializes an argument to a string for use in a cache key.
+       * @param {any} arg - The argument to serialize.
+       * @returns {string} - The serialized argument.
+       */
+    private serializeArgument;
+    /**
+       * Retrieves an item from the cache and updates its position to reflect recent use.
+       * @param {string} cacheKey - The key of the cached item.
+       * @returns {any} - The cached value.
+       */
+    private cacheGet;
+    /**
+       * Adds an item to the cache and evicts the least recently used item if necessary.
+       * @param {string} cacheKey - The key of the item to cache.
+       * @param {any} value - The value to cache.
+       */
+    private cacheSet;
+}
+//# sourceMappingURL=CachedKeyDeriver.d.ts.map

package/dist/types/src/wallet/sdk/CachedKeyDeriver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CachedKeyDeriver.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/sdk/CachedKeyDeriver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC9D,OAAO,EAAE,YAAY,EAAc,MAAM,cAAc,CAAA;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEpD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAkB;IACxC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;IAErC;;;;;SAKK;gBACQ,OAAO,EAAE,UAAU,GAAG,QAAQ,EAAE,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE;IAOhF;;;;;;;;SAQK;IACL,eAAe,CACb,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,YAAY,EAC1B,OAAO,GAAE,OAAe,GACvB,SAAS;IAWZ;;;;;;;SAOK;IACL,gBAAgB,CACd,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,YAAY,GACzB,UAAU;IAWb;;;;;;;;SAQK;IACL,kBAAkB,CAChB,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,YAAY,GACzB,YAAY;IAWf;;;;;;SAMK;IACL,wBAAwB,CAAE,YAAY,EAAE,YAAY,GAAG,MAAM,EAAE;IAW/D;;;;;;;SAOK;IACL,oBAAoB,CAClB,YAAY,EAAE,YAAY,EAC1B,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,MAAM,GACZ,MAAM,EAAE;IAWX;;;;;SAKK;IACL,OAAO,CAAC,gBAAgB;IAKxB;;;;SAIK;IACL,OAAO,CAAC,iBAAiB;IAYzB;;;;SAIK;IACL,OAAO,CAAC,QAAQ;IAQhB;;;;SAIK;IACL,OAAO,CAAC,QAAQ;CAQjB"}

package/dist/types/src/wallet/sdk/CertOps.d.ts

@@ -0,0 +1,63 @@
+import { sdk } from '..';
+import { Certificate } from './Certificate';
+export declare class CertOps extends Certificate {
+    wallet: sdk.WalletCrypto;
+    _keyring?: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
+    _encryptedFields?: Record<sdk.CertificateFieldNameUnder50Bytes, sdk.Base64String>;
+    _decryptedFields?: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
+    constructor(wallet: sdk.WalletCrypto, wc: sdk.WalletCertificate);
+    static fromCounterparty(wallet: sdk.WalletCrypto, e: {
+        certificate: sdk.WalletCertificate;
+        keyring: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
+        counterparty: sdk.PubKeyHex;
+    }): Promise<CertOps>;
+    static fromCertifier(wallet: sdk.WalletCrypto, e: {
+        certificate: sdk.WalletCertificate;
+        keyring: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
+    }): Promise<CertOps>;
+    static fromEncrypted(wallet: sdk.WalletCrypto, wc: sdk.WalletCertificate, keyring: Record<sdk.CertificateFieldNameUnder50Bytes, string>): Promise<CertOps>;
+    static fromDecrypted(wallet: sdk.WalletCrypto, wc: sdk.WalletCertificate): Promise<CertOps>;
+    static copyFields<T>(fields: Record<sdk.CertificateFieldNameUnder50Bytes, T>): Record<sdk.CertificateFieldNameUnder50Bytes, T>;
+    static getProtocolForCertificateFieldEncryption(serialNumber: string, fieldName: string): {
+        protocolID: sdk.WalletProtocol;
+        keyID: string;
+    };
+    exportForSubject(): {
+        certificate: sdk.WalletCertificate;
+        keyring: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
+    };
+    toWalletCertificate(): sdk.WalletCertificate;
+    encryptFields(counterparty?: 'self' | sdk.PubKeyHex): Promise<{
+        fields: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
+        keyring: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
+    }>;
+    decryptFields(counterparty?: sdk.PubKeyHex, keyring?: Record<sdk.CertificateFieldNameUnder50Bytes, string>): Promise<Record<sdk.CertificateFieldNameUnder50Bytes, string>>;
+    exportForCounterparty(
+    /** The incoming counterparty is who they are to us. */
+    counterparty: sdk.PubKeyHex, fieldsToReveal: sdk.CertificateFieldNameUnder50Bytes[]): Promise<{
+        certificate: sdk.WalletCertificate;
+        keyring: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
+        counterparty: sdk.PubKeyHex;
+    }>;
+    /**
+    * Creates a verifiable certificate structure for a specific verifier, allowing them access to specified fields.
+    * This method decrypts the master field keys for each field specified in `fieldsToReveal` and re-encrypts them
+    * for the verifier's identity key. The resulting certificate structure includes only the fields intended to be
+    * revealed and a verifier-specific keyring for field decryption.
+    *
+    * @param {sdk.PubKeyHex} verifierIdentityKey - The public identity key of the verifier who will receive access to the specified fields.
+    * @param {sdk.CertificateFieldNameUnder50Bytes[]} fieldsToReveal - An array of field names to be revealed to the verifier. Must be a subset of the certificate's fields.
+    * @param {sdk.OriginatorDomainNameStringUnder250Bytes} [originator] - Optional originator identifier, used if additional context is needed for decryption and encryption operations.
+    * @returns {Promise<Record<sdk.CertificateFieldNameUnder50Bytes[], sdk.Base64String>} - A new certificate structure containing the original encrypted fields, the verifier-specific field decryption keyring, and essential certificate metadata.
+    * @throws {WERR_INVALID_PARAMETER} Throws an error if:
+    *   - fieldsToReveal is empty or a field in `fieldsToReveal` does not exist in the certificate.
+    *   - The decrypted master field key fails to decrypt the corresponding field (indicating an invalid key).
+    */
+    createKeyringForVerifier(verifierIdentityKey: sdk.PubKeyHex, fieldsToReveal: sdk.CertificateFieldNameUnder50Bytes[], originator?: sdk.OriginatorDomainNameStringUnder250Bytes): Promise<Record<sdk.CertificateFieldNameUnder50Bytes, sdk.Base64String>>;
+    /**
+     * encrypt plaintext field values for the subject
+     * update the signature using the certifier's private key.
+     */
+    encryptAndSignNewCertificate(): Promise<void>;
+}
+//# sourceMappingURL=CertOps.d.ts.map

package/dist/types/src/wallet/sdk/CertOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CertOps.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/sdk/CertOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,IAAI,CAAA;AAExB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,qBAAa,OAAQ,SAAQ,WAAW;IAMzB,MAAM,EAAE,GAAG,CAAC,YAAY;IALnC,QAAQ,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAA;IAC/D,gBAAgB,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAA;IACjF,gBAAgB,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAA;gBAG5D,MAAM,EAAE,GAAG,CAAC,YAAY,EAC/B,EAAE,EAAE,GAAG,CAAC,iBAAiB;WAKhB,gBAAgB,CACzB,MAAM,EAAE,GAAG,CAAC,YAAY,EACxB,CAAC,EAAE;QACC,WAAW,EAAE,GAAG,CAAC,iBAAiB,CAAC;QACnC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;QAC9D,YAAY,EAAE,GAAG,CAAC,SAAS,CAAA;KAC9B,GAEH,OAAO,CAAC,OAAO,CAAC;WAWL,aAAa,CACtB,MAAM,EAAE,GAAG,CAAC,YAAY,EACxB,CAAC,EAAE;QAAE,WAAW,EAAE,GAAG,CAAC,iBAAiB,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAA;KAAE,GAE1G,OAAO,CAAC,OAAO,CAAC;WAKL,aAAa,CACtB,MAAM,EAAE,GAAG,CAAC,YAAY,EACxB,EAAE,EAAE,GAAG,CAAC,iBAAiB,EACzB,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,GAE/D,OAAO,CAAC,OAAO,CAAC;WAUL,aAAa,CACtB,MAAM,EAAE,GAAG,CAAC,YAAY,EACxB,EAAE,EAAE,GAAG,CAAC,iBAAiB,GACzB,OAAO,CAAC,OAAO,CAAC;IAQpB,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,CAAC,CAAC,GAAI,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,CAAC,CAAC;IAO/H,MAAM,CAAC,wCAAwC,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GACrF;QAAE,UAAU,EAAE,GAAG,CAAC,cAAc,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE;IAKnD,gBAAgB,IAAK;QAAE,WAAW,EAAE,GAAG,CAAC,iBAAiB,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAA;KAAE;IAS1H,mBAAmB,IAAK,GAAG,CAAC,iBAAiB;IAQvC,aAAa,CAAC,YAAY,GAAE,MAAM,GAAG,GAAG,CAAC,SAAkB,GAC/D,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAA;KAAC,CAAC;IAwBnI,aAAa,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;IA4B1K,qBAAqB;IACvB,uDAAuD;IACvD,YAAY,EAAE,GAAG,CAAC,SAAS,EAC3B,cAAc,EAAE,GAAG,CAAC,gCAAgC,EAAE,GAExD,OAAO,CAAC;QACN,WAAW,EAAE,GAAG,CAAC,iBAAiB,CAAC;QACnC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;QAC9D,YAAY,EAAE,GAAG,CAAC,SAAS,CAAA;KAC9B,CAAC;IAUF;;;;;;;;;;;;;MAaE;IACI,wBAAwB,CAC1B,mBAAmB,EAAE,GAAG,CAAC,SAAS,EAClC,cAAc,EAAE,GAAG,CAAC,gCAAgC,EAAE,EACtD,UAAU,CAAC,EAAE,GAAG,CAAC,uCAAuC,GAE1D,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;IAyCzE;;;OAGG;IACG,4BAA4B,IAAK,OAAO,CAAC,IAAI,CAAC;CASvD"}

package/dist/types/src/wallet/sdk/Certificate.d.ts

@@ -0,0 +1,77 @@
+import { Base64String, CertificateFieldNameUnder50Bytes, HexString, OutpointString, PubKeyHex } from "./Wallet.interfaces";
+import { WalletCrypto } from "./WalletCrypto";
+/**
+ * Represents an Identity Certificate as per the Wallet interface specifications.
+ *
+ * This class provides methods to serialize and deserialize certificates, as well as signing and verifying the certificate's signature.
+ */
+export declare class Certificate {
+    /**
+     * Type identifier for the certificate, base64 encoded string, 32 bytes.
+     */
+    type: Base64String;
+    /**
+     * Unique serial number of the certificate, base64 encoded string, 32 bytes.
+     */
+    serialNumber: Base64String;
+    /**
+     * The public key belonging to the certificate's subject, compressed public key hex string.
+     */
+    subject: PubKeyHex;
+    /**
+     * Public key of the certifier who issued the certificate, compressed public key hex string.
+     */
+    certifier: PubKeyHex;
+    /**
+     * The outpoint used to confirm that the certificate has not been revoked (TXID.OutputIndex), as a string.
+     */
+    revocationOutpoint: OutpointString;
+    /**
+     * All the fields present in the certificate, with field names as keys and field values as strings.
+     */
+    fields: Record<CertificateFieldNameUnder50Bytes, string>;
+    /**
+     * Certificate signature by the certifier's private key, DER encoded hex string.
+    */
+    signature?: HexString;
+    /**
+     * Constructs a new Certificate.
+     *
+     * @param {Base64String} type - Type identifier for the certificate, base64 encoded string, 32 bytes.
+     * @param {Base64String} serialNumber - Unique serial number of the certificate, base64 encoded string, 32 bytes.
+     * @param {PubKeyHex} subject - The public key belonging to the certificate's subject, compressed public key hex string.
+     * @param {PubKeyHex} certifier - Public key of the certifier who issued the certificate, compressed public key hex string.
+     * @param {OutpointString} revocationOutpoint - The outpoint used to confirm that the certificate has not been revoked (TXID.OutputIndex), as a string.
+     * @param {Record<CertificateFieldNameUnder50Bytes, string>} fields - All the fields present in the certificate.
+     * @param {HexString} signature - Certificate signature by the certifier's private key, DER encoded hex string.
+     */
+    constructor(type: Base64String, serialNumber: Base64String, subject: PubKeyHex, certifier: PubKeyHex, revocationOutpoint: OutpointString, fields: Record<CertificateFieldNameUnder50Bytes, string>, signature?: HexString);
+    /**
+     * Serializes the certificate into binary format, with or without a signature.
+     *
+     * @param {boolean} [includeSignature=true] - Whether to include the signature in the serialization.
+     * @returns {number[]} - The serialized certificate in binary format.
+     */
+    toBin(includeSignature?: boolean): number[];
+    /**
+     * Deserializes a certificate from binary format.
+     *
+     * @param {number[]} bin - The binary data representing the certificate.
+     * @returns {Certificate} - The deserialized Certificate object.
+     */
+    static fromBin(bin: number[]): Certificate;
+    /**
+     * Verifies the certificate's signature.
+     *
+     * @returns {Promise<boolean>} - A promise that resolves to true if the signature is valid.
+     */
+    verify(): Promise<boolean>;
+    /**
+     * Signs the certificate using the provided certifier wallet.
+     *
+     * @param {Wallet} certifier - The wallet representing the certifier.
+     * @returns {Promise<void>}
+     */
+    sign(certifier: WalletCrypto): Promise<void>;
+}
+//# sourceMappingURL=Certificate.d.ts.map

package/dist/types/src/wallet/sdk/Certificate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Certificate.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/sdk/Certificate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,gCAAgC,EAAE,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC1H,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAG7C;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;OAEG;IACH,IAAI,EAAE,YAAY,CAAA;IAElB;;OAEG;IACH,YAAY,EAAE,YAAY,CAAA;IAE1B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,kBAAkB,EAAE,cAAc,CAAA;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAA;IAExD;;MAEE;IACF,SAAS,CAAC,EAAE,SAAS,CAAA;IAErB;;;;;;;;;;OAUG;gBAED,IAAI,EAAE,YAAY,EAClB,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,SAAS,EAClB,SAAS,EAAE,SAAS,EACpB,kBAAkB,EAAE,cAAc,EAClC,MAAM,EAAE,MAAM,CAAC,gCAAgC,EAAE,MAAM,CAAC,EACxD,SAAS,CAAC,EAAE,SAAS;IAWvB;;;;;OAKG;IACH,KAAK,CAAE,gBAAgB,GAAE,OAAc,GAAG,MAAM,EAAE;IAkDlD;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,WAAW;IA6D3C;;;;OAIG;IACG,MAAM,IAAK,OAAO,CAAC,OAAO,CAAC;IAejC;;;;;OAKG;IACG,IAAI,CAAE,SAAS,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;CASpD"}

package/dist/types/src/wallet/sdk/KeyDeriver.d.ts

@@ -0,0 +1,128 @@
+import { PrivateKey, PublicKey, SymmetricKey, PubKeyHex } from '@bsv/sdk';
+import { WalletProtocol } from './Wallet.interfaces';
+export type Counterparty = PublicKey | PubKeyHex | 'self' | 'anyone';
+export interface KeyDeriverApi {
+    /**
+     * The root key from which all other keys are derived.
+     */
+    rootKey: PrivateKey;
+    /**
+     * The identity of this key deriver which is normally the public key associated with the `rootKey`
+     */
+    identityKey: string;
+    /**
+       * Derives a public key based on protocol ID, key ID, and counterparty.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {boolean} [forSelf=false] - Optional. false if undefined. Whether deriving for self.
+       * @returns {PublicKey} - The derived public key.
+       */
+    derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf?: boolean): PublicKey;
+    /**
+       * Derives a private key based on protocol ID, key ID, and counterparty.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PrivateKey} - The derived private key.
+       */
+    derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey;
+    /**
+       * Derives a symmetric key based on protocol ID, key ID, and counterparty.
+       * Note: Symmetric keys should not be derivable by everyone due to security risks.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {SymmetricKey} - The derived symmetric key.
+       * @throws {Error} - Throws an error if attempting to derive a symmetric key for 'anyone'.
+       */
+    deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey;
+    /**
+       * Reveals the shared secret between the root key and the counterparty.
+       * Note: This should not be used for 'self'.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {number[]} - The shared secret as a number array.
+       * @throws {Error} - Throws an error if attempting to reveal a shared secret for 'self'.
+       */
+    revealCounterpartySecret(counterparty: Counterparty): number[];
+    /**
+       * Reveals the specific key association for a given protocol ID, key ID, and counterparty.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {number[]} - The specific key association as a number array.
+       */
+    revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[];
+}
+/**
+ * Class responsible for deriving various types of keys using a root private key.
+ * It supports deriving public and private keys, symmetric keys, and revealing key linkages.
+ */
+export declare class KeyDeriver implements KeyDeriverApi {
+    rootKey: PrivateKey;
+    identityKey: string;
+    /**
+       * Initializes the KeyDeriver instance with a root private key.
+       * @param {PrivateKey | 'anyone'} rootKey - The root private key or the string 'anyone'.
+       */
+    constructor(rootKey: PrivateKey | 'anyone');
+    /**
+       * Derives a public key based on protocol ID, key ID, and counterparty.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {boolean} [forSelf=false] - Whether deriving for self.
+       * @returns {PublicKey} - The derived public key.
+       */
+    derivePublicKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty, forSelf?: boolean): PublicKey;
+    /**
+       * Derives a private key based on protocol ID, key ID, and counterparty.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PrivateKey} - The derived private key.
+       */
+    derivePrivateKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): PrivateKey;
+    /**
+       * Derives a symmetric key based on protocol ID, key ID, and counterparty.
+       * Note: Symmetric keys should not be derivable by everyone due to security risks.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {SymmetricKey} - The derived symmetric key.
+       * @throws {Error} - Throws an error if attempting to derive a symmetric key for 'anyone'.
+       */
+    deriveSymmetricKey(protocolID: WalletProtocol, keyID: string, counterparty: Counterparty): SymmetricKey;
+    /**
+       * Reveals the shared secret between the root key and the counterparty.
+       * Note: This should not be used for 'self'.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {number[]} - The shared secret as a number array.
+       * @throws {Error} - Throws an error if attempting to reveal a shared secret for 'self'.
+       */
+    revealCounterpartySecret(counterparty: Counterparty): number[];
+    /**
+       * Reveals the specific key association for a given protocol ID, key ID, and counterparty.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {number[]} - The specific key association as a number array.
+       */
+    revealSpecificSecret(counterparty: Counterparty, protocolID: WalletProtocol, keyID: string): number[];
+    /**
+       * Normalizes the counterparty to a public key.
+       * @param {Counterparty} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PublicKey} - The normalized counterparty public key.
+       * @throws {Error} - Throws an error if the counterparty is invalid.
+       */
+    private normalizeCounterparty;
+    /**
+       * Computes the invoice number based on the protocol ID and key ID.
+       * @param {WalletProtocol} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {string} - The computed invoice number.
+       * @throws {Error} - Throws an error if protocol ID or key ID are invalid.
+       */
+    private computeInvoiceNumber;
+}
+//# sourceMappingURL=KeyDeriver.d.ts.map

package/dist/types/src/wallet/sdk/KeyDeriver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyDeriver.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/sdk/KeyDeriver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAe,SAAS,EAAE,MAAM,UAAU,CAAA;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEpD,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEpE,MAAM,WAAW,aAAa;IAE5B;;OAEG;IACH,OAAO,EAAE,UAAU,CAAA;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;;;;;;SAOK;IACL,eAAe,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAEpH;;;;;;SAMK;IACL,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,UAAU,CAAA;IAEnG;;;;;;;;SAQK;IACL,kBAAkB,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,YAAY,CAAA;IAEvG;;;;;;SAMK;IACL,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,EAAE,CAAA;IAE9D;;;;;;SAMK;IACL,oBAAoB,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACtG;AAED;;;GAGG;AACH,qBAAa,UAAW,YAAW,aAAa;IAC9C,OAAO,EAAE,UAAU,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IAEnB;;;SAGK;gBACO,OAAO,EAAE,UAAU,GAAG,QAAQ;IAS1C;;;;;;;SAOK;IACL,eAAe,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,GAAE,OAAe,GAAG,SAAS;IAS3H;;;;;;SAMK;IACL,gBAAgB,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,UAAU;IAKnG;;;;;;;;SAQK;IACL,kBAAkB,CAAC,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,YAAY;IAYvG;;;;;;SAMK;IACL,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,EAAE;IAkB9D;;;;;;SAMK;IACL,oBAAoB,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE;IAOrG;;;;;SAKK;IACL,OAAO,CAAC,qBAAqB;IAc7B;;;;;;SAMK;IACL,OAAO,CAAC,oBAAoB;CAwC7B"}

package/dist/types/src/wallet/sdk/ProtoWallet.d.ts

@@ -0,0 +1,30 @@
+import { KeyDeriverApi } from './KeyDeriver';
+import { PrivateKey } from '@bsv/sdk';
+import { WalletCrypto } from './WalletCrypto';
+import { AbortActionArgs, AcquireCertificateArgs, CreateActionArgs, InternalizeActionArgs, ListActionsArgs, ListCertificatesArgs, ListOutputsArgs, ProveCertificateArgs, SignActionArgs, AbortActionResult, AcquireCertificateResult, AuthenticatedResult, CreateActionResult, DiscoverByAttributesArgs, DiscoverByIdentityKeyArgs, DiscoverCertificatesResult, GetHeaderArgs, GetHeaderResult, GetHeightResult, GetNetworkResult, GetVersionResult, InternalizeActionResult, ListActionsResult, ListCertificatesResult, ListOutputsResult, OriginatorDomainNameStringUnder250Bytes, ProveCertificateResult, RelinquishCertificateArgs, RelinquishCertificateResult, RelinquishOutputArgs, RelinquishOutputResult, SignActionResult, Wallet } from './Wallet.interfaces';
+/**
+ * A ProtoWallet is a structure that fulfills the Wallet interface, capable of performing all foundational cryptographic operations. It can derive keys, create signatures, facilitate encryption and HMAC operations, and reveal key linkages. However, ProtoWallet does not create transactions, manage outputs, interact with the blockchain, enable the management of identity certificates, or store any data.
+ */
+export declare class ProtoWallet extends WalletCrypto implements Wallet {
+    constructor(rootKeyOrKeyDeriver: PrivateKey | 'anyone' | KeyDeriverApi);
+    isAuthenticated(args: {}, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AuthenticatedResult>;
+    waitForAuthentication(args: {}, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AuthenticatedResult>;
+    getNetwork(args: {}, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetNetworkResult>;
+    getVersion(args: {}, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetVersionResult>;
+    createAction(args: CreateActionArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<CreateActionResult>;
+    signAction(args: SignActionArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<SignActionResult>;
+    abortAction(args: AbortActionArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AbortActionResult>;
+    listActions(args: ListActionsArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListActionsResult>;
+    internalizeAction(args: InternalizeActionArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<InternalizeActionResult>;
+    listOutputs(args: ListOutputsArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListOutputsResult>;
+    relinquishOutput(args: RelinquishOutputArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<RelinquishOutputResult>;
+    acquireCertificate(args: AcquireCertificateArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AcquireCertificateResult>;
+    listCertificates(args: ListCertificatesArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListCertificatesResult>;
+    proveCertificate(args: ProveCertificateArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ProveCertificateResult>;
+    relinquishCertificate(args: RelinquishCertificateArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<RelinquishCertificateResult>;
+    discoverByIdentityKey(args: DiscoverByIdentityKeyArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<DiscoverCertificatesResult>;
+    discoverByAttributes(args: DiscoverByAttributesArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<DiscoverCertificatesResult>;
+    getHeight(args: {}, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetHeightResult>;
+    getHeaderForHeight(args: GetHeaderArgs, Originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetHeaderResult>;
+}
+//# sourceMappingURL=ProtoWallet.d.ts.map

package/dist/types/src/wallet/sdk/ProtoWallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProtoWallet.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/sdk/ProtoWallet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,aAAa,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,eAAe,EAAE,oBAAoB,EAAE,eAAe,EAAE,oBAAoB,EAAE,cAAc,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,uCAAuC,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,2BAA2B,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAExuB;;GAEG;AACH,qBAAa,WAAY,SAAQ,YAAa,YAAW,MAAM;gBAEjD,mBAAmB,EAAE,UAAU,GAAG,QAAQ,GAAG,aAAa;IAOhE,eAAe,CAAC,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAI7G,qBAAqB,CAAC,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAInH,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIrG,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIrG,YAAY,CAAC,IAAI,EAAE,gBAAgB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIvH,UAAU,CAAC,IAAI,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIjH,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIpH,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIpH,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAItI,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIpH,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAInI,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAIzI,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAInI,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAInI,qBAAqB,CAAC,IAAI,EAAE,yBAAyB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAIlJ,qBAAqB,CAAC,IAAI,EAAE,yBAAyB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAIjJ,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAI/I,SAAS,CAAC,IAAI,EAAE,EAAE,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,eAAe,CAAC;IAInG,kBAAkB,CAAC,IAAI,EAAE,aAAa,EAAE,UAAU,CAAC,EAAE,uCAAuC,GAAG,OAAO,CAAC,eAAe,CAAC;CAG9H"}