Skip to content

Commit 173a6cb

Browse files
bgravenorstbgravenorst
committed
Add additional methods.
Signed-off-by: bgravenorst <[email protected]>
1 parent 09a962f commit 173a6cb

11 files changed

+67
-73
lines changed

‎services/reference/_partials/bundler/_pimlico_gettokenquotes-parameters.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
:::warning
2+
If a token in the request input is not supported by the ERC-20 Paymaster, the request will still succeed but it will not be included in the `quotes` array in the response.
3+
:::
4+
15
- `Object`: An object containing:
26
- `tokens`: (array) - An array of token addresses to get quotes for.
37

‎services/reference/_partials/bundler/_pimlico_gettokenquotes-returns.mdx‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,4 @@ An object containing an array of token quotes. Each quote includes information a
77
- `exchangeRate`: (string) - The exchange rate between the token and the native gas token.
88
- `exchangeRateNativeToUsd`: (string) - The exchange rate between the native gas token and USD with 6 decimals of precision.
99
- `balanceSlot`: (string) - The storage slot for the token balance.
10-
- `allowanceSlot`: (string) - The storage slot for the token allowance.
11-
12-
:::warning
13-
If a token in the request input is not supported by the ERC-20 Paymaster, the request will still succeed but it will not be included in the `quotes` array in the response.
14-
:::
15-
16-
:::info
17-
**exchangeRateNativeToUsd** represents the exchange rate between the chain's native gas token and USD with 6 decimals of precision.
18-
:::
10+
- `allowanceSlot`: (string) - The storage slot for the token allowance.

‎services/reference/_partials/bundler/_pm_getpaymasterdata-parameters.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ import TabItem from "@theme/TabItem"
3333

3434
- `chainId`: (string) - The chain ID in hexadecimal format.
3535

36-
- `context`: (object) [_optional_] - Additional context information. Can be one of:
36+
- `context`: (object) [_optional_] - Information about the specific paymaster implementation you are using.
37+
If use paying gas in ERC-20 Tokens, pass the token address:
3738
- An object with `token`: (string) - The ERC-20 token address to use for payment.
3839
- An object with `sponsorshipPolicyId`: (string) - The ID of the sponsorship policy to use.
39-
- `null` - No additional context.
4040

4141
</TabItem>
4242
<TabItem value="v0.6" label="v0.6 user operation">
@@ -65,10 +65,10 @@ import TabItem from "@theme/TabItem"
6565

6666
- `chainId`: (string) - The chain ID in hexadecimal format.
6767

68-
- `context`: (object) [_optional_] - Additional context information. Can be one of:
68+
- `context`: (object) [_optional_] - Information about the specific paymaster implementation you are using.
69+
If use paying gas in ERC-20 Tokens, pass the token address:
6970
- An object with `token`: (string) - The ERC-20 token address to use for payment.
7071
- An object with `sponsorshipPolicyId`: (string) - The ID of the sponsorship policy to use.
71-
- `null` - No additional context.
7272

7373
</TabItem>
7474
</Tabs>

‎services/reference/_partials/bundler/_pm_getpaymasterstubdata-parameters.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ import TabItem from "@theme/TabItem"
3333

3434
- `chainId`: (string) - The chain ID in hexadecimal format.
3535

36-
- `context`: (object) [_optional_] - Additional context information. Can be one of:
36+
- `context`: (object) [_optional_] - Information about the specific paymaster implementation you are using.
37+
If use paying gas in ERC-20 Tokens, pass the token address:
3738
- An object with `token`: (string) - The ERC-20 token address to use for payment.
3839
- An object with `sponsorshipPolicyId`: (string) - The ID of the sponsorship policy to use.
39-
- `null` - No additional context.
4040

4141
</TabItem>
4242
<TabItem value="v0.6" label="v0.6 user operation">
@@ -67,10 +67,10 @@ import TabItem from "@theme/TabItem"
6767

6868
- `chainId`: (string) - The chain ID in hexadecimal format.
6969

70-
- `context`: (object) [_optional_] - Additional context information. Can be one of:
70+
- `context`: (object) [_optional_] - Information about the specific paymaster implementation you are using.
71+
If use paying gas in ERC-20 Tokens, pass the token address:
7172
- An object with `token`: (string) - The ERC-20 token address to use for payment.
7273
- An object with `sponsorshipPolicyId`: (string) - The ID of the sponsorship policy to use.
73-
- `null` - No additional context.
7474

7575
</TabItem>
7676
</Tabs>

‎services/reference/_partials/bundler/_pm_getpaymasterstubdata-returns.mdx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ An object containing stub paymaster-related fields for gas estimation.
77
<TabItem value="v0.7" label="v0.7 and v0.8">
88

99
- `paymaster`: (string) - The address of the paymaster contract.
10-
- `paymasterData`: (string) - The data to be used in the paymasterData field of the user operation.
11-
- `paymasterVerificationGasLimit`: (string) - The amount of gas to allocate for the verification step of the paymaster.
12-
- `paymasterPostOpGasLimit`: (string) - The amount of gas to allocate for the post-operation step of the paymaster.
10+
- `paymasterData`: (string) - The data to be used in the `paymasterData` field of the user operation.
11+
- `paymasterVerificationGasLimit`: (string) - The amount of gas to allocate for the verification step
12+
of the paymaster.
13+
- `paymasterPostOpGasLimit`: (string) - The amount of gas to allocate for the post-operation step of
14+
the paymaster.
1315

1416
</TabItem>
1517
<TabItem value="v0.6" label="v0.6">

‎services/reference/_partials/bundler/_pm_sponsoruseroperation-description.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
import CreditCost from '@site/src/components/CreditCost/CreditCostPrice.js'
22

3-
Sponsors a user operation by providing all necessary paymaster-related fields and updated gas parameters. <CreditCost network="bundler" method="pm_sponsorUserOperation" />
3+
Sponsors a user operation by providing all necessary paymaster-related fields and updated gas
4+
parameters. <CreditCost network="bundler" method="pm_sponsorUserOperation" />

‎services/reference/_partials/bundler/_pm_sponsoruseroperation-parameters.mdx‎

Lines changed: 18 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,31 @@ import TabItem from "@theme/TabItem"
77
- `userOperation`: The user operation object containing the following fields:
88

99
- `sender`: (string) - The address of the account making the operation.
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.
10+
- `nonce`: (string) - Unique identifier for the request from this sender. This includes the key and
11+
sequence number.
12+
- `factory`: (string) [_optional_] - The factory contract address that will deploy the smart account
13+
if it doesn't exist yet.
1214
- `factoryData`: (string) [_optional_] - The data passed to the factory contract to deploy the smart account.
1315
- `callData`: (string) [_optional_] - The data to pass to the sender during the main execution call.
1416
- `callGasLimit`: (string) - The amount of gas to allocate the main execution call.
1517
- `verificationGasLimit`: (string) - The amount of gas to allocate for the verification step.
16-
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for pre-verification execution and `calldata`.
18+
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for
19+
pre-verification execution and `calldata`.
1720
- `maxFeePerGas`: (string) - Maximum fee per gas, in wei, the sender is willing to pay per gas.
18-
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above the base fee.
21+
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above
22+
the base fee.
1923
- `paymaster`: (string) [_optional_] - Address of paymaster sponsoring the transaction, or `null` if none.
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-
- `eip7702Auth`: (object) [_optional_] - The EIP-7702 authorization data. This can be a dummy authorization:
24-
- `address`: (string) - The contract address for the authorization.
25-
- `chainId`: (string) - The chain ID.
26-
- `nonce`: (string) - The nonce.
27-
- `r`: (string) - The r component of the signature.
28-
- `s`: (string) - The s component of the signature.
29-
- `v`: (string) - The v component of the signature.
30-
- `yParity`: (string) - The y-parity value.
31-
24+
- `paymasterVerificationGasLimit`: (string) [_optional_] - The amount of gas to allocate for the
25+
verification step of the paymaster, or `null` if no paymaster.
26+
- `paymasterPostOpGasLimit`: (string) [_optional_] - The amount of gas to allocate for the post-operation
27+
step of the paymaster, or `null` if no paymaster.
28+
- `paymasterData`: (string) [_optional_] - The data to pass to the paymaster during the verification
29+
step, or `null` if no paymaster.
3230
- `entryPoint`: (string) - The EntryPoint contract address (`0x0000000071727De22E5E9d8BAf0edAc6f37da032`).
33-
34-
- `context`: (object) [_optional_] - Additional context information. Can be one of:
31+
- `context`: (object) [_optional_] - Information about the specific paymaster implementation you are using.
32+
If use paying gas in ERC-20 Tokens, pass the token address:
3533
- An object with `token`: (string) - The ERC-20 token address to use for payment.
3634
- An object with `sponsorshipPolicyId`: (string) - The ID of the sponsorship policy to use.
37-
- `null` - No additional context.
3835

3936
</TabItem>
4037
<TabItem value="v0.6" label="v0.6 user operation">
@@ -52,21 +49,10 @@ import TabItem from "@theme/TabItem"
5249
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above the base fee.
5350
- `paymasterAndData`: (string) - The address of the paymaster contract and the data that will be passed to it.
5451
- `signature`: (string) - The signature data.
55-
- `eip7702Auth`: (object) [_optional_] - The EIP-7702 authorization data. This can be a dummy authorization:
56-
- `address`: (string) - The contract address for the authorization.
57-
- `chainId`: (string) - The chain ID.
58-
- `nonce`: (string) - The nonce.
59-
- `r`: (string) - The r component of the signature.
60-
- `s`: (string) - The s component of the signature.
61-
- `v`: (string) - The v component of the signature.
62-
- `yParity`: (string) - The y-parity value.
63-
6452
- `entryPoint`: (string) - The EntryPoint contract address (`0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789`).
65-
66-
- `context`: (object) [_optional_] - Additional context information. Can be one of:
53+
- `context`: (object) [_optional_] - Information about the specific paymaster implementation you are using.
54+
If use paying gas in ERC-20 Tokens, pass the token address:
6755
- An object with `token`: (string) - The ERC-20 token address to use for payment.
6856
- An object with `sponsorshipPolicyId`: (string) - The ID of the sponsorship policy to use.
69-
- `null` - No additional context.
70-
7157
</TabItem>
7258
</Tabs>

‎services/reference/_partials/bundler/_pm_sponsoruseroperation-returns.mdx‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,23 @@ An object containing paymaster-related fields and updated gas parameters.
77
<TabItem value="v0.7" label="v0.7 and v0.8">
88

99
- `paymaster`: (string) - The address of the paymaster contract.
10-
- `paymasterData`: (string) - The data to be used in the paymasterData field of the user operation.
11-
- `preVerificationGas`: (string) - The updated preVerificationGas value to use in the user operation.
12-
- `verificationGasLimit`: (string) - The updated verificationGasLimit value to use in the user operation.
13-
- `callGasLimit`: (string) - The updated callGasLimit value to use in the user operation.
14-
- `paymasterVerificationGasLimit`: (string) - The amount of gas to allocate for the verification step of the paymaster.
15-
- `paymasterPostOpGasLimit`: (string) - The amount of gas to allocate for the post-operation step of the paymaster.
10+
- `paymasterData`: (string) - The data to be used in the `paymasterData` field of the user operation.
11+
- `preVerificationGas`: (string) - The updated `preVerificationGas` value to use in the user operation.
12+
- `verificationGasLimit`: (string) - The updated `verificationGasLimit` value to use in the user operation.
13+
- `callGasLimit`: (string) - The updated `callGasLimit` value to use in the user operation.
14+
- `paymasterVerificationGasLimit`: (string) - The amount of gas to allocate for the verification step
15+
of the paymaster.
16+
- `paymasterPostOpGasLimit`: (string) - The amount of gas to allocate for the post-operation step of
17+
the paymaster.
1618

1719
</TabItem>
1820
<TabItem value="v0.6" label="v0.6">
1921

2022
- `paymasterAndData`: (string) - The combined paymaster address and data to be used in the user operation.
21-
- `preVerificationGas`: (string) - The updated preVerificationGas value to use in the user operation.
23+
- `preVerificationGas`: (string) - The updated `preVerificationGas` value to use in the user operation.
2224
- `verificationGas`: (string) - The amount of gas to allocate for the verification step.
23-
- `verificationGasLimit`: (string) - The updated verificationGasLimit value to use in the user operation.
24-
- `callGasLimit`: (string) - The updated callGasLimit value to use in the user operation.
25+
- `verificationGasLimit`: (string) - The updated `verificationGasLimit` value to use in the user operation.
26+
- `callGasLimit`: (string) - The updated `callGasLimit` value to use in the user operation.
2527

2628
</TabItem>
2729
</Tabs>

‎services/reference/_partials/bundler/_pm_validatesponsorshippolicies-description.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
import CreditCost from '@site/src/components/CreditCost/CreditCostPrice.js'
22

3-
Validates a user operation against an array of sponsorship policies and returns which policies are willing to sponsor the user operation. <CreditCost network="bundler" method="pm_validateSponsorshipPolicies" />
3+
Validates a user operation against an array of sponsorship policies and returns which policies are
4+
willing to sponsor the user operation. <CreditCost network="bundler" method="pm_validateSponsorshipPolicies" />

‎services/reference/_partials/bundler/_pm_validatesponsorshippolicies-parameters.mdx‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,25 @@ import TabItem from "@theme/TabItem"
77
- `userOperation`: The user operation object containing the following fields:
88

99
- `sender`: (string) - The address of the account making the operation.
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.
10+
- `nonce`: (string) - Unique identifier for the request from this sender. This includes the key and
11+
sequence number.
12+
- `factory`: (string) [_optional_] - The factory contract address that will deploy the smart account
13+
if it doesn't exist yet.
1214
- `factoryData`: (string) [_optional_] - The data passed to the factory contract to deploy the smart account.
1315
- `callData`: (string) [_optional_] - The data to pass to the sender during the main execution call.
1416
- `callGasLimit`: (string) - The amount of gas to allocate the main execution call.
1517
- `verificationGasLimit`: (string) - The amount of gas to allocate for the verification step.
16-
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for pre-verification execution and `calldata`.
18+
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for
19+
pre-verification execution and `calldata`.
1720
- `maxFeePerGas`: (string) - Maximum fee per gas, in wei, the sender is willing to pay per gas.
1821
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above the base fee.
1922
- `paymaster`: (string) [_optional_] - Address of paymaster sponsoring the transaction, or `null` if none.
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+
- `paymasterVerificationGasLimit`: (string) [_optional_] - The amount of gas to allocate for the
24+
verification step of the paymaster, or `null` if no paymaster.
25+
- `paymasterPostOpGasLimit`: (string) [_optional_] - The amount of gas to allocate for the
26+
post-operation step of the paymaster, or `null` if no paymaster.
27+
- `paymasterData`: (string) [_optional_] - The data to pass to the paymaster during the verification
28+
step, or `null` if no paymaster.
2329
- `signature`: (string) - The signature data.
2430

2531
- `entryPoint`: (string) - The EntryPoint contract address (`0x0000000071727De22E5E9d8BAf0edAc6f37da032`).
@@ -37,7 +43,8 @@ import TabItem from "@theme/TabItem"
3743
- `callData`: (string) [_optional_] - The data to pass to the sender during the main execution call.
3844
- `callGasLimit`: (string) - The amount of gas to allocate the main execution call.
3945
- `verificationGasLimit`: (string) - The amount of gas to allocate for the verification step.
40-
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for pre-verification execution and `calldata`.
46+
- `preVerificationGas`: (string) - The amount of gas to pay for to compensate the bundler for
47+
pre-verification execution and `calldata`.
4148
- `maxFeePerGas`: (string) - Maximum fee per gas, in wei, the sender is willing to pay per gas.
4249
- `maxPriorityFeePerGas`: (string) - Maximum fee, in wei, the sender is willing to pay per gas above the base fee.
4350
- `paymasterAndData`: (string) - The address of the paymaster contract and the data that will be passed to it.

0 commit comments

Comments
 (0)