@gurge/sdk 0.3.4 → 0.3.7

package/common/src/types/tenderly.api.types.d.ts

@@ -0,0 +1,196 @@
+export interface SendTransacrtionBase {
+    blockOverrides?: {
+        number: string;
+        timestamp: string;
+    };
+    stateOverrides?: {
+        nonce: number;
+        code: string;
+        balance: {
+            value: number;
+        };
+        storage: Map<string, string>;
+    };
+}
+export type SimulateTxBody = {
+    network_id: string;
+    from: string;
+    to: string;
+    input: string;
+    gas?: number;
+    block_number?: number;
+    transaction_index?: number;
+    gas_price?: string;
+    estimate_gas?: boolean;
+    value?: string;
+    save?: boolean;
+    save_if_fails?: boolean;
+};
+export type SimulateTxResponse = {
+    transaction: {
+        hash: string;
+        block_hash: string;
+        block_number: number;
+        from: string;
+        gas: number;
+        gas_price: number;
+        input: string;
+        nonce: number;
+        to: string;
+        index: number;
+        addresses: string[];
+        contract_ids: string[];
+        network_id: string;
+        timestamp: string;
+        transaction_info: {
+            contract_address: string;
+            method: 'approve';
+            logs: any[] | null;
+            balance_diff: any[] | null;
+            nonce_diff: any[] | null;
+            state_diff: any[] | null;
+            asset_changes: any[] | null;
+            exposure_changes: any[] | null;
+            balance_changes: any[] | null;
+        };
+        call_trace: any[] | null;
+        simulation: {
+            id: string;
+            project_id: string;
+            network_id: string;
+            blocknumber: number;
+            transaction_index: number;
+            block_header: object;
+            nonce: number;
+            contracts: any[];
+        };
+    };
+    simulation: object;
+};
+export type RpcTransactionParams = {
+    from: string;
+    to: string;
+    gas: string;
+    gasPrice?: string;
+    value: string | bigint;
+    input: string;
+    maxFeePerGas?: number;
+    maxPriorityFeePerGas?: number;
+};
+export type RpcSimulateTransactionBody<T extends RpcTransactionParams | RpcTransactionParams[] = RpcTransactionParams> = {
+    params: [
+        T,
+        string | 'latest' | 'earliest' | 'pending' | 'finalized' | 'safe',
+        {
+            [key in string]: {
+                balance: string;
+                nonce?: string;
+            };
+        }
+    ];
+};
+export type StorageStateChange = {
+    address: string;
+    balance?: {
+        previousValue: string;
+        newValue: string;
+    };
+    nonce?: {
+        previousValue: string;
+        newValue: string;
+    };
+    storage?: {
+        slot: string;
+        previousValue: string;
+        newValue: string;
+        ERC20ChangeType?: 'balance' | 'allowance';
+    }[];
+};
+export type RPCSimulationAssetChange = {
+    rawAmount: string;
+    amount: string | null;
+    dollarValue?: string;
+    from: string;
+    to: string;
+    type: string;
+    id?: string;
+    assetInfo: {
+        standard: string;
+        type: string;
+        contractAddress?: string;
+        symbol?: string;
+        name?: string;
+        logo?: string;
+        decimals?: number;
+        dollarValue?: string;
+    };
+};
+export type RPCSimulationExposureChange = {
+    assetInfo: {
+        standard: string;
+        type: string;
+        contractAddress: string;
+        symbol: string;
+        name: string;
+        logo: string;
+        decimals: number;
+        dollarValue: string;
+    };
+    type: string;
+    owner: string;
+    spender: string;
+    rawAmount: string;
+    amount: string;
+    dollarValue: string;
+};
+export interface RpcTrace {
+    type: string;
+    from: string;
+    to: string;
+    gas: string;
+    gasUsed: string;
+    input: string;
+    method?: string;
+    output?: string;
+    subtraces: number;
+    traceAddress: string[];
+    value?: string;
+    error?: string;
+    errorReason?: string;
+}
+export type RpcSimulateLog = {
+    name: string;
+    inputs: {
+        value: string;
+        type: string;
+        name: string;
+        indexed: boolean;
+    }[];
+    raw: {
+        address: string;
+        data: string;
+        topics: string[];
+    };
+};
+export type RpcSimulateResult = {
+    assetChanges: RPCSimulationAssetChange[];
+    status: boolean;
+    gasUsed: string;
+    cumulativeGasUsed: string;
+    blockNumber: string;
+    type: string;
+    logsBloom: string;
+    logs: RpcSimulateLog[];
+    stateChanges: StorageStateChange[];
+    trace?: RpcTrace[];
+    exposureChanges: RPCSimulationExposureChange[];
+};
+export type RpcSimulateTransactionResponse<T extends RpcSimulateResult | RpcSimulateResult[] = RpcSimulateResult> = {
+    jsonrpc: '2.0';
+    id: 0;
+    result: T;
+    error?: {
+        code: number;
+        message: string;
+    };
+};

package/common/src/types/token-prices.types.d.ts

@@ -0,0 +1,18 @@
+export declare const TOKEN_PRICE_STATUS: {
+    readonly INITIAL: "initial";
+    readonly FETCHING: "fetching";
+    readonly ERROR: "error";
+    readonly SUCCESS: "success";
+};
+export type TokenPriceStatus = (typeof TOKEN_PRICE_STATUS)[keyof typeof TOKEN_PRICE_STATUS];
+export interface TokenPriceState {
+    tokenPriceDollar: number | undefined;
+    tokenPriceFetchStatus: TokenPriceStatus;
+}
+export declare enum TokenPriceTimeframe {
+    ONE_WEEK = "1w",
+    ONE_MONTH = "1m",
+    THREE_MONTHS = "3m",
+    ONE_YEAR = "1y",
+    ALL_TIME = "allTime"
+}

package/common/src/types/token-with-id.types.d.ts

@@ -0,0 +1,4 @@
+export interface TokenWithId {
+    erc20TokenAddress: string;
+    tokenId: number;
+}

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

@@ -0,0 +1,88 @@
+export interface ERC20Token {
+    chainId: number;
+    erc20TokenAddress: string;
+    wrappedErc20TokenAddress?: string;
+    underlyingErc20TokenAddress?: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+    nftTokenType?: string;
+    logoURI?: string;
+    logoURIs?: string[];
+    whitelisted?: boolean;
+    isCustom?: true;
+    tokenIds?: string[];
+    approvalType?: ApprovalType;
+    isVolatile?: boolean;
+    sharedAddress?: string;
+    isPendleToken?: boolean;
+    isHToken?: boolean;
+    hasHToken?: boolean;
+    aaveToken?: boolean;
+    allowanceStorageOffset?: number;
+    balanceStorageOffset?: number;
+    isVyper?: boolean;
+    isSpam?: boolean;
+    is2022Program?: boolean;
+}
+export declare enum ApprovalType {
+    Classic = 0,
+    ERC20Permit = 1,
+    DAIPermit = 2
+}
+export interface NFT {
+    tokenId: number;
+    image?: string;
+    name?: string;
+    timestamp?: string;
+}
+export interface TokenBalance {
+    token: ERC20Token;
+    balance: bigint;
+    timestamp?: string;
+    nfts?: NFT[];
+}
+export interface TokenBalanceWithUsdValue extends TokenBalance {
+    isBalanceLoading?: boolean;
+    usdValue?: number;
+    isUsdValueLoading?: boolean;
+}
+export interface PublicTokenBalances {
+    publicTokenBalances: TokenBalance[];
+    isPublicBalancesLoading: boolean;
+}
+export interface PublicTokenBalancesWithUsd {
+    publicTokenBalancesWithUSD: TokenBalanceWithUsdValue[];
+    publicTotalUSDBalances: number;
+    isPublicBalancesLoading: boolean;
+    isUsdBalanceLoading: boolean;
+}
+export interface TokenChanges<T = number> {
+    token: ERC20Token;
+    amount: T;
+    nftIds?: string[];
+}
+export interface GasTokensInfoEntry {
+    token: ERC20Token;
+    balance: string;
+    dollarValue: number;
+    isLoading: boolean;
+    isInsufficientGasBalance: boolean;
+    disabled: boolean;
+}
+export type VolatileTokenChange = {
+    tokenAddress: string;
+    amount: string;
+    targetAddress?: string;
+    originalIndex: number;
+};
+export interface PrivateRecipientInfo {
+    recipientInfo: string;
+    amount: bigint;
+    token: ERC20Token;
+}
+export interface TemporaryWalletBalance extends TokenBalanceWithUsdValue {
+    nonce: number;
+    ethAddress: string;
+    privateKey: string;
+}

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

@@ -0,0 +1,160 @@
+import { MerkleTreeJson } from '../data-structures/merkle-tree/MerkleTree';
+import { TokenAmountInfo } from './activities.types';
+import { EncryptedOutputWithSign } from './commitments.types';
+import { ExternalActionId } from './external-action.types';
+import { FeeStructure, IntegrationProvider } from './hinkal.types';
+import { SubAccount } from './proxy.types';
+import { ERC20Token, TokenChanges } from './token.types';
+import { AppMetaData, WCTransactionParameters } from './wc.types';
+import { WithId } from './with-id.types';
+import { AdminTransactionType } from './admin.types';
+export declare enum TransactionRequestType {
+    ReceiveFromShieldedAccount = "ReceiveFromShieldedAccount",
+    SwapTokens = "SwapTokens",
+    PrivateTransactionFromProxy = "PrivateTransactionFromProxy",
+    ProxySend = "ProxySend",
+    Send = "Send",
+    Fund = "Fund",
+    ProxySwapTokens = "ProxySwapTokens",
+    BatchTransaction = "BatchTransaction",
+    SignSolanaTransaction = "SignSolanaTransaction",
+    SignAndSendSolanaTransaction = "SignAndSendSolanaTransaction"
+}
+export interface TransferTokenRequest {
+    type: TransactionRequestType.Send | TransactionRequestType.Fund;
+    amounts: bigint[];
+    erc20Tokens: ERC20Token[];
+    to: string;
+    isRelayerOff: boolean;
+    action: AdminTransactionType;
+    feeToken?: string;
+    feeStructure?: FeeStructure;
+}
+export interface PrivateTransactionBaseRequest {
+    appMetaData: AppMetaData;
+    from: string;
+    feeStructure?: FeeStructure;
+}
+export interface PrivateTransactionFromProxyRequest extends PrivateTransactionBaseRequest {
+    type: TransactionRequestType.PrivateTransactionFromProxy;
+    subAccount: SubAccount;
+    tokenChanges: TokenChanges<bigint>[];
+    proxyApprovalData?: {
+        approvalToken: ERC20Token;
+        approvalAmount: string;
+    };
+    txParams: WCTransactionParameters;
+    autoDepositBack: boolean;
+    maxGasInDollar?: string;
+}
+export interface BatchTransactionRequest extends PrivateTransactionBaseRequest {
+    type: TransactionRequestType.BatchTransaction;
+    tokenChanges: TokenChanges<bigint>[];
+    batchCalls: WCTransactionParameters[];
+    subAccount: SubAccount;
+    revokedTokens?: TokenAmountInfo[];
+    autoDepositBack?: boolean;
+    maxGasInDollar?: string;
+}
+export interface SignSolanaTransactionRequest extends PrivateTransactionBaseRequest {
+    type: TransactionRequestType.SignSolanaTransaction;
+    subAccount: SubAccount;
+    tokenChanges: TokenChanges<bigint>[];
+    txParams: WCTransactionParameters;
+    serializedTx: string;
+    signature: string;
+}
+export interface SignAndSendSolanaTransactionRequest extends PrivateTransactionBaseRequest {
+    type: TransactionRequestType.SignAndSendSolanaTransaction;
+    subAccount: SubAccount;
+    tokenChanges: TokenChanges<bigint>[];
+    txParams: WCTransactionParameters;
+    serializedTx: string;
+}
+export interface ReceiveFromSubAccountRequest {
+    type: TransactionRequestType.ReceiveFromShieldedAccount;
+    from: string;
+    amounts: bigint[];
+    erc20Tokens: ERC20Token[];
+    subAccount: SubAccount;
+    feeToken?: string;
+    feeStructure?: FeeStructure;
+}
+export interface SwapTokensRequest {
+    type: TransactionRequestType.SwapTokens;
+    from: string;
+    amountChanges: bigint[];
+    erc20Tokens: ERC20Token[];
+    externalActionId: ExternalActionId;
+    swapData: string;
+    integrationProvider: IntegrationProvider;
+    action: AdminTransactionType;
+    feeToken?: string;
+    feeStructure?: FeeStructure;
+    bridgedToken?: ERC20Token;
+    bridgedTokenAmount?: bigint;
+    extraNativeTokenFee?: bigint;
+}
+export interface ProxySwapTokensRequest {
+    type: TransactionRequestType.ProxySwapTokens;
+    from: string;
+    amountChanges: bigint[];
+    erc20Tokens: ERC20Token[];
+    externalActionId: ExternalActionId;
+    swapData: string;
+    isTheSameChainSwap: boolean;
+    integrationProvider: IntegrationProvider;
+    subAccount: SubAccount;
+    action: AdminTransactionType;
+    feeToken?: string;
+    feeStructure?: FeeStructure;
+    bridgedToken?: ERC20Token;
+    bridgedTokenAmount?: bigint;
+    extraNativeTokenFee?: bigint;
+    autoDepositBack?: boolean;
+    maxGasInDollar?: string;
+}
+export interface SendProxySendRequest {
+    type: TransactionRequestType.ProxySend;
+    from: string;
+    amounts: bigint[];
+    erc20Tokens: ERC20Token[];
+    to: string;
+    subAccount: SubAccount;
+    action: AdminTransactionType;
+    feeToken?: string;
+    feeStructure?: FeeStructure;
+}
+export interface PrepareHinkalFromSerializedArgs {
+    signature: string;
+    ethereumAddress: string;
+    chainId: number;
+    nullifiers: string[];
+    merkleTreeHinkal: MerkleTreeJson;
+    encryptedOutputs: EncryptedOutputWithSign<boolean>[];
+    generateProofRemotely: boolean;
+    serializedCache: Record<string, string>;
+    stealthPairCache: Record<string, string>;
+    stealthAddressCache: Record<string, string>;
+}
+export type TransactionRequest = (TransferTokenRequest | ReceiveFromSubAccountRequest | SwapTokensRequest | PrivateTransactionFromProxyRequest | SendProxySendRequest | ProxySwapTokensRequest | BatchTransactionRequest | SignAndSendSolanaTransactionRequest) & {
+    prepareHinkalArgs: PrepareHinkalFromSerializedArgs;
+};
+export type TransactionRuntimeMessageHandler = (message: WithId<TransactionRequest>) => Promise<{
+    result: string;
+} | undefined>;
+export interface TransactionResponseError {
+    id: number;
+    success: false;
+    error: Error;
+    erroredTx?: string;
+}
+export interface TransactionResponseBase {
+    id: number;
+    success: true;
+}
+export interface TransactionResponseTx extends TransactionResponseBase {
+    txHash: string;
+}
+export type TransactionResponseSuccess = TransactionResponseTx;
+export type TransactionResponse = TransactionResponseError | TransactionResponseSuccess;

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

@@ -0,0 +1,79 @@
+import { HookDataType, StealthAddressStructure } from './circom-data.types';
+export interface RawTx {
+    blockNumber: number;
+    timeStamp: number;
+    isError: string;
+    methodId: string;
+    input: string;
+    logs: Log[];
+    hash: string;
+    gas: number;
+    gasPrice: number;
+    contract?: string;
+}
+type Log = {
+    topics: readonly string[];
+    data: string;
+};
+export interface EventLog {
+    address: string;
+    topics: readonly string[];
+    data: string;
+    blockNumber: string;
+    blockHash: string;
+    timeStamp: string;
+    gasPrice: string;
+    gasUsed: string;
+    logIndex: string;
+    transactionHash: string;
+    transactionIndex: string;
+}
+export interface DecodedTx<T = bigint, K = bigint> extends RawTx {
+    decodedInput: {
+        erc20TokenAddresses: string[];
+        amountChanges: K[];
+        flatFees: K[];
+        externalActionId: K;
+        externalActionMetadata: string;
+        encryptedOutputs: string[];
+        hookData: HookDataType;
+        stealthAddressStructure: StealthAddressStructure<T>;
+    };
+    status: string;
+}
+export interface DecodedTxWithUtxos<T = bigint, K = bigint> extends DecodedTx<T, K> {
+    utxosArray?: OnChainUtxo<T>[];
+}
+export type OnChainUtxo<AmountType = bigint> = {
+    amount: AmountType;
+    erc20TokenAddress: string;
+    timeStamp: string;
+    tokenId: number;
+};
+export declare const emptyDecodedTx: DecodedTx;
+export declare enum TransactionStatus {
+    NotStarted = 0,
+    Loading = 1,
+    Confirmed = 2,
+    Failed = 3
+}
+export declare enum TransactionAction {
+    None = 0,
+    Deposit = 1,
+    Mint = 2,
+    PoolAdd = 3,
+    PoolRemove = 4,
+    Redeem = 5,
+    Swap = 6,
+    Bridge = 7,
+    Transfer = 8,
+    Withdraw = 9,
+    Send = 10,
+    Fund = 11,
+    Receive = 12
+}
+export declare enum TransactionReceiptStatus {
+    Failed = 0,
+    Succeeded = 1
+}
+export {};

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

@@ -0,0 +1,15 @@
+export interface TronSignerAdapter {
+    signMessage(message: string): Promise<string>;
+    signTransaction(transaction: any): Promise<any>;
+    on(event: 'accountsChanged', handler: (address: string, preAddr: string) => void): this;
+    off(event: 'accountsChanged', handler: (address: string, preAddr: string) => void): this;
+}
+export type TronWallet = {
+    address: string;
+    signerAdapter: TronSignerAdapter;
+};
+export interface TronChainParameter {
+    key: string;
+    value?: number;
+}
+export type TronAccountResources = Record<string, number>;

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

@@ -0,0 +1,78 @@
+import { BuildApprovedNamespacesParams } from '@walletconnect/utils';
+import { SessionMetadata } from './session.types';
+export interface VerifyContextOptions {
+    verified: {
+        origin: string;
+        validation: string;
+        verifyUrl: string;
+    };
+}
+export type WCSessionProposalOptions = {
+    id: number;
+    params: BuildApprovedNamespacesParams['proposal'];
+    verifyContext: VerifyContextOptions;
+};
+export type WCSessionRequestOptions = {
+    id: number;
+    topic: string;
+    params: {
+        chainId: string;
+        request: {
+            method: string;
+            params: unknown[];
+        };
+    };
+    verifyContext: VerifyContextOptions;
+};
+export interface TxParametersBase {
+    from: string;
+    to: string;
+    gas?: string;
+    gasPrice?: string;
+    value: string;
+    data?: string;
+}
+export interface WCTransactionParameters<T = number> extends TxParametersBase {
+    chainId: T;
+}
+type BaseNamespace = {
+    chains?: string[];
+    accounts: string[];
+    methods: string[];
+    events: string[];
+};
+export type Namespaces = Record<string, BaseNamespace>;
+export type WCSession = {
+    topic: string;
+    pairingTopic: string;
+    acknowledged: boolean;
+    controller: string;
+    self: {
+        publicKey: string;
+    };
+    peer: {
+        publicKey: string;
+        metadata: SessionMetadata;
+    };
+    namespaces: Namespaces;
+};
+export interface WCErrorResponse {
+    id: number;
+    error: {
+        code: number;
+        message: string;
+    };
+    jsonrpc: string;
+}
+export interface WCSuccessResponse {
+    id: number;
+    result: string | null | object;
+    jsonrpc: string;
+}
+export type WCResponse = WCErrorResponse | WCSuccessResponse;
+export type AppMetaData = {
+    url?: string;
+    icon: string;
+    name: string;
+};
+export {};

package/common/src/types/with-id.types.d.ts

@@ -0,0 +1,3 @@
+export type WithId<T> = T & {
+    id: number;
+};

package/common/src/webworker/WorkerWrapper.d.ts

@@ -0,0 +1,9 @@
+import { Worker as NodeWorker } from 'worker_threads';
+export declare class WorkerWrapper {
+    private worker;
+    constructor(worker: Worker | NodeWorker);
+    postMessage(data: any): void;
+    terminate(): void;
+    onMessage(cb: (data: any) => void): void;
+    onError(cb: (err: any) => void): void;
+}

package/common/src/webworker/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gurge/sdk",
-  "version": "0.3.4",
+  "version": "0.3.7",
   "homepage": "hinkal.io",
   "author": {
     "name": "Hinkal Protocol"

package/common/src/webworker/performTaskWithWorker.d.ts

@@ -0,0 +1,5 @@
+import { WorkerVariant } from './worker.registry';
+export declare const performTaskWithWorker: <P, T>(workerData: {
+    type: WorkerVariant;
+    payload: P;
+}) => Promise<T>;

package/common/src/webworker/snarkjsWorker/snarkjsWorker.types.d.ts

@@ -0,0 +1,14 @@
+import { WorkerParams, WorkerPayload } from '../worker.types';
+export declare enum SnarkJSWorkerActionType {
+    FULL_PROVE = 0
+}
+export interface SnarkJSWorkerFullProvePayload extends WorkerPayload<{
+    input: any;
+    chainId: number;
+    wasmFilePath: string;
+    zKeyFilePath: string;
+}> {
+    type: SnarkJSWorkerActionType.FULL_PROVE;
+}
+export type SnarkJSPayload = SnarkJSWorkerFullProvePayload;
+export type SnarkJSParams = WorkerParams<SnarkJSPayload>;

package/common/src/webworker/snarkjsWorker/snarkjsWorkerLauncher.d.ts

@@ -0,0 +1 @@
+export {};

package/common/src/webworker/snarkjsWorker/snarkjsWorkerLogic.d.ts

@@ -0,0 +1,2 @@
+import { SnarkJSParams } from './snarkjsWorker.types';
+export declare const onWorkerMessage: (data: SnarkJSParams) => Promise<void>;

package/common/src/webworker/snarkjsWorker/snarkjsWorkerNode.d.ts

@@ -0,0 +1 @@
+export {};