Feat/add rpc discover

[shanejonas]

User description

This adds

This adds rpc.discover method for OpenRPC service discovery. This enables clients to retrieve the OpenRPC schema via JSON-RPC.

Notes:

• It has to use this other way of programatically adding the method to jayson because it doesnt support rpc.

---

PR Type

Enhancement

---

Description

• Add rpc.discover OpenRPC service discovery method

• Integrate OpenRPC schema via @shardeum-foundation/api-specs

• Update method whitelist to allow rpc.discover

• Register rpc.discover in JSON-RPC server initialization

---

Changes walkthrough 📝

	Relevant files
Enhancement	rpcDiscover.ts Add rpcDiscover method for OpenRPC schema retrieval            src/methods/rpcDiscover.ts Introduce rpcDiscover method returning OpenRPC document Import OpenRPC schema from @shardeum-foundation/api-specs Export the new method for server use +7/-0      methodWhitelist.ts Allow rpc.discover in method whitelist                                      src/middlewares/methodWhitelist.ts Add rpc.discover to allowed JSON-RPC methods Ensure requests to rpc.discover are permitted +1/-1      server.ts Register rpc.discover in JSON-RPC server                                  src/server.ts Import and register rpcDiscover in JSON-RPC server Add custom handler for rpc.discover method Integrate with existing server initialization +8/-1
Dependencies	package.json Add OpenRPC schema dependency to project                                  package.json Add @shardeum-foundation/api-specs as a dependency Maintain existing dependencies and formatting +4/-3
Additional files	openrpc.json [link]

---

Need help?

Type /help how to ... in the comments thread for any questions about PR-Agent usage.

Check out the documentation for more information.

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 131 - Fully compliant Compliant requirements: Add rpc.discover OpenRPC service discovery method. Integrate OpenRPC schema via @shardeum-foundation/api-specs. Update method whitelist to allow rpc.discover. Register rpc.discover in JSON-RPC server initialization.

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🏅 Score: 85

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Version Management Policy Updates to @shardeum-foundation package versions are included in this PR. Per project policy, these should be in a separate PR or commit to avoid merge conflicts between branch lines with different versions. "@shardeum-foundation/api-specs": "^1.0.1", "@shardeum-foundation/lib-archiver-discovery": "1.3.0-prerelease.1", "@shardeum-foundation/lib-crypto-utils": "4.3.0-prerelease.1", "@shardeum-foundation/lib-types": "1.4.0-prerelease.2", Missing Unit Tests There are no unit tests added for the new rpc.discover method. Ensure that this method is covered by appropriate tests, including correct schema return and error handling. import ShardeumOpenRPCDocument from "@shardeum-foundation/api-specs" const rpcDiscover = async (): Promise<unknown> => { return ShardeumOpenRPCDocument } export default rpcDiscover

[github-actions]

Suggestion: The current implementation exposes the rpc.discover method without any authentication or rate limiting, which could allow abuse or information leakage. Consider adding appropriate access controls or rate limiting to this method to prevent misuse. [security, importance: 8]

Suggested change

	server._methods['rpc.discover'] = new jayson.Method((_args: unknown, done: jayson.JSONRPCCallbackTypePlain) => {
	rpcDiscover().then((res) => {
	done(null, res)
	}).catch((err) => {
	done(err, null)
	})
	});
	// Apply rate limiting or authentication as appropriate before exposing rpc.discover
	server._methods['rpc.discover'] = new jayson.Method((_args: unknown, done: jayson.JSONRPCCallbackTypePlain) => {
	// Example: check authentication or apply rate limiting here
	rpcDiscover().then((res) => {
	done(null, res)
	}).catch((err) => {
	done(err, null)
	})
	});