From f6c1cfb9808828d9d2d1cfa84914fd854c0c2793 Mon Sep 17 00:00:00 2001 From: emizzle Date: Mon, 17 Jun 2019 21:53:13 +1000 Subject: [PATCH] Readme updates --- README.md | 111 +++--------------------------------------------------- 1 file changed, 6 insertions(+), 105 deletions(-) diff --git a/README.md b/README.md index ab7c9e4..27609ea 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # EmbarkJS-Plasma EmbarkJS-Plasma is a convenience library for adding Plasma chain support to your DApp. It's meant to be used as an extension for [EmbarkJS](https://github.com/embark-framework/embark/packages/embarkjs), by being added as a property of EmbarkJS, ie `EmbarkJS.Plasma`. -> NOTE: This library is meant to be used as a dependency of [`embark-plasma`](https://github.com/embark-framework/embark-plasma), however it can be used as a standalone library is so desired. +> NOTE: This library is meant to be used as a dependency of [`embark-plasma`](https://github.com/embark-framework/embark-plasma), however it can be used as a standalone library if so desired. -The `embark-plasma` plugin will: +The `embarkjs-plasma` plugin will: 1. Load the contents of `embarkjs-plasma` in to the `Plasma` property of `EmbarkJS`, so it will available using `EmbarkJS.Plasma` in your DApp. 2. Instantiate `EmbarkJS.Plasma`. @@ -13,10 +13,10 @@ This will expose convenience methods to be used by your DApp to interact with Pl 1. Embark `^4.1.0-beta.2` ## Plugin config -Please see [`embark-plasma`](https://github.com/embark-framework/embark-plasma) for information on how to set up the `embark-plasma` plugin to be used in your DApp. +Please see [`embark-plasma`](https://github.com/embark-framework/embark-plasma) for information on how to set up the `embarkjs-plasma` plugin to be used in your DApp. ## Current limitations and known issues -1. The plugin currently only supports OMG's Samrong network and (v0.2) of the OMG SDK. The root chain is a contract on Rinkeby and the Plasma chain runs on Samrong. Chains creation for development purposes will be added in future versions. +1. The plugin currently only supports OMG's Samrong network and `v0.2` of the OMG SDK. The root chain is a contract on Rinkeby and the Plasma chain runs on Samrong. Chain creation for development purposes will be added in future versions. 2. The DApp must use Metamask. The accounts configured in the blockchain config cannot be used in the DApp. This is a limitation of Embark itself, and will hopefully be updated soon. ## Available properties/functions @@ -25,9 +25,9 @@ Please see [`embark-plasma`](https://github.com/embark-framework/embark-plasma) ### Properties `EmbarkJS.Plasma.currentAddress`: the active account exposed by Metamask. -`EmbarkJS.Plasma.initing`: true when the initialisation routine is in progress (ie run via `EmbarkJS.Plasma.init()`). +`EmbarkJS.Plasma.initing`: `true` when the initialisation routine is in progress (ie run via `EmbarkJS.Plasma.init()`). -`EmbarkJS.Plasma.inited`: true when the initialisation routine has finished (ie when `EmbarkJS.Plasma.init()` has completed). +`EmbarkJS.Plasma.inited`: `true` when the initialisation routine has finished (ie when `EmbarkJS.Plasma.init()` has completed). `EmbarkJS.Plasma.config`: Object representing the plugin config specified in the DApp's `embark.json`. See [`embark-plasma`](https://github.com/embark-framework/embark-plasma) for more config details. @@ -64,105 +64,6 @@ Please see [`embark-plasma`](https://github.com/embark-framework/embark-plasma) 4. `transactions`: Array of transactions that occurred on the child chain for the `account.address`. 5. `utxos`: UTXOs that exist on the child chain for the `account.address`. -An example configuration in `config/blockchain.js` would look like: -``` -module.exports = { - //... - rinkeby: { - networkType: "rinkeby", - syncMode: "light", - networkId: 4, - accounts: [ - { - nodeAccounts: true, - password: "config/testnet/password" - }, - { - mnemonic: "MNEMONIC GOES HERE", - addressIndex: "0", // Optional. The index to start getting the address - numAddresses: "1", // Optional. The number of addresses to get - hdpath: "m/44'/60'/0'/0/", // Optional. HD derivation path - } - ] - } - //... -} -``` - -### Init -Initialises the root and child chains and sets up web3. This is already done for us in the context of Embark, however we can re-initialise the plugin using the `--force` param if needed. -``` -# plasma init [--force] -plasma init -``` - -### Status -Gets the status of the child chain. -``` -# plasma status -plasma status - -Example output: -{ byzantine_events: - [ - { details: [Object], event: 'unchallenged_exit' }, - { details: [Object], event: 'unchallenged_exit' }, - { details: [Object], event: 'invalid_exit' }, - { details: [Object], event: 'invalid_exit' } - ], - contract_addr: '0x740ecec4c0ee99c285945de8b44e9f5bfb71eea7', - eth_syncing: false, - in_flight_exits: [], - last_mined_child_block_number: 247000, - last_mined_child_block_timestamp: 1560740479, - last_seen_eth_block_number: 4574127, - last_seen_eth_block_timestamp: 1560741679, - last_validated_child_block_number: 239000, - last_validated_child_block_timestamp: 1560431021, - services_synced_heights: - [ - { height: 4553417, service: 'block_getter' }, - { height: 4574114, service: 'challenges_responds_processor' }, - { height: 4574114, service: 'competitor_processor' }, - { height: 4574116, service: 'convenience_deposit_processor' }, - { height: 4553417, service: 'convenience_exit_processor' }, - { height: 4574116, service: 'depositor' }, - { height: 4574114, service: 'exit_challenger' }, - { height: 4553417, service: 'exit_finalizer' }, - { height: 4574114, service: 'exit_processor' }, - { height: 4553417, service: 'ife_exit_finalizer' }, - { height: 4574114, service: 'in_flight_exit_processor' }, - { height: 4574114, service: 'piggyback_challenges_processor' }, - { height: 4574114, service: 'piggyback_processor' }, - { height: 4574126, service: 'root_chain_height' } - ] -} -``` - -### Deposit -Deposits wei from the root chain (Rinkeby) to the child chain by sending funds to the Plasma contract on Rinkeby -``` -# plasma deposit [amount] -plasma deposit 10000 -``` - -### Transfer -Transfers wei from the main child chain account to any other account on Rinkeby. -``` -# plasma transfer [to_address] [amount] -plasma transfer 0xcc9581513771666c47b5f664024B2f47d5C08bD3 100 -``` - -### Exit -Exits all UTXO's from the child chain to the root chain for a particular address. Note that exits are subject to the minimum finalisation period (current 7 days). Please see the [`elixir-omg` documentation for more information](https://github.com/omisego/elixir-omg/blob/master/docs/morevp.md#morevp-exit-protocol-specification). -``` -# plasma exit [child_chain_address] -plasma exit 0xcc9581513771666c47b5f664024B2f47d5C08bD3 -``` - -## EmbarkJS-Plasma -This project depends on [`embarkjs-plasma`]() which extends EmbarkJS and makes convenience commands available to the DApp in the browser. - ## Example DApp The [`embark-plasma-demo`](https://github.com/embark-framework/embark-plasma-demo) is an example DApp using this plugin. It is based on the OMG [`js-starter-kit`](https://github.com/omisego/js-starter-kit), but instead uses `EmbarkJS.Plasma` for all its functionality.