From 91eee748d789943da442f6046f1a22dc6ff0920f Mon Sep 17 00:00:00 2001 From: damienen <44813558+damienen@users.noreply.github.com> Date: Mon, 13 May 2024 12:02:18 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20Itheum/s?= =?UTF-8?q?dk-data-marshal-network@e09c4c15611c5e9946e059e9bae348b24310714?= =?UTF-8?q?1=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/DataMarshal.html | 10 +++++----- classes/ErrNetworkConfig.html | 4 ++-- enums/EnvironmentsEnum.html | 4 ++-- interfaces/Config.html | 4 ++-- variables/networkConfiguration.html | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/classes/DataMarshal.html b/classes/DataMarshal.html index 8ab8587..9d1acf8 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 @@ -7,13 +7,13 @@ preaccess

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

    -

preaccess

  • preaccess(): Promise<{
        nonce: string;
    }>

  • Method that returns a nonce to sign in order to prove ownership of a wallet address

    +

preaccess

  • preaccess(): Promise<{
        nonce: string;
    }>

  • Method that returns a nonce to sign in order to prove ownership of a wallet address

    Returns Promise<{
        nonce: string;
    }>

    The nonce to sign

    -

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 62c12ea..8550b9b 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 1ec476b..8caed44 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/interfaces/Config.html b/interfaces/Config.html index 21a1cec..b1c4bd4 100644 --- a/interfaces/Config.html +++ b/interfaces/Config.html @@ -1,3 +1,3 @@ -Config | @itheum/sdk-data-marshal-network

Interface Config

interface Config {
    chainID: string;
    marshalUrl: string;
}

Properties

chainID +Config | @itheum/sdk-data-marshal-network

Interface Config

interface Config {
    chainID: string;
    marshalUrl: string;
}

Properties

chainID marshalUrl -

Properties

chainID

chainID: string

marshalUrl

marshalUrl: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

chainID

chainID: string

marshalUrl

marshalUrl: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/networkConfiguration.html b/variables/networkConfiguration.html index c129100..6f1e784 100644 --- a/variables/networkConfiguration.html +++ b/variables/networkConfiguration.html @@ -1 +1 @@ -networkConfiguration | @itheum/sdk-data-marshal-network

Variable networkConfigurationConst

networkConfiguration: {
    [key in EnvironmentsEnum]: Config
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +networkConfiguration | @itheum/sdk-data-marshal-network

Variable networkConfigurationConst

networkConfiguration: {
    [key in EnvironmentsEnum]: Config
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file