From 98bb4ee6ccdc8b22bc1517249267a8c1e5e30d1f Mon Sep 17 00:00:00 2001 From: vpanchal-supra Date: Wed, 2 Oct 2024 13:49:13 +0530 Subject: [PATCH] Updated readme --- README.md | 18 +++++++- doc/classes/SupraClient.html | 48 ++++++++++----------- doc/enums/TransactionStatus.html | 4 +- doc/enums/TxTypeForTransactionInsights.html | 4 +- doc/index.html | 15 ++++++- doc/interfaces/AccountInfo.html | 4 +- doc/interfaces/AccountResources.html | 4 +- doc/interfaces/CoinChange.html | 4 +- doc/interfaces/CoinInfo.html | 4 +- doc/interfaces/FaucetRequestResponse.html | 4 +- doc/interfaces/FunctionTypeArgs.html | 4 +- doc/interfaces/SendTxPayload.html | 4 +- doc/interfaces/TransactionDetail.html | 4 +- doc/interfaces/TransactionInsights.html | 4 +- doc/interfaces/TransactionResponse.html | 4 +- 15 files changed, 77 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 38dafac..1a8ee9b 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,22 @@ Install supra-l1-sdk with npm **NOTE:** This `sdk` utilizes [aptos-sdk](https://github.com/aptos-labs/aptos-core/tree/main/ecosystem/typescript/sdk) and expects few things such as `keyPair` of `aptos-sdk` type, so due to this you also have to add `aptos-sdk` in your project. -This `sdk` is under development and in future we will try to completely remove dependency from `aptos-sdk` - ## Usage Check [./src/example.ts](https://github.com/Entropy-Foundation/supra-l1-sdk/blob/master/src/example.ts) for understating about the usage. + +## Functionalities + +- [x] Significant `rpc_node` endpoint integration +- [x] Transaction insights +- [x] Transfer coin +- [x] Publish Package +- [X] `entry_function_payload` type tx +- [ ] `script_payload` type tx +- [ ] Sponsor transaction +- [ ] Multi-agent transaction +- [X] Starkey wallet integration support + +## Contributing + +If you found a bug or would like to request a feature, please file an issue. If, based on the discussion on an issue you would like to offer a code change, please make a pull request. diff --git a/doc/classes/SupraClient.html b/doc/classes/SupraClient.html index d3c6396..da6f3f4 100644 --- a/doc/classes/SupraClient.html +++ b/doc/classes/SupraClient.html @@ -1,5 +1,5 @@ SupraClient | supra-l1-sdk

Class SupraClient

Provides methods for interacting with supra rpc node.

-

Constructors

constructor +

Constructors

constructor

Properties

chainId delayBetweenPoolingRequest maxRetryForTransactionCompletion @@ -34,81 +34,81 @@ createRawTxObject createSerializedRawTxObject init -

Constructors

constructor

Properties

chainId

chainId: ChainId

delayBetweenPoolingRequest

delayBetweenPoolingRequest: number = 1000

maxRetryForTransactionCompletion

maxRetryForTransactionCompletion: number = 300

supraNodeURL

supraNodeURL: string

Methods

fundAccountWithFaucet

  • fundAccountWithFaucet(account): Promise<FaucetRequestResponse>

  • Airdrop test Supra token on given account

    +

Constructors

constructor

Properties

chainId

chainId: ChainId

delayBetweenPoolingRequest

delayBetweenPoolingRequest: number = 1000

maxRetryForTransactionCompletion

maxRetryForTransactionCompletion: number = 300

supraNodeURL

supraNodeURL: string

Methods

fundAccountWithFaucet

getAccountCoinBalance

  • getAccountCoinBalance(account, coinType): Promise<bigint>

  • Get Coin balance of given account

    +

getAccountCoinBalance

  • getAccountCoinBalance(account, coinType): Promise<bigint>

  • Get Coin balance of given account

    Parameters

    • account: HexString

      Supra account address for getting balance

    • coinType: string

      Type of a coin resource

    Returns Promise<bigint>

    Supra Balance

    -

getAccountCompleteTransactionsDetail

  • getAccountCompleteTransactionsDetail(account, count?): Promise<TransactionDetail[]>

  • Get transactions sent by the account and Coin transfer related transactions

    +

getAccountCompleteTransactionsDetail

  • getAccountCompleteTransactionsDetail(account, count?): Promise<TransactionDetail[]>

  • Get transactions sent by the account and Coin transfer related transactions

    Parameters

    • account: HexString

      Supra account address

    • count: number = 15

      Number of coin transfer transactions and account sent transaction to be considered, For instance if the value is N so total N*2 transactions will be returned.

    Returns Promise<TransactionDetail[]>

    List of TransactionDetail

    -

getAccountInfo

getAccountInfo

  • getAccountInfo(account): Promise<AccountInfo>

  • Get info of given supra account

    Parameters

    • account: HexString

      Hex-encoded 32 byte Supra account address

    Returns Promise<AccountInfo>

    AccountInfo

    -

getAccountResources

getAccountResources

  • getAccountResources(account): Promise<AccountResources>

  • Get list of all resources held by given supra account

    Parameters

    • account: HexString

      Hex-encoded 32 byte Supra account address

    Returns Promise<AccountResources>

    AccountResources

    -

getAccountSupraCoinBalance

  • getAccountSupraCoinBalance(account): Promise<bigint>

  • Get Supra balance of given account

    +

getAccountSupraCoinBalance

  • getAccountSupraCoinBalance(account): Promise<bigint>

  • Get Supra balance of given account

    Parameters

    • account: HexString

      Supra Account address for getting balance

    Returns Promise<bigint>

    Supra Balance

    -

getAccountTransactionsDetail

getAccountTransactionsDetail

  • getAccountTransactionsDetail(account, count?, start?): Promise<TransactionDetail[]>

  • Get transactions sent by the account

    Parameters

    • account: HexString

      Supra account address

    • count: number = 15

      Number of transactions details

    • start: null | number = null

      Cursor for pagination based response

    Returns Promise<TransactionDetail[]>

    List of TransactionDetail

    -

getChainId

  • getChainId(): Promise<ChainId>

  • Get Chain Id Of Supra Network

    +

getChainId

  • getChainId(): Promise<ChainId>

  • Get Chain Id Of Supra Network

    Returns Promise<ChainId>

    Chain Id of network

    -

Private getCoinChangeAmount

getCoinInfo

  • getCoinInfo(coinType): Promise<CoinInfo>

  • Get Supra balance of given account

    +

Private getCoinChangeAmount

getCoinInfo

  • getCoinInfo(coinType): Promise<CoinInfo>

  • Get Supra balance of given account

    Parameters

    • coinType: string

      Type of a coin resource

    Returns Promise<CoinInfo>

    CoinInfo

    -

getCoinTransactionsDetail

  • getCoinTransactionsDetail(account, count?, start?): Promise<TransactionDetail[]>

  • Get Coin Transfer related transactions associated with the account

    +

getCoinTransactionsDetail

  • getCoinTransactionsDetail(account, count?, start?): Promise<TransactionDetail[]>

  • Get Coin Transfer related transactions associated with the account

    Parameters

    • account: HexString

      Supra account address

    • count: number = 15

      Number of transactions details

    • start: null | number = null

      Cursor for pagination based response

    Returns Promise<TransactionDetail[]>

    List of TransactionDetail

    -

getGasPrice

  • getGasPrice(): Promise<bigint>

  • Get current mean_gas_price

    +

getGasPrice

  • getGasPrice(): Promise<bigint>

  • Get current mean_gas_price

    Returns Promise<bigint>

    Current mean_gas_price

    -

getResourceData

  • getResourceData(account, resourceType): Promise<any>

  • Get data of resource held by given supra account

    +

getResourceData

  • getResourceData(account, resourceType): Promise<any>

  • Get data of resource held by given supra account

    Parameters

    • account: HexString

      Hex-encoded 32 byte Supra account address

    • resourceType: string

      Type of a resource

    Returns Promise<any>

    Resource data

    -

Private getSendTxPayload

getTransactionDetail

  • getTransactionDetail(account, transactionHash): Promise<null | TransactionDetail>

  • Get transaction details of given transaction hash

    +

Private getSendTxPayload

getTransactionDetail

  • getTransactionDetail(account, transactionHash): Promise<null | TransactionDetail>

  • Get transaction details of given transaction hash

    Parameters

    • account: HexString

      Hex-encoded 32 byte Supra account address

    • transactionHash: string

      Hex-encoded 32 byte transaction hash for getting transaction details

    Returns Promise<null | TransactionDetail>

    TransactionDetail

    -

Private getTransactionInsights

getTransactionStatus

Private getTransactionInsights

getTransactionStatus

  • getTransactionStatus(transactionHash): Promise<null | TransactionStatus>

  • Get status of given supra transaction

    Parameters

    • transactionHash: string

      Hex-encoded 32 byte transaction hash for getting transaction status

    Returns Promise<null | TransactionStatus>

    TransactionStatus

    -

isAccountExists

  • isAccountExists(account): Promise<boolean>

  • Check whether given account exists onchain or not

    +

isAccountExists

  • isAccountExists(account): Promise<boolean>

  • Check whether given account exists onchain or not

    Parameters

    • account: HexString

      Hex-encoded 32 byte Supra account address

    Returns Promise<boolean>

    true if account exists otherwise false

    -

publishPackage

  • publishPackage(senderAccount, packageMetadata, modulesCode): Promise<TransactionResponse>

  • Publish package or module on supra network

    +

publishPackage

  • publishPackage(senderAccount, packageMetadata, modulesCode): Promise<TransactionResponse>

  • Publish package or module on supra network

    Parameters

    • senderAccount: AptosAccount

      Module Publisher KeyPair

    • packageMetadata: Uint8Array

      Package Metadata

    • modulesCode: Uint8Array[]

      module code

    Returns Promise<TransactionResponse>

    TransactionResponse

    -

Private sendRequest

  • sendRequest(isGetMethod, subURL, data?): Promise<AxiosResponse<any, any>>

  • Parameters

    • isGetMethod: boolean
    • subURL: string
    • Optional data: any

    Returns Promise<AxiosResponse<any, any>>

Private sendTx

sendTxUsingSerializedRawTransaction

  • sendTxUsingSerializedRawTransaction(senderAccount, serializedRawTransaction): Promise<TransactionResponse>

  • Send entry_function_payload type tx using serialized raw transaction datas

    +

Private sendRequest

  • sendRequest(isGetMethod, subURL, data?): Promise<AxiosResponse<any, any>>

  • Parameters

    • isGetMethod: boolean
    • subURL: string
    • Optional data: any

    Returns Promise<AxiosResponse<any, any>>

Private sendTx

sendTxUsingSerializedRawTransaction

  • sendTxUsingSerializedRawTransaction(senderAccount, serializedRawTransaction): Promise<TransactionResponse>

  • Send entry_function_payload type tx using serialized raw transaction datas

    Parameters

    • senderAccount: AptosAccount

      Sender KeyPair

    • serializedRawTransaction: Uint8Array

      Serialized raw transaction data

    Returns Promise<TransactionResponse>

    TransactionResponse

    -

Private signSupraTransaction

  • signSupraTransaction(senderAccount, rawTxn): string

  • Parameters

    • senderAccount: AptosAccount
    • rawTxn: RawTransaction

    Returns string

simulateTx

  • simulateTx(sendTxPayload): Promise<void>

  • Simulate a transaction using the provided transaction payload

    +

Private signSupraTransaction

  • signSupraTransaction(senderAccount, rawTxn): string

  • Parameters

    • senderAccount: AptosAccount
    • rawTxn: RawTransaction

    Returns string

simulateTx

  • simulateTx(sendTxPayload): Promise<void>

  • Simulate a transaction using the provided transaction payload

    Parameters

    Returns Promise<void>

transferCoin

  • transferCoin(senderAccount, receiverAccountAddr, amount, coinType, waitForTransactionCompletion?): Promise<TransactionResponse>

  • Transfer coin

    +

Returns Promise<void>

transferCoin

  • transferCoin(senderAccount, receiverAccountAddr, amount, coinType, waitForTransactionCompletion?): Promise<TransactionResponse>

  • Transfer coin

    Parameters

    • senderAccount: AptosAccount

      Sender KeyPair

    • receiverAccountAddr: HexString

      Receiver Supra Account address

    • amount: bigint

      Amount to transfer

    • coinType: string

      Type of coin

    • waitForTransactionCompletion: boolean = false

    Returns Promise<TransactionResponse>

    TransactionResponse

    -

transferSupraCoin

  • transferSupraCoin(senderAccount, receiverAccountAddr, amount, waitForTransactionCompletion?): Promise<TransactionResponse>

  • Transfer supra coin

    +

transferSupraCoin

  • transferSupraCoin(senderAccount, receiverAccountAddr, amount, waitForTransactionCompletion?): Promise<TransactionResponse>

  • Transfer supra coin

    Parameters

    • senderAccount: AptosAccount

      Sender KeyPair

    • receiverAccountAddr: HexString

      Receiver Supra Account address

    • amount: bigint

      Amount to transfer

    • waitForTransactionCompletion: boolean = false

    Returns Promise<TransactionResponse>

    TransactionResponse

    -

Private waitForTransactionCompletion

Static createRawTxObject

  • createRawTxObject(senderAddr, senderSequenceNumber, moduleAddr, moduleName, functionName, functionTypeArgs, functionArgs, chainId, maxGas?, gasUnitPrice?, txExpiryTime?): Promise<RawTransaction>

  • Parameters

    • senderAddr: HexString
    • senderSequenceNumber: bigint
    • moduleAddr: string
    • moduleName: string
    • functionName: string
    • functionTypeArgs: TypeTag[]
    • functionArgs: Uint8Array[]
    • chainId: ChainId
    • maxGas: bigint = ...
    • gasUnitPrice: bigint = ...
    • txExpiryTime: bigint = ...

    Returns Promise<RawTransaction>

Static createSerializedRawTxObject

  • createSerializedRawTxObject(senderAddr, senderSequenceNumber, moduleAddr, moduleName, functionName, functionTypeArgs, functionArgs, chainId, maxGas?, gasUnitPrice?, txExpiryTime?): Promise<Uint8Array>

  • Create serialized raw transaction object for entry_function_payload type tx

    +

Private waitForTransactionCompletion

Static createRawTxObject

  • createRawTxObject(senderAddr, senderSequenceNumber, moduleAddr, moduleName, functionName, functionTypeArgs, functionArgs, chainId, maxGas?, gasUnitPrice?, txExpiryTime?): Promise<RawTransaction>

  • Parameters

    • senderAddr: HexString
    • senderSequenceNumber: bigint
    • moduleAddr: string
    • moduleName: string
    • functionName: string
    • functionTypeArgs: TypeTag[]
    • functionArgs: Uint8Array[]
    • chainId: ChainId
    • maxGas: bigint = ...
    • gasUnitPrice: bigint = ...
    • txExpiryTime: bigint = ...

    Returns Promise<RawTransaction>

Static createSerializedRawTxObject

  • createSerializedRawTxObject(senderAddr, senderSequenceNumber, moduleAddr, moduleName, functionName, functionTypeArgs, functionArgs, chainId, maxGas?, gasUnitPrice?, txExpiryTime?): Promise<Uint8Array>

  • Create serialized raw transaction object for entry_function_payload type tx

    Parameters

    • senderAddr: HexString

      Sender account address

    • senderSequenceNumber: bigint

      Sender account sequence number

    • moduleAddr: string

      Target module address

      @@ -121,7 +121,7 @@
    • gasUnitPrice: bigint = ...

      Maximum gas unit price for transaction

    • txExpiryTime: bigint = ...

      Expiry time for transaction

    Returns Promise<Uint8Array>

    Serialized raw transaction object

    -

Static init

Static init

  • init(url): Promise<SupraClient>

  • Creates and initializes SupraClient instance

    Parameters

    • url: string

      rpc url of supra rpc node

    Returns Promise<SupraClient>

    SupraClient initialized instance

    -

Settings

Member Visibility

Theme

On This Page

constructorchainIddelayBetweenPoolingRequestmaxRetryForTransactionCompletionsupraNodeURLfundAccountWithFaucetgetAccountCoinBalancegetAccountCompleteTransactionsDetailgetAccountInfogetAccountResourcesgetAccountSupraCoinBalancegetAccountTransactionsDetailgetChainIdgetCoinChangeAmountgetCoinInfogetCoinTransactionsDetailgetGasPricegetResourceDatagetSendTxPayloadgetTransactionDetailgetTransactionInsightsgetTransactionStatusisAccountExistspublishPackagesendRequestsendTxsendTxUsingSerializedRawTransactionsignSupraTransactionsimulateTxtransferCointransferSupraCoinwaitForTransactionCompletioncreateRawTxObjectcreateSerializedRawTxObjectinit
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorchainIddelayBetweenPoolingRequestmaxRetryForTransactionCompletionsupraNodeURLfundAccountWithFaucetgetAccountCoinBalancegetAccountCompleteTransactionsDetailgetAccountInfogetAccountResourcesgetAccountSupraCoinBalancegetAccountTransactionsDetailgetChainIdgetCoinChangeAmountgetCoinInfogetCoinTransactionsDetailgetGasPricegetResourceDatagetSendTxPayloadgetTransactionDetailgetTransactionInsightsgetTransactionStatusisAccountExistspublishPackagesendRequestsendTxsendTxUsingSerializedRawTransactionsignSupraTransactionsimulateTxtransferCointransferSupraCoinwaitForTransactionCompletioncreateRawTxObjectcreateSerializedRawTxObjectinit
\ No newline at end of file diff --git a/doc/enums/TransactionStatus.html b/doc/enums/TransactionStatus.html index 2f8bcca..ad21571 100644 --- a/doc/enums/TransactionStatus.html +++ b/doc/enums/TransactionStatus.html @@ -1,4 +1,4 @@ -TransactionStatus | supra-l1-sdk

Enumeration TransactionStatus

Enumeration Members

Failed +TransactionStatus | supra-l1-sdk

Enumeration TransactionStatus

Enumeration Members

Failed Pending Success -

Enumeration Members

Failed

Failed: "Failed"

Pending

Pending: "Pending"

Success

Success: "Success"

Settings

Member Visibility

Theme

On This Page

FailedPendingSuccess
\ No newline at end of file +

Enumeration Members

Failed

Failed: "Failed"

Pending

Pending: "Pending"

Success

Success: "Success"

Settings

Member Visibility

Theme

On This Page

FailedPendingSuccess
\ No newline at end of file diff --git a/doc/enums/TxTypeForTransactionInsights.html b/doc/enums/TxTypeForTransactionInsights.html index dfa85ee..c6d74c3 100644 --- a/doc/enums/TxTypeForTransactionInsights.html +++ b/doc/enums/TxTypeForTransactionInsights.html @@ -1,4 +1,4 @@ -TxTypeForTransactionInsights | supra-l1-sdk

Enumeration TxTypeForTransactionInsights

Enumeration Members

CoinTransfer +TxTypeForTransactionInsights | supra-l1-sdk

Enumeration TxTypeForTransactionInsights

Enumeration Members

CoinTransfer EntryFunctionCall ScriptCall -

Enumeration Members

CoinTransfer

CoinTransfer: "CoinTransfer"

EntryFunctionCall

EntryFunctionCall: "EntryFunctionCall"

ScriptCall

ScriptCall: "ScriptCall"

Settings

Member Visibility

Theme

On This Page

CoinTransferEntryFunctionCallScriptCall
\ No newline at end of file +

Enumeration Members

CoinTransfer

CoinTransfer: "CoinTransfer"

EntryFunctionCall

EntryFunctionCall: "EntryFunctionCall"

ScriptCall

ScriptCall: "ScriptCall"

Settings

Member Visibility

Theme

On This Page

CoinTransferEntryFunctionCallScriptCall
\ No newline at end of file diff --git a/doc/index.html b/doc/index.html index ebd273b..52fce03 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,6 +3,17 @@ 
  npm install git+https://github.com/Entropy-Foundation/supra-l1-sdk.git

NOTE: This sdk utilizes aptos-sdk and expects few things such as keyPair of aptos-sdk type, so due to this you also have to add aptos-sdk in your project.

-

This sdk is under development and in future we will try to completely remove dependency from aptos-sdk

Usage

Check ./src/example.ts for understating about the usage.

-

Settings

Member Visibility

Theme

On This Page

Typescript SDK for Supra
\ No newline at end of file +

Functionalities

+

Contributing

If you found a bug or would like to request a feature, please file an issue. If, based on the discussion on an issue you would like to offer a code change, please make a pull request.

+

Settings

Member Visibility

Theme

On This Page

Typescript SDK for Supra
\ No newline at end of file diff --git a/doc/interfaces/AccountInfo.html b/doc/interfaces/AccountInfo.html index d884040..eea7256 100644 --- a/doc/interfaces/AccountInfo.html +++ b/doc/interfaces/AccountInfo.html @@ -1,3 +1,3 @@ -AccountInfo | supra-l1-sdk

Interface AccountInfo

interface AccountInfo {
    authentication_key: string;
    sequence_number: bigint;
}

Properties

authentication_key +AccountInfo | supra-l1-sdk

Interface AccountInfo

interface AccountInfo {
    authentication_key: string;
    sequence_number: bigint;
}

Properties

authentication_key sequence_number -

Properties

authentication_key

authentication_key: string

sequence_number

sequence_number: bigint

Settings

Member Visibility

Theme

On This Page

authentication_keysequence_number
\ No newline at end of file +

Properties

authentication_key

authentication_key: string

sequence_number

sequence_number: bigint

Settings

Member Visibility

Theme

On This Page

authentication_keysequence_number
\ No newline at end of file diff --git a/doc/interfaces/AccountResources.html b/doc/interfaces/AccountResources.html index 827348c..4930f7a 100644 --- a/doc/interfaces/AccountResources.html +++ b/doc/interfaces/AccountResources.html @@ -1,3 +1,3 @@ -AccountResources | supra-l1-sdk

Interface AccountResources

interface AccountResources {
    module: [string, {
        address: string;
        name: string;
    }][];
    struct_type: [string, {
        address: string;
        module: string;
        name: string;
        type_args: StructTag[];
    }][];
}

Properties

module +AccountResources | supra-l1-sdk

Interface AccountResources

interface AccountResources {
    module: [string, {
        address: string;
        name: string;
    }][];
    struct_type: [string, {
        address: string;
        module: string;
        name: string;
        type_args: StructTag[];
    }][];
}

Properties

module struct_type -

Properties

module

module: [string, {
    address: string;
    name: string;
}][]

struct_type

struct_type: [string, {
    address: string;
    module: string;
    name: string;
    type_args: StructTag[];
}][]

Settings

Member Visibility

Theme

On This Page

modulestruct_type
\ No newline at end of file +

Properties

module

module: [string, {
    address: string;
    name: string;
}][]

struct_type

struct_type: [string, {
    address: string;
    module: string;
    name: string;
    type_args: StructTag[];
}][]

Settings

Member Visibility

Theme

On This Page

modulestruct_type
\ No newline at end of file diff --git a/doc/interfaces/CoinChange.html b/doc/interfaces/CoinChange.html index 17b2474..7e14d0b 100644 --- a/doc/interfaces/CoinChange.html +++ b/doc/interfaces/CoinChange.html @@ -1,3 +1,3 @@ -CoinChange | supra-l1-sdk

Interface CoinChange

interface CoinChange {
    amount: bigint;
    coinType: string;
}

Properties

amount +CoinChange | supra-l1-sdk

Interface CoinChange

interface CoinChange {
    amount: bigint;
    coinType: string;
}

Properties

amount coinType -

Properties

amount

amount: bigint

coinType

coinType: string

Settings

Member Visibility

Theme

On This Page

amountcoinType
\ No newline at end of file +

Properties

amount

amount: bigint

coinType

coinType: string

Settings

Member Visibility

Theme

On This Page

amountcoinType
\ No newline at end of file diff --git a/doc/interfaces/CoinInfo.html b/doc/interfaces/CoinInfo.html index 842ff47..db011ad 100644 --- a/doc/interfaces/CoinInfo.html +++ b/doc/interfaces/CoinInfo.html @@ -1,4 +1,4 @@ -CoinInfo | supra-l1-sdk

Interface CoinInfo

interface CoinInfo {
    decimals: number;
    name: string;
    symbol: string;
}

Properties

decimals +CoinInfo | supra-l1-sdk

Interface CoinInfo

interface CoinInfo {
    decimals: number;
    name: string;
    symbol: string;
}

Properties

decimals name symbol -

Properties

decimals

decimals: number

name

name: string

symbol

symbol: string

Settings

Member Visibility

Theme

On This Page

decimalsnamesymbol
\ No newline at end of file +

Properties

decimals

decimals: number

name

name: string

symbol

symbol: string

Settings

Member Visibility

Theme

On This Page

decimalsnamesymbol
\ No newline at end of file diff --git a/doc/interfaces/FaucetRequestResponse.html b/doc/interfaces/FaucetRequestResponse.html index fa8f41b..c7b5ea5 100644 --- a/doc/interfaces/FaucetRequestResponse.html +++ b/doc/interfaces/FaucetRequestResponse.html @@ -1,3 +1,3 @@ -FaucetRequestResponse | supra-l1-sdk

Interface FaucetRequestResponse

interface FaucetRequestResponse {
    status: TransactionStatus;
    transactionHash: string;
}

Properties

status +FaucetRequestResponse | supra-l1-sdk

Interface FaucetRequestResponse

interface FaucetRequestResponse {
    status: TransactionStatus;
    transactionHash: string;
}

Properties

status transactionHash -

Properties

status

status: TransactionStatus

transactionHash

transactionHash: string

Settings

Member Visibility

Theme

On This Page

statustransactionHash
\ No newline at end of file +

Properties

status

status: TransactionStatus

transactionHash

transactionHash: string

Settings

Member Visibility

Theme

On This Page

statustransactionHash
\ No newline at end of file diff --git a/doc/interfaces/FunctionTypeArgs.html b/doc/interfaces/FunctionTypeArgs.html index e71f404..f09a241 100644 --- a/doc/interfaces/FunctionTypeArgs.html +++ b/doc/interfaces/FunctionTypeArgs.html @@ -1,2 +1,2 @@ -FunctionTypeArgs | supra-l1-sdk

Interface FunctionTypeArgs

interface FunctionTypeArgs {
    struct: {
        address: string;
        module: string;
        name: string;
        type_args: any[];
    };
}

Properties

struct -

Properties

struct

struct: {
    address: string;
    module: string;
    name: string;
    type_args: any[];
}

Type declaration

  • address: string
  • module: string
  • name: string
  • type_args: any[]

Settings

Member Visibility

Theme

On This Page

struct
\ No newline at end of file +FunctionTypeArgs | supra-l1-sdk

Interface FunctionTypeArgs

interface FunctionTypeArgs {
    struct: {
        address: string;
        module: string;
        name: string;
        type_args: any[];
    };
}

Properties

struct +

Properties

struct

struct: {
    address: string;
    module: string;
    name: string;
    type_args: any[];
}

Type declaration

  • address: string
  • module: string
  • name: string
  • type_args: any[]

Settings

Member Visibility

Theme

On This Page

struct
\ No newline at end of file diff --git a/doc/interfaces/SendTxPayload.html b/doc/interfaces/SendTxPayload.html index 26aad2e..87865cb 100644 --- a/doc/interfaces/SendTxPayload.html +++ b/doc/interfaces/SendTxPayload.html @@ -1,2 +1,2 @@ -SendTxPayload | supra-l1-sdk

Interface SendTxPayload

interface SendTxPayload {
    Move: {
        authenticator: {
            Ed25519: {
                public_key: string;
                signature: string;
            };
        };
        raw_txn: {
            chain_id: number;
            expiration_timestamp_secs: number;
            gas_unit_price: number;
            max_gas_amount: number;
            payload: {
                EntryFunction: {
                    args: number[][];
                    function: string;
                    module: {
                        address: string;
                        name: string;
                    };
                    ty_args: FunctionTypeArgs[];
                };
            };
            sender: string;
            sequence_number: number;
        };
    };
}

Properties

Move -

Properties

Move

Move: {
    authenticator: {
        Ed25519: {
            public_key: string;
            signature: string;
        };
    };
    raw_txn: {
        chain_id: number;
        expiration_timestamp_secs: number;
        gas_unit_price: number;
        max_gas_amount: number;
        payload: {
            EntryFunction: {
                args: number[][];
                function: string;
                module: {
                    address: string;
                    name: string;
                };
                ty_args: FunctionTypeArgs[];
            };
        };
        sender: string;
        sequence_number: number;
    };
}

Type declaration

  • authenticator: {
        Ed25519: {
            public_key: string;
            signature: string;
        };
    }
    • Ed25519: {
          public_key: string;
          signature: string;
      }
      • public_key: string
      • signature: string
  • raw_txn: {
        chain_id: number;
        expiration_timestamp_secs: number;
        gas_unit_price: number;
        max_gas_amount: number;
        payload: {
            EntryFunction: {
                args: number[][];
                function: string;
                module: {
                    address: string;
                    name: string;
                };
                ty_args: FunctionTypeArgs[];
            };
        };
        sender: string;
        sequence_number: number;
    }
    • chain_id: number
    • expiration_timestamp_secs: number
    • gas_unit_price: number
    • max_gas_amount: number
    • payload: {
          EntryFunction: {
              args: number[][];
              function: string;
              module: {
                  address: string;
                  name: string;
              };
              ty_args: FunctionTypeArgs[];
          };
      }
      • EntryFunction: {
            args: number[][];
            function: string;
            module: {
                address: string;
                name: string;
            };
            ty_args: FunctionTypeArgs[];
        }
        • args: number[][]
        • function: string
        • module: {
              address: string;
              name: string;
          }
          • address: string
          • name: string
        • ty_args: FunctionTypeArgs[]
    • sender: string
    • sequence_number: number

Settings

Member Visibility

Theme

On This Page

Move
\ No newline at end of file +SendTxPayload | supra-l1-sdk

Interface SendTxPayload

interface SendTxPayload {
    Move: {
        authenticator: {
            Ed25519: {
                public_key: string;
                signature: string;
            };
        };
        raw_txn: {
            chain_id: number;
            expiration_timestamp_secs: number;
            gas_unit_price: number;
            max_gas_amount: number;
            payload: {
                EntryFunction: {
                    args: number[][];
                    function: string;
                    module: {
                        address: string;
                        name: string;
                    };
                    ty_args: FunctionTypeArgs[];
                };
            };
            sender: string;
            sequence_number: number;
        };
    };
}

Properties

Move +

Properties

Move

Move: {
    authenticator: {
        Ed25519: {
            public_key: string;
            signature: string;
        };
    };
    raw_txn: {
        chain_id: number;
        expiration_timestamp_secs: number;
        gas_unit_price: number;
        max_gas_amount: number;
        payload: {
            EntryFunction: {
                args: number[][];
                function: string;
                module: {
                    address: string;
                    name: string;
                };
                ty_args: FunctionTypeArgs[];
            };
        };
        sender: string;
        sequence_number: number;
    };
}

Type declaration

  • authenticator: {
        Ed25519: {
            public_key: string;
            signature: string;
        };
    }
    • Ed25519: {
          public_key: string;
          signature: string;
      }
      • public_key: string
      • signature: string
  • raw_txn: {
        chain_id: number;
        expiration_timestamp_secs: number;
        gas_unit_price: number;
        max_gas_amount: number;
        payload: {
            EntryFunction: {
                args: number[][];
                function: string;
                module: {
                    address: string;
                    name: string;
                };
                ty_args: FunctionTypeArgs[];
            };
        };
        sender: string;
        sequence_number: number;
    }
    • chain_id: number
    • expiration_timestamp_secs: number
    • gas_unit_price: number
    • max_gas_amount: number
    • payload: {
          EntryFunction: {
              args: number[][];
              function: string;
              module: {
                  address: string;
                  name: string;
              };
              ty_args: FunctionTypeArgs[];
          };
      }
      • EntryFunction: {
            args: number[][];
            function: string;
            module: {
                address: string;
                name: string;
            };
            ty_args: FunctionTypeArgs[];
        }
        • args: number[][]
        • function: string
        • module: {
              address: string;
              name: string;
          }
          • address: string
          • name: string
        • ty_args: FunctionTypeArgs[]
    • sender: string
    • sequence_number: number

Settings

Member Visibility

Theme

On This Page

Move
\ No newline at end of file diff --git a/doc/interfaces/TransactionDetail.html b/doc/interfaces/TransactionDetail.html index dd22da1..ef37c41 100644 --- a/doc/interfaces/TransactionDetail.html +++ b/doc/interfaces/TransactionDetail.html @@ -1,4 +1,4 @@ -TransactionDetail | supra-l1-sdk

Interface TransactionDetail

interface TransactionDetail {
    blockHash: undefined | string;
    blockNumber: undefined | number;
    events: any;
    gasUnitPrice: number;
    gasUsed: undefined | number;
    maxGasAmount: number;
    sender: string;
    sequenceNumber: number;
    status: TransactionStatus;
    transactionCost: undefined | number;
    transactionInsights: TransactionInsights;
    txConfirmationTime: undefined | number;
    txHash: string;
    vm_status: undefined | string;
}

Properties

blockHash +TransactionDetail | supra-l1-sdk

Interface TransactionDetail

interface TransactionDetail {
    blockHash: undefined | string;
    blockNumber: undefined | number;
    events: any;
    gasUnitPrice: number;
    gasUsed: undefined | number;
    maxGasAmount: number;
    sender: string;
    sequenceNumber: number;
    status: TransactionStatus;
    transactionCost: undefined | number;
    transactionInsights: TransactionInsights;
    txConfirmationTime: undefined | number;
    txHash: string;
    vm_status: undefined | string;
}

Properties

blockHash blockNumber events gasUnitPrice @@ -12,4 +12,4 @@ txConfirmationTime txHash vm_status -

Properties

blockHash

blockHash: undefined | string

blockNumber

blockNumber: undefined | number

events

events: any

gasUnitPrice

gasUnitPrice: number

gasUsed

gasUsed: undefined | number

maxGasAmount

maxGasAmount: number

sender

sender: string

sequenceNumber

sequenceNumber: number

status

status: TransactionStatus

transactionCost

transactionCost: undefined | number

transactionInsights

transactionInsights: TransactionInsights

txConfirmationTime

txConfirmationTime: undefined | number

txHash

txHash: string

vm_status

vm_status: undefined | string

Settings

Member Visibility

Theme

On This Page

blockHashblockNumbereventsgasUnitPricegasUsedmaxGasAmountsendersequenceNumberstatustransactionCosttransactionInsightstxConfirmationTimetxHashvm_status
\ No newline at end of file +

Properties

blockHash

blockHash: undefined | string

blockNumber

blockNumber: undefined | number

events

events: any

gasUnitPrice

gasUnitPrice: number

gasUsed

gasUsed: undefined | number

maxGasAmount

maxGasAmount: number

sender

sender: string

sequenceNumber

sequenceNumber: number

status

status: TransactionStatus

transactionCost

transactionCost: undefined | number

transactionInsights

transactionInsights: TransactionInsights

txConfirmationTime

txConfirmationTime: undefined | number

txHash

txHash: string

vm_status

vm_status: undefined | string

Settings

Member Visibility

Theme

On This Page

blockHashblockNumbereventsgasUnitPricegasUsedmaxGasAmountsendersequenceNumberstatustransactionCosttransactionInsightstxConfirmationTimetxHashvm_status
\ No newline at end of file diff --git a/doc/interfaces/TransactionInsights.html b/doc/interfaces/TransactionInsights.html index cd4cf28..6760c04 100644 --- a/doc/interfaces/TransactionInsights.html +++ b/doc/interfaces/TransactionInsights.html @@ -1,4 +1,4 @@ -TransactionInsights | supra-l1-sdk

Interface TransactionInsights

interface TransactionInsights {
    coinChange: CoinChange[];
    coinReceiver: string;
    type: TxTypeForTransactionInsights;
}

Properties

coinChange +TransactionInsights | supra-l1-sdk

Interface TransactionInsights

interface TransactionInsights {
    coinChange: CoinChange[];
    coinReceiver: string;
    type: TxTypeForTransactionInsights;
}

Properties

coinChange coinReceiver type -

Properties

coinChange

coinChange: CoinChange[]

coinReceiver

coinReceiver: string

type

type: TxTypeForTransactionInsights

Settings

Member Visibility

Theme

On This Page

coinChangecoinReceivertype
\ No newline at end of file +

Properties

coinChange

coinChange: CoinChange[]

coinReceiver

coinReceiver: string

type

type: TxTypeForTransactionInsights

Settings

Member Visibility

Theme

On This Page

coinChangecoinReceivertype
\ No newline at end of file diff --git a/doc/interfaces/TransactionResponse.html b/doc/interfaces/TransactionResponse.html index e8411b9..f3ef163 100644 --- a/doc/interfaces/TransactionResponse.html +++ b/doc/interfaces/TransactionResponse.html @@ -1,3 +1,3 @@ -TransactionResponse | supra-l1-sdk

Interface TransactionResponse

interface TransactionResponse {
    result: TransactionStatus;
    txHash: string;
}

Properties

result +TransactionResponse | supra-l1-sdk

Interface TransactionResponse

interface TransactionResponse {
    result: TransactionStatus;
    txHash: string;
}

Properties

result txHash -

Properties

result

result: TransactionStatus

txHash

txHash: string

Settings

Member Visibility

Theme

On This Page

resulttxHash
\ No newline at end of file +

Properties

result

result: TransactionStatus

txHash

txHash: string

Settings

Member Visibility

Theme

On This Page

resulttxHash
\ No newline at end of file