Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/chilly-sloths-reply.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"gill-react": minor
---

added `useSendTransaction` hook
30 changes: 30 additions & 0 deletions packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Fetch data from the Solana blockchain with the gill hooks:
- [`useAccount`](#get-account-info-and-data) - get the account info for an address
- [`useBalance`](#get-account-balance-in-lamports) - get account balance (in lamports)
- [`useLatestBlockhash`](#get-latest-blockhash) - get the latest blockhash
- [`useSendTransaction`](#send-transaction) - send a fully signed transaction to the cluster
- [`useSignatureStatuses`](#get-signature-statuses) - get signature statuses
- [`useSignaturesForAddress`](#get-signatures-for-address) - get signatures for address
- [`useProgramAccounts`](#get-program-accounts-gpa) - get program accounts (GPA)
Expand Down Expand Up @@ -452,4 +453,33 @@ export function PageClient() {
</div>
);
}
```

### Send Transaction

Submit a fully signed transaction to the cluster using the Solana RPC method of [sendTransaction](https://solana.com/docs/rpc/http/sendtransaction)

```tsx
"use client";

import { useSendTransaction } from "gill-react";

export function PageClient() {
const { signature, isLoading, isError, error } = useSendTransaction({
transaction: "4hXTCkRzt9WyecNzV1XPgCDfGAZzQKNxLXgynz5QDuWWPSAZBZSHptvWRL3BjCvzUXRdKvHL2b7yGrRQcWyaqsaBCncVG7BFggS8w9snUts67BSh3EqKpXLUm5UMHfD7ZBe9GhARjbNQMLJ1QD3Spr6oMTBU6EhdB4RD8CP2xUxr2u3d6fos36PD98XS6oX8TQjLpsMwncs5DAMiD4nNnR8NBfyghGCWvCVifVwvA8B8TJxE1aiyiv2L429BCWfyzAme5sZW8rDb14NeCQHhZbtNqfXhcp2tAnaAT",
config : {
preflightCommitment: "finalized",
skipPreflight: false,
}
});

// if (isLoading) { return ... }
// if (isError) { return ... }

return (
<div className="">
<pre>signature: {JSON.stringify(signature, null, "\t")}</pre>
</div>
);
}
```
38 changes: 38 additions & 0 deletions packages/react/src/__typeset__/send-transaction.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { Base64EncodedWireTransaction, SendTransactionApi } from "gill";
import { useSendTransaction } from "../hooks";

// [DESCRIBE] useSendTransaction
{
const transaction = null as unknown as Base64EncodedWireTransaction;

{
const { signature } = useSendTransaction({ transaction });
signature satisfies ReturnType<SendTransactionApi["sendTransaction"]>;

// @ts-expect-error - Should not allow no argument
useSendTransaction();

// @ts-expect-error - Should not allow empty argument object
useSendTransaction({});
}

// accept transaction in `Base64EncodedWireTransaction` format
{
const { signature } = useSendTransaction({
transaction,
config: {
encoding: "base64",
skipPreflight: false
}
});
signature satisfies ReturnType<SendTransactionApi["sendTransaction"]>;
}

// should accept transaction in `string` format
{
const { signature } = useSendTransaction({
transaction: "4hXTCkRzt9WyecNzV1XPgCDfGAZzQKNxLXgynz5QDuWWPSAZBZSHptvWRL3BjCvzUXRdKvHL2b7yGrRQcWyaqsaBCncVG7BFggS8w9snUts67BSh3EqKpXLUm5UMHfD7ZBe9GhARjbNQMLJ1QD3Spr6oMTBU6EhdB4RD8CP2xUxr2u3d6fos36PD98XS6oX8TQjLpsMwncs5DAMiD4nNnR8NBfyghGCWvCVifVwvA8B8TJxE1aiyiv2L429BCWfyzAme5sZW8rDb14NeCQHhZbtNqfXhcp2tAnaAT"
});
signature satisfies ReturnType<SendTransactionApi["sendTransaction"]>;
}
}
1 change: 1 addition & 0 deletions packages/react/src/hooks/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export * from "./client";
export * from "./latest-blockhash";
export * from "./program-accounts";
export * from "./recent-prioritization-fees";
export * from "./send-transaction";
export * from "./signature-statuses";
export * from "./signatures-for-address";
export * from "./slot";
Expand Down
56 changes: 56 additions & 0 deletions packages/react/src/hooks/send-transaction.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
"use client";

import { useQuery } from "@tanstack/react-query";
import type { Base64EncodedWireTransaction, SendTransactionApi, Simplify } from "gill";
import { GILL_HOOK_CLIENT_KEY } from "../const";
import { useSolanaClient } from "./client";
import type { GillUseRpcHook } from "./types";

type RpcConfig = Simplify<Parameters<SendTransactionApi["sendTransaction"]>[1]>;

type UseSendTransactionInput<TConfig extends RpcConfig = RpcConfig> = GillUseRpcHook<TConfig> & {
/**
* A fully signed transaction in wire format, as a base64 encoded string
*/
transaction: Base64EncodedWireTransaction | string;
}

type UseSendTransactionResponse = ReturnType<SendTransactionApi["sendTransaction"]>;

/**
* Submits a signed transaction to the cluster for processing.
*
* Default `config`:
* - encoding: "base64"
* - preflightCommitment: "finalized"
* - skipPreflight: false
*/
export function useSendTransaction<TConfig extends RpcConfig = RpcConfig>({
options,
config,
abortSignal,
transaction,
}: UseSendTransactionInput<TConfig>) {
const { rpc } = useSolanaClient();

const { data, ...rest } = useQuery({
networkMode: "always",
...options,
enabled: !!transaction,
queryKey: [GILL_HOOK_CLIENT_KEY, "sendTransaction", transaction],
queryFn: async () => {
const result = await rpc.sendTransaction(transaction as Base64EncodedWireTransaction,
{
preflightCommitment: "finalized",
skipPreflight: false,
...(config || {}),
encoding: "base64", // Always ensure encoding is `base64` as required in `SendTransactionApi`
}).send({ abortSignal });
return result;
}
});
return {
...rest,
signature: data as UseSendTransactionResponse,
};
}