@gurge/sdk 0.3.4 → 0.3.7

package/common/src/types/WeeklyAnalytics.types.d.ts

@@ -0,0 +1,37 @@
+import { MemberStatus, Rank } from './RewardUserEnums';
+import { AllPoints } from './all-points.types';
+import { AchievementProgressItem } from './new-rewards.type';
+export interface WeeklyAnalyticBase extends AllPoints {
+    weekStart: Date;
+}
+export interface BrotherhoodUserWeeklyAnalytic extends WeeklyAnalyticBase {
+    ethereumAddress: string;
+    brotherhoodId: number;
+}
+export interface BrotherhoodUserWeeklyAnalyticLeaderboardEntry extends BrotherhoodUserWeeklyAnalytic {
+    profileImage?: string;
+    username?: string;
+    memberStatus?: MemberStatus;
+}
+export interface BrotherhoodWeeklyAnalytic extends WeeklyAnalyticBase {
+    brotherhoodId: number;
+    multiplier: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface BrotherhoodWeeklyAnalyticLeaderboardEntry extends BrotherhoodWeeklyAnalytic {
+    profileImage: string;
+    name: string;
+}
+export interface UserWeeklyAnalytic extends WeeklyAnalyticBase {
+    ethereumAddress: string;
+    rank: Rank;
+    multiplier: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface UserWeeklyAnalyticLeaderboardEntry extends UserWeeklyAnalytic {
+    profileImage?: string;
+    username: string;
+    achievementsProgress: AchievementProgressItem[];
+}

package/common/src/types/activities.types.d.ts

@@ -0,0 +1,77 @@
+import { IntegrationProvider } from './hinkal.types';
+import { ERC20Token } from './token.types';
+export declare enum ActivityStatus {
+    PENDING = "PENDING",
+    SUCCESSFUL = "SUCCESSFUL",
+    FAILED = "FAILED"
+}
+export declare enum ActivityTypes {
+    SHIELD = "Shield",
+    SWAP = "Swap",
+    BRIDGE = "Bridge",
+    SEND = "Send",
+    DAPP_INTERACTION = "dApp interaction",
+    DAPP_INTERACTION_APPROVAL = "dApp interaction approval",
+    RECIEVE = "Receive",
+    UNSHIELD = "Unshield",
+    ONBOARDING_DEPOSIT = "Onboarding deposit",
+    REVOKE = "Revoke",
+    AUTO_SHIELD = "Auto Shield",
+    UNKNOWN = "Unknown transaction"
+}
+export declare enum TokenChangeType {
+    SPEND = "SPEND",
+    RECEIVE = "RECEIVE",
+    APPROVE = "APPROVE"
+}
+export type TokenAmountInfo = {
+    token: ERC20Token;
+    amount: string;
+    nftIds?: string[];
+    usdValue?: string;
+};
+export declare const DexProviders: IntegrationProvider[];
+export declare const IntegrationProviderNames: {
+    1: string;
+    2: string;
+    3: string;
+    4: string;
+    5: string;
+    6: string;
+    7: string;
+};
+export type ActivityRightSideData = {
+    rightTop?: React.ReactNode;
+    rightTopClassName?: string;
+    rightBottom?: React.ReactNode;
+    rightBottomClassName?: string;
+};
+export interface ActivityAddRequest {
+    activityType: ActivityTypes;
+    chainId: number;
+    from: string;
+    to: string;
+    status?: ActivityStatus;
+    txHash?: string;
+    gasInDollar?: string;
+    extraNativeTokenFee?: string;
+    tokensReceive?: TokenAmountInfo[];
+    tokensSpend?: TokenAmountInfo[];
+    tokensApprove?: TokenAmountInfo[];
+    activityIcon?: string;
+    dappUrl?: string;
+    dappName?: string;
+    integrationProvider?: IntegrationProvider;
+    knownPartialSignature?: string;
+}
+export interface Activity extends ActivityAddRequest {
+    id: string;
+    timestamp: Date;
+    status: ActivityStatus;
+}
+export type MinimalActivity = Pick<Activity, 'timestamp' | 'status' | 'activityType' | 'tokensReceive' | 'tokensSpend' | 'chainId'>;
+export interface TimeLeft {
+    value: number;
+    unit: string;
+    expired: boolean;
+}

package/common/src/types/admin.types.d.ts

@@ -0,0 +1,42 @@
+export interface SwapPair {
+    tokenIn: {
+        symbol: string;
+        address: string;
+    };
+    tokenOut: {
+        symbol: string;
+        address: string;
+    };
+}
+export interface AdminDataType {
+    hashedOwner: string;
+    chainId: number;
+    timestamp: number;
+    action: AdminTransactionType;
+    erc20TokenAddresses: string[];
+    erc20TokenAmount: string[];
+    swapPair?: SwapPair;
+}
+export interface AdminInterface extends AdminDataType {
+    erc20TokenPrices: string[];
+}
+export declare enum AdminTransactionType {
+    PrivateToPrivateSend = "private_to_private_send",
+    ProxyToPrivateSend = "proxy_to_private_send",
+    PrivateToPublicSend = "private_to_public_send",
+    PublicToPublicSend = "public_to_public_send",
+    PublicToPublicBridgeSend = "public_to_public_bridge_send",
+    PrivateSwap = "private_swap",
+    PublicSwap = "public_swap",
+    PublicBridgeSwap = "public_bridge_swap",
+    Unshield = "unshield",
+    Shield = "shield",
+    AutoShield = "auto_shield",
+    PaymentLink = "payment_link",
+    PublicDappTransaction = "public_dapp_transaction",
+    PayPrivateToPublicSend = "pay_private_to_public_send",
+    PayPrivateToPrivateSend = "pay_private_to_private_send",
+    PayPublicToPublicSend = "pay_public_to_public_send",
+    PayPublicToPrivateSend = "pay_public_to_private_send",
+    PayPublicToPublicBridgeSend = "pay_public_to_public_bridge_send"
+}

package/common/src/types/all-points.types.d.ts

@@ -0,0 +1,7 @@
+export interface AllPoints {
+    aumPoints: number;
+    tradingPoints: number;
+    referralPoints: number;
+    questPoints: number;
+    totalPoints: number;
+}

package/common/src/types/approvals.types.d.ts

@@ -0,0 +1,41 @@
+import { ERC20Token } from './token.types';
+export interface AlchemyBatchRequest {
+    jsonrpc: '2.0';
+    id: number;
+    method: string;
+    params: any[];
+}
+export interface AlchemyBatchResponse {
+    jsonrpc: '2.0';
+    id: number;
+    result: string;
+    error?: {
+        code: number;
+        message: string;
+    };
+}
+export interface TokenApproval {
+    token: ERC20Token;
+    spenderAddress: string;
+    allowance: bigint;
+    tokenId?: string;
+}
+export interface ApprovalPair {
+    contractAddress: string;
+    spenderAddress: string;
+    tokenIds?: Set<string>;
+}
+export interface ApprovalsBySpender {
+    spenderAddress: string;
+    approvedAssets: TokenApproval[];
+}
+export declare enum RevokeType {
+    ERC20 = "ERC20",
+    tokenId = "tokenId",
+    approvedForAll = "approvedForAll"
+}
+export interface ApprovalRequestMetadata {
+    pairIndex: number;
+    type: RevokeType;
+    tokenId?: string;
+}

package/common/src/types/balances.types.d.ts

@@ -0,0 +1,39 @@
+import { UserKeys } from '../data-structures/crypto-keys/keys';
+import { TokenBalanceWithUsdValue } from './token.types';
+export type PrivateBalancesState = Record<number, TokenBalanceWithUsdValue[] | undefined>;
+export type PrivateBalancesAction = {
+    type: 'SET_BALANCES';
+    chainId: number;
+    balances: TokenBalanceWithUsdValue[] | undefined;
+} | {
+    type: 'SET_USD_BALANCES';
+    chainId: number;
+    balances: TokenBalanceWithUsdValue[] | undefined;
+} | {
+    type: 'CLEAR_BALANCES';
+    chainId?: number;
+} | {
+    type: 'SET_LOADING';
+    chainId: number;
+    newValue: boolean;
+} | {
+    type: 'SET_USD_LOADING';
+    chainId: number;
+    newValue: boolean;
+};
+export declare enum PrivateBalanceUpdateType {
+    OnlyCache = "ONLY_CACHE",
+    Fresh = "FRESH",
+    FreshWithoutLoader = "FRESH_WITHOUT_LOADER"
+}
+export interface BalanceChangeState {
+    ethereumAddress?: string;
+    userKeys?: UserKeys;
+}
+export type PrivateBalanceUpdateEventType = {
+    updateType?: PrivateBalanceUpdateType;
+    resetCacheBefore?: boolean;
+    chainIdToUpdate?: number;
+    balanceChangeState?: BalanceChangeState;
+    updateTokensListBefore?: boolean;
+};

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

@@ -0,0 +1,3 @@
+export type BigIntable = string | number | boolean | bigint | {
+    toBigInt: () => bigint;
+};

package/common/src/types/bridging-tx.types.d.ts

@@ -0,0 +1,17 @@
+import { Utxo } from '../data-structures/utxo/Utxo';
+import { TemporarySubAccount } from './proxy.types';
+export interface BridgeQuote {
+    calldata: string;
+    expectedAmount: bigint;
+    nativeFee: bigint;
+}
+export interface BridgeRecipient {
+    recipientAddress: string;
+    bridgeAmount: bigint;
+    quote: BridgeQuote;
+    temporarySubAccount: TemporarySubAccount;
+}
+export interface BridgeRecipientUtxo extends BridgeRecipient {
+    utxo: Utxo;
+    nativeUtxo?: Utxo;
+}

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

@@ -0,0 +1,11 @@
+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/common/src/types/cache.types.d.ts

@@ -0,0 +1,58 @@
+export declare 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",
+    LAST_ADDRESS = "lastAddress",
+    AUTO_LOCK_TIME = "autoLockTime",
+    TOKEN_REGISTRY = "tokenRegistry",
+    IS_BALANCE_HIDDEN = "isBalanceHidden",
+    TRANSACTION_STATUS = "transactionStatus",
+    SELECTED_SUB_ACCOUNT_ADDRESS = "selectedSubAccountAddress",
+    GENERATE_PROOF_REMOTELY = "generateProofRemotely",
+    IS_RELAYER_OFF = "isRelayerOff",
+    ONBOARDING_SHOWN = "onboardingShown",
+    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_SOLANA_ADDRESS = "connectedSolanaAddress",
+    CONNECTED_SESSIONS = "connectedSessions",
+    TX_ACTIVITY = "tx-activity",
+    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",
+    PENDING_SOLANA_SIGNATURES = "pendingSolanaSignatures",
+    ONBOARDING_TEMPORARY_PASSWORD = "onboardingTemporaryPassword",
+    STORAGE_KEY_LAST_SEEN_VERSION = "hinkalLastSeenVersion",
+    HINKAL_GOOGLE_SESSION = "hinkalGoogleSession",
+    IS_CREATE_NEW_PUBLIC_WALLET_ON = "isCreateNewPublicWalletOn",
+    DISGUISED_AS_METAMASK_HOSTS = "disguisedAsMetamaskHosts",
+    CHAIN_ID_FILTER = "chainIdFilter",
+    SIGNATURE = "signature",
+    PUBLIC_ACCOUNT_DETAILS = "publicAccountDetails",
+    IS_NEW_ACCOUNT_MANAGEMENT_SYSTEM = "isNewAccountManagementSystem",
+    SUB_ACCOUNTS_REFRESH_TOKEN = "subAccountsRefreshToken",
+    PRIVATE_SEND_NONCE = "privateSendNonce",
+    PRIVATE_SEND_PENDING_ENCLAVE_UTXOS = "privateSendPendingEnclaveUtxos",
+    SHOULD_SHOW_ANNOUNCEMENT_BANNER = "shouldShowAnnouncementBanner",
+    LAST_SHIELD_TIME = "lastShieldTime",
+    IS_TOUR_COMPLETED = "isTourCompleted",
+    TOUR_CURRENT_STEP = "tourCurrentStep",
+    REVOKE_APPROVALS_IN_PROGRESS = "revokeApprovalsInProgress"
+}

package/common/src/types/chains.types.d.ts

@@ -0,0 +1,11 @@
+export declare enum NetworkFilterType {
+    Wallet = "wallet",
+    Pay = "pay",
+    Dashboard = "dashboard",
+    Bridge = "bridge"
+}
+export declare enum EthereumNetworkType {
+    Mainnet = "Mainnet",
+    Testnet = "Testnet",
+    Local = "Local"
+}

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

@@ -0,0 +1,107 @@
+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 CircomDataType {
+    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;
+    onChainCreation: boolean[];
+    slippageValues: bigint[];
+    hinkalLogicArgs: HinkalLogicArgs;
+    feeStructure: FeeStructure;
+    signatureData: SignatureData;
+    originalSender: string;
+}
+export interface CircomDataJsonType {
+    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;
+    onChainCreation: boolean[];
+    slippageValues: bigint[] | string[];
+    hinkalLogicArgs: HinkalLogicArgs<bigint | string>;
+    feeStructure: FeeStructure<bigint | string>;
+    signatureData: SignatureData;
+    originalSender: string;
+}
+export interface CommitmentValidationDataType {
+    tokenAddresses: string[];
+    inAmounts: string[][];
+    inTimeStamps: string[][];
+    inRandomizations: string[][];
+    inCommitments: string[][];
+    inNullifiers: string[][];
+    proof: {
+        a: [string, string];
+        b: [[string, string], [string, string]];
+        c: [string, 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 type AnchorStealthAddressStructure = {
+    extraRandomization: number[];
+    stealthAddress: number[];
+    h0: number[];
+    h1: number[];
+};
+export declare const emptyStealthAddressStructure: {
+    extraRandomization: string;
+    stealthAddress: string;
+    H0: string;
+    H1: string;
+};
+export interface TransactParams<CircomType = CircomDataJsonType> {
+    dimensions: DimDataType;
+    circomData: CircomType;
+}
+export declare const defaultHookData: HookDataType;
+export declare const defaultHookDataArray: string[];
+export declare const defaultStealthAddressStructure: StealthAddressStructure;

package/common/src/types/coingecko.types.d.ts

@@ -0,0 +1,220 @@
+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;
+    }[];
+}
+export interface CoinGeckoMarketChartResponse {
+    prices: number[][];
+    market_caps: number[][];
+    total_volumes: number[][];
+}