feat: mod/client referrals

.changeset/late-timers-hammer.md

@@ -0,0 +1,6 @@
+---
+"@mod-protocol/react": minor
+"@mod-protocol/core": minor
+---
+
+feat: client and mod attribution in transactions

.changeset/slow-goats-share.md

@@ -0,0 +1,18 @@
+---
+"@mods/infura-ipfs-upload": patch
+"@mods/chatgpt-shorten": patch
+"@mods/zora-nft-minter": patch
+"@mods/livepeer-video": patch
+"@mods/giphy-picker": patch
+"@mods/image-render": patch
+"@mods/imgur-upload": patch
+"@mods/video-render": patch
+"@mods/zora-create": patch
+"@mods/nft-minter": patch
+"@mods/url-render": patch
+"@mods/chatgpt": patch
+"@mods/dall-e": patch
+"@mod-protocol/core": minor
+---
+
+fix: deprecate ENS support for `ModManifest` `custodyAddress` field

examples/nextjs-shadcn/.env.example

@@ -2,4 +2,5 @@ NEXT_PUBLIC_API_URL="http://localhost:3001/api"
 NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID=""
 NEXT_PUBLIC_URL="http://localhost:3000"
 NEXT_PUBLIC_HOST="localhost:3000"
-NEXT_PUBLIC_EXPERIMENTAL_MODS="false"
+NEXT_PUBLIC_EXPERIMENTAL_MODS="false"
+NEXT_PUBLIC_CLIENT_REFERRAL_ADDRESS=

examples/nextjs-shadcn/src/app/editor-example.tsx

@@ -51,6 +51,8 @@ import { useExperimentalMods } from "./use-experimental-mods";
 // Optionally replace with your API_URL here
 const API_URL =
   process.env.NEXT_PUBLIC_API_URL ?? "https://api.modprotocol.org/api";
+const CLIENT_REFERRAL_ADDRESS = process.env
+  .NEXT_PUBLIC_CLIENT_REFERRAL_ADDRESS as `0x${string}` | undefined;
 
 const getMentions = getFarcasterMentions(API_URL);
 const getChannels = getFarcasterChannels(API_URL);
@@ -217,6 +219,7 @@ export default function EditorExample() {
                 input={getText()}
                 embeds={getEmbeds()}
                 api={API_URL}
+                clientReferralAddress={CLIENT_REFERRAL_ADDRESS}
                 user={user}
                 variant="creation"
                 manifest={currentMod}

examples/nextjs-shadcn/src/app/embeds.tsx

@@ -72,6 +72,9 @@ export function Embeds(props: { embeds: Array<Embed> }) {
           address,
         },
       },
+      clientReferralAddress: process.env.NEXT_PUBLIC_CLIENT_REFERRAL_ADDRESS as
+        | `0x${string}`
+        | undefined,
     };
   }, [address]);
 

mods/chatgpt-shorten/src/manifest.ts

@@ -7,7 +7,7 @@ import loading from "./loading";
 const manifest: ModManifest = {
   slug: "chatgpt-shorten",
   name: "Shorten text using AI",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   logo: "https://i.imgur.com/hV566qC.png",
   custodyGithubUsername: "davidfurlong",
   version: "0.0.1",

mods/chatgpt/src/manifest.ts

@@ -7,7 +7,7 @@ import loading from "./loading";
 const manifest: ModManifest = {
   slug: "chatgpt",
   name: "Prompt ChatGPT",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   logo: "https://i.imgur.com/YayIWi1.png",
   custodyGithubUsername: "davidfurlong",
   version: "0.0.1",

mods/dall-e/src/manifest.ts

@@ -7,7 +7,7 @@ import loading from "./loading";
 const manifest: ModManifest = {
   slug: "dall-e",
   name: "Use AI to make an image",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   logo: "https://i.imgur.com/zKiFDal.png",
   custodyGithubUsername: "davidfurlong",
   version: "0.0.1",

mods/giphy-picker/src/manifest.ts

@@ -7,7 +7,7 @@ import loading from "./loading";
 const manifest: ModManifest = {
   slug: "giphy-picker",
   name: "Add GIF/Sticker",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   custodyGithubUsername: "davidfurlong",
   logo: "https://i.imgur.com/vccxL2r.png",
   version: "0.0.1",

mods/image-render/src/manifest.ts

@@ -4,7 +4,7 @@ import view from "./view";
 const manifest: ModManifest = {
   slug: "image-render",
   name: "View Images",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   version: "0.0.1",
   logo: "https://i.imgur.com/75cFuT9.png",
   custodyGithubUsername: "davidfurlong",

mods/imgur-upload/src/manifest.ts

@@ -7,7 +7,7 @@ import upload from "./upload";
 const manifest: ModManifest = {
   slug: "imgur-upload",
   name: "Upload image to Imgur",
-  custodyAddress: "stephancill.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   logo: "https://imgur.com/favicon.ico",
   custodyGithubUsername: "stephancill",
   version: "0.0.1",

mods/infura-ipfs-upload/src/manifest.ts

@@ -7,7 +7,7 @@ import upload from "./upload";
 const manifest: ModManifest = {
   slug: "infura-ipfs-upload",
   name: "Add image",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   logo: "https://i.imgur.com/FxgecX7.png",
   custodyGithubUsername: "davidfurlong",
   version: "0.0.1",

mods/livepeer-video/src/manifest.ts

@@ -7,7 +7,7 @@ import upload from "./upload";
 const manifest: ModManifest = {
   slug: "livepeer-video",
   name: "Add video",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   logo: "https://i.imgur.com/89epIn5.png",
   custodyGithubUsername: "davidfurlong",
   version: "0.0.1",

mods/nft-minter/src/manifest.ts

@@ -4,7 +4,7 @@ import view from "./view";
 const manifest: ModManifest = {
   slug: "nft-minter",
   name: "Preview and mint NFTs",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   version: "0.0.1",
   logo: "https://i.imgur.com/fuSkgoJ.png",
   custodyGithubUsername: "davidfurlong",

mods/url-render/src/manifest.ts

@@ -5,7 +5,7 @@ import fullimage from "./fullimage";
 const manifest: ModManifest = {
   slug: "url-render",
   name: "View urls",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   version: "0.0.1",
   logo: "https://i.imgur.com/E7PAMHH.png",
   custodyGithubUsername: "davidfurlong",

mods/video-render/src/manifest.ts

@@ -4,7 +4,7 @@ import view from "./view";
 const manifest: ModManifest = {
   slug: "video-render",
   name: "View Videos",
-  custodyAddress: "furlong.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   version: "0.0.1",
   logo: "https://i.imgur.com/RITeKTW.png",
   custodyGithubUsername: "davidfurlong",

mods/zora-create/src/manifest.ts

@@ -6,7 +6,7 @@ import loading from "./loading";
 const manifest: ModManifest = {
   slug: "zora-create",
   name: "Add NFT via Zora Premint",
-  custodyAddress: "stephancill.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   logo: "https://i.imgur.com/rsfLOfD.png",
   custodyGithubUsername: "stephancill",
   version: "0.0.1",

mods/zora-nft-minter/src/manifest.ts

@@ -4,7 +4,7 @@ import view from "./view";
 const manifest: ModManifest = {
   slug: "zora-nft-minter",
   name: "Preview and mint Zora NFTs",
-  custodyAddress: "stephancill.eth",
+  custodyAddress: "0xdcC59cF0Adf4175973D4abc8c0715f83f90d2f1d",
   version: "0.0.1",
   logo: "https://i.imgur.com/fuSkgoJ.png",
   custodyGithubUsername: "stephancill",

packages/core/src/manifest.ts

@@ -12,8 +12,8 @@ export type ModManifest = {
   name: string;
   /** A (temporary) github username to define as the owner */
   custodyGithubUsername: string;
-  /** An ethereum address or ENS address to define as the owner */
-  custodyAddress: string;
+  /** An ethereum address to define as the owner */
+  custodyAddress: `0x${string}`;
   /** A valid url pointing to an image file, it should be a square */
   logo: string;
   /** should be the same as the package version */

packages/core/src/renderer.ts

@@ -161,12 +161,13 @@ export type ModElementRef<T> =
 export type BaseContext = {
   user?: {
     wallet?: {
-      address?: string;
+      address?: `0x${string}`;
     };
     farcaster?: {
       fid?: string;
     };
   };
+  clientReferralAddress?: `0x${string}`;
 };
 
 export type CreationContext = BaseContext & {
@@ -933,13 +934,29 @@ export class Renderer {
       case "SENDETHTRANSACTION": {
         const promise = new Promise<void>((resolve) => {
           setTimeout(() => {
+            /* Populate attribution tags */
+            const zeroAddress = "0000000000000000000000000000000000000000";
+            const modTag =
+              this.manifest.custodyAddress.startsWith("0x") &&
+              this.manifest.custodyAddress.length === 42
+                ? this.manifest.custodyAddress.slice(2)
+                : zeroAddress;
+            const clientTag =
+              this.context.clientReferralAddress?.slice(2) || zeroAddress;
+            let txData = this.replaceInlineContext(action.txData.data || "");
+            // Check if data is hex and contains at least a function signature
+            // 4 hex bytes (8 chars) + '0x' = 10 chars
+            if (txData.startsWith("0x") && txData.length >= 10) {
+              txData = txData + modTag + clientTag;
+            }
+
             this.onSendEthTransactionAction(
               {
                 data: {
                   from: this.replaceInlineContext(action.txData.from),
                   to: this.replaceInlineContext(action.txData.to),
                   value: this.replaceInlineContext(action.txData.value || "0"),
-                  data: this.replaceInlineContext(action.txData.data || ""),
+                  data: txData,
                 },
                 chainId: this.replaceInlineContext(action.chainId),
               },

packages/react/src/index.tsx

@@ -453,8 +453,14 @@ export const CreationMod = (
 
   const input = variant === "creation" ? props.input : "";
   const context = React.useMemo<CreationContext>(
-    () => ({ input, embeds: props.embeds, api: props.api, user: props.user }),
-    [input, props.api, props.embeds, props.user]
+    () => ({
+      input,
+      embeds: props.embeds,
+      api: props.api,
+      user: props.user,
+      clientReferralAddress: props.clientReferralAddress,
+    }),
+    [input, props.api, props.embeds, props.user, props.clientReferralAddress]
   );
 
   const [renderer] = React.useState<Renderer>(
@@ -501,8 +507,13 @@ export const RenderMod = (
   const forceRerender = useForceRerender();
 
   const context = React.useMemo<RichEmbedContext>(
-    () => ({ embed: props.embed, api: props.api, user: props.user }),
-    [props.embed, props.api, props.user]
+    () => ({
+      embed: props.embed,
+      api: props.api,
+      user: props.user,
+      clientReferralAddress: props.clientReferralAddress,
+    }),
+    [props.embed, props.api, props.user, props.clientReferralAddress]
   );
 
   const [renderer] = React.useState<Renderer>(

turbo.json

@@ -39,6 +39,7 @@
     "IMGUR_CLIENT_ID",
     "NEXT_PUBLIC_EXPERIMENTAL_MODS",
     "ZORA_ADMIN_PRIVATE_KEY",
-    "NFT_STORAGE_API_KEY"
+    "NFT_STORAGE_API_KEY",
+    "NEXT_PUBLIC_CLIENT_REFERRAL_ADDRESS"
   ]
 }