@heliofi/common-fe 0.2.295 → 0.2.296

package/dist/index.d.ts

@@ -11,6 +11,13 @@ declare enum BlockchainSymbol {
   DOGE = "DOGE",
   TON = "TON",
 }
+declare enum DepositBlockchainSymbol {
+  ABSTRACT = "ABSTRACT",
+  HYPERLIQUID = "HYPERLIQUID",
+  HYPERCORE = "HYPERCORE",
+  PLASMA = "PLASMA",
+  MEGAETH = "MEGAETH",
+}
 //#endregion
 //#region ../common/src/domain/model/blockchainEngine/constants/BlockchainEngineType.d.ts
 declare enum BlockchainEngineType {
@@ -85,4 +92,331 @@ declare enum ThemeMode {
   DARK = "DARK",
 }
 //#endregion
-export { BlockchainEngineType, BlockchainSymbol, BroadcastAck, GeneralNetwork, Platform, SignedTransactionKind, TextColor, ThemeMode, ThemeType, WithdrawalFeature, WithdrawalState };
+//#region ../common/src/domain/model/entity/Entity.d.ts
+declare class Entity {
+  static fromObject<T extends Entity>(record: T): T;
+  static fromObjects<T extends Entity>(records: T[]): T[];
+}
+//#endregion
+//#region ../common/src/domain/model/blockchainEngine/entities/BlockchainEngine.entity.d.ts
+declare class BlockchainEngine extends Entity {
+  id: string;
+  type: BlockchainEngineType;
+  addressRegex?: string;
+}
+//#endregion
+//#region ../common/src/domain/model/blockchain/entities/BaseBlockchain.entity.d.ts
+declare class BaseBlockchain extends Entity {
+  id: string;
+  name: string;
+  displayName: string;
+  symbol: BlockchainSymbol;
+  iconUrl?: string;
+  iconUrlFull?: string;
+}
+//#endregion
+//#region ../common/src/domain/model/blockchain/entities/Blockchain.entity.d.ts
+declare class Blockchain extends BaseBlockchain {
+  engine: BlockchainEngine;
+}
+//#endregion
+//#region ../common/src/domain/model/currency/entities/CurrencyType.d.ts
+declare enum CurrencyType {
+  FIAT = "FIAT",
+  DIGITAL = "DIGITAL",
+}
+//#endregion
+//#region ../common/src/domain/model/currency/entities/CurrencyFeature.d.ts
+declare enum CurrencyFeature {
+  PAYMENT_PRICING = "PAYMENT_PRICING",
+  PAYMENT_RECIPIENT = "PAYMENT_RECIPIENT",
+  SWAP = "SWAP",
+  DEPOSIT_MERCHANT_RECIPIENT = "DEPOSIT_MERCHANT_RECIPIENT",
+  DEPOSIT_CUSTOMER_CHECKOUT = "DEPOSIT_CUSTOMER_CHECKOUT",
+  DEPOSIT_PAYLINK_CUSTOMER_CHECKOUT = "DEPOSIT_PAYLINK_CUSTOMER_CHECKOUT",
+  WITHDRAWAL_SOURCE = "WITHDRAWAL_SOURCE",
+  WITHDRAWAL_DESTINATION = "WITHDRAWAL_DESTINATION",
+  USD_RATE = "USD_RATE",
+  STABLECOIN = "STABLECOIN",
+  USD_STABLE = "USD_STABLE",
+  NATIVE_TOKEN = "NATIVE_TOKEN",
+}
+//#endregion
+//#region ../common/src/domain/model/currency/entities/OrderingType.d.ts
+declare enum OrderingType {
+  ALPHABETICAL = "ALPHABETICAL",
+  NUMERIC = "NUMERIC",
+}
+//#endregion
+//#region ../common/src/domain/model/currency/entities/BaseCurrency.entity.d.ts
+declare class BaseCurrency extends Entity {
+  id: string;
+  symbol: string;
+  name: string;
+  mintAddress: string;
+  coinMarketCapId: number;
+  decimals: number;
+  minDecimals?: number;
+  symbolPrefix?: string;
+  order: number;
+  type?: CurrencyType;
+  features?: CurrencyFeature[];
+  iconUrl?: string;
+  iconUrlFull?: string;
+  orderingType?: OrderingType;
+  isNative?: boolean;
+}
+//#endregion
+//#region ../common/src/domain/model/currency/entities/SlimCurrencyWithBlockchain.entity.d.ts
+type SlimCurrencyWithBlockchain = Omit<BaseCurrency, 'order' | 'orderingType' | 'features' | 'minDecimals' | 'iconUrl'> & {
+  blockchain: BaseBlockchain;
+};
+//#endregion
+//#region ../common/src/domain/model/currency/entities/SlimCurrencyWithPopulatedBlockchain.entity.d.ts
+type SlimCurrencyWithPopulatedBlockchain = Omit<SlimCurrencyWithBlockchain, 'blockchain'> & {
+  blockchain: Blockchain;
+};
+//#endregion
+//#region ../common/src/domain/model/wallet-balance/entities/WalletCurrencyBalance.entity.d.ts
+declare class WalletCurrencyBalance {
+  currencyId: string;
+  symbol: string;
+  mintAddress: string;
+  balance: string | null;
+  uiBalance: string | null;
+  maxWithdrawableAmount: string | null;
+  uiMaxWithdrawableAmount: string | null;
+}
+//#endregion
+//#region ../common/src/domain/constants/fiatCurrencies.d.ts
+declare enum FIATCurrencies {
+  USD = "USD",
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/WithdrawalConfig.entity.d.ts
+declare class WithdrawalConfigEntity extends Entity {
+  id: string;
+  name: string;
+  platform: Platform;
+  disabled: boolean;
+  disabledAt: string | null;
+  disabledBlockchainSymbols: BlockchainSymbol[];
+  enabledFeatures: WithdrawalFeature[];
+  createdAt: string;
+  updatedAt: string;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/WithdrawalCurrenciesExchangeRate.entity.d.ts
+declare class WithdrawalCurrenciesExchangeRate extends Entity {
+  minimalUnitRate: bigint;
+  decimalRate: string;
+  fromCurrencyId: string;
+  toCurrencyId: string;
+  fromCurrencySymbol: string;
+  fromBlockchainSymbol: BlockchainSymbol;
+  toCurrencySymbol: FIATCurrencies;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/WithdrawalMinSupportedVersions.entity.d.ts
+declare enum WithdrawalPackage {
+  HELIOFI_WITHDRAW_CORE = "@heliofi/withdraw-core",
+  HELIOFI_WITHDRAW_REACT = "@heliofi/withdraw-react",
+}
+declare class WithdrawalMinSupportedVersions extends Entity {
+  packages: Partial<Record<WithdrawalPackage, string>>;
+}
+//#endregion
+//#region ../common/src/domain/model/feature-flags/entities/BetaFeature.entity.d.ts
+declare enum BetaFeature {
+  SWAP = "SWAP",
+  MOONPAY_HEADLESS_FRAMES = "MOONPAY_HEADLESS_FRAMES",
+  GLIDE_DEPOSITS = "GLIDE_DEPOSITS",
+  CHECKOUT_V2 = "checkout_v2",
+}
+//#endregion
+//#region ../common/src/domain/model/theme/entities/CustomTheme.entity.d.ts
+declare class CustomTheme extends Entity {
+  primaryColor: string;
+  neutralColor: string;
+  textColorOnButton: TextColor;
+  themeMode: ThemeMode;
+  backgroundColor?: string;
+}
+//#endregion
+//#region ../common/src/domain/model/company/entities/BaseCompany.entity.d.ts
+declare class BaseCompany extends Entity {
+  id: string;
+  name?: string;
+  email?: string;
+  logoUrl?: string;
+  defaultCheckoutImageUrl?: string;
+  websiteUrl?: string;
+  twitterUsername?: string;
+  discordUsername?: string;
+  address?: string;
+  phoneNumber?: string;
+  twitterConfirmed?: boolean;
+  escrowFunds?: boolean;
+  tradingViewDetails?: string;
+  kycVerified?: boolean;
+  kybVerified?: boolean;
+  isVerificationRequired: boolean;
+  moonpayApiKey?: string;
+  moonpayIsEnabled?: boolean;
+  onramperIsEnabled?: boolean;
+  ironIsEnabled?: boolean;
+  onrampDirectlyToMerchant?: boolean;
+  showWeb3Auth?: boolean;
+  customTheme?: CustomTheme;
+  defaultThemeId?: string;
+  allowDeposit?: boolean;
+  enabledRestrictedDepositEngines?: BlockchainEngineType[];
+  enabledBetaFeatures: BetaFeature[];
+  verifiedEntity?: {
+    entityName?: string;
+    country?: string;
+  };
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/PublicWithdrawalConfig.entity.d.ts
+declare class PublicWithdrawalConfigEntity extends WithdrawalConfigEntity {
+  fromCurrencies: SlimCurrencyWithPopulatedBlockchain[];
+  exchangeRates: WithdrawalCurrenciesExchangeRate[];
+  minSupportedVersions: WithdrawalMinSupportedVersions;
+  company: BaseCompany;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/WithdrawalCustomerSwapRoute.entity.d.ts
+declare class WithdrawalCustomerSwapRoute {
+  id: string;
+  fromCurrencyId: string;
+  toCurrency: SlimCurrencyWithPopulatedBlockchain;
+  available: boolean;
+  minimumAmountMinimalUnit: string | null;
+  minimumAmountUsd: string;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/WithdrawalCustomerSwapRoutesResponse.entity.d.ts
+declare class WithdrawalCustomerSwapRoutesResponse {
+  fromCurrencies: SlimCurrencyWithPopulatedBlockchain[];
+  routes: WithdrawalCustomerSwapRoute[];
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/WithdrawalBalancesResponse.entity.d.ts
+declare class WithdrawalBalancesResponse {
+  walletAddress: string;
+  balances: WalletCurrencyBalance[];
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/SubmitWithdrawal.entity.d.ts
+declare class SubmitWithdrawalEntity extends Entity {
+  withdrawalDetailId: string;
+  txHash: string | null;
+  state: WithdrawalState;
+  broadcastAck: BroadcastAck | null;
+}
+//#endregion
+//#region ../common/src/domain/model/currency/entities/Currency.entity.d.ts
+declare class Currency extends BaseCurrency {
+  blockchain: Blockchain;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/WithdrawalQuoteFee.entity.d.ts
+declare class WithdrawalQuoteFeeEntity extends Entity {
+  amount: string;
+  currency: Currency | null;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/dtos/preparedWithdrawalTypedDataDomain.dto.d.ts
+declare class PreparedWithdrawalTypedDataDomainDto {
+  name: string;
+  version: string;
+  chainId: number;
+  verifyingContract: string;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/dtos/preparedWithdrawalTypedDataField.dto.d.ts
+declare class PreparedWithdrawalTypedDataFieldDto {
+  name: string;
+  type: string;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/dtos/preparedWithdrawalTypedData.dto.d.ts
+declare class PreparedWithdrawalTypedDataDto {
+  domain: PreparedWithdrawalTypedDataDomainDto;
+  types: Record<string, PreparedWithdrawalTypedDataFieldDto[]>;
+  primaryType: string;
+  message: Record<string, unknown>;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/dtos/preparedTransaction.dto.d.ts
+type PreparedTransaction = PolymarketWalletPreparedTransaction | RawPreparedTransaction | UserOpPreparedTransaction | HypercorePreparedTransaction;
+interface PolymarketWalletPreparedTransaction {
+  kind: SignedTransactionKind.POLYMARKET_WALLET;
+  typedData: PreparedWithdrawalTypedDataDto;
+}
+interface RawPreparedTransaction {
+  kind: SignedTransactionKind.RAW;
+  chain: BlockchainSymbol | DepositBlockchainSymbol;
+  unsignedTx: string;
+}
+interface HypercorePreparedTransaction {
+  kind: SignedTransactionKind.HYPERCORE;
+  chain: BlockchainSymbol | DepositBlockchainSymbol;
+  typedData: PreparedWithdrawalTypedDataDto;
+}
+interface UserOpPreparedTransaction {
+  kind: SignedTransactionKind.USER_OP;
+  chain: BlockchainSymbol;
+  userOp: Record<string, unknown>;
+  entryPoint: string;
+  authorization?: {
+    chainId: string;
+    address: string;
+    nonce: string;
+  };
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/dtos/preparedWithdrawalSummary.dto.d.ts
+declare class PreparedWithdrawalSummaryDto {
+  sourceToken: string;
+  sourceAmount: string;
+  destinationToken: string;
+  destinationAmount: string;
+  destinationAmountMin: string;
+  destinationAmountUsd?: string;
+  destinationAmountMinUsd?: string;
+  maxSlippageBps: number;
+  estimatedPriceImpact?: number;
+  bridgeFee: WithdrawalQuoteFeeEntity;
+  applicationFee: WithdrawalQuoteFeeEntity;
+  protocolFee: WithdrawalQuoteFeeEntity;
+  totalFee: WithdrawalQuoteFeeEntity;
+  expiresAt: string;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/entities/PreparedWithdrawal.entity.d.ts
+declare class PreparedWithdrawalEntity extends Entity {
+  withdrawalDetailId: string;
+  token: string;
+  prepared: PreparedTransaction;
+  summary: PreparedWithdrawalSummaryDto;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/dtos/preparedWithdrawal.dto.d.ts
+declare class PreparedWithdrawalDto {
+  ownerAddress: string;
+  recipient: string;
+  amount: string;
+  toCurrencyId: string;
+  sourceCurrencyId: string;
+  customerId?: string;
+}
+//#endregion
+//#region ../common/src/domain/model/withdraw/dtos/submitWithdrawal.dto.d.ts
+declare class SubmitWithdrawalDto {
+  token: string;
+  signedTx: string;
+}
+//#endregion
+export { type BaseBlockchain, type Blockchain, type BlockchainEngine, BlockchainEngineType, BlockchainSymbol, BroadcastAck, GeneralNetwork, type HypercorePreparedTransaction, Platform, type PolymarketWalletPreparedTransaction, type PreparedTransaction, type PreparedWithdrawalDto, type PreparedWithdrawalEntity, type PreparedWithdrawalSummaryDto, type PreparedWithdrawalTypedDataDto, type PublicWithdrawalConfigEntity, type RawPreparedTransaction, SignedTransactionKind, type SlimCurrencyWithBlockchain, type SlimCurrencyWithPopulatedBlockchain, type SubmitWithdrawalDto, type SubmitWithdrawalEntity, TextColor, ThemeMode, ThemeType, type UserOpPreparedTransaction, type WalletCurrencyBalance, type WithdrawalBalancesResponse, type WithdrawalCurrenciesExchangeRate, type WithdrawalCustomerSwapRoute, type WithdrawalCustomerSwapRoutesResponse, WithdrawalFeature, type WithdrawalMinSupportedVersions, type WithdrawalQuoteFeeEntity, WithdrawalState };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heliofi/common-fe",
-  "version": "0.2.295",
+  "version": "0.2.296",
   "private": false,
   "description": "Zero-dependency, frontend-safe shared enums (and, later, DTO type shapes) for Helio consumers. No class-validator / reflect-metadata / heavy blockchain deps.",
   "license": "ISC",
@@ -29,5 +29,5 @@
   "peerDependencies": {
     "typescript": "5.*"
   },
-  "gitHead": "773ef14b626fded2f03b33ceb0fb6a18f20bdd1d"
+  "gitHead": "bb4e8d793bac780042bdb25a3f380635c981441c"
 }