@sidhujag/sysweb3-keyring 1.0.624 → 1.0.626

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sidhujag/sysweb3-keyring",
-  "version": "1.0.624",
+  "version": "1.0.626",
   "description": "Keyring Manager for UTXO and Web3 Wallets",
   "main": "cjs/index.js",
   "types": "types/index.d.ts",

package/types/index.d.ts

@@ -4,6 +4,8 @@ export * from './storage';
 export * from './signers';
 export * from './initial-state';
 export * from './keyring-manager';
+export { MAX_PRIVATE_RECORD_BYTES, MAX_PRIVATE_RECORD_LABEL_BYTES, } from './private-records';
+export type { IDecryptPrivateRecordParams, IEncryptedPrivateRecord, IEncryptPrivateRecordParams, } from './private-records';
 export * from './providers';
 export * from './utils/derivation-paths';
 export * from './network-utils';

package/types/keyring-manager.d.ts

@@ -1,6 +1,7 @@
 import { INetwork, INetworkType } from '@sidhujag/sysweb3-network';
 import { HardwareWalletManager } from './hardware-wallet-manager';
 import { LedgerKeyring } from './ledger';
+import { IDecryptPrivateRecordParams, IEncryptedPrivateRecord, IEncryptPrivateRecordParams } from './private-records';
 import { SyscoinHDSigner } from './signers';
 import { TrezorKeyring } from './trezor';
 import { IKeyringAccountState, ICreateSmartAccountParams, ISyscoinTransactions, KeyringAccountType, IEthereumTransactions, IKeyringManager } from './types';
@@ -39,6 +40,7 @@ export declare class KeyringManager implements IKeyringManager {
     private accountAddressExists;
     private sessionPassword;
     private sessionMnemonic;
+    private privateRecordSessionRevision;
     /**
      * @param sharedHardwareWalletManager Optional shared HardwareWalletManager instance.
      *                                     If not provided, the singleton instance will be used.
@@ -79,7 +81,7 @@ export declare class KeyringManager implements IKeyringManager {
     private isDescriptor;
     private isXpubLike;
     private isWatchOnlyAccount;
-    getEncryptedXprv: (hd: SyscoinHDSigner) => string;
+    getEncryptedXprv: (hd: SyscoinHDSigner) => any;
     getSeed: (pwd: string) => Promise<any>;
     deriveSLHDSASetupSecretForAccount: ({ accountIndex, }: {
         accountIndex: number;
@@ -89,6 +91,12 @@ export declare class KeyringManager implements IKeyringManager {
     }>;
     encryptSLHDSASessionState: (plainText: string) => string;
     decryptSLHDSASessionState: (cipherText: string) => string;
+    private privateRecordSession;
+    /** Stable local profile identifier; never an account address or a key. */
+    getPrivateRecordProfileId(): Promise<string>;
+    /** Encrypt caller-owned bytes; persistence and encrypted backup belong to the caller. */
+    encryptPrivateRecord(params: IEncryptPrivateRecordParams): Promise<IEncryptedPrivateRecord>;
+    decryptPrivateRecord(params: IDecryptPrivateRecordParams): Promise<Uint8Array>;
     setSignerNetwork: (network: INetwork) => Promise<{
         activeChain?: INetworkType;
         success: boolean;

package/types/private-records.d.ts

@@ -0,0 +1,26 @@
+/** Versioned, public envelope. Application metadata belongs inside the plaintext. */
+export interface IEncryptedPrivateRecord {
+    ciphertext: string;
+    domain: string;
+    nonce: string;
+    profileId: string;
+    recordId: string;
+    version: 1;
+}
+export interface IEncryptPrivateRecordParams {
+    domain: string;
+    plaintext: Uint8Array;
+    recordId: string;
+}
+export interface IDecryptPrivateRecordParams {
+    domain: string;
+    envelope: IEncryptedPrivateRecord;
+    recordId: string;
+}
+export declare const MAX_PRIVATE_RECORD_BYTES: number;
+export declare const MAX_PRIVATE_RECORD_LABEL_BYTES = 128;
+type Guard = () => void;
+export declare function privateRecordProfileId(secret: Uint8Array, guard: Guard): Promise<string>;
+export declare function encryptPrivateRecordBytes(secret: Uint8Array, params: IEncryptPrivateRecordParams, guard: Guard): Promise<IEncryptedPrivateRecord>;
+export declare function decryptPrivateRecordBytes(secret: Uint8Array, params: IDecryptPrivateRecordParams, guard: Guard): Promise<Uint8Array>;
+export {};

package/types/transactions/ethereum.d.ts

@@ -4,7 +4,7 @@ import { BigNumber, TransactionResponse } from '../ethers-v6';
 import { LedgerKeyring } from '../ledger';
 import { CustomJsonRpcProvider } from '../providers';
 import { TrezorKeyring } from '../trezor';
-import { IResponseFromSendErcSignedTransaction, ISendSignedErcTransactionProps, IEthereumTransactions, IEvmCancellationOptions, IEvmReplacementOptions, SimpleTransactionRequest, KeyringAccountType, accountType, IGasParams } from '../types';
+import { IResponseFromSendErcSignedTransaction, ISendSignedErcTransactionProps, IEthereumTransactions, IEvmCancellationOptions, IEvmReplacementOptions, IEvmSendOptions, SimpleTransactionRequest, KeyringAccountType, accountType, IGasParams } from '../types';
 export declare class EthereumTransactions implements IEthereumTransactions {
     private _web3Provider;
     private _web3ProviderKey?;
@@ -68,7 +68,7 @@ export declare class EthereumTransactions implements IEthereumTransactions {
         isCanceled: boolean;
         transaction?: TransactionResponse;
     }>;
-    sendFormattedTransaction: (params: SimpleTransactionRequest, isLegacy?: boolean) => Promise<any>;
+    sendFormattedTransaction: (params: SimpleTransactionRequest, isLegacy?: boolean, options?: IEvmSendOptions) => Promise<any>;
     private sendFormattedTransactionInternal;
     sendTransactionWithEditedFee: (txHash: string, isLegacy?: boolean, options?: IEvmReplacementOptions) => Promise<{
         maximumFee?: string;

package/types/types.d.ts

@@ -4,6 +4,7 @@ import { ITxid } from '@sidhujag/sysweb3-utils';
 import { CustomJsonRpcProvider } from 'providers';
 import { BigNumber, BigNumberish, BytesLike, TransactionResponse } from './ethers-v6';
 import { LedgerKeyring } from './ledger';
+import { IDecryptPrivateRecordParams, IEncryptedPrivateRecord, IEncryptPrivateRecordParams } from './private-records';
 import { SyscoinHDSigner } from './signers';
 import { TrezorKeyring } from './trezor';
 export type AccessListish = Array<{
@@ -34,6 +35,10 @@ export type EvmLocalAccount = {
     privateKey: string;
     publicKey: string;
 };
+export interface IEvmSendOptions {
+    /** Synchronous host admission, rechecked immediately before signing and broadcast. */
+    assertCurrent?: () => void;
+}
 export interface IEvmReplacementOptions {
     /** Read-only preview; never requests credentials, a device signature or broadcast. */
     previewOnly?: boolean;
@@ -82,7 +87,7 @@ export interface IEthereumTransactions {
     signTypedData: (addr: string, typedData: TypedDataV1 | TypedMessage<any>, version: SignTypedDataVersion) => Promise<string>;
     importAccount: (mnemonicOrPrivKey: string) => EvmLocalAccount;
     parsePersonalMessage: (hexMsg: string) => string;
-    sendFormattedTransaction: (params: SimpleTransactionRequest, isLegacy?: boolean) => Promise<TransactionResponse>;
+    sendFormattedTransaction: (params: SimpleTransactionRequest, isLegacy?: boolean, options?: IEvmSendOptions) => Promise<TransactionResponse>;
     sendSignedErc1155Transaction: ({ receiver, tokenAddress, tokenId, isLegacy, gasPrice, gasLimit, maxFeePerGas, maxPriorityFeePerGas, }: ISendSignedErcTransactionProps) => Promise<IResponseFromSendErcSignedTransaction>;
     verifyPersonalMessage: (msg: string, sign: string) => string;
     toBigNumber: (aBigNumberish: string | number) => BigNumber;
@@ -164,6 +169,9 @@ export interface IKeyringManager {
     syscoinTransaction: ISyscoinTransactions;
     isSeedValid: (seedPhrase: string) => boolean;
     getSeed: (pwd: string) => Promise<string>;
+    getPrivateRecordProfileId: () => Promise<string>;
+    encryptPrivateRecord: (params: IEncryptPrivateRecordParams) => Promise<IEncryptedPrivateRecord>;
+    decryptPrivateRecord: (params: IDecryptPrivateRecordParams) => Promise<Uint8Array>;
     deriveSLHDSASetupSecretForAccount: (params: {
         accountIndex: number;
     }) => Promise<{