Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(blockchainAPI): bundler interaction API #246

Merged
merged 6 commits into from
Aug 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/specs/servers/blockchain/blockchain-bundler-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Blockchain API Bundlers interaction

This API provides a bundlers JSON-RPC interaction.
The supported `userOperation` interaction schema is according to v0.7 ERC-4337 specification.

## Make a bundler JSON-RPC request

Used to make a JSON-RPC call to the designated bundler.

`POST /v1/bundler?projectId={projectId}&chainId={chainId}&bundler={bundlerName}`

* `projectId` - Required. The project identifier.
* `chainId` - CAIP-2 chain identifier.
geekbrother marked this conversation as resolved.
Show resolved Hide resolved
* `bundlerName` - Bundler name to use.

The list of currently supported bundler names:
* `pimlico` - [Pimlico bundler](https://docs.pimlico.io/permissionless/reference/bundler-actions/sendUserOperation).

#### Request body:

```typescript
{
id: number, // Unique identifier. Default is 1.
jsonrpc: string, // JSON-RPC version. Default 2.0
method: string, // ERC-4337 bundler operation methods. Please check supported methods below.
params: string[], // Array of string variables input for the method.
}
```

List of supported `method` values:
* `wallet_getCallsStatus` - Returns the status of a call batch that was sent via `wallet_sendCalls`.
* `wallet_showCallsStatus` - Requests that a wallet shows information about a given call bundle that was sent with `wallet_sendCalls`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in the current demo PoC, we're fetching eth_getUserOperationReceipt are we going to support it?

Copy link
Contributor Author

@geekbrother geekbrother Jul 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's support it for a demo. Updated by adding eth_getUserOperationReceipt.

Copy link
Contributor Author

@geekbrother geekbrother Jul 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can add this operation also if needed. Let's support it for now. I have added it.

* `eth_getUserOperationReceipt` - Get the receipt for the UserOperation.

#### Success response body:

Successfull response body will contain the following JSON-RPC structure:

```typescript
{
id: number, // Unique identifier passed to the operation. Default is 1.
jsonrpc: string, // JSON-RPC version. Default 2.0
result: any // Result object from the operation.
}
```

#### Response error codes:

* `400 Bad request` - Wrong input variables format.