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:24

Accessors

did

get did(): Did
The DID of the keypair associated with this client.

Returns Did
Inherited from SecretVaultBaseClient.did
- Defined in src/base.ts:35

id

get id(): string
Returns string
Inherited from SecretVaultBaseClient.id
- Defined in src/base.ts:28

keypair

get keypair(): Keypair
The keypair used by this client for signing.

Returns Keypair
Inherited from SecretVaultBaseClient.keypair
- Defined in src/base.ts:49

nodes

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

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

Methods

createData

createData(
    delegation: string,
    body: {
        acl: {
            execute: boolean;
            grantee: string & $brand<"Did">;
            read: boolean;
            write: boolean;
        };
        collection: string;
        data: Record<string, unknown>[];
        owner: string & $brand<"Did">;
    },
): Promise<
    ByNodeName<
        {
            data: {
                created: string[];
                errors: { document: unknown; error: string }[];
            };
        },
    >,
>
Creates one or more data documents owned by the user.
Parameters
- delegation: string
- body: {
      acl: {
          execute: boolean;
          grantee: string & $brand<"Did">;
          read: boolean;
          write: boolean;
      };
      collection: string;
      data: Record<string, unknown>[];
      owner: string & $brand<"Did">;
  }
Returns Promise<
    ByNodeName<
        {
            data: {
                created: string[];
                errors: { document: unknown; error: string }[];
            };
        },
    >,
>
- Defined in src/user.ts:162

deleteData

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

grantAccess

grantAccess(
    body: {
        acl: {
            execute: boolean;
            grantee: string & $brand<"Did">;
            read: boolean;
            write: boolean;
        };
        collection: string;
        document: string;
    },
): Promise<ByNodeName<string>>
Grants a given Did access to a given user-owned document.
Parameters
- body: {
      acl: {
          execute: boolean;
          grantee: string & $brand<"Did">;
          read: boolean;
          write: boolean;
      };
      collection: string;
      document: string;
  }
Returns Promise<ByNodeName<string>>
- Defined in src/user.ts:290

listDataReferences

listDataReferences(): Promise<
    {
        data: {
            builder: string & $brand<"Did">;
            collection: string;
            document: string;
        }[];
    },
>
Lists references to all data documents owned by the user.

Returns Promise<
    {
        data: {
            builder: string & $brand<"Did">;
            collection: string;
            document: string;
        }[];
    },
>
- Defined in src/user.ts:202

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:56

readData

readData(
    params: { collection: string; document: string },
): Promise<
    {
        data: {
            _acl: {
                execute: boolean;
                grantee: string & $brand<"Did">;
                read: boolean;
                write: boolean;
            }[];
            _created: string;
            _id: string;
            _owner: string & $brand<"Did">;
            _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 }
Returns Promise<
    {
        data: {
            _acl: {
                execute: boolean;
                grantee: string & $brand<"Did">;
                read: boolean;
                write: boolean;
            }[];
            _created: string;
            _id: string;
            _owner: string & $brand<"Did">;
            _updated: string;
            [key: string]: unknown;
        };
    },
>
- Defined in src/user.ts:224

readProfile

readProfile(): Promise<
    {
        data: {
            _created: string;
            _id: string & $brand<"Did">;
            _updated: string;
            data: { collection: string; id: string }[];
            logs: {
                acl?: {
                    execute: boolean;
                    grantee: string & $brand<"Did">;
                    read: boolean;
                    write: boolean;
                };
                collection: string;
                op: string;
                [key: string]: unknown;
            }[];
        };
    },
>
Reads the user's profile information from the cluster.

Returns Promise<
    {
        data: {
            _created: string;
            _id: string & $brand<"Did">;
            _updated: string;
            data: { collection: string; id: string }[];
            logs: {
                acl?: {
                    execute: boolean;
                    grantee: string & $brand<"Did">;
                    read: boolean;
                    write: boolean;
                };
                collection: string;
                op: string;
                [key: string]: unknown;
            }[];
        };
    },
>
- Defined in src/user.ts:145

revokeAccess

revokeAccess(
    body: {
        collection: string;
        document: string;
        grantee: string & $brand<"Did">;
    },
): Promise<ByNodeName<string>>
Revokes access for a given Did to the specified user-owned document.
Parameters
- body: { collection: string; document: string; grantee: string & $brand<"Did"> }
Returns Promise<ByNodeName<string>>
- Defined in src/user.ts:317

`Static`from

from(
    options: {
        baseUrls: string[];
        blindfold?: BlindfoldFactoryConfig;
        keypair: Keypair;
    },
): Promise<SecretVaultUserClient>
Creates and initializes a new SecretVaultUserClient instance.
Parameters
- options: { baseUrls: string[]; blindfold?: BlindfoldFactoryConfig; keypair: Keypair }
  Configuration options for the client
  - baseUrls: string[]
    URL Array of nilDB node endpoints
  - Optionalblindfold?: BlindfoldFactoryConfig
    Optional blindfold configuration for concealed data
  - keypair: Keypair
    The user's keypair for authentication
Returns Promise<SecretVaultUserClient>
A promise that resolves to a configured SecretVaultUserClient
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',
  ],
});
```
- Defined in src/user.ts:89

Class SecretVaultUserClient

Example

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SecretVaultUserClient

Accessors

did

Returns Did

id

Returns string

keypair

Returns Keypair

nodes

Returns TClient[]

Methods

createData

Parameters

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

deleteData

Parameters

Returns Promise<ByNodeName<string>>

grantAccess

Parameters

Returns Promise<ByNodeName<string>>

listDataReferences

Returns Promise< { data: { builder: string & $brand<"Did">; collection: string; document: string; }[]; },>

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 & $brand<"Did">; read: boolean; write: boolean; }[]; _created: string; _id: string; _owner: string & $brand<"Did">; _updated: string; [key: string]: unknown; }; },>

readProfile

revokeAccess

Parameters

Returns Promise<ByNodeName<string>>

Staticfrom

Parameters

baseUrls: string[]

Optionalblindfold?: BlindfoldFactoryConfig

keypair: Keypair

Returns Promise<SecretVaultUserClient>

Example

Settings

On This Page

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

Returns Promise<
{
data: {
builder: string & $brand<"Did">;
collection: string;
document: string;
}[];
},
>

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 & $brand<"Did">;
read: boolean;
write: boolean;
}[];
_created: string;
_id: string;
_owner: string & $brand<"Did">;
_updated: string;
[key: string]: unknown;
};
},
>

`Static`from

`Optional`blindfold?: BlindfoldFactoryConfig