feat: mod/client referrals#152

Draft

stephancill wants to merge 4 commits intomain from

feat/mod-client-referrals

Draft

feat: mod/client referrals #152
stephancill wants to merge 4 commits intomain from
feat/mod-client-referrals

Conversation

@stephancill

Copy link

Contributor

@stephancill stephancill commented Jan 25, 2024 •

edited

Loading

Change Summary

Deprecate ENS support in ModManifest's custodyAddress field
Append Mod custody address and client referral address to transactions created via Mod to allow for fee revenue sharing

Todo: Indexer and claiming site

Merge Checklist

PR has a changeset
PR includes documentation if necessary
PR updates the rich-embed examples if necessary
includes a parallel PR for Mod-starter and the gateway if necessary

stephancill added 2 commits

January 25, 2024 17:00

@stephancill


 fix(core): deprecate ENS support in ModManifest custodyAddress field

635c729

@stephancill


 feat(core+react): client and mod attribution in transactions

076831c

@changeset-bot

Copy link

changeset-bot bot commented Jan 25, 2024 •

edited

Loading

🦋 Changeset detected

Latest commit: 12a98ba

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 18 packages

Name	Type
@mod-protocol/react	Minor
@mod-protocol/core	Minor
@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
web	Patch
@mod-protocol/react-ui-shadcn	Patch
api	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel

Copy link

vercel bot commented Jan 25, 2024 •

edited

Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
api	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 29, 2024 8:40am
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 29, 2024 8:40am
example-nextjs-shadcn	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 29, 2024 8:40am

@vercel vercel bot deployed to Preview – docs

January 25, 2024 15:04

View deployment

@vercel vercel bot deployed to Preview – api

January 25, 2024 15:05

View deployment

@stephancill stephancill mentioned this pull request

Jan 26, 2024

mod: erc-20 #147

Open

12 tasks

@stephancill


 fix(examples/nextjs-shadcn): add clientReferralAddress

d9c5431

@stephancill stephancill requested a review from davidfurlong

January 26, 2024 14:34

@vercel vercel bot deployed to Preview – api

January 26, 2024 14:34

View deployment

@vercel vercel bot deployed to Preview – example-nextjs-shadcn

January 26, 2024 14:36

View deployment

@vercel vercel bot deployed to Preview – docs

January 26, 2024 14:38

View deployment

davidfurlong

davidfurlong requested changes

Jan 26, 2024

View reviewed changes

Copy link

Contributor

@davidfurlong davidfurlong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

almost there! We should probably also redeploy the example with the new env variable as well

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

input={getText()}

embeds={getEmbeds()}

api={API_URL}

clientReferralAddress={CLIENT_REFERRAL_ADDRESS}

Copy link

Contributor

@davidfurlong davidfurlong Jan 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs to be changed in the docs as well

packages/core/src/renderer.ts

fid?: string;

};

clientReferralAddress?: `0x${string}`;

Copy link

Contributor

@davidfurlong davidfurlong Jan 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have a comment above describing it further; on which chain? EOA required?

I think we should also call it appEthRewardsAddress or something instead

Copy link

Contributor Author

@stephancill stephancill Jan 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will add a comment. I'm not too attached to the name, but I do prefer referring to the party implementing Mod as the client since app could be ambiguous

packages/core/src/renderer.ts Outdated

setTimeout(() => {

/* Populate attribution tags */

const zeroAddress = "0000000000000000000000000000000000000000";

const modTag = this.manifest.custodyAddress.startsWith("0x")

Copy link

Contributor

@davidfurlong davidfurlong Jan 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should probably check that this custodyAddress is valid in other ways, such as the length or characters. I have no idea what happens if you overflow the end of txData here but I don't want to find out

@stephancill


 fix(core): check if mod tag is the correct length

12a98ba

@vercel vercel bot deployed to Preview – docs

January 29, 2024 08:38

View deployment

@vercel vercel bot deployed to Preview – api

January 29, 2024 08:39

View deployment

@vercel vercel bot deployed to Preview – example-nextjs-shadcn

January 29, 2024 08:40

View deployment

Labels

None yet

2 participants

@stephancill @davidfurlong

Conversation

@stephancill stephancill commented Jan 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Summary

Merge Checklist

Uh oh!

changeset-bot bot commented Jan 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Jan 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

@davidfurlong davidfurlong left a comment

Choose a reason for hiding this comment

Uh oh!

@davidfurlong davidfurlong Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

@davidfurlong davidfurlong Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

@stephancill stephancill Jan 29, 2024

Choose a reason for hiding this comment

Uh oh!

@davidfurlong davidfurlong Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

@stephancill stephancill commented Jan 25, 2024 •

edited

Loading

changeset-bot bot commented Jan 25, 2024 •

edited

Loading

vercel bot commented Jan 25, 2024 •

edited

Loading