@global-torque/domain-types 0.2.2

package/src/profileTypes.ts

@@ -0,0 +1,9 @@
+export const PROFILE_TYPES = {
+  INDIVIDUAL: 'individual',
+  ENTITY: 'entity',
+  TRUST: 'trust',
+  SDIRA: 'sdira',
+  SOLO401K: 'solo401k',
+} as const;
+
+export type ProfileType = typeof PROFILE_TYPES[keyof typeof PROFILE_TYPES];

package/src/profilesTypes.ts

@@ -0,0 +1,344 @@
+import type { AccreditationTypes, IAccreditationData } from './accreditationTypes.ts';
+import type { IKycData, InvestKycTypes } from './kycTypes.ts';
+
+export interface IEmployment {
+  type: string;
+  employer_name?: string;
+  role?: string;
+  address1?: string;
+  address2?: string;
+  city?: string;
+  postal_code?: string;
+}
+
+export interface IFinra {
+  member_association: boolean;
+  correspondence: boolean;
+  member_firm_name: string;
+  compliance_contact_name: string;
+  compliance_contant_email: string;
+}
+
+export interface ITenPercentShareholder {
+  shareholder_association: boolean;
+  ticker_symbol_list: string;
+}
+
+export interface IBeneficiary {
+  first_name: string;
+  last_name: string;
+  relationship_type: string;
+  phone: string;
+  email: string;
+  dob: string;
+}
+
+export interface IInvestmentObjectives {
+  objectives: string;
+  years_experience: number;
+  duration: string;
+  importance_of_access: string;
+  risk_comfort: string;
+}
+
+export interface IAccreditedInvestor {
+  is_accredited: boolean;
+}
+
+export interface IRegCF {
+  limitation_rule: boolean;
+  limitation_rule_confirmation: boolean;
+  annual_income: number;
+  net_worth: number;
+  invested_external: number;
+}
+
+export interface IOwnership {
+  first_name: string;
+  last_name: string;
+  middle_name: string;
+  dob: string;
+  phone: string;
+  ssn: string;
+  address1: string;
+  address2: string;
+  city: string;
+  state: string;
+  zip_code: string;
+  country: string;
+  citizenship: string;
+  nc_account_nickname?: string;
+  nc_account_bank_name?: string;
+}
+
+export interface IBusinessController {
+  first_name: string;
+  last_name: string;
+  address1: string;
+  address2: string;
+  city: string;
+  state: string;
+  zip_code: string;
+  country: string;
+  phone: string;
+  email: string;
+  dob: string;
+}
+
+export interface ITypeOfId {
+  type: string;
+  number: string;
+}
+
+export interface IFormPartialBeneficialOwnershipItem {
+  first_name: string;
+  last_name: string;
+  dob: string;
+  address1: string;
+  address2?: string;
+  city: string;
+  state: string;
+  zip_code: string;
+  country: string;
+  phone: string;
+  email: string;
+  non_us: string;
+  ssn?: string;
+  type_of_identification?: {
+    id_number: string;
+    country: string;
+  };
+}
+
+export interface IFormPartialBeneficialOwnershipItemFormatted extends IFormPartialBeneficialOwnershipItem {
+  phoneFormatted?: string;
+}
+
+export interface IUserDataIndividual {
+  first_name?: string;
+  last_name?: string;
+  middle_name?: string;
+  dob?: string;
+  phone?: string;
+  email?: string;
+  ssn?: string;
+  address1?: string;
+  address2?: string;
+  type?: string;
+  city?: string;
+  state?: string;
+  zip_code?: string;
+  country?: string;
+  citizenship?: string;
+  nc_party_id?: string;
+  nc_link_id?: string;
+  employment: IEmployment;
+  ip_address: string;
+  beneficiary: IBeneficiary;
+  risk_involved?: boolean;
+  finra_affiliated: IFinra;
+  accredited_investor: IAccreditedInvestor;
+  resell_difficulties?: boolean;
+  cancelation_restrictions?: boolean;
+  educational_materials?: boolean;
+  investment_objectives: IInvestmentObjectives;
+  irs_backup_withholding?: boolean;
+  ten_percent_shareholder?: ITenPercentShareholder;
+  no_legal_advices_from_company?: boolean;
+  /** Answers to fund-defined custom onboarding questions, keyed by label-derived slug. */
+  custom_fields?: Record<string, string | number | boolean>;
+  name?: string;
+  owner_title?: string;
+  tax_exempts?: string;
+  solely_for_investing?: string;
+  business_controller?: IBusinessController;
+  type_of_identification?: ITypeOfId;
+  account_number?: string;
+  full_account_name?: string;
+  ein?: string;
+  is_full_ssn_provided: boolean;
+  beneficials?: IFormPartialBeneficialOwnershipItem[];
+  formattedBeneficials?: IFormPartialBeneficialOwnershipItemFormatted[];
+}
+
+export interface IProfileIndividual {
+  id: number;
+  escrow_id?: string;
+  type: string;
+  data: IUserDataIndividual;
+  kyc_id: number;
+  kyc_status?: InvestKycTypes;
+  kyc_data?: IKycData[];
+  accreditation_id: number;
+  accreditation_status?: AccreditationTypes;
+  accreditation_data?: IAccreditationData[];
+  kyc_at: string;
+  accreditation_at: string;
+  wallet: IWallet;
+  total_distributions?: number;
+  total_investments_12_months?: number;
+  total_investments?: number;
+  avarange_annual: number;
+  total_investments_change_percent: number;
+  total_distributions_change_percent: number;
+  user_id?: number;
+}
+
+export interface IProfileData {
+  id?: number;
+  profile_id?: number;
+  user_id?: number;
+  escrow_id?: string;
+  profile_type?: string;
+  first_name?: string;
+  last_name?: string;
+  middle_name?: string;
+  dob?: string;
+  phone?: string;
+  ssn?: string;
+  address1?: string;
+  address2?: string;
+  city?: string;
+  state?: string;
+  zip_code?: string;
+  country?: string;
+  citizenship?: string;
+  nc_party_id?: string;
+  nc_account_nickname?: string;
+  nc_account_bank_name?: string;
+  employment?: IEmployment;
+  finra_affiliated?: IFinra;
+  ten_percent_shareholder?: ITenPercentShareholder;
+  beneficiary?: IBeneficiary;
+  investment_objectives?: IInvestmentObjectives;
+  accredited_investor?: IAccreditedInvestor;
+  reg_cf?: IRegCF;
+  irs_backup_withholding?: boolean;
+  educational_materials?: boolean;
+  cancelation_restrictions?: boolean;
+  resell_difficulties?: boolean;
+  risk_involved?: boolean;
+  no_legal_advices_from_company?: boolean;
+  /** Answers to fund-defined custom onboarding questions, keyed by label-derived slug. */
+  custom_fields?: Record<string, string | number | boolean>;
+  total_distributions?: number;
+  total_investments_12_months?: number;
+  total_investments?: number;
+  kyc_status?: InvestKycTypes;
+  kyc_data?: IKycData[];
+  accreditation_status?: AccreditationTypes;
+  accreditation_data?: IAccreditationData[];
+  wallet_id?: number;
+}
+
+export interface IProfile {
+  accreditation_status: AccreditationTypes;
+  accreditation_data: IAccreditationData[];
+  accreditation_id: string;
+  id: number;
+  user_id: number;
+  escrow_id: string;
+  kyc_at: string;
+  accreditation_at: string;
+  created_at: string;
+  updated_at: string;
+  kyc_status: InvestKycTypes;
+  kyc_id: string;
+  kyc_data: IKycData[];
+  type: string;
+  data: IOwnership;
+  total_investments: number;
+  total_investments_12_months: number;
+  total_distributions: number;
+  avarange_annual: number;
+  wallet_id: number;
+}
+
+export interface IUser {
+  id: number;
+  first_name: string;
+  last_name: string;
+  phone: string;
+  created_at: string;
+  updated_at: string;
+  image_link_id: string;
+  profiles: IProfileFormatted[];
+}
+
+export interface IUserFormatted extends IUser {
+  fullName: string;
+  createdAtFormattedShortMonth: string;
+  phoneFormatted?: string;
+}
+
+export interface IProfileList {
+  id: number;
+  label: string;
+  value: string;
+  action?: IProfileListAction;
+}
+
+export interface IProfileListAction {
+  type: string;
+  url: string;
+}
+
+export interface ISchema {
+  $schema: string;
+  definitions: {
+    Individual?: {
+      properties: Record<string, any>;
+      type: string;
+      required?: string[];
+    };
+    RegCF?: {
+      properties: Record<string, any>;
+      type: string;
+      required?: string[];
+    };
+  };
+  $ref: string;
+}
+
+export interface IWallet {
+  id: number;
+  status: string;
+}
+
+export interface IBackgroundInfo {
+  reg_cf?: {
+    net_worth: number;
+    annual_income: number;
+    limitation_rule: boolean;
+    invested_external: number;
+    limitation_rule_confirmation: boolean;
+  };
+  accredited_investor?: {
+    explanation: string;
+    is_accredited: boolean;
+  };
+}
+
+export interface IProfileFormatted extends IProfileIndividual {
+  isTypeIndividual: boolean;
+  isTypeEntity: boolean;
+  isTypeTrust: boolean;
+  isTypeSdira: boolean;
+  isTypeSolo401k: boolean;
+  isKycApproved: boolean;
+  isKycInProgress: boolean;
+  isKycPending: boolean;
+  isKycDeclined: boolean;
+  isKycNew: boolean;
+  isKycNone: boolean;
+  isAccreditationApproved: boolean;
+  isAccreditationInProgress: boolean;
+  isAccreditationPending: boolean;
+  isAccreditationDeclined: boolean;
+  isAccreditationNew: boolean;
+  isAccreditationInfoRequired: boolean;
+  isAccreditationExpired: boolean;
+  isCanCallKycPlaid: boolean;
+  hasBeneficials: boolean;
+  beneficialsCount: number;
+}

package/src/settingsTypes.ts

@@ -0,0 +1,20 @@
+import type { ISession } from './authTypes.ts';
+
+export type { IAuthFlow, ILogoutFlow, ISession } from './authTypes.ts';
+
+export interface IActivityRow {
+  date: string;
+  time: string;
+  ip: string;
+  browser: string;
+  id: string;
+  current?: boolean;
+}
+
+export type ISessionDevice = ISession['devices'][number];
+
+export interface ISessionFormatted extends ISession {
+  authenticatedAtDate: string;
+  authenticatedAtTime: string;
+  devicesFormatted: IActivityRow[];
+}

package/src/vaultTypes.ts

@@ -0,0 +1,250 @@
+export const VaultProtocolStates = {
+  unconfirmed: 'unconfirmed',
+  pending: 'pending',
+  claimable: 'claimable',
+  claimed: 'claimed',
+} as const;
+
+export type VaultProtocolState =
+  typeof VaultProtocolStates[keyof typeof VaultProtocolStates];
+
+export const VaultOperationStatuses = {
+  created: 'created',
+  submitted: 'submitted',
+  confirmed: 'confirmed',
+  failed: 'failed',
+} as const;
+
+export type VaultOperationStatus =
+  typeof VaultOperationStatuses[keyof typeof VaultOperationStatuses];
+
+export type VaultOperationStage =
+  | 'awaiting_signature'
+  | 'signing_or_submitting'
+  | 'detected_provisional'
+  | 'expired'
+  | 'rejected'
+  | 'abandoned'
+  | VaultOperationStatus;
+
+export interface VaultOperationFinality {
+  block_number: number | string;
+  block_hash: string;
+  confirmation_count: number;
+  confirmation_target: number;
+  finalized: boolean;
+}
+
+export interface VaultLifecycleOperation {
+  id: number;
+  status: VaultOperationStatus;
+  stage?: VaultOperationStage;
+  failure_reason?: string;
+  amount_raw?: string;
+  tx_hash?: string;
+  transaction_to_address?: string;
+  call_target_address?: string;
+  selector?: string;
+  can_abandon?: boolean;
+  finality?: VaultOperationFinality;
+}
+
+export interface VaultSigningPayload {
+  reused: boolean;
+  operation_id: number;
+  stage: VaultOperationStage;
+  chain: string;
+  from_address: string;
+  transaction_to_address: string;
+  transaction_call_data: string;
+  call_target_address: string;
+  contract_function_selector: string;
+  call_data: string;
+  logical_call_data: string;
+  amount_raw: string;
+  confirmation_target: number;
+}
+
+export interface VaultAssetIdentity {
+  symbol: string;
+  address: string;
+  decimals: number;
+}
+
+export interface VaultDeployment {
+  contract_id: number;
+  status: string;
+  chain: string;
+  address: string;
+  asset: VaultAssetIdentity;
+  share: VaultAssetIdentity;
+}
+
+export interface VaultRedemptionEstimate {
+  nav_record_id: number;
+  nav_version: number;
+  nav_usdc_raw: string;
+  valuation_block_number: string;
+  valuation_as_of: string;
+  asset_amount_raw: string;
+}
+
+export interface VaultRedemptionFinal {
+  asset_amount_raw: string;
+  pricing_source?: string | null;
+  dealing_price_usdc_raw?: string | null;
+  priced_by_user_id?: number | null;
+  priced_request_effect_id?: number | null;
+  priced_at?: string | null;
+  nav_record_id?: number | null;
+  nav_version?: number | null;
+  nav_usdc_raw?: string | null;
+  valuation_block_number?: string | null;
+  valuation_as_of?: string | null;
+  delta_from_estimate_raw: string | null;
+}
+
+export type VaultClaimDirection = 'deposit' | 'redemption';
+export interface VaultRedemption {
+  id: number;
+  offer_id?: number;
+  profile_id?: number;
+  investment_id?: number | null;
+  vault_contract_id?: number;
+  request_origin: 'application' | 'chain';
+  request_effect_id: number | null;
+  request_effect_state?: 'assigned' | 'unassigned';
+  status?: string;
+  pricing_status: 'awaiting_dealing_nav' | 'priced';
+  protocol_state: VaultProtocolState;
+  share_amount_raw: string;
+  pending_shares_raw: string;
+  claimable_shares_raw: string;
+  claimable_assets_raw: string;
+  claimed_shares_raw: string;
+  claimed_assets_raw: string;
+  liquidity_shortfall_raw?: string;
+  request_locked_at?: string | null;
+  estimate: VaultRedemptionEstimate | null;
+  dealing_cutoff: {
+    block_number: string;
+    at: string;
+  } | null;
+  final: VaultRedemptionFinal | null;
+  operations: {
+    request: VaultLifecycleOperation | null;
+    fulfillment: VaultLifecycleOperation | null;
+    claim: VaultLifecycleOperation | null;
+  };
+}
+
+export interface VaultPosition {
+  offer_id: number;
+  profile_id: number;
+  vault: {
+    deployment: VaultDeployment;
+    deposit: {
+      investment_id: number;
+      protocol_state: VaultProtocolState;
+      request_origin: 'application' | 'chain';
+      request_effect_id: number | null;
+      request_effect_state?: 'assigned' | 'unassigned';
+      request_controller: {
+        chain_account_id: number;
+        address: string;
+      };
+      price_source: string | null;
+      price_usdc_raw: string;
+      nav_record_id: number | null;
+      nav_version: number | null;
+      priced_at: string | null;
+      custody: {
+        state: 'unfunded' | 'funding' | 'funded' | 'held' | 'refunding' | 'refund_locked' | 'released' | 'refunded';
+        wallet_address: string | null;
+        funded_at: string | null;
+        refund_locked_at: string | null;
+        released_at: string | null;
+        refunded_at: string | null;
+      };
+      request_locked_at: string | null;
+      asset_amount_raw: string;
+      share_amount_raw: string;
+      pending_assets_raw: string;
+      claimable_assets_raw: string;
+      claimable_shares_raw: string;
+      claimed_assets_raw: string;
+      claimed_shares_raw: string;
+      controller_aggregate?: {
+        pending_assets_raw: string;
+        claimable_assets_raw: string;
+        unassigned_pending_assets_raw: string;
+        unassigned_claimable_assets_raw: string;
+      };
+      operations: Record<string, VaultLifecycleOperation | null>;
+    } | null;
+    position: {
+      share_balance_raw: string;
+      historical_claimed_shares_raw: string;
+      available_to_redeem_shares_raw: string;
+    };
+    redemptions: VaultRedemption[];
+  };
+}
+
+export interface CreateVaultRedemptionRequest {
+  offer_id: number;
+  shares_raw: string;
+}
+
+export interface ArmVaultOperationRequest {
+  operation_id: number;
+}
+
+export interface VaultLifecycleStatus {
+  business_id?: number;
+  action: string;
+  vault_contract_id?: number;
+  profile_id?: number;
+  direction?: 'deposit' | 'redemption';
+  vault_request_origin?: string;
+  can_fund?: boolean;
+  can_request?: boolean;
+  funding_blocking_reason?: string | null;
+  protocol_state?: VaultProtocolState;
+  asset_amount_raw?: string;
+  share_amount_raw?: string;
+  pending_assets_raw?: string;
+  pending_shares_raw?: string;
+  claimable_assets_raw?: string;
+  claimable_shares_raw?: string;
+  custody_address?: string;
+  custody_funded_at?: string | null;
+  custody_refund_locked_at?: string | null;
+  custody_released_at?: string | null;
+  custody_refunded_at?: string | null;
+  request_locked_at?: string | null;
+  requested_at?: string | null;
+  request_effect_id?: number | null;
+  operation: VaultLifecycleOperation | null;
+  reconciliation?: {
+    vault_contract_id: number;
+    chain: string;
+    vault_address: string;
+    request_controller_address: string;
+    direction: 'deposit' | 'redemption';
+    observed_block: number;
+    observed_block_hash: string;
+    share_balance_raw: string;
+    pending_raw: string;
+    claimable_raw: string;
+    assigned_pending_raw: string;
+    assigned_claimable_raw: string;
+    unassigned_pending_raw: string;
+    unassigned_claimable_raw: string;
+    unassigned_effect_ids: number[];
+  };
+}
+
+export interface VaultCustodyFundingRequest {
+  idempotency_key: string;
+}