TypeScript Template

This is a template for TypeScript Cartesi DApps. It uses node to execute the backend application. The application entrypoint is the src/index.ts file. It is bundled with esbuild, but any bundler can be used.

How it Works

The entrypoint src/index.ts contains example code that shows all to perfrom CRUD and wallet operations using different custom routes.

The src/examples directory contains an example greetings.ts and a route.ts file.

The greetings.ts contains classes and methods required to handle the greetings functionality.

The route.ts manages the different routes required for the greetings.

Prerequisite

Ensure you have the following packages installed

• Node 20+,

• Docker and

• Cartesi CLI

• nonodo

How to Run the Backend Server Using Cartesi CLI

To set up your backend here are the required steps:

• Navigate to the backend directory of your created project and run the below command, ensure that your docker is all setup and running.

• Install all required dependencies using either yarn install or npm i

!NOTE

To build and run the backend ensure that you have Cartesi CLI is installed and that your docker is up and running.

To build the backend run the below command;

cartesi build

This will build th image. Once this is successful. The next command to run will be

cartesi run

This will start the local server.

The above command will start the local server with the epoch argument set to 5 seconds. You can set it to any number depending on the duration you want to wait before voucher can be executed.

cartesi address-book

To get list of addresses used for development purpose run this command;

How to Run the Backend Server Using Nonodo

Start nonodo

nonodo

Start the backend

node src/index.ts

Success build output:

 => exporting to image                                                                                                                                                        0.2s
 => => exporting layers                                                                                                                                                       0.2s
 => => writing image sha256:e8f879c648c3cbd230476a811bce2e826d20d96a383eb5acf9d9b084cf1f31ef                                                                                  0.0s
copying from tar archive /mnt/image.tar



 ›   Warning: ommiting environment variable NODE_VERSION=20.8.0
 ›   Warning: ommiting environment variable YARN_VERSION=1.22.19
cd /opt/cartesi/dapp;PATH=/opt/cartesi/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin ROLLUP_HTTP_SERVER_URL=http://127.0.0.1:5004 rollup-init node src/app.js

         .
        / \
      /    \
\---/---\  /----\
 \       X       \
  \----/  \---/---\
       \    / CARTESI
        \ /   MACHINE
         '

[INFO  rollup_http_server] starting http dispatcher service...
[INFO  rollup_http_server::http_service] starting http dispatcher http service!
[INFO  actix_server::builder] starting 1 workers
[INFO  actix_server::server] Actix runtime found; starting in Actix runtime
[INFO  rollup_http_server::dapp_process] starting dapp: node src/app.js
starting app.js...
[server]: Server is running at http://localhost:8383

Manual yield rx-accepted (0x100000000 data)
Cycles: 1493691714
1493691714: 7e2156ddf325ceb7334b18d6955d7b78b4331d3a7707d18cc966cd864cd1ace0
Storing machine: please wait

Success Run Output

To Learn More

To learn more about building on Cartesi you can visit the Cartesi and Sunodu documentations.