feat: IPFS-based video support #16

stephancill · 2023-10-16T14:35:17Z

Adds support for videos on IPFS via the livepeer-video and video-render Mods.

Uploading is done via the Infura IPFS API, which also pins the file.

When a video on IPFS is detected, the video-render mod tries to load the video directly via the IPFS gateway, but also makes a request to the /livepeer-video endpoint to upload and transcode the video to the livepeer servers via IPFS. This endpoint returns the livepeer asset ID which is then used to poll the /livepeer-video/<asset-id> endpoint to see if the streaming URL is ready. Once it is ready, it switches out the IPFS gateway video source for the HLS stream via Livepeer for a more performant streaming experience.

This PR introduces a few changes to mod packages to make this possible

Retryable HTTP requests via retryTimeout and retryCount available in the ModManifest type
Provide a mimeType alongside videoSrc for the video component
replaceInlineContext commands syntax + tests: split (splits a string) index selects an item at the specified index in an array e.g.

it("applies split and index operations to extract part of a string", () => {
    const context = { refs: { example: { url: "ipfs://exampleCID" } } };
    const template = "{{refs.example.url | split ipfs:// | index 1}}";
    expect(replaceInlineContext(template, context)).toBe("exampleCID");
  });

Todo:

Automatically request streaming url on load (blocking: onload is called excessively)
Confirm that livepeer uploads are being cached

changeset-bot · 2023-10-16T14:35:21Z

🦋 Changeset detected

Latest commit: 38d9420

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

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 · 2023-10-16T14:35:26Z

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 17, 2024 10:43am
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 17, 2024 10:43am
example-nextjs-shadcn	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 17, 2024 10:43am

davidfurlong

almost there

packages/react-ui-shadcn/src/renderers/video.tsx

davidfurlong · 2023-10-17T11:17:30Z

packages/react-ui-shadcn/src/renderers/video.tsx

+  const [hasStartedPlaying, setHasStartedPlaying] =
+    React.useState<boolean>(false);
+
+  const pollUrl = useCallback(


nice addition

davidfurlong · 2023-10-17T11:21:23Z

examples/api/src/app/api/open-graph/lib/url-handlers/ipfs.ts

+    return null;
+  }
+
+  // TODO: Generate thumbnail if image/video


would be nice to include this

davidfurlong · 2023-10-17T11:22:33Z

examples/api/src/app/api/livepeer-video/route.ts

-    return NextResponse.json(
-      {
-        message: "Took too long to upload. Try a smaller file",
+  // TODO: Cache this


I think livepeer automatically caches this - if you request via an IPFS cid it doesn't re-upload if it's been uploaded to livepeer previously. Worth confirming we're doing it correctly to get this benefit.

Just noticing that their API is returning a different playbackId for each request. Can we check with them?

could it be this:

For IPFS HTTP gateway URLs, the API currently only supports “path style” URLs and does not support “subdomain style” URLs. The API will support both styles of URLs in a future update.

https://docs.livepeer.org/reference/api#upload-an-asset

I think the IPFS url uses our subdomain gateway as it stands

(I haven't asked them yet)

try upload to web3.storage instead of infura for our gateway

davidfurlong · 2023-12-11T09:26:44Z

examples/api/src/app/api/livepeer-video/route.ts

-    }
+  // Exchange for livepeer url
+  const cid = url.replace("ipfs://", "");
+  const gatewayUrl = `${process.env.IPFS_DEFAULT_GATEWAY}/${cid}`;


try: I think this needs to be "https://w3s.link/ipfs/${cid}" https://github.com/livepeer/livepeer-react/blob/main/packages/core-react/src/components/media/player/useSourceMimeTyped.tsx

Tried it, still no caching

ok will try emailing them again

@stephancill can you try ipfs://{CID}?

Interesting - it uploads fine without specifying a gateway, but still no caching (returns a different asset id each time it uploads)

vercel bot deployed to Preview – example-nextjs-shadcn October 16, 2023 14:37 View deployment

vercel bot had a problem deploying to Preview – api October 16, 2023 14:39 Failure

stephancill force-pushed the feat/ipfs-videos branch from f80a9d4 to 0d85d8e Compare October 16, 2023 14:54

vercel bot deployed to Preview – api October 16, 2023 14:57 View deployment

vercel bot deployed to Preview – example-nextjs-shadcn October 16, 2023 14:59 View deployment

vercel bot deployed to Preview – docs October 16, 2023 15:01 View deployment

davidfurlong requested changes Oct 17, 2023

View reviewed changes

stephancill mentioned this pull request Oct 23, 2023

fix(image-render): match image embeds based on file extension in url #29

Merged

vercel bot had a problem deploying to Preview – example-nextjs-shadcn October 24, 2023 15:03 Failure

vercel bot deployed to Preview – api October 24, 2023 15:05 View deployment

vercel bot deployed to Preview – docs October 24, 2023 15:08 View deployment

stephancill force-pushed the feat/ipfs-videos branch from fa6bc2a to 52dbe8f Compare October 24, 2023 15:15

vercel bot deployed to Preview – docs October 24, 2023 15:17 View deployment

vercel bot deployed to Preview – api October 24, 2023 15:18 View deployment

vercel bot deployed to Preview – example-nextjs-shadcn October 24, 2023 15:21 View deployment

stephancill force-pushed the feat/ipfs-videos branch from 52dbe8f to a9f4247 Compare December 7, 2023 08:44

vercel bot had a problem deploying to Preview – api December 7, 2023 08:45 Failure

vercel bot deployed to Preview – example-nextjs-shadcn December 7, 2023 08:46 View deployment

vercel bot deployed to Preview – docs December 7, 2023 08:46 View deployment

vercel bot deployed to Preview – docs December 8, 2023 11:20 View deployment

vercel bot deployed to Preview – example-nextjs-shadcn December 8, 2023 11:20 View deployment

vercel bot had a problem deploying to Preview – api December 8, 2023 11:22 Failure

stephancill force-pushed the feat/ipfs-videos branch from 92bc21d to 4e8c95f Compare December 8, 2023 13:41

vercel bot deployed to Preview – example-nextjs-shadcn December 8, 2023 13:42 View deployment

vercel bot deployed to Preview – docs December 8, 2023 13:42 View deployment

vercel bot deployed to Preview – api December 8, 2023 13:44 View deployment

stephancill force-pushed the feat/ipfs-videos branch from 4e8c95f to 2071ec1 Compare December 8, 2023 13:55

vercel bot deployed to Preview – docs December 8, 2023 13:55 View deployment

vercel bot deployed to Preview – api December 8, 2023 13:55 View deployment

vercel bot deployed to Preview – example-nextjs-shadcn December 8, 2023 13:56 View deployment

stephancill added the mod label Dec 11, 2023

davidfurlong reviewed Dec 11, 2023

View reviewed changes

vercel bot deployed to Preview – api December 12, 2023 14:36 View deployment

vercel bot deployed to Preview – example-nextjs-shadcn December 12, 2023 14:37 View deployment

vercel bot deployed to Preview – docs December 12, 2023 14:38 View deployment

stephancill added 5 commits January 17, 2024 12:33

feat: handle videos linked via IPFS

87b11d6

fix: yarn.lock

f626dfd

feat: replaceInlineContext commands: split, index

6b6d9f4

chore: refactor ipfs video player into mod

ed0f0d0

fix: pass raw ipfs cid to livepeer api

38d9420

stephancill force-pushed the feat/ipfs-videos branch from c632f93 to 38d9420 Compare January 17, 2024 10:35

vercel bot deployed to Preview – example-nextjs-shadcn January 17, 2024 10:38 View deployment

vercel bot deployed to Preview – api January 17, 2024 10:41 View deployment

vercel bot deployed to Preview – docs January 17, 2024 10:43 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: IPFS-based video support #16

feat: IPFS-based video support #16

stephancill commented Oct 16, 2023 •

edited

Loading

changeset-bot bot commented Oct 16, 2023 •

edited

Loading

vercel bot commented Oct 16, 2023 •

edited

Loading

davidfurlong left a comment

davidfurlong Oct 17, 2023 •

edited

Loading

davidfurlong Oct 17, 2023

davidfurlong Oct 17, 2023

stephancill Oct 20, 2023

davidfurlong Oct 20, 2023

davidfurlong Oct 20, 2023 •

edited

Loading

davidfurlong Oct 20, 2023

davidfurlong Dec 11, 2023

davidfurlong Dec 11, 2023

stephancill Dec 12, 2023

davidfurlong Dec 12, 2023

davidfurlong Dec 12, 2023

stephancill Dec 12, 2023

feat: IPFS-based video support #16

Are you sure you want to change the base?

feat: IPFS-based video support #16

Conversation

stephancill commented Oct 16, 2023 • edited Loading

changeset-bot bot commented Oct 16, 2023 • edited Loading

🦋 Changeset detected

vercel bot commented Oct 16, 2023 • edited Loading

davidfurlong left a comment

Choose a reason for hiding this comment

davidfurlong Oct 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidfurlong Oct 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stephancill commented Oct 16, 2023 •

edited

Loading

changeset-bot bot commented Oct 16, 2023 •

edited

Loading

vercel bot commented Oct 16, 2023 •

edited

Loading

davidfurlong Oct 17, 2023 •

edited

Loading

davidfurlong Oct 20, 2023 •

edited

Loading