diff --git a/.babelrc b/.babelrc new file mode 100644 index 0000000..034c316 --- /dev/null +++ b/.babelrc @@ -0,0 +1,9 @@ +{ + "compact": false, + "presets": [ + ["@babel/env", {"targets": {"node": "8.11.3"}}] + ], + "plugins": [ + "@babel/plugin-transform-runtime" + ] +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..aabc2ec --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +dist +node_modules +package + +.idea +.vscode +.eslintrc.json + +embark.min.js +embarkjs-*.tgz +TODO +NOTES +npm-debug.log diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..3dbb5b9 --- /dev/null +++ b/.npmrc @@ -0,0 +1,2 @@ +package-lock = false +save-exact = true diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3fc192b --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2015 iuri matias + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/README.md b/README.md index 47f071b..e87e39d 100644 --- a/README.md +++ b/README.md @@ -1 +1,5 @@ -# EmbarkJS \ No newline at end of file +# EmbarkJS + +A JavaScript library for easily interacting with web3 technologies. + +This library is part of the [Embark](https://github.com/embark-framework/embark) framework. diff --git a/index.html b/index.html new file mode 100644 index 0000000..e4ad317 --- /dev/null +++ b/index.html @@ -0,0 +1,9 @@ + + + + + EmbarkJS — standalone + + + + diff --git a/package.json b/package.json new file mode 100644 index 0000000..66987a5 --- /dev/null +++ b/package.json @@ -0,0 +1,56 @@ +{ + "name": "embarkjs", + "version": "0.1.0", + "description": "JavaScript library for easily interacting with web3 technologies", + "main": "./dist/index.js", + "browser": "./src/browser.js", + "files": [ + "dist", + "embark.min.js", + "src" + ], + "scripts": { + "build": "npm run clean && npm run build-babel && npm run build-webpack", + "build-babel": "babel --ignore 'src/browser.js' --out-dir dist src", + "build-webpack": "npm run webpack", + "clean": "rimraf dist embark.min.js embarkjs-*.tgz package", + "prepack": "npm run build", + "server": "http-server", + "test": "echo \"Error: no test specified\" && exit 1", + "webpack": "webpack" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/embark-framework/EmbarkJS.git" + }, + "author": "Iuri Matias ", + "license": "MIT", + "keywords": [ + "ethereum", + "dapps", + "ipfs", + "solidity", + "solc", + "blockchain", + "serverless" + ], + "bugs": { + "url": "https://github.com/embark-framework/EmbarkJS/issues" + }, + "homepage": "https://github.com/embark-framework/EmbarkJS#readme", + "dependencies": { + "@babel/runtime": "7.0.0-beta.52" + }, + "devDependencies": { + "@babel/cli": "7.0.0-beta.52", + "@babel/core": "7.0.0-beta.52", + "@babel/plugin-transform-runtime": "7.0.0-beta.52", + "@babel/preset-env": "7.0.0-beta.52", + "ajv": "6.5.2", + "babel-loader": "8.0.0-beta.4", + "http-server": "0.11.1", + "rimraf": "2.6.2", + "webpack": "4.15.1", + "webpack-cli": "3.0.8" + } +} diff --git a/src/browser.js b/src/browser.js new file mode 100644 index 0000000..fb18030 --- /dev/null +++ b/src/browser.js @@ -0,0 +1,14 @@ +import _EmbarkJS from './embark'; + +var EmbarkJS = Object.assign({}, _EmbarkJS); + +EmbarkJS.checkWeb3 = function () { + _EmbarkJS.checkWeb3.call(this); + if (!this.web3 && typeof (web3) !== 'undefined') { + this.web3 = web3; + } else if (!this.web3) { + this.web3 = window.web3; + } +}; + +export default EmbarkJS; diff --git a/src/embark.js b/src/embark.js new file mode 100644 index 0000000..53757ce --- /dev/null +++ b/src/embark.js @@ -0,0 +1,404 @@ +var EmbarkJS = { + onReady: function (cb) { + if (typeof (__embarkContext) === 'undefined') { + return cb(); + } + return __embarkContext.execWhenReady(cb); + } +}; + +EmbarkJS.isNewWeb3 = function (web3Obj) { + var _web3 = web3Obj || (new Web3()); + if (typeof(_web3.version) === "string") { + return true; + } + return parseInt(_web3.version.api.split('.')[0], 10) >= 1; +}; + +EmbarkJS.checkWeb3 = function () {}; + +EmbarkJS.Contract = function (options) { + var self = this; + var i, abiElement; + var ContractClass; + + this.abi = options.abi; + this.address = options.address; + this.gas = options.gas; + this.code = '0x' + options.code; + + //this.web3 = options.web3 || web3; + this.web3 = options.web3; + + //if (!this.web3 && typeof (web3) !== 'undefined') { + // this.web3 = web3; + //} else if (!this.web3) { + // this.web3 = window.web3; + //} + EmbarkJS.checkWeb3.call(this); + + if (EmbarkJS.isNewWeb3(this.web3)) { + ContractClass = new this.web3.eth.Contract(this.abi, this.address); + ContractClass.setProvider(this.web3.currentProvider); + ContractClass.options.data = this.code; + ContractClass.options.from = this.from || this.web3.eth.defaultAccount; + ContractClass.abi = ContractClass.options.abi; + ContractClass.address = this.address; + ContractClass.gas = this.gas; + + let originalMethods = Object.keys(ContractClass); + + ContractClass._jsonInterface.forEach((abi) => { + if (originalMethods.indexOf(abi.name) >= 0) { + console.log(abi.name + " is a reserved word and cannot be used as a contract method, property or event"); + return; + } + + if (!abi.inputs) { + return; + } + + let numExpectedInputs = abi.inputs.length; + + if (abi.type === 'function' && abi.constant) { + ContractClass[abi.name] = function () { + let options = {}, cb = null, args = Array.from(arguments || []).slice(0, numExpectedInputs); + if (typeof (arguments[numExpectedInputs]) === 'function') { + cb = arguments[numExpectedInputs]; + } else if (typeof (arguments[numExpectedInputs]) === 'object') { + options = arguments[numExpectedInputs]; + cb = arguments[numExpectedInputs + 1]; + } + + let ref = ContractClass.methods[abi.name]; + let call = ref.apply(ref, ...arguments).call; + return call.apply(call, []); + }; + } else if (abi.type === 'function') { + ContractClass[abi.name] = function () { + let options = {}, cb = null, args = Array.from(arguments || []).slice(0, numExpectedInputs); + if (typeof (arguments[numExpectedInputs]) === 'function') { + cb = arguments[numExpectedInputs]; + } else if (typeof (arguments[numExpectedInputs]) === 'object') { + options = arguments[numExpectedInputs]; + cb = arguments[numExpectedInputs + 1]; + } + + let ref = ContractClass.methods[abi.name]; + let send = ref.apply(ref, args).send; + return send.apply(send, [options, cb]); + }; + } else if (abi.type === 'event') { + ContractClass[abi.name] = function (options, cb) { + let ref = ContractClass.events[abi.name]; + return ref.apply(ref, [options, cb]); + }; + } + }); + + return ContractClass; + } else { + ContractClass = this.web3.eth.contract(this.abi); + + this.eventList = []; + + if (this.abi) { + for (i = 0; i < this.abi.length; i++) { + abiElement = this.abi[i]; + if (abiElement.type === 'event') { + this.eventList.push(abiElement.name); + } + } + } + + var messageEvents = function () { + this.cb = function () { + }; + }; + + messageEvents.prototype.then = function (cb) { + this.cb = cb; + }; + + messageEvents.prototype.error = function (err) { + return err; + }; + + this._originalContractObject = ContractClass.at(this.address); + this._methods = Object.getOwnPropertyNames(this._originalContractObject).filter(function (p) { + // TODO: check for forbidden properties + if (self.eventList.indexOf(p) >= 0) { + + self[p] = function () { + var promise = new messageEvents(); + var args = Array.prototype.slice.call(arguments); + args.push(function (err, result) { + if (err) { + promise.error(err); + } else { + promise.cb(result); + } + }); + + self._originalContractObject[p].apply(self._originalContractObject[p], args); + return promise; + }; + return true; + } else if (typeof self._originalContractObject[p] === 'function') { + self[p] = function (_args) { + var args = Array.prototype.slice.call(arguments); + var fn = self._originalContractObject[p]; + var props = self.abi.find((x) => x.name == p); + + var promise = new Promise(function (resolve, reject) { + args.push(function (err, transaction) { + promise.tx = transaction; + if (err) { + return reject(err); + } + + var getConfirmation = function () { + self.web3.eth.getTransactionReceipt(transaction, function (err, receipt) { + if (err) { + return reject(err); + } + + if (receipt !== null) { + return resolve(receipt); + } + + setTimeout(getConfirmation, 1000); + }); + }; + + if (typeof transaction !== "string" || props.constant) { + resolve(transaction); + } else { + getConfirmation(); + } + }); + + fn.apply(fn, args); + }); + + return promise; + }; + return true; + } + return false; + }); + } +}; + +EmbarkJS.Contract.prototype.deploy = function (args, _options) { + var self = this; + var contractParams; + var options = _options || {}; + + contractParams = args || []; + + contractParams.push({ + from: this.web3.eth.accounts[0], + data: this.code, + gas: options.gas || 800000 + }); + + var contractObject = this.web3.eth.contract(this.abi); + + var promise = new Promise(function (resolve, reject) { + contractParams.push(function (err, transaction) { + if (err) { + reject(err); + } else if (transaction.address !== undefined) { + resolve(new EmbarkJS.Contract({ + abi: self.abi, + code: self.code, + address: transaction.address + })); + } + }); + + // returns promise + // deploys contract + // wraps it around EmbarkJS.Contract + contractObject["new"].apply(contractObject, contractParams); + }); + + + return promise; +}; + +EmbarkJS.Contract.prototype.new = EmbarkJS.Contract.prototype.deploy; + +EmbarkJS.Contract.prototype.at = function (address) { + return new EmbarkJS.Contract({abi: this.abi, code: this.code, address: address}); +}; + +EmbarkJS.Contract.prototype.send = function (value, unit, _options) { + var options, wei; + if (typeof unit === 'object') { + options = unit; + wei = value; + } else { + options = _options || {}; + wei = this.web3.toWei(value, unit); + } + + options.to = this.address; + options.value = wei; + + this.web3.eth.sendTransaction(options); +}; + +EmbarkJS.Storage = {}; + +EmbarkJS.Storage.Providers = {}; + +EmbarkJS.Storage.saveText = function (text) { + if (!this.currentStorage) { + throw new Error('Storage provider not set; e.g EmbarkJS.Storage.setProvider("ipfs")'); + } + return this.currentStorage.saveText(text); +}; + +EmbarkJS.Storage.get = function (hash) { + if (!this.currentStorage) { + throw new Error('Storage provider not set; e.g EmbarkJS.Storage.setProvider("ipfs")'); + } + return this.currentStorage.get(hash); +}; + +EmbarkJS.Storage.uploadFile = function (inputSelector) { + if (!this.currentStorage) { + throw new Error('Storage provider not set; e.g EmbarkJS.Storage.setProvider("ipfs")'); + } + return this.currentStorage.uploadFile(inputSelector); +}; + +EmbarkJS.Storage.getUrl = function (hash) { + if (!this.currentStorage) { + throw new Error('Storage provider not set; e.g EmbarkJS.Storage.setProvider("ipfs")'); + } + return this.currentStorage.getUrl(hash); +}; + +EmbarkJS.Storage.registerProvider = function (providerName, obj) { + EmbarkJS.Storage.Providers[providerName] = obj; +}; + +EmbarkJS.Storage.setProvider = function (provider, options) { + let providerObj = this.Providers[provider]; + + if (!providerObj) { + throw new Error('Unknown storage provider'); + } + + this.currentStorage = providerObj; + + return providerObj.setProvider(options); +}; + +EmbarkJS.Storage.isAvailable = function () { + if (!this.currentStorage) { + throw new Error('Storage provider not set; e.g EmbarkJS.Storage.setProvider("ipfs")'); + } + return this.currentStorage.isAvailable(); +}; + +EmbarkJS.Messages = {}; + +EmbarkJS.Messages.Providers = {}; + +EmbarkJS.Messages.registerProvider = function (providerName, obj) { + EmbarkJS.Messages.Providers[providerName] = obj; +}; + +EmbarkJS.Messages.setProvider = function (provider, options) { + let providerObj = this.Providers[provider]; + + if (!providerObj) { + throw new Error('Unknown messages provider'); + } + + this.currentMessages = providerObj; + + return providerObj.setProvider(options); +}; + +EmbarkJS.Messages.isAvailable = function () { + return this.currentMessages.isAvailable(); +}; + +EmbarkJS.Messages.sendMessage = function (options) { + if (!this.currentMessages) { + throw new Error('Messages provider not set; e.g EmbarkJS.Messages.setProvider("whisper")'); + } + return this.currentMessages.sendMessage(options); +}; + +EmbarkJS.Messages.listenTo = function (options, callback) { + if (!this.currentMessages) { + throw new Error('Messages provider not set; e.g EmbarkJS.Messages.setProvider("whisper")'); + } + return this.currentMessages.listenTo(options, callback); +}; + +EmbarkJS.Names = {}; + +EmbarkJS.Names.Providers = {}; + +EmbarkJS.Names.registerProvider = function (providerName, obj) { + EmbarkJS.Names.Providers[providerName] = obj; +}; + +EmbarkJS.Names.setProvider = function (provider, options) { + let providerObj = this.Providers[provider]; + + if (!providerObj) { + throw new Error('Unknown name system provider'); + } + + this.currentNameSystems = providerObj; + + return providerObj.setProvider(options); +}; + +// resolve resolves a name into an identifier of some kind +EmbarkJS.Names.resolve = function (name) { + if (!this.currentNameSystems) { + throw new Error('Name system provider not set; e.g EmbarkJS.Names.setProvider("ens")'); + } + return this.currentNameSystems.resolve(name); +}; + +// the reverse of resolve, resolves using an identifier to get to a name +EmbarkJS.Names.lookup = function (identifier) { + if (!this.currentNameSystems) { + throw new Error('Name system provider not set; e.g EmbarkJS.Names.setProvider("ens")'); + } + return this.currentNameSystems.lookup(identifier); +}; + +// To Implement + + +// register a name +EmbarkJS.Names.register = function(name, options) { + if (!this.currentNameSystems) { + throw new Error('Name system provider not set; e.g EmbarkJS.Names.setProvider("ens")'); + } + return this.currentNameSystems.register(name, options); +} + +EmbarkJS.Utils = { + fromAscii: function (str) { + var _web3 = new Web3(); + return _web3.utils ? _web3.utils.fromAscii(str) : _web3.fromAscii(str); + }, + toAscii: function (str) { + var _web3 = new Web3(); + return _web3.utils.toAscii(str); + } +}; + +export default EmbarkJS; diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..c96c61c --- /dev/null +++ b/src/index.js @@ -0,0 +1 @@ +module.exports = require('./embark').default; diff --git a/webpack.config.js b/webpack.config.js new file mode 100644 index 0000000..a8c7fbc --- /dev/null +++ b/webpack.config.js @@ -0,0 +1,39 @@ +const path = require('path'); + +const browser = { + entry: path.resolve(__dirname, 'src') + '/browser.js', + mode: 'production', + module: { + rules: [ + { + test: /\.js$/, + exclude: /(node_modules|bower_components)/, + use: { + loader: 'babel-loader', + options: { + babelrc: false, + presets: [ + ['@babel/env'] + ] + } + } + } + ] + }, + // optimization: { + // minimize: false + // }, + output: { + filename: 'embark.min.js', + library: 'EmbarkJS', + libraryTarget: 'umd', + libraryExport: 'default', + path: __dirname, + umdNamedDefine: true, + }, + target: 'web' +}; + +module.exports = [ + browser +];