@sabaaa1/common 0.0.1

package/src/types/hinkal.types.ts

@@ -0,0 +1,150 @@
+import { APPROVED_UTXO_CONVERSION_COUNT } from '../constants/conversion.constants';
+import { defaultFeeToken } from '../constants/fees.constants';
+import { zeroAddress } from '../constants/protocol.constants';
+import { UserKeys } from '../data-structures/crypto-keys/keys';
+
+/**
+ * Configuration options for the Hinkal system.
+ */
+export type HinkalConfig = {
+  /**
+   * Path to the cache file used for storing temporary data.
+   * It should be a valid file path string.
+   */
+  cacheFilePath?: string;
+  /**
+   * Indicator to use caching on a file level.
+   * Node only.
+   */
+  useFileCache?: boolean;
+  disableCaching?: boolean;
+  /**
+   * Indicator controlling wether the proof should be constructed remotely in secure enclave.
+   */
+  generateProofRemotely?: boolean;
+  disableMerkleTreeUpdates?: boolean;
+
+  serializedCache?: Record<string, string>;
+};
+
+export type ProverVersion = 'v1x0' | 'v1x1';
+
+export enum EventType {
+  BalanceChange = 'BalanceChange',
+  NetworkChange = 'NetworkChange',
+  KycNeeded = 'KycNeeded',
+  AccountChanged = 'AccountChanged',
+  ShowConnect = 'ShowConnect',
+  ShowNetworkPopup = 'ShowNetworkPopup',
+  MerkleTreeUpdated = 'MerkleTreeUpdated',
+  MerkleTreeResetStarted = 'MerkleTreeResetStarted',
+  MerkleTreeResetFinished = 'MerkleTreeResetFinished',
+}
+
+export enum IntegrationProvider {
+  UNISWAP = 1,
+  ODOS,
+  ONEINCH,
+  LIFI,
+  ALL,
+  NONE,
+}
+
+export enum HinkalStakeAction {
+  DepositOrStake,
+  Unstake,
+}
+
+export enum INTERACTION {
+  WITHDRAW = 'WITHDRAW',
+  SWAP = 'SWAP',
+  STAKING = 'STAKING',
+  UNSTAKING = 'UNSTAKING',
+  CLAIMING = 'CLAIMING',
+  EMPORIUM = 'EMPORIUM',
+  NONE = 'NONE',
+}
+
+export enum HinkalLogicAction {
+  NONE, // = 0
+  APPROVE, // = 1
+  RELEASE_BUFFER, // = 2
+  EXECUTE, // = 3
+}
+
+export interface UseApprovalUTXOData<T = bigint> {
+  approvalChanges: T[];
+  externalApprovalAddresses: string[];
+  conversionInHinkalAddress: T[];
+}
+
+export type ApprovedUtxo<T = bigint> = {
+  tokenAddress: string;
+  amount: T;
+  inHinkalAddress: T;
+};
+
+export type ApprovedUtxoWithInteractionAddress<T = bigint> = ApprovedUtxo<T> & {
+  interactionAddress: string;
+};
+
+export type HinkalLogicArgs<T = bigint> = {
+  hinkalLogicAction: HinkalLogicAction;
+  executeApprovalChanges: T[];
+  doPreTxApproval: boolean;
+  inHinkalAddress: T;
+  useApprovalUtxoData: UseApprovalUTXOData<T>[];
+  interactionAddress?: string;
+};
+
+export const defaultUseApprovalUTXOData = <T>(dimension: number, defaultValue: T) => ({
+  approvalChanges: Array.from<T>({ length: dimension }).fill(defaultValue),
+  externalApprovalAddresses: Array.from<string>({ length: dimension }).fill(zeroAddress),
+  conversionInHinkalAddress: Array.from<T>({ length: dimension }).fill(defaultValue),
+});
+
+export const defaultHinkalLogicArgs = (dimension: number, userKeys: UserKeys): HinkalLogicArgs => ({
+  hinkalLogicAction: HinkalLogicAction.NONE,
+  inHinkalAddress: userKeys.getInHinkalAddress(zeroAddress),
+  executeApprovalChanges: Array.from<bigint>({ length: dimension }).fill(0n),
+  doPreTxApproval: false,
+  useApprovalUtxoData: Array.from({ length: dimension }).map(() =>
+    defaultUseApprovalUTXOData(APPROVED_UTXO_CONVERSION_COUNT, 0n),
+  ),
+  interactionAddress: zeroAddress,
+});
+
+export type FeeStructure<T = bigint> = {
+  feeToken: string;
+  flatFee: T;
+  variableRate: T; // measured in beeps = 0.01 of 1%
+};
+
+export const defaultFeeStructure: FeeStructure<bigint> = {
+  feeToken: defaultFeeToken,
+  flatFee: 0n,
+  variableRate: 0n,
+};
+
+export type AuthorizationData = {
+  v: string;
+  r: string;
+  s: string;
+  nonce: string;
+  address: string;
+  chainId: string;
+};
+
+export type ParsedInLogicMetadata = {
+  signature: string;
+  deadline: number;
+  erc20TokenAddresses: string[];
+  externalCallData: string;
+};
+
+export enum UserProgress {
+  NOT_STARTED = 0,
+  CONNECTED = 1,
+  KYC = 2,
+  COMPLETED = 3,
+}

package/src/types/index.ts

@@ -0,0 +1,50 @@
+export * from './API.types';
+export * from './approvals.types';
+export * from './big-intable.types';
+export * from './circom-data.types';
+export * from './commitments.types';
+export * from './IMultiThreadedUtxoUtils';
+export * from './crypto.types';
+export * from './ethereum-network.types';
+export * from './external-action.types';
+export * from './hinkal.types';
+export * from './kyc.types';
+export * from './relayer.types';
+export * from './snark.types';
+export * from './token.types';
+export * from './slippage.types';
+export * from './transactions.types';
+export * from './rewards.types';
+export * from './hinkal.stake.types';
+export * from './duneAPI.types';
+export * from './admin.types';
+export * from './ICacheDevice';
+export * from './activities.types';
+export * from './wc.types';
+export * from './sandbox.types';
+export * from './with-id.types';
+export * from './balances.types';
+export * from './cache.types';
+export * from './tenderly.api.types';
+export * from './TransactionSimulator.types';
+export * from './coingecko.types';
+export * from './message.types';
+export * from './session.types';
+export * from './token-prices.types';
+export * from './presaleReferral.types';
+export * from './bridging.types';
+export * from './brotherhood-user.types';
+export * from './WeeklyAnalytics.types';
+export * from './referral.types';
+export * from './all-points.types';
+export * from './new-rewards.type';
+export * from './RewardUserEnums';
+export * from './generatePoints';
+export * from './eip5792.types';
+export * from './proxy.types';
+export * from './mystery-boxes.types';
+export * from './merch-order.types';
+export * from './routing.types';
+export * from './confirmation-request.types';
+export * from './signature.types';
+export * from './offscreen.types';

package/src/types/kyc.types.ts

@@ -0,0 +1,49 @@
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export enum VERIFICATION_TYPE {
+  USER = 'USER',
+  BUSINESS = 'BUSINESS',
+}
+
+export const VerificationTypes = [VERIFICATION_TYPE.USER, VERIFICATION_TYPE.BUSINESS];
+
+export enum Passports {
+  AiPriseKyc,
+  AiPriseKyb,
+  BABPassport,
+  GalxePassport,
+  // QuadrataPassport,
+  ZkMePassport,
+  CoinbasePassport,
+  AuthentoPassport,
+  AuthentoPassportKyb,
+  ReclaimCoinbasePassport,
+  ReclaimBNBPassport,
+  ReclaimOKXPassport,
+  ReclaimGatePassport,
+  ReclaimMexcPassport,
+  ReclaimHtxPassport,
+}
+
+// aiPrise verification result codes
+export enum KycVerificationResult {
+  APPROVED = 'APPROVED', // The user is verified. The verification process successfully completed.
+  DECLINED = 'DECLINED', // The user is not verified. The verification process successfully completed.
+  REVIEW = 'REVIEW', // The end user or business needs to be manually looked at. The verification process successfully completed.
+  UNKNOWN = 'UNKNOWN', // Unknown status. The verification process is not started or has failed.
+}
+
+export enum KycVerificationStatus {
+  COMPLETED = 'COMPLETED', // The verification process successfully completed.
+  FAILED = 'FAILED', // The verification process failed. status_reasons(explained below) should have more details.
+  PENDING = 'PENDING', // The verification process is waiting for a third-party API to complete its processing.
+  RUNNING = 'RUNNING', // The verification process is running.
+  NOT_STARTED = 'NOT_STARTED', // The verification process has not started yet. Most likely pre-conditions are being checked.
+}
+
+export interface VerificationData {
+  verificationResult: KycVerificationResult;
+  verificationStatus: KycVerificationStatus;
+  countryCode: string | null;
+  fullName: string | null;
+  idNumber: string | null;
+}

package/src/types/merch-order.types.ts

@@ -0,0 +1,18 @@
+import { Address } from './new-rewards.type';
+
+export enum MerchOrderStatus {
+  Pending = 'order placed',
+  Shipped = 'shipped',
+  Delivered = 'delivered',
+  Delayed = 'delayed',
+}
+
+export interface MerchOrder {
+  orderId: number;
+  ethereumAddress: string;
+  merchItemName: string;
+  status: MerchOrderStatus;
+  estimatedArrival?: string;
+  createdAt: string;
+  address?: Address | null;
+}

package/src/types/message.types.ts

@@ -0,0 +1,6 @@
+export type DecodedTypedMessageValue = {
+  value: any;
+  type: string;
+};
+
+export type DecodedTypedMessage = Record<string, DecodedTypedMessageValue>;

package/src/types/mystery-boxes.types.ts

@@ -0,0 +1,50 @@
+import { Rank } from './RewardUserEnums';
+
+export enum MysteryBoxItemFrequency {
+  Common = 'Common',
+  Uncommon = 'Uncommon',
+  Rare = 'Rare',
+  Epic = 'Epic',
+  Legendary = 'Legendary',
+}
+
+export enum MysteryBoxItemRewardType {
+  Point = 'Point',
+  Dollar = 'Dollar',
+  Merch = 'Merch',
+}
+
+export enum MysteryBoxRewardStatus {
+  Pending = 'Pending',
+  Claimed = 'Claimed',
+}
+
+type MysteryBoxItemBase = {
+  frequency: MysteryBoxItemFrequency;
+  rank: Rank;
+  id: number;
+  monthlyCount: number;
+  image: string;
+};
+
+export type MysteryBoxNumericRewardItem = MysteryBoxItemBase & {
+  type: MysteryBoxItemRewardType.Dollar | MysteryBoxItemRewardType.Point;
+  value: number;
+};
+
+export type MysteryBoxMerchItem = MysteryBoxItemBase & {
+  type: MysteryBoxItemRewardType.Merch;
+  value: string;
+};
+
+export type MysteryBoxItem = MysteryBoxNumericRewardItem | MysteryBoxMerchItem;
+
+export interface MysteryBoxReward {
+  mysteryBoxRewardId: number;
+  ethereumAddress: string;
+  mysteryBoxItemId: number;
+  type: MysteryBoxItemRewardType;
+  status: MysteryBoxRewardStatus;
+  createdAt: string;
+  isOld?: boolean;
+}

package/src/types/new-rewards.type.ts

@@ -0,0 +1,181 @@
+import { MemberStatus } from './RewardUserEnums';
+
+export interface SocialConnection {
+  id: string;
+  username: string;
+  profileImage?: string | null;
+  token?: string;
+  refreshToken?: string;
+  expireDate?: number;
+}
+
+export interface SocialsConnections {
+  discord?: SocialConnection;
+  x?: SocialConnection;
+  telegram?: SocialConnection;
+}
+
+export enum TaskCategory {
+  Welcome = 'welcome',
+  Daily = 'daily',
+  Brotherhood = 'brotherhood',
+  PointsBoost = 'pointsBoost',
+}
+
+export interface Task {
+  name: TaskTypes;
+  header: string;
+  description: string;
+  points: number;
+  category: TaskCategory;
+  progressMax: number;
+}
+
+export enum AchievementTiers {
+  None = 'None',
+  Bronze = 'Bronze',
+  Silver = 'Silver',
+  Gold = 'Gold',
+  Diamond = 'Diamond',
+}
+
+interface AchievementTier {
+  tier: AchievementTiers;
+  progressMax: number;
+  points: number;
+}
+
+export interface Achievement {
+  name: TaskTypes;
+  header: string;
+  description: string;
+  tiers: AchievementTier[];
+}
+
+export interface TelegramUser {
+  id: string;
+  first_name: string;
+  last_name: string;
+  auth_date: string;
+  hash: string;
+  photo_url?: string;
+  username?: string;
+}
+
+export enum TaskTypes {
+  x = 'x',
+  discord = 'discord',
+  telegram = 'telegram',
+  reclaim = 'reclaim',
+  firstSwap = 'firstSwap',
+  members = 'members',
+  quests = 'quests',
+  swaps = 'swaps',
+  referrals = 'referrals',
+  dApps = 'dApps',
+  chains = 'chains',
+  dailySwap = 'dailySwap',
+  dailyDappTx = 'dailyDappTx',
+  xReferral = 'xReferral',
+  achievementSwaps = 'achievementSwaps',
+  achievementReferrals = 'achievementReferrals',
+  achievementDapps = 'achievementDapps',
+  achievementChains = 'achievementChains',
+  createOrJoinBH = 'createOrJoinBH',
+  shieldUnshield = 'shieldUnshield',
+  moneyComes = 'moneyComes',
+}
+
+export enum BrotherhoodTaskTypes {
+  swappedChains = 'swappedChains',
+  interactedDApps = 'interactedDApps',
+}
+
+export interface TaskProgress {
+  name: TaskTypes;
+  progress: number;
+}
+
+export interface AchievementProgressItem extends TaskProgress {
+  currentTier: AchievementTiers;
+}
+
+export interface SwapStreakBase {
+  dailySwapAmount: number;
+  dailySwapHappened: boolean;
+  dailySwapMultiplier: number;
+  dailySwapStreak: number;
+}
+
+export interface SwapStreak extends SwapStreakBase {
+  weeklyStreak: Date[];
+}
+
+export interface SwapStreakClient extends SwapStreakBase {
+  weeklyStreak: string[];
+  joinedAt?: string;
+}
+
+export interface Address {
+  name: string;
+  addressLine1: string;
+  addressLine2?: string;
+  country: string;
+  city: string;
+  zipCode: string;
+}
+
+export interface RewardsUserInfo {
+  ethereumAddress: string;
+  username: string;
+  migratedSeasonOnePoints: number;
+  spentPoints: number;
+  lastTvl: number;
+  profileImage?: string;
+  lastVerify?: string;
+  socialsConnections?: SocialsConnections;
+  address?: Address | null;
+  swappedChains: number[];
+  interactedDApps: string[];
+  shieldHappened: boolean;
+  unshieldHappened: boolean;
+  pointsToShowInCongratsPopup: number;
+}
+
+export interface RewardsUser extends RewardsUserInfo, SwapStreak {
+  tasksProgress: TaskProgress[];
+  achievementsProgress: AchievementProgressItem[];
+  completedTasks: string[];
+  memberStatus: MemberStatus;
+  currentMonthUsdEarnings: number;
+}
+
+export interface BrotherhoodInfo {
+  brotherhoodId: number;
+  name: string;
+  profileImage: string;
+  inviteButtonName: string;
+  inviteButtonLink: string;
+  invitationToken: string;
+  isPublic: boolean;
+  createdAt: string;
+  updatedAt: string;
+  members: string[];
+  description: string;
+  swappedChains: number[];
+  interactedDApps: string[];
+}
+
+export interface Brotherhood extends BrotherhoodInfo {
+  tasksProgress: TaskProgress[];
+  completedTasks: string[];
+}
+
+export interface PublicBrotherhoodWithStats {
+  allTimeTotalPoints: number;
+  weeklyMultiplier: number;
+  memberCount: number;
+  name: string;
+  profileImage: string;
+  brotherhoodId: number;
+}

package/src/types/offscreen.types.ts

@@ -0,0 +1,8 @@
+export enum MessagesFromOffscreen {
+  EmitPassword = 'EmitPassword',
+  RefreshPublicBalance = 'RefreshPublicBalance',
+  RefreshSessions = 'RefreshSessions',
+  ChangeNetwork = 'ChangeNetwork',
+  UpdateLocationHash = 'UpdateLocationHash',
+  AutoShieldTxStatus = 'AutoShieldTxStatus',
+}

package/src/types/presaleReferral.types.ts

@@ -0,0 +1,4 @@
+export interface IPresaleReferral {
+  referralCode: string;
+  mintCount: string[];
+}

package/src/types/proxy.types.ts

@@ -0,0 +1,11 @@
+export type SubAccount = {
+  index: number | null; // positive number for created accounts and null for imported accounts
+  ethAddress: string;
+  name: string;
+  createdAt: string;
+  isHidden: boolean;
+  privateKey: string;
+  isImported: boolean;
+};
+
+export type SubAccountLight = Omit<SubAccount, 'privateKey' | 'isImported'>;

package/src/types/referral.types.ts

@@ -0,0 +1,13 @@
+export interface FilledReferredUser {
+  referralEthereumAddress: string;
+  joinedAt: Date;
+  points: number;
+  username?: string;
+  profileImageUrl?: string;
+}
+
+export interface Referral {
+  ethereumAddress: string;
+  referralCode: string;
+  referredUsers: FilledReferredUser[];
+}

package/src/types/relayer.types.ts

@@ -0,0 +1,16 @@
+export interface RelayerTransaction {
+  to: string;
+  from: string;
+  contractAddress: string | null;
+  gasUsed: { type: string; hex: string };
+  logsBloom: string;
+  blockHash: string;
+  transactionHash: string;
+  blockNumber: number;
+  confirmations: number;
+  cumulativeGasUsed: { type: string; hex: string };
+  effectiveGasPrice: { type: string; hex: string };
+  status: number;
+  type: number;
+  byzantium: boolean;
+}

package/src/types/remote-proof.types.ts

@@ -0,0 +1,18 @@
+import { NewZkCallDataType } from './snark.types';
+
+export type HandshakeResponseType = {
+  public_key: string;
+};
+
+export type RemoteProofType = {
+  pi_a: string[];
+  pi_b: string[][];
+  pi_c: string[];
+  protocol: string;
+};
+
+export type GenerateProofResponseType = {
+  proof: RemoteProofType;
+  public_signals: string[];
+  zk_calldata: NewZkCallDataType;
+};

package/src/types/rewards.types.ts

@@ -0,0 +1,53 @@
+import { Rank } from './RewardUserEnums';
+
+export enum OldPointType {
+  CertificationPoints = 'CertificationPoints',
+  TradePoints = 'TradePoints',
+  LPPoints = 'LPPoints',
+  ReferralPoints = 'ReferralPoints',
+  GalxePoints = 'GalxePoints',
+  ZealyPoints = 'ZealyPoints',
+  TaskOnPoints = 'TaskOnPoints',
+  BonusPoints = 'BonusPoints',
+}
+
+export enum RafflePrizeType {
+  Gold = 'Gold',
+  Silver = 'Silver',
+}
+
+export type CountDown = {
+  daysLeft: number;
+  hoursLeft: number;
+  minutesLeft: number;
+  secondsLeft: number;
+};
+
+export interface DailyJobLock {
+  day: Date;
+  createdAt: Date;
+}
+
+export interface DailyBoxCounter {
+  date: Date;
+  rank: string;
+  count: number;
+}
+
+export interface DailyProxyProgress {
+  day: Date;
+  ethereumAddress: string;
+  chainId: number;
+}
+
+export interface AuctionIntervalLock {
+  date: Date;
+  rank: Rank;
+  intervalStart: Date;
+}
+
+export interface DailyHinkalContractProgress {
+  day: Date;
+  contractAddress: string;
+  chainId: number;
+}

package/src/types/routing.types.ts

@@ -0,0 +1,7 @@
+export enum HttpMethod {
+  GET = 'GET',
+  POST = 'POST',
+  PUT = 'PUT',
+  DELETE = 'DELETE',
+  PATCH = 'PATCH',
+}