@psalomo/jsonrpc-client 0.3.0 → 0.5.0

package/dist/index.d.mts

@@ -1,5 +1,61 @@
-export { JsonRpcErrorSchema, JsonRpcRequestSchema, JsonRpcResponseSchema, RPC_METHODS } from '@near-js/jsonrpc-types';
+import { RpcStateChangesInBlockByTypeRequest, RpcStateChangesInBlockResponse, RpcStateChangesInBlockRequest, RpcStateChangesInBlockByTypeResponse, RpcCongestionLevelRequest, RpcCongestionLevelResponse, GenesisConfigRequest, GenesisConfig, RpcLightClientBlockProofRequest, RpcLightClientBlockProofResponse, RpcLightClientExecutionProofRequest, RpcLightClientExecutionProofResponse, RpcMaintenanceWindowsRequest, EXPERIMENTALMaintenanceWindowsResponse, RpcProtocolConfigRequest, RpcProtocolConfigResponse, RpcReceiptRequest, RpcReceiptResponse, RpcSplitStorageInfoRequest, RpcSplitStorageInfoResponse, RpcTransactionStatusRequest, RpcTransactionResponse, RpcValidatorsOrderedRequest, EXPERIMENTALValidatorsOrderedResponse, RpcBlockRequest, RpcBlockResponse, RpcSendTransactionRequest, CryptoHash, RpcChunkRequest, RpcChunkResponse, RpcClientConfigRequest, RpcClientConfigResponse, RpcGasPriceRequest, RpcGasPriceResponse, RpcHealthRequest, RpcHealthResponse, RpcNetworkInfoRequest, RpcNetworkInfoResponse, RpcLightClientNextBlockRequest, RpcLightClientNextBlockResponse, RpcQueryRequest, RpcQueryResponse, RpcStatusRequest, RpcStatusResponse, RpcValidatorRequest, RpcValidatorResponse, AccountView, CallResult, AccessKeyView, RPC_METHODS } from '@near-js/jsonrpc-types';
+export { JsonRpcRequestSchema, JsonRpcResponseSchema, RPC_METHODS } from '@near-js/jsonrpc-types';
 
+interface DynamicRpcMethods {
+    experimentalChanges(params?: RpcStateChangesInBlockByTypeRequest): Promise<RpcStateChangesInBlockResponse>;
+    experimentalChangesInBlock(params?: RpcStateChangesInBlockRequest): Promise<RpcStateChangesInBlockByTypeResponse>;
+    experimentalCongestionLevel(params?: RpcCongestionLevelRequest): Promise<RpcCongestionLevelResponse>;
+    experimentalGenesisConfig(params?: GenesisConfigRequest): Promise<GenesisConfig>;
+    experimentalLightClientBlockProof(params?: RpcLightClientBlockProofRequest): Promise<RpcLightClientBlockProofResponse>;
+    experimentalLightClientProof(params?: RpcLightClientExecutionProofRequest): Promise<RpcLightClientExecutionProofResponse>;
+    experimentalMaintenanceWindows(params?: RpcMaintenanceWindowsRequest): Promise<EXPERIMENTALMaintenanceWindowsResponse>;
+    experimentalProtocolConfig(params?: RpcProtocolConfigRequest): Promise<RpcProtocolConfigResponse>;
+    experimentalReceipt(params?: RpcReceiptRequest): Promise<RpcReceiptResponse>;
+    experimentalSplitStorageInfo(params?: RpcSplitStorageInfoRequest): Promise<RpcSplitStorageInfoResponse>;
+    experimentalTxStatus(params?: RpcTransactionStatusRequest): Promise<RpcTransactionResponse>;
+    experimentalValidatorsOrdered(params?: RpcValidatorsOrderedRequest): Promise<EXPERIMENTALValidatorsOrderedResponse>;
+    block(params?: RpcBlockRequest): Promise<RpcBlockResponse>;
+    broadcastTxAsync(params?: RpcSendTransactionRequest): Promise<CryptoHash>;
+    broadcastTxCommit(params?: RpcSendTransactionRequest): Promise<RpcTransactionResponse>;
+    changes(params?: RpcStateChangesInBlockByTypeRequest): Promise<RpcStateChangesInBlockResponse>;
+    chunk(params?: RpcChunkRequest): Promise<RpcChunkResponse>;
+    clientConfig(params?: RpcClientConfigRequest): Promise<RpcClientConfigResponse>;
+    gasPrice(params?: RpcGasPriceRequest): Promise<RpcGasPriceResponse>;
+    health(params?: RpcHealthRequest): Promise<RpcHealthResponse>;
+    lightClientProof(params?: RpcLightClientExecutionProofRequest): Promise<RpcLightClientExecutionProofResponse>;
+    networkInfo(params?: RpcNetworkInfoRequest): Promise<RpcNetworkInfoResponse>;
+    nextLightClientBlock(params?: RpcLightClientNextBlockRequest): Promise<RpcLightClientNextBlockResponse>;
+    query(params?: RpcQueryRequest): Promise<RpcQueryResponse>;
+    sendTx(params?: RpcSendTransactionRequest): Promise<RpcTransactionResponse>;
+    status(params?: RpcStatusRequest): Promise<RpcStatusResponse>;
+    tx(params?: RpcTransactionStatusRequest): Promise<RpcTransactionResponse>;
+    validators(params?: RpcValidatorRequest): Promise<RpcValidatorResponse>;
+}
+interface ConvenienceMethods {
+    viewAccount(params: {
+        accountId: string;
+        finality?: 'final' | 'near-final' | 'optimistic';
+        blockId?: string | number;
+    }): Promise<AccountView>;
+    viewFunction(params: {
+        accountId: string;
+        methodName: string;
+        argsBase64?: string;
+        finality?: 'final' | 'near-final' | 'optimistic';
+        blockId?: string | number;
+    }): Promise<CallResult>;
+    viewAccessKey(params: {
+        accountId: string;
+        publicKey: string;
+        finality?: 'final' | 'near-final' | 'optimistic';
+        blockId?: string | number;
+    }): Promise<AccessKeyView>;
+}
+interface CompleteClientInterface extends DynamicRpcMethods, ConvenienceMethods {
+    call<TParams = unknown, TResult = unknown>(method: string, params?: TParams): Promise<TResult>;
+}
+
+type RpcMethod = (typeof RPC_METHODS)[number];
 interface ClientConfig {
     endpoint: string;
     headers?: Record<string, string>;
@@ -33,186 +89,25 @@ declare class JsonRpcNetworkError extends Error {
     originalError: Error;
     constructor(message: string, originalError: Error);
 }
+
 declare class NearRpcClient {
     private endpoint;
     private headers;
     private timeout;
     private retries;
     private validateResponses;
-    private requestIdCounter;
     constructor(config: string | ClientConfig);
     /**
-     * Generate a unique request ID
+     * Get request ID matching NEAR RPC documentation examples
      */
-    private generateRequestId;
+    private getRequestId;
     /**
      * Make a raw JSON-RPC call
+     * This method is public to allow dynamic calls to any RPC method
      */
-    private call;
-    /**
-     * Get node status
-     */
-    status(): Promise<any>;
-    /**
-     * Get block information
-     */
-    block(params?: {
-        blockId?: string | number;
-        finality?: 'final' | 'near-final' | 'optimistic';
-    }): Promise<any>;
-    /**
-     * Get current gas price
-     */
-    gasPrice(params?: {
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get chunk information
-     */
-    chunk(params: {
-        chunkId: string;
-    } | {
-        blockId: string | number;
-        shardId: number;
-    }): Promise<any>;
-    /**
-     * Health check
-     */
-    health(): Promise<any>;
-    /**
-     * Get network information
-     */
-    networkInfo(): Promise<any>;
-    /**
-     * Get current validators
-     */
-    validators(params?: {
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get client configuration
-     */
-    clientConfig(): Promise<any>;
-    /**
-     * Broadcast transaction asynchronously
-     */
-    broadcastTxAsync(params: {
-        signedTxBase64: string;
-    }): Promise<any>;
-    /**
-     * Broadcast transaction and wait for commit
-     */
-    broadcastTxCommit(params: {
-        signedTxBase64: string;
-    }): Promise<any>;
-    /**
-     * Send transaction
-     */
-    sendTx(params: {
-        signedTxBase64: string;
-    }): Promise<any>;
-    /**
-     * Get transaction status
-     */
-    tx(params: {
-        txHash: string;
-        senderAccountId: string;
-    }): Promise<any>;
-    /**
-     * Query account/contract state
-     */
-    query(params: {
-        requestType: string;
-        finality?: 'final' | 'near-final' | 'optimistic';
-        blockId?: string | number;
-        accountId?: string;
-        methodName?: string;
-        argsBase64?: string;
-        publicKey?: string;
-        keyType?: string;
-    }): Promise<any>;
-    /**
-     * View account information (convenience method)
-     */
-    viewAccount(params: {
-        accountId: string;
-        finality?: 'final' | 'near-final' | 'optimistic';
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * View function call (convenience method)
-     */
-    viewFunction(params: {
-        accountId: string;
-        methodName: string;
-        argsBase64?: string;
-        finality?: 'final' | 'near-final' | 'optimistic';
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * View access key (convenience method)
-     */
-    viewAccessKey(params: {
-        accountId: string;
-        publicKey: string;
-        finality?: 'final' | 'near-final' | 'optimistic';
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get light client proof
-     */
-    lightClientProof(params: {
-        type: string;
-        lightClientHead: string;
-        transactionHash?: string;
-        senderId?: string;
-        receiptId?: string;
-    }): Promise<any>;
-    /**
-     * Get state changes (experimental)
-     */
-    experimentalChanges(params: {
-        changesType: string;
-        accountIds?: string[];
-        keyPrefixBase64?: string;
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get state changes in block (experimental)
-     */
-    experimentalChangesInBlock(params: {
-        blockId: string | number;
-    }): Promise<any>;
-    /**
-     * Get ordered validators (experimental)
-     */
-    experimentalValidatorsOrdered(params?: {
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get protocol configuration (experimental)
-     */
-    experimentalProtocolConfig(params?: {
-        blockId?: string | number;
-        finality?: 'final' | 'near-final' | 'optimistic';
-    }): Promise<any>;
-    /**
-     * Get genesis configuration (experimental)
-     */
-    experimentalGenesisConfig(): Promise<any>;
-    /**
-     * Get receipt information (experimental)
-     */
-    experimentalReceipt(params: {
-        receiptId: string;
-    }): Promise<any>;
-    /**
-     * Get transaction status (experimental)
-     */
-    experimentalTxStatus(params: {
-        txHash: string;
-        senderAccountId: string;
-    }): Promise<any>;
+    call<TParams = unknown, TResult = unknown>(method: RpcMethod, params?: TParams): Promise<TResult>;
+}
+interface NearRpcClient extends DynamicRpcMethods, ConvenienceMethods {
 }
 
 interface RpcRequest {
@@ -238,4 +133,4 @@ declare class NearRpcError extends Error {
     constructor(code: number, message: string, data?: unknown | undefined);
 }
 
-export { type ClientConfig, JsonRpcClientError, type JsonRpcError, JsonRpcNetworkError, type JsonRpcRequest, type JsonRpcResponse, NearRpcClient, NearRpcError, type RpcError, type RpcRequest, type RpcResponse, NearRpcClient as default };
+export { type ClientConfig, type CompleteClientInterface, type ConvenienceMethods, type DynamicRpcMethods, JsonRpcClientError, type JsonRpcError, JsonRpcNetworkError, type JsonRpcRequest, type JsonRpcResponse, NearRpcClient, NearRpcError, type RpcError, type RpcRequest, type RpcResponse, NearRpcClient as default };

package/dist/index.d.ts

@@ -1,241 +1,7 @@
-export { JsonRpcErrorSchema, JsonRpcRequestSchema, JsonRpcResponseSchema, RPC_METHODS } from '@near-js/jsonrpc-types';
-
-interface ClientConfig {
-    endpoint: string;
-    headers?: Record<string, string>;
-    timeout?: number;
-    retries?: number;
-    validateResponses?: boolean;
-}
-interface JsonRpcRequest<T = unknown> {
-    jsonrpc: '2.0';
-    id: string;
-    method: string;
-    params?: T;
-}
-interface JsonRpcResponse<T = unknown> {
-    jsonrpc: '2.0';
-    id: string;
-    result?: T;
-    error?: JsonRpcError;
-}
-interface JsonRpcError {
-    code: number;
-    message: string;
-    data?: unknown;
-}
-declare class JsonRpcClientError extends Error {
-    code?: number | undefined;
-    data?: unknown | undefined;
-    constructor(message: string, code?: number | undefined, data?: unknown | undefined);
-}
-declare class JsonRpcNetworkError extends Error {
-    originalError: Error;
-    constructor(message: string, originalError: Error);
-}
-declare class NearRpcClient {
-    private endpoint;
-    private headers;
-    private timeout;
-    private retries;
-    private validateResponses;
-    private requestIdCounter;
-    constructor(config: string | ClientConfig);
-    /**
-     * Generate a unique request ID
-     */
-    private generateRequestId;
-    /**
-     * Make a raw JSON-RPC call
-     */
-    private call;
-    /**
-     * Get node status
-     */
-    status(): Promise<any>;
-    /**
-     * Get block information
-     */
-    block(params?: {
-        blockId?: string | number;
-        finality?: 'final' | 'near-final' | 'optimistic';
-    }): Promise<any>;
-    /**
-     * Get current gas price
-     */
-    gasPrice(params?: {
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get chunk information
-     */
-    chunk(params: {
-        chunkId: string;
-    } | {
-        blockId: string | number;
-        shardId: number;
-    }): Promise<any>;
-    /**
-     * Health check
-     */
-    health(): Promise<any>;
-    /**
-     * Get network information
-     */
-    networkInfo(): Promise<any>;
-    /**
-     * Get current validators
-     */
-    validators(params?: {
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get client configuration
-     */
-    clientConfig(): Promise<any>;
-    /**
-     * Broadcast transaction asynchronously
-     */
-    broadcastTxAsync(params: {
-        signedTxBase64: string;
-    }): Promise<any>;
-    /**
-     * Broadcast transaction and wait for commit
-     */
-    broadcastTxCommit(params: {
-        signedTxBase64: string;
-    }): Promise<any>;
-    /**
-     * Send transaction
-     */
-    sendTx(params: {
-        signedTxBase64: string;
-    }): Promise<any>;
-    /**
-     * Get transaction status
-     */
-    tx(params: {
-        txHash: string;
-        senderAccountId: string;
-    }): Promise<any>;
-    /**
-     * Query account/contract state
-     */
-    query(params: {
-        requestType: string;
-        finality?: 'final' | 'near-final' | 'optimistic';
-        blockId?: string | number;
-        accountId?: string;
-        methodName?: string;
-        argsBase64?: string;
-        publicKey?: string;
-        keyType?: string;
-    }): Promise<any>;
-    /**
-     * View account information (convenience method)
-     */
-    viewAccount(params: {
-        accountId: string;
-        finality?: 'final' | 'near-final' | 'optimistic';
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * View function call (convenience method)
-     */
-    viewFunction(params: {
-        accountId: string;
-        methodName: string;
-        argsBase64?: string;
-        finality?: 'final' | 'near-final' | 'optimistic';
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * View access key (convenience method)
-     */
-    viewAccessKey(params: {
-        accountId: string;
-        publicKey: string;
-        finality?: 'final' | 'near-final' | 'optimistic';
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get light client proof
-     */
-    lightClientProof(params: {
-        type: string;
-        lightClientHead: string;
-        transactionHash?: string;
-        senderId?: string;
-        receiptId?: string;
-    }): Promise<any>;
-    /**
-     * Get state changes (experimental)
-     */
-    experimentalChanges(params: {
-        changesType: string;
-        accountIds?: string[];
-        keyPrefixBase64?: string;
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get state changes in block (experimental)
-     */
-    experimentalChangesInBlock(params: {
-        blockId: string | number;
-    }): Promise<any>;
-    /**
-     * Get ordered validators (experimental)
-     */
-    experimentalValidatorsOrdered(params?: {
-        blockId?: string | number;
-    }): Promise<any>;
-    /**
-     * Get protocol configuration (experimental)
-     */
-    experimentalProtocolConfig(params?: {
-        blockId?: string | number;
-        finality?: 'final' | 'near-final' | 'optimistic';
-    }): Promise<any>;
-    /**
-     * Get genesis configuration (experimental)
-     */
-    experimentalGenesisConfig(): Promise<any>;
-    /**
-     * Get receipt information (experimental)
-     */
-    experimentalReceipt(params: {
-        receiptId: string;
-    }): Promise<any>;
-    /**
-     * Get transaction status (experimental)
-     */
-    experimentalTxStatus(params: {
-        txHash: string;
-        senderAccountId: string;
-    }): Promise<any>;
-}
-
-interface RpcRequest {
-    jsonrpc: '2.0';
-    id: string | number;
-    method: string;
-    params: unknown;
-}
-interface RpcResponse<T = unknown> {
-    jsonrpc: '2.0';
-    id: string | number;
-    result?: T;
-    error?: RpcError;
-}
-interface RpcError {
-    code: number;
-    message: string;
-    data?: unknown;
-}
-declare class NearRpcError extends Error {
-    code: number;
-    data?: unknown | undefined;
-    constructor(code: number, message: string, data?: unknown | undefined);
-}
-
-export { type ClientConfig, JsonRpcClientError, type JsonRpcError, JsonRpcNetworkError, type JsonRpcRequest, type JsonRpcResponse, NearRpcClient, NearRpcError, type RpcError, type RpcRequest, type RpcResponse, NearRpcClient as default };
+export * from './client';
+export * from './types';
+export * from './generated-types';
+export { JsonRpcRequestSchema, JsonRpcResponseSchema, } from '@near-js/jsonrpc-types';
+export { RPC_METHODS } from '@near-js/jsonrpc-types';
+export { NearRpcClient as default } from './client';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAGlC,OAAO,EACL,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAGrD,OAAO,EAAE,aAAa,IAAI,OAAO,EAAE,MAAM,UAAU,CAAC"}