@space-rock/jsonrpc-types

TypeScript types and Valibot schemas for NEAR Protocol JSON-RPC API, automatically generated from the official OpenAPI specification.

Installation

npm install @space-rock/jsonrpc-types
# or
yarn add @space-rock/jsonrpc-types
# or
pnpm add @space-rock/jsonrpc-types

Usage

TypeScript Types

Import types for full type safety without runtime overhead:

import type { BlockReference } from '@space-rock/jsonrpc-types';

// Use types in your code
const blockRef: BlockReference = {
  finality: 'final',
};

// Types for specific methods
import type {
  ApiParams,
  ApiRequest,
  ApiResponse,
} from '@space-rock/jsonrpc-types';

// Request params type for a method
type BlockParams = ApiParams<'block'>;

// Full request type for a method
type BlockRequest = ApiRequest<'block'>;

// Response type for a method
type BlockResponse = ApiResponse<'block'>;

Integration with @space-rock/jsonrpc-client

The types package is designed to work seamlessly with the client:

import { block, createRpcClient } from '@space-rock/jsonrpc-client';
import type { ApiParams, ApiResponse } from '@space-rock/jsonrpc-types';

// Initialize client
const client = createRpcClient('https://near.lava.build:443');

const params: ApiParams<'block'> = { finality: 'final' };

// Types are automatically inferred
const response: ApiResponse<'block'> = await block(client, params);

if ('error' in response) {
  console.log(response.error.message);
} else {
  console.log(response.result.header.hash);
}

License

MIT