Create a MicroChain¶

DAPP Developer can create a MicroChain and running his DAPP on the MicroChain. He need to deposit enough MOAC in the MicroChain to reward the SCSs running the MicroChain.

Vnode Pool¶

VNODE pool contract, VnodeProtocolBase, is to setup a pool for VNODE servers to provide service to MicroChains. You can join existing VNODE pools that published by certified groups.

For each VNODE join a pool, VNODE need to deposit the minimum moac to the contract to register. If VNODE service is broken due to bad behavior or bad internet connection, these deposit will be deducted. If the VNODE server didn’t have enough deposit, then it will be moved out of the pool.

This is an example to deploy the VNODE pool with a Contract requiring 2 moac as minimum deposit:

> chain3 = require('chain3')
> solc = require('solc')
> chain3 = new chain3();
> chain3.setProvider(new chain3.providers.HttpProvider('http://localhost:8545'));
> solfile = 'VnodeProtocolBase.sol';
> contract = fs.readFileSync(solfile, 'utf8');
> output = solc.compile(contract, 1);
> abi = output.contracts[':VnodeProtocolBase'].interface;
> bin = output.contracts[':VnodeProtocolBase'].bytecode;
> VnodeProtocolBaseContract = chain3.mc.contract(JSON.parse(abi));
> chain3.personal.unlockAccount(chain3.mc.accounts[0], '123456');
> VnodeProtocolBase = VnodeProtocolBaseContract.new( 2, { from: chain3.mc.accounts[0],  data: '0x' + bin,  gas: '5000000'});
> chain3.mc.getTransactionReceipt(VnodeProtocolBase.transactionHash).contractAddress

The contract address will be generated after creation: 0x22f141dcc59850707708bc90e256318a5fe0b928

Note: gas limit should be less than the block limit 9,000,000, otherwise it will generate the error “exceeds block gas limit undefined”.

Add VNODE to pool¶

修改vnode目录配置文件vnodeconfig.json: VnodeBeneficialAddress里设置收益账号： 0xf103bc1c054babcecd13e7ac1cf34f029647b08c

这个账号也作为vnode的address，矿池中对应这个vnode的唯一编号

调用vnode矿池合约register方法加入矿池

Parameters:

from： 子链测试账号
value：押金，必须大于矿池合约的设置值
to: vnode矿池合约地址
data: register(address,string)

关于data传递调用register参数说明:

根据ABI chain3.sha3("register(address,string)") = 0x32434a2e90725ed590daff07a244305001c58c49f7bef73ce5e7249acf69f561
        取前4个字节 0x32434a2e
第一个参数address 传  vnodeconfig.json的VnodeBeneficialAddress  （前面补24个0， 凑足32个字节）
        000000000000000000000000f103bc1c054babcecd13e7ac1cf34f029647b08c
第二个参数string传 vnode提供给子链的调用地址 192.168.10.209:50062
端口号对应vnodeconfig.json的VnodeServiceCfg
        string数据类型 + string数据长度 + string内容
        string数据类型： 0000000000000000000000000000000000000000000000000000000000000040
        string内容： data = new Buffer('192.168.10.209:50062', 'utf8').toString('hex');
                后面补0， 凑足32个字节   3139322e3136382e31302e3230393a3530303632000000000000000000000000
        string数据长度:     3139322e3136382e31302e3230393a3530303632        20字节
                0000000000000000000000000000000000000000000000000000000000000014
        data = '0x32434a2e000000000000000000000000f103bc1c054babcecd13e7ac1cf34f029647b08c000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000143139322e3136382e31302e3230393a3530303632000000000000000000000000'

Example:

> amount = chain3.toSha(5,'mc')
> data = '0x32434a2e000000000000000000000000f103bc1c054babcecd13e7ac1cf34f029647b08c000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000143139322e3136382e31302e3230393a3530303632000000000000000000000000';
> chain3.personal.unlockAccount(chain3.mc.accounts[0], '123456');
> chain3.mc.sendTransaction({ from: chain3.mc.accounts[0], value:amount, to: '0x22f141dcc59850707708bc90e256318a5fe0b928', gas: "5000000", gasPrice: chain3.mc.gasPrice, data: data });

验证：访问Vnode矿池合约的vnodeCount

> chain3.mc.getStorageAt("0x22f141dcc59850707708bc90e256318a5fe0b928",0x02)   // 注意vnodeCount变量在合约中变量定义的位置（16进制）

SCS Pool¶

目前针对不同的共识协议，可以创建对应的子链矿池，接受对应SCS的注册，并缴纳保证金，进入矿池后，成为子链的候选节点

如果加入现成的子链矿池，则可以忽略此步骤

部署SubChainProtocolBase.sol示例: 共识:POR 最低保证金: 2moac

> chain3 = require('chain3')
> solc = require('solc')
> chain3 = new chain3();
> chain3.setProvider(new chain3.providers.HttpProvider('http://localhost:8545'));
> solfile = 'SubChainProtocolBase.sol';
> contract = fs.readFileSync(solfile, 'utf8');
> output = solc.compile(contract, 1);
> abi = output.contracts[':SubChainProtocolBase'].interface;
> bin = output.contracts[':SubChainProtocolBase'].bytecode;
> subchainprotocolbaseContract = chain3.mc.contract(JSON.parse(abi));
> chain3.personal.unlockAccount(chain3.mc.accounts[0], '123456');
> subchainprotocolbase = subchainprotocolbaseContract.new( "POR",  2, { from: chain3.mc.accounts[0],  data: '0x' + bin,  gas: '5000000'});
> chain3.mc.getTransactionReceipt(subchainprotocolbase.transactionHash).contractAddress

部署完毕后，获得子链矿池合约地址 0xe42f4f566aedc3b6dd61ea4f70cc78d396130fac

Start SCSs¶

这里我们设置两个scs节点

确认 userconfig.json配置

VnodeServiceCfg为代理vnode地址: 192.168.10.209:50062
Beneficiary为收益账号:
        0xa934198916cd993c73c1aa6e0c0e7b21ce7c735b
        0x2e7c076dbf6e61207a0ddb1b942ef7da8fd139f0

分别通过命令启动 scsserver-windows-4.0-amd64 –password “123456” （生成scs keystore的密码）

然后在生成的keystore文件中分别获得 scs 地址

d4057328a35f34507dbcd295d43ed0cccf9c368a
0x3e21ba36b396936c6cc9adc3674655b912e5fa54

最后给scs转入moac以支付必要的交易费用

> amount = 20;
> scsaddr = '0xd4057328a35f34507dbcd295d43ed0cccf9c368a';
> chain3.personal.unlockAccount(chain3.mc.accounts[0], '123456');
> chain3.mc.sendTransaction( { from: chain3.mc.accounts[0], value:chain3.toSha(amount,'mc'), to: scsaddr, gas: "2000000", gasPrice: chain3.mc.gasPrice, data: ''});
> scsaddr = '0x3e21ba36b396936c6cc9adc3674655b912e5fa54';
> chain3.mc.sendTransaction( { from: chain3.mc.accounts[0], value:chain3.toSha(amount,'mc'), to: scsaddr, gas: "2000000", gasPrice: chain3.mc.gasPrice, data: ''});

Check the balance of the SCS accounts.

> chain3.mc.getBalance('0xd4057328a35f34507dbcd295d43ed0cccf9c368a')
> chain3.mc.getBalance('0x3e21ba36b396936c6cc9adc3674655b912e5fa54')

Add SCSs to Pool¶

Call SubchainProtocolBase.sol’s register function to join the pool

Parameters:

from： 子链测试账号
value：押金，必须大于矿池合约的设置值
to: 子链矿池合约地址
data: register(address)

关于data传递调用register参数说明:

根据ABI chain3.sha3("register(address)") = 0x4420e4869750c98a56ac621854d2d00e598698ac87193cdfcbb6ed1164e9cbcd
        取前4个字节 0x4420e486
参数address传scs 地址    d4057328a35f34507dbcd295d43ed0cccf9c368a  （前面补24个0， 凑足32个字节）
        000000000000000000000000d4057328a35f34507dbcd295d43ed0cccf9c368a
data = '0x4420e486000000000000000000000000d4057328a35f34507dbcd295d43ed0cccf9c368a'

Example:

> amount = chain3.toSha(5,'mc')
> data = '0x4420e486000000000000000000000000d4057328a35f34507dbcd295d43ed0cccf9c368a';
> chain3.mc.sendTransaction({ from: chain3.mc.accounts[0], value:amount, to: '0xe42f4f566aedc3b6dd61ea4f70cc78d396130fac', gas: "5000000", gasPrice: chain3.mc.gasPrice, data: data });

验证：访问子链矿池合约的scsCount

> chain3.mc.getStorageAt("0xe42f4f566aedc3b6dd61ea4f70cc78d396130fac",0x02)     // 注意scsCount变量在合约中变量定义的位置（16进制）

同上将另一个scs（0x3e21ba36b396936c6cc9adc3674655b912e5fa54）也加入子链矿池

Deploy MicroChain Contract¶

subchainbase is the contract for the DAPP developers to form the MicroChain. It provides the MicroChain launch and running methods.

The parameters are as following:

proto：subchainprotocolbase contract address, obtain from MOAC team;
vnodeProtocolBaseAddr：vnodeprotocolbase contract address，obtain from MOAC team；
min：min SCSs required to launch MicroChain, can only be 3,5,7;
max：max SCS can be used in the MicroChain, can only be 11，21，31，51，99;
thousandth：default is 1;
flushRound：MicroChain flush interval between MotherChain blocks, the number should between 40 and 99;
The gas limit need set to larger than 7000000 for deploying, suggest using 9000000.

Example commands of deploying SubChainBase.sol:

> chain3 = require('chain3')
> solc = require('solc')
> chain3 = new chain3();
> chain3.setProvider(new chain3.providers.HttpProvider('http://localhost:8545'));
> input = {'': fs.readFileSync('SubChainBase.sol', 'utf8'), 'SubChainProtocolBase.sol': fs.readFileSync('SubChainProtocolBase.sol', 'utf8')};
> output = solc.compile({sources: input}, 1);
> abi = output.contracts[':SubChainBase'].interface;
> bin = output.contracts[':SubChainBase'].bytecode;
> proto = '0xe42f4f566aedc3b6dd61ea4f70cc78d396130fac' ;    // SCS pool contract
> vnodeProtocolBaseAddr = '0x22f141dcc59850707708bc90e256318a5fe0b928' ;       // Vnode pool contract
> min = 3 ;             // Minimum number of SCSs in the MicroChain，has to be one of：3，5，7
> max = 11;             // 子链需要SCS的最大数量，当前需要从如下值中选择：11，21，31，51，99
> thousandth = 1 ;                      // 千分之几
> flushRound = 40 ;             // 子链刷新周期  单位是主链block生成对应数量的时间，当前的取值范围是40-99
> SubChainBaseContract = chain3.mc.contract(JSON.parse(abi));
> chain3.personal.unlockAccount(chain3.mc.accounts[0], '123456');
> SubChainBase = SubChainBaseContract.new( proto, vnodeProtocolBaseAddr, min, max, thousandth, flushRound,{ from: chain3.mc.accounts[0],  data: '0x' + bin,  gas:'9000000'} , function (e, contract){console.log('Contract address: ' + contract.address + ' transactionHash: ' + contract.transactionHash); });

If deployed successful, a contract address will be generated, like: 0x1195cd9769692a69220312e95192e0dcb6a4ec09

RegisterOpen：¶

RegisterOpen step is doing the following tasks:

Dapp developer call this function on MotherChain to start the MicroChain；
MotherChain broadcast the call to all the VNODES. If the VNODE contains a valid SCS, it will wait for the selection signal；
If SCS receives a selection signal, it need to send a transaction to the MicroChain contract to finish the registeration (This is why SCS need to have some initial MOAC deposit).
MicroChain will collect the confirmations undtil it reaches the max limit as defined in the contract.

The MicroChain chooses in the SCS pool to form the microChain validators. By default, this process is random. The microChain creator can also change the selection process and only allow specific SCSs to join.

Before doing RegisterOpen, Developer need to deposit enough fund to the Microchain so it can send MotherChain transactions.

::: In ABI chain3.sha3(“addFund()”) = 0xa2f09dfa891d1ba530cdf00c7c12ddd9f6e625e5368fff9cdf23c9dc0ad433b1 Use the first 4 bytes: 0xa2f09dfa > amount = 20; > subchainaddr = ‘0x1195cd9769692a69220312e95192e0dcb6a4ec09’; > chain3.personal.unlockAccount(chain3.mc.accounts[0], ‘123456’); > chain3.mc.sendTransaction( { from: chain3.mc.accounts[0], value:chain3.toSha(amount,’mc’), to: subchainaddr, gas: “2000000”, gasPrice: chain3.mc.gasPrice, data: ‘0xa2f09dfa’});

The balance of MicroChain can be checked:

> chain3.mc.getBalance('0x1195cd9769692a69220312e95192e0dcb6a4ec09')

Then call the MicroChain registerOpen function to register the SCSs:

::: In ABI chain3.sha3(“registerOpen()”) = 0x5defc56ce78f178d760a165a5528a8e8974797e616a493970df1c0918c13a175 Use the first 4 bytes: 0x5defc56c > subchainaddr = ‘0x1195cd9769692a69220312e95192e0dcb6a4ec09’; > chain3.personal.unlockAccount(chain3.mc.accounts[0], ‘123456’); > chain3.mc.sendTransaction( { from: chain3.mc.accounts[0], value:0, to: subchainaddr, gas: “2000000”, gasPrice: chain3.mc.gasPrice, data: ‘0x5defc56c’});

Comments:

dappAddr、dappPasswd：Dapp Developer account and password to make the call；
subchainAddr: subchainbase contract address;
data：In sendtx, ‘0x5defc56c’ is a constant to send with. It was generate from the first 4 bytes in the hash of registerOpen() function.

After registerOpen is called，DAPP developer need to wait for a VNODE block generated. Then he can use the following methods to check how many SCS nodes registed in the MicroChain:

Method 1：

In the Console, check after call RegisterOpern in subchainBase:

This is to call the nodeCount function in subchainBase contract.

> subchainBase.nodeCount()

Method 2:

In the Console, call the subchain address to check the value of nodeCount (‘0x0e’):

> mc.getStorageAt(subchainaddr,0x14)
> mc.getStorageAt(subchainAddr,0x0e)

When enough SCS nodes registerd in the MicroChain, continue to next Step: RegisterClose().

RegisterClose¶

RegisterClose is doing the following tasks:

Dapp developer call the RegisterClose function;
The contract checks if the number of SCS registered is larger than the min number required in the MicroChain contract. If yes, continue. Otherwise, the register is void;
The contract is broacast to all the VNODEs and SCSs that the registration is closed;
The registered SCSs receive this broachasting, init the MicroChain and start generating MicroChain blocks.

After RegisterClose，SCSs cannot register through the MicroChain contract. The SCSs registered can participate as the MicroChain miner and get rewards from the MicroChain owner.

Besure to have enough SCS nodes registered befor calling Registerclose. Otherwise you need to start the Registeropen process again.

::: In ABI chain3.sha3(“registerClose()”) = 0x69f3576fc10c82561bd84b0045ee48d80d59a866174f2513fdef43d65702bf70 Use the first 4 bytes: 0x69f3576f > subchainaddr = ‘0x1195cd9769692a69220312e95192e0dcb6a4ec09’; > chain3.personal.unlockAccount(chain3.mc.accounts[0], ‘123456’); > chain3.mc.sendTransaction( { from: chain3.mc.accounts[0], value:0, to: subchainaddr, gas: “2000000”, gasPrice: chain3.mc.gasPrice, data: ‘0x69f3576f’});

Comments:

dappAddr、dappPasswd：Dapp developer account and password to send the TX;
subchainAddr：MicroChain contract subchainbase address;
‘0x69f3576f’: constant, generated from the subchainbase registerClose() function by using Keccak256 hash.

To check, can call the subchainbase contract if registerFlag = 0 (after nuwa 1.0.7 version): > chain3.mc.getStorageAt(subchainaddr,0x14) // 注意registerFlag变量在合约中变量定义的位置（16进制）

Now the MicroChain should be formed and SCS can output information about the MicroChain. You can check the status of the MicroChain by connect with the SCS rpc port:

chain3.setScsProvider(new chain3.providers.HttpProvider('http://localhost:8548'));

// List the SCS server ID
console.log("SCS ID:", chain3.scs.getSCSId());

// List the microChain running on the SCS server
mclist = chain3.scs.getMicroChainList();
console.log("SCS MicroChain List:", mclist);