Updates readme.

Changes to just reference script so I don't have to keep them in sync.

Author: Micah Zoltu

README.md

@@ -1,44 +1,17 @@
 # Deterministic Deployment Proxy
 This is a proxy contract that can be deployed to any chain at the same address, and can then in turn deploy any contract at a deterministic location using CREATE2.  To use, first deploy the contract using the one-time-account transaction specified in `output/deployment.json`, then call the `deploy` method on the contract at the address specified in `output/deployment.json` to deploy your contract.
 
-## Example Usage
+## Usage
 ```bash
-JSON_RPC="http://localhost:1234"
-
-# start parity in a local container
-PARITY_CONTAINER_ID=$(docker container run --rm -d -p 1234:8545 keydonix/parity-instantseal)
-# wait for parity to become responsive
-until $(curl --output /dev/null --silent --fail $JSON_RPC -X 'POST' -H 'Content-Type: application/json' --data "{\"jsonrpc\":\"2.0\", \"id\":1, \"method\": \"net_version\", \"params\": []}"); do sleep 1; done
-
-# extract the variables we need from json output
-MY_ADDRESS="0x913dA4198E6bE1D5f5E4a40D0667f70C0B5430Eb"
-ONE_TIME_SIGNER_ADDRESS="0x$(cat output/deployment.json | jq --raw-output '.signerAddress')"
-GAS_COST="0x$(printf '%x' $(($(cat output/deployment.json | jq --raw-output '.gasPrice') * $(cat output/deployment.json | jq --raw-output '.gasLimit'))))"
-TRANSACTION="0x$(cat output/deployment.json | jq --raw-output '.transaction')"
-DEPLOYER_ADDRESS="0x$(cat output/deployment.json | jq --raw-output '.address')"
-
-# send gas money to signer
-curl $JSON_RPC -X 'POST' -H 'Content-Type: application/json' --data "{\"jsonrpc\":\"2.0\", \"id\":1, \"method\": \"eth_sendTransaction\", \"params\": [{\"from\":\"$MY_ADDRESS\",\"to\":\"$ONE_TIME_SIGNER_ADDRESS\",\"value\":\"$GAS_COST\"}]}"
-
-# deploy the deployer contract
-curl $JSON_RPC -X 'POST' -H 'Content-Type: application/json' --data "{\"jsonrpc\":\"2.0\", \"id\":1, \"method\": \"eth_sendRawTransaction\", \"params\": [\"$TRANSACTION\"]}"
+npm install
+npm run build
+./scripts/test.sh
+```
 
-# deploy our contract
-# contract: pragma solidity 0.5.8; contract Apple {function banana() external pure returns (uint8) {return 42;}}
-DEPLOY_SIGNATURE="9c4ae2d0"
-BYTECODE_OFFSET="0000000000000000000000000000000000000000000000000000000000000040"
-SALT="0000000000000000000000000000000000000000000000000000000000000000"
-BYTECODE_LENGTH="0000000000000000000000000000000000000000000000000000000000000098"
-BYTECODE="6080604052348015600f57600080fd5b50607a8061001e6000396000f3fe6080604052348015600f57600080fd5b506004361060285760003560e01c8063c3cafc6f14602d575b600080fd5b60336049565b6040805160ff9092168252519081900360200190f35b602a9056fea165627a7a7230582061b42c10c5aed258685366454ca535be5306e982bf70d72569122494bc53deb60029"
-PADDING="0000000000000000"
-curl $JSON_RPC -X 'POST' -H 'Content-Type: application/json' --data "{\"jsonrpc\":\"2.0\", \"id\":1, \"method\": \"eth_sendTransaction\", \"params\": [{\"from\":\"$MY_ADDRESS\",\"to\":\"$DEPLOYER_ADDRESS\", \"data\":\"0x$DEPLOY_SIGNATURE$BYTECODE_OFFSET$SALT$BYTECODE_LENGTH$BYTECODE$PADDING\"}]}"
+### Details
+See `scripts/test.sh` (commented).  Change `JSON_RPC` environment variable to the chain of your choice (requires an unlocked wallet with ETH).  Notice that the script works against _any_ chain!  If the chain already has the deployer contract deployed to it, then you can just comment out the deployment steps (line 21 and 24) and everything else will still function as normal.  If you have already deployed your contract with it, it'll fail because your contract already exists at its address.
 
-# call our contract (we know the address, no matter what chain we ran this script against!)
-MY_CONTRACT_ADDRESS="0x8bb88a8d94804d59f8c2fb06d6605e288382e24f"
-MY_CONTRACT_METHOD_SIGNATURE="c3cafc6f"
-curl $JSON_RPC -X 'POST' -H 'Content-Type: application/json' --data "{\"jsonrpc\":\"2.0\", \"id\":1, \"method\": \"eth_call\", \"params\": [{\"to\":\"$MY_CONTRACT_ADDRESS\", \"data\":\"0x$MY_CONTRACT_METHOD_SIGNATURE\"}, \"latest\"]}"
-# expected result is 0x000000000000000000000000000000000000000000000000000000000000002a (hex encoded 42)
+## Explanation
+This repository contains a simple contract that can deploy other contracts with a deterministic address on any chain using CREATE2.  The CREATE2 call will deploy a contract (like CREATE opcode) but instead of the address being `keccak256(rlp([deployer_address, nonce]))` it instead uses the hash of the contract's bytecode and a salt.  This means that a given deployer address will deploy the same code to the same address no matter _when_ they issue the deployment.  The deployer is deployed with a one-time-use-account, so no matter what chain the deployer is on, its address will always be the same.  This means the only variables in determining the address of your contract are its bytecode hash and the provided salt.
 
-# shutdown Parity
-docker container stop $PARITY_CONTAINER_ID
-```
+Between the use of CREATE2 opcode and the one-time-use-account for the deployer, we can ensure that a given contract will exist at the _exact_ same address on every chain, but without having to use the same gas pricing or limits every time.

package.json

@@ -20,7 +20,6 @@
 		"typescript": "3.4.5"
 	},
 	"scripts": {
-		"build": "ts-node scripts/compile.ts",
-		"prepublishOnly": "npm run build"
+		"build": "ts-node scripts/compile.ts"
 	}
 }