Skip to content

Commit bb4c444

Browse files
docs: update v5 SDK reference docs for 5.0.0-beta.17 (#2426)
Co-authored-by: gha-aa-sdk[bot] <269827238+gha-aa-sdk[bot]@users.noreply.github.com>
1 parent a79fbfe commit bb4c444

25 files changed

Lines changed: 81 additions & 58 deletions

docs/pages/reference/wallet-apis/src/exports/functions/formatSign.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ layout: reference
88
{/* This file is auto-generated by TypeDoc. Do not edit manually. */}
99

1010
```ts
11-
function formatSign(client, params): Promise<{}>;
11+
function formatSign(client, params): Promise<FormatSignResult>;
1212
```
1313

1414
Defined in: [packages/wallet-apis/src/actions/formatSign.ts:46](https://github.com/alchemyplatform/aa-sdk/blob/v5.x.x/packages/wallet-apis/src/actions/formatSign.ts#L46)
@@ -60,7 +60,7 @@ const result = await client.formatSign({
6060
</td>
6161

6262
<td>
63-
`Object`
63+
[`FormatSignParams`](../type-aliases/FormatSignParams)
6464
</td>
6565

6666
<td>
@@ -73,7 +73,6 @@ const result = await client.formatSign({
7373

7474
## Returns
7575

76-
`Promise`\<\{
77-
}>
76+
`Promise`\<[`FormatSignResult`](../type-aliases/FormatSignResult)>
7877

7978
A Promise that resolves to the formatSign result containing the formatted signature.

docs/pages/reference/wallet-apis/src/exports/functions/grantPermissions.mdx

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,7 @@ layout: reference
88
{/* This file is auto-generated by TypeDoc. Do not edit manually. */}
99

1010
```ts
11-
function grantPermissions(
12-
client,
13-
params,
14-
): Promise<{
15-
context: `0x${string}`;
16-
}>;
11+
function grantPermissions(client, params): Promise<GrantPermissionsResult>;
1712
```
1813

1914
Defined in: [packages/wallet-apis/src/actions/grantPermissions.ts:82](https://github.com/alchemyplatform/aa-sdk/blob/v5.x.x/packages/wallet-apis/src/actions/grantPermissions.ts#L82)
@@ -94,7 +89,7 @@ const result = await client.sendPreparedCalls({
9489
</td>
9590

9691
<td>
97-
`Object`
92+
[`GrantPermissionsParams`](../type-aliases/GrantPermissionsParams)
9893
</td>
9994

10095
<td>
@@ -107,8 +102,6 @@ const result = await client.sendPreparedCalls({
107102

108103
## Returns
109104

110-
`Promise`\<\{
111-
`context`: `` `0x${string}` ``;
112-
}>
105+
`Promise`\<[`GrantPermissionsResult`](../type-aliases/GrantPermissionsResult)>
113106

114107
A Promise that resolves to the result containing a context identifier

docs/pages/reference/wallet-apis/src/exports/functions/listAccounts.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ layout: reference
88
{/* This file is auto-generated by TypeDoc. Do not edit manually. */}
99

1010
```ts
11-
function listAccounts(client, params): Promise<{}>;
11+
function listAccounts(client, params): Promise<ListAccountsResult>;
1212
```
1313

1414
Defined in: [packages/wallet-apis/src/actions/listAccounts.ts:56](https://github.com/alchemyplatform/aa-sdk/blob/v5.x.x/packages/wallet-apis/src/actions/listAccounts.ts#L56)
@@ -64,7 +64,7 @@ const nextPage = await client.listAccounts({
6464
</td>
6565

6666
<td>
67-
`Object`
67+
[`ListAccountsParams`](../type-aliases/ListAccountsParams)
6868
</td>
6969

7070
<td>
@@ -77,7 +77,6 @@ const nextPage = await client.listAccounts({
7777

7878
## Returns
7979

80-
`Promise`\<\{
81-
}>
80+
`Promise`\<[`ListAccountsResult`](../type-aliases/ListAccountsResult)>
8281

8382
A Promise that resolves to the list of accounts and pagination metadata

docs/pages/reference/wallet-apis/src/exports/functions/prepareCalls.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ const result = await client.prepareCalls({
7070
</td>
7171

7272
<td>
73-
`Object`
73+
[`PrepareCallsParams`](../type-aliases/PrepareCallsParams)
7474
</td>
7575

7676
<td>

docs/pages/reference/wallet-apis/src/exports/functions/prepareSign.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ layout: reference
88
{/* This file is auto-generated by TypeDoc. Do not edit manually. */}
99

1010
```ts
11-
function prepareSign(client, params): Promise<{}>;
11+
function prepareSign(client, params): Promise<PrepareSignResult>;
1212
```
1313

1414
Defined in: [packages/wallet-apis/src/actions/prepareSign.ts:44](https://github.com/alchemyplatform/aa-sdk/blob/v5.x.x/packages/wallet-apis/src/actions/prepareSign.ts#L44)
@@ -71,7 +71,6 @@ const result = await client.prepareSign({
7171

7272
## Returns
7373

74-
`Promise`\<\{
75-
}>
74+
`Promise`\<[`PrepareSignResult`](../type-aliases/PrepareSignResult)>
7675

7776
A Promise that resolves to the prepare sign result containing a signature request

docs/pages/reference/wallet-apis/src/exports/functions/requestAccount.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ const account = await client.requestAccount();
6161
</td>
6262

6363
<td>
64-
`any`
64+
[`RequestAccountParams`](../type-aliases/RequestAccountParams)
6565
</td>
6666

6767
<td>

docs/pages/reference/wallet-apis/src/exports/functions/sendCalls.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ layout: reference
88
{/* This file is auto-generated by TypeDoc. Do not edit manually. */}
99

1010
```ts
11-
function sendCalls(client, params): Promise<{}>;
11+
function sendCalls(client, params): Promise<SendCallsResult>;
1212
```
1313

1414
Defined in: [packages/wallet-apis/src/actions/sendCalls.ts:56](https://github.com/alchemyplatform/aa-sdk/blob/v5.x.x/packages/wallet-apis/src/actions/sendCalls.ts#L56)
@@ -76,7 +76,7 @@ from the user. It is recommended to use the `prepareCalls` action instead to man
7676
</td>
7777

7878
<td>
79-
`Object`
79+
[`SendCallsParams`](../type-aliases/SendCallsParams)
8080
</td>
8181

8282
<td>
@@ -89,7 +89,6 @@ from the user. It is recommended to use the `prepareCalls` action instead to man
8989

9090
## Returns
9191

92-
`Promise`\<\{
93-
}>
92+
`Promise`\<[`SendCallsResult`](../type-aliases/SendCallsResult)>
9493

9594
A Promise that resolves to the result containing the call ID.

docs/pages/reference/wallet-apis/src/exports/functions/sendPreparedCalls.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ layout: reference
88
{/* This file is auto-generated by TypeDoc. Do not edit manually. */}
99

1010
```ts
11-
function sendPreparedCalls(client, params): Promise<{}>;
11+
function sendPreparedCalls(client, params): Promise<SendPreparedCallsResult>;
1212
```
1313

1414
Defined in: [packages/wallet-apis/src/actions/sendPreparedCalls.ts:63](https://github.com/alchemyplatform/aa-sdk/blob/v5.x.x/packages/wallet-apis/src/actions/sendPreparedCalls.ts#L63)
@@ -87,7 +87,6 @@ const result = await client.sendPreparedCalls({
8787

8888
## Returns
8989

90-
`Promise`\<\{
91-
}>
90+
`Promise`\<[`SendPreparedCallsResult`](../type-aliases/SendPreparedCallsResult)>
9291

9392
A Promise that resolves to the result containing the call ID

docs/pages/reference/wallet-apis/src/exports/functions/signMessage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ const signature = await client.signMessage({
6060
</td>
6161

6262
<td>
63-
`Object`
63+
[`SignMessageParams`](../type-aliases/SignMessageParams)
6464
</td>
6565

6666
<td>

docs/pages/reference/wallet-apis/src/exports/functions/signSignatureRequest.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ const result = await client.signSignatureRequest({
7272
</td>
7373

7474
<td>
75-
`WithoutRawPayload`
75+
[`SignSignatureRequestParams`](../type-aliases/SignSignatureRequestParams)
7676
</td>
7777

7878
<td>

0 commit comments

Comments
 (0)