Merge pull request #735 from xmtp/changeset-release/main

release: version packages
xmtp · Nov 23, 2024 · 4e393d2 · 4e393d2
2 parents cdd1f45 + dcdd09b
commit 4e393d2
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 11 deletions.
diff --git a/.changeset/blue-wasps-hunt.md b/.changeset/blue-wasps-hunt.md
diff --git a/packages/frames-client/CHANGELOG.md b/packages/frames-client/CHANGELOG.md
@@ -1,5 +1,30 @@
 # @xmtp/frames-client
 
+## 1.0.0
+
+### BREAKING CHANGE
+
+- 86a8f9f: Refactored signing process using a new `FramesSigner` type
+
+The `FramesClient` class now accepts a `FramesSigner` that handles signing of the frame actions. It supports both V2 and V3 signers.
+
+```ts
+type V2FramesSigner = {
+  address: () => Promise<string> | string;
+  getPublicKeyBundle: () => Promise<publicKeyProto.PublicKeyBundle>;
+  sign: (message: Uint8Array) => Promise<signatureProto.Signature>;
+};
+
+type V3FramesSigner = {
+  installationId: () => Promise<Uint8Array> | Uint8Array;
+  inboxId: () => Promise<string> | string;
+  address: () => Promise<string> | string;
+  sign: (message: Uint8Array) => Promise<Uint8Array> | Uint8Array;
+};
+
+type FramesSigner = V2FramesSigner | V3FramesSigner;
+```
+
 ## 0.5.5
 
 ### Patch Changes

diff --git a/packages/frames-client/package.json b/packages/frames-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@xmtp/frames-client",
-  "version": "0.5.5",
+  "version": "1.0.0",
   "keywords": [
     "xmtp",
     "messaging",

diff --git a/packages/frames-validator/CHANGELOG.md b/packages/frames-validator/CHANGELOG.md
@@ -1,5 +1,24 @@
 # @xmtp/frames-validator
 
+## 1.0.0
+
+### BREAKING CHANGE
+
+- 86a8f9f: Added support for validating V3 frames
+
+`validateFramesPost` is now async to support fetching the inbox ID of an account address when validating V3 frames. It also accepts a second parameter to specify the environment to use when looking up inbox IDs. In production, this parameter **must** be set to `production`.
+
+```ts
+import { XmtpValidator, validateFramesPost } from "@xmtp/frames-validator";
+
+const validator = new XmtpValidator();
+// environment must be set in production (default: "dev")
+const validation = await validator(payload, "production");
+
+// now async, also requires environment in production (default: "dev")
+const validation = await validateFramesPost(payload, "production");
+```
+
 ## 0.6.3
 
 ### Patch Changes

diff --git a/packages/frames-validator/package.json b/packages/frames-validator/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@xmtp/frames-validator",
-  "version": "0.6.3",
+  "version": "1.0.0",
   "description": "A validator for XMTP frames requests",
   "homepage": "https://github.com/xmtp/xmtp-js",
   "bugs": {
@@ -49,7 +49,7 @@
     "@open-frames/types": "^0.1.1",
     "@rollup/plugin-typescript": "^12.1.1",
     "@types/bl": "^5.1.4",
-    "@xmtp/frames-client": "^0.5.5",
+    "@xmtp/frames-client": "^1.0.0",
     "@xmtp/xmtp-js": "^12.1.0",
     "ethers": "^6.10.0",
     "fast-glob": "^3.3.2",

diff --git a/yarn.lock b/yarn.lock
@@ -5024,7 +5024,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@xmtp/frames-client@npm:^0.5.5, @xmtp/frames-client@workspace:packages/frames-client":
+"@xmtp/frames-client@npm:^1.0.0, @xmtp/frames-client@workspace:packages/frames-client":
   version: 0.0.0-use.local
   resolution: "@xmtp/frames-client@workspace:packages/frames-client"
   dependencies:
@@ -5064,7 +5064,7 @@ __metadata:
     "@open-frames/types": "npm:^0.1.1"
     "@rollup/plugin-typescript": "npm:^12.1.1"
     "@types/bl": "npm:^5.1.4"
-    "@xmtp/frames-client": "npm:^0.5.5"
+    "@xmtp/frames-client": "npm:^1.0.0"
     "@xmtp/node-sdk": "npm:^0.0.27"
     "@xmtp/proto": "npm:^3.72.3"
     "@xmtp/xmtp-js": "npm:^12.1.0"