Class SecretVaultUserClient

Client for user operations on SecretVaults.

This client handles user-specific operations for managing owned documents, including creation, retrieval, updates, and deletion. It supports automatic handling of concealed data when configured with blindfold.

Example

const client = await SecretVaultUserClient.from({
  keypair: myKeypair,
  baseUrls: [
    'https://nildb-stg-n1.nillion.network',
    'https://nildb-stg-n2.nillion.network',
    'https://nildb-stg-n3.nillion.network',
  ],
  blindfold: { // optional blindfold config }
})

Hierarchy

SecretVaultBaseClient<NilDbUserClient>
- SecretVaultUserClient

Index

Constructors

constructor

new SecretVaultUserClient(
options: SecretVaultBaseOptions<NilDbUserClient>,
): SecretVaultUserClient
Parameters
- options: SecretVaultBaseOptions<NilDbUserClient>
Returns SecretVaultUserClient
Inherited from SecretVaultBaseClient<NilDbUserClient>.constructor
- Defined in src/base.ts:49

Accessors

nodes

get nodes(): TClient[]
The array of underlying node clients for the cluster.

Returns TClient[]
Inherited from SecretVaultBaseClient.nodes
- Defined in src/base.ts:67

signer

get signer(): Signer
The signer used by this client for signing.

Returns Signer
Inherited from SecretVaultBaseClient.signer
- Defined in src/base.ts:74

Methods

createData

createData(
    body: {
        acl: {
            execute: boolean;
            grantee: string;
            read: boolean;
            write: boolean;
        };
        collection: string;
        data: Record<string, unknown>[];
        owner: string;
    },
    options?: { auth?: AuthContext },
): Promise<
    ByNodeName<
        {
            data: {
                created: string[];
                errors: { document: unknown; error: string }[];
            };
        },
    >,
>
Creates one or more data documents owned by the user.
Parameters
- body: {
      acl: {
          execute: boolean;
          grantee: string;
          read: boolean;
          write: boolean;
      };
      collection: string;
      data: Record<string, unknown>[];
      owner: string;
  }
- Optionaloptions: { auth?: AuthContext }
Returns Promise<
    ByNodeName<
        {
            data: {
                created: string[];
                errors: { document: unknown; error: string }[];
            };
        },
    >,
>
- Defined in src/user.ts:169

deleteData

deleteData(
params: { collection: string; document: string },
options?: { auth?: AuthContext },
): Promise<ByNodeName<string>>
Deletes a user-owned document from all nodes.
Parameters
- params: { collection: string; document: string }
- Optionaloptions: { auth?: AuthContext }
Returns Promise<ByNodeName<string>>
- Defined in src/user.ts:284

getDid

getDid(): Promise<Did$1>
The DID of the signer associated with this client.

Returns Promise<Did$1>
Inherited from SecretVaultBaseClient.getDid
- Defined in src/base.ts:60

getId

getId(): Promise<string>
Returns Promise<string>
Inherited from SecretVaultBaseClient.getId
- Defined in src/base.ts:53

grantAccess

grantAccess(
    body: {
        acl: {
            execute: boolean;
            grantee: string;
            read: boolean;
            write: boolean;
        };
        collection: string;
        document: string;
    },
    options?: { auth?: AuthContext },
): Promise<ByNodeName<string>>
Grants a given Did access to a given user-owned document.
Parameters
- body: {
      acl: {
          execute: boolean;
          grantee: string;
          read: boolean;
          write: boolean;
      };
      collection: string;
      document: string;
  }
- Optionaloptions: { auth?: AuthContext }
Returns Promise<ByNodeName<string>>
- Defined in src/user.ts:312

listDataReferences

listDataReferences(
    options?: {
        auth?: AuthContext;
        pagination?: {
            limit: number;
            offset: number;
            sort?: Record<string, -1 | 1>;
        };
    },
): Promise<
    {
        data: { builder: string; collection: string; document: string }[];
        pagination: {
            limit: number;
            offset: number;
            sort?: Record<string, -1 | 1>;
            total: number;
        };
    },
>
Lists references to all data documents owned by the user.
Parameters
- Optionaloptions: {
      auth?: AuthContext;
      pagination?: {
          limit: number;
          offset: number;
          sort?: Record<string, -1 | 1>;
      };
  }
Returns Promise<
    {
        data: { builder: string; collection: string; document: string }[];
        pagination: {
            limit: number;
            offset: number;
            sort?: Record<string, -1 | 1>;
            total: number;
        };
    },
>
- Defined in src/user.ts:214

readClusterInfo

readClusterInfo(): Promise<
    ByNodeName<
        {
            build: { commit: string; time: string; version: string };
            maintenance: { active: boolean; started_at: string };
            public_key: string;
            started: string;
            url: string;
        },
    >,
>
Retrieves information about each node in the cluster.

Returns Promise<
    ByNodeName<
        {
            build: { commit: string; time: string; version: string };
            maintenance: { active: boolean; started_at: string };
            public_key: string;
            started: string;
            url: string;
        },
    >,
>
Inherited from SecretVaultBaseClient.readClusterInfo
- Defined in src/base.ts:81

readData

readData(
    params: { collection: string; document: string },
    options?: { auth?: AuthContext },
): Promise<
    {
        data: {
            _acl: {
                execute: boolean;
                grantee: string;
                read: boolean;
                write: boolean;
            }[];
            _created: string;
            _id: string;
            _owner: string;
            _updated: string;
            [key: string]: unknown;
        };
    },
>
Reads a single data document, automatically revealing concealed values if a key is configured.
Parameters
- params: { collection: string; document: string }
- Optionaloptions: { auth?: AuthContext }
Returns Promise<
    {
        data: {
            _acl: {
                execute: boolean;
                grantee: string;
                read: boolean;
                write: boolean;
            }[];
            _created: string;
            _id: string;
            _owner: string;
            _updated: string;
            [key: string]: unknown;
        };
    },
>
- Defined in src/user.ts:240

readProfile

readProfile(
    options?: { auth?: AuthContext },
): Promise<
    {
        data: {
            _created: string;
            _id: string;
            _updated: string;
            data: { collection: string; id: string }[];
            logs: {
                acl?: {
                    execute: boolean;
                    grantee: string;
                    read: boolean;
                    write: boolean;
                };
                collection: string;
                op: string;
                [key: string]: unknown;
            }[];
        };
    },
>
Reads the user's profile information from the cluster.
Parameters
- Optionaloptions: { auth?: AuthContext }
Returns Promise<
    {
        data: {
            _created: string;
            _id: string;
            _updated: string;
            data: { collection: string; id: string }[];
            logs: {
                acl?: {
                    execute: boolean;
                    grantee: string;
                    read: boolean;
                    write: boolean;
                };
                collection: string;
                op: string;
                [key: string]: unknown;
            }[];
        };
    },
>
- Defined in src/user.ts:149

revokeAccess

revokeAccess(
body: { collection: string; document: string; grantee: string },
options?: { auth?: AuthContext },
): Promise<ByNodeName<string>>
Revokes access for a given Did to the specified user-owned document.
Parameters
- body: { collection: string; document: string; grantee: string }
- Optionaloptions: { auth?: AuthContext }
Returns Promise<ByNodeName<string>>
- Defined in src/user.ts:341

`Static`from

from(
    options: {
        baseUrls: string[];
        blindfold?: BlindfoldFactoryConfig;
        signer: Signer;
    },
): Promise<SecretVaultUserClient>

Creates and initializes a new SecretVaultUserClient instance.

Parameters

options: { baseUrls: string[]; blindfold?: BlindfoldFactoryConfig; signer: Signer }

Returns Promise<SecretVaultUserClient>

Example

// Basic instantiation with an auto-generated key
const userClient = await SecretVaultUserClient.from({
  signer: Signer.generate(),
  baseUrls: ["http://localhost:40081", "http://localhost:40082"],
});

Example

// Advanced: Using a custom signer from a browser wallet
import { Signer } from "@nillion/nuc";

// Assumes window.ethereum is available from a browser wallet like MetaMask
const customSigner = await Signer.fromEip1193Provider(window.ethereum);

const clientWithSigner = await SecretVaultUserClient.from({
  signer: customSigner,
  baseUrls: ["http://localhost:40081", "http://localhost:40082"],
});

Class SecretVaultUserClient

Example

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SecretVaultUserClient

Accessors

nodes

Returns TClient[]

signer

Returns Signer

Methods

createData

Parameters

Returns Promise< ByNodeName< { data: { created: string[]; errors: { document: unknown; error: string }[]; }; }, >,>

deleteData

Parameters

Returns Promise<ByNodeName<string>>

getDid

Returns Promise<Did$1>

getId

Returns Promise<string>

grantAccess

Parameters

Returns Promise<ByNodeName<string>>

listDataReferences

Parameters

Returns Promise< { data: { builder: string; collection: string; document: string }[]; pagination: { limit: number; offset: number; sort?: Record<string, -1 | 1>; total: number; }; },>

readClusterInfo

Returns Promise< ByNodeName< { build: { commit: string; time: string; version: string }; maintenance: { active: boolean; started_at: string }; public_key: string; started: string; url: string; }, >,>

readData

Parameters

Returns Promise< { data: { _acl: { execute: boolean; grantee: string; read: boolean; write: boolean; }[]; _created: string; _id: string; _owner: string; _updated: string; [key: string]: unknown; }; },>

readProfile

Parameters

Returns Promise< { data: { _created: string; _id: string; _updated: string; data: { collection: string; id: string }[]; logs: { acl?: { execute: boolean; grantee: string; read: boolean; write: boolean; }; collection: string; op: string; [key: string]: unknown; }[]; }; },>

revokeAccess

Parameters

Returns Promise<ByNodeName<string>>

Staticfrom

Parameters

Returns Promise<SecretVaultUserClient>

Example

Example

Settings

On This Page

Returns Promise<
ByNodeName<
{
data: {
created: string[];
errors: { document: unknown; error: string }[];
};
},
>,
>

Returns Promise<
{
data: { builder: string; collection: string; document: string }[];
pagination: {
limit: number;
offset: number;
sort?: Record<string, -1 | 1>;
total: number;
};
},
>

Returns Promise<
ByNodeName<
{
build: { commit: string; time: string; version: string };
maintenance: { active: boolean; started_at: string };
public_key: string;
started: string;
url: string;
},
>,
>

Returns Promise<
{
data: {
_acl: {
execute: boolean;
grantee: string;
read: boolean;
write: boolean;
}[];
_created: string;
_id: string;
_owner: string;
_updated: string;
[key: string]: unknown;
};
},
>

Returns Promise<
{
data: {
_created: string;
_id: string;
_updated: string;
data: { collection: string; id: string }[];
logs: {
acl?: {
execute: boolean;
grantee: string;
read: boolean;
write: boolean;
};
collection: string;
op: string;
[key: string]: unknown;
}[];
};
},
>

`Static`from