@@ -39,24 +39,21 @@ Prool is a library that provides programmatic HTTP testing instances for Ethereu
3939Prool contains a set of pre-configured instances that can be used to simulate Ethereum server environments, being:
4040
4141- ** Local Execution Nodes:** [ ` anvil ` ] ( #anvil-execution-node )
42- - ** Bundler Nodes:** [ ` alto ` ] ( #alto-bundler-node ) , [ ` rundler ` ] ( #rundler-bundler-node )
43- - ** Indexer Nodes:** ` ponder ` ⚠️
42+ - ** ERC-4337 Bundler Nodes:** [ ` alto ` ] ( #alto-bundler-node ) , [ ` rundler ` ] ( #rundler-bundler-node )
4443
45- ⚠️ = soon
46-
47- You can also create your own custom instances by using the [ ` defineInstance ` function] ( #defineinstance ) .
44+ You can also create your own custom instances by using the [ ` Instance.define ` function] ( #instancedefine ) .
4845
4946## Table of Contents
5047
5148- [ Install] ( #install )
5249- [ Getting Started] ( #getting-started )
5350 - [ Anvil (Execution Node)] ( #anvil-execution-node )
54- - [ Alto (Bundler Node)] ( #alto-bundler-node )
55- - [ Rundler (Bundler Node)] ( #rundler-bundler-node )
51+ - [ Alto (ERC-4337 Bundler Node)] ( #alto-bundler-node )
52+ - [ Rundler (ERC-4337 Bundler Node)] ( #rundler-bundler-node )
5653- [ Reference] ( #reference )
57- - [ ` createServer ` ] ( #createserver )
58- - [ ` defineInstance ` ] ( #defineinstance )
59- - [ ` definePool ` ] ( #definepool )
54+ - [ ` Server.create ` ] ( #servercreate )
55+ - [ ` Instance.define ` ] ( #instancedefine )
56+ - [ ` Pool.define ` ] ( #pooldefine )
6057
6158
6259## Install
@@ -85,11 +82,10 @@ bun i prool
8582#### Usage
8683
8784``` ts
88- import { createServer } from ' prool'
89- import { anvil } from ' prool/instances'
85+ import { Instance , Server } from ' prool'
9086
91- const server = createServer ({
92- instance: anvil (),
87+ const server = Server . create ({
88+ instance: Instance . anvil (),
9389})
9490
9591await server .start ()
@@ -113,11 +109,10 @@ See [`AnvilParameters`](https://github.com/wevm/prool/blob/801ede06ded8b2cb2d59c
113109#### Usage
114110
115111``` ts
116- import { createServer } from ' prool'
117- import { anvil , alto } from ' prool/instances'
112+ import { Instance , Server } from ' prool'
118113
119- const executionServer = createServer ({
120- instance: anvil (),
114+ const executionServer = Server . create ({
115+ instance: Instance . anvil (),
121116 port: 8545
122117})
123118await executionServer .start ()
@@ -127,8 +122,8 @@ await executionServer.start()
127122// "http://localhost:8545/3"
128123// "http://localhost:8545/n"
129124
130- const bundlerServer = createServer ({
131- instance : (key ) => alto ({
125+ const bundlerServer = Server . create ({
126+ instance : (key ) => Instance . alto ({
132127 entrypoints: [' 0x0000000071727De22E5E9d8BAf0edAc6f37da032' ],
133128 rpcUrl: ` http://localhost:8545/${key } ` ,
134129 executorPrivateKeys: [' 0x...' ],
@@ -156,11 +151,10 @@ See [`AltoParameters`](https://github.com/wevm/prool/blob/801ede06ded8b2cb2d59c9
156151#### Usage
157152
158153``` ts
159- import { createServer } from ' prool'
160- import { anvil , rundler } from ' prool/instances'
154+ import { Instance , Server } from ' prool'
161155
162- const executionServer = createServer ({
163- instance: anvil (),
156+ const executionServer = Server . create ({
157+ instance: Instance . anvil (),
164158 port: 8545
165159})
166160await executionServer .start ()
@@ -170,8 +164,8 @@ await executionServer.start()
170164// "http://localhost:8545/3"
171165// "http://localhost:8545/n"
172166
173- const bundlerServer = createServer ({
174- instance : (key ) => rundler ({
167+ const bundlerServer = Server . create ({
168+ instance : (key ) => Instance . rundler ({
175169 nodeHttp: ` http://localhost:8545/${key } ` ,
176170 })
177171})
@@ -189,18 +183,17 @@ See [RundlerParameters]().
189183
190184## Reference
191185
192- ### ` createServer `
186+ ### ` Server.create `
193187
194188Creates a server that manages a pool of instances via a proxy.
195189
196190#### Usage
197191
198192``` ts
199- import { createServer } from ' prool'
200- import { anvil } from ' prool/instances'
193+ import { Instance , Server } from ' prool'
201194
202- const executionServer = createServer ({
203- instance: anvil (),
195+ const executionServer = Server . create ({
196+ instance: Instance . anvil (),
204197})
205198await executionServer .start ()
206199// Instances accessible at:
@@ -229,18 +222,18 @@ await executionServer.start()
229222| ` limit ` | Number of instances that can be instantiated in the pool | ` number ` |
230223| ` host ` | Host for the server. | ` string ` |
231224| ` port ` | Port for the server. | ` number ` |
232- | returns | Server | ` CreateServerReturnType ` |
225+ | returns | Server | ` Server.Server ` |
233226
234- ### ` defineInstance `
227+ ### ` Instance.define `
235228
236- Creates an instance definition, that can be used with [ ` createServer ` ] ( #createserver ) or [ ` definePool ` ] ( #definepool ) .
229+ Creates an instance definition, that can be used with [ ` Server.create ` ] ( #servercreate ) or [ ` Pool.define ` ] ( #pooldefine ) .
237230
238231#### Usage
239232
240233``` ts
241- import { defineInstance } from ' prool'
234+ import { Instance } from ' prool'
242235
243- const foo = defineInstance ((parameters : FooParameters ) => {
236+ const foo = Instance . define ((parameters : FooParameters ) => {
244237 return {
245238 name: ' foo' ,
246239 host: ' localhost' ,
@@ -262,18 +255,17 @@ const foo = defineInstance((parameters: FooParameters) => {
262255| ` fn ` | Instance definition. | ` DefineInstanceFn ` |
263256| returns | Instance. | ` Instance ` |
264257
265- ### ` definePool `
258+ ### ` Pool.define `
266259
267260Defines a pool of instances. Instances can be started, cached, and stopped against an identifier.
268261
269262#### Usage
270263
271264``` ts
272- import { definePool } from ' prool'
273- import { anvil } from ' prool/instances'
265+ import { Instance , Pool } from ' prool'
274266
275- const pool = definePool ({
276- instance: anvil (),
267+ const pool = Pool . define ({
268+ instance: Instance . anvil (),
277269})
278270const instance_1 = await pool .start (1 )
279271const instance_2 = await pool .start (2 )
0 commit comments