@portal-hq/web 3.13.2 → 3.14.0-alpha.0

package/src/shared/types/noah.ts

@@ -25,9 +25,40 @@ export interface NoahInitiatePayinRequest {
   destinationAddress: string
 }
 
+export interface StreetAddress {
+  city?: string
+  country?: string
+  line1?: string
+  line2?: string
+  postalCode?: string
+  state?: string
+}
+
+export interface BankToAddressRelatedPaymentMethod {
+  paymentMethodId: string
+  paymentMethodType: string
+  details?: {
+    accountNumber?: string
+    bankCode?: string
+  }
+}
+
+export interface BankDetails {
+  paymentMethodId: string
+  paymentMethodType: string
+  accountNumber: string
+  network: string
+  accountHolderName?: string
+  bankCode?: string
+  bankName?: string
+  bankAddress?: StreetAddress
+  reference?: string
+  relatedPaymentMethods?: BankToAddressRelatedPaymentMethod[]
+}
+
 export interface NoahInitiatePayinResponseData {
   payinId: string
-  bankDetails: Record<string, unknown>
+  bankDetails: BankDetails
 }
 
 export type NoahInitiatePayinResponse =
@@ -39,13 +70,15 @@ export interface NoahSimulatePayinRequest {
   fiatCurrency: string
 }
 
-export type NoahSimulatePayinResponseData = Record<string, unknown>
+export interface NoahSimulatePayinResponseData {
+  fiatDepositId: string
+}
 
 export type NoahSimulatePayinResponse =
   PortalApiSuccessEnvelope<NoahSimulatePayinResponseData>
 
 export interface NoahGetPayoutCountriesResponseData {
-  countries: unknown
+  countries: Record<string, string[]>
 }
 
 export type NoahGetPayoutCountriesResponse =
@@ -58,17 +91,84 @@ export interface NoahGetPayoutChannelsRequest {
   fiatAmount?: string
 }
 
-/** GET …/payouts/channels — body shape is provider-specific (array or object). */
-export type NoahGetPayoutChannelsResponseData = unknown
+export interface ChannelLimits {
+  minLimit: string
+  maxLimit?: string
+}
+
+export interface ChannelCalculated {
+  totalFee: string
+}
+
+export interface Channel {
+  id: string
+  paymentMethodType: string
+  fiatCurrency: string
+  country: string
+  limits: ChannelLimits
+  rate: string
+  processingSeconds: number
+  calculated?: ChannelCalculated
+}
+
+export interface NoahGetPayoutChannelsResponseData {
+  items: Channel[]
+  pageToken?: string
+}
 
 export type NoahGetPayoutChannelsResponse =
   PortalApiSuccessEnvelope<NoahGetPayoutChannelsResponseData>
 
-export type NoahGetPayoutChannelFormResponseData = unknown
+export interface NoahGetPayoutChannelFormResponseData {
+  formSchema?: Record<string, unknown>
+  formMetadata?: {
+    contentHash: string
+  }
+}
 
 export type NoahGetPayoutChannelFormResponse =
   PortalApiSuccessEnvelope<NoahGetPayoutChannelFormResponseData>
 
+export interface PaymentMethodDetails {
+  type: string
+  accountNumber?: string
+  bankCode?: string
+  last4?: string
+  scheme?: string
+  identifierType?: string
+  identifier?: string
+}
+
+export interface AccountHolderDetails {
+  name?: string
+  taxId?: string
+  email?: string
+  phoneNumber?: string
+  address?: StreetAddress
+}
+
+export interface IssuerDetails {
+  name?: string
+  bankCode?: string
+  bankName?: string
+}
+
+export interface PaymentMethod {
+  id: string
+  paymentMethodType: string
+  details: PaymentMethodDetails
+  accountHolderDetails?: AccountHolderDetails
+  issuerDetails?: IssuerDetails
+}
+
+export interface NoahGetPaymentMethodsResponseData {
+  paymentMethods: PaymentMethod[]
+  pageToken?: string
+}
+
+export type NoahGetPaymentMethodsResponse =
+  PortalApiSuccessEnvelope<NoahGetPaymentMethodsResponseData>
+
 export interface NoahGetPayoutQuoteRequest {
   channelId: string
   cryptoCurrency: string
@@ -78,34 +178,33 @@ export interface NoahGetPayoutQuoteRequest {
   paymentMethodId?: string
 }
 
+export interface FormNextStep {
+  stepId: string
+  stepType: 'Ack' | 'DataEntry'
+  schema: Record<string, unknown>
+}
+
 export interface NoahGetPayoutQuoteResponseData {
   payoutId: string
-  formSessionId: string
-  cryptoAmountEstimate: string
   totalFee: string
-  nextStep?: unknown
+  cryptoAmountEstimate: string
+  formSessionId: string
+  nextStep?: FormNextStep
 }
 
 export type NoahGetPayoutQuoteResponse =
   PortalApiSuccessEnvelope<NoahGetPayoutQuoteResponseData>
 
-/**
- * Single row inside Noah `AmountConditions` (PascalCase from API) or camelCase variants.
- * Aligns with connect-api Noah / on-chain deposit trigger payloads.
- */
-export interface NoahAmountConditionRow {
-  ComparisonOperator?: string
-  Value?: string
-  comparisonOperator?: string
-  value?: string
+export interface AmountCondition {
+  comparisonOperator: string
+  value: string
 }
 
-/** One condition block: amount rules + network (Noah payout deposit shape). */
-export interface NoahPayoutConditionBlock {
-  AmountConditions?: NoahAmountConditionRow[]
-  amountConditions?: NoahAmountConditionRow[]
-  Network?: string
-  network?: string
+export interface DepositSourceTriggerCondition {
+  amountConditions: AmountCondition[]
+  cryptoCurrency: string
+  network: string
+  destinationAddress: string
 }
 
 /** Supported Solana CAIP-2 IDs for payout deposit flows. */
@@ -135,16 +234,8 @@ export interface NoahInitiatePayoutRequest {
 
 export interface NoahInitiatePayoutResponseData {
   destinationAddress: string | null
-  conditions: unknown
+  conditions: DepositSourceTriggerCondition[]
 }
 
 export type NoahInitiatePayoutResponse =
   PortalApiSuccessEnvelope<NoahInitiatePayoutResponseData>
-
-export interface NoahGetPaymentMethodsResponseData {
-  paymentMethods: unknown
-  pageToken?: unknown
-}
-
-export type NoahGetPaymentMethodsResponse =
-  PortalApiSuccessEnvelope<NoahGetPaymentMethodsResponseData>

package/src/shared/types/yieldxyz.ts

@@ -776,3 +776,189 @@ export interface YieldXyzGetTransactionResponse {
   error?: string
   metadata?: YieldXyzGetTransactionMetadata
 }
+
+// ============================================================================
+// High-level Yield (deposit / withdraw / validators) — shared contract types
+// ============================================================================
+
+export interface YieldDefaultYieldEntry {
+  yieldId: string
+  opportunity: YieldXyzOpportunity | null
+}
+
+export type YieldDefaultYieldsMap = Record<string, YieldDefaultYieldEntry>
+
+export interface YieldXyzGetYieldDefaultsRequest {
+  includeOpportunities?: boolean
+}
+
+export interface YieldXyzGetYieldDefaultsResponse {
+  data?: YieldDefaultYieldsMap
+  error?: string
+}
+
+export interface YieldXyzValidator {
+  address: string
+  name?: string
+  commission?: string
+  apy?: string
+  [key: string]: unknown
+}
+
+export interface YieldXyzGetYieldValidatorsResponse {
+  data?: {
+    /** Validators may appear on data.validators or nested under data.rawResponse; consumers should read both. */
+    validators?: YieldXyzValidator[]
+    rawResponse?: {
+      validators?: YieldXyzValidator[]
+      /** Paginated validator list shape on nested rawResponse for some native-staking responses. */
+      items?: YieldXyzValidator[]
+      total?: number
+      offset?: number
+      limit?: number
+    }
+  }
+  error?: string
+}
+
+
+
+
+/**
+ * Progress event for deposit/withdraw high-level methods.
+ * Lifecycle steps emitted by high-level deposit/withdraw:
+ * - `signing`:    about to call signAndSendTransaction
+ * - `submitted`:  hash received from signAndSendTransaction
+ * - `confirming`: waiting for on-chain confirmation to reach required depth
+ * - `confirmed`:  on-chain confirmation complete; about to track
+ */
+export interface YieldSubmitProgress {
+  step: 'signing' | 'submitted' | 'confirming' | 'confirmed'
+  index: number
+  total: number
+  hash?: string
+}
+
+/**
+ * High-level yield deposit / withdraw using an explicit Portal `yieldId` (no defaults lookup).
+ */
+export interface YieldDepositParamsByYieldId {
+  yieldId: string
+  amount: string
+  address: string
+  arguments?: YieldXyzEnterArguments
+}
+
+/**
+ * High-level yield deposit / withdraw: the SDK resolves `yieldId` by fetching Portal yield
+ * defaults and reading the entry for `{chain}:{token}`. Pass `token` **exactly** as that map key
+ * suffix (same casing/symbol the API returns).
+ */
+export interface YieldDepositParamsByChainAndToken {
+  chain: string
+  token: string
+  amount: string
+  address: string
+  arguments?: YieldXyzEnterArguments
+}
+
+/**
+ * High-level yield deposit parameters: either {@link YieldDepositParamsByYieldId} or
+ * {@link YieldDepositParamsByChainAndToken}. When `yieldId` is a non-empty string (after trim), it
+ * is used directly and defaults lookup is skipped; otherwise `chain` and `token` are required.
+ * At runtime, a non-empty `yieldId` takes precedence over any also-present `chain` / `token`.
+ */
+export type YieldDepositParams =
+  | YieldDepositParamsByYieldId
+  | YieldDepositParamsByChainAndToken
+
+/**
+ * Same union as {@link YieldDepositParams}.
+ */
+export type YieldWithdrawParams = YieldDepositParams
+
+/**
+ * Options for deposit/withdraw high-level methods (e.g. onProgress).
+ */
+export interface YieldSubmitOptions {
+  onProgress?: (event: YieldSubmitProgress) => void
+  /**
+   * Per-call signer override. Takes priority over the instance-level setter
+   * ({@link YieldXyz.setSignAndSendTransaction}) when provided.
+   * Useful for one-off calls that need a different signer without reconfiguring the instance.
+   */
+  signAndSendTransaction?: (
+    transaction: unknown,
+    network: string,
+  ) => Promise<string>
+  /**
+   * Optional per-call override for post-submit confirmation logic.
+   * Called for **every** transaction on **any** chain (EVM and non-EVM).
+   * Takes priority over Portal.waitForConfirmation.
+   *
+   * When omitted, Portal.waitForConfirmation is used for EVM Yield networks
+   * (eth_getTransactionReceipt via gatewayConfig), so multi-step EVM flows stay
+   * nonce-safe without extra integrator code.
+   */
+  waitForConfirmation?: (
+    txHash: string,
+    network: string,
+  ) => Promise<void | boolean>
+  /**
+   * Optional per-call JSON-RPC transport used by the built-in EVM receipt poller when
+   * `waitForConfirmation` is not supplied.
+   */
+  evmRequestFn?: (
+    method: string,
+    params: unknown[],
+    network: string,
+  ) => Promise<unknown>
+  /**
+   * Per-call tuning for the built-in EVM receipt poller used when `waitForConfirmation`
+   * is not provided and the standalone `evmRequestFn` fallback is active.
+   * When omitted, the built-in defaults (4 s poll interval, 15 min timeout) are used.
+   */
+  evmPollerOptions?: {
+    pollIntervalMs?: number
+    timeoutMs?: number
+  }
+}
+
+/**
+ * Result of high-level deposit. When the call used `chain` + `token`, those are echoed on the
+ * result; when only `yieldId` was passed, `chain` and `token` are omitted.
+ */
+export interface YieldDepositResult {
+  hashes: string[]
+  yieldId: string
+  chain?: string
+  token?: string
+  yieldOpportunityDetails: {
+    yieldId: string
+    intent?: YieldXyzActionIntent
+    type?: YieldXyzActionType
+    executionPattern?: YieldXyzActionExecutionPattern
+    status?: YieldXyzActionStatus
+    amount?: string | null
+    amountUsd?: string | null
+  }
+}
+
+/**
+ * Result of high-level withdraw. Same `chain` / `token` echo rules as {@link YieldDepositResult}.
+ */
+export interface YieldWithdrawResult {
+  hashes: string[]
+  yieldId: string
+  chain?: string
+  token?: string
+  yieldOpportunityDetails: {
+    yieldId: string
+    intent?: YieldXyzActionIntent
+    type?: YieldXyzActionType
+    executionPattern?: YieldXyzActionExecutionPattern
+    status?: YieldXyzActionStatus
+    amount?: string | null
+    amountUsd?: string | null
+  }
+}

package/src/shared/types/zero-x.ts

@@ -15,6 +15,8 @@ export interface ZeroExQuoteRequest {
 }
 
 export interface ZeroExQuoteResponse {
+  /** When set (non-empty after trim), do not execute the quote (fail closed). */
+  error?: string
   data: {
     rawResponse: {
       message?: string
@@ -202,3 +204,67 @@ export interface ZeroExPriceResponse {
 export interface ZeroExOptions {
   zeroXApiKey?: string
 }
+
+// --- High-level 0x trade and progress types ---
+
+export type ZeroXTradeAssetProgressStatus =
+  | 'fetching_quote'
+  | 'signing'
+  | 'submitted'
+  | 'confirming'
+  | 'confirmed'
+  | 'failed'
+
+export interface ZeroXTradeAssetProgressData {
+  errorMessage?: string
+  buyAmount?: string
+  sellAmount?: string
+  transaction?: unknown
+  txHash?: string
+}
+
+export interface ZeroXTradeAssetParams extends Omit<ZeroExQuoteRequest, 'txOrigin'> {
+  fromAddress: string
+  onProgress?: (
+    status: ZeroXTradeAssetProgressStatus,
+    data?: ZeroXTradeAssetProgressData,
+  ) => void
+  zeroXApiKey?: string
+}
+
+/**
+ * **Signer:** per-call → instance (Portal wires default).
+ * **Confirmation:** per-call → instance, or `evmRequestFn` + receipt poll (eip155 only) on Web.
+ *
+ * @remarks
+ * When `waitForConfirmation` is omitted on EVM, the browser package can still confirm via
+ * `eth_getTransactionReceipt` polling by supplying `evmRequestFn` as the JSON-RPC transport.
+ */
+export interface ZeroXTradeAssetOptions {
+  signAndSendTransaction?: (
+    transaction: unknown,
+    network: string,
+  ) => Promise<string>
+  waitForConfirmation?: (
+    txHash: string,
+    network: string,
+  ) => Promise<void | boolean>
+  /**
+   * When `waitForConfirmation` is not set, the built-in EVM receipt poller uses this JSON-RPC
+   * function. Pass `waitForConfirmation` when you need custom confirmation semantics.
+   */
+  evmRequestFn?: (
+    method: string,
+    params: unknown[],
+    network: string,
+  ) => Promise<unknown>
+  /** Tuning for the built-in EVM receipt poller when using `evmRequestFn`. */
+  evmPollerOptions?: {
+    pollIntervalMs?: number
+    timeoutMs?: number
+  }
+}
+
+export interface ZeroXTradeAssetResult {
+  hashes: string[]
+}

package/types.d.ts

@@ -267,6 +267,12 @@ export interface PortalOptions {
   // Required options
   rpcConfig: RpcConfig
 
+  /**
+   * Optional RPC map for iframe-proxied reads only (receipt / Solana polling). Parent signing still
+   * uses `rpcConfig`. Omit in production when iframe and gateway CORS already align.
+   */
+  iframeRpcConfig?: RpcConfig
+
   // Optional options
   apiKey?: string
   authToken?: string