@xmtp/content-type-wallet-send-calls 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 XMTP (xmtp.org)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,101 @@
+# Wallet Send Calls content type
+
+## Install the package
+
+```bash
+# npm
+npm i @xmtp/content-type-wallet-send-calls
+
+# yarn
+yarn add @xmtp/content-type-wallet-send-calls
+
+# pnpm
+pnpm i @xmtp/content-type-wallet-send-calls
+```
+
+## Create a transaction request
+
+With XMTP, a transaction request is represented using `wallet_sendCalls` RPC specification from [EIP-5792](https://eips.ethereum.org/EIPS/eip-5792) with additional metadata for display:
+
+```tsx
+const walletSendCalls: WalletSendCallsParams = {
+  version: "1.0",
+  from: "0x123...abc",
+  chainId: "0x2105",
+  calls: [
+    {
+      to: "0x456...def",
+      value: "0x5AF3107A4000",
+      metadata: {
+        description: "Send 0.0001 ETH on base to 0x456...def",
+        transactionType: "transfer",
+        currency: "ETH",
+        amount: 100000000000000,
+        decimals: 18,
+        toAddress: "0x456...def",
+      },
+    },
+    {
+      to: "0x789...cba",
+      data: "0xdead...beef",
+      metadata: {
+        description: "Lend 10 USDC on base with Morpho @ 8.5% APY",
+        transactionType: "lend",
+        currency: "USDC",
+        amount: 10000000,
+        decimals: 6,
+        platform: "morpho",
+        apy: "8.5",
+      },
+    },
+  ],
+};
+```
+
+## Send a transaction request
+
+Once you have a transaction reference, you can send it as part of your conversation:
+
+```tsx
+await conversation.messages.send(walletSendCalls, {
+  contentType: ContentTypeWalletSendCalls,
+});
+```
+
+## Receive a transaction request
+
+To receive and process a transaction request:
+
+```tsx
+// Assume `loadLastMessage` is a thing you have
+const message: DecodedMessage = await loadLastMessage();
+
+if (!message.contentType.sameAs(ContentTypeWalletSendCalls)) {
+  // Handle non-transaction request message
+  return;
+}
+
+const walletSendCalls: WalletSendCallsParams = message.content;
+// Process the transaction request here
+```
+
+## Developing
+
+Run `yarn dev` to build the content type and watch for changes, which will trigger a rebuild.
+
+## Testing
+
+Before running unit tests, start the required Docker container at the root of this repository. For more info, see [Running tests](../../README.md#running-tests).
+
+## Useful commands
+
+- `yarn build`: Builds the content type
+- `yarn clean`: Removes `node_modules`, `dist`, and `.turbo` folders
+- `yarn dev`: Builds the content type and watches for changes, which will trigger a rebuild
+- `yarn format`: Runs Prettier format and write changes
+- `yarn format:check`: Runs Prettier format check
+- `yarn lint`: Runs ESLint
+- `yarn test:setup`: Starts a necessary Docker container for testing
+- `yarn test:teardown`: Stops Docker container for testing
+- `yarn test`: Runs all unit tests
+- `yarn typecheck`: Runs `tsc`

package/dist/browser/index.js

@@ -0,0 +1,2 @@
+import{ContentTypeId as e}from"@xmtp/content-type-primitives";const t=new e({authorityId:"xmtp.org",typeId:"walletSendCalls",versionMajor:1,versionMinor:0});class n{get contentType(){return t}encode(e){return{type:t,parameters:{},content:(new TextEncoder).encode(JSON.stringify(e))}}decode(e){const t=e.content;return JSON.parse((new TextDecoder).decode(t))}fallback(e){return`[Transaction request generated]: ${JSON.stringify(e)}`}shouldPush(){return!0}}export{t as ContentTypeWalletSendCalls,n as WalletSendCallsCodec};
+//# sourceMappingURL=index.js.map

package/dist/browser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/WalletSendCalls.ts"],"sourcesContent":[null],"names":["ContentTypeWalletSendCalls","ContentTypeId","authorityId","typeId","versionMajor","versionMinor","WalletSendCallsCodec","contentType","encode","content","type","parameters","TextEncoder","JSON","stringify","decode","encodedContent","uint8Array","parse","TextDecoder","fallback","shouldPush"],"mappings":"8DAOa,MAAAA,EAA6B,IAAIC,EAAc,CAC1DC,YAAa,WACbC,OAAQ,kBACRC,aAAc,EACdC,aAAc,UAoBHC,EAGX,eAAIC,GACF,OAAOP,EAGT,MAAAQ,CAAOC,GAML,MALgB,CACdC,KAAMV,EACNW,WAAY,CAAE,EACdF,SAAS,IAAIG,aAAcJ,OAAOK,KAAKC,UAAUL,KAKrD,MAAAM,CAAOC,GACL,MAAMC,EAAaD,EAAeP,QAIlC,OAHwBI,KAAKK,OAC3B,IAAIC,aAAcJ,OAAOE,IAK7B,QAAAG,CAASX,GACP,MAAO,oCAAoCI,KAAKC,UAAUL,KAG5D,UAAAY,GACE,OAAO"}

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import { ContentCodec, ContentTypeId, EncodedContent } from '@xmtp/content-type-primitives';
+
+declare const ContentTypeWalletSendCalls: ContentTypeId;
+type WalletSendCallsParams = {
+    version: string;
+    chainId: `0x${string}`;
+    from: `0x${string}`;
+    calls: {
+        to?: `0x${string}` | undefined;
+        data?: `0x${string}` | undefined;
+        value?: `0x${string}` | undefined;
+        gas?: `0x${string}` | undefined;
+        metadata?: {
+            description: string;
+            transactionType: string;
+        } & Record<string, any>;
+    }[];
+    capabilities?: Record<string, any> | undefined;
+};
+declare class WalletSendCallsCodec implements ContentCodec<WalletSendCallsParams> {
+    get contentType(): ContentTypeId;
+    encode(content: WalletSendCallsParams): EncodedContent;
+    decode(encodedContent: EncodedContent): WalletSendCallsParams;
+    fallback(content: WalletSendCallsParams): string | undefined;
+    shouldPush(): boolean;
+}
+
+export { ContentTypeWalletSendCalls, WalletSendCallsCodec, type WalletSendCallsParams };

package/dist/index.js

@@ -0,0 +1,36 @@
+import { ContentTypeId } from '@xmtp/content-type-primitives';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const ContentTypeWalletSendCalls = new ContentTypeId({
+    authorityId: "xmtp.org",
+    typeId: "walletSendCalls",
+    versionMajor: 1,
+    versionMinor: 0,
+});
+class WalletSendCallsCodec {
+    get contentType() {
+        return ContentTypeWalletSendCalls;
+    }
+    encode(content) {
+        const encoded = {
+            type: ContentTypeWalletSendCalls,
+            parameters: {},
+            content: new TextEncoder().encode(JSON.stringify(content)),
+        };
+        return encoded;
+    }
+    decode(encodedContent) {
+        const uint8Array = encodedContent.content;
+        const contentReceived = JSON.parse(new TextDecoder().decode(uint8Array));
+        return contentReceived;
+    }
+    fallback(content) {
+        return `[Transaction request generated]: ${JSON.stringify(content)}`;
+    }
+    shouldPush() {
+        return true;
+    }
+}
+
+export { ContentTypeWalletSendCalls, WalletSendCallsCodec };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/WalletSendCalls.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;AAOa,MAAA,0BAA0B,GAAG,IAAI,aAAa,CAAC;AAC1D,IAAA,WAAW,EAAE,UAAU;AACvB,IAAA,MAAM,EAAE,iBAAiB;AACzB,IAAA,YAAY,EAAE,CAAC;AACf,IAAA,YAAY,EAAE,CAAC;AAChB,CAAA;MAmBY,oBAAoB,CAAA;AAG/B,IAAA,IAAI,WAAW,GAAA;AACb,QAAA,OAAO,0BAA0B;;AAGnC,IAAA,MAAM,CAAC,OAA8B,EAAA;AACnC,QAAA,MAAM,OAAO,GAAG;AACd,YAAA,IAAI,EAAE,0BAA0B;AAChC,YAAA,UAAU,EAAE,EAAE;AACd,YAAA,OAAO,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;SAC3D;AACD,QAAA,OAAO,OAAO;;AAGhB,IAAA,MAAM,CAAC,cAA8B,EAAA;AACnC,QAAA,MAAM,UAAU,GAAG,cAAc,CAAC,OAAO;AACzC,QAAA,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAChC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CACZ;AAC1B,QAAA,OAAO,eAAe;;AAGxB,IAAA,QAAQ,CAAC,OAA8B,EAAA;QACrC,OAAO,CAAA,iCAAA,EAAoC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;;IAGtE,UAAU,GAAA;AACR,QAAA,OAAO,IAAI;;AAEd;;;;"}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@xmtp/content-type-wallet-send-calls",
+  "version": "1.0.0",
+  "description": "An XMTP content type to support sending transactions to wallet for execution",
+  "keywords": [
+    "xmtp",
+    "messaging",
+    "web3",
+    "js",
+    "ts",
+    "javascript",
+    "typescript",
+    "content-types"
+  ],
+  "homepage": "https://github.com/xmtp/xmtp-js",
+  "bugs": {
+    "url": "https://github.com/xmtp/xmtp-js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/xmtp/xmtp-js.git",
+    "directory": "content-types/content-type-wallet-send-calls"
+  },
+  "license": "MIT",
+  "author": "XMTP Labs <eng@xmtp.com>",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "browser": "./dist/browser/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.js",
+  "browser": "dist/browser/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.test.*"
+  ],
+  "scripts": {
+    "build": "yarn clean:dist && yarn rollup -c",
+    "clean": "yarn clean:dist && yarn clean:dbs && rimraf .turbo node_modules",
+    "clean:dbs": "rimraf *.db3* ||:",
+    "clean:dist": "rimraf dist",
+    "dev": "yarn clean:dist && yarn rollup -c --watch",
+    "test": "NODE_TLS_REJECT_UNAUTHORIZED=0 vitest run --environment node",
+    "typecheck": "tsc"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 3 chrome versions",
+      "last 3 firefox versions",
+      "last 3 safari versions"
+    ]
+  },
+  "dependencies": {
+    "@xmtp/content-type-primitives": "^2.0.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/node": "^22.13.10",
+    "@xmtp/node-sdk": "workspace:^",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.36.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-filesize": "^10.0.0",
+    "typescript": "^5.8.2",
+    "vite": "^6.2.2",
+    "vitest": "^3.0.9"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/src/WalletSendCalls.ts

@@ -0,0 +1,63 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import {
+  ContentTypeId,
+  type ContentCodec,
+  type EncodedContent,
+} from "@xmtp/content-type-primitives";
+
+export const ContentTypeWalletSendCalls = new ContentTypeId({
+  authorityId: "xmtp.org",
+  typeId: "walletSendCalls",
+  versionMajor: 1,
+  versionMinor: 0,
+});
+
+export type WalletSendCallsParams = {
+  version: string;
+  chainId: `0x${string}`; // Hex chain id
+  from: `0x${string}`;
+  calls: {
+    to?: `0x${string}` | undefined;
+    data?: `0x${string}` | undefined;
+    value?: `0x${string}` | undefined; // Hex value
+    gas?: `0x${string}` | undefined;
+    metadata?: {
+      description: string;
+      transactionType: string;
+    } & Record<string, any>;
+  }[];
+  capabilities?: Record<string, any> | undefined;
+};
+
+export class WalletSendCallsCodec
+  implements ContentCodec<WalletSendCallsParams>
+{
+  get contentType(): ContentTypeId {
+    return ContentTypeWalletSendCalls;
+  }
+
+  encode(content: WalletSendCallsParams): EncodedContent {
+    const encoded = {
+      type: ContentTypeWalletSendCalls,
+      parameters: {},
+      content: new TextEncoder().encode(JSON.stringify(content)),
+    };
+    return encoded;
+  }
+
+  decode(encodedContent: EncodedContent): WalletSendCallsParams {
+    const uint8Array = encodedContent.content;
+    const contentReceived = JSON.parse(
+      new TextDecoder().decode(uint8Array),
+    ) as WalletSendCallsParams;
+    return contentReceived;
+  }
+
+  fallback(content: WalletSendCallsParams): string | undefined {
+    return `[Transaction request generated]: ${JSON.stringify(content)}`;
+  }
+
+  shouldPush() {
+    return true;
+  }
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export {
+  WalletSendCallsCodec,
+  ContentTypeWalletSendCalls,
+} from "./WalletSendCalls";
+export type { WalletSendCallsParams } from "./WalletSendCalls";