Skip to content

Commit 4ef9164

Browse files
committed
Added v6 methods.
Signed-off-by: bgravenorst <[email protected]>
1 parent fe9c8cc commit 4ef9164

11 files changed

+189
-60
lines changed
Lines changed: 63 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
1-
- `userOperation`: (object) - The user operation object containing the following fields:
1+
import Tabs from "@theme/Tabs"
2+
import TabItem from "@theme/TabItem"
3+
4+
<Tabs>
5+
<TabItem value="v0.7" label="v0.7 and v0.8 user operation">
6+
7+
- `userOperation`: The user operation object containing the following fields:
8+
29
- `sender`: (string) - The address of the account making the operation.
3-
- `nonce`: (string) - The account nonce.
4-
- `factory`: (string) [_optional_] - The factory contract address that will deploy the smart account
5-
if it doesn't exist yet.
10+
- `nonce`: (string) - Unique identifier for the request from this sender. This includes the key and sequence number.
11+
- `factory`: (string) [_optional_] - The factory contract address that will deploy the smart account if it doesn't exist yet.
612
- `factoryData`: (string) [_optional_] - The data passed to the factory contract to deploy the smart account.
7-
- `callData`: (string) - The data to pass to the sender during the main execution call.
13+
- `callData`: (string) [_optional_] - The data to pass to the sender during the main execution call.
814
- `callGasLimit`: (string) - The amount of gas to allocate the main execution call.
915
- `verificationGasLimit`: (string) - The amount of gas to allocate for the verification step.
10-
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for
11-
pre-verification execution and `calldata`.
16+
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for pre-verification execution and `calldata`.
1217
- `maxFeePerGas`: (string) - Maximum fee per gas, in wei, the sender is willing to pay per gas.
13-
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above
14-
the base fee.
18+
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above the base fee.
1519
- `paymaster`: (string) [_optional_] - Address of paymaster sponsoring the transaction, or `null` if none.
16-
- `paymasterVerificationGasLimit`: (string) [_optional_] - The amount of gas to allocate for the
17-
verification step of the paymaster, or `null` if no paymaster.
18-
- `paymasterPostOpGasLimit`: (string) [_optional_] - The amount of gas to allocate for the
19-
post-operation step of the paymaster, or `null` if no paymaster.
20-
- `paymasterData`: (string) [_optional_] - The data to pass to the paymaster during the verification
21-
step, or `null` if no paymaster.
22-
- `signature`: (string) - The signature data. For gas estimation, this can be a dummy signature. For example,
23-
`0xfffffffffffffffffffffffffffffff0000000000000000000000000000000007aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1c`
24-
- `eip7702Auth`: (object) [_optional_] - The EIP-7702 authorization data. This can be a dummy authorization
25-
for estimations:
20+
- `paymasterVerificationGasLimit`: (string) [_optional_] - The amount of gas to allocate for the verification step of the paymaster, or `null` if no paymaster.
21+
- `paymasterPostOpGasLimit`: (string) [_optional_] - The amount of gas to allocate for the post-operation step of the paymaster, or `null` if no paymaster.
22+
- `paymasterData`: (string) [_optional_] - The data to pass to the paymaster during the verification step, or `null` if no paymaster.
23+
- `signature`: (string) - The signature data. For gas estimation, this can be a dummy signature.
24+
- `eip7702Auth`: (object) [_optional_] - The EIP-7702 authorization data. This can be a dummy authorization for estimations. `SignedAuthorization Type`:
2625
- `address`: (string) - The contract address for the authorization.
2726
- `chainId`: (string) - The chain ID.
2827
- `nonce`: (string) - The nonce.
@@ -31,15 +30,48 @@
3130
- `v`: (string) - The v component of the signature.
3231
- `yParity`: (string) - The y-parity value.
3332

34-
- `entryPoint`: (string) - The entry point contract address (`0x0000000071727De22E5E9d8BAf0edAc6f37da032`).
35-
36-
- `stateOverrides`: (object) [_optional_] - State overrides to apply for the simulation:
37-
- Each key is an address.
38-
- Each value is an object that can contain:
39-
- `balance`: (string) [_optional_] - The balance to set for the address.
40-
- `nonce`: (string) [_optional_] - The nonce to set for the address.
41-
- `code`: (string) [_optional_] - The code to set for the address.
42-
- `state`: (object) [_optional_] - Complete state to set, where each key is a 32-byte hex storage
43-
slot and each value is a 32-byte hex value.
44-
- `stateDiff`: (object) [_optional_] - State differences to apply, where each key is a 32-byte hex
45-
storage slot and each value is a 32-byte hex value.
33+
- `entryPoint`: (string) - The EntryPoint contract address (`0x0000000071727De22E5E9d8BAf0edAc6f37da032`).
34+
35+
- `stateOverrides`: (object) [_optional_] - State overrides to apply for the simulation. Each key is an address, and each value is an object that can contain:
36+
- `balance`: (string) [_optional_] - The balance to set for the address.
37+
- `nonce`: (string) [_optional_] - The nonce to set for the address.
38+
- `code`: (string) [_optional_] - The code to set for the address.
39+
- `state`: (object) [_optional_] - Complete state to set, where each key is a 32-byte hex storage slot and each value is a 32-byte hex value.
40+
- `stateDiff`: (object) [_optional_] - State differences to apply, where each key is a 32-byte hex storage slot and each value is a 32-byte hex value.
41+
42+
</TabItem>
43+
<TabItem value="v0.6" label="v0.6 user operation">
44+
45+
- `userOperation`: The user operation object containing the following fields:
46+
47+
- `sender`: (string) - The address of the account making the operation.
48+
- `nonce`: (string) - Unique identifier for the request from this sender.
49+
- `initCode`: (string) - The initialization code for the smart account if it doesn't exist yet.
50+
- `callData`: (string) [_optional_] - The data to pass to the sender during the main execution call.
51+
- `callGasLimit`: (string) - The amount of gas to allocate the main execution call.
52+
- `verificationGasLimit`: (string) - The amount of gas to allocate for the verification step.
53+
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for pre-verification execution and `calldata`.
54+
- `maxFeePerGas`: (string) - Maximum fee per gas, in wei, the sender is willing to pay per gas.
55+
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above the base fee.
56+
- `paymasterAndData`: (string) - The address of the paymaster contract and the data that will be passed to it.
57+
- `signature`: (string) - The signature data. For gas estimation, this can be a dummy signature.
58+
- `eip7702Auth`: (object) [_optional_] - The EIP-7702 authorization data. This can be a dummy authorization for estimations. `SignedAuthorization Type`:
59+
- `address`: (string) - The contract address for the authorization.
60+
- `chainId`: (string) - The chain ID.
61+
- `nonce`: (string) - The nonce.
62+
- `r`: (string) - The r component of the signature.
63+
- `s`: (string) - The s component of the signature.
64+
- `v`: (string) - The v component of the signature.
65+
- `yParity`: (string) - The y-parity value.
66+
67+
- `entryPoint`: (string) - The EntryPoint contract address (`0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789`).
68+
69+
- `stateOverrides`: (object) [_optional_] - State overrides to apply for the simulation. Each key is an address, and each value is an object that can contain:
70+
- `balance`: (string) [_optional_] - The balance to set for the address.
71+
- `nonce`: (string) [_optional_] - The nonce to set for the address.
72+
- `code`: (string) [_optional_] - The code to set for the address.
73+
- `state`: (object) [_optional_] - Complete state to set, where each key is a 32-byte hex storage slot and each value is a 32-byte hex value.
74+
- `stateDiff`: (object) [_optional_] - State differences to apply, where each key is a 32-byte hex storage slot and each value is a 32-byte hex value.
75+
76+
</TabItem>
77+
</Tabs>

services/reference/_partials/bundler/_eth_estimateuseroperationgas-request.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ import TabItem from "@theme/TabItem"
4949
{
5050
"sender": "0xa203fDb8bC335F86016F635b85389B62B189E417",
5151
"nonce": "0x35bf2a054f92f3730b87582ef223c8d663f9eb01158154750000000000000000",
52-
"factory": "0x",
52+
"factory": "0xd703aaE79538628d27099B8c4f621bE4CCd142d5",
5353
"callData": "0xb61d27f6000000000000000000000000530fff22987e137e7c8d2adcc4c15eb45b4fa752",
5454
"callGasLimit": "0x0",
5555
"verificationGasLimit": "0x0",
Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,30 @@
11
import Tabs from "@theme/Tabs"
22
import TabItem from "@theme/TabItem"
33

4+
**Type:** `Object`
5+
46
An object containing the estimated gas values for the user operation.
57

8+
<Tabs>
9+
<TabItem value="v0.7" label="v0.7 and v0.8">
10+
11+
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for
12+
pre-verification execution and `calldata`.
13+
- `verificationGasLimit`: (string) - The amount of gas to allocate for the verification step.
14+
- `callGasLimit`: (string) - The amount of gas to allocate the main execution call.
15+
- `paymasterVerificationGasLimit`: (string) - The amount of gas to allocate for the verification step
16+
of the paymaster, or `null` if no paymaster.
17+
- `paymasterPostOpGasLimit`: (string) - The amount of gas to allocate for the post-operation step of
18+
the paymaster, or `null` if no paymaster.
19+
20+
</TabItem>
21+
<TabItem value="v0.6" label="v0.6">
22+
623
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for
7-
pre-verification execution and `calldata`.
24+
pre-verification execution and `calldata`.
25+
- `verificationGas`: (string) - The amount of gas used for verification (legacy field from v0.6).
826
- `verificationGasLimit`: (string) - The amount of gas to allocate for the verification step.
927
- `callGasLimit`: (string) - The amount of gas to allocate the main execution call.
10-
- `paymasterVerificationGasLimit`: (string) - The amount of gas to allocate for the verification
11-
step of the paymaster, or `null` if no paymaster.
12-
- `paymasterPostOpGasLimit`: (string) - The amount of gas to allocate for the post-operation step
13-
of the paymaster, or `null` if no paymaster.
28+
29+
</TabItem>
30+
</Tabs>

services/reference/_partials/bundler/_eth_getuseroperationbyhash-returns.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ operation is not available. When available, the response object contains:
1414
the base fee.
1515
- `paymasterAndData`: (string) - The paymaster address and data.
1616
- `signature`: (string) - The signature data for the user operation.
17-
- `entryPoint`: (string) - The entry point contract address used.
17+
- `entryPoint`: (string) - The EntryPoint contract address used.
1818
- `transactionHash`: (string) - The hash of the transaction that included this user operation.
1919
- `blockHash`: (string) - The hash of the block containing the transaction.
2020
- `blockNumber`: (string) - The number of the block containing the transaction.

services/reference/_partials/bundler/_eth_getuseroperationreceipt-returns.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
An object containing the user operation receipt information, or `null` if the receipt is not available.
22
When available, the receipt object contains:
33

4-
- `entryPoint`: (string) - The entry point contract address.
4+
- `entryPoint`: (string) - The EntryPoint contract address.
55
- `userOpHash`: (string) - The hash of the user operation.
66
- `sender`: (string) - The address of the account that initiated the user operation.
77
- `nonce`: (string) - The nonce used for the user operation.
Lines changed: 45 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,54 @@
1+
import Tabs from "@theme/Tabs"
2+
import TabItem from "@theme/TabItem"
3+
4+
<Tabs>
5+
<TabItem value="v0.7" label="v0.7 and v0.8 user operation">
6+
17
- `userOperation`: The user operation object containing the following fields:
28

39
- `sender`: (string) - The address of the account making the operation.
4-
- `nonce`: (string) - Unique identifier for the request from this sender. This includes
5-
the key and sequence number.
6-
- `factory`: (string) [_optional_] - The factory contract address that will deploy the smart account
7-
if it doesn't exist yet.
10+
- `nonce`: (string) - Nonce for the request from this sender.
11+
- `factory`: (string) [_optional_] - The factory contract address that will deploy the smart account if it doesn't exist yet.
812
- `factoryData`: (string) [_optional_] - The data passed to the factory contract to deploy the smart account.
913
- `callData`: (string) [_optional_] - The data to pass to the sender during the main execution call.
1014
- `callGasLimit`: (string) - The amount of gas to allocate the main execution call.
1115
- `verificationGasLimit`: (string) - The amount of gas to allocate for the verification step.
12-
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for
13-
pre-verification execution and `calldata`.
16+
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for pre-verification execution and `calldata`.
1417
- `maxFeePerGas` : (string) - Maximum fee per gas, in wei, the sender is willing to pay per gas.
15-
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above
16-
the base fee.
18+
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above the base fee.
1719
- `paymaster`: (string) [_optional_] - Address of paymaster sponsoring the transaction, or `null` if none.
18-
- `paymasterVerificationGasLimit`: (string) [_optional_] - The amount of gas to allocate for the
19-
verification step of the paymaster, or `null` if no paymaster.
20-
- `paymasterPostOpGasLimit`: (string) [_optional_] - The amount of gas to allocate for the
21-
post-operation step of the paymaster, or `null` if no paymaster.
22-
- `paymasterData`: (string) [_optional_] - The data to pass to the paymaster during the verification
23-
step, or `null` if no paymaster.
20+
- `paymasterVerificationGasLimit`: (string) [_optional_] - The amount of gas to allocate for the verification step of the paymaster, or `null` if no paymaster.
21+
- `paymasterPostOpGasLimit`: (string) [_optional_] - The amount of gas to allocate for the post-operation step of the paymaster, or `null` if no paymaster.
22+
- `paymasterData`: (string) [_optional_] - The data to pass to the paymaster during the verification step, or `null` if no paymaster.
23+
- `signature`: (string) - The signature data.
24+
- `eip7702Auth`: (object) [_optional_] - The EIP-7702 authorization data:
25+
- `address`: (string) - The contract address for the authorization.
26+
- `chainId`: (string) - The chain ID.
27+
- `nonce`: (string) - The nonce.
28+
- `r`: (string) - The r component of the signature.
29+
- `s`: (string) - The s component of the signature.
30+
- `v`: (string) - The v component of the signature.
31+
- `yParity`: (string) - The y-parity value.
32+
33+
- `entryPoint`: (string) - The EntryPoint contract address (`0x0000000071727De22E5E9d8BAf0edAc6f37da032`).
34+
35+
</TabItem>
36+
<TabItem value="v0.6" label="v0.6 user operation">
37+
38+
- `userOperation`: The user operation object containing the following fields:
39+
40+
- `sender`: (string) - The address of the account making the operation.
41+
- `nonce`: (string) - Nonce for the request from this sender.
42+
- `initCode`: (string) - The initialization code for the smart account if it doesn't exist yet.
43+
- `callData`: (string) [_optional_] - The data to pass to the sender during the main execution call.
44+
- `callGasLimit`: (string) - The amount of gas to allocate the main execution call.
45+
- `verificationGasLimit`: (string) - The amount of gas to allocate for the verification step.
46+
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for pre-verification execution and `calldata`.
47+
- `maxFeePerGas` : (string) - Maximum fee per gas, in wei, the sender is willing to pay per gas.
48+
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above the base fee.
49+
- `paymasterAndData`: (string) - The address of the paymaster contract and the data that will be passed to it.
2450
- `signature`: (string) - The signature data.
25-
- `eip7702Auth`: (object) [_optional_] - The EIP-7702 authorization data. `SignedAuthorization Type`:
51+
- `eip7702Auth`: (object) [_optional_] - The EIP-7702 authorization data:
2652
- `address`: (string) - The contract address for the authorization.
2753
- `chainId`: (string) - The chain ID.
2854
- `nonce`: (string) - The nonce.
@@ -31,4 +57,7 @@
3157
- `v`: (string) - The v component of the signature.
3258
- `yParity`: (string) - The y-parity value.
3359

34-
- `entryPoint`: (string) - The entry point contract address (`0x0000000071727De22E5E9d8BAf0edAc6f37da032`).
60+
- `entryPoint`: (string) - The EntryPoint contract address (`0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789`).
61+
62+
</TabItem>
63+
</Tabs>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
An array of supported entry point addresses. The first address in the array is the preferred entry point
1+
An array of supported EntryPoint addresses. The first address in the array is the preferred EntryPoint
22
that the bundler recommends using.

services/reference/_partials/bundler/_pimlico_simulateassetchanges-description.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,8 @@ import CreditCost from '@site/src/components/CreditCost/CreditCostPrice.js'
22

33
Simulates a user operation to predict the asset changes it will cause. Shows all balance changes
44
and shows all balance changes including native currency, ERC-20, ERC-1155, and ERC-721 tokens. <CreditCost network="bundler" method="pimlico_simulateAssetChanges" />
5+
6+
:::info
7+
This method does not support v0.6 user operations.
8+
:::
9+

services/reference/_partials/bundler/_pimlico_simulateassetchanges-parameters.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@
1111
- `paymasterPostOpGasLimit`: (string) [_optional_] - Gas for paymaster post-operation step.
1212
- `signature`: (string) - Must be a valid dummy signature for simulation.
1313

14-
- `entryPoint`: (string) - The entry point contract address.
14+
- `entryPoint`: (string) - The EntryPoint contract address.
1515

1616
- `blockNumber`: (string) [_optional_] - Hex encoded block number to run the simulation at (defaults to `latest`).

0 commit comments

Comments
 (0)