@xyo-network/chain-reward-redemption 1.16.14 → 1.16.15

package/README.md

@@ -1,4 +1,4 @@
-# @xyo-network/chain-bridge
+# @xyo-network/chain-reward-redemption
 
 [![logo][]](https://xyo.network)
 
@@ -8,13 +8,13 @@
 [![npm-license-badge][]](LICENSE)
 [![socket-badge][]][socket-link]
 
-XYO Layer One Bridge
+XYO Layer One Rewards
 
 
 
 ## Reference
 
-**@xyo-network/chain-bridge**
+**@xyo-network/chain-reward-redemption**
 
 ***
 
@@ -27,12 +27,12 @@ XYO Layer One Bridge
 
   ### <a id="getApp"></a>getApp
 
-[**@xyo-network/chain-bridge**](#../README)
+[**@xyo-network/chain-reward-redemption**](#../README)
 
 ***
 
 ```ts
-function getApp(node): Express;
+function getApp(node, config): Express;
 ```
 
 ## Parameters
@@ -41,13 +41,305 @@ function getApp(node): Express;
 
 `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-bridge**](#../README)
+[**@xyo-network/chain-reward-redemption**](#../README)
 
 ***
 
@@ -83,14 +375,14 @@ function getServer(context): Promise<Server<typeof IncomingMessage, typeof Serve
 
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
 
-[npm-badge]: https://img.shields.io/npm/v/@xyo-network/chain-bridge.svg
-[npm-link]: https://www.npmjs.com/package/@xyo-network/chain-bridge
+[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-bridge
-[npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-bridge
+[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-bridge/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/chain-bridge
+[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-bridge
-[socket-link]: https://socket.dev/npm/package/@xyo-network/chain-bridge
+[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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/chain-reward-redemption",
-  "version": "1.16.14",
+  "version": "1.16.15",
   "description": "XYO Layer One Rewards",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -58,8 +58,8 @@
     "@xyo-network/archivist-view": "~5.1.23",
     "@xyo-network/bios": "~7.1.1",
     "@xyo-network/boundwitness-model": "~5.1.23",
-    "@xyo-network/chain-protocol": "~1.16.14",
-    "@xyo-network/chain-telemetry": "~1.16.14",
+    "@xyo-network/chain-protocol": "~1.16.15",
+    "@xyo-network/chain-telemetry": "~1.16.15",
     "@xyo-network/manifest-model": "~5.1.23",
     "@xyo-network/manifest-wrapper": "~5.1.23",
     "@xyo-network/module-abstract": "~5.1.23",
@@ -74,8 +74,8 @@
     "@xyo-network/wallet": "~5.1.23",
     "@xyo-network/wallet-model": "~5.1.23",
     "@xyo-network/xl1-protocol": "~1.13.11",
-    "@xyo-network/xl1-protocol-sdk": "~1.16.14",
-    "@xyo-network/xl1-rpc": "~1.16.14",
+    "@xyo-network/xl1-protocol-sdk": "~1.16.15",
+    "@xyo-network/xl1-rpc": "~1.16.15",
     "async-mutex": "~0.5.0",
     "compression": "~1.8.1",
     "cors": "~2.8.5",
@@ -100,8 +100,8 @@
     "@xyo-network/archivist-mongodb": "~5.1.23",
     "@xyo-network/bios-model": "~7.1.1",
     "@xyo-network/boundwitness-builder": "~5.1.23",
-    "@xyo-network/chain-protocol": "~1.16.14",
-    "@xyo-network/chain-services": "~1.16.14",
+    "@xyo-network/chain-protocol": "~1.16.15",
+    "@xyo-network/chain-services": "~1.16.15",
     "@xyo-network/manifest-wrapper": "~5.1.23",
     "@xyo-network/module-abstract": "~5.1.23",
     "@xyo-network/module-abstract-mongodb": "~5.1.23",