@sabaaa1/common 0.0.1

package/src/constants/server.constants.ts

@@ -0,0 +1,233 @@
+import { TaskTypes } from '../types';
+
+// Main Server Config
+export const API_CONFIG = {
+  ROUTES: {
+    checkKycStatus: '/check-kyc-status',
+    getUserSignature: '/signature-request',
+    startReclaimVerification: '/start-reclaim-verification',
+    startUserVerification: '/start-aiprise-verification',
+    zkMeAccessToken: '/zkMeAccessToken',
+    getSnapshots: '/snapshots',
+    callOdosAPI: '/OdosSwapData',
+    callOneInchAPI: '/OneInchSwapData',
+    callLifiAPI: '/LifiBridgeData',
+    getOdosPriceForToken: (tokenAddress: string) => `/getOdosPriceForToken/${tokenAddress}`,
+    userHasKyc: '/user-has-kyc',
+    restoreSnapshots: '/snapshots/restore',
+    monitor: '/monitor',
+    checkRisk: (address: string) => `/check-risk/${address}`,
+    userHasPassword: (ethereumAddress: string) => `/user-has-password/${ethereumAddress}`,
+    userRegisterPassword: `/user-register-password`,
+    stakedYield: '/staked-yield',
+    getPublicWalletInformation: (ethereumAddress: string) => `/get-public-wallet-data/${ethereumAddress}`,
+    getTokenApprovalAmount: '/get-token-approval-amount-from-html',
+    getTokenSpendsFromOrderMessage: '/get-token-spends-from-order-message',
+    isTxStateless: '/is-tx-stateless',
+    simulateBatchTx: '/simulate-batch-tx',
+    simulateVolatileTokenTransfer: '/simulate-volatile-token-transfer',
+    getTokensInfo: '/get-tokens-info',
+    getTokenData: (tokenSymbol: string) => `/get-token-data/${tokenSymbol}`,
+    getBridgeProtocols: '/get-bridge-protocols',
+    lifiStatus: '/LifiStatus',
+    getProxyAccounts: (secureKey: string) => `/get-proxy-accounts/${secureKey}`,
+    updateProxyAccounts: '/update-proxy-accounts',
+  },
+};
+
+// Relayer config
+export const RELAYER_CONFIG = {
+  getGasEstimate: (
+    tokenAddress: string,
+    externalActionId: string,
+    erc20TokenAddressLength: number,
+    gasAmount?: number,
+  ) => `/gas-estimation/${tokenAddress}/${erc20TokenAddressLength}/${externalActionId}/${gasAmount}`,
+  getTokenPrice: '/get-token-price',
+  getTokenPriceEth: (id: string) => `/get-token-price-in-eth/${id}`,
+  getTokenPrices: '/get-token-prices',
+  TRANSACT: '/general-transact',
+  getIdleRelay: '/get-idle-relay',
+  emitTxPublicData: '/emit-tx-public-data',
+};
+
+export const WALLET_TASK_VERIFICATION_TYPES: TaskTypes[] = [
+  TaskTypes.firstSwap,
+  TaskTypes.reclaim,
+  TaskTypes.dailySwap,
+  TaskTypes.dailyDappTx,
+  TaskTypes.createOrJoinBH,
+  TaskTypes.shieldUnshield,
+  TaskTypes.moneyComes,
+];
+
+// Verification routes
+export const VERIFICATION_ROUTES: Partial<Record<TaskTypes, (ethereumAddress: string) => string>> = {
+  [TaskTypes.discord]: (ethereumAddress) => `/verify/discord/${ethereumAddress}`,
+  [TaskTypes.x]: (ethereumAddress) => `/verify/x/${ethereumAddress}`,
+  [TaskTypes.xReferral]: (ethereumAddress) => `/verify/x-referral/${ethereumAddress}`,
+  [TaskTypes.telegram]: (ethereumAddress) => `/verify/telegram/${ethereumAddress}`,
+  ...Object.fromEntries(
+    WALLET_TASK_VERIFICATION_TYPES.map((taskType) => [
+      taskType,
+      (ethereumAddress: string) => `/verify/wallet-task/${ethereumAddress}`,
+    ]),
+  ),
+};
+
+// data-server config
+export const DATA_SERVER_CONFIG = {
+  createPresaleReferral: `/create-presale-referral`,
+  updatePresaleReferralList: `/update-presale-referral-list`,
+  generateTradingPoints: '/generate-trading-points',
+  getBrotherhoodUsers: (brotherhoodId: number) => `/brotherhoods/${brotherhoodId}/users`,
+  getCurrentUserBrotherhoodUsers: (ethereumAddress: string) => `/get-current-user-brotherhood-users/${ethereumAddress}`,
+  editBrotherhood: '/edit-brotherhood',
+  createBrotherhood: '/create-brotherhood',
+  getCurrentUserBrotherhood: '/get-current-user-brotherhood',
+  getPublicBrotherhoods: '/get-public-brotherhoods',
+  getBrotherhood: (brotherhoodId: number) => `/brotherhoods/${brotherhoodId}`,
+  leaveBrotherhood: (brotherhoodId: number) => `/brotherhoods/${brotherhoodId}/leave`,
+  joinBrotherhood: (brotherhoodId: number) => `/brotherhoods/${brotherhoodId}/join`,
+  getUserAnalytics: '/get-user-analytics',
+  getBrotherhoodAnalytics: '/brotherhood/analytics',
+  connectRewardsUser: '/connect-user',
+  updateRewardsUser: '/update-rewards-user',
+  getSwapStreak: '/swap-streak',
+  getUserCurrentLeaderboard: '/current-users-leaderboard',
+  getBrotherhoodsLeaderboard: '/brotherhoods-leaderboard',
+  getCurrentUserReferral: '/current-user-referral',
+  submitReferralCode: '/refer-user',
+  getCurrentUserAppliedReferralCode: '/current-user-applied-referral-code',
+  getTelegramCallback: '/auth/telegram/callback',
+  generateAumPoints: '/generate-aum-points',
+  getTasksProgress: (ethereumAddress: string) => `/get-tasks-progress/${ethereumAddress}`,
+  disconnectSocialNetwork: `/disconnect-social-network`,
+  openMysteryBox: '/open-mystery-box',
+  getMysteryBoxesHistory: (ethereumAddress: string) => `/get-mystery-boxes-history/${ethereumAddress}`,
+  createOrUpdateMerchAddress: '/create-or-update-merch-address',
+  claimMerchItem: '/claim-merch-item',
+  getMerchOrders: (ethereumAddress: string) => `/get-merch-orders/${ethereumAddress}`,
+  getNftMultiplier: (ethereumAddress: string) => `/get-nft-multiplier/${ethereumAddress}`,
+  getCurrentDayBoxPrizeCounts: '/get-current-day-box-prize-counts',
+  getCurrentAuctionsInfo: '/current-auctions-info',
+  getServerUtc: '/server-utc',
+};
+
+export const PLAYGROUND_URL = 'https://wallet-playground.hinkal.pro';
+export const STAGING_URL = 'https://wallet-staging.hinkal.pro';
+export const PRODUCTION_URL = 'https://wallet-prod.hinkal.pro';
+
+export const DATA_SERVER_URL_LOCAL = 'http://localhost:7090';
+export const DATA_SERVER_URL_ENDPOINT = '/ethMainnet-data-server';
+
+// SERVER LINKS
+export const STAGING_SERVER_URLS = {
+  polygon: `${STAGING_URL}/polygon-server`,
+  arbMainnet: `${STAGING_URL}/arbMainnet-server`,
+  ethMainnet: `${STAGING_URL}/ethMainnet-server`,
+  bnbMainnet: `${STAGING_URL}/bnbMainnet-server`,
+  avalanche: `${STAGING_URL}/avalanche-server`,
+  optimism: `${STAGING_URL}/optimism-server`,
+  base: `${STAGING_URL}/base-server`,
+  arcTestnet: `${STAGING_URL}/arcTestnet-server`,
+  localhost: 'http://localhost:7072',
+};
+
+export const PLAYGROUND_SERVER_URLS = {
+  polygon: `${PLAYGROUND_URL}/polygon-server`,
+  arbMainnet: `${PLAYGROUND_URL}/arbMainnet-server`,
+  ethMainnet: `${PLAYGROUND_URL}/ethMainnet-server`,
+  bnbMainnet: `${PLAYGROUND_URL}/bnbMainnet-server`,
+  avalanche: `${PLAYGROUND_URL}/avalanche-server`,
+  optimism: `${PLAYGROUND_URL}/optimism-server`,
+  base: `${PLAYGROUND_URL}/base-server`,
+  arcTestnet: `${PLAYGROUND_URL}/arcTestnet-server`,
+  localhost: 'http://localhost:7072',
+};
+
+export const PRODUCTION_SERVER_URLS = {
+  polygon: `${PRODUCTION_URL}/polygon-server`,
+  arbMainnet: `${PRODUCTION_URL}/arbMainnet-server`,
+  ethMainnet: `${PRODUCTION_URL}/ethMainnet-server`,
+  bnbMainnet: `${PRODUCTION_URL}/bnbMainnet-server`,
+  avalanche: `${PRODUCTION_URL}/avalanche-server`,
+  optimism: `${PRODUCTION_URL}/optimism-server`,
+  base: `${PRODUCTION_URL}/base-server`,
+  arcTestnet: `${PRODUCTION_URL}/arcTestnet-server`,
+  localhost: 'http://localhost:7072',
+};
+
+// RELAYER LINKS
+export const STAGING_RELAYER_URLS = {
+  polygon: `${STAGING_URL}/polygon-relayer`,
+  arbMainnet: `${STAGING_URL}/arbMainnet-relayer`,
+  ethMainnet: `${STAGING_URL}/ethMainnet-relayer`,
+  bnbMainnet: `${STAGING_URL}/bnbMainnet-relayer`,
+  avalanche: `${STAGING_URL}/avalanche-relayer`,
+  optimism: `${STAGING_URL}/optimism-relayer`,
+  base: `${STAGING_URL}/base-relayer`,
+  arcTestnet: `${STAGING_URL}/arcTestnet-relayer`,
+  localhost: 'http://localhost:7073',
+};
+
+export const PLAYGROUND_RELAYER_URLS = {
+  polygon: `${PLAYGROUND_URL}/polygon-relayer`,
+  arbMainnet: `${PLAYGROUND_URL}/arbMainnet-relayer`,
+  ethMainnet: `${PLAYGROUND_URL}/ethMainnet-relayer`,
+  bnbMainnet: `${PLAYGROUND_URL}/bnbMainnet-relayer`,
+  avalanche: `${PLAYGROUND_URL}/avalanche-relayer`,
+  optimism: `${PLAYGROUND_URL}/optimism-relayer`,
+  base: `${PLAYGROUND_URL}/base-relayer`,
+  arcTestnet: `${PLAYGROUND_URL}/arcTestnet-relayer`,
+  localhost: 'http://localhost:7073',
+};
+
+export const PRODUCTION_RELAYER_URLS = {
+  polygon: `${PRODUCTION_URL}/polygon-relayer`,
+  arbMainnet: `${PRODUCTION_URL}/arbMainnet-relayer`,
+  ethMainnet: `${PRODUCTION_URL}/ethMainnet-relayer`,
+  bnbMainnet: `${PRODUCTION_URL}/bnbMainnet-relayer`,
+  avalanche: `${PRODUCTION_URL}/avalanche-relayer`,
+  optimism: `${PRODUCTION_URL}/optimism-relayer`,
+  base: `${PRODUCTION_URL}/base-relayer`,
+  arcTestnet: `${PRODUCTION_URL}/arcTestnet-relayer`,
+  localhost: 'http://localhost:7073',
+};
+
+// SNAPSHOT SERVER LINKS
+export const PLAYGROUND_SNAPSHOT_SERVER_URLS = {
+  polygon: `${PLAYGROUND_URL}/polygon-snapshot-server`,
+  arbMainnet: `${PLAYGROUND_URL}/arbMainnet-snapshot-server`,
+  ethMainnet: `${PLAYGROUND_URL}/ethMainnet-snapshot-server`,
+  bnbMainnet: `${PLAYGROUND_URL}/bnbMainnet-snapshot-server`,
+  avalanche: `${PLAYGROUND_URL}/avalanche-snapshot-server`,
+  optimism: `${PLAYGROUND_URL}/optimism-snapshot-server`,
+  base: `${PLAYGROUND_URL}/base-snapshot-server`,
+  arcTestnet: `${PLAYGROUND_URL}/arcTestnet-snapshot-server`,
+  localhost: 'http://localhost:7074',
+};
+
+export const STAGING_SNAPSHOT_SERVER_URLS = {
+  polygon: `${STAGING_URL}/polygon-snapshot-server`,
+  arbMainnet: `${STAGING_URL}/arbMainnet-snapshot-server`,
+  ethMainnet: `${STAGING_URL}/ethMainnet-snapshot-server`,
+  bnbMainnet: `${STAGING_URL}/bnbMainnet-snapshot-server`,
+  avalanche: `${STAGING_URL}/avalanche-snapshot-server`,
+  optimism: `${STAGING_URL}/optimism-snapshot-server`,
+  base: `${STAGING_URL}/base-snapshot-server`,
+  arcTestnet: `${STAGING_URL}/arcTestnet-snapshot-server`,
+  localhost: 'http://localhost:7074',
+};
+
+export const PRODUCTION_SNAPSHOT_SERVER_URLS = {
+  polygon: `${PRODUCTION_URL}/polygon-snapshot-server`,
+  arbMainnet: `${PRODUCTION_URL}/arbMainnet-snapshot-server`,
+  ethMainnet: `${PRODUCTION_URL}/ethMainnet-snapshot-server`,
+  bnbMainnet: `${PRODUCTION_URL}/bnbMainnet-snapshot-server`,
+  avalanche: `${PRODUCTION_URL}/avalanche-snapshot-server`,
+  optimism: `${PRODUCTION_URL}/optimism-snapshot-server`,
+  base: `${PRODUCTION_URL}/base-snapshot-server`,
+  arcTestnet: `${PRODUCTION_URL}/arcTestnet-snapshot-server`,
+  localhost: 'http://localhost:7074',
+};

package/src/constants/tasks.constants.ts

@@ -0,0 +1,205 @@
+import { AchievementTiers, Task, TaskCategory, TaskTypes } from '../types';
+import { Achievement } from '../types/new-rewards.type';
+
+export const WELCOME_TASKS: Task[] = [
+  // {
+  //   name: TaskTypes.reclaim,
+  //   header: 'Complete integrity check',
+  //   description: 'Complete integrity verification using any provider',
+  //   points: 100,
+  //   category: TaskCategory.Welcome,
+  //   progressMax: 1,
+  // },
+  {
+    name: TaskTypes.x,
+    header: 'Follow Hinkal on X and tell your friends about it',
+    description: 'Follow @hinkal_protocol on X, and make a tweet about you using Hinkal',
+    points: 100,
+    category: TaskCategory.Welcome,
+    progressMax: 1,
+  },
+  {
+    name: TaskTypes.discord,
+    header: "Connect Discord and Join Hinkal's server",
+    description: 'Link your Discord account and join our community server',
+    points: 100,
+    category: TaskCategory.Welcome,
+    progressMax: 1,
+  },
+  {
+    name: TaskTypes.telegram,
+    header: "Connect Telegram and Join Hinkal's channel",
+    description: 'Link your Telegram account and join our official channel',
+    points: 100,
+    category: TaskCategory.Welcome,
+    progressMax: 1,
+  },
+  {
+    name: TaskTypes.firstSwap,
+    header: 'Do your first swap',
+    description: 'Complete your first token swap on Hinkal',
+    points: 100,
+    category: TaskCategory.Welcome,
+    progressMax: 1,
+  },
+];
+
+export const BROTHERHOOD_TASKS: Task[] = [
+  {
+    name: TaskTypes.swaps,
+    header: 'Swaps',
+    description: 'Reach a total of 500 swaps',
+    points: 30000,
+    category: TaskCategory.Brotherhood,
+    progressMax: 500,
+  },
+  // removed temporarily
+  // {
+  //   name: TaskTypes.members,
+  //   header: 'Members',
+  //   description: 'Reach a total of 50 members',
+  //   points: 30000,
+  //   category: TaskCategory.Brotherhood,
+  //   progressMax: 50,
+  // },
+  {
+    name: TaskTypes.quests,
+    header: 'Quests',
+    description: 'Finish a total of 50 quests',
+    points: 30000,
+    category: TaskCategory.Brotherhood,
+    progressMax: 50,
+  },
+  {
+    name: TaskTypes.referrals,
+    header: 'Referrals',
+    description: 'Get 25 new referrals',
+    points: 30000,
+    category: TaskCategory.Brotherhood,
+    progressMax: 25,
+  },
+  {
+    name: TaskTypes.dApps,
+    header: 'dApps',
+    description: 'Transact on 50 unique dApps',
+    points: 30000,
+    category: TaskCategory.Brotherhood,
+    progressMax: 50,
+  },
+  {
+    name: TaskTypes.chains,
+    header: 'Chains',
+    description: 'Do at least 1 swap on all chains',
+    points: 10000,
+    category: TaskCategory.Brotherhood,
+    progressMax: 5,
+  },
+];
+
+export const DAILY_TASKS: Task[] = [
+  {
+    name: TaskTypes.dailySwap,
+    header: 'Daily swap',
+    description: 'Swap any tokens on any chain once',
+    points: 100,
+    category: TaskCategory.Daily,
+    progressMax: 1,
+  },
+  {
+    name: TaskTypes.dailyDappTx,
+    header: 'dApp transactions',
+    description: 'Connect and do a transaction on any dApp',
+    points: 100,
+    category: TaskCategory.Daily,
+    progressMax: 1,
+  },
+  {
+    name: TaskTypes.xReferral,
+    header: 'Friends, friends, friends!',
+    description: 'Share your referral code on X',
+    points: 100,
+    category: TaskCategory.Daily,
+    progressMax: 1,
+  },
+];
+
+export const POINTS_BOOST_TASKS: Task[] = [
+  {
+    name: TaskTypes.createOrJoinBH,
+    header: 'Create or join a brotherhood',
+    description: 'Go to the brotherhoods and create or join one',
+    points: 1500,
+    category: TaskCategory.PointsBoost,
+    progressMax: 1,
+  },
+  {
+    name: TaskTypes.shieldUnshield,
+    header: 'Public account aficionado',
+    description: 'Shield and Unshield any tokens once',
+    points: 1500,
+    category: TaskCategory.PointsBoost,
+    progressMax: 1,
+  },
+  {
+    name: TaskTypes.moneyComes,
+    header: 'Here comes the money',
+    description: 'Do swap volume of $100 total with any token',
+    points: 1500,
+    category: TaskCategory.PointsBoost,
+    progressMax: 100,
+  },
+];
+
+export const REWARDS_TASKS: Task[] = [...WELCOME_TASKS, ...BROTHERHOOD_TASKS, ...DAILY_TASKS, ...POINTS_BOOST_TASKS];
+
+export const ACHIEVEMENTS: Achievement[] = [
+  {
+    name: TaskTypes.achievementDapps,
+    header: 'dApps',
+    description: 'Transact on a total of',
+    tiers: [
+      { tier: AchievementTiers.None, progressMax: 0, points: 0 },
+      { tier: AchievementTiers.Bronze, progressMax: 10, points: 10000 },
+      { tier: AchievementTiers.Silver, progressMax: 25, points: 25000 },
+      { tier: AchievementTiers.Gold, progressMax: 50, points: 50000 },
+      { tier: AchievementTiers.Diamond, progressMax: 100, points: 100000 },
+    ],
+  },
+  {
+    name: TaskTypes.achievementSwaps,
+    header: 'Swap',
+    description: 'Swap a total volume of',
+    tiers: [
+      { tier: AchievementTiers.None, progressMax: 0, points: 0 },
+      { tier: AchievementTiers.Bronze, progressMax: 1000, points: 5000 },
+      { tier: AchievementTiers.Silver, progressMax: 10000, points: 50000 },
+      { tier: AchievementTiers.Gold, progressMax: 100000, points: 500000 },
+      { tier: AchievementTiers.Diamond, progressMax: 250000, points: 1000000 },
+    ],
+  },
+  {
+    name: TaskTypes.achievementReferrals,
+    header: 'Referrals',
+    description: 'Refer a total of',
+    tiers: [
+      { tier: AchievementTiers.None, progressMax: 0, points: 0 },
+      { tier: AchievementTiers.Bronze, progressMax: 10, points: 10000 },
+      { tier: AchievementTiers.Silver, progressMax: 25, points: 25000 },
+      { tier: AchievementTiers.Gold, progressMax: 50, points: 50000 },
+      { tier: AchievementTiers.Diamond, progressMax: 100, points: 100000 },
+    ],
+  },
+  {
+    name: TaskTypes.achievementChains,
+    header: 'Chains',
+    description: 'Do at least 1 swap on all supported chains',
+    tiers: [
+      { tier: AchievementTiers.None, progressMax: 0, points: 0 },
+      {
+        tier: AchievementTiers.Diamond,
+        progressMax: 5,
+        points: 10000,
+      },
+    ],
+  },
+];

package/src/constants/token-data/ERC20Registry.ts

@@ -0,0 +1,90 @@
+import arbMainnetRegistry from './arbMainnetRegistry.json';
+import arbMainnetRegistryFixed from './arbMainnetRegistryFixed.json';
+import avalancheRegistry from './avalancheRegistry.json';
+import avalancheRegistryFixed from './avalancheRegistryFixed.json';
+import bnbMainnetRegistry from './bnbMainnetRegistry.json';
+import bnbMainnetRegistryFixed from './bnbMainnetRegistryFixed.json';
+import ethMainnetRegistry from './ethMainnetRegistry.json';
+import ethMainnetRegistryFixed from './ethMainnetRegistryFixed.json';
+import localhostRegistry from './localhostRegistry.json';
+import optimismRegistry from './optimismRegistry.json';
+import optimismRegistryFixed from './optimismRegistryFixed.json';
+import baseRegistry from './baseRegistry.json';
+import baseRegistryFixed from './baseRegistryFixed.json';
+import polygonRegistry from './polygonRegistry.json';
+import polygonRegistryFixed from './polygonRegistryFixed.json';
+import arcTestnetRegistry from './arcTestnetRegistry.json';
+import { ERC20Token } from '../../types/token.types';
+import { chainIds } from '../chains.constants';
+
+export const getERC20Registry = (chainId: number): ERC20Token[] => {
+  const result = localhostRegistry.networkRegistry.slice(0, 10);
+
+  switch (chainId) {
+    case chainIds.polygon:
+      return polygonRegistry.networkRegistry;
+
+    case chainIds.arbMainnet:
+      return arbMainnetRegistry.networkRegistry;
+
+    case chainIds.ethMainnet:
+      return ethMainnetRegistry.networkRegistry;
+
+    case chainIds.bnbMainnet:
+      return bnbMainnetRegistry.networkRegistry;
+
+    case chainIds.avalanche:
+      return avalancheRegistry.networkRegistry;
+
+    case chainIds.optimism:
+      return optimismRegistry.networkRegistry;
+
+    case chainIds.base:
+      return baseRegistry.networkRegistry;
+
+    case chainIds.arcTestnet:
+      return arcTestnetRegistry.networkRegistry;
+
+    default:
+      return result;
+  }
+};
+
+export const getFixedRegistry = (chainId: number): ERC20Token[] => {
+  let registryFixed;
+  switch (chainId) {
+    case chainIds.polygon: {
+      registryFixed = polygonRegistryFixed;
+      break;
+    }
+    case chainIds.arbMainnet: {
+      registryFixed = arbMainnetRegistryFixed;
+      break;
+    }
+    case chainIds.ethMainnet: {
+      registryFixed = ethMainnetRegistryFixed;
+      break;
+    }
+    case chainIds.avalanche: {
+      registryFixed = avalancheRegistryFixed;
+      break;
+    }
+    case chainIds.bnbMainnet: {
+      registryFixed = bnbMainnetRegistryFixed;
+      break;
+    }
+    case chainIds.optimism: {
+      registryFixed = optimismRegistryFixed;
+      break;
+    }
+    case chainIds.base: {
+      registryFixed = baseRegistryFixed;
+      break;
+    }
+    default: {
+      registryFixed = ethMainnetRegistryFixed;
+      break;
+    }
+  }
+  return registryFixed.networkRegistry;
+};