Types

A glossary of types.

Account

Name	Type	Required	Default	Description
address	string	yes	-	A base32 encoded public key with a 4-byte checksum appended as defined in keys and addresses.
name	string	no	undefined	A human-readable name for this account.

AuthenticateWithPasskeyParameters

Name	Type	Required	Default	Description
user	UserInformation	yes	-	User details.

AuthenticateWithPasswordParameters

Name	Type	Required	Default	Description
password	string	yes	-	The password used to encrypt the account private keys.
user	UserInformation	yes	-	User details.

BaseError

Name	Type	Required	Default	Description
message	string	yes	-	A message associated with the error.
isKatavaultError	true	yes	-	Used to determine if this a Katavault error.
type	string	yes	-	A reference for this error.

CreateKatavaultParameters

Name	Type	Required	Default	Description
debug	boolean	no	false	Whether to log debug messages.
client	{ icon?: string; name: string; }	no	-	The client's name and icon URL.

ImportAccountWithMnemonicParameters

Name	Type	Required	Default	Description
mnemonic	string	yes	-	A whitespace or comma separated 25-word mnemonic seed phrase containing BIP-039 words.
name	string	no	-	The name of the account.

ImportAccountWithPrivateKeyParameters

Name	Type	Required	Default	Description
name	string	no	-	The name of the account.
privateKey	Uint8Array	yes	-	The raw private key used to derive the Ed25519 key pair.

SetAccountNameByAddressParameters

Name	Type	Required	Default	Description
address	string	yes	-	The address of the account to update.
name	string	yes	-	The name of the account.

SignParameters

Name	Type	Required	Default	Description
address	string	yes	-	The address of the account to be used to sign the message.
encoding	base64 | hex	no	undefined	The output encoding of the signature. If no encoding is specified, the signature will be in raw bytes (Uint8Array).
message	string | Uint8Array	yes	-	A UTF-8 encoded message or raw bytes to sign.

UserInformation

Name	Type	Required	Default	Description
displayName	string	no	-	A human-readable display name for the user. This does not have to be unique and is used to display in the UI.
username	string	yes	-	A globally unique identifier for the user. This could be, for example, an email address.