Each package is available as bundled standalone library using IIFE. This way burstJS can be used also within <script>-Tags. This might be useful for Wordpress and/or other PHP applications.

Just import the package using the HTML <script> tag.

<script src='https://cdn.jsdelivr.net/npm/@burstjs/http/dist/burstjs.http.min.js'></script>

Example

// TO DO

See more here:

@burstjs/contracts Online Documentation

API Reference

Modules

contracts

Helper class for contracts

A contract owns additional data, which is split in 8 byte blocks. The content is encoded in hexadecimal representation and big endianness. This class facilitates access to these data

contracts ⇒

Calculates the minimum creation fee of the contract

contracts

contracts ⇒

Counts the code pages for given machine code

contracts ⇒

Generates a method call message of a contracts public method. The message can be sent using for example [[MessageApi.sendMessage]] with messageIsText = false or [[ContractApi.callContractMethod]]]

contracts ⇒

Extracts a variables value as hexadecimal string from a contract's machine data

This is a generic function to extract arbitrary data from a contract. It's recommended to use the [[ContractDataView]] class instead

Functions

convertArgument(value)

contracts

Helper class for contracts

A contract owns additional data, which is split in 8 byte blocks. The content is encoded in hexadecimal representation and big endianness. This class facilitates access to these data

contracts
- ~ContractDataView
  - new ContractDataView()
  - .getContract() ⇒
  - .countCodePages() ⇒
  - .getVariableAsString(index) ⇒
  - .getDataBlocksAsString(index, count) ⇒
  - .getVariableAsDecimal(index) ⇒
  - .getVariable(index) ⇒
  - .getHexDataAt(index, length) ⇒

contracts~ContractDataView

Kind: inner class of contracts

~ContractDataView
- new ContractDataView()
- .getContract() ⇒
- .countCodePages() ⇒
- .getVariableAsString(index) ⇒
- .getDataBlocksAsString(index, count) ⇒
- .getVariableAsDecimal(index) ⇒
- .getVariable(index) ⇒
- .getHexDataAt(index, length) ⇒

new ContractDataView()

The length of a contracts variable (considering Hex notation)

contractDataView.getContract() ⇒

Kind: instance method of ContractDataView
Returns:

Get the contract

contractDataView.countCodePages() ⇒

Kind: instance method of ContractDataView
Returns:

The number of code pages

contractDataView.getVariableAsString(index) ⇒

Get a variable as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getDataBlocksAsString(index, count) ⇒

Get multiple data blocks as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)
count	Number of blocks

contractDataView.getVariableAsDecimal(index) ⇒

Get a variable as decimal (string)

Kind: instance method of ContractDataView
Returns:

The data as a decimal string sequence

Param	Description
index	The index of variable (starting at 0)

contractDataView.getVariable(index) ⇒

Get a variable at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getHexDataAt(index, length) ⇒

Get a hexadecimal data block of arbitrary length at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)
length	The length of the data block (must be a multiple of 2)

contracts ⇒

Calculates the minimum creation fee of the contract

Returns:

The minimum fee

Param	Description
hexCode	The contracts code in hex form
isCIP20active	If is true, the fee calculation for active CIP20 is applied (lowered fees), otherwise the legacy calculation (BRS <V2.5) is applied

contracts ⇒
- ~ContractDataView
  - new ContractDataView()
  - .getContract() ⇒
  - .countCodePages() ⇒
  - .getVariableAsString(index) ⇒
  - .getDataBlocksAsString(index, count) ⇒
  - .getVariableAsDecimal(index) ⇒
  - .getVariable(index) ⇒
  - .getHexDataAt(index, length) ⇒

contracts~ContractDataView

Kind: inner class of contracts

~ContractDataView
- new ContractDataView()
- .getContract() ⇒
- .countCodePages() ⇒
- .getVariableAsString(index) ⇒
- .getDataBlocksAsString(index, count) ⇒
- .getVariableAsDecimal(index) ⇒
- .getVariable(index) ⇒
- .getHexDataAt(index, length) ⇒

new ContractDataView()

The length of a contracts variable (considering Hex notation)

contractDataView.getContract() ⇒

Kind: instance method of ContractDataView
Returns:

Get the contract

contractDataView.countCodePages() ⇒

Kind: instance method of ContractDataView
Returns:

The number of code pages

contractDataView.getVariableAsString(index) ⇒

Get a variable as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getDataBlocksAsString(index, count) ⇒

Get multiple data blocks as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)
count	Number of blocks

contractDataView.getVariableAsDecimal(index) ⇒

Get a variable as decimal (string)

Kind: instance method of ContractDataView
Returns:

The data as a decimal string sequence

Param	Description
index	The index of variable (starting at 0)

contractDataView.getVariable(index) ⇒

Get a variable at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getHexDataAt(index, length) ⇒

Get a hexadecimal data block of arbitrary length at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)
length	The length of the data block (must be a multiple of 2)

contracts

Internal: Size of Code Pages in bytes

contracts
- ~ContractDataView
  - new ContractDataView()
  - .getContract() ⇒
  - .countCodePages() ⇒
  - .getVariableAsString(index) ⇒
  - .getDataBlocksAsString(index, count) ⇒
  - .getVariableAsDecimal(index) ⇒
  - .getVariable(index) ⇒
  - .getHexDataAt(index, length) ⇒

contracts~ContractDataView

Kind: inner class of contracts

~ContractDataView
- new ContractDataView()
- .getContract() ⇒
- .countCodePages() ⇒
- .getVariableAsString(index) ⇒
- .getDataBlocksAsString(index, count) ⇒
- .getVariableAsDecimal(index) ⇒
- .getVariable(index) ⇒
- .getHexDataAt(index, length) ⇒

new ContractDataView()

The length of a contracts variable (considering Hex notation)

contractDataView.getContract() ⇒

Kind: instance method of ContractDataView
Returns:

Get the contract

contractDataView.countCodePages() ⇒

Kind: instance method of ContractDataView
Returns:

The number of code pages

contractDataView.getVariableAsString(index) ⇒

Get a variable as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getDataBlocksAsString(index, count) ⇒

Get multiple data blocks as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)
count	Number of blocks

contractDataView.getVariableAsDecimal(index) ⇒

Get a variable as decimal (string)

Kind: instance method of ContractDataView
Returns:

The data as a decimal string sequence

Param	Description
index	The index of variable (starting at 0)

contractDataView.getVariable(index) ⇒

Get a variable at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getHexDataAt(index, length) ⇒

Get a hexadecimal data block of arbitrary length at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)
length	The length of the data block (must be a multiple of 2)

contracts ⇒

Counts the code pages for given machine code

Returns:

The number of code pages for the passed code

Param	Description
hexCode	The contracts code in hex form

contracts ⇒
- ~ContractDataView
  - new ContractDataView()
  - .getContract() ⇒
  - .countCodePages() ⇒
  - .getVariableAsString(index) ⇒
  - .getDataBlocksAsString(index, count) ⇒
  - .getVariableAsDecimal(index) ⇒
  - .getVariable(index) ⇒
  - .getHexDataAt(index, length) ⇒

contracts~ContractDataView

Kind: inner class of contracts

~ContractDataView
- new ContractDataView()
- .getContract() ⇒
- .countCodePages() ⇒
- .getVariableAsString(index) ⇒
- .getDataBlocksAsString(index, count) ⇒
- .getVariableAsDecimal(index) ⇒
- .getVariable(index) ⇒
- .getHexDataAt(index, length) ⇒

new ContractDataView()

The length of a contracts variable (considering Hex notation)

contractDataView.getContract() ⇒

Kind: instance method of ContractDataView
Returns:

Get the contract

contractDataView.countCodePages() ⇒

Kind: instance method of ContractDataView
Returns:

The number of code pages

contractDataView.getVariableAsString(index) ⇒

Get a variable as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getDataBlocksAsString(index, count) ⇒

Get multiple data blocks as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)
count	Number of blocks

contractDataView.getVariableAsDecimal(index) ⇒

Get a variable as decimal (string)

Kind: instance method of ContractDataView
Returns:

The data as a decimal string sequence

Param	Description
index	The index of variable (starting at 0)

contractDataView.getVariable(index) ⇒

Get a variable at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getHexDataAt(index, length) ⇒

Get a hexadecimal data block of arbitrary length at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)
length	The length of the data block (must be a multiple of 2)

contracts ⇒

Generates a method call message of a contracts public method. The message can be sent using for example [[MessageApi.sendMessage]] with messageIsText = false or [[ContractApi.callContractMethod]]]

Returns:

A hex string that can be used as contracts transaction message

Param	Description
args	The argument object

contracts ⇒
- ~ContractDataView
  - new ContractDataView()
  - .getContract() ⇒
  - .countCodePages() ⇒
  - .getVariableAsString(index) ⇒
  - .getDataBlocksAsString(index, count) ⇒
  - .getVariableAsDecimal(index) ⇒
  - .getVariable(index) ⇒
  - .getHexDataAt(index, length) ⇒

contracts~ContractDataView

Kind: inner class of contracts

~ContractDataView
- new ContractDataView()
- .getContract() ⇒
- .countCodePages() ⇒
- .getVariableAsString(index) ⇒
- .getDataBlocksAsString(index, count) ⇒
- .getVariableAsDecimal(index) ⇒
- .getVariable(index) ⇒
- .getHexDataAt(index, length) ⇒

new ContractDataView()

The length of a contracts variable (considering Hex notation)

contractDataView.getContract() ⇒

Kind: instance method of ContractDataView
Returns:

Get the contract

contractDataView.countCodePages() ⇒

Kind: instance method of ContractDataView
Returns:

The number of code pages

contractDataView.getVariableAsString(index) ⇒

Get a variable as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getDataBlocksAsString(index, count) ⇒

Get multiple data blocks as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)
count	Number of blocks

contractDataView.getVariableAsDecimal(index) ⇒

Get a variable as decimal (string)

Kind: instance method of ContractDataView
Returns:

The data as a decimal string sequence

Param	Description
index	The index of variable (starting at 0)

contractDataView.getVariable(index) ⇒

Get a variable at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getHexDataAt(index, length) ⇒

Get a hexadecimal data block of arbitrary length at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)
length	The length of the data block (must be a multiple of 2)

contracts ⇒

Extracts a variables value as hexadecimal string from a contract's machine data

This is a generic function to extract arbitrary data from a contract. It's recommended to use the [[ContractDataView]] class instead

Returns:

The value as hexadecimal string (already considering endianness)

Param	Description
contract	The contract
position	The variables position
length	The length of data to be extracted

contracts ⇒
- ~ContractDataView
  - new ContractDataView()
  - .getContract() ⇒
  - .countCodePages() ⇒
  - .getVariableAsString(index) ⇒
  - .getDataBlocksAsString(index, count) ⇒
  - .getVariableAsDecimal(index) ⇒
  - .getVariable(index) ⇒
  - .getHexDataAt(index, length) ⇒

contracts~ContractDataView

Kind: inner class of contracts

~ContractDataView
- new ContractDataView()
- .getContract() ⇒
- .countCodePages() ⇒
- .getVariableAsString(index) ⇒
- .getDataBlocksAsString(index, count) ⇒
- .getVariableAsDecimal(index) ⇒
- .getVariable(index) ⇒
- .getHexDataAt(index, length) ⇒

new ContractDataView()

The length of a contracts variable (considering Hex notation)

contractDataView.getContract() ⇒

Kind: instance method of ContractDataView
Returns:

Get the contract

contractDataView.countCodePages() ⇒

Kind: instance method of ContractDataView
Returns:

The number of code pages

contractDataView.getVariableAsString(index) ⇒

Get a variable as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getDataBlocksAsString(index, count) ⇒

Get multiple data blocks as string

Kind: instance method of ContractDataView
Returns:

The data as string (Utf-8)

Param	Description
index	The index of variable (starting at 0)
count	Number of blocks

contractDataView.getVariableAsDecimal(index) ⇒

Get a variable as decimal (string)

Kind: instance method of ContractDataView
Returns:

The data as a decimal string sequence

Param	Description
index	The index of variable (starting at 0)

contractDataView.getVariable(index) ⇒

Get a variable at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)

contractDataView.getHexDataAt(index, length) ⇒

Get a hexadecimal data block of arbitrary length at given position/index

Kind: instance method of ContractDataView
Returns:

The data as hexadecimal string (in little endianness)

Param	Description
index	The index of variable (starting at 0)
length	The length of the data block (must be a multiple of 2)

convertArgument(value)

Kind: global function
Internal:

Param
value

FAQs

What is @burstjs/contracts?

Is @burstjs/contracts well maintained?

Package last updated on 29 Apr 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@burstjs/contracts