Portal Android SDK

Portal Android SDK/io.portalhq.android.yield/YieldXyz

YieldXyz

class YieldXyz(api: YieldXyzApi, portal: YieldXyzPortalDependency? = null)

YieldXyz provider implementation for discovering and managing yield opportunities.

Parameters

api

The low-level Yield.xyz API client.

portal

The Portal dependency used by high-level deposit/withdraw for signing, address resolution and confirmation. May be null when only the low-level API is used.

Constructors

constructor(api: YieldXyzApi, portal: YieldXyzPortalDependency? = null)

Functions

suspend fun deposit(params: YieldDepositParams, options: YieldSubmitOptions? = null): Result<YieldDepositResult>

High-level deposit: resolves the yield, builds enter transactions, signs and submits each transaction sequentially, waits for confirmation, and tracks each hash.

suspend fun discover(request: YieldXyzGetYieldsRequest? = null): Result<YieldXyzGetYieldsResponse>

Discovers yield opportunities based on the provided parameters.

suspend fun enter(request: YieldXyzEnterRequest): Result<YieldXyzEnterYieldResponse>

Enters a yield opportunity with the specified parameters.

suspend fun exit(request: YieldXyzExitRequest): Result<YieldXyzExitResponse>

Exits a yield opportunity with the specified parameters.

suspend fun getBalances(request: YieldXyzGetBalancesRequest): Result<YieldXyzGetBalancesResponse>

Retrieves yield balances for specified addresses and networks.

getHistoricalActions

suspend fun getHistoricalActions(request: YieldXyzGetHistoricalActionsRequest): Result<YieldXyzGetHistoricalActionsResponse>

Retrieves historical yield actions with optional filtering.

suspend fun getTransaction(transactionId: String): Result<YieldXyzGetTransactionResponse>

Retrieves a single yield action transaction by its ID.

suspend fun getValidators(yieldId: String): Result<List<YieldXyzValidator>>

Returns the available validators for a native-staking yield.

suspend fun manage(request: YieldXyzManageYieldRequest): Result<YieldXyzManageYieldResponse>

Manages a yield opportunity with the specified parameters.

suspend fun track(transactionId: String, txHash: String): Result<Boolean>

Tracks a transaction by submitting its hash to the Yield.xyz integration.

suspend fun withdraw(params: YieldWithdrawParams, options: YieldSubmitOptions? = null): Result<YieldWithdrawResult>

High-level withdraw; same parameters and behavior as deposit.