10174305868

Committed 31 Jul 2024 04:56AM UTC coverage: 93.726% (+0.4%) from 93.346%

Build # 10174305868

Build Type

Pull #213

github

Committed by

brunomenezes

Commit Message

chore: Small meta and text fixes.

Pull Request Pull Request #213: Feature/165 add decode specification v1

Run Details

1141 of 1361 branches covered (83.84%)

Branch coverage included in aggregate %.

3317 of 3433 new or added lines in 36 files covered. (96.62%)

1 existing line in 1 file now uncovered.

12348 of 13031 relevant lines covered (94.76%)

46.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.22

/apps/web/src/components/specification/decoder.ts

import {
    T,
    cond,
    head,
    includes,
    isEmpty,
    isNil,
    pathEq,
    pathOr,
    pipe,
} from "ramda";
import {
    AbiDecodingDataSizeTooSmallError,
    AbiFunction,
    AbiFunctionSignatureNotFoundError,
    Hex,
    InvalidAbiParametersError,
    decodeAbiParameters,
    decodeFunctionData,
    parseAbiParameters,
    slice,
} from "viem";
import SpecificationModeNotSupportedError from "./errors/SpecificationModeNotSupported";
import { ABI_PARAMS, JSON_ABI, Specification, specModes } from "./types";

interface Piece {
    name: string;
    part: Hex | Uint8Array;
    decodedPart?: any;
}

export interface Envelope {
    spec: Specification;
    input: Hex | Uint8Array;
    pieces: Piece[];
    result: Record<string, any>;
    error?: Error;
}

const getPieces = (
    abiParams: readonly string[],
    encodedData: Hex | Uint8Array,
): Piece[] => {
    const abiParameters = parseAbiParameters(abiParams);

    const resultList = decodeAbiParameters(
        // @ts-ignore dynamic type complains
        abiParameters,
        encodedData,
    );

    return resultList.map((decodedVal, index) => {
        // @ts-ignore
        const { name } = abiParameters[index] as {
            name: string;
        };

        return {
            name,
            part: encodedData,
            decodedPart: decodedVal,
        } as Piece;
    });
};

const addPiecesToEnvelope = (e: Envelope): Envelope => {
    if (!e.error && e.spec.mode === "abi_params") {
        try {
            if (e.spec.sliceInstructions?.length) {
                e.spec.sliceInstructions.forEach((instruction, index) => {
                    const { from, to, name, type } = instruction;
                    const part = slice(e.input, from, to);
                    const decodedPart =
                        !isNil(type) && !isEmpty(type)
                            ? head(decodeAbiParameters([{ type, name }], part))
                            : part;

                    e.pieces.push({
                        name: name ?? `param${index}`,
                        part,
                        decodedPart,
                    });
                });
            } else {
                const pieces = getPieces(e.spec.abiParams, e.input);
                e.pieces.push(...pieces);
            }
        } catch (error: any) {
            const message = pathOr(error.message, ["shortMessage"], error);
            const errorMeta = pathOr([], ["metaMessages"], error).join("\n");
            e.error = new Error(`${message}\n\n${errorMeta}`);
        }
    }

    return e;
};

const decodeTargetSliceAndAddToPieces = (e: Envelope): Envelope => {
    if (!e.error && e.spec.mode === "abi_params") {
        const targetName = e.spec.sliceTarget;
        const piece = e.pieces.find((piece) => piece.name === targetName);

        try {
            if (piece && piece.part) {
                const pieces = getPieces(e.spec.abiParams, piece.part);
                e.pieces.push(...pieces);
            }
        } catch (error: any) {
            const message = pathOr(error.message, ["shortMessage"], error);
            let errorMeta;
            let extra;

            if (error instanceof AbiDecodingDataSizeTooSmallError) {
                errorMeta = pathOr([], ["metaMessages"], error).join("\n");
                extra = `Slice name: "${targetName}" (Is it the right one?)`;
            }

            if (error instanceof InvalidAbiParametersError) {
                errorMeta = `ABI Parameters : [ ${e.spec.abiParams.join(
                    ",",
                )} ]`;
                extra = "Check the ABI parameters defined.";
            }

            const errorMessage = `${message}\n\n${errorMeta ?? ""}\n${
                extra ?? ""
            }`;

            e.error = new Error(errorMessage);
        }
    }
    return e;
};

const prepareResultFromPieces = (e: Envelope): Envelope => {
    if (!e.error && e.spec.mode === "abi_params") {
        const sliceTarget = e.spec.sliceTarget;
        e.result = e.pieces.reduce((prev, { name, decodedPart }, index) => {
            /**
             * Adding a unwrap effect
             * decoded target is not included in the result
             */
            if (sliceTarget === name) return prev;

            const key = name ?? `params${index}`;
            return { ...prev, [key]: decodedPart };
        }, {});
    }

    return e;
};

const prepareResultForJSONABI = (e: Envelope): Envelope => {
    if (e.spec.mode === "json_abi") {
        try {
            const { functionName, args } = decodeFunctionData({
                abi: e.spec.abi,
                data: e.input as Hex,
            });

            const orderedNamedArgs: [string, any][] = [];

            if (args && args?.length > 0) {
                const abiItem = e.spec.abi.find(
                    (item) =>
                        item.type === "function" && item.name === functionName,
                ) as AbiFunction;

                // respecting order of arguments but including abi names
                abiItem.inputs.forEach((param, index) => {
                    const name = param.name ?? `param${0}`;
                    orderedNamedArgs.push([name, args[index]]);
                });
            }

            e.result = {
                functionName,
                args,
                orderedNamedArgs,
            };
        } catch (err: any) {
            const message =
                err instanceof AbiFunctionSignatureNotFoundError
                    ? err.shortMessage
                    : err.message;
            e.error = new Error(message);
        }
    }

    return e;
};

const transform: (e: Envelope) => Envelope = cond([
    [
        pathEq(ABI_PARAMS, ["spec", "mode"]),
        pipe(
            addPiecesToEnvelope,
            decodeTargetSliceAndAddToPieces,
            prepareResultFromPieces,
        ),
    ],
    [pathEq(JSON_ABI, ["spec", "mode"]), prepareResultForJSONABI],
    [
        T,
        (e: Envelope) => {
            e.error = new SpecificationModeNotSupportedError(e.spec);
            return e;
        },
    ],
]);

/**
 * Decode the payload data based on the specification passed. The return
 * contains the result but also could contain an error as a value, therefore
 * the callee should decide what to do with it.
 * @param spec {Specification}
 * @param payload {Hex | Uint8Array}
 * @throws {SpecificationModeNotSupportedError}
 * @returns {Envelope}
 */
export function decodePayload(
    spec: Specification,
    input: Hex | Uint8Array,
): Envelope {
    if (!includes(spec.mode, specModes)) {
        throw new SpecificationModeNotSupportedError(spec);
    }

    const envelope: Envelope = {
        spec,
        input,
        pieces: [],
        result: {},
    };

    return transform(envelope);
}

1	import {	1✔
2	T,	1✔
3	cond,	1✔
4	head,	1✔
5	includes,	1✔
6	isEmpty,	1✔
7	isNil,	1✔
8	pathEq,	1✔
9	pathOr,	1✔
10	pipe,	1✔
11	} from "ramda";	1✔
12	import {	1✔
13	AbiDecodingDataSizeTooSmallError,	1✔
14	AbiFunction,	1✔
15	AbiFunctionSignatureNotFoundError,	1✔
16	Hex,	1✔
17	InvalidAbiParametersError,	1✔
18	decodeAbiParameters,	1✔
19	decodeFunctionData,	1✔
20	parseAbiParameters,	1✔
21	slice,	1✔
22	} from "viem";	1✔
23	import SpecificationModeNotSupportedError from "./errors/SpecificationModeNotSupported";	1✔
24	import { ABI_PARAMS, JSON_ABI, Specification, specModes } from "./types";	1✔
25		1✔
26	interface Piece {	1✔
27	name: string;	1✔
28	part: Hex \| Uint8Array;	1✔
29	decodedPart?: any;	1✔
30	}	1✔
31		1✔
32	export interface Envelope {	1✔
33	spec: Specification;	1✔
34	input: Hex \| Uint8Array;	1✔
35	pieces: Piece[];	1✔
36	result: Record<string, any>;	1✔
37	error?: Error;	1✔
38	}	1✔
39		1✔
40	const getPieces = (	1✔
41	abiParams: readonly string[],	8✔
42	encodedData: Hex \| Uint8Array,	8✔
43	): Piece[] => {	8✔
44	const abiParameters = parseAbiParameters(abiParams);	8✔
45		8✔
46	const resultList = decodeAbiParameters(	8✔
47	// @ts-ignore dynamic type complains	8✔
48	abiParameters,	8✔
49	encodedData,	8✔
50	);	8✔
51		8✔
52	return resultList.map((decodedVal, index) => {	8✔
53	// @ts-ignore	23✔
54	const { name } = abiParameters[index] as {	23✔
55	name: string;	23✔
56	};	23✔
57		23✔
58	return {	23✔
59	name,	23✔
60	part: encodedData,	23✔
61	decodedPart: decodedVal,	23✔
62	} as Piece;	23✔
63	});	8✔
64	};	8✔
65		1✔
66	const addPiecesToEnvelope = (e: Envelope): Envelope => {	1✔
67	if (!e.error && e.spec.mode === "abi_params") {	11✔
68	try {	11✔
69	if (e.spec.sliceInstructions?.length) {	11✔
70	e.spec.sliceInstructions.forEach((instruction, index) => {	6✔
71	const { from, to, name, type } = instruction;	17✔
72	const part = slice(e.input, from, to);	17✔
73	const decodedPart =	17✔
74	!isNil(type) && !isEmpty(type)	17✔
75	? head(decodeAbiParameters([{ type, name }], part))	4✔
76	: part;	13✔
77		17✔
78	e.pieces.push({	17✔
79	name: name ?? `param${index}`,	17!
80	part,	17✔
81	decodedPart,	17✔
82	});	17✔
83	});	6✔
84	} else {	11✔
85	const pieces = getPieces(e.spec.abiParams, e.input);	5✔
86	e.pieces.push(...pieces);	5✔
87	}	5✔
88	} catch (error: any) {	11✔
89	const message = pathOr(error.message, ["shortMessage"], error);	1✔
90	const errorMeta = pathOr([], ["metaMessages"], error).join("\n");	1✔
91	e.error = new Error(`${message}\n\n${errorMeta}`);	1✔
92	}	1✔
93	}	11✔
94		11✔
95	return e;	11✔
96	};	11✔
97		1✔
98	const decodeTargetSliceAndAddToPieces = (e: Envelope): Envelope => {	1✔
99	if (!e.error && e.spec.mode === "abi_params") {	11✔
100	const targetName = e.spec.sliceTarget;	10✔
101	const piece = e.pieces.find((piece) => piece.name === targetName);	10✔
102		10✔
103	try {	10✔
104	if (piece && piece.part) {	10✔
105	const pieces = getPieces(e.spec.abiParams, piece.part);	3✔
106	e.pieces.push(...pieces);	3✔
107	}	3✔
108	} catch (error: any) {	10✔
109	const message = pathOr(error.message, ["shortMessage"], error);	1✔
110	let errorMeta;	1✔
111	let extra;	1✔
112		1✔
113	if (error instanceof AbiDecodingDataSizeTooSmallError) {	1✔
114	errorMeta = pathOr([], ["metaMessages"], error).join("\n");	1✔
115	extra = `Slice name: "${targetName}" (Is it the right one?)`;	1✔
116	}	1✔
117		1✔
118	if (error instanceof InvalidAbiParametersError) {	1!
NEW 119	errorMeta = `ABI Parameters : [ ${e.spec.abiParams.join(	×
NEW 120	",",	×
NEW 121	)} ]`;	×
NEW 122	extra = "Check the ABI parameters defined.";	×
NEW 123	}	×
124		1✔
125	const errorMessage = `${message}\n\n${errorMeta ?? ""}\n${	1!
126	extra ?? ""	1!
127	}`;	1✔
128		1✔
129	e.error = new Error(errorMessage);	1✔
130	}	1✔
131	}	10✔
132	return e;	11✔
133	};	11✔
134		1✔
135	const prepareResultFromPieces = (e: Envelope): Envelope => {	1✔
136	if (!e.error && e.spec.mode === "abi_params") {	11✔
137	const sliceTarget = e.spec.sliceTarget;	9✔
138	e.result = e.pieces.reduce((prev, { name, decodedPart }, index) => {	9✔
139	/**	36✔
140	* Adding a unwrap effect	36✔
141	* decoded target is not included in the result	36✔
142	*/	36✔
143	if (sliceTarget === name) return prev;	36✔
144		34✔
145	const key = name ?? `params${index}`;	36!
146	return { ...prev, [key]: decodedPart };	36✔
147	}, {});	9✔
148	}	9✔
149		11✔
150	return e;	11✔
151	};	11✔
152		1✔
153	const prepareResultForJSONABI = (e: Envelope): Envelope => {	1✔
154	if (e.spec.mode === "json_abi") {	2✔
155	try {	2✔
156	const { functionName, args } = decodeFunctionData({	2✔
157	abi: e.spec.abi,	2✔
158	data: e.input as Hex,	2✔
159	});	2✔
160		2✔
161	const orderedNamedArgs: [string, any][] = [];	2✔
162		2✔
163	if (args && args?.length > 0) {	2✔
164	const abiItem = e.spec.abi.find(	1✔
165	(item) =>	1✔
166	item.type === "function" && item.name === functionName,	2✔
167	) as AbiFunction;	1✔
168		1✔
169	// respecting order of arguments but including abi names	1✔
170	abiItem.inputs.forEach((param, index) => {	1✔
171	const name = param.name ?? `param${0}`;	6!
172	orderedNamedArgs.push([name, args[index]]);	6✔
173	});	1✔
174	}	1✔
175		1✔
176	e.result = {	1✔
177	functionName,	1✔
178	args,	1✔
179	orderedNamedArgs,	1✔
180	};	1✔
181	} catch (err: any) {	1✔
182	const message =	1✔
183	err instanceof AbiFunctionSignatureNotFoundError	1✔
184	? err.shortMessage	1!
NEW 185	: err.message;	×
186	e.error = new Error(message);	1✔
187	}	1✔
188	}	2✔
189		2✔
190	return e;	2✔
191	};	2✔
192		1✔
193	const transform: (e: Envelope) => Envelope = cond([	1✔
194	[	1✔
195	pathEq(ABI_PARAMS, ["spec", "mode"]),	1✔
196	pipe(	1✔
197	addPiecesToEnvelope,	1✔
198	decodeTargetSliceAndAddToPieces,	1✔
199	prepareResultFromPieces,	1✔
200	),	1✔
201	],	1✔
202	[pathEq(JSON_ABI, ["spec", "mode"]), prepareResultForJSONABI],	1✔
203	[	1✔
204	T,	1✔
205	(e: Envelope) => {	1✔
NEW 206	e.error = new SpecificationModeNotSupportedError(e.spec);	×
NEW 207	return e;	×
NEW 208	},	×
209	],	1✔
210	]);	1✔
211		1✔
212	/**	1✔
213	* Decode the payload data based on the specification passed. The return	1✔
214	* contains the result but also could contain an error as a value, therefore	1✔
215	* the callee should decide what to do with it.	1✔
216	* @param spec {Specification}	1✔
217	* @param payload {Hex \| Uint8Array}	1✔
218	* @throws {SpecificationModeNotSupportedError}	1✔
219	* @returns {Envelope}	1✔
220	*/	1✔
221	export function decodePayload(	1✔
222	spec: Specification,	14✔
223	input: Hex \| Uint8Array,	14✔
224	): Envelope {	14✔
225	if (!includes(spec.mode, specModes)) {	14✔
226	throw new SpecificationModeNotSupportedError(spec);	1✔
227	}	1✔
228		13✔
229	const envelope: Envelope = {	13✔
230	spec,	13✔
231	input,	13✔
232	pieces: [],	13✔
233	result: {},	13✔
234	};	13✔
235		13✔
236	return transform(envelope);	13✔
237	}	13✔

cartesi / rollups-explorer / 10174305868

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous