@olane/o-protocol 0.1.0

package/dist/schema.ts

@@ -0,0 +1,193 @@
+export const LATEST_PROTOCOL_VERSION = '1.0.0';
+
+export enum oProtocolMethods {
+  HANDSHAKE = "handshake",
+  REGISTER = "register",
+  ROUTE = "route",
+  INDEX_NETWORK = "index_network",
+  INTENT = "intent",
+  INTENT_METHOD_CONFIGURATION = "intent_method_configuration",
+}
+
+
+
+
+export interface oMethod {
+  name: string;
+  description: string;
+  parameters: oParameter[];
+  dependencies: oDependency[];
+}
+
+export const JSONRPC_VERSION = "2.0";
+
+export type ConnectionId = string;
+
+/**
+ * An opaque token used to represent a cursor for pagination.
+ */
+export type Cursor = string;
+
+export interface RequestParams {
+  _connectionId: ConnectionId;
+  _requestMethod: string;
+  [key: string]: unknown;
+}
+
+export interface Request {
+  method: string;
+  params: RequestParams;
+}
+
+export interface Notification {
+  method: string;
+  params?: {
+    _meta?: { [key: string]: unknown };
+    [key: string]: unknown;
+  };
+}
+
+export interface Result {
+  _connectionId: ConnectionId;
+  _requestMethod: string;
+  [key: string]: unknown;
+}
+
+/**
+ * A uniquely identifying ID for a request in JSON-RPC.
+ */
+export type RequestId = string | number;
+
+/**
+ * A request that expects a response.
+ */
+export interface JSONRPCRequest extends Request {
+  jsonrpc: typeof JSONRPC_VERSION;
+  id: RequestId;
+}
+
+/**
+ * A notification which does not expect a response.
+ */
+export interface JSONRPCNotification extends Notification {
+  jsonrpc: typeof JSONRPC_VERSION;
+}
+
+/**
+ * A successful (non-error) response to a request.
+ */
+export interface JSONRPCResponse {
+  jsonrpc: typeof JSONRPC_VERSION;
+  id: RequestId;
+  result: Result;
+}
+
+// Standard JSON-RPC error codes
+export const PARSE_ERROR = -32700;
+export const INVALID_REQUEST = -32600;
+export const METHOD_NOT_FOUND = -32601;
+export const INVALID_PARAMS = -32602;
+export const INTERNAL_ERROR = -32603;
+
+/**
+ * A response to a request that indicates an error occurred.
+ */
+export interface JSONRPCError {
+  jsonrpc: typeof JSONRPC_VERSION;
+  id: RequestId;
+  error: {
+    /**
+     * The error type that occurred.
+     */
+    code: number;
+    /**
+     * A short description of the error. The message SHOULD be limited to a concise single sentence.
+     */
+    message: string;
+    /**
+     * Additional information about the error. The value of this member is defined by the sender (e.g. detailed error information, nested errors etc.).
+     */
+    data?: unknown;
+  };
+}
+
+/* Empty result */
+/**
+ * A response that indicates success but carries no data.
+ */
+export type EmptyResult = Result;
+
+export interface oRequest extends JSONRPCRequest {}
+export interface oResponse extends JSONRPCResponse {}
+
+export interface oAddress {
+  transports: string[];
+  protocol: string;
+}
+
+
+export interface oDependency {
+  address: string;
+  version?: string;
+  method?: string;
+  parameters?: oParameter[];
+}
+
+
+
+
+
+
+export interface oHandshakeRequest extends JSONRPCRequest {
+  method: oProtocolMethods.HANDSHAKE;
+  params: RequestParams & {
+    address: string;
+  };
+}
+
+export interface oHandshakeResponse extends JSONRPCResponse {
+  result: {
+    _connectionId: string;
+    _requestMethod: oProtocolMethods.HANDSHAKE;
+    dependencies: oDependency[];
+    parameters: oParameter[];
+  };
+}
+
+
+
+
+export interface oRouterRequest extends JSONRPCRequest {
+  method: oProtocolMethods.ROUTE;
+  params: RequestParams & {
+    address: string;
+    payload: {
+      [key: string]: unknown;
+    };
+  };
+}
+
+export interface oParameter {
+  name: string;
+  type: string;
+  value?: any;
+  description?: string;
+  required?: boolean;
+}
+
+
+
+
+export interface oRegistrationParams extends RequestParams {
+  transports: string[];
+  peerId: string;
+  address: string;
+  protocols: string[];
+  ttl?: number;
+}
+
+export interface oRegisterRequest extends oRequest {
+  method: oProtocolMethods.REGISTER;
+  params: oRegistrationParams;
+}
+

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@olane/o-protocol",
+  "version": "0.1.0",
+  "description": "oLane Protocol specification and protocol schema",
+  "license": "MIT",
+  "author": "oLane Inc. (https://olane.com)",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "browser": "dist/index.js",
+  "node": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.js",
+      "browser": "./dist/index.js",
+      "node": "./dist/index.js",
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "prettier": {
+    "overrides": [
+      {
+        "files": "*.{md,mdx}",
+        "options": {
+          "proseWrap": "preserve"
+        }
+      }
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/olane-labs/o-protocol.git"
+  },
+  "scripts": {
+    "check": "npm run check:schema && npm run check:docs",
+    "check:schema": "npm run check:schema:ts && npm run check:schema:json",
+    "check:schema:ts": "tsc",
+    "check:schema:json": "for f in schema/*/schema.ts; do typescript-json-schema --defaultNumberType integer --required --skipLibCheck \"$f\" \"*\" | cat | cmp \"${f%ts}json\" - || exit 1; done",
+    "check:docs": "npm run check:docs:format && npm run check:docs:links",
+    "check:docs:format": "prettier --check \"**/*.{md,mdx}\"",
+    "check:docs:links": "cd docs && mintlify broken-links",
+    "generate:json": "for f in schema/*/schema.ts; do typescript-json-schema --defaultNumberType integer --required --skipLibCheck \"$f\" \"*\" -o \"${f%ts}json\"; done",
+    "format": "prettier --write \"**/*.{md,mdx}\"",
+    "serve:docs": "cd docs && mintlify dev",
+    "build": "rm -rf dist && mkdir dist && touch dist/schema.ts && webpack --config webpack.config.js && tsc"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.27.4",
+    "@babel/preset-env": "^7.27.2",
+    "@babel/preset-react": "^7.27.1",
+    "@babel/preset-typescript": "^7.27.1",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
+    "babel-loader": "^10.0.0",
+    "glob": "^11.0.0",
+    "mintlify": "^4.0.468",
+    "prettier": "^3.4.2",
+    "ts-loader": "^9.5.2",
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.2",
+    "typescript-json-schema": "^0.65.1",
+    "webpack": "^5.99.9",
+    "webpack-cli": "^6.0.1"
+  },
+  "resolutions": {
+    "fast-json-patch": "^3.1.1"
+  }
+}

package/schema/v1.0.0/schema.ts

@@ -0,0 +1,159 @@
+export const LATEST_PROTOCOL_VERSION = "1.0.0";
+
+export enum oProtocolMethods {
+  HANDSHAKE = "handshake",
+  REGISTER = "register",
+  ROUTE = "route",
+}
+export interface oDependency {
+  address: string;
+  version: string;
+  parameters: {
+    [key: string]: unknown;
+  };
+}
+export const JSONRPC_VERSION = "2.0";
+
+export type ConnectionId = string;
+
+/**
+ * An opaque token used to represent a cursor for pagination.
+ */
+export type Cursor = string;
+
+export interface RequestParams {
+  _connectionId: ConnectionId;
+  _requestMethod: string;
+  [key: string]: unknown;
+}
+
+export interface Request {
+  method: string;
+  params: RequestParams;
+}
+
+export interface Notification {
+  method: string;
+  params?: {
+    _meta?: { [key: string]: unknown };
+    [key: string]: unknown;
+  };
+}
+
+export interface Result {
+  _connectionId: ConnectionId;
+  _requestMethod: string;
+  [key: string]: unknown;
+}
+
+/**
+ * A uniquely identifying ID for a request in JSON-RPC.
+ */
+export type RequestId = string | number;
+
+/**
+ * A request that expects a response.
+ */
+export interface JSONRPCRequest extends Request {
+  jsonrpc: typeof JSONRPC_VERSION;
+  id: RequestId;
+}
+
+/**
+ * A notification which does not expect a response.
+ */
+export interface JSONRPCNotification extends Notification {
+  jsonrpc: typeof JSONRPC_VERSION;
+}
+
+/**
+ * A successful (non-error) response to a request.
+ */
+export interface JSONRPCResponse {
+  jsonrpc: typeof JSONRPC_VERSION;
+  id: RequestId;
+  result: Result;
+}
+
+// Standard JSON-RPC error codes
+export const PARSE_ERROR = -32700;
+export const INVALID_REQUEST = -32600;
+export const METHOD_NOT_FOUND = -32601;
+export const INVALID_PARAMS = -32602;
+export const INTERNAL_ERROR = -32603;
+
+/**
+ * A response to a request that indicates an error occurred.
+ */
+export interface JSONRPCError {
+  jsonrpc: typeof JSONRPC_VERSION;
+  id: RequestId;
+  error: {
+    /**
+     * The error type that occurred.
+     */
+    code: number;
+    /**
+     * A short description of the error. The message SHOULD be limited to a concise single sentence.
+     */
+    message: string;
+    /**
+     * Additional information about the error. The value of this member is defined by the sender (e.g. detailed error information, nested errors etc.).
+     */
+    data?: unknown;
+  };
+}
+
+/* Empty result */
+/**
+ * A response that indicates success but carries no data.
+ */
+export type EmptyResult = Result;
+
+export interface oRequest extends JSONRPCRequest {}
+export interface oResponse extends JSONRPCResponse {}
+
+export interface oAddress {
+  transports: string[];
+  protocol: string;
+}
+
+export interface oRouterRequest extends JSONRPCRequest {
+  method: oProtocolMethods.ROUTE;
+  params: RequestParams & {
+    address: string;
+    payload: {
+      [key: string]: unknown;
+    };
+  };
+}
+
+export interface oHandshakeRequest extends JSONRPCRequest {
+  method: oProtocolMethods.HANDSHAKE;
+  params: RequestParams & {
+    address: string;
+  };
+}
+
+export interface oHandshakeResponse extends JSONRPCResponse {
+  result: {
+    _connectionId: string;
+    _requestMethod: oProtocolMethods.HANDSHAKE;
+    method: string;
+    dependencies: oDependency[];
+    parameters: any;
+  };
+}
+
+export interface oRegistrationParams extends RequestParams {
+  transports: string[];
+  peerId: string;
+  address: string;
+  protocols: string[];
+  ttl?: number;
+}
+
+export interface oRegisterRequest extends oRequest {
+  method: oProtocolMethods.REGISTER;
+  params: oRegistrationParams;
+}

package/src/address/index.ts

@@ -0,0 +1 @@
+export * from './o-address';

package/src/address/o-address.ts

@@ -0,0 +1,4 @@
+export interface oAddress {
+  transports: string[];
+  protocol: string;
+}

package/src/config.ts

@@ -0,0 +1 @@
+export const LATEST_PROTOCOL_VERSION = '1.0.0';

package/src/dependency/index.ts

@@ -0,0 +1 @@
+export * from './o-dependency';

package/src/dependency/o-dependency.ts

@@ -0,0 +1,8 @@
+import { oParameter } from "../parameter";
+
+export interface oDependency {
+  address: string;
+  version?: string;
+  method?: string;
+  parameters?: oParameter[];
+}

package/src/enums/index.ts

@@ -0,0 +1 @@
+export * from './o-protocol-methods.enum';

package/src/enums/o-protocol-methods.enum.ts

@@ -0,0 +1,8 @@
+export enum oProtocolMethods {
+  HANDSHAKE = "handshake",
+  REGISTER = "register",
+  ROUTE = "route",
+  INDEX_NETWORK = "index_network",
+  INTENT = "intent",
+  INTENT_METHOD_CONFIGURATION = "intent_method_configuration",
+}

package/src/handshake/index.ts

@@ -0,0 +1 @@
+export * from './o-handshake';

package/src/handshake/o-handshake.ts

@@ -0,0 +1,24 @@
+import { oParameter } from "../parameter";
+import { oDependency } from "../dependency";
+import { oProtocolMethods } from "../enums";
+import {
+  JSONRPCRequest,
+  JSONRPCResponse,
+  RequestParams,
+} from "../json-rpc/json-rpc";
+
+export interface oHandshakeRequest extends JSONRPCRequest {
+  method: oProtocolMethods.HANDSHAKE;
+  params: RequestParams & {
+    address: string;
+  };
+}
+
+export interface oHandshakeResponse extends JSONRPCResponse {
+  result: {
+    _connectionId: string;
+    _requestMethod: oProtocolMethods.HANDSHAKE;
+    dependencies: oDependency[];
+    parameters: oParameter[];
+  };
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+export * from "./address";
+export * from "./dependency";
+export * from "./enums";
+export * from "./handshake";
+export * from "./json-rpc";
+export * from "./router";
+export * from "./config";
+export * from "./register";
+export * from "./parameter";
+export * from "./method";

package/src/json-rpc/index.ts

@@ -0,0 +1 @@
+export * from './json-rpc';

package/src/json-rpc/json-rpc.ts

@@ -0,0 +1,100 @@
+export const JSONRPC_VERSION = "2.0";
+
+export type ConnectionId = string;
+
+/**
+ * An opaque token used to represent a cursor for pagination.
+ */
+export type Cursor = string;
+
+export interface RequestParams {
+  _connectionId: ConnectionId;
+  _requestMethod: string;
+  [key: string]: unknown;
+}
+
+export interface Request {
+  method: string;
+  params: RequestParams;
+}
+
+export interface Notification {
+  method: string;
+  params?: {
+    _meta?: { [key: string]: unknown };
+    [key: string]: unknown;
+  };
+}
+
+export interface Result {
+  _connectionId: ConnectionId;
+  _requestMethod: string;
+  [key: string]: unknown;
+}
+
+/**
+ * A uniquely identifying ID for a request in JSON-RPC.
+ */
+export type RequestId = string | number;
+
+/**
+ * A request that expects a response.
+ */
+export interface JSONRPCRequest extends Request {
+  jsonrpc: typeof JSONRPC_VERSION;
+  id: RequestId;
+}
+
+/**
+ * A notification which does not expect a response.
+ */
+export interface JSONRPCNotification extends Notification {
+  jsonrpc: typeof JSONRPC_VERSION;
+}
+
+/**
+ * A successful (non-error) response to a request.
+ */
+export interface JSONRPCResponse {
+  jsonrpc: typeof JSONRPC_VERSION;
+  id: RequestId;
+  result: Result;
+}
+
+// Standard JSON-RPC error codes
+export const PARSE_ERROR = -32700;
+export const INVALID_REQUEST = -32600;
+export const METHOD_NOT_FOUND = -32601;
+export const INVALID_PARAMS = -32602;
+export const INTERNAL_ERROR = -32603;
+
+/**
+ * A response to a request that indicates an error occurred.
+ */
+export interface JSONRPCError {
+  jsonrpc: typeof JSONRPC_VERSION;
+  id: RequestId;
+  error: {
+    /**
+     * The error type that occurred.
+     */
+    code: number;
+    /**
+     * A short description of the error. The message SHOULD be limited to a concise single sentence.
+     */
+    message: string;
+    /**
+     * Additional information about the error. The value of this member is defined by the sender (e.g. detailed error information, nested errors etc.).
+     */
+    data?: unknown;
+  };
+}
+
+/* Empty result */
+/**
+ * A response that indicates success but carries no data.
+ */
+export type EmptyResult = Result;
+
+export interface oRequest extends JSONRPCRequest {}
+export interface oResponse extends JSONRPCResponse {}

package/src/method/index.ts

@@ -0,0 +1 @@
+export * from "./o-method";

package/src/method/o-method.ts

@@ -0,0 +1,9 @@
+import { oDependency } from "../dependency/o-dependency";
+import { oParameter } from "../parameter/o-parameter";
+
+export interface oMethod {
+  name: string;
+  description: string;
+  parameters: oParameter[];
+  dependencies: oDependency[];
+}

package/src/parameter/index.ts

@@ -0,0 +1 @@
+export * from "./o-parameter";

package/src/parameter/o-parameter.ts

@@ -0,0 +1,7 @@
+export interface oParameter {
+  name: string;
+  type: string;
+  value?: any;
+  description?: string;
+  required?: boolean;
+}

package/src/register/index.ts

@@ -0,0 +1 @@
+export * from "./o-register";

package/src/register/o-register.ts

@@ -0,0 +1,15 @@
+import { oProtocolMethods } from "../enums";
+import { oRequest, RequestParams } from "../json-rpc";
+
+export interface oRegistrationParams extends RequestParams {
+  transports: string[];
+  peerId: string;
+  address: string;
+  protocols: string[];
+  ttl?: number;
+}
+
+export interface oRegisterRequest extends oRequest {
+  method: oProtocolMethods.REGISTER;
+  params: oRegistrationParams;
+}

package/src/router/index.ts

@@ -0,0 +1 @@
+export * from './o-router';

package/src/router/o-router.ts

@@ -0,0 +1,12 @@
+import { RequestParams, JSONRPCRequest } from "../json-rpc";
+import { oProtocolMethods } from "../enums";
+
+export interface oRouterRequest extends JSONRPCRequest {
+  method: oProtocolMethods.ROUTE;
+  params: RequestParams & {
+    address: string;
+    payload: {
+      [key: string]: unknown;
+    };
+  };
+}