@verify-network/protocol 0.0.0-stage → 0.1.1

package/dist/request.d.ts

@@ -0,0 +1,60 @@
+import { t as RouterDomain } from "./domain-CXJsoNRU.js";
+import { Address, Hex } from "viem";
+//#region src/request.d.ts
+/**
+ * A request as the router assigns it. Nothing about it is stored; the fields are
+ * hashed into the request id, emitted, and echoed back by the fulfiller (ADR 0001).
+ * Widths follow viem: up to 48 bits are a `number`, wider a `bigint`, so a decoded
+ * request is passed to a typed ABI call unchanged. `schemas.ts` holds its schema.
+ */
+export type Request = {
+  readonly consumer: Address;
+  readonly sequence: bigint;
+  readonly fulfiller: Address;
+  readonly assignedAt: number;
+  /** What the request reserved, and the most its fulfillment can ever charge. */
+  readonly fee: bigint;
+  /** The gas price the reservation was priced at. Settlement charges at this locked price. */
+  readonly gasPrice: bigint;
+  readonly callbackGasLimit: number;
+  readonly callbackData: Hex;
+};
+/**
+ * `Config.STALE_DELAY`, in seconds: how long after its assignment a request may be reported
+ * stale (ADR 0024), and from when a fulfillment of it is settled without the premium (ADR 0025),
+ * which decays in a straight line over it (ADR 0029).
+ */
+export declare const STALE_DELAY = 30;
+/**
+ * `Config.MAX_CALLBACK_DATA_BYTES`: the most callback data a request may carry (ADR 0023). A
+ * fulfillment echoes it, so it decides how many share one transaction under the enclave's calldata
+ * bound, and so how fast a node at capacity lands them against the stale delay.
+ */
+export declare const MAX_CALLBACK_DATA_BYTES = 16384;
+/** Mirrors `Vrf.staleAt`: the first second the request is reportable as stale. */
+export declare const staleAt: (assignedAt: bigint | number) => bigint;
+/**
+ * Mirrors `Vrf.isLate`: whether the stale delay since the assignment has elapsed at `at`, the
+ * router's `block.timestamp`. The one predicate the stale report and the settlement share, so the
+ * first second a report is taken is the first second a fulfillment's premium has decayed to nothing.
+ */
+export declare const isLate: ({ assignedAt, at }: {
+  readonly assignedAt: bigint | number;
+  readonly at: bigint | number;
+}) => boolean;
+/**
+ * Mirrors `Vrf.remainingDelay`: the seconds of the stale delay the request has left at `at`, the
+ * router's `block.timestamp`. All of them in the block of its assignment, none once it is late.
+ * Over `STALE_DELAY`, it is the share of the premium a fulfillment settled then earns (ADR 0029).
+ */
+export declare const remainingDelay: ({ assignedAt, at }: {
+  readonly assignedAt: bigint | number;
+  readonly at: bigint | number;
+}) => bigint;
+/** Tags the VRF service inside the request id so no other service can collide with it. */
+export declare const SERVICE_VRF: Hex;
+/** Mirrors `Vrf.requestId` in the router. */
+export declare const requestId: ({ chainId, router, request }: RouterDomain & {
+  readonly request: Request;
+}) => Hex;
+//#endregion

package/dist/request.js

@@ -0,0 +1,61 @@
+import { encodeAbiParameters, keccak256, stringToHex } from "viem";
+//#region src/request.ts
+/**
+* `Config.STALE_DELAY`, in seconds: how long after its assignment a request may be reported
+* stale (ADR 0024), and from when a fulfillment of it is settled without the premium (ADR 0025),
+* which decays in a straight line over it (ADR 0029).
+*/
+const STALE_DELAY = 30;
+/**
+* `Config.MAX_CALLBACK_DATA_BYTES`: the most callback data a request may carry (ADR 0023). A
+* fulfillment echoes it, so it decides how many share one transaction under the enclave's calldata
+* bound, and so how fast a node at capacity lands them against the stale delay.
+*/
+const MAX_CALLBACK_DATA_BYTES = 16384;
+/** Mirrors `Vrf.staleAt`: the first second the request is reportable as stale. */
+const staleAt = (assignedAt) => BigInt(assignedAt) + BigInt(30);
+/**
+* Mirrors `Vrf.isLate`: whether the stale delay since the assignment has elapsed at `at`, the
+* router's `block.timestamp`. The one predicate the stale report and the settlement share, so the
+* first second a report is taken is the first second a fulfillment's premium has decayed to nothing.
+*/
+const isLate = ({ assignedAt, at }) => BigInt(at) >= staleAt(assignedAt);
+/**
+* Mirrors `Vrf.remainingDelay`: the seconds of the stale delay the request has left at `at`, the
+* router's `block.timestamp`. All of them in the block of its assignment, none once it is late.
+* Over `STALE_DELAY`, it is the share of the premium a fulfillment settled then earns (ADR 0029).
+*/
+const remainingDelay = ({ assignedAt, at }) => isLate({
+	assignedAt,
+	at
+}) ? 0n : staleAt(assignedAt) - BigInt(at);
+/** Tags the VRF service inside the request id so no other service can collide with it. */
+const SERVICE_VRF = keccak256(stringToHex("VerifyNetworkVRF"));
+/** Mirrors `Vrf.requestId` in the router. */
+const requestId = ({ chainId, router, request }) => keccak256(encodeAbiParameters([
+	{ type: "uint256" },
+	{ type: "address" },
+	{ type: "bytes32" },
+	{ type: "address" },
+	{ type: "uint64" },
+	{ type: "address" },
+	{ type: "uint40" },
+	{ type: "uint96" },
+	{ type: "uint96" },
+	{ type: "uint32" },
+	{ type: "bytes32" }
+], [
+	BigInt(chainId),
+	router,
+	SERVICE_VRF,
+	request.consumer,
+	request.sequence,
+	request.fulfiller,
+	request.assignedAt,
+	request.fee,
+	request.gasPrice,
+	request.callbackGasLimit,
+	keccak256(request.callbackData)
+]));
+//#endregion
+export { MAX_CALLBACK_DATA_BYTES, SERVICE_VRF, STALE_DELAY, isLate, remainingDelay, requestId, staleAt };

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@verify-network/protocol",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "The Verify Network VRF protocol off-chain: ECVRF prove and verify, request ids, fulfillment typed data, router events and fees, and the router watch and direct-request client.",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./ecvrf": {
+      "types": "./dist/ecvrf.d.ts",
+      "default": "./dist/ecvrf.js"
+    },
+    "./event": {
+      "types": "./dist/event.d.ts",
+      "default": "./dist/event.js"
+    },
+    "./fee": {
+      "types": "./dist/fee.d.ts",
+      "default": "./dist/fee.js"
+    },
+    "./fulfillment": {
+      "types": "./dist/fulfillment.d.ts",
+      "default": "./dist/fulfillment.js"
+    },
+    "./request": {
+      "types": "./dist/request.d.ts",
+      "default": "./dist/request.js"
+    }
+  },
+  "scripts": {
+    "build": "vp pack",
+    "prepack": "vp pack && node ../../scripts/publish-manifest.ts apply",
+    "postpack": "node ../../scripts/publish-manifest.ts restore",
+    "test": "vp test",
+    "type-check": "tsc"
+  },
+  "dependencies": {
+    "@noble/curves": "^2.4.0",
+    "@noble/hashes": "^2.4.0"
+  },
+  "peerDependencies": {
+    "effect": "^4.0.0",
+    "viem": "^2.56.3"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}