Class Sdk

Sdk

Hierarchy

Sdk

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Sdk(walletProvider: WalletProviderLike, optionsLike?: EnvNames | SdkOptions): Sdk

Parameters
- walletProvider: WalletProviderLike
- Optional optionsLike: EnvNames | SdkOptions
Returns Sdk

Properties

Readonly internalContracts

internalContracts: Context["internalContracts"]

Readonly services

services: Context["services"]

Accessors

api

get api(): ApiService

Returns ApiService

error$

get error$(): ErrorSubject

Returns ErrorSubject

notifications$

get notifications$(): Subject<Notification>

Returns Subject<Notification>

state

get state(): StateService

Returns StateService

state$

get state$(): BehaviorSubject<State>

Returns BehaviorSubject<State>

supportedNetworks

get supportedNetworks(): Network[]

Returns Network[]

Methods

activatePaymentHubBridge

activatePaymentHubBridge(dto: UpdatePaymentHubBridgeDto): Promise<PaymentHubBridge>

activates payment hub bridge

Parameters
- dto: UpdatePaymentHubBridgeDto
Returns Promise<PaymentHubBridge>

Promise

advanceRoutes

advanceRoutes(dto: GetAdvanceRoutesDto): Promise<AdvanceRoutes>

gets advance routes of multi chain

Parameters
- dto: GetAdvanceRoutesDto
Returns Promise<AdvanceRoutes>

Promise

batchAddAccountOwner

batchAddAccountOwner(dto: AddAccountOwnerDto): Promise<GatewayBatch>

batch add account owner

Parameters
- dto: AddAccountOwnerDto
Returns Promise<GatewayBatch>

Promise

batchClaimENSNode

batchClaimENSNode(dto?: ClaimENSNodeDto): Promise<GatewayBatch>

batch claim ens node

Parameters
- Default value dto: ClaimENSNodeDto = {}
Returns Promise<GatewayBatch>

Promise

batchClaimENSReverseName

batchClaimENSReverseName(): Promise<GatewayBatch>

batch claim ens reverse name

Returns Promise<GatewayBatch>

Promise

batchCommitP2PPaymentChannel

batchCommitP2PPaymentChannel(dto: CommitP2PPaymentChannelDto): Promise<GatewayBatch>

batch commit p2p payment channel

Parameters
- dto: CommitP2PPaymentChannelDto
Returns Promise<GatewayBatch>

Promise

batchDeployAccount

batchDeployAccount(): Promise<GatewayBatch>

batch deploy account

Returns Promise<GatewayBatch>

Promise

batchExecuteAccountTransaction

batchExecuteAccountTransaction(dto: ExecuteAccountTransactionDto): Promise<GatewayBatch>

batch execute account transaction

Parameters
- dto: ExecuteAccountTransactionDto
Returns Promise<GatewayBatch>

Promise

batchGatewayTransactionRequest

batchGatewayTransactionRequest(dto: BatchGatewayTransactionRequestDto): Promise<GatewayBatch>

batches gateway transaction request

Parameters
- dto: BatchGatewayTransactionRequestDto
Returns Promise<GatewayBatch>

Promise

batchP2PPaymentDepositWithdrawal

batchP2PPaymentDepositWithdrawal(dto: P2PPaymentDepositWithdrawalDto): Promise<GatewayBatch>

batch p2p payment deposit withdrawal

Parameters
- dto: P2PPaymentDepositWithdrawalDto
Returns Promise<GatewayBatch>

Promise

batchRemoveAccountOwner

batchRemoveAccountOwner(dto: RemoveAccountOwnerDto): Promise<GatewayBatch>

batch remove account owner

Parameters
- dto: RemoveAccountOwnerDto
Returns Promise<GatewayBatch>

Promise

batchSetENSRecordName

batchSetENSRecordName(dto?: SetENSRecordNameDto): Promise<GatewayBatch>

batch set ens record name

Parameters
- Default value dto: SetENSRecordNameDto = {}
Returns Promise<GatewayBatch>

Promise

batchSetENSRecordText

batchSetENSRecordText(dto: SetENSRecordTextDto): Promise<GatewayBatch>

batch set ens record text

Parameters
- dto: SetENSRecordTextDto
Returns Promise<GatewayBatch>

Promise

batchWithdrawP2PPaymentDeposit

batchWithdrawP2PPaymentDeposit(dto: WithdrawP2PPaymentDepositDto): Promise<GatewayBatch>

batch withdraw p2p payment deposit

Parameters
- dto: WithdrawP2PPaymentDepositDto
Returns Promise<GatewayBatch>

Promise

buildCrossChainBridgeTransaction

buildCrossChainBridgeTransaction(dto: CrossChainBridgeRoute): Promise<CrossChainBridgeBuildTXResponse>

Parameters
- dto: CrossChainBridgeRoute
Returns Promise<CrossChainBridgeBuildTXResponse>

callCurrentProject

callCurrentProject<T>(dto?: CallCurrentProjectDto): Promise<T>

calls current project

Type parameters
- T: {}
Parameters
- Default value dto: CallCurrentProjectDto = {}
Returns Promise<T>

Promise

cancelGatewayBatch

cancelGatewayBatch(dto: CancelGatewayBatchDto): Promise<GatewaySubmittedBatch>

cancels gateway batch

Parameters
- dto: CancelGatewayBatchDto
Returns Promise<GatewaySubmittedBatch>

Promise

clearGatewayBatch

clearGatewayBatch(): void

clears gateway batch

Returns void

computeContractAccount

computeContractAccount(dto?: ComputeContractAccountDto): Promise<Account>

computes contract account

Parameters
- Default value dto: ComputeContractAccountDto = {}
Returns Promise<Account>

Promise

computeContractAccountByAddress

computeContractAccountByAddress(dto: ComputeContractAccountByAddressDto): Promise<string>

computes contract account by custom address

Parameters
- dto: ComputeContractAccountByAddressDto
Returns Promise<string>

Promise

createPaymentHubPayment

createPaymentHubPayment(dto: CreatePaymentHubPaymentDto): Promise<PaymentHubPayment>

creates payment hub payment

Parameters
- dto: CreatePaymentHubPaymentDto
Returns Promise<PaymentHubPayment>

Promise

createSession

createSession(dto?: CreateSessionDto): Promise<Session>

creates session

Parameters
- Default value dto: CreateSessionDto = {}
Returns Promise<Session>

Promise

createStreamTransactionPayload

createStreamTransactionPayload(dto: CreateStreamTransactionPayloadDto): Promise<StreamTransactionPayload>

returns transaction payload for creating stream of supertoken

Parameters
- dto: CreateStreamTransactionPayloadDto
Returns Promise<StreamTransactionPayload>

Promise

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

deactivatePaymentHubBridge(dto: UpdatePaymentHubBridgeDto): Promise<PaymentHubBridge>

deactivates payment hub bridge

Parameters
- dto: UpdatePaymentHubBridgeDto
Returns Promise<PaymentHubBridge>

Promise

deleteStreamTransactionPayload

deleteStreamTransactionPayload(dto: DeleteStreamTransactionPayloadDto): Promise<StreamTransactionPayload>

Parameters
- dto: DeleteStreamTransactionPayloadDto
Returns Promise<StreamTransactionPayload>

destroy

destroy(): void

destroys

Returns void

encodeAddAccountOwner

encodeAddAccountOwner(dto: AddAccountOwnerDto): Promise<TransactionRequest>

encodes add account owner

Parameters
- dto: AddAccountOwnerDto
Returns Promise<TransactionRequest>

Promise

encodeClaimENSNode

encodeClaimENSNode(dto?: ClaimENSNodeDto): Promise<TransactionRequest>

encodes claim ens node

Parameters
- Default value dto: ClaimENSNodeDto = {}
Returns Promise<TransactionRequest>

Promise

encodeClaimENSReverseName

encodeClaimENSReverseName(): Promise<TransactionRequest>

encodes claim ens reverse name

Returns Promise<TransactionRequest>

Promise

encodeCommitP2PPaymentChannel

encodeCommitP2PPaymentChannel(dto: CommitP2PPaymentChannelDto): Promise<TransactionRequest>

encodes commit p2p payment channel

Parameters
- dto: CommitP2PPaymentChannelDto
Returns Promise<TransactionRequest>

Promise

encodeDeployAccount

encodeDeployAccount(): Promise<TransactionRequest>

encodes deploy account

Returns Promise<TransactionRequest>

Promise

encodeExecuteAccountTransaction

encodeExecuteAccountTransaction(dto: ExecuteAccountTransactionDto): Promise<TransactionRequest>

encodes execute account transaction

Parameters
- dto: ExecuteAccountTransactionDto
Returns Promise<TransactionRequest>

Promise

encodeGatewayBatch

encodeGatewayBatch(dto?: EncodeGatewayBatchDto): Promise<TransactionRequest>

encodes gateway batch

Parameters
- Default value dto: EncodeGatewayBatchDto = {}
Returns Promise<TransactionRequest>

Promise

encodeP2PPaymentDepositWithdrawal

encodeP2PPaymentDepositWithdrawal(dto: P2PPaymentDepositWithdrawalDto): Promise<TransactionRequest>

encodes p2p payment deposit withdrawal

Parameters
- dto: P2PPaymentDepositWithdrawalDto
Returns Promise<TransactionRequest>

Promise

encodeRemoveAccountOwner

encodeRemoveAccountOwner(dto: RemoveAccountOwnerDto): Promise<TransactionRequest>

encodes remove account owner

Parameters
- dto: RemoveAccountOwnerDto
Returns Promise<TransactionRequest>

Promise

encodeSetENSRecordName

encodeSetENSRecordName(dto?: SetENSRecordNameDto): Promise<TransactionRequest>

encodes set ens record name

Parameters
- Default value dto: SetENSRecordNameDto = {}
Returns Promise<TransactionRequest>

Promise

encodeSetENSRecordText

encodeSetENSRecordText(dto: SetENSRecordTextDto): Promise<TransactionRequest>

encodes set ens record text

Parameters
- dto: SetENSRecordTextDto
Returns Promise<TransactionRequest>

Promise

encodeWithdrawP2PPaymentDeposit

encodeWithdrawP2PPaymentDeposit(dto: WithdrawP2PPaymentDepositDto): Promise<TransactionRequest>

encodes withdraw p2p payment deposit

Parameters
- dto: WithdrawP2PPaymentDepositDto
Returns Promise<TransactionRequest>

Promise

ensAddressesLookup

ensAddressesLookup(dto: ENSAddressesLookupDto): Promise<string[]>

ens addresses lookup

Parameters
- dto: ENSAddressesLookupDto
Returns Promise<string[]>

Promise<string[]>

ensNamesLookup

ensNamesLookup(dto: ENSNamesLookupDto): Promise<string[]>

ens names lookup

Parameters
- dto: ENSNamesLookupDto
Returns Promise<string[]>

Promise<string[]>

estimateGatewayBatch

estimateGatewayBatch(dto?: EstimateGatewayBatchDto): Promise<GatewayBatch>

estimates gateway batch

Parameters
- Default value dto: EstimateGatewayBatchDto = {}
Returns Promise<GatewayBatch>

Promise

estimateGatewayKnownOp

estimateGatewayKnownOp(dto: EstimateGatewayKnownOpDto): Promise<GatewayEstimatedKnownOp>

estimates gateway known op

Parameters
- dto: EstimateGatewayKnownOpDto
Returns Promise<GatewayEstimatedKnownOp>

Promise

estimateStatelessAccountTransactions

estimateStatelessAccountTransactions(transactionsDto: ExecuteAccountTransactionDto[], estimationDto?: EstimateGatewayBatchDto): Promise<GatewayBatch>

estimates stateless account transactions

Parameters
- transactionsDto: ExecuteAccountTransactionDto[]
- Default value estimationDto: EstimateGatewayBatchDto = {}
Returns Promise<GatewayBatch>

Promise

fetchExchangeRates

fetchExchangeRates(dto: FetchExchangeRatesDto): Promise<RateData>

Parameters
- dto: FetchExchangeRatesDto
Returns Promise<RateData>

findCrossChainBridgeRoutes

findCrossChainBridgeRoutes(dto: GetCrossChainBridgeRouteDto): Promise<CrossChainBridgeRoute[]>

Parameters
- dto: GetCrossChainBridgeRouteDto
Returns Promise<CrossChainBridgeRoute[]>

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

forceGatewayBatch(dto: ForceGatewayBatchDto): Promise<GatewaySubmittedBatch>

forces gateway batch

Parameters
- dto: ForceGatewayBatchDto
Returns Promise<GatewaySubmittedBatch>

Promise

getAccount

getAccount(dto?: GetAccountDto): Promise<Account>

get account

Parameters
- Default value dto: GetAccountDto = {}
Returns Promise<Account>

Promise

getAccount24HourNetCurve

getAccount24HourNetCurve(dto?: GetAccount24HourNetCurveDto): Promise<NetCurveBalances>

gets account 24 hour net curve data

Parameters
- Default value dto: GetAccount24HourNetCurveDto = {}
Returns Promise<NetCurveBalances>

Promise

getAccountBalances

getAccountBalances(dto?: GetAccountBalancesDto): Promise<AccountBalances>

gets account balances

Parameters
- Default value dto: GetAccountBalancesDto = {}
Returns Promise<AccountBalances>

Promise

getAccountInvestments

getAccountInvestments(dto?: GetAccountInvestmentsDto): Promise<AccountInvestments>

gets account investments

Parameters
- Default value dto: GetAccountInvestmentsDto = {}
Returns Promise<AccountInvestments>

Promise

getAccountMembers

getAccountMembers(dto?: GetAccountMembersDto): Promise<AccountMembers>

gets account members

Parameters
- Default value dto: GetAccountMembersDto = {}
Returns Promise<AccountMembers>

Promise

getAccountSettings

getAccountSettings(): Promise<AccountSettings>

gets account settings

Returns Promise<AccountSettings>

Promise

getAccountTokenListTokens

getAccountTokenListTokens(dto?: GetTokenListDto): Promise<TokenListToken[]>

gets account token list tokens

Parameters
- Default value dto: GetTokenListDto = {}
Returns Promise<TokenListToken[]>

Promise<TokenListToken[]>

getAccountTotalBalances

getAccountTotalBalances(dto: GetAccountTotalBalancesDto): Promise<AccountTotalBalances>

gets account total balances

Parameters
- dto: GetAccountTotalBalancesDto
Returns Promise<AccountTotalBalances>

Promise

getAdvanceRoutesLiFi

getAdvanceRoutesLiFi(dto: GetAdvanceRoutesLiFiDto): Promise<AdvanceRoutesLiFi>

Parameters
- dto: GetAdvanceRoutesLiFiDto
Returns Promise<AdvanceRoutesLiFi>

getConnectedAccounts

getConnectedAccounts(dto?: PaginationDto): Promise<Accounts>

gets connected accounts

Parameters
- Default value dto: PaginationDto = {}
Returns Promise<Accounts>

Promise

getCrossChainBridgeSupportedChains

getCrossChainBridgeSupportedChains(dto?: GetCrossChainBridgeSupportedChainsDto): Promise<CrossChainBridgeSupportedChain[]>

Parameters
- Optional dto: GetCrossChainBridgeSupportedChainsDto
Returns Promise<CrossChainBridgeSupportedChain[]>

getCrossChainBridgeTokenList

getCrossChainBridgeTokenList(dto: GetCrossChainBridgeTokenListDto): Promise<CrossChainBridgeToken[]>

Parameters
- dto: GetCrossChainBridgeTokenListDto
Returns Promise<CrossChainBridgeToken[]>

getCrossChainQuotes

getCrossChainQuotes(dto: GetExchangeCrossChainQuoteDto): Promise<BridgingQuotes>

gets multi chain quotes

Parameters
- dto: GetExchangeCrossChainQuoteDto
Returns Promise<BridgingQuotes>

Promise

getDelayTransactionOptions

getDelayTransactionOptions(): Promise<number[]>

gets delay transaction options

Returns Promise<number[]>

Promise<number[]>

getENSNode

getENSNode(dto?: GetENSNodeDto): Promise<ENSNode>

gets ens node

Parameters
- Default value dto: GetENSNodeDto = {}
Returns Promise<ENSNode>

Promise

getENSRootNode

getENSRootNode(dto: GetENSRootNodeDto): Promise<ENSRootNode>

gets ens root node

Parameters
- dto: GetENSRootNodeDto
Returns Promise<ENSRootNode>

Promise

getENSTopLevelDomains

getENSTopLevelDomains(): Promise<string[]>

gets ens top level domains

Returns Promise<string[]>

Promise<string[]>

getExchangeOffers

getExchangeOffers(dto: GetExchangeOffersDto): Promise<ExchangeOffer[]>

gets exchange offers

Parameters
- dto: GetExchangeOffersDto
Returns Promise<ExchangeOffer[]>

Promise<ExchangeOffer[]>

getExchangeSupportedAssets

getExchangeSupportedAssets(dto?: GetExchangeSupportedAssetsDto): Promise<PaginatedTokens>

gets exchange supported tokens

Parameters
- Default value dto: GetExchangeSupportedAssetsDto = {}
Returns Promise<PaginatedTokens>

Promise

getGatewayGasInfo

getGatewayGasInfo(): Promise<GatewayGasInfo>

gets gateway's gas info

Returns Promise<GatewayGasInfo>

Promise

getGatewaySubmittedBatch

getGatewaySubmittedBatch(dto: GetGatewaySubmittedBatchDto): Promise<GatewaySubmittedBatch>

gets gateway submitted batch

Parameters
- dto: GetGatewaySubmittedBatchDto
Returns Promise<GatewaySubmittedBatch>

Promise

getGatewaySubmittedBatches

getGatewaySubmittedBatches(dto?: PaginationDto): Promise<GatewaySubmittedBatches>

gets gateway submitted batches

Parameters
- Default value dto: PaginationDto = {}
Returns Promise<GatewaySubmittedBatches>

Promise

getGatewaySubmittedPendingBatches

getGatewaySubmittedPendingBatches(dto?: PaginationDto): Promise<GatewaySubmittedPendingBatches>

gets gateway submitted pending batches

Parameters
- Default value dto: PaginationDto = {}
Returns Promise<GatewaySubmittedPendingBatches>

Promise

getGatewaySupportedToken

getGatewaySupportedToken(dto: GetGatewaySupportedTokenDto): Promise<GatewaySupportedToken>

gets gateway supported token

Parameters
- dto: GetGatewaySupportedTokenDto
Returns Promise<GatewaySupportedToken>

Promise

getGatewaySupportedTokens

getGatewaySupportedTokens(): Promise<GatewaySupportedToken[]>

gets gateway supported tokens

Returns Promise<GatewaySupportedToken[]>

Promise<GatewaySupportedToken[]>

getGatewayTransaction

getGatewayTransaction(dto: GetGatewayTransactionDto): Promise<GatewayTransaction>

gets gateway transaction details

Parameters
- dto: GetGatewayTransactionDto
Returns Promise<GatewayTransaction>

Promise

getHistoricalTokenPrice

getHistoricalTokenPrice(dto?: GetHistoricalTokenPriceDto): Promise<HistoricalTokenPrices>

gets historical token price

Parameters
- Default value dto: GetHistoricalTokenPriceDto = {}
Returns Promise<HistoricalTokenPrices>

Promise

getLiFiStatus

getLiFiStatus(dto: GetLiFiStatusDto): Promise<LiFiStatus>

Parameters
- dto: GetLiFiStatusDto
Returns Promise<LiFiStatus>

getMarketDetails

getMarketDetails(dto?: GetHistoricalTokenPriceDto): Promise<MarketDetails>

gets market details of token

Parameters
- Default value dto: GetHistoricalTokenPriceDto = {}
Returns Promise<MarketDetails>

Promise

getNativeCurrencies

getNativeCurrencies(): Promise<NativeCurrenciesItem[]>

gets native currencies

Returns Promise<NativeCurrenciesItem[]>

Promise<NativeCurrenciesItem[]>

getNftList

getNftList(dto: GetNftListDto): Promise<NftList>

gets NFT list belonging to account

Parameters
- dto: GetNftListDto
Returns Promise<NftList>

Promise

getNumberOfTransactions

getNumberOfTransactions(dto?: GetTokenDetailsDto): Promise<NumberOfTransactions>

gets number of transactions of token

Parameters
- Default value dto: GetTokenDetailsDto = {}
Returns Promise<NumberOfTransactions>

Promise

getP2PPaymentChannel

getP2PPaymentChannel(dto: GetP2PPaymentChannelDto): Promise<P2PPaymentChannel>

gets p2p payment channel

Parameters
- dto: GetP2PPaymentChannelDto
Returns Promise<P2PPaymentChannel>

Promise

getP2PPaymentChannels

getP2PPaymentChannels(dto?: GetP2PPaymentChannelsDto): Promise<P2PPaymentChannels>

gets p2p payment channels

Parameters
- Default value dto: GetP2PPaymentChannelsDto = {}
Returns Promise<P2PPaymentChannels>

Promise

getP2PPaymentChannelsAdmin

getP2PPaymentChannelsAdmin(dto?: GetP2PPaymentChannelsAdminDto): Promise<P2PPaymentChannels>

gets p2p payment channels admin

Parameters
- Default value dto: GetP2PPaymentChannelsAdminDto = {}
Returns Promise<P2PPaymentChannels>

Promise

getP2PPaymentDeposits

getP2PPaymentDeposits(dto?: GetP2PPaymentDepositsDto): Promise<P2PPaymentDeposits>

gets p2p payment deposits

Parameters
- Default value dto: GetP2PPaymentDepositsDto = {}
Returns Promise<P2PPaymentDeposits>

Promise

getPaymentHub

getPaymentHub(dto: GetPaymentHubDto): Promise<PaymentHub>

gets payment hub

Parameters
- dto: GetPaymentHubDto
Returns Promise<PaymentHub>

Promise

getPaymentHubBridge

getPaymentHubBridge(dto?: GetPaymentHubBridgeDto): Promise<PaymentHubBridge>

gets payment hub bridge

Parameters
- Default value dto: GetPaymentHubBridgeDto = {}
Returns Promise<PaymentHubBridge>

Promise

getPaymentHubBridges

getPaymentHubBridges(dto: GetPaymentHubBridgesDto): Promise<PaymentHubBridges>

gets payment hub bridges

Parameters
- dto: GetPaymentHubBridgesDto
Returns Promise<PaymentHubBridges>

Promise

getPaymentHubDeposit

getPaymentHubDeposit(dto: GetPaymentHubDepositDto): Promise<PaymentHubDeposit>

gets payment hub deposit

Parameters
- dto: GetPaymentHubDepositDto
Returns Promise<PaymentHubDeposit>

Promise

getPaymentHubDeposits

getPaymentHubDeposits(dto: GetPaymentHubDepositsDto): Promise<PaymentHubDeposits>

gets payment hub deposits

Parameters
- dto: GetPaymentHubDepositsDto
Returns Promise<PaymentHubDeposits>

Promise

getPaymentHubPayment

getPaymentHubPayment(dto: GetPaymentHubPaymentDto): Promise<PaymentHubPayment>

gets payment hub payment

Parameters
- dto: GetPaymentHubPaymentDto
Returns Promise<PaymentHubPayment>

Promise

getPaymentHubPayments

getPaymentHubPayments(dto: GetPaymentHubPaymentsDto): Promise<PaymentHubPayments>

gets payment hub payments

Parameters
- dto: GetPaymentHubPaymentsDto
Returns Promise<PaymentHubPayments>

Promise

getPaymentHubs

getPaymentHubs(dto?: GetPaymentHubsDto): Promise<PaymentHubs>

gets payment hubs

Parameters
- Default value dto: GetPaymentHubsDto = {}
Returns Promise<PaymentHubs>

Promise

getPoolsActivity

getPoolsActivity(dto?: GetPoolsActivityDto): Promise<PoolsActivities>

gets pools activity of token

Parameters
- Default value dto: GetPoolsActivityDto = {}
Returns Promise<PoolsActivities>

Promise

getProject

getProject(dto: GetProjectDto): Promise<Project>

gets project

Parameters
- dto: GetProjectDto
Returns Promise<Project>

Promise

getProjects

getProjects(dto: PaginationDto): Promise<Projects>

gets projects

Parameters
- dto: PaginationDto
Returns Promise<Projects>

Promise

getRegisteredERC20WrapperTokens

getRegisteredERC20WrapperTokens(): Promise<KnownContracts>

get all registered super token wrappers

Returns Promise<KnownContracts>

Promise

getStepTransaction

getStepTransaction(dto: GetStepTransactionsLiFiDto): Promise<StepTransactions>

Parameters
- dto: GetStepTransactionsLiFiDto
Returns Promise<StepTransactions>

getStreamList

getStreamList(dto?: GetStreamListDto): Promise<StreamList>

Parameters
- Default value dto: GetStreamListDto = {}
Returns Promise<StreamList>

getTokenDetails

getTokenDetails(dto?: GetTokenDetailsDto): Promise<TokenDetails>

gets token details

Parameters
- Default value dto: GetTokenDetailsDto = {}
Returns Promise<TokenDetails>

Promise

getTokenListTokens

getTokenListTokens(dto?: GetTokenListDto): Promise<TokenListToken[]>

gets token list tokens

Parameters
- Default value dto: GetTokenListDto = {}
Returns Promise<TokenListToken[]>

Promise<TokenListToken[]>

getTokenLists

getTokenLists(): Promise<TokenList[]>

gets token lists

Returns Promise<TokenList[]>

Promise<TokenList[]>

getTradingHistory

getTradingHistory(dto?: GetTradingHistoryDto): Promise<TradingHistories>

gets trading history of token

Parameters
- Default value dto: GetTradingHistoryDto = {}
Returns Promise<TradingHistories>

Promise

getTransaction

getTransaction(dto: GetTransactionDto): Promise<Transaction>

gets transaction

Parameters
- dto: GetTransactionDto
Returns Promise<Transaction>

Promise

getTransactions

getTransactions(dto: GetTransactionsDto): Promise<Transactions>

gets transactions

Parameters
- dto: GetTransactionsDto
Returns Promise<Transactions>

Promise

increaseP2PPaymentChannelAmount

increaseP2PPaymentChannelAmount(dto: IncreaseP2PPaymentChannelAmountDto): Promise<P2PPaymentChannel>

increases p2p payment channel amount

Parameters
- dto: IncreaseP2PPaymentChannelAmountDto
Returns Promise<P2PPaymentChannel>

Promise

isEligibleForAirdrop

isEligibleForAirdrop(dto: IsEligibleForAirdropDto): Promise<boolean>

check if account is eligible for an airdrop

Parameters
- dto: IsEligibleForAirdropDto
Returns Promise<boolean>

Promise

isTokenOnTokenList

isTokenOnTokenList(dto: IsTokenOnTokenListDto): Promise<boolean>

checks if token is on token list

Parameters
- dto: IsTokenOnTokenListDto
Returns Promise<boolean>

Promise

joinContractAccount

joinContractAccount(dto: JoinContractAccountDto): Promise<Account>

joins contract account

Parameters
- dto: JoinContractAccountDto
Returns Promise<Account>

Promise

modifyStreamTransactionPayload

modifyStreamTransactionPayload(dto: CreateStreamTransactionPayloadDto): Promise<StreamTransactionPayload>

Parameters
- dto: CreateStreamTransactionPayloadDto
Returns Promise<StreamTransactionPayload>

registerContract

registerContract<T>(name: string, abi: any, addresses?: ContractAddresses): Contract & Partial<T>

registers contract

Type parameters
- T: {}
Parameters
- name: string
- abi: any
- Default value addresses: ContractAddresses = null
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

reserveENSName(dto: ReserveENSNameDto): Promise<ENSNode>

reserve ens name

Parameters
- dto: ReserveENSNameDto
Returns Promise<ENSNode>

Promise

resolveName

resolveName(dto?: NameResolutionNodeDto): Promise<NameResolutionsNodes>

resolves Name

Parameters
- Default value dto: NameResolutionNodeDto = {name: '',}
Returns Promise<NameResolutionsNodes>

Promise

signMessage

signMessage(dto: SignMessageDto): Promise<string>

signs message

Parameters
- dto: SignMessageDto
Returns Promise<string>

Promise

signP2PPaymentChannel

signP2PPaymentChannel(dto: SignP2PPaymentChannelDto): Promise<P2PPaymentChannel>

signs p2p payment channel

Parameters
- dto: SignP2PPaymentChannelDto
Returns Promise<P2PPaymentChannel>

Promise

submitGatewayBatch

submitGatewayBatch(dto?: CustomProjectMetadataDto): Promise<GatewaySubmittedBatch>

submits gateway batch

Parameters
- Default value dto: CustomProjectMetadataDto = {}
Returns Promise<GatewaySubmittedBatch>

Promise

switchCurrentProject

switchCurrentProject(dto?: SwitchCurrentProjectDto): Promise<CurrentProject>

switches current project

Parameters
- Default value dto: SwitchCurrentProjectDto = null
Returns Promise<CurrentProject>

Promise

syncAccount

syncAccount(): Promise<Account>

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

transferPaymentHubDeposit(dto: TransferPaymentHubDepositDto): Promise<PaymentHubDeposit>

transfers payment hub deposit

Parameters
- dto: TransferPaymentHubDepositDto
Returns Promise<PaymentHubDeposit>

Promise

updateAccountSettings

updateAccountSettings(dto: UpdateAccountSettingsDto): Promise<AccountSettings>

updates account settings

Parameters
- dto: UpdateAccountSettingsDto
Returns Promise<AccountSettings>

Promise

updateP2PPaymentChannel

updateP2PPaymentChannel(dto: UpdateP2PPaymentChannelDto): Promise<P2PPaymentChannel>

updates p2p payment channel

Parameters
- dto: UpdateP2PPaymentChannelDto
Returns Promise<P2PPaymentChannel>

Promise

updatePaymentHub

updatePaymentHub(dto?: UpdatePaymentHubDto): Promise<PaymentHub>

updates payment hub

Parameters
- Default value dto: UpdatePaymentHubDto = {}
Returns Promise<PaymentHub>

Promise

updatePaymentHubDeposit

updatePaymentHubDeposit(dto: UpdatePaymentHubDepositDto): Promise<PaymentHubDeposit>

updates payment hub deposit

Parameters
- dto: UpdatePaymentHubDepositDto
Returns Promise<PaymentHubDeposit>

Promise

updateProject

updateProject(dto: UpdateProjectDto): Promise<Project>

updates project

Parameters
- dto: UpdateProjectDto
Returns Promise<Project>

Promise

validateENSName

validateENSName(dto: ValidateENSNameDto): Promise<boolean>

validate ens name

Parameters
- dto: ValidateENSNameDto
Returns Promise<boolean>

Promise