Class InMemoryKeystore

Implements

KeystoreInterface

Constructors

constructor

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

Accessors

walletAddress

get walletAddress(): string
Returns string
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:104

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 KeystoreInterface.createAuthToken
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:209

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 KeystoreInterface.createInvite
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:377

decryptV1

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

decryptV2

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

encryptV1

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

encryptV2

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

getAccountAddress

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

Returns Promise<string>
Implementation of KeystoreInterface.getAccountAddress
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:532

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 KeystoreInterface.getPrivateKeyBundle
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:528

getPrivatePreferencesTopicIdentifier

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

Returns Promise<GetPrivatePreferencesTopicIdentifierResponse>
Implementation of KeystoreInterface.getPrivatePreferencesTopicIdentifier
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:277

getPublicKeyBundle

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

Returns Promise<PublicKeyBundle>
Implementation of KeystoreInterface.getPublicKeyBundle
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:524

getRefreshJob

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

getV1Conversations

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

Returns Promise<GetConversationsResponse>
Implementation of KeystoreInterface.getV1Conversations
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:502

getV2ConversationHmacKeys

getV2ConversationHmacKeys(req?): Promise<GetConversationHmacKeysResponse>
Returns the conversation HMAC keys for the current, previous, and next 30 day periods since the epoch
Parameters
- Optionalreq: GetConversationHmacKeysRequest
Returns Promise<GetConversationHmacKeysResponse>
Implementation of KeystoreInterface.getV2ConversationHmacKeys
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:606

getV2Conversations

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

Returns Promise<GetConversationsResponse>
Implementation of KeystoreInterface.getV2Conversations
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:510

lookupTopic

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

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 KeystoreInterface.saveInvites
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:334

saveV1Conversations

saveV1Conversations(__namedParameters): Promise<SaveV1ConversationsResponse>
Save V1 Conversations
Parameters
- __namedParameters: SaveV1ConversationsRequest
Returns Promise<SaveV1ConversationsResponse>
Implementation of KeystoreInterface.saveV1Conversations
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:487

selfDecrypt

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

selfEncrypt

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

setRefreshJob

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

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 KeystoreInterface.signDigest
- Defined in packages/js-sdk/src/keystore/InMemoryKeystore.ts:452

`Static`create

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