Class SwitchboardSecrets

constructor

• new SwitchboardSecrets(url?: string): SwitchboardSecrets

  Parameters

  • Optionalurl: string

  Returns SwitchboardSecrets

Readonlyurl

addMrEnclave

• addMrEnclave(request: AddMrEnclavePayload, signature: string): Promise<void>

  Parameters

  • request: AddMrEnclavePayload
  • signature: string

  Returns Promise<void>

createAddMrEnclaveRequest

• createAddMrEnclaveRequest(
      userPubkey: string,
      ciphersuite: string,
      mrEnclave: string,
      secretNames: string[],
      expiryTimestamp?: number,
  ): AddMrEnclavePayload

  Parameters

  • userPubkey: string

    The address of the user.
  • ciphersuite: string

    'ed25519' for Solana users, 'ethers' for EVM users.
  • mrEnclave: string

    The MrEnclave value to add.
  • secretNames: string[]

    The names of the secrets to whitelist the MrEnclave value for.
  • expiryTimestamp: number = ...

    The timestamp that this request expires.

    Default: now + 30 seconds.

  Returns AddMrEnclavePayload

createDeleteSecretRequest

• createDeleteSecretRequest(
      userPubkey: string,
      ciphersuite: string,
      secretName: string,
      expiryTimestamp?: number,
  ): DeleteSecretPayload

  Parameters

  • userPubkey: string

    The address of the user.
  • ciphersuite: string

    'ed25519' for Solana users, 'ethers' for EVM users.
  • secretName: string

    The name fo the secret to delete.
  • expiryTimestamp: number = ...

    The timestamp that this request expires.

    Default: now + 30 seconds.

  Returns DeleteSecretPayload

createOrUpdateUser

• createOrUpdateUser(request: UpdateUserPayload, signature: string): Promise<void>

  Parameters

  • request: UpdateUserPayload
  • signature: string

  Returns Promise<void>

createOrUpdateUserRequest

• createOrUpdateUserRequest(
      userPubkey: string,
      ciphersuite: string,
      contactInfo?: string,
      expiryTimestamp?: number,
  ): UpdateUserPayload

  Parameters

  • userPubkey: string

    The address of the user.
  • ciphersuite: string

    'ed25519' for Solana users, 'ethers' for EVM users.
  • contactInfo: string = ''

    Stringified contact info for the user.
  • expiryTimestamp: number = ...

    The timestamp that this request expires.

    Default: now + 30 seconds.

  Returns UpdateUserPayload

createRemoveMrEnclaveRequest

• createRemoveMrEnclaveRequest(
      userPubkey: string,
      ciphersuite: string,
      mrEnclave: string,
      expiryTimestamp?: number,
  ): RemoveMrEnclavePayload

  Parameters

  • userPubkey: string

    The address of the user.
  • ciphersuite: string

    'ed25519' for Solana users, 'ethers' for EVM users.
  • mrEnclave: string

    The mrEnclave value to remove.
  • expiryTimestamp: number = ...

    The timestamp that this request expires.

    Default: now + 30 seconds.

  Returns RemoveMrEnclavePayload

createSecret

• createSecret(request: CreateSecretPayload, signature: string): Promise<void>

  Parameters

  • request: CreateSecretPayload
  • signature: string

  Returns Promise<void>

createSecretRequest

• createSecretRequest(
      userPubkey: string,
      ciphersuite: string,
      secretName: string,
      secretValue: string,
      expiryTimestamp?: number,
  ): CreateSecretPayload

  Parameters

  • userPubkey: string

    The address of the user.
  • ciphersuite: string

    'ed25519' for Solana users, 'ethers' for EVM users.
  • secretName: string

    The key of the secret.

    Keys must be unique per user.
  • secretValue: string

    The value of the secret.
  • expiryTimestamp: number = ...

    The timestamp that this request expires.

    Default: now + 30 seconds.

  Returns CreateSecretPayload

deleteSecret

• deleteSecret(request: DeleteSecretPayload, signature: string): Promise<void>

  Parameters

  • request: DeleteSecretPayload
  • signature: string

  Returns Promise<void>

getUser

• getUser(userPubkey: string, ciphersuite: string): Promise<SecretsApiUser>

  Parameters

  • userPubkey: string
  • ciphersuite: string

  Returns Promise<SecretsApiUser>

getUserSecrets

• getUserSecrets(
      userPubkey: string,
      ciphersuite: string,
  ): Promise<SecretsApiSecret[]>

  Parameters

  • userPubkey: string
  • ciphersuite: string

  Returns Promise<SecretsApiSecret[]>

removeMrEnclave

• removeMrEnclave(
      request: RemoveMrEnclavePayload,
      signature: string,
  ): Promise<void>

  Parameters

  • request: RemoveMrEnclavePayload
  • signature: string

  Returns Promise<void>