Cartesi viem extension

Viem provides an extension mechanism to clients that can provide a convenient and familiar API for application developers based on L2 solutions.

This extension provides extensions for L1 operations and L2 operations related to Cartesi.

WalletClient L1

Transactions related to Cartesi applications are sent directly to the base layer (L1). This extension provides convenient methods for sending inputs and interacting with the portals provided by Cartesi Rollups.

• addInput
• depositEther
• depositERC20Tokens
• depositERC721Token
• depositSingleERC1155Token
• depositBatchERC1155Token
• executeOutput

PublicClient L1

The following methods are provided to interact with the Cartesi Rollups Smart Contracts.

• estimateAddInputGas
• estimateDepositEtherGas
• estimateDepositERC20TokensGas
• estimateDepositERC721TokenGas
• estimateDepositSingleERC1155TokenGas
• estimateDepositBatchERC1155TokenGas
• estimateExecuteOutputGas
• validateOutput

PublicClient L2

The following methods are provided to interact with the Cartesi Rollups Node.

• listApplications
• listEpochs
• listInputs
• listOutputs
• listReports
• getApplication
• getEpoch
• getInput
• getOutput
• getReport
• getProcessedInputCount
• getLastAcceptedEpoch
• waitForInput

Utilities

• getInputsAdded: this provides a utility method to get the input(s) added to the InputBox given a TransactionReceipt.

const receipt = await publicClient.waitForTransactionReceipt({ hash });
const [inputAdded] = getInputsAdded(receipt);

Example

Find below a complete example of depositing ERC-20 tokens and waiting for its effect on L2.

import { createPublicClient, createWalletClient, http, parseUnits } from "viem";
import { privateKeyToAccount } from "viem/accounts";
import { foundry } from "viem/chains";
import { getInputsAdded, publicActionsL2, walletActionsL1 } from "../src";

async function main() {
    const chain = foundry;
    const account = privateKeyToAccount(
        "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
    );

    // create public client to chain default url
    const publicClient = createPublicClient({ chain, transport: http() });

    // create extended public client to L2 with RPC url
    const publicClientL2 = createCartesiPublicClient({
        transport: http("http://127.0.0.1:6751/rpc"),
    });

    // create extended wallet client to chain default url
    const walletClient = createWalletClient({
        chain,
        transport: http(),
    }).extend(walletActionsL1());

    // application address
    const application = "0xab7528bb862fb57e8a2bcd567a2e929a0be56a5e";
    const token = "0x92C6bcA388E99d6B304f1Af3c3Cd749Ff0b591e2";

    // send input transaction
    const hash = await walletClient.depositERC20Tokens({
        account,
        application,
        chain,
        token,
        amount: parseUnits("1", 18),
        execLayerData: "0x",
    });

    // wait for receipt
    const receipt = await publicClient.waitForTransactionReceipt({ hash });

    // get input index from receipt
    const [inputAdded] = getInputsAdded(receipt);
    if (inputAdded) {
        const { inputIndex } = inputAdded;

        // wait for input to be processed
        const input = await publicClientL2.waitForInput({
            inputNumber: Number(inputIndex),
        });
        console.log(input);

        // get notice 0 produced by application
        const notice = await publicClientL2.getNotice({
            inputNumber: Number(inputIndex),
            noticeNumber: 0,
        });

        console.log(notice);
    }
}

main();