@virtonetwork/authenticators-webauthn 1.2.4 → 1.2.6

package/README.md

@@ -19,28 +19,93 @@ The implementation is **browser‑only** and keeps all credential mapping in the
 npm i @virtonetwork/authenticators-webauthn
 ```
 
-## 🚀 Quick start
+## Setup
+
+First, initialize the `WebAuthn` authenticator with the user's identifier and a challenger.
+
+```ts
+wa = await new WebAuthn(USERNAME, blockHashChallenger(client)).setup();
+```
+
+## Registration
+
+To register a new credential, call the `register` method. This will trigger the browser's WebAuthn prompt.
+The returned attestation must be submitted to the chain using the `Pass.register` extrinsic.
 
 ```ts
-import { WebAuthn } from "@virtonetwork/authenticators-webauthn";
-import { PassSigner } from "@virtonetwork/signer";
+const finalizedBlock = await client.getFinalizedBlock();
+const attestation = await wa.register(finalizedBlock.number);
+
+const tx = api.tx.Pass.register({
+  user: Binary.fromBytes(wa.hashedUserId),
+  attestation: {
+    type: 'WebAuthn',
+    value: {
+      meta: attestation.meta,
+      authenticator_data: attestation.authenticator_data,
+      client_data: attestation.client_data,
+      public_key: attestation.public_key,
+    },
+  },
+});
+
+await new Promise<void>((resolve, error) => {
+  tx.signSubmitAndWatch(ALICE).subscribe({
+    next: (event) => {
+      if (event.type === 'finalized') {
+        resolve();
+      }
+    },
+    error,
+  });
+});
+```
 
-// 1️⃣  Restore user → credential mapping (from DB, localStorage…)
-const savedId = await db.getCredentialId("alice@example.com");
+## Authentication
 
-// 2️⃣  Bootstrap helper
-const wa = await new WebAuthn("alice@example.com", savedId).setup();
+Once registered, you can use the `WebAuthn` instance to create a `KreivoPassSigner`.
+This signer can then be used to sign transactions, which will trigger the browser's WebAuthn prompt for authentication.
 
-// 3️⃣  Enrol a new pass‑key if needed
-if (!savedId) {
-  const att = await wa.register(blockNumber, blockHash);
-  await db.saveCredentialId("alice@example.com", att.credentialId);
+```ts
+const kreivoPassSigner = new KreivoPassSigner(wa);
+const accountId = ss58Encode(kreivoPassSigner.publicKey, 2);
+
+// Transfer tokens
+{
+  const tx = api.tx.Balances.transfer_keep_alive({
+    dest: { type: 'Id', value: accountId },
+    value: 1_0000000000n,
+  });
+
+  await new Promise<void>((resolve, error) =>
+    tx.signSubmitAndWatch(ALICE).subscribe({
+      next: (event) => {
+        if (event.type === 'finalized') {
+          resolve();
+        }
+      },
+      error,
+    }),
+  );
 }
 
-// 4️⃣  Sign any runtime challenge
-await passSigner.credentials(
-  await wa.authenticate(challenge, blockNumber),
-);
+// Sign remark
+{
+  const remark = Binary.fromText('Hello, Kreivo!');
+  const tx = api.tx.System.remark_with_event({ remark });
+
+  const signedTx = await tx.sign(kreivoPassSigner, {
+    mortality: { mortal: false },
+  });
+  const txBytes = Vector(u8).dec(signedTx);
+
+  const txResult = await api.apis.BlockBuilder.apply_extrinsic(
+    Binary.fromBytes(new Uint8Array(txBytes)),
+  );
+
+  assert(txResult.success);
+  assert(txResult.value.success);
+}
 ```
 
 ## 🛠️ API

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@virtonetwork/authenticators-webauthn",
   "description": "An Authenticator compatible with KreivoPassSigner that uses the WebAuthn standard",
-  "homepage": "https://virtonetwork.github.io/papi-signers/guide/webauthn",
-  "version": "1.2.4",
+  "homepage": "https://virto-network.github.io/papi-signers/guide/webauthn",
+  "version": "1.2.6",
   "type": "module",
   "files": [
     "dist"
@@ -37,7 +37,7 @@
   ],
   "dependencies": {
     "@simplewebauthn/server": "^13.1.1",
-    "@virtonetwork/signer": "^1.3.0",
+    "@virtonetwork/signer": "^1.3.2",
     "nid-webauthn-emulator": "^0.2.4"
   },
   "devDependencies": {