@bsv/sdk 1.3.15 → 1.3.18

package/docs/transaction.md

@@ -36,10 +36,6 @@ export interface ArcConfig {
 
 See also: [HttpClient](./transaction.md#interface-httpclient)
 
-<details>
-
-<summary>Interface ArcConfig Details</summary>
-
 #### Property apiKey
 
 Authentication token for the ARC API
@@ -89,8 +85,6 @@ httpClient?: HttpClient
 ```
 See also: [HttpClient](./transaction.md#interface-httpclient)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -205,10 +199,6 @@ export interface FetchOptions {
 }
 ```
 
-<details>
-
-<summary>Interface FetchOptions Details</summary>
-
 #### Property body
 
 An object or null to set request's body.
@@ -233,8 +223,6 @@ A string to set request's method.
 method?: string
 ```
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -250,10 +238,6 @@ export interface HttpClient {
 
 See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse)
 
-<details>
-
-<summary>Interface HttpClient Details</summary>
-
 #### Property request
 
 Makes a request to the server.
@@ -263,8 +247,6 @@ request: <T = any, D = any>(url: string, options: HttpClientRequestOptions<D>) =
 ```
 See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -280,10 +262,6 @@ export interface HttpClientRequestOptions<Data = any> {
 }
 ```
 
-<details>
-
-<summary>Interface HttpClientRequestOptions Details</summary>
-
 #### Property data
 
 An object or null to set request's body.
@@ -308,8 +286,6 @@ A string to set request's method.
 method?: string
 ```
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -442,10 +418,6 @@ export interface WhatsOnChainConfig {
 
 See also: [HttpClient](./transaction.md#interface-httpclient)
 
-<details>
-
-<summary>Interface WhatsOnChainConfig Details</summary>
-
 #### Property apiKey
 
 Authentication token for the WhatsOnChain API
@@ -463,8 +435,6 @@ httpClient?: HttpClient
 ```
 See also: [HttpClient](./transaction.md#interface-httpclient)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -509,10 +479,6 @@ export default class ARC implements Broadcaster {
 
 See also: [ArcConfig](./transaction.md#interface-arcconfig), [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [Transaction](./transaction.md#class-transaction)
 
-<details>
-
-<summary>Class ARC Details</summary>
-
 #### Constructor
 
 Constructs an instance of the ARC broadcaster.
@@ -581,8 +547,6 @@ Argument Details
 + **txs**
   + Array of transactions to be broadcasted.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -633,10 +597,6 @@ export class Beef {
 
 See also: [BEEF_V2](./transaction.md#variable-beef_v2), [BeefTx](./transaction.md#class-beeftx), [ChainTracker](./transaction.md#interface-chaintracker), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [Transaction](./transaction.md#class-transaction), [Writer](./primitives.md#class-writer), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
 
-<details>
-
-<summary>Class Beef Details</summary>
-
 #### Method addComputedLeaves
 
 In some circumstances it may be helpful for the BUMP MerklePaths to include
@@ -990,8 +950,6 @@ Argument Details
 + **allowTxidOnly**
   + optional. If true, transaction txid is assumed valid
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1031,10 +989,6 @@ export class BeefParty extends Beef {
 
 See also: [Beef](./transaction.md#class-beef)
 
-<details>
-
-<summary>Class BeefParty Details</summary>
-
 #### Constructor
 
 ```ts
@@ -1120,8 +1074,6 @@ mergeBeefFromParty(party: string, beef: number[] | Beef): void
 ```
 See also: [Beef](./transaction.md#class-beef)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1161,10 +1113,6 @@ export default class BeefTx {
 
 See also: [Reader](./primitives.md#class-reader), [Transaction](./transaction.md#class-transaction), [Writer](./primitives.md#class-writer)
 
-<details>
-
-<summary>Class BeefTx Details</summary>
-
 #### Constructor
 
 ```ts
@@ -1189,8 +1137,6 @@ Typically set by sorting transactions by proven dependency chains.
 isValid?: boolean = undefined
 ```
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1255,10 +1201,6 @@ export default class MerklePath {
 
 See also: [ChainTracker](./transaction.md#interface-chaintracker), [MerklePathLeaf](./transaction.md#interface-merklepathleaf), [Reader](./primitives.md#class-reader), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
 
-<details>
-
-<summary>Class MerklePath Details</summary>
-
 #### Method combine
 
 Combines this MerklePath with another to create a compound proof.
@@ -1417,8 +1359,6 @@ Argument Details
 + **chainTracker**
   + The ChainTracker instance used to verify the Merkle root.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1452,10 +1392,6 @@ export default class SatoshisPerKilobyte implements FeeModel {
 
 See also: [FeeModel](./transaction.md#interface-feemodel), [Transaction](./transaction.md#class-transaction)
 
-<details>
-
-<summary>Class SatoshisPerKilobyte Details</summary>
-
 #### Constructor
 
 Constructs an instance of the sat/kb fee model.
@@ -1487,8 +1423,6 @@ Argument Details
 + **tx**
   + The transaction for which a fee is to be computed.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1565,10 +1499,6 @@ export default class Transaction {
 
 See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [ChainTracker](./transaction.md#interface-chaintracker), [FeeModel](./transaction.md#interface-feemodel), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [SatoshisPerKilobyte](./transaction.md#class-satoshisperkilobyte), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput), [defaultBroadcaster](./transaction.md#function-defaultbroadcaster), [defaultChainTracker](./transaction.md#function-defaultchaintracker), [sign](./compat.md#variable-sign), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
 
-<details>
-
-<summary>Class Transaction Details</summary>
-
 #### Method addInput
 
 Adds a new input to the transaction.
@@ -2063,8 +1993,6 @@ Example
 tx.verify(new WhatsOnChain(), new SatoshisPerKilobyte(1))
 ```
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -2084,10 +2012,6 @@ export default class WhatsOnChain implements ChainTracker {
 
 See also: [ChainTracker](./transaction.md#interface-chaintracker), [WhatsOnChainConfig](./transaction.md#interface-whatsonchainconfig)
 
-<details>
-
-<summary>Class WhatsOnChain Details</summary>
-
 #### Constructor
 
 Constructs an instance of the WhatsOnChain ChainTracker.
@@ -2104,8 +2028,6 @@ Argument Details
 + **config**
   + Configuration options for the WhatsOnChain ChainTracker.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---

package/docs/wallet.md

@@ -502,10 +502,6 @@ export interface KeyDeriverApi {
 
 See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
 
-<details>
-
-<summary>Interface KeyDeriverApi Details</summary>
-
 #### Property derivePrivateKey
 
 Derives a private key based on protocol ID, key ID, and counterparty.
@@ -570,8 +566,6 @@ rootKey: PrivateKey
 ```
 See also: [PrivateKey](./primitives.md#class-privatekey)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1197,10 +1191,6 @@ export interface WalletInterface {
 
 See also: [AbortActionArgs](./wallet.md#interface-abortactionargs), [AbortActionResult](./wallet.md#interface-abortactionresult), [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [CreateHmacArgs](./wallet.md#interface-createhmacargs), [CreateHmacResult](./wallet.md#interface-createhmacresult), [CreateSignatureArgs](./wallet.md#interface-createsignatureargs), [CreateSignatureResult](./wallet.md#interface-createsignatureresult), [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [GetHeaderArgs](./wallet.md#interface-getheaderargs), [GetHeaderResult](./wallet.md#interface-getheaderresult), [GetHeightResult](./wallet.md#interface-getheightresult), [GetNetworkResult](./wallet.md#interface-getnetworkresult), [GetPublicKeyArgs](./wallet.md#interface-getpublickeyargs), [GetPublicKeyResult](./wallet.md#interface-getpublickeyresult), [GetVersionResult](./wallet.md#interface-getversionresult), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [InternalizeActionResult](./wallet.md#interface-internalizeactionresult), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesArgs](./wallet.md#interface-listcertificatesargs), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [RelinquishCertificateArgs](./wallet.md#interface-relinquishcertificateargs), [RelinquishCertificateResult](./wallet.md#interface-relinquishcertificateresult), [RelinquishOutputArgs](./wallet.md#interface-relinquishoutputargs), [RelinquishOutputResult](./wallet.md#interface-relinquishoutputresult), [RevealCounterpartyKeyLinkageArgs](./wallet.md#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](./wallet.md#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](./wallet.md#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](./wallet.md#interface-revealspecifickeylinkageresult), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VerifyHmacArgs](./wallet.md#interface-verifyhmacargs), [VerifyHmacResult](./wallet.md#interface-verifyhmacresult), [VerifySignatureArgs](./wallet.md#interface-verifysignatureargs), [VerifySignatureResult](./wallet.md#interface-verifysignatureresult), [WalletCertificate](./wallet.md#interface-walletcertificate), [WalletDecryptArgs](./wallet.md#interface-walletdecryptargs), [WalletDecryptResult](./wallet.md#interface-walletdecryptresult), [WalletEncryptArgs](./wallet.md#interface-walletencryptargs), [WalletEncryptResult](./wallet.md#interface-walletencryptresult), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
 
-<details>
-
-<summary>Interface WalletInterface Details</summary>
-
 #### Property abortAction
 
 Aborts a transaction that is in progress and has not yet been finalized or sent to the network.
@@ -1453,8 +1443,6 @@ waitForAuthentication: (args: object, originator?: OriginatorDomainNameStringUnd
 ```
 See also: [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1546,10 +1534,6 @@ export default class CachedKeyDeriver {
 
 See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
 
-<details>
-
-<summary>Class CachedKeyDeriver Details</summary>
-
 #### Constructor
 
 Initializes the CachedKeyDeriver instance with a root private key and optional cache settings.
@@ -1689,8 +1673,6 @@ Argument Details
 + **keyID**
   + The key identifier.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1955,10 +1937,6 @@ export class KeyDeriver implements KeyDeriverApi {
 
 See also: [Counterparty](./wallet.md#type-counterparty), [KeyDeriverApi](./wallet.md#interface-keyderiverapi), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol)
 
-<details>
-
-<summary>Class KeyDeriver Details</summary>
-
 #### Constructor
 
 Initializes the KeyDeriver instance with a root private key.
@@ -2087,8 +2065,6 @@ Argument Details
 + **keyID**
   + The key identifier.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.3.15",
+  "version": "1.3.18",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",
@@ -239,6 +239,7 @@
     "project": "tsconfig.eslint.json",
     "ignore": [
       "dist",
+      "src/script/ScriptTemplate.ts",
       "src/transaction/Transaction.ts",
       "src/auth/transports/SimplifiedFetchTransport.ts"
     ]

package/src/script/ScriptTemplate.ts

@@ -1,6 +1,5 @@
 import LockingScript from './LockingScript.js'
-import UnlockingScript from './UnlockingScript.js'
-import Transaction from '../transaction/Transaction.js'
+import ScriptTemplateUnlock from './ScriptTemplateUnlock.js'
 
 /**
  * @interface
@@ -12,10 +11,10 @@ export default interface ScriptTemplate {
   /**
    * Creates a locking script with the given parameters.
    *
-   * @param {...any} params - The parameters required to create the locking script.
+   * @param {...any[]} params - The parameters required to create the locking script.
    * @returns {LockingScript} - An instance of LockingScript, or a Promise for one.
    */
-  lock: (...params: unknown[]) => LockingScript | Promise<LockingScript>
+  lock: (...params: any[]) => LockingScript | Promise<LockingScript>
 
   /**
    * Creates a function that generates an unlocking script along with its signature and length estimation.
@@ -24,11 +23,8 @@ export default interface ScriptTemplate {
    * 1. `sign` - A function that, when called with a transaction and an input index, returns an UnlockingScript instance.
    * 2. `estimateLength` - A function that returns the estimated length of the unlocking script in bytes.
    *
-   * @param {...any} params - The parameters required to create the unlocking script.
-   * @returns {Object} - An object containing the `sign` and `estimateLength` functions.
+   * @param {...any[]} params - The parameters required to create the unlocking script.
+   * @returns {ScriptTemplateUnlock} - An object containing the `sign` and `estimateLength` functions.
    */
-  unlock: (...params: unknown[]) => {
-    sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>
-    estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>
-  }
+  unlock: (...params: any[]) => ScriptTemplateUnlock
 }

package/src/script/ScriptTemplateUnlock.ts

@@ -0,0 +1,7 @@
+import UnlockingScript from './UnlockingScript.js'
+import Transaction from '../transaction/Transaction.js'
+
+export default interface ScriptTemplateUnlock {
+  sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>
+  estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>
+}

package/src/script/index.ts

@@ -3,5 +3,6 @@ export { default as Script } from './Script.js'
 export { default as LockingScript } from './LockingScript.js'
 export { default as UnlockingScript } from './UnlockingScript.js'
 export { default as Spend } from './Spend.js'
+export type { default as ScriptTemplateUnlock } from './ScriptTemplateUnlock.js'
 export type { default as ScriptTemplate } from './ScriptTemplate.js'
 export * from './templates/index.js'

package/src/wallet/substrates/HTTPWalletJSON.ts

@@ -64,9 +64,16 @@ export default class HTTPWalletJSON implements WalletInterface {
             body: JSON.stringify(args)
           })
         ).json()
+        if (!response.ok) {
+          const err = {
+            call,
+            args,
+            message: response.message || `HTTP Client error ${response.status}`
+          }
+          throw new Error(JSON.stringify(err))
+        }
         return response
       } catch (error) {
-        console.log({ HTTPWalletJSON: { call, args, error } })
         throw error
       }
     }