feat: token-gated support for Publication Metadata v3 and Lens API v2

.changeset/funny-radios-clap.md

@@ -0,0 +1,6 @@
+---
+"@lens-protocol/client": minor
+"@lens-protocol/gated-content": patch
+---
+
+**feat:** token-gated support for LIP-2 metadata spec

.vscode/settings.json

@@ -15,7 +15,6 @@
     "packages/prettier-config",
     "packages/react-web",
     "packages/react",
-    "packages/sdk-gated",
     "packages/shared-kernel",
     "packages/storage",
     "packages/tsconfig",

examples/node/package.json

@@ -19,7 +19,7 @@
   "dependencies": {
     "@bundlr-network/client": "^0.11.9",
     "@lens-protocol/client": "workspace:*",
-    "@lens-protocol/metadata": "0.1.0-alpha.25",
+    "@lens-protocol/metadata": "0.1.0-alpha.29",
     "dotenv": "^16.0.3",
     "ethers": "^5.7.2",
     "uuid": "^9.0.0",
@@ -33,7 +33,7 @@
     "@types/uuid": "^9.0.0",
     "prettier": "^2.8.4",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "typescript": "^4.9.5"
   },
   "prettier": "@lens-protocol/prettier-config"
 }

examples/node/scripts/authenticate.ts

@@ -28,8 +28,7 @@ async function main() {
   const accessTokenResult = await client.authentication.getAccessToken();
   const accessToken = accessTokenResult.unwrap();
 
-  const profileIdResult = await client.authentication.getProfileId();
-  const profileId = profileIdResult.unwrap();
+  const profileId = await client.authentication.getProfileId();
 
   console.log(`Is LensClient authenticated? `, await client.authentication.isAuthenticated());
   console.log(`Authenticated profileId: `, profileId);

examples/node/scripts/follow/createFollowTypedData.ts

@@ -36,7 +36,8 @@ async function main() {
   }
 
   console.log(
-    `Transaction to follow was successfully broadcasted with txId ${followBroadcastResultValue.txId}`,
+    `Transaction to follow was successfully broadcasted with txId`,
+    followBroadcastResultValue.txId,
   );
 
   // wait for follow to be indexed

examples/node/scripts/follow/createSetFollowModuleTypedData.ts

@@ -61,7 +61,8 @@ async function main() {
   }
 
   console.log(
-    `Profile follow module sucessfully set and successfully broadcasted with txId ${followBroadcastResultValue.txId}`,
+    `Profile follow module successfully set and successfully broadcasted with txId`,
+    followBroadcastResultValue.txId,
   );
 
   // wait for follow to be indexed

examples/node/scripts/follow/createUnfollowTypedData.ts

@@ -36,7 +36,8 @@ async function main() {
   }
 
   console.log(
-    `Transaction to follow ${profileToUnfollowId} was successfully broadcasted with txId ${followBroadcastResultValue.txId}`,
+    `Transaction to follow ${profileToUnfollowId} was successfully broadcasted with txId`,
+    followBroadcastResultValue.txId,
   );
 
   // wait for follow to be indexed
@@ -49,9 +50,9 @@ async function main() {
   });
 
   console.log(`Just followed profile`, {
-    id: justFollowedProfile.id,
-    handle: justFollowedProfile.handle,
-    isFollowedByMe: justFollowedProfile.operations.isFollowedByMe,
+    id: justFollowedProfile?.id,
+    handle: justFollowedProfile?.handle,
+    isFollowedByMe: justFollowedProfile?.operations.isFollowedByMe,
   });
 }
 

examples/node/scripts/misc/pagination.ts

@@ -30,14 +30,17 @@ async function main() {
     console.log(`Fetching page for cursor: ${pagination.pageInfo.next}`);
 
     const nextPage = await pagination.next();
-    publications.push(...nextPage.items);
-
-    console.log(
-      `Next page:`,
-      nextPage.items.map((i) => ({
-        id: i.id,
-      })),
-    );
+
+    if (nextPage) {
+      publications.push(...nextPage.items);
+
+      console.log(
+        `Next page:`,
+        nextPage.items.map((i) => ({
+          id: i.id,
+        })),
+      );
+    }
   }
 
   console.log(

examples/node/scripts/profile/create.ts

@@ -24,7 +24,8 @@ async function main() {
   }
 
   console.log(
-    `Transaction to create a new profile with handle "${handle}" was successfully broadcasted with txId ${profileCreateResult.txId}`,
+    `Transaction to create a new profile with handle "${handle}" was successfully broadcasted with txId`,
+    profileCreateResult.txId,
   );
 
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/profile/createBlockProfilesTypedData.ts

@@ -33,7 +33,7 @@ async function main() {
 
   await client.transaction.waitUntilComplete({ forTxId: broadcastResultValue.txId });
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastResultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastResultValue.txId);
 }
 
 main();

examples/node/scripts/profile/createChangeProfileManagersTypedData.ts

@@ -7,8 +7,7 @@ async function main() {
   const wallet = setupWallet();
   const client = await getAuthenticatedClientFromEthersWallet(wallet);
 
-  const profileIdResult = await client.authentication.getProfileId();
-  const profileId = profileIdResult.unwrap();
+  const profileId = await client.authentication.getProfileId();
 
   const typedDataResult = await client.profile.createChangeProfileManagersTypedData({
     approveLensManager: true,
@@ -43,7 +42,7 @@ async function main() {
   }
 
   console.log(
-    `Successfully changed profile manager for profile ${profileId} with: `,
+    `Successfully changed profile manager for profile ${String(profileId)} with: `,
     onchainRelayResult,
   );
 }

examples/node/scripts/profile/createLinkHandleTypedData.ts

@@ -33,7 +33,7 @@ async function main() {
 
   await client.transaction.waitUntilComplete({ forTxId: broadcastResultValue.txId });
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastResultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastResultValue.txId);
 }
 
 main();

examples/node/scripts/profile/createSetProfileMetadataTypedData.ts

@@ -38,7 +38,7 @@ async function main() {
   // or wait till transaction is indexed
   await client.transaction.waitUntilComplete({ forTxId: broadcastResultValue.txId });
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastResultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastResultValue.txId);
 }
 
 main();

examples/node/scripts/profile/createUnblockProfilesTypedData.ts

@@ -33,7 +33,7 @@ async function main() {
 
   await client.transaction.waitUntilComplete({ forTxId: broadcastResultValue.txId });
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastResultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastResultValue.txId);
 }
 
 main();

examples/node/scripts/profile/createUnlinkHandleTypedData.ts

@@ -33,7 +33,7 @@ async function main() {
 
   await client.transaction.waitUntilComplete({ forTxId: broadcastResultValue.txId });
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastResultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastResultValue.txId);
 }
 
 main();

examples/node/scripts/profile/fetch.ts

@@ -10,16 +10,16 @@ async function main() {
     forProfileId: '0x01',
   });
 
-  console.log(`Profile fetched by id: `, { id: profileById.id, handle: profileById.handle });
+  console.log(`Profile fetched by id: `, { id: profileById?.id, handle: profileById?.handle });
 
   // by handle
   const profileByHandle = await client.profile.fetch({
     forHandle: 'test/@firstprofile',
   });
 
   console.log(`Profile fetched by handle: `, {
-    id: profileByHandle.id,
-    handle: profileByHandle.handle,
+    id: profileByHandle?.id,
+    handle: profileByHandle?.handle,
   });
 }
 

examples/node/scripts/profile/interests.ts

@@ -15,11 +15,11 @@ async function main() {
   });
 
   // fetch all interests
-  const { interests } = await client.profile.fetch({
+  const profile = await client.profile.fetch({
     forProfileId: profileId,
   });
 
-  console.log(`Profile interests`, interests);
+  console.log(`Profile interests`, profile?.interests);
 
   // remove interests
   await client.profile.removeInterests({

examples/node/scripts/profile/recipes/checkIfProfileManagerIsEnabled.ts

@@ -11,7 +11,7 @@ async function main() {
     forProfileId: profileId,
   });
 
-  if (profile.lensManager) {
+  if (profile?.lensManager) {
     console.log('Profile manager is enabled');
   } else {
     console.log('Profile manager is disabled');

examples/node/scripts/profile/stats.ts

@@ -29,9 +29,9 @@ async function main() {
   );
 
   console.log(`Result: `, {
-    id: result.id,
-    handle: result.handle,
-    stats: result.stats,
+    id: result?.id,
+    handle: result?.handle,
+    stats: result?.stats,
   });
 }
 

examples/node/scripts/publication/actions/actOn.ts

@@ -21,7 +21,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${resultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, resultValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/actions/createActOnTypedData.ts

@@ -39,7 +39,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/commentOnchain.ts

@@ -19,7 +19,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${resultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, resultValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/createLegacyCollectTypedData.ts

@@ -36,7 +36,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/createOnchainCommentTypedData.ts

@@ -37,7 +37,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/createOnchainMirrorTypedData.ts

@@ -36,7 +36,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/createOnchainPostTypedData.ts

@@ -38,7 +38,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/createOnchainQuoteTypedData.ts

@@ -37,7 +37,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${broadcastValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, broadcastValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/legacyCollect.ts

@@ -18,7 +18,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${resultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, resultValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/mirrorOnchain.ts

@@ -18,7 +18,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${resultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, resultValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/postOnchain.ts

@@ -20,7 +20,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${resultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, resultValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/quoteOnchain.ts

@@ -19,7 +19,7 @@ async function main() {
     return;
   }
 
-  console.log(`Transaction was successfully broadcasted with txId ${resultValue.txId}`);
+  console.log(`Transaction was successfully broadcasted with txId`, resultValue.txId);
 
   // wait in a loop
   console.log(`Waiting for the transaction to be indexed...`);

examples/node/scripts/publication/stats.ts

@@ -9,11 +9,11 @@ async function main() {
     forId: '0x04-0x0b',
   });
 
-  if (isMirrorPublication(result)) {
+  if (result && isMirrorPublication(result)) {
     throw new Error(`Stats are not available for mirrors`);
   }
 
-  console.log(`Stats for the publication: `, result.stats);
+  console.log(`Stats for the publication: `, result?.stats);
 }
 
 main();

examples/node/scripts/publication/validateMetadata.ts

@@ -12,7 +12,7 @@ async function main() {
   });
 
   if (!result.valid) {
-    throw new Error(`Metadata is not valid because of ${result.reason}`);
+    throw new Error(`Metadata is not valid because of ${String(result.reason)}`);
   }
 
   console.log(`Result: `, result);

examples/node/scripts/shared/getAuthenticatedClient.ts

@@ -1,5 +1,5 @@
 import { LensClient, development } from '@lens-protocol/client';
-import { Wallet } from 'ethers';
+import { Wallet, constants } from 'ethers';
 import { WalletClient } from 'viem';
 
 import { getOwnedProfileId } from './getOwnedProfileId';
@@ -26,7 +26,7 @@ export async function getAuthenticatedClientFromViemWalletClient(walletClient: W
   const client = new LensClient({
     environment: development,
   });
-  const address = walletClient.account.address;
+  const address = walletClient.account?.address ?? constants.AddressZero;
   const profileId = await getOwnedProfileId(client, address);
 
   const { id, text } = await client.authentication.generateChallenge({

examples/node/scripts/shared/uploadWithBundlr.ts

@@ -10,7 +10,9 @@ export async function uploadWithBundlr(data: { [key: string]: unknown }): Promis
   const atomicBalance = await bundlr.getLoadedBalance();
   const balance = bundlr.utils.fromAtomic(atomicBalance);
 
-  console.log(`Bundlr balance for wallet ${bundlr.address} is ${balance.toString()} MUMBAI MATIC`);
+  console.log(
+    `Bundlr balance for wallet ${String(bundlr.address)} is ${balance.toString()} MUMBAI MATIC`,
+  );
 
   // fund bundlr balance if empty
   if (balance.eq(0)) {