@bsv/sdk 1.3.13 → 1.3.14

package/docs/transaction.md

@@ -503,7 +503,7 @@ export default class ARC implements Broadcaster {
     constructor(URL: string, apiKey?: string);
     constructor(URL: string, config?: string | ArcConfig) 
     async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure> 
-    async broadcastMany(txs: Transaction[]): Promise<Array<object>> 
+    async broadcastMany(txs: Transaction[]): Promise<object[]> 
 }
 ```
 
@@ -568,7 +568,7 @@ Broadcasts multiple transactions via ARC.
 Handles mixed responses where some transactions succeed and others fail.
 
 ```ts
-async broadcastMany(txs: Transaction[]): Promise<Array<object>> 
+async broadcastMany(txs: Transaction[]): Promise<object[]> 
 ```
 See also: [Transaction](./transaction.md#class-transaction)
 
@@ -603,15 +603,15 @@ export class Beef {
     mergeBump(bump: MerklePath): number 
     mergeRawTx(rawTx: number[], bumpIndex?: number): BeefTx 
     mergeTransaction(tx: Transaction): BeefTx 
-    removeExistingTxid(txid: string) 
+    removeExistingTxid(txid: string): void 
     mergeTxidOnly(txid: string): BeefTx 
     mergeBeefTx(btx: BeefTx): BeefTx 
-    mergeBeef(beef: number[] | Beef) 
+    mergeBeef(beef: number[] | Beef): void 
     isValid(allowTxidOnly?: boolean): boolean 
     async verify(chainTracker: ChainTracker, allowTxidOnly?: boolean): Promise<boolean> 
-    toWriter(writer: Writer) 
+    toWriter(writer: Writer): void 
     toBinary(): number[] 
-    toBinaryAtomic(txid: string) 
+    toBinaryAtomic(txid: string): number[] 
     toHex(): string 
     static fromReader(br: Reader): Beef 
     static fromBinary(bin: number[]): Beef 
@@ -624,10 +624,10 @@ export class Beef {
         txidOnly: string[];
     } 
     clone(): Beef 
-    trimKnownTxids(knownTxids: string[]) 
+    trimKnownTxids(knownTxids: string[]): void 
     getValidTxids(): string[] 
     toLogString(): string 
-    addComputedLeaves() 
+    addComputedLeaves(): void 
 }
 ```
 
@@ -639,11 +639,11 @@ See also: [BEEF_V2](./transaction.md#variable-beef_v2), [BeefTx](./transaction.m
 
 #### Method addComputedLeaves
 
-In some circumstances it may be helpful for the BUMP MerkePaths to include
+In some circumstances it may be helpful for the BUMP MerklePaths to include
 leaves that can be computed from row zero.
 
 ```ts
-addComputedLeaves() 
+addComputedLeaves(): void 
 ```
 
 #### Method clone
@@ -868,7 +868,7 @@ txid of tx
 Removes an existing transaction from the BEEF, given its TXID
 
 ```ts
-removeExistingTxid(txid: string) 
+removeExistingTxid(txid: string): void 
 ```
 
 Argument Details
@@ -920,7 +920,7 @@ Serialize this Beef as AtomicBEEF.
 after sorting, if txid is not last txid, creates a clone and removes newer txs
 
 ```ts
-toBinaryAtomic(txid: string) 
+toBinaryAtomic(txid: string): number[] 
 ```
 
 Returns
@@ -954,7 +954,7 @@ Summary of `Beef` contents as multi-line string.
 Serializes this data to `writer`
 
 ```ts
-toWriter(writer: Writer) 
+toWriter(writer: Writer): void 
 ```
 See also: [Writer](./primitives.md#class-writer)
 
@@ -963,7 +963,7 @@ See also: [Writer](./primitives.md#class-writer)
 Ensure that all the txids in `knownTxids` are txidOnly
 
 ```ts
-trimKnownTxids(knownTxids: string[]) 
+trimKnownTxids(knownTxids: string[]): void 
 ```
 
 #### Method verify
@@ -1020,12 +1020,12 @@ The size and redundancy of these Beefs becomes a problem when chained transactio
 export class BeefParty extends Beef {
     knownTo: Record<string, Record<string, boolean>> = {};
     constructor(parties?: string[]) 
-    isParty(party: string) 
-    addParty(party: string) 
+    isParty(party: string): boolean 
+    addParty(party: string): void 
     getKnownTxidsForParty(party: string): string[] 
     getTrimmedBeefForParty(party: string): Beef 
-    addKnownTxidsForParty(party: string, knownTxids: string[]) 
-    mergeBeefFromParty(party: string, beef: number[] | Beef) 
+    addKnownTxidsForParty(party: string, knownTxids: string[]): void 
+    mergeBeefFromParty(party: string, beef: number[] | Beef): void 
 }
 ```
 
@@ -1060,7 +1060,7 @@ knownTo: Record<string, Record<string, boolean>> = {}
 Make note of additional txids "known" to `party`.
 
 ```ts
-addKnownTxidsForParty(party: string, knownTxids: string[]) 
+addKnownTxidsForParty(party: string, knownTxids: string[]): void 
 ```
 
 Argument Details
@@ -1073,7 +1073,7 @@ Argument Details
 Adds a new unique party identifier to this `BeefParty`.
 
 ```ts
-addParty(party: string) 
+addParty(party: string): void 
 ```
 
 #### Method getKnownTxidsForParty
@@ -1100,7 +1100,7 @@ trimmed beef of unknown transactions and proofs for `party`
 #### Method isParty
 
 ```ts
-isParty(party: string) 
+isParty(party: string): boolean 
 ```
 
 Returns
@@ -1116,7 +1116,7 @@ corresponding to transactions for which `party`
 has raw transaction and validity proof data.
 
 ```ts
-mergeBeefFromParty(party: string, beef: number[] | Beef) 
+mergeBeefFromParty(party: string, beef: number[] | Beef): void 
 ```
 See also: [Beef](./transaction.md#class-beef)
 
@@ -1147,9 +1147,9 @@ export default class BeefTx {
     set bumpIndex(v: number | undefined) 
     get hasProof(): boolean 
     get isTxidOnly(): boolean 
-    get txid() 
-    get tx() 
-    get rawTx() 
+    get txid(): string 
+    get tx(): Transaction | undefined 
+    get rawTx(): number[] | undefined 
     constructor(tx: Transaction | number[] | string, bumpIndex?: number) 
     static fromTx(tx: Transaction, bumpIndex?: number): BeefTx 
     static fromRawTx(rawTx: number[], bumpIndex?: number): BeefTx 
@@ -1249,7 +1249,7 @@ export default class MerklePath {
     findOrComputeLeaf(height: number, offset: number): MerklePathLeaf | undefined 
     async verify(txid: string, chainTracker: ChainTracker): Promise<boolean> 
     combine(other: MerklePath): void 
-    trim() 
+    trim(): void 
 }
 ```
 
@@ -1394,7 +1394,7 @@ Assumes that at least all required nodes are present.
 Leaves all levels sorted by increasing offset.
 
 ```ts
-trim() 
+trim(): void 
 ```
 
 #### Method verify

package/docs/wallet-substrates.md

@@ -39,7 +39,7 @@ export default class HTTPWalletJSON implements WalletInterface {
     baseUrl: string;
     httpClient: typeof fetch;
     originator: OriginatorDomainNameStringUnder250Bytes | undefined;
-    api: (call: string, args: any) => Promise<any>;
+    api: (call: string, args: object) => Promise<unknown>;
     constructor(originator: OriginatorDomainNameStringUnder250Bytes | undefined, baseUrl: string = "http://localhost:3321", httpClient = fetch) 
     async createAction(args: CreateActionArgs): Promise<CreateActionResult> 
     async signAction(args: SignActionArgs): Promise<SignActionResult> 
@@ -228,13 +228,13 @@ export default class HTTPWalletJSON implements WalletInterface {
         limit?: PositiveIntegerDefault10Max10000;
         offset?: PositiveIntegerOrZero;
     }): Promise<DiscoverCertificatesResult> 
-    async isAuthenticated(args: {}): Promise<{
+    async isAuthenticated(args: object): Promise<{
         authenticated: true;
     }> 
-    async waitForAuthentication(args: {}): Promise<{
+    async waitForAuthentication(args: object): Promise<{
         authenticated: true;
     }> 
-    async getHeight(args: {}): Promise<{
+    async getHeight(args: object): Promise<{
         height: PositiveInteger;
     }> 
     async getHeaderForHeight(args: {
@@ -242,16 +242,16 @@ export default class HTTPWalletJSON implements WalletInterface {
     }): Promise<{
         header: HexString;
     }> 
-    async getNetwork(args: {}): Promise<{
+    async getNetwork(args: object): Promise<{
         network: "mainnet" | "testnet";
     }> 
-    async getVersion(args: {}): Promise<{
+    async getVersion(args: object): Promise<{
         version: VersionString7To30Bytes;
     }> 
 }
 ```
 
-See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AcquireCertificateResult](./wallet.md#interface-acquirecertificateresult), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [OutpointString](./wallet.md#type-outpointstring), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [PubKeyHex](./wallet.md#type-pubkeyhex), [SecurityLevel](./wallet.md#type-securitylevel), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
+See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AcquireCertificateResult](./wallet.md#type-acquirecertificateresult), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [OutpointString](./wallet.md#type-outpointstring), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [PubKeyHex](./wallet.md#type-pubkeyhex), [SecurityLevel](./wallet.md#type-securitylevel), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -508,7 +508,7 @@ export default class WalletWireTransceiver implements WalletInterface {
 }
 ```
 
-See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AcquireCertificateResult](./wallet.md#interface-acquirecertificateresult), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [OutpointString](./wallet.md#type-outpointstring), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [PubKeyHex](./wallet.md#type-pubkeyhex), [SecurityLevel](./wallet.md#type-securitylevel), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [WalletWire](./wallet.md#interface-walletwire), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
+See also: [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AcquireCertificateResult](./wallet.md#type-acquirecertificateresult), [Base64String](./wallet.md#type-base64string), [BasketStringUnder300Bytes](./wallet.md#type-basketstringunder300bytes), [BooleanDefaultFalse](./wallet.md#type-booleandefaultfalse), [BooleanDefaultTrue](./wallet.md#type-booleandefaulttrue), [Byte](./wallet.md#type-byte), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [HexString](./wallet.md#type-hexstring), [ISOTimestampString](./wallet.md#type-isotimestampstring), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [KeyIDStringUnder800Bytes](./wallet.md#type-keyidstringunder800bytes), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [OutpointString](./wallet.md#type-outpointstring), [PositiveInteger](./wallet.md#type-positiveinteger), [PositiveIntegerDefault10Max10000](./wallet.md#type-positiveintegerdefault10max10000), [PositiveIntegerOrZero](./wallet.md#type-positiveintegerorzero), [ProtocolString5To400Bytes](./wallet.md#type-protocolstring5to400bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [PubKeyHex](./wallet.md#type-pubkeyhex), [SecurityLevel](./wallet.md#type-securitylevel), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VersionString7To30Bytes](./wallet.md#type-versionstring7to30bytes), [WalletInterface](./wallet.md#interface-walletinterface), [WalletWire](./wallet.md#interface-walletwire), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -928,13 +928,13 @@ export default class WindowCWISubstrate implements WalletInterface {
             decryptedFields: Record<CertificateFieldNameUnder50Bytes, string>;
         }>;
     }> 
-    async isAuthenticated(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
+    async isAuthenticated(args: object, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
         authenticated: true;
     }> 
-    async waitForAuthentication(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
+    async waitForAuthentication(args: object, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
         authenticated: true;
     }> 
-    async getHeight(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
+    async getHeight(args: object, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
         height: PositiveInteger;
     }> 
     async getHeaderForHeight(args: {
@@ -942,10 +942,10 @@ export default class WindowCWISubstrate implements WalletInterface {
     }, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
         header: HexString;
     }> 
-    async getNetwork(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
+    async getNetwork(args: object, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
         network: "mainnet" | "testnet";
     }> 
-    async getVersion(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
+    async getVersion(args: object, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<{
         version: VersionString7To30Bytes;
     }> 
 }