@btc-stamps/tx-builder - v0.1.7
    Preparing search index...

    Class SRC20CompressionService

    SRC-20 Compression Service

    Handles compression and decompression of SRC-20 JSON data for efficient storage in Bitcoin transactions.

    Index

    Constructors

    constructor

    Methods

    analyzeCompressionBenefits compress decompress testCompressionRoundTrip

    Constructors

    Methods

    • Analyze compression benefits for SRC-20 data

      Parameters

      • jsonData: string | object

      Returns {
          analysis: string[];
          estimatedCompressedSize: number;
          estimatedSavings: number;
          originalSize: number;
          outputsCompressed: number;
          outputsOriginal: number;
          outputsSaved: number;
          recommendCompression: boolean;
          satsSaved: number;
      }

    • Compress SRC-20 data for transaction embedding

      Parameters

      • jsonData: string | object
      • options: SRC20CompressionOptions = {}

      Returns Promise<SRC20CompressionResult>

    • Decompress SRC-20 data from transaction

      Parameters

      • data: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

      Returns Promise<SRC20DecompressionResult>

    • Test compression round-trip

      Parameters

      • jsonData: string | object
      • Optionaloptions: SRC20CompressionOptions

      Returns Promise<
          {
              compressed?: SRC20CompressionResult;
              compressedSize: number;
              dataMatches: boolean;
              decompressed?: SRC20DecompressionResult;
              decompressedData: any;
              error?: string;
              originalData: any;
              success: boolean;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods