Skip to content

Commit d7ee3d8

Browse files
FerossgpFerossgp
authored
Refactor API for abi strategies and the stores to add global rate-limit (#214)
* Refactor API for abi strategies and the stores to add global rate-limit * Fix linter conflicting with prettier
1 parent e6456a0 commit d7ee3d8

26 files changed

+468
-470
lines changed

‎.changeset/fresh-candles-deny.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
'@3loop/transaction-decoder': minor
3+
---
4+
5+
BREAKING CHANGE: Changing the interface we use to declare ABI strategies and adding rate limiter per strategy. The Breaking Change will only affect you if you are declaring the store layers manually, if you are using the default stores you will not be affected.
6+
7+
Example usage:
8+
9+
```ts
10+
EtherscanV2StrategyResolver({
11+
apikey: apikey,
12+
rateLimit: { limit: 5, interval: '2 seconds', algorithm: 'fixed-window' },
13+
})
14+
```

‎apps/docs/src/content/components/effect-abi-store-interface.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
```ts
2-
export interface AbiStore<Key = AbiParams, Value = ContractAbiResult> {
2+
export interface AbiStore {
33
readonly strategies: Record<ChainOrDefault, readonly ContractAbiResolverStrategy[]>
4-
readonly set: (key: Key, value: Value) => Effect.Effect<void, never>
5-
readonly get: (arg: Key) => Effect.Effect<Value, never>
6-
readonly getMany?: (arg: Array<Key>) => Effect.Effect<Array<Value>, never>
4+
readonly set: (key: AbiParams, value: ContractAbiResult) => Effect.Effect<void, never>
5+
readonly get: (arg: AbiParams) => Effect.Effect<ContractAbiResult, never>
6+
readonly getMany?: (arg: Array<AbiParams>) => Effect.Effect<Array<ContractAbiResult>, never>
77
}
88
```

‎apps/docs/src/content/components/effect-meta-store-interface.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
```ts
2-
export interface ContractMetaStore<Key = ContractMetaParams, Value = ContractMetaResult> {
2+
export interface ContractMetaStore {
33
readonly strategies: Record<ChainOrDefault, readonly ContractMetaResolverStrategy[]>
4-
readonly set: (arg: Key, value: Value) => Effect.Effect<void, never>
5-
readonly get: (arg: Key) => Effect.Effect<Value, never>
6-
readonly getMany?: (arg: Array<Key>) => Effect.Effect<Array<Value>, never>
4+
readonly set: (arg: ContractMetaParams, value: ContractMetaResult) => Effect.Effect<void, never>
5+
readonly get: (arg: ContractMetaParams) => Effect.Effect<ContractMetaResult, never>
6+
readonly getMany?: (arg: Array<ContractMetaParams>) => Effect.Effect<Array<ContractMetaResult>, never>
77
}
88
```

‎apps/web/src/lib/decode.ts‎

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,6 @@ import {
1010
FourByteStrategyResolver,
1111
OpenchainStrategyResolver,
1212
SourcifyStrategyResolver,
13-
AbiStore,
14-
AbiParams,
15-
ContractAbiResult,
16-
ContractMetaStore,
17-
ContractMetaParams,
18-
ContractMetaResult,
1913
PublicClient,
2014
ERC20RPCStrategyResolver,
2115
NFTRPCStrategyResolver,
@@ -24,10 +18,6 @@ import {
2418
import { SqlAbiStore, SqlContractMetaStore } from '@3loop/transaction-decoder/sql'
2519
import { Hex } from 'viem'
2620
import { DatabaseLive } from './database'
27-
import { PgClient } from '@effect/sql-pg/PgClient'
28-
import { SqlClient } from '@effect/sql/SqlClient'
29-
import { ConfigError } from 'effect/ConfigError'
30-
import { SqlError } from '@effect/sql/SqlError'
3121

3222
const AbiStoreLive = Layer.unwrapEffect(
3323
Effect.gen(function* () {
@@ -60,15 +50,7 @@ const CacheLayer = Layer.setRequestCache(Request.makeCache({ capacity: 100, time
6050
const DataLayer = Layer.mergeAll(RPCProviderLive, DatabaseLive)
6151
const LoadersLayer = Layer.mergeAll(AbiStoreLive, MetaStoreLive)
6252

63-
const MainLayer = Layer.provideMerge(LoadersLayer, DataLayer) as Layer.Layer<
64-
| AbiStore<AbiParams, ContractAbiResult>
65-
| ContractMetaStore<ContractMetaParams, ContractMetaResult>
66-
| PublicClient
67-
| PgClient
68-
| SqlClient,
69-
ConfigError | SqlError,
70-
never
71-
>
53+
const MainLayer = Layer.provideMerge(LoadersLayer, DataLayer)
7254

7355
const runtime = ManagedRuntime.make(Layer.provide(MainLayer, CacheLayer))
7456

‎packages/eslint-config-custom/library.js‎

Lines changed: 41 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,46 @@
11
/** @type {import('eslint').Linter.Config} */
22
module.exports = {
3-
env: {
4-
browser: true,
5-
es6: true,
6-
node: true,
7-
},
8-
extends: [
9-
"turbo",
10-
"eslint:recommended",
11-
"plugin:@typescript-eslint/recommended",
12-
"plugin:sort-export-all/recommended",
13-
"plugin:prettier/recommended",
3+
env: {
4+
browser: true,
5+
es6: true,
6+
node: true,
7+
},
8+
extends: [
9+
"turbo",
10+
"eslint:recommended",
11+
"plugin:@typescript-eslint/recommended",
12+
"plugin:sort-export-all/recommended",
13+
],
14+
parser: "@typescript-eslint/parser",
15+
plugins: [
16+
"@typescript-eslint",
17+
"prettier",
18+
"sort-export-all",
19+
],
20+
settings: {
21+
"import/resolver": { typescript: true, node: true },
22+
"import/parsers": { "@typescript-eslint/parser": [".ts", ".tsx"] },
23+
},
24+
rules: {
25+
"@typescript-eslint/no-empty-interface": "off",
26+
"@typescript-eslint/no-explicit-any": "off",
27+
'@typescript-eslint/strict-boolean-expressions': [
28+
'error',
29+
{
30+
allowString: false,
31+
allowNullableObject: false,
32+
allowNumber: false,
33+
allowNullableBoolean: true,
34+
},
1435
],
15-
parser: "@typescript-eslint/parser",
16-
plugins: [
17-
"@typescript-eslint",
18-
"prettier",
19-
"sort-export-all",
36+
"@typescript-eslint/strict-boolean-expressions": "off",
37+
"object-shorthand": ["warn", "always"],
38+
"eqeqeq": [
39+
'error',
40+
'always',
41+
{
42+
null: 'never',
43+
},
2044
],
21-
settings: {
22-
"import/resolver": { typescript: true, node: true },
23-
"import/parsers": { "@typescript-eslint/parser": [".ts", ".tsx"] },
24-
},
25-
rules: {
26-
"@typescript-eslint/no-empty-interface": "off",
27-
"@typescript-eslint/no-explicit-any": "off",
28-
'@typescript-eslint/strict-boolean-expressions': [
29-
'error',
30-
{
31-
allowString: false,
32-
allowNullableObject: false,
33-
allowNumber: false,
34-
allowNullableBoolean: true,
35-
},
36-
],
37-
"@typescript-eslint/strict-boolean-expressions": "off",
38-
"object-shorthand": ["warn", "always"],
39-
"eqeqeq": [
40-
'error',
41-
'always',
42-
{
43-
null: 'never',
44-
},
45-
],
46-
},
45+
},
4746
};

‎packages/transaction-decoder/src/abi-loader.ts‎

Lines changed: 16 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,7 @@
1-
import {
2-
Context,
3-
Effect,
4-
Either,
5-
RequestResolver,
6-
Request,
7-
Array,
8-
pipe,
9-
Data,
10-
PrimaryKey,
11-
Schema,
12-
SchemaAST,
13-
} from 'effect'
14-
import { ContractABI, ContractAbiResolverStrategy, GetContractABIStrategy } from './abi-strategy/request-model.js'
1+
import { Effect, Either, RequestResolver, Request, Array, pipe, Data, PrimaryKey, Schema, SchemaAST } from 'effect'
2+
import { ContractABI } from './abi-strategy/request-model.js'
153
import { Abi } from 'viem'
16-
17-
export interface AbiParams {
18-
chainID: number
19-
address: string
20-
event?: string | undefined
21-
signature?: string | undefined
22-
}
23-
24-
export interface ContractAbiSuccess {
25-
status: 'success'
26-
result: ContractABI
27-
}
28-
29-
export interface ContractAbiNotFound {
30-
status: 'not-found'
31-
result: null
32-
}
33-
34-
export interface ContractAbiEmpty {
35-
status: 'empty'
36-
result: null
37-
}
38-
39-
export type ContractAbiResult = ContractAbiSuccess | ContractAbiNotFound | ContractAbiEmpty
40-
41-
type ChainOrDefault = number | 'default'
42-
43-
export interface AbiStore<Key = AbiParams, Value = ContractAbiResult> {
44-
readonly strategies: Record<ChainOrDefault, readonly ContractAbiResolverStrategy[]>
45-
readonly set: (key: Key, value: Value) => Effect.Effect<void, never>
46-
readonly get: (arg: Key) => Effect.Effect<Value, never>
47-
readonly getMany?: (arg: Array<Key>) => Effect.Effect<Array<Value>, never>
48-
}
49-
50-
export const AbiStore = Context.GenericTag<AbiStore>('@3loop-decoder/AbiStore')
4+
import { AbiParams, AbiStore } from './abi-store.js'
515

526
interface LoadParameters {
537
readonly chainID: number
@@ -174,7 +128,7 @@ const getBestMatch = (abi: ContractABI | null) => {
174128
const AbiLoaderRequestResolver: Effect.Effect<
175129
RequestResolver.RequestResolver<AbiLoader, never>,
176130
never,
177-
AbiStore<AbiParams, ContractAbiResult>
131+
AbiStore
178132
> = RequestResolver.makeBatched((requests: Array<AbiLoader>) =>
179133
Effect.gen(function* () {
180134
if (requests.length === 0) return
@@ -218,27 +172,19 @@ const AbiLoaderRequestResolver: Effect.Effect<
218172
const allAvailableStrategies = Array.prependAll(strategies.default, strategies[req.chainID] ?? []).filter(
219173
(strategy) => strategy.type === 'address',
220174
)
221-
222175
return Effect.validateFirst(allAvailableStrategies, (strategy) => {
223-
return pipe(
224-
Effect.request(
225-
new GetContractABIStrategy({
226-
address: req.address,
227-
chainId: req.chainID,
228-
strategyId: strategy.id,
229-
}),
230-
strategy.resolver,
231-
),
232-
Effect.withRequestCaching(true),
233-
)
176+
return strategy.resolver({
177+
address: req.address,
178+
chainId: req.chainID,
179+
strategyId: strategy.id,
180+
})
234181
}).pipe(
235182
Effect.map(Either.left),
236183
Effect.orElseSucceed(() => Either.right(req)),
237184
)
238185
},
239186
{
240187
concurrency: 'unbounded',
241-
batching: true,
242188
},
243189
)
244190

@@ -254,19 +200,13 @@ const AbiLoaderRequestResolver: Effect.Effect<
254200

255201
// TODO: Distinct the errors and missing data, so we can retry on errors
256202
return Effect.validateFirst(allAvailableStrategies, (strategy) =>
257-
pipe(
258-
Effect.request(
259-
new GetContractABIStrategy({
260-
address,
261-
chainId: chainID,
262-
event,
263-
signature,
264-
strategyId: strategy.id,
265-
}),
266-
strategy.resolver,
267-
),
268-
Effect.withRequestCaching(true),
269-
),
203+
strategy.resolver({
204+
address,
205+
chainId: chainID,
206+
event,
207+
signature,
208+
strategyId: strategy.id,
209+
}),
270210
).pipe(Effect.orElseSucceed(() => null))
271211
},
272212
{

‎packages/transaction-decoder/src/abi-store.ts‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
import { Context, Effect, RateLimiter, Function, Layer } from 'effect'
2+
import { ContractABI, ContractAbiResolverStrategy, GetContractABIStrategyParams } from './abi-strategy/request-model.js'
3+
4+
export interface AbiParams {
5+
chainID: number
6+
address: string
7+
event?: string | undefined
8+
signature?: string | undefined
9+
}
10+
11+
export interface ContractAbiSuccess {
12+
status: 'success'
13+
result: ContractABI
14+
}
15+
16+
export interface ContractAbiNotFound {
17+
status: 'not-found'
18+
result: null
19+
}
20+
21+
export interface ContractAbiEmpty {
22+
status: 'empty'
23+
result: null
24+
}
25+
26+
export type ContractAbiResult = ContractAbiSuccess | ContractAbiNotFound | ContractAbiEmpty
27+
28+
type ChainOrDefault = number | 'default'
29+
30+
export interface AbiStore {
31+
readonly strategies: Record<ChainOrDefault, readonly ContractAbiResolverStrategy[]>
32+
readonly set: (key: AbiParams, value: ContractAbiResult) => Effect.Effect<void, never>
33+
readonly get: (arg: AbiParams) => Effect.Effect<ContractAbiResult, never>
34+
readonly getMany?: (arg: Array<AbiParams>) => Effect.Effect<Array<ContractAbiResult>, never>
35+
}
36+
37+
export const AbiStore = Context.GenericTag<AbiStore>('@3loop-decoder/AbiStore')
38+
39+
export const make = ({ strategies: strategiesWithoutRateLimit, ...rest }: AbiStore) =>
40+
Effect.gen(function* () {
41+
const strategies = yield* Effect.reduce(
42+
Object.entries(strategiesWithoutRateLimit),
43+
{} as Record<ChainOrDefault, ContractAbiResolverStrategy[]>,
44+
(acc, [chainID, specific]) =>
45+
Effect.gen(function* () {
46+
const all = yield* Effect.forEach(specific, (strategy) =>
47+
Effect.gen(function* () {
48+
const rateLimit = strategy.rateLimit ? yield* RateLimiter.make(strategy.rateLimit) : Function.identity
49+
50+
return yield* Effect.succeed({
51+
...strategy,
52+
resolver: (params: GetContractABIStrategyParams) => strategy.resolver(params).pipe(rateLimit),
53+
})
54+
}),
55+
)
56+
57+
return {
58+
...acc,
59+
[chainID]: all,
60+
}
61+
}),
62+
)
63+
return {
64+
strategies,
65+
...rest,
66+
}
67+
})
68+
69+
export const layer = (args: AbiStore) => Layer.scoped(AbiStore, make(args))

‎packages/transaction-decoder/src/abi-strategy/blockscout-abi.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { Effect, RequestResolver } from 'effect'
1+
import { Effect } from 'effect'
22
import * as RequestModel from './request-model.js'
33

44
async function fetchContractABI(
5-
{ address, chainId }: RequestModel.GetContractABIStrategy,
5+
{ address, chainId }: RequestModel.GetContractABIStrategyParams,
66
config: { apikey?: string; endpoint: string },
77
): Promise<RequestModel.ContractABI[]> {
88
const endpoint = config.endpoint
@@ -43,7 +43,7 @@ export const BlockscoutStrategyResolver = (config: {
4343
return {
4444
id: 'blockscout-strategy',
4545
type: 'address',
46-
resolver: RequestResolver.fromEffect((req: RequestModel.GetContractABIStrategy) =>
46+
resolver: (req: RequestModel.GetContractABIStrategyParams) =>
4747
Effect.withSpan(
4848
Effect.tryPromise({
4949
try: () => fetchContractABI(req, config),
@@ -52,6 +52,5 @@ export const BlockscoutStrategyResolver = (config: {
5252
'AbiStrategy.BlockscoutStrategyResolver',
5353
{ attributes: { chainId: req.chainId, address: req.address } },
5454
),
55-
),
5655
}
5756
}

0 commit comments

Comments
 (0)