@gurge/sdk 0.3.5 → 0.3.8

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

@@ -0,0 +1,42 @@
+import { BigIntable } from './big-intable.types';
+export interface EncryptedOutputWithSign<Sign = boolean> {
+    value: string;
+    isPositive: Sign;
+    isBlocked: boolean;
+}
+export interface EncryptedOutputWithCommitment {
+    commitment: string;
+    encryptedOutput: string;
+}
+export interface OutputsWithSignAndLast<Sign = boolean> {
+    additionalEncryptedOutputs: EncryptedOutputWithSign<Sign>[];
+    lastOutput: string;
+}
+export interface CommitmentEvent<BN = BigIntable> {
+    commitment: BN;
+    index: BN;
+    encryptedOutput: string;
+}
+export interface SolanaCommitmentEvent {
+    commitment: number[];
+    index: number[];
+    encrypted_output: number[];
+    on_chain_data: number[][];
+}
+export interface AccessTokenEvent<BN = BigIntable> {
+    accessKey: BN;
+    index: BN;
+    senderAddress: string;
+}
+export interface SolanaAccessTokenEvent<BN, PublicKeyType> {
+    access_key: BN;
+    index: BN;
+    sender_address: PublicKeyType;
+}
+export interface NullifierEvent<T> {
+    nullifier: T;
+}
+export interface RegisterEvent {
+    ethereumAddress: string;
+    shieldedAddressHash: string;
+}

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

@@ -0,0 +1,10 @@
+export declare 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/common/src/types/connector.types.d.ts

@@ -0,0 +1,5 @@
+export type ConnectorInfo = {
+    id: string;
+    icon?: string;
+    isEVM?: boolean;
+};

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

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

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

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

package/common/src/types/dashboard-account.d.ts

@@ -0,0 +1,101 @@
+import { Contact } from './contacts.types';
+export declare enum MemberRole {
+    OWNER = "Owner",
+    MEMBER = "Member"
+}
+export interface InvitedMemberInterface {
+    email: string;
+    username?: string;
+}
+export interface InvitedMember {
+    email: string;
+    invitedAt: Date;
+    username: string;
+}
+export interface AccountMemberInterface {
+    email: string;
+    role: MemberRole;
+    username: string;
+    providerUserId: string;
+    profileImage?: string;
+}
+export interface AccountMember {
+    email: string;
+    role: MemberRole;
+    username: string;
+    providerUserId: string;
+    profileImage?: string;
+    updatedAt: Date;
+    createdAt: Date;
+}
+export interface DashboardAccountInterface {
+    contacts: Contact[];
+    accessToken: string;
+    refreshToken: string;
+    updatedAt: Date;
+    createdAt: Date;
+    organizationName?: string;
+    defaultDeliveryMethod?: DeliveryMethod;
+    defaultNetworkChainId?: number;
+    organizationEmail?: string;
+    organizationImage?: string;
+    ethereumAddress?: string;
+    members?: AccountMember[];
+    invitedMembers?: InvitedMember[];
+    notifications?: {
+        payoutApprovalRequested: boolean;
+        largePayoutAlerts: boolean;
+        balanceLowWarning: boolean;
+    };
+    encryptedEvmBalances?: string;
+    encryptedSolanaBalances?: string;
+    encryptedTronBalances?: string;
+    balancesUpdatedAt?: Date;
+    id: string;
+}
+export interface DashboardDbBalance {
+    balance: string;
+    chainId: number;
+    erc20TokenAddress: string;
+}
+interface DashboardAccountBase {
+    contacts: Contact[];
+    members?: AccountMember[];
+    invitedMembers?: InvitedMember[];
+    organizationName?: string;
+    defaultDeliveryMethod?: DeliveryMethod;
+    defaultNetworkChainId?: number;
+    organizationEmail?: string;
+    organizationImage?: string;
+    ethereumAddress?: string;
+    tronAddress?: string;
+    solanaAddress?: string;
+    notifications?: {
+        payoutApprovalRequested: boolean;
+        largePayoutAlerts: boolean;
+        balanceLowWarning: boolean;
+    };
+    encryptedEvmBalances?: string;
+    encryptedSolanaBalances?: string;
+    encryptedTronBalances?: string;
+    id: string;
+}
+export interface DeserializedEncryptedBalances {
+    privateBalances: DashboardDbBalance[];
+    publicBalances: DashboardDbBalance[];
+}
+export interface DashboardAccount extends DashboardAccountBase {
+    balancesUpdatedAt?: Date;
+    updatedAt: Date;
+    createdAt: Date;
+}
+export interface DashboardAccountClient extends DashboardAccountBase {
+    balancesUpdatedAt?: string;
+    updatedAt: string;
+    createdAt: string;
+}
+export declare enum DeliveryMethod {
+    CONFIDENTIAL = "Confidential Settlement",
+    DIRECT = "Direct to wallet"
+}
+export {};

package/common/src/types/dashboard-payout.types.d.ts

@@ -0,0 +1,29 @@
+export declare enum PayoutType {
+    SINGLE = "Single",
+    BATCH = "Batch"
+}
+export declare enum PayoutStatus {
+    PENDING = "Pending",
+    REJECTED = "Rejected",
+    COMPLETED = "Completed"
+}
+export interface PayoutItem {
+    payoutType: PayoutType;
+    payoutStatus: PayoutStatus;
+    usePrivateBalance: boolean;
+    recipient: string;
+    selectedTokenChainId: number;
+    selectedTokenAddress: string;
+    amount: string;
+    publicTransfer: boolean;
+    destinationChainId?: number;
+}
+export interface DashboardPayout {
+    id: string;
+    dashboardAccountId: string;
+    status: PayoutStatus;
+    payoutItems: PayoutItem[];
+    providerUserId: string;
+    createdAt: string;
+    updatedAt: string;
+}

package/common/src/types/dashboard-transaction.types.d.ts

@@ -0,0 +1,22 @@
+import { PayActivityStatus, PayActivityTypes, TransferVisibility } from './pay-activities.types';
+interface DashboardTransactionBase {
+    hashedDashboardAccountId: string;
+    activityType: PayActivityTypes;
+    amount: string;
+    amountInDollar: string;
+    from: string;
+    to: string;
+    sentFrom: TransferVisibility;
+    sentTo: TransferVisibility;
+    status: PayActivityStatus;
+    chainId: number;
+    erc20TokenAddress: string;
+    txHash: string;
+}
+export interface DashboardTransaction extends DashboardTransactionBase {
+    timestamp?: Date;
+}
+export interface DashboardTransactionClient extends DashboardTransactionBase {
+    timestamp?: string;
+}
+export {};

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

@@ -0,0 +1,33 @@
+type Capability = {
+    [key: string]: unknown;
+    optional?: boolean;
+};
+export 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 declare enum GetCallsStatusCode {
+    Pending = "pending",
+    Confirmed = "confirmed",
+    Failed = "failed",
+    NotFound = "not_found"
+}
+export declare enum CallsStatus {
+    Pending = 100,// Batch has been received but not completed execution onchain
+    Confirmed = 200,// Batch has been included onchain without reverts
+    OffchainFailure = 400,// Batch has not been included onchain and wallet will not retry
+    ChainFailure = 500,// Batch reverted completely onchain
+    PartialFailure = 600
+}
+export {};

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

@@ -0,0 +1,62 @@
+import { InterfaceAbi } from 'ethers';
+import { Idl } from '@coral-xyz/anchor';
+export type ContractMetadata = {
+    abi?: InterfaceAbi;
+    address?: string;
+};
+export declare enum ContractType {
+    HinkalContract = 0,
+    HinkalHelperContract = 1,
+    UniswapV3FactoryContract = 2,
+    UniswapV3PoolContract = 3,
+    UniswapV3QuoterContract = 4,
+    ERC20Contract = 5,
+    ERC721Contract = 6,
+    ERC1155Contract = 7,
+    WATokenContract = 8,
+    OneInchExternalActionContract = 9,
+    MerkleTreeContract = 10,
+    ContractWithNonces = 11,
+    PermitterContract = 12,
+    UniswapV2PoolContract = 13,
+    HinkalWrapper = 14,
+    HinkalWrapper2 = 15,
+    DepositOnChainUtxos = 16
+}
+export interface ContractData {
+    hinkalAddress: string;
+    hinkalABI?: InterfaceAbi;
+    hinkalIdl?: Idl;
+    hinkalHelperAddress?: string;
+    hinkalHelperABI?: InterfaceAbi;
+    permitterAddress?: string;
+    permitterABI?: InterfaceAbi;
+    uniswapExternalActionAddress?: string;
+    odosExternalActionInstanceAddress?: string;
+    oneInchExternalActionInstanceAddress?: string;
+    waTokenABI?: InterfaceAbi;
+    hinkalWrapperAddress?: string;
+    hinkalWrapper2Address?: string;
+    hinkalWrapperABI?: InterfaceAbi;
+    HinkalWrapper2ABI?: InterfaceAbi;
+    emporiumAddress?: string;
+    hinkalWalletAddress?: string;
+    originalDeployer?: string;
+    depositOnChainUtxosExternalActionAddress?: string;
+    depositOnChainUtxosExternalActionABI?: InterfaceAbi;
+}
+export interface EthereumNetwork {
+    name: string;
+    chainId: number;
+    rpcUrl: string;
+    maxPageSize?: number;
+    fetchRpcUrl?: string;
+    wsRpcUrl?: string;
+    contractData: ContractData;
+    supported?: boolean;
+    quoterV2Address?: string;
+    uniswapV3FactoryAddress?: string;
+    pollingInterval?: number;
+    gasStationUrl?: string;
+    priority?: number;
+}

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

@@ -0,0 +1,5 @@
+import { BlockchainEvent } from '../data-structures/BlockchainEvent/BlockchainEvent';
+export type EventProcessorFunction = (events: BlockchainEvent[], scannedToBlock?: number) => Promise<number> | number;
+export declare enum EventCategory {
+    MainContractEvents = "MainContractEvents"
+}

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

@@ -0,0 +1,17 @@
+export declare 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
+    Okx = "Okx",// Note: not an actual external action
+    Emporium = "Emporium",
+    Wallet = "Wallet",
+    DepositOnChainUtxos = "DepositOnChainUtxos",
+    ProofLess = "ProofLess"
+}
+export interface ExternalActionData {
+    externalActionId: 0n | ExternalActionId;
+    externalAddress: string;
+    externalActionMetadata: string;
+}

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

@@ -0,0 +1,13 @@
+import { ERC20Token } from './token.types';
+export interface MinimalFeeInfo {
+    flatFees: bigint[];
+    feeUnit: ERC20Token | undefined;
+}
+export interface FeeInfo extends MinimalFeeInfo {
+    priceOfTransactionInToken: bigint | undefined;
+    priceOfTransactionInUSD: number | undefined;
+}
+export declare enum SolanaPriorityFeeMode {
+    RECOMMENDED = "RECOMMENDED",
+    HIGH = "HIGH"
+}

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

@@ -0,0 +1,14 @@
+export declare enum TradingType {
+    Swap = 0,
+    DApp = 1,
+    Shield = 2,
+    Unshield = 3,
+    PrivateSend = 4
+}
+export declare enum PointsType {
+    Trading = 0,
+    Quests = 1,
+    Aum = 2,
+    Referral = 3,
+    MysteryBox = 4
+}

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

@@ -0,0 +1,102 @@
+/**
+ * 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>;
+    /**
+     * Override which Tron chain this Hinkal instance targets.
+     */
+    tronChainOverride?: number;
+};
+export declare enum EventType {
+    BalanceChange = "BalanceChange",
+    KycNeeded = "KycNeeded",
+    AccountChanged = "AccountChanged",
+    ShowConnect = "ShowConnect",
+    ShowNetworkPopup = "ShowNetworkPopup",
+    MerkleTreeUpdated = "MerkleTreeUpdated",
+    MerkleTreeResetStarted = "MerkleTreeResetStarted",
+    MerkleTreeResetFinished = "MerkleTreeResetFinished"
+}
+export declare enum IntegrationProvider {
+    UNISWAP = 1,
+    ODOS = 2,
+    ONEINCH = 3,
+    LIFI = 4,
+    OKX = 5,
+    ALL = 6,
+    NONE = 7
+}
+export declare enum INTERACTION {
+    WITHDRAW = "WITHDRAW",
+    SWAP = "SWAP",
+    CLAIMING = "CLAIMING",
+    EMPORIUM = "EMPORIUM",
+    NONE = "NONE"
+}
+export declare enum HinkalLogicAction {
+    NONE = 0,// = 0
+    APPROVE = 1,// = 1
+    RELEASE_BUFFER = 2,// = 2
+    EXECUTE = 3
+}
+export interface UseApprovalUTXOData<T = bigint> {
+    approvalChanges: T[];
+    externalApprovalAddresses: string[];
+    conversionInHinkalAddress: T[];
+}
+export type HinkalLogicArgs<T = bigint> = {
+    hinkalLogicAction: HinkalLogicAction;
+    executeApprovalChanges: T[];
+    doPreTxApproval: boolean;
+    inHinkalAddress: T;
+    useApprovalUtxoData: UseApprovalUTXOData<T>[];
+    interactionAddress?: string;
+};
+export declare const defaultHinkalLogicArgs: (count: number) => HinkalLogicArgs<bigint>;
+export type FeeStructure<T = bigint> = {
+    feeToken: string;
+    flatFee: T;
+    variableRate: T;
+};
+export declare const zeroFeeStructure: FeeStructure<bigint>;
+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 declare enum UserProgress {
+    NOT_STARTED = 0,
+    CONNECTED = 1,
+    KYC = 2,
+    COMPLETED = 3
+}
+export declare enum LoginMessageMode {
+    PROTOCOL = "protocol",
+    PRIVATE_TRANSFER = "privateTransfer"
+}

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

@@ -0,0 +1,8 @@
+import { AxiosRequestConfig } from 'axios';
+export interface HttpClient {
+    get<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
+    post<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+    put<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+    patch<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+    delete<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
+}

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

@@ -0,0 +1,61 @@
+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 './snark.types';
+export * from './token.types';
+export * from './slippage.types';
+export * from './transactions.types';
+export * from './rewards.types';
+export * from './admin.types';
+export * from './ICacheDevice';
+export * from './activities.types';
+export * from './wc.types';
+export * from './transaction.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 './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 './confirmation-request.types';
+export * from './signature.types';
+export * from './offscreen.types';
+export * from './solana.types';
+export * from './okx.types';
+export * from './http.types';
+export * from './connector.types';
+export * from './scheduled-transactions.types';
+export * from './bridging-tx.types';
+export * from './near-intents.types';
+export * from './onramp.types';
+export * from './events.types';
+export * from './tron.types';
+export * from './pay-activities.types';
+export * from './schedule.types';
+export * from './dashboard-account';
+export * from './pay-routing.types';
+export * from './contacts.types';
+export * from './dashboard-payout.types';
+export * from './dashboard-transaction.types';
+export * from './chains.types';

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

@@ -0,0 +1,41 @@
+export declare enum VERIFICATION_TYPE {
+    USER = "USER",
+    BUSINESS = "BUSINESS"
+}
+export declare const VerificationTypes: VERIFICATION_TYPE[];
+export declare enum Passports {
+    AiPriseKyc = 0,
+    AiPriseKyb = 1,
+    BABPassport = 2,
+    GalxePassport = 3,
+    ZkMePassport = 4,
+    CoinbasePassport = 5,
+    AuthentoPassport = 6,
+    AuthentoPassportKyb = 7,
+    ReclaimCoinbasePassport = 8,
+    ReclaimBNBPassport = 9,
+    ReclaimOKXPassport = 10,
+    ReclaimGatePassport = 11,
+    ReclaimMexcPassport = 12,
+    ReclaimHtxPassport = 13
+}
+export declare 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"
+}
+export declare 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"
+}
+export interface VerificationData {
+    verificationResult: KycVerificationResult | null;
+    verificationStatus: KycVerificationStatus | null;
+    countryCode: string | null;
+    fullName: string | null;
+    idNumber: string | null;
+}

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

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

package/common/src/types/near-intents.types.d.ts

@@ -0,0 +1,60 @@
+import { TokenBalanceWithUsdValue } from './token.types';
+export type NearIntentsSwapType = 'EXACT_INPUT' | 'EXACT_OUTPUT';
+export type NearIntentsDepositType = 'ORIGIN_CHAIN' | 'INTENTS';
+export type NearIntentsRecipientType = 'DESTINATION_CHAIN' | 'INTENTS';
+export type NearIntentsRefundType = 'ORIGIN_CHAIN' | 'INTENTS';
+export interface NearIntentsQuoteRequest {
+    dry: boolean;
+    swapType: NearIntentsSwapType;
+    slippageTolerance: number;
+    originAsset: string;
+    depositType: NearIntentsDepositType;
+    destinationAsset: string;
+    amount: string;
+    recipient: string;
+    recipientType: NearIntentsRecipientType;
+    refundTo: string;
+    refundType: NearIntentsRefundType;
+    deadline: string;
+}
+export interface NearIntentsQuoteResponse {
+    quote: {
+        depositAddress: string;
+        amountOut: string;
+        deadline?: string;
+        timeWhenInactive?: string;
+    };
+}
+export interface NearIntentsToken {
+    assetId: string;
+    decimals: number;
+    blockchain: string;
+    symbol: string;
+    contractAddress?: string;
+}
+export interface NearBridgeParams {
+    originAsset: string;
+    destinationChainId: number;
+    destinationAsset: string;
+    slippageBps?: number;
+}
+export interface NearIntentsRefundBalance extends TokenBalanceWithUsdValue {
+    assetId: string;
+}
+export interface NearBridgeLeg {
+    destinationRecipient: string;
+    amount: bigint;
+    depositAddress: string;
+    quote: NearIntentsQuoteResponse['quote'];
+}
+export interface NearBridgeResult {
+    depositTxHash: string;
+    legs: NearBridgeLeg[];
+}
+export interface NearBridgeQuoteResult {
+    totalOutputAmount: bigint;
+    outputAmounts: bigint[];
+    isLoading: boolean;
+    error: string;
+    hasRoute: boolean;
+}