https://github.com/consenlabs/token-core

Next generation core inside imToken Wallet.
https://github.com/consenlabs/token-core

bitcoin-cash blockchain cross-platform cryptocurrency imtoken litecoin

Last synced: about 1 month ago
JSON representation

Next generation core inside imToken Wallet.

• Host: GitHub
• URL: https://github.com/consenlabs/token-core
• Owner: consenlabs
• License: apache-2.0
• Created: 2019-05-17T00:51:29.000Z (over 5 years ago)
• Default Branch: dev
• Last Pushed: 2023-10-10T12:56:22.000Z (12 months ago)
• Last Synced: 2024-07-27T18:50:04.775Z (about 2 months ago)
• Topics: bitcoin-cash, blockchain, cross-platform, cryptocurrency, imtoken, litecoin
• Language: Rust
• Homepage:
• Size: 95.2 MB
• Stars: 286
• Watchers: 36
• Forks: 116
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# TokenCoreX

[![Build status](https://travis-ci.org/consenlabs/token-core.svg?branch=dev)](https://travis-ci.org/consenlabs/token-core)

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/imtoken-wallet/token-core)

Next generation core inside imToken Wallet.

A cross-platform library that implements crypto wallet functions for blockchains, exporting c interfaces in Protobuf

protocol. This library totally wrote in Rust, and now provides friendly interfaces for the mobile platform including

ReactNative, iOS, and Android.

TokenCoreX welcomes contribution from everyone. See [CONTRIBUTING.md](./CONTRIBUTING.md) for help getting started. 

In all communications and contributions, this project follows the [Code of Conduct](./CODE_OF_CONDUCT.md)

## Goals

* Abstration interfaces that provide crypto wallet common logic with multi blockchain support

* Cross platform, on mobile, desktop, server side

* Multi keystore support, with file, HSM, KMS, hardware-wallet

## Packages

* `tcx` wallet interface wrapper

* `tcx-bch` | `tcx-btc-fork` | `tcx-tron` | `tcx-ckb` packages contain particular chain operations

* `tcx-chain` keystore and signer interface

* `tcx-proto` protobuf datastructure definition

* `tcx-constants` blockchain spec definition

* [`tcx-primitive` | `tcx-crypto`] low level component

## Examples

We provide three example applications, 

* [ReactNative](examples/RN), full functions including all expose API, and e2e testing

* [iOS](examples/iOSExample)

* [Android](examples/android)

## Test Coverage

We can use [tarpaulin](https://github.com/xd009642/tarpaulin) to know the coverage rate.

The easy way to run coverage test is using docker,

```

docker run --security-opt seccomp=unconfined -v "${PWD}:/volume" xd009642/tarpaulin sh -c "cargo tarpaulin --out Html"

```

After couple minutes, it will generate html report of project root directory named `tarpaulin-report.html`. 

## Code Styles

This project is using pre-commit. Please run `cargo clean && cargo test` to install the git pre-commit hooks on you clone.

Every time you will try to commit, pre-commit will run checks on your files to make sure they follow our style standards

and they aren't affected by some simple issues. If the checks fail, pre-commit won't let you commit.

## Read More

* [How to build project](docs/BUILD.md)

* [Crypto keys abstraction design (Chinese)](docs/KEYS.zh.md)

* [Architecture design (Chinese)](docs/TECH.zh.md)

* [How to add more blockchain support](docs/INTEGRATION.md)

* [Security](SECURITY.md) including the bug bounty program

* [FAQ](docs/FAQ.md)

## License

Apache Licence v2.0