Single constructor (deprecates EosApi.Testnet and EosApi.Localnet) EOSIO#68

Author: James Calfee

README.md

@@ -19,7 +19,7 @@ General purpose library for the EOS blockchain.
 ```javascript
 Eos = require('eosjs') // Eos = require('./src')
 
-eos = Eos.Localnet() // 127.0.0.1:8888
+eos = Eos() // 127.0.0.1:8888
 
 // All API methods print help when called with no-arguments.
 eos.getBlock()
@@ -39,7 +39,6 @@ eos.getBlock({block_num_or_id: 1}, callback)
 
 // Provide an empty object or a callback if an API call has no arguments
 eos.getInfo({}).then(result => {console.log(result)})
-
 ```
 
 API methods and documentation are generated from:
@@ -62,11 +61,11 @@ config = {
   },
   expireInSeconds: 60,
   broadcast: true,
-  debug: false,
+  debug: false, // API and transactions
   sign: true
 }
 
-eos = Eos.Localnet(config)
+eos = Eos(config)
 ```
 
 * `mockTransactions` (optional)
@@ -107,12 +106,12 @@ options = {
 
 ### Usage (read/write)
 
-If you use the Testnet, you'll need to replace the private key in keyProvider.
+You'll need to provide the private key in keyProvider.
 
 ```javascript
 Eos = require('eosjs') // Eos = require('./src')
 
-eos = Eos.Localnet({keyProvider: '5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3'})
+eos = Eos({keyProvider: '5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3'})
 
 // Run with no arguments to print usage.
 eos.transfer()
@@ -153,7 +152,7 @@ Eos = require('eosjs') // Eos = require('./src')
 wif = '5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3'
 pubkey = 'EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV'
 
-eos = Eos.Localnet({keyProvider: wif})
+eos = Eos({keyProvider: wif})
 
 eos.transaction(tr => {
   tr.newaccount({
@@ -200,7 +199,7 @@ Import and include the library when you configure Eos:
 
 ```javascript
 binaryen = require('binaryen')
-eos = Eos.Localnet({..., binaryen})
+eos = Eos({..., binaryen})
 ```
 
 Complete example:
@@ -215,9 +214,9 @@ keyProvider = '5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3'
 //
 // $ npm install [email protected]
 // binaryen = require('binaryen')
-// eos = Eos.Localnet({keyProvider, binaryen})
+// eos = Eos({keyProvider, binaryen})
 
-eos = Eos.Localnet({keyProvider})
+eos = Eos({keyProvider})
 
 wasm = fs.readFileSync(`docker/contracts/eosio.token/eosio.token.wasm`)
 abi = fs.readFileSync(`docker/contracts/eosio.token/eosio.token.abi`)
@@ -243,7 +242,7 @@ keyProvider = [
   Eos.modules.ecc.seedPrivate('currency')
 ]
 
-eos = Eos.Localnet({keyProvider})
+eos = Eos({keyProvider})
 
 // if either transfer fails, both will fail (1 transaction, 2 messages)
 eos.transaction(eos =>
@@ -288,7 +287,7 @@ A manual transaction provides for more flexibility.
 ```javascript
 Eos = require('eosjs') // Eos = require('./src')
 
-eos = Eos.Localnet({keyProvider: '5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3'})
+eos = Eos({keyProvider: '5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3'})
 
 // returns Promise
 eos.transaction({
@@ -324,28 +323,24 @@ import from `./src` instead.
 
 ```javascript
 Eos = require('./src')
-
-// Creating the instance `eos` means that common blockchain data-structures are
-// available for a given network (Testnet, Mainnet, etc).
-eos = Eos.Localnet()
+eos = Eos()
 ```
 
 * Fcbuffer
 
-The `eos` instance can provide more convenient serialization:
+The `eos` instance can provide serialization:
 
 ```javascript
 // 'asset' is a type but could be any struct or type like: transaction or uint8
 type = {type: 1, data: '00ff'}
 buffer = eos.fc.toBuffer('extensions_type', type)
 assert.deepEqual(type, eos.fc.fromBuffer('extensions_type', buffer))
 
-// Serialization for a smart-contract's Abi:
-eos.contract('currency', (error, c) => currency = c)
-create = {issuer: 'inita', maximum_supply: '1.0000 4,CUR'}
-buffer = currency.fc.toBuffer('create', create)
-create.maximum_supply = '1.0000 CUR'
-assert.deepEqual(create, currency.fc.fromBuffer('create', buffer))
+// ABI Serialization
+eos.contract('eosio.token', (error, c) => eosio_token = c)
+create = {issuer: 'inita', maximum_supply: '1.0000 SYS'}
+buffer = eosio_token.fc.toBuffer('create', create)
+assert.deepEqual(create, eosio_token.fc.fromBuffer('create', buffer))
 ```
 
 Use Node v8+ to `package-lock.json`.
@@ -357,7 +352,7 @@ need to use them directly.  They are exported here giving more API access or
 in some cases may be used standalone.
 
 ```javascript
-var {api, ecc, json, Fcbuffer, format} = Eos.modules
+var {format, api, ecc, json, Fcbuffer} = Eos.modules
 ```
 * format [./format.md](./docs/format.md)
   * Blockchain name validation
@@ -393,13 +388,16 @@ git clone https://github.com/EOSIO/eosjs.git
 cd eosjs
 npm install
 npm run build_browser
-# builds: ./dist/eos.js
+# builds: ./dist/eos.js load with ./dist/index.html
+
+npm run build_browser_test
+# builds: ./dist/test.js run with ./dist/test.html
 ```
 
 ```html
 <script src="eos.js"></script>
 <script>
-var eos = Eos.Testnet()
+var eos = Eos()
 //...
 </script>
 ```

dist/index.html

@@ -3,7 +3,11 @@
   <meta charset="utf-8">
   <script src="eos.js"></script>
   <script>
-  eos = Eos.Testnet()
+  eos = Eos({
+    httpEndpoint: 'http://ayeaye.cypherglass.com:8888',
+    chainId: 'a628a5a6123d6ed60242560f23354c557f4a02826e223bb38aad79ddeb9afbca',
+    debug: true
+  })
   </script>
 </head>
 <body>

package-lock.json

@@ -46,7 +46,7 @@
     "babel-polyfill": "^6.26.0",
     "binaryen": "^37.0.0",
     "create-hash": "^1.1.3",
-    "eosjs-api": "6.1.2",
+    "eosjs-api": "6.1.3",
     "eosjs-ecc": "4.0.1",
     "fcbuffer": "2.2.0"
   },

package.json

@@ -7,64 +7,71 @@ try {
 }
 
 const ecc = require('eosjs-ecc')
-const json = {
-  api: require('eosjs-api').api,
-  schema: require('./schema')
-}
-
 const Fcbuffer = require('fcbuffer')
-const api = require('eosjs-api')
+const EosApi = require('eosjs-api')
+const assert = require('assert')
 
 const Structs = require('./structs')
 const AbiCache = require('./abi-cache')
 const AssetCache = require('./asset-cache')
 const writeApiGen = require('./write-api')
-const assert = require('assert')
 const format = require('./format')
-
+const schema = require('./schema')
 const pkg = require('../package.json')
-const Eos = {
-  version: pkg.version
-}
-
-module.exports = Eos
-
-Eos.modules = {
-  json,
-  ecc,
-  api,
-  Fcbuffer,
-  format
-}
 
 const configDefaults = {
   broadcast: true,
   debug: false,
   sign: true
 }
 
-function development(Network) {
-  Network.schema = json.schema
-  return (config = {}) => {
-    config = Object.assign({}, configDefaults, config)
-    const network = Network(Object.assign({}, {
-      apiLog: consoleObjCallbackLog(config.verbose)},
-      config
-    ))
-    const eosConfig = Object.assign({}, {
-      transactionLog: consoleObjCallbackLog(config.verbose)},
-      config
-    )
-    return createEos(eosConfig, Network, network)
+const Eos = (config = {}) => createEos(
+  Object.assign(
+    {},
+    {
+      apiLog: consoleObjCallbackLog(config.verbose),
+      transactionLog: consoleObjCallbackLog(config.verbose),
+    },
+    configDefaults,
+    config
+  )
+)
+
+module.exports = Eos
+
+Object.assign(
+  Eos,
+  {
+    version: pkg.version,
+    modules: {
+      format,
+      api: EosApi,
+      ecc,
+      json: {
+        api: EosApi.api,
+        schema
+      },
+      Fcbuffer
+    },
+
+    /** @deprecated */
+    Testnet: function (config) {
+      console.error('deprecated, change Eos.Testnet(..) to just Eos(..)')
+      return Eos(config)
+    },
+
+    /** @deprecated */
+    Localnet: function (config) {
+      console.error('deprecated, change Eos.Localnet(..) to just Eos(..)')
+      return Eos(config)
+    }
   }
-}
+)
 
-Eos.Testnet = development(api.Testnet)
-Eos.Localnet = development(api.Localnet)
-// Eos.Mainnet = config => ..
 
-function createEos(config, Network, network) {
-  config = Object.assign({}, config, {network})
+function createEos(config) {
+  const network = EosApi(config)
+  config.network = network
 
   config.assetCache = AssetCache(network)
   config.abiCache = AbiCache(network, config)
@@ -84,7 +91,7 @@ function createEos(config, Network, network) {
   }
 
   const {structs, types, fromBuffer, toBuffer} = Structs(config)
-  const eos = mergeWriteFunctions(config, Network, structs)
+  const eos = mergeWriteFunctions(config, EosApi, structs)
 
   Object.assign(eos, {fc: {
     structs,
@@ -121,18 +128,18 @@ function consoleObjCallbackLog(verbose = false) {
   name conflicts.
 
   @arg {object} config.network - read-only api calls
-  @arg {object} Network - api[Network] read-only api calls
+  @arg {object} EosApi - api[EosApi] read-only api calls
   @return {object} - read and write method calls (create and sign transactions)
   @throw {TypeError} if a funciton name conflicts
 */
-function mergeWriteFunctions(config, Network, structs) {
+function mergeWriteFunctions(config, EosApi, structs) {
   assert(config.network, 'network instance required')
   const {network} = config
 
   const merge = Object.assign({}, network)
 
-  const writeApi = writeApiGen(Network, network, structs, config)
-  throwOnDuplicate(merge, writeApi, 'Conflicting methods in Network Api and Transaction Api')
+  const writeApi = writeApiGen(EosApi, network, structs, config, schema)
+  throwOnDuplicate(merge, writeApi, 'Conflicting methods in EosApi and Transaction Api')
   Object.assign(merge, writeApi)
 
   return merge