@btc-vision/bitcoin 7.0.0-alpha.0 → 7.0.0-alpha.10

package/build/io/MemoryPool.js

@@ -1,309 +0,0 @@
-/**
- * Memory pool using SharedArrayBuffer for zero-allocation operations.
- *
- * Provides thread-safe memory allocation using Atomics for concurrent access.
- * Ideal for parsing operations where temporary buffers are needed.
- *
- * @packageDocumentation
- */
-/**
- * Thread-safe memory pool using SharedArrayBuffer.
- *
- * Allocates memory from a pre-allocated SharedArrayBuffer pool,
- * eliminating garbage collection pressure from repeated allocations.
- *
- * Uses Atomics for thread-safe allocation when used with Workers.
- *
- * @example
- * ```typescript
- * import { MemoryPool } from '@btc-vision/bitcoin';
- *
- * // Create a 1MB pool
- * const pool = new MemoryPool(1024 * 1024);
- *
- * // Allocate memory for transaction parsing
- * const txBuffer = pool.alloc(500);
- * // ... use txBuffer ...
- *
- * // Reset pool when done (all allocations become invalid)
- * pool.reset();
- * ```
- */
-export class MemoryPool {
-    /**
-     * The underlying SharedArrayBuffer.
-     */
-    #buffer;
-    /**
-     * View for data allocations.
-     */
-    #data;
-    /**
-     * Control array for atomic offset management.
-     * Located at the end of the buffer.
-     */
-    #control;
-    /**
-     * Maximum allocatable size (buffer size minus control bytes).
-     */
-    #maxSize;
-    /**
-     * Creates a new MemoryPool.
-     *
-     * @param size - Size of the pool in bytes (default 4MB)
-     *
-     * @example
-     * ```typescript
-     * import { MemoryPool } from '@btc-vision/bitcoin';
-     *
-     * // 4MB pool (default)
-     * const pool = new MemoryPool();
-     *
-     * // 16MB pool
-     * const largePool = new MemoryPool(16 * 1024 * 1024);
-     * ```
-     */
-    constructor(size = 4 * 1024 * 1024) {
-        // Add 4 bytes for atomic control (current offset)
-        const totalSize = size + 4;
-        this.#buffer = new SharedArrayBuffer(totalSize);
-        this.#data = new Uint8Array(this.#buffer, 0, size);
-        this.#control = new Int32Array(this.#buffer, size, 1);
-        this.#maxSize = size;
-    }
-    /**
-     * Creates a MemoryPool from an existing SharedArrayBuffer.
-     *
-     * Useful for sharing a pool between Workers.
-     *
-     * @param buffer - Existing SharedArrayBuffer
-     * @returns A new MemoryPool instance wrapping the buffer
-     *
-     * @example
-     * ```typescript
-     * // Main thread
-     * const pool = new MemoryPool(1024 * 1024);
-     * worker.postMessage({ buffer: pool.sharedBuffer });
-     *
-     * // Worker thread
-     * self.onmessage = (e) => {
-     *     const pool = MemoryPool.fromSharedBuffer(e.data.buffer);
-     *     const mem = pool.alloc(100);
-     * };
-     * ```
-     */
-    static fromSharedBuffer(buffer) {
-        const pool = Object.create(MemoryPool.prototype);
-        const size = buffer.byteLength - 4;
-        // Use Object.defineProperty to set private fields on the created object
-        Object.defineProperty(pool, '#buffer', { value: buffer });
-        Object.defineProperty(pool, '#data', { value: new Uint8Array(buffer, 0, size) });
-        Object.defineProperty(pool, '#control', { value: new Int32Array(buffer, size, 1) });
-        Object.defineProperty(pool, '#maxSize', { value: size });
-        return pool;
-    }
-    /**
-     * Total capacity of the pool in bytes.
-     */
-    get capacity() {
-        return this.#maxSize;
-    }
-    /**
-     * Current allocation offset (bytes used).
-     *
-     * Uses Atomics for thread-safe reading.
-     */
-    get used() {
-        return Atomics.load(this.#control, 0);
-    }
-    /**
-     * Remaining available bytes.
-     */
-    get available() {
-        return this.#maxSize - this.used;
-    }
-    /**
-     * The underlying SharedArrayBuffer.
-     *
-     * Can be transferred to Workers for shared memory access.
-     */
-    get sharedBuffer() {
-        return this.#buffer;
-    }
-    /**
-     * Allocates memory from the pool.
-     *
-     * Thread-safe using Atomics.add for concurrent access.
-     *
-     * @param size - Number of bytes to allocate
-     * @returns Uint8Array view into the pool
-     * @throws RangeError if pool is exhausted
-     *
-     * @example
-     * ```typescript
-     * const pool = new MemoryPool(1024);
-     * const buf1 = pool.alloc(100); // First 100 bytes
-     * const buf2 = pool.alloc(200); // Next 200 bytes
-     * ```
-     */
-    alloc(size) {
-        if (size <= 0) {
-            throw new RangeError('Allocation size must be positive');
-        }
-        // Atomically reserve space
-        const oldOffset = Atomics.add(this.#control, 0, size);
-        if (oldOffset + size > this.#maxSize) {
-            // Undo the allocation
-            Atomics.sub(this.#control, 0, size);
-            throw new RangeError(`MemoryPool exhausted: requested ${size} bytes, only ${this.#maxSize - oldOffset} available`);
-        }
-        return this.#data.subarray(oldOffset, oldOffset + size);
-    }
-    /**
-     * Allocates memory and fills it with zeros.
-     *
-     * @param size - Number of bytes to allocate
-     * @returns Uint8Array view into the pool, filled with zeros
-     * @throws RangeError if pool is exhausted
-     */
-    allocZeroed(size) {
-        const mem = this.alloc(size);
-        mem.fill(0);
-        return mem;
-    }
-    /**
-     * Allocates memory for a specific typed array.
-     *
-     * @param length - Number of elements
-     * @param bytesPerElement - Size of each element in bytes
-     * @returns Uint8Array view (use constructor of target type on underlying buffer)
-     * @throws RangeError if pool is exhausted
-     *
-     * @example
-     * ```typescript
-     * const pool = new MemoryPool(1024);
-     * const bytes = pool.allocTyped(10, 4); // 40 bytes for 10 Uint32
-     * const u32View = new Uint32Array(bytes.buffer, bytes.byteOffset, 10);
-     * ```
-     */
-    allocTyped(length, bytesPerElement) {
-        return this.alloc(length * bytesPerElement);
-    }
-    /**
-     * Resets the pool, making all memory available again.
-     *
-     * WARNING: All previously allocated views become invalid.
-     * Only call when you're sure no references are held.
-     *
-     * Thread-safe using Atomics.store.
-     *
-     * @example
-     * ```typescript
-     * const pool = new MemoryPool(1024);
-     * const buf = pool.alloc(100);
-     * // ... use buf ...
-     * pool.reset(); // buf is now invalid!
-     * ```
-     */
-    reset() {
-        Atomics.store(this.#control, 0, 0);
-    }
-    /**
-     * Checks if the pool can accommodate an allocation.
-     *
-     * @param size - Number of bytes needed
-     * @returns True if allocation would succeed
-     */
-    canAlloc(size) {
-        return this.available >= size;
-    }
-}
-/**
- * Non-shared memory pool using regular ArrayBuffer.
- *
- * Use when SharedArrayBuffer is not available (e.g., browsers without
- * proper COOP/COEP headers) or when thread-safety is not needed.
- *
- * @example
- * ```typescript
- * import { SimpleMemoryPool } from '@btc-vision/bitcoin';
- *
- * const pool = new SimpleMemoryPool(1024 * 1024);
- * const buf = pool.alloc(100);
- * ```
- */
-export class SimpleMemoryPool {
-    #data;
-    #offset = 0;
-    /**
-     * Creates a new SimpleMemoryPool.
-     *
-     * @param size - Size of the pool in bytes
-     */
-    constructor(size) {
-        this.#data = new Uint8Array(size);
-    }
-    /**
-     * Total capacity of the pool in bytes.
-     */
-    get capacity() {
-        return this.#data.length;
-    }
-    /**
-     * Current allocation offset (bytes used).
-     */
-    get used() {
-        return this.#offset;
-    }
-    /**
-     * Remaining available bytes.
-     */
-    get available() {
-        return this.#data.length - this.#offset;
-    }
-    /**
-     * Allocates memory from the pool.
-     *
-     * @param size - Number of bytes to allocate
-     * @returns Uint8Array view into the pool
-     * @throws RangeError if pool is exhausted
-     */
-    alloc(size) {
-        if (size <= 0) {
-            throw new RangeError('Allocation size must be positive');
-        }
-        if (this.#offset + size > this.#data.length) {
-            throw new RangeError(`SimpleMemoryPool exhausted: requested ${size} bytes, only ${this.available} available`);
-        }
-        const start = this.#offset;
-        this.#offset += size;
-        return this.#data.subarray(start, this.#offset);
-    }
-    /**
-     * Allocates memory and fills it with zeros.
-     *
-     * @param size - Number of bytes to allocate
-     * @returns Uint8Array view into the pool, filled with zeros
-     */
-    allocZeroed(size) {
-        const mem = this.alloc(size);
-        mem.fill(0);
-        return mem;
-    }
-    /**
-     * Resets the pool, making all memory available again.
-     */
-    reset() {
-        this.#offset = 0;
-    }
-    /**
-     * Checks if the pool can accommodate an allocation.
-     *
-     * @param size - Number of bytes needed
-     * @returns True if allocation would succeed
-     */
-    canAlloc(size) {
-        return this.available >= size;
-    }
-}
-//# sourceMappingURL=MemoryPool.js.map

package/build/io/MemoryPool.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MemoryPool.js","sourceRoot":"","sources":["../../src/io/MemoryPool.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,UAAU;IACnB;;OAEG;IACM,OAAO,CAAoB;IAEpC;;OAEG;IACM,KAAK,CAAa;IAE3B;;;OAGG;IACM,QAAQ,CAAa;IAE9B;;OAEG;IACM,QAAQ,CAAS;IAE1B;;;;;;;;;;;;;;;OAeG;IACH,YAAmB,OAAe,CAAC,GAAG,IAAI,GAAG,IAAI;QAC7C,kDAAkD;QAClD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAyB;QACpD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAe,CAAC;QAC/D,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC;QAEnC,wEAAwE;QACxE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1D,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACjF,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,IAAI,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACpF,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAEzD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI;QACX,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,IAAW,YAAY;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,IAAY;QACrB,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,UAAU,CAAC,kCAAkC,CAAC,CAAC;QAC7D,CAAC;QAED,2BAA2B;QAC3B,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAEtD,IAAI,SAAS,GAAG,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,sBAAsB;YACtB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACpC,MAAM,IAAI,UAAU,CAChB,mCAAmC,IAAI,gBAAgB,IAAI,CAAC,QAAQ,GAAG,SAAS,YAAY,CAC/F,CAAC;QACN,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,IAAY;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACZ,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,UAAU,CAAC,MAAc,EAAE,eAAuB;QACrD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,eAAe,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK;QACR,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IAClC,CAAC;CACJ;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,gBAAgB;IAChB,KAAK,CAAa;IAC3B,OAAO,GAAW,CAAC,CAAC;IAEpB;;;;OAIG;IACH,YAAmB,IAAY;QAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAY;QACrB,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,UAAU,CAAC,kCAAkC,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC1C,MAAM,IAAI,UAAU,CAChB,yCAAyC,IAAI,gBAAgB,IAAI,CAAC,SAAS,YAAY,CAC1F,CAAC;QACN,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,IAAY;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACZ,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;OAEG;IACI,KAAK;QACR,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IAClC,CAAC;CACJ"}

package/src/ecpair.d.ts

@@ -1,99 +0,0 @@
-/**
- * Ambient module declaration for ecpair.
- *
- * The upstream ecpair@3 .d.ts files depend on valibot@^0.37 type-level APIs.
- * When a different valibot major is hoisted (e.g. v1.x required by bip32),
- * @typescript-eslint resolves valibot from the project root instead of
- * ecpair's nested node_modules, turning every ecpair type into an error type.
- *
- * This local declaration re-exports the subset of ecpair's public API that
- * this project actually uses, without any valibot dependency.
- */
-declare module 'ecpair' {
-    interface Network {
-        messagePrefix: string | Uint8Array;
-        bech32: string;
-        bip32: {
-            public: number;
-            private: number;
-        };
-        pubKeyHash: number;
-        scriptHash: number;
-        wif: number;
-    }
-
-    interface Signer {
-        publicKey: Uint8Array;
-        network?: unknown;
-        sign(hash: Uint8Array, lowR?: boolean): Uint8Array;
-    }
-
-    interface SignerAsync {
-        publicKey: Uint8Array;
-        network?: unknown;
-        sign(hash: Uint8Array, lowR?: boolean): Promise<Uint8Array>;
-    }
-
-    interface ECPairInterface extends Signer {
-        compressed: boolean;
-        network: Network;
-        lowR: boolean;
-        privateKey?: Uint8Array;
-        toWIF(): string;
-        tweak(t: Uint8Array): ECPairInterface;
-        verify(hash: Uint8Array, signature: Uint8Array): boolean;
-        verifySchnorr(hash: Uint8Array, signature: Uint8Array): boolean;
-        signSchnorr(hash: Uint8Array): Uint8Array;
-    }
-
-    interface ECPairOptions {
-        compressed?: boolean;
-        network?: Network;
-        rng?: (arg?: number) => Uint8Array;
-    }
-
-    interface ECPairAPI {
-        isPoint(maybePoint: unknown): boolean;
-        fromPrivateKey(buffer: Uint8Array, options?: ECPairOptions): ECPairInterface;
-        fromPublicKey(buffer: Uint8Array, options?: ECPairOptions): ECPairInterface;
-        fromWIF(wifString: string, network?: Network | Network[]): ECPairInterface;
-        makeRandom(options?: ECPairOptions): ECPairInterface;
-    }
-
-    interface TinySecp256k1Interface {
-        isPoint(p: Uint8Array): boolean;
-        pointCompress(p: Uint8Array, compressed?: boolean): Uint8Array;
-        isPrivate(d: Uint8Array): boolean;
-        pointFromScalar(d: Uint8Array, compressed?: boolean): Uint8Array | null;
-        xOnlyPointAddTweak(
-            p: Uint8Array,
-            tweak: Uint8Array,
-        ): { parity: 1 | 0; xOnlyPubkey: Uint8Array } | null;
-        privateAdd(d: Uint8Array, tweak: Uint8Array): Uint8Array | null;
-        privateNegate(d: Uint8Array): Uint8Array;
-        sign(h: Uint8Array, d: Uint8Array, e?: Uint8Array): Uint8Array;
-        signSchnorr?(h: Uint8Array, d: Uint8Array, e?: Uint8Array): Uint8Array;
-        verify(h: Uint8Array, Q: Uint8Array, signature: Uint8Array, strict?: boolean): boolean;
-        verifySchnorr?(h: Uint8Array, Q: Uint8Array, signature: Uint8Array): boolean;
-    }
-
-    const networks: {
-        bitcoin: Network;
-        testnet: Network;
-    };
-
-    function ECPairFactory(ecc: TinySecp256k1Interface): ECPairAPI;
-    export default ECPairFactory;
-
-    export {
-        ECPairFactory,
-        Signer,
-        SignerAsync,
-        ECPairAPI,
-        ECPairInterface,
-        ECPairOptions,
-        TinySecp256k1Interface,
-        Network,
-        networks,
-    };
-}