Class SnapProvider

The Snap keystore provider will:

  1. Check if the user is capable of using Snaps
  2. Check if the user has already setup the Snap with the appropriate keys
  3. If not, will get keys from the network or create new keys and store them in the Snap

Implements

Constructors

constructor

Properties

snapId snapVersion?

Methods

newKeystore

Constructors

constructor

Properties

snapId

snapId: string

Optional snapVersion

snapVersion?: string

Methods

newKeystore

  • newKeystore(opts, apiClient, wallet?): Promise<Flatten<{
        createAuthToken: ((req) => Promise<Token>);
        createInvite: ((req) => Promise<CreateInviteResponse>);
        decryptV1: ((req) => Promise<DecryptResponse>);
        decryptV2: ((req) => Promise<DecryptResponse>);
        encryptV1: ((req) => Promise<EncryptResponse>);
        encryptV2: ((req) => Promise<EncryptResponse>);
        getKeystoreStatus: ((req) => Promise<GetKeystoreStatusResponse>);
        getPrivateKeyBundle: (() => Promise<PrivateKeyBundleV1>);
        getPrivatePreferencesTopicIdentifier: (() => Promise<GetPrivatePreferencesTopicIdentifierResponse>);
        getPublicKeyBundle: (() => Promise<PublicKeyBundle>);
        getRefreshJob: ((req) => Promise<GetRefreshJobResponse>);
        getV1Conversations: (() => Promise<GetConversationsResponse>);
        getV2ConversationHmacKeys: ((req) => Promise<GetConversationHmacKeysResponse>);
        getV2Conversations: (() => Promise<GetConversationsResponse>);
        initKeystore: ((req) => Promise<InitKeystoreResponse>);
        saveInvites: ((req) => Promise<SaveInvitesResponse>);
        saveV1Conversations: ((req) => Promise<SaveV1ConversationsResponse>);
        selfDecrypt: ((req) => Promise<DecryptResponse>);
        selfEncrypt: ((req) => Promise<SelfEncryptResponse>);
        setRefreshJob: ((req) => Promise<SetRefreshJobResponse>);
        signDigest: ((req) => Promise<Signature>);
    } & OtherKeyStoreMethods>>

  • Parameters

    Returns Promise<Flatten<{
        createAuthToken: ((req) => Promise<Token>);
        createInvite: ((req) => Promise<CreateInviteResponse>);
        decryptV1: ((req) => Promise<DecryptResponse>);
        decryptV2: ((req) => Promise<DecryptResponse>);
        encryptV1: ((req) => Promise<EncryptResponse>);
        encryptV2: ((req) => Promise<EncryptResponse>);
        getKeystoreStatus: ((req) => Promise<GetKeystoreStatusResponse>);
        getPrivateKeyBundle: (() => Promise<PrivateKeyBundleV1>);
        getPrivatePreferencesTopicIdentifier: (() => Promise<GetPrivatePreferencesTopicIdentifierResponse>);
        getPublicKeyBundle: (() => Promise<PublicKeyBundle>);
        getRefreshJob: ((req) => Promise<GetRefreshJobResponse>);
        getV1Conversations: (() => Promise<GetConversationsResponse>);
        getV2ConversationHmacKeys: ((req) => Promise<GetConversationHmacKeysResponse>);
        getV2Conversations: (() => Promise<GetConversationsResponse>);
        initKeystore: ((req) => Promise<InitKeystoreResponse>);
        saveInvites: ((req) => Promise<SaveInvitesResponse>);
        saveV1Conversations: ((req) => Promise<SaveV1ConversationsResponse>);
        selfDecrypt: ((req) => Promise<DecryptResponse>);
        selfEncrypt: ((req) => Promise<SelfEncryptResponse>);
        setRefreshJob: ((req) => Promise<SetRefreshJobResponse>);
        signDigest: ((req) => Promise<Signature>);
    } & OtherKeyStoreMethods>>

Settings

Member Visibility

Theme

On This Page

constructorsnapIdsnapVersionnewKeystore