@solana/rpc-api 6.3.1 → 6.3.2-canary-20260313112147

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/rpc-api",
-  "version": "6.3.1",
+  "version": "6.3.2-canary-20260313112147",
   "description": "Defines all default Solana RPC methods as types",
   "homepage": "https://www.solanakit.com/api#solanarpc-api",
   "exports": {
@@ -33,7 +33,8 @@
   "types": "./dist/types/index.d.ts",
   "type": "commonjs",
   "files": [
-    "./dist/"
+    "./dist/",
+    "./src/"
   ],
   "sideEffects": false,
   "keywords": [
@@ -55,17 +56,17 @@
     "maintained node versions"
   ],
   "dependencies": {
-    "@solana/addresses": "6.3.1",
-    "@solana/codecs-strings": "6.3.1",
-    "@solana/errors": "6.3.1",
-    "@solana/keys": "6.3.1",
-    "@solana/codecs-core": "6.3.1",
-    "@solana/rpc-parsed-types": "6.3.1",
-    "@solana/rpc-spec": "6.3.1",
-    "@solana/rpc-transformers": "6.3.1",
-    "@solana/transaction-messages": "6.3.1",
-    "@solana/rpc-types": "6.3.1",
-    "@solana/transactions": "6.3.1"
+    "@solana/addresses": "6.3.2-canary-20260313112147",
+    "@solana/codecs-core": "6.3.2-canary-20260313112147",
+    "@solana/codecs-strings": "6.3.2-canary-20260313112147",
+    "@solana/errors": "6.3.2-canary-20260313112147",
+    "@solana/keys": "6.3.2-canary-20260313112147",
+    "@solana/rpc-parsed-types": "6.3.2-canary-20260313112147",
+    "@solana/rpc-transformers": "6.3.2-canary-20260313112147",
+    "@solana/rpc-spec": "6.3.2-canary-20260313112147",
+    "@solana/rpc-types": "6.3.2-canary-20260313112147",
+    "@solana/transactions": "6.3.2-canary-20260313112147",
+    "@solana/transaction-messages": "6.3.2-canary-20260313112147"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"

package/src/getAccountInfo.ts

@@ -0,0 +1,145 @@
+import type { Address } from '@solana/addresses';
+import type {
+    AccountInfoBase,
+    AccountInfoWithBase58Bytes,
+    AccountInfoWithBase58EncodedData,
+    AccountInfoWithBase64EncodedData,
+    AccountInfoWithBase64EncodedZStdCompressedData,
+    AccountInfoWithJsonData,
+    Commitment,
+    DataSlice,
+    Slot,
+    SolanaRpcResponse,
+} from '@solana/rpc-types';
+
+type GetAccountInfoApiResponse<T> = (AccountInfoBase & T) | null;
+
+type GetAccountInfoApiCommonConfig = Readonly<{
+    /**
+     * Fetch the details of the account as of the highest slot that has reached this level of
+     * commitment.
+     *
+     * @defaultValue Whichever default is applied by the underlying {@link RpcApi} in use. For
+     * example, when using an API created by a `createSolanaRpc*()` helper, the default commitment
+     * is `"confirmed"` unless configured otherwise. Unmitigated by an API layer on the client, the
+     * default commitment applied by the server is `"finalized"`.
+     */
+    commitment?: Commitment;
+    /**
+     * Determines how the account data should be encoded in the response.
+     *
+     * - `'base58'` returns a tuple whose first element is the data as a base58-encoded string. If
+     *   the account contains more than 129 bytes of data, an error will be raised.
+     * - `'base64'` returns a tuple whose first element is the data as a base64-encoded string.
+     * - `'base64+zstd'` returns a tuple whose first element is the
+     *   [ZStandard](https://facebook.github.io/zstd/)-compressed data as a base64-encoded string.
+     * - `'jsonParsed'` will cause the server to attempt to process the data using a parser specific
+     *   to the account's owning program. If successful, the parsed data will be returned in the
+     *   response as JSON. Otherwise, the raw account data will be returned in the response as a
+     *   tuple whose first element is a base64-encoded string.
+     */
+    encoding: 'base58' | 'base64' | 'base64+zstd' | 'jsonParsed';
+    /**
+     * Prevents accessing stale data by enforcing that the RPC node has processed transactions up to
+     * this slot
+     */
+    minContextSlot?: Slot;
+}>;
+
+type GetAccountInfoApiSliceableCommonConfig = Readonly<{
+    /**
+     * Define which slice of the account's data you want the RPC to return.
+     *
+     * Use this to save network bandwidth and encoding time when you do not need the entire buffer.
+     *
+     * Data slicing is only available for `"base58"`, `"base64"`, and `"base64+zstd"` encodings.
+     */
+    dataSlice?: DataSlice;
+}>;
+
+export type GetAccountInfoApi = {
+    /**
+     * Fetches information associated with the account at the given address.
+     *
+     * If the account has data, it will be returned in the response as a tuple whose first element
+     * is a base64-encoded string.
+     *
+     * {@label base64}
+     * @see https://solana.com/docs/rpc/http/getaccountinfo
+     */
+    getAccountInfo(
+        address: Address,
+        config: GetAccountInfoApiCommonConfig &
+            GetAccountInfoApiSliceableCommonConfig &
+            Readonly<{
+                encoding: 'base64';
+            }>,
+    ): SolanaRpcResponse<GetAccountInfoApiResponse<AccountInfoWithBase64EncodedData>>;
+    /**
+     * Fetches information associated with the account at the given address.
+     *
+     * If the account has data, it will first be compressed using
+     * [ZStandard](https://facebook.github.io/zstd/) and the result will be returned in the response
+     * as a tuple whose first element is a base64-encoded string.
+     *
+     * {@label base64-zstd-compressed}
+     * @see https://solana.com/docs/rpc/http/getaccountinfo
+     */
+    getAccountInfo(
+        address: Address,
+        config: GetAccountInfoApiCommonConfig &
+            GetAccountInfoApiSliceableCommonConfig &
+            Readonly<{
+                encoding: 'base64+zstd';
+            }>,
+    ): SolanaRpcResponse<GetAccountInfoApiResponse<AccountInfoWithBase64EncodedZStdCompressedData>>;
+    /**
+     * Fetches information associated with the account at the given address.
+     *
+     * If the account has data, the server will attempt to process it using a parser specific to the
+     * account's owning program. If successful, the parsed data will be returned in the response as
+     * JSON. Otherwise, the raw account data will be returned in the response as a tuple whose first
+     * element is a base64-encoded string.
+     *
+     * {@label parsed}
+     * @see https://solana.com/docs/rpc/http/getaccountinfo
+     */
+    getAccountInfo(
+        address: Address,
+        config: GetAccountInfoApiCommonConfig &
+            Readonly<{
+                encoding: 'jsonParsed';
+            }>,
+    ): SolanaRpcResponse<GetAccountInfoApiResponse<AccountInfoWithJsonData>>;
+    /**
+     * Fetches information associated with the account at the given address.
+     *
+     * If the account has data, it will be returned in the response as a tuple whose first element
+     * is a base58-encoded string. If the account contains more than 129 bytes of data, this method
+     * will raise an error.
+     *
+     * {@label base58}
+     * @see https://solana.com/docs/rpc/http/getaccountinfo
+     */
+    getAccountInfo(
+        address: Address,
+        config: GetAccountInfoApiCommonConfig &
+            GetAccountInfoApiSliceableCommonConfig &
+            Readonly<{
+                encoding: 'base58';
+            }>,
+    ): SolanaRpcResponse<GetAccountInfoApiResponse<AccountInfoWithBase58EncodedData>>;
+    /**
+     * Fetches information associated with the account at the given address.
+     *
+     * If the account has data, it will be returned in the response as a base58-encoded string. If
+     * the account contains more than 129 bytes of data, this method will raise an error.
+     *
+     * {@label base58-legacy}
+     * @see https://solana.com/docs/rpc/http/getaccountinfo
+     */
+    getAccountInfo(
+        address: Address,
+        config?: Omit<GetAccountInfoApiCommonConfig, 'encoding'>,
+    ): SolanaRpcResponse<GetAccountInfoApiResponse<AccountInfoWithBase58Bytes>>;
+};

package/src/getBalance.ts

@@ -0,0 +1,31 @@
+import type { Address } from '@solana/addresses';
+import type { Commitment, Lamports, Slot, SolanaRpcResponse } from '@solana/rpc-types';
+
+type GetBalanceApiResponse = SolanaRpcResponse<Lamports>;
+
+export type GetBalanceApi = {
+    /**
+     * Fetches the Lamport balance of the account at the given address.
+     * @see https://solana.com/docs/rpc/http/getbalance
+     */
+    getBalance(
+        address: Address,
+        config?: Readonly<{
+            /**
+             * Fetch the balance of the account as of the highest slot that has reached this level
+             * of commitment.
+             *
+             * @defaultValue Whichever default is applied by the underlying {@link RpcApi} in use.
+             * For example, when using an API created by a `createSolanaRpc*()` helper, the default
+             * commitment is `"confirmed"` unless configured otherwise. Unmitigated by an API layer
+             * on the client, the default commitment applied by the server is `"finalized"`.
+             */
+            commitment?: Commitment;
+            /**
+             * Prevents accessing stale data by enforcing that the RPC node has processed
+             * transactions up to this slot
+             */
+            minContextSlot?: Slot;
+        }>,
+    ): GetBalanceApiResponse;
+};