Class DefaultEncryptedMapsClient

constructor

• new DefaultEncryptedMapsClient(
      agent: HttpAgent,
      canisterId: string,
  ): DefaultEncryptedMapsClient

  Parameters

  • agent: HttpAgent
  • canisterId: string

  Returns DefaultEncryptedMapsClient

actor

get_accessible_shared_map_names

• get_accessible_shared_map_names(): Promise<[Principal, ByteBuf][]>

  Retrieves a list of maps that were shared with the user and the user still has access to.

  Returns Promise<[Principal, ByteBuf][]>

  Promise resolving to an array of [Principal, ByteBuf] pairs representing accessible map identifiers.

get_all_accessible_encrypted_maps

• get_all_accessible_encrypted_maps(): Promise<EncryptedMapData[]>

  Retrieves all accessible maps with their encrypted values.

  Returns Promise<EncryptedMapData[]>

  Promise resolving to an array of encrypted map data

get_all_accessible_encrypted_values

• get_all_accessible_encrypted_values(): Promise<
      [[Principal, ByteBuf], [ByteBuf, ByteBuf][]][],
  >

  Retrieves all accessible values across all maps the user has access to.

  Returns Promise<[[Principal, ByteBuf], [ByteBuf, ByteBuf][]][]>

  Promise resolving to an array of map data with encrypted values

get_encrypted_value

• get_encrypted_value(
      mapOwner: Principal,
      mapName: ByteBuf,
      mapKey: ByteBuf,
  ): Promise<{ Ok: [] | [ByteBuf] } | { Err: string }>

  Retrieves an encrypted value from a map.

  Parameters

  • mapOwner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map
  • mapKey: ByteBuf

    The key to retrieve

  Returns Promise<{ Ok: [] | [ByteBuf] } | { Err: string }>

  Promise resolving to the encrypted value if it exists, or an error if the operation fails

get_encrypted_values_for_map

• get_encrypted_values_for_map(
      mapOwner: Principal,
      mapName: ByteBuf,
  ): Promise<{ Ok: [ByteBuf, ByteBuf][] } | { Err: string }>

  Retrieves all encrypted values from a specific map.

  Parameters

  • mapOwner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map

  Returns Promise<{ Ok: [ByteBuf, ByteBuf][] } | { Err: string }>

  Promise resolving to an array of key-value pairs, or an error if the operation fails

get_encrypted_vetkey

• get_encrypted_vetkey(
      mapOwner: Principal,
      mapName: ByteBuf,
      transportKey: ByteBuf,
  ): Promise<{ Ok: ByteBuf } | { Err: string }>

  Fetches an encrypted VetKey.

  Parameters

  • mapOwner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map
  • transportKey: ByteBuf

    The public transport key to use for encryption

  Returns Promise<{ Ok: ByteBuf } | { Err: string }>

  Promise resolving to the encrypted VetKey bytes, or an error if the operation fails

get_owned_non_empty_map_names

• get_owned_non_empty_map_names(): Promise<ByteBuf[]>

  Retrieves a list of non-empty maps owned by the caller.

  Returns Promise<ByteBuf[]>

  Promise resolving to an array of map names

get_shared_user_access_for_map

• get_shared_user_access_for_map(
      owner: Principal,
      mapName: ByteBuf,
  ): Promise<{ Ok: [Principal, AccessRights][] } | { Err: string }>

  Gets all users that have access to a map and their access rights.

  Parameters

  • owner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map

  Returns Promise<{ Ok: [Principal, AccessRights][] } | { Err: string }>

  Promise resolving to an array of user-access rights pairs, or an error if the operation fails

get_user_rights

• get_user_rights(
      owner: Principal,
      mapName: ByteBuf,
      user: Principal,
  ): Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Checks a user's access rights.

  Parameters

  • owner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map
  • user: Principal

    The principal of the user to check rights for

  Returns Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Promise resolving to the user's access rights if they exist, or an error if the operation fails

get_vetkey_verification_key

• get_vetkey_verification_key(): Promise<ByteBuf>

  Retrieves the public verification key for validating encrypted VetKeys.

  Returns Promise<ByteBuf>

  Promise resolving to the verification key bytes

insert_encrypted_value

• insert_encrypted_value(
      mapOwner: Principal,
      mapName: ByteBuf,
      mapKey: ByteBuf,
      data: ByteBuf,
  ): Promise<{ Ok: [] | [ByteBuf] } | { Err: string }>

  Stores an encrypted value in a map.

  Parameters

  • mapOwner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map
  • mapKey: ByteBuf

    The key to store
  • data: ByteBuf

    The encrypted value to store

  Returns Promise<{ Ok: [] | [ByteBuf] } | { Err: string }>

  Promise resolving to the previous value if it existed, or an error if the operation fails

remove_encrypted_value

• remove_encrypted_value(
      mapOwner: Principal,
      mapName: ByteBuf,
      mapKey: ByteBuf,
  ): Promise<{ Ok: [] | [ByteBuf] } | { Err: string }>

  Removes a value from a map.

  Parameters

  • mapOwner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map
  • mapKey: ByteBuf

    The key to remove

  Returns Promise<{ Ok: [] | [ByteBuf] } | { Err: string }>

  Promise resolving to the removed value if it existed, or an error if the operation fails

remove_map_values

• remove_map_values(
      mapOwner: Principal,
      mapName: ByteBuf,
  ): Promise<{ Ok: ByteBuf[] } | { Err: string }>

  Removes all values from a map.

  Parameters

  • mapOwner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map

  Returns Promise<{ Ok: ByteBuf[] } | { Err: string }>

  Promise resolving to an array of removed keys, or an error if the operation fails

remove_user

• remove_user(
      owner: Principal,
      mapName: ByteBuf,
      user: Principal,
  ): Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Revokes a user's access.

  Parameters

  • owner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map
  • user: Principal

    The principal of the user to remove

  Returns Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Promise resolving to the previous access rights if they existed, or an error if the operation fails

set_user_rights

• set_user_rights(
      owner: Principal,
      mapName: ByteBuf,
      user: Principal,
      userRights: AccessRights,
  ): Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Grants or modifies access rights for a user.

  Parameters

  • owner: Principal

    The principal of the map owner
  • mapName: ByteBuf

    The name/identifier of the map
  • user: Principal

    The principal of the user to grant/modify rights for
  • userRights: AccessRights

    The access rights to grant

  Returns Promise<{ Ok: [] | [AccessRights] } | { Err: string }>

  Promise resolving to the previous access rights if they existed, or an error if the operation fails