@bsv/sdk 1.2.14 → 1.2.17

package/docs/transaction.md

@@ -624,6 +624,7 @@ export class Beef {
     trimKnownTxids(knownTxids: string[]) 
     getValidTxids(): string[] 
     toLogString(): string 
+    addComputedLeaves() 
 }
 ```
 
@@ -633,6 +634,15 @@ See also: [BeefTx](#class-beeftx), [BeefVersion](#type-beefversion), [ChainTrack
 
 <summary>Class Beef Details</summary>
 
+#### Method addComputedLeaves
+
+In some circumstances it may be helpful for the BUMP MerkePaths to include
+leaves that can be computed from row zero.
+
+```ts
+addComputedLeaves() 
+```
+
 #### Method clone
 
 ```ts
@@ -902,8 +912,9 @@ A binary array representing the BEEF
 
 Serialize this Beef as AtomicBEEF.
 
-`txid` must exist and be the last transaction
-in sorted (dependency) order.
+`txid` must exist
+
+after sorting, if txid is not last txid, creates a clone and removes newer txs
 
 ```ts
 toBinaryAtomic(txid: string) 
@@ -1217,7 +1228,7 @@ export default class MerklePath {
         duplicate?: boolean;
     }>>;
     static fromHex(hex: string): MerklePath 
-    static fromReader(reader: Reader): MerklePath 
+    static fromReader(reader: Reader, legalOffsetsOnly: boolean = true): MerklePath 
     static fromBinary(bump: number[]): MerklePath 
     static fromCoinbaseTxidAndHeight(txid: string, height: number): MerklePath 
     constructor(blockHeight: number, path: Array<Array<{
@@ -1225,7 +1236,7 @@ export default class MerklePath {
         hash?: string;
         txid?: boolean;
         duplicate?: boolean;
-    }>>) 
+    }>>, legalOffsetsOnly: boolean = true) 
     toBinary(): number[] 
     toHex(): string 
     computeRoot(txid?: string): string 
@@ -1524,6 +1535,7 @@ export default class Transaction {
     constructor(version: number = 1, inputs: TransactionInput[] = [], outputs: TransactionOutput[] = [], lockTime: number = 0, metadata: Record<string, any> = {}, merklePath?: MerklePath) 
     addInput(input: TransactionInput): void 
     addOutput(output: TransactionOutput): void 
+    addP2PKHOutput(address: number[] | string, satoshis?: number): void 
     updateMetadata(metadata: Record<string, any>): void 
     async fee(modelOrFee: FeeModel | number = new SatoshisPerKilobyte(10), changeDistribution: "equal" | "random" = "equal"): Promise<void> 
     getFee(): number 
@@ -1583,6 +1595,21 @@ Argument Details
 + **output**
   + The TransactionOutput object to add to the transaction.
 
+#### Method addP2PKHOutput
+
+Adds a new P2PKH output to the transaction.
+
+```ts
+addP2PKHOutput(address: number[] | string, satoshis?: number): void 
+```
+
+Argument Details
+
++ **address**
+  + The P2PKH address of the output.
++ **satoshis**
+  + The number of satoshis to send to the address - if not provided, the output is considered a change output.
+
 #### Method broadcast
 
 Broadcasts a transaction.