Merge pull request #118 from storyprotocol/fix/add-off-chain-data-to-…

…license-terms fix: Update `licenseTermsData` to Include Off-Chain Data
storyprotocol · Jan 31, 2025 · 10ce536 · 10ce536
2 parents f533a3f + 0f0e8d1
commit 10ce536
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 3 deletions.
diff --git a/packages/storykit/package.json b/packages/storykit/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@storyprotocol/storykit",
   "author": "storyprotocol engineering <[email protected]>",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "type": "module",
   "exports": {
     ".": {

diff --git a/packages/storykit/src/lib/api.ts b/packages/storykit/src/lib/api.ts
@@ -64,6 +64,5 @@ export async function listResource<T>(
 
 export async function getMetadataFromIpfs(ipfsUrl: string) {
   const metadata = await fetch(ipfsUrl).then((res) => res.json())
-  console.log("@@ metadata", metadata)
   return metadata
 }
diff --git a/packages/storykit/src/providers/IpProvider/IpProvider.tsx b/packages/storykit/src/providers/IpProvider/IpProvider.tsx
@@ -8,6 +8,7 @@ import { Address, Hash } from "viem"
 
 import { getMetadataFromIpfs, getResource, listResource } from "../../lib/api"
 import { getNFTByTokenId } from "../../lib/simplehash"
+import { convertIpfsUriToUrl } from "../../lib/utils"
 import { RESOURCE_TYPE } from "../../types/api"
 import {
   Asset,
@@ -245,14 +246,39 @@ export const IpProvider = ({
     )
     const results = await Promise.all(requests)
 
-    return results
+    const termsDetail = results
       .filter((value) => !!value)
       .map((result) => {
         return {
           ...result.data,
           licenseTerms: convertLicenseTermObject(result.data.licenseTerms),
         }
       })
+
+    const offChainUri = termsDetail.map((detail) => detail.terms.uri)
+    const offChainData = await Promise.all(
+      offChainUri.map(async (uri) => {
+        try {
+          if (uri === "") {
+            return
+          }
+          const ipfsData = await getMetadataFromIpfs(convertIpfsUriToUrl(uri))
+          return ipfsData
+        } catch (error) {
+          return
+        }
+      })
+    )
+
+    return termsDetail.map((termDetail, index) => {
+      return {
+        ...termDetail,
+        terms: {
+          ...termDetail.terms,
+          offChainData: offChainData[index],
+        },
+      }
+    })
   }
 
   const {

diff --git a/packages/storykit/src/types/assets.ts b/packages/storykit/src/types/assets.ts
@@ -80,7 +80,9 @@ export type PILTerms = {
   derivativesReciprocal: boolean
   derivativesRevenueCelling: number
   expiration: string
+  // @deprecated, use uri instead
   uRI: string
+  uri?: string
 }
 
 export type IPLicenseTerms = {
@@ -109,13 +111,18 @@ export interface Trait {
   max_value?: number
 }
 
+export interface LicenseOffChainData {
+  aiLearningModels?: boolean
+}
+export type PILTermsWithOffChainData = PILTerms & LicenseOffChainData
 export type LicenseTerms = {
   id: string
   // json: string
   licenseTerms: Trait[]
   licenseTemplate: Address
   blockNumber: string
   blockTime: string
+  terms: PILTermsWithOffChainData
 }
 
 export type LicenseToken = {