@portal-hq/web 3.12.0 → 3.13.0-alpha.0

package/src/integrations/ramps/noah/index.ts

@@ -0,0 +1,89 @@
+import Mpc from '../../../mpc'
+import type {
+  NoahGetPayoutChannelsRequest,
+  NoahGetPayoutChannelsResponse,
+  NoahGetPayoutChannelFormResponse,
+  NoahGetPayoutCountriesResponse,
+  NoahGetPaymentMethodsResponse,
+  NoahGetPayoutQuoteRequest,
+  NoahGetPayoutQuoteResponse,
+  NoahInitiateKycRequest,
+  NoahInitiateKycResponse,
+  NoahInitiatePayinRequest,
+  NoahInitiatePayinResponse,
+  NoahInitiatePayoutRequest,
+  NoahInitiatePayoutResponse,
+  NoahSimulatePayinRequest,
+  NoahSimulatePayinResponse,
+} from '../../../shared/types'
+
+/**
+ * Noah fiat on/off-ramp API on `portal.ramps.noah`.
+ * Each method forwards to the embedded Portal iframe, which calls connect-api.
+ */
+export default class Noah {
+  private mpc: Mpc
+
+  constructor({ mpc }: { mpc: Mpc }) {
+    this.mpc = mpc
+  }
+
+  /** Start hosted KYC; response includes `hostedUrl` to open in a browser tab. */
+  public async initiateKyc(
+    data: NoahInitiateKycRequest,
+  ): Promise<NoahInitiateKycResponse> {
+    return this.mpc.initiateKyc(data)
+  }
+
+  /** Create a pay-in (fiat → crypto) with bank transfer instructions. */
+  public async initiatePayin(
+    data: NoahInitiatePayinRequest,
+  ): Promise<NoahInitiatePayinResponse> {
+    return this.mpc.initiatePayin(data)
+  }
+
+  /** Dry-run pay-in pricing / eligibility for a payment method and fiat amount. */
+  public async simulatePayin(
+    data: NoahSimulatePayinRequest,
+  ): Promise<NoahSimulatePayinResponse> {
+    return this.mpc.simulatePayin(data)
+  }
+
+  /** Countries supported for fiat payouts. */
+  public async getPayoutCountries(): Promise<NoahGetPayoutCountriesResponse> {
+    return this.mpc.getPayoutCountries()
+  }
+
+  /** Available payout rails for a country / currency pair. */
+  public async getPayoutChannels(
+    data: NoahGetPayoutChannelsRequest,
+  ): Promise<NoahGetPayoutChannelsResponse> {
+    return this.mpc.getPayoutChannels(data)
+  }
+
+  /** Dynamic form schema for a payout channel (recipient fields). */
+  public async getPayoutChannelForm(
+    channelId: string,
+  ): Promise<NoahGetPayoutChannelFormResponse> {
+    return this.mpc.getPayoutChannelForm(channelId)
+  }
+
+  /** Quote fees and crypto amount for a payout channel and form payload. */
+  public async getPayoutQuote(
+    data: NoahGetPayoutQuoteRequest,
+  ): Promise<NoahGetPayoutQuoteResponse> {
+    return this.mpc.getPayoutQuote(data)
+  }
+
+  /** Start payout execution; may return on-chain deposit `conditions` for crypto legs. */
+  public async initiatePayout(
+    data: NoahInitiatePayoutRequest,
+  ): Promise<NoahInitiatePayoutResponse> {
+    return this.mpc.initiatePayout(data)
+  }
+
+  /** Pay-in payment methods available to the customer. */
+  public async getPaymentMethods(): Promise<NoahGetPaymentMethodsResponse> {
+    return this.mpc.getPaymentMethods()
+  }
+}

package/src/mpc/index.ts

@@ -65,6 +65,21 @@ import {
   LifiStatusResponse,
   LifiStepTransactionRequest,
   LifiStepTransactionResponse,
+  NoahGetPayoutChannelsRequest,
+  NoahGetPayoutChannelsResponse,
+  NoahGetPayoutChannelFormResponse,
+  NoahGetPayoutCountriesResponse,
+  NoahGetPaymentMethodsResponse,
+  NoahGetPayoutQuoteRequest,
+  NoahGetPayoutQuoteResponse,
+  NoahInitiateKycRequest,
+  NoahInitiateKycResponse,
+  NoahInitiatePayinRequest,
+  NoahInitiatePayinResponse,
+  NoahInitiatePayoutRequest,
+  NoahInitiatePayoutResponse,
+  NoahSimulatePayinRequest,
+  NoahSimulatePayinResponse,
   ZeroExOptions,
   ZeroExPriceRequest,
   ZeroExPriceResponse,
@@ -110,7 +125,7 @@ import {
 } from '../../hypernative'
 import { generateTraceId } from '../shared/trace'
 
-const WEB_SDK_VERSION = '3.12.0'
+const WEB_SDK_VERSION = '3.13.0-alpha.0'
 
 class Mpc {
   public iframe?: HTMLIFrameElement
@@ -669,6 +684,105 @@ class Mpc {
     })
   }
 
+  /**
+   * Noah ramp: postMessage bridge to the Portal iframe (connect-api).
+   * Application code should call `portal.ramps.noah` instead of Mpc directly.
+   */
+  public async initiateKyc(
+    data: NoahInitiateKycRequest,
+  ): Promise<NoahInitiateKycResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:noah:initiateKyc',
+      errorMessage: 'portal:noah:initiateKycError',
+      resultMessage: 'portal:noah:initiateKycResult',
+      data,
+    })
+  }
+
+  public async initiatePayin(
+    data: NoahInitiatePayinRequest,
+  ): Promise<NoahInitiatePayinResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:noah:initiatePayin',
+      errorMessage: 'portal:noah:initiatePayinError',
+      resultMessage: 'portal:noah:initiatePayinResult',
+      data,
+    })
+  }
+
+  public async simulatePayin(
+    data: NoahSimulatePayinRequest,
+  ): Promise<NoahSimulatePayinResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:noah:simulatePayin',
+      errorMessage: 'portal:noah:simulatePayinError',
+      resultMessage: 'portal:noah:simulatePayinResult',
+      data,
+    })
+  }
+
+  public async getPayoutCountries(): Promise<NoahGetPayoutCountriesResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:noah:getPayoutCountries',
+      errorMessage: 'portal:noah:getPayoutCountriesError',
+      resultMessage: 'portal:noah:getPayoutCountriesResult',
+      data: {},
+    })
+  }
+
+  public async getPayoutChannels(
+    data: NoahGetPayoutChannelsRequest,
+  ): Promise<NoahGetPayoutChannelsResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:noah:getPayoutChannels',
+      errorMessage: 'portal:noah:getPayoutChannelsError',
+      resultMessage: 'portal:noah:getPayoutChannelsResult',
+      data,
+    })
+  }
+
+  public async getPayoutChannelForm(
+    channelId: string,
+  ): Promise<NoahGetPayoutChannelFormResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:noah:getPayoutChannelForm',
+      errorMessage: 'portal:noah:getPayoutChannelFormError',
+      resultMessage: 'portal:noah:getPayoutChannelFormResult',
+      data: channelId,
+    })
+  }
+
+  public async getPayoutQuote(
+    data: NoahGetPayoutQuoteRequest,
+  ): Promise<NoahGetPayoutQuoteResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:noah:getPayoutQuote',
+      errorMessage: 'portal:noah:getPayoutQuoteError',
+      resultMessage: 'portal:noah:getPayoutQuoteResult',
+      data,
+    })
+  }
+
+  public async initiatePayout(
+    data: NoahInitiatePayoutRequest,
+  ): Promise<NoahInitiatePayoutResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:noah:initiatePayout',
+      errorMessage: 'portal:noah:initiatePayoutError',
+      resultMessage: 'portal:noah:initiatePayoutResult',
+      data,
+    })
+  }
+
+  public async getPaymentMethods(): Promise<NoahGetPaymentMethodsResponse> {
+    return this.handleRequestToIframeAndPost({
+      methodMessage: 'portal:noah:getPaymentMethods',
+      errorMessage: 'portal:noah:getPaymentMethodsError',
+      resultMessage: 'portal:noah:getPaymentMethodsResult',
+      data: {},
+    })
+  }
+
   public async getSwapsQuoteV2(
     data: ZeroExQuoteRequest,
     options?: ZeroExOptions,

package/src/shared/types/index.ts

@@ -16,6 +16,7 @@ export * from './api'
 export * from './yieldxyz'
 export * from './zero-x'
 export * from './lifi'
+export * from './noah'
 export * from './hypernative'
 export * from './blockaid'
 

package/src/shared/types/noah.ts

@@ -0,0 +1,150 @@
+export interface PortalApiSuccessEnvelope<T> {
+  data: T
+  metadata?: Record<string, unknown>
+}
+
+export interface NoahInitiateKycRequest {
+  returnUrl: string
+  fiatOptions?: { fiatCurrencyCode: string }[]
+  customerType?: 'Individual' | 'Business'
+  metadata?: Record<string, unknown>
+  form?: Record<string, unknown>
+}
+
+export interface NoahInitiateKycResponseData {
+  hostedUrl: string
+}
+
+export type NoahInitiateKycResponse =
+  PortalApiSuccessEnvelope<NoahInitiateKycResponseData>
+
+export interface NoahInitiatePayinRequest {
+  fiatCurrency: string
+  cryptoCurrency: string
+  network: string
+  destinationAddress: string
+}
+
+export interface NoahInitiatePayinResponseData {
+  payinId: string
+  bankDetails: Record<string, unknown>
+}
+
+export type NoahInitiatePayinResponse =
+  PortalApiSuccessEnvelope<NoahInitiatePayinResponseData>
+
+export interface NoahSimulatePayinRequest {
+  paymentMethodId: string
+  fiatAmount: string
+  fiatCurrency: string
+}
+
+export type NoahSimulatePayinResponseData = Record<string, unknown>
+
+export type NoahSimulatePayinResponse =
+  PortalApiSuccessEnvelope<NoahSimulatePayinResponseData>
+
+export interface NoahGetPayoutCountriesResponseData {
+  countries: unknown
+}
+
+export type NoahGetPayoutCountriesResponse =
+  PortalApiSuccessEnvelope<NoahGetPayoutCountriesResponseData>
+
+export interface NoahGetPayoutChannelsRequest {
+  country: string
+  cryptoCurrency: string
+  fiatCurrency: string
+  fiatAmount?: string
+}
+
+/** GET …/payouts/channels — body shape is provider-specific (array or object). */
+export type NoahGetPayoutChannelsResponseData = unknown
+
+export type NoahGetPayoutChannelsResponse =
+  PortalApiSuccessEnvelope<NoahGetPayoutChannelsResponseData>
+
+export type NoahGetPayoutChannelFormResponseData = unknown
+
+export type NoahGetPayoutChannelFormResponse =
+  PortalApiSuccessEnvelope<NoahGetPayoutChannelFormResponseData>
+
+export interface NoahGetPayoutQuoteRequest {
+  channelId: string
+  cryptoCurrency: string
+  fiatAmount: string
+  form?: Record<string, unknown>
+  fiatCurrency?: string
+  paymentMethodId?: string
+}
+
+export interface NoahGetPayoutQuoteResponseData {
+  payoutId: string
+  formSessionId: string
+  cryptoAmountEstimate: string
+  totalFee: string
+  nextStep?: unknown
+}
+
+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
+}
+
+/** One condition block: amount rules + network (Noah payout deposit shape). */
+export interface NoahPayoutConditionBlock {
+  AmountConditions?: NoahAmountConditionRow[]
+  amountConditions?: NoahAmountConditionRow[]
+  Network?: string
+  network?: string
+}
+
+/** Supported Solana CAIP-2 IDs for payout deposit flows. */
+export type NoahSolanaCaipId =
+  | 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1'
+  | 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp'
+
+export interface NoahSingleOnchainDepositSourceTriggerInput {
+  Type: 'SingleOnchainDepositSourceTriggerInput'
+  Conditions: {
+    AmountConditions: { ComparisonOperator: string; Value: string }[]
+    Network: string
+  }[]
+  SourceAddress: string
+  Expiry: string
+  Nonce: string
+}
+
+export interface NoahInitiatePayoutRequest {
+  payoutId: string
+  sourceAddress: string
+  expiry: string
+  nonce: string
+  network: string
+  trigger?: NoahSingleOnchainDepositSourceTriggerInput
+}
+
+export interface NoahInitiatePayoutResponseData {
+  destinationAddress: string | null
+  conditions: unknown
+}
+
+export type NoahInitiatePayoutResponse =
+  PortalApiSuccessEnvelope<NoahInitiatePayoutResponseData>
+
+export interface NoahGetPaymentMethodsResponseData {
+  paymentMethods: unknown
+  pageToken?: unknown
+}
+
+export type NoahGetPaymentMethodsResponse =
+  PortalApiSuccessEnvelope<NoahGetPaymentMethodsResponseData>

package/tsconfig.json

@@ -23,6 +23,7 @@
     "types.d.ts",
     "yieldxyz-types.d.ts",
     "lifi-types.d.ts",
+    "noah-types.d.ts",
     "hypernative.d.ts",
     "zero-x.d.ts"
   ],