@portal-hq/web 3.7.0 → 3.8.0

package/yieldxyz-types.d.ts

@@ -1,778 +1,78 @@
 /**
- * Tron resource types
- */
-export type YieldXyzTronResource = 'BANDWIDTH' | 'ENERGY'
-
-/**
- * Execution modes for yield actions
- */
-export type YieldXyzExecutionMode = 'individual' | 'batched'
-
-/**
- * Arguments for entering a yield opportunity
- */
-export interface YieldXyzEnterArguments {
-  amount?: string
-  validatorAddress?: string
-  validatorAddresses?: string[]
-  providerId?: string
-  duration?: number
-  inputToken?: string
-  subnetId?: number
-  tronResource?: YieldXyzTronResource
-  feeConfigurationId?: string
-  cosmosPubKey?: string
-  tezosPubKey?: string
-  cAddressBech?: string
-  pAddressBech?: string
-  executionMode?: YieldXyzExecutionMode
-  ledgerWalletApiCompatible?: boolean
-}
-
-/**
- * Request to enter a yield opportunity
- */
-export interface YieldXyzEnterRequest {
-  yieldId: string
-  address: string
-  arguments?: YieldXyzEnterArguments
-}
-
-/**
- * Request to exit a yield opportunity
- */
-export interface YieldXyzExitRequest {
-  yieldId: string
-  address: string
-  arguments?: YieldXyzEnterArguments
-}
-
-/**
- * Yield action intent types
- */
-export type YieldXyzActionIntent = 'enter' | 'manage' | 'exit'
-
-/**
- * Yield action types
- */
-export type YieldXyzActionType =
-  | 'STAKE'
-  | 'UNSTAKE'
-  | 'CLAIM_REWARDS'
-  | 'RESTAKE_REWARDS'
-  | 'WITHDRAW'
-  | 'WITHDRAW_ALL'
-  | 'RESTAKE'
-  | 'CLAIM_UNSTAKED'
-  | 'UNLOCK_LOCKED'
-  | 'STAKE_LOCKED'
-  | 'VOTE'
-  | 'REVOKE'
-  | 'VOTE_LOCKED'
-  | 'REVOTE'
-  | 'REBOND'
-  | 'MIGRATE'
-  | 'VERIFY_WITHDRAW_CREDENTIALS'
-  | 'DELEGATE'
-
-/**
- * Yield action execution patterns
- */
-export type YieldXyzActionExecutionPattern =
-  | 'synchronous'
-  | 'asynchronous'
-  | 'batch'
-
-/**
- * Yield action status
- */
-export type YieldXyzActionStatus =
-  | 'CANCELED'
-  | 'CREATED'
-  | 'WAITING_FOR_NEXT'
-  | 'PROCESSING'
-  | 'FAILED'
-  | 'SUCCESS'
-  | 'STALE'
-
-/**
- * Yield action transaction status
- */
-export type YieldXyzActionTransactionStatus =
-  | 'BLOCKED'
-  | 'BROADCASTED'
-  | 'CONFIRMED'
-  | 'CREATED'
-  | 'FAILED'
-  | 'NOT_FOUND'
-  | 'PENDING'
-  | 'SIGNED'
-  | 'SKIPPED'
-  | 'WAITING_FOR_SIGNATURE'
-
-/**
- * Yield action transaction type
- */
-export type YieldXyzActionTransactionType =
-  | 'APPROVAL'
-  | 'BRIDGE'
-  | 'CLAIM_REWARDS'
-  | 'CLAIM_UNSTAKED'
-  | 'COMPLETE_QUEUED_WITHDRAWALS'
-  | 'CREATE_ACCOUNT'
-  | 'CREATE_EIGENPOD'
-  | 'DELEGATE'
-  | 'DEPOSIT'
-  | 'FREEZE_BANDWIDTH'
-  | 'FREEZE_ENERGY'
-  | 'INFSTONES_CLAIM_REQUEST'
-  | 'INFSTONES_EXIT_REQUEST'
-  | 'INFSTONES_PROVISION'
-  | 'LOCK'
-  | 'LUGANODES_EXIT_REQUEST'
-  | 'LUGANODES_PROVISION'
-  | 'MERGE'
-  | 'MIGRATE'
-  | 'P2P_NODE_REQUEST'
-  | 'QUEUE_WITHDRAWALS'
-  | 'REBOND'
-  | 'RESTAKE'
-  | 'RESTAKE_REWARDS'
-  | 'REVEAL'
-  | 'REVOKE'
-  | 'SPLIT'
-  | 'STAKE'
-  | 'START_CHECKPOINT'
-  | 'SUPPLY'
-  | 'SWAP'
-  | 'UNDELEGATE'
-  | 'UNDELEGATE_BANDWIDTH'
-  | 'UNDELEGATE_ENERGY'
-  | 'UNFREEZE_BANDWIDTH'
-  | 'UNFREEZE_ENERGY'
-  | 'UNFREEZE_LEGACY'
-  | 'UNFREEZE_LEGACY_BANDWIDTH'
-  | 'UNFREEZE_LEGACY_ENERGY'
-  | 'UNLOCK'
-  | 'UNSTAKE'
-  | 'UNWRAP'
-  | 'UTXO_C_TO_P_IMPORT'
-  | 'UTXO_P_TO_C_IMPORT'
-  | 'VERIFY_CHECKPOINT_PROOFS'
-  | 'VERIFY_WITHDRAW_CREDENTIALS'
-  | 'VOTE'
-  | 'WITHDRAW'
-  | 'WITHDRAW_ALL'
-  | 'WRAP'
-
-/**
- * Yield action transaction
- */
-export interface YieldXyzActionTransaction {
-  id: string
-  title: string
-  network: string
-  status: YieldXyzActionTransactionStatus
-  type: YieldXyzActionTransactionType
-  hash?: string
-  createdAt: string
-  broadcastedAt?: string
-  signedTransaction?: string
-  unsignedTransaction?: string
-  annotatedTransaction?: Record<string, any>
-  structuredTransaction?: Record<string, any>
-  stepIndex: number
-  description?: string
-  error?: string
-  gasEstimate?: string
-  explorerUrl?: string
-  isMessage?: boolean
-}
-
-export interface YieldXyzEnterRawResponse {
-  id: string
-  intent: YieldXyzActionIntent
-  type: YieldXyzActionType
-  yieldId: string
-  address: string
-  amount?: string
-  amountRaw?: string
-  amountUsd?: string
-  transactions: YieldXyzActionTransaction[]
-  executionPattern: YieldXyzActionExecutionPattern
-  rawArguments?: YieldXyzEnterArguments
-  createdAt: string
-  completedAt?: string
-  status: YieldXyzActionStatus
-}
-
-export interface YieldXyzEnterYieldData {
-  rawResponse: YieldXyzEnterRawResponse
-}
-
-/**
- * Response from entering a yield opportunity
- */
-export interface YieldXyzEnterYieldResponse {
-  data?: YieldXyzEnterYieldData
-  error?: string
-}
-
-export interface YieldXyzExitRawResponse {
-  id: string
-  intent: YieldXyzActionIntent
-  type: YieldXyzActionType
-  yieldId: string
-  address: string
-  amount?: string
-  amountRaw?: string
-  amountUsd?: string
-  transactions: YieldXyzActionTransaction[]
-  executionPattern: YieldXyzActionExecutionPattern
-  rawArguments?: YieldXyzEnterArguments
-  createdAt: string
-  completedAt?: string
-  status: YieldXyzActionStatus
-}
-
-export interface YieldXyzExitData {
-  rawResponse: YieldXyzExitRawResponse
-}
-
-/**
- * Response from exiting a yield opportunity
- */
-export interface YieldXyzExitResponse {
-  data?: YieldXyzExitData
-  error?: string
-}
-
-export interface YieldXyzBalanceQuery {
-  address: string
-  network: string
-  yieldId?: string
-}
-
-/**
- * Request to get yield balances for specific addresses and networks
- */
-export interface YieldXyzGetBalancesRequest {
-  queries: YieldXyzBalanceQuery[]
-}
-
-export interface YieldXyzBalanceToken {
-  address: string
-  symbol: string
-  name: string
-  decimals: number
-  logoURI?: string
-  network: string
-  isPoints?: boolean
-}
-
-export interface YieldXyzBalancePendingAction {
-  intent: YieldXyzActionIntent
-  type: YieldXyzActionType
-  passthrough: string
-  arguments?: YieldXyzArgument
-}
-
-export interface YieldXyzBalance {
-  address: string
-  amount: string
-  amountRaw: string
-  type: string
-  token: YieldXyzBalanceToken
-  pendingActions?: YieldXyzBalancePendingAction[]
-  amountUsd?: string
-  isEarning?: boolean
-}
-
-export interface YieldXyzGetBalancesItem {
-  yieldId: string
-  balances: YieldXyzBalance[]
-}
-
-export interface YieldXyzGetBalancesRawResponse {
-  items: YieldXyzGetBalancesItem[]
-  errors?: string[]
-}
-
-export interface YieldXyzGetBalancesData {
-  rawResponse: YieldXyzGetBalancesRawResponse
-}
-
-export interface YieldXyzGetBalancesMetadata {
-  clientId?: string
-}
-
-/**
- * Response from getting yield balances
- */
-export interface YieldXyzGetBalancesResponse {
-  data?: YieldXyzGetBalancesData
-  error?: string
-  metadata?: YieldXyzGetBalancesMetadata
-}
-
-/**
- * Request to get historical yield actions with optional filtering
- */
-export interface YieldXyzGetHistoricalActionsRequest {
-  offset?: number
-  limit?: number
-  address?: string
-  status?: YieldXyzActionStatus
-  intent?: YieldXyzActionIntent
-  type?: YieldXyzActionType
-  yieldId?: string
-}
-
-export interface YieldXyzGetHistoricalActionsRawResponse {
-  items: YieldXyzEnterRawResponse[]
-  total?: number
-  offset?: number
-  limit?: number
-}
-
-export interface YieldXyzGetHistoricalActionsData {
-  rawResponse: YieldXyzGetHistoricalActionsRawResponse
-}
-
-/**
- * Response for fetching yield actions list for an address
- */
-export interface YieldXyzGetHistoricalActionsResponse {
-  data?: YieldXyzGetHistoricalActionsData
-  error?: string
-  metadata?: YieldXyzGetBalancesMetadata
-}
-
-/**
- * Sort options for yield opportunities
- */
-export type YieldXyzGetYieldsSort =
-  | 'statusEnterAsc'
-  | 'statusEnterDesc'
-  | 'statusExitAsc'
-  | 'statusExitDesc'
-
-/**
- * Yield mechanics types
- */
-export type YieldXyzMechanicsType =
-  | 'staking'
-  | 'restaking'
-  | 'lending'
-  | 'vault'
-  | 'fixed_yield'
-  | 'real_world_asset'
-
-/**
- * Request parameters for getting yield opportunities from Yield.xyz
- */
-export interface YieldXyzGetYieldsRequest {
-  offset?: number
-  limit?: number
-  network?: string
-  yieldId?: string
-  type?: YieldXyzMechanicsType
-  hasCooldownPeriod?: boolean
-  hasWarmupPeriod?: boolean
-  token?: string
-  inputToken?: string
-  provider?: string
-  search?: string
-  sort?: YieldXyzGetYieldsSort
-}
-
-/**
- * Token information
- */
-export interface YieldXyzToken {
-  symbol: string
-  name: string
-  decimals?: number
-  network?: string
-  address?: string
-  logoURI?: string
-  isPoints?: boolean
-  coinGeckoId?: string
-}
-
-/**
- * Rate type
- */
-export type YieldXyzRateType = 'APR' | 'APY'
-
-/**
- * Yield source
- */
-export type YieldXyzSource =
-  | 'staking'
-  | 'restaking'
-  | 'protocol_incentive'
-  | 'points'
-  | 'lending_interest'
-  | 'mev'
-  | 'real_world_asset_yield'
-  | 'validator_commission'
-
-/**
- * Reward rate component
- */
-export interface YieldXyzRewardRateComponent {
-  rate: number
-  rateType: YieldXyzRateType
-  token: YieldXyzToken
-  yieldSource: YieldXyzSource
-  description: string
-}
-
-/**
- * Reward rate information
- */
-export interface YieldXyzRewardRate {
-  total: number
-  rateType: YieldXyzRateType
-  components: YieldXyzRewardRateComponent[]
-}
-
-/**
- * Statistics for a yield opportunity
- */
-export interface YieldXyzStatistics {
-  tvlUsd?: string
-  tvl?: string | null
-  uniqueUsers?: number
-  averagePositionSizeUsd?: string | null
-  averagePositionSize?: string | null
-}
-
-/**
- * Status of a yield opportunity
- */
-export interface YieldXyzStatus {
-  enter: boolean
-  exit: boolean
-}
-
-/**
- * Metadata for a yield opportunity
- */
-export interface YieldXyzOpportunityMetadata {
-  name: string
-  logoURI: string
-  description: string
-  documentation: string
-  underMaintenance: boolean
-  deprecated: boolean
-  supportedStandards: string[]
-}
-
-/**
- * Reward schedule
- */
-export type YieldXyzRewardSchedule =
-  | 'block'
-  | 'hour'
-  | 'day'
-  | 'week'
-  | 'month'
-  | 'era'
-  | 'epoch'
-  | 'campaign'
-
-/**
- * Reward claiming
- */
-export type YieldXyzRewardClaiming = 'auto' | 'manual'
-
-/**
- * Lockup period information
- */
-export interface YieldXyzLockupPeriod {
-  seconds: number
-}
-
-/**
- * Cooldown period information
- */
-export interface YieldXyzCooldownPeriod {
-  seconds: number
-}
-
-/**
- * Warmup period information
- */
-export interface YieldXyzWarmupPeriod {
-  seconds: number
-}
-
-/**
- * Fee information
- */
-export interface YieldXyzFee {
-  deposit: number
-  withdrawal: number
-  performance: number
-  management: number
-}
-
-/**
- * Entry limits information
- */
-export interface YieldXyzEntryLimits {
-  minimum?: string
-  maximum?: string
-}
-
-/**
- * Argument field name
- */
-export type YieldXyzArgumentFieldName =
-  | 'amount'
-  | 'validatorAddress'
-  | 'validatorAddresses'
-  | 'receiverAddress'
-  | 'providerId'
-  | 'duration'
-  | 'inputToken'
-  | 'subnetId'
-  | 'tronResource'
-  | 'feeConfigurationId'
-  | 'cosmosPubKey'
-  | 'tezosPubKey'
-  | 'cAddressBech'
-  | 'pAddressBech'
-  | 'executionMode'
-  | 'ledgerWalletApiCompatible'
-
-/**
- * Argument field type
- */
-export type YieldXyzArgumentFieldType =
-  | 'string'
-  | 'number'
-  | 'address'
-  | 'enum'
-  | 'boolean'
-
-/**
- * Argument field definition
- */
-export interface YieldXyzArgumentField {
-  name: YieldXyzArgumentFieldName
-  type: YieldXyzArgumentFieldType
-  label: string
-  description?: string
-  required?: boolean
-  options?: string[]
-  optionsRef?: string
-  default?: Record<string, any>
-  placeholder?: string
-  minimum?: string
-  maximum?: string
-  isArray?: boolean
-}
-
-/**
- * Argument definition
- */
-export interface YieldXyzArgument {
-  fields: YieldXyzArgumentField[]
-  notes?: string
-}
-
-/**
- * Arguments for yield operations
- */
-export interface YieldXyzArguments {
-  enter: YieldXyzArgument
-  exit: YieldXyzArgument
-  manage?: Record<string, any>
-  balance?: YieldXyzArgument
-}
-
-/**
- * Possible fee taking mechanisms
- */
-export interface YieldXyzPossibleFeeTakingMechanisms {
-  depositFee: boolean
-  managementFee: boolean
-  performanceFee: boolean
-  validatorRebates: boolean
-}
-
-/**
- * Mechanics information for a yield opportunity
- */
-export interface YieldXyzMechanics {
-  type: YieldXyzMechanicsType
-  requiresValidatorSelection: boolean
-  rewardSchedule: YieldXyzRewardSchedule
-  rewardClaiming: YieldXyzRewardClaiming
-  gasFeeToken: YieldXyzToken
-  lockupPeriod?: YieldXyzLockupPeriod
-  cooldownPeriod?: YieldXyzCooldownPeriod
-  warmupPeriod?: YieldXyzWarmupPeriod
-  fee?: YieldXyzFee
-  entryLimits: YieldXyzEntryLimits
-  supportsLedgerWalletApi: boolean
-  extraTransactionFormatsSupported?: string[]
-  arguments: YieldXyzArguments
-  possibleFeeTakingMechanisms: YieldXyzPossibleFeeTakingMechanisms
-}
-
-/**
- * A yield opportunity
- */
-export interface YieldXyzOpportunity {
-  id: string
-  network: string
-  inputTokens: YieldXyzToken[]
-  outputToken: YieldXyzToken
-  token: YieldXyzToken
-  rewardRate: YieldXyzRewardRate
-  statistics?: YieldXyzStatistics
-  status: YieldXyzStatus
-  metadata: YieldXyzOpportunityMetadata
-  mechanics: YieldXyzMechanics
-  providerId: string
-  tags: string[]
-}
-
-export interface YieldXyzGetYieldsRawResponse {
-  items: YieldXyzOpportunity[]
-  limit: number
-  offset: number
-  total: number
-}
-
-export interface YieldXyzGetYieldsData {
-  rawResponse: YieldXyzGetYieldsRawResponse
-}
-
-/**
- * Response containing yield opportunities from Yield.xyz
- */
-export interface YieldXyzGetYieldsResponse {
-  data?: YieldXyzGetYieldsData
-  error?: string
-}
-
-/**
- * Request to manage a yield opportunity
- */
-export interface YieldXyzManageYieldRequest {
-  yieldId: string
-  address: string
-  arguments?: YieldXyzEnterArguments
-  action: YieldXyzActionType
-  passthrough: string
-}
-
-export interface YieldXyzManageYieldRawResponse {
-  id: string
-  intent: YieldXyzActionIntent
-  type: YieldXyzActionType
-  yieldId: string
-  address: string
-  amount?: string
-  amountRaw?: string
-  amountUsd?: string
-  transactions: YieldXyzActionTransaction[]
-  executionPattern: YieldXyzActionExecutionPattern
-  rawArguments?: YieldXyzEnterArguments
-  createdAt: string
-  completedAt?: string
-  status: YieldXyzActionStatus
-}
-
-export interface YieldXyzManageYieldData {
-  rawResponse: YieldXyzManageYieldRawResponse
-}
-
-/**
- * Response from managing a yield opportunity
- */
-export interface YieldXyzManageYieldResponse {
-  data?: YieldXyzManageYieldData
-  error?: string
-}
-
-// ============================================================================
-// Track Transaction Types
-// ============================================================================
-
-/**
- * Request to submit a transaction hash for tracking
- */
-export interface YieldXyzTrackTransactionRequest {
-  transactionId: string
-  hash: string
-}
-
-export interface YieldXyzTrackTransactionRawResponse {
-  id: string
-  title: string
-  network: string
-  status: YieldXyzActionTransactionStatus
-  type: YieldXyzActionTransactionType
-  hash?: string
-  createdAt: string
-  broadcastedAt?: string
-  signedTransaction?: string
-  unsignedTransaction?: string
-  stepIndex: number
-  gasEstimate?: string
-}
-
-export interface YieldXyzTrackTransactionData {
-  rawResponse: YieldXyzTrackTransactionRawResponse
-}
-
-/**
- * Response from submitting a transaction hash
- */
-export interface YieldXyzTrackTransactionResponse {
-  data?: YieldXyzTrackTransactionData
-  error?: string
-}
-
-// ============================================================================
-// Get Transaction Types
-// ============================================================================
-
-export interface YieldXyzGetTransactionRawResponse {
-  id: string
-  title: string
-  network: string
-  status: YieldXyzActionTransactionStatus
-  type: YieldXyzActionTransactionType
-  hash?: string
-  createdAt: string
-  broadcastedAt?: string
-  signedTransaction?: string
-  unsignedTransaction?: string
-  stepIndex: number
-  gasEstimate?: string
-}
-
-export interface YieldXyzGetTransactionRequest {
-  rawResponse: YieldXyzGetTransactionRawResponse
-}
-
-export interface YieldXyzGetTransactionMetadata {
-  clientId?: string
-  transactionId?: string
-}
-
-/**
- * Response for fetching a single yield action transaction by ID
- */
-export interface YieldXyzGetTransactionResponse {
-  data?: YieldXyzGetTransactionRequest
-  error?: string
-  metadata?: YieldXyzGetTransactionMetadata
-}
+ * Re-export all YieldXyz types from shared types
+ */
+export type {
+  YieldXyzTronResource,
+  YieldXyzExecutionMode,
+  YieldXyzEnterArguments,
+  YieldXyzEnterRequest,
+  YieldXyzExitRequest,
+  YieldXyzActionIntent,
+  YieldXyzActionType,
+  YieldXyzActionExecutionPattern,
+  YieldXyzActionStatus,
+  YieldXyzActionTransactionStatus,
+  YieldXyzActionTransactionType,
+  YieldXyzActionTransaction,
+  YieldXyzEnterRawResponse,
+  YieldXyzEnterYieldData,
+  YieldXyzEnterYieldResponse,
+  YieldXyzExitRawResponse,
+  YieldXyzExitData,
+  YieldXyzExitResponse,
+  YieldXyzBalanceQuery,
+  YieldXyzGetBalancesRequest,
+  YieldXyzBalanceToken,
+  YieldXyzBalancePendingAction,
+  YieldXyzBalance,
+  YieldXyzGetBalancesItem,
+  YieldXyzGetBalancesRawResponse,
+  YieldXyzGetBalancesData,
+  YieldXyzGetBalancesMetadata,
+  YieldXyzGetBalancesResponse,
+  YieldXyzGetHistoricalActionsRequest,
+  YieldXyzGetHistoricalActionsRawResponse,
+  YieldXyzGetHistoricalActionsData,
+  YieldXyzGetHistoricalActionsResponse,
+  YieldXyzGetYieldsSort,
+  YieldXyzMechanicsType,
+  YieldXyzGetYieldsRequest,
+  YieldXyzToken,
+  YieldXyzRateType,
+  YieldXyzSource,
+  YieldXyzRewardRateComponent,
+  YieldXyzRewardRate,
+  YieldXyzStatistics,
+  YieldXyzStatus,
+  YieldXyzOpportunityMetadata,
+  YieldXyzRewardSchedule,
+  YieldXyzRewardClaiming,
+  YieldXyzLockupPeriod,
+  YieldXyzCooldownPeriod,
+  YieldXyzWarmupPeriod,
+  YieldXyzFee,
+  YieldXyzEntryLimits,
+  YieldXyzArgumentFieldName,
+  YieldXyzArgumentFieldType,
+  YieldXyzArgumentField,
+  YieldXyzArgument,
+  YieldXyzArguments,
+  YieldXyzPossibleFeeTakingMechanisms,
+  YieldXyzMechanics,
+  YieldXyzOpportunity,
+  YieldXyzGetYieldsRawResponse,
+  YieldXyzGetYieldsData,
+  YieldXyzGetYieldsResponse,
+  YieldXyzManageYieldRequest,
+  YieldXyzManageYieldRawResponse,
+  YieldXyzManageYieldData,
+  YieldXyzManageYieldResponse,
+  YieldXyzTrackTransactionRequest,
+  YieldXyzTrackTransactionRawResponse,
+  YieldXyzTrackTransactionData,
+  YieldXyzTrackTransactionResponse,
+  YieldXyzGetTransactionRawResponse,
+  YieldXyzGetTransactionRequest,
+  YieldXyzGetTransactionMetadata,
+  YieldXyzGetTransactionResponse,
+} from './src/shared/types/yieldxyz'