Skip to content

Commit 5d4b3e1

Browse files
authored
Merge pull request #105
2 parents 5b67a1c + d233ab2 commit 5d4b3e1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

typescript/solver/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ solver/
5656
- **solvers/**: Contains implementations of different solvers and common utilities.
5757
- **BaseListener.ts**: An abstract base class that provides common functionality for event listeners. It handles setting up contract connections and defines the interface for parsing event arguments.
5858
- **BaseFiller.ts**: An abstract base class that provides common functionality for fillers. It handles the solver's lifecycle `prepareIntent`, `fill`, and `settle`.
59-
- **`prepareIntent`**: evaluate allow/block lists, balances, and run the defined rules to decide wether to fill or not an intent.
59+
- **`prepareIntent`**: evaluate allow/block lists, balances, and run the defined rules to decide whether to fill or not an intent.
6060
- **`fill`**: The actual filling.
6161
- **`settle`**: The settlement step, can be avoided.
6262
- **<eco|hyperlane7683>/**: Implements the solvers for the ECO and Hyperlane7683 domains.
@@ -118,9 +118,9 @@ Configure which intent to fill , and which to ignore
118118

119119
By default, the solver will attempt to fill intents sent from its origin chain to any destination chains.
120120

121-
Solvers may want to further filter the intents they attempt to fill. For example, fill intents coaming from a specific address or going to a subset of chains.
121+
Solvers may want to further filter the intents they attempt to fill. For example, fill intents coming from a specific address or going to a subset of chains.
122122

123-
In order to do this, you can configure a block-list or a allow-list at a global level within the [allowBlockList.ts file](./config/allowBlockLists.ts) or at a specific solver level like e.g. [solvers/eco/config/allowBlockList.ts file](./solvers/eco/config/allowBlockLists.ts).
123+
In order to do this, you can configure a block-list or an allow-list at a global level within the [allowBlockList.ts file](./config/allowBlockLists.ts) or at a specific solver level like e.g. [solvers/eco/config/allowBlockList.ts file](./solvers/eco/config/allowBlockLists.ts).
124124

125125
Such configs should be written in the `allowBlockLists` variable
126126

@@ -150,11 +150,11 @@ type AllowBlockLists = {
150150
151151
Both the allow-list and block-lists have "any" semantics. In other words, the Solver will deliver intents that match any of the allow-list filters, and ignore intents that match any of the block-list filters.
152152
153-
The clock-list supersedes the allow-list, i.e. if a message matches both the allow-list and the block-list, it will not be delivered.
153+
The block-list supersedes the allow-list, i.e. if a message matches both the allow-list and the block-list, it will not be delivered.
154154
155155
### Logging
156156
157-
The application utilizes a custom Logger class for logging. You can adjust the log level and format by modifying the Logger instantiation in index.ts. By default it will log to `stdout` in a human-readable format using the `INFO` level.
157+
The application utilizes a custom Logger class for logging. You can adjust the log level and format by modifying the Logger instantiation in index.ts. By default, it will log to `stdout` in a human-readable format using the `INFO` level.
158158
159159
You can customize the logging destination by using a pino transport of your choosing. There's an example for logging to a Syslog server running on `localhost` commented in [logger.ts](logger.ts). Check out the [pino transports docs](https://github.com/pinojs/pino/blob/main/docs/transports.md) for other available transports.
160160

0 commit comments

Comments
 (0)