Organigram Passkey Wallet

L'expérience web3 ultime : déverrouillez vos portefeuilles et signez vos transactions en un clin d'œil, avec des passkeys récupérables.

Organigram Passkey Wallet est un portefeuille Ethereum léger fondé sur les passkeys WebAuthn. Il offre aux utilisateurs l'expérience quotidienne qu'ils attendent des applications modernes sans mot de passe, tout en préservant la propriété essentielle du web3 : posséder pleinement et en toute sécurité une adresse Ethereum standard.

Pas de déploiement fastidieux de smart account. Pas de création de compte réseau par réseau. Pas de service de garde des clés. Pas d'enfermement dans un protocole. Simplement un EOA standard, chiffré côté client, déverrouillé par des passkeys renouvelables et exposé via Wagmi et RainbowKit.

L'identité web3, enfin résolue

La plupart des parcours d'accueil web3 demandent encore aux utilisateurs de comprendre les extensions de navigateur, les phrases de récupération, les appareils matériels, l'abstraction de compte, le sponsoring du gas, les contrats de récupération, les déploiements propres à chaque réseau, les permissions des signataires... avant même d'avoir utilisé le produit. Organigram Passkey Wallet emprunte un chemin plus simple.

L'utilisateur crée un portefeuille dans le navigateur. Ce portefeuille est un EOA Ethereum ordinaire dérivé d'une phrase de récupération. Cette phrase est chiffrée localement avec une clé dérivée de la sortie PRF d'une passkey WebAuthn, puis stockée uniquement sous forme d'enveloppe de coffre chiffrée. Quand l'utilisateur revient, sa passkey déverrouille le coffre et l'EOA signe messages et transactions comme n'importe quel autre portefeuille.

Le résultat est une expérience de portefeuille qui semble native au web :

• les utilisateurs déverrouillent et signent avec des passkeys ;
• plusieurs passkeys de secours peuvent être ajoutées à la même adresse ;
• les passkeys compromises ou obsolètes peuvent être renouvelées ;
• les phrases de récupération peuvent être exportées en prévision d'un sinistre ;
• les coffres de sauvegarde chiffrés peuvent être enregistrés à distance ou localement ;
• une seule adresse sur tous les réseaux EVM ;
• la sémantique EIP-1193 standard pour les dapps ;
• aucun déploiement on-chain nécessaire ;
• aucun relais de signature off-chain ni signataire hébergé à qui faire confiance.

Points forts

Déverrouiller et signer avec des passkeys

Les utilisateurs déverrouillent le portefeuille avec une passkey WebAuthn. Une fois déverrouillé, le portefeuille signe messages, données typées et transactions avec l'EOA sous-jacent.

Un portefeuille Ethereum à part entière

Le portefeuille expose la même interface que celle que les dapps attendent déjà des portefeuilles injectés, des portefeuilles WalletConnect et des connecteurs RainbowKit. Il prend en charge les demandes de compte, le changement de chaîne, la signature de messages et de données typées, et l'envoi de transactions, comme tout portefeuille standard.

Plusieurs clés de secours, une seule adresse

Les utilisateurs peuvent ajouter d'autres passkeys pour la même adresse. Un téléphone de secours, un ordinateur portable, un gestionnaire de mots de passe ou une clé de sécurité peuvent déverrouiller le même coffre chiffré.

Aucun smart account à déployer

L'adresse est un EOA standard : elle existe partout où existent des comptes EVM. Inutile de déployer des contrats de compte sur chaque réseau avant que l'utilisateur puisse commencer.

Export de la phrase de récupération

Les passkeys simplifient l'usage quotidien, tandis que la possibilité d'exporter la phrase de récupération préserve la portabilité et donne aux utilisateurs une issue de secours au cas où toutes leurs passkeys seraient perdues.

Coffres récupérables

L'application exporte un coffre chiffré qui peut être enregistré et restauré depuis n'importe où. Utilisez des serveurs distants, enregistrez-le localement ou dans un gestionnaire de mots de passe sans crainte de divulguer d'informations sensibles.

Interface du portefeuille

Ce paquet construit une application prête pour la production, qui sert le portefeuille en local ou sur des domaines personnalisés.

build:artifact compile la bibliothèque TypeScript dans app-dist, et emballe une archive déterministe artifacts/passkey-wallet-app-v<version>.tar.gz avec un .sha256 de contrôle et un manifeste.

Développement local

pnpm dev sert le portefeuille à l'adresse https://localhost:3002, derrière un proxy HTTPS placé devant Vite (port 3003). Le premier lancement crée un certificat local avec mkcert.

Tout autre nom d'hôte peut être passé en argument (pnpm dev my.host.test) : le certificat est alors régénéré pour l'inclure.

Exécuter votre propre portefeuille

Vous n'avez pas à faire confiance aux serveurs de wallet.organigram.ai, ni au code qu'ils servent, pour utiliser vos comptes Organigram. Le profil local-organigram sert votre propre copie du portefeuille, construite à partir de ce code source, sur votre machine :

(ou pnpm passkey-wallet dev local-organigram depuis la racine du dépôt), puis ouvrez https://local.wallet.organigram.ai:3002.

local.wallet.organigram.ai est un sous-domaine de wallet.organigram.ai, donc cette copie déverrouille les mêmes passkeys, et donc les mêmes comptes : le profil fixe le RP ID des passkeys à wallet.organigram.ai. Son stockage navigateur est distinct : restaurez-y donc une fois votre coffre chiffré (voir Coffres récupérables) ; votre passkey le déverrouille ensuite comme d'habitude. Vos clés ne quittent jamais votre navigateur, et la connexion ne dépend plus de la disponibilité ni de l'intégrité de wallet.organigram.ai.

Le nom pointe déjà vers 127.0.0.1 via le DNS public, aucune configuration n'est donc nécessaire. Pour une garantie plus forte, déclarez-le aussi dans votre fichier hosts : sinon, un enregistrement DNS falsifié pourrait le rediriger vers un serveur capable de demander la sortie PRF de vos passkeys (macOS et Linux) :

Pour l'utiliser depuis n'importe quelle application, activez Paramètres → Votre propre portefeuille sur wallet.organigram.ai. Les requêtes vont alors vers votre copie et, dès qu'elle a répondu, les applications l'ouvrent directement : wallet.organigram.ai n'est plus chargé du tout. Si votre copie cesse de répondre, par exemple parce qu'elle n'est pas lancée, la requête revient vers wallet.organigram.ai au bout de quelques secondes.

Les applications qui utilisent ce paquet acceptent la copie locale du portefeuille officiel sans aucun réglage, sur leurs pages comme sur leurs points d'accès au portefeuille (défi de connexion, sauvegardes de coffres, RPC).

Un portefeuille déployé ailleurs peut offrir la même chose à ses utilisateurs avec sa propre copie locale, servie sous un sous-domaine de son hôte afin qu'elle déverrouille les mêmes passkeys :

• le déploiement la déclare avec localWalletOrigin dans passkey-wallet.config.json (ou PASSKEY_WALLET_LOCAL_WALLET_ORIGIN au moment du build), par exemple https://local.wallet.example.com:3002;
• les utilisateurs la lancent avec PASSKEY_WALLET_PASSKEY_RP_ID=wallet.example.com pnpm dev local.wallet.example.com;
• les applications l'acceptent avec NEXT_PUBLIC_ORGANIGRAM_PASSKEY_WALLET_LOCAL_URL, à côté de NEXT_PUBLIC_ORGANIGRAM_PASSKEY_WALLET_URL. La valeur est ignorée si ce n'est pas un sous-domaine HTTPS de l'hôte du portefeuille.

Chaque build de production de https://wallet.organigram.ai est publié comme release de ce dépôt, avec le SHA-256 de chaque fichier servi. Pour vérifier que le portefeuille en ligne sert l'une de ces releases sans modification, lancez depuis un clone de ce dépôt :

Avec Node.js 24 et pnpm 10.28, reconstruire le commit d'une release reproduit ses fichiers :

Architecture

En pratique, le déroulement est le suivant :

1. Générer une phrase de récupération dans le navigateur.
2. Dériver de cette phrase un EOA Ethereum standard.
3. Créer une passkey WebAuthn avec residentKey: "required", userVerification: "required", et l'extension prf .
4. Dériver une clé de chiffrement du coffre à partir de la sortie PRF et d'un sel aléatoire.
5. Chiffrer le coffre du portefeuille avec AES-GCM.
6. Ne stocker côté serveur que les métadonnées de l'identifiant et l'enveloppe chiffrée du coffre.
7. Au déverrouillage, vérifier WebAuthn, récupérer la sortie PRF, déchiffrer l'enveloppe et exposer l'EOA via EIP-1193.

Les secrets du portefeuille sont générés et déchiffrés dans le navigateur. Le serveur ne stocke que les éléments de vérification WebAuthn et les enveloppes chiffrées des coffres. Il n'a jamais besoin de la phrase de récupération, de la clé privée ni du coffre déchiffré de l'utilisateur.

Démarrage rapide

Créez et déverrouillez des coffres dans l'interface avec les fonctions du portefeuille :

La cérémonie de passkey et le déchiffrement du coffre ont lieu sur l'origine du portefeuille. Les dapps doivent s'intégrer via le connecteur distant.

Intégration RainbowKit

Du point de vue de la dapp, il se comporte comme un portefeuille. Un appel à personal_sign, eth_signTypedData_v4, ou eth_sendTransaction passe par l'origine du portefeuille, où l'utilisateur approuve la requête.

Rôle du serveur

L'application du portefeuille est statique. Un serveur est facultatif et ne doit recevoir que des sauvegardes chiffrées ou des défis de connexion des dapps. Il ne doit ni créer d'identifiants WebAuthn, ni déverrouiller de coffres, ni recevoir de secrets déchiffrés du portefeuille.

Clés de secours et renouvellement

Un portefeuille à passkeys ne doit jamais dépendre d'un seul authentificateur.

Organigram Passkey Wallet permet d'ajouter une autre passkey au même portefeuille en rechiffrant le même contenu de coffre pour un nouvel identifiant. L'adresse ne change pas. L'utilisateur garde le même EOA tout en ajoutant une passkey d'ordinateur, de téléphone, de gestionnaire de mots de passe ou une clé de sécurité matérielle.

Le renouvellement suit la même idée à l'inverse : ne retirer les identifiants obsolètes que s'il reste une autre méthode de récupération. Le paquet fournit les briques du portefeuille et des enveloppes ; c'est à votre produit de définir la politique d'expérience utilisateur pour la suppression, la confirmation et le nombre minimal de sauvegardes.

Récupération

Les passkeys simplifient l'usage quotidien du portefeuille, mais les utilisateurs ont toujours besoin d'une issue de secours.

Organigram Passkey Wallet garde le portefeuille portable en dérivant l'EOA d'une phrase de récupération standard. Si toutes les passkeys sont perdues, l'utilisateur peut récupérer le compte avec cette phrase, ou l'utiliser dans n'importe quel autre portefeuille.

La phrase de récupération doit toujours être exportée avant que l'utilisateur perde toutes ses passkeys. Le paquet fournit une fonction pour exporter la phrase de récupération après une cérémonie WebAuthn réussie, mais ne peut plus le faire une fois tout accès au coffre perdu.

Modèle de sécurité

Organigram Passkey Wallet est non custodial par conception.

Le navigateur crée le portefeuille. Le navigateur chiffre le coffre. Le navigateur déchiffre le coffre après une cérémonie WebAuthn réussie. Le serveur stocke les enveloppes chiffrées et vérifie que les réponses WebAuthn sont valides pour le défi, l'origine, le RP ID et la clé publique d'identifiant attendus.

Ce modèle suppose que :

• la prise en charge de WebAuthn PRF est requise pour le coffre à passkeys ;
• l'application hôte sert l'interface du portefeuille depuis une origine de confiance ;
• le serveur fait correctement expirer et consomme les défis ;
• le serveur vérifie les compteurs d'identifiants et la vérification de l'utilisateur ;
• l'export de la phrase de récupération est traité comme une opération sensible ;
• la suppression d'une passkey de secours ne laisse jamais l'utilisateur sans méthode de récupération ;
• une session de navigateur compromise peut lire les secrets déverrouillés du portefeuille pendant le traitement d'une requête.

Portée des passkeys

Les passkeys sont créées pour le nom d'hôte exact qui sert le portefeuille (par exemple wallet.organigram.ai). Toute page servie sous le RP ID des passkeys peut demander la sortie PRF qui déchiffre le coffre : aucune autre application ne doit donc y être hébergée. Les dapps n'ont jamais besoin du RP ID du portefeuille : elles l'atteignent via sa fenêtre popup et postMessage.

Un portefeuille servi depuis un sous-domaine peut réutiliser les passkeys de l'hôte parent en réglant passkeyRpId dans passkey-wallet.config.json (ou PASSKEY_WALLET_PASSKEY_RP_ID) sur cet hôte. La valeur doit être le nom d'hôte courant ou l'un de ses domaines parents. pnpm dev local-organigram le fait pour wallet.organigram.ai (voir Exécuter votre propre portefeuille).

Le portefeuille envoie une Content-Security-Policy qui interdit les scripts tiers et toute intégration de l'origine du portefeuille dans un cadre.

Compatibilité des navigateurs

Le coffre à passkeys dépend de l'extension WebAuthn prf . Les navigateurs ou gestionnaires de mots de passe qui ne renvoient pas de sortie PRF ne peuvent pas déverrouiller le coffre chiffré.

Les applications doivent proposer une solution de repli claire quand PRF n'est pas disponible :

• réessayer avec un autre fournisseur de passkeys ;
• utiliser un authentificateur de plateforme qui prend en charge PRF ;
• connecter plutôt un portefeuille crypto externe.

Ce que ce n'est pas

Organigram Passkey Wallet n'est pas un framework de smart accounts. Il ne nécessite ni infrastructure 4337, ni paymasters, ni bundlers, ni registres de modules, ni déploiements par chaîne.

Ce n'est pas un portefeuille custodial. Le serveur ne reçoit jamais la phrase de récupération ni la clé privée en clair.

Ce n'est pas un service de portefeuille hébergé. Le paquet est open source ; l'application hôte gère la persistance, l'authentification et la politique de sauvegarde.

Il ne remplace pas les portefeuilles matériels pour les conservations exigeant un haut niveau de garantie. Il est conçu pour offrir l'expérience web grand public la plus sûre possible, tout en restant portable et compatible EVM.

Licence

MIT

Connecter une application

Les applications atteignent le portefeuille via createOrganigramRemotePasskeyWallet(), un portefeuille RainbowKit dont le connecteur wagmi ouvre le portefeuille dans une fenêtre popup. Chaque connexion, signature, transaction ou opération de chiffrement est une requête que l'utilisateur approuve dans la popup. Les applications échangent requêtes et réponses avec la popup via postMessage, et n'acceptent que les réponses provenant de l'origine du portefeuille et de sa copie locale. Les signatures sont vérifiées par rapport à l'adresse et à la chaîne connectées avant d'atteindre l'application. Les clés privées ne quittent jamais l'origine du portefeuille.

CreateOrganigramRemotePasskeyWalletInput

Definition

export type CreateOrganigramRemotePasskeyWalletInput = {

walletOrigin?: string;

requestConnect?: RemoteRequestConnect;

requestPersonalSign?: RemoteRequestPersonalSign;

requestSignTypedData?: RemoteRequestSignTypedData;

requestSendTransaction?: RemoteRequestSendTransaction;

};

HydrateOrganigramRemoteWalletConnectionConnector

Definition

export type HydrateOrganigramRemoteWalletConnectionConnector = {

id: string;

};

HydrateOrganigramRemoteWalletConnectionInput

Definition

export type HydrateOrganigramRemoteWalletConnectionInput = {

address: `0x${string}`;

chainId?: number;

};

HydrateOrganigramRemoteWalletConnectionOptions

Definition

export type HydrateOrganigramRemoteWalletConnectionOptions<TConnector extends HydrateOrganigramRemoteWalletConnectionConnector> = HydrateOrganigramRemoteWalletConnectionInput & {

connectors: readonly TConnector[];

connectAsync: (input: {

connector: TConnector;

}) => Promise<unknown>;

defaultChainId?: number;

};

OrganigramRemotePasskeyWalletConnection

Elle ne contient que l'adresse publique et la chaîne, jamais de clé : chaque signature est toujours demandée à l'utilisateur dans la popup du portefeuille.

Definition

export type OrganigramRemotePasskeyWalletConnection = {

version: 1;

address: `0x${string}`;

chainId: number;

connectedAt: string;

};

beginOrganigramWalletApprovalSequence

Signature

beginOrganigramWalletApprovalSequence: (input: {

count: number;

label?: string;

}) => (() => void)

clearOrganigramRemotePasskeyWalletConnection

Signature

clearOrganigramRemotePasskeyWalletConnection: () => void

createOrganigramRemotePasskeyWallet

Le connecteur expose un fournisseur EIP-1193. Les demandes de compte et de signature ouvrent la popup du portefeuille, et chaque signature est vérifiée par rapport à l'adresse et à la chaîne connectées. Les autres requêtes JSON-RPC vont à l'URL RPC par défaut de la chaîne active.

Signature

createOrganigramRemotePasskeyWallet: (input?: CreateOrganigramRemotePasskeyWalletInput) => Wallet

Paramètres

Nom	Type	Description
input	CreateOrganigramRemotePasskeyWalletInput	L'origine du portefeuille, et les remplacements de ses requêtes.

getOrganigramRemotePasskeyWalletConnection

Signature

getOrganigramRemotePasskeyWalletConnection: () => OrganigramRemotePasskeyWalletConnection | null

Retourne

Type	Description
OrganigramRemotePasskeyWalletConnection | null	La connexion, ou null si aucune n'est valide.

hydrateOrganigramRemoteWalletConnection

Mémorise la connexion, puis connecte le connecteur du portefeuille, qui la restaure. Si la connexion échoue, elle est oubliée.

Signature

hydrateOrganigramRemoteWalletConnection: <TConnector extends HydrateOrganigramRemoteWalletConnectionConnector>(input: HydrateOrganigramRemoteWalletConnectionOptions<TConnector>) => Promise<void>

rememberOrganigramRemotePasskeyWalletConnection

Signature

rememberOrganigramRemotePasskeyWalletConnection: (input: {

address: `0x${string}`;

chainId: number;

}) => void

Paramètres

Nom	Type	Description
input	{ address: `0x${string}`; chainId: number; }	L'adresse et la chaîne connectées.

organigramRemotePasskeyWalletId

Definition

const organigramRemotePasskeyWalletId = "organigram-passkeys"

PasskeyWalletConnectPopupInput

Definition

export type PasskeyWalletConnectPopupInput = PasskeyWalletRemotePopupInput;

PasskeyWalletConnectRequest

Definition

export type PasskeyWalletConnectRequest = PasskeyWalletRemoteRequestBase & {

type: typeof passkeyWalletConnectType;

};

PasskeyWalletConnectResult

Definition

export type PasskeyWalletConnectResult = PasskeyWalletRemoteResultBase & {

type: typeof passkeyWalletConnectResultType;

};

PasskeyWalletDecryptPayloadRequest

Definition

export type PasskeyWalletDecryptPayloadRequest = PasskeyWalletRemoteRequestBase & {

type: typeof passkeyWalletDecryptPayloadType;

address: `0x${string}`;

encryptedPayload: WalletEncryptedPayload;

};

PasskeyWalletDecryptPayloadResult

Definition

export type PasskeyWalletDecryptPayloadResult = PasskeyWalletRemoteResultBase & {

type: typeof passkeyWalletDecryptPayloadResultType;

plaintext: string;

};

PasskeyWalletEncryptPayloadRequest

Definition

export type PasskeyWalletEncryptPayloadRequest = PasskeyWalletRemoteRequestBase & {

type: typeof passkeyWalletEncryptPayloadType;

address: `0x${string}`;

plaintext: string;

};

PasskeyWalletEncryptPayloadResult

Definition

export type PasskeyWalletEncryptPayloadResult = PasskeyWalletRemoteResultBase & {

type: typeof passkeyWalletEncryptPayloadResultType;

encryptedPayload: WalletEncryptedPayload;

};

PasskeyWalletRemoteErrorResult

Definition

export type PasskeyWalletRemoteErrorResult = Omit<PasskeyWalletRemoteResultBase, 'address'> & {

type: typeof passkeyWalletRemoteErrorResultType;

address?: undefined;

error: string;

};

PasskeyWalletRemotePopupInput

Definition

export type PasskeyWalletRemotePopupInput = {

walletOrigin?: string;

appOrigin?: string;

chainId: number;

requestId?: string;

requestedAt?: string;

approvalStep?: number;

approvalCount?: number;

approvalLabel?: string;

};

PasskeyWalletRemoteRequest

Definition

export type PasskeyWalletRemoteRequest = PasskeyWalletConnectRequest | PasskeyWalletSignMessageRequest | PasskeyWalletSignTypedDataRequest | PasskeyWalletSendTransactionRequest | PasskeyWalletEncryptPayloadRequest | PasskeyWalletDecryptPayloadRequest;

PasskeyWalletRemoteRequestPayloadMessage

Definition

export type PasskeyWalletRemoteRequestPayloadMessage = {

type: typeof passkeyWalletRemoteRequestPayloadType;

version: 1;

request: PasskeyWalletRemoteRequest;

};

PasskeyWalletRemoteRequestType

Definition

export type PasskeyWalletRemoteRequestType = typeof passkeyWalletConnectType | typeof passkeyWalletSignMessageType | typeof passkeyWalletSignTypedDataType | typeof passkeyWalletSendTransactionType | typeof passkeyWalletEncryptPayloadType | typeof passkeyWalletDecryptPayloadType;

PasskeyWalletRemoteResult

Definition

export type PasskeyWalletRemoteResult = PasskeyWalletConnectResult | PasskeyWalletSignMessageResult | PasskeyWalletSignTypedDataResult | PasskeyWalletSendTransactionResult | PasskeyWalletEncryptPayloadResult | PasskeyWalletDecryptPayloadResult | PasskeyWalletRemoteErrorResult;

PasskeyWalletSendTransactionRequest

Definition

export type PasskeyWalletSendTransactionRequest = PasskeyWalletRemoteRequestBase & {

type: typeof passkeyWalletSendTransactionType;

address: `0x${string}`;

transaction: PasskeyWalletTransaction;

};

PasskeyWalletSendTransactionResult

Definition

export type PasskeyWalletSendTransactionResult = PasskeyWalletRemoteResultBase & {

type: typeof passkeyWalletSendTransactionResultType;

transactionHash: `0x${string}`;

};

PasskeyWalletSignMessagePopupInput

Definition

export type PasskeyWalletSignMessagePopupInput = PasskeyWalletRemotePopupInput & {

address: `0x${string}`;

message: string;

};

PasskeyWalletSignMessageRequest

Definition

export type PasskeyWalletSignMessageRequest = PasskeyWalletRemoteRequestBase & {

type: typeof passkeyWalletSignMessageType;

address: `0x${string}`;

message: string;

};

PasskeyWalletSignMessageResult

Definition

export type PasskeyWalletSignMessageResult = PasskeyWalletRemoteResultBase & {

type: typeof passkeyWalletSignMessageResultType;

message: string;

signature: `0x${string}`;

};

PasskeyWalletSignTypedDataPopupInput

Definition

export type PasskeyWalletSignTypedDataPopupInput = PasskeyWalletRemotePopupInput & {

address: `0x${string}`;

typedData: PasskeyWalletTypedData;

};

PasskeyWalletSignTypedDataRequest

Definition

export type PasskeyWalletSignTypedDataRequest = PasskeyWalletRemoteRequestBase & {

type: typeof passkeyWalletSignTypedDataType;

address: `0x${string}`;

typedData: PasskeyWalletTypedData;

};

PasskeyWalletSignTypedDataResult

Definition

export type PasskeyWalletSignTypedDataResult = PasskeyWalletRemoteResultBase & {

type: typeof passkeyWalletSignTypedDataResultType;

typedData: PasskeyWalletTypedData;

signature: `0x${string}`;

};

PasskeyWalletTransaction

Definition

export type PasskeyWalletTransaction = {

from: `0x${string}`;

to: `0x${string}`;

data?: `0x${string}`;

value?: `0x${string}`;

gas?: `0x${string}`;

gasPrice?: `0x${string}`;

maxFeePerGas?: `0x${string}`;

maxPriorityFeePerGas?: `0x${string}`;

nonce?: `0x${string}`;

};

PasskeyWalletTypedData

Definition

export type PasskeyWalletTypedData = {

domain: Record<string, unknown>;

types: Record<string, ReadonlyArray<{

name: string;

type: string;

}>>;

primaryType: string;

message: Record<string, unknown>;

};

assertPasskeyWalletSignMessageResult

Retrouve le signataire à partir de la signature, afin qu'une réponse falsifiée soit rejetée. Cela ne fonctionne que pour les signatures d'EOA, que produit le portefeuille.

Signature

assertPasskeyWalletSignMessageResult: (input: {

result: PasskeyWalletSignMessageResult;

address: `0x${string}`;

chainId: number;

message: string;

}) => Promise<void>

Paramètres

Nom	Type	Description
input	{ result: PasskeyWalletSignMessageResult; address: `0x${string}`; chainId: number; message: string; }	La réponse, et l'adresse, la chaîne et le message de la requête.

assertPasskeyWalletSignTypedDataResult

Retrouve le signataire à partir de la signature, afin qu'une réponse falsifiée soit rejetée.

Signature

assertPasskeyWalletSignTypedDataResult: (input: {

result: PasskeyWalletSignTypedDataResult;

address: `0x${string}`;

chainId: number;

typedData: PasskeyWalletTypedData;

}) => Promise<void>

Paramètres

Nom	Type	Description
input	{ result: PasskeyWalletSignTypedDataResult; address: `0x${string}`; chainId: number; typedData: PasskeyWalletTypedData; }	La réponse, et l'adresse, la chaîne et les données typées de la requête.

buildPasskeyWalletRemotePopupUrl

Toute requête autre que la connexion est ensuite transmise par postMessage. Le portefeuille lit l'origine demandeuse dans le MessageEvent authentifié par le navigateur, au lieu de faire confiance au appOrigin écrit dans l'URL, et aucun message, aucune transaction ni aucun secret ne se retrouve dans une URL.

Signature

buildPasskeyWalletRemotePopupUrl: (input: PasskeyWalletRemotePopupInput & {

type: PasskeyWalletRemoteRequestType;

address?: `0x${string}`;

}) => URL

Paramètres

Nom	Type	Description
input	PasskeyWalletRemotePopupInput & { type: PasskeyWalletRemoteRequestType; address?: `0x${string}`; }	La requête, avec son type et son adresse.

isPasskeyWalletRemoteRequestPayloadMessage

Le domaine de la requête doit être l'hôte de son appOrigin. Le portefeuille doit encore comparer appOrigin à l'origine du MessageEvent, que le navigateur authentifie.

Signature

isPasskeyWalletRemoteRequestPayloadMessage: (value: unknown, expectedRequestId?: string) => value is PasskeyWalletRemoteRequestPayloadMessage

Paramètres

Nom	Type	Description
value	unknown	Les données du message.
expectedRequestId	string	L'identifiant de la requête attendue, s'il est connu.

isPasskeyWalletTransaction

Signature

isPasskeyWalletTransaction: (value: unknown) => value is PasskeyWalletTransaction

Paramètres

Nom	Type	Description
value	unknown	La valeur à vérifier.

parsePasskeyWalletRemoteRequest

Rejette les requêtes de chiffrement et de déchiffrement, qui doivent être transmises par postMessage, ainsi que les requêtes dont le domaine n'est pas l'hôte de leur appOrigin.

Signature

parsePasskeyWalletRemoteRequest: (params: URLSearchParams) => PasskeyWalletRemoteRequest

Paramètres

Nom	Type	Description
params	URLSearchParams	Les paramètres d'URL.

parsePasskeyWalletTypedData

Signature

parsePasskeyWalletTypedData: (value: unknown) => PasskeyWalletTypedData

Paramètres

Nom	Type	Description
value	unknown	Les données typées, ou leur JSON.

requestPasskeyWalletConnect

Signature

requestPasskeyWalletConnect: (input: PasskeyWalletConnectPopupInput & {

timeoutMs?: number;

}) => Promise<PasskeyWalletConnectResult>

Paramètres

Nom	Type	Description
input	PasskeyWalletConnectPopupInput & { timeoutMs?: number; }	La requête, et un délai d'expiration, 5 minutes par défaut.

Retourne

Type	Description
Promise<PasskeyWalletConnectResult>	La réponse, avec l'adresse choisie par l'utilisateur.

requestPasskeyWalletDecryptPayload

Signature

requestPasskeyWalletDecryptPayload: (input: PasskeyWalletRemotePopupInput & {

address: `0x${string}`;

encryptedPayload: WalletEncryptedPayload;

timeoutMs?: number;

}) => Promise<PasskeyWalletDecryptPayloadResult>

Paramètres

Nom	Type	Description
input	PasskeyWalletRemotePopupInput & { address: `0x${string}`; encryptedPayload: WalletEncryptedPayload; timeoutMs?: number; }	La requête, l'adresse, le contenu chiffré et un délai d'expiration, 5 minutes par défaut.

Retourne

Type	Description
Promise<PasskeyWalletDecryptPayloadResult>	La réponse, avec le texte déchiffré.

requestPasskeyWalletEncryptPayload

Signature

requestPasskeyWalletEncryptPayload: (input: PasskeyWalletRemotePopupInput & {

address: `0x${string}`;

plaintext: string;

timeoutMs?: number;

}) => Promise<PasskeyWalletEncryptPayloadResult>

Paramètres

Nom	Type	Description
input	PasskeyWalletRemotePopupInput & { address: `0x${string}`; plaintext: string; timeoutMs?: number; }	La requête, l'adresse, le texte et un délai d'expiration, 5 minutes par défaut.

Retourne

Type	Description
Promise<PasskeyWalletEncryptPayloadResult>	La réponse, avec le contenu chiffré.

requestPasskeyWalletSignMessage

La réponse est vérifiée avec assertPasskeyWalletSignMessageResult().

Signature

requestPasskeyWalletSignMessage: (input: PasskeyWalletSignMessagePopupInput & {

timeoutMs?: number;

}) => Promise<PasskeyWalletSignMessageResult>

Paramètres

Nom	Type	Description
input	PasskeyWalletSignMessagePopupInput & { timeoutMs?: number; }	La requête, l'adresse, le message et un délai d'expiration, 5 minutes par défaut.

Retourne

Type	Description
Promise<PasskeyWalletSignMessageResult>	La réponse, avec la signature.

stringifyPasskeyWalletTypedData

Signature

stringifyPasskeyWalletTypedData: (typedData: PasskeyWalletTypedData) => string

Paramètres

Nom	Type	Description
typedData	PasskeyWalletTypedData	Les données typées.

passkeyWalletConnectResultType

Definition

const passkeyWalletConnectResultType = "organigram:wallet:connect-result"

passkeyWalletConnectType

Definition

const passkeyWalletConnectType = "organigram:wallet:connect"

passkeyWalletDecryptPayloadResultType

Definition

const passkeyWalletDecryptPayloadResultType = "organigram:wallet:decrypt-payload-result"

passkeyWalletDecryptPayloadType

Definition

const passkeyWalletDecryptPayloadType = "organigram:wallet:decrypt-payload"

passkeyWalletEncryptPayloadResultType

Definition

const passkeyWalletEncryptPayloadResultType = "organigram:wallet:encrypt-payload-result"

passkeyWalletEncryptPayloadType

Definition

const passkeyWalletEncryptPayloadType = "organigram:wallet:encrypt-payload"

passkeyWalletRemoteErrorResultType

Definition

const passkeyWalletRemoteErrorResultType = "organigram:wallet:remote-error"

passkeyWalletRemoteRequestPayloadType

Definition

const passkeyWalletRemoteRequestPayloadType = "organigram:wallet:request-payload"

passkeyWalletSendTransactionResultType

Definition

const passkeyWalletSendTransactionResultType = "organigram:wallet:send-transaction-result"

passkeyWalletSendTransactionType

Definition

const passkeyWalletSendTransactionType = "organigram:wallet:send-transaction"

passkeyWalletSignMessageResultType

Definition

const passkeyWalletSignMessageResultType = "organigram:wallet:sign-message-result"

passkeyWalletSignMessageType

Definition

const passkeyWalletSignMessageType = "organigram:wallet:sign-message"

passkeyWalletSignTypedDataResultType

Definition

const passkeyWalletSignTypedDataResultType = "organigram:wallet:sign-typed-data-result"

passkeyWalletSignTypedDataType

Definition

const passkeyWalletSignTypedDataType = "organigram:wallet:sign-typed-data"

getAcceptedWalletOrigins

Signature

getAcceptedWalletOrigins: (walletOrigin: string) => string[]

getLocalWalletOrigin

Signature

getLocalWalletOrigin: (walletOrigin: string) => string | null

isLocalWalletOriginOf

Signature

isLocalWalletOriginOf: (localWalletOrigin: string, walletOrigin: string) => boolean

postToWalletPopup

Signature

postToWalletPopup: (popup: Window, message: unknown, walletOrigin: string) => void

rememberWalletOrigin

Signature

rememberWalletOrigin: (walletOrigin: string, answeringOrigin: string) => void

toPreferredWalletUrl

Signature

toPreferredWalletUrl: (url: URL) => URL

watchLocalWalletPopup

Signature

watchLocalWalletPopup: (input: {

popup: Window;

popupUrl: URL;

walletOrigin: string;

requestId: string;

timeoutMs?: number;

}) => (() => void)

localWalletOptOutParam

Definition

const localWalletOptOutParam = "localWallet"

officialLocalWalletOrigin

Un portefeuille peut avoir une copie locale : le même portefeuille exécuté sur la machine de l'utilisateur, servi sous un sous-domaine de l'hôte du portefeuille, afin qu'il déverrouille les mêmes passkeys. Une application qui fait confiance au portefeuille fait alors aussi confiance à cette copie. La copie du portefeuille officiel est pnpm dev local-organigram; un autre déploiement déclare la sienne via NEXT_PUBLIC_ORGANIGRAM_PASSKEY_WALLET_LOCAL_URL.

Definition

const officialLocalWalletOrigin = "https://local.wallet.organigram.ai:3002"

officialWalletOrigin

Definition

const officialWalletOrigin = "https://wallet.organigram.ai"

passkeyWalletLocalHandoffType

Definition

const passkeyWalletLocalHandoffType = "organigram:wallet:local-handoff"

passkeyWalletReadyType

Definition

const passkeyWalletReadyType = "organigram:wallet:ready"

Se connecter

Les utilisateurs se connectent à une application avec Sign-In with Ethereum. L'application émet un message avec un nonce venant de son serveur, le portefeuille le signe dans une popup, et le serveur vérifie la signature, le domaine et le nonce avant d'ouvrir une session. Avec NextAuth, signInWithPasskeyWallet() exécute tout le parcours dans le navigateur, et authorizePasskeyWalletCredentials() vérifie le résultat dans un fournisseur d'identifiants.

PasskeyWalletPopupInput

Definition

export type PasskeyWalletPopupInput = {

walletOrigin?: string;

appOrigin?: string;

nonce: string;

chainId: number;

requestId?: string;

requestedAt?: string;

popup?: Window | null;

};

PasskeyWalletStackSessionChangedMessage

Definition

export type PasskeyWalletStackSessionChangedMessage = {

type: typeof passkeyWalletStackSessionChangedType;

version: 1;

event: 'revoked';

appOrigin: string;

address: `0x${string}` | null;

};

SignInWithPasskeyWalletInput

Definition

export type SignInWithPasskeyWalletInput = {

chainId?: number;

walletOrigin?: string;

getCsrfToken: () => Promise<string | null | undefined>;

requestWalletSignIn?: (input: WalletSignInInput) => Promise<PasskeyWalletSignInResult>;

submitCredentials?: SubmitCredentials;

};

buildPasskeyWalletSignInPopupUrl

Signature

buildPasskeyWalletSignInPopupUrl: (input: PasskeyWalletPopupInput) => URL

Paramètres

Nom	Type	Description
input	PasskeyWalletPopupInput	La requête de connexion.

createPasskeyWalletStackSessionChangedMessage

Signature

createPasskeyWalletStackSessionChangedMessage: (input: {

event: "revoked";

appOrigin: string;

address?: `0x${string}` | null;

}) => PasskeyWalletStackSessionChangedMessage

Paramètres

Nom	Type	Description
input	{ event: "revoked"; appOrigin: string; address?: `0x${string}` | null; }	L'événement, l'origine de l'application et l'adresse de la session.

notifyCurrentTabNextAuthSessionChanged

Signature

notifyCurrentTabNextAuthSessionChanged: () => void

notifyPasskeyWalletStackSessionChanged

Signature

notifyPasskeyWalletStackSessionChanged: (input: {

event: "revoked";

appOrigin: string;

address?: `0x${string}` | null;

targetOrigin?: string;

}) => void

Paramètres

Nom	Type	Description
input	{ event: "revoked"; appOrigin: string; address?: `0x${string}` | null; targetOrigin?: string; }	L'événement, l'origine de l'application, l'adresse de la session et l'origine à laquelle transmettre, par défaut celle de l'application.

parsePasskeyWalletStackSessionChangedMessage

Vérifiez aussi l'origine du MessageEvent qui le transporte : ne faites confiance qu'aux messages du portefeuille.

Signature

parsePasskeyWalletStackSessionChangedMessage: (value: unknown) => PasskeyWalletStackSessionChangedMessage | null

Paramètres

Nom	Type	Description
value	unknown	Les données du message.

Retourne

Type	Description
PasskeyWalletStackSessionChangedMessage | null	Le message, ou null si elle est invalide.

requestPasskeyWalletSignIn

N'accepte que les réponses de l'origine du portefeuille et de sa copie locale, pour cette requête. Le résultat n'est pas vérifié : le serveur doit le vérifier avec verifyPasskeyWalletSiwe().

Signature

requestPasskeyWalletSignIn: (input: PasskeyWalletPopupInput & {

timeoutMs?: number;

}) => Promise<PasskeyWalletSignInResult>

Paramètres

Nom	Type	Description
input	PasskeyWalletPopupInput & { timeoutMs?: number; }	La requête de connexion, et un délai d'expiration, 5 minutes par défaut.

Retourne

Type	Description
Promise<PasskeyWalletSignInResult>	Le message signé.

signInWithPasskeyWallet

Ouvre la popup du portefeuille, utilise le jeton CSRF comme nonce du message Sign-In with Ethereum, et soumet le message signé au fournisseur d'identifiants NextAuth, qui le vérifie avec authorizePasskeyWalletCredentials().

Signature

signInWithPasskeyWallet: (input: SignInWithPasskeyWalletInput) => Promise<PasskeyWalletSignInResult>

Paramètres

Nom	Type	Description
input	SignInWithPasskeyWalletInput	La fonction d'obtention du jeton CSRF, la chaîne et l'origine du portefeuille.

Retourne

Type	Description
Promise<PasskeyWalletSignInResult>	Le message signé.

passkeyWalletStackSessionChangedType

Definition

const passkeyWalletStackSessionChangedType = "organigram:wallet:stack-session-changed"

submitPasskeyWalletCredentials

Definition

const submitPasskeyWalletCredentials: SubmitCredentials

AuthorizePasskeyWalletCredentialsInput

Definition

export type AuthorizePasskeyWalletCredentialsInput = {

credentials: PasskeyWalletNextAuthCredentials | undefined;

domain: string;

nonce: string | null | undefined;

chain?: Chain;

transportUrl: string;

transportOptions?: Parameters<typeof import('viem').http>[1];

};

PasskeyWalletNextAuthCredentials

Definition

export type PasskeyWalletNextAuthCredentials = {

message?: unknown;

signature?: unknown;

csrfToken?: unknown;

};

authorizePasskeyWalletCredentials

Rejette les identifiants sans message, signature ou nonce, puis les vérifie avec verifyPasskeyWalletSiwe(). Le nonce est le jeton CSRF de la session, que signInWithPasskeyWallet() place dans le message.

Signature

authorizePasskeyWalletCredentials: (input: AuthorizePasskeyWalletCredentialsInput) => Promise<PasskeyWalletVerifiedSiwe | null>

Paramètres

Nom	Type	Description
input	AuthorizePasskeyWalletCredentialsInput	Les identifiants, le domaine et le nonce de l'application, et un point d'accès RPC.

Retourne

Type	Description
Promise<PasskeyWalletVerifiedSiwe | null>	La connexion vérifiée, ou null.

PasskeyWalletChallenge

Definition

export type PasskeyWalletChallenge = {

domain: string;

nonce: string;

issuedAt: string;

expiresAt: string;

message: string;

};

PasskeyWalletVerifiedSiwe

Definition

export type PasskeyWalletVerifiedSiwe = {

address: `0x${string}`;

chainId: number;

domain: string;

uri: string;

nonce: string;

encryptionPublicKeyResource: WalletEncryptionPublicKeySiweResource | null;

};

PasskeyWalletVerifySiweInput

Definition

export type PasskeyWalletVerifySiweInput = {

message: string;

signature: Hex;

domain: string;

nonce: string;

chain?: Chain;

transportUrl: string;

transportOptions?: Parameters<typeof http>[1];

};

buildPasskeyWalletPopupUrl

Signature

buildPasskeyWalletPopupUrl: (input: {

walletOrigin: string;

domain: string;

challengeUrl: string;

requestId?: string;

requestedAt?: string;

returnUrl?: string;

}) => URL

Paramètres

Nom	Type	Description
input	{ walletOrigin: string; domain: string; challengeUrl: string; requestId?: string; requestedAt?: string; returnUrl?: string; }	L'origine du portefeuille, le domaine de l'application, son URL de défi, et éventuellement l'identifiant de la requête, la date et l'URL de retour.

createPasskeyWalletChallenge

Stockez le nonce sur le serveur, par exemple dans la session, et vérifiez-le avec verifyPasskeyWalletSiwe().

Signature

createPasskeyWalletChallenge: (input: {

request: Request;

address: `0x${string}`;

chainId: number;

encryptionPublicKeyResource?: string;

nonce?: string;

now?: Date;

statement?: string;

uri?: string;

}) => PasskeyWalletChallenge

Paramètres

Nom	Type	Description
input	{ request: Request; address: `0x${string}`; chainId: number; encryptionPublicKeyResource?: string; nonce?: string; now?: Date; statement?: string; uri?: string; }	La requête, l'adresse et la chaîne, et éventuellement la ressource de clé publique issue de createWalletEncryptionPublicKeySiweResource(), un nonce, la date courante, une déclaration et l'URI de l'application, par défaut l'origine de la requête.

createPasskeyWalletManifest

Signature

createPasskeyWalletManifest: (request: Request) => PasskeyWalletManifest

Paramètres

Nom	Type	Description
request	Request	La requête du manifeste.

getPasskeyWalletCorsAllowedOrigins

Autorise le portefeuille officiel et sa copie locale, le portefeuille configuré et sa copie locale, les autres origines configurées et, quand l'application tourne sur localhost, le portefeuille servi sur le port 3002 du même hôte.

Signature

getPasskeyWalletCorsAllowedOrigins: (input: {

request: Request;

walletUrl?: string;

allowedOrigins?: string;

}) => string[]

Paramètres

Nom	Type	Description
input	{ request: Request; walletUrl?: string; allowedOrigins?: string; }	La requête, l'URL du portefeuille configuré et les autres origines autorisées, séparées par des virgules.

getPasskeyWalletCorsOrigin

Signature

getPasskeyWalletCorsOrigin: (input: {

request: Request;

walletUrl?: string;

allowedOrigins?: string;

}) => string | null

Paramètres

Nom	Type	Description
input	{ request: Request; walletUrl?: string; allowedOrigins?: string; }	La requête, l'URL du portefeuille configuré et les autres origines autorisées, séparées par des virgules.

Retourne

Type	Description
string | null	L'origine, ou null.

getPasskeyWalletRequestOrigin

Les clients peuvent définir ces en-têtes. Ne vous fiez au résultat que derrière un proxy qui les écrase.

Signature

getPasskeyWalletRequestOrigin: (request: Request) => string

Paramètres

Nom	Type	Description
request	Request	La requête.

isWalletSignInOriginAllowed

Signature

isWalletSignInOriginAllowed: (origin: string, allowedOrigins: readonly string[]) => boolean

Paramètres

Nom	Type	Description
origin	string	L'origine à vérifier.
allowedOrigins	readonly string[]	Les origines autorisées.

verifyPasskeyWalletSiwe

Vérifie avec viem la signature, le domaine, le nonce et les dates de validité du message. Ne passez jamais un domaine ou un nonce vide : viem ignore alors leur vérification. Vérifiez que le nonce est celui que l'application a émis pour cette session, et ne l'utilisez qu'une fois.

Signature

verifyPasskeyWalletSiwe: (input: PasskeyWalletVerifySiweInput) => Promise<PasskeyWalletVerifiedSiwe | null>

Paramètres

Nom	Type	Description
input	PasskeyWalletVerifySiweInput	Le message, la signature, le domaine et le nonce attendus, et un point d'accès RPC.

Retourne

Type	Description
Promise<PasskeyWalletVerifiedSiwe | null>	La connexion vérifiée, ou null si le message est invalide.

withPasskeyWalletCorsHeaders

Signature

withPasskeyWalletCorsHeaders: <Response extends {

headers: Headers;

}>(request: Request, response: Response, options?: {

allowedMethods?: string;

walletUrl?: string;

allowedOrigins?: string;

}) => Response

Paramètres

Nom	Type	Description
request	Request	La requête.
response	Response	La réponse, renvoyée avec ses en-têtes modifiés.
options	{ allowedMethods?: string; walletUrl?: string; allowedOrigins?: string; }	Méthodes autorisées, GET, OPTIONS par défaut, l'URL du portefeuille configuré et les autres origines autorisées.

PasskeyWalletErrorResult

Definition

export type PasskeyWalletErrorResult = {

type: typeof passkeyWalletErrorType;

version: 1;

requestId: string;

code: 'user_rejected' | 'challenge_unavailable' | 'domain_mismatch' | 'wallet_locked' | 'unsupported_origin' | 'internal_error';

message: string;

};

PasskeyWalletManifest

Definition

export type PasskeyWalletManifest = {

version: 1;

domain: string;

signInChallengeUrl: string;

signInCompletionUrl?: string;

};

PasskeyWalletSignInRequest

Definition

export type PasskeyWalletSignInRequest = {

type: typeof passkeyWalletSignInType;

version: 1;

requestId: string;

domain: string;

challengeUrl: string;

returnUrl?: string;

requestedAt: string;

};

PasskeyWalletSignInResult

Definition

export type PasskeyWalletSignInResult = {

type: typeof passkeyWalletSignInResultType;

version: 1;

requestId: string;

domain: string;

address: `0x${string}`;

message: string;

signature: `0x${string}`;

completedAt: string;

};

assertSignInDomainMatches

Signature

assertSignInDomainMatches: (message: string, expectedDomain: string) => void

Paramètres

Nom	Type	Description
message	string	Le message.
expectedDomain	string	Le domaine de la requête.

parsePasskeyWalletSignInRequest

L'URL de défi doit utiliser HTTPS et appartenir au domaine demandé ou à l'un de ses sous-domaines, et l'URL de retour doit utiliser HTTPS, afin que le portefeuille ne signe que des messages récupérés auprès de l'application qui les demande.

Signature

parsePasskeyWalletSignInRequest: (params: URLSearchParams) => PasskeyWalletSignInRequest

Paramètres

Nom	Type	Description
params	URLSearchParams	Les paramètres d'URL.

resolveSiweDomain

Signature

resolveSiweDomain: (message: string) => string

Paramètres

Nom	Type	Description
message	string	Le message.

validatePasskeyWalletManifest

Le domaine du manifeste doit être l'hôte qui le sert, et ses URL doivent utiliser HTTPS et appartenir à ce domaine ou à ses sous-domaines.

Signature

validatePasskeyWalletManifest: (manifest: unknown, servingHost: string) => PasskeyWalletManifest

Paramètres

Nom	Type	Description
manifest	unknown	Le manifeste, analysé depuis le JSON.
servingHost	string	L'hôte depuis lequel le manifeste a été récupéré.

passkeyWalletErrorType

Definition

const passkeyWalletErrorType = "organigram:wallet:error"

passkeyWalletSignInResultType

Definition

const passkeyWalletSignInResultType = "organigram:wallet:sign-in-result"

passkeyWalletSignInType

Definition

const passkeyWalletSignInType = "organigram:wallet:sign-in"

Coffres à passkeys

Le portefeuille est un compte Ethereum standard dérivé d'une phrase de récupération BIP-39. La phrase de récupération est chiffrée dans un coffre avec AES-256-GCM, sous une clé dérivée de la sortie PRF d'une passkey WebAuthn, afin que seule cette passkey puisse la déchiffrer. Un portefeuille peut avoir plusieurs passkeys, chacune avec son propre coffre. Ces fonctions s'exécutent dans l'application du portefeuille : un portefeuille déverrouillé garde en mémoire la phrase de récupération et les clés, ne l'y gardez donc que le temps nécessaire, et ne le stockez, ne l'envoyez ni ne le journalisez jamais.

BrowserPasskeyWalletVaultPayload

Contient la phrase de récupération en clair : ne la stockez, ne l'envoyez ni ne la journalisez jamais hors d'une enveloppe chiffrée.

Definition

export type BrowserPasskeyWalletVaultPayload = {

version: 1;

recoveryPhrase: string;

walletEncryptionKey?: WalletEncryptionKeyPairPayload;

};

PasskeyPrfCredential

Definition

export type PasskeyPrfCredential = {

credentialId: string;

transports?: string[];

prfSalt: string;

};

createBrowserPasskeyWalletVaultPayload

Signature

createBrowserPasskeyWalletVaultPayload: (recoveryPhrase: string) => Promise<BrowserPasskeyWalletVaultPayload>

Paramètres

Nom	Type	Description
recoveryPhrase	string	La phrase de récupération du portefeuille.

createGeneratedRecoveryPhrase

Signature

createGeneratedRecoveryPhrase: () => string

decryptVaultPayloadWithPrfOutput

Ne met pas à zéro la sortie PRF, afin que l'appelant puisse essayer plusieurs enveloppes avec. Mettez-la à zéro une fois terminé.

Signature

decryptVaultPayloadWithPrfOutput: (input: {

envelope: PasskeyVaultEnvelopeData;

prfOutput: Uint8Array;

}) => Promise<BrowserPasskeyWalletVaultPayload>

Paramètres

Nom	Type	Description
input	{ envelope: PasskeyVaultEnvelopeData; prfOutput: Uint8Array; }	L'enveloppe et la sortie PRF.

derivePasskeyWalletAccount

Signature

derivePasskeyWalletAccount: (input: {

wallet: UnlockedPasskeyWallet;

account: StoredVaultAccount;

}) => UnlockedPasskeyWallet

Paramètres

Nom	Type	Description
input	{ wallet: UnlockedPasskeyWallet; account: StoredVaultAccount; }	Le portefeuille déverrouillé et le compte à sélectionner.

deriveStoredVaultAccount

Signature

deriveStoredVaultAccount: (input: {

recoveryPhrase: string;

addressIndex: number;

name: string;

}) => StoredVaultAccount

Paramètres

Nom	Type	Description
input	{ recoveryPhrase: string; addressIndex: number; name: string; }	La phrase de récupération, l'index d'adresse et le nom du compte, Account <index + 1> par défaut.

getDerivationPath

Signature

getDerivationPath: (addressIndex: number) => string

Paramètres

Nom	Type	Description
addressIndex	number	L'index d'adresse.

hexEncodeMessage

Signature

hexEncodeMessage: (message: string) => `0x${string}`

Paramètres

Nom	Type	Description
message	string	Le message.

parseBrowserPasskeyWalletVaultPayload

Signature

parseBrowserPasskeyWalletVaultPayload: (plaintext: string) => BrowserPasskeyWalletVaultPayload

Paramètres

Nom	Type	Description
plaintext	string	Le contenu déchiffré, en JSON.

registerAdditionalBrowserPasskeyVault

Signature

registerAdditionalBrowserPasskeyVault: (input: {

wallet: UnlockedPasskeyWallet;

name: string;

accounts: StoredVaultAccount[];

rpId?: string;

rpName?: string;

}) => Promise<{

record: StoredVaultRecord;

wallet: UnlockedPasskeyWallet;

}>

Paramètres

Nom	Type	Description
input	{ wallet: UnlockedPasskeyWallet; name: string; accounts: StoredVaultAccount[]; rpId?: string; rpName?: string; }	Le portefeuille déverrouillé, le nom de la passkey, les comptes qu'elle déverrouille et la partie de confiance WebAuthn.

Retourne

Type	Description
Promise<{ record: StoredVaultRecord; wallet: UnlockedPasskeyWallet; }>	Le nouvel enregistrement de coffre et le portefeuille, désormais rattaché à la nouvelle passkey.

registerBrowserPasskeyVault

Demande au navigateur de créer une passkey détectable avec vérification de l'utilisateur et l'extension PRF. La phrase de récupération est chiffrée avec une clé dérivée de la sortie PRF, qui est ensuite mise à zéro. Stockez l'enregistrement renvoyé, qui ne contient aucun secret en clair, et ne gardez le portefeuille déverrouillé qu'en mémoire.

Signature

registerBrowserPasskeyVault: (input: {

recoveryPhrase: string;

name: string;

rpId?: string;

rpName?: string;

}) => Promise<{

record: StoredVaultRecord;

wallet: UnlockedPasskeyWallet;

}>

Paramètres

Nom	Type	Description
input	{ recoveryPhrase: string; name: string; rpId?: string; rpName?: string; }	La phrase de récupération, le nom du portefeuille, l'identifiant de la partie de confiance WebAuthn, par défaut le nom d'hôte courant, et le nom de la partie de confiance.

Retourne

Type	Description
Promise<{ record: StoredVaultRecord; wallet: UnlockedPasskeyWallet; }>	L'enregistrement de coffre et le portefeuille déverrouillé, sur son premier compte.

requestPasskeyPrfOutput

Signature

requestPasskeyPrfOutput: (input: {

credentials: PasskeyPrfCredential[];

rpId?: string;

}) => Promise<{

credentialId: string;

prfOutput: Uint8Array;

}>

signPersonalMessage

Signature

signPersonalMessage: (input: {

wallet: UnlockedPasskeyWallet;

message: string;

}) => Promise<`0x${string}`>

Paramètres

Nom	Type	Description
input	{ wallet: UnlockedPasskeyWallet; message: string; }	Le portefeuille déverrouillé et le message.

signTypedDataMessage

Signature

signTypedDataMessage: (input: {

wallet: UnlockedPasskeyWallet;

typedData: PasskeyWalletTypedData;

}) => Promise<`0x${string}`>

Paramètres

Nom	Type	Description
input	{ wallet: UnlockedPasskeyWallet; typedData: PasskeyWalletTypedData; }	Le portefeuille déverrouillé et les données typées.

unlockBrowserPasskeyVault

Demande à l'utilisateur de choisir l'une des passkeys des enregistrements, avec vérification de l'utilisateur. Les coffres de cette passkey sont essayés tour à tour, et le premier dont la phrase de récupération dérive l'adresse de son enregistrement est déverrouillé. La sortie PRF est mise à zéro.

Signature

unlockBrowserPasskeyVault: (input: {

records: StoredVaultRecord[];

rpId?: string;

}) => Promise<{

record: StoredVaultRecord;

wallet: UnlockedPasskeyWallet;

}>

Paramètres

Nom	Type	Description
input	{ records: StoredVaultRecord[]; rpId?: string; }	Les enregistrements de coffres parmi lesquels choisir, et l'identifiant de la partie de confiance WebAuthn, par défaut le nom d'hôte courant.

Retourne

Type	Description
Promise<{ record: StoredVaultRecord; wallet: UnlockedPasskeyWallet; }>	L'enregistrement déverrouillé et le portefeuille, sur le premier compte de l'enregistrement.

updateStaticPasskeyVaultEncryptionKey

Demande une passkey à l'utilisateur, et conserve le sel PRF du coffre. Stockez l'enregistrement renvoyé à la place de l'ancien.

Signature

updateStaticPasskeyVaultEncryptionKey: (input: {

records: StoredVaultRecord[];

walletEncryptionKey: WalletEncryptionKeyPairPayload;

rpId?: string;

}) => Promise<{

record: StoredVaultRecord;

wallet: UnlockedPasskeyWallet;

}>

Paramètres

Nom	Type	Description
input	{ records: StoredVaultRecord[]; walletEncryptionKey: WalletEncryptionKeyPairPayload; rpId?: string; }	Les enregistrements de coffres parmi lesquels choisir, la nouvelle paire de clés et l'identifiant de la partie de confiance WebAuthn.

Retourne

Type	Description
Promise<{ record: StoredVaultRecord; wallet: UnlockedPasskeyWallet; }>	L'enregistrement rechiffré et le portefeuille déverrouillé.

PasskeyVaultEnvelopeData

L'enveloppe ne contient aucun secret : elle peut être stockée n'importe où, car seule la passkey qui l'a créée peut la déchiffrer.

Definition

export type PasskeyVaultEnvelopeData = {

algorithm: typeof passkeyVaultAlgorithm;

keyVersion: typeof passkeyVaultKeyVersion;

ciphertext: string;

salt: string;

prfSalt: string;

nonce: string;

};

base64UrlToBytes

N'accepte que du base64url canonique sans remplissage. Les décodeurs tolérants ignorent silencieusement les caractères inconnus : une valeur altérée pourrait sinon se décoder en d'autres octets que ceux qu'elle semble encoder.

Signature

base64UrlToBytes: (value: string) => Uint8Array

Paramètres

Nom	Type	Description
value	string	La valeur à décoder.

bytesToBase64Url

Signature

bytesToBase64Url: (bytes: Uint8Array) => string

Paramètres

Nom	Type	Description
bytes	Uint8Array	Les octets à encoder.

decryptPasskeyVaultSecret

Signature

decryptPasskeyVaultSecret: (input: DecryptPasskeyVaultSecretInput) => Promise<string>

Paramètres

Nom	Type	Description
input	~DecryptPasskeyVaultSecretInput	L'enveloppe et la clé dérivée pour elle.

derivePasskeyVaultKey

La clé ne peut pas être exportée. Une copie de la sortie PRF faite pour l'import est ensuite mise à zéro, mais pas l'original : mettez-le à zéro dès que vous n'en avez plus besoin.

Signature

derivePasskeyVaultKey: (input: DerivePasskeyVaultKeyInput) => Promise<CryptoKey>

Paramètres

Nom	Type	Description
input	~DerivePasskeyVaultKeyInput	La sortie PRF de 32 octets, le sel de 32 octets du coffre et un info HKDF facultatif qui sépare les clés dérivées d'une même sortie PRF pour des usages différents.

encryptPasskeyVaultSecret

Signature

encryptPasskeyVaultSecret: (input: EncryptPasskeyVaultSecretInput) => Promise<PasskeyVaultEnvelopeData>

Paramètres

Nom	Type	Description
input	~EncryptPasskeyVaultSecretInput	Le secret, la clé issue de derivePasskeyVaultKey(), le sel avec lequel elle a été dérivée, le sel PRF de 32 octets et un nonce facultatif de 12 octets, aléatoire par défaut. Ne réutilisez jamais un nonce avec la même clé.

getCrypto

Signature

getCrypto: () => Crypto

hasBase64UrlByteLength

Signature

hasBase64UrlByteLength: (value: unknown, isValidLength: (byteLength: number) => boolean) => boolean

Paramètres

Nom	Type	Description
value	unknown	La valeur à vérifier.
isValidLength	(byteLength: number) => boolean	Test de la longueur décodée, en octets.

isPasskeyPrfSupported

Signature

isPasskeyPrfSupported: (input: {

credential: PrfSupportCredential | null;

}) => Promise<boolean>

Paramètres

Nom	Type	Description
input	{ credential: ~PrfSupportCredential | null; }	L'identifiant renvoyé par navigator.credentials.create().

isPasskeyVaultEnvelope

Signature

isPasskeyVaultEnvelope: (value: unknown) => value is PasskeyVaultEnvelopeData

Paramètres

Nom	Type	Description
value	unknown	La valeur à vérifier.

randomBytes

Signature

randomBytes: (length: number) => Uint8Array

Paramètres

Nom	Type	Description
length	number	Nombre d'octets.

toArrayBuffer

Signature

toArrayBuffer: (bytes: Uint8Array) => ArrayBuffer

Paramètres

Nom	Type	Description
bytes	Uint8Array	Les octets à copier.

passkeyVaultAlgorithm

Definition

const passkeyVaultAlgorithm = "AES-GCM-HKDF-SHA-256"

passkeyVaultKeyVersion

Definition

const passkeyVaultKeyVersion = 2

textDecoder

Definition

const textDecoder: TextDecoder

textEncoder

Definition

const textEncoder: TextEncoder

PasskeyProviderEvent

Definition

export type PasskeyProviderEvent = 'accountsChanged' | 'chainChanged' | 'disconnect';

PasskeyProviderListener

Definition

export type PasskeyProviderListener = (...args: unknown[]) => void;

PasskeyRegistrationResult

Definition

export type PasskeyRegistrationResult = {

address: `0x${string}`;

credentialId: string;

};

UnlockedPasskeyWallet

Il garde en mémoire la phrase de récupération et les clés privées. Ne le gardez en mémoire que le temps nécessaire, et ne le stockez, ne l'envoyez ni ne le journalisez jamais.

Definition

export type UnlockedPasskeyWallet = {

address: `0x${string}`;

account: HDAccount;

recoveryPhrase: string;

walletEncryptionKey?: WalletEncryptionKeyPairPayload;

credentialId: string;

};

organigramPasskeyWalletIcon

Definition

const organigramPasskeyWalletIcon = "/png/logo-gradient.png"

organigramPasskeyWalletId

Definition

const organigramPasskeyWalletId = "organigram-passkeys"

Enregistrements de coffres

Un enregistrement de coffre contient une enveloppe de coffre avec les informations publiques nécessaires pour la déverrouiller : les comptes, la passkey et son appareil. Les enregistrements ne contiennent aucun secret en clair, ils peuvent donc être stockés dans le navigateur ou exportés. Ces fonctions lisent, listent et mettent à jour les enregistrements.

StoredVaultAccount

Definition

export type StoredVaultAccount = {

address: `0x${string}`;

name: string;

addressIndex: number;

derivationPath: string;

};

StoredVaultRecord

Un portefeuille a un enregistrement par passkey capable de le déverrouiller. L'enregistrement ne contient aucun secret en clair : seule sa passkey peut déchiffrer l'enveloppe.

Definition

export type StoredVaultRecord = {

version: 1;

address: `0x${string}`;

accounts: StoredVaultAccount[];

credentialId: string;

rawCredentialId?: string;

name: string;

transports: string[];

passkeyDevice: {

kind: 'macos' | 'ios' | 'ipados' | 'windows' | 'android' | 'linux' | 'security-key' | 'cross-device' | 'platform' | 'passkey';

label: string;

};

createdAt: string;

lastUsedAt: string | null;

envelope: PasskeyVaultEnvelopeData;

};

VaultRegistry

Definition

export type VaultRegistry = {

version: 1;

vaults: StoredVaultRecord[];

};

addAccountToVaultRecords

Signature

addAccountToVaultRecords: (input: {

vaults: StoredVaultRecord[];

sourceAddress: `0x${string}`;

account: StoredVaultAccount;

}) => StoredVaultRecord[]

Paramètres

Nom	Type	Description
input	{ vaults: StoredVaultRecord[]; sourceAddress: `0x${string}`; account: StoredVaultAccount; }	Les enregistrements de coffres, un compte que le portefeuille contient déjà, et le compte à ajouter.

createVaultRegistry

Signature

createVaultRegistry: (vaults: StoredVaultRecord[]) => VaultRegistry

Paramètres

Nom	Type	Description
vaults	StoredVaultRecord[]	Les enregistrements de coffres.

isStoredVaultRecord

Signature

isStoredVaultRecord: (value: unknown) => value is StoredVaultRecord

Paramètres

Nom	Type	Description
value	unknown	La valeur à vérifier.

markVaultRecordUsed

Signature

markVaultRecordUsed: (input: {

vaults: StoredVaultRecord[];

credentialId: string;

usedAt?: string;

}) => StoredVaultRecord[]

Paramètres

Nom	Type	Description
input	{ vaults: StoredVaultRecord[]; credentialId: string; usedAt?: string; }	Les enregistrements de coffres, l'identifiant de la passkey et la date, maintenant par défaut.

parseVaultRegistry

Signature

parseVaultRegistry: (value: unknown) => VaultRegistry

Paramètres

Nom	Type	Description
value	unknown	Le registre, analysé depuis le JSON.

removeAccountFromVaultRecords

Cela ne retire que des enregistrements locaux. Sans coffre restant ni phrase de récupération exportée, le compte ne peut plus être déverrouillé.

Signature

removeAccountFromVaultRecords: (input: {

vaults: StoredVaultRecord[];

address: `0x${string}`;

}) => StoredVaultRecord[]

Paramètres

Nom	Type	Description
input	{ vaults: StoredVaultRecord[]; address: `0x${string}`; }	Les enregistrements de coffres et l'adresse du compte.

removeVaultRecord

Signature

removeVaultRecord: (input: {

vaults: StoredVaultRecord[];

credentialId: string;

}) => StoredVaultRecord[]

Paramètres

Nom	Type	Description
input	{ vaults: StoredVaultRecord[]; credentialId: string; }	Les enregistrements de coffres et l'identifiant de la passkey.

removeVaultRecords

Signature

removeVaultRecords: (input: {

vaults: StoredVaultRecord[];

credentialIds: Set<string>;

}) => StoredVaultRecord[]

Paramètres

Nom	Type	Description
input	{ vaults: StoredVaultRecord[]; credentialIds: Set<string>; }	Les enregistrements de coffres et les identifiants des passkeys.

serializeVaultRegistry

Signature

serializeVaultRegistry: (vaults: StoredVaultRecord[], space?: number) => string

Paramètres

Nom	Type	Description
vaults	StoredVaultRecord[]	Les enregistrements de coffres.
space	number	Indentation du JSON.

upsertVaultRecord

Signature

upsertVaultRecord: (input: {

vaults: StoredVaultRecord[];

record: StoredVaultRecord;

}) => StoredVaultRecord[]

Paramètres

Nom	Type	Description
input	{ vaults: StoredVaultRecord[]; record: StoredVaultRecord; }	Les enregistrements de coffres et l'enregistrement à ajouter.

vaultHasAccount

Signature

vaultHasAccount: (vault: StoredVaultRecord, address: string) => boolean

Paramètres

Nom	Type	Description
vault	StoredVaultRecord	L'enregistrement de coffre.
address	string	L'adresse du compte.

VaultRegistryGroup

Definition

export type VaultRegistryGroup = {

id: string;

accounts: StoredVaultAccount[];

passkeys: StoredVaultRecord[];

createdAt: string;

};

WalletGroup

Definition

export type WalletGroup = {

address: `0x${string}`;

name: string;

addressIndex: number;

derivationPath: string;

passkeys: StoredVaultRecord[];

};

formatAddress

Signature

formatAddress: (address: string) => string

Paramètres

Nom	Type	Description
address	string	L'adresse.

formatCredentialId

Signature

formatCredentialId: (credentialId: string) => string

Paramètres

Nom	Type	Description
credentialId	string	L'identifiant de la passkey.

getNextAddressIndex

Signature

getNextAddressIndex: (records: StoredVaultRecord[]) => number

Paramètres

Nom	Type	Description
records	StoredVaultRecord[]	Les enregistrements de coffres.

getVaultAccount

Signature

getVaultAccount: (vault: StoredVaultRecord, address: string) => StoredVaultAccount | null

Paramètres

Nom	Type	Description
vault	StoredVaultRecord	L'enregistrement de coffre.
address	string	L'adresse du compte.

Retourne

Type	Description
StoredVaultAccount | null	Le compte, ou null.

getVaultRegistryGroupId

Signature

getVaultRegistryGroupId: (vault: StoredVaultRecord) => string

Paramètres

Nom	Type	Description
vault	StoredVaultRecord	L'enregistrement de coffre.

groupVaultRecordsBySeed

Signature

groupVaultRecordsBySeed: (vaults: StoredVaultRecord[]) => VaultRegistryGroup[]

Paramètres

Nom	Type	Description
vaults	StoredVaultRecord[]	Les enregistrements de coffres.

groupVaultsByWallet

Signature

groupVaultsByWallet: (vaults: StoredVaultRecord[]) => WalletGroup[]

Paramètres

Nom	Type	Description
vaults	StoredVaultRecord[]	Les enregistrements de coffres.

mergeVaults

Un enregistrement importé remplace l'enregistrement local de la même passkey.

Signature

mergeVaults: (localVaults: StoredVaultRecord[], importedVaults: StoredVaultRecord[]) => StoredVaultRecord[]

Paramètres

Nom	Type	Description
localVaults	StoredVaultRecord[]	Les enregistrements locaux.
importedVaults	StoredVaultRecord[]	Les enregistrements importés.

Sauvegardes

Les enregistrements de coffres peuvent être sauvegardés sur un serveur. Chaque sauvegarde n'expose que son enveloppe de coffre et l'identifiant de sa passkey : le reste de l'enregistrement est chiffré avec une clé dérivée de la phrase de récupération, si bien que le serveur n'apprend rien au-delà de l'adresse du portefeuille, et que n'importe quelle passkey du portefeuille peut restaurer toutes les sauvegardes.

RemoteVaultBackupPackage

Definition

export type RemoteVaultBackupPackage = {

version: 1;

address: `0x${string}`;

backups: RemoteVaultBackupRecord[];

exportedAt: string;

};

RemoteVaultBackupRecord

Une sauvegarde expose son enveloppe de coffre, que seule sa propre passkey peut déchiffrer, avec l'identifiant de cette passkey. Le reste de l'enregistrement de coffre (adresses des comptes, noms, appareils) est chiffré avec une clé dérivée de la phrase de récupération, si bien que n'importe quelle passkey du portefeuille peut restaurer toutes les sauvegardes, tandis que le serveur n'apprend rien au-delà de l'adresse du portefeuille.

Definition

export type RemoteVaultBackupRecord = {

version: 2;

backupId: string;

credentialId: string;

envelope: PasskeyVaultEnvelopeData;

salt: string;

iv: string;

ciphertext: string;

createdAt: string;

};

createRemoteVaultBackupPackage

Signature

createRemoteVaultBackupPackage: (input: {

address: `0x${string}`;

backups: RemoteVaultBackupRecord[];

}) => RemoteVaultBackupPackage

Paramètres

Nom	Type	Description
input	{ address: `0x${string}`; backups: RemoteVaultBackupRecord[]; }	L'adresse du portefeuille et ses sauvegardes.

createRemoteVaultBackupRecord

La clé de sauvegarde est dérivée par HKDF d'un hash SHA-256 de la phrase de récupération, d'un sel aléatoire et de l'adresse. La phrase de récupération elle-même ne fait jamais partie de la sauvegarde.

Signature

createRemoteVaultBackupRecord: (input: {

address: `0x${string}`;

record: StoredVaultRecord;

recoveryPhrase: string;

}) => Promise<RemoteVaultBackupRecord>

Paramètres

Nom	Type	Description
input	{ address: `0x${string}`; record: StoredVaultRecord; recoveryPhrase: string; }	L'adresse du portefeuille, l'enregistrement de coffre et la phrase de récupération du portefeuille.

createVaultBackupDigest

Signature

createVaultBackupDigest: (backups: RemoteVaultBackupRecord[]) => Promise<string>

Paramètres

Nom	Type	Description
backups	RemoteVaultBackupRecord[]	Les sauvegardes.

Retourne

Type	Description
Promise<string>	L'empreinte, en hexadécimal.

createVaultBackupSignatureMessage

Signature

createVaultBackupSignatureMessage: (input: {

address: `0x${string}`;

vaultCount: number;

digest: string;

}) => string

Paramètres

Nom	Type	Description
input	{ address: `0x${string}`; vaultCount: number; digest: string; }	L'adresse du portefeuille, le nombre de sauvegardes et leur empreinte issue de createVaultBackupDigest().

decryptRemoteVaultBackupRecord

Le résultat n'est pas validé : vérifiez-le avec isStoredVaultRecord() avant de l'utiliser.

Signature

decryptRemoteVaultBackupRecord: (input: {

address: `0x${string}`;

backup: RemoteVaultBackupRecord;

recoveryPhrase: string;

}) => Promise<StoredVaultRecord>

Paramètres

Nom	Type	Description
input	{ address: `0x${string}`; backup: RemoteVaultBackupRecord; recoveryPhrase: string; }	L'adresse du portefeuille, la sauvegarde et la phrase de récupération du portefeuille.

normalizeBackupAddress

Signature

normalizeBackupAddress: (value: string) => `0x${string}`

Paramètres

Nom	Type	Description
value	string	L'adresse.

parseRemoteVaultBackupPackage

Signature

parseRemoteVaultBackupPackage: (value: unknown) => RemoteVaultBackupPackage

Paramètres

Nom	Type	Description
value	unknown	Le paquet, analysé depuis le JSON.

Chiffrement de bout en bout

Chaque portefeuille a une paire de clés ECDH P-256, stockée dans ses coffres, pour chiffrer des fichiers et des textes que lui seul peut déchiffrer. Sa clé publique peut être partagée avec une application dans une ressource Sign-In with Ethereum. Les textes chiffrés pour une application sont liés à l'origine de cette application, si bien qu'une autre application ne peut pas les faire déchiffrer.

WalletDecryptedFile

Definition

export type WalletDecryptedFile = {

name: string;

type: string;

bytes: Uint8Array;

lastModified?: number;

};

WalletEncryptedFilePackage

Definition

export type WalletEncryptedFilePackage = {

version: 1;

kind: 'organigram:wallet-encrypted-file';

algorithm: 'ECDH-P256+A256GCM';

recipient: {

address: `0x${string}`;

publicKey: JsonWebKey;

keyVersion: number;

};

file: {

name: string;

type: string;

size: number;

lastModified?: number;

};

iv: string;

ciphertext: string;

encryptedAt: string;

};

WalletEncryptedPayload

Definition

export type WalletEncryptedPayload = {

version: 1;

kind: 'organigram:wallet-encrypted-payload';

algorithm: 'ECDH-P256+A256GCM';

appOrigin: string;

recipient: {

address: `0x${string}`;

publicKey: JsonWebKey;

keyVersion: number;

};

iv: string;

ciphertext: string;

encryptedAt: string;

};

WalletEncryptionKeyPairPayload

Contient la clé privée en clair : ne la gardez que dans le coffre chiffré et en mémoire, et ne la stockez, ne l'envoyez ni ne la journalisez jamais ailleurs.

Definition

export type WalletEncryptionKeyPairPayload = {

version: 1;

algorithm: 'ECDH-P256';

privateKey: JsonWebKey;

publicKey: JsonWebKey;

keyVersion: number;

};

WalletEncryptionPublicKeySiweResource

Definition

export type WalletEncryptionPublicKeySiweResource = {

kind: typeof encryptionPublicKeyResourceKind;

address: string;

publicKey: JsonWebKey;

keyVersion: number;

};

createWalletEncryptionKeyPair

La clé privée est exportable, afin de pouvoir être stockée dans les coffres à passkeys du portefeuille. Gardez-la là.

Signature

createWalletEncryptionKeyPair: () => Promise<WalletEncryptionKeyPairPayload>

createWalletEncryptionPublicKeySiweResource

Se connecter avec cette ressource permet à l'application d'apprendre la clé publique du portefeuille, liée à son adresse par la signature.

Signature

createWalletEncryptionPublicKeySiweResource: (input: {

address: `0x${string}`;

keyPair: WalletEncryptionKeyPairPayload;

}) => string

Paramètres

Nom	Type	Description
input	{ address: `0x${string}`; keyPair: WalletEncryptionKeyPairPayload; }	L'adresse du portefeuille et sa paire de clés. Seule la clé publique est encodée.

decryptFileWithWalletEncryptionKey

Signature

decryptFileWithWalletEncryptionKey: (input: {

encryptedPackage: WalletEncryptedFilePackage;

keyPair: WalletEncryptionKeyPairPayload;

}) => Promise<WalletDecryptedFile>

Paramètres

Nom	Type	Description
input	{ encryptedPackage: WalletEncryptedFilePackage; keyPair: WalletEncryptionKeyPairPayload; }	Le paquet chiffré et la paire de clés du portefeuille.

decryptPayloadWithWalletEncryptionKey

Signature

decryptPayloadWithWalletEncryptionKey: (input: {

encryptedPayload: WalletEncryptedPayload;

appOrigin: string;

keyPair: WalletEncryptionKeyPairPayload;

}) => Promise<string>

Paramètres

Nom	Type	Description
input	{ encryptedPayload: WalletEncryptedPayload; appOrigin: string; keyPair: WalletEncryptionKeyPairPayload; }	Le contenu chiffré, l'origine de l'application qui le demande, et la paire de clés du portefeuille.

encryptFileWithWalletEncryptionKey

La clé AES-GCM est dérivée par ECDH entre les clés privée et publique de la même paire. Le nom, le type, la taille et la date du fichier restent en clair et ne sont pas authentifiés avec le texte chiffré.

Signature

encryptFileWithWalletEncryptionKey: (input: {

address: `0x${string}`;

file: File;

keyPair: WalletEncryptionKeyPairPayload;

}) => Promise<WalletEncryptedFilePackage>

Paramètres

Nom	Type	Description
input	{ address: `0x${string}`; file: File; keyPair: WalletEncryptionKeyPairPayload; }	L'adresse du portefeuille, le fichier et la paire de clés.

encryptPayloadWithWalletEncryptionKey

L'origine de l'application, l'adresse et la version de clé sont authentifiées avec le texte chiffré, si bien que le contenu ne peut pas être déchiffré pour une autre application ni réétiqueté pour elle.

Signature

encryptPayloadWithWalletEncryptionKey: (input: {

address: `0x${string}`;

appOrigin: string;

plaintext: string;

keyPair: WalletEncryptionKeyPairPayload;

}) => Promise<WalletEncryptedPayload>

Paramètres

Nom	Type	Description
input	{ address: `0x${string}`; appOrigin: string; plaintext: string; keyPair: WalletEncryptionKeyPairPayload; }	L'adresse du portefeuille, l'origine de l'application, le texte et la paire de clés.

parseWalletEncryptedFilePackage

Signature

parseWalletEncryptedFilePackage: (value: unknown) => WalletEncryptedFilePackage

Paramètres

Nom	Type	Description
value	unknown	Le paquet, analysé depuis le JSON.

parseWalletEncryptedPayload

Signature

parseWalletEncryptedPayload: (value: unknown) => WalletEncryptedPayload

Paramètres

Nom	Type	Description
value	unknown	Le contenu, analysé depuis le JSON.

parseWalletEncryptionKeyPair

Signature

parseWalletEncryptionKeyPair: (value: unknown) => WalletEncryptionKeyPairPayload

Paramètres

Nom	Type	Description
value	unknown	La paire de clés, analysée depuis le JSON.

parseWalletEncryptionPublicKeySiweResource

Ne vous fiez au résultat qu'une fois la signature du message vérifiée.

Signature

parseWalletEncryptionPublicKeySiweResource: (input: {

address: string;

resources: string[] | undefined;

}) => WalletEncryptionPublicKeySiweResource | null

Paramètres

Nom	Type	Description
input	{ address: string; resources: string[] | undefined; }	L'adresse qui a signé le message, et les ressources du message.

Retourne

Type	Description
WalletEncryptionPublicKeySiweResource | null	La clé publique, ou null si aucune ressource valide de cette adresse n'est trouvée.