Browse Source

update readme

bug_fix
aaronisme 5 years ago
parent
commit
02ca920d57
  1. 34
      README.md

34
README.md

@ -1,8 +1,8 @@
# Cobo Vault # Cobo Vault
Cobo Vault is an air-gapped & open source hardware wallet that uses completely transparent QR code data transmissions.Visit [Cobo Vault official website]( https://cobo.com/hardware-wallet/cobo-vault) to know more information about Cobo Vault. Cobo Vault is an air-gapped, open source hardware wallet that uses completely transparent QR code data transmissions. Visit the [Cobo Vault official website]( https://cobo.com/hardware-wallet/cobo-vault) to learn more about Cobo Vault.
Follow [@Cobo Vault](https://twitter.com/CoboVault) on Twitter. You can also follow [@Cobo Vault](https://twitter.com/CoboVault) on Twitter.
<div align=center><img src="https://cobo.com/_next/static/images/intro-2b5b0b44cc64639df4fcdd9ccc46fd4b.png"/></div> <div align=center><img src="https://cobo.com/_next/static/images/intro-2b5b0b44cc64639df4fcdd9ccc46fd4b.png"/></div>
@ -14,17 +14,17 @@ Follow [@Cobo Vault](https://twitter.com/CoboVault) on Twitter.
- [Test](#test) - [Test](#test)
- [Code Structure](#code-structure) - [Code Structure](#code-structure)
- [Core Dependencies](#core-dependencies) - [Core Dependencies](#core-dependencies)
- [Issues and PRS](#issues-and-prs) - [Issues and PRs](#issues-and-prs)
- [License](#license) - [License](#license)
## Introduction ## Introduction
Cobo Vault runs as a standalone application on customized hardware and Android 8.1 Oreo (Go Edition). This app performs: Cobo Vault runs as a standalone application on customized hardware and Android 8.1 Oreo (Go Edition). This app performs:
1. Interaction with user. 1. Interaction with the user.
2. Interaction with mobile application [Cobo Vault Mobile](https://cobo.com/hardware-wallet/cobo-vault-app) via QR code. 2. Interaction with the mobile application [Cobo Vault Mobile](https://cobo.com/hardware-wallet/cobo-vault-app) via QR code.
3. Interaction with Secure Element (SE) via serial port, the firmware of SE is opensourced at [cobo-vault-se-firmware](https://github.com/CoboVault/cobo-vault-se-firmware). The transaction data will be signed by this SE and the generated signature will be send back to this application. This signature and other necessary message will be displayed to user via QR code. Users use their mobile or desktop application to acquire signed transaction and broadcast it. 3. Interaction with the Secure Element (SE) via serial port, open source SE firmware can be found at [cobo-vault-se-firmware](https://github.com/CoboVault/cobo-vault-se-firmware). Transaction data is signed by the Secure Element and the generated signature is sent back to the application. This signature and other necessary messages are displayed as a QR code. You can check the animation on our webpage to see the whole process. Users use their mobile or desktop application to acquire signed transaction data and broadcast it.
The application of this hardware wallet is programmed with Java language. The transaction related work is done by Typescript opensourced at [crypto-coin-kit](https://github.com/CoboVault/crypto-coin-kit). The framework, J2V8 is used as the bridge between Java and Typescript. The hardware wallet application was programmed with Java language. The transaction related work is done by Typescript, for which open source code is available at [crypto-coin-kit](https://github.com/CoboVault/crypto-coin-kit). The J2V8 framework is used as a bridge between Java and Typescript.
## Clone ## Clone
@ -34,28 +34,28 @@ The application of this hardware wallet is programmed with Java language. The tr
## Build ## Build
cd cobo-vault-cold cd cobo-vault-cold
./gradlew assembleVault_v2Release ./gradlew assembleVault_v2Release
or you can build with IDEs, such as `Android Studio`,`intelliJ` You can also build with IDEs, such as `Android Studio`,`intelliJ`.
## Test ## Test
./gradlew test ./gradlew test
## Code Structure ## Code Structure
Modules: Modules
`app` the main application module `app`: Main application module
`coinlib` the module for supported blockchains, currently included 12 blockchains `coinlib`: Module for supported blockchains, currently included in 12 blockchains
`encryption-core` module for Secure Element, include commands, protocol, serialize/deserialize, serial port communication `encryption-core`: Module for the Secure Element, includes commands, protocol, serialize/deserialize, serial port communication
## Core Dependencies ## Core Dependencies
1. [crypto-coin-message-protocol](https://github.com/CoboVault/crypto-coin-message-protocol) - protocol buffer of communication with mobile application 1. [crypto-coin-message-protocol](https://github.com/CoboVault/crypto-coin-message-protocol) - protocol buffer of communication with the mobile application
2. [crypto-coin-kit](https://github.com/CoboVault/crypto-coin-kit) - crypto-coin libraries 2. [crypto-coin-kit](https://github.com/CoboVault/crypto-coin-kit) - crypto-coin libraries
3. [cobo-vault-se-firmware](https://github.com/CoboVault/cobo-vault-se-firmware) - the firmware of SE 3. [cobo-vault-se-firmware](https://github.com/CoboVault/cobo-vault-se-firmware) - Secure Element firmware
## Issues and PRS ## Issues and PRs
any issues please submit at [issues](https://github.com/CoboVault/cobo-vault-cold/issues). and PRS are welcome! Please submit any issues [here](https://github.com/CoboVault/cobo-vault-cold/issues). PRs are also welcome!
## License ## License
[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-green.svg)](https://opensource.org/licenses/) [![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-green.svg)](https://opensource.org/licenses/)
This project is licensed under the GPL License - see the [LICENSE](LICENSE) file for details This project is licensed under the GPL License. See the [LICENSE](LICENSE) file for details.

Loading…
Cancel
Save