jaw-sdk-best-practices

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

JAW SDK Best Practices

JAW SDK 最佳实践

Guide for building applications with the JAW SDK passkey-authenticated smart accounts on EVM chains with programmable permissions.

本指南介绍如何使用JAW SDK在EVM链上构建具备可编程权限、通过密钥对认证的智能账户应用。

When to use

适用场景

Reference these guidelines when:

Installing or setting up
```
@jaw.id/wagmi
```
,
```
@jaw.id/core
```
, or
```
@jaw.id/ui
```
Configuring the JAW connector or provider (API key, modes, paymasters, ENS)
Connecting/disconnecting wallets with passkey authentication
Sending transactions (single or batched) through JAW smart accounts
Signing messages or typed data (EIP-191, EIP-712, ERC-7871)
Granting, querying, or revoking permissions (ERC-7715)
Implementing subscription payments or recurring charges
Setting up gas sponsoring with paymasters (ERC-7677)
Issuing ENS subnames to users during onboarding
Implementing Sign-In With Ethereum (SIWE)
Building headless integrations, server-side operations, or AI agent wallets
Using the Account class directly (no UI)
Building stablecoin payment flows (USDC gas, batch payouts)
Choosing between CrossPlatform and AppSpecific authentication modes
Implementing a custom UI handler for app-specific mode
Reviewing or debugging code that uses JAW SDK

在以下场景中可参考本指南：

安装或设置
```
@jaw.id/wagmi
```
、
```
@jaw.id/core
```
或
```
@jaw.id/ui
```
配置JAW连接器或提供者（API密钥、模式、支付方、ENS）
通过密钥对认证连接/断开钱包
通过JAW智能账户发送交易（单笔或批量）
签署消息或类型化数据（EIP-191、EIP-712、ERC-7871）
授予、查询或撤销权限（ERC-7715）
实现订阅支付或定期扣费
通过支付方设置Gas赞助（ERC-7677）
在用户注册流程中为其发放ENS子域名
实现以太坊登录（SIWE）
构建无头集成、服务器端操作或AI Agent钱包
直接使用Account类（无UI）
构建稳定币支付流程（USDC Gas、批量付款）
在CrossPlatform与AppSpecific认证模式间做选择
为应用专属模式实现自定义UI处理器
审查或调试使用JAW SDK的代码

Key facts

关键信息

Packages:
```
@jaw.id/wagmi
```
(React),
```
@jaw.id/core
```
(vanilla JS / server),
```
@jaw.id/ui
```
(app-specific mode UI)
API Key: Required. Get one at https://dashboard.jaw.id
EIP-1193 compatible: Drop-in replacement for MetaMask or any wallet
Smart accounts: ERC-4337 with passkey signers, gasless tx, batch ops, permissions
EntryPoint: v0.8 only (for paymasters)

包列表：
```
@jaw.id/wagmi
```
（React）、
```
@jaw.id/core
```
（原生JS/服务器端）、
```
@jaw.id/ui
```
（应用专属模式UI）
API密钥： 必需。可在https://dashboard.jaw.id获取
兼容EIP-1193： 可直接替代MetaMask或其他钱包
智能账户： 基于ERC-4337标准，支持密钥对签名、免Gas交易、批量操作、权限管理
EntryPoint： 仅支持v0.8版本（用于支付方）

Rule index

规则目录

1. Setup & Configuration

1. 安装与配置

<rules/installation.md> - Package installation, peer dependencies, choosing wagmi vs core
<rules/configuration.md> - All config options: apiKey, appName, ens, mode, paymasters, preference
<rules/auth-modes.md> - CrossPlatform vs AppSpecific modes and when to use each

<rules/installation.md> - 包安装、peer依赖、选择wagmi还是core
<rules/configuration.md> - 所有配置选项：apiKey、appName、ens、mode、paymasters、preference
<rules/auth-modes.md> - CrossPlatform与AppSpecific模式对比及适用场景

2. Wagmi Integration (React)

2. Wagmi集成（React）

<rules/wagmi-setup.md> - Wagmi connector setup, providers, using standard wagmi hooks with JAW
<rules/connect-disconnect.md> - useConnect, useDisconnect, connection with capabilities

<rules/wagmi-setup.md> - Wagmi连接器设置、提供者、将标准wagmi钩子与JAW结合使用
<rules/connect-disconnect.md> - useConnect、useDisconnect、带权限的连接

3. Core Operations

3. 核心操作

<rules/transactions.md> - Sending transactions, batch calls, gas estimation, checking status
<rules/signing.md> - Personal sign, typed data, unified wallet_sign, cross-chain signing

<rules/transactions.md> - 发送交易、批量调用、Gas估算、状态查询
<rules/signing.md> - 个人签名、类型化数据签名、统一wallet_sign、跨链签名

4. Permissions & Payments

4. 权限与支付

<rules/permissions.md> - Granting, querying, revoking permissions (ERC-7715)
<rules/subscription-payments.md> - Recurring subscription payments using permissions
<rules/stablecoin-payments.md> - Headless USDC payments, batch payouts, ERC-20 gas

<rules/permissions.md> - 授予、查询、撤销权限（ERC-7715）
<rules/subscription-payments.md> - 使用权限实现定期订阅支付
<rules/stablecoin-payments.md> - 无头USDC支付、批量付款、ERC-20 Gas

5. Identity & Auth

5. 身份与认证

<rules/ens-identity.md> - ENS subname issuance, profile resolution, text records
<rules/siwe.md> - Sign-In With Ethereum (SIWE) implementation
<rules/gas-sponsoring.md> - Paymaster setup, sponsorship policies, multi-chain config

<rules/ens-identity.md> - ENS子域名发放、资料解析、文本记录
<rules/siwe.md> - 以太坊登录（SIWE）实现
<rules/gas-sponsoring.md> - 支付方设置、赞助策略、多链配置

6. Advanced

6. 进阶内容

<rules/account-api.md> - Headless Account class for AI agents, server-side, embedded wallets
<rules/custom-ui-handler.md> - Building a custom UIHandler for app-specific mode
<rules/provider-api.md> - Direct provider RPC methods reference and patterns

<rules/account-api.md> - 用于AI Agent、服务器端、嵌入式钱包的无头Account类
<rules/custom-ui-handler.md> - 为应用专属模式构建自定义UIHandler
<rules/provider-api.md> - 直接提供者RPC方法参考与模式

7. Reference

7. 参考资料

<rules/error-handling.md> - EIP-1193 error codes, common errors, debugging
<rules/typescript-types.md> - Key TypeScript interfaces and type patterns

<rules/error-handling.md> - EIP-1193错误码、常见错误、调试方法
<rules/typescript-types.md> - 关键TypeScript接口与类型模式

How to use

使用方法

Read individual rule files for detailed guidance. Each contains: correct usage examples, common mistakes to avoid, and critical requirements.

阅读单个规则文件获取详细指导。每个文件包含：正确使用示例、需避免的常见错误以及关键要求。