Interface Keystore

A Keystore is responsible for holding the user's XMTP private keys and using them to encrypt/decrypt/sign messages. Keystores are instantiated using a KeystoreProvider

Hierarchy

Keystore

Implemented by

InMemoryKeystore

Index

Methods

createAuthToken createInvite decryptV1 decryptV2 encryptV1 encryptV2 getAccountAddress getPrivateKeyBundle getPrivatePreferencesTopicIdentifier getPublicKeyBundle getRefreshJob getV1Conversations getV2Conversations saveInvites saveV1Conversations selfDecrypt selfEncrypt setRefreshJob signDigest

Methods

createAuthToken

createAuthToken(req): Promise<Token>
Create an XMTP auth token to be used as a header on XMTP API requests
Parameters
- req: CreateAuthTokenRequest
Returns Promise<Token>
- Defined in src/keystore/interfaces.ts:41

createInvite

createInvite(req): Promise<CreateInviteResponse>
Create a sealed/encrypted invite and store the Topic keys in the Keystore for later use. The returned invite payload must be sent to the network for the other party to be able to communicate.
Parameters
- req: CreateInviteRequest
Returns Promise<CreateInviteResponse>
- Defined in src/keystore/interfaces.ts:35

decryptV1

decryptV1(req): Promise<DecryptResponse>
Decrypt a batch of V1 messages
Parameters
- req: DecryptV1Request
Returns Promise<DecryptResponse>
- Defined in src/keystore/interfaces.ts:12

decryptV2

decryptV2(req): Promise<DecryptResponse>
Decrypt a batch of V2 messages
Parameters
- req: DecryptV2Request
Returns Promise<DecryptResponse>
- Defined in src/keystore/interfaces.ts:16

encryptV1

encryptV1(req): Promise<EncryptResponse>
Encrypt a batch of V1 messages
Parameters
- req: EncryptV1Request
Returns Promise<EncryptResponse>
- Defined in src/keystore/interfaces.ts:20

encryptV2

encryptV2(req): Promise<EncryptResponse>
Encrypt a batch of V2 messages
Parameters
- req: EncryptV2Request
Returns Promise<EncryptResponse>
- Defined in src/keystore/interfaces.ts:24

getAccountAddress

getAccountAddress(): Promise<string>
Get the account address of the wallet used to create the Keystore

Returns Promise<string>
- Defined in src/keystore/interfaces.ts:83

getPrivateKeyBundle

getPrivateKeyBundle(): Promise<PrivateKeyBundleV1>
Export the private keys. May throw an error if the keystore implementation does not allow this operation

Returns Promise<PrivateKeyBundleV1>
- Defined in src/keystore/interfaces.ts:79

getPrivatePreferencesTopicIdentifier

getPrivatePreferencesTopicIdentifier(): Promise<GetPrivatePreferencesTopicIdentifierResponse>
Get the private preferences topic identifier

Returns Promise<GetPrivatePreferencesTopicIdentifierResponse>
- Defined in src/keystore/interfaces.ts:99

getPublicKeyBundle

getPublicKeyBundle(): Promise<PublicKeyBundle>
Get the PublicKeyBundle associated with the Keystore's private keys

Returns Promise<PublicKeyBundle>
- Defined in src/keystore/interfaces.ts:75

getRefreshJob

getRefreshJob(req): Promise<GetRefreshJobResponse>
Get a refresh job from the persistence
Parameters
- req: GetRefreshJobRequest
Returns Promise<GetRefreshJobResponse>
- Defined in src/keystore/interfaces.ts:49

getV1Conversations

getV1Conversations(): Promise<GetConversationsResponse>
Get a list of V1 conversations

Returns Promise<GetConversationsResponse>
- Defined in src/keystore/interfaces.ts:67

getV2Conversations

getV2Conversations(): Promise<GetConversationsResponse>
Get a list of V2 conversations

Returns Promise<GetConversationsResponse>
- Defined in src/keystore/interfaces.ts:71

saveInvites

saveInvites(req): Promise<SaveInvitesResponse>
Take a batch of invite messages and store the TopicKeys for later use in decrypting messages
Parameters
- req: SaveInvitesRequest
Returns Promise<SaveInvitesResponse>
- Defined in src/keystore/interfaces.ts:28

saveV1Conversations

saveV1Conversations(req): Promise<SaveV1ConversationsResponse>
Save V1 Conversations
Parameters
- req: SaveV1ConversationsRequest
Returns Promise<SaveV1ConversationsResponse>
- Defined in src/keystore/interfaces.ts:61

selfDecrypt

selfDecrypt(req): Promise<DecryptResponse>
Decrypt a batch of messages to yourself
Parameters
- req: SelfDecryptRequest
Returns Promise<DecryptResponse>
- Defined in src/keystore/interfaces.ts:93

selfEncrypt

selfEncrypt(req): Promise<SelfEncryptResponse>
Encrypt a batch of messages to yourself
Parameters
- req: SelfEncryptRequest
Returns Promise<SelfEncryptResponse>
- Defined in src/keystore/interfaces.ts:87

setRefreshJob

setRefreshJob(req): Promise<SetRefreshJobResponse>
Sets the time of a refresh job
Parameters
- req: SetRefeshJobRequest
Returns Promise<SetRefreshJobResponse>
- Defined in src/keystore/interfaces.ts:55

signDigest

signDigest(req): Promise<Signature>
Sign the provided digest with either the IdentityKey or a specified PreKey
Parameters
- req: SignDigestRequest
Returns Promise<Signature>
- Defined in src/keystore/interfaces.ts:45

Generated using TypeDoc