Skip to content

Commit a02e460

Browse files
FerossgpFerossgp
committed
Implement different type of error in strategies
1 parent a91f392 commit a02e460

13 files changed

Lines changed: 509 additions & 187 deletions

‎.changeset/forty-cars-clap.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@3loop/transaction-decoder': minor
3+
---
4+
5+
Implement circuit breaker and request pool for abi and meta strategies

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

Lines changed: 72 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,68 @@
11
import { Effect } from 'effect'
22
import * as RequestModel from './request-model.js'
33

4+
type FetchResult =
5+
| { type: 'success'; data: RequestModel.ContractABI[] }
6+
| { type: 'missing'; reason: string }
7+
| { type: 'error'; cause: unknown }
8+
49
async function fetchContractABI(
510
{ address, chainId }: RequestModel.GetContractABIStrategyParams,
611
config: { apikey?: string; endpoint: string },
7-
): Promise<RequestModel.ContractABI[]> {
8-
const endpoint = config.endpoint
12+
): Promise<FetchResult> {
13+
try {
14+
const endpoint = config.endpoint
915

10-
const params: Record<string, string> = {
11-
module: 'contract',
12-
action: 'getabi',
13-
address,
14-
}
16+
const params: Record<string, string> = {
17+
module: 'contract',
18+
action: 'getabi',
19+
address,
20+
}
1521

16-
if (config?.apikey) {
17-
params['apikey'] = config.apikey
18-
}
22+
if (config?.apikey) {
23+
params['apikey'] = config.apikey
24+
}
1925

20-
const searchParams = new URLSearchParams(params)
26+
const searchParams = new URLSearchParams(params)
2127

22-
const response = await fetch(`${endpoint}?${searchParams.toString()}`)
23-
const json = (await response.json()) as { status: string; result: string; message: string }
28+
const response = await fetch(`${endpoint}?${searchParams.toString()}`)
29+
const json = (await response.json()) as { status: string; result: string; message: string }
2430

25-
if (json.status === '1') {
26-
return [
27-
{
28-
chainID: chainId,
29-
address,
30-
abi: json.result,
31-
type: 'address',
32-
},
33-
]
34-
}
31+
if (json.status === '1') {
32+
return {
33+
type: 'success',
34+
data: [
35+
{
36+
chainID: chainId,
37+
address,
38+
abi: json.result,
39+
type: 'address',
40+
},
41+
],
42+
}
43+
}
3544

36-
throw new Error(`Failed to fetch ABI for ${address} on chain ${chainId}`)
45+
// If the API request was successful but no ABI was found
46+
if (
47+
json.status === '0' &&
48+
(json.message?.includes('not verified') || json.result === 'Contract source code not verified')
49+
) {
50+
return {
51+
type: 'missing',
52+
reason: `No verified ABI found: ${json.message || json.result}`,
53+
}
54+
}
55+
56+
return {
57+
type: 'error',
58+
cause: json,
59+
}
60+
} catch (error) {
61+
return {
62+
type: 'error',
63+
cause: error,
64+
}
65+
}
3766
}
3867

3968
export const BlockscoutStrategyResolver = (config: {
@@ -45,9 +74,25 @@ export const BlockscoutStrategyResolver = (config: {
4574
type: 'address',
4675
resolver: (req: RequestModel.GetContractABIStrategyParams) =>
4776
Effect.withSpan(
48-
Effect.tryPromise({
49-
try: () => fetchContractABI(req, config),
50-
catch: () => new RequestModel.ResolveStrategyABIError('Blockscout', req.address, req.chainId),
77+
Effect.gen(function* () {
78+
const result = yield* Effect.promise(() => fetchContractABI(req, config))
79+
80+
if (result.type === 'success') {
81+
return result.data
82+
} else if (result.type === 'missing') {
83+
return yield* Effect.fail(
84+
new RequestModel.MissingABIStrategyError(
85+
req.address,
86+
req.chainId,
87+
'blockscout-strategy',
88+
undefined,
89+
undefined,
90+
result.reason,
91+
),
92+
)
93+
} else {
94+
return yield* Effect.fail(new RequestModel.ResolveStrategyABIError('Blockscout', req.address, req.chainId))
95+
}
5196
}),
5297
'AbiStrategy.BlockscoutStrategyResolver',
5398
{ attributes: { chainId: req.chainId, address: req.address } },

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

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

4+
type FetchResult =
5+
| { type: 'success'; data: RequestModel.ContractABI[] }
6+
| { type: 'missing'; reason: string }
7+
| { type: 'error'; cause: unknown }
8+
49
const endpoints: { [k: number]: string } = {
510
// all mainnet
611
1: 'https://api.etherscan.io/api',
@@ -50,35 +55,59 @@ const endpoints: { [k: number]: string } = {
5055
async function fetchContractABI(
5156
{ address, chainId }: RequestModel.GetContractABIStrategyParams,
5257
config?: { apikey?: string; endpoint?: string },
53-
): Promise<RequestModel.ContractABI[]> {
54-
const endpoint = config?.endpoint ?? endpoints[chainId]
55-
const params: Record<string, string> = {
56-
module: 'contract',
57-
action: 'getabi',
58-
address,
59-
}
58+
): Promise<FetchResult> {
59+
try {
60+
const endpoint = config?.endpoint ?? endpoints[chainId]
61+
const params: Record<string, string> = {
62+
module: 'contract',
63+
action: 'getabi',
64+
address,
65+
}
6066

61-
if (config?.apikey) {
62-
params['apikey'] = config.apikey
63-
}
67+
if (config?.apikey) {
68+
params['apikey'] = config.apikey
69+
}
6470

65-
const searchParams = new URLSearchParams(params)
71+
const searchParams = new URLSearchParams(params)
6672

67-
const response = await fetch(`${endpoint}?${searchParams.toString()}`)
68-
const json = (await response.json()) as { status: string; result: string }
73+
const response = await fetch(`${endpoint}?${searchParams.toString()}`)
74+
const json = (await response.json()) as { status: string; result: string }
6975

70-
if (json.status === '1') {
71-
return [
72-
{
73-
type: 'address',
74-
address,
75-
chainID: chainId,
76-
abi: json.result,
77-
},
78-
]
79-
}
76+
if (json.status === '1') {
77+
return {
78+
type: 'success',
79+
data: [
80+
{
81+
type: 'address',
82+
address,
83+
chainID: chainId,
84+
abi: json.result,
85+
},
86+
],
87+
}
88+
}
8089

81-
throw new Error(`Failed to fetch ABI for ${address} on chain ${chainId}`)
90+
// If the API request was successful but no ABI was found
91+
if (
92+
json.status === '0' &&
93+
(json.result === 'Contract source code not verified' || json.result.includes('not verified'))
94+
) {
95+
return {
96+
type: 'missing',
97+
reason: `No verified ABI found: ${json.result}`,
98+
}
99+
}
100+
101+
return {
102+
type: 'error',
103+
cause: json,
104+
}
105+
} catch (error) {
106+
return {
107+
type: 'error',
108+
cause: error,
109+
}
110+
}
82111
}
83112

84113
export const EtherscanStrategyResolver = (config?: {
@@ -90,9 +119,25 @@ export const EtherscanStrategyResolver = (config?: {
90119
type: 'address',
91120
resolver: (req: RequestModel.GetContractABIStrategyParams) =>
92121
Effect.withSpan(
93-
Effect.tryPromise({
94-
try: () => fetchContractABI(req, config),
95-
catch: () => new RequestModel.ResolveStrategyABIError('etherscan', req.address, req.chainId),
122+
Effect.gen(function* () {
123+
const result = yield* Effect.promise(() => fetchContractABI(req, config))
124+
125+
if (result.type === 'success') {
126+
return result.data
127+
} else if (result.type === 'missing') {
128+
return yield* Effect.fail(
129+
new RequestModel.MissingABIStrategyError(
130+
req.address,
131+
req.chainId,
132+
'etherscan-strategy',
133+
undefined,
134+
undefined,
135+
result.reason,
136+
),
137+
)
138+
} else {
139+
return yield* Effect.fail(new RequestModel.ResolveStrategyABIError('etherscan', req.address, req.chainId))
140+
}
96141
}),
97142
'AbiStrategy.EtherscanStrategyResolver',
98143
{ attributes: { chainId: req.chainId, address: req.address } },

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

Lines changed: 72 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,67 @@ import * as RequestModel from './request-model.js'
33

44
const endpoint = 'https://api.etherscan.io/v2/api'
55

6+
type FetchResult =
7+
| { type: 'success'; data: RequestModel.ContractABI[] }
8+
| { type: 'missing'; reason: string }
9+
| { type: 'error'; cause: unknown }
10+
611
async function fetchContractABI(
712
{ address, chainId }: RequestModel.GetContractABIStrategyParams,
813
config?: { apikey?: string },
9-
): Promise<RequestModel.ContractABI[]> {
10-
const params: Record<string, string> = {
11-
module: 'contract',
12-
action: 'getabi',
13-
chainId: chainId.toString(),
14-
address,
15-
}
14+
): Promise<FetchResult> {
15+
try {
16+
const params: Record<string, string> = {
17+
module: 'contract',
18+
action: 'getabi',
19+
chainId: chainId.toString(),
20+
address,
21+
}
1622

17-
if (config?.apikey) {
18-
params['apikey'] = config.apikey
19-
}
23+
if (config?.apikey) {
24+
params['apikey'] = config.apikey
25+
}
2026

21-
const searchParams = new URLSearchParams(params)
27+
const searchParams = new URLSearchParams(params)
2228

23-
const response = await fetch(`${endpoint}?${searchParams.toString()}`)
24-
const json = (await response.json()) as { status: string; result: string }
29+
const response = await fetch(`${endpoint}?${searchParams.toString()}`)
30+
const json = (await response.json()) as { status: string; result: string }
2531

26-
if (json.status === '1') {
27-
return [
28-
{
29-
type: 'address',
30-
address,
31-
chainID: chainId,
32-
abi: json.result,
33-
},
34-
]
35-
}
32+
if (json.status === '1') {
33+
return {
34+
type: 'success',
35+
data: [
36+
{
37+
type: 'address',
38+
address,
39+
chainID: chainId,
40+
abi: json.result,
41+
},
42+
],
43+
}
44+
}
3645

37-
throw new Error(`Failed to fetch ABI for ${address} on chain ${chainId}`, {
38-
cause: json,
39-
})
46+
// If the API request was successful but no ABI was found
47+
if (
48+
json.status === '0' &&
49+
(json.result === 'Contract source code not verified' || json.result.includes('not verified'))
50+
) {
51+
return {
52+
type: 'missing',
53+
reason: `No verified ABI found: ${json.result}`,
54+
}
55+
}
56+
57+
return {
58+
type: 'error',
59+
cause: json,
60+
}
61+
} catch (error) {
62+
return {
63+
type: 'error',
64+
cause: error,
65+
}
66+
}
4067
}
4168

4269
export const EtherscanV2StrategyResolver = (config?: {
@@ -55,9 +82,25 @@ export const EtherscanV2StrategyResolver = (config?: {
5582
},
5683
resolver: (req: RequestModel.GetContractABIStrategyParams) =>
5784
Effect.withSpan(
58-
Effect.tryPromise({
59-
try: () => fetchContractABI(req, config),
60-
catch: () => new RequestModel.ResolveStrategyABIError('etherscanV2', req.address, req.chainId),
85+
Effect.gen(function* () {
86+
const result = yield* Effect.promise(() => fetchContractABI(req, config))
87+
88+
if (result.type === 'success') {
89+
return result.data
90+
} else if (result.type === 'missing') {
91+
return yield* Effect.fail(
92+
new RequestModel.MissingABIStrategyError(
93+
req.address,
94+
req.chainId,
95+
'etherscanV2-strategy',
96+
undefined,
97+
undefined,
98+
result.reason,
99+
),
100+
)
101+
} else {
102+
return yield* Effect.fail(new RequestModel.ResolveStrategyABIError('etherscanV2', req.address, req.chainId))
103+
}
61104
}),
62105
'AbiStrategy.EtherscanV2StrategyResolver',
63106
{ attributes: { chainId: req.chainId, address: req.address } },

‎packages/transaction-decoder/src/abi-strategy/experimental-erc20.ts‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,17 @@ const getLocalFragments = (service: PublicClient, { address, chainId }: RequestM
4444
] as RequestModel.ContractABI[]
4545
}
4646

47-
return yield* Effect.fail(new RequestModel.ResolveStrategyABIError('local-strategy', address, chainId))
47+
// Contract exists but is not an ERC20 token - this is a "no data found" case
48+
return yield* Effect.fail(
49+
new RequestModel.MissingABIStrategyError(
50+
address,
51+
chainId,
52+
'experimental-erc20-strategy',
53+
undefined,
54+
undefined,
55+
'Contract is not an ERC20 token',
56+
),
57+
)
4858
})
4959

5060
export const ExperimentalErc20AbiStrategyResolver = (

0 commit comments

Comments
 (0)