@gurge/sdk 0.3.5 → 0.3.8

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

@@ -0,0 +1,153 @@
+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;
+    telegram?: SocialConnection;
+}
+export declare 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 declare 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 declare enum TaskTypes {
+    discord = "discord",
+    telegram = "telegram",
+    reclaim = "reclaim",
+    firstSwap = "firstSwap",
+    members = "members",
+    quests = "quests",
+    swaps = "swaps",
+    referrals = "referrals",
+    dApps = "dApps",
+    chains = "chains",
+    dailySwap = "dailySwap",
+    dailyDappTx = "dailyDappTx",
+    achievementSwaps = "achievementSwaps",
+    achievementReferrals = "achievementReferrals",
+    achievementDapps = "achievementDapps",
+    achievementChains = "achievementChains",
+    achievementPrivateSends = "achievementPrivateSends",
+    createOrJoinBH = "createOrJoinBH",
+    shieldUnshield = "shieldUnshield",
+    moneyComes = "moneyComes",
+    referralPrivateSendBonus = "referralPrivateSendBonus"
+}
+export declare 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 RewardsUserInfo {
+    ethereumAddress: string;
+    username: string;
+    migratedSeasonOnePoints: number;
+    spentPoints: number;
+    lastTvl: number;
+    profileImage?: string;
+    lastVerify?: string;
+    socialsConnections?: SocialsConnections;
+    swappedChains: number[];
+    interactedDApps: string[];
+    shieldHappened: boolean;
+    unshieldHappened: boolean;
+    pointsToShowInCongratsPopup: number;
+    accessCode?: string;
+    accessCodeMultiplierExpiresAt?: Date | string;
+}
+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;
+}
+export {};

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

@@ -0,0 +1,9 @@
+export declare enum MessagesFromOffscreen {
+    EmitPassword = "EmitPassword",
+    RefreshPublicBalance = "RefreshPublicBalance",
+    RefreshSessions = "RefreshSessions",
+    ChangeNetwork = "ChangeNetwork",
+    UpdateLocationHash = "UpdateLocationHash",
+    AutoShieldTxStatus = "AutoShieldTxStatus",
+    RefreshActivity = "RefreshActivity"
+}

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

@@ -0,0 +1,57 @@
+export interface OKXQuote {
+    amount: string;
+    chainIndex: string;
+    fromTokenAddress: string;
+    toTokenAddress: string;
+    userWalletAddress: string;
+    slippagePercent: string;
+    directRoute: boolean;
+}
+interface OKXSwapResponseToken {
+    decimal: string;
+    isHoneyPot: boolean;
+    taxRate: string;
+    tokenContractAddress: string;
+    tokenSymbol: string;
+    tokenUnitPrice: string;
+}
+interface OKXSwapResponseRouterResult {
+    chainIndex: '501';
+    contextSlot: number;
+    dexRouterList: unknown;
+    fromToken: OKXSwapResponseToken;
+    fromTokenAmount: string;
+    priceImpactPercent: string;
+    router: string;
+    swapMode: string;
+    toToken: OKXSwapResponseToken;
+    toTokenAmount: string;
+    tradeFee: string;
+}
+export interface OKXAccount {
+    isSigner: boolean;
+    isWritable: boolean;
+    pubkey: string;
+}
+export interface OKXSwapResponseInstruction {
+    data: string;
+    accounts: OKXAccount[];
+    programId: string;
+}
+export interface OKXSwapResponseData {
+    addressLookupTableAccount: string[];
+    instructionLists: OKXSwapResponseInstruction[];
+    routerResult: OKXSwapResponseRouterResult;
+    tx: {
+        from: string;
+        minReceiveAmount: string;
+        slippagePercent: string;
+        to: string;
+    };
+}
+export interface OKXSwapResponse {
+    code: string;
+    data: OKXSwapResponseData;
+    msg: string;
+}
+export {};

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

@@ -0,0 +1,58 @@
+export declare enum MoonPayCurrencyType {
+    CRYPTO = "crypto",
+    FIAT = "fiat"
+}
+export interface MoonPayCurrencyMetadata {
+    contractAddress: string | null;
+    coinType: string | null;
+    chainId: string | null;
+    networkCode: string;
+}
+export interface MoonPaySupportedCurrency {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    type: MoonPayCurrencyType;
+    name: string;
+    code: string;
+    precision: number;
+    decimals: number;
+    icon: string;
+    maxAmount: number | null;
+    minAmount: number | null;
+    minBuyAmount: number | null;
+    maxBuyAmount: number | null;
+    minSellAmount: number | null;
+    maxSellAmount: number | null;
+    isSellSupported: boolean;
+    isUtxoCompatible: boolean;
+    notAllowedUSStates: string[];
+    notAllowedCountries: string[];
+    addressRegex: string;
+    testnetAddressRegex: string;
+    supportsAddressTag: boolean;
+    addressTagRegex: string | null;
+    supportsTestMode: boolean;
+    supportsLiveMode: boolean;
+    isSuspended: boolean;
+    isStableCoin: boolean;
+    isSwapBaseSupported: boolean;
+    isSwapQuoteSupported: boolean;
+    isBaseAsset: boolean;
+    isSupportedInUS: boolean;
+    metadata: MoonPayCurrencyMetadata;
+}
+export interface MoonPayQuote {
+    id: string;
+    baseCurrencyAmount: number;
+    baseCurrencyCode: string;
+    quoteCurrencyAmount: number;
+    quoteCurrencyCode: string;
+    totalFeesAmount: number;
+    totalFeesCurrencyCode: string;
+    paymentMethod: string;
+    createdAt: string;
+    expiresAt: string;
+    totalAmount: number;
+    quoteCurrencyPrice: number;
+}

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

@@ -0,0 +1,32 @@
+import { ERC20Token } from './token.types';
+export declare enum PayActivityStatus {
+    SUCCESSFUL = "SUCCESSFUL",
+    FAILED = "FAILED"
+}
+export declare enum PayActivityTypes {
+    PAID_PRIVATELY = "Paid Privately",
+    WITHDRAWN_TO_PUBLIC = "Withdrawn to Public",
+    PRIVATE_SEND = "Private Send"
+}
+export declare enum TransferVisibility {
+    CONFIDENTIAL = "CONFIDENTIAL",
+    PUBLIC = "PUBLIC"
+}
+export interface PayActivityAddRequest {
+    activityType: PayActivityTypes;
+    status: PayActivityStatus;
+    to: string;
+    from: string;
+    amount: string;
+    amountInDollar: string;
+    token: ERC20Token;
+    sentFrom: TransferVisibility;
+    sentTo: TransferVisibility;
+    txHash: string;
+}
+export interface PayActivity extends PayActivityAddRequest {
+    timestamp: Date;
+}
+export interface PayActivityClient extends PayActivityAddRequest {
+    timestamp: string;
+}

package/common/src/types/pay-routing.types.d.ts

@@ -0,0 +1,9 @@
+export interface RecipientRequest {
+    recipientAddress: string;
+    amount: bigint;
+}
+export interface RecipientRoutingResult {
+    directRecipients: RecipientRequest[];
+    directRecipientInfos: string[];
+    fallbackRecipients: RecipientRequest[];
+}

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

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

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

@@ -0,0 +1,19 @@
+export type SubAccount = {
+    index: number | null;
+    ethAddress?: string;
+    solanaAddress?: string;
+    name: string;
+    createdAt: string;
+    isHidden: boolean;
+    isFavorite: boolean;
+    iconIndex: number;
+    privateKey?: string;
+    solanaPrivateKey?: string;
+    isImported: boolean;
+};
+export type SubAccountLight = Omit<SubAccount, 'privateKey' | 'solanaPrivateKey' | 'isImported' | 'iconIndex'>;
+export type TemporarySubAccount = {
+    index: number;
+    ethAddress: string;
+    privateKey: string;
+};

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

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

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

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

@@ -0,0 +1,34 @@
+export declare enum OldPointType {
+    CertificationPoints = "CertificationPoints",
+    TradePoints = "TradePoints",
+    LPPoints = "LPPoints",
+    ReferralPoints = "ReferralPoints",
+    GalxePoints = "GalxePoints",
+    ZealyPoints = "ZealyPoints",
+    TaskOnPoints = "TaskOnPoints",
+    BonusPoints = "BonusPoints"
+}
+export declare 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;
+    address: string;
+    chainId: number;
+}

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

@@ -0,0 +1,7 @@
+export declare enum ScheduleDelayOption {
+    INSTANTLY = "Instantly",
+    FIFTEEN_MINUTES = "15m",
+    THIRTY_MINUTES = "30m",
+    ONE_HOUR = "1hr",
+    TWENTY_FOUR_HOURS = "24hrs"
+}

package/common/src/types/scheduled-transactions.types.d.ts

@@ -0,0 +1,49 @@
+import { Utxo } from '../data-structures/utxo/Utxo';
+export declare enum ScheduledTransactionStatus {
+    PENDING = "pending",
+    PROCESSING = "processing",
+    WAITING_FOR_RELAYER = "waiting_for_relayer",
+    COMPLETED = "completed",
+    FAILED = "failed"
+}
+export declare enum DepositAndWithdrawPhase {
+    BEFORE_DEPOSIT = "before_deposit",
+    AFTER_DEPOSIT = "after_deposit",
+    BEFORE_SCHEDULE_WITHDRAW = "before_schedule_withdraw",
+    AFTER_SCHEDULE_WITHDRAW = "after_schedule_withdraw"
+}
+export interface ScheduledTransactionItemStatus {
+    status: ScheduledTransactionStatus;
+    scheduledTime: string;
+    txHash: string | null;
+}
+export interface ScheduledTransactionResponseItem {
+    chainId: number;
+    status: ScheduledTransactionStatus;
+    scheduledTime: string;
+    erc20TokenAddresses: string[];
+    amount: string;
+    createdAt: string;
+    externalAddress: string;
+    transactionHash?: string;
+}
+export interface RecipientUtxo {
+    recipientAddress: string;
+    utxo: Utxo;
+}
+export interface ClaimableUtxo {
+    chainId: number;
+    senderAddress: string;
+    utxo: Utxo;
+    claimableSignature?: string;
+}
+export interface PendingEnclaveUtxo extends ClaimableUtxo {
+    recipientAddress: string;
+}
+export interface FallbackRecipientUtxoPlan {
+    recipientIndex: number;
+    recipientAddress: string;
+    shieldedPrivateKey: string;
+    claimableSignature?: string;
+    utxo: Utxo;
+}

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

@@ -0,0 +1,13 @@
+export interface SessionMetadata {
+    name: string;
+    description: string;
+    url: string;
+    icons: string[];
+}
+export interface Session {
+    topic: string;
+    metadata: SessionMetadata;
+    chainId: number;
+    ethereumAddress: string;
+    fromInjectedConnector?: boolean;
+}

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

@@ -0,0 +1,10 @@
+import { ConfirmationRequestType } from './confirmation-request.types';
+import { AppMetaData } from './wc.types';
+export interface SignedMessage {
+    timestamp: string;
+    chainId: number;
+    messageText: string;
+    messageType: ConfirmationRequestType.PERSONAL_SIGN | ConfirmationRequestType.SIGN_TYPE_V4;
+    subAccountAddress: string;
+    appMetaData: AppMetaData;
+}

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

@@ -0,0 +1,3 @@
+export declare enum SlippageType {
+    Swap = "Swap"
+}

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

@@ -0,0 +1,40 @@
+interface ZkBaseInputType {
+    rootHashHinkal: bigint | undefined;
+    shieldedPrivateKey: string;
+    inAmounts: string[];
+    inBlindings: string[];
+    inNullifiers: string[];
+    inCommitmentSiblings: string[][];
+    inCommitmentSiblingSides: string[][];
+    outCommitments: string[];
+    rootHashAccessToken: bigint | undefined;
+    accessTokenSiblings: string[];
+    accessTokenSiblingSides: string[];
+    relayFee: bigint;
+    relay: string;
+}
+export interface ZkInputType extends ZkBaseInputType {
+    publicAmount: bigint;
+    recipientAddress: string;
+    erc20TokenAddress: string;
+    outAmounts: string[];
+    outShieldedPublicKey: string[];
+    outBlindings: string[];
+}
+export interface ZkExternalInputType extends ZkBaseInputType {
+    inSwapAmount: bigint;
+    inErc20TokenAddress: string;
+    outAmount: bigint;
+    outBlinding: bigint;
+    outSwapAmount: bigint;
+    outErc20TokenAddress: string;
+    outSwapBlinding: bigint;
+    externalActionId: bigint;
+    externalActionMetadataHash: bigint;
+}
+export interface ZkResultType {
+    proof: string;
+    publicSignals: string[];
+}
+export type NewZkCallDataType = [[string, string], [[string, string], [string, string]], [string, string], string[]];
+export {};

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

@@ -0,0 +1,87 @@
+import { PublicKey, Transaction, VersionedTransaction } from '@solana/web3.js';
+import { CommitmentValidationDataType, DimDataType } from './circom-data.types';
+import { OKXAccount } from './okx.types';
+import { Adapter } from '@solana/wallet-adapter-base';
+import { AdminDataType } from './admin.types';
+export interface SolanaEvent {
+    signature: string;
+    slot: number;
+    blockTime: number;
+    programId: PublicKey;
+    data: any;
+    eventName: string;
+}
+export type SolanaWallet = {
+    publicKey: PublicKey;
+    signTransaction<T extends Transaction | VersionedTransaction>(tx: T): Promise<T>;
+    signAllTransactions<T extends Transaction | VersionedTransaction>(txs: T[]): Promise<T[]>;
+    signMessage: (message: Uint8Array, display?: string) => Promise<{
+        signature: Uint8Array;
+        publicKey: PublicKey;
+    }>;
+    adapter?: Adapter;
+    isLedger?: boolean;
+};
+export interface SolanaArgs {
+    proofAArr: number[];
+    proofBArr: number[];
+    proofCArr: number[];
+    publicInputsArr: number[][];
+    encryptedOutputs: number[][];
+    relayerFee: string;
+    variableRate?: string | null;
+    dimensions: DimDataType;
+}
+export type SolanaTransactArgs = SolanaArgs;
+export interface SolanaSwapArgs extends SolanaArgs {
+    hinkalInstructions: Array<{
+        accountIndexes: number[];
+        data: number[];
+        programIndex: number;
+    }>;
+}
+export interface SolanaAccounts {
+    recipient: string;
+}
+export interface SolanaTransactAccounts extends SolanaAccounts {
+    mint?: string;
+}
+export interface SolanaSwapAccounts extends SolanaAccounts {
+    storageAccount: string;
+    storageVault: string;
+    swapperAccount: string;
+    mintFrom: string | null;
+    mintTo: string | null;
+    remainingAccounts: OKXAccount[];
+    addressLookupTableAccount: string[];
+}
+export interface SolanaTransactBody {
+    relayAddress: string;
+    functionName: 'transact' | 'transfer';
+    args: SolanaTransactArgs;
+    accounts: SolanaTransactAccounts;
+}
+export interface SolanaSwapBody {
+    relayAddress: string;
+    functionName: 'swap';
+    args: SolanaSwapArgs;
+    accounts: SolanaSwapAccounts;
+}
+export type SolanaTransactionBody = (SolanaTransactBody | SolanaSwapBody) & {
+    chainId: number;
+    commitmentValidationData?: CommitmentValidationDataType;
+    recipientAmount?: string;
+    adminData?: AdminDataType;
+    displayRecipient?: string;
+};
+export interface SolanaTransactionParams {
+    mintFrom?: string;
+    mintTo?: string;
+    recipient?: string;
+    nullifierCount?: number;
+}
+export interface SolanaAccountKeys {
+    storageAccount: string;
+    swapperAccount: string;
+    relayerPublicKey: string;
+}