@lifi/perps-sdk 31.1.0 → 31.1.1

package/README.md

@@ -88,6 +88,29 @@ so either disables registry-level reuse and request coalescing. Such hooks still
 run on every `sync()`. This cache applies only to reference registries, not account,
 price, or authenticated trading responses.
 
+## Platform notices
+
+`getMeta(client)` returns the API `version` and the `notices` that the backend
+serves. The scope of a `Notice` comes from `providerKeys`:
+
+- A notice without `providerKeys` is global. It applies to all users.
+- A notice with `providerKeys` applies only to the listed providers. An
+  imported provider notice always lists one or more providers.
+
+All `Notice` times are Unix epoch milliseconds. The visibility interval is
+`[validFrom, validTo)`: it includes `validFrom` and excludes `validTo`. An
+absent bound has no limit. The visibility bounds do not describe a maintenance
+window. `startsAt`, `endsAt`, and `resolvedAt` describe the event. An absent
+`endsAt` means that the end is not known, and a scheduled `endsAt` does not
+prove recovery.
+
+`id` identifies a notice across polls. `revision` is an opaque value that
+changes when the user-facing content changes. `lastCheckedAt` is the last
+successful observation of the source, not the last poll attempt.
+
+The SDK returns the notices as the backend serves them. It does not filter
+them by visibility, scope, or acknowledgement. The caller does that work.
+
 ## High-level client
 
 `PerpsClient` owns the end-to-end action pipeline. Its trade wrappers include

package/dist/cjs/services/getMeta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getMeta.d.ts","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAE7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAgB1D,wBAAsB,OAAO,CAC3B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAOf"}
+{"version":3,"file":"getMeta.d.ts","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAE7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAmB1D,wBAAsB,OAAO,CAC3B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAOf"}

package/dist/cjs/services/getMeta.js.map

@@ -1 +1 @@
-{"version":3,"file":"getMeta.js","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":";;AAmBA,0BAUC;AA5BD,wDAAiD;AAkB1C,KAAK,UAAU,OAAO,CAC3B,MAAsB,EACtB,OAA2B;IAE3B,OAAO,IAAA,oBAAO,EACZ,MAAM,CAAC,MAAM,EACb,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,OAAO,EAC9B,EAAE,EACF,OAAO,CACR,CAAA;AACH,CAAC"}
+{"version":3,"file":"getMeta.js","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":";;AAsBA,0BAUC;AA/BD,wDAAiD;AAqB1C,KAAK,UAAU,OAAO,CAC3B,MAAsB,EACtB,OAA2B;IAE3B,OAAO,IAAA,oBAAO,EACZ,MAAM,CAAC,MAAM,EACb,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,OAAO,EAC9B,EAAE,EACF,OAAO,CACR,CAAA;AACH,CAAC"}

package/dist/cjs/version.d.ts

@@ -1,3 +1,3 @@
 export declare const name = "@lifi/perps-sdk";
-export declare const version = "31.1.0";
+export declare const version = "31.1.1";
 //# sourceMappingURL=version.d.ts.map

package/dist/cjs/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = exports.name = void 0;
 exports.name = '@lifi/perps-sdk';
-exports.version = '31.1.0';
+exports.version = '31.1.1';
 //# sourceMappingURL=version.js.map

package/dist/esm/services/getMeta.d.ts

@@ -2,9 +2,12 @@ import type { Meta } from '@lifi/perps-types';
 import type { SDKRequestOptions } from '../types/config.js';
 import type { PerpsSDKClient } from '../types/provider.js';
 /**
- * Get platform metadata: the API version and any active platform-level notices.
+ * Get platform metadata: the API version and the notices the backend serves.
+ * A notice without `providerKeys` is global; a notice with `providerKeys` is
+ * scoped to those providers. The SDK returns notices as served and does not
+ * filter them by `validFrom` / `validTo`.
  *
- * @returns Platform version and the list of active notices
+ * @returns Platform version and the global and provider-scoped notices
  * @throws {PerpsError} On API error responses
  * @throws {PerpsError} On network or parsing errors
  *

package/dist/esm/services/getMeta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getMeta.d.ts","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAE7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;;;;;;;;;;GAaG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAOf"}
+{"version":3,"file":"getMeta.d.ts","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAE7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAOf"}

package/dist/esm/services/getMeta.js

@@ -1,8 +1,11 @@
 import { request } from '../transport/request.js';
 /**
- * Get platform metadata: the API version and any active platform-level notices.
+ * Get platform metadata: the API version and the notices the backend serves.
+ * A notice without `providerKeys` is global; a notice with `providerKeys` is
+ * scoped to those providers. The SDK returns notices as served and does not
+ * filter them by `validFrom` / `validTo`.
  *
- * @returns Platform version and the list of active notices
+ * @returns Platform version and the global and provider-scoped notices
  * @throws {PerpsError} On API error responses
  * @throws {PerpsError} On network or parsing errors
  *

package/dist/esm/services/getMeta.js.map

@@ -1 +1 @@
-{"version":3,"file":"getMeta.js","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAIjD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,MAAsB,EACtB,OAA2B;IAE3B,OAAO,OAAO,CACZ,MAAM,CAAC,MAAM,EACb,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,OAAO,EAC9B,EAAE,EACF,OAAO,CACR,CAAA;AACH,CAAC"}
+{"version":3,"file":"getMeta.js","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAIjD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,MAAsB,EACtB,OAA2B;IAE3B,OAAO,OAAO,CACZ,MAAM,CAAC,MAAM,EACb,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,OAAO,EAC9B,EAAE,EACF,OAAO,CACR,CAAA;AACH,CAAC"}

package/dist/esm/version.d.ts

@@ -9,5 +9,5 @@ export declare const name = "@lifi/perps-sdk";
  *
  * @public
  */
-export declare const version = "31.1.0";
+export declare const version = "31.1.1";
 //# sourceMappingURL=version.d.ts.map

package/dist/esm/version.js

@@ -9,5 +9,5 @@ export const name = '@lifi/perps-sdk';
  *
  * @public
  */
-export const version = '31.1.0';
+export const version = '31.1.1';
 //# sourceMappingURL=version.js.map

package/dist/types/services/getMeta.d.ts

@@ -2,9 +2,12 @@ import type { Meta } from '@lifi/perps-types';
 import type { SDKRequestOptions } from '../types/config.js';
 import type { PerpsSDKClient } from '../types/provider.js';
 /**
- * Get platform metadata: the API version and any active platform-level notices.
+ * Get platform metadata: the API version and the notices the backend serves.
+ * A notice without `providerKeys` is global; a notice with `providerKeys` is
+ * scoped to those providers. The SDK returns notices as served and does not
+ * filter them by `validFrom` / `validTo`.
  *
- * @returns Platform version and the list of active notices
+ * @returns Platform version and the global and provider-scoped notices
  * @throws {PerpsError} On API error responses
  * @throws {PerpsError} On network or parsing errors
  *

package/dist/types/services/getMeta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getMeta.d.ts","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAE7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;;;;;;;;;;GAaG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAOf"}
+{"version":3,"file":"getMeta.d.ts","sourceRoot":"","sources":["../../../src/services/getMeta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAE7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAOf"}

package/dist/types/version.d.ts

@@ -9,5 +9,5 @@ export declare const name = "@lifi/perps-sdk";
  *
  * @public
  */
-export declare const version = "31.1.0";
+export declare const version = "31.1.1";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/perps-sdk",
-  "version": "31.1.0",
+  "version": "31.1.1",
   "description": "LI.FI Perps SDK for perpetuals trading",
   "homepage": "https://github.com/lifinance/perps-sdk",
   "bugs": {
@@ -45,7 +45,7 @@
     "@lifi/types": "^18.3.0",
     "big.js": "^7.0.1",
     "partysocket": "^1.1.19",
-    "@lifi/perps-types": "^27.1.0"
+    "@lifi/perps-types": "^27.2.0"
   },
   "peerDependencies": {
     "viem": ">=2.57.11 <2.57.12"

package/src/services/getMeta.ts

@@ -4,9 +4,12 @@ import type { SDKRequestOptions } from '../types/config.js'
 import type { PerpsSDKClient } from '../types/provider.js'
 
 /**
- * Get platform metadata: the API version and any active platform-level notices.
+ * Get platform metadata: the API version and the notices the backend serves.
+ * A notice without `providerKeys` is global; a notice with `providerKeys` is
+ * scoped to those providers. The SDK returns notices as served and does not
+ * filter them by `validFrom` / `validTo`.
  *
- * @returns Platform version and the list of active notices
+ * @returns Platform version and the global and provider-scoped notices
  * @throws {PerpsError} On API error responses
  * @throws {PerpsError} On network or parsing errors
  *

package/src/version.ts

@@ -10,4 +10,4 @@ export const name = '@lifi/perps-sdk'
  *
  * @public
  */
-export const version = '31.1.0'
+export const version = '31.1.1'