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

Update readme #41

Merged
merged 1 commit into from
Dec 1, 2023
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
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# EVM Context
![Screenshot 2023-12-01 at 1 26 47 PM](https://github.com/waterfall-mkt/curta-write-ups/assets/26611339/d8e17298-c339-43f8-a0e8-52e91caaa5e8)

> Context for Ethereum L1 and L2 transactions.

If you want your protocol to work well on your own app, you can stick with a private indexer for your protocol.

If you want your protocol to work well across all of web3, contribute to **EVM Context**.
## Context for Ethereum L1 and L2 transactions

##### Ideal contributors
If you want your protocol to work well on your own app, use a private indexer.<br/>
If you want your protocol to work well _across all of web3_, contribute to **EVM Context**.

#### Ideal contributors:
- Protocol teams

##### Ideal users
#### Ideal users

- Wallets
- Web3 browsing tools
Expand All @@ -19,21 +20,23 @@ If you want your protocol to work well across all of web3, contribute to **EVM C
## Quick start

### Generating a new contextualization

Run this command `npm run create:contextualizer [name of protocol] -- -h [transaction hash]`

```
npm run create:contextualizer [name of protocol] -- -h [transaction hash]`
```
This will generate a new file called `protocol/[name of protocol].ts` and a test file called `protocol/[name of protocol].spec.ts`.

### Writing tests

You should write unit tests for your PR using a real transaction.
### Writing tests

You can do this by running `npm run grab:transaction [txHash] [nickname for the type of tx]`.
You should write unit tests for your PR using a real transaction. Do this by running:
```
npm run grab:transaction [txHash] [nickname for the type of tx]
``````

### Finishing your new contextualization

Once that's ready, please open a PR on this repo and request review from `pcowgill` and `jordanmessina`
Once that's ready, please open a PR on this repo and request review from [pcowgill](https://github.com/pcowgill) and [jordanmessina](https://github.com/jordanmessina)

## License

See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).
See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).