diff --git a/classes/DataMarshal.html b/classes/DataMarshal.html index ef12653..4414656 100644 --- a/classes/DataMarshal.html +++ b/classes/DataMarshal.html @@ -1,4 +1,4 @@ -DataMarshal | @itheum/sdk-data-marshal-network

Class DataMarshal

Constructors

constructor +DataMarshal | @itheum/sdk-data-marshal-network

Class DataMarshal

Constructors

constructor

Properties

chainID env marshalUrl @@ -6,11 +6,11 @@ encryptDataStream

Constructors

constructor

  • new DataMarshal(env): DataMarshal

  • Creates a new instance of the Marshal class, which can be used to interact with the marshal service

    Parameters

    • env: string

      'devnet' | 'mainnet' | 'testnet'

      -

    Returns DataMarshal

Properties

Readonly chainID

chainID: string

Readonly env

env: string

Readonly marshalUrl

marshalUrl: string

Methods

checkUpTime

  • checkUpTime(tokenIdentifier): Promise<{
        response_code: number;
    }>

  • Method that checks the uptime of the data stream using the NFT token identifier and the data marshal service

    +

Returns DataMarshal

Properties

Readonly chainID

chainID: string

Readonly env

env: string

Readonly marshalUrl

marshalUrl: string

Methods

checkUpTime

  • checkUpTime(tokenIdentifier): Promise<{
        response_code: number;
    }>

  • Method that checks the uptime of the data stream using the NFT token identifier and the data marshal service

    Parameters

    • tokenIdentifier: string

      The token identifier that is used to check the uptime of th data stream

    Returns Promise<{
        response_code: number;
    }>

    The response code 200 or 404

    -

encryptDataStream

  • encryptDataStream(dataStream, creatorAddress): Promise<{
        dataStreamEncrypted: string;
        messageHash: string;
    }>

  • Method that encrypts the data stream using the data marshal service

    +

encryptDataStream

  • encryptDataStream(dataStream, creatorAddress): Promise<{
        dataStreamEncrypted: string;
        messageHash: string;
    }>

  • Method that encrypts the data stream using the data marshal service

    Parameters

    • dataStream: string

      The data stream to be encrypted

    • creatorAddress: string

      The address of the creator of the data stream

    Returns Promise<{
        dataStreamEncrypted: string;
        messageHash: string;
    }>

    The encrypted data stream and the hash of the data stream

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/ErrNetworkConfig.html b/classes/ErrNetworkConfig.html index 9cbb9a3..020aa0d 100644 --- a/classes/ErrNetworkConfig.html +++ b/classes/ErrNetworkConfig.html @@ -1,11 +1,11 @@ -ErrNetworkConfig | @itheum/sdk-data-marshal-network

Class ErrNetworkConfig

Hierarchy

  • Error
    • ErrNetworkConfig

Constructors

constructor +ErrNetworkConfig | @itheum/sdk-data-marshal-network

Class ErrNetworkConfig

Hierarchy

  • Error
    • ErrNetworkConfig

Constructors

constructor

Properties

message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/enums/EnvironmentsEnum.html b/enums/EnvironmentsEnum.html index 5b16677..bd52991 100644 --- a/enums/EnvironmentsEnum.html +++ b/enums/EnvironmentsEnum.html @@ -1,4 +1,4 @@ -EnvironmentsEnum | @itheum/sdk-data-marshal-network

Enumeration EnvironmentsEnum

Enumeration Members

devnet +EnvironmentsEnum | @itheum/sdk-data-marshal-network

Enumeration EnvironmentsEnum

Enumeration Members

devnet mainnet testnet -

Enumeration Members

devnet

devnet: "devnet"

mainnet

mainnet: "mainnet"

testnet

testnet: "testnet"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

devnet

devnet: "devnet"

mainnet

mainnet: "mainnet"

testnet

testnet: "testnet"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 3da8ea9..f9d8620 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -@itheum/sdk-data-marshal-network

@itheum/sdk-data-marshal-network

SDK MX - Data Marshal Network

npm (scoped)

+@itheum/sdk-data-marshal-network

@itheum/sdk-data-marshal-network

SDK MX - Data Marshal Network

npm (scoped)

This SDK is currently focused on interacting with the Itheum's Data Marshal Network.

Contributing