@sabaaa1/common 0.0.5 → 0.0.7

package/src/types/big-intable.types.ts

@@ -0,0 +1,3 @@
+import { BigNumber } from 'ethers';
+
+export type BigIntable = BigNumber | string | number | boolean | bigint;

package/src/types/bridging.types.ts

@@ -0,0 +1,30 @@
+export interface BridgeProtocolQuery {
+  name?: string;
+  url?: string;
+}
+
+export interface Bridge {
+  name: string;
+  url: string;
+}
+export interface ChainlistRawEntry {
+  name: string;
+  chainId: number;
+  parent?: {
+    type?: string;
+    chain?: string;
+    bridges?: { url: string }[];
+  };
+}
+
+export interface DefillamaRawEntry {
+  name?: string;
+  url?: string;
+  category?: string;
+}
+
+export interface JumperExchangeRawEntry {
+  bridges?: {
+    name?: string;
+  }[];
+}

package/src/types/brotherhood-user.types.ts

@@ -0,0 +1,13 @@
+import { MemberStatus } from './RewardUserEnums';
+import { AllPoints } from './all-points.types';
+
+export interface BrotherhoodUserBase extends AllPoints {
+  ethereumAddress: string;
+  brotherhoodId: number;
+  memberStatus: MemberStatus;
+}
+
+export interface BrotherhoodUser extends BrotherhoodUserBase {
+  username: string;
+  profileImage: string;
+}

package/src/types/cache.types.ts

@@ -0,0 +1,42 @@
+export enum StorageKeys {
+  LAST_IGNORED_DEPOSIT_BALANCE_1K = 'lastIgnoredDepositBalance1K',
+  LAST_IGNORED_DEPOSIT_BALANCE_10K = 'lastIgnoredDepositBalance10K',
+  LAST_IGNORED_DEPOSIT_SCAM_TOKENS = 'lastIgnoredDepositScamTokens',
+  LAST_IGNORED_DEPOSIT_TRANSACTIONS = 'lastIgnoredDepositTransactions',
+  LOCAL_STORAGE_KEY_USER_ANALYTICS_CONSENT = 'userAnalyticsConsentPref',
+  PASSWORD_HASH = 'passwordHash',
+  SELECTED_NETWORK_CHAIN_ID = 'selectedNetworkChainId',
+  LAST_ADDRESS = 'lastAddress',
+  AUTO_LOCK_TIME = 'autoLockTime',
+  TOKEN_REGISTRY = 'tokenRegistry',
+  IS_BALANCE_HIDDEN = 'isBalanceHidden',
+  SANDBOX_TRANSACTION_STATUS = 'sandboxTransactionStatus',
+  SELECTED_SUB_ACCOUNT_ADDRESS = 'selectedSubAccountAddress',
+  GENERATE_PROOF_REMOTELY = 'generateProofRemotely',
+  IS_RELAYER_OFF = 'isRelayerOff',
+  ONBOARDING_SHOWN = 'onboardingShown',
+  CONNECT_WITH_HINKAL = 'connectWithHinkal',
+  GAS_COST_TOKEN = 'gasCostToken',
+  PRIVATE_TOKENS = 'privateTokens',
+  ALCHEMY_PUBLIC_TOKENS = 'alchemyPublicTokens',
+  EVENTS_PUBLIC_TOKENS = 'eventsPublicTokens',
+  ARC_PUBLIC_TOKENS = 'arcPublicTokens',
+  PUBLIC_TOKENS_LAST_PROCESSED_BLOCKS = 'publicTokensLastProcessedBlocks',
+  ACCEPTED_TERMS_OF_SERVICES = 'acceptedTermsOfServices',
+  SLIPPAGE_PERCENTAGE = 'slippagePercentage',
+  IS_SLIPPAGE_PERCENTAGE_CUSTOM = 'isSlippagePercentageCustom',
+  MNEMONIC_PHRASE = 'mnemonicPhrase',
+  SOURCE_MNEMONIC_PHRASE = 'sourceMnemonicPhrase',
+  SELECTED_WALLET_ENVIRONMENT = 'selectedWalletEnvironment',
+  IS_TOOLTIPS_ON = 'isTooltipsOn',
+  CONNECTED_ADDRESS = 'connectedAddress',
+  CONNECTED_SESSIONS = 'connectedSessions',
+  TX_ACTIVITY = 'tx-activity',
+  IS_TOR_ROUTING_ON = 'isTorRoutingOn',
+  EVENTS_PUBLIC_APPROVALS = 'eventsPublicApprovals',
+  PUBLIC_APPROVALS_LAST_PROCESSED_BLOCKS = 'publicApprovalsLastProcessedBlocks',
+  ACTIVE_SUB_ACCOUNT = 'activeSubAccount',
+  SIGNED_MESSAGES = 'signedMessages',
+  AUTO_SHIELD_IS_ON = 'autoShieldIsOn',
+  MAX_GAS_IN_DOLLAR = 'maxGasInDollar',
+}

package/src/types/circom-data.types.ts

@@ -0,0 +1,120 @@
+import { ethers } from 'ethers';
+import { SignatureData } from './crypto.types';
+import { FeeStructure, HinkalLogicArgs } from './hinkal.types';
+
+export interface TypedData {
+  domain: ethers.TypedDataDomain;
+  types: Record<string, Array<ethers.TypedDataField>>;
+  value: Record<string, any>;
+}
+
+export interface CircomDataBaseType {
+  rootHashHinkal: bigint | undefined;
+  erc20TokenAddresses: string[];
+  tokenIds: string[];
+  amountChanges: bigint[];
+  inputNullifiers: string[][];
+  outCommitments: string[][];
+  encryptedOutputs: string[][];
+  timeStamp?: string;
+  stealthAddressStructure: StealthAddressStructure;
+  rootHashAccessToken: bigint | undefined;
+  relay: string;
+  externalAddress: string;
+  externalActionMetadata: string;
+  externalActionId: bigint;
+  hookData: HookDataType;
+  calldataHash: bigint;
+  publicSignalCount: number;
+}
+
+export interface CircomDataV1 extends CircomDataBaseType {
+  flatFees: bigint[];
+}
+
+export interface CircomDataV1x1 extends CircomDataBaseType {
+  onChainCreation: boolean[];
+  slippageValues: bigint[];
+  hinkalLogicArgs: HinkalLogicArgs;
+  feeStructure: FeeStructure;
+  signatureData: SignatureData;
+  originalSender: string;
+}
+
+export interface CircomDataBaseJsonType {
+  rootHashHinkal: bigint | undefined | string;
+  erc20TokenAddresses: string[];
+  tokenIds: string[];
+  amountChanges: bigint[] | string[];
+  inputNullifiers: string[][];
+  outCommitments: string[][];
+  encryptedOutputs: string[][];
+  stealthAddressStructure: StealthAddressStructure<bigint | string>;
+  timeStamp?: string;
+  rootHashAccessToken: bigint | undefined | string;
+  relay: string;
+  externalAddress: string;
+  externalActionMetadata: string;
+  externalActionId: bigint | string;
+  hookData: HookDataType;
+  calldataHash: bigint | string;
+  publicSignalCount: number;
+}
+
+export interface CircomDataBaseJsonV1 extends CircomDataBaseJsonType {
+  flatFees: bigint[] | string[];
+}
+
+export interface CircomDataBaseJsonV1x1 extends CircomDataBaseJsonType {
+  onChainCreation: boolean[] | string[];
+  slippageValues: bigint[] | string[];
+  hinkalLogicArgs: HinkalLogicArgs<bigint | string>;
+  feeStructure: FeeStructure<bigint | string>;
+}
+
+export type DimDataType = {
+  tokenNumber: number;
+  nullifierAmount: number;
+  outputAmount: number;
+};
+
+export type HookDataType = {
+  hookContract: string;
+  preHookContract: string;
+  preHookMetadata: string;
+  postHookMetadata: string;
+};
+
+export type StealthAddressStructure<T = bigint> = {
+  extraRandomization: T;
+  stealthAddress: T;
+  H0: T;
+  H1: T;
+};
+
+export const emptyStealthAddressStructure = {
+  extraRandomization: '',
+  stealthAddress: '',
+  H0: '',
+  H1: '',
+};
+export interface TransactParams<CircomType = CircomDataBaseJsonV1x1> {
+  dimensions: DimDataType;
+  circomData: CircomType;
+}
+
+export const defaultHookData: HookDataType = {
+  preHookContract: '0x0000000000000000000000000000000000000000',
+  hookContract: '0x0000000000000000000000000000000000000000',
+  preHookMetadata: '0x00',
+  postHookMetadata: '0x00',
+};
+
+export const defaultHookDataArray = Object.values(defaultHookData);
+
+export const defaultStealthAddressStructure: StealthAddressStructure = {
+  extraRandomization: 1n,
+  stealthAddress: 0n,
+  H0: 0n,
+  H1: 0n,
+};

package/src/types/coingecko.types.ts

@@ -0,0 +1,216 @@
+export interface CoingeckoToken {
+  id: string;
+  symbol: string;
+  name: string;
+  platforms: {
+    [key: string]: string;
+  };
+}
+
+export interface CoinGeckoResponse {
+  id: string;
+  symbol: string;
+  name: string;
+  web_slug: string;
+  asset_platform_id: string;
+  platforms: {
+    [key: string]: string;
+  };
+  detail_platforms: {
+    [key: string]: {
+      decimal_place: number | null;
+      contract_address: string;
+    };
+  };
+  block_time_in_minutes: number;
+  hashing_algorithm: null;
+  categories: string[];
+  preview_listing: boolean;
+  public_notice: string;
+  additional_notices: any[];
+  localization: {
+    [key: string]: string;
+  };
+  description: {
+    [key: string]: string;
+  };
+  links: {
+    homepage: string[];
+    whitepaper: string;
+    blockchain_site: string[];
+    official_forum_url: string[];
+    chat_url: string[];
+    announcement_url: string[];
+    snapshot_url: null;
+    twitter_screen_name: string;
+    facebook_username: string;
+    bitcointalk_thread_identifier: null;
+    telegram_channel_identifier: string;
+    subreddit_url: string;
+    repos_url: {
+      github: string[];
+      bitbucket: any[];
+    };
+  };
+  image: {
+    thumb: string;
+    small: string;
+    large: string;
+  };
+  country_origin: string;
+  genesis_date: null;
+  contract_address: string;
+  sentiment_votes_up_percentage: number;
+  sentiment_votes_down_percentage: number;
+  watchlist_portfolio_users: number;
+  market_cap_rank: number;
+  market_data: {
+    current_price: {
+      [key: string]: number;
+    };
+    total_value_locked: null;
+    mcap_to_tvl_ratio: null;
+    fdv_to_tvl_ratio: null;
+    roi: null;
+    ath: {
+      [key: string]: number;
+    };
+    ath_change_percentage: {
+      [key: string]: number;
+    };
+    ath_date: {
+      [key: string]: string;
+    };
+    atl: {
+      [key: string]: number;
+    };
+    atl_change_percentage: {
+      [key: string]: number;
+    };
+    atl_date: {
+      [key: string]: string;
+    };
+    market_cap: {
+      [key: string]: number;
+    };
+    market_cap_rank: number;
+    fully_diluted_valuation: {
+      [key: string]: number;
+    };
+    market_cap_fdv_ratio: number;
+    total_volume: {
+      [key: string]: number;
+    };
+    high_24h: {
+      [key: string]: number;
+    };
+    low_24h: {
+      [key: string]: number;
+    };
+    price_change_24h: number;
+    price_change_percentage_24h: number;
+    price_change_percentage_7d: number;
+    price_change_percentage_14d: number;
+    price_change_percentage_30d: number;
+    price_change_percentage_60d: number;
+    price_change_percentage_200d: number;
+    price_change_percentage_1y: number;
+    market_cap_change_24h: number;
+    market_cap_change_percentage_24h: number;
+    price_change_24h_in_currency: {
+      [key: string]: number;
+    };
+    price_change_percentage_1h_in_currency: {
+      [key: string]: number;
+    };
+    price_change_percentage_24h_in_currency: {
+      [key: string]: number;
+    };
+    price_change_percentage_7d_in_currency: {
+      [key: string]: number;
+    };
+    price_change_percentage_14d_in_currency: {
+      [key: string]: number;
+    };
+    price_change_percentage_30d_in_currency: {
+      [key: string]: number;
+    };
+    price_change_percentage_60d_in_currency: {
+      [key: string]: number;
+    };
+    price_change_percentage_200d_in_currency: {
+      [key: string]: number;
+    };
+    price_change_percentage_1y_in_currency: {
+      [key: string]: number;
+    };
+    market_cap_change_24h_in_currency: {
+      [key: string]: number;
+    };
+    market_cap_change_percentage_24h_in_currency: {
+      [key: string]: number;
+    };
+    total_supply: number;
+    max_supply: null;
+    circulating_supply: number;
+    last_updated: string;
+  };
+  community_data: {
+    facebook_likes: null;
+    twitter_followers: number;
+    reddit_average_posts_48h: number;
+    reddit_average_comments_48h: number;
+    reddit_subscribers: number;
+    reddit_accounts_active_48h: number;
+    telegram_channel_user_count: null;
+  };
+  developer_data: {
+    forks: number;
+    stars: number;
+    subscribers: number;
+    total_issues: number;
+    closed_issues: number;
+    pull_requests_merged: number;
+    pull_request_contributors: number;
+    code_additions_deletions_4_weeks: {
+      additions: number;
+      deletions: number;
+    };
+    commit_count_4_weeks: number;
+    last_4_weeks_commit_activity_series: number[];
+  };
+  status_updates: any[];
+  last_updated: string;
+  tickers: {
+    base: string;
+    target: string;
+    market: {
+      name: string;
+      identifier: string;
+      has_trading_incentive: boolean;
+    };
+    last: number;
+    volume: number;
+    converted_last: {
+      btc: number;
+      eth: number;
+      usd: number;
+    };
+    converted_volume: {
+      btc: number;
+      eth: number;
+      usd: number;
+    };
+    trust_score: string;
+    bid_ask_spread_percentage: number;
+    timestamp: string;
+    last_traded_at: string;
+    last_fetch_at: string;
+    is_anomaly: boolean;
+    is_stale: boolean;
+    trade_url: string;
+    token_info_url: null;
+    coin_id: string;
+    target_coin_id: string;
+  }[];
+}

package/src/types/commitments.types.ts

@@ -0,0 +1,39 @@
+import { BigIntable } from './big-intable.types';
+
+export interface EncryptedOutputWithSign<Sign = boolean> {
+  value: string;
+  isPositive: Sign;
+}
+
+export interface OutputsWithSignAndLast<Sign = boolean> {
+  additionalEncryptedOutputs: EncryptedOutputWithSign<Sign>[];
+  lastOutput: string;
+}
+
+export interface CommitmentEvent<BN = BigIntable> {
+  commitment: BN;
+  index: BN;
+  encryptedOutput: string;
+}
+
+export interface AccessTokenEvent<BN = BigIntable> {
+  accessKey: BN;
+  index: BN;
+  senderAddress: string;
+}
+
+export interface NullifierEvent<T> {
+  nullifier: T;
+}
+
+export interface RegisterEvent {
+  ethereumAddress: string;
+  shieldedAddressHash: string;
+}
+
+export interface NewApprovedUtxoEvent<T = bigint> {
+  approveTo: string;
+  tokenAddress: string;
+  amount: T;
+  inHinkalAddress: T;
+}

package/src/types/confirmation-request.types.ts

@@ -0,0 +1,10 @@
+export enum ConfirmationRequestType {
+  'CONNECT' = 'CONNECT',
+  'PERSONAL_SIGN' = 'PERSONAL_SIGN',
+  'SIGN_TYPE_V4' = 'SIGN_TYPE_V4',
+  'SEND_TRANSACTION' = 'SEND_TRANSACTION',
+  'SEND_BATCH_TRANSACTION' = 'SEND_BATCH_TRANSACTION',
+  'UNSUPPORTED_NETWORK' = 'UNSUPPORTED_NETWORK',
+  'UNSUPPORTED_METHOD' = 'UNSUPPORTED_METHOD',
+  'BLACKLISTED_DAPP' = 'BLACKLISTED_DAPP',
+}

package/src/types/contacts.types.ts

@@ -0,0 +1,6 @@
+export interface Contact {
+  ethereumAddress: string;
+  nickname: string;
+  profilePicture?: string;
+  ensName?: string;
+}

package/src/types/crypto.types.ts

@@ -0,0 +1,8 @@
+export interface SignatureData {
+  r: string;
+  s: string;
+  v: string;
+  accessKey: string;
+  nonce: number;
+  ethereumAddress: string;
+}

package/src/types/duneAPI.types.ts

@@ -0,0 +1,9 @@
+export interface WalletBalancesInfo {
+  amount: number;
+  address: string;
+  chain: string;
+  chain_id: number;
+  symbol: string;
+  value_usd: number;
+  logoURI?: string;
+}

package/src/types/eip5792.types.ts

@@ -0,0 +1,31 @@
+// EIP-5792 Types and Interfaces
+// Based on https://eips.ethereum.org/EIPS/eip-5792
+
+type Capability = {
+  [key: string]: unknown;
+  optional?: boolean;
+};
+
+type Call = {
+  to?: string;
+  data?: string;
+  value?: string;
+  capabilities?: Record<string, Capability>;
+};
+
+export type SendCallsParams = {
+  version: string;
+  id?: string;
+  from?: string;
+  chainId: string;
+  atomicRequired: boolean;
+  calls: Call[];
+  capabilities?: Record<string, Capability>;
+};
+
+export enum GetCallsStatusCode {
+  Pending = 'pending',
+  Confirmed = 'confirmed',
+  Failed = 'failed',
+  NotFound = 'not_found',
+}

package/src/types/ethereum-network.types.ts

@@ -0,0 +1,70 @@
+import { ContractInterface } from 'ethers';
+
+export type ContractMetadata = {
+  abi?: ContractInterface;
+  address?: string;
+};
+
+export enum ContractType {
+  HinkalContract,
+  HinkalHelperContract,
+  AccessTokenContract,
+  UniswapV3FactoryContract,
+  UniswapV3PoolContract,
+  UniswapV3QuoterContract,
+  ERC20Contract,
+  ERC721Contract,
+  ERC1155Contract,
+  WATokenContract,
+  OneInchExternalActionContract,
+  MerkleTreeContract,
+  ContractWithNonces,
+  PermitterContract,
+  UniswapV2PoolContract,
+  HinkalWrapper,
+  HinkalWrapper2,
+  HinkalStakeExternalAction,
+  HToken,
+}
+
+export interface ContractData {
+  hinkalAddress: string;
+  hinkalABI: ContractInterface;
+  hinkalHelperAddress?: string;
+  hinkalHelperABI?: ContractInterface;
+  accessTokenAddress?: string;
+  accessTokenABI?: ContractInterface;
+  permitterAddress?: string;
+  permitterABI?: ContractInterface;
+  uniswapExternalActionAddress?: string;
+  odosExternalActionInstanceAddress?: string;
+  oneInchExternalActionInstanceAddress?: string;
+  waTokenABI?: ContractInterface;
+  hinkalWrapperAddress?: string;
+  hinkalWrapper2Address?: string;
+  HinkalWrapperABI?: ContractInterface;
+  HinkalWrapper2ABI?: ContractInterface;
+  hinkalStakeExternalActionAddress?: string;
+  HinkalStakeExternalActionABI?: ContractInterface;
+  HTokenABI?: ContractInterface;
+  hETHOracleAddress?: string;
+  HTokenOracleABI?: ContractInterface;
+  emporiumAddress?: string;
+  hinkalWalletAddress?: string;
+}
+
+export interface EthereumNetwork {
+  name: string;
+  chainId: number;
+  rpcUrl: string;
+  maxPageSize?: number;
+  fetchRpcUrl?: string;
+  privateMempoolRpcUrl?: string;
+  contractData: ContractData;
+  supported?: boolean;
+  quoterV2Address?: string;
+  uniswapV3FactoryAddress?: string;
+  pollingInterval?: number;
+  gasStationUrl?: string;
+  priority?: number;
+}

package/src/types/external-action.types.ts

@@ -0,0 +1,19 @@
+export enum ExternalActionId {
+  Transact = 'Transact',
+  Uniswap = 'Uniswap',
+  Odos = 'Odos',
+  OneInch = 'OneInch',
+  Lifi = 'Lifi', // Note: not an actual external action, added to handle lifi in hinkal.proxySwap
+  // Hinkal Stake
+  HinkalStake = 'HinkalStake',
+  // Emporium
+  Emporium = 'Emporium',
+  // Wallet
+  Wallet = 'Wallet',
+}
+
+export interface ExternalActionData {
+  externalActionId: 0n | ExternalActionId;
+  externalAddress: string;
+  externalActionMetadata: string;
+}

package/src/types/fee.types.ts

@@ -0,0 +1,11 @@
+import { ERC20Token } from './token.types';
+
+export interface MinimalFeeInfo {
+  flatFees: bigint[];
+  feeUnit: ERC20Token | undefined;
+}
+
+export interface FeeInfo extends MinimalFeeInfo {
+  priceOfTransactionInToken: bigint | undefined;
+  priceOfTransactionInUSD: number | undefined;
+}

package/src/types/generatePoints.ts

@@ -0,0 +1,14 @@
+export enum TradingType {
+  Swap,
+  DApp,
+  Shield,
+  Unshield,
+}
+
+export enum PointsType {
+  Trading,
+  Quests,
+  Aum,
+  Referral,
+  MysteryBox,
+}

package/src/types/hinkal.stake.types.ts

@@ -0,0 +1,12 @@
+export enum HinkalStakeMode {
+  Deposit = 'Deposit',
+  Stake = 'Stake',
+  Unstake = 'Unstake',
+}
+
+export interface StakeArgs {
+  mode: HinkalStakeMode;
+  stakedTokenRecipient: string;
+  stakeBlinding: bigint;
+  depositorAddress: string;
+}