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

Deprecated

Use KeystoreInterface instead

interface Keystore {
    createAuthToken(req): Promise<Token>;
    createInvite(req): Promise<CreateInviteResponse>;
    decryptV1(req): Promise<DecryptResponse>;
    decryptV2(req): Promise<DecryptResponse>;
    encryptV1(req): Promise<EncryptResponse>;
    encryptV2(req): Promise<EncryptResponse>;
    getAccountAddress(): Promise<string>;
    getPrivateKeyBundle(): Promise<PrivateKeyBundleV1>;
    getPrivatePreferencesTopicIdentifier(): Promise<GetPrivatePreferencesTopicIdentifierResponse>;
    getPublicKeyBundle(): Promise<PublicKeyBundle>;
    getRefreshJob(req): Promise<GetRefreshJobResponse>;
    getV1Conversations(): Promise<GetConversationsResponse>;
    getV2ConversationHmacKeys(): Promise<GetConversationHmacKeysResponse>;
    getV2Conversations(): Promise<GetConversationsResponse>;
    saveInvites(req): Promise<SaveInvitesResponse>;
    saveV1Conversations(req): Promise<SaveV1ConversationsResponse>;
    selfDecrypt(req): Promise<DecryptResponse>;
    selfEncrypt(req): Promise<SelfEncryptResponse>;
    setRefreshJob(req): Promise<SetRefreshJobResponse>;
    signDigest(req): Promise<Signature>;
}

Methods

createAuthToken createInvite decryptV1 decryptV2 encryptV1 encryptV2 getAccountAddress getPrivateKeyBundle getPrivatePreferencesTopicIdentifier getPublicKeyBundle getRefreshJob getV1Conversations getV2ConversationHmacKeys 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>

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>

decryptV1

  • decryptV1(req): Promise<DecryptResponse>

  • Decrypt a batch of V1 messages

    Parameters

    • req: DecryptV1Request

    Returns Promise<DecryptResponse>

decryptV2

  • decryptV2(req): Promise<DecryptResponse>

  • Decrypt a batch of V2 messages

    Parameters

    • req: DecryptV2Request

    Returns Promise<DecryptResponse>

encryptV1

  • encryptV1(req): Promise<EncryptResponse>

  • Encrypt a batch of V1 messages

    Parameters

    • req: EncryptV1Request

    Returns Promise<EncryptResponse>

encryptV2

  • encryptV2(req): Promise<EncryptResponse>

  • Encrypt a batch of V2 messages

    Parameters

    • req: EncryptV2Request

    Returns Promise<EncryptResponse>

getAccountAddress

  • getAccountAddress(): Promise<string>

  • Get the account address of the wallet used to create the Keystore

    Returns Promise<string>

getPrivateKeyBundle

  • getPrivateKeyBundle(): Promise<PrivateKeyBundleV1>

  • Export the private keys. May throw an error if the keystore implementation does not allow this operation

    Returns Promise<PrivateKeyBundleV1>

getPrivatePreferencesTopicIdentifier

  • getPrivatePreferencesTopicIdentifier(): Promise<GetPrivatePreferencesTopicIdentifierResponse>

  • Get the private preferences topic identifier

    Returns Promise<GetPrivatePreferencesTopicIdentifierResponse>

getPublicKeyBundle

  • getPublicKeyBundle(): Promise<PublicKeyBundle>

  • Get the PublicKeyBundle associated with the Keystore's private keys

    Returns Promise<PublicKeyBundle>

getRefreshJob

  • getRefreshJob(req): Promise<GetRefreshJobResponse>

  • Get a refresh job from the persistence

    Parameters

    • req: GetRefreshJobRequest

    Returns Promise<GetRefreshJobResponse>

getV1Conversations

  • getV1Conversations(): Promise<GetConversationsResponse>

  • Get a list of V1 conversations

    Returns Promise<GetConversationsResponse>

getV2ConversationHmacKeys

  • getV2ConversationHmacKeys(): Promise<GetConversationHmacKeysResponse>

  • Returns the conversation HMAC keys for the current, previous, and next 30 day periods since the epoch

    Returns Promise<GetConversationHmacKeysResponse>

getV2Conversations

  • getV2Conversations(): Promise<GetConversationsResponse>

  • Get a list of V2 conversations

    Returns Promise<GetConversationsResponse>

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>

saveV1Conversations

  • saveV1Conversations(req): Promise<SaveV1ConversationsResponse>

  • Save V1 Conversations

    Parameters

    • req: SaveV1ConversationsRequest

    Returns Promise<SaveV1ConversationsResponse>

selfDecrypt

  • selfDecrypt(req): Promise<DecryptResponse>

  • Decrypt a batch of messages to yourself

    Parameters

    • req: SelfDecryptRequest

    Returns Promise<DecryptResponse>

selfEncrypt

  • selfEncrypt(req): Promise<SelfEncryptResponse>

  • Encrypt a batch of messages to yourself

    Parameters

    • req: SelfEncryptRequest

    Returns Promise<SelfEncryptResponse>

setRefreshJob

  • setRefreshJob(req): Promise<SetRefreshJobResponse>

  • Sets the time of a refresh job

    Parameters

    • req: SetRefeshJobRequest

    Returns Promise<SetRefreshJobResponse>

signDigest

  • signDigest(req): Promise<Signature>

  • Sign the provided digest with either the IdentityKey or a specified PreKey

    Parameters

    • req: SignDigestRequest

    Returns Promise<Signature>

Settings

Member Visibility

Theme

On This Page

createAuthTokencreateInvitedecryptV1decryptV2encryptV1encryptV2getAccountAddressgetPrivateKeyBundlegetPrivatePreferencesTopicIdentifiergetPublicKeyBundlegetRefreshJobgetV1ConversationsgetV2ConversationHmacKeysgetV2ConversationssaveInvitessaveV1ConversationsselfDecryptselfEncryptsetRefreshJobsignDigest

Generated using TypeDoc