Class DataController

Example

// Basic file upload
const result = await vana.data.upload({
  content: "My personal data",
  filename: "diary.txt"
});

// Upload with schema validation
const result = await vana.data.upload({
  content: { name: "John", age: 30 },
  filename: "profile.json",
  schemaId: 1
});

// Upload with permissions (encrypted - requires publicKey)
const result = await vana.data.upload({
  content: "Data for AI analysis",
  filename: "analysis.txt",
  permissions: [{
    grantee: "0x1234...",
    operation: "llm_inference",
    parameters: { model: "gpt-4" },
    publicKey: "0x04..." // Required when encrypt is true (default)
  }]
});

// Upload without encryption
const result = await vana.data.upload({
  content: "Public data",
  filename: "public.txt",
  encrypt: false,
  permissions: [{
    grantee: "0x1234...",
    operation: "read",
    parameters: {}
  }]
});
Copy

Example

// Basic file upload
const result = await vana.data.upload({
  content: "My personal data",
  filename: "diary.txt"
});

// Upload with schema validation
const result = await vana.data.upload({
  content: { name: "John", age: 30 },
  filename: "profile.json",
  schemaId: 1
});

// Upload with permissions (encrypted - requires publicKey)
const result = await vana.data.upload({
  content: "Data for AI analysis",
  filename: "analysis.txt",
  permissions: [{
    grantee: "0x1234...",
    operation: "llm_inference",
    parameters: { model: "gpt-4" },
    publicKey: "0x04..." // Required when encrypt is true (default)
  }]
});

// Upload without encryption
const result = await vana.data.upload({
  content: "Public data",
  filename: "public.txt",
  encrypt: false,
  permissions: [{
    grantee: "0x1234...",
    operation: "read",
    parameters: {}
  }]
});
Copy

Example

// Basic file upload
const result = await vana.data.upload({
  content: "My personal data",
  filename: "diary.txt"
});

// Upload with schema validation
const result = await vana.data.upload({
  content: { name: "John", age: 30 },
  filename: "profile.json",
  schemaId: 1
});

// Upload with permissions (encrypted - requires publicKey)
const result = await vana.data.upload({
  content: "Data for AI analysis",
  filename: "analysis.txt",
  permissions: [{
    grantee: "0x1234...",
    operation: "llm_inference",
    parameters: { model: "gpt-4" },
    publicKey: "0x04..." // Required when encrypt is true (default)
  }]
});

// Upload without encryption
const result = await vana.data.upload({
  content: "Public data",
  filename: "public.txt",
  encrypt: false,
  permissions: [{
    grantee: "0x1234...",
    operation: "read",
    parameters: {}
  }]
});
Copy

Example

// Basic file decryption
const files = await vana.data.getUserFiles({ owner: userAddress });
const decryptedBlob = await vana.data.decryptFile(files[0]);

// Convert to text
const text = await decryptedBlob.text();
console.log('Decrypted content:', text);

// Convert to JSON
const json = JSON.parse(await decryptedBlob.text());
console.log('Decrypted data:', json);

// With custom encryption seed
const decryptedBlob = await vana.data.decryptFile(
  files[0],
  "My custom encryption seed"
);

// Save to file (in Node.js)
const buffer = await decryptedBlob.arrayBuffer();
fs.writeFileSync('decrypted-file.txt', Buffer.from(buffer));
Copy

Example

// Query files for a specific user
const files = await vana.data.getUserFiles({
  owner: "0x742d35Cc6558Fd4D9e9E0E888F0462ef6919Bd36",
});

files.forEach(file => {
  console.log(`File ${file.id}: ${file.url} (Schema: ${file.schemaId})`);
});
Copy

Example

// Use subgraph for fast queries
const result = await vana.data.getUserTrustedServers({
  user: '0x...',
  mode: 'subgraph',
  subgraphUrl: 'https://...'
});

// Use direct RPC (no external dependencies)
const result = await vana.data.getUserTrustedServers({
  user: '0x...',
  mode: 'rpc',
  limit: 10
});

// Auto-fallback mode
const result = await vana.data.getUserTrustedServers({
  user: '0x...',
  mode: 'auto' // tries subgraph first, falls back to RPC
});
Copy

Example

const totalFiles = await vana.data.getTotalFilesCount();
console.log(`Total files in registry: ${totalFiles}`);

// Use for pagination calculations
const filesPerPage = 20;
const totalPages = Math.ceil(totalFiles / filesPerPage);
console.log(`Total pages: ${totalPages}`);
Copy

Example

try {
  const file = await vana.data.getFileById(123);
  console.log('File details:', {
    id: file.id,
    url: file.url,
    owner: file.ownerAddress,
    addedAt: file.addedAtBlock
  });
} catch (error) {
  console.error('File not found or error retrieving file:', error);
}
Copy

This method queries the DataRegistry contract directly to get file details for any file ID, regardless of user ownership. This is useful for file lookup functionality where users can search for specific files by ID.

Example

// Fetch and decrypt a file
const encryptionKey = await generateEncryptionKey(walletClient);
const encryptedBlob = await vana.data.fetch(file.url);
const decryptedBlob = await decryptBlob(encryptedBlob, encryptionKey, platform);

// With custom headers for authentication
const response = await fetch(file.url, {
  headers: { 'Authorization': 'Bearer token' }
});
const encryptedBlob = await response.blob();
Copy

Example

// Fetch from IPFS with custom gateways
const encryptedBlob = await vana.data.fetchFromIPFS(file.url, {
  gateways: [
    'https://my-private-gateway.com/ipfs/',
    'https://dweb.link/ipfs/',
    'https://ipfs.io/ipfs/'
  ]
});

// Decrypt the fetched content
const encryptionKey = await generateEncryptionKey(walletClient);
const decryptedBlob = await decryptBlob(encryptedBlob, encryptionKey, platform);

// With raw CID
const blob = await vana.data.fetchFromIPFS('QmXxx...', {
  gateways: ['https://ipfs.io/ipfs/']
});
Copy

Example

const schema = {
  name: "User Profile",
  version: "1.0.0",
  dialect: "json",
  schema: {
    type: "object",
    properties: {
      name: { type: "string" },
      age: { type: "number" }
    }
  }
};

vana.data.validateDataSchema(schema);
Copy

Example

const schema = {
  name: "User Profile",
  version: "1.0.0",
  dialect: "json",
  schema: {
    type: "object",
    properties: {
      name: { type: "string" },
      age: { type: "number" }
    },
    required: ["name"]
  }
};

const userData = { name: "Alice", age: 30 };
vana.data.validateDataAgainstSchema(userData, schema);
Copy

Example

// Fetch and validate a schema from IPFS or HTTP
const schema = await vana.data.fetchAndValidateSchema("https://example.com/schema.json");
console.log(schema.name, schema.dialect);

// Use the schema to validate user data
if (schema.dialect === "json") {
  vana.data.validateDataAgainstSchema(userData, schema);
}
Copy

Example

// Get schema from registry and validate its schema
const schema = await vana.data.getValidatedSchema(123);

// Use it to validate user data
if (schema.dialect === "json") {
  vana.data.validateDataAgainstSchema(userData, schema);
}
Copy