Skip to content

Commit

Permalink
fix: move user op fee options and overrides types in doc to inside th…
Browse files Browse the repository at this point in the history
…e provider section
  • Loading branch information
denniswon committed Dec 1, 2023
1 parent 0d6bf9b commit ea6a9bf
Show file tree
Hide file tree
Showing 16 changed files with 35 additions and 35 deletions.
38 changes: 19 additions & 19 deletions site/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,25 @@ export default defineConfig({
text: "extend",
link: "/extend",
},
{
text: "Types",
base: "/packages/aa-core/provider/types",
collapsed: true,
items: [
{
text: "userOperationFeeOptions",
link: "/userOperationFeeOptions",
},
{
text: "UserOperationFeeOptionsField",
link: "/userOperationFeeOptionsField",
},
{
text: "UserOperationOverrides",
link: "/userOperationOverrides",
},
],
},
],
},
{
Expand Down Expand Up @@ -451,25 +470,6 @@ export default defineConfig({
},
],
},
{
text: "Types",
base: "/packages/aa-core/types",
collapsed: true,
items: [
{
text: "UserOperationFeeOptions",
link: "/UserOperationFeeOptions",
},
{
text: "UserOperationFeeOptionsField",
link: "/userOperationFeeOptionsField",
},
{
text: "UserOperationOverrides",
link: "/userOperationOverrides",
},
],
},
{
text: "Utils",
base: "/packages/aa-core/utils",
Expand Down
4 changes: 2 additions & 2 deletions site/packages/aa-accounts/light-account/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ A Promise containing a new `SmartAccountProvider` connected to a Light Account.

- `txRetryMulitplier: string | undefined` -- [optional] the mulitplier on interval length to wait between retries while waiting for transaction receipts (default: 1.5).

- `feeOptions:` [`UserOperationFeeOptions`](/packages/aa-core/types/userOperationFeeOptions.md) `| undefined` --[optional] user operation fee options to be used for gas estimation, set at the global level on the provider.
If not set, default fee options for the chain are used. Available fields in `feeOptions` include `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` where each field is of type [`UserOperationFeeOptionsField`](/packages/aa-core/types/userOperationFeeOptionsField.md).
- `feeOptions:` [`UserOperationFeeOptions`](/packages/aa-core/provider/types/UserOperationFeeOptions.md) `| undefined` --[optional] user operation fee options to be used for gas estimation, set at the global level on the provider.
If not set, default fee options for the chain are used. Available fields in `feeOptions` include `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` where each field is of type [`UserOperationFeeOptionsField`](/packages/aa-core/provider/types/UserOperationFeeOptionsField.md).

- `maxFeePerGas`: `UserOperationFeeOptionsField`
- `maxPriorityFeePerGas`: `UserOperationFeeOptionsField`
Expand Down
4 changes: 2 additions & 2 deletions site/packages/aa-alchemy/provider/constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ A new instance of an `AlchemyProvider`.

- `txRetryMulitplier: string | undefined` -- [optional] the mulitplier on interval length to wait between retries while waiting for transaction receipts (default: 1.5).

- `feeOptions:` [`UserOperationFeeOptions`](/packages/aa-core/types/userOperationFeeOptions.md) `| undefined` --[optional] user operation fee options to be used for gas estimation, set at the global level on the provider.
If not set, default fee options for the chain are used. Available fields in `feeOptions` include `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` where each field is of type [`UserOperationFeeOptionsField`](/packages/aa-core/types/userOperationFeeOptionsField.md).
- `feeOptions:` [`UserOperationFeeOptions`](/packages/aa-core/provider/types/UserOperationFeeOptions.md) `| undefined` --[optional] user operation fee options to be used for gas estimation, set at the global level on the provider.
If not set, default fee options for the chain are used. Available fields in `feeOptions` include `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` where each field is of type [`UserOperationFeeOptionsField`](/packages/aa-core/provider/types/UserOperationFeeOptionsField.md).

- `maxFeePerGas`: `UserOperationFeeOptionsField`
- `maxPriorityFeePerGas`: `UserOperationFeeOptionsField`
Expand Down
4 changes: 2 additions & 2 deletions site/packages/aa-alchemy/provider/light-account-factory.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ A Promise containing a new `AlchemyProvider` connected to a Light Account.

- `txRetryMulitplier: string | undefined` -- [optional] the mulitplier on interval length to wait between retries while waiting for transaction receipts (default: 1.5).

- `feeOptions:` [`UserOperationFeeOptions`](/packages/aa-core/types/userOperationFeeOptions.md) `| undefined` --[optional] user operation fee options to be used for gas estimation, set at the global level on the provider.
If not set, default fee options for the chain are used. Available fields in `feeOptions` include `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` where each field is of type [`UserOperationFeeOptionsField`](/packages/aa-core/types/userOperationFeeOptionsField.md).
- `feeOptions:` [`UserOperationFeeOptions`](/packages/aa-core/provider/types/UserOperationFeeOptions.md) `| undefined` --[optional] user operation fee options to be used for gas estimation, set at the global level on the provider.
If not set, default fee options for the chain are used. Available fields in `feeOptions` include `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` where each field is of type [`UserOperationFeeOptionsField`](/packages/aa-core/provider/types/UserOperationFeeOptionsField.md).

- `maxFeePerGas`: `UserOperationFeeOptionsField`
- `maxPriorityFeePerGas`: `UserOperationFeeOptionsField`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@ const uo = await provider.sendUserOperation(uoStruct);
- `data: Hex` - can be either `0x` or a call data string
- `value?: bigint` - optionally, set the value in wei you want to send to the target

### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/types/userOperationOverrides.md)
### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/provider/types/userOperationOverrides.md)

Optional parameter where you can specify override values for `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` or `paymasterAndData` on the user operation request
2 changes: 1 addition & 1 deletion site/packages/aa-core/provider/buildUserOperation.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,6 @@ A Promise containing the _unsigned_ UO struct resulting from the middleware pipe
- `data: Hex` - can be either `0x` or a call data string
- `value?: bigint` - optionally, set the value in wei you want to send to the target

### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/types/userOperationOverrides.md)
### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/provider/types/userOperationOverrides.md)

Optional parameter where you can specify override values for `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` or `paymasterAndData` on the user operation request
2 changes: 1 addition & 1 deletion site/packages/aa-core/provider/buildUserOperationFromTx.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@ A Promise containing the _unsigned_ UO struct converted from the input transacti

The `RpcTransactionRequest` object representing a traditional ethereum transaction

### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/types/userOperationOverrides.md)
### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/provider/types/userOperationOverrides.md)

Optional parameter where you can specify override values for `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` or `paymasterAndData` on the user operation request
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ A Promise containing the boolean value indicating whether the UO to be sent is e
- `data: Hex` - can be either `0x` or a call data string
- `value?: bigint` - optionally, set the value in wei you want to send to the target

### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/types/userOperationOverrides.md)
### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/provider/types/userOperationOverrides.md)

Optional parameter where you can specify override values for `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` or `paymasterAndData` on the user operation request
4 changes: 2 additions & 2 deletions site/packages/aa-core/provider/constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ A new instance of a `SmartAccountProvider`.

- `txRetryMulitplier: string | undefined` -- [optional] the mulitplier on interval length to wait between retries while waiting for transaction receipts (default: 1.5).

- `feeOptions:` [`UserOperationFeeOptions`](/packages/aa-core/types/userOperationFeeOptions.md) `| undefined` --[optional] user operation fee options to be used for gas estimation, set at the global level on the provider.
If not set, default fee options for the chain are used. Available fields in `feeOptions` include `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` where each field is of type [`UserOperationFeeOptionsField`](/packages/aa-core/types/userOperationFeeOptionsField.md).
- `feeOptions:` [`UserOperationFeeOptions`](/packages/aa-core/provider/types/UserOperationFeeOptions.md) `| undefined` --[optional] user operation fee options to be used for gas estimation, set at the global level on the provider.
If not set, default fee options for the chain are used. Available fields in `feeOptions` include `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` where each field is of type [`UserOperationFeeOptionsField`](/packages/aa-core/provider/types/UserOperationFeeOptionsField.md).

- `maxFeePerGas`: `UserOperationFeeOptionsField`
- `maxPriorityFeePerGas`: `UserOperationFeeOptionsField`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ A Promise containing the hash of the user operation and the request that was sen

A previously submitted `UserOperation`.

### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/types/userOperationOverrides.md)
### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/provider/types/userOperationOverrides.md)

Optional parameter where you can specify override values for `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` or `paymasterAndData` on the user operation request
2 changes: 1 addition & 1 deletion site/packages/aa-core/provider/sendTransaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ A Promise containing the transaction hash

The `RpcTransactionRequest` object representing a traditional ethereum transaction

### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/types/userOperationOverrides.md)
### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/provider/types/userOperationOverrides.md)

Optional parameter where you can specify override values for `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` or `paymasterAndData` on the user operation request
2 changes: 1 addition & 1 deletion site/packages/aa-core/provider/sendTransactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,6 @@ A Promise containing the transaction hash

An `RpcTransactionRequest` array representing a traditional ethereum transaction

### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/types/userOperationOverrides.md)
### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/provider/types/userOperationOverrides.md)

Optional parameter where you can specify override values for `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` or `paymasterAndData` on the user operation request
2 changes: 1 addition & 1 deletion site/packages/aa-core/provider/sendUserOperation.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,6 @@ A Promise containing the hash of the user operation and the request that was sen
- `data: Hex` - can be either `0x` or a call data string
- `value?: bigint` - optionally, set the value in wei you want to send to the target

### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/types/userOperationOverrides.md)
### `overrides?:` [`UserOperationOverrides`](/packages/aa-core/provider/types/userOperationOverrides.md)

Optional parameter where you can specify override values for `maxFeePerGas`, `maxPriorityFeePerGas`, `callGasLimit`, `preVerificationGas`, `verificationGasLimit` or `paymasterAndData` on the user operation request

0 comments on commit ea6a9bf

Please sign in to comment.