@metamask-previews/snap-networks-utils 2.0.0-preview-0a7c77e1 → 3.0.0-preview-61fa1fce

package/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0]
+
+### Added
+
+- Add `createFetchPolicy`, a retry and circuit-breaker policy for calls to one upstream service, built on `createServicePolicy` from `@metamask/base-data-service` ([#462](https://github.com/MetaMask/internal-snaps/pull/462))
+  - Retries only transient errors (network failures, timeouts and HTTP 408, 425, 429, 500, 502, 503 and 504), up to 3 times, with exponential backoff and jitter
+  - Waits for the error's `retryAfterMs` when it is longer than the backoff, and doesn't retry when it is over `MAX_RETRY_AFTER_MS` (30 seconds)
+  - Opens the circuit for 30 seconds on repeated transient errors or 5xx responses, but not on other 4xx, aborts or validation errors
+  - Logs retries, give-ups, `Retry-After` values over the cap and circuit breaks to the given `logger`
+- Add the `FetchPolicyError` type, `createFetchPolicyError`, `FetchPolicyErrorName` and `isTransientError` for converting errors to the shape `createFetchPolicy` decides on ([#462](https://github.com/MetaMask/internal-snaps/pull/462))
+- Re-export `BrokenCircuitError` from `@metamask/base-data-service`, the error `createFetchPolicy` policies throw while the circuit is open ([#462](https://github.com/MetaMask/internal-snaps/pull/462))
+  - Its `name` is `Error`, so check for it with `instanceof`
+- Add a `@metamask/snap-networks-utils/performance-shim` export, which snaps must provide as the `performance` global (e.g. with webpack's `ProvidePlugin`) to use `createFetchPolicy` ([#462](https://github.com/MetaMask/internal-snaps/pull/462))
+
+### Removed
+
+- **BREAKING:** Remove the CommonJS build; the package is now published as ESM only ([#452](https://github.com/MetaMask/internal-snaps/pull/452))
+  - `require('@metamask/snap-networks-utils')` no longer works. Import the package from ESM code or a bundler such as `mm-snap` (webpack) instead
+
 ## [2.0.0]
 
 ### Added
@@ -76,6 +95,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Implement `AssetsProvider` ([#82](https://github.com/MetaMask/internal-snaps/pull/82))
 - Initial package release ([#79](https://github.com/MetaMask/internal-snaps/pull/79))
 
-[Unreleased]: https://github.com/MetaMask/internal-snaps/compare/@metamask/snap-networks-utils@2.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/internal-snaps/compare/@metamask/snap-networks-utils@3.0.0...HEAD
+[3.0.0]: https://github.com/MetaMask/internal-snaps/compare/@metamask/snap-networks-utils@2.0.0...@metamask/snap-networks-utils@3.0.0
 [2.0.0]: https://github.com/MetaMask/internal-snaps/compare/@metamask/snap-networks-utils@1.0.0...@metamask/snap-networks-utils@2.0.0
 [1.0.0]: https://github.com/MetaMask/internal-snaps/releases/tag/@metamask/snap-networks-utils@1.0.0

package/dist/index.d.mts

@@ -32,6 +32,8 @@ export { InMemoryState } from "./utils/state/InMemoryState.mjs";
 export type { IStateManager } from "./utils/state/IStateManager.mjs";
 export { createSnapErrorHandling, createTrackError, createWithCatchAndThrowSnapError, formatAccountSyncFailures, getSyncFailuresFromSettledResult, isSnapRpcError, normalizeError, stringifyReason, SynchronizationError, } from "./utils/errors/index.mjs";
 export { InFlightCoalescer } from "./utils/dedupe/InFlightCoalescer.mjs";
+export { BrokenCircuitError, createFetchPolicy, createFetchPolicyError, FetchPolicyErrorName, isTransientError, MAX_RETRY_AFTER_MS, } from "./utils/fetchPolicy/createFetchPolicy.mjs";
+export type { CreateFetchPolicyOptions, FetchPolicyError, } from "./utils/fetchPolicy/createFetchPolicy.mjs";
 export { ActionHeader } from "./ui/ActionHeader/ActionHeader.mjs";
 export type { ActionHeaderProps } from "./ui/ActionHeader/ActionHeader.mjs";
 export { Asset, AssetIcon } from "./ui/Asset/Asset.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,KAAK,uBAAuB,GAC7B,8CAA0C;AAC3C,OAAO,EACL,kCAAkC,EAClC,0BAA0B,EAC1B,KAAK,mCAAmC,GACzC,wEAAoE;AACrE,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,GACrB,kDAA8C;AAC/C,YAAY,EACV,uBAAuB,EACvB,oCAAoC,EACpC,oCAAoC,EACpC,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC1B,mCAAmC,EACnC,wCAAwC,GACzC,kDAA8C;AAC/C,OAAO,EAAE,SAAS,EAAE,wCAAoC;AACxD,OAAO,EACL,0BAA0B,EAC1B,iCAAiC,GAClC,oDAAgD;AACjD,OAAO,EAAE,QAAQ,EAAE,sCAAkC;AACrD,YAAY,EAAE,cAAc,EAAE,sCAAkC;AAChE,OAAO,EACL,yBAAyB,EACzB,WAAW,GACZ,sCAAkC;AACnC,OAAO,EAAE,SAAS,EAAE,wCAAoC;AACxD,OAAO,EAAE,UAAU,EAAE,0CAAsC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,kDAA8C;AAC/E,YAAY,EACV,sBAAsB,EACtB,uBAAuB,GACxB,kDAA8C;AAC/C,OAAO,EAAE,QAAQ,EAAE,oCAAgC;AACnD,OAAO,EAAE,kBAAkB,EAAE,8CAA0C;AACvE,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,GACjB,sCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,0CAAsC;AAC/D,OAAO,EACL,WAAW,EACX,iBAAiB,GAClB,6CAAyC;AAC1C,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,2BAA2B,EAC3B,oBAAoB,EACpB,MAAM,GACP,gCAA4B;AAC7B,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,kCAA8B;AACzD,YAAY,EACV,aAAa,EACb,YAAY,EACZ,SAAS,EACT,kBAAkB,EAClB,gBAAgB,GACjB,kCAA8B;AAC/B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,gDAA4C;AAC7E,YAAY,EAAE,YAAY,EAAE,wCAAoC;AAChE,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,EAChC,uCAAuC,EACvC,sCAAsC,EACtC,wCAAwC,EACxC,mCAAmC,EACnC,kCAAkC,EAClC,6BAA6B,EAC7B,iCAAiC,GAClC,sDAAkD;AACnD,YAAY,EACV,0BAA0B,EAC1B,iCAAiC,EACjC,gCAAgC,EAChC,kCAAkC,EAClC,6BAA6B,EAC7B,4BAA4B,EAC5B,uBAAuB,GACxB,sDAAkD;AACnD,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,uBAAuB,GACxB,8DAA0D;AAC3D,YAAY,EAAE,6BAA6B,EAAE,8DAA0D;AACvG,OAAO,EAAE,cAAc,EAAE,qDAAiD;AAC1E,OAAO,EAAE,KAAK,EAAE,gCAA4B;AAC5C,YAAY,EAAE,WAAW,EAAE,gCAA4B;AACvD,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAC5D,YAAY,EAAE,aAAa,EAAE,wCAAoC;AACjE,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,gCAAgC,EAChC,yBAAyB,EACzB,gCAAgC,EAChC,cAAc,EACd,cAAc,EACd,eAAe,EACf,oBAAoB,GACrB,iCAAuB;AACxB,OAAO,EAAE,iBAAiB,EAAE,6CAAyC;AACrE,OAAO,EAAE,YAAY,EAAE,2CAAuC;AAC9D,YAAY,EAAE,iBAAiB,EAAE,2CAAuC;AACxE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,6BAAyB;AACpD,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,6BAAyB;AACnE,OAAO,EAAE,gBAAgB,EAAE,mDAA+C;AAC1E,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,GACtB,mDAA+C;AAChD,OAAO,EAAE,gBAAgB,EAAE,mDAA+C;AAC1E,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,GAC3B,mDAA+C;AAChD,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAC5D,OAAO,EAAE,UAAU,EAAE,qCAAiC;AACtD,OAAO,EAAE,QAAQ,EAAE,mCAA+B;AAClD,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAC5D,YAAY,EAAE,YAAY,EAAE,mCAA+B;AAC3D,YAAY,EACV,iBAAiB,EACjB,gBAAgB,GACjB,wCAAoC;AACrC,YAAY,EACV,MAAM,EACN,UAAU,EACV,qBAAqB,GACtB,gCAA4B;AAC7B,YAAY,EACV,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,UAAU,GACX,qCAAiC;AAClC,OAAO,EACL,iBAAiB,EACjB,gBAAgB,GACjB,8CAA0C;AAC3C,YAAY,EACV,YAAY,EACZ,0BAA0B,GAC3B,8CAA0C;AAC3C,YAAY,EACV,kBAAkB,EAClB,8BAA8B,EAC9B,uBAAuB,EACvB,uCAAuC,EACvC,UAAU,EACV,gBAAgB,EAChB,yBAAyB,EACzB,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,yBAAyB,EACzB,YAAY,GACb,iCAAuB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,KAAK,uBAAuB,GAC7B,8CAA0C;AAC3C,OAAO,EACL,kCAAkC,EAClC,0BAA0B,EAC1B,KAAK,mCAAmC,GACzC,wEAAoE;AACrE,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,GACrB,kDAA8C;AAC/C,YAAY,EACV,uBAAuB,EACvB,oCAAoC,EACpC,oCAAoC,EACpC,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC1B,mCAAmC,EACnC,wCAAwC,GACzC,kDAA8C;AAC/C,OAAO,EAAE,SAAS,EAAE,wCAAoC;AACxD,OAAO,EACL,0BAA0B,EAC1B,iCAAiC,GAClC,oDAAgD;AACjD,OAAO,EAAE,QAAQ,EAAE,sCAAkC;AACrD,YAAY,EAAE,cAAc,EAAE,sCAAkC;AAChE,OAAO,EACL,yBAAyB,EACzB,WAAW,GACZ,sCAAkC;AACnC,OAAO,EAAE,SAAS,EAAE,wCAAoC;AACxD,OAAO,EAAE,UAAU,EAAE,0CAAsC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,kDAA8C;AAC/E,YAAY,EACV,sBAAsB,EACtB,uBAAuB,GACxB,kDAA8C;AAC/C,OAAO,EAAE,QAAQ,EAAE,oCAAgC;AACnD,OAAO,EAAE,kBAAkB,EAAE,8CAA0C;AACvE,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,GACjB,sCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,0CAAsC;AAC/D,OAAO,EACL,WAAW,EACX,iBAAiB,GAClB,6CAAyC;AAC1C,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,2BAA2B,EAC3B,oBAAoB,EACpB,MAAM,GACP,gCAA4B;AAC7B,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,kCAA8B;AACzD,YAAY,EACV,aAAa,EACb,YAAY,EACZ,SAAS,EACT,kBAAkB,EAClB,gBAAgB,GACjB,kCAA8B;AAC/B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,gDAA4C;AAC7E,YAAY,EAAE,YAAY,EAAE,wCAAoC;AAChE,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,EAChC,uCAAuC,EACvC,sCAAsC,EACtC,wCAAwC,EACxC,mCAAmC,EACnC,kCAAkC,EAClC,6BAA6B,EAC7B,iCAAiC,GAClC,sDAAkD;AACnD,YAAY,EACV,0BAA0B,EAC1B,iCAAiC,EACjC,gCAAgC,EAChC,kCAAkC,EAClC,6BAA6B,EAC7B,4BAA4B,EAC5B,uBAAuB,GACxB,sDAAkD;AACnD,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,uBAAuB,GACxB,8DAA0D;AAC3D,YAAY,EAAE,6BAA6B,EAAE,8DAA0D;AACvG,OAAO,EAAE,cAAc,EAAE,qDAAiD;AAC1E,OAAO,EAAE,KAAK,EAAE,gCAA4B;AAC5C,YAAY,EAAE,WAAW,EAAE,gCAA4B;AACvD,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAC5D,YAAY,EAAE,aAAa,EAAE,wCAAoC;AACjE,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,gCAAgC,EAChC,yBAAyB,EACzB,gCAAgC,EAChC,cAAc,EACd,cAAc,EACd,eAAe,EACf,oBAAoB,GACrB,iCAAuB;AACxB,OAAO,EAAE,iBAAiB,EAAE,6CAAyC;AACrE,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,GACnB,kDAA8C;AAC/C,YAAY,EACV,wBAAwB,EACxB,gBAAgB,GACjB,kDAA8C;AAC/C,OAAO,EAAE,YAAY,EAAE,2CAAuC;AAC9D,YAAY,EAAE,iBAAiB,EAAE,2CAAuC;AACxE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,6BAAyB;AACpD,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,6BAAyB;AACnE,OAAO,EAAE,gBAAgB,EAAE,mDAA+C;AAC1E,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,GACtB,mDAA+C;AAChD,OAAO,EAAE,gBAAgB,EAAE,mDAA+C;AAC1E,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,GAC3B,mDAA+C;AAChD,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAC5D,OAAO,EAAE,UAAU,EAAE,qCAAiC;AACtD,OAAO,EAAE,QAAQ,EAAE,mCAA+B;AAClD,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAC5D,YAAY,EAAE,YAAY,EAAE,mCAA+B;AAC3D,YAAY,EACV,iBAAiB,EACjB,gBAAgB,GACjB,wCAAoC;AACrC,YAAY,EACV,MAAM,EACN,UAAU,EACV,qBAAqB,GACtB,gCAA4B;AAC7B,YAAY,EACV,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,UAAU,GACX,qCAAiC;AAClC,OAAO,EACL,iBAAiB,EACjB,gBAAgB,GACjB,8CAA0C;AAC3C,YAAY,EACV,YAAY,EACZ,0BAA0B,GAC3B,8CAA0C;AAC3C,YAAY,EACV,kBAAkB,EAClB,8BAA8B,EAC9B,uBAAuB,EACvB,uCAAuC,EACvC,UAAU,EACV,gBAAgB,EAChB,yBAAyB,EACzB,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,yBAAyB,EACzB,YAAY,GACb,iCAAuB"}

package/dist/index.mjs

@@ -23,6 +23,7 @@ export { State } from "./utils/state/State.mjs";
 export { InMemoryState } from "./utils/state/InMemoryState.mjs";
 export { createSnapErrorHandling, createTrackError, createWithCatchAndThrowSnapError, formatAccountSyncFailures, getSyncFailuresFromSettledResult, isSnapRpcError, normalizeError, stringifyReason, SynchronizationError } from "./utils/errors/index.mjs";
 export { InFlightCoalescer } from "./utils/dedupe/InFlightCoalescer.mjs";
+export { BrokenCircuitError, createFetchPolicy, createFetchPolicyError, FetchPolicyErrorName, isTransientError, MAX_RETRY_AFTER_MS } from "./utils/fetchPolicy/createFetchPolicy.mjs";
 export { ActionHeader } from "./ui/ActionHeader/ActionHeader.mjs";
 export { Asset, AssetIcon } from "./ui/Asset/Asset.mjs";
 export { EstimatedChanges } from "./ui/EstimatedChanges/EstimatedChanges.mjs";

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,cAAc,EAEf,8CAA0C;AAC3C,OAAO,EACL,kCAAkC,EAClC,0BAA0B,EAE3B,wEAAoE;AACrE,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACrB,kDAA8C;AAW/C,OAAO,EAAE,SAAS,EAAE,wCAAoC;AACxD,OAAO,EACL,0BAA0B,EAC1B,iCAAiC,EAClC,oDAAgD;AACjD,OAAO,EAAE,QAAQ,EAAE,sCAAkC;AAErD,OAAO,EACL,yBAAyB,EACzB,WAAW,EACZ,sCAAkC;AACnC,OAAO,EAAE,SAAS,EAAE,wCAAoC;AACxD,OAAO,EAAE,UAAU,EAAE,0CAAsC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,kDAA8C;AAK/E,OAAO,EAAE,QAAQ,EAAE,oCAAgC;AACnD,OAAO,EAAE,kBAAkB,EAAE,8CAA0C;AACvE,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EACjB,sCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,0CAAsC;AAC/D,OAAO,EACL,WAAW,EACX,iBAAiB,EAClB,6CAAyC;AAC1C,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,2BAA2B,EAC3B,oBAAoB,EACpB,MAAM,EACP,gCAA4B;AAC7B,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,kCAA8B;AAQzD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,gDAA4C;AAE7E,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,EAChC,uCAAuC,EACvC,sCAAsC,EACtC,wCAAwC,EACxC,mCAAmC,EACnC,kCAAkC,EAClC,6BAA6B,EAC7B,iCAAiC,EAClC,sDAAkD;AAUnD,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,uBAAuB,EACxB,8DAA0D;AAE3D,OAAO,EAAE,cAAc,EAAE,qDAAiD;AAC1E,OAAO,EAAE,KAAK,EAAE,gCAA4B;AAE5C,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAE5D,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,gCAAgC,EAChC,yBAAyB,EACzB,gCAAgC,EAChC,cAAc,EACd,cAAc,EACd,eAAe,EACf,oBAAoB,EACrB,iCAAuB;AACxB,OAAO,EAAE,iBAAiB,EAAE,6CAAyC;AACrE,OAAO,EAAE,YAAY,EAAE,2CAAuC;AAE9D,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,6BAAyB;AAEpD,OAAO,EAAE,gBAAgB,EAAE,mDAA+C;AAM1E,OAAO,EAAE,gBAAgB,EAAE,mDAA+C;AAO1E,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAC5D,OAAO,EAAE,UAAU,EAAE,qCAAiC;AACtD,OAAO,EAAE,QAAQ,EAAE,mCAA+B;AAClD,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAiB5D,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EACjB,8CAA0C","sourcesContent":["export {\n  ASSETS_PROVIDER_NAME,\n  AssetsProvider,\n  type AssetsProviderMessenger,\n} from './providers/assets/AssetsProvider';\nexport {\n  REMOTE_FEATURE_FLAGS_PROVIDER_NAME,\n  RemoteFeatureFlagsProvider,\n  type RemoteFeatureFlagsProviderMessenger,\n} from './providers/remote-feature-flags/RemoteFeatureFlagsProvider';\nexport {\n  AnalyticsService,\n  SecurityEventType,\n  TransactionEventType,\n} from './services/analytics/AnalyticsService';\nexport type {\n  AnalyticsServiceOptions,\n  SecurityAlertDetectedEventProperties,\n  SecurityScanCompletedEventProperties,\n  SnapTrackEventRequest,\n  TrackEventCapableProvider,\n  TransactionEventProperties,\n  TransactionFinalizedEventProperties,\n  WebSocketConnectionClosedEventProperties,\n} from './services/analytics/AnalyticsService';\nexport { safeMerge } from './utils/safeMerge/safeMerge';\nexport {\n  resolveFlowTransactionType,\n  resolveUnifiedSwapTransactionType,\n} from './utils/transactionType/transactionType';\nexport { buildUrl } from './utils/buildUrl/buildUrl';\nexport type { BuildUrlParams } from './utils/buildUrl/buildUrl';\nexport {\n  sanitizeControlCharacters,\n  sanitizeUri,\n} from './utils/sanitize/sanitize';\nexport { UrlStruct } from './utils/urlStruct/urlStruct';\nexport { UuidStruct } from './utils/uuidStruct/uuidStruct';\nexport { asStrictKeyringAccount } from './utils/keyringAccount/keyringAccount';\nexport type {\n  ExtendedKeyringAccount,\n  KeyringAccountExtension,\n} from './utils/keyringAccount/keyringAccount';\nexport { parseEnv } from './utils/config/parseEnv';\nexport { BaseConfigProvider } from './utils/config/BaseConfigProvider';\nexport {\n  commaSeparatedListOf,\n  defaultedUrlStruct,\n  emptyToUndefined,\n  parseIntegerStruct,\n  parseFloatStruct,\n} from './utils/config/envStructs';\nexport { LogLevelStruct } from './utils/config/logLevelStruct';\nexport {\n  Environment,\n  EnvironmentStruct,\n} from './utils/config/environmentStruct';\nexport {\n  batchesAll,\n  batchesAllSettled,\n  batchesAllSettledWithChunks,\n  batchesAllWithChunks,\n  chunks,\n} from './utils/async/async';\nexport { Logger, LogLevel } from './utils/logger/Logger';\nexport type {\n  LoggerOptions,\n  LoggerMethod,\n  LogMethod,\n  LogMethodDecorator,\n  LoggerDecorators,\n} from './utils/logger/Logger';\nexport { serialize, deserialize } from './utils/serialization/serialization';\nexport type { Serializable } from './utils/serialization/types';\nexport {\n  parseProofOfOwnershipMessage,\n  ProofOfOwnershipBatchErrorStruct,\n  ProofOfOwnershipBatchItemResponseStruct,\n  ProofOfOwnershipBatchRequestItemStruct,\n  ProofOfOwnershipBatchRequestParamsStruct,\n  ProofOfOwnershipBatchResponseStruct,\n  ProofOfOwnershipBatchSuccessStruct,\n  ProofOfOwnershipMessageStruct,\n  PROOF_OF_OWNERSHIP_MESSAGE_PREFIX,\n} from './utils/proofOfOwnership/proofOfOwnership';\nexport type {\n  ProofOfOwnershipBatchError,\n  ProofOfOwnershipBatchItemResponse,\n  ProofOfOwnershipBatchRequestItem,\n  ProofOfOwnershipBatchRequestParams,\n  ProofOfOwnershipBatchResponse,\n  ProofOfOwnershipBatchSuccess,\n  ProofOfOwnershipMessage,\n} from './utils/proofOfOwnership/proofOfOwnership';\nexport {\n  createOriginPermissions,\n  DEFAULT_PROD_ORIGINS,\n  DEFAULT_DEV_ORIGINS,\n  DEFAULT_METAMASK_ORIGIN,\n} from './utils/originPermissions/createOriginPermissions';\nexport type { CreateOriginPermissionsParams } from './utils/originPermissions/createOriginPermissions';\nexport { validateOrigin } from './utils/originPermissions/validateOrigin';\nexport { State } from './utils/state/State';\nexport type { StateConfig } from './utils/state/State';\nexport { InMemoryState } from './utils/state/InMemoryState';\nexport type { IStateManager } from './utils/state/IStateManager';\nexport {\n  createSnapErrorHandling,\n  createTrackError,\n  createWithCatchAndThrowSnapError,\n  formatAccountSyncFailures,\n  getSyncFailuresFromSettledResult,\n  isSnapRpcError,\n  normalizeError,\n  stringifyReason,\n  SynchronizationError,\n} from './utils/errors';\nexport { InFlightCoalescer } from './utils/dedupe/InFlightCoalescer';\nexport { ActionHeader } from './ui/ActionHeader/ActionHeader';\nexport type { ActionHeaderProps } from './ui/ActionHeader/ActionHeader';\nexport { Asset, AssetIcon } from './ui/Asset/Asset';\nexport type { AssetIconProps, AssetProps } from './ui/Asset/Asset';\nexport { EstimatedChanges } from './ui/EstimatedChanges/EstimatedChanges';\nexport type {\n  EstimatedChangesAsset,\n  EstimatedChangesLabels,\n  EstimatedChangesProps,\n} from './ui/EstimatedChanges/EstimatedChanges';\nexport { TransactionAlert } from './ui/TransactionAlert/TransactionAlert';\nexport type {\n  TransactionAlertError,\n  TransactionAlertLabels,\n  TransactionAlertProps,\n  TransactionAlertValidation,\n} from './ui/TransactionAlert/TransactionAlert';\nexport { InMemoryCache } from './utils/cache/InMemoryCache';\nexport { StateCache } from './utils/cache/StateCache';\nexport { useCache } from './utils/cache/useCache';\nexport { useCacheUntil } from './utils/cache/useCacheUntil';\nexport type { CacheOptions } from './utils/cache/useCache';\nexport type {\n  CacheUntilOptions,\n  ResultWithExpiry,\n} from './utils/cache/useCacheUntil';\nexport type {\n  ICache,\n  CacheEntry,\n  TimestampMilliseconds,\n} from './utils/cache/types';\nexport type {\n  CacheStateManager,\n  CacheStore,\n  CachePrefix,\n  StateValue,\n} from './utils/cache/StateCache';\nexport {\n  noopAssetHandlers,\n  wrapSnapHandlers,\n} from './utils/handlers/wrapSnapHandlers';\nexport type {\n  SnapHandlers,\n  WithCatchAndThrowSnapError,\n} from './utils/handlers/wrapSnapHandlers';\nexport type {\n  AccountSyncFailure,\n  CreateSnapErrorHandlingOptions,\n  CreateTrackErrorOptions,\n  CreateWithCatchAndThrowSnapErrorOptions,\n  LogErrorFn,\n  NormalizeErrorFn,\n  PrepareErrorForTrackingFn,\n  ShouldTrackErrorFn,\n  SnapRpcError,\n  SnapTrackErrorRequest,\n  TrackErrorCapableProvider,\n  TrackErrorFn,\n} from './utils/errors';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,cAAc,EAEf,8CAA0C;AAC3C,OAAO,EACL,kCAAkC,EAClC,0BAA0B,EAE3B,wEAAoE;AACrE,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACrB,kDAA8C;AAW/C,OAAO,EAAE,SAAS,EAAE,wCAAoC;AACxD,OAAO,EACL,0BAA0B,EAC1B,iCAAiC,EAClC,oDAAgD;AACjD,OAAO,EAAE,QAAQ,EAAE,sCAAkC;AAErD,OAAO,EACL,yBAAyB,EACzB,WAAW,EACZ,sCAAkC;AACnC,OAAO,EAAE,SAAS,EAAE,wCAAoC;AACxD,OAAO,EAAE,UAAU,EAAE,0CAAsC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,kDAA8C;AAK/E,OAAO,EAAE,QAAQ,EAAE,oCAAgC;AACnD,OAAO,EAAE,kBAAkB,EAAE,8CAA0C;AACvE,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EACjB,sCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,0CAAsC;AAC/D,OAAO,EACL,WAAW,EACX,iBAAiB,EAClB,6CAAyC;AAC1C,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,2BAA2B,EAC3B,oBAAoB,EACpB,MAAM,EACP,gCAA4B;AAC7B,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,kCAA8B;AAQzD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,gDAA4C;AAE7E,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,EAChC,uCAAuC,EACvC,sCAAsC,EACtC,wCAAwC,EACxC,mCAAmC,EACnC,kCAAkC,EAClC,6BAA6B,EAC7B,iCAAiC,EAClC,sDAAkD;AAUnD,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,uBAAuB,EACxB,8DAA0D;AAE3D,OAAO,EAAE,cAAc,EAAE,qDAAiD;AAC1E,OAAO,EAAE,KAAK,EAAE,gCAA4B;AAE5C,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAE5D,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,gCAAgC,EAChC,yBAAyB,EACzB,gCAAgC,EAChC,cAAc,EACd,cAAc,EACd,eAAe,EACf,oBAAoB,EACrB,iCAAuB;AACxB,OAAO,EAAE,iBAAiB,EAAE,6CAAyC;AACrE,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EACnB,kDAA8C;AAK/C,OAAO,EAAE,YAAY,EAAE,2CAAuC;AAE9D,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,6BAAyB;AAEpD,OAAO,EAAE,gBAAgB,EAAE,mDAA+C;AAM1E,OAAO,EAAE,gBAAgB,EAAE,mDAA+C;AAO1E,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAC5D,OAAO,EAAE,UAAU,EAAE,qCAAiC;AACtD,OAAO,EAAE,QAAQ,EAAE,mCAA+B;AAClD,OAAO,EAAE,aAAa,EAAE,wCAAoC;AAiB5D,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EACjB,8CAA0C","sourcesContent":["export {\n  ASSETS_PROVIDER_NAME,\n  AssetsProvider,\n  type AssetsProviderMessenger,\n} from './providers/assets/AssetsProvider';\nexport {\n  REMOTE_FEATURE_FLAGS_PROVIDER_NAME,\n  RemoteFeatureFlagsProvider,\n  type RemoteFeatureFlagsProviderMessenger,\n} from './providers/remote-feature-flags/RemoteFeatureFlagsProvider';\nexport {\n  AnalyticsService,\n  SecurityEventType,\n  TransactionEventType,\n} from './services/analytics/AnalyticsService';\nexport type {\n  AnalyticsServiceOptions,\n  SecurityAlertDetectedEventProperties,\n  SecurityScanCompletedEventProperties,\n  SnapTrackEventRequest,\n  TrackEventCapableProvider,\n  TransactionEventProperties,\n  TransactionFinalizedEventProperties,\n  WebSocketConnectionClosedEventProperties,\n} from './services/analytics/AnalyticsService';\nexport { safeMerge } from './utils/safeMerge/safeMerge';\nexport {\n  resolveFlowTransactionType,\n  resolveUnifiedSwapTransactionType,\n} from './utils/transactionType/transactionType';\nexport { buildUrl } from './utils/buildUrl/buildUrl';\nexport type { BuildUrlParams } from './utils/buildUrl/buildUrl';\nexport {\n  sanitizeControlCharacters,\n  sanitizeUri,\n} from './utils/sanitize/sanitize';\nexport { UrlStruct } from './utils/urlStruct/urlStruct';\nexport { UuidStruct } from './utils/uuidStruct/uuidStruct';\nexport { asStrictKeyringAccount } from './utils/keyringAccount/keyringAccount';\nexport type {\n  ExtendedKeyringAccount,\n  KeyringAccountExtension,\n} from './utils/keyringAccount/keyringAccount';\nexport { parseEnv } from './utils/config/parseEnv';\nexport { BaseConfigProvider } from './utils/config/BaseConfigProvider';\nexport {\n  commaSeparatedListOf,\n  defaultedUrlStruct,\n  emptyToUndefined,\n  parseIntegerStruct,\n  parseFloatStruct,\n} from './utils/config/envStructs';\nexport { LogLevelStruct } from './utils/config/logLevelStruct';\nexport {\n  Environment,\n  EnvironmentStruct,\n} from './utils/config/environmentStruct';\nexport {\n  batchesAll,\n  batchesAllSettled,\n  batchesAllSettledWithChunks,\n  batchesAllWithChunks,\n  chunks,\n} from './utils/async/async';\nexport { Logger, LogLevel } from './utils/logger/Logger';\nexport type {\n  LoggerOptions,\n  LoggerMethod,\n  LogMethod,\n  LogMethodDecorator,\n  LoggerDecorators,\n} from './utils/logger/Logger';\nexport { serialize, deserialize } from './utils/serialization/serialization';\nexport type { Serializable } from './utils/serialization/types';\nexport {\n  parseProofOfOwnershipMessage,\n  ProofOfOwnershipBatchErrorStruct,\n  ProofOfOwnershipBatchItemResponseStruct,\n  ProofOfOwnershipBatchRequestItemStruct,\n  ProofOfOwnershipBatchRequestParamsStruct,\n  ProofOfOwnershipBatchResponseStruct,\n  ProofOfOwnershipBatchSuccessStruct,\n  ProofOfOwnershipMessageStruct,\n  PROOF_OF_OWNERSHIP_MESSAGE_PREFIX,\n} from './utils/proofOfOwnership/proofOfOwnership';\nexport type {\n  ProofOfOwnershipBatchError,\n  ProofOfOwnershipBatchItemResponse,\n  ProofOfOwnershipBatchRequestItem,\n  ProofOfOwnershipBatchRequestParams,\n  ProofOfOwnershipBatchResponse,\n  ProofOfOwnershipBatchSuccess,\n  ProofOfOwnershipMessage,\n} from './utils/proofOfOwnership/proofOfOwnership';\nexport {\n  createOriginPermissions,\n  DEFAULT_PROD_ORIGINS,\n  DEFAULT_DEV_ORIGINS,\n  DEFAULT_METAMASK_ORIGIN,\n} from './utils/originPermissions/createOriginPermissions';\nexport type { CreateOriginPermissionsParams } from './utils/originPermissions/createOriginPermissions';\nexport { validateOrigin } from './utils/originPermissions/validateOrigin';\nexport { State } from './utils/state/State';\nexport type { StateConfig } from './utils/state/State';\nexport { InMemoryState } from './utils/state/InMemoryState';\nexport type { IStateManager } from './utils/state/IStateManager';\nexport {\n  createSnapErrorHandling,\n  createTrackError,\n  createWithCatchAndThrowSnapError,\n  formatAccountSyncFailures,\n  getSyncFailuresFromSettledResult,\n  isSnapRpcError,\n  normalizeError,\n  stringifyReason,\n  SynchronizationError,\n} from './utils/errors';\nexport { InFlightCoalescer } from './utils/dedupe/InFlightCoalescer';\nexport {\n  BrokenCircuitError,\n  createFetchPolicy,\n  createFetchPolicyError,\n  FetchPolicyErrorName,\n  isTransientError,\n  MAX_RETRY_AFTER_MS,\n} from './utils/fetchPolicy/createFetchPolicy';\nexport type {\n  CreateFetchPolicyOptions,\n  FetchPolicyError,\n} from './utils/fetchPolicy/createFetchPolicy';\nexport { ActionHeader } from './ui/ActionHeader/ActionHeader';\nexport type { ActionHeaderProps } from './ui/ActionHeader/ActionHeader';\nexport { Asset, AssetIcon } from './ui/Asset/Asset';\nexport type { AssetIconProps, AssetProps } from './ui/Asset/Asset';\nexport { EstimatedChanges } from './ui/EstimatedChanges/EstimatedChanges';\nexport type {\n  EstimatedChangesAsset,\n  EstimatedChangesLabels,\n  EstimatedChangesProps,\n} from './ui/EstimatedChanges/EstimatedChanges';\nexport { TransactionAlert } from './ui/TransactionAlert/TransactionAlert';\nexport type {\n  TransactionAlertError,\n  TransactionAlertLabels,\n  TransactionAlertProps,\n  TransactionAlertValidation,\n} from './ui/TransactionAlert/TransactionAlert';\nexport { InMemoryCache } from './utils/cache/InMemoryCache';\nexport { StateCache } from './utils/cache/StateCache';\nexport { useCache } from './utils/cache/useCache';\nexport { useCacheUntil } from './utils/cache/useCacheUntil';\nexport type { CacheOptions } from './utils/cache/useCache';\nexport type {\n  CacheUntilOptions,\n  ResultWithExpiry,\n} from './utils/cache/useCacheUntil';\nexport type {\n  ICache,\n  CacheEntry,\n  TimestampMilliseconds,\n} from './utils/cache/types';\nexport type {\n  CacheStateManager,\n  CacheStore,\n  CachePrefix,\n  StateValue,\n} from './utils/cache/StateCache';\nexport {\n  noopAssetHandlers,\n  wrapSnapHandlers,\n} from './utils/handlers/wrapSnapHandlers';\nexport type {\n  SnapHandlers,\n  WithCatchAndThrowSnapError,\n} from './utils/handlers/wrapSnapHandlers';\nexport type {\n  AccountSyncFailure,\n  CreateSnapErrorHandlingOptions,\n  CreateTrackErrorOptions,\n  CreateWithCatchAndThrowSnapErrorOptions,\n  LogErrorFn,\n  NormalizeErrorFn,\n  PrepareErrorForTrackingFn,\n  ShouldTrackErrorFn,\n  SnapRpcError,\n  SnapTrackErrorRequest,\n  TrackErrorCapableProvider,\n  TrackErrorFn,\n} from './utils/errors';\n"]}

package/dist/utils/fetchPolicy/createFetchPolicy.d.mts

@@ -0,0 +1,152 @@
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/base-data-service";
+import type { Logger } from "../logger/Logger.mjs";
+/**
+ * The error `policy.execute()` throws while the circuit is open. Its `name` is
+ * `Error`, so check for it with `instanceof`.
+ */
+export { BrokenCircuitError } from "@metamask/base-data-service";
+/**
+ * The error shape the fetch policy decides on. Each snap converts its errors
+ * to this shape at the network boundary.
+ *
+ * - `httpStatus` is set only when a non-2xx response arrived.
+ * - Network failures and timeouts have no `httpStatus`; they are identified by
+ * their `name` (see {@link FetchPolicyErrorName}).
+ * - `retryAfterMs` is the parsed `Retry-After` header, when there is one.
+ */
+export type FetchPolicyError = Error & {
+    httpStatus?: number;
+    retryAfterMs?: number;
+};
+/**
+ * The error names the fetch policy treats as transient. `TimeoutError` is also
+ * the name of the error thrown by `AbortSignal.timeout()`.
+ */
+export declare const FetchPolicyErrorName: {
+    readonly Network: "NetworkError";
+    readonly Timeout: "TimeoutError";
+};
+/**
+ * The longest `Retry-After` the policy waits for. A longer one fails the call
+ * at once rather than blocking the user.
+ */
+export declare const MAX_RETRY_AFTER_MS = 30000;
+/**
+ * Creates an error in the shape the fetch policy decides on.
+ *
+ * @param message - The error message.
+ * @param options - The error fields. Omitted fields are not set.
+ * @param options.name - The error name, e.g. `FetchPolicyErrorName.Network`.
+ * @param options.httpStatus - The HTTP status of a non-2xx response.
+ * @param options.retryAfterMs - The parsed `Retry-After` header, in milliseconds.
+ * @param options.cause - The original error.
+ * @returns The error.
+ */
+export declare const createFetchPolicyError: (message: string, { name, httpStatus, retryAfterMs, cause, }?: {
+    name?: string;
+    httpStatus?: number;
+    retryAfterMs?: number;
+    cause?: unknown;
+}) => FetchPolicyError;
+/**
+ * Whether an error is a transient failure: a network failure, a timeout, or
+ * HTTP 408, 425, 429, 500, 502, 503 or 504.
+ *
+ * @param error - The error to check.
+ * @returns `true` if the error is transient.
+ */
+export declare const isTransientError: (error: unknown) => boolean;
+export type CreateFetchPolicyOptions = Omit<CreateServicePolicyOptions, 'retryFilterPolicy' | 'isServiceFailure'> & {
+    /**
+     * The upstream service the policy protects, e.g. `price_api`. Create one
+     * policy per service, so one failing service doesn't open the circuit for
+     * the others.
+     */
+    service: string;
+    /**
+     * The CAIP-2 chain ID the service is called for, if any.
+     */
+    chainIdCaip?: string;
+    /**
+     * Where retries, circuit breaks and give-ups are logged.
+     */
+    logger: Pick<Logger, 'warn'>;
+};
+/**
+ * Creates a retry and circuit-breaker policy for calls to one upstream
+ * service, on top of `createServicePolicy` from `@metamask/base-data-service`.
+ *
+ * - Retries only transient errors (see {@link isTransientError}), up to 3 times
+ * by default, with exponential backoff and jitter.
+ * - Waits for the error's `retryAfterMs` when it is longer than the backoff, and
+ * doesn't retry when it is over {@link MAX_RETRY_AFTER_MS}.
+ * - Counts transient errors and any 5xx toward opening the circuit, which then
+ * stays open for 30 seconds by default. Other errors, such as 4xx, aborts and
+ * validation errors, don't count.
+ *
+ * The circuit state lives in memory, and a snap is stopped after about 30
+ * seconds idle, so the circuit only protects within a burst of requests.
+ *
+ * Snaps must provide a `performance` global (see `performance-shim`), which
+ * the underlying library uses to time calls.
+ *
+ * Create one policy per upstream service, convert errors to
+ * {@link FetchPolicyError} at the network boundary, and wrap each call with
+ * `policy.execute()`:
+ *
+ * @example
+ * ```typescript
+ * const priceApiPolicy = createFetchPolicy({ service: 'price_api', logger });
+ *
+ * const prices = await priceApiPolicy.execute(async () => {
+ *   const response = await fetch(url, {
+ *     signal: AbortSignal.timeout(10_000),
+ *   });
+ *   if (!response.ok) {
+ *     throw createFetchPolicyError(`HTTP ${response.status}`, {
+ *       httpStatus: response.status,
+ *     });
+ *   }
+ *   return response.json();
+ * });
+ * ```
+ *
+ * Don't wrap calls that build, sign and send a transaction: a retry could send
+ * it twice.
+ *
+ * While the circuit is open, `policy.execute()` throws
+ * {@link BrokenCircuitError} without calling the service. Its `name` is
+ * `Error`, so check for it with `instanceof`.
+ *
+ * The underlying library times calls with `performance.now()`, which snaps
+ * don't have. Add `webpack` as a dev dependency, on the same major version as
+ * `@metamask/snaps-cli`, and provide the shim in `snap.config.ts`:
+ *
+ * @example
+ * ```typescript
+ * import type { SnapConfig } from '@metamask/snaps-cli';
+ * import { merge } from '@metamask/snaps-cli';
+ * import { ProvidePlugin } from 'webpack';
+ *
+ * const config: SnapConfig = {
+ *   // ...
+ *   customizeWebpackConfig: (webpackConfig) =>
+ *     merge(webpackConfig, {
+ *       plugins: [
+ *         new ProvidePlugin({
+ *           performance: '@metamask/snap-networks-utils/performance-shim',
+ *         }),
+ *       ],
+ *     }),
+ * };
+ * ```
+ *
+ * @param options - The policy options.
+ * @param options.service - The upstream service name.
+ * @param options.chainIdCaip - The CAIP-2 chain ID, if any.
+ * @param options.logger - The logger.
+ * @param options.backoff - The base backoff. Defaults to exponential backoff.
+ * @returns The policy. Wrap each call with `policy.execute()`.
+ */
+export declare const createFetchPolicy: ({ service, chainIdCaip, logger, backoff, ...options }: CreateFetchPolicyOptions) => ServicePolicy;
+//# sourceMappingURL=createFetchPolicy.d.mts.map

package/dist/utils/fetchPolicy/createFetchPolicy.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFetchPolicy.d.mts","sourceRoot":"","sources":["../../../src/utils/fetchPolicy/createFetchPolicy.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,oCAAoC;AAErC,OAAO,KAAK,EAAE,MAAM,EAAE,6BAAyB;AAE/C;;;GAGG;AACH,OAAO,EAAE,kBAAkB,EAAE,oCAAoC;AAEjE;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;;CAGvB,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAS,CAAC;AAMzC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GACjC,SAAS,MAAM,EACf,6CAKG;IACD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;CACZ,KACL,gBAeF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,OAAO,KAAG,OAUjD,CAAC;AA4CF,MAAM,MAAM,wBAAwB,GAAG,IAAI,CACzC,0BAA0B,EAC1B,mBAAmB,GAAG,kBAAkB,CACzC,GAAG;IACF;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,eAAO,MAAM,iBAAiB,GAAI,uDAM/B,wBAAwB,KAAG,aA8C7B,CAAC"}

package/dist/utils/fetchPolicy/createFetchPolicy.mjs

@@ -0,0 +1,204 @@
+import { createServicePolicy, ExponentialBackoff, handleWhen } from "@metamask/base-data-service";
+/**
+ * The error `policy.execute()` throws while the circuit is open. Its `name` is
+ * `Error`, so check for it with `instanceof`.
+ */
+export { BrokenCircuitError } from "@metamask/base-data-service";
+/**
+ * The error names the fetch policy treats as transient. `TimeoutError` is also
+ * the name of the error thrown by `AbortSignal.timeout()`.
+ */
+export const FetchPolicyErrorName = {
+    Network: 'NetworkError',
+    Timeout: 'TimeoutError',
+};
+/**
+ * The longest `Retry-After` the policy waits for. A longer one fails the call
+ * at once rather than blocking the user.
+ */
+export const MAX_RETRY_AFTER_MS = 30_000;
+const DEFAULT_CIRCUIT_BREAK_DURATION_MS = 30_000;
+const RETRYABLE_HTTP_STATUSES = new Set([408, 425, 429, 500, 502, 503, 504]);
+/**
+ * Creates an error in the shape the fetch policy decides on.
+ *
+ * @param message - The error message.
+ * @param options - The error fields. Omitted fields are not set.
+ * @param options.name - The error name, e.g. `FetchPolicyErrorName.Network`.
+ * @param options.httpStatus - The HTTP status of a non-2xx response.
+ * @param options.retryAfterMs - The parsed `Retry-After` header, in milliseconds.
+ * @param options.cause - The original error.
+ * @returns The error.
+ */
+export const createFetchPolicyError = (message, { name, httpStatus, retryAfterMs, cause, } = {}) => {
+    const error = new Error(message, cause === undefined ? undefined : { cause });
+    if (name !== undefined) {
+        error.name = name;
+    }
+    if (httpStatus !== undefined) {
+        error.httpStatus = httpStatus;
+    }
+    if (retryAfterMs !== undefined) {
+        error.retryAfterMs = retryAfterMs;
+    }
+    return error;
+};
+/**
+ * Whether an error is a transient failure: a network failure, a timeout, or
+ * HTTP 408, 425, 429, 500, 502, 503 or 504.
+ *
+ * @param error - The error to check.
+ * @returns `true` if the error is transient.
+ */
+export const isTransientError = (error) => {
+    if (!(error instanceof Error)) {
+        return false;
+    }
+    const { name, httpStatus } = error;
+    return (name === FetchPolicyErrorName.Network ||
+        name === FetchPolicyErrorName.Timeout ||
+        (httpStatus !== undefined && RETRYABLE_HTTP_STATUSES.has(httpStatus)));
+};
+const isServiceFailure = (error) => isTransientError(error) ||
+    (error?.httpStatus ?? 0) >= 500;
+/**
+ * Gets the error of a failed attempt, if it threw one.
+ *
+ * @param reason - The failure reason from the policy (`{ error }` or `{ value }`).
+ * @returns The error, or `undefined` if the attempt didn't throw.
+ */
+const errorOf = (reason) => reason.error;
+/**
+ * Wraps a backoff so each delay is at least the failed attempt's
+ * `retryAfterMs`.
+ *
+ * @param inner - The backoff to wrap.
+ * @returns The wrapped backoff.
+ */
+const withRetryAfter = (inner) => ({
+    next(context) {
+        const step = inner.next(context);
+        const error = errorOf(context.result);
+        const retryAfter = error?.retryAfterMs;
+        const retryAfterMs = typeof retryAfter === 'number' &&
+            Number.isFinite(retryAfter) &&
+            retryAfter >= 0
+            ? retryAfter
+            : 0;
+        return {
+            ...withRetryAfter(step),
+            duration: Math.max(step.duration, retryAfterMs),
+        };
+    },
+});
+/**
+ * Creates a retry and circuit-breaker policy for calls to one upstream
+ * service, on top of `createServicePolicy` from `@metamask/base-data-service`.
+ *
+ * - Retries only transient errors (see {@link isTransientError}), up to 3 times
+ * by default, with exponential backoff and jitter.
+ * - Waits for the error's `retryAfterMs` when it is longer than the backoff, and
+ * doesn't retry when it is over {@link MAX_RETRY_AFTER_MS}.
+ * - Counts transient errors and any 5xx toward opening the circuit, which then
+ * stays open for 30 seconds by default. Other errors, such as 4xx, aborts and
+ * validation errors, don't count.
+ *
+ * The circuit state lives in memory, and a snap is stopped after about 30
+ * seconds idle, so the circuit only protects within a burst of requests.
+ *
+ * Snaps must provide a `performance` global (see `performance-shim`), which
+ * the underlying library uses to time calls.
+ *
+ * Create one policy per upstream service, convert errors to
+ * {@link FetchPolicyError} at the network boundary, and wrap each call with
+ * `policy.execute()`:
+ *
+ * @example
+ * ```typescript
+ * const priceApiPolicy = createFetchPolicy({ service: 'price_api', logger });
+ *
+ * const prices = await priceApiPolicy.execute(async () => {
+ *   const response = await fetch(url, {
+ *     signal: AbortSignal.timeout(10_000),
+ *   });
+ *   if (!response.ok) {
+ *     throw createFetchPolicyError(`HTTP ${response.status}`, {
+ *       httpStatus: response.status,
+ *     });
+ *   }
+ *   return response.json();
+ * });
+ * ```
+ *
+ * Don't wrap calls that build, sign and send a transaction: a retry could send
+ * it twice.
+ *
+ * While the circuit is open, `policy.execute()` throws
+ * {@link BrokenCircuitError} without calling the service. Its `name` is
+ * `Error`, so check for it with `instanceof`.
+ *
+ * The underlying library times calls with `performance.now()`, which snaps
+ * don't have. Add `webpack` as a dev dependency, on the same major version as
+ * `@metamask/snaps-cli`, and provide the shim in `snap.config.ts`:
+ *
+ * @example
+ * ```typescript
+ * import type { SnapConfig } from '@metamask/snaps-cli';
+ * import { merge } from '@metamask/snaps-cli';
+ * import { ProvidePlugin } from 'webpack';
+ *
+ * const config: SnapConfig = {
+ *   // ...
+ *   customizeWebpackConfig: (webpackConfig) =>
+ *     merge(webpackConfig, {
+ *       plugins: [
+ *         new ProvidePlugin({
+ *           performance: '@metamask/snap-networks-utils/performance-shim',
+ *         }),
+ *       ],
+ *     }),
+ * };
+ * ```
+ *
+ * @param options - The policy options.
+ * @param options.service - The upstream service name.
+ * @param options.chainIdCaip - The CAIP-2 chain ID, if any.
+ * @param options.logger - The logger.
+ * @param options.backoff - The base backoff. Defaults to exponential backoff.
+ * @returns The policy. Wrap each call with `policy.execute()`.
+ */
+export const createFetchPolicy = ({ service, chainIdCaip, logger, backoff = new ExponentialBackoff(), ...options }) => {
+    const prefix = `[${[service, chainIdCaip].filter(Boolean).join(' ')}]`;
+    const isRetryable = (error) => {
+        if (!isTransientError(error)) {
+            return false;
+        }
+        const retryAfterMs = error.retryAfterMs ?? 0;
+        if (retryAfterMs > MAX_RETRY_AFTER_MS) {
+            logger.warn(`${prefix} Not retrying: Retry-After of ${retryAfterMs} ms is over the ${MAX_RETRY_AFTER_MS} ms cap:`, error);
+            return false;
+        }
+        return true;
+    };
+    const policy = createServicePolicy({
+        circuitBreakDuration: DEFAULT_CIRCUIT_BREAK_DURATION_MS,
+        ...options,
+        backoff: withRetryAfter(backoff),
+        retryFilterPolicy: handleWhen(isRetryable),
+        isServiceFailure,
+    });
+    policy.onRetry(({ attempt, delay, ...reason }) => logger.warn(`${prefix} Retrying (attempt ${attempt}, delay ${delay} ms):`, errorOf(reason)));
+    policy.retryPolicy.onGiveUp((reason) => logger.warn(`${prefix} Giving up:`, errorOf(reason)));
+    policy.onBreak((reason) => {
+        const message = `${prefix} Circuit opened for ${policy.circuitBreakDuration} ms`;
+        const error = errorOf(reason);
+        if (error === undefined) {
+            logger.warn(message);
+        }
+        else {
+            logger.warn(`${message}:`, error);
+        }
+    });
+    return policy;
+};
+//# sourceMappingURL=createFetchPolicy.mjs.map

package/dist/utils/fetchPolicy/createFetchPolicy.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFetchPolicy.mjs","sourceRoot":"","sources":["../../../src/utils/fetchPolicy/createFetchPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,UAAU,EACX,oCAAoC;AAQrC;;;GAGG;AACH,OAAO,EAAE,kBAAkB,EAAE,oCAAoC;AAgBjE;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,OAAO,EAAE,cAAc;IACvB,OAAO,EAAE,cAAc;CACf,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAEzC,MAAM,iCAAiC,GAAG,MAAM,CAAC;AAEjD,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAE7E;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAAe,EACf,EACE,IAAI,EACJ,UAAU,EACV,YAAY,EACZ,KAAK,MAMH,EAAE,EACY,EAAE;IACpB,MAAM,KAAK,GAAqB,IAAI,KAAK,CACvC,OAAO,EACP,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAC5C,CAAC;IACF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;IACpB,CAAC;IACD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;IAChC,CAAC;IACD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC;IACpC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAW,EAAE;IAC1D,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAyB,CAAC;IACvD,OAAO,CACL,IAAI,KAAK,oBAAoB,CAAC,OAAO;QACrC,IAAI,KAAK,oBAAoB,CAAC,OAAO;QACrC,CAAC,UAAU,KAAK,SAAS,IAAI,uBAAuB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CACtE,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAW,EAAE,CACnD,gBAAgB,CAAC,KAAK,CAAC;IACvB,CAAE,KAAsC,EAAE,UAAU,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC;AAIpE;;;;;GAKG;AACH,MAAM,OAAO,GAAG,CAAC,MAAe,EAAW,EAAE,CAC1C,MAA8B,CAAC,KAAK,CAAC;AAExC;;;;;;GAMG;AACH,MAAM,cAAc,GAAG,CAAC,KAAc,EAAW,EAAE,CAAC,CAAC;IACnD,IAAI,CAAC,OAAO;QACV,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,OAAO,CAAE,OAA+B,CAAC,MAAM,CAEhD,CAAC;QACd,MAAM,UAAU,GAAG,KAAK,EAAE,YAAY,CAAC;QACvC,MAAM,YAAY,GAChB,OAAO,UAAU,KAAK,QAAQ;YAC9B,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC;YAC3B,UAAU,IAAI,CAAC;YACb,CAAC,CAAC,UAAU;YACZ,CAAC,CAAC,CAAC,CAAC;QACR,OAAO;YACL,GAAG,cAAc,CAAC,IAAI,CAAC;YACvB,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC;SAChD,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAsBH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAChC,OAAO,EACP,WAAW,EACX,MAAM,EACN,OAAO,GAAG,IAAI,kBAAkB,EAAE,EAClC,GAAG,OAAO,EACe,EAAiB,EAAE;IAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAEvE,MAAM,WAAW,GAAG,CAAC,KAAuB,EAAW,EAAE;QACvD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,CAAC,CAAC;QAC7C,IAAI,YAAY,GAAG,kBAAkB,EAAE,CAAC;YACtC,MAAM,CAAC,IAAI,CACT,GAAG,MAAM,iCAAiC,YAAY,mBAAmB,kBAAkB,UAAU,EACrG,KAAK,CACN,CAAC;YACF,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,mBAAmB,CAAC;QACjC,oBAAoB,EAAE,iCAAiC;QACvD,GAAG,OAAO;QACV,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;QAChC,iBAAiB,EAAE,UAAU,CAAC,WAAW,CAAC;QAC1C,gBAAgB;KACjB,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,CAC/C,MAAM,CAAC,IAAI,CACT,GAAG,MAAM,sBAAsB,OAAO,WAAW,KAAK,OAAO,EAC7D,OAAO,CAAC,MAAM,CAAC,CAChB,CACF,CAAC;IACF,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,EAAE,CACrC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CACrD,CAAC;IACF,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACxB,MAAM,OAAO,GAAG,GAAG,MAAM,uBAAuB,MAAM,CAAC,oBAAoB,KAAK,CAAC;QACjF,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC","sourcesContent":["import {\n  createServicePolicy,\n  ExponentialBackoff,\n  handleWhen,\n} from '@metamask/base-data-service';\nimport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/base-data-service';\n\nimport type { Logger } from '../logger/Logger';\n\n/**\n * The error `policy.execute()` throws while the circuit is open. Its `name` is\n * `Error`, so check for it with `instanceof`.\n */\nexport { BrokenCircuitError } from '@metamask/base-data-service';\n\n/**\n * The error shape the fetch policy decides on. Each snap converts its errors\n * to this shape at the network boundary.\n *\n * - `httpStatus` is set only when a non-2xx response arrived.\n * - Network failures and timeouts have no `httpStatus`; they are identified by\n * their `name` (see {@link FetchPolicyErrorName}).\n * - `retryAfterMs` is the parsed `Retry-After` header, when there is one.\n */\nexport type FetchPolicyError = Error & {\n  httpStatus?: number;\n  retryAfterMs?: number;\n};\n\n/**\n * The error names the fetch policy treats as transient. `TimeoutError` is also\n * the name of the error thrown by `AbortSignal.timeout()`.\n */\nexport const FetchPolicyErrorName = {\n  Network: 'NetworkError',\n  Timeout: 'TimeoutError',\n} as const;\n\n/**\n * The longest `Retry-After` the policy waits for. A longer one fails the call\n * at once rather than blocking the user.\n */\nexport const MAX_RETRY_AFTER_MS = 30_000;\n\nconst DEFAULT_CIRCUIT_BREAK_DURATION_MS = 30_000;\n\nconst RETRYABLE_HTTP_STATUSES = new Set([408, 425, 429, 500, 502, 503, 504]);\n\n/**\n * Creates an error in the shape the fetch policy decides on.\n *\n * @param message - The error message.\n * @param options - The error fields. Omitted fields are not set.\n * @param options.name - The error name, e.g. `FetchPolicyErrorName.Network`.\n * @param options.httpStatus - The HTTP status of a non-2xx response.\n * @param options.retryAfterMs - The parsed `Retry-After` header, in milliseconds.\n * @param options.cause - The original error.\n * @returns The error.\n */\nexport const createFetchPolicyError = (\n  message: string,\n  {\n    name,\n    httpStatus,\n    retryAfterMs,\n    cause,\n  }: {\n    name?: string;\n    httpStatus?: number;\n    retryAfterMs?: number;\n    cause?: unknown;\n  } = {},\n): FetchPolicyError => {\n  const error: FetchPolicyError = new Error(\n    message,\n    cause === undefined ? undefined : { cause },\n  );\n  if (name !== undefined) {\n    error.name = name;\n  }\n  if (httpStatus !== undefined) {\n    error.httpStatus = httpStatus;\n  }\n  if (retryAfterMs !== undefined) {\n    error.retryAfterMs = retryAfterMs;\n  }\n  return error;\n};\n\n/**\n * Whether an error is a transient failure: a network failure, a timeout, or\n * HTTP 408, 425, 429, 500, 502, 503 or 504.\n *\n * @param error - The error to check.\n * @returns `true` if the error is transient.\n */\nexport const isTransientError = (error: unknown): boolean => {\n  if (!(error instanceof Error)) {\n    return false;\n  }\n  const { name, httpStatus } = error as FetchPolicyError;\n  return (\n    name === FetchPolicyErrorName.Network ||\n    name === FetchPolicyErrorName.Timeout ||\n    (httpStatus !== undefined && RETRYABLE_HTTP_STATUSES.has(httpStatus))\n  );\n};\n\nconst isServiceFailure = (error: unknown): boolean =>\n  isTransientError(error) ||\n  ((error as FetchPolicyError | undefined)?.httpStatus ?? 0) >= 500;\n\ntype Backoff = NonNullable<CreateServicePolicyOptions['backoff']>;\n\n/**\n * Gets the error of a failed attempt, if it threw one.\n *\n * @param reason - The failure reason from the policy (`{ error }` or `{ value }`).\n * @returns The error, or `undefined` if the attempt didn't throw.\n */\nconst errorOf = (reason: unknown): unknown =>\n  (reason as { error?: unknown }).error;\n\n/**\n * Wraps a backoff so each delay is at least the failed attempt's\n * `retryAfterMs`.\n *\n * @param inner - The backoff to wrap.\n * @returns The wrapped backoff.\n */\nconst withRetryAfter = (inner: Backoff): Backoff => ({\n  next(context): ReturnType<Backoff['next']> {\n    const step = inner.next(context);\n    const error = errorOf((context as { result: unknown }).result) as\n      | FetchPolicyError\n      | undefined;\n    const retryAfter = error?.retryAfterMs;\n    const retryAfterMs =\n      typeof retryAfter === 'number' &&\n      Number.isFinite(retryAfter) &&\n      retryAfter >= 0\n        ? retryAfter\n        : 0;\n    return {\n      ...withRetryAfter(step),\n      duration: Math.max(step.duration, retryAfterMs),\n    };\n  },\n});\n\nexport type CreateFetchPolicyOptions = Omit<\n  CreateServicePolicyOptions,\n  'retryFilterPolicy' | 'isServiceFailure'\n> & {\n  /**\n   * The upstream service the policy protects, e.g. `price_api`. Create one\n   * policy per service, so one failing service doesn't open the circuit for\n   * the others.\n   */\n  service: string;\n  /**\n   * The CAIP-2 chain ID the service is called for, if any.\n   */\n  chainIdCaip?: string;\n  /**\n   * Where retries, circuit breaks and give-ups are logged.\n   */\n  logger: Pick<Logger, 'warn'>;\n};\n\n/**\n * Creates a retry and circuit-breaker policy for calls to one upstream\n * service, on top of `createServicePolicy` from `@metamask/base-data-service`.\n *\n * - Retries only transient errors (see {@link isTransientError}), up to 3 times\n * by default, with exponential backoff and jitter.\n * - Waits for the error's `retryAfterMs` when it is longer than the backoff, and\n * doesn't retry when it is over {@link MAX_RETRY_AFTER_MS}.\n * - Counts transient errors and any 5xx toward opening the circuit, which then\n * stays open for 30 seconds by default. Other errors, such as 4xx, aborts and\n * validation errors, don't count.\n *\n * The circuit state lives in memory, and a snap is stopped after about 30\n * seconds idle, so the circuit only protects within a burst of requests.\n *\n * Snaps must provide a `performance` global (see `performance-shim`), which\n * the underlying library uses to time calls.\n *\n * Create one policy per upstream service, convert errors to\n * {@link FetchPolicyError} at the network boundary, and wrap each call with\n * `policy.execute()`:\n *\n * @example\n * ```typescript\n * const priceApiPolicy = createFetchPolicy({ service: 'price_api', logger });\n *\n * const prices = await priceApiPolicy.execute(async () => {\n *   const response = await fetch(url, {\n *     signal: AbortSignal.timeout(10_000),\n *   });\n *   if (!response.ok) {\n *     throw createFetchPolicyError(`HTTP ${response.status}`, {\n *       httpStatus: response.status,\n *     });\n *   }\n *   return response.json();\n * });\n * ```\n *\n * Don't wrap calls that build, sign and send a transaction: a retry could send\n * it twice.\n *\n * While the circuit is open, `policy.execute()` throws\n * {@link BrokenCircuitError} without calling the service. Its `name` is\n * `Error`, so check for it with `instanceof`.\n *\n * The underlying library times calls with `performance.now()`, which snaps\n * don't have. Add `webpack` as a dev dependency, on the same major version as\n * `@metamask/snaps-cli`, and provide the shim in `snap.config.ts`:\n *\n * @example\n * ```typescript\n * import type { SnapConfig } from '@metamask/snaps-cli';\n * import { merge } from '@metamask/snaps-cli';\n * import { ProvidePlugin } from 'webpack';\n *\n * const config: SnapConfig = {\n *   // ...\n *   customizeWebpackConfig: (webpackConfig) =>\n *     merge(webpackConfig, {\n *       plugins: [\n *         new ProvidePlugin({\n *           performance: '@metamask/snap-networks-utils/performance-shim',\n *         }),\n *       ],\n *     }),\n * };\n * ```\n *\n * @param options - The policy options.\n * @param options.service - The upstream service name.\n * @param options.chainIdCaip - The CAIP-2 chain ID, if any.\n * @param options.logger - The logger.\n * @param options.backoff - The base backoff. Defaults to exponential backoff.\n * @returns The policy. Wrap each call with `policy.execute()`.\n */\nexport const createFetchPolicy = ({\n  service,\n  chainIdCaip,\n  logger,\n  backoff = new ExponentialBackoff(),\n  ...options\n}: CreateFetchPolicyOptions): ServicePolicy => {\n  const prefix = `[${[service, chainIdCaip].filter(Boolean).join(' ')}]`;\n\n  const isRetryable = (error: FetchPolicyError): boolean => {\n    if (!isTransientError(error)) {\n      return false;\n    }\n    const retryAfterMs = error.retryAfterMs ?? 0;\n    if (retryAfterMs > MAX_RETRY_AFTER_MS) {\n      logger.warn(\n        `${prefix} Not retrying: Retry-After of ${retryAfterMs} ms is over the ${MAX_RETRY_AFTER_MS} ms cap:`,\n        error,\n      );\n      return false;\n    }\n    return true;\n  };\n\n  const policy = createServicePolicy({\n    circuitBreakDuration: DEFAULT_CIRCUIT_BREAK_DURATION_MS,\n    ...options,\n    backoff: withRetryAfter(backoff),\n    retryFilterPolicy: handleWhen(isRetryable),\n    isServiceFailure,\n  });\n\n  policy.onRetry(({ attempt, delay, ...reason }) =>\n    logger.warn(\n      `${prefix} Retrying (attempt ${attempt}, delay ${delay} ms):`,\n      errorOf(reason),\n    ),\n  );\n  policy.retryPolicy.onGiveUp((reason) =>\n    logger.warn(`${prefix} Giving up:`, errorOf(reason)),\n  );\n  policy.onBreak((reason) => {\n    const message = `${prefix} Circuit opened for ${policy.circuitBreakDuration} ms`;\n    const error = errorOf(reason);\n    if (error === undefined) {\n      logger.warn(message);\n    } else {\n      logger.warn(`${message}:`, error);\n    }\n  });\n\n  return policy;\n};\n"]}

package/dist/utils/fetchPolicy/performanceShim.d.mts

@@ -0,0 +1,16 @@
+/**
+ * A minimal `performance` global for snaps, which don't have one. The fetch
+ * policy's underlying library times calls with `performance.now()`.
+ *
+ * Provide it in `snap.config.ts`:
+ *
+ * ```ts
+ * new ProvidePlugin({
+ *   performance: '@metamask/snap-networks-utils/performance-shim',
+ * });
+ * ```
+ *
+ * @returns The current time in milliseconds.
+ */
+export declare const now: () => number;
+//# sourceMappingURL=performanceShim.d.mts.map

package/dist/utils/fetchPolicy/performanceShim.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"performanceShim.d.mts","sourceRoot":"","sources":["../../../src/utils/fetchPolicy/performanceShim.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,GAAG,QAAO,MAAoB,CAAC"}

package/dist/utils/fetchPolicy/performanceShim.mjs

@@ -0,0 +1,16 @@
+/**
+ * A minimal `performance` global for snaps, which don't have one. The fetch
+ * policy's underlying library times calls with `performance.now()`.
+ *
+ * Provide it in `snap.config.ts`:
+ *
+ * ```ts
+ * new ProvidePlugin({
+ *   performance: '@metamask/snap-networks-utils/performance-shim',
+ * });
+ * ```
+ *
+ * @returns The current time in milliseconds.
+ */
+export const now = () => Date.now();
+//# sourceMappingURL=performanceShim.mjs.map

package/dist/utils/fetchPolicy/performanceShim.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"performanceShim.mjs","sourceRoot":"","sources":["../../../src/utils/fetchPolicy/performanceShim.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,GAAW,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC","sourcesContent":["/**\n * A minimal `performance` global for snaps, which don't have one. The fetch\n * policy's underlying library times calls with `performance.now()`.\n *\n * Provide it in `snap.config.ts`:\n *\n * ```ts\n * new ProvidePlugin({\n *   performance: '@metamask/snap-networks-utils/performance-shim',\n * });\n * ```\n *\n * @returns The current time in milliseconds.\n */\nexport const now = (): number => Date.now();\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/snap-networks-utils",
-  "version": "2.0.0-preview-0a7c77e1",
+  "version": "3.0.0-preview-61fa1fce",
   "description": "Shared utilities for MetaMask network snaps",
   "keywords": [
     "Ethereum",
@@ -19,38 +19,24 @@
     "dist/"
   ],
   "sideEffects": false,
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.cts",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
     },
     "./dedupe": {
-      "import": {
-        "types": "./dist/utils/dedupe/InFlightCoalescer.d.mts",
-        "default": "./dist/utils/dedupe/InFlightCoalescer.mjs"
-      },
-      "require": {
-        "types": "./dist/utils/dedupe/InFlightCoalescer.d.cts",
-        "default": "./dist/utils/dedupe/InFlightCoalescer.cjs"
-      }
+      "types": "./dist/utils/dedupe/InFlightCoalescer.d.mts",
+      "default": "./dist/utils/dedupe/InFlightCoalescer.mjs"
+    },
+    "./performance-shim": {
+      "types": "./dist/utils/fetchPolicy/performanceShim.d.mts",
+      "default": "./dist/utils/fetchPolicy/performanceShim.mjs"
     },
     "./logger": {
-      "import": {
-        "types": "./dist/utils/logger/Logger.d.mts",
-        "default": "./dist/utils/logger/Logger.mjs"
-      },
-      "require": {
-        "types": "./dist/utils/logger/Logger.d.cts",
-        "default": "./dist/utils/logger/Logger.cjs"
-      }
+      "types": "./dist/utils/logger/Logger.d.mts",
+      "default": "./dist/utils/logger/Logger.mjs"
     },
     "./package.json": "./package.json"
   },
@@ -59,21 +45,22 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references && yarn build:assets",
-    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean && yarn build:assets",
+    "build": "ts-bridge --format module --project tsconfig.build.json --verbose --clean --no-references && yarn build:assets",
+    "build:all": "ts-bridge --format module --project tsconfig.build.json --verbose --clean && yarn build:assets",
     "build:assets": "rsync -a --prune-empty-dirs --include='*/' --include='*.svg' --exclude='*' src/ dist/",
     "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/snap-networks-utils",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/snap-networks-utils",
     "since-latest-release": "../../scripts/since-latest-release.sh",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter && yarn coverage:ratchet",
+    "test": "jest --reporters=jest-silent-reporter && yarn coverage:ratchet",
     "coverage:ratchet": "[ -n \"$CI\" ] || jest-it-up",
-    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
-    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
-    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+    "test:clean": "jest --clearCache",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
   },
   "dependencies": {
     "@metamask/assets-controller": "^15.0.0",
+    "@metamask/base-data-service": "^2.1.0",
     "@metamask/keyring-api": "^24.1.0",
     "@metamask/keyring-internal-api": "^12.0.0",
     "@metamask/remote-feature-flag-controller": "^5.0.0",