@xyo-network/xl1-rpc-server

Node HTTP JSON-RPC server adapter for XL1 RPC engines.

Description

XL1 is the XYO Layer One blockchain protocol. This package exposes a Node HTTP server for an XL1 JSON-RPC engine. It is infrastructure glue for node services, indexers, and local test fixtures that already have an engine and need a POST /rpc endpoint.

Application clients should normally use GatewayBuilder from @xyo-network/xl1-sdk/gateway instead of writing JSON-RPC requests by hand.

Install

Using npm:

npm i --save @xyo-network/xl1-rpc-server

Using yarn:

yarn add @xyo-network/xl1-rpc-server

Using pnpm:

pnpm add @xyo-network/xl1-rpc-server

Using bun:

bun add @xyo-network/xl1-rpc-server

Usage

Create a standalone server from a JSON-RPC engine:

import { createRpcHttpServer } from '@xyo-network/xl1-rpc-server'

const { close, port } = await createRpcHttpServer({ engine, port: 8080 })

console.log(`XL1 RPC listening at http://localhost:${port}/rpc`)
await close()

For framework integration, use the lower-level request handler:

import { createRpcRequestHandler } from '@xyo-network/xl1-rpc-server'

const handleRpc = createRpcRequestHandler(engine)
const response = await handleRpc(requestBody)

Documentation

• createRpcHttpServer binds a Node http.Server to POST /rpc.
• createRpcRequestHandler converts unknown request bodies into engine responses.
• The package expects an engine from @ariestools/json-rpc-engine.
• SDK consumers should prefer typed gateway APIs over direct RPC envelopes.

AI Agent Skills

Install the recommended XL1/XYO skills with Skills.sh:

npx skills add XYOracleNetwork/xyo-skills --all

In XY toolchain repos, the equivalent convenience command is:

pnpm xy skills defaults
pnpm xy skills lint --fix

For XL1 work, ask your agent to use xyo-knowledge, xl1-knowledge, and xl1-patterns. These skills cover XYO primitives, XL1 chain and gateway APIs, and application patterns for XL1 dApps.

Building Locally

pnpm xy build @xyo-network/xl1-rpc-server
pnpm xy test @xyo-network/xl1-rpc-server
pnpm xy lint @xyo-network/xl1-rpc-server

License

See the repository LICENSE file for license rights and limitations (LGPL-3.0-only).

Credits

Made with 🔥 and ❄️ by XYO Foundation