Skip to content

Commit

Permalink
Init
Browse files Browse the repository at this point in the history
  • Loading branch information
andreyvEze committed Nov 8, 2021
0 parents commit 75296a4
Show file tree
Hide file tree
Showing 151 changed files with 21,141 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist/
docs_generated/
_typedoc/
node_modules/
54 changes: 54 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"env": {
"es6": true,
"node": true,
"mocha": true
},
"parser": "@typescript-eslint/parser",
"parserOptions": {
"project": "tsconfig.json",
"sourceType": "module",
"tsconfigRootDir": "./"
},
"settings": {
"import/resolver": {
"typescript": {
"alwaysTryTypes": true,
"project": ["tsconfig.json"]
}
}
},
"extends": ["eslint:recommended", "plugin:import/errors"],
"plugins": ["@typescript-eslint", "import", "simple-import-sort", "prettier"],
"rules": {
"indent": 2,
"semi": ["error", "never"],
"simple-import-sort/imports": "warn",
"no-unused-vars": "off",
"comma-dangle": "off",
"@typescript-eslint/comma-dangle": ["error", "always-multiline"],
"@typescript-eslint/no-unused-vars": [
"warn",
{
"varsIgnorePattern": "^_",
"argsIgnorePattern": "^_"
}
],
"@typescript-eslint/consistent-type-imports": [
"warn",
{ "prefer": "type-imports" }
]
},
"overrides": [
{
"files": ["src/**/*.ts"],
"rules": {}
},
{
"files": ["example-node/**/*.js", "test/**/*.ts"],
"rules": {
"no-unused-vars": ["off"]
}
}
]
}
11 changes: 11 additions & 0 deletions .flowconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[ignore]

[include]

[untyped]

[libs]

[lints]

[options]
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist
node_modules
.vscode
docs_generated/
5 changes: 5 additions & 0 deletions .idea/.gitignore

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

12 changes: 12 additions & 0 deletions .idea/ledger-fio-js.iml

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

6 changes: 6 additions & 0 deletions .idea/misc.xml

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

8 changes: 8 additions & 0 deletions .idea/modules.xml

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

6 changes: 6 additions & 0 deletions .idea/vcs.xml

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

4 changes: 4 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
tabWidth: 2,
singleQuote: false
};
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
### Fio

JS Library for communication with Ledger Hardware Wallets.
This library is compatible with the FIO Ledger Application.

### Example code

Demo app code interacting with `hw-app-fio` is provided in `example-node` directory. You can execute it with the `yarn run-example` command.

### Tests

Automated tests are provided. There are two types of tests

1. `yarn test-integration`. Tests integration of JS api with the ledger app.
2. `yarn device-self-test`. Runs unnit tests on ledger (development build required).

Note that for these tests it is advisable to install the developer build of the FIO app with _headless_ mode enabled unless you want to verify the UI flows, otherwise you will need a significant amount of time to manually confirm all prompts on the device.

### Documentation

- you can build the docs by running `yarn gen-docs` and then navigate to docs_generated/index.html

Loading

0 comments on commit 75296a4

Please sign in to comment.