Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion .github/workflows/check-secrets.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ jobs:
NC='\033[0m'

# 排除的目录
EXCLUDED_DIRS="node_modules|\.git|\.netlify|\.svelte-kit|build|dist|\.next|contracts/broadcast|contracts/cache|contracts/lib|test-results|playwright-report|\.auth|vendor|cache|out"
# _media/ holds TypeDoc-generated example source (.ts/.md) copied into the
# API docs; these are published examples with placeholder keys (e.g.
# 0x1234…), not real source — exclude them like other generated output.
EXCLUDED_DIRS="node_modules|\.git|\.netlify|\.svelte-kit|build|dist|\.next|contracts/broadcast|contracts/cache|contracts/lib|test-results|playwright-report|\.auth|vendor|cache|out|_media"

# 扫描的文件扩展名
SCAN_EXTENSIONS="\.(ts|tsx|js|jsx|svelte|sol|md|json|env|example|toml|yaml|yml)$"
Expand Down
56 changes: 51 additions & 5 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ const guideSidebar: DefaultTheme.SidebarItem[] = [
text: 'Lifecycle API (L3)',
items: [
{ text: 'Developer Guide', link: '/guide/docs/L3_Lifecycle_Developer_Guide' },
{ text: 'Complete Demo Walkthrough', link: '/guide/docs/L3_Complete_Demo_Walkthrough' },
{ text: 'Use Case Analysis', link: '/guide/docs/L3_Use_Case_Analysis' },
{ text: 'Patterns Design', link: '/guide/docs/L3_Lifecycle_Patterns_Design' }
]
}
Expand Down Expand Up @@ -107,6 +107,52 @@ const zhGuideSidebar: DefaultTheme.SidebarItem[] = [
]

const apiSidebar: DefaultTheme.SidebarItem[] = [
{
text: 'Getting Started',
items: [
{ text: 'Overview', link: '/api/' },
{ text: 'Installation', link: '/api/@aastar/sdk#installation' },
{ text: 'Quick Start', link: '/api/@aastar/sdk#usage' }
]
},
{
text: '@aastar/sdk (Meta Package)',
items: [
{ text: 'Overview', link: '/api/@aastar/sdk' },
{ text: 'Node.js Tools', link: '/api/@aastar/sdk/node' }
]
},
{
text: 'Core Modules',
collapsed: false,
items: [
{ text: '@aastar/core', link: '/api/@aastar/core' },
{ text: '@aastar/account', link: '/api/@aastar/account' },
{ text: '@aastar/paymaster', link: '/api/@aastar/paymaster' },
{ text: '@aastar/enduser', link: '/api/@aastar/enduser' },
{ text: '@aastar/operator', link: '/api/@aastar/operator' },
{ text: '@aastar/admin', link: '/api/@aastar/admin' },
{ text: '@aastar/dapp', link: '/api/@aastar/dapp' },
{ text: '@aastar/tokens', link: '/api/@aastar/tokens' },
{ text: '@aastar/identity', link: '/api/@aastar/identity' },
{ text: '@aastar/airaccount', link: '/api/@aastar/airaccount' },
{ text: '@aastar/channel', link: '/api/@aastar/channel' },
{ text: '@aastar/x402', link: '/api/@aastar/x402' }
]
},
{
text: 'Examples',
items: [
{ text: 'SDK Handbooks', link: '/api/@aastar/sdk#core-scenarios' }
]
}
]

// Frozen API sidebar for the archived v0.16.23 snapshot. v0.16.23 predates the
// single-package consolidation, so it still exposes @aastar/community and
// @aastar/analytics and lacks admin/airaccount/channel/x402. Kept separate so
// updating the latest apiSidebar above never rewrites the frozen archive.
const apiSidebarArchived: DefaultTheme.SidebarItem[] = [
{
text: 'Getting Started',
items: [
Expand Down Expand Up @@ -154,7 +200,7 @@ const examplesSidebar: DefaultTheme.SidebarItem[] = [
{ text: 'Operator Flow', link: '/examples/operator-flow' },
{ text: 'Community Flow', link: '/examples/community-flow' },
{ text: 'End User Flow', link: '/examples/enduser-flow' },
{ text: 'L3 Complete Lifecycle', link: '/guide/docs/L3_Complete_Demo_Walkthrough' },
{ text: 'L3 Lifecycle Developer Guide', link: '/guide/docs/L3_Lifecycle_Developer_Guide' },
{ text: 'Multi-Chain Setup', link: '/examples/multi-chain' }
]
}
Expand Down Expand Up @@ -228,9 +274,9 @@ export default defineConfig({
{ text: 'Deployments', link: '/guide/deployments/' },
{ text: 'History', link: '/changelog' },
{
text: 'v0.20.x (latest)',
text: 'v0.20.8 (latest)',
items: [
{ text: 'v0.20.x (latest)', link: '/' },
{ text: 'v0.20.8 (latest)', link: '/' },
{ text: 'v0.16.23', link: '/0.16.23/' }
]
}
Expand All @@ -245,7 +291,7 @@ export default defineConfig({
// Mirrored sidebars for the frozen archived version (v0.16.23).
// Links are auto-prefixed with the version path via prefixSidebar().
'/0.16.23/guide/': prefixSidebar(guideSidebar, ARCHIVED_VERSION),
'/0.16.23/api/': prefixSidebar(apiSidebar, ARCHIVED_VERSION),
'/0.16.23/api/': prefixSidebar(apiSidebarArchived, ARCHIVED_VERSION),
'/0.16.23/examples/': prefixSidebar(examplesSidebar, ARCHIVED_VERSION),
'/0.16.23/zh/guide/': prefixSidebar(zhGuideSidebar, ARCHIVED_VERSION)
},
Expand Down
8 changes: 4 additions & 4 deletions api/@aastar/account/classes/UserOpClient.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Defined in: [packages/account/src/index.ts:40](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L40)
Defined in: [packages/account/src/index.ts:40](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L40)

UserOperation Client for handling high-level flows

Expand All @@ -18,7 +18,7 @@ UserOperation Client for handling high-level flows

> `static` **estimateGas**(`bundler`, `op`, `entryPoint`): `Promise`\<`any`\>

Defined in: [packages/account/src/index.ts:41](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L41)
Defined in: [packages/account/src/index.ts:41](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L41)

#### Parameters

Expand All @@ -38,7 +38,7 @@ Defined in: [packages/account/src/index.ts:41](https://github.com/AAStarCommunit

> `static` **getReceipt**(`bundler`, `hash`): `Promise`\<`any`\>

Defined in: [packages/account/src/index.ts:55](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L55)
Defined in: [packages/account/src/index.ts:55](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L55)

#### Parameters

Expand All @@ -57,7 +57,7 @@ Defined in: [packages/account/src/index.ts:55](https://github.com/AAStarCommunit

> `static` **sendUserOp**(`bundler`, `op`, `entryPoint`): `Promise`\<`any`\>

Defined in: [packages/account/src/index.ts:48](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L48)
Defined in: [packages/account/src/index.ts:48](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L48)

#### Parameters

Expand Down
2 changes: 1 addition & 1 deletion api/@aastar/account/functions/createEOAWalletClient.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> **createEOAWalletClient**(`privateKey`, `chain`, `transport`): [`EOAWalletClient`](../type-aliases/EOAWalletClient.md)

Defined in: [packages/account/src/eoa.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/eoa.ts#L9)
Defined in: [packages/account/src/eoa.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/eoa.ts#L9)

## Parameters

Expand Down
2 changes: 1 addition & 1 deletion api/@aastar/account/functions/getUserOpHash.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> **getUserOpHash**(`op`, `ep`, `chainId`): `` `0x${string}` ``

Defined in: [packages/account/src/index.ts:16](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L16)
Defined in: [packages/account/src/index.ts:16](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L16)

Local implementation of EntryPoint v0.7 getUserOpHash

Expand Down
2 changes: 1 addition & 1 deletion api/@aastar/account/functions/packUserOpLimits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> **packUserOpLimits**(`high`, `low`): `` `0x${string}` ``

Defined in: [packages/account/src/index.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L9)
Defined in: [packages/account/src/index.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L9)

Common Pack Logic for v0.7 UserOperations

Expand Down
2 changes: 1 addition & 1 deletion api/@aastar/account/functions/toSimpleSmartAccount.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> **toSimpleSmartAccount**(`parameters`): `Promise`\<[`SimpleSmartAccount`](../type-aliases/SimpleSmartAccount.md)\>

Defined in: [packages/account/src/accounts/simple.ts:22](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/accounts/simple.ts#L22)
Defined in: [packages/account/src/accounts/simple.ts:22](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/accounts/simple.ts#L22)

## Parameters

Expand Down
2 changes: 1 addition & 1 deletion api/@aastar/account/type-aliases/EOAWalletClient.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> **EOAWalletClient** = [`WalletClient`](https://viem.sh/docs/index.html) & `object`

Defined in: [packages/account/src/eoa.ts:4](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/eoa.ts#L4)
Defined in: [packages/account/src/eoa.ts:4](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/eoa.ts#L4)

## Type Declaration

Expand Down
2 changes: 1 addition & 1 deletion api/@aastar/account/type-aliases/SimpleSmartAccount.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> **SimpleSmartAccount** = [`LocalAccount`](https://viem.sh/docs/index.html) & `object`

Defined in: [packages/account/src/accounts/simple.ts:15](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/accounts/simple.ts#L15)
Defined in: [packages/account/src/accounts/simple.ts:15](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/accounts/simple.ts#L15)

## Type Declaration

Expand Down
Loading
Loading