@psalomo/jsonrpc-client 0.3.0 → 0.5.0

package/README.md

@@ -1,6 +1,6 @@
 # `@near-js/jsonrpc-client`
 
-This package provides a fully-typed client for the NEAR Protocol JSON-RPC API.
+This package provides a fully-typed, dynamic client for the NEAR Protocol JSON-RPC API. All methods and types are automatically generated from the official OpenAPI specification.
 
 ## Installation
 
@@ -13,9 +13,11 @@ pnpm add @near-js/jsonrpc-client
 Create a new client instance and call any of the available RPC methods:
 
 ```typescript
-import { JsonRpcClient } from '@near-js/jsonrpc-client';
+import { NearRpcClient } from '@near-js/jsonrpc-client';
 
-const client = new JsonRpcClient({ url: 'https://rpc.mainnet.near.org' });
+const client = new NearRpcClient({
+  endpoint: 'https://rpc.mainnet.near.org'
+});
 
 async function getNetworkStatus() {
   const status = await client.status();
@@ -27,17 +29,55 @@ getNetworkStatus();
 
 ### Handling Responses
 
-All method calls return a promise that resolves to a result object. The result object is fully typed based on the JSON-RPC API specification.
+All method calls return a promise that resolves to a fully typed result object based on the JSON-RPC API specification.
 
 ```typescript
-import { JsonRpcClient } from '@near-js/jsonrpc-client';
+import { NearRpcClient } from '@near-js/jsonrpc-client';
 
-const client = new JsonRpcClient({ url: 'https://rpc.mainnet.near.org' });
+const client = new NearRpcClient({
+  endpoint: 'https://rpc.mainnet.near.org'
+});
 
 async function getLatestBlock() {
   const block = await client.block({ finality: 'final' });
-  console.log('Latest block:', block);
+  console.log('Latest block height:', block.header?.height);
 }
 
 getLatestBlock();
 ```
+
+### Convenience Methods
+
+The client includes convenience methods for common query operations:
+
+```typescript
+// View account information
+const account = await client.viewAccount({
+  accountId: 'example.near',
+  finality: 'final'
+});
+console.log('Account balance:', account.amount);
+console.log('Storage used:', account.storageUsage);
+
+// Call view functions
+const result = await client.viewFunction({
+  accountId: 'contract.near',
+  methodName: 'get_balance',
+  finality: 'final'
+});
+
+// View access keys
+const accessKey = await client.viewAccessKey({
+  accountId: 'example.near',
+  publicKey: 'ed25519:...',
+  finality: 'final'
+});
+```
+
+## Features
+
+- **🔧 Dynamic methods**: All 28+ RPC methods automatically available
+- **📝 Fully typed**: Complete TypeScript support with proper request/response types
+- **🔄 Auto-updating**: New API methods appear automatically without code changes
+- **✅ Runtime validation**: Built-in parameter validation with helpful error messages
+- **🎯 Convenience methods**: Simplified methods for common operations like `viewAccount`

package/dist/__tests__/test-utils.d.ts

@@ -0,0 +1,5 @@
+export declare function camelToSnake(str: string): string;
+export declare function snakeToCamel(str: string): string;
+export declare function convertKeysToSnakeCase(obj: any): any;
+export declare function convertKeysToCamelCase(obj: any): any;
+//# sourceMappingURL=test-utils.d.ts.map

package/dist/__tests__/test-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../src/__tests__/test-utils.ts"],"names":[],"mappings":"AAGA,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAepD;AAED,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAepD"}