Currently this project is at the 2410-Piloting Version.

Please feel free to file issues for your new feature requests and track them in the project page

CKB-Autotrader

This repo is a generic scaffold and exemplary project for building backend and bot services for projects on CKB: you can both use it as the starter for your new project for any purposes or as a reference to learn or demonstrate how to use all kinds of CKB-related libraries, infrastructures, and to connect to other pre-existing services.

Principles of Project

1. Modularization: Follows the modular design of Nest.js and make each functionality swappable and extensible based on actual needs.
2. Demonstration: Aims to be the best source of latest and recommended practices, tech stacks, and examples for building CKB-related services by openly invite contributions from developers of all awesome projects on CKB in the forms of available modules.
3. Business Oriented: For developers with actual tasks of application for business, the project should allow them to focus on the business logic and the actual needs of the project on the basis of the abstractions provided by all available modules.

Basic Modules

• ScenarioSnapshotService
  • Balance Checking
  • UTXOSwap Pool Checking
• Schemas
  • TypeORM
• ExecuteService
  • Transfer
  • Swap
• StrategyService
  • Redistribute Tokens Across Wallets
  • Redistribute Tokens Within Wallet

Core Concepts

• scenarioSnapshot
• action

State-of-the-art Packages in Use

• CCC - CKBers' Codebase: "CCC - CKBers' Codebase" is the next step of "Common Chains Connector".
  • Empower yourself with CCC to discover the unlimited potential of CKB.
  • Interoperate with wallets from different chain ecosystems.
  • Fully enabling CKB's Turing completeness and cryptographic freedom power.

Optional Modules

• GraphQL (WIP)
• Spore SDK (TBD)
• Fiber Network Payments (TBD)

Installation

pnpm install

Running the app

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

Test

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

Support

• File issue in the repo
• Telegram @Alive24

Roadmap

• GraphQL Module
• Dockerization
• Tests in CI

License

Nest is MIT licensed.