Paul Shapiro
f6e497bbcc
|
6 years ago | |
---|---|---|
bin | 6 years ago | |
configs | 6 years ago | |
cryptonote_utils | 6 years ago | |
hostAPI | 6 years ago | |
monero_utils | 6 years ago | |
src | 6 years ago | |
tests | 6 years ago | |
.eslintignore | 6 years ago | |
.eslintrc.json | 6 years ago | |
.gitignore | 6 years ago | |
.gitmodules | 6 years ago | |
.prettierignore | 6 years ago | |
.prettierrc | 6 years ago | |
CMakeLists.txt | 6 years ago | |
LICENSE.txt | 6 years ago | |
README.md | 6 years ago | |
index.js | 6 years ago | |
package.json | 6 years ago | |
wallaby.js | 6 years ago |
README.md
MyMonero Core JS
Info
- Legal
- What's in This Repo?
- Library API Documentation
- Building MyMoneroCoreCpp from Scratch
Contributing
- QA
- Pull Requests
Info
Legal
See LICENSE.txt
for license.
All source code copyright © 2014-2018 by MyMonero. All rights reserved.
What's in This Repo?
This repository holds the Javascript source code for the Monero/CryptoNote cryptography and protocols, plus lightwallet functions which power the official MyMonero apps.
There is also a chain of build scripts which is capable of building a JS module by transpiling a subset of Monero source code via emscripten, which relies upon static boost libs, for which there is also a script for building from source.
Contents
-
monero_utils
contains Monero- and MyMonero-specific implementations, wrappers, and declarations, and the MyMonero JS and wasm implementations for the underlying cryptography behind Monero.monero_utils/MyMoneroCoreCpp.(js,wasm)
are produced by transpiling Monero core C++ code to JS via Emscripten (See Building MyMoneroCoreCpp). A Module instance is managed bymonero_utils/MyMoneroCoreBridge.js
.- A ready-made entrypoint for interacting with
MyMoneroCoreBridge
is located atmonero_utils/monero_utils.js
with usagerequire("./monero_utils/monero_utils").then(function(monero_utils) { })
-
This readme is located at
README.md
, and the license is located atLICENSE.txt
.
Library API Documentation
Coming soon
Building MyMoneroCoreCpp from Scratch
There's no need to build monero_utils/MyMoneroCoreCpp as a build is provided, but if you were for example interested in adding a C++ function, you could use the information in this section to transpile it to JS.
Repository Setup
- Execute
bin/update_submodules
Install Emscripten SDK
Ensure you've properly installed Emscripten and exposed the Emscripten executables in your PATH, e.g.:
source ./emsdk_env.sh
Boost for Emscripten
Depends upon: Emscripten SDK
Download a copy of the contents of the Boost source into ./contrib/boost-sdk/
.
- Execute
bin/build-boost-emscripten.sh
Emscripten Module
Depends upon: Repository Setup, Emscripten SDK, Boost for Emscripten
- Execute
bin/build-emcpp.sh
Or if you want to copy the build products to their distribution locations,
- Execute
bin/archive-emcpp.sh
Contributing
QA
Please submit any bugs as Issues unless they have already been reported.
Suggestions and feedback are very welcome!
Pull Requests
We'll merge nearly anything constructive. Contributors welcome and credited in releases.
We often collaborate over IRC in #mymonero on Freenode.
All development happens off the develop
branch like the Gitflow Workflow.
Regular contributors
-
💿
endogenic
(Paul Shapiro) Maintainer -
🍄
luigi
Major contiributor of original JS core crypto and Monero-specific routines; Advisor -
🏄♂️
paullinator
(Paul Puey) API design -
🔒
cryptochangement
Subaddress send & decode support; Initial tests