@buildersgarden/siwa 0.0.15 → 0.0.17

package/README.md

@@ -64,7 +64,7 @@ See [`references/security-model.md`](references/security-model.md) for the full
 
 ## References
 
-- [SKILL.md](SKILL.md) — Full skill documentation and API reference
+- [skill.md](skill.md) — Full skill documentation and API reference
 - [ERC-8004 specification](https://github.com/builders-garden/ERC-8004)
 - [SIWA protocol spec](references/siwa-spec.md)
 

package/dist/registry.d.ts

@@ -7,7 +7,7 @@
  * Dependencies:
  *   npm install viem
  */
-import { type PublicClient } from 'viem';
+import { type PublicClient, type Address, type Hex } from 'viem';
 import type { TransactionSigner } from './signer/index.js';
 /** Service endpoint types defined in ERC-8004 */
 export type ServiceType = 'web' | 'A2A' | 'MCP' | 'OASF' | 'ENS' | 'DID' | 'email';
@@ -73,6 +73,45 @@ export declare function getAgent(agentId: number, options: GetAgentOptions): Pro
  * @param options  Reputation registry address, client, and optional filters
  */
 export declare function getReputation(agentId: number, options: GetReputationOptions): Promise<ReputationSummary>;
+export interface EncodeRegisterAgentOptions {
+    /** The agent metadata URI (IPFS, HTTP, or data URL) */
+    agentURI: string;
+    /** The chain ID to register on */
+    chainId: number;
+}
+export interface EncodeRegisterAgentResult {
+    /** The registry contract address */
+    to: Address;
+    /** The ABI-encoded calldata for `register(agentURI)` */
+    data: Hex;
+}
+/**
+ * Encode the calldata for an ERC-8004 agent registration without sending it.
+ *
+ * Use this when your wallet provider handles transaction submission separately
+ * (e.g. Bankr's `/agent/submit`, or any ERC-4337 bundler).
+ *
+ * @example
+ * ```typescript
+ * import { encodeRegisterAgent } from '@buildersgarden/siwa/registry';
+ *
+ * const { to, data } = encodeRegisterAgent({
+ *   agentURI: 'data:application/json;base64,...',
+ *   chainId: 84532,
+ * });
+ *
+ * // Submit via your provider (e.g. Bankr)
+ * await fetch('https://api.bankr.bot/agent/submit', {
+ *   method: 'POST',
+ *   headers: { 'Content-Type': 'application/json', 'X-API-Key': apiKey },
+ *   body: JSON.stringify({
+ *     transaction: { to, data, value: '0', chainId: 84532 },
+ *     waitForConfirmation: true,
+ *   }),
+ * });
+ * ```
+ */
+export declare function encodeRegisterAgent(options: EncodeRegisterAgentOptions): EncodeRegisterAgentResult;
 export interface RegisterAgentOptions {
     /** The agent metadata URI (IPFS, HTTP, or data URL) */
     agentURI: string;

package/dist/registry.js

@@ -156,6 +156,42 @@ export async function getReputation(agentId, options) {
     const score = Number(rawValue) / 10 ** decimals;
     return { count: Number(count), score, rawValue, decimals };
 }
+/**
+ * Encode the calldata for an ERC-8004 agent registration without sending it.
+ *
+ * Use this when your wallet provider handles transaction submission separately
+ * (e.g. Bankr's `/agent/submit`, or any ERC-4337 bundler).
+ *
+ * @example
+ * ```typescript
+ * import { encodeRegisterAgent } from '@buildersgarden/siwa/registry';
+ *
+ * const { to, data } = encodeRegisterAgent({
+ *   agentURI: 'data:application/json;base64,...',
+ *   chainId: 84532,
+ * });
+ *
+ * // Submit via your provider (e.g. Bankr)
+ * await fetch('https://api.bankr.bot/agent/submit', {
+ *   method: 'POST',
+ *   headers: { 'Content-Type': 'application/json', 'X-API-Key': apiKey },
+ *   body: JSON.stringify({
+ *     transaction: { to, data, value: '0', chainId: 84532 },
+ *     waitForConfirmation: true,
+ *   }),
+ * });
+ * ```
+ */
+export function encodeRegisterAgent(options) {
+    const { agentURI, chainId } = options;
+    const registryAddress = getRegistryAddress(chainId);
+    const data = encodeFunctionData({
+        abi: IDENTITY_REGISTRY_ABI,
+        functionName: 'register',
+        args: [agentURI],
+    });
+    return { to: registryAddress, data };
+}
 /**
  * Register an agent on the ERC-8004 Identity Registry in a single call.
  *

package/dist/signer/bankr.d.ts

@@ -0,0 +1,51 @@
+/**
+ * bankr.ts
+ *
+ * Bankr wallet signer implementation.
+ *
+ * Uses the Bankr Agent API (https://api.bankr.bot) for signing operations.
+ * Wallet address is fetched via GET /agent/me, messages are signed via POST /agent/sign.
+ */
+import type { Signer } from "./types.js";
+/**
+ * Configuration for the Bankr SIWA signer.
+ */
+export interface BankrSiwaSignerConfig {
+    /** Bankr API key (or BANKR_API_KEY env var) */
+    apiKey?: string;
+    /** Bankr API base URL (defaults to https://api.bankr.bot) */
+    baseUrl?: string;
+}
+/**
+ * Creates a SIWA Signer that wraps the Bankr Agent API.
+ *
+ * This signer implements the core Signer interface for SIWA message signing.
+ * It supports both standard message signing (EIP-191) and raw hex signing
+ * for ERC-8128 HTTP message signatures.
+ *
+ * The wallet address is fetched from the Bankr API on creation.
+ *
+ * @param config - Bankr API configuration
+ * @returns A Promise that resolves to a Signer compatible with SIWA's signSIWAMessage function
+ *
+ * @example
+ * ```typescript
+ * import { signSIWAMessage } from '@buildersgarden/siwa';
+ * import { createBankrSiwaSigner } from '@buildersgarden/siwa/signer';
+ *
+ * const signer = await createBankrSiwaSigner({
+ *   apiKey: process.env.BANKR_API_KEY!,
+ * });
+ *
+ * const { message, signature, address } = await signSIWAMessage({
+ *   domain: 'example.com',
+ *   uri: 'https://example.com/login',
+ *   agentId: 123,
+ *   agentRegistry: 'eip155:84532:0x...',
+ *   chainId: 84532,
+ *   nonce: generateNonce(),
+ *   issuedAt: new Date().toISOString(),
+ * }, signer);
+ * ```
+ */
+export declare function createBankrSiwaSigner(config?: BankrSiwaSignerConfig): Promise<Signer>;

package/dist/signer/bankr.js

@@ -0,0 +1,123 @@
+/**
+ * bankr.ts
+ *
+ * Bankr wallet signer implementation.
+ *
+ * Uses the Bankr Agent API (https://api.bankr.bot) for signing operations.
+ * Wallet address is fetched via GET /agent/me, messages are signed via POST /agent/sign.
+ */
+function resolveConfig(config) {
+    const apiKey = config.apiKey ?? process.env.BANKR_API_KEY;
+    if (!apiKey) {
+        throw new Error("Bankr API key is required. Provide apiKey in config or set BANKR_API_KEY env var.");
+    }
+    return {
+        apiKey,
+        baseUrl: config.baseUrl ?? "https://api.bankr.bot",
+    };
+}
+/**
+ * Fetches the EVM wallet address from the Bankr API.
+ */
+async function fetchWalletAddress(config) {
+    const response = await fetch(`${config.baseUrl}/agent/me`, {
+        headers: {
+            "X-API-Key": config.apiKey,
+        },
+    });
+    if (!response.ok) {
+        throw new Error(`Bankr API /agent/me failed: ${response.status} ${response.statusText}`);
+    }
+    const data = await response.json();
+    const evmWallet = data.wallets?.find((w) => w.chain === "evm");
+    if (!evmWallet?.address) {
+        throw new Error("No EVM wallet found in Bankr account");
+    }
+    return evmWallet.address;
+}
+/**
+ * Signs a message using the Bankr Agent API.
+ */
+async function bankrSign(config, signatureType, payload) {
+    const response = await fetch(`${config.baseUrl}/agent/sign`, {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/json",
+            "X-API-Key": config.apiKey,
+        },
+        body: JSON.stringify({ signatureType, ...payload }),
+    });
+    if (!response.ok) {
+        throw new Error(`Bankr sign failed: ${response.status} ${response.statusText}`);
+    }
+    const result = await response.json();
+    if (!result.success || !result.signature) {
+        throw new Error(`Bankr sign failed: ${result.error ?? "no signature returned"}`);
+    }
+    return {
+        signature: result.signature,
+        signer: result.signer,
+    };
+}
+/**
+ * Creates a SIWA Signer that wraps the Bankr Agent API.
+ *
+ * This signer implements the core Signer interface for SIWA message signing.
+ * It supports both standard message signing (EIP-191) and raw hex signing
+ * for ERC-8128 HTTP message signatures.
+ *
+ * The wallet address is fetched from the Bankr API on creation.
+ *
+ * @param config - Bankr API configuration
+ * @returns A Promise that resolves to a Signer compatible with SIWA's signSIWAMessage function
+ *
+ * @example
+ * ```typescript
+ * import { signSIWAMessage } from '@buildersgarden/siwa';
+ * import { createBankrSiwaSigner } from '@buildersgarden/siwa/signer';
+ *
+ * const signer = await createBankrSiwaSigner({
+ *   apiKey: process.env.BANKR_API_KEY!,
+ * });
+ *
+ * const { message, signature, address } = await signSIWAMessage({
+ *   domain: 'example.com',
+ *   uri: 'https://example.com/login',
+ *   agentId: 123,
+ *   agentRegistry: 'eip155:84532:0x...',
+ *   chainId: 84532,
+ *   nonce: generateNonce(),
+ *   issuedAt: new Date().toISOString(),
+ * }, signer);
+ * ```
+ */
+export async function createBankrSiwaSigner(config = {}) {
+    const resolved = resolveConfig(config);
+    const walletAddress = await fetchWalletAddress(resolved);
+    return {
+        /**
+         * Returns the wallet address.
+         */
+        async getAddress() {
+            return walletAddress;
+        },
+        /**
+         * Signs a message using EIP-191 personal_sign.
+         * Used for standard SIWA message signing.
+         */
+        async signMessage(message) {
+            const result = await bankrSign(resolved, "personal_sign", { message });
+            return result.signature;
+        },
+        /**
+         * Signs raw hex bytes.
+         * Used by ERC-8128 for HTTP message signatures.
+         */
+        async signRawMessage(rawHex) {
+            const result = await bankrSign(resolved, "personal_sign", {
+                message: rawHex,
+            });
+            return result.signature;
+        },
+    };
+}

package/dist/signer/index.d.ts

@@ -13,6 +13,7 @@
  *   - createCircleSiwaSigner(config)           — Circle developer-controlled wallet
  *   - createCircleSiwaSignerFromClient(config) — Circle with existing client
  *   - createPrivySiwaSigner(config)            — Privy server wallet
+ *   - createBankrSiwaSigner(config)            — Bankr Agent API wallet
  *
  * Usage:
  *   import { signSIWAMessage, createLocalAccountSigner } from '@buildersgarden/siwa';
@@ -28,3 +29,4 @@ export { createLocalAccountSigner } from './local-account.js';
 export { createWalletClientSigner } from './wallet-client.js';
 export { createCircleSiwaSigner, createCircleSiwaSignerFromClient, type CircleSiwaSignerConfig, type CircleSiwaSignerClientConfig, } from './circle.js';
 export { createPrivySiwaSigner, type PrivySiwaSignerConfig, } from './privy.js';
+export { createBankrSiwaSigner, type BankrSiwaSignerConfig, } from './bankr.js';

package/dist/signer/index.js

@@ -13,6 +13,7 @@
  *   - createCircleSiwaSigner(config)           — Circle developer-controlled wallet
  *   - createCircleSiwaSignerFromClient(config) — Circle with existing client
  *   - createPrivySiwaSigner(config)            — Privy server wallet
+ *   - createBankrSiwaSigner(config)            — Bankr Agent API wallet
  *
  * Usage:
  *   import { signSIWAMessage, createLocalAccountSigner } from '@buildersgarden/siwa';
@@ -28,3 +29,4 @@ export { createLocalAccountSigner } from './local-account.js';
 export { createWalletClientSigner } from './wallet-client.js';
 export { createCircleSiwaSigner, createCircleSiwaSignerFromClient, } from './circle.js';
 export { createPrivySiwaSigner, } from './privy.js';
+export { createBankrSiwaSigner, } from './bankr.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildersgarden/siwa",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "type": "module",
   "exports": {
     ".": {