code-server

module
v1.10.19 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2024 License: MIT

README

Code Server

Code Server

Release PkgGoDev Tests GitHub License

Code server monolith containing the gRPC/web services and workers that power a next-generation payments system. The project contains the first L2 solution on top of Solana, utilizing an intent-based system backed by the Code Sequencer to handle transactions.

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-server.git
  1. Run the test suite:
make test

Project Structure

The implementations powering the Code ecosystem (Code Wallet App, Code SDK, etc) can be found under the pkg/code/ directory. All other code under the pkg/ directory are generic libraries and utilities.

To begin diving into core systems, we recommend starting with the following packages:

  • pkg/code/async/: Asynchronous workers that perform tasks outside of RPC and web calls
  • pkg/code/server/: gRPC and web service implementations

APIs

The gRPC APIs provided by Code server can be found in the code-protobuf-api project. Refer to the Code SDK if you want to integrate micropayments into your web application.

Learn More

To learn more about fundamental concepts and advanced topics related to Code server, we recommend jumping into the Code SDK documentation for a high-level overview. The Extra Topics section includes notes on topics like the Sequencer, Privacy Protocol, Timelock, and more.

Contributing

Anyone is welcome to make code contributions through a PR.

The best way to share general feedback is on Discord.

This will evolve as we continue to build out the platform and open up more ways to contribute.

Getting Help

If you have any additional questions or need help integrating Code into your website or application, please reach out to us on Discord or Twitter.

Directories

Path Synopsis
pkg
cluster
Package cluster provides utilities for multi-server clustering.
Package cluster provides utilities for multi-server clustering.
kin
retry/backoff
Package backoff provides varies backoff strategies for retry.
Package backoff provides varies backoff strategies for retry.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL