Skip to content

Contributing.md

Latest commit

 

History

History
136 lines (95 loc) · 7.66 KB

Contributing.md

File metadata and controls

136 lines (95 loc) · 7.66 KB

Contributing

To add functionality to wallet core follow these instructions.

Project organization

This project has a number of different pieces. Each piece lives in its own subfolder.

  • The docs folder contains documentation.
  • The src folder contains the C++ implementation of the core functionality.
  • The include folder contains the public C header files used to expose a cross-platform interface.
  • The codegen folder contains the code and templates used to generate code for different platforms and languages.
  • The jni folder contains the generated JNI interface and Java classes.
  • The android folder contains the Android Studio project and integration tests.
  • The swift folder contains the generated Swift code and Xcode project.
  • The trezor-crypto folder contains a fork of https://github.com/trezor/trezor-crypto/ with modifications.
  • The tests folder contains unit tests.
  • The lib folder contains third-party dependencies as git submodules.
  • THe tools folder contains scripts to automate common tasks.

Before you start

  • Install Xcode
  • Install Xcode command line tools: xcode-select --install
  • Install CMake, boost, protobuf: brew install cmake ninja boost protobuf swift-protobuf autoconf automake libtool
  • Install Android Studio
  • Install the Android NDK

Library Design Guidelines

This library is designed so that it can be used from any other programming languages, and that every language has an idiomatic interface. Design goals also include minimizing the binary size and maximizing perfomance.

With these goals in mind we chose C/C++ for the implementation and a strict subset of C for the interface. This C interface is used to generate the idiomatic interfaces for every supported language. To augment the expressivity of the interface we also use Protocol Buffer objects that get serialized across the interface.

Keep this in mind when adding to the library:

  • Only expose C headers. Clients should not have access to the C++ interfaces.
  • C headers need to have annotations for the code generation tool, see below.
  • Use Protocol Buffers to represent models. C doesn't have good abstractions for variable-sized types.
  • Every time you modify the interface run the code generation tool and make sure the interface also makes sense in target languages.

Building

Use the bootstrap.sh script in the root folder to quickly build and test.

The build pipeline uses CMake. If you add or rename files you need to re-run cmake: cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DGIT_SUBMODULE=OFF. If you only change existing files and want to run the tests you only need to run make: make -C build tests.

If you change interface files in the include folder you need to regenerate the interface code: codegen/bin/codegen. Run codegen/bin/codegen -h to get usage information on the tool. Note that currently if you add a new interface header file you need to manually add that file as a public header to the iOS project, otherwise iOS tests will fail.

Testing

Use the bootstrap.sh script in the root folder to quickly build and test. After you have run either bootstrap.sh or cmake, run make -C build tests && build/tests/tests. This will run all the C++ tests. To run integration tests on each platform run the respective script in the tools folder:

  • Android: tools/android-test
  • iOS: tools/ios-test

C Headers

The wallet core code generator parses C headers for class and struct definitions. Headers need to be in the include/TrustWalletCode folder and start with the TW prefix followed by the class or sturct name. Inside each header file there needs to be exactly one class or struct defition.

A class definition starts with the TW_EXPORT_CLASS macro followed by a forward-declared struct. For example:

TW_EXPORT_CLASS
struct TWPrivateKey;

Similarly, a struct definition start with the TW_EXPORT_STRUCT macro followed by an inline-declared struct. For example:

TW_EXPORT_STRUCT
struct TWPublicKey {
    uint8_t bytes[TWPublicKeyUncompressedSize];
};

You can also define enumerations using the TW_EXPORT_ENUM() macro:

TW_EXPORT_ENUM(uint32_t)
enum TWCoinType {
    TWCoinTypeBitcoin = 0,
};

After the class or struct definition you can declare as many methods and properties as necessary. There are four types of declarations: static method, static property, method, and property. Each is declared by TW_EXPORT_STATIC_METHOD, TW_EXPORT_STATIC_PROPERTY, TW_EXPORT_METHOD, and TW_EXPORT_PROPERTY respectively. Each method or property name needs to start with the type name. For instance TWPublicKeyIsValid gets translated to the isValid property in the PublicKey type.

The types that methods can take and return are restricted to: bool, int, size_t, uint8_t, uint16_t, uint32_t, uint64_t, TWData, TWString, and any defined classses, structs or enums.

Methods always take the type as their first argument. The type needs to be a pointer if the type is a class and a struct if the type is a struct. Properties need to take the type as its only argument.

Static property declarations can take no arguments. Static methods can take any arguments.

Protocol Buffers

Since the C language doesn't provide good abstractions for variable-sized arrays and strings, the C interface uses Protocol Buffers. All models are defined in the src/proto folder. These models can then be used in the C interface by using the proto model name with underscores. For instance TW_Binance_Proto_SigningInput.

The proto file will be used to generate C++ classes and also classes in each supported client language (Swift, Java, etc.). The code generator will also generate the protobuf serialization code so that library clients don't have to worry about serialization. To generate the Protocol Buffers code run the tools/generate-files script when you modify the src/TrustWalletCore.proto file.

Blockchain checklist

When implementing a new blockchain make sure you go through this checklist:

  • Implement functionality in C++. Put it in a subfolder of src/.
  • Write unit tests. Put them in a subfolder of tests/.
  • Add relevant constants in TWCointType, TWP2SHPrefix, TWEthereymChainID, etc. as necessary.
  • Write interface header in include/TrustWalletCore and implement the interface in src/interface.
    • Write custom address type if necessary.
    • Write interface for signing transactions.
  • Validate generated code in Android an iOS projects. Write integration tests for each.

Also check out the Adding Support for a New Blockchain document.

Releasing

iOS

Run bootstrap.sh then tools/ios-release. This will build, archive and upload a Cocoapod. You need to be registered as an owner for the pod.

Android

First Time

  1. See https://docs.gradle.org/current/userguide/signing_plugin.html to set up GPG signing.
  2. Get a OSSRH username and password, get added to the group ID.
  3. Create ~/.gradle/gradle.properties and add your information from the previous steps:
NEXUS_USERNAME=user
NEXUS_PASSWORD=pass

signing.keyId=00000000
signing.password=password
signing.secretKeyRingFile=/Users/me/.gnupg/secring.gpg

org.gradle.daemon=true

Every Release

  1. Update the VERSION_NAME in android/gradle.properties.
  2. In the android folder run ./gradlew uploadArchive.
  3. Go to the Sonatype webpage. Look for the staging library. It should be at the end of the list. Select it, and press “Close” button.