@bsv/sdk 1.6.9 → 1.6.11

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

@@ -1,301 +0,0 @@
-import { sdk } from "..";
-import { OutPoint } from "./types";
-export declare function parseWalletOutpoint(outpoint: string): {
-    txid: string;
-    vout: number;
-};
-export declare function validateSatoshis(v: number | undefined, name: string, min?: number): number;
-export declare function validateOptionalInteger(v: number | undefined, name: string, min?: number, max?: number): number | undefined;
-export declare function validateInteger(v: number | undefined, name: string, defaultValue?: number, min?: number, max?: number): number;
-export declare function validatePositiveIntegerOrZero(v: number, name: string): number;
-export declare function validateStringLength(s: string, name: string, min?: number, max?: number): string;
-export declare function isHexString(s: string): boolean;
-export interface ValidCreateActionInput {
-    outpoint: OutPoint;
-    inputDescription: sdk.DescriptionString5to50Bytes;
-    sequenceNumber: sdk.PositiveIntegerOrZero;
-    unlockingScript?: sdk.HexString;
-    unlockingScriptLength: sdk.PositiveInteger;
-}
-export declare function validateCreateActionInput(i: sdk.CreateActionInput): ValidCreateActionInput;
-export interface ValidCreateActionOutput {
-    lockingScript: sdk.HexString;
-    satoshis: sdk.SatoshiValue;
-    outputDescription: sdk.DescriptionString5to50Bytes;
-    basket?: sdk.BasketStringUnder300Bytes;
-    customInstructions?: string;
-    tags: sdk.OutputTagStringUnder300Bytes[];
-}
-export declare function validateCreateActionOutput(o: sdk.CreateActionOutput): ValidCreateActionOutput;
-/**
- * Set all default true/false booleans to true or false if undefined.
- * Set all possibly undefined numbers to their default values.
- * Set all possibly undefined arrays to empty arrays.
- * Convert string outpoints to `{ txid: string, vout: number }`
- */
-export declare function validateCreateActionOptions(options?: sdk.CreateActionOptions): ValidCreateActionOptions;
-export interface ValidProcessActionOptions {
-    acceptDelayedBroadcast: sdk.BooleanDefaultTrue;
-    returnTXIDOnly: sdk.BooleanDefaultFalse;
-    noSend: sdk.BooleanDefaultFalse;
-    sendWith: sdk.TXIDHexString[];
-}
-export interface ValidCreateActionOptions extends ValidProcessActionOptions {
-    signAndProcess: boolean;
-    trustSelf?: sdk.TrustSelf;
-    knownTxids: sdk.TXIDHexString[];
-    noSendChange: OutPoint[];
-    randomizeOutputs: boolean;
-}
-export interface ValidSignActionOptions extends ValidProcessActionOptions {
-    acceptDelayedBroadcast: boolean;
-    returnTXIDOnly: boolean;
-    noSend: boolean;
-    sendWith: sdk.TXIDHexString[];
-}
-export interface ValidProcessActionArgs {
-    options: sdk.ValidProcessActionOptions;
-    isSendWith: boolean;
-    isNewTx: boolean;
-    isNoSend: boolean;
-    isDelayed: boolean;
-    userId?: number;
-    log?: string;
-}
-export interface ValidCreateActionArgs extends ValidProcessActionArgs {
-    description: sdk.DescriptionString5to50Bytes;
-    inputBEEF?: sdk.BEEF;
-    inputs: sdk.ValidCreateActionInput[];
-    outputs: sdk.ValidCreateActionOutput[];
-    lockTime: number;
-    version: number;
-    labels: string[];
-    options: ValidCreateActionOptions;
-    isSignAction: boolean;
-    userId?: number;
-    log?: string;
-}
-export interface ValidSignActionArgs extends ValidProcessActionArgs {
-    spends: Record<sdk.PositiveIntegerOrZero, sdk.SignActionSpend>;
-    reference: sdk.Base64String;
-    options: sdk.ValidSignActionOptions;
-    userId?: number;
-    log?: string;
-}
-export declare function validateCreateActionArgs(args: sdk.CreateActionArgs): ValidCreateActionArgs;
-/**
- * Set all default true/false booleans to true or false if undefined.
- * Set all possibly undefined numbers to their default values.
- * Set all possibly undefined arrays to empty arrays.
- * Convert string outpoints to `{ txid: string, vout: number }`
- */
-export declare function validateSignActionOptions(options?: sdk.SignActionOptions): ValidSignActionOptions;
-export declare function validateSignActionArgs(args: sdk.SignActionArgs): ValidSignActionArgs;
-export interface ValidAbortActionArgs {
-    reference: sdk.Base64String;
-    userId?: number;
-    log?: string;
-}
-export declare function validateAbortActionArgs(args: sdk.AbortActionArgs): ValidAbortActionArgs;
-export interface ValidWalletPayment {
-    derivationPrefix: sdk.Base64String;
-    derivationSuffix: sdk.Base64String;
-    senderIdentityKey: sdk.PubKeyHex;
-}
-export declare function validateWalletPayment(args?: sdk.WalletPayment): ValidWalletPayment | undefined;
-export interface ValidBasketInsertion {
-    basket: sdk.BasketStringUnder300Bytes;
-    customInstructions?: string;
-    tags: sdk.OutputTagStringUnder300Bytes[];
-}
-export declare function validateBasketInsertion(args?: sdk.BasketInsertion): ValidBasketInsertion | undefined;
-export interface ValidInternalizeOutput {
-    outputIndex: sdk.PositiveIntegerOrZero;
-    protocol: 'wallet payment' | 'basket insertion';
-    paymentRemittance?: ValidWalletPayment;
-    insertionRemittance?: ValidBasketInsertion;
-}
-export declare function validateInternalizeOutput(args: sdk.InternalizeOutput): ValidInternalizeOutput;
-export interface ValidInternalizeActionArgs {
-    tx: sdk.AtomicBEEF;
-    outputs: sdk.InternalizeOutput[];
-    description: sdk.DescriptionString5to50Bytes;
-    labels: sdk.LabelStringUnder300Bytes[];
-    seekPermission: sdk.BooleanDefaultTrue;
-    userId?: number;
-    log?: string;
-}
-export declare function validateOriginator(s?: string): string | undefined;
-export declare function validateInternalizeActionArgs(args: sdk.InternalizeActionArgs): ValidInternalizeActionArgs;
-export declare function validateOptionalOutpointString(outpoint: string | undefined, name: string): string | undefined;
-export declare function validateOutpointString(outpoint: string, name: string): string;
-export interface ValidRelinquishOutputArgs {
-    basket: sdk.BasketStringUnder300Bytes;
-    output: sdk.OutpointString;
-    userId?: number;
-    log?: string;
-}
-export declare function validateRelinquishOutputArgs(args: sdk.RelinquishOutputArgs): ValidRelinquishOutputArgs;
-export interface ValidRelinquishCertificateArgs {
-    type: sdk.Base64String;
-    serialNumber: sdk.Base64String;
-    certifier: sdk.PubKeyHex;
-    userId?: number;
-    log?: string;
-}
-export declare function validateRelinquishCertificateArgs(args: sdk.RelinquishCertificateArgs): ValidRelinquishCertificateArgs;
-export interface ValidListCertificatesArgs {
-    partial?: {
-        type?: sdk.Base64String;
-        serialNumber?: sdk.Base64String;
-        certifier?: sdk.PubKeyHex;
-        subject?: sdk.PubKeyHex;
-        revocationOutpoint?: sdk.OutpointString;
-        signature?: sdk.HexString;
-    };
-    certifiers: sdk.PubKeyHex[];
-    types: sdk.Base64String[];
-    limit: sdk.PositiveIntegerDefault10Max10000;
-    offset: sdk.PositiveIntegerOrZero;
-    privileged: sdk.BooleanDefaultFalse;
-    privilegedReason?: sdk.DescriptionString5to50Bytes;
-    userId?: number;
-    log?: string;
-}
-export declare function validateListCertificatesArgs(args: sdk.ListCertificatesArgs): ValidListCertificatesArgs;
-export interface ValidAcquireCertificateArgs {
-    acquisitionProtocol: sdk.AcquisitionProtocol;
-    type: sdk.Base64String;
-    serialNumber?: sdk.Base64String;
-    certifier: sdk.PubKeyHex;
-    revocationOutpoint?: sdk.OutpointString;
-    fields: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
-    signature?: sdk.HexString;
-    certifierUrl?: string;
-    keyringRevealer?: sdk.KeyringRevealer;
-    keyringForSubject?: Record<sdk.CertificateFieldNameUnder50Bytes, sdk.Base64String>;
-    privileged: boolean;
-    privilegedReason?: sdk.DescriptionString5to50Bytes;
-    userId?: string;
-    log?: string;
-}
-/**
- *
- * @param args
- * @param subject Must be valid for "direct" `acquisitionProtocol`. public key of the certificate subject.
- * @returns
- */
-export declare function validateAcquireCertificateArgs(args: sdk.AcquireCertificateArgs): Promise<ValidAcquireCertificateArgs>;
-export interface ValidAcquireDirectCertificateArgs {
-    type: sdk.Base64String;
-    serialNumber: sdk.Base64String;
-    certifier: sdk.PubKeyHex;
-    revocationOutpoint: sdk.OutpointString;
-    fields: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
-    signature: sdk.HexString;
-    /**
-     * validated to an empty string, must be provided by wallet and must
-     * match expectations of keyringForSubject
-     */
-    subject: sdk.PubKeyHex;
-    keyringRevealer: sdk.KeyringRevealer;
-    keyringForSubject: Record<sdk.CertificateFieldNameUnder50Bytes, sdk.Base64String>;
-    privileged: boolean;
-    privilegedReason?: sdk.DescriptionString5to50Bytes;
-    userId?: number;
-    log?: string;
-}
-export declare function validateAcquireDirectCertificateArgs(args: sdk.AcquireCertificateArgs): ValidAcquireDirectCertificateArgs;
-export interface ValidProveCertificateArgs {
-    type?: sdk.Base64String;
-    serialNumber?: sdk.Base64String;
-    certifier?: sdk.PubKeyHex;
-    subject?: sdk.PubKeyHex;
-    revocationOutpoint?: sdk.OutpointString;
-    signature?: sdk.HexString;
-    fieldsToReveal: sdk.CertificateFieldNameUnder50Bytes[];
-    verifier: sdk.PubKeyHex;
-    privileged: boolean;
-    privilegedReason?: sdk.DescriptionString5to50Bytes;
-    userId?: number;
-    log?: string;
-}
-export declare function validateProveCertificateArgs(args: sdk.ProveCertificateArgs): ValidProveCertificateArgs;
-export interface ValidDiscoverByIdentityKeyArgs {
-    identityKey: sdk.PubKeyHex;
-    limit: sdk.PositiveIntegerDefault10Max10000;
-    offset: sdk.PositiveIntegerOrZero;
-    seekPermission: boolean;
-    userId?: number;
-    log?: string;
-}
-export declare function validateDiscoverByIdentityKeyArgs(args: sdk.DiscoverByIdentityKeyArgs): ValidDiscoverByIdentityKeyArgs;
-export interface ValidDiscoverByAttributesArgs {
-    attributes: Record<sdk.CertificateFieldNameUnder50Bytes, string>;
-    limit: sdk.PositiveIntegerDefault10Max10000;
-    offset: sdk.PositiveIntegerOrZero;
-    seekPermission: boolean;
-    userId?: number;
-    log?: string;
-}
-export declare function validateDiscoverByAttributesArgs(args: sdk.DiscoverByAttributesArgs): ValidDiscoverByAttributesArgs;
-export interface ValidListOutputsArgs {
-    basket: sdk.BasketStringUnder300Bytes;
-    tags: sdk.OutputTagStringUnder300Bytes[];
-    tagQueryMode: 'all' | 'any';
-    includeLockingScripts: boolean;
-    includeTransactions: boolean;
-    includeCustomInstructions: sdk.BooleanDefaultFalse;
-    includeTags: sdk.BooleanDefaultFalse;
-    includeLabels: sdk.BooleanDefaultFalse;
-    limit: sdk.PositiveIntegerDefault10Max10000;
-    offset: sdk.PositiveIntegerOrZero;
-    seekPermission: sdk.BooleanDefaultTrue;
-    knownTxids: string[];
-    userId?: number;
-    log?: string;
-}
-/**
-   * @param {BasketStringUnder300Bytes} args.basket - Required. The associated basket name whose outputs should be listed.
-   * @param {OutputTagStringUnder300Bytes[]} [args.tags] - Optional. Filter outputs based on these tags.
-   * @param {'all' | 'any'} [args.tagQueryMode] - Optional. Filter mode, defining whether all or any of the tags must match. By default, any tag can match.
-   * @param {'locking scripts' | 'entire transactions'} [args.include] - Optional. Whether to include locking scripts (with each output) or entire transactions (as aggregated BEEF, at the top level) in the result. By default, unless specified, neither are returned.
-   * @param {BooleanDefaultFalse} [args.includeEntireTransactions] - Optional. Whether to include the entire transaction(s) in the result.
-   * @param {BooleanDefaultFalse} [args.includeCustomInstructions] - Optional. Whether custom instructions should be returned in the result.
-   * @param {BooleanDefaultFalse} [args.includeTags] - Optional. Whether the tags associated with the output should be returned.
-   * @param {BooleanDefaultFalse} [args.includeLabels] - Optional. Whether the labels associated with the transaction containing the output should be returned.
-   * @param {PositiveIntegerDefault10Max10000} [args.limit] - Optional limit on the number of outputs to return.
-   * @param {PositiveIntegerOrZero} [args.offset] - Optional. Number of outputs to skip before starting to return results.
-   * @param {BooleanDefaultTrue} [args.seekPermission] — Optional. Whether to seek permission from the user for this operation if required. Default true, will return an error rather than proceed if set to false.
- */
-export declare function validateListOutputsArgs(args: sdk.ListOutputsArgs): ValidListOutputsArgs;
-export interface ValidListActionsArgs {
-    labels: sdk.LabelStringUnder300Bytes[];
-    labelQueryMode: 'any' | 'all';
-    includeLabels: sdk.BooleanDefaultFalse;
-    includeInputs: sdk.BooleanDefaultFalse;
-    includeInputSourceLockingScripts: sdk.BooleanDefaultFalse;
-    includeInputUnlockingScripts: sdk.BooleanDefaultFalse;
-    includeOutputs: sdk.BooleanDefaultFalse;
-    includeOutputLockingScripts: sdk.BooleanDefaultFalse;
-    limit: sdk.PositiveIntegerDefault10Max10000;
-    offset: sdk.PositiveIntegerOrZero;
-    seekPermission: sdk.BooleanDefaultTrue;
-    userId?: number;
-    log?: string;
-}
-/**
-   * @param {sdk.LabelStringUnder300Bytes[]} args.labels - An array of labels used to filter actions.
-   * @param {'any' | 'all'} [args.labelQueryMode] - Optional. Specifies how to match labels (default is any which matches any of the labels).
-   * @param {sdk.BooleanDefaultFalse} [args.includeLabels] - Optional. Whether to include transaction labels in the result set.
-   * @param {sdk.BooleanDefaultFalse} [args.includeInputs] - Optional. Whether to include input details in the result set.
-   * @param {sdk.BooleanDefaultFalse} [args.includeInputSourceLockingScripts] - Optional. Whether to include input source locking scripts in the result set.
-   * @param {sdk.BooleanDefaultFalse} [args.includeInputUnlockingScripts] - Optional. Whether to include input unlocking scripts in the result set.
-   * @param {sdk.BooleanDefaultFalse} [args.includeOutputs] - Optional. Whether to include output details in the result set.
-   * @param {sdk.BooleanDefaultFalse} [args.includeOutputLockingScripts] - Optional. Whether to include output locking scripts in the result set.
-   * @param {sdk.PositiveIntegerDefault10Max10000} [args.limit] - Optional. The maximum number of transactions to retrieve.
-   * @param {sdk.PositiveIntegerOrZero} [args.offset] - Optional. Number of transactions to skip before starting to return the results.
-   * @param {sdk.BooleanDefaultTrue} [args.seekPermission] — Optional. Whether to seek permission from the user for this operation if required. Default true, will return an error rather than proceed if set to false.
- */
-export declare function validateListActionsArgs(args: sdk.ListActionsArgs): ValidListActionsArgs;
-//# sourceMappingURL=validationHelpers.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"validationHelpers.d.ts","sourceRoot":"","sources":["../../../../src/wallet/validationHelpers.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;CAAE,CAGrF;AAcD,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAM1F;AAED,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAG3H;AAED,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAa9H;AAED,wBAAgB,6BAA6B,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAOhG;AA+ED,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAQ9C;AAED,MAAM,WAAW,sBAAsB;IACnC,QAAQ,EAAE,QAAQ,CAAA;IAClB,gBAAgB,EAAE,GAAG,CAAC,2BAA2B,CAAA;IACjD,cAAc,EAAE,GAAG,CAAC,qBAAqB,CAAA;IACzC,eAAe,CAAC,EAAE,GAAG,CAAC,SAAS,CAAA;IAC/B,qBAAqB,EAAE,GAAG,CAAC,eAAe,CAAA;CAC7C;AAED,wBAAgB,yBAAyB,CAAC,CAAC,EAAE,GAAG,CAAC,iBAAiB,GAAG,sBAAsB,CAe1F;AAED,MAAM,WAAW,uBAAuB;IACpC,aAAa,EAAE,GAAG,CAAC,SAAS,CAAA;IAC5B,QAAQ,EAAE,GAAG,CAAC,YAAY,CAAA;IAC1B,iBAAiB,EAAE,GAAG,CAAC,2BAA2B,CAAA;IAClD,MAAM,CAAC,EAAE,GAAG,CAAC,yBAAyB,CAAA;IACtC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,IAAI,EAAE,GAAG,CAAC,4BAA4B,EAAE,CAAA;CAC3C;AAED,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,GAAG,CAAC,kBAAkB,GAAG,uBAAuB,CAU7F;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,mBAAmB,GAAG,wBAAwB,CAavG;AAED,MAAM,WAAW,yBAAyB;IACtC,sBAAsB,EAAE,GAAG,CAAC,kBAAkB,CAAA;IAC9C,cAAc,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACvC,MAAM,EAAE,GAAG,CAAC,mBAAmB,CAAA;IAC/B,QAAQ,EAAE,GAAG,CAAC,aAAa,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,wBAAyB,SAAQ,yBAAyB;IACvE,cAAc,EAAE,OAAO,CAAA;IACvB,SAAS,CAAC,EAAE,GAAG,CAAC,SAAS,CAAA;IACzB,UAAU,EAAE,GAAG,CAAC,aAAa,EAAE,CAAA;IAC/B,YAAY,EAAE,QAAQ,EAAE,CAAA;IACxB,gBAAgB,EAAE,OAAO,CAAA;CAC5B;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACrE,sBAAsB,EAAE,OAAO,CAAA;IAC/B,cAAc,EAAE,OAAO,CAAA;IACvB,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,GAAG,CAAC,aAAa,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,sBAAsB;IACnC,OAAO,EAAE,GAAG,CAAC,yBAAyB,CAAA;IAEtC,UAAU,EAAE,OAAO,CAAA;IAEnB,OAAO,EAAE,OAAO,CAAA;IAEhB,QAAQ,EAAE,OAAO,CAAA;IAEjB,SAAS,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;IACjE,WAAW,EAAE,GAAG,CAAC,2BAA2B,CAAA;IAC5C,SAAS,CAAC,EAAE,GAAG,CAAC,IAAI,CAAA;IACpB,MAAM,EAAE,GAAG,CAAC,sBAAsB,EAAE,CAAA;IACpC,OAAO,EAAE,GAAG,CAAC,uBAAuB,EAAE,CAAA;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,EAAE,CAAA;IAEhB,OAAO,EAAE,wBAAwB,CAAA;IAEjC,YAAY,EAAE,OAAO,CAAA;IAErB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,mBAAoB,SAAQ,sBAAsB;IAC/D,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,qBAAqB,EAAE,GAAG,CAAC,eAAe,CAAC,CAAA;IAC9D,SAAS,EAAE,GAAG,CAAC,YAAY,CAAA;IAE3B,OAAO,EAAE,GAAG,CAAC,sBAAsB,CAAA;IAEnC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,GAAG,CAAC,gBAAgB,GAAG,qBAAqB,CA0B1F;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,iBAAiB,GAAG,sBAAsB,CASjG;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,GAAG,CAAC,cAAc,GAAG,mBAAmB,CAiBpF;AAED,MAAM,WAAW,oBAAoB;IACjC,SAAS,EAAE,GAAG,CAAC,YAAY,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,GAAG,CAAC,eAAe,GAAG,oBAAoB,CAQvF;AAED,MAAM,WAAW,kBAAkB;IAC/B,gBAAgB,EAAE,GAAG,CAAC,YAAY,CAAA;IAClC,gBAAgB,EAAE,GAAG,CAAC,YAAY,CAAA;IAClC,iBAAiB,EAAE,GAAG,CAAC,SAAS,CAAA;CACnC;AAED,wBAAgB,qBAAqB,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,aAAa,GAAG,kBAAkB,GAAG,SAAS,CAQ9F;AAED,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,GAAG,CAAC,yBAAyB,CAAA;IACrC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,IAAI,EAAE,GAAG,CAAC,4BAA4B,EAAE,CAAA;CAC3C;AAED,wBAAgB,uBAAuB,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,oBAAoB,GAAG,SAAS,CAQpG;AAED,MAAM,WAAW,sBAAsB;IACnC,WAAW,EAAE,GAAG,CAAC,qBAAqB,CAAA;IACtC,QAAQ,EAAE,gBAAgB,GAAG,kBAAkB,CAAA;IAC/C,iBAAiB,CAAC,EAAE,kBAAkB,CAAA;IACtC,mBAAmB,CAAC,EAAE,oBAAoB,CAAA;CAC7C;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,GAAG,CAAC,iBAAiB,GAAG,sBAAsB,CAU7F;AAED,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,GAAG,CAAC,UAAU,CAAC;IACnB,OAAO,EAAE,GAAG,CAAC,iBAAiB,EAAE,CAAA;IAChC,WAAW,EAAE,GAAG,CAAC,2BAA2B,CAAA;IAC5C,MAAM,EAAE,GAAG,CAAC,wBAAwB,EAAE,CAAA;IACtC,cAAc,EAAE,GAAG,CAAC,kBAAkB,CAAA;IACtC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,kBAAkB,CAAC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAQjE;AAED,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,GAAG,CAAC,qBAAqB,GAAG,0BAA0B,CAYzG;AAED,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAG7G;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAO7E;AAED,MAAM,WAAW,yBAAyB;IACtC,MAAM,EAAE,GAAG,CAAC,yBAAyB,CAAA;IACrC,MAAM,EAAE,GAAG,CAAC,cAAc,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAAG,yBAAyB,CAStG;AAED,MAAM,WAAW,8BAA8B;IAC3C,IAAI,EAAE,GAAG,CAAC,YAAY,CAAA;IACtB,YAAY,EAAE,GAAG,CAAC,YAAY,CAAA;IAC9B,SAAS,EAAE,GAAG,CAAC,SAAS,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,iCAAiC,CAAC,IAAI,EAAE,GAAG,CAAC,yBAAyB,GAAG,8BAA8B,CAUrH;AAED,MAAM,WAAW,yBAAyB;IACtC,OAAO,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,GAAG,CAAC,YAAY,CAAA;QACvB,YAAY,CAAC,EAAE,GAAG,CAAC,YAAY,CAAA;QAC/B,SAAS,CAAC,EAAE,GAAG,CAAC,SAAS,CAAA;QACzB,OAAO,CAAC,EAAE,GAAG,CAAC,SAAS,CAAA;QACvB,kBAAkB,CAAC,EAAE,GAAG,CAAC,cAAc,CAAA;QACvC,SAAS,CAAC,EAAE,GAAG,CAAC,SAAS,CAAA;KAC5B,CAAA;IACD,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,CAAA;IAC3B,KAAK,EAAE,GAAG,CAAC,YAAY,EAAE,CAAA;IACzB,KAAK,EAAE,GAAG,CAAC,gCAAgC,CAAA;IAC3C,MAAM,EAAE,GAAG,CAAC,qBAAqB,CAAA;IACjC,UAAU,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACnC,gBAAgB,CAAC,EAAE,GAAG,CAAC,2BAA2B,CAAA;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAAG,yBAAyB,CAatG;AAED,MAAM,WAAW,2BAA2B;IACxC,mBAAmB,EAAE,GAAG,CAAC,mBAAmB,CAAA;IAE5C,IAAI,EAAE,GAAG,CAAC,YAAY,CAAA;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC,YAAY,CAAA;IAC/B,SAAS,EAAE,GAAG,CAAC,SAAS,CAAA;IACxB,kBAAkB,CAAC,EAAE,GAAG,CAAC,cAAc,CAAA;IACvC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAA;IAC5D,SAAS,CAAC,EAAE,GAAG,CAAC,SAAS,CAAA;IAEzB,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB,eAAe,CAAC,EAAE,GAAG,CAAC,eAAe,CAAA;IACrC,iBAAiB,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAA;IAElF,UAAU,EAAE,OAAO,CAAA;IACnB,gBAAgB,CAAC,EAAE,GAAG,CAAC,2BAA2B,CAAA;IAElD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAiCD;;;;;GAKG;AACH,wBAAsB,8BAA8B,CAAC,IAAI,EAAE,GAAG,CAAC,sBAAsB,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAyB3H;AAED,MAAM,WAAW,iCAAiC;IAC9C,IAAI,EAAE,GAAG,CAAC,YAAY,CAAA;IACtB,YAAY,EAAE,GAAG,CAAC,YAAY,CAAA;IAC9B,SAAS,EAAE,GAAG,CAAC,SAAS,CAAA;IACxB,kBAAkB,EAAE,GAAG,CAAC,cAAc,CAAA;IACtC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAA;IAC5D,SAAS,EAAE,GAAG,CAAC,SAAS,CAAA;IAExB;;;OAGG;IACH,OAAO,EAAE,GAAG,CAAC,SAAS,CAAA;IAEtB,eAAe,EAAE,GAAG,CAAC,eAAe,CAAA;IACpC,iBAAiB,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAA;IAEjF,UAAU,EAAE,OAAO,CAAA;IACnB,gBAAgB,CAAC,EAAE,GAAG,CAAC,2BAA2B,CAAA;IAElD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,oCAAoC,CAAC,IAAI,EAAE,GAAG,CAAC,sBAAsB,GAAG,iCAAiC,CAyBxH;AAED,MAAM,WAAW,yBAAyB;IACtC,IAAI,CAAC,EAAE,GAAG,CAAC,YAAY,CAAA;IACvB,YAAY,CAAC,EAAE,GAAG,CAAC,YAAY,CAAA;IAC/B,SAAS,CAAC,EAAE,GAAG,CAAC,SAAS,CAAA;IACzB,OAAO,CAAC,EAAE,GAAG,CAAC,SAAS,CAAA;IACvB,kBAAkB,CAAC,EAAE,GAAG,CAAC,cAAc,CAAA;IACvC,SAAS,CAAC,EAAE,GAAG,CAAC,SAAS,CAAA;IAEzB,cAAc,EAAE,GAAG,CAAC,gCAAgC,EAAE,CAAA;IACtD,QAAQ,EAAE,GAAG,CAAC,SAAS,CAAA;IACvB,UAAU,EAAE,OAAO,CAAA;IACnB,gBAAgB,CAAC,EAAE,GAAG,CAAC,2BAA2B,CAAA;IAClD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,GAAG,CAAC,oBAAoB,GACrE,yBAAyB,CAkB9B;AAED,MAAM,WAAW,8BAA8B;IAC3C,WAAW,EAAE,GAAG,CAAC,SAAS,CAAA;IAC1B,KAAK,EAAE,GAAG,CAAC,gCAAgC,CAAA;IAC3C,MAAM,EAAE,GAAG,CAAC,qBAAqB,CAAA;IACjC,cAAc,EAAE,OAAO,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,iCAAiC,CAAC,IAAI,EAAE,GAAG,CAAC,yBAAyB,GAC/E,8BAA8B,CAUnC;AAED,MAAM,WAAW,6BAA6B;IAC1C,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAA;IAChE,KAAK,EAAE,GAAG,CAAC,gCAAgC,CAAA;IAC3C,MAAM,EAAE,GAAG,CAAC,qBAAqB,CAAA;IACjC,cAAc,EAAE,OAAO,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAUD,wBAAgB,gCAAgC,CAAC,IAAI,EAAE,GAAG,CAAC,wBAAwB,GAC7E,6BAA6B,CAUlC;AAED,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,GAAG,CAAC,yBAAyB,CAAA;IACrC,IAAI,EAAE,GAAG,CAAC,4BAA4B,EAAE,CAAA;IACxC,YAAY,EAAE,KAAK,GAAG,KAAK,CAAA;IAC3B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,yBAAyB,EAAE,GAAG,CAAC,mBAAmB,CAAA;IAClD,WAAW,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACpC,aAAa,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACtC,KAAK,EAAE,GAAG,CAAC,gCAAgC,CAAA;IAC3C,MAAM,EAAE,GAAG,CAAC,qBAAqB,CAAA;IACjC,cAAc,EAAE,GAAG,CAAC,kBAAkB,CAAA;IACtC,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,GAAG,CAAC,eAAe,GAAG,oBAAoB,CA2BvF;AAED,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,GAAG,CAAC,wBAAwB,EAAE,CAAA;IACtC,cAAc,EAAE,KAAK,GAAG,KAAK,CAAA;IAC7B,aAAa,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACtC,aAAa,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACtC,gCAAgC,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACzD,4BAA4B,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACrD,cAAc,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACvC,2BAA2B,EAAE,GAAG,CAAC,mBAAmB,CAAA;IACpD,KAAK,EAAE,GAAG,CAAC,gCAAgC,CAAA;IAC3C,MAAM,EAAE,GAAG,CAAC,qBAAqB,CAAA;IACjC,cAAc,EAAE,GAAG,CAAC,kBAAkB,CAAA;IACtC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,GAAG,CAAC,eAAe,GAAG,oBAAoB,CA6BvF"}

package/docs/README.md

@@ -1,21 +0,0 @@
-# TypeScript Library API Documentation
-
-The documentation is split into various pages, each covering a set of related functionality. The pages are as follows:
-
-- [Primitives](./primitives.md) — Covers public and private keys, key derivation, digital signaturs, symmetric keys, and low-level operations
-- [Script](./script.md) — Covers Bitcoin scripts, the templating system, serialization, and the Spend class (script interpreter)
-- [Transaction](./transaction.md) — Covers transaction construction, signing, broadcasters, fee models, merkle proofs, and SPV structures like BUMP
-- [Messages](./messages.md) — Covers generalizable message signing, verification, encryption and decryption
-- [TOTP](./totp.md) - Covers Time-based One Time Password, useful for validating counterparties across unsecured mediums.
-- [Wallet](./wallet.md) - Covers the Wallet interface for communication between applications and wallets using a standard interface.
-- [Wallet Substrates](./wallet-substrates.md) - Covers the Wallet Substrates which facilitate communication between apps and wallets.
-- [Overlay Tools](./overlay-tools.md) - Covers the use of Overlays for broadcast of transactions based on topics, as well as distributed lookup of tokens.
-- [Auth](./auth.md) - Mutual Authentication and Service Monetization Framework
-- [Storage](./storage.md) — Covers a UHRP client for storing and retrieving data from distributed data storage services by hash.
-- [Compat](./compat.md) — Covers deprecated functionality for legacy systems like BIP32 and ECIES
-
-## Swagger
-
-[BRC-100](https://brc.dev/100) defines a Unified, Vendor-Neutral, Unchanging, and Open BSV Blockchain Standard Wallet-to-Application Interface which is implemented in this library within the WalletClient class. The API is laid out here as a swagger openapi document to offer a fast-track to understanding the interface which is implemented across multiple substrates. The JSON api is generally considered a developer friendly introduction to the WalletClient, where an binary equivalent ABI may be preferred for production use cases.
-
-- [Wallet JSON API Swagger](./swagger)