Class CalldataGenerator

Class to generate bitcoin script for interaction transactions

Hierarchy (view full)

Generator
- CalldataGenerator

Index

Constructors

Properties

contractSaltPubKey? network senderPubKey xSenderPubKey DATA_CHUNK_SIZE MAGIC

Accessors

senderFirstByte

Methods

compile splitBufferIntoChunks

Constructors

constructor

new CalldataGenerator(senderPubKey, contractSaltPubKey, network?): CalldataGenerator
Parameters
- senderPubKey: Buffer
- contractSaltPubKey: Buffer
- network: Network = networks.bitcoin
Returns CalldataGenerator
Overrides Generator.constructor
- Defined in src/generators/builders/CalldataGenerator.ts:12

Properties

`Protected` `Optional` `Readonly`contractSaltPubKey

contractSaltPubKey?: Buffer

The public key of the contract salt

`Protected` `Readonly`network

network: Network = networks.bitcoin

The network to use

`Protected` `Readonly`senderPubKey

senderPubKey: Buffer

The public key of the sender

`Protected` `Readonly`xSenderPubKey

xSenderPubKey: Buffer

The public key of the sender

`Static` `Readonly`DATA_CHUNK_SIZE

DATA_CHUNK_SIZE: number = 512

The maximum size of a data chunk

`Static` `Readonly`MAGIC

MAGIC: Buffer = ...

The magic number of OPNet

Accessors

senderFirstByte

get senderFirstByte(): Buffer
Returns Buffer
Inherited from Generator.senderFirstByte
- Defined in src/generators/Generator.ts:51

Methods

compile

compile(calldata, contractSecret, features?, vaultPublicKeys?, minimumSignatures?): Buffer
Compile an interaction bitcoin script
Parameters
- calldata: Buffer
  The calldata to use
- contractSecret: Buffer
  The contract secret
- Optionalfeatures: UNWRAP[] = []
  The features to use (optional)
- OptionalvaultPublicKeys: Buffer[] = []
  The public keys of the vault (optional)
- OptionalminimumSignatures: number = 0
  The minimum number of signatures (optional)
Returns Buffer
- The compiled script
Throws
- If something goes wrong
Overrides Generator.compile
- Defined in src/generators/builders/CalldataGenerator.ts:65

`Protected`splitBufferIntoChunks

splitBufferIntoChunks(buffer, chunkSize?): Buffer[][]
Protected
Split a buffer into chunks
Parameters
- buffer: Buffer
  The buffer to split
- chunkSize: number = Generator.DATA_CHUNK_SIZE
  The size of each chunk
Returns Buffer[][]
- The chunks
Inherited from Generator.splitBufferIntoChunks
- Defined in src/generators/Generator.ts:69