@burstjs/contracts NPM

@burstjs/contracts

Generic HTTP client that is used as a network provider for @burst/core.

Installation

@burstjs/contracts can be used with NodeJS or Web. Two formats are available

Using with NodeJS and/or modern web frameworks

Install using npm:

npm install @burstjs/contracts

or using yarn:

yarn add @burstjs/contracts

Example

// TO DO

Using in classic `<script>`

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

Functions

contracts

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()

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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 ⇒

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()

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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()

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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 ⇒

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()

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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 ⇒

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()

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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 ⇒

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()

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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) ⇒

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

@burstjs/util

@infinitebrahmanuniverse/nolb-_bur @everything-registry/sub-chunk-148 @burstjs/core @zalastax/nolb-_bur

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago