Skip to content

Commit 2166949

Browse files
authored
Merge pull request #4 from AAStarCommunity/docs/sync-sdk-0.20.9
docs: publish SDK 0.20.9 (latest)
2 parents b77fbd8 + 2cfcdfd commit 2166949

1,144 files changed

Lines changed: 4994 additions & 4994 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.

.vitepress/config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,9 +274,9 @@ export default defineConfig({
274274
{ text: 'Deployments', link: '/guide/deployments/' },
275275
{ text: 'History', link: '/changelog' },
276276
{
277-
text: 'v0.20.8 (latest)',
277+
text: 'v0.20.9 (latest)',
278278
items: [
279-
{ text: 'v0.20.8 (latest)', link: '/' },
279+
{ text: 'v0.20.9 (latest)', link: '/' },
280280
{ text: 'v0.16.23', link: '/0.16.23/' }
281281
]
282282
}

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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L40)
1+
Defined in: [packages/account/src/index.ts:40](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L41)
21+
Defined in: [packages/account/src/index.ts:41](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L55)
41+
Defined in: [packages/account/src/index.ts:55](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L48)
60+
Defined in: [packages/account/src/index.ts:48](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/eoa.ts#L9)
3+
Defined in: [packages/account/src/eoa.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L16)
3+
Defined in: [packages/account/src/index.ts:16](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/index.ts#L9)
3+
Defined in: [packages/account/src/index.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/accounts/simple.ts#L22)
3+
Defined in: [packages/account/src/accounts/simple.ts:22](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/eoa.ts#L4)
3+
Defined in: [packages/account/src/eoa.ts:4](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/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/605127e5698e83b701be3a068b636f758e1cef9c/packages/account/src/accounts/simple.ts#L15)
3+
Defined in: [packages/account/src/accounts/simple.ts:15](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/account/src/accounts/simple.ts#L15)
44

55
## Type Declaration
66

api/@aastar/admin/classes/ProtocolGovernance.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Defined in: [admin/src/ProtocolGovernance.ts:20](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L20)
1+
Defined in: [admin/src/ProtocolGovernance.ts:20](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L20)
22

33
ProtocolGovernance - L3 Pattern
44

@@ -17,7 +17,7 @@ Responsibilities:
1717

1818
> **new ProtocolGovernance**(`config`): `ProtocolGovernance`
1919
20-
Defined in: [admin/src/ProtocolGovernance.ts:24](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L24)
20+
Defined in: [admin/src/ProtocolGovernance.ts:24](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L24)
2121

2222
#### Parameters
2323

@@ -51,7 +51,7 @@ Defined in: core/dist/clients/BaseClient.d.ts:5
5151

5252
> **entryPointAddress**: `` `0x${string}` ``
5353
54-
Defined in: [admin/src/ProtocolGovernance.ts:22](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L22)
54+
Defined in: [admin/src/ProtocolGovernance.ts:22](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L22)
5555

5656
#### Overrides
5757

@@ -111,7 +111,7 @@ Defined in: core/dist/clients/BaseClient.d.ts:6
111111

112112
> **registryAddress**: `` `0x${string}` ``
113113
114-
Defined in: [admin/src/ProtocolGovernance.ts:21](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L21)
114+
Defined in: [admin/src/ProtocolGovernance.ts:21](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L21)
115115

116116
#### Overrides
117117

@@ -123,7 +123,7 @@ Defined in: [admin/src/ProtocolGovernance.ts:21](https://github.com/AAStarCommun
123123

124124
> **configureRole**(`params`, `options?`): `Promise`\<`` `0x${string}` ``\>
125125
126-
Defined in: [admin/src/ProtocolGovernance.ts:95](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L95)
126+
Defined in: [admin/src/ProtocolGovernance.ts:95](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L95)
127127

128128
Configure a Role's parameters (Admin only).
129129
Reads the current on-chain config first, then merges the provided overrides
@@ -169,7 +169,7 @@ Get the account address of the connected wallet
169169

170170
> **getProtocolParams**(): `Promise`\<[`ProtocolParams`](../interfaces/ProtocolParams.md)\>
171171
172-
Defined in: [admin/src/ProtocolGovernance.ts:137](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L137)
172+
Defined in: [admin/src/ProtocolGovernance.ts:137](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L137)
173173

174174
#### Returns
175175

@@ -279,7 +279,7 @@ Defined in: core/dist/clients/BaseClient.d.ts:21
279279

280280
> **setStaking**(`staking`, `options?`): `Promise`\<`` `0x${string}` ``\>
281281
282-
Defined in: [admin/src/ProtocolGovernance.ts:82](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L82)
282+
Defined in: [admin/src/ProtocolGovernance.ts:82](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L82)
283283

284284
Set the Staking contract address
285285

@@ -300,7 +300,7 @@ Set the Staking contract address
300300

301301
> **setSuperPaymaster**(`paymaster`, `options?`): `Promise`\<`` `0x${string}` ``\>
302302
303-
Defined in: [admin/src/ProtocolGovernance.ts:71](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L71)
303+
Defined in: [admin/src/ProtocolGovernance.ts:71](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L71)
304304

305305
Approve a new SuperPaymaster contract address
306306

@@ -321,7 +321,7 @@ Approve a new SuperPaymaster contract address
321321

322322
> **setTreasury**(`treasury`, `options?`): `Promise`\<`` `0x${string}` ``\>
323323
324-
Defined in: [admin/src/ProtocolGovernance.ts:40](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L40)
324+
Defined in: [admin/src/ProtocolGovernance.ts:40](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L40)
325325

326326
Update the Global Treasury Address where protocol fees are collected
327327

@@ -342,7 +342,7 @@ Update the Global Treasury Address where protocol fees are collected
342342

343343
> **transferToDAO**(`daoAddress`, `options?`): `Promise`\<`` `0x${string}` ``\>
344344
345-
Defined in: [admin/src/ProtocolGovernance.ts:125](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L125)
345+
Defined in: [admin/src/ProtocolGovernance.ts:125](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L125)
346346

347347
Transfer Protocol Ownership to a DAO (Multisig/Timelock)
348348
This is the final step of "Protocol Admin" lifecycle.
@@ -364,7 +364,7 @@ This is the final step of "Protocol Admin" lifecycle.
364364

365365
> **updateEntryPoint**(`entryPoint`, `options?`): `Promise`\<`` `0x${string}` ``\>
366366
367-
Defined in: [admin/src/ProtocolGovernance.ts:57](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L57)
367+
Defined in: [admin/src/ProtocolGovernance.ts:57](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L57)
368368

369369
Update the supported EntryPoint address
370370

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
Defined in: [admin/src/ProtocolGovernance.ts:5](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L5)
1+
Defined in: [admin/src/ProtocolGovernance.ts:5](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L5)
22

33
## Properties
44

55
### entryPoint
66

77
> **entryPoint**: `` `0x${string}` ``
88
9-
Defined in: [admin/src/ProtocolGovernance.ts:8](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L8)
9+
Defined in: [admin/src/ProtocolGovernance.ts:8](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L8)
1010

1111
***
1212

1313
### minStake
1414

1515
> **minStake**: `bigint`
1616
17-
Defined in: [admin/src/ProtocolGovernance.ts:6](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L6)
17+
Defined in: [admin/src/ProtocolGovernance.ts:6](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L6)
1818

1919
***
2020

2121
### superPaymaster
2222

2323
> **superPaymaster**: `` `0x${string}` ``
2424
25-
Defined in: [admin/src/ProtocolGovernance.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L9)
25+
Defined in: [admin/src/ProtocolGovernance.ts:9](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L9)
2626

2727
***
2828

2929
### treasury
3030

3131
> **treasury**: `` `0x${string}` ``
3232
33-
Defined in: [admin/src/ProtocolGovernance.ts:7](https://github.com/AAStarCommunity/aastar-sdk/blob/605127e5698e83b701be3a068b636f758e1cef9c/packages/admin/src/ProtocolGovernance.ts#L7)
33+
Defined in: [admin/src/ProtocolGovernance.ts:7](https://github.com/AAStarCommunity/aastar-sdk/blob/f84ad01d4a6f445b93e18d397ea2859a5682be1a/packages/admin/src/ProtocolGovernance.ts#L7)

0 commit comments

Comments
 (0)