Skip to content

Le formiche sono insetti sociali che vivono in colonie e sono note per la loro organizzazione e cooperazione.

Notifications You must be signed in to change notification settings

bochaco/formicaio

Repository files navigation

Formicaio

Le formiche sono insetti sociali che vivono in colonie e sono note per la loro organizzazione e cooperazione.

Ants are social insects that live in colonies and are known for their organization and cooperation.

Simplify your decentralized experience with this intuitive application, designed to streamline your daily tasks when running nodes from home on peer-to-peer (P2P) networks. Seamlessly participate in online communities using the integrated Nostr client, and manage your digital assets with ease through the built-in wallet. Receive, send, and store tokens, rewards, and coins earned from running nodes or received from third-party sources, all within a single, user-friendly interface.

How to use:

UmbrelOS

This application has not yet been published on the official UmbrelOS app store. However, you can still install and run it on any UmbrelOS device using the Formicaio community app store. To do this, simply add the GitHub URL (https://github.com/bochaco/formicaio-app-store) through the UmbrelOS user interface, as demonstrated in the following demo:

umbrel-0.5.2.mp4

Linux (amd64/arm64)

This application can also be launched on a Linux (amd64/arm64) machine using Docker Compose with the following commands:

$ git clone https://github.com/bochaco/formicaio
$ cd formicaio/deploy/local
$ docker compose up -d

Once Docker has completed pulling the images and starting the containers, the app will be running in the background, and you can access the Formicaio app from a web browser at localhost:52100

To see the logs you can simply use the following command:

$ docker compose logs -f

Upgrading the application (without stopping the running nodes instances) can be simply achieved by pulling the new Formicaio image and restarting the service:

$ docker compose pull formicaio
$ docker compose down formicaio
$ docker compose up formicaio -d

For stopping the Formicaio app and services simply run:

$ docker compose down

Displaying nodes stats on external LCD device

When running Formicaio on a Raspberry Pi, it is possible to connect an external LCD display and have Formicaio to show nodes stats on it, currently the following stats are shown:

  • Estimated network size
  • Number of active/running nodes
  • Total number of stored records
  • Node binary version
  • Total rewards balance

You can follow the instructions in this Raspberry Pi4 LCD setup guide for enabling the I2C interface which is the one Formicaio supports/uses to communicate with the LCD device (you can ignore the step related to running a python example app).

As part of the setup, take note of both the configured I2C device path, e.g. '/dev/i2c-1', and the I2C address backpack detected with the i2cdetect tool/cmd (usually 0x27 or 0x3F), you'll need them to set up Formicaio through its settings panel.

Note that the above may not work if you are using UmbrelOS, as it has the boot path mounted as read-only. This means the tool cannot overwrite it to enable the I2C interface. The following is a workaround to this limitation, but please be aware that attempting this may pose significant risks and leave your UmbrelOS in a non-functional state. If you choose to proceed with the following workaround, be advised that it involves advanced technical commands and should only be attempted by those with a strong understanding of system configurations and potential consequences. Proceed with caution and at your own risk specially if you have important data and/or application on the device:

$ sudo apt install raspi-config

$ sudo umount /boot

$ sudo mount /dev/<boot-fs-device> /boot -t vfat -o rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=ascii,shortname=mixed,errors=remount-ro

$ sudo raspi-config

Replacing <boot-fs-device> with the partition name where the /boot is originally mounted on, you can find out by running the following cmd:

$ mount | grep /boot

/dev/mmcblk0p2 on /boot type vfat (ro,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=ascii,shortname=mixed,errors=remount-ro)

Once I2c was successfully enabled through raspi-config, reboot the Rasberry Pi, and then enable the LCD display in Formicaio through its settings panel.

Disclaimer

Please be aware that the Formicaio backend application, as well as the safenode binary running within each user-created node instance, utilizes third-party RPC services to retrieve information related to the Arbitrum L2 ledger.

Specifically, the Formicaio backend application queries the RPC server at https://sepolia-rollup.arbitrum.io/rpc to periodically check the current rewards balances for each node instance based on the configured (ETH) rewards addresses.

Risks:

  • Privacy: Using third-party RPC services may expose your IP address and other metadata to those services. This means that the service provider can potentially track which addresses you are querying, which could lead to privacy concerns regarding your activity on the Arbitrum network.
  • Data Exposure: Any data sent to the RPC service may be logged or monitored by the service provider, which could include sensitive information related to your node instances.

We recommend considering these risks when using the application and taking appropriate measures to protect your privacy.

License

This project is licensed under the General Public License (GPL), version 3 (LICENSE).

About

Le formiche sono insetti sociali che vivono in colonie e sono note per la loro organizzazione e cooperazione.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages