10930828877

Committed 18 Sep 2024 10:06PM UTC coverage: 86.208% (-0.5%) from 86.665%

Build # 10930828877

Build Type

push

github

Committed by

brunomenezes

Commit Message

feat: Add support for decoding Voucher payload when available to remotely retrieve the destination contract ABI.

Run Details

1133 of 1373 branches covered (82.52%)

Branch coverage included in aggregate %.

91 of 158 new or added lines in 6 files covered. (57.59%)

10 existing lines in 1 file now uncovered.

8343 of 9619 relevant lines covered (86.73%)

45.91 hits per line

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

37.8

/apps/web/src/components/specification/hooks/useVoucherDecoder.tsx

"use client";
import { whatsabi } from "@shazow/whatsabi";
import { any, isNil } from "ramda";
import { isNilOrEmpty, isNotNilOrEmpty } from "ramda-adjunct";
import { useEffect, useState } from "react";
import { Abi, Hex, createPublicClient } from "viem";
import getSupportedChainInfo, {
    SupportedChainId,
} from "../../../lib/getSupportedChainInformation";
import buildTransport from "../../../lib/transport";
import { decodePayload } from "../decoder";
import { Specification } from "../types";
import { stringifyContent } from "../utils";

type UseVoucherDecoderProps = {
    destination: Hex;
    payload: Hex;
    chainId: number;
};
const cache = new Map<string, Abi>();

const buildClient = (chainId: number) => {
    const chain = getSupportedChainInfo(chainId as SupportedChainId);

    if (isNil(chain)) throw new Error(`ChainId ${chainId} is not supported!`);

    return createPublicClient({
        transport: buildTransport(chain.id),
        chain,
    });
};

const fetchAbiFor = async (destination: Hex, chainId: number) => {
    const cacheKey = `${chainId}:${destination}`;
    const abi = cache.get(cacheKey);

    if (abi && isNotNilOrEmpty(abi)) return abi;

    const result = await whatsabi.autoload(destination, {
        provider: buildClient(chainId),
        followProxies: true,
        onError: () => false,
    });

    cache.set(cacheKey, result.abi as Abi);

    return result.abi as Abi;
};

const buildSpecification = (
    destination: Hex,
    chainId: number,
    abi: Abi,
): Specification => {
    return {
        mode: "json_abi",
        abi,
        name: `Abi for ${destination} on chain ${chainId}`,
        timestamp: Date.now(),
        version: 1,
    };
};

interface Result {
    status: "loading" | "idle";
    data: string | null;
}

const useVoucherDecoder = ({
    destination,
    payload,
    chainId,
}: UseVoucherDecoderProps) => {
    const [result, setResult] = useState<Result>({
        status: "idle",
        data: null,
    });

    useEffect(() => {
        if (any(isNilOrEmpty)([destination, chainId, payload])) return;

        setResult((old) => ({ ...old, status: "loading" }));

        (async () => {
            let result: string;

            const baseMessage = "Skipping voucher decoding. Reason:";
            try {
                const abi = await fetchAbiFor(destination, chainId);
                const spec = buildSpecification(destination, chainId, abi);
                const envelope = decodePayload(spec, payload);

                if (!envelope.error) result = stringifyContent(envelope.result);
                else {
                    console.info(`${baseMessage} ${envelope.error.message}`);
                    result = payload;
                }
            } catch (error: any) {
                console.info(`${baseMessage} ${error.message}`);
                result = payload;
            }

            setResult(() => ({ status: "idle", data: result }));
        })();
    }, [destination, chainId, payload]);

    return result;
};

export default useVoucherDecoder;

1	"use client";	1✔
2	import { whatsabi } from "@shazow/whatsabi";	1✔
3	import { any, isNil } from "ramda";	1✔
4	import { isNilOrEmpty, isNotNilOrEmpty } from "ramda-adjunct";	1✔
5	import { useEffect, useState } from "react";	1✔
6	import { Abi, Hex, createPublicClient } from "viem";	1✔
7	import getSupportedChainInfo, {
8	SupportedChainId,
9	} from "../../../lib/getSupportedChainInformation";	1✔
10	import buildTransport from "../../../lib/transport";	1✔
11	import { decodePayload } from "../decoder";	1✔
12	import { Specification } from "../types";
13	import { stringifyContent } from "../utils";	1✔
14
15	type UseVoucherDecoderProps = {
16	destination: Hex;
17	payload: Hex;
18	chainId: number;
19	};
20	const cache = new Map<string, Abi>();	1✔
21
22	const buildClient = (chainId: number) => {	1✔
NEW 23	const chain = getSupportedChainInfo(chainId as SupportedChainId);	×
24
NEW 25	if (isNil(chain)) throw new Error(`ChainId ${chainId} is not supported!`);	×
26
NEW 27	return createPublicClient({	×
NEW 28	transport: buildTransport(chain.id),	×
NEW 29	chain,	×
NEW 30	});	×
NEW 31	};	×
32
33	const fetchAbiFor = async (destination: Hex, chainId: number) => {	1✔
NEW 34	const cacheKey = `${chainId}:${destination}`;	×
NEW 35	const abi = cache.get(cacheKey);	×
36
NEW 37	if (abi && isNotNilOrEmpty(abi)) return abi;	×
38
NEW 39	const result = await whatsabi.autoload(destination, {	×
NEW 40	provider: buildClient(chainId),	×
NEW 41	followProxies: true,	×
NEW 42	onError: () => false,	×
NEW 43	});	×
44
NEW 45	cache.set(cacheKey, result.abi as Abi);	×
46
NEW 47	return result.abi as Abi;	×
NEW 48	};	×
49
50	const buildSpecification = (	1✔
NEW 51	destination: Hex,	×
NEW 52	chainId: number,	×
NEW 53	abi: Abi,	×
NEW 54	): Specification => {	×
NEW 55	return {	×
NEW 56	mode: "json_abi",	×
NEW 57	abi,	×
NEW 58	name: `Abi for ${destination} on chain ${chainId}`,	×
NEW 59	timestamp: Date.now(),	×
NEW 60	version: 1,	×
NEW 61	};	×
NEW 62	};	×
63
64	interface Result {
65	status: "loading" \| "idle";
66	data: string \| null;
67	}
68
69	const useVoucherDecoder = ({	1✔
70	destination,	33✔
71	payload,	33✔
72	chainId,	33✔
73	}: UseVoucherDecoderProps) => {	33✔
74	const [result, setResult] = useState<Result>({	33✔
75	status: "idle",	33✔
76	data: null,	33✔
77	});	33✔
78
79	useEffect(() => {	33✔
80	if (any(isNilOrEmpty)([destination, chainId, payload])) return;	13!
81
NEW 82	setResult((old) => ({ ...old, status: "loading" }));	×
83
NEW 84	(async () => {	×
NEW 85	let result: string;	×
86
NEW 87	const baseMessage = "Skipping voucher decoding. Reason:";	×
NEW 88	try {	×
NEW 89	const abi = await fetchAbiFor(destination, chainId);	×
NEW 90	const spec = buildSpecification(destination, chainId, abi);	×
NEW 91	const envelope = decodePayload(spec, payload);	×
92
NEW 93	if (!envelope.error) result = stringifyContent(envelope.result);	×
NEW 94	else {	×
NEW 95	console.info(`${baseMessage} ${envelope.error.message}`);	×
NEW 96	result = payload;	×
NEW 97	}	×
NEW 98	} catch (error: any) {	×
NEW 99	console.info(`${baseMessage} ${error.message}`);	×
NEW 100	result = payload;	×
NEW 101	}	×
102
NEW 103	setResult(() => ({ status: "idle", data: result }));	×
NEW 104	})();	×
105	}, [destination, chainId, payload]);	33✔
106
107	return result;	33✔
108	};	33✔
109
110	export default useVoucherDecoder;	1✔

cartesi / rollups-explorer / 10930828877

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