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
  •  
  •  
  •  
183 changes: 183 additions & 0 deletions docs/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1424,6 +1424,189 @@ navigation:
path: wallets/pages/reference/account-kit/core/src/variables/zora.mdx
- page: zoraSepolia
path: wallets/pages/reference/account-kit/core/src/variables/zoraSepolia.mdx
- section: Infra
path: wallets/pages/reference/account-kit/infra/src/exports/README.mdx
contents:
- section: Enumerations
contents:
- page: SimulateAssetType
path: wallets/pages/reference/account-kit/infra/src/exports/enumerations/SimulateAssetType.mdx
- page: SimulateChangeType
path: wallets/pages/reference/account-kit/infra/src/exports/enumerations/SimulateChangeType.mdx
- section: Functions
contents:
- page: alchemy
path: wallets/pages/reference/account-kit/infra/src/exports/functions/alchemy.mdx
- page: alchemyGasAndPaymasterAndDataMiddleware
path: wallets/pages/reference/account-kit/infra/src/exports/functions/alchemyGasAndPaymasterAndDataMiddleware.mdx
- page: alchemyGasManagerMiddleware
path: wallets/pages/reference/account-kit/infra/src/exports/functions/alchemyGasManagerMiddleware.mdx
- page: alchemyUserOperationSimulator
path: wallets/pages/reference/account-kit/infra/src/exports/functions/alchemyUserOperationSimulator.mdx
- page: convertHeadersToObject
path: wallets/pages/reference/account-kit/infra/src/exports/functions/convertHeadersToObject.mdx
- page: createAlchemyPublicRpcClient
path: wallets/pages/reference/account-kit/infra/src/exports/functions/createAlchemyPublicRpcClient.mdx
- page: createAlchemySmartAccountClient
path: wallets/pages/reference/account-kit/infra/src/exports/functions/createAlchemySmartAccountClient.mdx
- page: defineAlchemyChain
path: wallets/pages/reference/account-kit/infra/src/exports/functions/defineAlchemyChain.mdx
- page: getAlchemyPaymasterAddress
path: wallets/pages/reference/account-kit/infra/src/exports/functions/getAlchemyPaymasterAddress.mdx
- page: getDefaultUserOperationFeeOptions
path: wallets/pages/reference/account-kit/infra/src/exports/functions/getDefaultUserOperationFeeOptions.mdx
- page: getSignerTypeHeader
path: wallets/pages/reference/account-kit/infra/src/exports/functions/getSignerTypeHeader.mdx
- page: headersUpdate
path: wallets/pages/reference/account-kit/infra/src/exports/functions/headersUpdate.mdx
- page: isAlchemySmartAccountClient
path: wallets/pages/reference/account-kit/infra/src/exports/functions/isAlchemySmartAccountClient.mdx
- page: isAlchemyTransport
path: wallets/pages/reference/account-kit/infra/src/exports/functions/isAlchemyTransport.mdx
- page: mutateRemoveTrackingHeaders
path: wallets/pages/reference/account-kit/infra/src/exports/functions/mutateRemoveTrackingHeaders.mdx
- section: Interfaces
contents:
- page: SimulateAssetChange
path: wallets/pages/reference/account-kit/infra/src/exports/interfaces/SimulateAssetChange.mdx
- page: SimulateAssetChangesError
path: wallets/pages/reference/account-kit/infra/src/exports/interfaces/SimulateAssetChangesError.mdx
- section: Type Aliases
contents:
- page: AlchemyChainConfig
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/AlchemyChainConfig.mdx
- page: AlchemyRpcSchema
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/AlchemyRpcSchema.mdx
- page: AlchemySmartAccountClient
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/AlchemySmartAccountClient.mdx
- page: AlchemySmartAccountClientActions
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/AlchemySmartAccountClientActions.mdx
- page: AlchemySmartAccountClientConfig
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/AlchemySmartAccountClientConfig.mdx
- page: AlchemySmartAccountClient_Base
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/AlchemySmartAccountClient_Base.mdx
- page: AlchemyTransport
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/AlchemyTransport.mdx
- page: AlchemyTransportConfig
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/AlchemyTransportConfig.mdx
- page: BaseAlchemyActions
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/BaseAlchemyActions.mdx
- page: ClientWithAlchemyMethods
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/ClientWithAlchemyMethods.mdx
- page: PolicyToken
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/PolicyToken.mdx
- page: RequestGasAndPaymasterAndDataRequest
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/RequestGasAndPaymasterAndDataRequest.mdx
- page: RequestGasAndPaymasterAndDataResponse
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/RequestGasAndPaymasterAndDataResponse.mdx
- page: RequestPaymasterTokenQuoteRequest
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/RequestPaymasterTokenQuoteRequest.mdx
- page: RequestPaymasterTokenQuoteResponse
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/RequestPaymasterTokenQuoteResponse.mdx
- page: SimulateUserOperationAssetChangesRequest
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/SimulateUserOperationAssetChangesRequest.mdx
- page: SimulateUserOperationAssetChangesResponse
path: wallets/pages/reference/account-kit/infra/src/exports/type-aliases/SimulateUserOperationAssetChangesResponse.mdx
- section: Variables
contents:
- page: AlchemyChainSchema
path: wallets/pages/reference/account-kit/infra/src/exports/variables/AlchemyChainSchema.mdx
- page: alchemyActions
path: wallets/pages/reference/account-kit/infra/src/exports/variables/alchemyActions.mdx
- page: alchemyFeeEstimator
path: wallets/pages/reference/account-kit/infra/src/exports/variables/alchemyFeeEstimator.mdx
- page: arbitrum
path: wallets/pages/reference/account-kit/infra/src/exports/variables/arbitrum.mdx
- page: arbitrumGoerli
path: wallets/pages/reference/account-kit/infra/src/exports/variables/arbitrumGoerli.mdx
- page: arbitrumNova
path: wallets/pages/reference/account-kit/infra/src/exports/variables/arbitrumNova.mdx
- page: arbitrumSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/arbitrumSepolia.mdx
- page: base
path: wallets/pages/reference/account-kit/infra/src/exports/variables/base.mdx
- page: baseGoerli
path: wallets/pages/reference/account-kit/infra/src/exports/variables/baseGoerli.mdx
- page: baseSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/baseSepolia.mdx
- page: beraChainBartio
path: wallets/pages/reference/account-kit/infra/src/exports/variables/beraChainBartio.mdx
- page: bobaMainnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/bobaMainnet.mdx
- page: bobaSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/bobaSepolia.mdx
- page: celoAlfajores
path: wallets/pages/reference/account-kit/infra/src/exports/variables/celoAlfajores.mdx
- page: celoMainnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/celoMainnet.mdx
- page: fraxtal
path: wallets/pages/reference/account-kit/infra/src/exports/variables/fraxtal.mdx
- page: fraxtalSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/fraxtalSepolia.mdx
- page: gensynTestnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/gensynTestnet.mdx
- page: goerli
path: wallets/pages/reference/account-kit/infra/src/exports/variables/goerli.mdx
- page: inkMainnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/inkMainnet.mdx
- page: inkSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/inkSepolia.mdx
- page: mainnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/mainnet.mdx
- page: mekong
path: wallets/pages/reference/account-kit/infra/src/exports/variables/mekong.mdx
- page: monadTestnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/monadTestnet.mdx
- page: opbnbMainnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/opbnbMainnet.mdx
- page: opbnbTestnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/opbnbTestnet.mdx
- page: openlootSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/openlootSepolia.mdx
- page: optimism
path: wallets/pages/reference/account-kit/infra/src/exports/variables/optimism.mdx
- page: optimismGoerli
path: wallets/pages/reference/account-kit/infra/src/exports/variables/optimismGoerli.mdx
- page: optimismSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/optimismSepolia.mdx
- page: polygon
path: wallets/pages/reference/account-kit/infra/src/exports/variables/polygon.mdx
- page: polygonAmoy
path: wallets/pages/reference/account-kit/infra/src/exports/variables/polygonAmoy.mdx
- page: polygonMumbai
path: wallets/pages/reference/account-kit/infra/src/exports/variables/polygonMumbai.mdx
- page: riseTestnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/riseTestnet.mdx
- page: sepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/sepolia.mdx
- page: shape
path: wallets/pages/reference/account-kit/infra/src/exports/variables/shape.mdx
- page: shapeSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/shapeSepolia.mdx
- page: simulateUserOperationChanges
path: wallets/pages/reference/account-kit/infra/src/exports/variables/simulateUserOperationChanges.mdx
- page: soneiumMainnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/soneiumMainnet.mdx
- page: soneiumMinato
path: wallets/pages/reference/account-kit/infra/src/exports/variables/soneiumMinato.mdx
- page: storyAeneid
path: wallets/pages/reference/account-kit/infra/src/exports/variables/storyAeneid.mdx
- page: storyMainnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/storyMainnet.mdx
- page: teaSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/teaSepolia.mdx
- page: unichainMainnet
path: wallets/pages/reference/account-kit/infra/src/exports/variables/unichainMainnet.mdx
- page: unichainSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/unichainSepolia.mdx
- page: worldChain
path: wallets/pages/reference/account-kit/infra/src/exports/variables/worldChain.mdx
- page: worldChainSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/worldChainSepolia.mdx
- page: zora
path: wallets/pages/reference/account-kit/infra/src/exports/variables/zora.mdx
- page: zoraSepolia
path: wallets/pages/reference/account-kit/infra/src/exports/variables/zoraSepolia.mdx
- section: React
path: wallets/pages/reference/account-kit/react/src/README.mdx
contents:
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/concepts/middleware.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Middleware allows you to avoid having to write the same flows over and over when
As mentioned above, the client can be configured with a series of middleware that always run in the same order:

1. `dummyPaymasterAndData` - Generates a dummy paymaster and data for gas estimation if using a paymaster (default: noop)
2. `feeEstimator` - Estimates the fees for a user operation. If you are using our RPCs, it's important to use the [`alchemyFeeEstimator`](/wallets/reference/account-kit/infra/functions/alchemyFeeEstimator) middleware.
2. `feeEstimator` - Estimates the fees for a user operation. If you are using our RPCs, it's important to use the [`alchemyFeeEstimator`](/wallets/reference/account-kit/core/variables/alchemyFeeEstimator) middleware.
3. `gasEstimator` - Estimates the gas limits for a user operation. The default middleware calls the underlying bundler RPC to `eth_estimateUserOperationGas`.
4. `customMiddleware` - Allows you define custom middleware to run before requesting sponsorship if there are any additional steps you need to take before requesting sponsorship. (default: noop)
5. `paymasterAndData` - Requests a gas sponsorship from a paymaster. (default: noop)
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/react/solana-wallets/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ function MyComponent() {

## Using the `useSolanaTransaction` hook

If you want to connect to a user’s Solana Wallet and send transactions, you should use the [`useSolanaTransaction`](/wallets/transactions/send/send-solana-user-operations) hook. This hook also exposes the Solana wallet address through the `signer.address` parameter.
If you want to connect to a user’s Solana Wallet and send transactions, you should use the [`useSolanaTransaction`](/wallets/reference/account-kit/react/hooks/useSolanaTransaction) hook. This hook also exposes the Solana wallet address through the `signer.address` parameter.

## Not using React hooks?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ layout: reference

{/* This file is auto-generated by TypeDoc. Do not edit manually. */}

Defined in: [aa-sdk/core/src/errors/account.ts:8](https://github.com/alchemyplatform/aa-sdk/blob/c1a84188d03473acac2fdb49fb7cd7fdba73169b/aa-sdk/core/src/errors/account.ts#L8)
Defined in: [aa-sdk/core/src/errors/account.ts:8](https://github.com/alchemyplatform/aa-sdk/blob/dc58c113ff1eeb06d4b3f76c505cbbaad47db8fc/aa-sdk/core/src/errors/account.ts#L8)

This error is thrown when an account could not be found to execute a specific action. It extends the `BaseError` class.

Expand All @@ -23,7 +23,7 @@ This error is thrown when an account could not be found to execute a specific ac
new AccountNotFoundError(): AccountNotFoundError;
```

Defined in: [aa-sdk/core/src/errors/account.ts:15](https://github.com/alchemyplatform/aa-sdk/blob/c1a84188d03473acac2fdb49fb7cd7fdba73169b/aa-sdk/core/src/errors/account.ts#L15)
Defined in: [aa-sdk/core/src/errors/account.ts:15](https://github.com/alchemyplatform/aa-sdk/blob/dc58c113ff1eeb06d4b3f76c505cbbaad47db8fc/aa-sdk/core/src/errors/account.ts#L15)

Constructor for initializing an error message indicating that an account could not be found to execute the specified action.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ layout: reference

{/* This file is auto-generated by TypeDoc. Do not edit manually. */}

Defined in: [aa-sdk/core/src/errors/account.ts:138](https://github.com/alchemyplatform/aa-sdk/blob/c1a84188d03473acac2fdb49fb7cd7fdba73169b/aa-sdk/core/src/errors/account.ts#L138)
Defined in: [aa-sdk/core/src/errors/account.ts:138](https://github.com/alchemyplatform/aa-sdk/blob/dc58c113ff1eeb06d4b3f76c505cbbaad47db8fc/aa-sdk/core/src/errors/account.ts#L138)

Represents an error that occurs when an account requires an owner to execute but none is provided.

Expand All @@ -23,7 +23,7 @@ Represents an error that occurs when an account requires an owner to execute but
new AccountRequiresOwnerError(accountType): AccountRequiresOwnerError;
```

Defined in: [aa-sdk/core/src/errors/account.ts:146](https://github.com/alchemyplatform/aa-sdk/blob/c1a84188d03473acac2fdb49fb7cd7fdba73169b/aa-sdk/core/src/errors/account.ts#L146)
Defined in: [aa-sdk/core/src/errors/account.ts:146](https://github.com/alchemyplatform/aa-sdk/blob/dc58c113ff1eeb06d4b3f76c505cbbaad47db8fc/aa-sdk/core/src/errors/account.ts#L146)

Constructs an error indicating that an account of the specified type requires an owner to execute.

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/reference/aa-sdk/core/src/classes/BaseError.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ layout: reference

{/* This file is auto-generated by TypeDoc. Do not edit manually. */}

Defined in: [aa-sdk/core/src/errors/base.ts:24](https://github.com/alchemyplatform/aa-sdk/blob/c1a84188d03473acac2fdb49fb7cd7fdba73169b/aa-sdk/core/src/errors/base.ts#L24)
Defined in: [aa-sdk/core/src/errors/base.ts:24](https://github.com/alchemyplatform/aa-sdk/blob/dc58c113ff1eeb06d4b3f76c505cbbaad47db8fc/aa-sdk/core/src/errors/base.ts#L24)

A custom error class that extends from `ViemBaseError`. This class allows for error messages to include links to relevant documentation based on provided `docsPath` and `docsSlug` parameters.
This is based on on viem's BaseError type (obviously from the import and extend)
Expand Down Expand Up @@ -55,7 +55,7 @@ we want the errors here to point to our docs if we supply a docsPath though
new BaseError(shortMessage, args): BaseError;
```

Defined in: [aa-sdk/core/src/errors/base.ts:28](https://github.com/alchemyplatform/aa-sdk/blob/c1a84188d03473acac2fdb49fb7cd7fdba73169b/aa-sdk/core/src/errors/base.ts#L28)
Defined in: [aa-sdk/core/src/errors/base.ts:28](https://github.com/alchemyplatform/aa-sdk/blob/dc58c113ff1eeb06d4b3f76c505cbbaad47db8fc/aa-sdk/core/src/errors/base.ts#L28)

#### Parameters

Expand Down
Loading
Loading