Class InMemoryKeystore

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

InMemoryKeystore

Implements

Keystore

Constructors

constructor

new InMemoryKeystore(keys, v1Store, v2Store, persistence): InMemoryKeystore
Parameters
- keys: PrivateKeyBundleV1
- v1Store: V1Store
- v2Store: V2Store
- persistence: Persistence
Returns InMemoryKeystore
- Defined in src/keystore/InMemoryKeystore.ts:67

Accessors

walletAddress

get walletAddress(): string
Returns string
- Defined in src/keystore/InMemoryKeystore.ts:90

Methods

createAuthToken

createAuthToken(__namedParameters): Promise<Token>
Create an XMTP auth token to be used as a header on XMTP API requests
Parameters
- __namedParameters: CreateAuthTokenRequest
Returns Promise<Token>
Implementation of Keystore.createAuthToken
- Defined in src/keystore/InMemoryKeystore.ts:195

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>
Implementation of Keystore.createInvite
- Defined in src/keystore/InMemoryKeystore.ts:347

decryptV1

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

decryptV2

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

encryptV1

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

encryptV2

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

getAccountAddress

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

Returns Promise<string>
Implementation of Keystore.getAccountAddress
- Defined in src/keystore/InMemoryKeystore.ts:501

getPrivateKeyBundle

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

Returns Promise<PrivateKeyBundleV1>
Implementation of Keystore.getPrivateKeyBundle
- Defined in src/keystore/InMemoryKeystore.ts:497

getPrivatePreferencesTopicIdentifier

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

Returns Promise<GetPrivatePreferencesTopicIdentifierResponse>
Implementation of Keystore.getPrivatePreferencesTopicIdentifier
- Defined in src/keystore/InMemoryKeystore.ts:257

getPublicKeyBundle

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

Returns Promise<PublicKeyBundle>
Implementation of Keystore.getPublicKeyBundle
- Defined in src/keystore/InMemoryKeystore.ts:493

getRefreshJob

getRefreshJob(__namedParameters): Promise<GetRefreshJobResponse>
Get a refresh job from the persistence
Parameters
- __namedParameters: GetRefreshJobRequest
Returns Promise<GetRefreshJobResponse>
Implementation of Keystore.getRefreshJob
- Defined in src/keystore/InMemoryKeystore.ts:510

getV1Conversations

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

Returns Promise<GetConversationsResponse>
Implementation of Keystore.getV1Conversations
- Defined in src/keystore/InMemoryKeystore.ts:471

getV2Conversations

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

Returns Promise<GetConversationsResponse>
Implementation of Keystore.getV2Conversations
- Defined in src/keystore/InMemoryKeystore.ts:479

lookupTopic

lookupTopic(topic): undefined | TopicMap_TopicData
Parameters
- topic: string
Returns undefined | TopicMap_TopicData
- Defined in src/keystore/InMemoryKeystore.ts:570

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>
Implementation of Keystore.saveInvites
- Defined in src/keystore/InMemoryKeystore.ts:304

saveV1Conversations

saveV1Conversations(__namedParameters): Promise<SaveV1ConversationsResponse>
Save V1 Conversations
Parameters
- __namedParameters: SaveV1ConversationsRequest
Returns Promise<SaveV1ConversationsResponse>
Implementation of Keystore.saveV1Conversations
- Defined in src/keystore/InMemoryKeystore.ts:456

selfDecrypt

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

selfEncrypt

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

setRefreshJob

setRefreshJob(__namedParameters): Promise<SetRefreshJobResponse>
Sets the time of a refresh job
Parameters
- __namedParameters: SetRefeshJobRequest
Returns Promise<SetRefreshJobResponse>
Implementation of Keystore.setRefreshJob
- Defined in src/keystore/InMemoryKeystore.ts:527

signDigest

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

`Static` create

create(keys, persistence): Promise<InMemoryKeystore>
Parameters
- keys: PrivateKeyBundleV1
- persistence: Persistence
Returns Promise<InMemoryKeystore>
- Defined in src/keystore/InMemoryKeystore.ts:81

Generated using TypeDoc