Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Ferossgp committed Nov 10, 2024
1 parent 0e0b959 commit 7371258
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 2 additions & 2 deletions apps/docs/src/content/docs/guides/sql-stores.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 4
---

To use the default SQL stores you can import `SqlAbiStore` and `ContractStore ` from the `@3loop/transaction-decoder/sql`.
To use the default SQL stores you can import `SqlAbiStore` and `SqlContractMetaStore ` from the `@3loop/transaction-decoder/sql`.

Given that the SQL stores are based on `@effect/sql` it inherits its SQL Client abstraction. For example we will use a Sqlite client for bun: `SqliteClient` from `@effect/sql-sqlite-bun` package.

Expand Down Expand Up @@ -93,5 +93,5 @@ main()
Now you can run this script with bun:

```
$ bun run index.ts 1 0x123transactionhash
$ ETHERSCAN_API_KEY='YOUR_API_KEY' RPC_1=https://rpc.ankr.com/eth bun run index.ts 1 0xc0bd04d7e94542e58709f51879f64946ff4a744e1c37f5f920cea3d478e115d7
```
4 changes: 3 additions & 1 deletion apps/docs/src/content/docs/reference/data-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,9 @@ By defulat loop decoder provides two stores that can be used out of the box:
- `InMemoryAbiStore` - caches the resolved abi in-memory
- `InMemoryContractMetaStore` - caches the resolved contract metadata in-memory

2. Sqlite store - located at `@3loop/transaction-decoder/sql`
You will most likely use these stores for testing and development purposes. A persistent store will significantly improve the performance of the decoder over time.

1. Sqlite store - located at `@3loop/transaction-decoder/sql`

- `SqlAbiStore` - caches the resolved abi in any sql database supported by `@effect/sql`
- `SqlContractMetaStore` - caches the resolved contract metadata in any sql database supported by `@effect/sql`

0 comments on commit 7371258

Please sign in to comment.