@opendatalabs/vana-sdk 0.1.0-alpha.7ee7635 → 0.1.0-alpha.80df35f

package/dist/controllers/permissions.d.ts

@@ -1,17 +1,22 @@
-import { Hash, Address } from 'viem';
-import { GrantPermissionParams, GrantFile, PermissionGrantTypedData, TrustServerTypedData, AddAndTrustServerTypedData, GenericTypedData, RevokePermissionParams, GetUserPermissionsOptions, OnChainPermissionGrant, AddAndTrustServerParams, TrustServerParams, UntrustServerParams, TrustedServerQueryOptions, PaginatedTrustedServers, TrustedServerInfo, BatchServerInfoResult, ServerTrustStatus, RegisterGranteeParams, RegisterGranteeTypedData, GranteeQueryOptions, PaginatedGrantees, Grantee, ServerInfo, PermissionInfo, GranteeInfo, ServerFilesAndPermissionParams, ServerFilesAndPermissionTypedData } from '../types/permissions.js';
-import { PermissionGrantResult, PermissionRevokeResult, ServerTrustResult } from '../types/transactionResults.js';
-import { TransactionResult } from '../types/operations.js';
-import { ControllerContext } from '../types/controller-context.js';
-import '../generated/event-types.js';
-import '../generated/server/server-exports.js';
-import '../generated/server/server.js';
-import '../platform/interface.js';
-import '../types/config.js';
-import '../types/chains.js';
-import '../types/storage.js';
-import '../storage/manager.js';
-
+import type { Address, Hash } from "viem";
+import type { GrantPermissionParams, RevokePermissionParams, PermissionGrantTypedData, GenericTypedData, OnChainPermissionGrant, GetUserPermissionsOptions, AddAndTrustServerParams, TrustServerParams, UntrustServerParams, AddAndTrustServerTypedData, TrustServerTypedData, TrustedServerInfo, PaginatedTrustedServers, TrustedServerQueryOptions, BatchServerInfoResult, ServerTrustStatus, GrantFile, Grantee, GranteeInfo, RegisterGranteeParams, RegisterGranteeTypedData, GranteeQueryOptions, PaginatedGrantees, ServerInfo, ServerFilesAndPermissionParams, ServerFilesAndPermissionTypedData } from "../types/index";
+import type { PermissionGrantResult, PermissionRevokeResult, ServerTrustResult } from "../types/transactionResults";
+import type { TransactionResult } from "../types/operations";
+import type { PermissionInfo } from "../types/permissions";
+/**
+ * Provides shared configuration and services for all SDK controllers.
+ *
+ * @remarks
+ * This interface defines the foundational blockchain and storage services that all
+ * controllers require for operation. The main Vana SDK class automatically creates
+ * this context during initialization and passes it to each controller. It includes
+ * wallet clients for transaction signing, storage managers for file operations,
+ * and platform adapters for environment-specific functionality.
+ * @category Configuration
+ */
+import type { ControllerContext } from "../types/controller-context";
+import { BaseController } from "./base";
+export type { ControllerContext };
 /**
  * Manages gasless data access permissions and trusted server registry operations.
  *
@@ -58,8 +63,7 @@ import '../storage/manager.js';
  * @category Permissions
  * @see {@link https://docs.vana.com/developer/permissions | Vana Permissions System} for conceptual overview
  */
-declare class PermissionsController {
-    private readonly context;
+export declare class PermissionsController extends BaseController {
     constructor(context: ControllerContext);
     /**
      * Grants permission for an application to access user data with gasless transactions.
@@ -282,15 +286,6 @@ declare class PermissionsController {
      * @returns Promise resolving to PermissionGrantResult with parsed events
      */
     private confirmGrantInternalWithEvents;
-    /**
-     * Internal method to submit a signed revoke and wait for events.
-     *
-     * @internal
-     * @param typedData - The EIP-712 typed data for the permission revoke
-     * @param signature - The user's signature authorizing the transaction
-     * @returns Promise resolving to PermissionRevokeResult with parsed events
-     */
-    private submitSignedRevokeWithEvents;
     /**
      * Submits an already-signed permission revoke transaction to the blockchain.
      *
@@ -419,43 +414,6 @@ declare class PermissionsController {
      * ```
      */
     submitRevokeWithSignature(params: RevokePermissionParams): Promise<TransactionResult<"DataPortabilityPermissions", "revokePermissionWithSignature">>;
-    /**
-     * @deprecated Use getPermissionsUserNonce() for permission operations or getServersUserNonce() for server operations
-     *
-     * Retrieves the user's current nonce from the DataPortabilityServers contract.
-     * This method is deprecated in favor of more specific nonce methods.
-     *
-     * The nonce is used to prevent replay attacks in signed transactions and must
-     * be incremented with each transaction to maintain security.
-     *
-     * @returns Promise resolving to the user's current nonce value as a bigint
-     * @throws {Error} When wallet account is not available
-     * @throws {Error} When chain ID is not available
-     * @throws {NonceError} When reading nonce from contract fails
-     * @private
-     * @example
-     * ```typescript
-     * // Deprecated - use specific methods instead
-     * const nonce = await this.getUserNonce();
-     *
-     * // Use these instead:
-     * const permissionsNonce = await this.getPermissionsUserNonce();
-     * const serversNonce = await this.getServersUserNonce();
-     * ```
-     */
-    /**
-     * @deprecated Use getPermissionsUserNonce() for permission operations or getServersUserNonce() for server operations
-     *
-     * Retrieves the user's current nonce from the DataPortabilityServers contract.
-     *
-     * @remarks
-     * This method is deprecated in favor of more specific nonce methods that target
-     * the appropriate contract for the operation being performed.
-     *
-     * @returns Promise resolving to the user's current nonce as a bigint
-     * @throws {NonceError} When retrieving the nonce fails
-     */
-    private getUserNonce;
     /**
      * Retrieves the user's current nonce from the DataPortabilityServers contract.
      * This nonce is used for server-related operations (AddAndTrustServer, TrustServer, UntrustServer).
@@ -549,11 +507,10 @@ declare class PermissionsController {
      */
     private signTypedData;
     /**
-     * Gets the user's address from the wallet client.
+     * Gets the user's address from the context.
      *
-     * @returns Promise resolving to the user's wallet address
+     * @returns The user's address
      */
-    private getUserAddress;
     /**
      * Gets on-chain permission grant data without expensive off-chain resolution.
      *
@@ -590,14 +547,6 @@ declare class PermissionsController {
      * ```
      */
     getUserPermissionGrantsOnChain(options?: GetUserPermissionsOptions): Promise<OnChainPermissionGrant[]>;
-    /**
-     * Normalizes grant ID to hex format.
-     * Handles conversion from permission ID (bigint/number/string) to proper hex hash format.
-     *
-     * @param grantId - Permission ID or grant hash in various formats
-     * @returns Normalized hex hash
-     */
-    private normalizeGrantId;
     /**
      * Registers a new server and immediately trusts it in the DataPortabilityServers contract.
      *
@@ -606,7 +555,6 @@ declare class PermissionsController {
      * Trusted servers can handle data export and portability requests from the user.
      *
      * @param params - Parameters for adding and trusting the server
-     * @param params.owner - Ethereum address that will own this server registration
      * @param params.serverAddress - Ethereum address of the server
      * @param params.serverUrl - HTTPS URL where the server can be reached
      * @param params.publicKey - Server's public key for encryption (hex string)
@@ -1294,7 +1242,7 @@ declare class PermissionsController {
      * @param params.serverAddress - Server wallet address for decryption permissions
      * @param params.serverUrl - Server endpoint URL
      * @param params.serverPublicKey - Server's public key for encryption.
-     *   Obtain via `vana.server.getIdentity(userAddress).public_key`.
+     *   Obtain via `vana.server.getIdentity(userAddress).publicKey`.
      * @param params.filePermissions - Nested array of permissions for each file
      * @returns TransactionResult with immediate hash access and optional event data
      * @throws {Error} When schemaIds array length doesn't match fileUrls array length
@@ -1316,7 +1264,7 @@ declare class PermissionsController {
      *   schemaIds: [123], // LinkedIn profile schema ID
      *   serverAddress: "0x742d35Cc6634C0532925a3b844Bc9e7595f0b0Bb",
      *   serverUrl: "https://server.example.com",
-     *   serverPublicKey: serverInfo.public_key,
+     *   serverPublicKey: serverInfo.publicKey,
      *   filePermissions: [[{
      *     account: "0x742d35Cc6634C0532925a3b844Bc9e7595f0b0Bb",
      *     key: encryptedKey
@@ -1379,5 +1327,3 @@ declare class PermissionsController {
      */
     private submitDirectAddServerFilesAndPermissionsTransaction;
 }
-
-export { ControllerContext, PermissionsController };