Skip to content

Commit

Permalink
Merge pull request #19 from ZondaX/upgradeTransport
Browse files Browse the repository at this point in the history
refactoring + upgrading transport dependencies
  • Loading branch information
jleni committed Jun 1, 2019
2 parents ea2828e + cdc02b7 commit 49393e5
Show file tree
Hide file tree
Showing 27 changed files with 6,371 additions and 4,214 deletions.
10 changes: 10 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"presets": ["@babel/preset-env"],
"plugins": [
["@babel/plugin-transform-runtime",
{
"regenerator": true
}
]
]
}
59 changes: 59 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
version: 2

defaults: &defaults
working_directory: ~/repo
docker:
- image: circleci/node:11.12.0

jobs:
build:
<<: *defaults
steps:
- checkout
- run: yarn install
- run: yarn build

test:
<<: *defaults
steps:
- checkout
- run: yarn install
- run: yarn test:unit

publish:
<<: *defaults
steps:
- checkout
- run: yarn install
- run: yarn build
- run:
name: prepare authentication config
command: echo "//registry.npmjs.org/:_authToken=$npm_TOKEN" > ~/repo/.npmrc
- run:
name: Update tag
command: npm --no-git-tag-version version $CIRCLE_TAG
- run:
name: Publish package
command: npm publish

workflows:
version: 2
test-suite:
jobs:
- build:
filters:
tags:
only: /.*/
- test:
filters:
tags:
only: /.*/
- publish:
requires:
- build
- test
filters:
tags:
only: /^v[0-9]+(\.[0-9]+)*/
branches:
ignore: /.*/
21 changes: 21 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"env": {
"browser": true,
"es6": true,
"node": true,
"jest/globals": true
},
"plugins": ["jest"],
"extends": "airbnb-base",
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
},
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module"
},
"rules": {
"indent": ["error", 4]
}
}
10 changes: 3 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,8 @@ typings/

\.idea/

browser/ledger\.js
.vscode

browser/chrome-u2f-api\.js
TODO\.md

tests/browser/chrome-u2f-api\.js

tests/browser/ledger\.js

tests/browser/test-bundle\.js
\dist
File renamed without changes.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2019 ZondaX GmbH

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
50 changes: 4 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,11 @@
# ledger-cosmos-js

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![npm version](https://badge.fury.io/js/ledger-cosmos-js.svg)](https://badge.fury.io/js/ledger-cosmos-js)
[![CircleCI](https://circleci.com/gh/ZondaX/ledger-cosmos-js/tree/master.svg?style=shield)](https://circleci.com/gh/ZondaX/ledger-cosmos-js/tree/master)

This package provides a basic client library to communicate with a Tendermint/Cosmos App running in a Ledger Nano S
This package provides a basic client library to communicate with a Tendermint/Cosmos App running in a Ledger Nano S/X

There are two running modes:
The package is being published in npmjs. It is recommended to use that in order to receive updates and fixes.

- *HID*: Direct access via HID. This can be used from a backend, node.js, etc.
- *U2F*: This allows access to the device from the browser (client side)

# Testing

Install all dependencies by running

```
npm install
```

There are a few useful scripts:

- ```npm test```: Will run HID tests

- ```npm browserify```: Will generate js files that are necessary for U2F/browser integration

- ```npm browserify-test```: Will generate js files that are necessary for browser testing. After executing this script. You can access `tests/browser/index.html` to run browser tests.

Warning: You need to setup a webserver and point it to index.html. U2F communication requires an https connection.

## How to run browser tests

First you need to deploy the javascript files. Run the following:

```bash
npm run browserify
npm run browserify-test
```

now go to the test directory and run `caddy`
```bash
cd tests/browser
caddy
```

you should see something like:

```text
Activating privacy features... done.
https://localhost:2020
WARNING: File descriptor limit 1024 is too low for production servers. At least 8192 is recommended. Fix with `ulimit -n 8192`.
```

Open your browser at `https://localhost:2020` and you can now run the test
12 changes: 12 additions & 0 deletions jest.config.integration.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
const config = require('./jest.config');

// Override default configuration
config.testMatch = [
'**/__tests__/**/*.[jt]s?(x)',
'**/?(*.)+(ispec|test).[tj]s?(x)',
];

// eslint-disable-next-line no-console
console.log('RUNNING INTEGRATION TESTS');

module.exports = config;
190 changes: 190 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
// For a detailed explanation regarding each configuration property, visit:
// https://jestjs.io/docs/en/configuration.html

module.exports = {
modulePaths: [
'<rootDir>/src',
'<rootDir>/tests',
],
// All imported modules in your tests should be mocked automatically
// automock: false,

// Stop running tests after `n` failures
// bail: 0,

// Respect "browser" field in package.json when resolving modules
// browser: false,

// The directory where Jest should store its cached dependency information
// cacheDirectory: "/tmp/jest_rs",

// Automatically clear mock calls and instances between every test
clearMocks: true,

// Indicates whether the coverage information should be collected while executing the test
// collectCoverage: false,

// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: null,

// The directory where Jest should output its coverage files
coverageDirectory: 'coverage',

// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "/node_modules/"
// ],

// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],

// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: null,

// A path to a custom dependency extractor
// dependencyExtractor: null,

// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,

// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],

// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: null,

// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: null,

// A set of global variables that need to be available in all test environments
// globals: {},

// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],

// An array of file extensions your modules use
// moduleFileExtensions: [
// "js",
// "json",
// "jsx",
// "ts",
// "tsx",
// "node"
// ],

// A map from regular expressions to module names that allow to stub out resources with a single module
// moduleNameMapper: {},

// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],

// Activates notifications for test results
// notify: false,

// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",

// A preset that is used as a base for Jest's configuration
// preset: null,

// Run tests from one or more projects
// projects: null,

// Use this configuration option to add custom reporters to Jest
// reporters: undefined,

// Automatically reset mock state between every test
// resetMocks: false,

// Reset the module registry before running each individual test
// resetModules: false,

// A path to a custom resolver
// resolver: null,

// Automatically restore mock state between every test
// restoreMocks: false,

// The root directory that Jest should scan for tests and modules within
// rootDir: null,

// A list of paths to directories that Jest should use to search for files in
roots: [
'<rootDir>',
],

// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",

// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],

// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: [],

// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],

// The test environment that will be used for testing
testEnvironment: 'node',

// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},

// Adds a location field to test results
// testLocationInResults: false,

// The glob patterns Jest uses to detect test files
testMatch: [
'**/__tests__/**/*.[jt]s?(x)',
'**/?(*.)+(spec|test).[tj]s?(x)',
'**/?(*.)+(ispec|test).[tj]s?(x)',
],

// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
// testPathIgnorePatterns: [
// "/node_modules/"
// ],

// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],

// This option allows the use of a custom results processor
// testResultsProcessor: null,

// This option allows use of a custom test runner
// testRunner: "jasmine2",

// This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
// testURL: "http://localhost",

// Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
// timers: "real",

// A map from regular expressions to paths to transformers
// transform: null,

// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
// transformIgnorePatterns: [
// "/node_modules/"
// ],

// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,

// Indicates whether each individual test should be reported during the run
// verbose: null,

// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],

// Whether to use watchman for file crawling
// watchman: true,
};
12 changes: 12 additions & 0 deletions jest.config.unit.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
const config = require('./jest.config');

// Override default configuration
config.testMatch = [
'**/__tests__/**/*.[jt]s?(x)',
'**/?(*.)+(spec|test).[tj]s?(x)',
];

// eslint-disable-next-line no-console
console.log('RUNNING UNIT TESTS');

module.exports = config;
Loading

0 comments on commit 49393e5

Please sign in to comment.