Portal Android SDK/io.portalhq.android.api/Api

Api

open class Api(apiHost: String, apiKey: String, requests: PortalRequests = PortalRequests(), provider: Provider, featureFlags: FeatureFlags? = null)

The Api class provides an interface for interacting with the backend API.

It handles authentication, network requests, and response parsing for various endpoints related to client management, blockchain data, and analytics.

Parameters

apiHost

The base URL of the API server.

apiKey

The API key used for authentication.

requests

An instance of PortalRequests to handle HTTP requests. Defaults to a new instance.

provider

An instance of Provider to access device specific data.

featureFlags

An optional instance of FeatureFlags for feature flag management.

Constructors

Api

constructor(apiHost: String, apiKey: String, requests: PortalRequests = PortalRequests(), provider: Provider, featureFlags: FeatureFlags? = null)

Types

Companion

object Companion

Properties

api

open val api: HttpRequester

client

val client: Deferred<ClientResponse?>

Asynchronously retrieves the client details using a coroutine.

host

val host: String

Functions

buildEip155Transaction

open suspend fun buildEip155Transaction(chainId: String, params: BuildTransactionParam): Result<BuildEip115TransactionResponse>

Builds an EIP-155 compatible transaction for the specified blockchain.

buildSolanaTransaction

open suspend fun buildSolanaTransaction(chainId: String, params: BuildTransactionParam): Result<BuildSolanaTransactionResponse>

Builds a Solana-compatible transaction for the specified blockchain.

ejectClient

open fun ejectClient(): Result<Boolean>

Ejects the client from the system, removing their session.

evaluateTransaction

open suspend fun evaluateTransaction(chainId: String, transaction: EvaluateTransactionParam, operationType: EvaluateTransactionOperationType? = null): Result<BlockaidValidateTrxRes>

Evaluates a transaction by validating its parameters.

getAssets

open suspend fun getAssets(chainId: String): Result<GetAssetsByChainResponse>

Retrieves the list of fungible assets owned by the client on a specific blockchain.

getBackupShareMetadata

fun getBackupShareMetadata(): Result<List<BackupSharePairMetadata>>

Retrieves metadata for all stored backup share pairs associated with the client.

getClient

open suspend fun getClient(): ClientResponse

Fetches the client details from the API.

getClientCipherText

open suspend fun getClientCipherText(backupSharePairId: String): String

Retrieves the encrypted client backup share ciphertext associated with a given backup share pair ID.

getEnabledDapps

open fun getEnabledDapps(): List<Dapp>

Fetches the list of enabled decentralized applications (DApps) from the API.

getNetworks

open fun getNetworks(): List<Network>

Retrieves the list of available blockchain networks from the API.

getNftAssets

open suspend fun getNftAssets(chainId: String): Result<GetNftAssetsByChainResponse>

Retrieves the list of NFT assets owned by the client on a specific blockchain.

getQuote

open suspend fun getQuote(chainId: String, swapsApiKey: String, args: QuoteArgs): Result<Quote>

Retrieves a quote for a swap transaction on the specified blockchain.

getSigningShareMetadata

fun getSigningShareMetadata(): Result<List<SigningSharePairMetadata>>

Retrieves metadata for all stored signing share pairs associated with the client.

getSources

open suspend fun getSources(chainId: String, swapsApiKey: String): Result<Map<String, String>>

Retrieves the available sources for swap transactions on the specified blockchain.

getTransactions

open suspend fun getTransactions(chainId: String, limit: Int? = null, offset: Int? = null, order: GetTransactionsOrder? = null): Result<List<Transaction>>

Fetches a list of transactions associated with the client on a given blockchain.

identify

fun identify(traits: Map<String, Any> = mapOf()): MetricsResponse

Identifies a user for analytics tracking by associating traits with them.

prepareEject

open suspend fun prepareEject(walletId: String, backupMethod: BackupMethods): String

Prepares the ejection of a wallet by obtaining the necessary share for the operation.

refreshClient

open suspend fun refreshClient()

Refreshes the client details by resetting the cached client and fetching updated information.

storeClientCipherText

open suspend fun storeClientCipherText(backupSharePairId: String, cipherText: String): Boolean

Stores the encrypted client backup share ciphertext for a given backup share pair ID.

storedClientBackupShare

fun storedClientBackupShare(success: Boolean, backupMethod: BackupMethods): Result<Boolean>

Marks the client backup share as stored by the organization.

storedClientBackupShareKey

open fun storedClientBackupShareKey(success: Boolean, backupMethod: BackupMethods): Result<Boolean>

Marks the client backup share key as stored by the organization.

storedClientSigningShare

open fun storedClientSigningShare(signingSharePairId: String): Boolean

Marks a client signing share as stored by the organization.

track

fun track(event: String, properties: Map<String, Any> = mapOf()): MetricsResponse

Tracks an event for analytics purposes.

updateSharePairStatus

open suspend fun updateSharePairStatus(type: PortalMpcShareType, status: PortalMpcShareStatus, sharePairIds: List<String>): Boolean

Updates the status of a share pair (either signing or backup).