Add datasource for Safe Decoder Service #2313
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iamacook
force-pushed
the
safe-decoder-datasource
branch
from
ef803f7 to
4b4cb62
Compare
iamacook
commented
Jan 29, 2025
Comment on lines
+6
to
+26
| export const ProjectSchema = z.object({ | ||
| description: z.string(), | ||
| logo_file: z.string().url(), | ||
| }); | ||
|
|
||
| export const AbiSchema = z.object({ | ||
| // We could use abitype here, but we don't consume the ABI/it would increase entity complexity | ||
| abi_json: z.array(z.record(z.unknown())), | ||
| abi_hash: HexSchema, | ||
| modified: z.coerce.date(), | ||
| }); | ||
|
|
||
| export const ContractSchema = z.object({ | ||
| address: AddressSchema, | ||
| name: z.string(), | ||
| display_name: z.string().nullable(), | ||
| chain_id: z.number().transform(String), | ||
| project: ProjectSchema.nullable(), | ||
| abi: AbiSchema, | ||
| modified: z.coerce.date(), | ||
| }); |
There was a problem hiding this comment.
@Uxio0 has confirmed that this (and decoded data) will be changed to camel case, hence leaving this as a draft.
iamacook
commented
Jan 29, 2025
Comment on lines
+11
to
+53
| export const MultisendSchema = z.object({ | ||
| operation: z.nativeEnum(Operation), | ||
| value: NumericStringSchema, | ||
| data_decoded: z.lazy(() => BaseDataDecodedSchema.nullable()), | ||
| to: AddressSchema, | ||
| data: HexSchema.nullable(), | ||
| }); | ||
|
|
||
| export const ValueDecodedSchema = z.union([ | ||
| z.array(z.lazy(() => MultisendSchema)), | ||
| z.lazy(() => BaseDataDecodedSchema), | ||
| ]); | ||
|
|
||
| export const ParameterSchema = z.object({ | ||
| name: z.string(), | ||
| type: z.string(), | ||
| value: HexSchema, | ||
| value_decoded: ValueDecodedSchema.nullable(), | ||
| }); | ||
|
|
||
| export const BaseDataDecodedSchemaShape = { | ||
| method: z.string(), | ||
| parameters: z.array(z.lazy(() => ParameterSchema)), | ||
| }; | ||
|
|
||
| // We need explicitly define ZodType due to recursion | ||
| export const BaseDataDecodedSchema: z.ZodType<{ | ||
| method: string; | ||
| parameters: Array<z.infer<typeof ParameterSchema>>; | ||
| }> = z.lazy(() => z.object(BaseDataDecodedSchemaShape)); | ||
|
|
||
| export const Accuracy = [ | ||
| 'FULL_MATCH', // Matched contract and chain ID | ||
| 'PARTIAL_MATCH', // Matched contract | ||
| 'ONLY_FUNCTION_MATCH', // Matched function from another contract | ||
| 'NO_MATCH', // Selector cannot be decoded | ||
| ] as const; | ||
|
|
||
| export const DataDecodedSchema = z.lazy(() => | ||
| z.object(BaseDataDecodedSchemaShape).extend({ | ||
| accuracy: z.enum([...Accuracy, 'UNKNOWN']).catch('UNKNOWN'), | ||
| }), | ||
| ); |
There was a problem hiding this comment.
As before re. snake- to camelcase.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The new Safe Decoder Service improves upon the decoder of the Safe Transaction Service. As such, we intend to migrate to it.
This lays the foundation of usage, by creating a datasource (with manager) and base repository for validating the responses.
Changes
safeDataDecoder.baseUri(test) configurationDataDecoderApiManagerinterface, implementation and moduleDataDecoderApiinterface, implementation and moduleDataDecodedand `Contract, with inferred types and buildersDataDecoderRepositoryfor accessing/validating datasource responses