@bsv/sdk 1.3.22 → 1.3.24

package/docs/overlay-tools.md

@@ -262,7 +262,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 | [HTTPSOverlayLookupFacilitator](#class-httpsoverlaylookupfacilitator) |
 | [LookupResolver](#class-lookupresolver) |
 | [OverlayAdminTokenTemplate](#class-overlayadmintokentemplate) |
-| [SHIPCast](#class-shipcast) |
+| [SHIPBroadcaster](#class-shipbroadcaster) |
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -430,12 +430,12 @@ Argument Details
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-### Class: SHIPCast
+### Class: SHIPBroadcaster
 
 Represents a SHIP transaction broadcaster.
 
 ```ts
-export default class SHIPCast implements Broadcaster {
+export default class SHIPBroadcaster implements Broadcaster {
     constructor(topics: string[], config?: SHIPBroadcasterConfig) 
     async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure> 
 }

package/docs/script.md

@@ -211,11 +211,12 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ```ts
 export default class PushDrop implements ScriptTemplate {
     wallet: WalletInterface;
+    originator?: string;
     static decode(script: LockingScript): {
         lockingPublicKey: PublicKey;
         fields: number[][];
     } 
-    constructor(wallet: WalletInterface) 
+    constructor(wallet: WalletInterface, originator?: string) 
     async lock(fields: number[][], protocolID: [
         SecurityLevel,
         string
@@ -237,7 +238,7 @@ See also: [LockingScript](./script.md#class-lockingscript), [PublicKey](./primit
 Constructs a new instance of the PushDrop class.
 
 ```ts
-constructor(wallet: WalletInterface) 
+constructor(wallet: WalletInterface, originator?: string) 
 ```
 See also: [WalletInterface](./wallet.md#interface-walletinterface)
 
@@ -245,6 +246,8 @@ Argument Details
 
 + **wallet**
   + The wallet interface used for creating signatures and accessing public keys.
++ **originator**
+  + — The originator to use with Wallet requests
 
 #### Method decode
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.3.22",
+  "version": "1.3.24",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package/src/overlay-tools/SHIPBroadcaster.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import {
   Transaction,
   BroadcastResponse,
@@ -60,10 +59,7 @@ export interface SHIPBroadcasterConfig {
   /** Determines which topics (all, any, or a specific list) must be present within STEAK received from at least one host for the broadcast to be considered a success. */
   requireAcknowledgmentFromAnyHostForTopics?: 'all' | 'any' | string[]
   /** Determines a mapping whose keys are specific hosts and whose values are the topics (all, any, or a specific list) that must be present within the STEAK received by the given hosts, in order for the broadcast to be considered a success. */
-  requireAcknowledgmentFromSpecificHostsForTopics?: Record<
-  string,
-  'all' | 'any' | string[]
-  >
+  requireAcknowledgmentFromSpecificHostsForTopics?: Record<string, 'all' | 'any' | string[]>
 }
 
 /** Facilitates transaction broadcasts that return STEAK. */
@@ -73,8 +69,7 @@ export interface OverlayBroadcastFacilitator {
 
 const MAX_SHIP_QUERY_TIMEOUT = 1000
 
-export class HTTPSOverlayBroadcastFacilitator
-implements OverlayBroadcastFacilitator {
+export class HTTPSOverlayBroadcastFacilitator implements OverlayBroadcastFacilitator {
   httpClient: typeof fetch
 
   constructor (httpClient = fetch) {
@@ -106,24 +101,13 @@ implements OverlayBroadcastFacilitator {
 /**
  * Represents a SHIP transaction broadcaster.
  */
-export default class SHIPCast implements Broadcaster {
+export default class SHIPBroadcaster implements Broadcaster {
   private readonly topics: string[]
   private readonly facilitator: OverlayBroadcastFacilitator
   private readonly resolver: LookupResolver
-  private readonly requireAcknowledgmentFromAllHostsForTopics:
-  | 'all'
-  | 'any'
-  | string[]
-
-  private readonly requireAcknowledgmentFromAnyHostForTopics:
-  | 'all'
-  | 'any'
-  | string[]
-
-  private readonly requireAcknowledgmentFromSpecificHostsForTopics: Record<
-  string,
-  'all' | 'any' | string[]
-  >
+  private readonly requireAcknowledgmentFromAllHostsForTopics: | 'all' | 'any' | string[]
+  private readonly requireAcknowledgmentFromAnyHostForTopics: | 'all' | 'any' | string[]
+  private readonly requireAcknowledgmentFromSpecificHostsForTopics: Record<string, 'all' | 'any' | string[]>
 
   /**
    * Constructs an instance of the SHIP broadcaster.
@@ -145,7 +129,7 @@ export default class SHIPCast implements Broadcaster {
       requireAcknowledgmentFromAllHostsForTopics,
       requireAcknowledgmentFromAnyHostForTopics,
       requireAcknowledgmentFromSpecificHostsForTopics
-    } = config ?? defaultConfig
+    } = config ?? {}
     this.facilitator = facilitator ?? new HTTPSOverlayBroadcastFacilitator()
     this.resolver = resolver ?? new LookupResolver()
     this.requireAcknowledgmentFromAllHostsForTopics =
@@ -215,14 +199,14 @@ export default class SHIPCast implements Broadcaster {
 
     for (const result of successfulHosts) {
       const host = result.host
-      const steak = result.steak
+      const steak = result.steak as STEAK
 
       const acknowledgedTopics = new Set<string>()
 
       for (const [topic, instructions] of Object.entries(steak)) {
         const outputsToAdmit = instructions.outputsToAdmit
         const coinsToRetain = instructions.coinsToRetain
-        const coinsRemoved = instructions.coinsRemoved
+        const coinsRemoved = instructions.coinsRemoved as number[]
 
         if (
           outputsToAdmit?.length > 0 ||

package/src/script/templates/PushDrop.ts

@@ -57,6 +57,7 @@ const createMinimallyEncodedScriptChunk = (
 
 export default class PushDrop implements ScriptTemplate {
   wallet: WalletInterface
+  originator?: string
 
   /**
    * Decodes a PushDrop script back into its token fields and the locking public key. If a signature was present, it will be the last field returned.
@@ -105,9 +106,11 @@ export default class PushDrop implements ScriptTemplate {
    * Constructs a new instance of the PushDrop class.
    *
    * @param {WalletInterface} wallet - The wallet interface used for creating signatures and accessing public keys.
+   * @param {string} originator — The originator to use with Wallet requests
    */
-  constructor(wallet: WalletInterface) {
+  constructor(wallet: WalletInterface, originator?: string) {
     this.wallet = wallet
+    this.originator = originator
   }
 
   /**
@@ -135,7 +138,7 @@ export default class PushDrop implements ScriptTemplate {
       keyID,
       counterparty,
       forSelf
-    })
+    }, this.originator)
     const lockChunks: Array<{ op: number, data?: number[] }> = []
     const pushDropChunks: Array<{ op: number, data?: number[] }> = []
     lockChunks.push({
@@ -150,7 +153,7 @@ export default class PushDrop implements ScriptTemplate {
         protocolID,
         keyID,
         counterparty
-      })
+      }, this.originator)
       fields.push(signature)
     }
     for (const field of fields) {
@@ -263,7 +266,7 @@ export default class PushDrop implements ScriptTemplate {
           protocolID,
           keyID,
           counterparty
-        })
+        }, this.originator)
         const signature = Signature.fromDER([...bareSignature])
         const txSignature = new TransactionSignature(
           signature.r,