Skip to content

Commit

Permalink
Bump npm version to v0.4.0 (#562)
Browse files Browse the repository at this point in the history
  • Loading branch information
BSathvik authored Jul 27, 2019
1 parent 8ebc16d commit 2b615ca
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src="docs/banner.png" align="center" title="Trust logo">

Trust Wallet Core is a cross-platform library that implements low-level cryptographic wallet functionality for all supported blockchains. Most of the code is C++ with a set of strict exported C interfaces. The library provides idiomatic interfaces for all supported languages (currently Swift for iOS and Java for Android).
Trust Wallet Core is a cross-platform library that implements low-level cryptographic wallet functionality for all supported blockchains. Most of the code is C++ with a set of strict exported C interfaces. The library provides idiomatic interfaces for all supported languages (currently Swift for iOS, Java for Android and JavaScript/TypeScript for Node.js).

[![iOS status](https://dev.azure.com/TrustWallet/Trust%20Wallet%20Core/_apis/build/status/Wallet%20Core%20iOS)](https://dev.azure.com/TrustWallet/Trust%20Wallet%20Core/_build/latest?definitionId=13)
[![Android status](https://dev.azure.com/TrustWallet/Trust%20Wallet%20Core/_apis/build/status/Wallet%20Core%20Android)](https://dev.azure.com/TrustWallet/Trust%20Wallet%20Core/_build/latest?definitionId=11)
Expand All @@ -13,7 +13,7 @@ Trust Wallet Core is a cross-platform library that implements low-level cryptogr
![Maven Central](https://img.shields.io/maven-central/v/com.trustwallet.walletcore/walletcore.svg)
![Cocoapods](https://img.shields.io/cocoapods/v/TrustWalletCore.svg)
![Cocoapods platforms](https://img.shields.io/cocoapods/p/TrustWalletCore.svg)
[![npm](https://img.shields.io/badge/npm-v0.1.0-blue.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/trust-wallet-core)
[![npm](https://img.shields.io/badge/npm-v0.4.0-blue.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/trust-wallet-core)

### Supported Blockchains

Expand Down
29 changes: 24 additions & 5 deletions js/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# Trust Wallet Core

[![npm](https://img.shields.io/badge/npm-v0.1.0-blue.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/trust-wallet-core)
[![npm](https://img.shields.io/badge/npm-v0.4.0-blue.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/trust-wallet-core)

`trust-wallet-core` is a JavaScript wrapper around the [wallet-core](https://github.com/TrustWallet/wallet-core) library that is a standalone `npm` package.

Type definitions for TypeScript are included.

## Install

```
$ npm install trust-wallet-core
```
$ npm install trust-wallet-core

## Usage

Expand All @@ -26,4 +24,25 @@ from { HDWallet } from 'trust-wallet-core';

HDWallet.create(128);
//=> "army cook device assault vendor case coast rose dismiss lady dust point!"
```
```

## Documentation

### Platforms

`trust-wallet-core` only supports `macOS/OSX` at the moment. `Linux` and `Windows` support is forthcoming.

### Bindings

- This project uses [`node-addon-api`](https://github.com/nodejs/node-addon-api) to interface with `wallet-core` [C headers]((https://github.com/TrustWallet/wallet-core/tree/master/include/TrustWalletCore)).
- The `node-addon-api` functions are wrapped in TypeScript that is then used to generate a JavaScript module with type definitions.

### Memory management

- Please note that memory allocated with C/C++ is released once there are no references to the JavaScript object, then Node.js garbage collector will try to release it from memory.

## Other Resources

- For general [`TrustWallet/wallet-core`](https://github.com/TrustWallet/wallet-core) documentation, please refer to [GitBooks](https://developer.trustwallet.com/wallet-core).

- For documentation on specific modules that are avaiable, please refer to [`TrustWallet/wallet-core`](https://github.com/TrustWallet/wallet-core) [exposed C headers](https://github.com/TrustWallet/wallet-core/tree/master/include/TrustWalletCore).
2 changes: 1 addition & 1 deletion js/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion js/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "trust-wallet-core",
"version": "0.3.0",
"version": "0.4.0",
"description": "JavaScript wrapper for wallet-core",
"main": "build/lib/index.js",
"types": "build/lib/index.d.ts",
Expand Down

0 comments on commit 2b615ca

Please sign in to comment.