@solana/kit
Version:
Solana Javascript API
89 lines • 4.3 kB
TypeScript
import type { PendingRpcRequest } from '@solana/rpc';
import type { PendingRpcSubscriptionsRequest } from '@solana/rpc-subscriptions';
import type { SolanaRpcResponse } from '@solana/rpc-types';
import type { ReactiveStore } from '@solana/subscribable';
type CreateReactiveStoreWithInitialValueAndSlotTrackingConfig<TRpcValue, TSubscriptionValue, TItem> = Readonly<{
/**
* Triggering this abort signal will cancel the pending RPC request and subscription, and
* disconnect the store from further updates.
*/
abortSignal: AbortSignal;
/**
* A pending RPC request whose response will be used to set the store's initial state.
* The response must be a {@link SolanaRpcResponse} so that its slot can be compared with
* subscription notifications.
*/
rpcRequest: PendingRpcRequest<SolanaRpcResponse<TRpcValue>>;
/**
* A pending RPC subscription request whose notifications will be used to keep the store
* up to date. Each notification must be a {@link SolanaRpcResponse} so that its slot can be
* compared with the initial RPC response and other notifications.
*/
rpcSubscriptionRequest: PendingRpcSubscriptionsRequest<SolanaRpcResponse<TSubscriptionValue>>;
/**
* Maps the value from a subscription notification to the item type stored in the reactive store.
*/
rpcSubscriptionValueMapper: (value: TSubscriptionValue) => TItem;
/**
* Maps the value from the RPC response to the item type stored in the reactive store.
*/
rpcValueMapper: (value: TRpcValue) => TItem;
}>;
/**
* Creates a {@link ReactiveStore} that combines an initial RPC fetch with an ongoing subscription
* to keep its state up to date.
*
* The store uses slot-based comparison to ensure that only the most recent value is kept,
* regardless of whether it came from the initial RPC response or a subscription notification.
* This prevents stale data from overwriting newer data when the RPC response and subscription
* notifications arrive out of order.
*
* Things to note:
*
* - `getState()` returns `undefined` until the first response or notification arrives. Once
* data arrives, it returns a {@link SolanaRpcResponse} containing the value and the slot
* context at which it was observed.
* - On error from either source, `getState()` continues to return the last known value and
* `getError()` returns the error. Only the first error is captured.
* - When an error occurs, the abort signal is triggered, cancelling both the RPC request and
* the subscription.
* - Triggering the caller's abort signal disconnects the store from both sources.
*
* @param config
*
* @example
* ```ts
* import {
* address,
* createReactiveStoreWithInitialValueAndSlotTracking,
* createSolanaRpc,
* createSolanaRpcSubscriptions,
* } from '@solana/kit';
*
* const rpc = createSolanaRpc('http://127.0.0.1:8899');
* const rpcSubscriptions = createSolanaRpcSubscriptions('ws://127.0.0.1:8900');
* const myAddress = address('FnHyam9w4NZoWR6mKN1CuGBritdsEWZQa4Z4oawLZGxa');
*
* const balanceStore = createReactiveStoreWithInitialValueAndSlotTracking({
* abortSignal: AbortSignal.timeout(60_000),
* rpcRequest: rpc.getBalance(myAddress, { commitment: 'confirmed' }),
* rpcValueMapper: lamports => lamports,
* rpcSubscriptionRequest: rpcSubscriptions.accountNotifications(myAddress),
* rpcSubscriptionValueMapper: ({ lamports }) => lamports,
* });
*
* const unsubscribe = balanceStore.subscribe(() => {
* const error = balanceStore.getError();
* if (error) console.error('Error:', error);
* else {
* const state = balanceStore.getState();
* if (state) console.log(`Balance at slot ${state.context.slot}:`, state.value);
* }
* });
* ```
*
* @see {@link ReactiveStore}
*/
export declare function createReactiveStoreWithInitialValueAndSlotTracking<TRpcValue, TSubscriptionValue, TItem>({ abortSignal, rpcRequest, rpcValueMapper, rpcSubscriptionRequest, rpcSubscriptionValueMapper, }: CreateReactiveStoreWithInitialValueAndSlotTrackingConfig<TRpcValue, TSubscriptionValue, TItem>): ReactiveStore<SolanaRpcResponse<TItem>>;
export {};
//# sourceMappingURL=create-reactive-store-with-initial-value-and-slot-tracking.d.ts.map