Class Gated

Decrypts a Publication Metadata fragment returned by the Lens API.

⚠️ Requires authenticated LensClient.

The fragment MUST be encrypted. Use the isEncryptedPublicationMetadata type guard to check if the fragment is encrypted.

Example

Typical usage:

1. fetch a publication via a LensClient method,
2. determine if the publication metadata is encrypted,
3. decrypt the metadata fragment,

const post = await client.publication.fetch({ forId: '...' });

if (isEncryptedPublicationMetadata(post.metadata)) {
  const result = await client.gated.decryptPublicationMetadataFragment(post.metadata);

  if (result.isSuccess()) {
    console.log(result.value);
  }
}
Copy

Encrypts Publication Metadata with the given access condition.

⚠️ Requires authenticated LensClient.

Example

Typical usage:

1. create metadata,
2. encrypt it,
3. upload it to a public location (e.g. IPFS, Arweave),
4. use the resulting contentURI to create a Lens publication.

// create publication metadata via '@lens-protocol/metadata' helpers
const metadata = article({ content: '...' });

// encrypt the metadata specifying the access condition
const result = await client.gated.encryptPublicationMetadata(
  metadata,
  eoaOwnershipCondition({
    address: signer.address,
  }),
);
const encrypted = result.unwrap();

// upload the encrypted metadata your storage of choice
const contentURI = await uploadToIPFS(encrypted);

// use the contentURI to create a publication
Copy

Example

Multiple criteria can be combined using the orCondition and andCondition helpers.

const result = await client.gated.encryptPublicationMetadata(
  metadata,
  orCondition([
    profileOwnershipCondition({
      profileId: profile.id,
    }),
    eoaOwnershipCondition({
      address: signer.address,
    }),
  ])
);
Copy

Supported criteria:

• collectCondition - the collection of a given publication is required
• eoaOwnershipCondition - the ownership of a given EOA is required
• erc20OwnershipCondition - the ownership of a given ERC20 amount is required
• erc721OwnershipCondition - the ownership of a given ERC721 token is required
• erc1155OwnershipCondition - the ownership of a given ERC1155 token is required
• profileOwnershipCondition - the ownership of a given profile is required
• followCondition - following a given profile is required
• andCondition - up to 5 conditions can be combined using the AND operator (except orCondition and andCondition)
• orCondition - up to 5 conditions can be combined using the OR operator (except orCondition and andCondition)

See

Metadata helpers for more information on how to create publication metadata and access conditions.