@xyo-network/chain-reward-redemption 1.20.14 → 1.20.16

package/README.md

@@ -1,388 +1,24 @@
 # @xyo-network/chain-reward-redemption
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![socket-badge][]][socket-link]
+> XYO Layer One Rewards
 
-XYO Layer One Rewards
+## Install
 
-
-
-## Reference
-
-**@xyo-network/chain-reward-redemption**
-
-***
-
-## Functions
-
-- [getApp](#functions/getApp)
-- [getServer](#functions/getServer)
-
-### functions
-
-  ### <a id="getApp"></a>getApp
-
-[**@xyo-network/chain-reward-redemption**](#../README)
-
-***
-
-```ts
-function getApp(node, config): Express;
+```sh
+{{pm}} add {{name}}
 ```
 
-## Parameters
-
-### node
-
-`NodeInstance`
-
-### config
-
-### api
-
-\{
-  `host`: `string`;
-  `initRewardsCache`: `boolean`;
-  `mnemonic?`: `string`;
-  `port`: `number`;
-\}
-
-### api.host
-
-`string`
-
-### api.initRewardsCache
-
-`boolean`
-
-### api.mnemonic?
-
-`string`
-
-### api.port
-
-`number`
-
-### app
-
-\{
-  `port`: `number`;
-\}
-
-### app.port
-
-`number`
-
-### bridge
-
-\{
-  `host`: `string`;
-  `mnemonic?`: `string`;
-  `port`: `number`;
-\}
-
-### bridge.host
-
-`string`
-
-### bridge.mnemonic?
-
-`string`
-
-### bridge.port
-
-`number`
-
-### chain
-
-\{
-  `id?`: `string`;
-\}
-
-### chain.id?
-
-`string`
-
-### evm
-
-\{
-  `chainId?`: `string`;
-  `infura?`: \{
-     `projectId?`: `string`;
-     `projectSecret?`: `string`;
-  \};
-  `jsonRpc?`: \{
-     `url?`: `string`;
-  \};
-\}
-
-### evm.chainId?
-
-`string`
-
-### evm.infura?
-
-\{
-  `projectId?`: `string`;
-  `projectSecret?`: `string`;
-\}
-
-### evm.infura.projectId?
-
-`string`
-
-### evm.infura.projectSecret?
-
-`string`
-
-### evm.jsonRpc?
-
-\{
-  `url?`: `string`;
-\}
-
-### evm.jsonRpc.url?
-
-`string`
-
-### mempool
-
-\{
-  `enabled`: `boolean`;
-  `host`: `string`;
-  `mnemonic?`: `string`;
-  `port`: `number`;
-\}
-
-### mempool.enabled
-
-`boolean`
-
-### mempool.host
-
-`string`
-
-### mempool.mnemonic?
-
-`string`
-
-### mempool.port
-
-`number`
-
-### producer
-
-\{
-  `allowlist?`: `Address`[];
-  `disableIntentRedeclaration?`: `boolean`;
-  `healthCheckPort?`: `number`;
-  `heartbeatInterval`: `number`;
-  `minStake`: `number`;
-  `mnemonic?`: `string`;
-  `port`: `number`;
-  `rewardAddress?`: `string`;
-\}
-
-### producer.allowlist?
-
-`Address`[]
-
-### producer.disableIntentRedeclaration?
-
-`boolean`
-
-### producer.healthCheckPort?
-
-`number`
-
-### producer.heartbeatInterval
-
-`number`
-
-### producer.minStake
-
-`number`
-
-### producer.mnemonic?
-
-`string`
-
-### producer.port
-
-`number`
-
-### producer.rewardAddress?
-
-`string`
-
-### rewardRedemptionApi
-
-\{
-  `chainRpcApiUrl`: `string`;
-  `host`: `string`;
-  `mnemonic?`: `string`;
-  `port`: `number`;
-\}
-
-### rewardRedemptionApi.chainRpcApiUrl
-
-`string`
-
-### rewardRedemptionApi.host
-
-`string`
-
-### rewardRedemptionApi.mnemonic?
-
-`string`
-
-### rewardRedemptionApi.port
-
-`number`
-
-### storage
-
-\{
-  `mongo?`: \{
-     `connectionString?`: `string`;
-     `database?`: `string`;
-     `domain?`: `string`;
-     `password?`: `string`;
-     `username?`: `string`;
-  \};
-  `root?`: `string`;
-\}
-
-### storage.mongo?
-
-\{
-  `connectionString?`: `string`;
-  `database?`: `string`;
-  `domain?`: `string`;
-  `password?`: `string`;
-  `username?`: `string`;
-\}
-
-### storage.mongo.connectionString?
-
-`string`
-
-### storage.mongo.database?
-
-`string`
-
-### storage.mongo.domain?
-
-`string`
-
-### storage.mongo.password?
-
-`string`
-
-### storage.mongo.username?
-
-`string`
-
-### storage.root?
-
-`string`
-
-### telemetry
-
-\{
-  `otel?`: \{
-     `otlpEndpoint?`: `string`;
-  \};
-\}
-
-### telemetry.otel?
-
-\{
-  `otlpEndpoint?`: `string`;
-\}
-
-### telemetry.otel.otlpEndpoint?
-
-`string`
-
-### validation
-
-\{
-  `allowedRewardRedeemers?`: `Address`[];
-  `allowedRewardEscrowAccountSigners?`: `Address`[];
-\}
-
-### validation.allowedRewardRedeemers?
-
-`Address`[]
-
-### validation.allowedRewardEscrowAccountSigners?
-
-`Address`[]
-
-### logLevel
-
-`"error"` \| `"warn"` \| `"info"` \| `"log"` \| `"debug"` \| `"trace"`
-
-### silent
-
-`boolean`
-
-## Returns
-
-`Express`
-
-  ### <a id="getServer"></a>getServer
-
-[**@xyo-network/chain-reward-redemption**](#../README)
-
-***
-
-```ts
-function getServer(context): Promise<Server<typeof IncomingMessage, typeof ServerResponse>>;
-```
-
-## Parameters
-
-### context
-
-`GetServerContext`
-
-## Returns
-
-`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\>
-
-
-## Maintainers
-
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-## Credits
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
-
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
 
 [npm-badge]: https://img.shields.io/npm/v/@xyo-network/chain-reward-redemption.svg
 [npm-link]: https://www.npmjs.com/package/@xyo-network/chain-reward-redemption
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/chain-reward-redemption
-[npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-reward-redemption
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/chain-reward-redemption/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/chain-reward-redemption
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/chain-reward-redemption
-[socket-link]: https://socket.dev/npm/package/@xyo-network/chain-reward-redemption
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-reward-redemption.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/dist/node/index.mjs

@@ -313,8 +313,51 @@ var addInstrumentation = /* @__PURE__ */ __name(() => {
   });
 }, "addInstrumentation");
 
-// src/server/routes/dataLake/archivistMiddleware.ts
+// src/server/routes/livez/get.ts
 import { setRawResponseFormat } from "@xylabs/express";
+import { ReasonPhrases } from "http-status-codes";
+var message = ReasonPhrases.OK;
+var handler = /* @__PURE__ */ __name((_req, res) => {
+  setRawResponseFormat(res);
+  res.status(200).send({
+    message
+  });
+}, "handler");
+var getLivez = handler;
+
+// src/server/routes/readyz/get.ts
+import { setRawResponseFormat as setRawResponseFormat2 } from "@xylabs/express";
+import { ReasonPhrases as ReasonPhrases2 } from "http-status-codes";
+var message2 = ReasonPhrases2.OK;
+var handler2 = /* @__PURE__ */ __name((_req, res) => {
+  setRawResponseFormat2(res);
+  res.status(200).send({
+    message: message2
+  });
+}, "handler");
+var getReadyz = handler2;
+
+// src/server/routes/startupz/get.ts
+import { setRawResponseFormat as setRawResponseFormat3 } from "@xylabs/express";
+import { ReasonPhrases as ReasonPhrases3 } from "http-status-codes";
+var message3 = ReasonPhrases3.OK;
+var handler3 = /* @__PURE__ */ __name((_req, res) => {
+  setRawResponseFormat3(res);
+  res.status(200).send({
+    message: message3
+  });
+}, "handler");
+var getStartupz = handler3;
+
+// src/server/routes/addProbeRoutes.ts
+var addProbeRoutes = /* @__PURE__ */ __name((app) => {
+  app.get("/livez", getLivez);
+  app.get("/readyz", getReadyz);
+  app.get("/startupz", getStartupz);
+}, "addProbeRoutes");
+
+// src/server/routes/dataLake/archivistMiddleware.ts
+import { setRawResponseFormat as setRawResponseFormat4 } from "@xylabs/express";
 import { asHash, isDefined as isDefined3 } from "@xylabs/sdk-js";
 import { asArchivistInstance, isAnyPayload, isSequence, PayloadBuilder } from "@xyo-network/sdk-js";
 import express from "express";
@@ -336,7 +379,7 @@ var archivistMiddleware = /* @__PURE__ */ __name((options) => {
     mergeParams: true
   });
   router.post("/insert", async (req, res) => {
-    setRawResponseFormat(res);
+    setRawResponseFormat4(res);
     const body2 = Array.isArray(req.body) ? req.body : [
       req.body
     ];
@@ -346,7 +389,7 @@ var archivistMiddleware = /* @__PURE__ */ __name((options) => {
     res.status(200).json(result);
   });
   router.get("/next", async (req, res) => {
-    setRawResponseFormat(res);
+    setRawResponseFormat4(res);
     const cursor = isSequence(req.query.cursor) ? req.query.cursor : void 0;
     const limit = isDefined3(req.query.limit) ? Number(req.query.limit) : void 0;
     const open = isDefined3(req.query.open) ? Boolean(req.query.open) : void 0;
@@ -362,14 +405,14 @@ var archivistMiddleware = /* @__PURE__ */ __name((options) => {
     res.status(200).json(result);
   });
   router.post("/next", async (req, res) => {
-    setRawResponseFormat(res);
+    setRawResponseFormat4(res);
     const options2 = req.body;
     const archivist = await getArchivist(node, archivistModuleIdentifier);
     const result = await (isDefined3(options2) ? archivist.next(options2) : archivist.next());
     res.status(200).json(result);
   });
   router.get("/get/:hash", async (req, res) => {
-    setRawResponseFormat(res);
+    setRawResponseFormat4(res);
     const { hash: rawHash } = req.params;
     const hash = asHash(rawHash);
     if (isDefined3(hash)) {
@@ -525,6 +568,7 @@ var addRewardRedemptionRoutes = /* @__PURE__ */ __name((app) => {
 
 // src/server/routes/addRoutes.ts
 var addRoutes = /* @__PURE__ */ __name((app) => {
+  addProbeRoutes(app);
   addDataLakeRoutes(app);
   addRewardRedemptionRoutes(app);
 }, "addRoutes");