Skip to content

Repository files navigation

Cartesi TypeScript libraries

This repository hosts different Cartesi related TypeScript libraries, that tipically helps with development of Cartesi applications.

Documentation for all of them is published at https://cartesi.github.io/rollups-ts.

What's inside?

This repo includes the following packages:

Packages

  • @cartesi/client: a viem extension with L1 actions for the Cartesi smart contracts and L2 actions for the Cartesi Rollups node JSON-RPC API
  • @cartesi/react: React hooks (built on TanStack Query) wrapping the client actions
  • @cartesi/rpc: a Cartesi JSON-RPC typed client library
  • @cartesi/codec: isomorphic encoding and decoding of Cartesi Rollups inputs, outputs and portal deposits
  • @cartesi/rollup: Node.js bindings for libcmt, for applications running inside a Cartesi Machine
  • @cartesi/wagmi-plugin: a Wagmi CLI plugin that generates ABIs and deployment addresses from a rollups-contracts release

Apps

Setup

@cartesi/rollup builds a native addon from the machine-guest-tools git submodule, so check it out before installing:

git submodule update --init
pnpm install

Build

To build all packages, run the following command:

pnpm build

Develop

To develop all packages, run the following command:

pnpm dev

License

Licensed under Apache 2.0.

About

Cartesi Rollups TypeScript libraries

Resources

Stars

3 stars

Watchers

10 watching

Forks

Releases

Packages

Used by

Contributors

Languages