@pythnetwork/price-pusher 5.7.1 → 6.0.0

package/README.md

@@ -37,6 +37,7 @@ The parameters above are configured per price feed in a price configuration YAML
   time_difference: 60 # Time difference threshold (in seconds) to push a newer price feed.
   price_deviation: 0.5 # The price deviation (%) threshold to push a newer price feed.
   confidence_ratio: 1 # The confidence/price (%) threshold to push a newer price feed.
+
   # Optional block to configure whether this feed can be early updated. If at least one feed meets the
   # triggering conditions above, all other feeds who meet the early update conditions will be included in
   # the submitted batch of prices. This logic takes advantage of the fact that adding a feed to a larger
@@ -49,6 +50,24 @@ The parameters above are configured per price feed in a price configuration YAML
 - ...
 ```
 
+By default, the price pusher will automatically update the price of all listed price feeds whenever the
+triggering condition for a single feed is met. This behavior takes advantage of the reduced cost of batch price updates
+provided by the [Perseus upgrade](https://medium.com/@antonia.vanna.delgado/pyth-network-perseus-first-party-data-matters-e3379bf0d019),
+and is typically the lowest cost way to schedule price updates for multiple feeds.
+
+However, if you would like to customize this behavior, you can add an `early_update` section to the YAML configuration file for
+the feed.
+
+```yaml
+- alias: A/USD # Arbitrary alias for the price feed. It is used in enhance logging.
+  ...
+  # If provided, only early update this price feed if at least one of the listed triggering conditions is met.
+  early_update:
+    time_difference: 30
+    price_deviation: 0.1
+    confidence_ratio: 0.5
+```
+
 Two sample YAML configuration files are available in the root of this repo.
 
 You can get the list of available price feeds from

package/lib/price-config.d.ts

@@ -7,6 +7,7 @@ export type PriceConfig = {
     timeDifference: DurationInSeconds;
     priceDeviation: PctNumber;
     confidenceRatio: PctNumber;
+    customEarlyUpdate: boolean | undefined;
     earlyUpdateTimeDifference: DurationInSeconds | undefined;
     earlyUpdatePriceDeviation: PctNumber | undefined;
     earlyUpdateConfidenceRatio: PctNumber | undefined;

package/lib/price-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"price-config.d.ts","sourceRoot":"","sources":["../src/price-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAI9D,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAmB,MAAM,SAAS,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAuBxC,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,SAAS,CAAC;IACd,cAAc,EAAE,iBAAiB,CAAC;IAClC,cAAc,EAAE,SAAS,CAAC;IAC1B,eAAe,EAAE,SAAS,CAAC;IAI3B,yBAAyB,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACzD,yBAAyB,EAAE,SAAS,GAAG,SAAS,CAAC;IACjD,0BAA0B,EAAE,SAAS,GAAG,SAAS,CAAC;CACnD,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,EAAE,CAsB/D;AAED,oBAAY,eAAe;IAEzB,GAAG,IAAA;IAEH,KAAK,IAAA;IAEL,EAAE,IAAA;CACH;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,WAAW,EAAE,WAAW,EACxB,iBAAiB,EAAE,SAAS,GAAG,SAAS,EACxC,iBAAiB,EAAE,SAAS,GAAG,SAAS,GACvC,eAAe,CAmEjB"}
+{"version":3,"file":"price-config.d.ts","sourceRoot":"","sources":["../src/price-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAI9D,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAmB,MAAM,SAAS,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAuBxC,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,SAAS,CAAC;IACd,cAAc,EAAE,iBAAiB,CAAC;IAClC,cAAc,EAAE,SAAS,CAAC;IAC1B,eAAe,EAAE,SAAS,CAAC;IAU3B,iBAAiB,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,yBAAyB,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACzD,yBAAyB,EAAE,SAAS,GAAG,SAAS,CAAC;IACjD,0BAA0B,EAAE,SAAS,GAAG,SAAS,CAAC;CACnD,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,EAAE,CAuB/D;AAED,oBAAY,eAAe;IAEzB,GAAG,IAAA;IAEH,KAAK,IAAA;IAEL,EAAE,IAAA;CACH;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,WAAW,EAAE,WAAW,EACxB,iBAAiB,EAAE,SAAS,GAAG,SAAS,EACxC,iBAAiB,EAAE,SAAS,GAAG,SAAS,GACvC,eAAe,CAqEjB"}

package/lib/price-config.js

@@ -39,6 +39,7 @@ function readPriceConfigFile(path) {
             timeDifference: priceConfigRaw.time_difference,
             priceDeviation: priceConfigRaw.price_deviation,
             confidenceRatio: priceConfigRaw.confidence_ratio,
+            customEarlyUpdate: priceConfigRaw.early_update !== undefined,
             earlyUpdateTimeDifference: priceConfigRaw.early_update?.time_difference,
             earlyUpdatePriceDeviation: priceConfigRaw.early_update?.price_deviation,
             earlyUpdateConfidenceRatio: priceConfigRaw.early_update?.confidence_ratio,
@@ -93,8 +94,10 @@ function shouldUpdate(priceConfig, sourceLatestPrice, targetLatestPrice) {
         confidenceRatioPct >= priceConfig.confidenceRatio) {
         return UpdateCondition.YES;
     }
-    else if ((priceConfig.earlyUpdateTimeDifference !== undefined &&
-        timeDifference >= priceConfig.earlyUpdateTimeDifference) ||
+    else if (priceConfig.customEarlyUpdate === undefined ||
+        !priceConfig.customEarlyUpdate ||
+        (priceConfig.earlyUpdateTimeDifference !== undefined &&
+            timeDifference >= priceConfig.earlyUpdateTimeDifference) ||
         (priceConfig.earlyUpdatePriceDeviation !== undefined &&
             priceDeviationPct >= priceConfig.earlyUpdatePriceDeviation) ||
         (priceConfig.earlyUpdateConfidenceRatio !== undefined &&

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/price-pusher",
-  "version": "5.7.1",
+  "version": "6.0.0",
   "description": "Pyth Price Pusher",
   "homepage": "https://pyth.network",
   "main": "lib/index.js",
@@ -64,5 +64,5 @@
     "yaml": "^2.1.1",
     "yargs": "^17.5.1"
   },
-  "gitHead": "44ebfbaf5512acd96a12b3cdf361b47e64802dbf"
+  "gitHead": "cc7054b6f35e5d6dd3875b91d348303c78773d5d"
 }