@btc-vision/transaction 1.8.0-beta.1 → 1.8.0-beta.4

package/browser/verification/TapscriptVerificator.d.ts

@@ -1,21 +1,23 @@
-import { Network, Taptree } from '../../node_modules/@btc-vision/bitcoin/build/index.js';
+import { Network, PublicKey, Taptree } from '../../node_modules/@btc-vision/bitcoin/browser/index.js';
 import { IChallengeSolution } from '../epoch/interfaces/IChallengeSolution.js';
 import { Feature, Features } from '../generators/Features.js';
 export interface ContractAddressVerificationParams {
-    readonly deployerPubKey: Buffer;
-    readonly contractSaltPubKey: Buffer;
-    readonly originalSalt: Buffer;
-    readonly bytecode: Buffer;
+    readonly deployerPubKey: PublicKey;
+    readonly contractSaltPubKey: Uint8Array;
+    readonly originalSalt: Uint8Array;
+    readonly bytecode: Uint8Array;
     readonly challenge: IChallengeSolution;
     readonly priorityFee: bigint;
     readonly features: Feature<Features>[];
-    readonly calldata?: Buffer;
+    readonly calldata?: Uint8Array;
     readonly network?: Network;
 }
 export declare class TapscriptVerificator {
     private static readonly TAP_SCRIPT_VERSION;
     static getContractAddress(params: ContractAddressVerificationParams): string | undefined;
-    static verifyControlBlock(params: ContractAddressVerificationParams, controlBlock: Buffer): boolean;
-    static getContractSeed(deployerPubKey: Buffer, bytecode: Buffer, saltHash: Buffer): Buffer;
+    static verifyControlBlock(params: ContractAddressVerificationParams, controlBlock: Uint8Array): boolean;
+    static getContractSeed(deployerPubKey: Uint8Array, bytecode: Uint8Array, saltHash: Uint8Array): Uint8Array;
     static generateAddressFromScript(params: ContractAddressVerificationParams, scriptTree: Taptree): string | undefined;
+    private static buildScriptTree;
 }
+//# sourceMappingURL=TapscriptVerificator.d.ts.map

package/browser/verification/TapscriptVerificator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TapscriptVerificator.d.ts","sourceRoot":"","sources":["../../src/verification/TapscriptVerificator.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,KAAK,OAAO,EAMZ,KAAK,SAAS,EAGd,KAAK,OAAO,EAEf,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AACpF,OAAO,EAAE,KAAK,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAEnE,MAAM,WAAW,iCAAiC;IAC9C,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC;IACnC,QAAQ,CAAC,kBAAkB,EAAE,UAAU,CAAC;IACxC,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACvC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC9B;AAQD,qBAAa,oBAAoB;IAC7B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAe;WAE3C,kBAAkB,CAC5B,MAAM,EAAE,iCAAiC,GAC1C,MAAM,GAAG,SAAS;WAMP,kBAAkB,CAC5B,MAAM,EAAE,iCAAiC,EACzC,YAAY,EAAE,UAAU,GACzB,OAAO;WAuBI,eAAe,CACzB,cAAc,EAAE,UAAU,EAC1B,QAAQ,EAAE,UAAU,EACpB,QAAQ,EAAE,UAAU,GACrB,UAAU;WAMC,yBAAyB,CACnC,MAAM,EAAE,iCAAiC,EACzC,UAAU,EAAE,OAAO,GACpB,MAAM,GAAG,SAAS;IAWrB,OAAO,CAAC,MAAM,CAAC,eAAe;CAqCjC"}

package/build/_version.d.ts

@@ -1 +1,2 @@
 export declare const version = "1.8.0-beta.1";
+//# sourceMappingURL=_version.d.ts.map

package/build/_version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_version.d.ts","sourceRoot":"","sources":["../src/_version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,iBAAiB,CAAC"}

package/build/_version.js

@@ -1 +1,2 @@
 export const version = '1.8.0-beta.1';
+//# sourceMappingURL=_version.js.map

package/build/_version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_version.js","sourceRoot":"","sources":["../src/_version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,cAAc,CAAC"}

package/build/abi/ABICoder.d.ts

@@ -36,6 +36,6 @@ export declare class ABICoder {
     decodeData(data: Uint8Array, types: ABIDataTypes[]): unknown[];
     encodeSelector(selectorIdentifier: string): string;
     numericSelectorToHex(selector: number): string;
-    private bigIntToUint8Array;
     private sha256;
 }
+//# sourceMappingURL=ABICoder.d.ts.map

package/build/abi/ABICoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ABICoder.d.ts","sourceRoot":"","sources":["../../src/abi/ABICoder.ts"],"names":[],"mappings":"AAGA,oBAAY,YAAY;IAEpB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IAGnB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,MAAM,WAAW;IAGjB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,KAAK,UAAU;IAGf,qBAAqB,0BAA0B;IAC/C,8BAA8B,mCAAmC;IAGjE,iBAAiB,sBAAsB;IAGvC,kBAAkB,uBAAuB;IACzC,2BAA2B,gCAAgC;IAC3D,gBAAgB,qBAAqB;IACrC,gBAAgB,qBAAqB;IACrC,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;CACxC;AAED,qBAAa,QAAQ;IACV,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,OAAO,EAAE;IA6G9D,cAAc,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM;IAQlD,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIrD,OAAO,CAAC,MAAM;CAGjB"}

package/build/abi/ABICoder.js

@@ -1,19 +1,21 @@
 import shajs from 'sha.js';
 import { BinaryReader } from '../buffer/BinaryReader.js';
-import { BufferHelper } from '../utils/BufferHelper.js';
 export var ABIDataTypes;
 (function (ABIDataTypes) {
+    // Unsigned integers
     ABIDataTypes["UINT8"] = "UINT8";
     ABIDataTypes["UINT16"] = "UINT16";
     ABIDataTypes["UINT32"] = "UINT32";
     ABIDataTypes["UINT64"] = "UINT64";
     ABIDataTypes["UINT128"] = "UINT128";
     ABIDataTypes["UINT256"] = "UINT256";
+    // Signed integers
     ABIDataTypes["INT8"] = "INT8";
     ABIDataTypes["INT16"] = "INT16";
     ABIDataTypes["INT32"] = "INT32";
     ABIDataTypes["INT64"] = "INT64";
     ABIDataTypes["INT128"] = "INT128";
+    // Basic types
     ABIDataTypes["BOOL"] = "BOOL";
     ABIDataTypes["ADDRESS"] = "ADDRESS";
     ABIDataTypes["EXTENDED_ADDRESS"] = "EXTENDED_ADDRESS";
@@ -21,9 +23,12 @@ export var ABIDataTypes;
     ABIDataTypes["BYTES4"] = "BYTES4";
     ABIDataTypes["BYTES32"] = "BYTES32";
     ABIDataTypes["BYTES"] = "BYTES";
+    // Tuples/Maps
     ABIDataTypes["ADDRESS_UINT256_TUPLE"] = "ADDRESS_UINT256_TUPLE";
     ABIDataTypes["EXTENDED_ADDRESS_UINT256_TUPLE"] = "EXTENDED_ADDRESS_UINT256_TUPLE";
+    // Signatures
     ABIDataTypes["SCHNORR_SIGNATURE"] = "SCHNORR_SIGNATURE";
+    // Arrays
     ABIDataTypes["ARRAY_OF_ADDRESSES"] = "ARRAY_OF_ADDRESSES";
     ABIDataTypes["ARRAY_OF_EXTENDED_ADDRESSES"] = "ARRAY_OF_EXTENDED_ADDRESSES";
     ABIDataTypes["ARRAY_OF_UINT256"] = "ARRAY_OF_UINT256";
@@ -144,22 +149,16 @@ export class ABICoder {
         return result;
     }
     encodeSelector(selectorIdentifier) {
+        // first 4 bytes of sha256 hash of the function signature
         const hash = this.sha256(selectorIdentifier);
-        const selector = Buffer.from(hash.subarray(0, 4));
+        const selector = Buffer.from(hash.subarray(0, 4)); // 4 bytes
         return selector.toString('hex');
     }
     numericSelectorToHex(selector) {
         return selector.toString(16);
     }
-    bigIntToUint8Array(bigIntValue, length) {
-        const byteArray = new Uint8Array(length);
-        const buf = BufferHelper.valueToUint8Array(bigIntValue);
-        for (let i = 0; i < length; i++) {
-            byteArray[i] = buf[i] || 0;
-        }
-        return byteArray;
-    }
     sha256(buffer) {
         return new shajs.sha256().update(buffer).digest();
     }
 }
+//# sourceMappingURL=ABICoder.js.map

package/build/abi/ABICoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ABICoder.js","sourceRoot":"","sources":["../../src/abi/ABICoder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,QAAQ,CAAC;AAE3B,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,MAAM,CAAN,IAAY,YA4CX;AA5CD,WAAY,YAAY;IACpB,oBAAoB;IACpB,+BAAe,CAAA;IACf,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,mCAAmB,CAAA;IAEnB,kBAAkB;IAClB,6BAAa,CAAA;IACb,+BAAe,CAAA;IACf,+BAAe,CAAA;IACf,+BAAe,CAAA;IACf,iCAAiB,CAAA;IAEjB,cAAc;IACd,6BAAa,CAAA;IACb,mCAAmB,CAAA;IACnB,qDAAqC,CAAA;IACrC,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IAEf,cAAc;IACd,+DAA+C,CAAA;IAC/C,iFAAiE,CAAA;IAEjE,aAAa;IACb,uDAAuC,CAAA;IAEvC,SAAS;IACT,yDAAyC,CAAA;IACzC,2EAA2D,CAAA;IAC3D,qDAAqC,CAAA;IACrC,qDAAqC,CAAA;IACrC,mDAAmC,CAAA;IACnC,mDAAmC,CAAA;IACnC,mDAAmC,CAAA;IACnC,iDAAiC,CAAA;IACjC,mDAAmC,CAAA;IACnC,iDAAiC,CAAA;IACjC,qDAAqC,CAAA;AACzC,CAAC,EA5CW,YAAY,KAAZ,YAAY,QA4CvB;AAED,MAAM,OAAO,QAAQ;IACV,UAAU,CAAC,IAAgB,EAAE,KAAqB;QACrD,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAc,EAAE,CAAC;QAE7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,QAAQ,IAAI,EAAE,CAAC;gBACX,KAAK,YAAY,CAAC,KAAK;oBACnB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;oBACjC,MAAM;gBACV,KAAK,YAAY,CAAC,MAAM;oBACpB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,YAAY,CAAC,MAAM;oBACpB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,YAAY,CAAC,MAAM;oBACpB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;oBACrC,MAAM;gBACV,KAAK,YAAY,CAAC,OAAO;oBACrB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;oBACtC,MAAM;gBACV,KAAK,YAAY,CAAC,IAAI;oBAClB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;oBACtC,MAAM;gBACV,KAAK,YAAY,CAAC,OAAO;oBACrB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;oBACtC,MAAM;gBACV,KAAK,YAAY,CAAC,MAAM;oBACpB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;oBAC/C,MAAM;gBACV,KAAK,YAAY,CAAC,OAAO;oBACrB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACnC,MAAM;gBACV,KAAK,YAAY,CAAC,OAAO;oBACrB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACnC,MAAM;gBACV,KAAK,YAAY,CAAC,IAAI;oBAClB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;oBACjC,MAAM;gBACV,KAAK,YAAY,CAAC,KAAK;oBACnB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,YAAY,CAAC,KAAK;oBACnB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,YAAY,CAAC,KAAK;oBACnB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,YAAY,CAAC,MAAM;oBACpB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACnC,MAAM;gBACV,KAAK,YAAY,CAAC,gBAAgB;oBAC9B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC;oBAC9C,MAAM;gBACV,KAAK,YAAY,CAAC,qBAAqB;oBACnC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC;oBAChD,MAAM;gBACV,KAAK,YAAY,CAAC,8BAA8B;oBAC5C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAC,CAAC;oBACrD,MAAM;gBACV,KAAK,YAAY,CAAC,iBAAiB;oBAC/B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;oBAC/C,MAAM;gBACV,KAAK,YAAY,CAAC,KAAK;oBACnB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC;oBAC9C,MAAM;gBACV,KAAK,YAAY,CAAC,MAAM;oBACpB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,YAAY,CAAC,kBAAkB;oBAChC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,CAAC;oBAC3C,MAAM;gBACV,KAAK,YAAY,CAAC,2BAA2B;oBACzC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAC,CAAC;oBACnD,MAAM;gBACV,KAAK,YAAY,CAAC,gBAAgB;oBAC9B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC;oBACxC,MAAM;gBACV,KAAK,YAAY,CAAC,gBAAgB;oBAC9B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC;oBACxC,MAAM;gBACV,KAAK,YAAY,CAAC,eAAe;oBAC7B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,CAAC;oBACvC,MAAM;gBACV,KAAK,YAAY,CAAC,eAAe;oBAC7B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,CAAC;oBACvC,MAAM;gBACV,KAAK,YAAY,CAAC,eAAe;oBAC7B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,CAAC;oBACvC,MAAM;gBACV,KAAK,YAAY,CAAC,cAAc;oBAC5B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;oBACtC,MAAM;gBACV,KAAK,YAAY,CAAC,eAAe;oBAC7B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC;oBAC1C,MAAM;gBACV,KAAK,YAAY,CAAC,cAAc;oBAC5B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;oBACzC,MAAM;gBACV,KAAK,YAAY,CAAC,gBAAgB;oBAC9B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,CAAC;oBAC5C,MAAM;YACd,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,cAAc,CAAC,kBAA0B;QAC5C,yDAAyD;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU;QAE7D,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAEM,oBAAoB,CAAC,QAAgB;QACxC,OAAO,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAEO,MAAM,CAAC,MAAoC;QAC/C,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;IACtD,CAAC;CACJ"}

package/build/branded/Branded.d.ts

@@ -0,0 +1,4 @@
+import type { Brand } from '@btc-vision/ecpair';
+export type MLDSAHashedPublicKey = Brand<Uint8Array, 'MLDSAHashedPublicKey'>;
+export type HybridPublicKey = Brand<Uint8Array, 'HybridPublicKey'>;
+//# sourceMappingURL=Branded.d.ts.map

package/build/branded/Branded.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Branded.d.ts","sourceRoot":"","sources":["../../src/branded/Branded.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAEhD,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAAC;AAE7E,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC"}

package/build/branded/Branded.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Branded.js.map

package/build/branded/Branded.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Branded.js","sourceRoot":"","sources":["../../src/branded/Branded.ts"],"names":[],"mappings":""}

package/build/buffer/BinaryReader.d.ts

@@ -1,42 +1,138 @@
 import { AddressMap } from '../deterministic/AddressMap.js';
 import { ExtendedAddressMap } from '../deterministic/ExtendedAddressMap.js';
 import { Address } from '../keypair/Address.js';
-import { BufferLike, i16, i32, i64, i8, Selector, u16, u32, u8 } from '../utils/types.js';
+import type { BufferLike, i16, i32, i64, i8, Selector, u16, u32, u8 } from '../utils/types.js';
+/**
+ * Represents a Schnorr signature paired with the signer's Address.
+ * This class bundles a 64-byte Schnorr signature with its associated
+ * full Address (both MLDSA and tweaked keys), providing a complete signed data structure
+ * for Bitcoin Taproot-compatible signatures.
+ */
 export interface SchnorrSignature {
+    /** The signer's Address containing both MLDSA and tweaked public keys */
     readonly address: Address;
+    /** The 64-byte Schnorr signature */
     readonly signature: Uint8Array;
 }
 export declare class BinaryReader {
     private buffer;
     private currentOffset;
     constructor(bytes: BufferLike);
+    get byteLength(): number;
     static stringCompare(a: string, b: string): number;
     static bigintCompare(a: bigint, b: bigint): number;
     static numberCompare(a: number, b: number): number;
     setBuffer(bytes: BufferLike): void;
-    get byteLength(): number;
     length(): number;
     bytesLeft(): number;
+    /**
+     * Reads a single signed byte (i8).
+     */
     readI8(): i8;
+    /**
+     * Reads a signed 16-bit integer. By default, big-endian.
+     * @param be - Endianness; true means big-endian (the default).
+     */
     readI16(be?: boolean): i16;
+    /**
+     * Reads a signed 32-bit integer. By default, big-endian.
+     * @param be - Endianness; true means big-endian (the default).
+     */
     readI32(be?: boolean): i32;
+    /**
+     * Reads a signed 64-bit integer. By default, big-endian.
+     * @param be - Endianness; true means big-endian (the default).
+     */
     readI64(be?: boolean): i64;
+    /**
+     * Reads a single unsigned byte (u8).
+     */
     readU8(): u8;
+    /**
+     * Reads an unsigned 16-bit integer. By default, big-endian.
+     * @param be - Endianness; true means big-endian (the default).
+     */
     readU16(be?: boolean): u16;
+    /**
+     * Reads an unsigned 32-bit integer. By default, big-endian.
+     * @param be - Endianness; true means big-endian (the default).
+     */
     readU32(be?: boolean): u32;
+    /**
+     * Reads an unsigned 64-bit integer. By default, big-endian.
+     * @param be - Endianness; true means big-endian (the default).
+     */
     readU64(be?: boolean): bigint;
+    /**
+     * Reads a 128-bit unsigned integer. By default, read big-endian.
+     * @param be - Endianness; true => big-endian (default).
+     */
     readU128(be?: boolean): bigint;
+    /**
+     * Reads a 256-bit unsigned integer. Same approach as readU128.
+     * @param be - Endianness; true => big-endian (default).
+     */
     readU256(be?: boolean): bigint;
+    /**
+     * Reads a 128-bit signed integer. Interpret the sign bit if big-endian.
+     * @param be - Endianness; true => big-endian (default).
+     */
     readI128(be?: boolean): bigint;
+    /**
+     * Read a boolean (u8 != 0).
+     */
     readBoolean(): boolean;
+    /**
+     * Reads 32 bits
+     */
     readSelector(): Selector;
+    /**
+     * Reads a raw sequence of bytes (length must be known).
+     * If zeroStop = true, stops if we encounter 0x00 early.
+     */
     readBytes(length: u32, zeroStop?: boolean): Uint8Array;
+    /**
+     * Reads a string of the given length in raw bytes. By default, do NOT zero-stop
+     * (matching how we wrote the raw bytes).
+     */
     readString(length: u32): string;
+    /**
+     * Reads a string that was written as [u16 length][raw bytes].
+     */
     readStringWithLength(be?: boolean): string;
+    /**
+     * Reads an address (32 bytes MLDSA key hash only).
+     */
     readAddress(): Address;
+    /**
+     * Reads the tweaked public key portion (32 bytes) and returns it as a raw Uint8Array.
+     * Use this when you only need the tweaked key without the full Address object.
+     */
     readTweakedPublicKey(): Uint8Array;
+    /**
+     * Reads a full address with both MLDSA key hash and tweaked public key (64 bytes total).
+     * Format: [32 bytes tweakedPublicKey][32 bytes MLDSA key hash]
+     *
+     * This is the equivalent of btc-runtime's readExtendedAddress().
+     *
+     * @returns An Address instance with both keys set
+     */
     readExtendedAddress(): Address;
+    /**
+     * Reads a Schnorr signature with its associated full Address.
+     * Format: [64 bytes full Address][64 bytes signature]
+     *
+     * Used for deserializing signed data where both the signer's address
+     * and their Schnorr signature are stored together.
+     *
+     * @returns A SchnorrSignature containing the address and signature
+     */
     readSchnorrSignature(): SchnorrSignature;
+    /**
+     * Reads bytes written as [u32 length][bytes].
+     * @param maxLength if > 0, enforces an upper bound
+     * @param be
+     */
     readBytesWithLength(maxLength?: number, be?: boolean): Uint8Array;
     readArrayOfBuffer(be?: boolean): Uint8Array[];
     readAddressArray(be?: boolean): Address[];
@@ -48,12 +144,35 @@ export declare class BinaryReader {
     readU8Array(): u8[];
     readStringArray(be?: boolean): string[];
     readBytesArray(be?: boolean): Uint8Array[];
+    /**
+     * Reads [u16 length][ (address, u256) pairs ].
+     */
     readAddressValueTuple(be?: boolean): AddressMap<bigint>;
+    /**
+     * Reads an array of full addresses (64 bytes each).
+     * Format: [u16 length][FullAddress 0][FullAddress 1]...
+     */
     readExtendedAddressArray(be?: boolean): Address[];
+    /**
+     * Reads a map of full Address -> u256 using the tweaked key for map lookup.
+     * Format: [u16 length][FullAddress key][u256 value]...
+     *
+     * This is the equivalent of btc-runtime's readExtendedAddressMapU256().
+     */
     readExtendedAddressMapU256(be?: boolean): ExtendedAddressMap<bigint>;
     getOffset(): u16;
     setOffset(offset: u16): void;
+    /**
+     * Verifies we have enough bytes in the buffer to read up to `size`.
+     */
     verifyEnd(size: number): void;
+    /**
+     * Utility: reverses a byte array in-place or returns a reversed copy.
+     */
     private reverseBytes;
+    /**
+     * Utility: turn bytes into a hex string without `0x` prefix.
+     */
     private toHexString;
 }
+//# sourceMappingURL=BinaryReader.d.ts.map

package/build/buffer/BinaryReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BinaryReader.d.ts","sourceRoot":"","sources":["../../src/buffer/BinaryReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAiBhD,OAAO,KAAK,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,mBAAmB,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC7B,yEAAyE;IACzE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,oCAAoC;IACpC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;CAClC;AAED,qBAAa,YAAY;IACrB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,aAAa,CAAa;gBAEtB,KAAK,EAAE,UAAU;IAI7B,IAAW,UAAU,IAAI,MAAM,CAE9B;WAGa,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;WAI3C,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;WAM3C,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAMlD,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAKlC,MAAM,IAAI,MAAM;IAIhB,SAAS,IAAI,MAAM;IAM1B;;OAEG;IACI,MAAM,IAAI,EAAE;IAOnB;;;OAGG;IACI,OAAO,CAAC,EAAE,GAAE,OAAc,GAAG,GAAG;IAOvC;;;OAGG;IACI,OAAO,CAAC,EAAE,GAAE,OAAc,GAAG,GAAG;IAOvC;;;OAGG;IACI,OAAO,CAAC,EAAE,GAAE,OAAc,GAAG,GAAG;IASvC;;OAEG;IACI,MAAM,IAAI,EAAE;IAOnB;;;OAGG;IACI,OAAO,CAAC,EAAE,GAAE,OAAc,GAAG,GAAG;IAOvC;;;OAGG;IACI,OAAO,CAAC,EAAE,GAAE,OAAc,GAAG,GAAG;IAOvC;;;OAGG;IACI,OAAO,CAAC,EAAE,GAAE,OAAc,GAAG,MAAM;IAO1C;;;OAGG;IACI,QAAQ,CAAC,EAAE,GAAE,OAAc,GAAG,MAAM;IAU3C;;;OAGG;IACI,QAAQ,CAAC,EAAE,GAAE,OAAc,GAAG,MAAM;IAS3C;;;OAGG;IACI,QAAQ,CAAC,EAAE,GAAE,OAAc,GAAG,MAAM;IAqB3C;;OAEG;IACI,WAAW,IAAI,OAAO;IAI7B;;OAEG;IACI,YAAY,IAAI,QAAQ;IAI/B;;;OAGG;IACI,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,GAAE,OAAe,GAAG,UAAU;IAepE;;;OAGG;IACI,UAAU,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM;IAMtC;;OAEG;IACI,oBAAoB,CAAC,EAAE,GAAE,OAAc,GAAG,MAAM;IAKvD;;OAEG;IACI,WAAW,IAAI,OAAO;IAK7B;;;OAGG;IACI,oBAAoB,IAAI,UAAU;IAKzC;;;;;;;OAOG;IACI,mBAAmB,IAAI,OAAO;IAYrC;;;;;;;;OAQG;IACI,oBAAoB,IAAI,gBAAgB;IAW/C;;;;OAIG;IACI,mBAAmB,CAAC,SAAS,GAAE,MAAU,EAAE,EAAE,GAAE,OAAc,GAAG,UAAU;IAW1E,iBAAiB,CAAC,EAAE,GAAE,OAAc,GAAG,UAAU,EAAE;IASnD,gBAAgB,CAAC,EAAE,GAAE,OAAc,GAAG,OAAO,EAAE;IAS/C,aAAa,CAAC,EAAE,GAAE,OAAc,GAAG,MAAM,EAAE;IAS3C,aAAa,CAAC,EAAE,GAAE,OAAc,GAAG,MAAM,EAAE;IAS3C,YAAY,CAAC,EAAE,GAAE,OAAc,GAAG,MAAM,EAAE;IAS1C,YAAY,CAAC,EAAE,GAAE,OAAc,GAAG,GAAG,EAAE;IASvC,YAAY,CAAC,EAAE,GAAE,OAAc,GAAG,GAAG,EAAE;IASvC,WAAW,IAAI,EAAE,EAAE;IASnB,eAAe,CAAC,EAAE,GAAE,OAAc,GAAG,MAAM,EAAE;IAS7C,cAAc,CAAC,EAAE,GAAE,OAAc,GAAG,UAAU,EAAE;IASvD;;OAEG;IACI,qBAAqB,CAAC,EAAE,GAAE,OAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAgBpE;;;OAGG;IACI,wBAAwB,CAAC,EAAE,GAAE,OAAc,GAAG,OAAO,EAAE;IAS9D;;;;;OAKG;IACI,0BAA0B,CAAC,EAAE,GAAE,OAAc,GAAG,kBAAkB,CAAC,MAAM,CAAC;IAmB1E,SAAS,IAAI,GAAG;IAIhB,SAAS,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI;IAInC;;OAEG;IACI,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQpC;;OAEG;IACH,OAAO,CAAC,YAAY;IAQpB;;OAEG;IACH,OAAO,CAAC,WAAW;CAGtB"}