Skip to content

Commit 6cd7c39

Browse files
github-actions[bot]gha-aa-sdk[bot]
github-actions[bot]
and
gha-aa-sdk[bot]
authored
docs: update v5 SDK reference docs for 5.0.0-beta.29 (#2500)
Co-authored-by: gha-aa-sdk[bot] <269827238+gha-aa-sdk[bot]@users.noreply.github.com>
1 parent b96f9b7 commit 6cd7c39

49 files changed

Lines changed: 5814 additions & 386 deletions

Some content is hidden

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

‎docs/docs.yml‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -439,14 +439,20 @@ navigation:
439439
path: wallets/pages/reference/wallet-apis/src/exports/functions/undelegateAccount.mdx
440440
- page: requestQuoteV0 (experimental)
441441
path: wallets/pages/reference/wallet-apis/src/exports/experimental/functions/requestQuoteV0.mdx
442+
- section: Interfaces
443+
contents:
444+
- page: SolanaSigner
445+
path: wallets/pages/reference/wallet-apis/src/exports/interfaces/SolanaSigner.mdx
442446
- section: Type Aliases
443447
contents:
444448
- page: AlchemyWalletTransport
445449
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/AlchemyWalletTransport.mdx
446-
- page: BaseWalletClient
447-
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/BaseWalletClient.mdx
450+
- page: CreateEvmSmartWalletClientParams
451+
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/CreateEvmSmartWalletClientParams.mdx
448452
- page: CreateSmartWalletClientParams
449453
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/CreateSmartWalletClientParams.mdx
454+
- page: CreateSolanaSmartWalletClientParams
455+
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/CreateSolanaSmartWalletClientParams.mdx
450456
- page: FormatSignParams
451457
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/FormatSignParams.mdx
452458
- page: FormatSignResult
@@ -499,12 +505,12 @@ navigation:
499505
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/SignTypedDataParams.mdx
500506
- page: SignTypedDataResult
501507
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/SignTypedDataResult.mdx
502-
- page: SignerClient
503-
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/SignerClient.mdx
504508
- page: SmartWalletActions
505509
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/SmartWalletActions.mdx
506510
- page: SmartWalletClient
507511
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/SmartWalletClient.mdx
512+
- page: SolanaSmartWalletClient
513+
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/SolanaSmartWalletClient.mdx
508514
- page: UndelegateAccountParams
509515
path: wallets/pages/reference/wallet-apis/src/exports/type-aliases/UndelegateAccountParams.mdx
510516
- page: UndelegateAccountResult

‎docs/pages/reference/common/src/functions/isAlchemyConnectionConfig.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ layout: reference
1010
```ts
1111
function isAlchemyConnectionConfig(
1212
value,
13-
): value is { apiKey?: string; jwt?: string; url?: string };
13+
): value is { url?: string; jwt?: string; apiKey?: string };
1414
```
1515

1616
Defined in: [packages/common/src/transport/connectionSchema.ts:141](https://github.com/alchemyplatform/aa-sdk/blob/v5.x.x/packages/common/src/transport/connectionSchema.ts#L141)
@@ -63,6 +63,6 @@ if (isAlchemyConnectionConfig(maybeConfig)) {
6363

6464
## Returns
6565

66-
`value is { apiKey?: string; jwt?: string; url?: string }`
66+
`value is { url?: string; jwt?: string; apiKey?: string }`
6767

6868
True if the value is a valid Alchemy connection config

‎docs/pages/reference/common/src/variables/AlchemyConnectionConfigSchema.mdx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,36 +19,36 @@ const AlchemyConnectionConfigSchema: ZodEffects<
1919
"strict",
2020
ZodTypeAny,
2121
{
22-
apiKey?: string;
23-
jwt?: string;
2422
url?: string;
23+
jwt?: string;
24+
apiKey?: string;
2525
},
2626
{
27-
apiKey?: string;
28-
jwt?: string;
2927
url?: string;
28+
jwt?: string;
29+
apiKey?: string;
3030
}
3131
>,
3232
{
33-
apiKey?: string;
34-
jwt?: string;
3533
url?: string;
34+
jwt?: string;
35+
apiKey?: string;
3636
},
3737
{
38-
apiKey?: string;
39-
jwt?: string;
4038
url?: string;
39+
jwt?: string;
40+
apiKey?: string;
4141
}
4242
>,
4343
{
44-
apiKey?: string;
45-
jwt?: string;
4644
url?: string;
45+
jwt?: string;
46+
apiKey?: string;
4747
},
4848
{
49-
apiKey?: string;
50-
jwt?: string;
5149
url?: string;
50+
jwt?: string;
51+
apiKey?: string;
5252
}
5353
>;
5454
```

‎docs/pages/reference/wallet-apis/src/exports/README.mdx‎

Lines changed: 44 additions & 37 deletions
Large diffs are not rendered by default.

‎docs/pages/reference/wallet-apis/src/exports/experimental/functions/requestQuoteV0.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ layout: reference
1515
function requestQuoteV0(client, params): Promise<RequestQuoteV0Result>;
1616
```
1717

18-
Defined in: [packages/wallet-apis/src/experimental/actions/requestQuoteV0.ts:104](https://github.com/alchemyplatform/aa-sdk/blob/v5.x.x/packages/wallet-apis/src/experimental/actions/requestQuoteV0.ts#L104)
18+
Defined in: [packages/wallet-apis/src/experimental/actions/requestQuoteV0.ts:119](https://github.com/alchemyplatform/aa-sdk/blob/v5.x.x/packages/wallet-apis/src/experimental/actions/requestQuoteV0.ts#L119)
1919

2020
Requests a quote for a token swap, returning either prepared calls for smart wallets
2121
or raw calls for EOA wallets depending on the returnRawCalls parameter.

0 commit comments

Comments
 (0)