-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Arseniy Fokin <stinger112@gmail.com>
1 parent
c12b0e4
commit b89c6dc
Showing
16 changed files
with
201 additions
and
5,916 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,201 @@ | ||
Copyright 2016 Soramitsu Co., Ltd. | ||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
1. Definitions. | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS | ||
|
||
APPENDIX: How to apply the Apache License to your work. | ||
|
||
To apply the Apache License to your work, attach the following | ||
boilerplate notice, with the fields enclosed by brackets "[]" | ||
replaced with your own identifying information. (Don't include | ||
the brackets!) The text should be enclosed in the appropriate | ||
comment syntax for the file format. We also recommend that a | ||
file or class name and description of purpose be included on the | ||
same "printed page" as the copyright notice for easier | ||
identification within third-party archives. | ||
|
||
Copyright 2018 Soramitsu LLC | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,200 +1,5 @@ | ||
# いろはjs (irohajs) | ||
# Iroha Library for JavaScript (**iroha-lib**) | ||
|
||
## What's いろは(iroha)? | ||
いろは(iroha) is [this](https://github.com/soramitsu/iroha). | ||
## Warning! | ||
|
||
## Description | ||
いろはjs(irohajs) is client javascript library for using いろは(iroha). | ||
[demo](https://soramitsu.github.io/iroha-javascript/) | ||
|
||
## Requirement | ||
* [js-sha3](https://github.com/emn178/js-sha3) | ||
* [supercop.js(GUCCI-swallow)](https://github.com/GUCCI-swallow/supercop.js) | ||
|
||
## Installation | ||
* Clone this repository. | ||
* [Download the latest release](). | ||
* [Feature]Install with npm/bower. | ||
|
||
## Usage | ||
### Load | ||
|
||
```html | ||
<script src="/path/to/iroha.js"></script> | ||
``` | ||
|
||
### API | ||
#### iroha.createKeyPair | ||
|
||
```js | ||
var keys = iroha.createKeyPair(); | ||
``` | ||
|
||
|
||
|
||
Return key object. | ||
**Response**: | ||
|
||
```js | ||
{ | ||
publicKey: A 32 byte public key encoded base64, | ||
privateKey: A 64 byte private key encoded base64 | ||
} | ||
``` | ||
#### iroha.createSignature | ||
|
||
```js | ||
var keys = iroha.createSignature(); | ||
``` | ||
|
||
|
||
|
||
Return key object. | ||
**keys**: | ||
|
||
```js | ||
//keys | ||
{ | ||
publicKey: A 32 byte public key encoded base64, | ||
privateKey: A 64 byte private key encoded base64, | ||
message: A message | ||
} | ||
``` | ||
**Response**: | ||
|
||
signature(A signature string encoded base64) | ||
|
||
#### iroha.verify | ||
|
||
```js | ||
var keys = iroha.verify(); | ||
``` | ||
|
||
|
||
Return key object. | ||
**keys**: | ||
|
||
```js | ||
//keys | ||
{ | ||
publicKey: A 32 byte public key encoded base64, | ||
signature: A signature, | ||
message: A message | ||
} | ||
``` | ||
**Response**: | ||
|
||
Return True or False; | ||
|
||
### Development Guide | ||
|
||
#### Features | ||
|
||
- Zero-setup. After running `npm install` things will be setup for you :wink: | ||
- **[Webpack 2](https://webpack.js.org/)** for UMD bundle, with [Tree-shaking](https://webpack.js.org/guides/tree-shaking/) dead code elimination | ||
- Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)** | ||
- **[TSLint](https://palantir.github.io/tslint/)** ([standard-config](https://github.com/blakeembrey/tslint-config-standard)) for your code styling | ||
- **Docs automatic generation and deployment** to `gh-pages`, using **[TypeDoc](http://typedoc.org/)** | ||
- Automatic types `(*.d.ts)` file generation | ||
- **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report | ||
- (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks) | ||
|
||
#### NPM scripts | ||
|
||
- `npm t`: Run test suite | ||
- `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch) | ||
- `npm run test:prod`: Run linting + generate coverage | ||
- `npm run build`: Bundles code, create docs and generate typings | ||
- `npm run build:dev`: Same than `build`, but code is not minified | ||
- `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:) | ||
|
||
#### Automatic releases | ||
|
||
If you'd like to have automatic releases with Semantic Versioning, follow these simple steps. | ||
|
||
_**Prerequisites**: you need to create/login accounts and add your project to:_ | ||
- npm | ||
- Travis | ||
- Coveralls | ||
|
||
Set up the git hooks (see [Git hooks section](#git-hooks) for more info): | ||
|
||
```bash | ||
node tools/init-hooks | ||
``` | ||
|
||
Install semantic release and run it (answer NO to "Generate travis.yml"). | ||
|
||
```bash | ||
npm install -g semantic-release-cli | ||
semantic-release setup | ||
# IMPORTANT!! Answer NO to "Generate travis.yml" question. Is already prepared for you :P | ||
``` | ||
|
||
From now on, you'll need to use `npm run commit`, which is a convenient way to create conventional commits. | ||
|
||
Automatic releases are possible thanks to [semantic release](https://github.com/semantic-release/semantic-release), which publishes your code automatically on github and npm, plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library) | ||
|
||
#### Git Hooks | ||
|
||
By default, there are 2 disabled git hooks. You can enable them by running `node tools/init-hooks` (which uses [husky](https://github.com/typicode/husky)). They make sure: | ||
- You follow a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog) | ||
- Your build is not gonna fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push` | ||
|
||
This makes more sense in combination of [automatic releases](#automatic-releases) | ||
|
||
#### FAQ | ||
|
||
##### Why using TypeScript and Babel? | ||
|
||
In most cases, you can compile TypeScript code to ES5, or even ES3. But in some cases, where you use "functional es2015+ features", such as `Array.prototype.find`, `Map`, `Set`... then you need to set `target` to "es6". This is by design, since TypeScript only provides down-emits on syntactical language features (such as `const`, `class`...), but Babel does. So it's set up in a 2 steps build so you can use es2015+ features. | ||
|
||
This should be transparent for you and you shouldn't even notice. But if don't need this, you can remove Babel from the build: | ||
- Set target to "es5" or "es3" in `tsconfig.json` | ||
- Remove `"useBabel": true` from `tsconfig.json` | ||
|
||
More info in [https://github.com/Microsoft/TypeScript/issues/6945](https://github.com/Microsoft/TypeScript/issues/6945) | ||
|
||
##### What if I don't want git-hooks, automatic releases or semantic-release? | ||
|
||
Then you may want to: | ||
- Remove `commitmsg`, `postinstall` scripts from `package.json`. That will not use those git hooks to make sure you make a conventional commit | ||
- Remove `npm run semantic-release` from `.travis.yml` | ||
|
||
##### What if I don't want to use coveralls or report my coverage? | ||
|
||
Remove `npm run report-coverage` from `.travis.yml` | ||
|
||
##### What is `npm install` doing the first time runned? | ||
|
||
It runs the script `tools/init` which sets up everything for you. In short, it: | ||
- Configures webpack for the build, which creates the umd library, generate docs, etc. | ||
- Configures `package.json` (typings file, main file, etc) | ||
- Renames main src and test files | ||
|
||
## Credits | ||
|
||
Made with :heart: by [GUCCI-swallow](https://github.com/GUCCI-swallow) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): | ||
|
||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| [<img src="https://avatars3.githubusercontent.com/u/20982317?v=3&s=460" width="100px;"/><br /><sub>誠</sub>](https://github.com/takemiyamakoto)<br />[💻](https://github.com/GUCCI-swallow/iroha-javascript/commits?author=takemiyamakoto) | [<img src="https://avatars0.githubusercontent.com/u/12592891?v=3&s=460" width="100px;"/><br /><sub>Satoshi Kaji</sub>](https://github.com/luca3104)<br />[📖](https://github.com/GUCCI-swallow/iroha-javascript/commits?author=luca3104) | [<img src="https://avatars0.githubusercontent.com/u/11345397?v=3&s=460" width="100px;"/><br /><sub>6londe</sub>](https://github.com/6londe)<br />[📖](https://github.com/GUCCI-swallow/iroha-javascript/commits?author=6londe) | [<img src="https://avatars3.githubusercontent.com/u/475517?v=3&s=460" width="100px;"/><br /><sub>George Theofilis</sub>](https://github.com/theofilis)<br />[💻](https://github.com/GUCCI-swallow/iroha-javascript/commits?author=theofilis) [⚠️](https://github.com/GUCCI-swallow/iroha-javascript/commits?author=theofilis) 🔧 | | ||
| :---: | :---: | :---: | :---: | | ||
<!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
||
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! | ||
|
||
## License | ||
|
||
Copyright 2016 Soramitsu Co., Ltd. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
This repository contains prebuilt binary releases **ONLY**. To find actual code and README watch [main Iroha repo](https://github.com/hyperledger/iroha/tree/develop/shared_model/packages/javascript) and [**iroha-lib** NPM](https://www.npmjs.com/package/iroha-lib). |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.