windkit 0.2.2 → 0.2.3

package/CHANGELOG.md

@@ -1,54 +1,91 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+All notable changes to this project are documented in this file.
 
-This project follows Semantic Versioning.
+This project follows [Semantic Versioning](https://semver.org/).
 
 ---
 
-## [0.2.2] - 2026-03-02
+## [0.2.3] - 2026-03-02
+
+Published: 2026-03-02T14:07:04Z
 
 ### Changed
 
 - Session storage key standardized to `"vex-session"`.
-- Login identity request now stores compact app info keys:
-  - `pi` (peer id), `na` (app name), `ic` (icon), `do` (origin), optional `auth` (cached proof).
-- Request method names standardized:
-  - `signRequest`, `signMessage`, `sharedSecret`.
+- Login identity payload compacted with standardized keys:
+  - `pi` (peer id)
+  - `na` (app name)
+  - `ic` (icon)
+  - `do` (origin)
+  - optional `auth` (cached identity proof)
+- RPC method names standardized:
+  - `signRequest`
+  - `signMessage`
+  - `sharedSecret`
 
 ### Added
 
-- `clearSession()` helper.
-- Session reuse:
-  - Reuses saved `peerID` and hints (`account@permission`) when present.
+- `clearSession()` helper for manual session reset.
+- Smart session reuse:
+  - Reuses stored `peerID`
+  - Reuses permission hints (`account@permission`) when available.
 
 ### Fixed
 
-- Safer session loading (auto-clears invalid or expired payloads).
-- Improved cleanup on disconnect (best-effort destroy/disconnect).
+- Hardened session loader:
+  - Automatically clears expired or malformed session payloads.
+- Improved disconnect cleanup:
+  - Safe destroy/disconnect (best-effort, non-throwing).
 
 ### Improved
 
-- Low-memory friendly behavior:
-  - Lightweight heartbeat/ping with jitter (best-effort).
-  - Minimal allocations on message routing.
+- Optimized for low-memory environments:
+  - Lightweight heartbeat with jitter
+  - Reduced message routing allocations
+  - Lower background CPU usage on mobile devices
 
 ---
 
-## [0.2.1]
+## [0.2.1] - 2025-10-13
+
+Published: 2025-10-13T16:28:38Z
 
 ### Added
 
-- Initial PeerJS signaling support.
-- Session persistence via sessionStorage.
-- Transaction signing via VSR.
-- Message signing.
-- Shared secret (ECDH).
+- PeerJS signaling support.
+- Session persistence via `sessionStorage`.
+- Transaction signing via Vexanium Signing Request (VSR).
+- Message signing support.
+- Shared secret derivation (ECDH).
 
 ---
 
-## [0.1.1]
+## [0.2.0] - 2025-10-06
+
+Published: 2025-10-06T14:44:23Z
+
+### Added
+
+- Structured WebRTC connection lifecycle.
+- WalletSession abstraction layer.
+- Basic login flow via embedded PeerID inside VSR.
+- Request/response routing via internal request IDs.
+
+### Improved
+
+- More predictable session initialization flow.
+- Internal protocol normalization groundwork.
+
+---
+
+## [0.1.1] - 2025-08-12
+
+Published: 2025-08-12T01:33:25Z
 
 ### Added
 
 - Initial public release of WindKit.
+- Basic VSR identity login.
+- WebRTC DataConnection integration.
+- Minimal transaction signing flow.

package/README.md

@@ -7,39 +7,46 @@ WindKit is a lightweight WebRTC protocol for connecting Vexanium DApps to Wind W
 
 It enables secure cross-device login and transaction signing without requiring browser extensions.
 
+Designed for production environments, including low-RAM mobile devices.
+
 ---
 
-## Features
+## ✨ Features
 
 - Cross-device login via VSR (Vexanium Signing Request)
 - Transaction signing (single action, multiple actions, or full transaction)
-- Optional broadcast (sign-only or broadcast)
+- Optional broadcast control (sign-only or broadcast)
 - Message signing
 - Shared secret derivation (ECDH)
-- Session persistence via sessionStorage
-- Lightweight keepalive (low memory footprint)
-- Pure ESM module
+- Session persistence via `sessionStorage`
+- Low-memory heartbeat strategy
+- Pure ESM module (JavaScript-only)
 
 ---
 
-## Installation
+## 📦 Installation
 
+```bash
 npm install windkit
+```
 
-WindKit is ESM-only.
+WindKit is **ESM-only**.
 
-Your project must use:
+Your project must include:
 
+```json
 {
   "type": "module"
 }
+```
 
 ---
 
-## Quick Start
+## 🚀 Quick Start
 
 ### Create Connector
 
+```js
 import { WindConnector } from "windkit";
 
 const connector = new WindConnector();
@@ -49,29 +56,37 @@ connector.on("session", (session, proof) => {
 });
 
 await connector.connect();
+```
 
-By default, WindKit relies on PeerJS default signaling behavior (no host/port/path/secure configured).
+By default, WindKit uses PeerJS default signaling.
 
 ---
 
-### Use Your Own PeerJS Server (Optional)
+## 🌐 Custom PeerJS Server (Optional)
 
+```js
 connector.setServer("peer.yourdomain.com", 443, "/", true);
+```
 
 Signature:
 
-setServer(host, port, path, secure)
+```js
+setServer(host, port, path, secure);
+```
 
-Add custom STUN/TURN server:
+Add custom ICE server:
 
+```js
 connector.addIceServer({
   urls: "stun:stun.cloudflare.com:3478"
 });
+```
 
 ---
 
-## Login Flow (VSR)
+## 🔐 Login Flow (VSR)
 
+```js
 const vsr = connector.createLoginRequest(
   "My Vexanium DApp",
   "https://example.com/icon.png"
@@ -83,20 +98,21 @@ window.open(
   `https://wallet.windcrypto.com/login?vsr=${encodeURIComponent(payload)}`,
   "Wind Wallet"
 );
+```
 
 Wallet flow:
 
 1. Decode VSR  
 2. Connect to embedded PeerID  
-3. Send LOGIN_OK  
+3. Send `LOGIN_OK`  
 4. Emit session  
 
 ---
 
-## Session Handling
+## 🔄 Session Handling
 
+```js
 connector.on("session", (session, proof) => {
-
   session.onClose(() => {
     console.log("Wallet disconnected");
   });
@@ -107,13 +123,15 @@ connector.on("session", (session, proof) => {
 
   window.appSession = session;
 });
+```
 
 ---
 
-## Send Transaction
+## ✍️ Send Transaction
 
 ### With ABI Cache (Recommended)
 
+```js
 import { Action } from "@wharfkit/antelope";
 import { ABICache } from "@wharfkit/abicache";
 
@@ -130,7 +148,7 @@ const action = Action.from(
       from: "alice",
       to: "bob",
       quantity: "1.0000 VEX",
-      memo: "test"
+      memo: "WindKit test"
     },
     authorization: [appSession.permissionLevel]
   },
@@ -140,119 +158,145 @@ const action = Action.from(
 const result = await appSession.transact({ action });
 
 console.log(result.transaction_id ?? result.id);
+```
 
 ---
 
 ### Sign Only (No Broadcast)
 
+```js
 await appSession.transact(
   { action },
   { broadcast: false }
 );
+```
 
 ---
 
-## Sign Message
+## 📝 Sign Message
 
+```js
 const signature = await appSession.signMessage("Hello Wind!");
 console.log(signature.toString());
+```
 
 ---
 
-## Shared Secret (ECDH)
+## 🔑 Shared Secret (ECDH)
 
+```js
 import { PublicKey } from "@wharfkit/antelope";
 
 const pub = PublicKey.from("PUB_K1_...");
 const secret = await appSession.sharedSecret(pub);
 
 console.log(secret.toString());
+```
 
 ---
 
-## Session Storage
+## 💾 Session Storage
 
 WindKit stores session data in:
 
+```js
 sessionStorage["vex-session"]
+```
 
 Example structure:
 
+```json
 {
   "peerID": "VEX-xxxx",
   "permission": "account@active",
   "expiration": "2026-03-01T12:00:00",
   "auth": "base64u_identity_proof"
 }
+```
 
-To clear session manually:
+Clear session manually:
 
+```js
 import { clearSession } from "windkit";
 
 clearSession();
+```
 
 ---
 
-## Architecture
+## 🏗 Architecture
+
+### WindConnector
 
-WindConnector
 - Creates VSR identity login
 - Hosts PeerJS PeerID (DApp-side)
 - Waits for wallet connection
 - Emits session
 
-WalletSession
+### WalletSession
+
 - Sends:
-  - signRequest
-  - signMessage
-  - sharedSecret
+  - `signRequest`
+  - `signMessage`
+  - `sharedSecret`
 - Routes replies via request IDs
-- Lightweight keepalive ping
+- Lightweight heartbeat ping
 - Handles account change events
 
 ---
 
-## Protocol Notes
+## 🔎 Protocol Notes
+
+Transaction signing method:
 
-Transaction signing method name:
-"signRequest"
+```
+signRequest
+```
 
 Wallet push events handled:
+
+```
 LOGIN_OK
 ACTIVE_ACCOUNT_CHANGED
+```
 
-All communication occurs via PeerJS DataConnection.
+All communication occurs over PeerJS `DataConnection`.
 
 ---
 
-## Technical Details
+## ⚙ Technical Details
+
+Chain ID is internally fixed via:
 
-Chain ID is fixed internally via:
+```js
 WalletSession.ChainID
+```
+
+Dependencies:
+
+- `@wharfkit/signing-request`
+- `@wharfkit/antelope`
+- `peerjs`
+- `pako`
 
-Uses:
-- @wharfkit/signing-request
-- @wharfkit/antelope
-- peerjs
-- pako (zlib compression)
+Optimized for:
 
-Designed for:
 - Low-RAM mobile devices
-- Background tabs
-- Unstable WebRTC environments
+- Background browser tabs
+- Unstable WebRTC networks
 
 ---
 
-## Security Model
+## 🔐 Security Model
 
 - IdentityProof can be verified by the DApp (recommended).
 - Private keys never leave the wallet.
 - VSR ensures transaction integrity.
-- PeerID is embedded inside VSR to prevent misrouting.
+- PeerID is embedded inside the VSR payload to prevent misrouting.
 
 ---
 
-## License
+## 📄 License
 
 MIT License  
 © Wind Stack

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "windkit",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Lightweight protocol to connect Vexanium DApps to Wind Wallet via PeerJS and VSR.",
   "license": "MIT",
   "author": "windstack",