@organigram/passkey-wallet 0.1.6

package/.organigram-docs-cache/passkey-wallet/yaml/passkey-wallet.yml

@@ -0,0 +1,870 @@
+### YamlMime:TSPackage
+uid: '@organigram/passkey-wallet!'
+name: '@organigram/passkey-wallet'
+type: package
+summary: ''
+typeAliases:
+  - '@organigram/passkey-wallet!CreateOrganigramPasskeyWalletInput:type'
+  - '@organigram/passkey-wallet!IdentityPasskeyCapabilities:type'
+  - '@organigram/passkey-wallet!OrganigramPasskeyCapabilities:type'
+  - '@organigram/passkey-wallet!OrganigramPasskeyProvider:type'
+  - '@organigram/passkey-wallet!OrganigramPasskeyProviderActions:type'
+  - '@organigram/passkey-wallet!PasskeyProviderEvent:type'
+  - '@organigram/passkey-wallet!PasskeyProviderListener:type'
+  - '@organigram/passkey-wallet!PasskeyRegistrationResult:type'
+  - '@organigram/passkey-wallet!PasskeyVaultEnvelopeData:type'
+  - '@organigram/passkey-wallet!PasskeyVaultEnvelopeInput:type'
+  - '@organigram/passkey-wallet!PasskeyWalletApiClient:type'
+  - '@organigram/passkey-wallet!PasskeyWalletCapabilities:type'
+  - '@organigram/passkey-wallet!PasskeyWalletLoginCapabilities:type'
+  - '@organigram/passkey-wallet!PasskeyWalletRegistrationCapabilities:type'
+  - '@organigram/passkey-wallet!PasskeyWalletVaultPayload:type'
+  - '@organigram/passkey-wallet!UnlockedPasskeyWallet:type'
+classes:
+  - '@organigram/passkey-wallet!PasskeyPrfUnavailableError:class'
+  - '@organigram/passkey-wallet!PasskeyVaultDecryptError:class'
+functions:
+  - name: base64UrlToBytes(value)
+    uid: '@organigram/passkey-wallet!base64UrlToBytes:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'base64UrlToBytes: (value: string) => Uint8Array'
+      parameters:
+        - id: value
+          description: ''
+          type: string
+      return:
+        type: Uint8Array
+        description: ''
+  - name: buildEmailPasskeyCapabilities(email)
+    uid: '@organigram/passkey-wallet!buildEmailPasskeyCapabilities:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'buildEmailPasskeyCapabilities: (email: string) => IdentityPasskeyCapabilities'
+      parameters:
+        - id: email
+          description: ''
+          type: string
+      return:
+        type: <xref uid="@organigram/passkey-wallet!IdentityPasskeyCapabilities:type" />
+        description: ''
+  - name: buildIdentityPasskeyCapabilities(email)
+    uid: '@organigram/passkey-wallet!buildIdentityPasskeyCapabilities:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'buildIdentityPasskeyCapabilities: (email: string) => IdentityPasskeyCapabilities'
+      parameters:
+        - id: email
+          description: ''
+          type: string
+      return:
+        type: <xref uid="@organigram/passkey-wallet!IdentityPasskeyCapabilities:type" />
+        description: ''
+  - name: buildPasskeyWalletCapabilities()
+    uid: '@organigram/passkey-wallet!buildPasskeyWalletCapabilities:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'buildPasskeyWalletCapabilities: () => PasskeyWalletCapabilities'
+      return:
+        type: <xref uid="@organigram/passkey-wallet!PasskeyWalletCapabilities:type" />
+        description: ''
+  - name: bytesToBase64Url(bytes)
+    uid: '@organigram/passkey-wallet!bytesToBase64Url:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'bytesToBase64Url: (bytes: Uint8Array) => string'
+      parameters:
+        - id: bytes
+          description: ''
+          type: Uint8Array
+      return:
+        type: string
+        description: ''
+  - name: createFetchPasskeyWalletApiClient(basePath)
+    uid: '@organigram/passkey-wallet!createFetchPasskeyWalletApiClient:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'createFetchPasskeyWalletApiClient: (basePath?: string) => PasskeyWalletApiClient'
+      parameters:
+        - id: basePath
+          description: ''
+          type: string
+      return:
+        type: <xref uid="@organigram/passkey-wallet!PasskeyWalletApiClient:type" />
+        description: ''
+  - name: createNewPasskeyWalletVault({ capabilities }, input)
+    uid: '@organigram/passkey-wallet!createNewPasskeyWalletVault:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        createNewPasskeyWalletVault: (input: {
+            capabilities: OrganigramPasskeyCapabilities;
+        }) => Promise<{
+            address: `0x${string}`;
+            vaultPayload: PasskeyWalletVaultPayload;
+        }>
+      parameters:
+        - id: '{ capabilities }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                capabilities: <xref uid="@organigram/passkey-wallet!OrganigramPasskeyCapabilities:type" />;
+            }
+      return:
+        type: |-
+          Promise&lt;{
+              address: `0x${string}`;
+              vaultPayload: <xref uid="@organigram/passkey-wallet!PasskeyWalletVaultPayload:type" />;
+          }&gt;
+        description: ''
+  - name: >-
+      createOrganigramPasskeyWallet({ unlockOrCreatePasskeyWallet, registerAdditionalPasskeyCredential,
+      exportPasskeyWalletRecoveryPhrase }, input)
+    uid: '@organigram/passkey-wallet!createOrganigramPasskeyWallet:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'createOrganigramPasskeyWallet: (input: CreateOrganigramPasskeyWalletInput) => Wallet'
+      parameters:
+        - id: '{ unlockOrCreatePasskeyWallet, registerAdditionalPasskeyCredential, exportPasskeyWalletRecoveryPhrase }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: <xref uid="@organigram/passkey-wallet!CreateOrganigramPasskeyWalletInput:type" />
+      return:
+        type: <xref uid="@rainbow-me/rainbowkit!Wallet:type" />
+        description: ''
+  - name: createPasskeyAuthenticationOptions({ rpId, credentials }, input)
+    uid: '@organigram/passkey-wallet!createPasskeyAuthenticationOptions:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        createPasskeyAuthenticationOptions: (input: {
+            rpId: string;
+            credentials?: Array<{
+                credentialId: string;
+                transports: string[];
+            }>;
+        }) => Promise<import("@simplewebauthn/server").PublicKeyCredentialRequestOptionsJSON>
+      parameters:
+        - id: '{ rpId, credentials }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                rpId: string;
+                credentials?: Array&lt;{
+                    credentialId: string;
+                    transports: string[];
+                }&gt;;
+            }
+      return:
+        type: >-
+          Promise&lt;import("@simplewebauthn/server").<xref
+          uid="@simplewebauthn/server!PublicKeyCredentialRequestOptionsJSON:interface" />&gt;
+        description: ''
+  - name: createPasskeyChallengeExpiry()
+    uid: '@organigram/passkey-wallet!createPasskeyChallengeExpiry:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'createPasskeyChallengeExpiry: () => Date'
+      return:
+        type: Date
+        description: ''
+  - name: createPasskeyRegistrationOptions({ rpId, userAddress, email }, input)
+    uid: '@organigram/passkey-wallet!createPasskeyRegistrationOptions:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        createPasskeyRegistrationOptions: (input: {
+            rpId: string;
+            userAddress?: string | null;
+            email?: string | null;
+        }) => Promise<import("@simplewebauthn/server").PublicKeyCredentialCreationOptionsJSON>
+      parameters:
+        - id: '{ rpId, userAddress, email }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                rpId: string;
+                userAddress?: string | null;
+                email?: string | null;
+            }
+      return:
+        type: >-
+          Promise&lt;import("@simplewebauthn/server").<xref
+          uid="@simplewebauthn/server!PublicKeyCredentialCreationOptionsJSON:interface" />&gt;
+        description: ''
+  - name: createPasskeyWalletProvider({ wallet, chain, rpcUrl, switchChain, actions }, input)
+    uid: '@organigram/passkey-wallet!createPasskeyWalletProvider:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        createPasskeyWalletProvider: (input: {
+            wallet: UnlockedPasskeyWallet;
+            chain: Chain;
+            rpcUrl: string;
+            switchChain: (chainId: number) => Chain;
+            actions: OrganigramPasskeyProviderActions;
+        }) => OrganigramPasskeyProvider
+      parameters:
+        - id: '{ wallet, chain, rpcUrl, switchChain, actions }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                wallet: <xref uid="@organigram/passkey-wallet!UnlockedPasskeyWallet:type" />;
+                chain: <xref uid="viem!Chain:type" />;
+                rpcUrl: string;
+                switchChain: (chainId: number) =&gt; <xref uid="viem!Chain:type" />;
+                actions: <xref uid="@organigram/passkey-wallet!OrganigramPasskeyProviderActions:type" />;
+            }
+      return:
+        type: <xref uid="@organigram/passkey-wallet!OrganigramPasskeyProvider:type" />
+        description: ''
+  - name: createPasskeyWalletVaultPayload(recoveryPhrase)
+    uid: '@organigram/passkey-wallet!createPasskeyWalletVaultPayload:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'createPasskeyWalletVaultPayload: (recoveryPhrase: string) => Promise<PasskeyWalletVaultPayload>'
+      parameters:
+        - id: recoveryPhrase
+          description: ''
+          type: string
+      return:
+        type: Promise&lt;<xref uid="@organigram/passkey-wallet!PasskeyWalletVaultPayload:type" />&gt;
+        description: ''
+  - name: createUnlockedPasskeyWallet({ address, credentialId, vaultPayload, now }, input)
+    uid: '@organigram/passkey-wallet!createUnlockedPasskeyWallet:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        createUnlockedPasskeyWallet: (input: {
+            address: `0x${string}`;
+            credentialId: string;
+            vaultPayload: PasskeyWalletVaultPayload;
+            now?: number;
+        }) => UnlockedPasskeyWallet
+      parameters:
+        - id: '{ address, credentialId, vaultPayload, now }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                address: `0x${string}`;
+                credentialId: string;
+                vaultPayload: <xref uid="@organigram/passkey-wallet!PasskeyWalletVaultPayload:type" />;
+                now?: number;
+            }
+      return:
+        type: <xref uid="@organigram/passkey-wallet!UnlockedPasskeyWallet:type" />
+        description: ''
+  - name: decryptPasskeyVaultSecret({ envelope, key }, input)
+    uid: '@organigram/passkey-wallet!decryptPasskeyVaultSecret:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'decryptPasskeyVaultSecret: (input: DecryptPasskeyVaultSecretInput) => Promise<string>'
+      parameters:
+        - id: '{ envelope, key }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: <xref uid="@organigram/passkey-wallet!~DecryptPasskeyVaultSecretInput:type" />
+      return:
+        type: Promise&lt;string&gt;
+        description: ''
+  - name: derivePasskeyVaultKey({ prfOutput, salt }, input)
+    uid: '@organigram/passkey-wallet!derivePasskeyVaultKey:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'derivePasskeyVaultKey: (input: DerivePasskeyVaultKeyInput) => Promise<CryptoKey>'
+      parameters:
+        - id: '{ prfOutput, salt }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: <xref uid="@organigram/passkey-wallet!~DerivePasskeyVaultKeyInput:type" />
+      return:
+        type: Promise&lt;CryptoKey&gt;
+        description: ''
+  - name: encryptPasskeyVaultSecret({ plaintext, key, salt, nonce }, input)
+    uid: '@organigram/passkey-wallet!encryptPasskeyVaultSecret:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'encryptPasskeyVaultSecret: (input: EncryptPasskeyVaultSecretInput) => Promise<PasskeyVaultEnvelopeData>'
+      parameters:
+        - id: '{ plaintext, key, salt, nonce }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: <xref uid="@organigram/passkey-wallet!~EncryptPasskeyVaultSecretInput:type" />
+      return:
+        type: Promise&lt;<xref uid="@organigram/passkey-wallet!PasskeyVaultEnvelopeData:type" />&gt;
+        description: ''
+  - name: exportPasskeyWalletRecoveryPhrase({ api, expectedAddress }, input)
+    uid: '@organigram/passkey-wallet!exportPasskeyWalletRecoveryPhrase:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        exportPasskeyWalletRecoveryPhrase: (input: {
+            api: PasskeyWalletApiClient;
+            expectedAddress: `0x${string}`;
+        }) => Promise<string>
+      parameters:
+        - id: '{ api, expectedAddress }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                api: <xref uid="@organigram/passkey-wallet!PasskeyWalletApiClient:type" />;
+                expectedAddress: `0x${string}`;
+            }
+      return:
+        type: Promise&lt;string&gt;
+        description: ''
+  - name: getWebAuthnClientDataChallenge(response)
+    uid: '@organigram/passkey-wallet!getWebAuthnClientDataChallenge:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'getWebAuthnClientDataChallenge: (response: unknown) => string'
+      parameters:
+        - id: response
+          description: ''
+          type: unknown
+      return:
+        type: string
+        description: ''
+  - name: hydratePasskeyPrfOptions(options)
+    uid: '@organigram/passkey-wallet!hydratePasskeyPrfOptions:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        hydratePasskeyPrfOptions: <T extends {
+            extensions?: unknown;
+        }>(options: T) => T
+      parameters:
+        - id: options
+          description: ''
+          type: T
+      return:
+        type: T
+        description: ''
+  - name: isOrganigramPasskeyConnector({ id }, input)
+    uid: '@organigram/passkey-wallet!isOrganigramPasskeyConnector:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        isOrganigramPasskeyConnector: (input: {
+            id: string;
+        }) => boolean
+      parameters:
+        - id: '{ id }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                id: string;
+            }
+      return:
+        type: boolean
+        description: ''
+  - name: isPasskeyPrfSupported({ credential }, input)
+    uid: '@organigram/passkey-wallet!isPasskeyPrfSupported:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        isPasskeyPrfSupported: (input: {
+            credential: PrfSupportCredential | null;
+        }) => Promise<boolean>
+      parameters:
+        - id: '{ credential }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                credential: <xref uid="@organigram/passkey-wallet!~PrfSupportCredential:type" /> | null;
+            }
+      return:
+        type: Promise&lt;boolean&gt;
+        description: ''
+  - name: normalizePasskeyWalletAddress(address)
+    uid: '@organigram/passkey-wallet!normalizePasskeyWalletAddress:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'normalizePasskeyWalletAddress: (address: `0x${string}`) => `0x${string}`'
+      parameters:
+        - id: address
+          description: ''
+          type: '`0x${string}`'
+      return:
+        type: '`0x${string}`'
+        description: ''
+  - name: parsePasskeyWalletVaultPayload(plaintext)
+    uid: '@organigram/passkey-wallet!parsePasskeyWalletVaultPayload:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'parsePasskeyWalletVaultPayload: (plaintext: string) => PasskeyWalletVaultPayload'
+      parameters:
+        - id: plaintext
+          description: ''
+          type: string
+      return:
+        type: <xref uid="@organigram/passkey-wallet!PasskeyWalletVaultPayload:type" />
+        description: ''
+  - name: registerAdditionalPasskeyCredential({ api, wallet, name }, input)
+    uid: '@organigram/passkey-wallet!registerAdditionalPasskeyCredential:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        registerAdditionalPasskeyCredential: (input: {
+            api: PasskeyWalletApiClient;
+            wallet: UnlockedPasskeyWallet;
+            name?: string;
+        }) => Promise<PasskeyRegistrationResult>
+      parameters:
+        - id: '{ api, wallet, name }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                api: <xref uid="@organigram/passkey-wallet!PasskeyWalletApiClient:type" />;
+                wallet: <xref uid="@organigram/passkey-wallet!UnlockedPasskeyWallet:type" />;
+                name?: string;
+            }
+      return:
+        type: Promise&lt;<xref uid="@organigram/passkey-wallet!PasskeyRegistrationResult:type" />&gt;
+        description: ''
+  - name: registerPasskeyCredentialEnvelope({ api, address, vaultPayload, email, name }, input)
+    uid: '@organigram/passkey-wallet!registerPasskeyCredentialEnvelope:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        export declare function registerPasskeyCredentialEnvelope(input: {
+            api: PasskeyWalletApiClient;
+            address: `0x${string}`;
+            vaultPayload: PasskeyWalletVaultPayload;
+            email?: string | null;
+            name?: string | null;
+        }): Promise<PasskeyRegistrationResult>;
+      parameters:
+        - id: '{ api, address, vaultPayload, email, name }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                api: <xref uid="@organigram/passkey-wallet!PasskeyWalletApiClient:type" />;
+                address: `0x${string}`;
+                vaultPayload: <xref uid="@organigram/passkey-wallet!PasskeyWalletVaultPayload:type" />;
+                email?: string | null;
+                name?: string | null;
+            }
+      return:
+        type: Promise&lt;<xref uid="@organigram/passkey-wallet!PasskeyRegistrationResult:type" />&gt;
+        description: ''
+  - name: registerPasskeyWallet({ api, capabilities }, input)
+    uid: '@organigram/passkey-wallet!registerPasskeyWallet:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        registerPasskeyWallet: (input: {
+            api: PasskeyWalletApiClient;
+            capabilities: OrganigramPasskeyCapabilities;
+        }) => Promise<UnlockedPasskeyWallet>
+      parameters:
+        - id: '{ api, capabilities }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                api: <xref uid="@organigram/passkey-wallet!PasskeyWalletApiClient:type" />;
+                capabilities: <xref uid="@organigram/passkey-wallet!OrganigramPasskeyCapabilities:type" />;
+            }
+      return:
+        type: Promise&lt;<xref uid="@organigram/passkey-wallet!UnlockedPasskeyWallet:type" />&gt;
+        description: ''
+  - name: >-
+      serializePasskeyWalletVaultPayload({ recoveryPhrase, userEncryptionPrivateKey, userEncryptionPublicKey,
+      userEncryptionKeyVersion }, input)
+    uid: '@organigram/passkey-wallet!serializePasskeyWalletVaultPayload:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: 'serializePasskeyWalletVaultPayload: (input: Omit<PasskeyWalletVaultPayload, "version">) => string'
+      parameters:
+        - id: '{ recoveryPhrase, userEncryptionPrivateKey, userEncryptionPublicKey, userEncryptionKeyVersion }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: Omit&lt;<xref uid="@organigram/passkey-wallet!PasskeyWalletVaultPayload:type" />, "version"&gt;
+      return:
+        type: string
+        description: ''
+  - name: toPasskeyVaultEnvelopeData({ encryptedMnemonic, salt, nonce, algorithm, keyVersion }, input)
+    uid: '@organigram/passkey-wallet!toPasskeyVaultEnvelopeData:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        toPasskeyVaultEnvelopeData: (input: {
+            encryptedMnemonic: string;
+            salt: string;
+            nonce: string;
+            algorithm: string;
+            keyVersion: number;
+        }) => PasskeyVaultEnvelopeData
+      parameters:
+        - id: '{ encryptedMnemonic, salt, nonce, algorithm, keyVersion }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                encryptedMnemonic: string;
+                salt: string;
+                nonce: string;
+                algorithm: string;
+                keyVersion: number;
+            }
+      return:
+        type: <xref uid="@organigram/passkey-wallet!PasskeyVaultEnvelopeData:type" />
+        description: ''
+  - name: unlockOrCreatePasskeyWallet({ api, capabilities }, input)
+    uid: '@organigram/passkey-wallet!unlockOrCreatePasskeyWallet:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        unlockOrCreatePasskeyWallet: (input: {
+            api: PasskeyWalletApiClient;
+            capabilities: OrganigramPasskeyCapabilities;
+            targetChainId: number;
+        }) => Promise<UnlockedPasskeyWallet>
+      parameters:
+        - id: '{ api, capabilities }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                api: <xref uid="@organigram/passkey-wallet!PasskeyWalletApiClient:type" />;
+                capabilities: <xref uid="@organigram/passkey-wallet!OrganigramPasskeyCapabilities:type" />;
+                targetChainId: number;
+            }
+      return:
+        type: Promise&lt;<xref uid="@organigram/passkey-wallet!UnlockedPasskeyWallet:type" />&gt;
+        description: ''
+  - name: unlockPasskeyWallet({ api }, input)
+    uid: '@organigram/passkey-wallet!unlockPasskeyWallet:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        unlockPasskeyWallet: (input: {
+            api: PasskeyWalletApiClient;
+        }) => Promise<UnlockedPasskeyWallet | null>
+      parameters:
+        - id: '{ api }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                api: <xref uid="@organigram/passkey-wallet!PasskeyWalletApiClient:type" />;
+            }
+      return:
+        type: Promise&lt;<xref uid="@organigram/passkey-wallet!UnlockedPasskeyWallet:type" /> | null&gt;
+        description: ''
+  - name: validatePasskeyVaultEnvelopeInput(input)
+    uid: '@organigram/passkey-wallet!validatePasskeyVaultEnvelopeInput:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        validatePasskeyVaultEnvelopeInput: (input: PasskeyVaultEnvelopeInput) => PasskeyVaultEnvelopeInput & {
+            address: `0x${string}`;
+        }
+      parameters:
+        - id: input
+          description: ''
+          type: <xref uid="@organigram/passkey-wallet!PasskeyVaultEnvelopeInput:type" />
+      return:
+        type: |-
+          <xref uid="@organigram/passkey-wallet!PasskeyVaultEnvelopeInput:type" /> & {
+              address: `0x${string}`;
+          }
+        description: ''
+  - name: verifyPasskeyAuthentication({ response, expectedChallenge, expectedOrigin, expectedRpId, credential }, input)
+    uid: '@organigram/passkey-wallet!verifyPasskeyAuthentication:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        verifyPasskeyAuthentication: (input: {
+            response: unknown;
+            expectedChallenge: string;
+            expectedOrigin: string;
+            expectedRpId: string;
+            credential: {
+                credentialId: string;
+                publicKey: string;
+                signCount: number;
+            };
+        }) => Promise<Awaited<ReturnType<typeof verifyAuthenticationResponse>>>
+      parameters:
+        - id: '{ response, expectedChallenge, expectedOrigin, expectedRpId, credential }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                response: unknown;
+                expectedChallenge: string;
+                expectedOrigin: string;
+                expectedRpId: string;
+                credential: {
+                    credentialId: string;
+                    publicKey: string;
+                    signCount: number;
+                };
+            }
+      return:
+        type: >-
+          Promise&lt;Awaited&lt;ReturnType&lt;typeof <xref
+          uid="@simplewebauthn/server!verifyAuthenticationResponse:function" />&gt;&gt;&gt;
+        description: ''
+  - name: verifyPasskeyRegistration({ response, expectedChallenge, expectedOrigin, expectedRpId, envelope }, input)
+    uid: '@organigram/passkey-wallet!verifyPasskeyRegistration:function(1)'
+    package: '@organigram/passkey-wallet!'
+    summary: ''
+    remarks: ''
+    example: []
+    isPreview: false
+    isDeprecated: false
+    syntax:
+      content: |-
+        verifyPasskeyRegistration: (input: {
+            response: unknown;
+            expectedChallenge: string;
+            expectedOrigin: string;
+            expectedRpId: string;
+            envelope: PasskeyVaultEnvelopeInput;
+        }) => Promise<{
+            verification: VerifiedPasskeyRegistrationResponse;
+            vaultEnvelope: PasskeyVaultEnvelopeInput & {
+                address: `0x${string}`;
+            };
+        }>
+      parameters:
+        - id: '{ response, expectedChallenge, expectedOrigin, expectedRpId, envelope }'
+          description: ''
+          type: ''
+        - id: input
+          description: ''
+          type: |-
+            {
+                response: unknown;
+                expectedChallenge: string;
+                expectedOrigin: string;
+                expectedRpId: string;
+                envelope: <xref uid="@organigram/passkey-wallet!PasskeyVaultEnvelopeInput:type" />;
+            }
+      return:
+        type: |-
+          Promise&lt;{
+              verification: <xref uid="@organigram/passkey-wallet!~VerifiedPasskeyRegistrationResponse:type" />;
+              vaultEnvelope: <xref uid="@organigram/passkey-wallet!PasskeyVaultEnvelopeInput:type" /> & {
+                  address: `0x${string}`;
+              };
+          }&gt;
+        description: ''