Skip to content

Commit

Permalink
Merge pull request #246 from WalletConnect/feat/add_bundler_api
Browse files Browse the repository at this point in the history
feat(blockchainAPI): bundler interaction API
  • Loading branch information
geekbrother authored Aug 7, 2024
2 parents 17f7ec7 + e98b75f commit 34bdb3b
Showing 1 changed file with 49 additions and 0 deletions.
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.
* `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`.
* `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.

0 comments on commit 34bdb3b

Please sign in to comment.