Fix deploy scripts and include as part of CI

Author: 0age

.travis.yml

@@ -17,7 +17,9 @@ install:
   - yarn global add coveralls
   - yarn install
 script:
-  - yarn run coverage && cat coverage/lcov.info | coveralls
+  - yarn build
+  - yarn deploy basic && yarn deploy extended && yarn deploy token
+  - yarn coverage && cat coverage/lcov.info | coveralls
   - yarn test
 cache:
   yarn: true

README.md

@@ -52,13 +52,12 @@ $ ganache-cli --gasLimit 8000000
 
 Then, to run tests:
 ```sh
-$ yarn run coverage
 $ yarn test
-$ node scripts/gasAnalysis.js
-$ ./node_modules/.bin/solhint "contracts/**/*.sol"
+$ yarn coverage
+$ yarn linter
 ```
 
-Contracts may also be deployed locally using `$ node scripts/deploy.js`.
+A jurisdiction may then be deployed locally using `yarn deploy basic` or `yarn deploy extended`.
 
 ## API
 *NOTE: This documentation is still a work in progress. See the relevant contract source code for additional information.*

config.js

@@ -1,9 +1,5 @@
 module.exports = {
   network: 'development',
   TPLTokenAttributeID: 0,
-  TPLTokenTotalSupply: 100,
-  TPLTokenAttributeRestricted: false,
-  TPLTokenAttributeMinimumRequiredStake: 0,
-  TPLTokenAttributeJurisdictionFee: 0,
-  TPLTokenAttributeDescription: 'Valid TPL token holder'
+  TPLTokenTotalSupply: 100
 }

package.json

@@ -13,7 +13,9 @@
   },
   "scripts": {
   	"build": "./node_modules/.bin/truffle compile",
-  	"test": "./node_modules/.bin/truffle compile compile && node scripts/testBasicDirect.js && node scripts/testExtendedDirect.js && node scripts/testBasicOnExtendedDirect.js && echo 'skipping scripts/testOptimizationDisabled.js'",
-  	"coverage": "./node_modules/.bin/solidity-coverage"
+  	"test": "./node_modules/.bin/truffle compile && node scripts/testBasicDirect.js && node scripts/testExtendedDirect.js && node scripts/testBasicOnExtendedDirect.js && echo 'skipping scripts/testOptimizationDisabled.js'",
+  	"coverage": "./node_modules/.bin/solidity-coverage",
+    "linter": "./node_modules/.bin/solhint 'contracts/**/*.sol'",
+    "deploy": "node scripts/deploy.js"
   }
 }

scripts/deploy.js

@@ -1,74 +1,108 @@
 var fs = require('fs');
-
-const JurisdictionContractData = require('../build/contracts/Jurisdiction.json')
-const TPLTokenContractData = require('../build/contracts/TPLToken.json')
 const applicationConfig = require('../config.js')
 const connectionConfig = require('../truffle.js')
-
 const connection = connectionConfig.networks[applicationConfig.network]
 
+const deployMetadataFilename = 'build/contractDeploymentAddresses.json'
+
+let deployAddresses
+try {
+  deployAddresses = require(`../${deployMetadataFilename}`)
+} catch(error) {
+  deployAddresses = {}
+}
+
+let deployType = process.argv[2] // Provide Basic or Extended jurisdiction type
+if (typeof(deployType) === 'undefined') {
+  deployType = 'extended'
+} else {
+  deployType = deployType.toLowerCase()
+}
+
+let showAccounts = process.argv[3] // Provide if you'd like to dump accounts
+
+const deployTypeOptions = new Set(['basic', 'extended', 'token'])
+if (!deployTypeOptions.has(deployType)) {
+  console.error('must supply "basic", "extended", or "token" as the target!')
+  process.exit(1)
+}
+
+let args
+if (deployType === 'token') {
+  const jurisdiction = deployAddresses.jurisdiction
+  
+  if (typeof(jurisdiction) === 'undefined') {
+    console.error('must first deploy a jurisdiction before attaching a token!')
+    process.exit(1)
+  }
+
+  args = [
+    applicationConfig.TPLTokenTotalSupply,
+    jurisdiction,
+    applicationConfig.TPLTokenAttributeID
+  ]
+} else {
+  args = []
+}
+
+let contractImportLocation
+if (deployType === 'basic') {
+  contractImportLocation = '../build/contracts/BasicJurisdiction.json'
+} else if (deployType === 'extended') {
+  contractImportLocation = '../build/contracts/ExtendedJurisdiction.json'
+} else if (deployType === 'token') {
+  contractImportLocation = '../build/contracts/TPLERC20RestrictedReceiverInstance.json'
+}
+
+const ContractData = require(contractImportLocation)
+
 let web3 = connection.provider
 
-const Jurisdiction = new web3.eth.Contract(JurisdictionContractData.abi)
-const TPLToken = new web3.eth.Contract(TPLTokenContractData.abi)
-
-const TPLTokenAttributeID = applicationConfig.TPLTokenAttributeID
-const TPLTokenTotalSupply = applicationConfig.TPLTokenTotalSupply
-const TPLTokenAttributeRestricted = applicationConfig[
-  'TPLTokenAttributeRestricted'
-]
-const TPLTokenAttributeMinimumRequiredStake = applicationConfig[
-  'TPLTokenAttributeMinimumRequiredStake'
-]
-const TPLTokenAttributeJurisdictionFee = applicationConfig[
-  'TPLTokenAttributeJurisdictionFee'
-]
-const TPLTokenAttributeDescription = applicationConfig[
-  'TPLTokenAttributeDescription'
-]
+const Contract = new web3.eth.Contract(ContractData.abi)
 
 async function main() {
-  console.log('deploying jurisdiction & mock TPLToken...')
-  let deployAddresses = {}
-  const deployMetadataFilename = 'build/contractDeploymentAddresses.json'
-  const addresses = await Promise.resolve(web3.eth.getAccounts())
-  if (addresses.length === 0) {
-    console.log('cannot find any addresses...')
-    return false
+  console.log(
+    `deploying ${
+      deployType
+    }${
+      deployType !== 'token' ? ' jurisdiction' : ''
+    } to ${
+      applicationConfig.network
+    } network...`
+  )
+  
+  const accounts = await Promise.resolve(web3.eth.getAccounts())
+  if (accounts.length === 0) {
+    console.error('cannot find any accounts...')
+    process.exit(1)
   }
 
-  const address = addresses[0]
-  deployAddresses.owner = address
-  console.log(`         owner: ${address}`)
-
-  const JurisdictionContractInstance = await Jurisdiction.deploy({
-    data: JurisdictionContractData.bytecode
-  }).send({
-    from: address,
-    gas: 5000000,
-    gasPrice: '1000000000'
-  })
+  const account = accounts[0]
+  if (deployType !== 'token') {
+    deployAddresses.jurisdictionOwner = account
+  } else {
+    deployAddresses.tokenOwner = account
+  }
+  
+  console.log(`   deployed by: ${account}`)
 
-  const jurisdictionAddress = JurisdictionContractInstance.options.address
-  deployAddresses.jurisdiction = jurisdictionAddress
-  console.log(`  jurisdiction: ${jurisdictionAddress}`)
-
-  const TPLTokenContractInstance = await TPLToken.deploy({
-    data: TPLTokenContractData.bytecode,
-    arguments: [
-      JurisdictionContractInstance.options.address,
-      TPLTokenAttributeID,
-      TPLTokenTotalSupply
-    ]
+  const ContractInstance = await Contract.deploy({
+    data: ContractData.bytecode,
+    arguments: args
   }).send({
-    from: address,
-    gas: 5000000,
-    gasPrice: '1000000000'
+    from: account,
+    gas: 7000000,
+    gasPrice: '10000000000'
   })
 
-  const tokenAddress = TPLTokenContractInstance.options.address
-  deployAddresses.token = tokenAddress
-  console.log(`mock TPL token: ${tokenAddress}`)
+  const deployedAddress = ContractInstance.options.address
+  if (deployType !== 'token') {
+    deployAddresses.jurisdiction = deployedAddress
+    console.log(`  jurisdiction: ${deployedAddress}`)
+  } else {
+    deployAddresses.token = deployedAddress
+    console.log(`    mock token: ${deployedAddress}`)
+  }
 
   fs.writeFile(
     deployMetadataFilename,
@@ -77,10 +111,14 @@ async function main() {
     err => {
       if (err) {
         console.error(err)
-        process.exit()
+        process.exit(1)
       }
       console.log(`metadata written to ${deployMetadataFilename}`)
-      process.exit()
+      if (showAccounts === 'verbose') {
+        console.log()
+        console.log(JSON.stringify(deployAddresses, null, 2))
+      }
+      process.exit(0)
     }
   )
 }