Class ContractDataView

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. The term "index" is used to address these 8 byte blocks

Example

A contract may have the following data

010000000000000000e1f5050000000000000000000000003eba832d8f2c82fe0048e80100000000

Then it can be split into five data sections each 8 bytes (16 chars in hex) and indexed like shown

0100000000000000 00e1f50500000000 0000000000000000 3eba832d8f2c82fe 0048e80100000000

|------ 0 ------|------ 1 -------|------ 2 -------|------ 3 -------|------ 4 ------| = Indices

Example: Usage

const client = LedgerClientFactory.createClient({nodehost: "https://europe.signum.network"});
const nft = await client.contracts.getContract("9482276719950823724");
const dataView - new ContractDataView(nft);
const ownerId = dataView.getVariableAsDecimal(0);
const currentPrice = Amount.fromPlanck(dataview.getVariableAsDecimal(2));

Constructors

constructor

Properties

VariableLength

Methods

countCodePages getContract getDataBlocksAsString getHexDataAt getVariable getVariableAsDecimal getVariableAsString

Constructors

constructor

Properties

StaticVariableLength

VariableLength: number = 16

The length of a contracts variable (considering Hex notation)

Methods

countCodePages

getContract

getDataBlocksAsString

  • getDataBlocksAsString(index, count?): string

  • Get multiple data blocks as string

    Parameters

    • index: number

      The index of variable (starting at 0)

    • Optionalcount: number

      Number of blocks

    Returns string

    The data as string (Utf-8)

getHexDataAt

  • getHexDataAt(index, length?): string

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

    Parameters

    • index: number

      The index of variable (starting at 0)

    • Optionallength: number

      The length of the data block (must be a multiple of 2)

    Returns string

    The data as hexadecimal string (in little endianness)

getVariable

  • getVariable(index): string

  • Get a variable at given position/index

    Parameters

    • index: number

      The index of variable (starting at 0)

    Returns string

    The data as hexadecimal string (in little endianness)

getVariableAsDecimal

  • getVariableAsDecimal(index): string

  • Get a variable as decimal (string)

    Parameters

    • index: number

      The index of variable (starting at 0)

    Returns string

    The data as a decimal string sequence

getVariableAsString

Settings

Member Visibility

On This Page

Constructors
Properties
Methods