@bsv/sdk 1.6.8 → 1.6.9

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

@@ -0,0 +1,102 @@
+import { sdk, table } from "..";
+export interface StorageSyncReader {
+    isAvailable(): boolean;
+    makeAvailable(): Promise<void>;
+    /**
+     * Valid if isAvailable() returns true which requires makeAvailable() to complete successfully.
+     */
+    settings?: table.Settings;
+    destroy(): Promise<void>;
+    getSettings(trx?: sdk.TrxToken): Promise<table.Settings>;
+    getProvenTxsForUser(identityKey: string, since?: Date, paged?: sdk.Paged, trx?: sdk.TrxToken): Promise<table.ProvenTx[]>;
+    getProvenTxReqsForUser(identityKey: string, since?: Date, paged?: sdk.Paged, trx?: sdk.TrxToken): Promise<table.ProvenTxReq[]>;
+    getTxLabelMapsForUser(identityKey: string, since?: Date, paged?: sdk.Paged, trx?: sdk.TrxToken): Promise<table.TxLabelMap[]>;
+    getOutputTagMapsForUser(identityKey: string, since?: Date, paged?: sdk.Paged, trx?: sdk.TrxToken): Promise<table.OutputTagMap[]>;
+    findCertificates(args: sdk.FindCertificatesArgs): Promise<table.Certificate[]>;
+    findCommissions(args: sdk.FindCommissionsArgs): Promise<table.Commission[]>;
+    findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<table.OutputBasket[]>;
+    findOutputs(args: sdk.FindOutputsArgs): Promise<table.Output[]>;
+    findOutputTags(args: sdk.FindOutputTagsArgs): Promise<table.OutputTag[]>;
+    findTransactions(args: sdk.FindTransactionsArgs): Promise<table.Transaction[]>;
+    findTxLabels(args: sdk.FindTxLabelsArgs): Promise<table.TxLabel[]>;
+    findSyncStates(args: sdk.FindSyncStatesArgs): Promise<table.SyncState[]>;
+    findUsers(args: sdk.FindUsersArgs): Promise<table.User[]>;
+    requestSyncChunk(args: RequestSyncChunkArgs): Promise<RequestSyncChunkResult>;
+}
+/**
+ * success: Last sync of this user from this dojo was successful.
+ *
+ * error: Last sync protocol operation for this user to this dojo threw and error.
+ *
+ * identified: Configured sync dojo has been identified but not sync'ed.
+ *
+ * unknown: Sync protocol state is unknown.
+ */
+export type SyncStatus = 'success' | 'error' | 'identified' | 'updated' | 'unknown';
+export type SyncProtocolVersion = '0.1.0';
+export interface RequestSyncChunkArgs {
+    /**
+     * The identity of whose data is being requested
+     */
+    identityKey: string;
+    /**
+     * The max updated_at time received from the storage service receiving the request.
+     * Will be undefiend if this is the first request or if no data was previously sync'ed.
+     *
+     * `since` must include items if 'updated_at' is greater or equal. Thus, when not undefined, a sync request should always return at least one item already seen.
+     */
+    since?: Date;
+    /**
+     * A rough limit on how large the response should be.
+     * The item that exceeds the limit is included and ends adding more items.
+     */
+    maxRoughSize: number;
+    /**
+     * The maximum number of items (records) to be returned.
+     */
+    maxItems: number;
+    /**
+     * For each entity in dependency order, the offset at which to start returning items
+     * from `since`.
+     *
+     * The entity order is:
+     * 0 ProvenTxs
+     * 1 ProvenTxReqs
+     * 2 OutputBaskets
+     * 3 TxLabels
+     * 4 OutputTags
+     * 5 Transactions
+     * 6 TxLabelMaps
+     * 7 Commissions
+     * 8 Outputs
+     * 9 OutputTagMaps
+     * 10 Certificates
+     * 11 CertificateFields
+     */
+    offsets: {
+        name: string;
+        offset: number;
+    }[];
+}
+/**
+ * Result received from remote `WalletStorage` in response to a `RequestSyncChunkArgs` request.
+ *
+ * Each property is undefined if there was no attempt to update it. Typically this is caused by size and count limits on this result.
+ *
+ * If all properties are empty arrays the sync process has received all available new and updated items.
+ */
+export interface RequestSyncChunkResult {
+    provenTxs?: table.ProvenTx[];
+    provenTxReqs?: table.ProvenTxReq[];
+    outputBaskets?: table.OutputBasket[];
+    txLabels?: table.TxLabel[];
+    outputTags?: table.OutputTag[];
+    transactions?: table.Transaction[];
+    txLabelMaps?: table.TxLabelMap[];
+    commissions?: table.Commission[];
+    outputs?: table.Output[];
+    outputTagMaps?: table.OutputTagMap[];
+    certificates?: table.Certificate[];
+    certificateFields?: table.CertificateField[];
+}
+//# sourceMappingURL=StorageSyncReader.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StorageSyncReader.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/sdk/StorageSyncReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC;AAEhC,MAAM,WAAW,iBAAiB;IAE9B,WAAW,IAAI,OAAO,CAAA;IACtB,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAA;IAEzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAQxB,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;IAExD,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;IACxH,sBAAsB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;IAC9H,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAA;IAC5H,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAA;IAEhI,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;IAC9E,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,mBAAmB,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAA;IAC3E,iBAAiB,CAAC,IAAI,EAAE,GAAG,CAAC,qBAAqB,GAAG,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAA;IACjF,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAA;IAC/D,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAA;IACxE,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;IAC9E,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;IAGlE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAA;IACxE,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;IAEzD,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;CAChF;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,CAAA;AAEnF,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAA;AAEzC,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAA;IACZ;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAC9C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACnC,SAAS,CAAC,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAA;IAC5B,YAAY,CAAC,EAAE,KAAK,CAAC,WAAW,EAAE,CAAA;IAClC,aAAa,CAAC,EAAE,KAAK,CAAC,YAAY,EAAE,CAAA;IACpC,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAA;IAC1B,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,EAAE,CAAA;IAC9B,YAAY,CAAC,EAAE,KAAK,CAAC,WAAW,EAAE,CAAA;IAClC,WAAW,CAAC,EAAE,KAAK,CAAC,UAAU,EAAE,CAAA;IAChC,WAAW,CAAC,EAAE,KAAK,CAAC,UAAU,EAAE,CAAA;IAChC,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,EAAE,CAAA;IACxB,aAAa,CAAC,EAAE,KAAK,CAAC,YAAY,EAAE,CAAA;IACpC,YAAY,CAAC,EAAE,KAAK,CAAC,WAAW,EAAE,CAAA;IAClC,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,EAAE,CAAA;CAC/C"}

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

@@ -0,0 +1,84 @@
+import { WalletNetwork } from "./Wallet.interfaces";
+import { WalletError } from "./WalletError";
+/**
+ * Not implemented.
+ */
+export declare class WERR_NOT_IMPLEMENTED extends WalletError {
+    constructor(message?: string);
+}
+/**
+ * An internal error has occurred.
+ *
+ * This is an example of an error with an optional custom `message`.
+ */
+export declare class WERR_INTERNAL extends WalletError {
+    constructor(message?: string);
+}
+/**
+ * The ${parameter} parameter is invalid.
+ *
+ * This is an example of an error object with a custom property `parameter` and templated `message`.
+ */
+export declare class WERR_INVALID_OPERATION extends WalletError {
+    constructor(message?: string);
+}
+/**
+ * The ${parameter} parameter is invalid.
+ *
+ * This is an example of an error object with a custom property `parameter` and templated `message`.
+ */
+export declare class WERR_INVALID_PARAMETER extends WalletError {
+    parameter: string;
+    constructor(parameter: string, mustBe?: string);
+}
+/**
+ * The required ${parameter} parameter is missing.
+ *
+ * This is an example of an error object with a custom property `parameter`
+ */
+export declare class WERR_MISSING_PARAMETER extends WalletError {
+    parameter: string;
+    constructor(parameter: string);
+}
+/**
+ * The request is invalid.
+ */
+export declare class WERR_BAD_REQUEST extends WalletError {
+    constructor(message?: string);
+}
+/**
+ * Configured network chain is invalid or does not match across services.
+ */
+export declare class WERR_NETWORK_CHAIN extends WalletError {
+    constructor(message?: string);
+}
+/**
+ * Access is denied due to an authorization error.
+ */
+export declare class WERR_UNAUTHORIZED extends WalletError {
+    constructor(message?: string);
+}
+/**
+ * Insufficient funds in the available inputs to cover the cost of the required outputs
+ * and the transaction fee (${moreSatoshisNeeded} more satoshis are needed,
+ * for a total of ${totalSatoshisNeeded}), plus whatever would be required in order
+ * to pay the fee to unlock and spend the outputs used to provide the additional satoshis.
+ */
+export declare class WERR_INSUFFICIENT_FUNDS extends WalletError {
+    totalSatoshisNeeded: number;
+    moreSatoshisNeeded: number;
+    /**
+     * @param totalSatoshisNeeded Total satoshis required to fund transactions after net of required inputs and outputs.
+     * @param moreSatoshisNeeded Shortfall on total satoshis required to fund transactions after net of required inputs and outputs.
+     */
+    constructor(totalSatoshisNeeded: number, moreSatoshisNeeded: number);
+}
+export declare class WERR_INVALID_PUBLIC_KEY extends WalletError {
+    key: string;
+    /**
+     * @param key The invalid public key that caused the error.
+     * @param environment Optional environment flag to control whether the key is included in the message.
+     */
+    constructor(key: string, network?: WalletNetwork);
+}
+//# sourceMappingURL=WERR_errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WERR_errors.d.ts","sourceRoot":"","sources":["../../../../../src/wallet/sdk/WERR_errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;gBAAgB,OAAO,CAAC,EAAE,MAAM;CAAoE;AAEzJ;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,WAAW;gBAAgB,OAAO,CAAC,EAAE,MAAM;CAA4E;AAE1J;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;gBAAgB,OAAO,CAAC,EAAE,MAAM;CAAyF;AAEhL;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IAAuB,SAAS,EAAE,MAAM;gBAAjB,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;CAAmG;AAEnN;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IAAuB,SAAS,EAAE,MAAM;gBAAjB,SAAS,EAAE,MAAM;CAA0F;AAEzL;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;gBAAgB,OAAO,CAAC,EAAE,MAAM;CAAuE;AAExJ;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;gBAAgB,OAAO,CAAC,EAAE,MAAM;CAAwH;AAE3M;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;gBAAgB,OAAO,CAAC,EAAE,MAAM;CAAgG;AAElL;;;;;GAKG;AACH,qBAAa,uBAAwB,SAAQ,WAAW;IAKjC,mBAAmB,EAAE,MAAM;IAAS,kBAAkB,EAAE,MAAM;IAJjF;;;OAGG;gBACgB,mBAAmB,EAAE,MAAM,EAAS,kBAAkB,EAAE,MAAM;CAGpF;AAED,qBAAa,uBAAwB,SAAQ,WAAW;IAKjC,GAAG,EAAE,MAAM;IAJ9B;;;OAGG;gBACgB,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,aAAyB;CAUrE"}