@ton/appkit 0.0.1-alpha.2 → 0.0.2

package/src/queries/swap/build-swap-transaction.ts

@@ -0,0 +1,84 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type { MutateOptions, MutationOptions } from '@tanstack/query-core';
+
+import type { AppKit } from '../../core/app-kit';
+import type { MutationParameter } from '../../types/query';
+import type { Compute } from '../../types/utils';
+import { buildSwapTransaction } from '../../actions/swap/build-swap-transaction';
+import type {
+    BuildSwapTransactionOptions,
+    BuildSwapTransactionReturnType,
+} from '../../actions/swap/build-swap-transaction';
+
+export type BuildSwapTransactionMutationOptions<context = unknown> = MutationParameter<
+    BuildSwapTransactionData,
+    BuildSwapTransactionErrorType,
+    BuildSwapTransactionVariables,
+    context
+>;
+
+export const buildSwapTransactionMutationOptions = <context = unknown>(
+    appKit: AppKit,
+    options: BuildSwapTransactionMutationOptions<context> = {},
+): BuildSwapTransactionMutationConfig<context> => {
+    return {
+        ...options.mutation,
+        mutationFn(variables) {
+            const { quote, userAddress } = variables;
+            if (!quote || !userAddress) {
+                throw new Error('Required parameters "quote" and "userAddress" are missing');
+            }
+
+            return buildSwapTransaction(appKit, variables);
+        },
+        mutationKey: ['buildSwapTransaction'],
+    };
+};
+
+export type BuildSwapTransactionMutationConfig<context = unknown> = MutationOptions<
+    BuildSwapTransactionData,
+    BuildSwapTransactionErrorType,
+    BuildSwapTransactionVariables,
+    context
+>;
+
+export type BuildSwapTransactionData = Compute<Awaited<BuildSwapTransactionReturnType>>;
+
+export type BuildSwapTransactionErrorType = Error;
+
+export type BuildSwapTransactionVariables = BuildSwapTransactionOptions;
+
+export type BuildSwapTransactionMutate<context = unknown> = (
+    variables: BuildSwapTransactionVariables,
+    options?:
+        | Compute<
+              MutateOptions<
+                  BuildSwapTransactionData,
+                  BuildSwapTransactionErrorType,
+                  Compute<BuildSwapTransactionVariables>,
+                  context
+              >
+          >
+        | undefined,
+) => void;
+
+export type BuildSwapTransactionMutateAsync<context = unknown> = (
+    variables: BuildSwapTransactionVariables,
+    options?:
+        | Compute<
+              MutateOptions<
+                  BuildSwapTransactionData,
+                  BuildSwapTransactionErrorType,
+                  Compute<BuildSwapTransactionVariables>,
+                  context
+              >
+          >
+        | undefined,
+) => Promise<BuildSwapTransactionData>;

package/src/queries/swap/get-swap-quote.ts

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import { getSwapQuote } from '../../actions/swap/get-swap-quote';
+import type { GetSwapQuoteOptions } from '../../actions/swap/get-swap-quote';
+import type { GetSwapQuoteReturnType } from '../../actions/swap/get-swap-quote';
+import type { AppKit } from '../../core/app-kit';
+import type { QueryOptions, QueryParameter } from '../../types/query';
+import type { Compute, ExactPartial } from '../../types/utils';
+import { filterQueryOptions } from '../../utils';
+
+export type GetSwapQuoteErrorType = Error;
+
+export type GetSwapQuoteQueryConfig<selectData = GetSwapQuoteData> = Compute<ExactPartial<GetSwapQuoteOptions>> &
+    QueryParameter<GetSwapQuoteQueryFnData, GetSwapQuoteErrorType, selectData, GetSwapQuoteQueryKey>;
+
+export const getSwapQuoteQueryOptions = <selectData = GetSwapQuoteData>(
+    appKit: AppKit,
+    options: GetSwapQuoteQueryConfig<selectData> = {},
+): GetSwapQuoteQueryOptions<selectData> => {
+    return {
+        ...options.query,
+        enabled: Boolean(options.amount && options.from && options.to && (options.query?.enabled ?? true)),
+        queryFn: async (context) => {
+            const [, parameters] = context.queryKey as [string, GetSwapQuoteOptions];
+            if (!parameters.amount || !parameters.from || !parameters.to) {
+                throw new Error('amount, fromToken, and toToken are required');
+            }
+
+            return getSwapQuote(appKit, parameters);
+        },
+        queryKey: getSwapQuoteQueryKey(options),
+        // refetchInterval: (query) => {
+        //     const data = query.state.data as GetSwapQuoteData | undefined;
+        //     if (!data?.expiresAt) {
+        //         return false;
+        //     }
+
+        //     const now = Date.now();
+        //     const expiresAt = data.expiresAt * 1000;
+        //     const timeUntilExpiration = expiresAt - now;
+
+        //     return Math.max(0, timeUntilExpiration);
+        // },
+    };
+};
+
+export type GetSwapQuoteQueryFnData = Compute<Awaited<GetSwapQuoteReturnType>>;
+
+export type GetSwapQuoteData = GetSwapQuoteQueryFnData;
+
+export const getSwapQuoteQueryKey = (
+    options: Compute<ExactPartial<GetSwapQuoteOptions>> = {},
+): GetSwapQuoteQueryKey => {
+    return ['swapQuote', filterQueryOptions(options as unknown as Record<string, unknown>)] as const;
+};
+
+export type GetSwapQuoteQueryKey = readonly ['swapQuote', Compute<ExactPartial<GetSwapQuoteOptions>>];
+
+export type GetSwapQuoteQueryOptions<selectData = GetSwapQuoteData> = QueryOptions<
+    GetSwapQuoteQueryFnData,
+    GetSwapQuoteErrorType,
+    selectData,
+    GetSwapQuoteQueryKey
+>;

package/src/queries/transaction/get-transaction-status.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import { getTransactionStatus } from '../../actions/transaction/get-transaction-status';
+import type {
+    GetTransactionStatusErrorType,
+    GetTransactionStatusParameters,
+    GetTransactionStatusReturnType,
+} from '../../actions/transaction/get-transaction-status';
+import type { AppKit } from '../../core/app-kit';
+import type { QueryOptions, QueryParameter } from '../../types/query';
+import type { Compute } from '../../types/utils';
+
+export type { GetTransactionStatusErrorType, GetTransactionStatusParameters, GetTransactionStatusReturnType };
+
+export type GetTransactionStatusData = Compute<GetTransactionStatusReturnType>;
+
+export type GetTransactionStatusQueryKey = readonly ['transactionStatus', string];
+
+export type GetTransactionStatusQueryConfig<selectData = GetTransactionStatusData> = QueryParameter<
+    GetTransactionStatusData,
+    GetTransactionStatusErrorType,
+    selectData,
+    GetTransactionStatusQueryKey
+>;
+
+export type GetTransactionStatusQueryOptions<selectData = GetTransactionStatusData> = QueryOptions<
+    GetTransactionStatusData,
+    GetTransactionStatusErrorType,
+    selectData,
+    GetTransactionStatusQueryKey
+>;
+
+export const getTransactionStatusQueryOptions = <selectData = GetTransactionStatusData>(
+    appKit: AppKit,
+    options: GetTransactionStatusParameters & GetTransactionStatusQueryConfig<selectData>,
+): GetTransactionStatusQueryOptions<selectData> => {
+    return {
+        ...options.query,
+        queryFn: () => {
+            return getTransactionStatus(appKit, options);
+        },
+        queryKey: ['transactionStatus', (options.boc ?? options.normalizedHash) as string] as const,
+    };
+};

package/src/queries/transaction/send-transaction.ts

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type { MutateOptions, MutationOptions } from '@tanstack/query-core';
+
+import { sendTransaction } from '../../actions/transaction/send-transaction';
+import type {
+    SendTransactionErrorType,
+    SendTransactionParameters,
+    SendTransactionReturnType,
+} from '../../actions/transaction/send-transaction';
+import type { AppKit } from '../../core/app-kit';
+import type { MutationParameter } from '../../types/query';
+import type { Compute } from '../../types/utils';
+
+export type { SendTransactionErrorType, SendTransactionParameters, SendTransactionReturnType };
+
+export type SendTransactionOptions<context = unknown> = MutationParameter<
+    SendTransactionData,
+    SendTransactionErrorType,
+    SendTransactionVariables,
+    context
+>;
+
+export const sendTransactionMutationOptions = <context = unknown>(
+    appKit: AppKit,
+    options: SendTransactionOptions<context> = {},
+): SendTransactionMutationOptions<context> => {
+    return {
+        ...options.mutation,
+        mutationFn(variables) {
+            return sendTransaction(appKit, variables);
+        },
+        mutationKey: ['sendTransaction'],
+    };
+};
+
+export type SendTransactionMutationOptions<context = unknown> = MutationOptions<
+    SendTransactionData,
+    SendTransactionErrorType,
+    SendTransactionVariables,
+    context
+>;
+
+export type SendTransactionData = Compute<SendTransactionReturnType>;
+
+export type SendTransactionVariables = SendTransactionParameters;
+
+export type SendTransactionMutate<context = unknown> = (
+    variables: SendTransactionVariables,
+    options?:
+        | Compute<
+              MutateOptions<SendTransactionData, SendTransactionErrorType, Compute<SendTransactionVariables>, context>
+          >
+        | undefined,
+) => void;
+
+export type SendTransactionMutateAsync<context = unknown> = (
+    variables: SendTransactionVariables,
+    options?:
+        | Compute<
+              MutateOptions<SendTransactionData, SendTransactionErrorType, Compute<SendTransactionVariables>, context>
+          >
+        | undefined,
+) => Promise<SendTransactionData>;

package/src/queries/transaction/transfer-ton.ts

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type { MutateOptions, MutationOptions } from '@tanstack/query-core';
+
+import { transferTon } from '../../actions/transaction/transfer-ton';
+import type {
+    TransferTonErrorType,
+    TransferTonParameters,
+    TransferTonReturnType,
+} from '../../actions/transaction/transfer-ton';
+import type { AppKit } from '../../core/app-kit';
+import type { MutationParameter } from '../../types/query';
+import type { Compute } from '../../types/utils';
+
+export type { TransferTonErrorType, TransferTonParameters, TransferTonReturnType };
+
+export type TransferTonOptions<context = unknown> = MutationParameter<
+    TransferTonData,
+    TransferTonErrorType,
+    TransferTonVariables,
+    context
+>;
+
+export const transferTonMutationOptions = <context = unknown>(
+    appKit: AppKit,
+    options: TransferTonOptions<context> = {},
+): TransferTonMutationOptions<context> => {
+    return {
+        ...options.mutation,
+        mutationFn(variables) {
+            return transferTon(appKit, variables);
+        },
+        mutationKey: ['transferTon'],
+    };
+};
+
+export type TransferTonMutationOptions<context = unknown> = MutationOptions<
+    TransferTonData,
+    TransferTonErrorType,
+    TransferTonVariables,
+    context
+>;
+
+export type TransferTonData = Compute<TransferTonReturnType>;
+
+export type TransferTonVariables = TransferTonParameters;
+
+export type TransferTonMutate<context = unknown> = (
+    variables: TransferTonVariables,
+    options?:
+        | Compute<MutateOptions<TransferTonData, TransferTonErrorType, Compute<TransferTonVariables>, context>>
+        | undefined,
+) => void;
+
+export type TransferTonMutateAsync<context = unknown> = (
+    variables: TransferTonVariables,
+    options?:
+        | Compute<MutateOptions<TransferTonData, TransferTonErrorType, Compute<TransferTonVariables>, context>>
+        | undefined,
+) => Promise<TransferTonData>;

package/src/swap/index.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+export type { SwapToken, TokenAmount, SwapParams } from '@ton/walletkit';

package/src/swap/omniston/index.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+export * from '@ton/walletkit/swap/omniston';

package/src/types/balance.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type { TokenAmount } from '@ton/walletkit';
+
+export type Balance = TokenAmount;

package/src/types/connector.ts

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type { NetworkManager } from '@ton/walletkit';
+
+import type { WalletInterface } from './wallet';
+import type { AppKitEmitter } from '../core/app-kit';
+
+/**
+ * Interface for wallet connectors
+ */
+export interface Connector {
+    /** Provider unique identifier */
+    readonly id: string;
+
+    /** Protocol type (e.g. 'tonconnect', 'ledger', 'mnemonic') */
+    readonly type: string;
+
+    readonly metadata: ConnectorMetadata;
+
+    /** Initialize connector (restore connections, setup event listeners) */
+    initialize(emitter: AppKitEmitter, networkManager: NetworkManager): Promise<void>;
+
+    /** Cleanup connector resources */
+    destroy(): void;
+
+    /** Connect a wallet */
+    connectWallet(): Promise<void>;
+
+    /** Disconnect a wallet */
+    disconnectWallet(): Promise<void>;
+
+    /** Get connected wallets */
+    getConnectedWallets(): WalletInterface[];
+}
+
+export interface ConnectorMetadata {
+    name: string;
+    iconUrl?: string;
+}

package/src/types/jetton.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+export type { Jetton, JettonInfo } from '@ton/walletkit';

package/src/types/network.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+export { Network } from '@ton/walletkit';

package/src/types/nft.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+export type { NFT } from '@ton/walletkit';

package/src/types/primitives.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+export type { Base64String } from '@ton/walletkit';

package/src/types/provider.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type { SwapProviderInterface } from '@ton/walletkit';
+
+/**
+ * Provider configuration
+ */
+export type Provider = SwapProviderInterface;

package/src/types/query.ts

@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type * as Query from '@tanstack/query-core';
+
+import type { Compute, LooseOmit, RequiredBy, UnionLooseOmit } from './utils.js';
+
+export type MutationParameter<data = unknown, error = Error, variables = void, context = unknown> = {
+    mutation?:
+        | LooseOmit<
+              Query.MutationOptions<data, error, Compute<variables>, context>,
+              'mutationFn' | 'mutationKey' | 'throwOnError'
+          >
+        | undefined;
+};
+
+export type QueryParameter<
+    queryFnData = unknown,
+    error = Query.DefaultError,
+    data = queryFnData,
+    queryKey extends Query.QueryKey = Query.QueryKey,
+> = {
+    query?: UnionLooseOmit<QueryOptions<queryFnData, error, data, queryKey>, 'queryKey' | 'queryFn'> | undefined;
+};
+
+export type QueryOptions<
+    queryFnData = unknown,
+    error = Query.DefaultError,
+    data = queryFnData,
+    queryKey extends Query.QueryKey = Query.QueryKey,
+> = Omit<
+    RequiredBy<Query.QueryObserverOptions<queryFnData, error, data, queryFnData, queryKey>, 'queryKey'>,
+    'queryFn' | 'queryHash' | 'queryKeyHashFn' | 'throwOnError'
+> & {
+    queryFn: Exclude<
+        Query.QueryObserverOptions<queryFnData, error, data, queryFnData, queryKey>['queryFn'],
+        typeof Query.skipToken | undefined
+    >;
+};

package/src/types/signing.ts

@@ -0,0 +1,78 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type { Network } from './network';
+import type { Base64String } from './primitives';
+
+// SignData types for wallet adapter
+
+/**
+ * Data to be signed by the wallet, discriminated by type.
+ */
+export type SignData =
+    | { type: 'text'; value: SignDataText }
+    | { type: 'binary'; value: SignDataBinary }
+    | { type: 'cell'; value: SignDataCell };
+
+/**
+ * Binary data to be signed.
+ */
+export interface SignDataBinary {
+    /**
+     * Raw binary content encoded as bytes in Base64
+     */
+    content: Base64String;
+}
+
+/**
+ * TON Cell data to be signed with a schema definition.
+ */
+export interface SignDataCell {
+    /**
+     * Schema describing the cell structure for parsing
+     */
+    schema: string;
+    /**
+     * Cell content encoded in Base64
+     */
+    content: Base64String;
+}
+
+/**
+ * Plain text data to be signed.
+ */
+export interface SignDataText {
+    /**
+     * Text content to be signed
+     */
+    content: string;
+}
+
+/** SignData Request Payload - sent to wallet */
+export interface SignDataRequest {
+    /** Network */
+    network?: Network;
+    /** Sender address in raw format */
+    from?: string;
+    /** Data to sign */
+    data: SignData;
+}
+
+/** SignData Response - returned from wallet */
+export interface SignDataResponse {
+    /** Base64 encoded signature */
+    signature: string;
+    /** Wallet address that signed */
+    address: string;
+    /** Unix timestamp when signed */
+    timestamp: number;
+    /** Domain of the dApp */
+    domain: string;
+    /** Original payload that was signed */
+    payload: SignDataRequest;
+}

package/src/types/transaction.ts

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) TonTech.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import type { ExtraCurrencies, TokenAmount } from '@ton/walletkit';
+
+import type { Network } from './network';
+
+export type { TransactionStatus } from '@ton/walletkit';
+
+export interface TransactionRequest {
+    /**
+     * List of messages to include in the transaction
+     */
+    messages: TransactionRequestMessage[];
+
+    /**
+     * Network to execute the transaction on
+     */
+    network?: Network;
+
+    /**
+     * Unix timestamp after which the transaction becomes invalid
+     */
+    validUntil?: number;
+
+    /**
+     * Sender wallet address in received format(raw, user friendly)
+     */
+    fromAddress?: string;
+}
+
+/**
+ * Individual message within a transaction request.
+ */
+export interface TransactionRequestMessage {
+    /**
+     * Recipient wallet address in format received from caller (raw, user friendly)
+     */
+    address: string;
+
+    /**
+     * Amount to transfer in nanos
+     */
+    amount: TokenAmount;
+
+    /**
+     * Additional currencies to include in the transfer
+     */
+    extraCurrency?: ExtraCurrencies;
+
+    /**
+     * Initial state for deploying a new contract, encoded in Base64
+     */
+    stateInit?: string;
+
+    /**
+     * Message payload data encoded in Base64
+     */
+    payload?: string;
+}