Skip to content

Commit fafbca4

Browse files
committed
Add supersim to README
1 parent ae34711 commit fafbca4

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

src/README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Prool is a library that provides programmatic HTTP testing instances for Ethereu
3838

3939
Prool contains a set of pre-configured instances that can be used to simulate Ethereum server environments, being:
4040

41-
- **Local Execution Nodes:** [`anvil`](#anvil-execution-node)
41+
- **Local Execution Nodes:** [`anvil`](#anvil-execution-node), [`supersim`](#supersim-op-execution-nodes)
4242
- **Bundler Nodes:** [`alto`](#alto-bundler-node), [`rundler`](#rundler-bundler-node), [`silius`](#silius-bundler-node), [`stackup`](#stackup-bundler-node)
4343
- **Indexer Nodes:** `ponder`⚠️
4444

@@ -51,6 +51,7 @@ You can also create your own custom instances by using the [`defineInstance` fun
5151
- [Install](#install)
5252
- [Getting Started](#getting-started)
5353
- [Anvil (Execution Node)](#anvil-execution-node)
54+
- [Supersim (OP Execution Nodes)](#supersim-op-execution-nodes)
5455
- [Alto (Bundler Node)](#alto-bundler-node)
5556
- [Rundler (Bundler Node)](#rundler-bundler-node)
5657
- [Silius (Bundler Node)](#silius-bundler-node)
@@ -106,6 +107,36 @@ await server.start()
106107

107108
See [`AnvilParameters`](https://github.com/wevm/prool/blob/801ede06ded8b2cb2d59c95294aae795e548897c/src/instances/anvil.ts#L5).
108109

110+
### Supersim (OP Execution Nodes)
111+
112+
#### Requirements
113+
114+
- [Foundry](https://getfoundry.sh/) binary installed
115+
- Download: `curl -L https://foundry.paradigm.xyz | bash`
116+
- [Supersim](https://github.com/ethereum-optimism/supersim?tab=readme-ov-file#2-install-supersim) binary installed
117+
118+
#### Usage
119+
120+
```ts
121+
import { createServer } from 'prool'
122+
import { supersim } from 'prool/instances'
123+
124+
const server = createServer({
125+
instance: supersim(),
126+
})
127+
128+
await server.start()
129+
// Instances accessible at:
130+
// "http://localhost:8545/1"
131+
// "http://localhost:8545/2"
132+
// "http://localhost:8545/3"
133+
// "http://localhost:8545/n"
134+
```
135+
136+
#### Parameters
137+
138+
See [`SupersimParameters`](https://github.com/wevm/prool/blob/ae34711701d3f4316a5e85442ae618a6506f55e1/src/instances/supersim.ts#L5).
139+
109140
### Alto (Bundler Node)
110141

111142
#### Requirements

0 commit comments

Comments
 (0)