Skip to content

Commit b77fbd8

Browse files
jhfnetboyjhfnetboy
authored
Merge pull request #3 from AAStarCommunity/docs/sync-sdk-0.20.8
docs: publish SDK 0.20.8 (regenerated API, new modules, examples, deployments)
2 parents 1d71cd6 + d7efd17 commit b77fbd8

1,198 files changed

Lines changed: 83003 additions & 3364 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/check-secrets.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ jobs:
2929
NC='\033[0m'
3030
3131
# 排除的目录
32-
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"
32+
# _media/ holds TypeDoc-generated example source (.ts/.md) copied into the
33+
# API docs; these are published examples with placeholder keys (e.g.
34+
# 0x1234…), not real source — exclude them like other generated output.
35+
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"
3336
3437
# 扫描的文件扩展名
3538
SCAN_EXTENSIONS="\.(ts|tsx|js|jsx|svelte|sol|md|json|env|example|toml|yaml|yml)$"

‎.vitepress/config.ts‎

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ const guideSidebar: DefaultTheme.SidebarItem[] = [
7171
text: 'Lifecycle API (L3)',
7272
items: [
7373
{ text: 'Developer Guide', link: '/guide/docs/L3_Lifecycle_Developer_Guide' },
74-
{ text: 'Complete Demo Walkthrough', link: '/guide/docs/L3_Complete_Demo_Walkthrough' },
74+
{ text: 'Use Case Analysis', link: '/guide/docs/L3_Use_Case_Analysis' },
7575
{ text: 'Patterns Design', link: '/guide/docs/L3_Lifecycle_Patterns_Design' }
7676
]
7777
}
@@ -107,6 +107,52 @@ const zhGuideSidebar: DefaultTheme.SidebarItem[] = [
107107
]
108108

109109
const apiSidebar: DefaultTheme.SidebarItem[] = [
110+
{
111+
text: 'Getting Started',
112+
items: [
113+
{ text: 'Overview', link: '/api/' },
114+
{ text: 'Installation', link: '/api/@aastar/sdk#installation' },
115+
{ text: 'Quick Start', link: '/api/@aastar/sdk#usage' }
116+
]
117+
},
118+
{
119+
text: '@aastar/sdk (Meta Package)',
120+
items: [
121+
{ text: 'Overview', link: '/api/@aastar/sdk' },
122+
{ text: 'Node.js Tools', link: '/api/@aastar/sdk/node' }
123+
]
124+
},
125+
{
126+
text: 'Core Modules',
127+
collapsed: false,
128+
items: [
129+
{ text: '@aastar/core', link: '/api/@aastar/core' },
130+
{ text: '@aastar/account', link: '/api/@aastar/account' },
131+
{ text: '@aastar/paymaster', link: '/api/@aastar/paymaster' },
132+
{ text: '@aastar/enduser', link: '/api/@aastar/enduser' },
133+
{ text: '@aastar/operator', link: '/api/@aastar/operator' },
134+
{ text: '@aastar/admin', link: '/api/@aastar/admin' },
135+
{ text: '@aastar/dapp', link: '/api/@aastar/dapp' },
136+
{ text: '@aastar/tokens', link: '/api/@aastar/tokens' },
137+
{ text: '@aastar/identity', link: '/api/@aastar/identity' },
138+
{ text: '@aastar/airaccount', link: '/api/@aastar/airaccount' },
139+
{ text: '@aastar/channel', link: '/api/@aastar/channel' },
140+
{ text: '@aastar/x402', link: '/api/@aastar/x402' }
141+
]
142+
},
143+
{
144+
text: 'Examples',
145+
items: [
146+
{ text: 'SDK Handbooks', link: '/api/@aastar/sdk#core-scenarios' }
147+
]
148+
}
149+
]
150+
151+
// Frozen API sidebar for the archived v0.16.23 snapshot. v0.16.23 predates the
152+
// single-package consolidation, so it still exposes @aastar/community and
153+
// @aastar/analytics and lacks admin/airaccount/channel/x402. Kept separate so
154+
// updating the latest apiSidebar above never rewrites the frozen archive.
155+
const apiSidebarArchived: DefaultTheme.SidebarItem[] = [
110156
{
111157
text: 'Getting Started',
112158
items: [
@@ -154,7 +200,7 @@ const examplesSidebar: DefaultTheme.SidebarItem[] = [
154200
{ text: 'Operator Flow', link: '/examples/operator-flow' },
155201
{ text: 'Community Flow', link: '/examples/community-flow' },
156202
{ text: 'End User Flow', link: '/examples/enduser-flow' },
157-
{ text: 'L3 Complete Lifecycle', link: '/guide/docs/L3_Complete_Demo_Walkthrough' },
203+
{ text: 'L3 Lifecycle Developer Guide', link: '/guide/docs/L3_Lifecycle_Developer_Guide' },
158204
{ text: 'Multi-Chain Setup', link: '/examples/multi-chain' }
159205
]
160206
}
@@ -228,9 +274,9 @@ export default defineConfig({
228274
{ text: 'Deployments', link: '/guide/deployments/' },
229275
{ text: 'History', link: '/changelog' },
230276
{
231-
text: 'v0.20.x (latest)',
277+
text: 'v0.20.8 (latest)',
232278
items: [
233-
{ text: 'v0.20.x (latest)', link: '/' },
279+
{ text: 'v0.20.8 (latest)', link: '/' },
234280
{ text: 'v0.16.23', link: '/0.16.23/' }
235281
]
236282
}
@@ -245,7 +291,7 @@ export default defineConfig({
245291
// Mirrored sidebars for the frozen archived version (v0.16.23).
246292
// Links are auto-prefixed with the version path via prefixSidebar().
247293
'/0.16.23/guide/': prefixSidebar(guideSidebar, ARCHIVED_VERSION),
248-
'/0.16.23/api/': prefixSidebar(apiSidebar, ARCHIVED_VERSION),
294+
'/0.16.23/api/': prefixSidebar(apiSidebarArchived, ARCHIVED_VERSION),
249295
'/0.16.23/examples/': prefixSidebar(examplesSidebar, ARCHIVED_VERSION),
250296
'/0.16.23/zh/guide/': prefixSidebar(zhGuideSidebar, ARCHIVED_VERSION)
251297
},

‎api/@aastar/account/classes/UserOpClient.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Defined in: [packages/account/src/index.ts:40](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L40)
1+
Defined in: [packages/account/src/index.ts:40](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L40)
22

33
UserOperation Client for handling high-level flows
44

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

1919
> `static` **estimateGas**(`bundler`, `op`, `entryPoint`): `Promise`\<`any`\>
2020
21-
Defined in: [packages/account/src/index.ts:41](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L41)
21+
Defined in: [packages/account/src/index.ts:41](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L41)
2222

2323
#### Parameters
2424

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

3939
> `static` **getReceipt**(`bundler`, `hash`): `Promise`\<`any`\>
4040
41-
Defined in: [packages/account/src/index.ts:55](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L55)
41+
Defined in: [packages/account/src/index.ts:55](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L55)
4242

4343
#### Parameters
4444

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

5858
> `static` **sendUserOp**(`bundler`, `op`, `entryPoint`): `Promise`\<`any`\>
5959
60-
Defined in: [packages/account/src/index.ts:48](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L48)
60+
Defined in: [packages/account/src/index.ts:48](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L48)
6161

6262
#### Parameters
6363

‎api/@aastar/account/functions/createEOAWalletClient.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
> **createEOAWalletClient**(`privateKey`, `chain`, `transport`): [`EOAWalletClient`](../type-aliases/EOAWalletClient.md)
22
3-
Defined in: [packages/account/src/eoa.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/eoa.ts#L9)
3+
Defined in: [packages/account/src/eoa.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/eoa.ts#L9)
44

55
## Parameters
66

‎api/@aastar/account/functions/getUserOpHash.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
> **getUserOpHash**(`op`, `ep`, `chainId`): `` `0x${string}` ``
22
3-
Defined in: [packages/account/src/index.ts:16](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L16)
3+
Defined in: [packages/account/src/index.ts:16](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L16)
44

55
Local implementation of EntryPoint v0.7 getUserOpHash
66

‎api/@aastar/account/functions/packUserOpLimits.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
> **packUserOpLimits**(`high`, `low`): `` `0x${string}` ``
22
3-
Defined in: [packages/account/src/index.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/index.ts#L9)
3+
Defined in: [packages/account/src/index.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L9)
44

55
Common Pack Logic for v0.7 UserOperations
66

‎api/@aastar/account/functions/toSimpleSmartAccount.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
> **toSimpleSmartAccount**(`parameters`): `Promise`\<[`SimpleSmartAccount`](../type-aliases/SimpleSmartAccount.md)\>
22
3-
Defined in: [packages/account/src/accounts/simple.ts:22](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/accounts/simple.ts#L22)
3+
Defined in: [packages/account/src/accounts/simple.ts:22](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/accounts/simple.ts#L22)
44

55
## Parameters
66

‎api/@aastar/account/type-aliases/EOAWalletClient.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
> **EOAWalletClient** = [`WalletClient`](https://viem.sh/docs/index.html) & `object`
22
3-
Defined in: [packages/account/src/eoa.ts:4](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/eoa.ts#L4)
3+
Defined in: [packages/account/src/eoa.ts:4](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/eoa.ts#L4)
44

55
## Type Declaration
66

‎api/@aastar/account/type-aliases/SimpleSmartAccount.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
> **SimpleSmartAccount** = [`LocalAccount`](https://viem.sh/docs/index.html) & `object`
22
3-
Defined in: [packages/account/src/accounts/simple.ts:15](https://github.com/AAStarCommunity/aastar-sdk/blob/9c654bccf291bedf59c180131227065a5460e904/packages/account/src/accounts/simple.ts#L15)
3+
Defined in: [packages/account/src/accounts/simple.ts:15](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/accounts/simple.ts#L15)
44

55
## Type Declaration
66

0 commit comments

Comments
 (0)