Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding a contract to store minimum required client version #1081

Merged
merged 21 commits into from
Oct 8, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions packages/protocol/contracts/governance/BlockchainParams.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
pragma solidity ^0.5.3;

import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
import "../common/Initializable.sol";

/**
* @title Contract for storing blockchain parameters that can be set by governance.
*/
contract BlockchainParams is Ownable, Initializable {
mrsmkl marked this conversation as resolved.
Show resolved Hide resolved

string public minimumClientVersion;
mrsmkl marked this conversation as resolved.
Show resolved Hide resolved

event MinimumClientVersionSet(string minimumClientVersion);

/**
* @notice Initializes critical variables.
* @param _minimumClientVersion Minimum client version that can be used in the chain.
*/
function initialize(string calldata _minimumClientVersion) external initializer {
_transferOwnership(msg.sender);
setMinimumClientVersion(_minimumClientVersion);
}

/**
* @notice Sets the minimum client version.
* @param _minimumClientVersion Minimum client version that can be used in the chain.
*/
function setMinimumClientVersion(string memory _minimumClientVersion) public onlyOwner {
require(bytes(_minimumClientVersion).length > 0, "Minimum client version cannot be empty string");
minimumClientVersion = _minimumClientVersion;
emit MinimumClientVersionSet(_minimumClientVersion);
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pragma solidity ^0.5.3;

import "../../common/Proxy.sol";

/* solhint-disable no-empty-blocks */
contract BlockchainParamsProxy is Proxy {
}
5 changes: 3 additions & 2 deletions packages/protocol/lib/proxy-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@ import Web3 = require('web3')

import { ProxyInstance } from 'types'

export function setAndInitializeImplementation(
export async function setAndInitializeImplementation(
web3: Web3,
proxy: ProxyInstance,
implementationAddress: string,
initializerAbi: any,
...args: any[]
) {
const callData = web3.eth.abi.encodeFunctionCall(initializerAbi, args)
return proxy._setAndInitializeImplementation(implementationAddress, callData as any)
const res = await proxy._setAndInitializeImplementation(implementationAddress, callData as any)
mrsmkl marked this conversation as resolved.
Show resolved Hide resolved
return res
}
2 changes: 2 additions & 0 deletions packages/protocol/lib/registry-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export enum CeloContractName {
SortedOracles = 'SortedOracles',
StableToken = 'StableToken',
Validators = 'Validators',
BlockchainParams = 'BlockchainParams',
}

// TODO(amy): Pull this list from the build artifacts instead
Expand All @@ -33,4 +34,5 @@ export const hasEntryInRegistry: string[] = [
CeloContractName.StableToken,
CeloContractName.Random,
CeloContractName.Reserve,
CeloContractName.BlockchainParams,
]
15 changes: 15 additions & 0 deletions packages/protocol/migrations/15_blockchainparams.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { CeloContractName } from '@celo/protocol/lib/registry-utils'
import { deploymentForCoreContract } from '@celo/protocol/lib/web3-utils'
import { BlockchainParamsInstance } from 'types'
import { config } from '@celo/protocol/migrationsConfig'

const initializeArgs = async (_: string): Promise<any[]> => {
return [config.blockchainParams.minimumClientVersion]
}

module.exports = deploymentForCoreContract<BlockchainParamsInstance>(
m-chrzan marked this conversation as resolved.
Show resolved Hide resolved
web3,
artifacts,
CeloContractName.BlockchainParams,
initializeArgs
)
3 changes: 3 additions & 0 deletions packages/protocol/migrationsConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ const DefaultConfig = {
groupName: 'C-Labs',
groupUrl: 'https://www.celo.org',
},
blockchainParams: {
minimumClientVersion: '1.8.23',
},
}

const linkedLibraries = {
Expand Down
5 changes: 0 additions & 5 deletions packages/protocol/test/common/linkedlist.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
import { assertRevert } from '@celo/protocol/lib/test-utils'
// import BigNumber from 'bignumber.js'
import { LinkedListTestContract, LinkedListTestInstance } from 'types'

const LinkedListTest: LinkedListTestContract = artifacts.require('LinkedListTest')

// @ts-ignore
// TODO(mcortesi): Use BN
LinkedListTest.numberFormat = 'BigNumber'
mrsmkl marked this conversation as resolved.
Show resolved Hide resolved

contract('LinkedListTest', () => {
let linkedListTest: LinkedListTestInstance

Expand Down
19 changes: 19 additions & 0 deletions packages/protocol/test/governance/blockchainparams.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { BlockchainParamsContract, BlockchainParamsInstance } from 'types'

const BlockchainParamsTest: BlockchainParamsContract = artifacts.require('BlockchainParams')

contract('BlockchainParams', () => {
let blockchainParamsTest: BlockchainParamsInstance
const version = '1.8.4'

beforeEach(async () => {
blockchainParamsTest = await BlockchainParamsTest.new()
})

describe('#setMinimumClientVersion()', () => {
m-chrzan marked this conversation as resolved.
Show resolved Hide resolved
it('should set the variable', async () => {
await blockchainParamsTest.setMinimumClientVersion(version)
assert.equal(version, await blockchainParamsTest.minimumClientVersion())
})
})
})