Class Sdk

Sdk

Hierarchy

  • Sdk

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

internalContracts

internalContracts: Context["internalContracts"]

services

services: Context["services"]

Accessors

api

error$

  • get error$(): ErrorSubject
  • Returns ErrorSubject

notifications$

state

state$

  • get state$(): BehaviorSubject<State>
  • Returns BehaviorSubject<State>

supportedNetworks

  • get supportedNetworks(): Network[]

Methods

activatePaymentHubBridge

batchAddAccountOwner

batchClaimENSNode

batchClaimENSReverseName

  • batch claim ens reverse name

    Returns Promise<GatewayBatch>

    Promise

batchCommitP2PPaymentChannel

batchDeployAccount

  • batch deploy account

    Returns Promise<GatewayBatch>

    Promise

batchExecuteAccountTransaction

batchGatewayTransactionRequest

batchP2PPaymentDepositWithdrawal

batchRemoveAccountOwner

batchSetENSRecordName

batchSetENSRecordText

batchWithdrawP2PPaymentDeposit

buildCrossChainBridgeTransaction

callCurrentProject

  • calls current project

    Type parameters

    • T: {}

    Parameters

    Returns Promise<T>

    Promise

cancelGatewayBatch

clearGatewayBatch

  • clearGatewayBatch(): void
  • clears gateway batch

    Returns void

computeContractAccount

computeContractAccountByAddress

createPaymentHubPayment

createSession

createStreamTransactionPayload

createSuperERC20WrapperTransactionPayload

  • createSuperERC20WrapperTransactionPayload(underlyingToken: string, underlyingDecimals?: number, name?: string, symbol?: string): Promise<StreamTransactionPayload>
  • wraps erc20 token to super token

    Parameters

    • underlyingToken: string
    • Optional underlyingDecimals: number
    • Optional name: string
    • Optional symbol: string

    Returns Promise<StreamTransactionPayload>

    Promise<string | null>

deactivatePaymentHubBridge

deleteStreamTransactionPayload

destroy

  • destroy(): void
  • destroys

    Returns void

encodeAddAccountOwner

encodeClaimENSNode

encodeClaimENSReverseName

encodeCommitP2PPaymentChannel

encodeDeployAccount

encodeExecuteAccountTransaction

encodeGatewayBatch

encodeP2PPaymentDepositWithdrawal

encodeRemoveAccountOwner

encodeSetENSRecordName

encodeSetENSRecordText

encodeWithdrawP2PPaymentDeposit

ensAddressesLookup

ensNamesLookup

  • ens names lookup

    Parameters

    Returns Promise<string[]>

    Promise<string[]>

estimateGatewayBatch

estimateGatewayKnownOp

estimateStatelessAccountTransactions

fetchExchangeRates

findCrossChainBridgeRoutes

findSuperERC20WrapperOnChain

  • findSuperERC20WrapperOnChain(underlyingToken: string, chainId?: number, underlyingDecimals?: number, name?: string, symbol?: string): Promise<string>
  • searchs for existing super erc20 wrapper on chain

    Parameters

    • underlyingToken: string
    • Optional chainId: number
    • Optional underlyingDecimals: number
    • Optional name: string
    • Optional symbol: string

    Returns Promise<string>

    Promise<string | null>

forceGatewayBatch

  • forces gateway batch

    Parameters

    • dto: ForceGatewayBatchDto

    Returns Promise<GatewaySubmittedBatch>

    Promise

getAccount

getAccountBalances

getAccountInvestments

getAccountMembers

getAccountSettings

getAccountTokenListTokens

getAccountTotalBalances

getAdvanceRoutesLiFi

getConnectedAccounts

  • gets connected accounts

    Parameters

    Returns Promise<Accounts>

    Promise

getCrossChainBridgeSupportedChains

getCrossChainBridgeTokenList

getCrossChainQuotes

getDelayTransactionOptions

  • getDelayTransactionOptions(): Promise<number[]>
  • gets delay transaction options

    Returns Promise<number[]>

    Promise<number[]>

getENSNode

getENSRootNode

getENSTopLevelDomains

  • getENSTopLevelDomains(): Promise<string[]>
  • gets ens top level domains

    Returns Promise<string[]>

    Promise<string[]>

getExchangeOffers

getExchangeSupportedAssets

getGatewayGasInfo

getGatewaySubmittedBatch

getGatewaySubmittedBatches

getGatewaySubmittedPendingBatches

getGatewaySupportedToken

getGatewaySupportedTokens

  • gets gateway supported tokens

    Returns Promise<GatewaySupportedToken[]>

    Promise<GatewaySupportedToken[]>

getGatewayTransaction

  • gets gateway transaction details

    Parameters

    • dto: GetGatewayTransactionDto

    Returns Promise<GatewayTransaction>

    Promise

getLiFiStatus

getNativeCurrencies

getNftList

getP2PPaymentChannel

getP2PPaymentChannels

getP2PPaymentChannelsAdmin

getP2PPaymentDeposits

getPaymentHub

getPaymentHubBridge

getPaymentHubBridges

getPaymentHubDeposit

getPaymentHubDeposits

getPaymentHubPayment

getPaymentHubPayments

getPaymentHubs

getProject

getProjects

getRegisteredERC20WrapperTokens

  • get all registered super token wrappers

    Returns Promise<KnownContracts>

    Promise

getStepTransaction

getStreamList

getTokenListTokens

getTokenLists

  • gets token lists

    Returns Promise<TokenList[]>

    Promise<TokenList[]>

getTransaction

getTransactions

increaseP2PPaymentChannelAmount

isEligibleForAirdrop

  • check if account is eligible for an airdrop

    Parameters

    Returns Promise<boolean>

    Promise

isTokenOnTokenList

  • checks if token is on token list

    Parameters

    Returns Promise<boolean>

    Promise

joinContractAccount

modifyStreamTransactionPayload

registerContract

  • registers contract

    Type parameters

    • T: {}

    Parameters

    Returns Contract & Partial<T>

    Contract

registerERC20WrapperToken

  • registerERC20WrapperToken(wrapperAddress: string, chainId?: number): Promise<KnownContract | null>
  • register super token wrapper

    Parameters

    • wrapperAddress: string
    • Optional chainId: number

    Returns Promise<KnownContract | null>

    Promise<KnownContract | null>

reserveENSName

resolveName

signMessage

  • signs message

    Parameters

    Returns Promise<string>

    Promise

signP2PPaymentChannel

submitGatewayBatch

switchCurrentProject

syncAccount

  • syncs account

    Returns Promise<Account>

    Promise

topUp

  • topUp(value: string): Promise<void>
  • Parameters

    • value: string

    Returns Promise<void>

topUpAccount

  • topUpAccount(): Promise<string>
  • top-up account

    Returns Promise<string>

    Promise

topUpP2P

  • topUpP2P(value: string): Promise<void>
  • Parameters

    • value: string

    Returns Promise<void>

topUpPaymentDepositAccount

  • topUpPaymentDepositAccount(): Promise<string>
  • top-up account

    Returns Promise<string>

    Promise

topUpToken

  • topUpToken(value: string, contractAddress: string): Promise<void>
  • Parameters

    • value: string
    • contractAddress: string

    Returns Promise<void>

topUpTokenP2P

  • topUpTokenP2P(value: string, contractAddress: string): Promise<void>
  • Parameters

    • value: string
    • contractAddress: string

    Returns Promise<void>

transferPaymentHubDeposit

updateAccountSettings

updateP2PPaymentChannel

updatePaymentHub

updatePaymentHubDeposit

updateProject

validateENSName

  • validateENSName(dto: ValidateENSNameDto): Promise<boolean>
  • validate ens name

    Parameters

    • dto: ValidateENSNameDto

    Returns Promise<boolean>

    Promise