@bluxcc/react 0.3.6 → 0.3.8

package/dist/useStellar/useTradeAggregation.d.ts

@@ -1,5 +1,5 @@
 import { UseQueryResult } from '@tanstack/react-query';
-import type { GetTradeAggregationResult } from "@bluxcc/core/dist/exports/core/getTradeAggregation";
+import type { GetTradeAggregationResult } from "@bluxcc/core";
 import { Asset } from '@stellar/stellar-sdk';
 import { CallBuilderOptions } from '../utils';
 import type { QueryOptions } from '../utils';
@@ -37,5 +37,10 @@ export declare function useTradeAggregation(args: [
     end_time: number,
     resolution: number,
     offset: number
-], options?: O, queryOptions?: QueryOptions<R>): UseQueryResult<R, Error>;
+], options?: {
+    cursor?: string;
+    limit?: number;
+    network?: string;
+    order?: 'asc' | 'desc';
+}, queryOptions?: QueryOptions<R>): UseQueryResult<R, Error>;
 export {};

package/dist/useStellar/useTrades.d.ts

@@ -1,5 +1,6 @@
+import type { AssetArg } from '@bluxcc/core';
 import { UseQueryResult } from '@tanstack/react-query';
-import type { GetTradesResult, GetTradesOptions } from "@bluxcc/core/dist/exports/core/getTrades";
+import type { GetTradesResult, GetTradesOptions } from "@bluxcc/core";
 import type { QueryOptions } from "../utils";
 type R = GetTradesResult;
 type O = GetTradesOptions;
@@ -23,5 +24,24 @@ type O = GetTradesOptions;
  * });
  * ```
  */
-export declare function useTrades(options?: O, queryOptions?: QueryOptions<R>): UseQueryResult<R, Error>;
+export declare function useTrades(options?: {
+    /** Paging token; pass the previous page's cursor to fetch the next page. */
+    cursor?: string;
+    /** Maximum number of records returned per page. */
+    limit?: number;
+    /** Network passphrase to query. Defaults to the active network. */
+    network?: string;
+    /** Sort direction by ledger sequence. Defaults to Horizon's `asc`. */
+    order?: 'asc' | 'desc';
+    /** Only trades for this `[base, counter]` asset pair. Each accepts `'xlm'`, `'CODE:ISSUER'`, or an `Asset`. */
+    forAssetPair?: [base: AssetArg, counter: AssetArg];
+    /** Only trades against this offer id. */
+    forOffer?: string;
+    /** Only trades of this type (e.g. `orderbook`, `liquidity_pool`). */
+    forType?: Horizon.ServerApi.TradeType;
+    /** Only trades involving this account (address, SEP-2 address, or `.xlm` name). */
+    forAccount?: string;
+    /** Only trades for this liquidity pool id. */
+    forLiquidityPool?: string;
+}, queryOptions?: QueryOptions<R>): UseQueryResult<R, Error>;
 export {};

package/dist/useStellar/useTransactions.d.ts

@@ -1,5 +1,5 @@
 import { UseQueryResult } from '@tanstack/react-query';
-import type { GetTransactionsResult, GetTransactionsOptions } from "@bluxcc/core/dist/exports/core/getTransactions";
+import type { GetTransactionsResult, GetTransactionsOptions } from "@bluxcc/core";
 import type { QueryOptions } from "../utils";
 type R = GetTransactionsResult;
 type O = GetTransactionsOptions;
@@ -21,5 +21,24 @@ type O = GetTransactionsOptions;
  * const { data } = useTransactions({ forAccount: 'GA…', limit: 25 });
  * ```
  */
-export declare function useTransactions(options?: O, queryOptions?: QueryOptions<R>): UseQueryResult<R, Error>;
+export declare function useTransactions(options?: {
+    /** Paging token; pass the previous page's cursor to fetch the next page. */
+    cursor?: string;
+    /** Maximum number of records returned per page. */
+    limit?: number;
+    /** Network passphrase to query. Defaults to the active network. */
+    network?: string;
+    /** Sort direction by ledger sequence. Defaults to Horizon's `asc`. */
+    order?: 'asc' | 'desc';
+    /** Only transactions touching this account (address, SEP-2 address, or `.xlm` name). */
+    forAccount?: string;
+    /** Only transactions affecting this claimable balance id. */
+    forClaimableBalance?: string;
+    /** Only transactions in this ledger, by sequence number. */
+    forLedger?: string | number;
+    /** Only transactions affecting this liquidity pool id. */
+    forLiquidityPool?: string;
+    /** Include failed transactions. Defaults to `false`. */
+    includeFailed?: boolean;
+}, queryOptions?: QueryOptions<R>): UseQueryResult<R, Error>;
 export {};

package/dist/useStellar/useTransfer.d.ts

@@ -1,15 +1,50 @@
+import type { AssetArg, Numberish } from '@bluxcc/core';
 import { transfer } from '@bluxcc/core';
 import { UseMutationResult } from '@tanstack/react-query';
-import type { TransferOptions } from '@bluxcc/core/dist/exports/core/transfer';
+import type { TransferOptions } from '@bluxcc/core';
 import type { MutationOptions } from '../utils';
 type R = Awaited<ReturnType<typeof transfer>>;
 /**
  * Variables for {@link useTransfer} — the core `transfer` options verbatim, so
  * every path it supports (native XLM, issued asset, claimable balance, SEP-41
- * token, federated address) is just a different object passed to
+ * token, federated address, `.xlm` name) is just a different object passed to
  * `transfer({ ... })`.
  */
-export type TransferVariables = TransferOptions;
+export type TransferVariables = {
+    /**
+     * Recipient: a Stellar address (`G...` or muxed `M...`), a SEP-2 federated
+     * address (`alice*example.com`), or a `.xlm` name. For a `token` transfer a
+     * contract id (`C...`) or a name resolving to one is also accepted.
+     */
+    to: string;
+    /**
+     * Amount to send. Numbers and bigints are coerced to a string. For classic
+     * assets this is a decimal amount (`"10.5"`); for a `token` it is the integer
+     * base-unit amount the contract expects.
+     */
+    amount: Numberish;
+    /**
+     * Asset to send. Accepts `'xlm'` / `'native'`, a `CODE:ISSUER` string, or an
+     * `Asset`. Defaults to the native lumen. Ignored when `token` is set.
+     */
+    asset?: AssetArg;
+    /** Optional text memo. Ignored for `token` (Soroban) transfers. */
+    memo?: string;
+    /**
+     * When the recipient cannot receive the asset directly (its account does not
+     * exist, or it has no trustline for an issued asset), send a claimable balance
+     * it can claim later instead of failing. Defaults to `false`.
+     */
+    claimable?: boolean;
+    /**
+     * A SEP-41 token contract id (`C...`) or name resolving to one. When set,
+     * value moves through the contract's `transfer(from, to, amount)` entrypoint
+     * instead of a classic op.
+     */
+    token?: string;
+    /** Network passphrase to send on. Defaults to the active network. */
+    network?: string;
+};
 type V = TransferVariables;
 /**
  * Return type of {@link useTransfer}: the full TanStack mutation result plus
@@ -53,7 +88,7 @@ export type UseTransferResult = UseMutationResult<R, Error, V> & {
  * transfer({ to: 'GB…', amount: '1000000', token: 'C…' });
  *
  * // Await the result (e.g. in a form submit handler)
- * const tx = await transferAsync({ to: 'alice*example.com', amount: '5' });
+ * const tx = await transferAsync({ to: 'alice.xlm', amount: '5' });
  * ```
  */
 export declare function useTransfer(mutationOptions?: MutationOptions<R, V>): UseTransferResult;

package/dist/useStellar/useWriteContract.d.ts

@@ -1,8 +1,12 @@
 import { writeContract } from '@bluxcc/core';
 import { UseMutationResult } from '@tanstack/react-query';
-import type { IContractCall, WriteContractsOptions } from '@bluxcc/core/dist/exports/utils';
+import type { IContractCall, WriteContractsOptions } from '@bluxcc/core';
 import type { MutationOptions } from '../utils';
-type R = Awaited<ReturnType<typeof writeContract>>;
+type CoreWriteContractResult = Awaited<ReturnType<typeof writeContract>>;
+/** Submitted transaction with a caller-specified decoded contract result. */
+export type WriteContractHookResult<TReturnValue = unknown> = Omit<CoreWriteContractResult, 'returnValue'> & {
+    returnValue: () => Promise<TReturnValue | null>;
+};
 /**
  * Variables for {@link useWriteContract}: the contract `call` to invoke and
  * optional core write `options` (e.g. `network`).
@@ -14,12 +18,12 @@ export type WriteContractVariables = {
 type V = WriteContractVariables;
 /**
  * Submits a state-changing Soroban contract invocation as a signed, on-chain
- * transaction.
+ * transaction. Native positional arguments are encoded from the deployed
+ * contract ABI; pre-built `xdr.ScVal`s are also accepted.
  *
  * A thin wrapper over TanStack Query's `useMutation`: call `mutate` /
- * `mutateAsync` with the contract call to sign and send it. Build `args` with
- * the exported `ToScVal` helpers. For read-only calls (no signature, no fees)
- * use `useReadContracts` instead.
+ * `mutateAsync` with the contract call to sign and send it. For read-only calls
+ * (no signature, no fees) use `useReadContract` or `useReadContracts` instead.
  *
  * @param mutationOptions - Optional TanStack Mutation options (`onSuccess`,
  *   `onError`, `onSettled`, …); `mutationFn` is provided by the hook.
@@ -29,20 +33,17 @@ type V = WriteContractVariables;
  *
  * @example
  * ```tsx
- * const { mutate, isPending, data } = useWriteContract();
+ * const { mutateAsync, isPending } = useWriteContract<bigint>();
  *
- * mutate({
+ * const transaction = await mutateAsync({
  *   call: {
- *     address: 'C…',
+ *     address: 'token.xlm',
  *     fn: 'transfer',
- *     args: [
- *       ToScVal.address('GFROM…'),
- *       ToScVal.address('GTO…'),
- *       ToScVal.i128('1000000'),
- *     ],
+ *     args: ['alice.xlm', 'bob.xlm', 1_000_000],
  *   },
  * });
+ * const result = await transaction.returnValue(); // bigint | null
  * ```
  */
-export declare function useWriteContract(mutationOptions?: MutationOptions<R, V>): UseMutationResult<R, Error, V>;
+export declare function useWriteContract<TReturnValue = unknown>(mutationOptions?: MutationOptions<WriteContractHookResult<TReturnValue>, V>): UseMutationResult<WriteContractHookResult<TReturnValue>, Error, V>;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bluxcc/react",
   "author": "Blux team",
-  "version": "0.3.6",
+  "version": "0.3.8",
   "homepage": "https://blux.cc",
   "description": "Connecting to the Stellar Ecosystem and Beyond",
   "repository": {
@@ -30,7 +30,7 @@
     "build": "rollup -c rollup.config.prod.js"
   },
   "peerDependencies": {
-    "@bluxcc/core": "^0.3.6",
+    "@bluxcc/core": "^0.3.8",
     "@stellar/stellar-sdk": "^17.0.1",
     "@tanstack/react-query": "^5.90.11",
     "react": ">=17.0.0",