@bsv/wallet-toolbox 1.1.0

package/out/src/sdk/WalletServices.interfaces.d.ts

@@ -0,0 +1,325 @@
+import { Beef, Transaction as BsvTransaction, ChainTracker, MerklePath } from '@bsv/sdk';
+import { sdk } from '../index.client';
+import { ChaintracksServiceClient } from '../services/chaintracker';
+/**
+ * Defines standard interfaces to access functionality implemented by external transaction processing services.
+ */
+export interface WalletServices {
+    /**
+     * The chain being serviced.
+     */
+    chain: sdk.Chain;
+    /**
+     * @returns standard `ChainTracker` service which requires `options.chaintracks` be valid.
+     */
+    getChainTracker(): Promise<ChainTracker>;
+    /**
+     * @returns serialized block header for height on active chain
+     * @param height
+     */
+    getHeaderForHeight(height: number): Promise<number[]>;
+    /**
+     * @returns the height of the active chain
+     */
+    getHeight(): Promise<number>;
+    /**
+     * Approximate exchange rate US Dollar / BSV, USD / BSV
+     *
+     * This is the US Dollar price of one BSV
+     */
+    getBsvExchangeRate(): Promise<number>;
+    /**
+     * Approximate exchange rate currency per base.
+     */
+    getFiatExchangeRate(currency: 'USD' | 'GBP' | 'EUR', base?: 'USD' | 'GBP' | 'EUR'): Promise<number>;
+    /**
+     * Attempts to obtain the raw transaction bytes associated with a 32 byte transaction hash (txid).
+     *
+     * Cycles through configured transaction processing services attempting to get a valid response.
+     *
+     * On success:
+     * Result txid is the requested transaction hash
+     * Result rawTx will be an array containing raw transaction bytes.
+     * Result name will be the responding service's identifying name.
+     * Returns result without incrementing active service.
+     *
+     * On failure:
+     * Result txid is the requested transaction hash
+     * Result mapi will be the first mapi response obtained (service name and response), or null
+     * Result error will be the first error thrown (service name and CwiError), or null
+     * Increments to next configured service and tries again until all services have been tried.
+     *
+     * @param txid transaction hash for which raw transaction bytes are requested
+     * @param useNext optional, forces skip to next service before starting service requests cycle.
+     */
+    getRawTx(txid: string, useNext?: boolean): Promise<GetRawTxResult>;
+    /**
+     * Attempts to obtain the merkle proof associated with a 32 byte transaction hash (txid).
+     *
+     * Cycles through configured transaction processing services attempting to get a valid response.
+     *
+     * On success:
+     * Result txid is the requested transaction hash
+     * Result proof will be the merkle proof.
+     * Result name will be the responding service's identifying name.
+     * Returns result without incrementing active service.
+     *
+     * On failure:
+     * Result txid is the requested transaction hash
+     * Result mapi will be the first mapi response obtained (service name and response), or null
+     * Result error will be the first error thrown (service name and CwiError), or null
+     * Increments to next configured service and tries again until all services have been tried.
+     *
+     * @param txid transaction hash for which proof is requested
+     * @param useNext optional, forces skip to next service before starting service requests cycle.
+     */
+    getMerklePath(txid: string, useNext?: boolean): Promise<GetMerklePathResult>;
+    /**
+     *
+     * @param beef
+     * @param txids
+     * @param chain
+     * @returns
+     */
+    postTxs(beef: Beef, txids: string[]): Promise<PostTxsResult[]>;
+    /**
+     *
+     * @param beef
+     * @param txids
+     * @param chain
+     * @returns
+     */
+    postBeef(beef: Beef, txids: string[]): Promise<PostBeefResult[]>;
+    /**
+     * Attempts to determine the UTXO status of a transaction output.
+     *
+     * Cycles through configured transaction processing services attempting to get a valid response.
+     *
+     * @param output transaction output identifier in format determined by `outputFormat`.
+     * @param chain which chain to post to, all of rawTx's inputs must be unspent on this chain.
+     * @param outputFormat optional, supported values:
+     *      'hashLE' little-endian sha256 hash of output script
+     *      'hashBE' big-endian sha256 hash of output script
+     *      'script' entire transaction output script
+     *      undefined if length of `output` is 32 then 'hashBE`, otherwise 'script'.
+     * @param useNext optional, forces skip to next service before starting service requests cycle.
+     */
+    getUtxoStatus(output: string, outputFormat?: GetUtxoStatusOutputFormat, useNext?: boolean): Promise<GetUtxoStatusResult>;
+    /**
+     * @returns a block header
+     * @param hash block hash
+     */
+    hashToHeader(hash: string): Promise<sdk.BlockHeader>;
+    /**
+     * @returns whether the locktime value allows the transaction to be mined at the current chain height
+     * @param txOrLockTime either a bitcoin locktime value or hex, binary, un-encoded Transaction
+     */
+    nLockTimeIsFinal(txOrLockTime: string | number[] | BsvTransaction | number): Promise<boolean>;
+}
+export type GetUtxoStatusOutputFormat = 'hashLE' | 'hashBE' | 'script';
+export interface BsvExchangeRate {
+    timestamp: Date;
+    base: 'USD';
+    rate: number;
+}
+export interface FiatExchangeRates {
+    timestamp: Date;
+    base: 'USD';
+    rates: Record<string, number>;
+}
+export interface WalletServicesOptions {
+    chain: sdk.Chain;
+    taalApiKey?: string;
+    bsvExchangeRate: BsvExchangeRate;
+    bsvUpdateMsecs: number;
+    fiatExchangeRates: FiatExchangeRates;
+    fiatUpdateMsecs: number;
+    disableMapiCallback?: boolean;
+    exchangeratesapiKey?: string;
+    chaintracksFiatExchangeRatesUrl?: string;
+    chaintracks?: ChaintracksServiceClient;
+}
+/**
+ * Properties on result returned from `WalletServices` function `getRawTx`.
+ */
+export interface GetRawTxResult {
+    /**
+     * Transaction hash or rawTx (and of initial request)
+     */
+    txid: string;
+    /**
+     * The name of the service returning the rawTx, or undefined if no rawTx
+     */
+    name?: string;
+    /**
+     * Multiple proofs may be returned when a transaction also appears in
+     * one or more orphaned blocks
+     */
+    rawTx?: number[];
+    /**
+     * The first exception error that occurred during processing, if any.
+     */
+    error?: sdk.WalletError;
+}
+/**
+ * Properties on result returned from `WalletServices` function `getMerkleProof`.
+ */
+export interface GetMerklePathResult {
+    /**
+     * The name of the service returning the proof, or undefined if no proof
+     */
+    name?: string;
+    /**
+     * Multiple proofs may be returned when a transaction also appears in
+     * one or more orphaned blocks
+     */
+    merklePath?: MerklePath;
+    header?: BlockHeader;
+    /**
+     * The first exception error that occurred during processing, if any.
+     */
+    error?: sdk.WalletError;
+}
+export interface PostTxResultForTxid {
+    txid: string;
+    /**
+     * 'success' - The transaction was accepted for processing
+     */
+    status: 'success' | 'error';
+    /**
+     * if true, the transaction was already known to this service. Usually treat as a success.
+     *
+     * Potentially stop posting to additional transaction processors.
+     */
+    alreadyKnown?: boolean;
+    blockHash?: string;
+    blockHeight?: number;
+    merklePath?: MerklePath;
+    data?: object;
+}
+export interface PostBeefResult extends PostTxsResult {
+}
+/**
+ * Properties on array items of result returned from `WalletServices` function `postBeef`.
+ */
+export interface PostTxsResult {
+    /**
+     * The name of the service to which the transaction was submitted for processing
+     */
+    name: string;
+    /**
+     * 'success' all txids returned status of 'success'
+     * 'error' one or more txids returned status of 'error'. See txidResults for details.
+     */
+    status: 'success' | 'error';
+    error?: sdk.WalletError;
+    txidResults: PostTxResultForTxid[];
+    /**
+     * Service response object. Use service name and status to infer type of object.
+     */
+    data?: object;
+}
+export interface GetUtxoStatusDetails {
+    /**
+     * if isUtxo, the block height containing the matching unspent transaction output
+     *
+     * typically there will be only one, but future orphans can result in multiple values
+     */
+    height?: number;
+    /**
+     * if isUtxo, the transaction hash (txid) of the transaction containing the matching unspent transaction output
+     *
+     * typically there will be only one, but future orphans can result in multiple values
+     */
+    txid?: string;
+    /**
+     * if isUtxo, the output index in the transaction containing of the matching unspent transaction output
+     *
+     * typically there will be only one, but future orphans can result in multiple values
+     */
+    index?: number;
+    /**
+     * if isUtxo, the amount of the matching unspent transaction output
+     *
+     * typically there will be only one, but future orphans can result in multiple values
+     */
+    satoshis?: number;
+}
+export interface GetUtxoStatusResult {
+    /**
+     * The name of the service to which the transaction was submitted for processing
+     */
+    name: string;
+    /**
+     * 'success' - the operation was successful, non-error results are valid.
+     * 'error' - the operation failed, error may have relevant information.
+     */
+    status: 'success' | 'error';
+    /**
+     * When status is 'error', provides code and description
+     */
+    error?: sdk.WalletError;
+    /**
+     * true if the output is associated with at least one unspent transaction output
+     */
+    isUtxo?: boolean;
+    /**
+     * Additional details about occurances of this output script as a utxo.
+     *
+     * Normally there will be one item in the array but due to the possibility of orphan races
+     * there could be more than one block in which it is a valid utxo.
+     */
+    details: GetUtxoStatusDetails[];
+}
+/**
+ * These are fields of 80 byte serialized header in order whose double sha256 hash is a block's hash value
+ * and the next block's previousHash value.
+ *
+ * All block hash values and merkleRoot values are 32 byte hex string values with the byte order reversed from the serialized byte order.
+ */
+export interface BaseBlockHeader {
+    /**
+     * Block header version value. Serialized length is 4 bytes.
+     */
+    version: number;
+    /**
+     * Hash of previous block's block header. Serialized length is 32 bytes.
+     */
+    previousHash: string;
+    /**
+     * Root hash of the merkle tree of all transactions in this block. Serialized length is 32 bytes.
+     */
+    merkleRoot: string;
+    /**
+     * Block header time value. Serialized length is 4 bytes.
+     */
+    time: number;
+    /**
+     * Block header bits value. Serialized length is 4 bytes.
+     */
+    bits: number;
+    /**
+     * Block header nonce value. Serialized length is 4 bytes.
+     */
+    nonce: number;
+}
+/**
+ * A `BaseBlockHeader` extended with its computed hash and height in its chain.
+ */
+export interface BlockHeader extends BaseBlockHeader {
+    /**
+     * Height of the header, starting from zero.
+     */
+    height: number;
+    /**
+     * The double sha256 hash of the serialized `BaseBlockHeader` fields.
+     */
+    hash: string;
+}
+export type GetUtxoStatusService = (output: string, chain: sdk.Chain, outputFormat?: GetUtxoStatusOutputFormat) => Promise<GetUtxoStatusResult>;
+export type GetMerklePathService = (txid: string, chain: sdk.Chain, services: WalletServices) => Promise<GetMerklePathResult>;
+export type GetRawTxService = (txid: string, chain: sdk.Chain) => Promise<GetRawTxResult>;
+export type PostTxsService = (beef: Beef, txids: string[], services: WalletServices) => Promise<PostTxsResult>;
+export type PostBeefService = (beef: Beef, txids: string[], services: WalletServices) => Promise<PostBeefResult>;
+export type UpdateFiatExchangeRateService = (targetCurrencies: string[], options: WalletServicesOptions) => Promise<FiatExchangeRates>;
+//# sourceMappingURL=WalletServices.interfaces.d.ts.map

package/out/src/sdk/WalletServices.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WalletServices.interfaces.d.ts","sourceRoot":"","sources":["../../../src/sdk/WalletServices.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,WAAW,IAAI,cAAc,EAC7B,YAAY,EACZ,UAAU,EACX,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAA;AACnE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC,KAAK,CAAA;IAEhB;;OAEG;IACH,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC,CAAA;IAExC;;;OAGG;IACH,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAErD;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IAE5B;;;;OAIG;IACH,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IAErC;;OAEG;IACH,mBAAmB,CACjB,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,EAC/B,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAC3B,OAAO,CAAC,MAAM,CAAC,CAAA;IAElB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAElE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAE5E;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;IAE9D;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAEhE;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAAM,EAAE,MAAM,EACd,YAAY,CAAC,EAAE,yBAAyB,EACxC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAE/B;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IAEpD;;;OAGG;IACH,gBAAgB,CACd,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,cAAc,GAAG,MAAM,GACxD,OAAO,CAAC,OAAO,CAAC,CAAA;CACpB;AAED,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAEtE,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,IAAI,CAAA;IACf,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,IAAI,CAAA;IACf,IAAI,EAAE,KAAK,CAAA;IACX,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,eAAe,EAAE,eAAe,CAAA;IAChC,cAAc,EAAE,MAAM,CAAA;IACtB,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,eAAe,EAAE,MAAM,CAAA;IACvB,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,+BAA+B,CAAC,EAAE,MAAM,CAAA;IACxC,WAAW,CAAC,EAAE,wBAAwB,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC,WAAW,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAA;IAEvB,MAAM,CAAC,EAAE,WAAW,CAAA;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC,WAAW,CAAA;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,OAAO,CAAA;IAE3B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,UAAU,CAAA;IAEvB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,cAAe,SAAQ,aAAa;CAAG;AAExD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,MAAM,EAAE,SAAS,GAAG,OAAO,CAAA;IAE3B,KAAK,CAAC,EAAE,GAAG,CAAC,WAAW,CAAA;IAEvB,WAAW,EAAE,mBAAmB,EAAE,CAAA;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,MAAM,EAAE,SAAS,GAAG,OAAO,CAAA;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC,WAAW,CAAA;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;;;OAKG;IACH,OAAO,EAAE,oBAAoB,EAAE,CAAA;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,oBAAoB,GAAG,CACjC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,GAAG,CAAC,KAAK,EAChB,YAAY,CAAC,EAAE,yBAAyB,KACrC,OAAO,CAAC,mBAAmB,CAAC,CAAA;AAEjC,MAAM,MAAM,oBAAoB,GAAG,CACjC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,GAAG,CAAC,KAAK,EAChB,QAAQ,EAAE,cAAc,KACrB,OAAO,CAAC,mBAAmB,CAAC,CAAA;AAEjC,MAAM,MAAM,eAAe,GAAG,CAC5B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,GAAG,CAAC,KAAK,KACb,OAAO,CAAC,cAAc,CAAC,CAAA;AAE5B,MAAM,MAAM,cAAc,GAAG,CAC3B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,MAAM,EAAE,EACf,QAAQ,EAAE,cAAc,KACrB,OAAO,CAAC,aAAa,CAAC,CAAA;AAE3B,MAAM,MAAM,eAAe,GAAG,CAC5B,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,MAAM,EAAE,EACf,QAAQ,EAAE,cAAc,KACrB,OAAO,CAAC,cAAc,CAAC,CAAA;AAE5B,MAAM,MAAM,6BAA6B,GAAG,CAC1C,gBAAgB,EAAE,MAAM,EAAE,EAC1B,OAAO,EAAE,qBAAqB,KAC3B,OAAO,CAAC,iBAAiB,CAAC,CAAA"}

package/out/src/sdk/WalletServices.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=WalletServices.interfaces.js.map

package/out/src/sdk/WalletServices.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WalletServices.interfaces.js","sourceRoot":"","sources":["../../../src/sdk/WalletServices.interfaces.ts"],"names":[],"mappings":""}

package/out/src/sdk/WalletSigner.interfaces.d.ts

@@ -0,0 +1,10 @@
+import { KeyDeriverApi } from '@bsv/sdk';
+import { sdk } from '../index.client';
+/**
+ */
+export interface WalletSigner {
+    isWalletSigner: true;
+    chain: sdk.Chain;
+    keyDeriver: KeyDeriverApi;
+}
+//# sourceMappingURL=WalletSigner.interfaces.d.ts.map

package/out/src/sdk/WalletSigner.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WalletSigner.interfaces.d.ts","sourceRoot":"","sources":["../../../src/sdk/WalletSigner.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAYL,aAAa,EAed,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAErC;GACG;AACH,MAAM,WAAW,YAAY;IAC3B,cAAc,EAAE,IAAI,CAAA;IAEpB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAA;IAChB,UAAU,EAAE,aAAa,CAAA;CAC1B"}

package/out/src/sdk/WalletSigner.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=WalletSigner.interfaces.js.map

package/out/src/sdk/WalletSigner.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WalletSigner.interfaces.js","sourceRoot":"","sources":["../../../src/sdk/WalletSigner.interfaces.ts"],"names":[],"mappings":""}

package/out/src/sdk/WalletStorage.interfaces.d.ts

@@ -0,0 +1,299 @@
+import { AbortActionArgs, AbortActionResult, Beef, InternalizeActionArgs, InternalizeActionResult, ListActionsArgs, ListActionsResult, ListCertificatesResult, ListOutputsArgs, ListOutputsResult, RelinquishCertificateArgs, RelinquishOutputArgs, SendWithResult } from '@bsv/sdk';
+import { sdk, table } from '../index.client';
+/**
+ * This is the `WalletStorage` interface implemented by a class such as `WalletStorageManager`,
+ * which manges an active and set of backup storage providers.
+ *
+ * Access and conrol is not directly managed. Typically each request is made with an associated identityKey
+ * and it is left to the providers: physical access or remote channel authentication.
+ */
+export interface WalletStorage {
+    /**
+     * @returns false
+     */
+    isStorageProvider(): boolean;
+    isAvailable(): boolean;
+    makeAvailable(): Promise<table.Settings>;
+    migrate(storageName: string, storageIdentityKey: string): Promise<string>;
+    destroy(): Promise<void>;
+    setServices(v: sdk.WalletServices): void;
+    getServices(): sdk.WalletServices;
+    getSettings(): table.Settings;
+    getAuth(): Promise<sdk.AuthId>;
+    findOrInsertUser(identityKey: string): Promise<{
+        user: table.User;
+        isNew: boolean;
+    }>;
+    abortAction(args: AbortActionArgs): Promise<AbortActionResult>;
+    createAction(args: sdk.ValidCreateActionArgs): Promise<sdk.StorageCreateActionResult>;
+    processAction(args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>;
+    internalizeAction(args: InternalizeActionArgs): Promise<InternalizeActionResult>;
+    findCertificates(args: sdk.FindCertificatesArgs): Promise<table.Certificate[]>;
+    findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<table.OutputBasket[]>;
+    findOutputs(args: sdk.FindOutputsArgs): Promise<table.Output[]>;
+    findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<table.ProvenTxReq[]>;
+    listActions(args: ListActionsArgs): Promise<ListActionsResult>;
+    listCertificates(args: sdk.ValidListCertificatesArgs): Promise<ListCertificatesResult>;
+    listOutputs(args: ListOutputsArgs): Promise<ListOutputsResult>;
+    insertCertificate(certificate: table.CertificateX): Promise<number>;
+    relinquishCertificate(args: RelinquishCertificateArgs): Promise<number>;
+    relinquishOutput(args: RelinquishOutputArgs): Promise<number>;
+}
+/**
+ * This is the `WalletStorage` interface implemented with authentication checking and
+ * is the actual minimal interface implemented by storage and remoted storage providers.
+ */
+export interface WalletStorageProvider extends WalletStorageSync {
+    /**
+     * @returns true if this object's interface can be extended to the full `StorageProvider` interface
+     */
+    isStorageProvider(): boolean;
+    setServices(v: sdk.WalletServices): void;
+}
+export interface WalletStorageSync extends WalletStorageWriter {
+    findOrInsertSyncStateAuth(auth: sdk.AuthId, storageIdentityKey: string, storageName: string): Promise<{
+        syncState: table.SyncState;
+        isNew: boolean;
+    }>;
+    setActive(auth: sdk.AuthId, newActiveStorageIdentityKey: string): Promise<number>;
+    getSyncChunk(args: sdk.RequestSyncChunkArgs): Promise<sdk.SyncChunk>;
+    processSyncChunk(args: sdk.RequestSyncChunkArgs, chunk: sdk.SyncChunk): Promise<sdk.ProcessSyncChunkResult>;
+}
+export interface WalletStorageWriter extends WalletStorageReader {
+    makeAvailable(): Promise<table.Settings>;
+    migrate(storageName: string, storageIdentityKey: string): Promise<string>;
+    destroy(): Promise<void>;
+    findOrInsertUser(identityKey: string): Promise<{
+        user: table.User;
+        isNew: boolean;
+    }>;
+    abortAction(auth: sdk.AuthId, args: AbortActionArgs): Promise<AbortActionResult>;
+    createAction(auth: sdk.AuthId, args: sdk.ValidCreateActionArgs): Promise<sdk.StorageCreateActionResult>;
+    processAction(auth: sdk.AuthId, args: sdk.StorageProcessActionArgs): Promise<sdk.StorageProcessActionResults>;
+    internalizeAction(auth: sdk.AuthId, args: InternalizeActionArgs): Promise<InternalizeActionResult>;
+    insertCertificateAuth(auth: sdk.AuthId, certificate: table.CertificateX): Promise<number>;
+    relinquishCertificate(auth: sdk.AuthId, args: RelinquishCertificateArgs): Promise<number>;
+    relinquishOutput(auth: sdk.AuthId, args: RelinquishOutputArgs): Promise<number>;
+}
+export interface WalletStorageReader {
+    isAvailable(): boolean;
+    getServices(): sdk.WalletServices;
+    getSettings(): table.Settings;
+    findCertificatesAuth(auth: sdk.AuthId, args: sdk.FindCertificatesArgs): Promise<table.Certificate[]>;
+    findOutputBasketsAuth(auth: sdk.AuthId, args: sdk.FindOutputBasketsArgs): Promise<table.OutputBasket[]>;
+    findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<table.Output[]>;
+    findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<table.ProvenTxReq[]>;
+    listActions(auth: sdk.AuthId, vargs: sdk.ValidListActionsArgs): Promise<ListActionsResult>;
+    listCertificates(auth: sdk.AuthId, vargs: sdk.ValidListCertificatesArgs): Promise<ListCertificatesResult>;
+    listOutputs(auth: sdk.AuthId, vargs: sdk.ValidListOutputsArgs): Promise<ListOutputsResult>;
+}
+export interface AuthId {
+    identityKey: string;
+    userId?: number;
+    isActive?: boolean;
+}
+export interface FindSincePagedArgs {
+    since?: Date;
+    paged?: sdk.Paged;
+    trx?: sdk.TrxToken;
+}
+export interface FindForUserSincePagedArgs extends FindSincePagedArgs {
+    userId: number;
+}
+export interface FindPartialSincePagedArgs<T extends object> extends FindSincePagedArgs {
+    partial: Partial<T>;
+}
+export interface FindCertificatesArgs extends FindSincePagedArgs {
+    partial: Partial<table.Certificate>;
+    certifiers?: string[];
+    types?: string[];
+    includeFields?: boolean;
+}
+export interface FindOutputBasketsArgs extends FindSincePagedArgs {
+    partial: Partial<table.OutputBasket>;
+}
+export interface FindOutputsArgs extends FindSincePagedArgs {
+    partial: Partial<table.Output>;
+    noScript?: boolean;
+    txStatus?: sdk.TransactionStatus[];
+}
+export type StorageProvidedBy = 'you' | 'storage' | 'you-and-storage';
+export interface StorageCreateTransactionSdkInput {
+    vin: number;
+    sourceTxid: string;
+    sourceVout: number;
+    sourceSatoshis: number;
+    sourceLockingScript: string;
+    unlockingScriptLength: number;
+    providedBy: StorageProvidedBy;
+    type: string;
+    spendingDescription?: string;
+    derivationPrefix?: string;
+    derivationSuffix?: string;
+    senderIdentityKey?: string;
+}
+export interface StorageCreateTransactionSdkOutput extends sdk.ValidCreateActionOutput {
+    vout: number;
+    providedBy: StorageProvidedBy;
+    purpose?: string;
+    derivationSuffix?: string;
+}
+export interface StorageCreateActionResult {
+    inputBeef?: number[];
+    inputs: StorageCreateTransactionSdkInput[];
+    outputs: StorageCreateTransactionSdkOutput[];
+    noSendChangeOutputVouts?: number[];
+    derivationPrefix: string;
+    version: number;
+    lockTime: number;
+    reference: string;
+}
+export interface StorageProcessActionArgs {
+    isNewTx: boolean;
+    isSendWith: boolean;
+    isNoSend: boolean;
+    isDelayed: boolean;
+    reference?: string;
+    txid?: string;
+    rawTx?: number[];
+    sendWith: string[];
+    log?: string;
+}
+export interface StorageProcessActionResults {
+    sendWithResults?: SendWithResult[];
+    log?: string;
+}
+export interface ProvenOrRawTx {
+    proven?: table.ProvenTx;
+    rawTx?: number[];
+    inputBEEF?: number[];
+}
+export interface PurgeParams {
+    purgeCompleted: boolean;
+    purgeFailed: boolean;
+    purgeSpent: boolean;
+    /**
+     * Minimum age in msecs for transient completed transaction data purge.
+     * Default is 14 days.
+     */
+    purgeCompletedAge?: number;
+    /**
+     * Minimum age in msecs for failed transaction data purge.
+     * Default is 14 days.
+     */
+    purgeFailedAge?: number;
+    /**
+     * Minimum age in msecs for failed transaction data purge.
+     * Default is 14 days.
+     */
+    purgeSpentAge?: number;
+}
+export interface PurgeResults {
+    count: number;
+    log: string;
+}
+export interface StorageProvenOrReq {
+    proven?: table.ProvenTx;
+    req?: table.ProvenTxReq;
+}
+/**
+ * Specifies the available options for computing transaction fees.
+ */
+export interface StorageFeeModel {
+    /**
+     * Available models. Currently only "sat/kb" is supported.
+     */
+    model: 'sat/kb';
+    /**
+     * When "fee.model" is "sat/kb", this is an integer representing the number of satoshis per kb of block space
+     * the transaction will pay in fees.
+     *
+     * If undefined, the default value is used.
+     */
+    value?: number;
+}
+export interface StorageGetBeefOptions {
+    /** if 'known', txids known to local storage as valid are included as txidOnly */
+    trustSelf?: 'known';
+    /** list of txids to be included as txidOnly if referenced. Validity is known to caller. */
+    knownTxids?: string[];
+    /** optional. If defined, raw transactions and merkle paths required by txid are merged to this instance and returned. Otherwise a new Beef is constructed and returned. */
+    mergeToBeef?: Beef | number[];
+    /** optional. Default is false. `storage` is used for raw transaction and merkle proof lookup */
+    ignoreStorage?: boolean;
+    /** optional. Default is false. `getServices` is used for raw transaction and merkle proof lookup */
+    ignoreServices?: boolean;
+    /** optional. Default is false. If true, raw transactions with proofs missing from `storage` and obtained from `getServices` are not inserted to `storage`. */
+    ignoreNewProven?: boolean;
+    /** optional. Default is zero. Ignores available merkle paths until recursion detpth equals or exceeds value  */
+    minProofLevel?: number;
+}
+export interface StorageSyncReaderOptions {
+    chain: sdk.Chain;
+}
+export interface FindCertificateFieldsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.CertificateField>;
+}
+export interface FindCommissionsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.Commission>;
+}
+export interface FindOutputTagMapsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.OutputTagMap>;
+    tagIds?: number[];
+}
+export interface FindOutputTagsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.OutputTag>;
+}
+export interface FindProvenTxReqsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.ProvenTxReq>;
+    status?: sdk.ProvenTxReqStatus[];
+    txids?: string[];
+}
+export interface FindProvenTxsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.ProvenTx>;
+}
+export interface FindSyncStatesArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.SyncState>;
+}
+export interface FindTransactionsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.Transaction>;
+    status?: sdk.TransactionStatus[];
+    noRawTx?: boolean;
+}
+export interface FindTxLabelMapsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.TxLabelMap>;
+    labelIds?: number[];
+}
+export interface FindTxLabelsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.TxLabel>;
+}
+export interface FindUsersArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.User>;
+}
+export interface FindMonitorEventsArgs extends sdk.FindSincePagedArgs {
+    partial: Partial<table.MonitorEvent>;
+}
+/**
+ * Place holder for the transaction control object used by actual storage provider implementation.
+ */
+export interface TrxToken {
+}
+export interface UpdateProvenTxReqWithNewProvenTxArgs {
+    provenTxReqId: number;
+    txid: string;
+    attempts: number;
+    status: sdk.ProvenTxReqStatus;
+    history: string;
+    height: number;
+    index: number;
+    blockHash: string;
+    merkleRoot: string;
+    merklePath: number[];
+}
+export interface UpdateProvenTxReqWithNewProvenTxResult {
+    status: sdk.ProvenTxReqStatus;
+    history: string;
+    provenTxId: number;
+    log?: string;
+}
+//# sourceMappingURL=WalletStorage.interfaces.d.ts.map