@effectstream/frontend-sdk 0.100.14 → 0.100.15

package/README.md

@@ -0,0 +1,77 @@
+# @effectstream/frontend-sdk
+
+Umbrella name for EffectStream's frontend code. Currently re-exports
+everything from `@effectstream/wallets`. Depend on this if you want a
+stable frontend namespace; import `@effectstream/wallets` directly if
+you prefer.
+
+## Install
+
+```bash
+bun add @effectstream/frontend-sdk
+# or
+npm install @effectstream/frontend-sdk
+```
+
+## Usage
+
+The export surface is exactly `@effectstream/wallets`:
+
+```typescript
+import {
+  allInjectedWallets,
+  walletLogin,
+  WalletMode,
+} from "@effectstream/frontend-sdk";
+
+const available = await allInjectedWallets({
+  signatureSupport: true,
+  transactionSupport: true,
+});
+const evmOption = available[WalletMode.EvmInjected][0];
+
+const { provider, signedLogin } = await walletLogin({
+  preference: { name: evmOption.metadata.name },
+  mode: WalletMode.EvmInjected,
+});
+```
+
+> **Browser only.** Like `@effectstream/wallets`, this package depends
+> on injected wallet APIs (`window.ethereum`, CIP-30, …) and won't load
+> in plain Node.
+
+## Inside EffectStream
+
+A thin re-export of `@effectstream/wallets`. If/when frontend-only
+helpers (React context providers, batcher submission hooks, event
+subscribers wired to React) ship, they'll live here without breaking
+app code that depended on the umbrella name.
+
+## Key exports
+
+Everything `@effectstream/wallets` exports. The most-imported symbols
+across templates are:
+
+- `walletLogin(...)` — one-call wallet connection + signed batcher message.
+- `WalletMode` — enum of supported wallet types.
+- `Wallet` — type for a connected wallet.
+- `EffectstreamConfig` — runtime config the wallet helpers consume.
+- `sendTransaction`, `sendBatcherTransaction`, `signMessage`, `waitForEffectstreamBlockProcessed` — send/wait helpers.
+- `allInjectedWallets`, `getAddressType`, `WalletNameMap` — discovery + identification helpers.
+
+For lower-level connector machinery (`connectInjectedWallet`,
+`WalletModeMap`, `IProvider`, `IConnector`, `IInjectedConnector`), import
+from `@effectstream/wallets` directly.
+
+## Examples
+
+Runnable: [`test/examples.test.ts`](./test/examples.test.ts).
+
+Real-world: every frontend in
+[`templates/`](https://github.com/PaimaStudios/paima-engine/tree/main/templates)
+demonstrates the same surface.
+
+## Links
+
+- Docs: https://effectstream.github.io/docs/packages/tools/frontend-sdk
+- Source: https://github.com/PaimaStudios/paima-engine/tree/main/packages/frontend

package/dist/mod.js

@@ -21013,7 +21013,7 @@ class EventManager {
 import { Kind, Type as Type8 } from "@sinclair/typebox";
 // ../effectstream-sdk/wallets/src/effectstream.ts
 class EffectstreamConfig {
-  appName;
+  securityNamespace;
   effectstreamL2SyncProtocolName;
   effectstreamL2ContractAddress;
   effectstreamL2Abi;
@@ -21022,8 +21022,8 @@ class EffectstreamConfig {
   web3 = undefined;
   batcherURL = undefined;
   preferBatchedMode = false;
-  constructor(appName, effectstreamL2SyncProtocolName, effectstreamL2ContractAddress, effectstreamL2Chain, effectstreamL2Abi, batcherURL, preferBatchedMode = false) {
-    this.appName = appName ?? "";
+  constructor(securityNamespace, effectstreamL2SyncProtocolName, effectstreamL2ContractAddress, effectstreamL2Chain, effectstreamL2Abi, batcherURL, preferBatchedMode = false) {
+    this.securityNamespace = securityNamespace && securityNamespace.length > 0 ? securityNamespace : null;
     this.effectstreamL2SyncProtocolName = effectstreamL2SyncProtocolName;
     this.effectstreamL2ContractAddress = effectstreamL2ContractAddress;
     this.effectstreamL2Abi = effectstreamL2Abi ?? this.fallbackABI();
@@ -21155,7 +21155,7 @@ async function sendBatcherTransaction(wallet, conciseData, effectstreamConfig, w
   }
   const conciseDataStr = JSON.stringify(conciseData);
   const timestamp2 = Date.now().toString();
-  const signature = await wallet.provider.signMessage(createMessageForBatcher(effectstreamConfig.appName, timestamp2, wallet.provider.getAddress().address, wallet.provider.getAddress().type, conciseDataStr, batcherTarget));
+  const signature = await wallet.provider.signMessage(createMessageForBatcher(effectstreamConfig.securityNamespace, timestamp2, wallet.provider.getAddress().address, wallet.provider.getAddress().type, conciseDataStr, batcherTarget));
   const response = await fetch(`${effectstreamConfig.batcherURL}/send-input`, {
     method: "POST",
     headers: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effectstream/frontend-sdk",
-  "version": "0.100.14",
+  "version": "0.100.15",
   "license": "MIT",
   "homepage": "https://effectstream.github.io/docs/",
   "repository": {
@@ -27,7 +27,7 @@
     "build": "bun run build.ts"
   },
   "dependencies": {
-    "@effectstream/wallets": "0.100.14"
+    "@effectstream/wallets": "0.100.15"
   },
   "description": "React frontend SDK for EffectStream"
 }