code-vm-indexer

README

Code VM Indexer

Indexer Service for the Code VM. It has two main components:

1. Geyser worker that maintains up-to-date state against instances of the Code VM.
2. RPC service to fetch virtual account state, as well as relevant storage metadata.

The Indexer Service is designed to be run independently, enabling anyone to have full self-custodial access to their funds using the next iteration of the Timelock Explorer.

Important Note: Only memory storage is currently supported. Compressed storage support will be added at a later date.

What is Code?

Code is a mobile wallet app leveraging self-custodial blockchain technology to provide an instant, global, and private payments experience.

Quick Start

1. Install Go. See the official documentation.

2. Download the source code.

git clone git@github.com:code-payments/code-vm-indexer.git

1. Run the test suite:

make test

1. Run the RPC service locally:

DATA_STORAGE_TYPE=memory make run-rpc

1. Run the Geyser worker locally:

DATA_STORAGE_TYPE=memory GEYSER_WORKER_GRPC_PLUGIN_ENDPOINT=localhost:10000 GEYSER_WORKER_VM_ACCOUNT=<VM_PUBLIC_KEY> SOLANA_RPC_ENDPOINT=http://localhost:8899 make run-geyser

Getting Help

If you have any questions or need help, please reach out to us on Discord or Twitter.

Security and Issue Disclosures

In the interest of protecting the security of our users and their funds, we ask that if you discover any security vulnerabilities please report them using this Report a Vulnerability link.