📦 Deliverables: Code generation, GitHub automation, NPM packages, documentation, testing<hr><h3 class="heading-node">📘 Background</h3>The NEAR Protocol provides an <a class="link" href="https://github.com/near/nearcore/blob/master/chain/jsonrpc/openapi/openapi.json" target="_blank">OpenAPI specification [link]</a> for its <a class="link" href="https://docs.near.org/api/rpc/introduction" target="_blank">JSON-RPC interface [link]</a> (there is also <a class="link" href="https://github.com/near/nearcore/blob/master/chain/jsonrpc/openapi/progenitor.json" target="_blank">a patched version for Rust client [link]</a> which might or might not work better) , but a high-quality, type-safe TypeScript client is still missing from the ecosystem.We’re looking for an experienced TypeScript/Node.js developer or small team to automate the generation and packaging of a developer-friendly TypeScript client using the OpenAPI spec from the <code class="inline" spellcheck="false">nearcore</code> repository.This tool will serve as a public good: it must be fully automated, thoroughly documented, well-tested, and published under a permissive license for long-term use and contribution.<hr><h3 class="heading-node">🧩 Scope of Work</h3><h4 class="heading-node">1. OpenAPI Parsing &amp; TypeScript Code Generation</h4><ul class="list-node"><li>Parse the OpenAPI spec provided in the <code class="inline" spellcheck="false">nearcore</code> repo. WARNING: The OpenAPI spec does not exactly match nearcore’s JSON-RPC implementation. The spec uses unique paths for each method while the actual JSON-RPC implementation expects that the path is the same - <code class="inline" spellcheck="false">/</code>, so you must patch the generated code to skip using the paths.</li><li>Generate a fully type-safe TypeScript client with:<ul class="list-node"><li><code class="inline" spellcheck="false">fetch</code>-based RPC calls</li><li>Zod-based input/output validation</li><li>Automatic conversion from <code class="inline" spellcheck="false">snake_case</code> (from API) to <code class="inline" spellcheck="false">camelCase</code> (TypeScript)</li></ul></li></ul><h4 class="heading-node">2. Two NPM Packages</h4><ul class="list-node"><li>Package A: <code class="inline" spellcheck="false">@near-js/jsonrpc-types</code><ul class="list-node"><li>Contains only types and Zod schemas</li><li>Lightweight, tree-shakable</li></ul></li><li>Package B: <code class="inline" spellcheck="false">@near-js/jsonrpc-client</code><ul class="list-node"><li>Depends on <code class="inline" spellcheck="false">@near-js/jsonrpc-types</code></li><li>Includes all RPC method implementations using <code class="inline" spellcheck="false">fetch</code> and auto-typed requests/responses</li></ul></li></ul><h4 class="heading-node">3. GitHub Actions Automation</h4><ul class="list-node"><li>Set up CI/CD to:<ul class="list-node"><li>Fetch the latest OpenAPI spec on push or schedule</li><li>Regenerate code and types</li><li>Submit a PR to the repo to run CI tests and get humans review</li><li>Once the PR is merged, release-please automation must pick it up to bump a version and create a new PR with a proposal to make a release (it can be skipped or ignored)</li></ul></li></ul><h4 class="heading-node">4. Testing Suite</h4><ul class="list-node"><li>Unit tests for type safety and runtime validation</li><li>Integration tests (mocking or optional real RPC endpoint)</li></ul><h4 class="heading-node">5. Documentation</h4><ul class="list-node"><li>README and usage examples for both packages</li><li>Instructions for contributing and regenerating code</li><li>Deployment workflow documentation (e.g., how GitHub Actions publishes to NPM)</li></ul><hr><h3 class="heading-node">✅ Deliverables</h3><ul class="list-node"><li>✅ Full codebase in a new public GitHub repository (MIT or Apache-2.0 licensed)</li><li>✅ Two published NPM packages: <code class="inline" spellcheck="false">@near-js/jsonrpc-types</code> and <code class="inline" spellcheck="false">@near-js/jsonrpc-client</code></li><li>✅ GitHub Actions automation for regeneration, testing, and publishing</li><li>✅ 80%+ test coverage for core functionality</li><li>✅ Developer-focused documentation for use and contribution</li></ul><hr><h3 class="heading-node">🧪 Tech Stack</h3><ul class="list-node"><li>TypeScript (strict mode)</li><li>Zod for runtime validation</li><li>Fetch API (or compatible polyfill for Node.js)</li><li>OpenAPI tooling (e.g., <code class="inline" spellcheck="false">openapi-typescript</code>, <code class="inline" spellcheck="false">zod-openapi</code>, or custom tooling)</li><li>GitHub Actions for automation</li><li>Jest / Vitest or similar for testing</li></ul><hr><h3 class="heading-node">💰 Budget &amp; Timeline</h3><ul class="list-node"><li>Budget: 3,000 NEAR<ul class="list-node"><li>This includes all automation, testing, documentation, and NPM publishing</li></ul></li><li>Timeline: Flexible, but preferred delivery within 3-4 weeks</li><li>Payment: lump sum upon successful delivery</li><li>Winner selection: The best complete solution submitted by the deadline of the bounty will be selected 2 days after the bounty deadline. The submissions are private while the competition is ongoing. Tip: Consider running your implementation against the community in chats (see them at the end of the description)</li></ul><hr><h3 class="heading-node">🌱 Why This Matters</h3>This project will fill a critical gap in the NEAR developer experience—making RPC integration simpler, safer, and more productive for frontend, backend, and tooling developers alike.It will be open-source and publicly maintained for the benefit of the NEAR community.<hr><h3 class="heading-node">🚀 Ready to Apply?</h3>Submit a comment with:<ul class="list-node"><li>A short description of your relevant experience</li><li>Estimated timeline (if different)</li><li>Any clarifying questions</li></ul><hr>Join community chats to ask for feedback and discuss technical questions:<ul class="list-node tight" data-tight="true"><li>Telegram: <a class="link" href="https://t.me/NEAR_Tools_Community_Group" target="_blank">@NEAR_Tools_Community_Group,</a> <a class="link" href="https://t.me/neardev" target="_blank">@NEARDev</a></li></ul><hr><h3 class="heading-node">🔒 Internal Info (for tracking only)</h3><ul class="list-node"><li>DevHub Area: DevTools</li><li>DevHub Moderator: Vlad Frolov</li></ul>

Automate Generation of TypeScript RPC Client for NEAR Protocol

Automate Generation of TypeScript RPC Client for NEAR Protocol

Status: Reviewed

3,000NEAR Total Prizes
3,000 NEAR 1st