docsFunctionsEncryptionencrypt

encrypt

Encrypts data.

Signature

async function encrypt(
  dataIn: Uint8Array,
  walletClient: Client<Transport, Chain, Account>,
  metadataIn: DataMetadata,
  authorization: any,
  config: EncryptConfig,
  debug?: boolean
): Promise<EncryptionResult>

Description

The encrypt function encrypts the provided data using Keypo with EIP-7702 smart accounts. It requires a viem wallet client and authorization signature for the encryption process. The function encrypts the data and stores it on IPFS, returning identifiers needed for subsequent decryption and access management. The function caller is initially the only user who can decrypt the data, but they can update access after encryption.

Important: This function uses EIP-7702 smart accounts powered by ZeroDev to make the experience gassless to the end user, which requires an authorization signature. This will not work with injected wallet providers like MetaMask, but is compatible with local wallets where the private key is available or with embedded wallets such as Privy, Dynamic, and Turnkey.

Parameters

ParameterTypeRequiredDescription
dataInUint8ArrayYesThe data to be encrypted as a Uint8 byte array (typically generated using preProcess).
walletClientClient<Transport, Chain, Account>YesThe viem wallet client with the account used for the encryption process.
metadataInDataMetadataYesMetadata object associated with the data (typically generated using preProcess).
authorizationanyYesThe EIP-7702 authorization signature. See signAuthorization for details.
configEncryptConfigYesConfiguration object containing API endpoints, contract addresses, and RPC endpoints.
debugbooleanNoWhen set to true, enables debug statements during encryption. Default is false.

EncryptConfig Structure

Note: use init to automatically load the config.

{
  apiUrl: string,                           // API endpoint for encryption service
  validatorAddress: string,                 // Address of the validator contract
  registryContractAddress: string,          // Address of the registry contract
  bundlerRpcUrl: string                     // RPC URL for the bundler (recommended: ZeroDev, but works with any account abstraction bundler/paymaster like biconomy, alchemy, etc)
}

Returns

Promise<EncryptionResult> - A Promise that resolves to an object with the following properties:

PropertyTypeDescription
dataCIDstringIPFS Content Identifier (CID) of the encrypted data.
dataIdentifierstringUnique identifier for the encrypted data.

Examples

Basic Usage

// import relevant libraries
import { init, encrypt } from "@keypo/typescript-sdk";
import { http, createWalletClient } from "viem"
import { privateKeyToAccount } from "viem/accounts"
import { baseSepolia } from "viem/chains"
 
// load config
const config = await init("https://api.keypo.io");
 
// Create wallet client
const account = privateKeyToAccount('0x...');
const walletClient = createWalletClient({
  account,
  chain: baseSepolia,
  transport: http()
});
 
// Get authorization signature (needed for wallet to use smart account features)
const authorization = await walletClient.signAuthorization({
    contractAddress: config.kernelAddress as `0x${string}`, // Kernel V3.3 implementation address
});
 
// Prepare data for encryption
const { dataOut, metadataOut } = keypo.preProcess(data, 'my-encrypted-data');
 
// Encrypt data
const result = await keypo.encrypt(
  dataOut,
  walletClient,
  metadataOut,
  authorization,
  config.encryptConfig
);
 
console.log('Data encrypted successfully:', result.dataIdentifier);

With Embedded Wallets

Keypo works with the following embedded wallets: Privy, Dynamic and Turnkey.

You need to pass the embedded wallet as Viem wallet client to the delete function in order for it to work properly. Please consult the embedded wallet’s documentation on guidelines for how to do that.

Authorization Requirements

This function requires an EIP-7702 authorization signature. The authorization must be signed by the account that has permission to delete the data.

Getting Authorization Signatures

With Known Private Keys

const authorization = await walletClient.signAuthorization({
    contractAddress: config.kernelAddress as `0x${string}`, // Kernel V3.3 implementation address
});

With Embedded Wallets

For Privy, Dynamic, and Turnkey integrations, consult the ZeroDev 7702 documentation for wallet-specific implementation details.

Notes

  • Initially, the encrypted data can only be decrypted by the wallet that encrypted it.
  • To share access to the data with others, use the share function.
  • The encryption operation is performed on-chain using EIP-7702 smart accounts and is gassless.
  • Debug mode will log transaction details and receipts for troubleshooting.

See Also

postProcessencryptForProxy