From 2e3562d08c384422beeb70d9dcfc8b82a4c4636f Mon Sep 17 00:00:00 2001 From: Adrian Hetman Date: Thu, 27 Sep 2018 15:35:21 +0200 Subject: [PATCH 01/18] Added docs for the Solidity code --- .../contracts/truffle/docs/BalanceContract.md | 72 +++ client/contracts/truffle/docs/CappedToken.md | 75 +++ client/contracts/truffle/docs/Consensus.md | 55 ++ .../contracts/truffle/docs/ConsensusMock.md | 62 +++ .../contracts/truffle/docs/DomainResolver.md | 59 ++ .../truffle/docs/DomainResolverMock.md | 62 +++ client/contracts/truffle/docs/ExchangeMgr.md | 262 +++++++++ .../contracts/truffle/docs/FIFSRegistrar.md | 97 ++++ .../contracts/truffle/docs/Initializable.md | 72 +++ client/contracts/truffle/docs/KNS.md | 149 +++++ client/contracts/truffle/docs/KNSRegistry.md | 231 ++++++++ .../contracts/truffle/docs/KNSRegistryV1.md | 237 ++++++++ client/contracts/truffle/docs/KRC223.md | 148 +++++ client/contracts/truffle/docs/Math.md | 101 ++++ client/contracts/truffle/docs/Migrations.md | 90 +++ client/contracts/truffle/docs/MiningToken.md | 79 +++ .../contracts/truffle/docs/MintableToken.md | 107 ++++ .../contracts/truffle/docs/MultiSigWallet.md | 511 ++++++++++++++++++ client/contracts/truffle/docs/NameHash.md | 59 ++ client/contracts/truffle/docs/OracleMgr.md | 290 ++++++++++ client/contracts/truffle/docs/Ownable.md | 116 ++++ client/contracts/truffle/docs/Pausable.md | 108 ++++ .../contracts/truffle/docs/PriceProvider.md | 49 ++ .../contracts/truffle/docs/PublicResolver.md | 373 +++++++++++++ client/contracts/truffle/docs/SafeMath.md | 109 ++++ client/contracts/truffle/docs/Stability.md | 182 +++++++ client/contracts/truffle/docs/SystemVars.md | 139 +++++ client/contracts/truffle/docs/Token.md | 212 ++++++++ client/contracts/truffle/docs/TokenMock.md | 151 ++++++ .../contracts/truffle/docs/TokenReceiver.md | 56 ++ client/contracts/truffle/docs/ValidatorMgr.md | 405 ++++++++++++++ client/contracts/truffle/docs/strings.md | 497 +++++++++++++++++ 32 files changed, 5215 insertions(+) create mode 100644 client/contracts/truffle/docs/BalanceContract.md create mode 100644 client/contracts/truffle/docs/CappedToken.md create mode 100644 client/contracts/truffle/docs/Consensus.md create mode 100644 client/contracts/truffle/docs/ConsensusMock.md create mode 100644 client/contracts/truffle/docs/DomainResolver.md create mode 100644 client/contracts/truffle/docs/DomainResolverMock.md create mode 100644 client/contracts/truffle/docs/ExchangeMgr.md create mode 100644 client/contracts/truffle/docs/FIFSRegistrar.md create mode 100644 client/contracts/truffle/docs/Initializable.md create mode 100644 client/contracts/truffle/docs/KNS.md create mode 100644 client/contracts/truffle/docs/KNSRegistry.md create mode 100644 client/contracts/truffle/docs/KNSRegistryV1.md create mode 100644 client/contracts/truffle/docs/KRC223.md create mode 100644 client/contracts/truffle/docs/Math.md create mode 100644 client/contracts/truffle/docs/Migrations.md create mode 100644 client/contracts/truffle/docs/MiningToken.md create mode 100644 client/contracts/truffle/docs/MintableToken.md create mode 100644 client/contracts/truffle/docs/MultiSigWallet.md create mode 100644 client/contracts/truffle/docs/NameHash.md create mode 100644 client/contracts/truffle/docs/OracleMgr.md create mode 100644 client/contracts/truffle/docs/Ownable.md create mode 100644 client/contracts/truffle/docs/Pausable.md create mode 100644 client/contracts/truffle/docs/PriceProvider.md create mode 100644 client/contracts/truffle/docs/PublicResolver.md create mode 100644 client/contracts/truffle/docs/SafeMath.md create mode 100644 client/contracts/truffle/docs/Stability.md create mode 100644 client/contracts/truffle/docs/SystemVars.md create mode 100644 client/contracts/truffle/docs/Token.md create mode 100644 client/contracts/truffle/docs/TokenMock.md create mode 100644 client/contracts/truffle/docs/TokenReceiver.md create mode 100644 client/contracts/truffle/docs/ValidatorMgr.md create mode 100644 client/contracts/truffle/docs/strings.md diff --git a/client/contracts/truffle/docs/BalanceContract.md b/client/contracts/truffle/docs/BalanceContract.md new file mode 100644 index 000000000..e18e355c0 --- /dev/null +++ b/client/contracts/truffle/docs/BalanceContract.md @@ -0,0 +1,72 @@ +# BalanceContract.sol + +**contract BalanceContract is [TokenReceiver](TokenReceiver.md)** + +**BalanceContract** + +## Contract Members +**Constants & Variables** + +```js +//internal members +address internal owner; +bytes internal data; +//public members +address public from; +uint256 public value; +``` + +## Functions + +- [tokenFallback](#tokenfallback) + +### tokenFallback + +:small_red_triangle: overrides [TokenReceiver.tokenFallback](TokenReceiver.md#tokenfallback) + +```js +function tokenFallback(address _from, uint256 _value, bytes _data) public +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _from | address | | +| _value | uint256 | | +| _data | bytes | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/CappedToken.md b/client/contracts/truffle/docs/CappedToken.md new file mode 100644 index 000000000..ce048e638 --- /dev/null +++ b/client/contracts/truffle/docs/CappedToken.md @@ -0,0 +1,75 @@ +# Capped token (CappedToken.sol) + +**contract CappedToken is [MintableToken](MintableToken.md)** + +**CappedToken** + +Mintable token with a token cap. + +## Contract Members +**Constants & Variables** + +```js +uint256 public cap; +``` + +## Functions + +- [mint](#mint) + +### mint + +:small_red_triangle: overrides [MintableToken.mint](MintableToken.md#mint) + +Function to mint tokens + +```js +function mint(address _to, uint256 _amount) public onlyOwner canMint +returns(bool) +``` + +**Returns** + +A boolean that indicates if the operation was successful. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | The address that will receive the minted tokens. | +| _amount | uint256 | The amount of tokens to mint. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/Consensus.md b/client/contracts/truffle/docs/Consensus.md new file mode 100644 index 000000000..896fd46c8 --- /dev/null +++ b/client/contracts/truffle/docs/Consensus.md @@ -0,0 +1,55 @@ +# Consensus.sol + +**Consensus** + +## Functions + +- [isSuperNode](#issupernode) + +### isSuperNode + +```js +function isSuperNode(address identity) public view +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/ConsensusMock.md b/client/contracts/truffle/docs/ConsensusMock.md new file mode 100644 index 000000000..dff40000a --- /dev/null +++ b/client/contracts/truffle/docs/ConsensusMock.md @@ -0,0 +1,62 @@ +# ConsensusMock.sol + +**ConsensusMock** + +## Contract Members +**Constants & Variables** + +```js +bool internal superNode; +``` + +## Functions + +- [isSuperNode](#issupernode) + +### isSuperNode + +```js +function isSuperNode(address identity) public view +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/DomainResolver.md b/client/contracts/truffle/docs/DomainResolver.md new file mode 100644 index 000000000..d9e319c46 --- /dev/null +++ b/client/contracts/truffle/docs/DomainResolver.md @@ -0,0 +1,59 @@ +# DomainResolver.sol + +**DomainResolver** + +## Functions + +- [addr](#addr) + +### addr + +```js +function addr(bytes32 node) public view +returns(address) +``` + +**Returns** + +The associated address. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/DomainResolverMock.md b/client/contracts/truffle/docs/DomainResolverMock.md new file mode 100644 index 000000000..9085a1a8b --- /dev/null +++ b/client/contracts/truffle/docs/DomainResolverMock.md @@ -0,0 +1,62 @@ +# DomainResolverMock.sol + +**DomainResolverMock** + +## Contract Members +**Constants & Variables** + +```js +address internal domainAddr; +``` + +## Functions + +- [addr](#addr) + +### addr + +```js +function addr(bytes32 node) public view +returns(address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/ExchangeMgr.md b/client/contracts/truffle/docs/ExchangeMgr.md new file mode 100644 index 000000000..6ae28fb2d --- /dev/null +++ b/client/contracts/truffle/docs/ExchangeMgr.md @@ -0,0 +1,262 @@ +# Exchange Manager contract (ExchangeMgr.sol) + +**contract ExchangeMgr is [Pausable](Pausable.md), [Initializable](Initializable.md)** + +**ExchangeMgr** + +## Structs +### Exchange + +```js +struct Exchange { + uint256 index, + bool isExchange, + bool isWhitelisted +} +``` + +## Contract Members +**Constants & Variables** + +```js +//private members +mapping(string => struct ExchangeMgr.Exchange) private exchangeRegistry; +//public members +string[] public whitelist; +``` + +**Events** + +```js +event Whitelisted(string exchange); +event Blacklisted(string exchange); +event Addition(string exchange); +event Removal(string exchange); +``` + +## Modifiers + +- [onlyNewCandidate](#onlynewcandidate) +- [onlyExchange](#onlyexchange) +- [onlyWhitelistedExchange](#onlywhitelistedexchange) +- [onlyBlacklistedExchange](#onlyblacklistedexchange) + +### onlyNewCandidate + +```js +modifier onlyNewCandidate(string name) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | | + +### onlyExchange + +```js +modifier onlyExchange(string name) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | | + +### onlyWhitelistedExchange + +```js +modifier onlyWhitelistedExchange(string name) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | | + +### onlyBlacklistedExchange + +```js +modifier onlyBlacklistedExchange(string name) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | | + +## Functions + +- [addExchange](#addexchange) +- [removeExchange](#removeexchange) +- [whitelistExchange](#whitelistexchange) +- [blacklistExchange](#blacklistexchange) +- [isExchange](#isexchange) +- [isWhitelistedExchange](#iswhitelistedexchange) +- [isBlacklistedExchange](#isblacklistedexchange) +- [getWhitelistedExchangeCount](#getwhitelistedexchangecount) +- [getWhitelistedExchangeAtIndex](#getwhitelistedexchangeatindex) + +### addExchange + +Adds and whitelists an exchange. + +```js +function addExchange(string name) public whenNotPaused onlyOwner onlyNewCandidate +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### removeExchange + +Removes an exchange. + +```js +function removeExchange(string name) public whenNotPaused onlyOwner onlyExchange +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### whitelistExchange + +Whitelists an exchange. + +```js +function whitelistExchange(string name) public whenNotPaused onlyOwner onlyBlacklistedExchange +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### blacklistExchange + +Blacklists an exchange. + +```js +function blacklistExchange(string name) public whenNotPaused onlyOwner onlyWhitelistedExchange +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### isExchange + +checks whether the given name is an whitelisted exchange or not + +```js +function isExchange(string name) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### isWhitelistedExchange + +checks whether the given name is an whitelisted exchange or not + +```js +function isWhitelistedExchange(string name) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### isBlacklistedExchange + +checks whether the given name is a blacklisted exchange or not + +```js +function isBlacklistedExchange(string name) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### getWhitelistedExchangeCount + +get whitelisted exchange count + +```js +function getWhitelistedExchangeCount() public view +returns(count uint256) +``` + +### getWhitelistedExchangeAtIndex + +get whitelisted exchange information + +```js +function getWhitelistedExchangeAtIndex(uint256 index) public view +returns(name string) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of a given exchange in the whitelist | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/FIFSRegistrar.md b/client/contracts/truffle/docs/FIFSRegistrar.md new file mode 100644 index 000000000..71386c378 --- /dev/null +++ b/client/contracts/truffle/docs/FIFSRegistrar.md @@ -0,0 +1,97 @@ +# FIFSRegistrar.sol + +**contract FIFSRegistrar is [Initializable](Initializable.md)** + +**FIFSRegistrar** + +## Contract Members +**Constants & Variables** + +```js +contract KNS internal kns; +bytes32 internal rootNode; +``` + +## Modifiers + +- [only_owner](#only_owner) + +### only_owner + +```js +modifier only_owner(bytes32 subnode) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| subnode | bytes32 | | + +## Functions + +- [initialize](#initialize) +- [register](#register) + +### initialize + +initialize function for Proxy Pattern. + +```js +function initialize(KNS knsAddr, bytes32 node) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| knsAddr | KNS | The address of the KNS registry. | +| node | bytes32 | The node that this registrar administers. | + +### register + +```js +function register(bytes32 subnode, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| subnode | bytes32 | The hash of the label to register. | +| owner | address | The address of the new owner. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/Initializable.md b/client/contracts/truffle/docs/Initializable.md new file mode 100644 index 000000000..435e308d7 --- /dev/null +++ b/client/contracts/truffle/docs/Initializable.md @@ -0,0 +1,72 @@ +# Initializable (Initializable.sol) + +**Initializable** + +Simple helper contract to support initialization outside of the constructor. +To use it, replace the constructor with a function that has the +`isInitializer` modifier. +WARNING: This helper does not support multiple inheritance. +WARNING: It is the developer's responsibility to ensure that an initializer +is actually called. +Use `Migratable` for more complex migration mechanisms. + +## Contract Members +**Constants & Variables** + +```js +bool public initialized; +``` + +## Modifiers + +- [isInitializer](#isinitializer) + +### isInitializer + +Modifier to use in the initialization function of a contract. + +```js +modifier isInitializer() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/KNS.md b/client/contracts/truffle/docs/KNS.md new file mode 100644 index 000000000..7bb35e3cd --- /dev/null +++ b/client/contracts/truffle/docs/KNS.md @@ -0,0 +1,149 @@ +# KNS.sol + +**KNS** + +**Events** + +```js +event NewOwner(bytes32 indexed node, bytes32 indexed label, address owner); +event Transfer(bytes32 indexed node, address owner); +event NewResolver(bytes32 indexed node, address resolver); +event NewTTL(bytes32 indexed node, uint64 ttl); +``` + +## Functions + +- [setSubnodeOwner](#setsubnodeowner) +- [setResolver](#setresolver) +- [setOwner](#setowner) +- [setTTL](#setttl) +- [owner](#owner) +- [resolver](#resolver) +- [ttl](#ttl) + +### setSubnodeOwner + +```js +function setSubnodeOwner(bytes32 node, bytes32 label, address owner) external +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | +| label | bytes32 | | +| owner | address | | + +### setResolver + +```js +function setResolver(bytes32 node, address resolver) external +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | +| resolver | address | | + +### setOwner + +```js +function setOwner(bytes32 node, address owner) external +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | +| owner | address | | + +### setTTL + +```js +function setTTL(bytes32 node, uint64 ttl) external +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | +| ttl | uint64 | | + +### owner + +```js +function owner(bytes32 node) external view +returns(address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +### resolver + +```js +function resolver(bytes32 node) external view +returns(address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +### ttl + +```js +function ttl(bytes32 node) external view +returns(uint64) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/KNSRegistry.md b/client/contracts/truffle/docs/KNSRegistry.md new file mode 100644 index 000000000..65b9cd572 --- /dev/null +++ b/client/contracts/truffle/docs/KNSRegistry.md @@ -0,0 +1,231 @@ +# KNSRegistry.sol + +**contract KNSRegistry is [KNS](KNS.md), [Initializable](Initializable.md)** + +**KNSRegistry** + +## Structs +### Record + +```js +struct Record { + address owner, + address resolver, + uint64 ttl +} +``` + +## Contract Members +**Constants & Variables** + +```js +mapping(bytes32 => struct KNSRegistry.Record) internal records; +``` + +## Modifiers + +- [only_owner](#only_owner) + +### only_owner + +```js +modifier only_owner(bytes32 node) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Functions + +- [initialize](#initialize) +- [setOwner](#setowner) +- [setSubnodeOwner](#setsubnodeowner) +- [setResolver](#setresolver) +- [setTTL](#setttl) +- [owner](#owner) +- [resolver](#resolver) +- [ttl](#ttl) + +### initialize + +initialize function for Proxy Pattern. + +```js +function initialize(address _owner) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _owner | address | address of the root owner | + +### setOwner + +:small_red_triangle: overrides [KNS.setOwner](KNS.md#setowner) + +Transfers ownership of a node to a new address. May only be called by the current owner of the node. + +```js +function setOwner(bytes32 node, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to transfer ownership of. | +| owner | address | The address of the new owner. | + +### setSubnodeOwner + +:small_red_triangle: overrides [KNS.setSubnodeOwner](KNS.md#setsubnodeowner) + +Transfers ownership of a subnode keccak256(node, label) to a new address. May only be called by the owner of the parent node. + +```js +function setSubnodeOwner(bytes32 node, bytes32 label, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The parent node. | +| label | bytes32 | The hash of the label specifying the subnode. | +| owner | address | The address of the new owner. | + +### setResolver + +:small_red_triangle: overrides [KNS.setResolver](KNS.md#setresolver) + +Sets the resolver address for the specified node. + +```js +function setResolver(bytes32 node, address resolver) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| resolver | address | The address of the resolver. | + +### setTTL + +:small_red_triangle: overrides [KNS.setTTL](KNS.md#setttl) + +Sets the TTL for the specified node. + +```js +function setTTL(bytes32 node, uint64 ttl) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| ttl | uint64 | The TTL in seconds. | + +### owner + +:small_red_triangle: overrides [KNS.owner](KNS.md#owner) + +Returns the address that owns the specified node. + +```js +function owner(bytes32 node) public view +returns(address) +``` + +**Returns** + +address of the owner. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +### resolver + +:small_red_triangle: overrides [KNS.resolver](KNS.md#resolver) + +Returns the address of the resolver for the specified node. + +```js +function resolver(bytes32 node) public view +returns(address) +``` + +**Returns** + +address of the resolver. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +### ttl + +:small_red_triangle: overrides [KNS.ttl](KNS.md#ttl) + +Returns the TTL of a node, and any records associated with it. + +```js +function ttl(bytes32 node) public view +returns(uint64) +``` + +**Returns** + +ttl of the node. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/KNSRegistryV1.md b/client/contracts/truffle/docs/KNSRegistryV1.md new file mode 100644 index 000000000..dd65f9bfe --- /dev/null +++ b/client/contracts/truffle/docs/KNSRegistryV1.md @@ -0,0 +1,237 @@ +# KNSRegistryV1.sol + +**contract KNSRegistryV1 is [KNS](KNS.md), [Initializable](Initializable.md)** + +**KNSRegistryV1** + +## Structs +### Record + +```js +struct Record { + address owner, + address resolver, + uint64 ttl +} +``` + +## Contract Members +**Constants & Variables** + +```js +mapping(bytes32 => struct KNSRegistryV1.Record) internal records; +``` + +## Modifiers + +- [only_owner](#only_owner) + +### only_owner + +```js +modifier only_owner(bytes32 node) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Functions + +- [initialize](#initialize) +- [helloProxy](#helloproxy) +- [setOwner](#setowner) +- [setSubnodeOwner](#setsubnodeowner) +- [setResolver](#setresolver) +- [setTTL](#setttl) +- [owner](#owner) +- [resolver](#resolver) +- [ttl](#ttl) + +### initialize + +```js +function initialize(address _owner) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _owner | address | | + +### helloProxy + +```js +function helloProxy() public pure +returns(string) +``` + +### setOwner + +:small_red_triangle: overrides [KNS.setOwner](KNS.md#setowner) + +Transfers ownership of a node to a new address. May only be called by the current owner of the node. + +```js +function setOwner(bytes32 node, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to transfer ownership of. | +| owner | address | The address of the new owner. | + +### setSubnodeOwner + +:small_red_triangle: overrides [KNS.setSubnodeOwner](KNS.md#setsubnodeowner) + +Transfers ownership of a subnode keccak256(node, label) to a new address. May only be called by the owner of the parent node. + +```js +function setSubnodeOwner(bytes32 node, bytes32 label, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The parent node. | +| label | bytes32 | The hash of the label specifying the subnode. | +| owner | address | The address of the new owner. | + +### setResolver + +:small_red_triangle: overrides [KNS.setResolver](KNS.md#setresolver) + +Sets the resolver address for the specified node. + +```js +function setResolver(bytes32 node, address resolver) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| resolver | address | The address of the resolver. | + +### setTTL + +:small_red_triangle: overrides [KNS.setTTL](KNS.md#setttl) + +Sets the TTL for the specified node. + +```js +function setTTL(bytes32 node, uint64 ttl) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| ttl | uint64 | The TTL in seconds. | + +### owner + +:small_red_triangle: overrides [KNS.owner](KNS.md#owner) + +Returns the address that owns the specified node. + +```js +function owner(bytes32 node) public view +returns(address) +``` + +**Returns** + +address of the owner. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +### resolver + +:small_red_triangle: overrides [KNS.resolver](KNS.md#resolver) + +Returns the address of the resolver for the specified node. + +```js +function resolver(bytes32 node) public view +returns(address) +``` + +**Returns** + +address of the resolver. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +### ttl + +:small_red_triangle: overrides [KNS.ttl](KNS.md#ttl) + +Returns the TTL of a node, and any records associated with it. + +```js +function ttl(bytes32 node) public view +returns(uint64) +``` + +**Returns** + +ttl of the node. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/KRC223.md b/client/contracts/truffle/docs/KRC223.md new file mode 100644 index 000000000..0e1a5f25e --- /dev/null +++ b/client/contracts/truffle/docs/KRC223.md @@ -0,0 +1,148 @@ +# KRC223.sol + +**KRC223** + +## Contract Members +**Constants & Variables** + +```js +uint256 public totalSupply; +``` + +**Events** + +```js +event Transfer(address indexed from, address indexed to, uint256 value, bytes data); +``` + +## Functions + +- [balanceOf](#balanceof) +- [name](#name) +- [symbol](#symbol) +- [decimals](#decimals) +- [totalSupply](#totalsupply) +- [transfer](#transfer) +- [transfer](#transfer) +- [transfer](#transfer) + +### balanceOf + +```js +function balanceOf(address who) public view +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| who | address | | + +### name + +```js +function name() public view +returns(_name string) +``` + +### symbol + +```js +function symbol() public view +returns(_symbol string) +``` + +### decimals + +```js +function decimals() public view +returns(_decimals uint8) +``` + +### totalSupply + +```js +function totalSupply() public view +returns(_supply uint256) +``` + +### transfer + +```js +function transfer(address to, uint256 value) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | + +### transfer + +```js +function transfer(address to, uint256 value, bytes data) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | +| data | bytes | | + +### transfer + +```js +function transfer(address to, uint256 value, bytes data, string custom_fallback) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | +| data | bytes | | +| custom_fallback | string | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/Math.md b/client/contracts/truffle/docs/Math.md new file mode 100644 index 000000000..dbb176476 --- /dev/null +++ b/client/contracts/truffle/docs/Math.md @@ -0,0 +1,101 @@ +# Math.sol + +**Math** + +## Functions + +- [max64](#max64) +- [min64](#min64) +- [max256](#max256) +- [min256](#min256) + +### max64 + +```js +function max64(uint64 _a, uint64 _b) internal pure +returns(uint64) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint64 | | +| _b | uint64 | | + +### min64 + +```js +function min64(uint64 _a, uint64 _b) internal pure +returns(uint64) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint64 | | +| _b | uint64 | | + +### max256 + +```js +function max256(uint256 _a, uint256 _b) internal pure +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +### min256 + +```js +function min256(uint256 _a, uint256 _b) internal pure +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/Migrations.md b/client/contracts/truffle/docs/Migrations.md new file mode 100644 index 000000000..f4d1c63d4 --- /dev/null +++ b/client/contracts/truffle/docs/Migrations.md @@ -0,0 +1,90 @@ +# Migrations.sol + +**Migrations** + +## Contract Members +**Constants & Variables** + +```js +address public owner; +uint256 public last_completed_migration; +``` + +## Modifiers + +- [restricted](#restricted) + +### restricted + +```js +modifier restricted() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [setCompleted](#setcompleted) +- [upgrade](#upgrade) + +### setCompleted + +```js +function setCompleted(uint256 completed) public restricted +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| completed | uint256 | | + +### upgrade + +```js +function upgrade(address new_address) public restricted +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| new_address | address | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/MiningToken.md b/client/contracts/truffle/docs/MiningToken.md new file mode 100644 index 000000000..56f916cbe --- /dev/null +++ b/client/contracts/truffle/docs/MiningToken.md @@ -0,0 +1,79 @@ +# MiningToken.sol + +**contract MiningToken is [CappedToken](CappedToken.md)** + +**MiningToken** + +## Constructor + +```js +constructor(uint256 _cap) public +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _cap | uint256 | | + +## Functions + +- [initialize](#initialize) +- [getOwner](#getowner) + +### initialize + +```js +function initialize(string _name, string _symbol, uint256 _cap, uint8 _decimals) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _name | string | | +| _symbol | string | | +| _cap | uint256 | | +| _decimals | uint8 | | + +### getOwner + +```js +function getOwner() public +returns(address) +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/MintableToken.md b/client/contracts/truffle/docs/MintableToken.md new file mode 100644 index 000000000..34c131e83 --- /dev/null +++ b/client/contracts/truffle/docs/MintableToken.md @@ -0,0 +1,107 @@ +# MintableToken.sol + +**contract MintableToken is [Token](Token.md), [Ownable](Ownable.md)** + +**MintableToken** + +## Contract Members +**Constants & Variables** + +```js +bool public mintingFinished; +``` + +**Events** + +```js +event Mint(address indexed to, uint256 amount); +event MintFinished(); +``` + +## Modifiers + +- [canMint](#canmint) + +### canMint + +```js +modifier canMint() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [mint](#mint) +- [finishMinting](#finishminting) + +### mint + +Function to mint tokens + +```js +function mint(address _to, uint256 _amount) public onlyOwner canMint +returns(bool) +``` + +**Returns** + +A boolean that indicates if the operation was successful. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | The address that will receive the minted tokens. | +| _amount | uint256 | The amount of tokens to mint. | + +### finishMinting + +Function to stop minting new tokens. + +```js +function finishMinting() public onlyOwner canMint +returns(bool) +``` + +**Returns** + +True if the operation was successful. + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/MultiSigWallet.md b/client/contracts/truffle/docs/MultiSigWallet.md new file mode 100644 index 000000000..6fb2efbb8 --- /dev/null +++ b/client/contracts/truffle/docs/MultiSigWallet.md @@ -0,0 +1,511 @@ +# MultiSigWallet.sol + +**MultiSigWallet** + +## Constructor + +Contract constructor sets initial owners and required number of confirmations. + +```js +constructor(uint256 , uint256 _required) public +``` + +**Arguments** + +## Structs +### Transaction + +```js +struct Transaction { + address destination, + uint256 value, + bytes data, + bool executed +} +``` + +## Contract Members +**Constants & Variables** + +```js +uint256 public constant MAX_OWNER_COUNT; +mapping(uint256 => struct MultiSigWallet.Transaction) public transactions; +mapping(uint256 => mapping(address => bool)) public confirmations; +mapping(address => bool) public isOwner; +address[] public owners; +uint256 public required; +uint256 public transactionCount; +``` + +**Events** + +```js +event Confirmation(address indexed sender, uint256 indexed transactionId); +event Revocation(address indexed sender, uint256 indexed transactionId); +event Submission(uint256 indexed transactionId); +event Execution(uint256 indexed transactionId); +event ExecutionFailure(uint256 indexed transactionId); +event Deposit(address indexed sender, uint256 value); +event OwnerAddition(address indexed owner); +event OwnerRemoval(address indexed owner); +event RequirementChange(uint256 required); +``` + +| Name | Type | Description | +| ------------- |------------- | -----| +| | uint256 | _owners List of initial owners. | +| _required | uint256 | Number of required confirmations. | + +## Modifiers + +- [onlyWallet](#onlywallet) +- [ownerDoesNotExist](#ownerdoesnotexist) +- [ownerExists](#ownerexists) +- [transactionExists](#transactionexists) +- [confirmed](#confirmed) +- [notConfirmed](#notconfirmed) +- [notExecuted](#notexecuted) +- [notNull](#notnull) +- [validRequirement](#validrequirement) + +### onlyWallet + +```js +modifier onlyWallet() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### ownerDoesNotExist + +```js +modifier ownerDoesNotExist(address owner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | | + +### ownerExists + +```js +modifier ownerExists(address owner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | | + +### transactionExists + +```js +modifier transactionExists(uint256 transactionId) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | | + +### confirmed + +```js +modifier confirmed(uint256 transactionId, address owner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | | +| owner | address | | + +### notConfirmed + +```js +modifier notConfirmed(uint256 transactionId, address owner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | | +| owner | address | | + +### notExecuted + +```js +modifier notExecuted(uint256 transactionId) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | | + +### notNull + +```js +modifier notNull(address _address) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _address | address | | + +### validRequirement + +```js +modifier validRequirement(uint256 ownerCount, uint256 _required) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| ownerCount | uint256 | | +| _required | uint256 | | + +## Functions + +- [](#) +- [addOwner](#addowner) +- [removeOwner](#removeowner) +- [replaceOwner](#replaceowner) +- [changeRequirement](#changerequirement) +- [submitTransaction](#submittransaction) +- [confirmTransaction](#confirmtransaction) +- [revokeConfirmation](#revokeconfirmation) +- [executeTransaction](#executetransaction) +- [external_call](#external_call) +- [isConfirmed](#isconfirmed) +- [addTransaction](#addtransaction) +- [getConfirmationCount](#getconfirmationcount) +- [getTransactionCount](#gettransactioncount) +- [getOwners](#getowners) +- [getConfirmations](#getconfirmations) +- [getTransactionIds](#gettransactionids) + +### + +Fallback function allows to deposit kUSD. + +```js +function () public payable payable +``` + +### addOwner + +Allows to add a new owner. Transaction has to be sent by wallet. + +```js +function addOwner(address owner) public onlyWallet ownerDoesNotExist notNull validRequirement +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | Address of new owner. | + +### removeOwner + +Allows to remove an owner. Transaction has to be sent by wallet. + +```js +function removeOwner(address owner) public onlyWallet ownerExists +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | Address of owner. | + +### replaceOwner + +Allows to replace an owner with a new owner. Transaction has to be sent by wallet. + +```js +function replaceOwner(address owner, address newOwner) public onlyWallet ownerExists ownerDoesNotExist +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | Address of owner to be replaced. | +| newOwner | address | Address of new owner. | + +### changeRequirement + +Allows to change the number of required confirmations. Transaction has to be sent by wallet. + +```js +function changeRequirement(uint256 _required) public onlyWallet validRequirement +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _required | uint256 | Number of required confirmations. | + +### submitTransaction + +Allows an owner to submit and confirm a transaction. + +```js +function submitTransaction(address destination, uint256 value, bytes data) public +returns(transactionId uint256) +``` + +**Returns** + +Returns transaction ID. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| destination | address | Transaction target address. | +| value | uint256 | Transaction ether value. | +| data | bytes | Transaction data payload. | + +### confirmTransaction + +Allows an owner to confirm a transaction. + +```js +function confirmTransaction(uint256 transactionId) public ownerExists transactionExists notConfirmed +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### revokeConfirmation + +Allows an owner to revoke a confirmation for a transaction. + +```js +function revokeConfirmation(uint256 transactionId) public ownerExists confirmed notExecuted +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### executeTransaction + +Allows anyone to execute a confirmed transaction. + +```js +function executeTransaction(uint256 transactionId) public ownerExists confirmed notExecuted +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### external_call + +```js +function external_call(address destination, uint256 value, uint256 dataLength, bytes data) private +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| destination | address | | +| value | uint256 | | +| dataLength | uint256 | | +| data | bytes | | + +### isConfirmed + +Returns the confirmation status of a transaction. + +```js +function isConfirmed(uint256 transactionId) public view +returns(bool) +``` + +**Returns** + +Confirmation status. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### addTransaction + +Adds a new transaction to the transaction mapping, if transaction does not exist yet. + +```js +function addTransaction(address destination, uint256 value, bytes data) internal notNull +returns(transactionId uint256) +``` + +**Returns** + +Returns transaction ID. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| destination | address | Transaction target address. | +| value | uint256 | Transaction ether value. | +| data | bytes | Transaction data payload. | + +### getConfirmationCount + +Returns number of confirmations of a transaction. + +```js +function getConfirmationCount(uint256 transactionId) public view +returns(count uint256) +``` + +**Returns** + +Number of confirmations. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### getTransactionCount + +Returns total number of transactions after filers are applied. + +```js +function getTransactionCount(bool pending, bool executed) public view +returns(count uint256) +``` + +**Returns** + +Total number of transactions after filters are applied. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| pending | bool | Include pending transactions. | +| executed | bool | Include executed transactions. | + +### getOwners + +Returns list of owners. + +```js +function getOwners() public view +returns(address[]) +``` + +**Returns** + +List of owner addresses. + +### getConfirmations + +Returns array with owner addresses, which confirmed transaction. + +```js +function getConfirmations(uint256 transactionId) public view +returns(_confirmations address[]) +``` + +**Returns** + +Returns array of owner addresses. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### getTransactionIds + +Returns list of transaction IDs in defined range. + +```js +function getTransactionIds(uint256 from, uint256 to, bool pending, bool executed) public view +returns(_transactionIds uint256[]) +``` + +**Returns** + +Returns array of transaction IDs. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| from | uint256 | Index start position of transaction array. | +| to | uint256 | Index end position of transaction array. | +| pending | bool | Include pending transactions. | +| executed | bool | Include executed transactions. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/NameHash.md b/client/contracts/truffle/docs/NameHash.md new file mode 100644 index 000000000..494cf8f6c --- /dev/null +++ b/client/contracts/truffle/docs/NameHash.md @@ -0,0 +1,59 @@ +# NameHash.sol + +**NameHash** + +## Functions + +- [namehash](#namehash) + +### namehash + +```js +function namehash(string _node) public view +returns(_namehash bytes32) +``` + +**Returns** + +_namehash The result of namehash algorithm applied at _node. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _node | string | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/OracleMgr.md b/client/contracts/truffle/docs/OracleMgr.md new file mode 100644 index 000000000..69536a7cc --- /dev/null +++ b/client/contracts/truffle/docs/OracleMgr.md @@ -0,0 +1,290 @@ +# Oracle Manager contract (OracleMgr.sol) + +**contract OracleMgr is [Pausable](Pausable.md), [Initializable](Initializable.md)** + +**OracleMgr** + +## Structs +### OraclePrice + +```js +struct OraclePrice { + uint256 price, + address oracle +} +``` + +### Oracle + +```js +struct Oracle { + uint256 index, + bool isOracle, + bool hasSubmittedPrice +} +``` + +## Contract Members +**Constants & Variables** + +```js +//public members +uint256 public maxNumOracles; +uint256 public syncFrequency; +uint256 public updatePeriod; +uint256 public price; +contract DomainResolver public knsResolver; +//internal members +bytes32 internal nodeNamehash; +//private members +mapping(address => struct OracleMgr.Oracle) private oracleRegistry; +address[] private oraclePool; +struct OracleMgr.OraclePrice[] private prices; +``` + +## Modifiers + +- [onlyOracle](#onlyoracle) +- [onlyNewCandidate](#onlynewcandidate) +- [onlySuperNode](#onlysupernode) +- [onlyOnce](#onlyonce) + +### onlyOracle + +```js +modifier onlyOracle() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyNewCandidate + +```js +modifier onlyNewCandidate() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlySuperNode + +```js +modifier onlySuperNode() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyOnce + +```js +modifier onlyOnce() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [initialize](#initialize) +- [isOracle](#isoracle) +- [_hasAvailability](#_hasavailability) +- [_deleteOracle](#_deleteoracle) +- [_insertOracle](#_insertoracle) +- [getOracleCount](#getoraclecount) +- [getOracleAtIndex](#getoracleatindex) +- [getPriceCount](#getpricecount) +- [getPriceAtIndex](#getpriceatindex) +- [registerOracle](#registeroracle) +- [deregisterOracle](#deregisteroracle) +- [submitPrice](#submitprice) + +### initialize + +```js +function initialize(uint256 _maxNumOracles, uint256 _syncFrequency, uint256 _updatePeriod, address _resolverAddr) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _maxNumOracles | uint256 | Maximum numbers of Oracles. | +| _syncFrequency | uint256 | Synchronize frequency for Oracles. | +| _updatePeriod | uint256 | Update period. | +| _resolverAddr | address | Address of KNS Resolver. | + +### isOracle + +Checks if given address is Oracle + +```js +function isOracle(address identity) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | Address of an Oracle. | + +### _hasAvailability + +Checks availability of OraclePool + +```js +function _hasAvailability() private view +returns(available bool) +``` + +### _deleteOracle + +Deletes given oracle + +```js +function _deleteOracle(address identity) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | Address of an Oracle. | + +### _insertOracle + +Inserts oracle + +```js +function _insertOracle(address identity, uint256 deposit) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | Address of an Oracle. | +| deposit | uint256 | Deposit ammount | + +### getOracleCount + +Get Oracle count + +```js +function getOracleCount() public view +returns(count uint256) +``` + +### getOracleAtIndex + +Get Oracle information + +```js +function getOracleAtIndex(uint256 index) public view +returns(code address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of an Oracle to check. | + +### getPriceCount + +Get submissions count + +```js +function getPriceCount() public view +returns(count uint256) +``` + +### getPriceAtIndex + +Get submissions information + +```js +function getPriceAtIndex(uint256 index) public view +returns(price uint256, oracle address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of a submission to check. | + +### registerOracle + +Registers a new candidate as oracle + +```js +function registerOracle() public payable payable whenNotPaused onlyNewCandidate onlySuperNode +``` + +### deregisterOracle + +Deregisters the msg sender from the oracle set + +```js +function deregisterOracle() public whenNotPaused onlyOracle +``` + +### submitPrice + +Adds price + +```js +function submitPrice(uint256 _price) public whenNotPaused onlyOracle onlyOnce +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _price | uint256 | price | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/Ownable.md b/client/contracts/truffle/docs/Ownable.md new file mode 100644 index 000000000..b4bc9d7ef --- /dev/null +++ b/client/contracts/truffle/docs/Ownable.md @@ -0,0 +1,116 @@ +# Ownable (Ownable.sol) + +**Ownable** + +The Ownable contract has an owner address, and provides basic authorization control +functions, this simplifies the implementation of "user permissions". + +## Contract Members +**Constants & Variables** + +```js +address public owner; +``` + +**Events** + +```js +event OwnershipRenounced(address indexed previousOwner); +event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); +``` + +## Modifiers + +- [onlyOwner](#onlyowner) + +### onlyOwner + +Throws if called by any account other than the owner. + +```js +modifier onlyOwner() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [renounceOwnership](#renounceownership) +- [transferOwnership](#transferownership) +- [_transferOwnership](#_transferownership) + +### renounceOwnership + +Renouncing to ownership will leave the contract without an owner. +It will not be possible to call the functions with the `onlyOwner` +modifier anymore. + +```js +function renounceOwnership() public onlyOwner +``` + +### transferOwnership + +Allows the current owner to transfer control of the contract to a newOwner. + +```js +function transferOwnership(address _newOwner) public onlyOwner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _newOwner | address | The address to transfer ownership to. | + +### _transferOwnership + +Transfers control of the contract to a newOwner. + +```js +function _transferOwnership(address _newOwner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _newOwner | address | The address to transfer ownership to. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/Pausable.md b/client/contracts/truffle/docs/Pausable.md new file mode 100644 index 000000000..11fd96a67 --- /dev/null +++ b/client/contracts/truffle/docs/Pausable.md @@ -0,0 +1,108 @@ +# Pausable (Pausable.sol) + +**contract Pausable is [Ownable](Ownable.md)** + +**Pausable** + +Base contract which allows children to implement an emergency stop mechanism. + +## Contract Members +**Constants & Variables** + +```js +bool public paused; +``` + +**Events** + +```js +event Pause(); +event Unpause(); +``` + +## Modifiers + +- [whenNotPaused](#whennotpaused) +- [whenPaused](#whenpaused) + +### whenNotPaused + +Modifier to make a function callable only when the contract is not paused. + +```js +modifier whenNotPaused() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### whenPaused + +Modifier to make a function callable only when the contract is paused. + +```js +modifier whenPaused() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [pause](#pause) +- [unpause](#unpause) + +### pause + +called by the owner to pause, triggers stopped state + +```js +function pause() public onlyOwner whenNotPaused +``` + +### unpause + +called by the owner to unpause, returns to normal state + +```js +function unpause() public onlyOwner whenPaused +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/PriceProvider.md b/client/contracts/truffle/docs/PriceProvider.md new file mode 100644 index 000000000..e114938ce --- /dev/null +++ b/client/contracts/truffle/docs/PriceProvider.md @@ -0,0 +1,49 @@ +# PriceProvider interface (PriceProvider.sol) + +**PriceProvider** + +## Functions + +- [price](#price) + +### price + +```js +function price() public view +returns(uint256) +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/PublicResolver.md b/client/contracts/truffle/docs/PublicResolver.md new file mode 100644 index 000000000..b0c16fbb9 --- /dev/null +++ b/client/contracts/truffle/docs/PublicResolver.md @@ -0,0 +1,373 @@ +# PublicResolver.sol + +**contract PublicResolver is [Initializable](Initializable.md)** + +**PublicResolver** + +## Structs +### PublicKey + +```js +struct PublicKey { + bytes32 x, + bytes32 y +} +``` + +### Record + +```js +struct Record { + address addr, + bytes32 content, + string name, + struct PublicResolver.PublicKey pubkey, + mapping(string => string) text, + mapping(uint256 => bytes) abis, + bytes multihash +} +``` + +## Contract Members +**Constants & Variables** + +```js +bytes4 internal constant INTERFACE_META_ID; +bytes4 internal constant ADDR_INTERFACE_ID; +bytes4 internal constant CONTENT_INTERFACE_ID; +bytes4 internal constant NAME_INTERFACE_ID; +bytes4 internal constant ABI_INTERFACE_ID; +bytes4 internal constant PUBKEY_INTERFACE_ID; +bytes4 internal constant TEXT_INTERFACE_ID; +bytes4 internal constant MULTIHASH_INTERFACE_ID; +contract KNS internal kns; +mapping(bytes32 => struct PublicResolver.Record) internal records; +``` + +**Events** + +```js +event AddrChanged(bytes32 indexed node, address a); +event ContentChanged(bytes32 indexed node, bytes32 hash); +event NameChanged(bytes32 indexed node, string name); +event ABIChanged(bytes32 indexed node, uint256 indexed contentType); +event PubkeyChanged(bytes32 indexed node, bytes32 x, bytes32 y); +event TextChanged(bytes32 indexed node, string indexedKey, string key); +event MultihashChanged(bytes32 indexed node, bytes hash); +``` + +## Modifiers + +- [only_owner](#only_owner) + +### only_owner + +```js +modifier only_owner(bytes32 node) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Functions + +- [initialize](#initialize) +- [setAddr](#setaddr) +- [setContent](#setcontent) +- [setMultihash](#setmultihash) +- [setName](#setname) +- [setABI](#setabi) +- [setPubkey](#setpubkey) +- [setText](#settext) +- [text](#text) +- [pubkey](#pubkey) +- [ABI](#abi) +- [name](#name) +- [content](#content) +- [multihash](#multihash) +- [addr](#addr) +- [supportsInterface](#supportsinterface) + +### initialize + +initialize function for Proxy Pattern. + +```js +function initialize(KNS knsAddr) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| knsAddr | KNS | The address of the KNS registry. | + +### setAddr + +```js +function setAddr(bytes32 node, address addr) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| addr | address | The address to set. | + +### setContent + +```js +function setContent(bytes32 node, bytes32 hash) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| hash | bytes32 | The content hash to set | + +### setMultihash + +```js +function setMultihash(bytes32 node, bytes hash) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| hash | bytes | The multihash to set | + +### setName + +```js +function setName(bytes32 node, string name) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| name | string | The name to set. | + +### setABI + +```js +function setABI(bytes32 node, uint256 contentType, bytes data) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| contentType | uint256 | The content type of the ABI | +| data | bytes | The ABI data. | + +### setPubkey + +```js +function setPubkey(bytes32 node, bytes32 x, bytes32 y) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query | +| x | bytes32 | the X coordinate of the curve point for the public key. | +| y | bytes32 | the Y coordinate of the curve point for the public key. | + +### setText + +```js +function setText(bytes32 node, string key, string value) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| key | string | The key to set. | +| value | string | The text data value to set. | + +### text + +```js +function text(bytes32 node, string key) public view +returns(string) +``` + +**Returns** + +The associated text data. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | +| key | string | The text data key to query. | + +### pubkey + +```js +function pubkey(bytes32 node) public view +returns(x bytes32, y bytes32) +``` + +**Returns** + +x, y the X and Y coordinates of the curve point for the public key. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query | + +### ABI + +```js +function ABI(bytes32 node, uint256 contentTypes) public view +returns(contentType uint256, data bytes) +``` + +**Returns** + +contentType The content type of the return value + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query | +| contentTypes | uint256 | A bitwise OR of the ABI formats accepted by the caller. | + +### name + +```js +function name(bytes32 node) public view +returns(string) +``` + +**Returns** + +The associated name. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +### content + +```js +function content(bytes32 node) public view +returns(bytes32) +``` + +**Returns** + +The associated content hash. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +### multihash + +```js +function multihash(bytes32 node) public view +returns(bytes) +``` + +**Returns** + +The associated multihash. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +### addr + +```js +function addr(bytes32 node) public view +returns(address) +``` + +**Returns** + +The associated address. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +### supportsInterface + +```js +function supportsInterface(bytes4 interfaceID) public pure +returns(bool) +``` + +**Returns** + +True if the contract implements the requested interface. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| interfaceID | bytes4 | The ID of the interface to check for. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/SafeMath.md b/client/contracts/truffle/docs/SafeMath.md new file mode 100644 index 000000000..04262b1eb --- /dev/null +++ b/client/contracts/truffle/docs/SafeMath.md @@ -0,0 +1,109 @@ +# SafeMath.sol + +**SafeMath** + +## Functions + +- [mul](#mul) +- [div](#div) +- [sub](#sub) +- [add](#add) + +### mul + +Multiplies two numbers, throws on overflow. + +```js +function mul(uint256 _a, uint256 _b) internal pure +returns(c uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +### div + +Integer division of two numbers, truncating the quotient. + +```js +function div(uint256 _a, uint256 _b) internal pure +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +### sub + +Subtracts two numbers, throws on overflow (i.e. if subtrahend is greater than minuend). + +```js +function sub(uint256 _a, uint256 _b) internal pure +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +### add + +Adds two numbers, throws on overflow. + +```js +function add(uint256 _a, uint256 _b) internal pure +returns(c uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/Stability.md b/client/contracts/truffle/docs/Stability.md new file mode 100644 index 000000000..b254cbfc0 --- /dev/null +++ b/client/contracts/truffle/docs/Stability.md @@ -0,0 +1,182 @@ +# Stability contract supports network utility (Stability.sol) + +**contract Stability is [Pausable](Pausable.md), [Initializable](Initializable.md)** + +**Stability** + +## Structs +### Subscription + +```js +struct Subscription { + uint256 index, + bool hasSubscription, + uint256 deposit +} +``` + +## Contract Members +**Constants & Variables** + +```js +//internal members +uint256 internal constant ONE; +contract PriceProvider internal priceProvider; +//public members +uint256 public minDeposit; +//private members +mapping(address => struct Stability.Subscription) private subscriptionRegistry; +address[] private subscriptions; +``` + +## Modifiers + +- [onlySubscriber](#onlysubscriber) +- [onlyWithMinDeposit](#onlywithmindeposit) +- [whenPriceGreaterEqualOne](#whenpricegreaterequalone) + +### onlySubscriber + +```js +modifier onlySubscriber() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyWithMinDeposit + +```js +modifier onlyWithMinDeposit() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### whenPriceGreaterEqualOne + +```js +modifier whenPriceGreaterEqualOne() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [initialize](#initialize) +- [getSubscriptionCount](#getsubscriptioncount) +- [getSubscriptionAtIndex](#getsubscriptionatindex) +- [_hasSubscription](#_hassubscription) +- [_insertSubscription](#_insertsubscription) +- [subscribe](#subscribe) +- [unsubscribe](#unsubscribe) + +### initialize + +```js +function initialize(uint256 _minDeposit, address _priceProviderAddr) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _minDeposit | uint256 | minimum deposit required to subscribe to the service | +| _priceProviderAddr | address | address of system variables contract | + +### getSubscriptionCount + +```js +function getSubscriptionCount() public view +returns(count uint256) +``` + +### getSubscriptionAtIndex + +```js +function getSubscriptionAtIndex(uint256 index) public view +returns(code address, deposit uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | | + +### _hasSubscription + +```js +function _hasSubscription(address identity) private view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | | + +### _insertSubscription + +```js +function _insertSubscription() private onlyWithMinDeposit +``` + +### subscribe + +Subscribe to the stability contract service + +```js +function subscribe() public payable payable whenNotPaused +``` + +### unsubscribe + +Unsubscribe the service + +```js +function unsubscribe() public onlySubscriber whenPriceGreaterEqualOne +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/SystemVars.md b/client/contracts/truffle/docs/SystemVars.md new file mode 100644 index 000000000..0b9742e4c --- /dev/null +++ b/client/contracts/truffle/docs/SystemVars.md @@ -0,0 +1,139 @@ +# System Variables (SystemVars.sol) + +**contract SystemVars is [Initializable](Initializable.md)** + +**SystemVars** + +## Contract Members +**Constants & Variables** + +```js +//internal members +uint256 internal constant INITIAL_MINTED_AMOUNT; +uint256 internal constant INITIAL_CAP; +uint256 internal constant STABILIZED_PRICE; +uint256 internal constant ADJUSTMENT_FACTOR; +uint256 internal constant LOW_SUPPLY_METRIC; +uint256 internal constant MAX_UNDER_NORMAL_CONDITIONS; +uint256 internal constant DEFAULT_ORACLE_REWARD; +uint256 internal constant ORACLE_DEDUCTION_FRACTION; +//public members +uint256 public prevCurrencyPrice; +uint256 public currencyPrice; +uint256 public currencySupply; +uint256 public mintedReward; +``` + +## Functions + +- [initialize](#initialize) +- [_hasEnoughSupply](#_hasenoughsupply) +- [_cap](#_cap) +- [price](#price) +- [mintedAmount](#mintedamount) +- [oracleDeduction](#oraclededuction) +- [oracleReward](#oraclereward) + +### initialize + +```js +function initialize(uint256 _initialPrice, uint256 _initialSupply) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _initialPrice | uint256 | initial price for the system's currency | +| _initialSupply | uint256 | minted amount on the genesis block | + +### _hasEnoughSupply + +```js +function _hasEnoughSupply() private view +returns(bool) +``` + +### _cap + +```js +function _cap() private view +returns(amount uint256) +``` + +### price + +Get the current system's currency price + +```js +function price() public view +returns(price uint256) +``` + +### mintedAmount + +Get the amount of coins that should be minted + +```js +function mintedAmount() public view +returns(uint256) +``` + +### oracleDeduction + +Get the oracle deduction + +```js +function oracleDeduction(uint256 mintedAmount) public view +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| mintedAmount | uint256 | the minted amount for the current block. | + +### oracleReward + +Get the oracle reward + +```js +function oracleReward() public view +returns(uint256) +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/Token.md b/client/contracts/truffle/docs/Token.md new file mode 100644 index 000000000..5b586ceb1 --- /dev/null +++ b/client/contracts/truffle/docs/Token.md @@ -0,0 +1,212 @@ +# Token.sol + +**contract Token is [KRC223](KRC223.md), [Initializable](Initializable.md)** + +**Token** + +## Contract Members +**Constants & Variables** + +```js +//internal members +mapping(address => uint256) internal balances; +//public members +string public name; +string public symbol; +uint8 public decimals; +uint256 public totalSupply; +``` + +## Functions + +- [name](#name) +- [symbol](#symbol) +- [decimals](#decimals) +- [totalSupply](#totalsupply) +- [transfer](#transfer) +- [transfer](#transfer) +- [transfer](#transfer) +- [isContract](#iscontract) +- [transferToAddress](#transfertoaddress) +- [transferToContract](#transfertocontract) +- [balanceOf](#balanceof) + +### name + +:small_red_triangle: overrides [KRC223.name](KRC223.md#name) + +```js +function name() public view +returns(_name string) +``` + +### symbol + +:small_red_triangle: overrides [KRC223.symbol](KRC223.md#symbol) + +```js +function symbol() public view +returns(_symbol string) +``` + +### decimals + +:small_red_triangle: overrides [KRC223.decimals](KRC223.md#decimals) + +```js +function decimals() public view +returns(_decimals uint8) +``` + +### totalSupply + +:small_red_triangle: overrides [KRC223.totalSupply](KRC223.md#totalsupply) + +```js +function totalSupply() public view +returns(_totalSupply uint256) +``` + +### transfer + +:small_red_triangle: overrides [KRC223.transfer](KRC223.md#transfer) + +```js +function transfer(address _to, uint256 _value, bytes _data) public +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | +| _data | bytes | | + +### transfer + +:small_red_triangle: overrides [KRC223.transfer](KRC223.md#transfer) + +```js +function transfer(address _to, uint256 _value, bytes _data, string _custom_fallback) public +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | +| _data | bytes | | +| _custom_fallback | string | | + +### transfer + +:small_red_triangle: overrides [KRC223.transfer](KRC223.md#transfer) + +```js +function transfer(address _to, uint256 _value) public +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | + +### isContract + +```js +function isContract(address _addr) private view +returns(is_contract bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _addr | address | | + +### transferToAddress + +```js +function transferToAddress(address _to, uint256 _value, bytes _data) private +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | +| _data | bytes | | + +### transferToContract + +```js +function transferToContract(address _to, uint256 _value, bytes _data) private +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | +| _data | bytes | | + +### balanceOf + +:small_red_triangle: overrides [KRC223.balanceOf](KRC223.md#balanceof) + +```js +function balanceOf(address _owner) public view +returns(balance uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _owner | address | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/TokenMock.md b/client/contracts/truffle/docs/TokenMock.md new file mode 100644 index 000000000..7b7b19dee --- /dev/null +++ b/client/contracts/truffle/docs/TokenMock.md @@ -0,0 +1,151 @@ +# TokenMock.sol + +**TokenMock** + +## Contract Members +**Constants & Variables** + +```js +//public members +uint256 public totalSupply; +//private members +mapping(address => uint256) private balances; +``` + +**Events** + +```js +event Transfer(address indexed from, address indexed to, uint256 value, bytes indexed data); +``` + +## Functions + +- [balanceOf](#balanceof) +- [name](#name) +- [symbol](#symbol) +- [decimals](#decimals) +- [totalSupply](#totalsupply) +- [transfer](#transfer) +- [transfer](#transfer) +- [transfer](#transfer) + +### balanceOf + +```js +function balanceOf(address who) public view +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| who | address | | + +### name + +```js +function name() public view +returns(_name string) +``` + +### symbol + +```js +function symbol() public view +returns(_symbol string) +``` + +### decimals + +```js +function decimals() public view +returns(_decimals uint8) +``` + +### totalSupply + +```js +function totalSupply() public view +returns(_supply uint256) +``` + +### transfer + +```js +function transfer(address to, uint256 value) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | + +### transfer + +```js +function transfer(address to, uint256 value, bytes data) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | +| data | bytes | | + +### transfer + +```js +function transfer(address to, uint256 value, bytes data, string custom_fallback) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | +| data | bytes | | +| custom_fallback | string | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/TokenReceiver.md b/client/contracts/truffle/docs/TokenReceiver.md new file mode 100644 index 000000000..72ef16388 --- /dev/null +++ b/client/contracts/truffle/docs/TokenReceiver.md @@ -0,0 +1,56 @@ +# TokenReceiver.sol + +**TokenReceiver** + +## Functions + +- [tokenFallback](#tokenfallback) + +### tokenFallback + +```js +function tokenFallback(address _from, uint256 _value, bytes _data) public +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _from | address | | +| _value | uint256 | | +| _data | bytes | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/ValidatorMgr.md b/client/contracts/truffle/docs/ValidatorMgr.md new file mode 100644 index 000000000..340727b35 --- /dev/null +++ b/client/contracts/truffle/docs/ValidatorMgr.md @@ -0,0 +1,405 @@ +# Validator Manager for PoS consensus (ValidatorMgr.sol) + +**contract ValidatorMgr is [Pausable](Pausable.md), [Initializable](Initializable.md)** + +**ValidatorMgr** + +## Structs +### Deposit + +```js +struct Deposit { + uint256 amount, + uint256 availableAt +} +``` + +### Validator + +```js +struct Validator { + uint256 index, + bool isValidator, + bool isGenesis, + struct ValidatorMgr.Deposit[] deposits +} +``` + +### TKN + +```js +struct TKN { + address sender, + uint256 value +} +``` + +## Contract Members +**Constants & Variables** + +```js +//public members +uint256 public baseDeposit; +uint256 public maxNumValidators; +uint256 public freezePeriod; +bytes32 public validatorsChecksum; +uint256 public superNodeAmount; +contract DomainResolver public knsResolver; +//internal members +bytes32 internal nodeNamehash; +address[] internal validatorPool; +struct ValidatorMgr.TKN internal tkn; +//private members +mapping(address => struct ValidatorMgr.Validator) private validatorRegistry; +``` + +## Modifiers + +- [onlyWithMinDeposit](#onlywithmindeposit) +- [onlyValidator](#onlyvalidator) +- [onlyNewCandidate](#onlynewcandidate) + +### onlyWithMinDeposit + +```js +modifier onlyWithMinDeposit() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyValidator + +```js +modifier onlyValidator() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyNewCandidate + +```js +modifier onlyNewCandidate() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [initialize](#initialize) +- [isGenesisValidator](#isgenesisvalidator) +- [isValidator](#isvalidator) +- [isSuperNode](#issupernode) +- [getValidatorCount](#getvalidatorcount) +- [getValidatorAtIndex](#getvalidatoratindex) +- [_hasAvailability](#_hasavailability) +- [getMinimumDeposit](#getminimumdeposit) +- [_updateChecksum](#_updatechecksum) +- [_insertValidator](#_insertvalidator) +- [setBaseDeposit](#setbasedeposit) +- [setMaxValidators](#setmaxvalidators) +- [_deleteValidator](#_deletevalidator) +- [_deleteSmallestBidder](#_deletesmallestbidder) +- [getDepositCount](#getdepositcount) +- [getDepositAtIndex](#getdepositatindex) +- [_registerValidator](#_registervalidator) +- [deregisterValidator](#deregistervalidator) +- [_removeDeposits](#_removedeposits) +- [releaseDeposits](#releasedeposits) +- [registerValidator](#registervalidator) + +### initialize + +```js +function initialize(uint256 _baseDeposit, uint256 _maxNumValidators, uint256 _freezePeriod, uint256 _superNodeAmount, address _resolverAddr) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _baseDeposit | uint256 | base deposit for Validator | +| _maxNumValidators | uint256 | Maximum numbers of Validators. | +| _freezePeriod | uint256 | Freeze period for Validator's deposits. | +| _superNodeAmount | uint256 | Amount required to be considered a super node. | +| _resolverAddr | address | Address of KNS Resolver. | + +### isGenesisValidator + +Checks if given address is Genesis Validator + +```js +function isGenesisValidator(address code) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | Address of an Validator. | + +### isValidator + +Checks if given address is Validator + +```js +function isValidator(address code) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | Address of a Validator to check. | + +### isSuperNode + +Checks if given address is super node + +```js +function isSuperNode(address code) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | Address of a supernode to check. | + +### getValidatorCount + +Get Validator count + +```js +function getValidatorCount() public view +returns(count uint256) +``` + +### getValidatorAtIndex + +Get Validator information + +```js +function getValidatorAtIndex(uint256 index) public view +returns(code address, deposit uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of an Validator to check. | + +### _hasAvailability + +```js +function _hasAvailability() public view +returns(available bool) +``` + +### getMinimumDeposit + +returns the base deposit if there are positions available or +the current smallest deposit required if there aren't positions available. + +```js +function getMinimumDeposit() public view +returns(deposit uint256) +``` + +### _updateChecksum + +updates the checksum + +```js +function _updateChecksum() private +``` + +### _insertValidator + +Add new validator + +```js +function _insertValidator(address code, uint256 deposit) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | Address of an Validator. | +| deposit | uint256 | amount to deposit | + +### setBaseDeposit + +Set new base deposit for Validators + +```js +function setBaseDeposit(uint256 deposit) public onlyOwner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| deposit | uint256 | | + +### setMaxValidators + +Set maximum numbers of Validators + +```js +function setMaxValidators(uint256 max) public onlyOwner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| max | uint256 | number of max Validators | + +### _deleteValidator + +Delete Validator + +```js +function _deleteValidator(address account) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| account | address | address of a Validator | + +### _deleteSmallestBidder + +removes the Validator with the smallest deposit + +```js +function _deleteSmallestBidder() private +``` + +### getDepositCount + +Get deposit count + +```js +function getDepositCount() public view +returns(count uint256) +``` + +### getDepositAtIndex + +Get deposit at given index + +```js +function getDepositAtIndex(uint256 index) public view +returns(amount uint256, availableAt uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of a Validator to get deposit | + +### _registerValidator + +Register new Validator + +```js +function _registerValidator() private whenNotPaused onlyNewCandidate onlyWithMinDeposit +``` + +### deregisterValidator + +deregister Validator + +```js +function deregisterValidator() public whenNotPaused onlyValidator +``` + +### _removeDeposits + +remove deposit + +```js +function _removeDeposits(address code, uint256 index) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | address of a Validator | +| index | uint256 | index of a deposit | + +### releaseDeposits + +transfers locked deposit(s) back the user account if they are past the freeze period + +```js +function releaseDeposits() public whenNotPaused +``` + +### registerValidator + +Register Validator + +```js +function registerValidator(address _from, uint256 _value) public +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _from | address | from address | +| _value | uint256 | value to send | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/client/contracts/truffle/docs/strings.md b/client/contracts/truffle/docs/strings.md new file mode 100644 index 000000000..537ada4d6 --- /dev/null +++ b/client/contracts/truffle/docs/strings.md @@ -0,0 +1,497 @@ +# strings.sol + +**strings** + +## Structs +### slice + +```js +struct slice { + uint256 _len, + uint256 _ptr +} +``` + +## Functions + +- [memcpy](#memcpy) +- [toSlice](#toslice) +- [len](#len) +- [toSliceB32](#tosliceb32) +- [copy](#copy) +- [toString](#tostring) +- [len](#len) +- [empty](#empty) +- [compare](#compare) +- [equals](#equals) +- [nextRune](#nextrune) +- [nextRune](#nextrune) +- [ord](#ord) +- [keccak](#keccak) +- [startsWith](#startswith) +- [beyond](#beyond) +- [endsWith](#endswith) +- [until](#until) +- [findPtr](#findptr) +- [rfindPtr](#rfindptr) +- [find](#find) +- [rfind](#rfind) +- [split](#split) +- [split](#split) +- [rsplit](#rsplit) +- [rsplit](#rsplit) +- [count](#count) +- [contains](#contains) +- [concat](#concat) +- [join](#join) + +### memcpy + +```js +function memcpy(uint256 dest, uint256 src, uint256 len) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| dest | uint256 | | +| src | uint256 | | +| len | uint256 | | + +### toSlice + +```js +function toSlice(string self) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | string | | + +### len + +```js +function len(bytes32 self) internal +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | bytes32 | | + +### toSliceB32 + +```js +function toSliceB32(bytes32 self) internal +returns(ret struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | bytes32 | | + +### copy + +```js +function copy(struct strings.slice self) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### toString + +```js +function toString(struct strings.slice self) internal +returns(string) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### len + +```js +function len(struct strings.slice self) internal +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### empty + +```js +function empty(struct strings.slice self) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### compare + +```js +function compare(struct strings.slice self, struct strings.slice other) internal +returns(int256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| other | struct strings.slice | | + +### equals + +```js +function equals(struct strings.slice self, struct strings.slice other) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| other | struct strings.slice | | + +### nextRune + +```js +function nextRune(struct strings.slice self, struct strings.slice rune) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| rune | struct strings.slice | | + +### nextRune + +```js +function nextRune(struct strings.slice self) internal +returns(ret struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### ord + +```js +function ord(struct strings.slice self) internal +returns(ret uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### keccak + +```js +function keccak(struct strings.slice self) internal +returns(ret bytes32) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### startsWith + +```js +function startsWith(struct strings.slice self, struct strings.slice needle) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### beyond + +```js +function beyond(struct strings.slice self, struct strings.slice needle) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### endsWith + +```js +function endsWith(struct strings.slice self, struct strings.slice needle) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### until + +```js +function until(struct strings.slice self, struct strings.slice needle) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### findPtr + +```js +function findPtr(uint256 selflen, uint256 selfptr, uint256 needlelen, uint256 needleptr) private +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| selflen | uint256 | | +| selfptr | uint256 | | +| needlelen | uint256 | | +| needleptr | uint256 | | + +### rfindPtr + +```js +function rfindPtr(uint256 selflen, uint256 selfptr, uint256 needlelen, uint256 needleptr) private +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| selflen | uint256 | | +| selfptr | uint256 | | +| needlelen | uint256 | | +| needleptr | uint256 | | + +### find + +```js +function find(struct strings.slice self, struct strings.slice needle) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### rfind + +```js +function rfind(struct strings.slice self, struct strings.slice needle) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### split + +```js +function split(struct strings.slice self, struct strings.slice needle, struct strings.slice token) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | +| token | struct strings.slice | | + +### split + +```js +function split(struct strings.slice self, struct strings.slice needle) internal +returns(token struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### rsplit + +```js +function rsplit(struct strings.slice self, struct strings.slice needle, struct strings.slice token) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | +| token | struct strings.slice | | + +### rsplit + +```js +function rsplit(struct strings.slice self, struct strings.slice needle) internal +returns(token struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### count + +```js +function count(struct strings.slice self, struct strings.slice needle) internal +returns(count uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### contains + +```js +function contains(struct strings.slice self, struct strings.slice needle) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### concat + +```js +function concat(struct strings.slice self, struct strings.slice other) internal +returns(string) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| other | struct strings.slice | | + +### join + +```js +function join(struct strings.slice self, struct strings.slice[] parts) internal +returns(string) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| parts | struct strings.slice[] | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) From 2643d4b60fbf66e4af345b6fb80689f09249b59c Mon Sep 17 00:00:00 2001 From: Adrian Hetman Date: Thu, 27 Sep 2018 21:59:38 +0200 Subject: [PATCH 02/18] WIP dockerfile --- client/contracts/truffle/solidoc | 1 + 1 file changed, 1 insertion(+) create mode 160000 client/contracts/truffle/solidoc diff --git a/client/contracts/truffle/solidoc b/client/contracts/truffle/solidoc new file mode 160000 index 000000000..2ebfb1b9e --- /dev/null +++ b/client/contracts/truffle/solidoc @@ -0,0 +1 @@ +Subproject commit 2ebfb1b9e5815c8b873c3840008f7740fa997374 From 66490772b50ff36b8940f20cd1c7c0393b3653b3 Mon Sep 17 00:00:00 2001 From: Albert Callarisa Date: Tue, 2 Oct 2018 12:36:28 +0200 Subject: [PATCH 03/18] Added solidoc dockerfile --- client/contracts/truffle/solidoc.Dockerfile | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 client/contracts/truffle/solidoc.Dockerfile diff --git a/client/contracts/truffle/solidoc.Dockerfile b/client/contracts/truffle/solidoc.Dockerfile new file mode 100644 index 000000000..53ae75a80 --- /dev/null +++ b/client/contracts/truffle/solidoc.Dockerfile @@ -0,0 +1,11 @@ +FROM microsoft/dotnet:2.1-sdk-alpine AS build-env +RUN apk update && apk add git nodejs python g++ make bash && rm -rf /var/cache/apk/* + +WORKDIR /app +RUN git clone https://github.com/binodnp/solidoc . +RUN dotnet restore +RUN dotnet publish -c Release + +RUN npm install -g truffle@4.1.x + +ENTRYPOINT ["dotnet", "/app/bin/Release/netcoreapp2.1/publish/Solidoc.dll", "/src", "/out"] From 2a55885835a5ce902e8af81c4a86d7039cda0554 Mon Sep 17 00:00:00 2001 From: Adrian Hetman Date: Tue, 2 Oct 2018 13:19:35 +0200 Subject: [PATCH 04/18] Updated ReadMe and regenerated the docs using the docker tool --- .../contracts/truffle/{solidoc.Dockerfile => Dockerfile} | 2 +- client/contracts/truffle/README.md | 8 ++++++++ client/contracts/truffle/solidoc | 1 - 3 files changed, 9 insertions(+), 2 deletions(-) rename client/contracts/truffle/{solidoc.Dockerfile => Dockerfile} (92%) delete mode 160000 client/contracts/truffle/solidoc diff --git a/client/contracts/truffle/solidoc.Dockerfile b/client/contracts/truffle/Dockerfile similarity index 92% rename from client/contracts/truffle/solidoc.Dockerfile rename to client/contracts/truffle/Dockerfile index 53ae75a80..c33eafc15 100644 --- a/client/contracts/truffle/solidoc.Dockerfile +++ b/client/contracts/truffle/Dockerfile @@ -8,4 +8,4 @@ RUN dotnet publish -c Release RUN npm install -g truffle@4.1.x -ENTRYPOINT ["dotnet", "/app/bin/Release/netcoreapp2.1/publish/Solidoc.dll", "/src", "/out"] +ENTRYPOINT ["dotnet", "/app/bin/Release/netcoreapp2.1/publish/Solidoc.dll", "/src", "/out"] \ No newline at end of file diff --git a/client/contracts/truffle/README.md b/client/contracts/truffle/README.md index 07937bd85..6c6b69288 100644 --- a/client/contracts/truffle/README.md +++ b/client/contracts/truffle/README.md @@ -108,3 +108,11 @@ const knsv1 = await KNSV1.new(); await knsProxy.upgradeTo(knsv1.address, { from: admin }); knsContract = await KNSV1.at(knsProxyAddress); ``` + +# How to generate solidity documentation +We are using docker image with built in tool from https://github.com/binodnp/solidoc to generate our documentation for Solidity. +In the main folder of truffle you will need to do these steps: +1. Build docker image : `docker build . -t kowalatech/solidoc` +2. Run docker image : `docker run --rm -it -v aboslute/path/to/the/project/kcoin/client/contracts/truffle/:/src -v aboslute/path/to/the/project/kcoin/client/contracts/truffle/docs:/outkowalatech/solidoc` + +First argument is the project path and second is the output folder where all generated docs will be. \ No newline at end of file diff --git a/client/contracts/truffle/solidoc b/client/contracts/truffle/solidoc deleted file mode 160000 index 2ebfb1b9e..000000000 --- a/client/contracts/truffle/solidoc +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 2ebfb1b9e5815c8b873c3840008f7740fa997374 From 4f27a9176b6af2124fd853b601922b1d7794aa35 Mon Sep 17 00:00:00 2001 From: Adrian Hetman Date: Tue, 2 Oct 2018 17:40:55 +0200 Subject: [PATCH 05/18] Added pipeline for drone to create solidity docs --- .drone.yml | 12 +++++++++++- Makefile | 10 +++++++++- .../truffle/{Dockerfile => solidoc.Dockerfile} | 0 3 files changed, 20 insertions(+), 2 deletions(-) rename client/contracts/truffle/{Dockerfile => solidoc.Dockerfile} (100%) diff --git a/.drone.yml b/.drone.yml index 8eff0ec54..852d3f6de 100644 --- a/.drone.yml +++ b/.drone.yml @@ -374,7 +374,17 @@ pipeline: when: branch: [dev] event: [push] - + + build_solidity_docs: + group: build_artifacts + image: kowalatech/solidoc + commands: + - make dev_docker_images + - make build_solidity_docs_with_docker + when: + event: [push,tag] + branch: [master,dev] + build_docs: group: build_artifacts image: kowalatech/mkdocs diff --git a/Makefile b/Makefile index c9285118f..d9508c205 100644 --- a/Makefile +++ b/Makefile @@ -202,10 +202,14 @@ build_docs: build_docs_with_docker: @docker run --rm -v $(PWD)/docs:/documents kowalatech/mkdocs $(BUILD_DOCS) +.PHONY: build_solidity_docs_with_docker +build_solidity_docs_with_docker: + @docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/docs:/out kowalatech/solidoc + ## Dev docker images .PHONY: dev_docker_images -dev_docker_images: dev_explorer_docker_image dev_explorer_sync_docker_image dev_kusd_docker_image dev_bootnode_docker_image dev_faucet_docker_image dev_wallet_backend_docker_image dev_transactions_persistance_docker_image dev_transactions_publisher_docker_image dev_backend_api_docker_image +dev_docker_images: dev_explorer_docker_image dev_explorer_sync_docker_image dev_kusd_docker_image dev_bootnode_docker_image dev_faucet_docker_image dev_wallet_backend_docker_image dev_transactions_persistance_docker_image dev_transactions_publisher_docker_image dev_backend_api_docker_image dev_solidocs_docker_image .PHONY: dev_kusd_docker_image dev_kusd_docker_image: @@ -243,6 +247,10 @@ dev_explorer_docker_image: dev_explorer_sync_docker_image: docker build -t kowalatech/kexplorersync -f explorer/sync.Dockerfile . +.PHONY: dev_solidocs_docker_image +dev_solidocs_docker_image: + docker build -t kowalatech/solidoc -f client/contracts/truffle/solidoc.Dockerfile . + # Tools .PHONY: dep diff --git a/client/contracts/truffle/Dockerfile b/client/contracts/truffle/solidoc.Dockerfile similarity index 100% rename from client/contracts/truffle/Dockerfile rename to client/contracts/truffle/solidoc.Dockerfile From 1a7b3c12b1259f565a2eacd213df452eff914043 Mon Sep 17 00:00:00 2001 From: Adrian Hetman Date: Wed, 3 Oct 2018 14:31:43 +0200 Subject: [PATCH 06/18] Updated mkdocs.yml, fixes --- .drone.yml | 20 +- Makefile | 2 +- docs/docs/smartcontracts/BalanceContract.md | 72 +++ docs/docs/smartcontracts/CappedToken.md | 75 +++ docs/docs/smartcontracts/Consensus.md | 55 ++ docs/docs/smartcontracts/ConsensusMock.md | 62 +++ docs/docs/smartcontracts/DomainResolver.md | 59 ++ .../docs/smartcontracts/DomainResolverMock.md | 62 +++ docs/docs/smartcontracts/ExchangeMgr.md | 262 +++++++++ docs/docs/smartcontracts/FIFSRegistrar.md | 97 ++++ docs/docs/smartcontracts/Initializable.md | 72 +++ docs/docs/smartcontracts/KNS.md | 149 +++++ docs/docs/smartcontracts/KNSRegistry.md | 231 ++++++++ docs/docs/smartcontracts/KNSRegistryV1.md | 237 ++++++++ docs/docs/smartcontracts/KRC223.md | 148 +++++ docs/docs/smartcontracts/Math.md | 101 ++++ docs/docs/smartcontracts/Migrations.md | 90 +++ docs/docs/smartcontracts/MiningToken.md | 79 +++ docs/docs/smartcontracts/MintableToken.md | 107 ++++ docs/docs/smartcontracts/MultiSigWallet.md | 511 ++++++++++++++++++ docs/docs/smartcontracts/NameHash.md | 59 ++ docs/docs/smartcontracts/OracleMgr.md | 290 ++++++++++ docs/docs/smartcontracts/Ownable.md | 116 ++++ docs/docs/smartcontracts/Pausable.md | 108 ++++ docs/docs/smartcontracts/PriceProvider.md | 49 ++ docs/docs/smartcontracts/PublicResolver.md | 373 +++++++++++++ docs/docs/smartcontracts/SafeMath.md | 109 ++++ docs/docs/smartcontracts/Stability.md | 182 +++++++ docs/docs/smartcontracts/SystemVars.md | 139 +++++ docs/docs/smartcontracts/Token.md | 212 ++++++++ docs/docs/smartcontracts/TokenMock.md | 151 ++++++ docs/docs/smartcontracts/TokenReceiver.md | 56 ++ docs/docs/smartcontracts/ValidatorMgr.md | 405 ++++++++++++++ docs/docs/smartcontracts/strings.md | 497 +++++++++++++++++ docs/mkdocs.yml | 33 ++ 35 files changed, 5259 insertions(+), 11 deletions(-) create mode 100644 docs/docs/smartcontracts/BalanceContract.md create mode 100644 docs/docs/smartcontracts/CappedToken.md create mode 100644 docs/docs/smartcontracts/Consensus.md create mode 100644 docs/docs/smartcontracts/ConsensusMock.md create mode 100644 docs/docs/smartcontracts/DomainResolver.md create mode 100644 docs/docs/smartcontracts/DomainResolverMock.md create mode 100644 docs/docs/smartcontracts/ExchangeMgr.md create mode 100644 docs/docs/smartcontracts/FIFSRegistrar.md create mode 100644 docs/docs/smartcontracts/Initializable.md create mode 100644 docs/docs/smartcontracts/KNS.md create mode 100644 docs/docs/smartcontracts/KNSRegistry.md create mode 100644 docs/docs/smartcontracts/KNSRegistryV1.md create mode 100644 docs/docs/smartcontracts/KRC223.md create mode 100644 docs/docs/smartcontracts/Math.md create mode 100644 docs/docs/smartcontracts/Migrations.md create mode 100644 docs/docs/smartcontracts/MiningToken.md create mode 100644 docs/docs/smartcontracts/MintableToken.md create mode 100644 docs/docs/smartcontracts/MultiSigWallet.md create mode 100644 docs/docs/smartcontracts/NameHash.md create mode 100644 docs/docs/smartcontracts/OracleMgr.md create mode 100644 docs/docs/smartcontracts/Ownable.md create mode 100644 docs/docs/smartcontracts/Pausable.md create mode 100644 docs/docs/smartcontracts/PriceProvider.md create mode 100644 docs/docs/smartcontracts/PublicResolver.md create mode 100644 docs/docs/smartcontracts/SafeMath.md create mode 100644 docs/docs/smartcontracts/Stability.md create mode 100644 docs/docs/smartcontracts/SystemVars.md create mode 100644 docs/docs/smartcontracts/Token.md create mode 100644 docs/docs/smartcontracts/TokenMock.md create mode 100644 docs/docs/smartcontracts/TokenReceiver.md create mode 100644 docs/docs/smartcontracts/ValidatorMgr.md create mode 100644 docs/docs/smartcontracts/strings.md diff --git a/.drone.yml b/.drone.yml index 852d3f6de..2763b6c14 100644 --- a/.drone.yml +++ b/.drone.yml @@ -17,6 +17,16 @@ pipeline: when: event: [pull_request] + build_solidity_docs: + group: build_artifacts + image: kowalatech/solidoc + commands: + - make dev_solidocs_docker_image + - make build_solidity_docs_with_docker + when: + event: [push,tag] + branch: [master,dev] + go_generate: group: generate image: kowalatech/go:1.0.12 @@ -375,16 +385,6 @@ pipeline: branch: [dev] event: [push] - build_solidity_docs: - group: build_artifacts - image: kowalatech/solidoc - commands: - - make dev_docker_images - - make build_solidity_docs_with_docker - when: - event: [push,tag] - branch: [master,dev] - build_docs: group: build_artifacts image: kowalatech/mkdocs diff --git a/Makefile b/Makefile index d9508c205..909a17832 100644 --- a/Makefile +++ b/Makefile @@ -204,7 +204,7 @@ build_docs_with_docker: .PHONY: build_solidity_docs_with_docker build_solidity_docs_with_docker: - @docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/docs:/out kowalatech/solidoc + @docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/docs/docs/smartcontracts:/out kowalatech/solidoc ## Dev docker images diff --git a/docs/docs/smartcontracts/BalanceContract.md b/docs/docs/smartcontracts/BalanceContract.md new file mode 100644 index 000000000..e18e355c0 --- /dev/null +++ b/docs/docs/smartcontracts/BalanceContract.md @@ -0,0 +1,72 @@ +# BalanceContract.sol + +**contract BalanceContract is [TokenReceiver](TokenReceiver.md)** + +**BalanceContract** + +## Contract Members +**Constants & Variables** + +```js +//internal members +address internal owner; +bytes internal data; +//public members +address public from; +uint256 public value; +``` + +## Functions + +- [tokenFallback](#tokenfallback) + +### tokenFallback + +:small_red_triangle: overrides [TokenReceiver.tokenFallback](TokenReceiver.md#tokenfallback) + +```js +function tokenFallback(address _from, uint256 _value, bytes _data) public +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _from | address | | +| _value | uint256 | | +| _data | bytes | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/CappedToken.md b/docs/docs/smartcontracts/CappedToken.md new file mode 100644 index 000000000..ce048e638 --- /dev/null +++ b/docs/docs/smartcontracts/CappedToken.md @@ -0,0 +1,75 @@ +# Capped token (CappedToken.sol) + +**contract CappedToken is [MintableToken](MintableToken.md)** + +**CappedToken** + +Mintable token with a token cap. + +## Contract Members +**Constants & Variables** + +```js +uint256 public cap; +``` + +## Functions + +- [mint](#mint) + +### mint + +:small_red_triangle: overrides [MintableToken.mint](MintableToken.md#mint) + +Function to mint tokens + +```js +function mint(address _to, uint256 _amount) public onlyOwner canMint +returns(bool) +``` + +**Returns** + +A boolean that indicates if the operation was successful. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | The address that will receive the minted tokens. | +| _amount | uint256 | The amount of tokens to mint. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/Consensus.md b/docs/docs/smartcontracts/Consensus.md new file mode 100644 index 000000000..896fd46c8 --- /dev/null +++ b/docs/docs/smartcontracts/Consensus.md @@ -0,0 +1,55 @@ +# Consensus.sol + +**Consensus** + +## Functions + +- [isSuperNode](#issupernode) + +### isSuperNode + +```js +function isSuperNode(address identity) public view +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/ConsensusMock.md b/docs/docs/smartcontracts/ConsensusMock.md new file mode 100644 index 000000000..dff40000a --- /dev/null +++ b/docs/docs/smartcontracts/ConsensusMock.md @@ -0,0 +1,62 @@ +# ConsensusMock.sol + +**ConsensusMock** + +## Contract Members +**Constants & Variables** + +```js +bool internal superNode; +``` + +## Functions + +- [isSuperNode](#issupernode) + +### isSuperNode + +```js +function isSuperNode(address identity) public view +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/DomainResolver.md b/docs/docs/smartcontracts/DomainResolver.md new file mode 100644 index 000000000..d9e319c46 --- /dev/null +++ b/docs/docs/smartcontracts/DomainResolver.md @@ -0,0 +1,59 @@ +# DomainResolver.sol + +**DomainResolver** + +## Functions + +- [addr](#addr) + +### addr + +```js +function addr(bytes32 node) public view +returns(address) +``` + +**Returns** + +The associated address. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/DomainResolverMock.md b/docs/docs/smartcontracts/DomainResolverMock.md new file mode 100644 index 000000000..9085a1a8b --- /dev/null +++ b/docs/docs/smartcontracts/DomainResolverMock.md @@ -0,0 +1,62 @@ +# DomainResolverMock.sol + +**DomainResolverMock** + +## Contract Members +**Constants & Variables** + +```js +address internal domainAddr; +``` + +## Functions + +- [addr](#addr) + +### addr + +```js +function addr(bytes32 node) public view +returns(address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/ExchangeMgr.md b/docs/docs/smartcontracts/ExchangeMgr.md new file mode 100644 index 000000000..6ae28fb2d --- /dev/null +++ b/docs/docs/smartcontracts/ExchangeMgr.md @@ -0,0 +1,262 @@ +# Exchange Manager contract (ExchangeMgr.sol) + +**contract ExchangeMgr is [Pausable](Pausable.md), [Initializable](Initializable.md)** + +**ExchangeMgr** + +## Structs +### Exchange + +```js +struct Exchange { + uint256 index, + bool isExchange, + bool isWhitelisted +} +``` + +## Contract Members +**Constants & Variables** + +```js +//private members +mapping(string => struct ExchangeMgr.Exchange) private exchangeRegistry; +//public members +string[] public whitelist; +``` + +**Events** + +```js +event Whitelisted(string exchange); +event Blacklisted(string exchange); +event Addition(string exchange); +event Removal(string exchange); +``` + +## Modifiers + +- [onlyNewCandidate](#onlynewcandidate) +- [onlyExchange](#onlyexchange) +- [onlyWhitelistedExchange](#onlywhitelistedexchange) +- [onlyBlacklistedExchange](#onlyblacklistedexchange) + +### onlyNewCandidate + +```js +modifier onlyNewCandidate(string name) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | | + +### onlyExchange + +```js +modifier onlyExchange(string name) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | | + +### onlyWhitelistedExchange + +```js +modifier onlyWhitelistedExchange(string name) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | | + +### onlyBlacklistedExchange + +```js +modifier onlyBlacklistedExchange(string name) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | | + +## Functions + +- [addExchange](#addexchange) +- [removeExchange](#removeexchange) +- [whitelistExchange](#whitelistexchange) +- [blacklistExchange](#blacklistexchange) +- [isExchange](#isexchange) +- [isWhitelistedExchange](#iswhitelistedexchange) +- [isBlacklistedExchange](#isblacklistedexchange) +- [getWhitelistedExchangeCount](#getwhitelistedexchangecount) +- [getWhitelistedExchangeAtIndex](#getwhitelistedexchangeatindex) + +### addExchange + +Adds and whitelists an exchange. + +```js +function addExchange(string name) public whenNotPaused onlyOwner onlyNewCandidate +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### removeExchange + +Removes an exchange. + +```js +function removeExchange(string name) public whenNotPaused onlyOwner onlyExchange +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### whitelistExchange + +Whitelists an exchange. + +```js +function whitelistExchange(string name) public whenNotPaused onlyOwner onlyBlacklistedExchange +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### blacklistExchange + +Blacklists an exchange. + +```js +function blacklistExchange(string name) public whenNotPaused onlyOwner onlyWhitelistedExchange +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### isExchange + +checks whether the given name is an whitelisted exchange or not + +```js +function isExchange(string name) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### isWhitelistedExchange + +checks whether the given name is an whitelisted exchange or not + +```js +function isWhitelistedExchange(string name) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### isBlacklistedExchange + +checks whether the given name is a blacklisted exchange or not + +```js +function isBlacklistedExchange(string name) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| name | string | exchange name. | + +### getWhitelistedExchangeCount + +get whitelisted exchange count + +```js +function getWhitelistedExchangeCount() public view +returns(count uint256) +``` + +### getWhitelistedExchangeAtIndex + +get whitelisted exchange information + +```js +function getWhitelistedExchangeAtIndex(uint256 index) public view +returns(name string) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of a given exchange in the whitelist | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/FIFSRegistrar.md b/docs/docs/smartcontracts/FIFSRegistrar.md new file mode 100644 index 000000000..71386c378 --- /dev/null +++ b/docs/docs/smartcontracts/FIFSRegistrar.md @@ -0,0 +1,97 @@ +# FIFSRegistrar.sol + +**contract FIFSRegistrar is [Initializable](Initializable.md)** + +**FIFSRegistrar** + +## Contract Members +**Constants & Variables** + +```js +contract KNS internal kns; +bytes32 internal rootNode; +``` + +## Modifiers + +- [only_owner](#only_owner) + +### only_owner + +```js +modifier only_owner(bytes32 subnode) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| subnode | bytes32 | | + +## Functions + +- [initialize](#initialize) +- [register](#register) + +### initialize + +initialize function for Proxy Pattern. + +```js +function initialize(KNS knsAddr, bytes32 node) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| knsAddr | KNS | The address of the KNS registry. | +| node | bytes32 | The node that this registrar administers. | + +### register + +```js +function register(bytes32 subnode, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| subnode | bytes32 | The hash of the label to register. | +| owner | address | The address of the new owner. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/Initializable.md b/docs/docs/smartcontracts/Initializable.md new file mode 100644 index 000000000..435e308d7 --- /dev/null +++ b/docs/docs/smartcontracts/Initializable.md @@ -0,0 +1,72 @@ +# Initializable (Initializable.sol) + +**Initializable** + +Simple helper contract to support initialization outside of the constructor. +To use it, replace the constructor with a function that has the +`isInitializer` modifier. +WARNING: This helper does not support multiple inheritance. +WARNING: It is the developer's responsibility to ensure that an initializer +is actually called. +Use `Migratable` for more complex migration mechanisms. + +## Contract Members +**Constants & Variables** + +```js +bool public initialized; +``` + +## Modifiers + +- [isInitializer](#isinitializer) + +### isInitializer + +Modifier to use in the initialization function of a contract. + +```js +modifier isInitializer() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/KNS.md b/docs/docs/smartcontracts/KNS.md new file mode 100644 index 000000000..7bb35e3cd --- /dev/null +++ b/docs/docs/smartcontracts/KNS.md @@ -0,0 +1,149 @@ +# KNS.sol + +**KNS** + +**Events** + +```js +event NewOwner(bytes32 indexed node, bytes32 indexed label, address owner); +event Transfer(bytes32 indexed node, address owner); +event NewResolver(bytes32 indexed node, address resolver); +event NewTTL(bytes32 indexed node, uint64 ttl); +``` + +## Functions + +- [setSubnodeOwner](#setsubnodeowner) +- [setResolver](#setresolver) +- [setOwner](#setowner) +- [setTTL](#setttl) +- [owner](#owner) +- [resolver](#resolver) +- [ttl](#ttl) + +### setSubnodeOwner + +```js +function setSubnodeOwner(bytes32 node, bytes32 label, address owner) external +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | +| label | bytes32 | | +| owner | address | | + +### setResolver + +```js +function setResolver(bytes32 node, address resolver) external +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | +| resolver | address | | + +### setOwner + +```js +function setOwner(bytes32 node, address owner) external +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | +| owner | address | | + +### setTTL + +```js +function setTTL(bytes32 node, uint64 ttl) external +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | +| ttl | uint64 | | + +### owner + +```js +function owner(bytes32 node) external view +returns(address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +### resolver + +```js +function resolver(bytes32 node) external view +returns(address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +### ttl + +```js +function ttl(bytes32 node) external view +returns(uint64) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/KNSRegistry.md b/docs/docs/smartcontracts/KNSRegistry.md new file mode 100644 index 000000000..65b9cd572 --- /dev/null +++ b/docs/docs/smartcontracts/KNSRegistry.md @@ -0,0 +1,231 @@ +# KNSRegistry.sol + +**contract KNSRegistry is [KNS](KNS.md), [Initializable](Initializable.md)** + +**KNSRegistry** + +## Structs +### Record + +```js +struct Record { + address owner, + address resolver, + uint64 ttl +} +``` + +## Contract Members +**Constants & Variables** + +```js +mapping(bytes32 => struct KNSRegistry.Record) internal records; +``` + +## Modifiers + +- [only_owner](#only_owner) + +### only_owner + +```js +modifier only_owner(bytes32 node) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Functions + +- [initialize](#initialize) +- [setOwner](#setowner) +- [setSubnodeOwner](#setsubnodeowner) +- [setResolver](#setresolver) +- [setTTL](#setttl) +- [owner](#owner) +- [resolver](#resolver) +- [ttl](#ttl) + +### initialize + +initialize function for Proxy Pattern. + +```js +function initialize(address _owner) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _owner | address | address of the root owner | + +### setOwner + +:small_red_triangle: overrides [KNS.setOwner](KNS.md#setowner) + +Transfers ownership of a node to a new address. May only be called by the current owner of the node. + +```js +function setOwner(bytes32 node, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to transfer ownership of. | +| owner | address | The address of the new owner. | + +### setSubnodeOwner + +:small_red_triangle: overrides [KNS.setSubnodeOwner](KNS.md#setsubnodeowner) + +Transfers ownership of a subnode keccak256(node, label) to a new address. May only be called by the owner of the parent node. + +```js +function setSubnodeOwner(bytes32 node, bytes32 label, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The parent node. | +| label | bytes32 | The hash of the label specifying the subnode. | +| owner | address | The address of the new owner. | + +### setResolver + +:small_red_triangle: overrides [KNS.setResolver](KNS.md#setresolver) + +Sets the resolver address for the specified node. + +```js +function setResolver(bytes32 node, address resolver) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| resolver | address | The address of the resolver. | + +### setTTL + +:small_red_triangle: overrides [KNS.setTTL](KNS.md#setttl) + +Sets the TTL for the specified node. + +```js +function setTTL(bytes32 node, uint64 ttl) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| ttl | uint64 | The TTL in seconds. | + +### owner + +:small_red_triangle: overrides [KNS.owner](KNS.md#owner) + +Returns the address that owns the specified node. + +```js +function owner(bytes32 node) public view +returns(address) +``` + +**Returns** + +address of the owner. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +### resolver + +:small_red_triangle: overrides [KNS.resolver](KNS.md#resolver) + +Returns the address of the resolver for the specified node. + +```js +function resolver(bytes32 node) public view +returns(address) +``` + +**Returns** + +address of the resolver. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +### ttl + +:small_red_triangle: overrides [KNS.ttl](KNS.md#ttl) + +Returns the TTL of a node, and any records associated with it. + +```js +function ttl(bytes32 node) public view +returns(uint64) +``` + +**Returns** + +ttl of the node. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/KNSRegistryV1.md b/docs/docs/smartcontracts/KNSRegistryV1.md new file mode 100644 index 000000000..dd65f9bfe --- /dev/null +++ b/docs/docs/smartcontracts/KNSRegistryV1.md @@ -0,0 +1,237 @@ +# KNSRegistryV1.sol + +**contract KNSRegistryV1 is [KNS](KNS.md), [Initializable](Initializable.md)** + +**KNSRegistryV1** + +## Structs +### Record + +```js +struct Record { + address owner, + address resolver, + uint64 ttl +} +``` + +## Contract Members +**Constants & Variables** + +```js +mapping(bytes32 => struct KNSRegistryV1.Record) internal records; +``` + +## Modifiers + +- [only_owner](#only_owner) + +### only_owner + +```js +modifier only_owner(bytes32 node) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Functions + +- [initialize](#initialize) +- [helloProxy](#helloproxy) +- [setOwner](#setowner) +- [setSubnodeOwner](#setsubnodeowner) +- [setResolver](#setresolver) +- [setTTL](#setttl) +- [owner](#owner) +- [resolver](#resolver) +- [ttl](#ttl) + +### initialize + +```js +function initialize(address _owner) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _owner | address | | + +### helloProxy + +```js +function helloProxy() public pure +returns(string) +``` + +### setOwner + +:small_red_triangle: overrides [KNS.setOwner](KNS.md#setowner) + +Transfers ownership of a node to a new address. May only be called by the current owner of the node. + +```js +function setOwner(bytes32 node, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to transfer ownership of. | +| owner | address | The address of the new owner. | + +### setSubnodeOwner + +:small_red_triangle: overrides [KNS.setSubnodeOwner](KNS.md#setsubnodeowner) + +Transfers ownership of a subnode keccak256(node, label) to a new address. May only be called by the owner of the parent node. + +```js +function setSubnodeOwner(bytes32 node, bytes32 label, address owner) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The parent node. | +| label | bytes32 | The hash of the label specifying the subnode. | +| owner | address | The address of the new owner. | + +### setResolver + +:small_red_triangle: overrides [KNS.setResolver](KNS.md#setresolver) + +Sets the resolver address for the specified node. + +```js +function setResolver(bytes32 node, address resolver) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| resolver | address | The address of the resolver. | + +### setTTL + +:small_red_triangle: overrides [KNS.setTTL](KNS.md#setttl) + +Sets the TTL for the specified node. + +```js +function setTTL(bytes32 node, uint64 ttl) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| ttl | uint64 | The TTL in seconds. | + +### owner + +:small_red_triangle: overrides [KNS.owner](KNS.md#owner) + +Returns the address that owns the specified node. + +```js +function owner(bytes32 node) public view +returns(address) +``` + +**Returns** + +address of the owner. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +### resolver + +:small_red_triangle: overrides [KNS.resolver](KNS.md#resolver) + +Returns the address of the resolver for the specified node. + +```js +function resolver(bytes32 node) public view +returns(address) +``` + +**Returns** + +address of the resolver. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +### ttl + +:small_red_triangle: overrides [KNS.ttl](KNS.md#ttl) + +Returns the TTL of a node, and any records associated with it. + +```js +function ttl(bytes32 node) public view +returns(uint64) +``` + +**Returns** + +ttl of the node. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The specified node. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/KRC223.md b/docs/docs/smartcontracts/KRC223.md new file mode 100644 index 000000000..0e1a5f25e --- /dev/null +++ b/docs/docs/smartcontracts/KRC223.md @@ -0,0 +1,148 @@ +# KRC223.sol + +**KRC223** + +## Contract Members +**Constants & Variables** + +```js +uint256 public totalSupply; +``` + +**Events** + +```js +event Transfer(address indexed from, address indexed to, uint256 value, bytes data); +``` + +## Functions + +- [balanceOf](#balanceof) +- [name](#name) +- [symbol](#symbol) +- [decimals](#decimals) +- [totalSupply](#totalsupply) +- [transfer](#transfer) +- [transfer](#transfer) +- [transfer](#transfer) + +### balanceOf + +```js +function balanceOf(address who) public view +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| who | address | | + +### name + +```js +function name() public view +returns(_name string) +``` + +### symbol + +```js +function symbol() public view +returns(_symbol string) +``` + +### decimals + +```js +function decimals() public view +returns(_decimals uint8) +``` + +### totalSupply + +```js +function totalSupply() public view +returns(_supply uint256) +``` + +### transfer + +```js +function transfer(address to, uint256 value) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | + +### transfer + +```js +function transfer(address to, uint256 value, bytes data) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | +| data | bytes | | + +### transfer + +```js +function transfer(address to, uint256 value, bytes data, string custom_fallback) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | +| data | bytes | | +| custom_fallback | string | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/Math.md b/docs/docs/smartcontracts/Math.md new file mode 100644 index 000000000..dbb176476 --- /dev/null +++ b/docs/docs/smartcontracts/Math.md @@ -0,0 +1,101 @@ +# Math.sol + +**Math** + +## Functions + +- [max64](#max64) +- [min64](#min64) +- [max256](#max256) +- [min256](#min256) + +### max64 + +```js +function max64(uint64 _a, uint64 _b) internal pure +returns(uint64) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint64 | | +| _b | uint64 | | + +### min64 + +```js +function min64(uint64 _a, uint64 _b) internal pure +returns(uint64) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint64 | | +| _b | uint64 | | + +### max256 + +```js +function max256(uint256 _a, uint256 _b) internal pure +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +### min256 + +```js +function min256(uint256 _a, uint256 _b) internal pure +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/Migrations.md b/docs/docs/smartcontracts/Migrations.md new file mode 100644 index 000000000..f4d1c63d4 --- /dev/null +++ b/docs/docs/smartcontracts/Migrations.md @@ -0,0 +1,90 @@ +# Migrations.sol + +**Migrations** + +## Contract Members +**Constants & Variables** + +```js +address public owner; +uint256 public last_completed_migration; +``` + +## Modifiers + +- [restricted](#restricted) + +### restricted + +```js +modifier restricted() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [setCompleted](#setcompleted) +- [upgrade](#upgrade) + +### setCompleted + +```js +function setCompleted(uint256 completed) public restricted +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| completed | uint256 | | + +### upgrade + +```js +function upgrade(address new_address) public restricted +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| new_address | address | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/MiningToken.md b/docs/docs/smartcontracts/MiningToken.md new file mode 100644 index 000000000..56f916cbe --- /dev/null +++ b/docs/docs/smartcontracts/MiningToken.md @@ -0,0 +1,79 @@ +# MiningToken.sol + +**contract MiningToken is [CappedToken](CappedToken.md)** + +**MiningToken** + +## Constructor + +```js +constructor(uint256 _cap) public +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _cap | uint256 | | + +## Functions + +- [initialize](#initialize) +- [getOwner](#getowner) + +### initialize + +```js +function initialize(string _name, string _symbol, uint256 _cap, uint8 _decimals) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _name | string | | +| _symbol | string | | +| _cap | uint256 | | +| _decimals | uint8 | | + +### getOwner + +```js +function getOwner() public +returns(address) +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/MintableToken.md b/docs/docs/smartcontracts/MintableToken.md new file mode 100644 index 000000000..34c131e83 --- /dev/null +++ b/docs/docs/smartcontracts/MintableToken.md @@ -0,0 +1,107 @@ +# MintableToken.sol + +**contract MintableToken is [Token](Token.md), [Ownable](Ownable.md)** + +**MintableToken** + +## Contract Members +**Constants & Variables** + +```js +bool public mintingFinished; +``` + +**Events** + +```js +event Mint(address indexed to, uint256 amount); +event MintFinished(); +``` + +## Modifiers + +- [canMint](#canmint) + +### canMint + +```js +modifier canMint() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [mint](#mint) +- [finishMinting](#finishminting) + +### mint + +Function to mint tokens + +```js +function mint(address _to, uint256 _amount) public onlyOwner canMint +returns(bool) +``` + +**Returns** + +A boolean that indicates if the operation was successful. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | The address that will receive the minted tokens. | +| _amount | uint256 | The amount of tokens to mint. | + +### finishMinting + +Function to stop minting new tokens. + +```js +function finishMinting() public onlyOwner canMint +returns(bool) +``` + +**Returns** + +True if the operation was successful. + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/MultiSigWallet.md b/docs/docs/smartcontracts/MultiSigWallet.md new file mode 100644 index 000000000..6fb2efbb8 --- /dev/null +++ b/docs/docs/smartcontracts/MultiSigWallet.md @@ -0,0 +1,511 @@ +# MultiSigWallet.sol + +**MultiSigWallet** + +## Constructor + +Contract constructor sets initial owners and required number of confirmations. + +```js +constructor(uint256 , uint256 _required) public +``` + +**Arguments** + +## Structs +### Transaction + +```js +struct Transaction { + address destination, + uint256 value, + bytes data, + bool executed +} +``` + +## Contract Members +**Constants & Variables** + +```js +uint256 public constant MAX_OWNER_COUNT; +mapping(uint256 => struct MultiSigWallet.Transaction) public transactions; +mapping(uint256 => mapping(address => bool)) public confirmations; +mapping(address => bool) public isOwner; +address[] public owners; +uint256 public required; +uint256 public transactionCount; +``` + +**Events** + +```js +event Confirmation(address indexed sender, uint256 indexed transactionId); +event Revocation(address indexed sender, uint256 indexed transactionId); +event Submission(uint256 indexed transactionId); +event Execution(uint256 indexed transactionId); +event ExecutionFailure(uint256 indexed transactionId); +event Deposit(address indexed sender, uint256 value); +event OwnerAddition(address indexed owner); +event OwnerRemoval(address indexed owner); +event RequirementChange(uint256 required); +``` + +| Name | Type | Description | +| ------------- |------------- | -----| +| | uint256 | _owners List of initial owners. | +| _required | uint256 | Number of required confirmations. | + +## Modifiers + +- [onlyWallet](#onlywallet) +- [ownerDoesNotExist](#ownerdoesnotexist) +- [ownerExists](#ownerexists) +- [transactionExists](#transactionexists) +- [confirmed](#confirmed) +- [notConfirmed](#notconfirmed) +- [notExecuted](#notexecuted) +- [notNull](#notnull) +- [validRequirement](#validrequirement) + +### onlyWallet + +```js +modifier onlyWallet() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### ownerDoesNotExist + +```js +modifier ownerDoesNotExist(address owner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | | + +### ownerExists + +```js +modifier ownerExists(address owner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | | + +### transactionExists + +```js +modifier transactionExists(uint256 transactionId) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | | + +### confirmed + +```js +modifier confirmed(uint256 transactionId, address owner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | | +| owner | address | | + +### notConfirmed + +```js +modifier notConfirmed(uint256 transactionId, address owner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | | +| owner | address | | + +### notExecuted + +```js +modifier notExecuted(uint256 transactionId) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | | + +### notNull + +```js +modifier notNull(address _address) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _address | address | | + +### validRequirement + +```js +modifier validRequirement(uint256 ownerCount, uint256 _required) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| ownerCount | uint256 | | +| _required | uint256 | | + +## Functions + +- [](#) +- [addOwner](#addowner) +- [removeOwner](#removeowner) +- [replaceOwner](#replaceowner) +- [changeRequirement](#changerequirement) +- [submitTransaction](#submittransaction) +- [confirmTransaction](#confirmtransaction) +- [revokeConfirmation](#revokeconfirmation) +- [executeTransaction](#executetransaction) +- [external_call](#external_call) +- [isConfirmed](#isconfirmed) +- [addTransaction](#addtransaction) +- [getConfirmationCount](#getconfirmationcount) +- [getTransactionCount](#gettransactioncount) +- [getOwners](#getowners) +- [getConfirmations](#getconfirmations) +- [getTransactionIds](#gettransactionids) + +### + +Fallback function allows to deposit kUSD. + +```js +function () public payable payable +``` + +### addOwner + +Allows to add a new owner. Transaction has to be sent by wallet. + +```js +function addOwner(address owner) public onlyWallet ownerDoesNotExist notNull validRequirement +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | Address of new owner. | + +### removeOwner + +Allows to remove an owner. Transaction has to be sent by wallet. + +```js +function removeOwner(address owner) public onlyWallet ownerExists +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | Address of owner. | + +### replaceOwner + +Allows to replace an owner with a new owner. Transaction has to be sent by wallet. + +```js +function replaceOwner(address owner, address newOwner) public onlyWallet ownerExists ownerDoesNotExist +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| owner | address | Address of owner to be replaced. | +| newOwner | address | Address of new owner. | + +### changeRequirement + +Allows to change the number of required confirmations. Transaction has to be sent by wallet. + +```js +function changeRequirement(uint256 _required) public onlyWallet validRequirement +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _required | uint256 | Number of required confirmations. | + +### submitTransaction + +Allows an owner to submit and confirm a transaction. + +```js +function submitTransaction(address destination, uint256 value, bytes data) public +returns(transactionId uint256) +``` + +**Returns** + +Returns transaction ID. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| destination | address | Transaction target address. | +| value | uint256 | Transaction ether value. | +| data | bytes | Transaction data payload. | + +### confirmTransaction + +Allows an owner to confirm a transaction. + +```js +function confirmTransaction(uint256 transactionId) public ownerExists transactionExists notConfirmed +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### revokeConfirmation + +Allows an owner to revoke a confirmation for a transaction. + +```js +function revokeConfirmation(uint256 transactionId) public ownerExists confirmed notExecuted +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### executeTransaction + +Allows anyone to execute a confirmed transaction. + +```js +function executeTransaction(uint256 transactionId) public ownerExists confirmed notExecuted +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### external_call + +```js +function external_call(address destination, uint256 value, uint256 dataLength, bytes data) private +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| destination | address | | +| value | uint256 | | +| dataLength | uint256 | | +| data | bytes | | + +### isConfirmed + +Returns the confirmation status of a transaction. + +```js +function isConfirmed(uint256 transactionId) public view +returns(bool) +``` + +**Returns** + +Confirmation status. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### addTransaction + +Adds a new transaction to the transaction mapping, if transaction does not exist yet. + +```js +function addTransaction(address destination, uint256 value, bytes data) internal notNull +returns(transactionId uint256) +``` + +**Returns** + +Returns transaction ID. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| destination | address | Transaction target address. | +| value | uint256 | Transaction ether value. | +| data | bytes | Transaction data payload. | + +### getConfirmationCount + +Returns number of confirmations of a transaction. + +```js +function getConfirmationCount(uint256 transactionId) public view +returns(count uint256) +``` + +**Returns** + +Number of confirmations. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### getTransactionCount + +Returns total number of transactions after filers are applied. + +```js +function getTransactionCount(bool pending, bool executed) public view +returns(count uint256) +``` + +**Returns** + +Total number of transactions after filters are applied. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| pending | bool | Include pending transactions. | +| executed | bool | Include executed transactions. | + +### getOwners + +Returns list of owners. + +```js +function getOwners() public view +returns(address[]) +``` + +**Returns** + +List of owner addresses. + +### getConfirmations + +Returns array with owner addresses, which confirmed transaction. + +```js +function getConfirmations(uint256 transactionId) public view +returns(_confirmations address[]) +``` + +**Returns** + +Returns array of owner addresses. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| transactionId | uint256 | Transaction ID. | + +### getTransactionIds + +Returns list of transaction IDs in defined range. + +```js +function getTransactionIds(uint256 from, uint256 to, bool pending, bool executed) public view +returns(_transactionIds uint256[]) +``` + +**Returns** + +Returns array of transaction IDs. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| from | uint256 | Index start position of transaction array. | +| to | uint256 | Index end position of transaction array. | +| pending | bool | Include pending transactions. | +| executed | bool | Include executed transactions. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/NameHash.md b/docs/docs/smartcontracts/NameHash.md new file mode 100644 index 000000000..494cf8f6c --- /dev/null +++ b/docs/docs/smartcontracts/NameHash.md @@ -0,0 +1,59 @@ +# NameHash.sol + +**NameHash** + +## Functions + +- [namehash](#namehash) + +### namehash + +```js +function namehash(string _node) public view +returns(_namehash bytes32) +``` + +**Returns** + +_namehash The result of namehash algorithm applied at _node. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _node | string | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/OracleMgr.md b/docs/docs/smartcontracts/OracleMgr.md new file mode 100644 index 000000000..69536a7cc --- /dev/null +++ b/docs/docs/smartcontracts/OracleMgr.md @@ -0,0 +1,290 @@ +# Oracle Manager contract (OracleMgr.sol) + +**contract OracleMgr is [Pausable](Pausable.md), [Initializable](Initializable.md)** + +**OracleMgr** + +## Structs +### OraclePrice + +```js +struct OraclePrice { + uint256 price, + address oracle +} +``` + +### Oracle + +```js +struct Oracle { + uint256 index, + bool isOracle, + bool hasSubmittedPrice +} +``` + +## Contract Members +**Constants & Variables** + +```js +//public members +uint256 public maxNumOracles; +uint256 public syncFrequency; +uint256 public updatePeriod; +uint256 public price; +contract DomainResolver public knsResolver; +//internal members +bytes32 internal nodeNamehash; +//private members +mapping(address => struct OracleMgr.Oracle) private oracleRegistry; +address[] private oraclePool; +struct OracleMgr.OraclePrice[] private prices; +``` + +## Modifiers + +- [onlyOracle](#onlyoracle) +- [onlyNewCandidate](#onlynewcandidate) +- [onlySuperNode](#onlysupernode) +- [onlyOnce](#onlyonce) + +### onlyOracle + +```js +modifier onlyOracle() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyNewCandidate + +```js +modifier onlyNewCandidate() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlySuperNode + +```js +modifier onlySuperNode() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyOnce + +```js +modifier onlyOnce() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [initialize](#initialize) +- [isOracle](#isoracle) +- [_hasAvailability](#_hasavailability) +- [_deleteOracle](#_deleteoracle) +- [_insertOracle](#_insertoracle) +- [getOracleCount](#getoraclecount) +- [getOracleAtIndex](#getoracleatindex) +- [getPriceCount](#getpricecount) +- [getPriceAtIndex](#getpriceatindex) +- [registerOracle](#registeroracle) +- [deregisterOracle](#deregisteroracle) +- [submitPrice](#submitprice) + +### initialize + +```js +function initialize(uint256 _maxNumOracles, uint256 _syncFrequency, uint256 _updatePeriod, address _resolverAddr) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _maxNumOracles | uint256 | Maximum numbers of Oracles. | +| _syncFrequency | uint256 | Synchronize frequency for Oracles. | +| _updatePeriod | uint256 | Update period. | +| _resolverAddr | address | Address of KNS Resolver. | + +### isOracle + +Checks if given address is Oracle + +```js +function isOracle(address identity) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | Address of an Oracle. | + +### _hasAvailability + +Checks availability of OraclePool + +```js +function _hasAvailability() private view +returns(available bool) +``` + +### _deleteOracle + +Deletes given oracle + +```js +function _deleteOracle(address identity) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | Address of an Oracle. | + +### _insertOracle + +Inserts oracle + +```js +function _insertOracle(address identity, uint256 deposit) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | Address of an Oracle. | +| deposit | uint256 | Deposit ammount | + +### getOracleCount + +Get Oracle count + +```js +function getOracleCount() public view +returns(count uint256) +``` + +### getOracleAtIndex + +Get Oracle information + +```js +function getOracleAtIndex(uint256 index) public view +returns(code address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of an Oracle to check. | + +### getPriceCount + +Get submissions count + +```js +function getPriceCount() public view +returns(count uint256) +``` + +### getPriceAtIndex + +Get submissions information + +```js +function getPriceAtIndex(uint256 index) public view +returns(price uint256, oracle address) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of a submission to check. | + +### registerOracle + +Registers a new candidate as oracle + +```js +function registerOracle() public payable payable whenNotPaused onlyNewCandidate onlySuperNode +``` + +### deregisterOracle + +Deregisters the msg sender from the oracle set + +```js +function deregisterOracle() public whenNotPaused onlyOracle +``` + +### submitPrice + +Adds price + +```js +function submitPrice(uint256 _price) public whenNotPaused onlyOracle onlyOnce +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _price | uint256 | price | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/Ownable.md b/docs/docs/smartcontracts/Ownable.md new file mode 100644 index 000000000..b4bc9d7ef --- /dev/null +++ b/docs/docs/smartcontracts/Ownable.md @@ -0,0 +1,116 @@ +# Ownable (Ownable.sol) + +**Ownable** + +The Ownable contract has an owner address, and provides basic authorization control +functions, this simplifies the implementation of "user permissions". + +## Contract Members +**Constants & Variables** + +```js +address public owner; +``` + +**Events** + +```js +event OwnershipRenounced(address indexed previousOwner); +event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); +``` + +## Modifiers + +- [onlyOwner](#onlyowner) + +### onlyOwner + +Throws if called by any account other than the owner. + +```js +modifier onlyOwner() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [renounceOwnership](#renounceownership) +- [transferOwnership](#transferownership) +- [_transferOwnership](#_transferownership) + +### renounceOwnership + +Renouncing to ownership will leave the contract without an owner. +It will not be possible to call the functions with the `onlyOwner` +modifier anymore. + +```js +function renounceOwnership() public onlyOwner +``` + +### transferOwnership + +Allows the current owner to transfer control of the contract to a newOwner. + +```js +function transferOwnership(address _newOwner) public onlyOwner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _newOwner | address | The address to transfer ownership to. | + +### _transferOwnership + +Transfers control of the contract to a newOwner. + +```js +function _transferOwnership(address _newOwner) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _newOwner | address | The address to transfer ownership to. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/Pausable.md b/docs/docs/smartcontracts/Pausable.md new file mode 100644 index 000000000..11fd96a67 --- /dev/null +++ b/docs/docs/smartcontracts/Pausable.md @@ -0,0 +1,108 @@ +# Pausable (Pausable.sol) + +**contract Pausable is [Ownable](Ownable.md)** + +**Pausable** + +Base contract which allows children to implement an emergency stop mechanism. + +## Contract Members +**Constants & Variables** + +```js +bool public paused; +``` + +**Events** + +```js +event Pause(); +event Unpause(); +``` + +## Modifiers + +- [whenNotPaused](#whennotpaused) +- [whenPaused](#whenpaused) + +### whenNotPaused + +Modifier to make a function callable only when the contract is not paused. + +```js +modifier whenNotPaused() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### whenPaused + +Modifier to make a function callable only when the contract is paused. + +```js +modifier whenPaused() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [pause](#pause) +- [unpause](#unpause) + +### pause + +called by the owner to pause, triggers stopped state + +```js +function pause() public onlyOwner whenNotPaused +``` + +### unpause + +called by the owner to unpause, returns to normal state + +```js +function unpause() public onlyOwner whenPaused +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/PriceProvider.md b/docs/docs/smartcontracts/PriceProvider.md new file mode 100644 index 000000000..e114938ce --- /dev/null +++ b/docs/docs/smartcontracts/PriceProvider.md @@ -0,0 +1,49 @@ +# PriceProvider interface (PriceProvider.sol) + +**PriceProvider** + +## Functions + +- [price](#price) + +### price + +```js +function price() public view +returns(uint256) +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/PublicResolver.md b/docs/docs/smartcontracts/PublicResolver.md new file mode 100644 index 000000000..b0c16fbb9 --- /dev/null +++ b/docs/docs/smartcontracts/PublicResolver.md @@ -0,0 +1,373 @@ +# PublicResolver.sol + +**contract PublicResolver is [Initializable](Initializable.md)** + +**PublicResolver** + +## Structs +### PublicKey + +```js +struct PublicKey { + bytes32 x, + bytes32 y +} +``` + +### Record + +```js +struct Record { + address addr, + bytes32 content, + string name, + struct PublicResolver.PublicKey pubkey, + mapping(string => string) text, + mapping(uint256 => bytes) abis, + bytes multihash +} +``` + +## Contract Members +**Constants & Variables** + +```js +bytes4 internal constant INTERFACE_META_ID; +bytes4 internal constant ADDR_INTERFACE_ID; +bytes4 internal constant CONTENT_INTERFACE_ID; +bytes4 internal constant NAME_INTERFACE_ID; +bytes4 internal constant ABI_INTERFACE_ID; +bytes4 internal constant PUBKEY_INTERFACE_ID; +bytes4 internal constant TEXT_INTERFACE_ID; +bytes4 internal constant MULTIHASH_INTERFACE_ID; +contract KNS internal kns; +mapping(bytes32 => struct PublicResolver.Record) internal records; +``` + +**Events** + +```js +event AddrChanged(bytes32 indexed node, address a); +event ContentChanged(bytes32 indexed node, bytes32 hash); +event NameChanged(bytes32 indexed node, string name); +event ABIChanged(bytes32 indexed node, uint256 indexed contentType); +event PubkeyChanged(bytes32 indexed node, bytes32 x, bytes32 y); +event TextChanged(bytes32 indexed node, string indexedKey, string key); +event MultihashChanged(bytes32 indexed node, bytes hash); +``` + +## Modifiers + +- [only_owner](#only_owner) + +### only_owner + +```js +modifier only_owner(bytes32 node) internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | | + +## Functions + +- [initialize](#initialize) +- [setAddr](#setaddr) +- [setContent](#setcontent) +- [setMultihash](#setmultihash) +- [setName](#setname) +- [setABI](#setabi) +- [setPubkey](#setpubkey) +- [setText](#settext) +- [text](#text) +- [pubkey](#pubkey) +- [ABI](#abi) +- [name](#name) +- [content](#content) +- [multihash](#multihash) +- [addr](#addr) +- [supportsInterface](#supportsinterface) + +### initialize + +initialize function for Proxy Pattern. + +```js +function initialize(KNS knsAddr) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| knsAddr | KNS | The address of the KNS registry. | + +### setAddr + +```js +function setAddr(bytes32 node, address addr) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| addr | address | The address to set. | + +### setContent + +```js +function setContent(bytes32 node, bytes32 hash) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| hash | bytes32 | The content hash to set | + +### setMultihash + +```js +function setMultihash(bytes32 node, bytes hash) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| hash | bytes | The multihash to set | + +### setName + +```js +function setName(bytes32 node, string name) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| name | string | The name to set. | + +### setABI + +```js +function setABI(bytes32 node, uint256 contentType, bytes data) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| contentType | uint256 | The content type of the ABI | +| data | bytes | The ABI data. | + +### setPubkey + +```js +function setPubkey(bytes32 node, bytes32 x, bytes32 y) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query | +| x | bytes32 | the X coordinate of the curve point for the public key. | +| y | bytes32 | the Y coordinate of the curve point for the public key. | + +### setText + +```js +function setText(bytes32 node, string key, string value) public only_owner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The node to update. | +| key | string | The key to set. | +| value | string | The text data value to set. | + +### text + +```js +function text(bytes32 node, string key) public view +returns(string) +``` + +**Returns** + +The associated text data. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | +| key | string | The text data key to query. | + +### pubkey + +```js +function pubkey(bytes32 node) public view +returns(x bytes32, y bytes32) +``` + +**Returns** + +x, y the X and Y coordinates of the curve point for the public key. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query | + +### ABI + +```js +function ABI(bytes32 node, uint256 contentTypes) public view +returns(contentType uint256, data bytes) +``` + +**Returns** + +contentType The content type of the return value + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query | +| contentTypes | uint256 | A bitwise OR of the ABI formats accepted by the caller. | + +### name + +```js +function name(bytes32 node) public view +returns(string) +``` + +**Returns** + +The associated name. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +### content + +```js +function content(bytes32 node) public view +returns(bytes32) +``` + +**Returns** + +The associated content hash. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +### multihash + +```js +function multihash(bytes32 node) public view +returns(bytes) +``` + +**Returns** + +The associated multihash. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +### addr + +```js +function addr(bytes32 node) public view +returns(address) +``` + +**Returns** + +The associated address. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| node | bytes32 | The KNS node to query. | + +### supportsInterface + +```js +function supportsInterface(bytes4 interfaceID) public pure +returns(bool) +``` + +**Returns** + +True if the contract implements the requested interface. + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| interfaceID | bytes4 | The ID of the interface to check for. | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/SafeMath.md b/docs/docs/smartcontracts/SafeMath.md new file mode 100644 index 000000000..04262b1eb --- /dev/null +++ b/docs/docs/smartcontracts/SafeMath.md @@ -0,0 +1,109 @@ +# SafeMath.sol + +**SafeMath** + +## Functions + +- [mul](#mul) +- [div](#div) +- [sub](#sub) +- [add](#add) + +### mul + +Multiplies two numbers, throws on overflow. + +```js +function mul(uint256 _a, uint256 _b) internal pure +returns(c uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +### div + +Integer division of two numbers, truncating the quotient. + +```js +function div(uint256 _a, uint256 _b) internal pure +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +### sub + +Subtracts two numbers, throws on overflow (i.e. if subtrahend is greater than minuend). + +```js +function sub(uint256 _a, uint256 _b) internal pure +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +### add + +Adds two numbers, throws on overflow. + +```js +function add(uint256 _a, uint256 _b) internal pure +returns(c uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _a | uint256 | | +| _b | uint256 | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/Stability.md b/docs/docs/smartcontracts/Stability.md new file mode 100644 index 000000000..b254cbfc0 --- /dev/null +++ b/docs/docs/smartcontracts/Stability.md @@ -0,0 +1,182 @@ +# Stability contract supports network utility (Stability.sol) + +**contract Stability is [Pausable](Pausable.md), [Initializable](Initializable.md)** + +**Stability** + +## Structs +### Subscription + +```js +struct Subscription { + uint256 index, + bool hasSubscription, + uint256 deposit +} +``` + +## Contract Members +**Constants & Variables** + +```js +//internal members +uint256 internal constant ONE; +contract PriceProvider internal priceProvider; +//public members +uint256 public minDeposit; +//private members +mapping(address => struct Stability.Subscription) private subscriptionRegistry; +address[] private subscriptions; +``` + +## Modifiers + +- [onlySubscriber](#onlysubscriber) +- [onlyWithMinDeposit](#onlywithmindeposit) +- [whenPriceGreaterEqualOne](#whenpricegreaterequalone) + +### onlySubscriber + +```js +modifier onlySubscriber() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyWithMinDeposit + +```js +modifier onlyWithMinDeposit() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### whenPriceGreaterEqualOne + +```js +modifier whenPriceGreaterEqualOne() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [initialize](#initialize) +- [getSubscriptionCount](#getsubscriptioncount) +- [getSubscriptionAtIndex](#getsubscriptionatindex) +- [_hasSubscription](#_hassubscription) +- [_insertSubscription](#_insertsubscription) +- [subscribe](#subscribe) +- [unsubscribe](#unsubscribe) + +### initialize + +```js +function initialize(uint256 _minDeposit, address _priceProviderAddr) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _minDeposit | uint256 | minimum deposit required to subscribe to the service | +| _priceProviderAddr | address | address of system variables contract | + +### getSubscriptionCount + +```js +function getSubscriptionCount() public view +returns(count uint256) +``` + +### getSubscriptionAtIndex + +```js +function getSubscriptionAtIndex(uint256 index) public view +returns(code address, deposit uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | | + +### _hasSubscription + +```js +function _hasSubscription(address identity) private view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| identity | address | | + +### _insertSubscription + +```js +function _insertSubscription() private onlyWithMinDeposit +``` + +### subscribe + +Subscribe to the stability contract service + +```js +function subscribe() public payable payable whenNotPaused +``` + +### unsubscribe + +Unsubscribe the service + +```js +function unsubscribe() public onlySubscriber whenPriceGreaterEqualOne +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/SystemVars.md b/docs/docs/smartcontracts/SystemVars.md new file mode 100644 index 000000000..0b9742e4c --- /dev/null +++ b/docs/docs/smartcontracts/SystemVars.md @@ -0,0 +1,139 @@ +# System Variables (SystemVars.sol) + +**contract SystemVars is [Initializable](Initializable.md)** + +**SystemVars** + +## Contract Members +**Constants & Variables** + +```js +//internal members +uint256 internal constant INITIAL_MINTED_AMOUNT; +uint256 internal constant INITIAL_CAP; +uint256 internal constant STABILIZED_PRICE; +uint256 internal constant ADJUSTMENT_FACTOR; +uint256 internal constant LOW_SUPPLY_METRIC; +uint256 internal constant MAX_UNDER_NORMAL_CONDITIONS; +uint256 internal constant DEFAULT_ORACLE_REWARD; +uint256 internal constant ORACLE_DEDUCTION_FRACTION; +//public members +uint256 public prevCurrencyPrice; +uint256 public currencyPrice; +uint256 public currencySupply; +uint256 public mintedReward; +``` + +## Functions + +- [initialize](#initialize) +- [_hasEnoughSupply](#_hasenoughsupply) +- [_cap](#_cap) +- [price](#price) +- [mintedAmount](#mintedamount) +- [oracleDeduction](#oraclededuction) +- [oracleReward](#oraclereward) + +### initialize + +```js +function initialize(uint256 _initialPrice, uint256 _initialSupply) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _initialPrice | uint256 | initial price for the system's currency | +| _initialSupply | uint256 | minted amount on the genesis block | + +### _hasEnoughSupply + +```js +function _hasEnoughSupply() private view +returns(bool) +``` + +### _cap + +```js +function _cap() private view +returns(amount uint256) +``` + +### price + +Get the current system's currency price + +```js +function price() public view +returns(price uint256) +``` + +### mintedAmount + +Get the amount of coins that should be minted + +```js +function mintedAmount() public view +returns(uint256) +``` + +### oracleDeduction + +Get the oracle deduction + +```js +function oracleDeduction(uint256 mintedAmount) public view +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| mintedAmount | uint256 | the minted amount for the current block. | + +### oracleReward + +Get the oracle reward + +```js +function oracleReward() public view +returns(uint256) +``` + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/Token.md b/docs/docs/smartcontracts/Token.md new file mode 100644 index 000000000..5b586ceb1 --- /dev/null +++ b/docs/docs/smartcontracts/Token.md @@ -0,0 +1,212 @@ +# Token.sol + +**contract Token is [KRC223](KRC223.md), [Initializable](Initializable.md)** + +**Token** + +## Contract Members +**Constants & Variables** + +```js +//internal members +mapping(address => uint256) internal balances; +//public members +string public name; +string public symbol; +uint8 public decimals; +uint256 public totalSupply; +``` + +## Functions + +- [name](#name) +- [symbol](#symbol) +- [decimals](#decimals) +- [totalSupply](#totalsupply) +- [transfer](#transfer) +- [transfer](#transfer) +- [transfer](#transfer) +- [isContract](#iscontract) +- [transferToAddress](#transfertoaddress) +- [transferToContract](#transfertocontract) +- [balanceOf](#balanceof) + +### name + +:small_red_triangle: overrides [KRC223.name](KRC223.md#name) + +```js +function name() public view +returns(_name string) +``` + +### symbol + +:small_red_triangle: overrides [KRC223.symbol](KRC223.md#symbol) + +```js +function symbol() public view +returns(_symbol string) +``` + +### decimals + +:small_red_triangle: overrides [KRC223.decimals](KRC223.md#decimals) + +```js +function decimals() public view +returns(_decimals uint8) +``` + +### totalSupply + +:small_red_triangle: overrides [KRC223.totalSupply](KRC223.md#totalsupply) + +```js +function totalSupply() public view +returns(_totalSupply uint256) +``` + +### transfer + +:small_red_triangle: overrides [KRC223.transfer](KRC223.md#transfer) + +```js +function transfer(address _to, uint256 _value, bytes _data) public +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | +| _data | bytes | | + +### transfer + +:small_red_triangle: overrides [KRC223.transfer](KRC223.md#transfer) + +```js +function transfer(address _to, uint256 _value, bytes _data, string _custom_fallback) public +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | +| _data | bytes | | +| _custom_fallback | string | | + +### transfer + +:small_red_triangle: overrides [KRC223.transfer](KRC223.md#transfer) + +```js +function transfer(address _to, uint256 _value) public +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | + +### isContract + +```js +function isContract(address _addr) private view +returns(is_contract bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _addr | address | | + +### transferToAddress + +```js +function transferToAddress(address _to, uint256 _value, bytes _data) private +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | +| _data | bytes | | + +### transferToContract + +```js +function transferToContract(address _to, uint256 _value, bytes _data) private +returns(success bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _to | address | | +| _value | uint256 | | +| _data | bytes | | + +### balanceOf + +:small_red_triangle: overrides [KRC223.balanceOf](KRC223.md#balanceof) + +```js +function balanceOf(address _owner) public view +returns(balance uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _owner | address | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/TokenMock.md b/docs/docs/smartcontracts/TokenMock.md new file mode 100644 index 000000000..7b7b19dee --- /dev/null +++ b/docs/docs/smartcontracts/TokenMock.md @@ -0,0 +1,151 @@ +# TokenMock.sol + +**TokenMock** + +## Contract Members +**Constants & Variables** + +```js +//public members +uint256 public totalSupply; +//private members +mapping(address => uint256) private balances; +``` + +**Events** + +```js +event Transfer(address indexed from, address indexed to, uint256 value, bytes indexed data); +``` + +## Functions + +- [balanceOf](#balanceof) +- [name](#name) +- [symbol](#symbol) +- [decimals](#decimals) +- [totalSupply](#totalsupply) +- [transfer](#transfer) +- [transfer](#transfer) +- [transfer](#transfer) + +### balanceOf + +```js +function balanceOf(address who) public view +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| who | address | | + +### name + +```js +function name() public view +returns(_name string) +``` + +### symbol + +```js +function symbol() public view +returns(_symbol string) +``` + +### decimals + +```js +function decimals() public view +returns(_decimals uint8) +``` + +### totalSupply + +```js +function totalSupply() public view +returns(_supply uint256) +``` + +### transfer + +```js +function transfer(address to, uint256 value) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | + +### transfer + +```js +function transfer(address to, uint256 value, bytes data) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | +| data | bytes | | + +### transfer + +```js +function transfer(address to, uint256 value, bytes data, string custom_fallback) public +returns(ok bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| to | address | | +| value | uint256 | | +| data | bytes | | +| custom_fallback | string | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/TokenReceiver.md b/docs/docs/smartcontracts/TokenReceiver.md new file mode 100644 index 000000000..72ef16388 --- /dev/null +++ b/docs/docs/smartcontracts/TokenReceiver.md @@ -0,0 +1,56 @@ +# TokenReceiver.sol + +**TokenReceiver** + +## Functions + +- [tokenFallback](#tokenfallback) + +### tokenFallback + +```js +function tokenFallback(address _from, uint256 _value, bytes _data) public +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _from | address | | +| _value | uint256 | | +| _data | bytes | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/ValidatorMgr.md b/docs/docs/smartcontracts/ValidatorMgr.md new file mode 100644 index 000000000..340727b35 --- /dev/null +++ b/docs/docs/smartcontracts/ValidatorMgr.md @@ -0,0 +1,405 @@ +# Validator Manager for PoS consensus (ValidatorMgr.sol) + +**contract ValidatorMgr is [Pausable](Pausable.md), [Initializable](Initializable.md)** + +**ValidatorMgr** + +## Structs +### Deposit + +```js +struct Deposit { + uint256 amount, + uint256 availableAt +} +``` + +### Validator + +```js +struct Validator { + uint256 index, + bool isValidator, + bool isGenesis, + struct ValidatorMgr.Deposit[] deposits +} +``` + +### TKN + +```js +struct TKN { + address sender, + uint256 value +} +``` + +## Contract Members +**Constants & Variables** + +```js +//public members +uint256 public baseDeposit; +uint256 public maxNumValidators; +uint256 public freezePeriod; +bytes32 public validatorsChecksum; +uint256 public superNodeAmount; +contract DomainResolver public knsResolver; +//internal members +bytes32 internal nodeNamehash; +address[] internal validatorPool; +struct ValidatorMgr.TKN internal tkn; +//private members +mapping(address => struct ValidatorMgr.Validator) private validatorRegistry; +``` + +## Modifiers + +- [onlyWithMinDeposit](#onlywithmindeposit) +- [onlyValidator](#onlyvalidator) +- [onlyNewCandidate](#onlynewcandidate) + +### onlyWithMinDeposit + +```js +modifier onlyWithMinDeposit() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyValidator + +```js +modifier onlyValidator() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +### onlyNewCandidate + +```js +modifier onlyNewCandidate() internal +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| + +## Functions + +- [initialize](#initialize) +- [isGenesisValidator](#isgenesisvalidator) +- [isValidator](#isvalidator) +- [isSuperNode](#issupernode) +- [getValidatorCount](#getvalidatorcount) +- [getValidatorAtIndex](#getvalidatoratindex) +- [_hasAvailability](#_hasavailability) +- [getMinimumDeposit](#getminimumdeposit) +- [_updateChecksum](#_updatechecksum) +- [_insertValidator](#_insertvalidator) +- [setBaseDeposit](#setbasedeposit) +- [setMaxValidators](#setmaxvalidators) +- [_deleteValidator](#_deletevalidator) +- [_deleteSmallestBidder](#_deletesmallestbidder) +- [getDepositCount](#getdepositcount) +- [getDepositAtIndex](#getdepositatindex) +- [_registerValidator](#_registervalidator) +- [deregisterValidator](#deregistervalidator) +- [_removeDeposits](#_removedeposits) +- [releaseDeposits](#releasedeposits) +- [registerValidator](#registervalidator) + +### initialize + +```js +function initialize(uint256 _baseDeposit, uint256 _maxNumValidators, uint256 _freezePeriod, uint256 _superNodeAmount, address _resolverAddr) public isInitializer +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _baseDeposit | uint256 | base deposit for Validator | +| _maxNumValidators | uint256 | Maximum numbers of Validators. | +| _freezePeriod | uint256 | Freeze period for Validator's deposits. | +| _superNodeAmount | uint256 | Amount required to be considered a super node. | +| _resolverAddr | address | Address of KNS Resolver. | + +### isGenesisValidator + +Checks if given address is Genesis Validator + +```js +function isGenesisValidator(address code) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | Address of an Validator. | + +### isValidator + +Checks if given address is Validator + +```js +function isValidator(address code) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | Address of a Validator to check. | + +### isSuperNode + +Checks if given address is super node + +```js +function isSuperNode(address code) public view +returns(isIndeed bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | Address of a supernode to check. | + +### getValidatorCount + +Get Validator count + +```js +function getValidatorCount() public view +returns(count uint256) +``` + +### getValidatorAtIndex + +Get Validator information + +```js +function getValidatorAtIndex(uint256 index) public view +returns(code address, deposit uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of an Validator to check. | + +### _hasAvailability + +```js +function _hasAvailability() public view +returns(available bool) +``` + +### getMinimumDeposit + +returns the base deposit if there are positions available or +the current smallest deposit required if there aren't positions available. + +```js +function getMinimumDeposit() public view +returns(deposit uint256) +``` + +### _updateChecksum + +updates the checksum + +```js +function _updateChecksum() private +``` + +### _insertValidator + +Add new validator + +```js +function _insertValidator(address code, uint256 deposit) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | Address of an Validator. | +| deposit | uint256 | amount to deposit | + +### setBaseDeposit + +Set new base deposit for Validators + +```js +function setBaseDeposit(uint256 deposit) public onlyOwner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| deposit | uint256 | | + +### setMaxValidators + +Set maximum numbers of Validators + +```js +function setMaxValidators(uint256 max) public onlyOwner +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| max | uint256 | number of max Validators | + +### _deleteValidator + +Delete Validator + +```js +function _deleteValidator(address account) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| account | address | address of a Validator | + +### _deleteSmallestBidder + +removes the Validator with the smallest deposit + +```js +function _deleteSmallestBidder() private +``` + +### getDepositCount + +Get deposit count + +```js +function getDepositCount() public view +returns(count uint256) +``` + +### getDepositAtIndex + +Get deposit at given index + +```js +function getDepositAtIndex(uint256 index) public view +returns(amount uint256, availableAt uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| index | uint256 | index of a Validator to get deposit | + +### _registerValidator + +Register new Validator + +```js +function _registerValidator() private whenNotPaused onlyNewCandidate onlyWithMinDeposit +``` + +### deregisterValidator + +deregister Validator + +```js +function deregisterValidator() public whenNotPaused onlyValidator +``` + +### _removeDeposits + +remove deposit + +```js +function _removeDeposits(address code, uint256 index) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| code | address | address of a Validator | +| index | uint256 | index of a deposit | + +### releaseDeposits + +transfers locked deposit(s) back the user account if they are past the freeze period + +```js +function releaseDeposits() public whenNotPaused +``` + +### registerValidator + +Register Validator + +```js +function registerValidator(address _from, uint256 _value) public +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _from | address | from address | +| _value | uint256 | value to send | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/docs/smartcontracts/strings.md b/docs/docs/smartcontracts/strings.md new file mode 100644 index 000000000..537ada4d6 --- /dev/null +++ b/docs/docs/smartcontracts/strings.md @@ -0,0 +1,497 @@ +# strings.sol + +**strings** + +## Structs +### slice + +```js +struct slice { + uint256 _len, + uint256 _ptr +} +``` + +## Functions + +- [memcpy](#memcpy) +- [toSlice](#toslice) +- [len](#len) +- [toSliceB32](#tosliceb32) +- [copy](#copy) +- [toString](#tostring) +- [len](#len) +- [empty](#empty) +- [compare](#compare) +- [equals](#equals) +- [nextRune](#nextrune) +- [nextRune](#nextrune) +- [ord](#ord) +- [keccak](#keccak) +- [startsWith](#startswith) +- [beyond](#beyond) +- [endsWith](#endswith) +- [until](#until) +- [findPtr](#findptr) +- [rfindPtr](#rfindptr) +- [find](#find) +- [rfind](#rfind) +- [split](#split) +- [split](#split) +- [rsplit](#rsplit) +- [rsplit](#rsplit) +- [count](#count) +- [contains](#contains) +- [concat](#concat) +- [join](#join) + +### memcpy + +```js +function memcpy(uint256 dest, uint256 src, uint256 len) private +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| dest | uint256 | | +| src | uint256 | | +| len | uint256 | | + +### toSlice + +```js +function toSlice(string self) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | string | | + +### len + +```js +function len(bytes32 self) internal +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | bytes32 | | + +### toSliceB32 + +```js +function toSliceB32(bytes32 self) internal +returns(ret struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | bytes32 | | + +### copy + +```js +function copy(struct strings.slice self) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### toString + +```js +function toString(struct strings.slice self) internal +returns(string) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### len + +```js +function len(struct strings.slice self) internal +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### empty + +```js +function empty(struct strings.slice self) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### compare + +```js +function compare(struct strings.slice self, struct strings.slice other) internal +returns(int256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| other | struct strings.slice | | + +### equals + +```js +function equals(struct strings.slice self, struct strings.slice other) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| other | struct strings.slice | | + +### nextRune + +```js +function nextRune(struct strings.slice self, struct strings.slice rune) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| rune | struct strings.slice | | + +### nextRune + +```js +function nextRune(struct strings.slice self) internal +returns(ret struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### ord + +```js +function ord(struct strings.slice self) internal +returns(ret uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### keccak + +```js +function keccak(struct strings.slice self) internal +returns(ret bytes32) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | + +### startsWith + +```js +function startsWith(struct strings.slice self, struct strings.slice needle) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### beyond + +```js +function beyond(struct strings.slice self, struct strings.slice needle) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### endsWith + +```js +function endsWith(struct strings.slice self, struct strings.slice needle) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### until + +```js +function until(struct strings.slice self, struct strings.slice needle) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### findPtr + +```js +function findPtr(uint256 selflen, uint256 selfptr, uint256 needlelen, uint256 needleptr) private +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| selflen | uint256 | | +| selfptr | uint256 | | +| needlelen | uint256 | | +| needleptr | uint256 | | + +### rfindPtr + +```js +function rfindPtr(uint256 selflen, uint256 selfptr, uint256 needlelen, uint256 needleptr) private +returns(uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| selflen | uint256 | | +| selfptr | uint256 | | +| needlelen | uint256 | | +| needleptr | uint256 | | + +### find + +```js +function find(struct strings.slice self, struct strings.slice needle) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### rfind + +```js +function rfind(struct strings.slice self, struct strings.slice needle) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### split + +```js +function split(struct strings.slice self, struct strings.slice needle, struct strings.slice token) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | +| token | struct strings.slice | | + +### split + +```js +function split(struct strings.slice self, struct strings.slice needle) internal +returns(token struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### rsplit + +```js +function rsplit(struct strings.slice self, struct strings.slice needle, struct strings.slice token) internal +returns(struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | +| token | struct strings.slice | | + +### rsplit + +```js +function rsplit(struct strings.slice self, struct strings.slice needle) internal +returns(token struct strings.slice) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### count + +```js +function count(struct strings.slice self, struct strings.slice needle) internal +returns(count uint256) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### contains + +```js +function contains(struct strings.slice self, struct strings.slice needle) internal +returns(bool) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| needle | struct strings.slice | | + +### concat + +```js +function concat(struct strings.slice self, struct strings.slice other) internal +returns(string) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| other | struct strings.slice | | + +### join + +```js +function join(struct strings.slice self, struct strings.slice[] parts) internal +returns(string) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| self | struct strings.slice | | +| parts | struct strings.slice[] | | + +## Contracts + +- [KNSRegistryV1](KNSRegistryV1.md) +- [ValidatorMgr](ValidatorMgr.md) +- [Math](Math.md) +- [NameHash](NameHash.md) +- [SystemVars](SystemVars.md) +- [Stability](Stability.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) +- [TokenReceiver](TokenReceiver.md) +- [SafeMath](SafeMath.md) +- [CappedToken](CappedToken.md) +- [FIFSRegistrar](FIFSRegistrar.md) +- [Initializable](Initializable.md) +- [KNSRegistry](KNSRegistry.md) +- [ExchangeMgr](ExchangeMgr.md) +- [KRC223](KRC223.md) +- [PublicResolver](PublicResolver.md) +- [MultiSigWallet](MultiSigWallet.md) +- [DomainResolver](DomainResolver.md) +- [PriceProvider](PriceProvider.md) +- [BalanceContract](BalanceContract.md) +- [MiningToken](MiningToken.md) +- [MintableToken](MintableToken.md) +- [strings](strings.md) +- [Pausable](Pausable.md) +- [Migrations](Migrations.md) +- [Ownable](Ownable.md) +- [Consensus](Consensus.md) +- [OracleMgr](OracleMgr.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolverMock](DomainResolverMock.md) +- [KNS](KNS.md) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 7202684fd..d08f3a77d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -51,6 +51,39 @@ pages: - Official networks: 'advanced/official-networks.md' - Running local testnet: 'advanced/running-local-testnet.md' - Minting mining tokens: 'advanced/minting-tokens.md' + - Smart Contracs: + - 'Balance Contract': 'smartcontracts/BalanceContract.md' + - 'Capped Token': 'smartcontracts/CappedToken.md' + - 'Consensus': 'smartcontracts/Consensus.md' + - 'Consensus Mock': 'smartcontracts/ConsensusMock.md' + - 'Domain Resolver': 'smartcontracts/DomainResolver.md' + - 'Domain Resolver Mock': 'smartcontracts/DomainResolverMock.md' + - 'Exchange Mgr': 'smartcontracts/ExchangeMgr.md' + - 'FIFS Registrar': 'smartcontracts/FIFSRegistrar.md' + - 'Initializable': 'smartcontracts/Initializable.md' + - 'KNS': 'smartcontracts/KNS.md' + - 'KNS Registry': 'smartcontracts/KNSRegistry.md' + - 'KNS Registry V1': 'smartcontracts/KNSRegistryV1.md' + - 'KRC223': 'smartcontracts/KRC223.md' + - 'Math': 'smartcontracts/Math.md' + - 'Migrations': 'smartcontracts/Migrations.md' + - 'Mining Token': 'smartcontracts/MiningToken.md' + - 'Mintable Token': 'smartcontracts/MintableToken.md' + - 'Multi Sig Wallet': 'smartcontracts/MultiSigWallet.md' + - 'Name Hash': 'smartcontracts/NameHash.md' + - 'Oracle Mgr': 'smartcontracts/OracleMgr.md' + - 'Ownable': 'smartcontracts/Ownable.md' + - 'Pausable': 'smartcontracts/Pausable.md' + - 'Price Provider': 'smartcontracts/PriceProvider.md' + - 'Public Resolver': 'smartcontracts/PublicResolver.md' + - 'Safe Math': 'smartcontracts/SafeMath.md' + - 'Stability': 'smartcontracts/Stability.md' + - 'Strings': 'smartcontracts/strings.md' + - 'System Vars': 'smartcontracts/SystemVars.md' + - 'Token': 'smartcontracts/Token.md' + - 'Token Mock': 'smartcontracts/TokenMock.md' + - 'Token Receiver': 'smartcontracts/TokenReceiver.md' + - 'Validator Mgr': 'smartcontracts/ValidatorMgr.md' - Contributing: - 'Projects': 'contributing/projects.md' - About: From ec5ae9174d4f38b2e677d1ecdf781f9aa4063487 Mon Sep 17 00:00:00 2001 From: Albert Callarisa Date: Wed, 3 Oct 2018 15:40:06 +0200 Subject: [PATCH 07/18] Better use of the docker image --- .drone.yml | 7 +++---- Makefile | 10 +--------- client/contracts/truffle/solidoc.Dockerfile | 11 ----------- 3 files changed, 4 insertions(+), 24 deletions(-) delete mode 100644 client/contracts/truffle/solidoc.Dockerfile diff --git a/.drone.yml b/.drone.yml index 2763b6c14..4da5f2afc 100644 --- a/.drone.yml +++ b/.drone.yml @@ -19,10 +19,9 @@ pipeline: build_solidity_docs: group: build_artifacts - image: kowalatech/solidoc - commands: - - make dev_solidocs_docker_image - - make build_solidity_docs_with_docker + image: kowalatech/solidoc:1.0.1 + commands: + - 'dotnet /app/bin/Release/netcoreapp2.1/publish/Solidoc.dll /go/src/github.com/kowala-tech/kcoin/client/contracts/truffle /go/src/github.com/kowala-tech/kcoin/docs/docs/smartcontracts' when: event: [push,tag] branch: [master,dev] diff --git a/Makefile b/Makefile index 909a17832..c9285118f 100644 --- a/Makefile +++ b/Makefile @@ -202,14 +202,10 @@ build_docs: build_docs_with_docker: @docker run --rm -v $(PWD)/docs:/documents kowalatech/mkdocs $(BUILD_DOCS) -.PHONY: build_solidity_docs_with_docker -build_solidity_docs_with_docker: - @docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/docs/docs/smartcontracts:/out kowalatech/solidoc - ## Dev docker images .PHONY: dev_docker_images -dev_docker_images: dev_explorer_docker_image dev_explorer_sync_docker_image dev_kusd_docker_image dev_bootnode_docker_image dev_faucet_docker_image dev_wallet_backend_docker_image dev_transactions_persistance_docker_image dev_transactions_publisher_docker_image dev_backend_api_docker_image dev_solidocs_docker_image +dev_docker_images: dev_explorer_docker_image dev_explorer_sync_docker_image dev_kusd_docker_image dev_bootnode_docker_image dev_faucet_docker_image dev_wallet_backend_docker_image dev_transactions_persistance_docker_image dev_transactions_publisher_docker_image dev_backend_api_docker_image .PHONY: dev_kusd_docker_image dev_kusd_docker_image: @@ -247,10 +243,6 @@ dev_explorer_docker_image: dev_explorer_sync_docker_image: docker build -t kowalatech/kexplorersync -f explorer/sync.Dockerfile . -.PHONY: dev_solidocs_docker_image -dev_solidocs_docker_image: - docker build -t kowalatech/solidoc -f client/contracts/truffle/solidoc.Dockerfile . - # Tools .PHONY: dep diff --git a/client/contracts/truffle/solidoc.Dockerfile b/client/contracts/truffle/solidoc.Dockerfile deleted file mode 100644 index c33eafc15..000000000 --- a/client/contracts/truffle/solidoc.Dockerfile +++ /dev/null @@ -1,11 +0,0 @@ -FROM microsoft/dotnet:2.1-sdk-alpine AS build-env -RUN apk update && apk add git nodejs python g++ make bash && rm -rf /var/cache/apk/* - -WORKDIR /app -RUN git clone https://github.com/binodnp/solidoc . -RUN dotnet restore -RUN dotnet publish -c Release - -RUN npm install -g truffle@4.1.x - -ENTRYPOINT ["dotnet", "/app/bin/Release/netcoreapp2.1/publish/Solidoc.dll", "/src", "/out"] \ No newline at end of file From f9381af835a2c133a9d6eca35328d769643c07a4 Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Thu, 4 Oct 2018 14:18:09 +0100 Subject: [PATCH 08/18] Updated solidoc docker implementation --- .drone.yml | 11 +++++------ Makefile | 8 +++++++- client/contracts/truffle/README.md | 12 ++++++++++-- 3 files changed, 22 insertions(+), 9 deletions(-) diff --git a/.drone.yml b/.drone.yml index 4da5f2afc..70f3740ab 100644 --- a/.drone.yml +++ b/.drone.yml @@ -18,13 +18,12 @@ pipeline: event: [pull_request] build_solidity_docs: - group: build_artifacts - image: kowalatech/solidoc:1.0.1 + group: solidity_docs + image: kowalatech/solidoc:1.0.2 commands: - 'dotnet /app/bin/Release/netcoreapp2.1/publish/Solidoc.dll /go/src/github.com/kowala-tech/kcoin/client/contracts/truffle /go/src/github.com/kowala-tech/kcoin/docs/docs/smartcontracts' when: - event: [push,tag] - branch: [master,dev] + event: [pull_request] go_generate: group: generate @@ -390,8 +389,8 @@ pipeline: commands: - make build_docs when: - event: [push,tag] - branch: [master,dev] + event: [push] + branch: [dev] build_cdn: group: build_artifacts diff --git a/Makefile b/Makefile index c9285118f..ce049e33a 100644 --- a/Makefile +++ b/Makefile @@ -106,14 +106,20 @@ go_generate: client/contracts/truffle/node_modules go generate ./client/contracts/bindings/utils/namehash.go go generate ./... +.PHONY: docker_generate +docker_generate: docker_go_generate docker_solidoc_generate + .PHONY: docker_go_generate docker_go_generate: docker run --rm -v $(PWD):/go/src/github.com/kowala-tech/kcoin -w /go/src/github.com/kowala-tech/kcoin kowalatech/go:1.0.12 make install_tools go_generate +docker_solidoc_generate: + docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/client/contracts/truffle/docs:/out kowalatech/solidoc:1.0.2 /src /out + .PHONY: assert_no_changes assert_no_changes: git status - @if ! git diff-index --quiet HEAD; then echo 'There are uncommited go generate files.\nRun `make docker_go_generate` to regenerate all of them.'; exit 1; fi + @if ! git diff-index --quiet HEAD; then echo 'There are uncommited generated files.\nRun `make docker_generate` to regenerate all of them.'; exit 1; fi .PHONY: notifications_dep notifications_dep: dep diff --git a/client/contracts/truffle/README.md b/client/contracts/truffle/README.md index 6c6b69288..d28bc6c03 100644 --- a/client/contracts/truffle/README.md +++ b/client/contracts/truffle/README.md @@ -111,8 +111,16 @@ knsContract = await KNSV1.at(knsProxyAddress); # How to generate solidity documentation We are using docker image with built in tool from https://github.com/binodnp/solidoc to generate our documentation for Solidity. + In the main folder of truffle you will need to do these steps: + 1. Build docker image : `docker build . -t kowalatech/solidoc` -2. Run docker image : `docker run --rm -it -v aboslute/path/to/the/project/kcoin/client/contracts/truffle/:/src -v aboslute/path/to/the/project/kcoin/client/contracts/truffle/docs:/outkowalatech/solidoc` +2. Run docker image : `docker run --rm -it -v absolute/path/to/the/project/kcoin/client/contracts/truffle/:/src -v aboslute/path/to/the/project/kcoin/client/contracts/truffle/docs:/out kowalatech/solidoc /src /out` + +First argument is the project path and second is the output folder where all generated docs will be. -First argument is the project path and second is the output folder where all generated docs will be. \ No newline at end of file +Or, from the kcoin root: + +``` +make docker_solidoc_generate +``` From 06b8294e6b5ddfb49352230a87921d6d245e2d98 Mon Sep 17 00:00:00 2001 From: Adrian Hetman Date: Thu, 4 Oct 2018 15:28:42 +0200 Subject: [PATCH 09/18] Smart contracts -> Core Contracts --- docs/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index d08f3a77d..f3ac1cf15 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -51,7 +51,7 @@ pages: - Official networks: 'advanced/official-networks.md' - Running local testnet: 'advanced/running-local-testnet.md' - Minting mining tokens: 'advanced/minting-tokens.md' - - Smart Contracs: + - Core Contracs: - 'Balance Contract': 'smartcontracts/BalanceContract.md' - 'Capped Token': 'smartcontracts/CappedToken.md' - 'Consensus': 'smartcontracts/Consensus.md' From 4e2932009898a77f8e06f2e144d17ec133411edb Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Thu, 4 Oct 2018 14:46:52 +0100 Subject: [PATCH 10/18] Build node modules before anything else --- .drone.yml | 12 ++++++++++-- Makefile | 5 +++++ 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/.drone.yml b/.drone.yml index 70f3740ab..439aff863 100644 --- a/.drone.yml +++ b/.drone.yml @@ -16,12 +16,20 @@ pipeline: - make install_tools when: event: [pull_request] + + truffle_node_modules: + group: truffle_setup + image: kowalatech/go:1.0.12 + commands: + - make client/contracts/truffle/node_modules + when: + event: [pull_request] build_solidity_docs: group: solidity_docs image: kowalatech/solidoc:1.0.2 commands: - - 'dotnet /app/bin/Release/netcoreapp2.1/publish/Solidoc.dll /go/src/github.com/kowala-tech/kcoin/client/contracts/truffle /go/src/github.com/kowala-tech/kcoin/docs/docs/smartcontracts' + - make solidoc_generate when: event: [pull_request] @@ -523,7 +531,7 @@ pipeline: status: failure event: [tag, pull_request] -services: +services2: docker: image: docker:dind command: [ '-l', 'fatal' ] diff --git a/Makefile b/Makefile index ce049e33a..1aefed681 100644 --- a/Makefile +++ b/Makefile @@ -106,6 +106,11 @@ go_generate: client/contracts/truffle/node_modules go generate ./client/contracts/bindings/utils/namehash.go go generate ./... +# This is designed to be run inside a kowalatech/solidoc container +.PHONY: solidoc_generate +solidoc_generate: client/contracts/truffle/node_modules + dotnet /app/bin/Release/netcoreapp2.1/publish/Solidoc.dll /go/src/github.com/kowala-tech/kcoin/client/contracts/truffle /go/src/github.com/kowala-tech/kcoin/docs/docs/smartcontracts + .PHONY: docker_generate docker_generate: docker_go_generate docker_solidoc_generate From cbbf634437a391d05efac563cf10b4e71c4cdbe8 Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Thu, 4 Oct 2018 14:52:04 +0100 Subject: [PATCH 11/18] Regenerated docs; separated assert and build --- .drone.yml | 9 +++- docs/docs/smartcontracts/BalanceContract.md | 48 +++++++++---------- docs/docs/smartcontracts/CappedToken.md | 48 +++++++++---------- docs/docs/smartcontracts/Consensus.md | 48 +++++++++---------- docs/docs/smartcontracts/ConsensusMock.md | 48 +++++++++---------- docs/docs/smartcontracts/DomainResolver.md | 48 +++++++++---------- .../docs/smartcontracts/DomainResolverMock.md | 48 +++++++++---------- docs/docs/smartcontracts/ExchangeMgr.md | 48 +++++++++---------- docs/docs/smartcontracts/FIFSRegistrar.md | 48 +++++++++---------- docs/docs/smartcontracts/Initializable.md | 48 +++++++++---------- docs/docs/smartcontracts/KNS.md | 48 +++++++++---------- docs/docs/smartcontracts/KNSRegistry.md | 48 +++++++++---------- docs/docs/smartcontracts/KNSRegistryV1.md | 48 +++++++++---------- docs/docs/smartcontracts/KRC223.md | 48 +++++++++---------- docs/docs/smartcontracts/Math.md | 48 +++++++++---------- docs/docs/smartcontracts/Migrations.md | 48 +++++++++---------- docs/docs/smartcontracts/MiningToken.md | 48 +++++++++---------- docs/docs/smartcontracts/MintableToken.md | 48 +++++++++---------- docs/docs/smartcontracts/MultiSigWallet.md | 48 +++++++++---------- docs/docs/smartcontracts/NameHash.md | 48 +++++++++---------- docs/docs/smartcontracts/OracleMgr.md | 48 +++++++++---------- docs/docs/smartcontracts/Ownable.md | 48 +++++++++---------- docs/docs/smartcontracts/Pausable.md | 48 +++++++++---------- docs/docs/smartcontracts/PriceProvider.md | 48 +++++++++---------- docs/docs/smartcontracts/PublicResolver.md | 48 +++++++++---------- docs/docs/smartcontracts/SafeMath.md | 48 +++++++++---------- docs/docs/smartcontracts/Stability.md | 48 +++++++++---------- docs/docs/smartcontracts/SystemVars.md | 48 +++++++++---------- docs/docs/smartcontracts/Token.md | 48 +++++++++---------- docs/docs/smartcontracts/TokenMock.md | 48 +++++++++---------- docs/docs/smartcontracts/TokenReceiver.md | 48 +++++++++---------- docs/docs/smartcontracts/ValidatorMgr.md | 48 +++++++++---------- docs/docs/smartcontracts/strings.md | 48 +++++++++---------- 33 files changed, 776 insertions(+), 769 deletions(-) diff --git a/.drone.yml b/.drone.yml index 439aff863..b3618059c 100644 --- a/.drone.yml +++ b/.drone.yml @@ -38,6 +38,13 @@ pipeline: image: kowalatech/go:1.0.12 commands: - make go_generate + when: + event: [pull_request] + + assert_no_changes: + group: assert_no_changes + image: kowalatech/go:1.0.12 + commands: - make assert_no_changes when: event: [pull_request] @@ -531,7 +538,7 @@ pipeline: status: failure event: [tag, pull_request] -services2: +services: docker: image: docker:dind command: [ '-l', 'fatal' ] diff --git a/docs/docs/smartcontracts/BalanceContract.md b/docs/docs/smartcontracts/BalanceContract.md index e18e355c0..508eb88fa 100644 --- a/docs/docs/smartcontracts/BalanceContract.md +++ b/docs/docs/smartcontracts/BalanceContract.md @@ -38,35 +38,35 @@ function tokenFallback(address _from, uint256 _value, bytes _data) public ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/CappedToken.md b/docs/docs/smartcontracts/CappedToken.md index ce048e638..ecc226d56 100644 --- a/docs/docs/smartcontracts/CappedToken.md +++ b/docs/docs/smartcontracts/CappedToken.md @@ -41,35 +41,35 @@ A boolean that indicates if the operation was successful. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/Consensus.md b/docs/docs/smartcontracts/Consensus.md index 896fd46c8..f2016b986 100644 --- a/docs/docs/smartcontracts/Consensus.md +++ b/docs/docs/smartcontracts/Consensus.md @@ -21,35 +21,35 @@ returns(bool) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/ConsensusMock.md b/docs/docs/smartcontracts/ConsensusMock.md index dff40000a..166f11518 100644 --- a/docs/docs/smartcontracts/ConsensusMock.md +++ b/docs/docs/smartcontracts/ConsensusMock.md @@ -28,35 +28,35 @@ returns(bool) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/DomainResolver.md b/docs/docs/smartcontracts/DomainResolver.md index d9e319c46..f453194b2 100644 --- a/docs/docs/smartcontracts/DomainResolver.md +++ b/docs/docs/smartcontracts/DomainResolver.md @@ -25,35 +25,35 @@ The associated address. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/DomainResolverMock.md b/docs/docs/smartcontracts/DomainResolverMock.md index 9085a1a8b..b65b06706 100644 --- a/docs/docs/smartcontracts/DomainResolverMock.md +++ b/docs/docs/smartcontracts/DomainResolverMock.md @@ -28,35 +28,35 @@ returns(address) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/ExchangeMgr.md b/docs/docs/smartcontracts/ExchangeMgr.md index 6ae28fb2d..557c57b6d 100644 --- a/docs/docs/smartcontracts/ExchangeMgr.md +++ b/docs/docs/smartcontracts/ExchangeMgr.md @@ -228,35 +228,35 @@ returns(name string) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/FIFSRegistrar.md b/docs/docs/smartcontracts/FIFSRegistrar.md index 71386c378..2e6c32889 100644 --- a/docs/docs/smartcontracts/FIFSRegistrar.md +++ b/docs/docs/smartcontracts/FIFSRegistrar.md @@ -63,35 +63,35 @@ function register(bytes32 subnode, address owner) public only_owner ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/Initializable.md b/docs/docs/smartcontracts/Initializable.md index 435e308d7..008c35531 100644 --- a/docs/docs/smartcontracts/Initializable.md +++ b/docs/docs/smartcontracts/Initializable.md @@ -38,35 +38,35 @@ modifier isInitializer() internal ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/KNS.md b/docs/docs/smartcontracts/KNS.md index 7bb35e3cd..a76e32125 100644 --- a/docs/docs/smartcontracts/KNS.md +++ b/docs/docs/smartcontracts/KNS.md @@ -115,35 +115,35 @@ returns(uint64) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/KNSRegistry.md b/docs/docs/smartcontracts/KNSRegistry.md index 65b9cd572..fee6b80ab 100644 --- a/docs/docs/smartcontracts/KNSRegistry.md +++ b/docs/docs/smartcontracts/KNSRegistry.md @@ -197,35 +197,35 @@ ttl of the node. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/KNSRegistryV1.md b/docs/docs/smartcontracts/KNSRegistryV1.md index dd65f9bfe..e27194b13 100644 --- a/docs/docs/smartcontracts/KNSRegistryV1.md +++ b/docs/docs/smartcontracts/KNSRegistryV1.md @@ -203,35 +203,35 @@ ttl of the node. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/KRC223.md b/docs/docs/smartcontracts/KRC223.md index 0e1a5f25e..bad84499a 100644 --- a/docs/docs/smartcontracts/KRC223.md +++ b/docs/docs/smartcontracts/KRC223.md @@ -114,35 +114,35 @@ returns(ok bool) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/Math.md b/docs/docs/smartcontracts/Math.md index dbb176476..89febaa3b 100644 --- a/docs/docs/smartcontracts/Math.md +++ b/docs/docs/smartcontracts/Math.md @@ -67,35 +67,35 @@ returns(uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/Migrations.md b/docs/docs/smartcontracts/Migrations.md index f4d1c63d4..2f52b8474 100644 --- a/docs/docs/smartcontracts/Migrations.md +++ b/docs/docs/smartcontracts/Migrations.md @@ -56,35 +56,35 @@ function upgrade(address new_address) public restricted ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/MiningToken.md b/docs/docs/smartcontracts/MiningToken.md index 56f916cbe..f9a1ec60f 100644 --- a/docs/docs/smartcontracts/MiningToken.md +++ b/docs/docs/smartcontracts/MiningToken.md @@ -45,35 +45,35 @@ returns(address) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/MintableToken.md b/docs/docs/smartcontracts/MintableToken.md index 34c131e83..a9ae2dc1e 100644 --- a/docs/docs/smartcontracts/MintableToken.md +++ b/docs/docs/smartcontracts/MintableToken.md @@ -73,35 +73,35 @@ True if the operation was successful. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/MultiSigWallet.md b/docs/docs/smartcontracts/MultiSigWallet.md index 6fb2efbb8..4c337b242 100644 --- a/docs/docs/smartcontracts/MultiSigWallet.md +++ b/docs/docs/smartcontracts/MultiSigWallet.md @@ -477,35 +477,35 @@ Returns array of transaction IDs. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/NameHash.md b/docs/docs/smartcontracts/NameHash.md index 494cf8f6c..48191e98f 100644 --- a/docs/docs/smartcontracts/NameHash.md +++ b/docs/docs/smartcontracts/NameHash.md @@ -25,35 +25,35 @@ _namehash The result of namehash algorithm applied at _node. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/OracleMgr.md b/docs/docs/smartcontracts/OracleMgr.md index 69536a7cc..06d1ee70b 100644 --- a/docs/docs/smartcontracts/OracleMgr.md +++ b/docs/docs/smartcontracts/OracleMgr.md @@ -256,35 +256,35 @@ function submitPrice(uint256 _price) public whenNotPaused onlyOracle onlyOnce ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/Ownable.md b/docs/docs/smartcontracts/Ownable.md index b4bc9d7ef..975162f7c 100644 --- a/docs/docs/smartcontracts/Ownable.md +++ b/docs/docs/smartcontracts/Ownable.md @@ -82,35 +82,35 @@ function _transferOwnership(address _newOwner) internal ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/Pausable.md b/docs/docs/smartcontracts/Pausable.md index 11fd96a67..696f44eac 100644 --- a/docs/docs/smartcontracts/Pausable.md +++ b/docs/docs/smartcontracts/Pausable.md @@ -74,35 +74,35 @@ function unpause() public onlyOwner whenPaused ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/PriceProvider.md b/docs/docs/smartcontracts/PriceProvider.md index e114938ce..2c1afd64f 100644 --- a/docs/docs/smartcontracts/PriceProvider.md +++ b/docs/docs/smartcontracts/PriceProvider.md @@ -15,35 +15,35 @@ returns(uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/PublicResolver.md b/docs/docs/smartcontracts/PublicResolver.md index b0c16fbb9..5f283a13c 100644 --- a/docs/docs/smartcontracts/PublicResolver.md +++ b/docs/docs/smartcontracts/PublicResolver.md @@ -339,35 +339,35 @@ True if the contract implements the requested interface. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/SafeMath.md b/docs/docs/smartcontracts/SafeMath.md index 04262b1eb..a53dc55f5 100644 --- a/docs/docs/smartcontracts/SafeMath.md +++ b/docs/docs/smartcontracts/SafeMath.md @@ -75,35 +75,35 @@ returns(c uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/Stability.md b/docs/docs/smartcontracts/Stability.md index b254cbfc0..233b2354f 100644 --- a/docs/docs/smartcontracts/Stability.md +++ b/docs/docs/smartcontracts/Stability.md @@ -148,35 +148,35 @@ function unsubscribe() public onlySubscriber whenPriceGreaterEqualOne ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/SystemVars.md b/docs/docs/smartcontracts/SystemVars.md index 0b9742e4c..50f432089 100644 --- a/docs/docs/smartcontracts/SystemVars.md +++ b/docs/docs/smartcontracts/SystemVars.md @@ -105,35 +105,35 @@ returns(uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/Token.md b/docs/docs/smartcontracts/Token.md index 5b586ceb1..7e879a4bb 100644 --- a/docs/docs/smartcontracts/Token.md +++ b/docs/docs/smartcontracts/Token.md @@ -178,35 +178,35 @@ returns(balance uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/TokenMock.md b/docs/docs/smartcontracts/TokenMock.md index 7b7b19dee..7545be44d 100644 --- a/docs/docs/smartcontracts/TokenMock.md +++ b/docs/docs/smartcontracts/TokenMock.md @@ -117,35 +117,35 @@ returns(ok bool) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/TokenReceiver.md b/docs/docs/smartcontracts/TokenReceiver.md index 72ef16388..a06c0dc88 100644 --- a/docs/docs/smartcontracts/TokenReceiver.md +++ b/docs/docs/smartcontracts/TokenReceiver.md @@ -22,35 +22,35 @@ function tokenFallback(address _from, uint256 _value, bytes _data) public ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/ValidatorMgr.md b/docs/docs/smartcontracts/ValidatorMgr.md index 340727b35..1d362730e 100644 --- a/docs/docs/smartcontracts/ValidatorMgr.md +++ b/docs/docs/smartcontracts/ValidatorMgr.md @@ -371,35 +371,35 @@ function registerValidator(address _from, uint256 _value) public ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/docs/docs/smartcontracts/strings.md b/docs/docs/smartcontracts/strings.md index 537ada4d6..05a716428 100644 --- a/docs/docs/smartcontracts/strings.md +++ b/docs/docs/smartcontracts/strings.md @@ -463,35 +463,35 @@ returns(string) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) From 07d363f991ccbd02e1d207dd60352d545fc02602 Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Thu, 4 Oct 2018 15:05:18 +0100 Subject: [PATCH 12/18] Moved docs to proper location --- Makefile | 2 +- .../truffle => docs}/docs/BalanceContract.md | 48 +++++++++---------- .../truffle => docs}/docs/CappedToken.md | 48 +++++++++---------- .../truffle => docs}/docs/Consensus.md | 48 +++++++++---------- .../truffle => docs}/docs/ConsensusMock.md | 48 +++++++++---------- .../truffle => docs}/docs/DomainResolver.md | 48 +++++++++---------- .../docs/DomainResolverMock.md | 48 +++++++++---------- .../truffle => docs}/docs/ExchangeMgr.md | 48 +++++++++---------- .../truffle => docs}/docs/FIFSRegistrar.md | 48 +++++++++---------- .../truffle => docs}/docs/Initializable.md | 48 +++++++++---------- .../contracts/truffle => docs}/docs/KNS.md | 48 +++++++++---------- .../truffle => docs}/docs/KNSRegistry.md | 48 +++++++++---------- .../truffle => docs}/docs/KNSRegistryV1.md | 48 +++++++++---------- .../contracts/truffle => docs}/docs/KRC223.md | 48 +++++++++---------- .../contracts/truffle => docs}/docs/Math.md | 48 +++++++++---------- .../truffle => docs}/docs/Migrations.md | 48 +++++++++---------- .../truffle => docs}/docs/MiningToken.md | 48 +++++++++---------- .../truffle => docs}/docs/MintableToken.md | 48 +++++++++---------- .../truffle => docs}/docs/MultiSigWallet.md | 48 +++++++++---------- .../truffle => docs}/docs/NameHash.md | 48 +++++++++---------- .../truffle => docs}/docs/OracleMgr.md | 48 +++++++++---------- .../truffle => docs}/docs/Ownable.md | 48 +++++++++---------- .../truffle => docs}/docs/Pausable.md | 48 +++++++++---------- .../truffle => docs}/docs/PriceProvider.md | 48 +++++++++---------- .../truffle => docs}/docs/PublicResolver.md | 48 +++++++++---------- .../truffle => docs}/docs/SafeMath.md | 48 +++++++++---------- .../truffle => docs}/docs/Stability.md | 48 +++++++++---------- .../truffle => docs}/docs/SystemVars.md | 48 +++++++++---------- .../contracts/truffle => docs}/docs/Token.md | 48 +++++++++---------- .../truffle => docs}/docs/TokenMock.md | 48 +++++++++---------- .../truffle => docs}/docs/TokenReceiver.md | 48 +++++++++---------- .../truffle => docs}/docs/ValidatorMgr.md | 48 +++++++++---------- .../truffle => docs}/docs/strings.md | 48 +++++++++---------- 33 files changed, 769 insertions(+), 769 deletions(-) rename {client/contracts/truffle => docs}/docs/BalanceContract.md (96%) rename {client/contracts/truffle => docs}/docs/CappedToken.md (96%) rename {client/contracts/truffle => docs}/docs/Consensus.md (96%) rename {client/contracts/truffle => docs}/docs/ConsensusMock.md (96%) rename {client/contracts/truffle => docs}/docs/DomainResolver.md (96%) rename {client/contracts/truffle => docs}/docs/DomainResolverMock.md (96%) rename {client/contracts/truffle => docs}/docs/ExchangeMgr.md (96%) rename {client/contracts/truffle => docs}/docs/FIFSRegistrar.md (96%) rename {client/contracts/truffle => docs}/docs/Initializable.md (96%) rename {client/contracts/truffle => docs}/docs/KNS.md (96%) rename {client/contracts/truffle => docs}/docs/KNSRegistry.md (96%) rename {client/contracts/truffle => docs}/docs/KNSRegistryV1.md (96%) rename {client/contracts/truffle => docs}/docs/KRC223.md (95%) rename {client/contracts/truffle => docs}/docs/Math.md (96%) rename {client/contracts/truffle => docs}/docs/Migrations.md (96%) rename {client/contracts/truffle => docs}/docs/MiningToken.md (96%) rename {client/contracts/truffle => docs}/docs/MintableToken.md (95%) rename {client/contracts/truffle => docs}/docs/MultiSigWallet.md (96%) rename {client/contracts/truffle => docs}/docs/NameHash.md (96%) rename {client/contracts/truffle => docs}/docs/OracleMgr.md (96%) rename {client/contracts/truffle => docs}/docs/Ownable.md (96%) rename {client/contracts/truffle => docs}/docs/Pausable.md (95%) rename {client/contracts/truffle => docs}/docs/PriceProvider.md (96%) rename {client/contracts/truffle => docs}/docs/PublicResolver.md (96%) rename {client/contracts/truffle => docs}/docs/SafeMath.md (96%) rename {client/contracts/truffle => docs}/docs/Stability.md (96%) rename {client/contracts/truffle => docs}/docs/SystemVars.md (96%) rename {client/contracts/truffle => docs}/docs/Token.md (96%) rename {client/contracts/truffle => docs}/docs/TokenMock.md (95%) rename {client/contracts/truffle => docs}/docs/TokenReceiver.md (96%) rename {client/contracts/truffle => docs}/docs/ValidatorMgr.md (96%) rename {client/contracts/truffle => docs}/docs/strings.md (96%) diff --git a/Makefile b/Makefile index 1aefed681..29908f61d 100644 --- a/Makefile +++ b/Makefile @@ -119,7 +119,7 @@ docker_go_generate: docker run --rm -v $(PWD):/go/src/github.com/kowala-tech/kcoin -w /go/src/github.com/kowala-tech/kcoin kowalatech/go:1.0.12 make install_tools go_generate docker_solidoc_generate: - docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/client/contracts/truffle/docs:/out kowalatech/solidoc:1.0.2 /src /out + docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/docs/docs:/out kowalatech/solidoc:1.0.2 /src /out .PHONY: assert_no_changes assert_no_changes: diff --git a/client/contracts/truffle/docs/BalanceContract.md b/docs/docs/BalanceContract.md similarity index 96% rename from client/contracts/truffle/docs/BalanceContract.md rename to docs/docs/BalanceContract.md index e18e355c0..508eb88fa 100644 --- a/client/contracts/truffle/docs/BalanceContract.md +++ b/docs/docs/BalanceContract.md @@ -38,35 +38,35 @@ function tokenFallback(address _from, uint256 _value, bytes _data) public ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/CappedToken.md b/docs/docs/CappedToken.md similarity index 96% rename from client/contracts/truffle/docs/CappedToken.md rename to docs/docs/CappedToken.md index ce048e638..ecc226d56 100644 --- a/client/contracts/truffle/docs/CappedToken.md +++ b/docs/docs/CappedToken.md @@ -41,35 +41,35 @@ A boolean that indicates if the operation was successful. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/Consensus.md b/docs/docs/Consensus.md similarity index 96% rename from client/contracts/truffle/docs/Consensus.md rename to docs/docs/Consensus.md index 896fd46c8..f2016b986 100644 --- a/client/contracts/truffle/docs/Consensus.md +++ b/docs/docs/Consensus.md @@ -21,35 +21,35 @@ returns(bool) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/ConsensusMock.md b/docs/docs/ConsensusMock.md similarity index 96% rename from client/contracts/truffle/docs/ConsensusMock.md rename to docs/docs/ConsensusMock.md index dff40000a..166f11518 100644 --- a/client/contracts/truffle/docs/ConsensusMock.md +++ b/docs/docs/ConsensusMock.md @@ -28,35 +28,35 @@ returns(bool) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/DomainResolver.md b/docs/docs/DomainResolver.md similarity index 96% rename from client/contracts/truffle/docs/DomainResolver.md rename to docs/docs/DomainResolver.md index d9e319c46..f453194b2 100644 --- a/client/contracts/truffle/docs/DomainResolver.md +++ b/docs/docs/DomainResolver.md @@ -25,35 +25,35 @@ The associated address. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/DomainResolverMock.md b/docs/docs/DomainResolverMock.md similarity index 96% rename from client/contracts/truffle/docs/DomainResolverMock.md rename to docs/docs/DomainResolverMock.md index 9085a1a8b..b65b06706 100644 --- a/client/contracts/truffle/docs/DomainResolverMock.md +++ b/docs/docs/DomainResolverMock.md @@ -28,35 +28,35 @@ returns(address) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/ExchangeMgr.md b/docs/docs/ExchangeMgr.md similarity index 96% rename from client/contracts/truffle/docs/ExchangeMgr.md rename to docs/docs/ExchangeMgr.md index 6ae28fb2d..557c57b6d 100644 --- a/client/contracts/truffle/docs/ExchangeMgr.md +++ b/docs/docs/ExchangeMgr.md @@ -228,35 +228,35 @@ returns(name string) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/FIFSRegistrar.md b/docs/docs/FIFSRegistrar.md similarity index 96% rename from client/contracts/truffle/docs/FIFSRegistrar.md rename to docs/docs/FIFSRegistrar.md index 71386c378..2e6c32889 100644 --- a/client/contracts/truffle/docs/FIFSRegistrar.md +++ b/docs/docs/FIFSRegistrar.md @@ -63,35 +63,35 @@ function register(bytes32 subnode, address owner) public only_owner ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/Initializable.md b/docs/docs/Initializable.md similarity index 96% rename from client/contracts/truffle/docs/Initializable.md rename to docs/docs/Initializable.md index 435e308d7..008c35531 100644 --- a/client/contracts/truffle/docs/Initializable.md +++ b/docs/docs/Initializable.md @@ -38,35 +38,35 @@ modifier isInitializer() internal ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/KNS.md b/docs/docs/KNS.md similarity index 96% rename from client/contracts/truffle/docs/KNS.md rename to docs/docs/KNS.md index 7bb35e3cd..a76e32125 100644 --- a/client/contracts/truffle/docs/KNS.md +++ b/docs/docs/KNS.md @@ -115,35 +115,35 @@ returns(uint64) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/KNSRegistry.md b/docs/docs/KNSRegistry.md similarity index 96% rename from client/contracts/truffle/docs/KNSRegistry.md rename to docs/docs/KNSRegistry.md index 65b9cd572..fee6b80ab 100644 --- a/client/contracts/truffle/docs/KNSRegistry.md +++ b/docs/docs/KNSRegistry.md @@ -197,35 +197,35 @@ ttl of the node. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/KNSRegistryV1.md b/docs/docs/KNSRegistryV1.md similarity index 96% rename from client/contracts/truffle/docs/KNSRegistryV1.md rename to docs/docs/KNSRegistryV1.md index dd65f9bfe..e27194b13 100644 --- a/client/contracts/truffle/docs/KNSRegistryV1.md +++ b/docs/docs/KNSRegistryV1.md @@ -203,35 +203,35 @@ ttl of the node. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/KRC223.md b/docs/docs/KRC223.md similarity index 95% rename from client/contracts/truffle/docs/KRC223.md rename to docs/docs/KRC223.md index 0e1a5f25e..bad84499a 100644 --- a/client/contracts/truffle/docs/KRC223.md +++ b/docs/docs/KRC223.md @@ -114,35 +114,35 @@ returns(ok bool) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/Math.md b/docs/docs/Math.md similarity index 96% rename from client/contracts/truffle/docs/Math.md rename to docs/docs/Math.md index dbb176476..89febaa3b 100644 --- a/client/contracts/truffle/docs/Math.md +++ b/docs/docs/Math.md @@ -67,35 +67,35 @@ returns(uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/Migrations.md b/docs/docs/Migrations.md similarity index 96% rename from client/contracts/truffle/docs/Migrations.md rename to docs/docs/Migrations.md index f4d1c63d4..2f52b8474 100644 --- a/client/contracts/truffle/docs/Migrations.md +++ b/docs/docs/Migrations.md @@ -56,35 +56,35 @@ function upgrade(address new_address) public restricted ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/MiningToken.md b/docs/docs/MiningToken.md similarity index 96% rename from client/contracts/truffle/docs/MiningToken.md rename to docs/docs/MiningToken.md index 56f916cbe..f9a1ec60f 100644 --- a/client/contracts/truffle/docs/MiningToken.md +++ b/docs/docs/MiningToken.md @@ -45,35 +45,35 @@ returns(address) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/MintableToken.md b/docs/docs/MintableToken.md similarity index 95% rename from client/contracts/truffle/docs/MintableToken.md rename to docs/docs/MintableToken.md index 34c131e83..a9ae2dc1e 100644 --- a/client/contracts/truffle/docs/MintableToken.md +++ b/docs/docs/MintableToken.md @@ -73,35 +73,35 @@ True if the operation was successful. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/MultiSigWallet.md b/docs/docs/MultiSigWallet.md similarity index 96% rename from client/contracts/truffle/docs/MultiSigWallet.md rename to docs/docs/MultiSigWallet.md index 6fb2efbb8..4c337b242 100644 --- a/client/contracts/truffle/docs/MultiSigWallet.md +++ b/docs/docs/MultiSigWallet.md @@ -477,35 +477,35 @@ Returns array of transaction IDs. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/NameHash.md b/docs/docs/NameHash.md similarity index 96% rename from client/contracts/truffle/docs/NameHash.md rename to docs/docs/NameHash.md index 494cf8f6c..48191e98f 100644 --- a/client/contracts/truffle/docs/NameHash.md +++ b/docs/docs/NameHash.md @@ -25,35 +25,35 @@ _namehash The result of namehash algorithm applied at _node. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/OracleMgr.md b/docs/docs/OracleMgr.md similarity index 96% rename from client/contracts/truffle/docs/OracleMgr.md rename to docs/docs/OracleMgr.md index 69536a7cc..06d1ee70b 100644 --- a/client/contracts/truffle/docs/OracleMgr.md +++ b/docs/docs/OracleMgr.md @@ -256,35 +256,35 @@ function submitPrice(uint256 _price) public whenNotPaused onlyOracle onlyOnce ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/Ownable.md b/docs/docs/Ownable.md similarity index 96% rename from client/contracts/truffle/docs/Ownable.md rename to docs/docs/Ownable.md index b4bc9d7ef..975162f7c 100644 --- a/client/contracts/truffle/docs/Ownable.md +++ b/docs/docs/Ownable.md @@ -82,35 +82,35 @@ function _transferOwnership(address _newOwner) internal ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/Pausable.md b/docs/docs/Pausable.md similarity index 95% rename from client/contracts/truffle/docs/Pausable.md rename to docs/docs/Pausable.md index 11fd96a67..696f44eac 100644 --- a/client/contracts/truffle/docs/Pausable.md +++ b/docs/docs/Pausable.md @@ -74,35 +74,35 @@ function unpause() public onlyOwner whenPaused ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/PriceProvider.md b/docs/docs/PriceProvider.md similarity index 96% rename from client/contracts/truffle/docs/PriceProvider.md rename to docs/docs/PriceProvider.md index e114938ce..2c1afd64f 100644 --- a/client/contracts/truffle/docs/PriceProvider.md +++ b/docs/docs/PriceProvider.md @@ -15,35 +15,35 @@ returns(uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/PublicResolver.md b/docs/docs/PublicResolver.md similarity index 96% rename from client/contracts/truffle/docs/PublicResolver.md rename to docs/docs/PublicResolver.md index b0c16fbb9..5f283a13c 100644 --- a/client/contracts/truffle/docs/PublicResolver.md +++ b/docs/docs/PublicResolver.md @@ -339,35 +339,35 @@ True if the contract implements the requested interface. ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/SafeMath.md b/docs/docs/SafeMath.md similarity index 96% rename from client/contracts/truffle/docs/SafeMath.md rename to docs/docs/SafeMath.md index 04262b1eb..a53dc55f5 100644 --- a/client/contracts/truffle/docs/SafeMath.md +++ b/docs/docs/SafeMath.md @@ -75,35 +75,35 @@ returns(c uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/Stability.md b/docs/docs/Stability.md similarity index 96% rename from client/contracts/truffle/docs/Stability.md rename to docs/docs/Stability.md index b254cbfc0..233b2354f 100644 --- a/client/contracts/truffle/docs/Stability.md +++ b/docs/docs/Stability.md @@ -148,35 +148,35 @@ function unsubscribe() public onlySubscriber whenPriceGreaterEqualOne ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/SystemVars.md b/docs/docs/SystemVars.md similarity index 96% rename from client/contracts/truffle/docs/SystemVars.md rename to docs/docs/SystemVars.md index 0b9742e4c..50f432089 100644 --- a/client/contracts/truffle/docs/SystemVars.md +++ b/docs/docs/SystemVars.md @@ -105,35 +105,35 @@ returns(uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/Token.md b/docs/docs/Token.md similarity index 96% rename from client/contracts/truffle/docs/Token.md rename to docs/docs/Token.md index 5b586ceb1..7e879a4bb 100644 --- a/client/contracts/truffle/docs/Token.md +++ b/docs/docs/Token.md @@ -178,35 +178,35 @@ returns(balance uint256) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/TokenMock.md b/docs/docs/TokenMock.md similarity index 95% rename from client/contracts/truffle/docs/TokenMock.md rename to docs/docs/TokenMock.md index 7b7b19dee..7545be44d 100644 --- a/client/contracts/truffle/docs/TokenMock.md +++ b/docs/docs/TokenMock.md @@ -117,35 +117,35 @@ returns(ok bool) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/TokenReceiver.md b/docs/docs/TokenReceiver.md similarity index 96% rename from client/contracts/truffle/docs/TokenReceiver.md rename to docs/docs/TokenReceiver.md index 72ef16388..a06c0dc88 100644 --- a/client/contracts/truffle/docs/TokenReceiver.md +++ b/docs/docs/TokenReceiver.md @@ -22,35 +22,35 @@ function tokenFallback(address _from, uint256 _value, bytes _data) public ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/ValidatorMgr.md b/docs/docs/ValidatorMgr.md similarity index 96% rename from client/contracts/truffle/docs/ValidatorMgr.md rename to docs/docs/ValidatorMgr.md index 340727b35..1d362730e 100644 --- a/client/contracts/truffle/docs/ValidatorMgr.md +++ b/docs/docs/ValidatorMgr.md @@ -371,35 +371,35 @@ function registerValidator(address _from, uint256 _value) public ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) diff --git a/client/contracts/truffle/docs/strings.md b/docs/docs/strings.md similarity index 96% rename from client/contracts/truffle/docs/strings.md rename to docs/docs/strings.md index 537ada4d6..05a716428 100644 --- a/client/contracts/truffle/docs/strings.md +++ b/docs/docs/strings.md @@ -463,35 +463,35 @@ returns(string) ## Contracts -- [KNSRegistryV1](KNSRegistryV1.md) +- [DomainResolverMock](DomainResolverMock.md) - [ValidatorMgr](ValidatorMgr.md) -- [Math](Math.md) -- [NameHash](NameHash.md) -- [SystemVars](SystemVars.md) -- [Stability](Stability.md) -- [Token](Token.md) -- [TokenMock](TokenMock.md) -- [TokenReceiver](TokenReceiver.md) - [SafeMath](SafeMath.md) -- [CappedToken](CappedToken.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [Initializable](Initializable.md) -- [KNSRegistry](KNSRegistry.md) -- [ExchangeMgr](ExchangeMgr.md) +- [MintableToken](MintableToken.md) +- [Ownable](Ownable.md) - [KRC223](KRC223.md) +- [KNSRegistry](KNSRegistry.md) +- [Token](Token.md) +- [OracleMgr](OracleMgr.md) +- [NameHash](NameHash.md) +- [KNS](KNS.md) +- [Pausable](Pausable.md) +- [TokenMock](TokenMock.md) +- [strings](strings.md) +- [Math](Math.md) +- [BalanceContract](BalanceContract.md) - [PublicResolver](PublicResolver.md) - [MultiSigWallet](MultiSigWallet.md) -- [DomainResolver](DomainResolver.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [ExchangeMgr](ExchangeMgr.md) +- [Migrations](Migrations.md) +- [SystemVars](SystemVars.md) +- [FIFSRegistrar](FIFSRegistrar.md) - [PriceProvider](PriceProvider.md) -- [BalanceContract](BalanceContract.md) +- [Initializable](Initializable.md) - [MiningToken](MiningToken.md) -- [MintableToken](MintableToken.md) -- [strings](strings.md) -- [Pausable](Pausable.md) -- [Migrations](Migrations.md) -- [Ownable](Ownable.md) -- [Consensus](Consensus.md) -- [OracleMgr](OracleMgr.md) - [ConsensusMock](ConsensusMock.md) -- [DomainResolverMock](DomainResolverMock.md) -- [KNS](KNS.md) +- [Stability](Stability.md) +- [TokenReceiver](TokenReceiver.md) +- [DomainResolver](DomainResolver.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) From 16a5f98417e8a1adbc371776be12577baf563e41 Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Thu, 4 Oct 2018 15:19:58 +0100 Subject: [PATCH 13/18] Added git debugging --- Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/Makefile b/Makefile index 29908f61d..82005d4c5 100644 --- a/Makefile +++ b/Makefile @@ -123,6 +123,7 @@ docker_solidoc_generate: .PHONY: assert_no_changes assert_no_changes: + git --no-pager diff git status @if ! git diff-index --quiet HEAD; then echo 'There are uncommited generated files.\nRun `make docker_generate` to regenerate all of them.'; exit 1; fi From 11febda31c65456733ba2cc068b28e62695f70ef Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Thu, 4 Oct 2018 15:28:22 +0100 Subject: [PATCH 14/18] Moved docs to the proper directory --- Makefile | 3 +- docs/docs/BalanceContract.md | 72 ----- docs/docs/CappedToken.md | 75 ----- docs/docs/Consensus.md | 55 ---- docs/docs/ConsensusMock.md | 62 ---- docs/docs/DomainResolver.md | 59 ---- docs/docs/DomainResolverMock.md | 62 ---- docs/docs/ExchangeMgr.md | 262 ---------------- docs/docs/FIFSRegistrar.md | 97 ------ docs/docs/Initializable.md | 72 ----- docs/docs/KNS.md | 149 ---------- docs/docs/KNSRegistry.md | 231 --------------- docs/docs/KNSRegistryV1.md | 237 --------------- docs/docs/KRC223.md | 148 --------- docs/docs/Math.md | 101 ------- docs/docs/Migrations.md | 90 ------ docs/docs/MiningToken.md | 79 ----- docs/docs/MintableToken.md | 107 ------- docs/docs/MultiSigWallet.md | 511 -------------------------------- docs/docs/NameHash.md | 59 ---- docs/docs/OracleMgr.md | 290 ------------------ docs/docs/Ownable.md | 116 -------- docs/docs/Pausable.md | 108 ------- docs/docs/PriceProvider.md | 49 --- docs/docs/PublicResolver.md | 373 ----------------------- docs/docs/SafeMath.md | 109 ------- docs/docs/Stability.md | 182 ------------ docs/docs/SystemVars.md | 139 --------- docs/docs/Token.md | 212 ------------- docs/docs/TokenMock.md | 151 ---------- docs/docs/TokenReceiver.md | 56 ---- docs/docs/ValidatorMgr.md | 405 ------------------------- docs/docs/strings.md | 497 ------------------------------- 33 files changed, 1 insertion(+), 5217 deletions(-) delete mode 100644 docs/docs/BalanceContract.md delete mode 100644 docs/docs/CappedToken.md delete mode 100644 docs/docs/Consensus.md delete mode 100644 docs/docs/ConsensusMock.md delete mode 100644 docs/docs/DomainResolver.md delete mode 100644 docs/docs/DomainResolverMock.md delete mode 100644 docs/docs/ExchangeMgr.md delete mode 100644 docs/docs/FIFSRegistrar.md delete mode 100644 docs/docs/Initializable.md delete mode 100644 docs/docs/KNS.md delete mode 100644 docs/docs/KNSRegistry.md delete mode 100644 docs/docs/KNSRegistryV1.md delete mode 100644 docs/docs/KRC223.md delete mode 100644 docs/docs/Math.md delete mode 100644 docs/docs/Migrations.md delete mode 100644 docs/docs/MiningToken.md delete mode 100644 docs/docs/MintableToken.md delete mode 100644 docs/docs/MultiSigWallet.md delete mode 100644 docs/docs/NameHash.md delete mode 100644 docs/docs/OracleMgr.md delete mode 100644 docs/docs/Ownable.md delete mode 100644 docs/docs/Pausable.md delete mode 100644 docs/docs/PriceProvider.md delete mode 100644 docs/docs/PublicResolver.md delete mode 100644 docs/docs/SafeMath.md delete mode 100644 docs/docs/Stability.md delete mode 100644 docs/docs/SystemVars.md delete mode 100644 docs/docs/Token.md delete mode 100644 docs/docs/TokenMock.md delete mode 100644 docs/docs/TokenReceiver.md delete mode 100644 docs/docs/ValidatorMgr.md delete mode 100644 docs/docs/strings.md diff --git a/Makefile b/Makefile index 82005d4c5..fddc4d1ca 100644 --- a/Makefile +++ b/Makefile @@ -119,11 +119,10 @@ docker_go_generate: docker run --rm -v $(PWD):/go/src/github.com/kowala-tech/kcoin -w /go/src/github.com/kowala-tech/kcoin kowalatech/go:1.0.12 make install_tools go_generate docker_solidoc_generate: - docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/docs/docs:/out kowalatech/solidoc:1.0.2 /src /out + docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/docs/docs/smartcontracts:/out kowalatech/solidoc:1.0.2 /src /out .PHONY: assert_no_changes assert_no_changes: - git --no-pager diff git status @if ! git diff-index --quiet HEAD; then echo 'There are uncommited generated files.\nRun `make docker_generate` to regenerate all of them.'; exit 1; fi diff --git a/docs/docs/BalanceContract.md b/docs/docs/BalanceContract.md deleted file mode 100644 index 508eb88fa..000000000 --- a/docs/docs/BalanceContract.md +++ /dev/null @@ -1,72 +0,0 @@ -# BalanceContract.sol - -**contract BalanceContract is [TokenReceiver](TokenReceiver.md)** - -**BalanceContract** - -## Contract Members -**Constants & Variables** - -```js -//internal members -address internal owner; -bytes internal data; -//public members -address public from; -uint256 public value; -``` - -## Functions - -- [tokenFallback](#tokenfallback) - -### tokenFallback - -:small_red_triangle: overrides [TokenReceiver.tokenFallback](TokenReceiver.md#tokenfallback) - -```js -function tokenFallback(address _from, uint256 _value, bytes _data) public -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _from | address | | -| _value | uint256 | | -| _data | bytes | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/CappedToken.md b/docs/docs/CappedToken.md deleted file mode 100644 index ecc226d56..000000000 --- a/docs/docs/CappedToken.md +++ /dev/null @@ -1,75 +0,0 @@ -# Capped token (CappedToken.sol) - -**contract CappedToken is [MintableToken](MintableToken.md)** - -**CappedToken** - -Mintable token with a token cap. - -## Contract Members -**Constants & Variables** - -```js -uint256 public cap; -``` - -## Functions - -- [mint](#mint) - -### mint - -:small_red_triangle: overrides [MintableToken.mint](MintableToken.md#mint) - -Function to mint tokens - -```js -function mint(address _to, uint256 _amount) public onlyOwner canMint -returns(bool) -``` - -**Returns** - -A boolean that indicates if the operation was successful. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _to | address | The address that will receive the minted tokens. | -| _amount | uint256 | The amount of tokens to mint. | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/Consensus.md b/docs/docs/Consensus.md deleted file mode 100644 index f2016b986..000000000 --- a/docs/docs/Consensus.md +++ /dev/null @@ -1,55 +0,0 @@ -# Consensus.sol - -**Consensus** - -## Functions - -- [isSuperNode](#issupernode) - -### isSuperNode - -```js -function isSuperNode(address identity) public view -returns(bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| identity | address | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/ConsensusMock.md b/docs/docs/ConsensusMock.md deleted file mode 100644 index 166f11518..000000000 --- a/docs/docs/ConsensusMock.md +++ /dev/null @@ -1,62 +0,0 @@ -# ConsensusMock.sol - -**ConsensusMock** - -## Contract Members -**Constants & Variables** - -```js -bool internal superNode; -``` - -## Functions - -- [isSuperNode](#issupernode) - -### isSuperNode - -```js -function isSuperNode(address identity) public view -returns(bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| identity | address | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/DomainResolver.md b/docs/docs/DomainResolver.md deleted file mode 100644 index f453194b2..000000000 --- a/docs/docs/DomainResolver.md +++ /dev/null @@ -1,59 +0,0 @@ -# DomainResolver.sol - -**DomainResolver** - -## Functions - -- [addr](#addr) - -### addr - -```js -function addr(bytes32 node) public view -returns(address) -``` - -**Returns** - -The associated address. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The KNS node to query. | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/DomainResolverMock.md b/docs/docs/DomainResolverMock.md deleted file mode 100644 index b65b06706..000000000 --- a/docs/docs/DomainResolverMock.md +++ /dev/null @@ -1,62 +0,0 @@ -# DomainResolverMock.sol - -**DomainResolverMock** - -## Contract Members -**Constants & Variables** - -```js -address internal domainAddr; -``` - -## Functions - -- [addr](#addr) - -### addr - -```js -function addr(bytes32 node) public view -returns(address) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/ExchangeMgr.md b/docs/docs/ExchangeMgr.md deleted file mode 100644 index 557c57b6d..000000000 --- a/docs/docs/ExchangeMgr.md +++ /dev/null @@ -1,262 +0,0 @@ -# Exchange Manager contract (ExchangeMgr.sol) - -**contract ExchangeMgr is [Pausable](Pausable.md), [Initializable](Initializable.md)** - -**ExchangeMgr** - -## Structs -### Exchange - -```js -struct Exchange { - uint256 index, - bool isExchange, - bool isWhitelisted -} -``` - -## Contract Members -**Constants & Variables** - -```js -//private members -mapping(string => struct ExchangeMgr.Exchange) private exchangeRegistry; -//public members -string[] public whitelist; -``` - -**Events** - -```js -event Whitelisted(string exchange); -event Blacklisted(string exchange); -event Addition(string exchange); -event Removal(string exchange); -``` - -## Modifiers - -- [onlyNewCandidate](#onlynewcandidate) -- [onlyExchange](#onlyexchange) -- [onlyWhitelistedExchange](#onlywhitelistedexchange) -- [onlyBlacklistedExchange](#onlyblacklistedexchange) - -### onlyNewCandidate - -```js -modifier onlyNewCandidate(string name) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | | - -### onlyExchange - -```js -modifier onlyExchange(string name) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | | - -### onlyWhitelistedExchange - -```js -modifier onlyWhitelistedExchange(string name) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | | - -### onlyBlacklistedExchange - -```js -modifier onlyBlacklistedExchange(string name) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | | - -## Functions - -- [addExchange](#addexchange) -- [removeExchange](#removeexchange) -- [whitelistExchange](#whitelistexchange) -- [blacklistExchange](#blacklistexchange) -- [isExchange](#isexchange) -- [isWhitelistedExchange](#iswhitelistedexchange) -- [isBlacklistedExchange](#isblacklistedexchange) -- [getWhitelistedExchangeCount](#getwhitelistedexchangecount) -- [getWhitelistedExchangeAtIndex](#getwhitelistedexchangeatindex) - -### addExchange - -Adds and whitelists an exchange. - -```js -function addExchange(string name) public whenNotPaused onlyOwner onlyNewCandidate -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | exchange name. | - -### removeExchange - -Removes an exchange. - -```js -function removeExchange(string name) public whenNotPaused onlyOwner onlyExchange -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | exchange name. | - -### whitelistExchange - -Whitelists an exchange. - -```js -function whitelistExchange(string name) public whenNotPaused onlyOwner onlyBlacklistedExchange -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | exchange name. | - -### blacklistExchange - -Blacklists an exchange. - -```js -function blacklistExchange(string name) public whenNotPaused onlyOwner onlyWhitelistedExchange -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | exchange name. | - -### isExchange - -checks whether the given name is an whitelisted exchange or not - -```js -function isExchange(string name) public view -returns(isIndeed bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | exchange name. | - -### isWhitelistedExchange - -checks whether the given name is an whitelisted exchange or not - -```js -function isWhitelistedExchange(string name) public view -returns(isIndeed bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | exchange name. | - -### isBlacklistedExchange - -checks whether the given name is a blacklisted exchange or not - -```js -function isBlacklistedExchange(string name) public view -returns(isIndeed bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| name | string | exchange name. | - -### getWhitelistedExchangeCount - -get whitelisted exchange count - -```js -function getWhitelistedExchangeCount() public view -returns(count uint256) -``` - -### getWhitelistedExchangeAtIndex - -get whitelisted exchange information - -```js -function getWhitelistedExchangeAtIndex(uint256 index) public view -returns(name string) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| index | uint256 | index of a given exchange in the whitelist | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/FIFSRegistrar.md b/docs/docs/FIFSRegistrar.md deleted file mode 100644 index 2e6c32889..000000000 --- a/docs/docs/FIFSRegistrar.md +++ /dev/null @@ -1,97 +0,0 @@ -# FIFSRegistrar.sol - -**contract FIFSRegistrar is [Initializable](Initializable.md)** - -**FIFSRegistrar** - -## Contract Members -**Constants & Variables** - -```js -contract KNS internal kns; -bytes32 internal rootNode; -``` - -## Modifiers - -- [only_owner](#only_owner) - -### only_owner - -```js -modifier only_owner(bytes32 subnode) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| subnode | bytes32 | | - -## Functions - -- [initialize](#initialize) -- [register](#register) - -### initialize - -initialize function for Proxy Pattern. - -```js -function initialize(KNS knsAddr, bytes32 node) public isInitializer -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| knsAddr | KNS | The address of the KNS registry. | -| node | bytes32 | The node that this registrar administers. | - -### register - -```js -function register(bytes32 subnode, address owner) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| subnode | bytes32 | The hash of the label to register. | -| owner | address | The address of the new owner. | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/Initializable.md b/docs/docs/Initializable.md deleted file mode 100644 index 008c35531..000000000 --- a/docs/docs/Initializable.md +++ /dev/null @@ -1,72 +0,0 @@ -# Initializable (Initializable.sol) - -**Initializable** - -Simple helper contract to support initialization outside of the constructor. -To use it, replace the constructor with a function that has the -`isInitializer` modifier. -WARNING: This helper does not support multiple inheritance. -WARNING: It is the developer's responsibility to ensure that an initializer -is actually called. -Use `Migratable` for more complex migration mechanisms. - -## Contract Members -**Constants & Variables** - -```js -bool public initialized; -``` - -## Modifiers - -- [isInitializer](#isinitializer) - -### isInitializer - -Modifier to use in the initialization function of a contract. - -```js -modifier isInitializer() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -## Functions - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/KNS.md b/docs/docs/KNS.md deleted file mode 100644 index a76e32125..000000000 --- a/docs/docs/KNS.md +++ /dev/null @@ -1,149 +0,0 @@ -# KNS.sol - -**KNS** - -**Events** - -```js -event NewOwner(bytes32 indexed node, bytes32 indexed label, address owner); -event Transfer(bytes32 indexed node, address owner); -event NewResolver(bytes32 indexed node, address resolver); -event NewTTL(bytes32 indexed node, uint64 ttl); -``` - -## Functions - -- [setSubnodeOwner](#setsubnodeowner) -- [setResolver](#setresolver) -- [setOwner](#setowner) -- [setTTL](#setttl) -- [owner](#owner) -- [resolver](#resolver) -- [ttl](#ttl) - -### setSubnodeOwner - -```js -function setSubnodeOwner(bytes32 node, bytes32 label, address owner) external -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | -| label | bytes32 | | -| owner | address | | - -### setResolver - -```js -function setResolver(bytes32 node, address resolver) external -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | -| resolver | address | | - -### setOwner - -```js -function setOwner(bytes32 node, address owner) external -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | -| owner | address | | - -### setTTL - -```js -function setTTL(bytes32 node, uint64 ttl) external -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | -| ttl | uint64 | | - -### owner - -```js -function owner(bytes32 node) external view -returns(address) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | - -### resolver - -```js -function resolver(bytes32 node) external view -returns(address) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | - -### ttl - -```js -function ttl(bytes32 node) external view -returns(uint64) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/KNSRegistry.md b/docs/docs/KNSRegistry.md deleted file mode 100644 index fee6b80ab..000000000 --- a/docs/docs/KNSRegistry.md +++ /dev/null @@ -1,231 +0,0 @@ -# KNSRegistry.sol - -**contract KNSRegistry is [KNS](KNS.md), [Initializable](Initializable.md)** - -**KNSRegistry** - -## Structs -### Record - -```js -struct Record { - address owner, - address resolver, - uint64 ttl -} -``` - -## Contract Members -**Constants & Variables** - -```js -mapping(bytes32 => struct KNSRegistry.Record) internal records; -``` - -## Modifiers - -- [only_owner](#only_owner) - -### only_owner - -```js -modifier only_owner(bytes32 node) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | - -## Functions - -- [initialize](#initialize) -- [setOwner](#setowner) -- [setSubnodeOwner](#setsubnodeowner) -- [setResolver](#setresolver) -- [setTTL](#setttl) -- [owner](#owner) -- [resolver](#resolver) -- [ttl](#ttl) - -### initialize - -initialize function for Proxy Pattern. - -```js -function initialize(address _owner) public isInitializer -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _owner | address | address of the root owner | - -### setOwner - -:small_red_triangle: overrides [KNS.setOwner](KNS.md#setowner) - -Transfers ownership of a node to a new address. May only be called by the current owner of the node. - -```js -function setOwner(bytes32 node, address owner) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to transfer ownership of. | -| owner | address | The address of the new owner. | - -### setSubnodeOwner - -:small_red_triangle: overrides [KNS.setSubnodeOwner](KNS.md#setsubnodeowner) - -Transfers ownership of a subnode keccak256(node, label) to a new address. May only be called by the owner of the parent node. - -```js -function setSubnodeOwner(bytes32 node, bytes32 label, address owner) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The parent node. | -| label | bytes32 | The hash of the label specifying the subnode. | -| owner | address | The address of the new owner. | - -### setResolver - -:small_red_triangle: overrides [KNS.setResolver](KNS.md#setresolver) - -Sets the resolver address for the specified node. - -```js -function setResolver(bytes32 node, address resolver) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| resolver | address | The address of the resolver. | - -### setTTL - -:small_red_triangle: overrides [KNS.setTTL](KNS.md#setttl) - -Sets the TTL for the specified node. - -```js -function setTTL(bytes32 node, uint64 ttl) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| ttl | uint64 | The TTL in seconds. | - -### owner - -:small_red_triangle: overrides [KNS.owner](KNS.md#owner) - -Returns the address that owns the specified node. - -```js -function owner(bytes32 node) public view -returns(address) -``` - -**Returns** - -address of the owner. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The specified node. | - -### resolver - -:small_red_triangle: overrides [KNS.resolver](KNS.md#resolver) - -Returns the address of the resolver for the specified node. - -```js -function resolver(bytes32 node) public view -returns(address) -``` - -**Returns** - -address of the resolver. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The specified node. | - -### ttl - -:small_red_triangle: overrides [KNS.ttl](KNS.md#ttl) - -Returns the TTL of a node, and any records associated with it. - -```js -function ttl(bytes32 node) public view -returns(uint64) -``` - -**Returns** - -ttl of the node. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The specified node. | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/KNSRegistryV1.md b/docs/docs/KNSRegistryV1.md deleted file mode 100644 index e27194b13..000000000 --- a/docs/docs/KNSRegistryV1.md +++ /dev/null @@ -1,237 +0,0 @@ -# KNSRegistryV1.sol - -**contract KNSRegistryV1 is [KNS](KNS.md), [Initializable](Initializable.md)** - -**KNSRegistryV1** - -## Structs -### Record - -```js -struct Record { - address owner, - address resolver, - uint64 ttl -} -``` - -## Contract Members -**Constants & Variables** - -```js -mapping(bytes32 => struct KNSRegistryV1.Record) internal records; -``` - -## Modifiers - -- [only_owner](#only_owner) - -### only_owner - -```js -modifier only_owner(bytes32 node) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | - -## Functions - -- [initialize](#initialize) -- [helloProxy](#helloproxy) -- [setOwner](#setowner) -- [setSubnodeOwner](#setsubnodeowner) -- [setResolver](#setresolver) -- [setTTL](#setttl) -- [owner](#owner) -- [resolver](#resolver) -- [ttl](#ttl) - -### initialize - -```js -function initialize(address _owner) public isInitializer -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _owner | address | | - -### helloProxy - -```js -function helloProxy() public pure -returns(string) -``` - -### setOwner - -:small_red_triangle: overrides [KNS.setOwner](KNS.md#setowner) - -Transfers ownership of a node to a new address. May only be called by the current owner of the node. - -```js -function setOwner(bytes32 node, address owner) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to transfer ownership of. | -| owner | address | The address of the new owner. | - -### setSubnodeOwner - -:small_red_triangle: overrides [KNS.setSubnodeOwner](KNS.md#setsubnodeowner) - -Transfers ownership of a subnode keccak256(node, label) to a new address. May only be called by the owner of the parent node. - -```js -function setSubnodeOwner(bytes32 node, bytes32 label, address owner) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The parent node. | -| label | bytes32 | The hash of the label specifying the subnode. | -| owner | address | The address of the new owner. | - -### setResolver - -:small_red_triangle: overrides [KNS.setResolver](KNS.md#setresolver) - -Sets the resolver address for the specified node. - -```js -function setResolver(bytes32 node, address resolver) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| resolver | address | The address of the resolver. | - -### setTTL - -:small_red_triangle: overrides [KNS.setTTL](KNS.md#setttl) - -Sets the TTL for the specified node. - -```js -function setTTL(bytes32 node, uint64 ttl) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| ttl | uint64 | The TTL in seconds. | - -### owner - -:small_red_triangle: overrides [KNS.owner](KNS.md#owner) - -Returns the address that owns the specified node. - -```js -function owner(bytes32 node) public view -returns(address) -``` - -**Returns** - -address of the owner. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The specified node. | - -### resolver - -:small_red_triangle: overrides [KNS.resolver](KNS.md#resolver) - -Returns the address of the resolver for the specified node. - -```js -function resolver(bytes32 node) public view -returns(address) -``` - -**Returns** - -address of the resolver. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The specified node. | - -### ttl - -:small_red_triangle: overrides [KNS.ttl](KNS.md#ttl) - -Returns the TTL of a node, and any records associated with it. - -```js -function ttl(bytes32 node) public view -returns(uint64) -``` - -**Returns** - -ttl of the node. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The specified node. | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/KRC223.md b/docs/docs/KRC223.md deleted file mode 100644 index bad84499a..000000000 --- a/docs/docs/KRC223.md +++ /dev/null @@ -1,148 +0,0 @@ -# KRC223.sol - -**KRC223** - -## Contract Members -**Constants & Variables** - -```js -uint256 public totalSupply; -``` - -**Events** - -```js -event Transfer(address indexed from, address indexed to, uint256 value, bytes data); -``` - -## Functions - -- [balanceOf](#balanceof) -- [name](#name) -- [symbol](#symbol) -- [decimals](#decimals) -- [totalSupply](#totalsupply) -- [transfer](#transfer) -- [transfer](#transfer) -- [transfer](#transfer) - -### balanceOf - -```js -function balanceOf(address who) public view -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| who | address | | - -### name - -```js -function name() public view -returns(_name string) -``` - -### symbol - -```js -function symbol() public view -returns(_symbol string) -``` - -### decimals - -```js -function decimals() public view -returns(_decimals uint8) -``` - -### totalSupply - -```js -function totalSupply() public view -returns(_supply uint256) -``` - -### transfer - -```js -function transfer(address to, uint256 value) public -returns(ok bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| to | address | | -| value | uint256 | | - -### transfer - -```js -function transfer(address to, uint256 value, bytes data) public -returns(ok bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| to | address | | -| value | uint256 | | -| data | bytes | | - -### transfer - -```js -function transfer(address to, uint256 value, bytes data, string custom_fallback) public -returns(ok bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| to | address | | -| value | uint256 | | -| data | bytes | | -| custom_fallback | string | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/Math.md b/docs/docs/Math.md deleted file mode 100644 index 89febaa3b..000000000 --- a/docs/docs/Math.md +++ /dev/null @@ -1,101 +0,0 @@ -# Math.sol - -**Math** - -## Functions - -- [max64](#max64) -- [min64](#min64) -- [max256](#max256) -- [min256](#min256) - -### max64 - -```js -function max64(uint64 _a, uint64 _b) internal pure -returns(uint64) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _a | uint64 | | -| _b | uint64 | | - -### min64 - -```js -function min64(uint64 _a, uint64 _b) internal pure -returns(uint64) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _a | uint64 | | -| _b | uint64 | | - -### max256 - -```js -function max256(uint256 _a, uint256 _b) internal pure -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _a | uint256 | | -| _b | uint256 | | - -### min256 - -```js -function min256(uint256 _a, uint256 _b) internal pure -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _a | uint256 | | -| _b | uint256 | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/Migrations.md b/docs/docs/Migrations.md deleted file mode 100644 index 2f52b8474..000000000 --- a/docs/docs/Migrations.md +++ /dev/null @@ -1,90 +0,0 @@ -# Migrations.sol - -**Migrations** - -## Contract Members -**Constants & Variables** - -```js -address public owner; -uint256 public last_completed_migration; -``` - -## Modifiers - -- [restricted](#restricted) - -### restricted - -```js -modifier restricted() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -## Functions - -- [setCompleted](#setcompleted) -- [upgrade](#upgrade) - -### setCompleted - -```js -function setCompleted(uint256 completed) public restricted -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| completed | uint256 | | - -### upgrade - -```js -function upgrade(address new_address) public restricted -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| new_address | address | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/MiningToken.md b/docs/docs/MiningToken.md deleted file mode 100644 index f9a1ec60f..000000000 --- a/docs/docs/MiningToken.md +++ /dev/null @@ -1,79 +0,0 @@ -# MiningToken.sol - -**contract MiningToken is [CappedToken](CappedToken.md)** - -**MiningToken** - -## Constructor - -```js -constructor(uint256 _cap) public -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _cap | uint256 | | - -## Functions - -- [initialize](#initialize) -- [getOwner](#getowner) - -### initialize - -```js -function initialize(string _name, string _symbol, uint256 _cap, uint8 _decimals) public isInitializer -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _name | string | | -| _symbol | string | | -| _cap | uint256 | | -| _decimals | uint8 | | - -### getOwner - -```js -function getOwner() public -returns(address) -``` - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/MintableToken.md b/docs/docs/MintableToken.md deleted file mode 100644 index a9ae2dc1e..000000000 --- a/docs/docs/MintableToken.md +++ /dev/null @@ -1,107 +0,0 @@ -# MintableToken.sol - -**contract MintableToken is [Token](Token.md), [Ownable](Ownable.md)** - -**MintableToken** - -## Contract Members -**Constants & Variables** - -```js -bool public mintingFinished; -``` - -**Events** - -```js -event Mint(address indexed to, uint256 amount); -event MintFinished(); -``` - -## Modifiers - -- [canMint](#canmint) - -### canMint - -```js -modifier canMint() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -## Functions - -- [mint](#mint) -- [finishMinting](#finishminting) - -### mint - -Function to mint tokens - -```js -function mint(address _to, uint256 _amount) public onlyOwner canMint -returns(bool) -``` - -**Returns** - -A boolean that indicates if the operation was successful. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _to | address | The address that will receive the minted tokens. | -| _amount | uint256 | The amount of tokens to mint. | - -### finishMinting - -Function to stop minting new tokens. - -```js -function finishMinting() public onlyOwner canMint -returns(bool) -``` - -**Returns** - -True if the operation was successful. - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/MultiSigWallet.md b/docs/docs/MultiSigWallet.md deleted file mode 100644 index 4c337b242..000000000 --- a/docs/docs/MultiSigWallet.md +++ /dev/null @@ -1,511 +0,0 @@ -# MultiSigWallet.sol - -**MultiSigWallet** - -## Constructor - -Contract constructor sets initial owners and required number of confirmations. - -```js -constructor(uint256 , uint256 _required) public -``` - -**Arguments** - -## Structs -### Transaction - -```js -struct Transaction { - address destination, - uint256 value, - bytes data, - bool executed -} -``` - -## Contract Members -**Constants & Variables** - -```js -uint256 public constant MAX_OWNER_COUNT; -mapping(uint256 => struct MultiSigWallet.Transaction) public transactions; -mapping(uint256 => mapping(address => bool)) public confirmations; -mapping(address => bool) public isOwner; -address[] public owners; -uint256 public required; -uint256 public transactionCount; -``` - -**Events** - -```js -event Confirmation(address indexed sender, uint256 indexed transactionId); -event Revocation(address indexed sender, uint256 indexed transactionId); -event Submission(uint256 indexed transactionId); -event Execution(uint256 indexed transactionId); -event ExecutionFailure(uint256 indexed transactionId); -event Deposit(address indexed sender, uint256 value); -event OwnerAddition(address indexed owner); -event OwnerRemoval(address indexed owner); -event RequirementChange(uint256 required); -``` - -| Name | Type | Description | -| ------------- |------------- | -----| -| | uint256 | _owners List of initial owners. | -| _required | uint256 | Number of required confirmations. | - -## Modifiers - -- [onlyWallet](#onlywallet) -- [ownerDoesNotExist](#ownerdoesnotexist) -- [ownerExists](#ownerexists) -- [transactionExists](#transactionexists) -- [confirmed](#confirmed) -- [notConfirmed](#notconfirmed) -- [notExecuted](#notexecuted) -- [notNull](#notnull) -- [validRequirement](#validrequirement) - -### onlyWallet - -```js -modifier onlyWallet() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -### ownerDoesNotExist - -```js -modifier ownerDoesNotExist(address owner) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| owner | address | | - -### ownerExists - -```js -modifier ownerExists(address owner) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| owner | address | | - -### transactionExists - -```js -modifier transactionExists(uint256 transactionId) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | | - -### confirmed - -```js -modifier confirmed(uint256 transactionId, address owner) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | | -| owner | address | | - -### notConfirmed - -```js -modifier notConfirmed(uint256 transactionId, address owner) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | | -| owner | address | | - -### notExecuted - -```js -modifier notExecuted(uint256 transactionId) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | | - -### notNull - -```js -modifier notNull(address _address) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _address | address | | - -### validRequirement - -```js -modifier validRequirement(uint256 ownerCount, uint256 _required) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| ownerCount | uint256 | | -| _required | uint256 | | - -## Functions - -- [](#) -- [addOwner](#addowner) -- [removeOwner](#removeowner) -- [replaceOwner](#replaceowner) -- [changeRequirement](#changerequirement) -- [submitTransaction](#submittransaction) -- [confirmTransaction](#confirmtransaction) -- [revokeConfirmation](#revokeconfirmation) -- [executeTransaction](#executetransaction) -- [external_call](#external_call) -- [isConfirmed](#isconfirmed) -- [addTransaction](#addtransaction) -- [getConfirmationCount](#getconfirmationcount) -- [getTransactionCount](#gettransactioncount) -- [getOwners](#getowners) -- [getConfirmations](#getconfirmations) -- [getTransactionIds](#gettransactionids) - -### - -Fallback function allows to deposit kUSD. - -```js -function () public payable payable -``` - -### addOwner - -Allows to add a new owner. Transaction has to be sent by wallet. - -```js -function addOwner(address owner) public onlyWallet ownerDoesNotExist notNull validRequirement -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| owner | address | Address of new owner. | - -### removeOwner - -Allows to remove an owner. Transaction has to be sent by wallet. - -```js -function removeOwner(address owner) public onlyWallet ownerExists -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| owner | address | Address of owner. | - -### replaceOwner - -Allows to replace an owner with a new owner. Transaction has to be sent by wallet. - -```js -function replaceOwner(address owner, address newOwner) public onlyWallet ownerExists ownerDoesNotExist -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| owner | address | Address of owner to be replaced. | -| newOwner | address | Address of new owner. | - -### changeRequirement - -Allows to change the number of required confirmations. Transaction has to be sent by wallet. - -```js -function changeRequirement(uint256 _required) public onlyWallet validRequirement -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _required | uint256 | Number of required confirmations. | - -### submitTransaction - -Allows an owner to submit and confirm a transaction. - -```js -function submitTransaction(address destination, uint256 value, bytes data) public -returns(transactionId uint256) -``` - -**Returns** - -Returns transaction ID. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| destination | address | Transaction target address. | -| value | uint256 | Transaction ether value. | -| data | bytes | Transaction data payload. | - -### confirmTransaction - -Allows an owner to confirm a transaction. - -```js -function confirmTransaction(uint256 transactionId) public ownerExists transactionExists notConfirmed -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | Transaction ID. | - -### revokeConfirmation - -Allows an owner to revoke a confirmation for a transaction. - -```js -function revokeConfirmation(uint256 transactionId) public ownerExists confirmed notExecuted -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | Transaction ID. | - -### executeTransaction - -Allows anyone to execute a confirmed transaction. - -```js -function executeTransaction(uint256 transactionId) public ownerExists confirmed notExecuted -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | Transaction ID. | - -### external_call - -```js -function external_call(address destination, uint256 value, uint256 dataLength, bytes data) private -returns(bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| destination | address | | -| value | uint256 | | -| dataLength | uint256 | | -| data | bytes | | - -### isConfirmed - -Returns the confirmation status of a transaction. - -```js -function isConfirmed(uint256 transactionId) public view -returns(bool) -``` - -**Returns** - -Confirmation status. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | Transaction ID. | - -### addTransaction - -Adds a new transaction to the transaction mapping, if transaction does not exist yet. - -```js -function addTransaction(address destination, uint256 value, bytes data) internal notNull -returns(transactionId uint256) -``` - -**Returns** - -Returns transaction ID. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| destination | address | Transaction target address. | -| value | uint256 | Transaction ether value. | -| data | bytes | Transaction data payload. | - -### getConfirmationCount - -Returns number of confirmations of a transaction. - -```js -function getConfirmationCount(uint256 transactionId) public view -returns(count uint256) -``` - -**Returns** - -Number of confirmations. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | Transaction ID. | - -### getTransactionCount - -Returns total number of transactions after filers are applied. - -```js -function getTransactionCount(bool pending, bool executed) public view -returns(count uint256) -``` - -**Returns** - -Total number of transactions after filters are applied. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| pending | bool | Include pending transactions. | -| executed | bool | Include executed transactions. | - -### getOwners - -Returns list of owners. - -```js -function getOwners() public view -returns(address[]) -``` - -**Returns** - -List of owner addresses. - -### getConfirmations - -Returns array with owner addresses, which confirmed transaction. - -```js -function getConfirmations(uint256 transactionId) public view -returns(_confirmations address[]) -``` - -**Returns** - -Returns array of owner addresses. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| transactionId | uint256 | Transaction ID. | - -### getTransactionIds - -Returns list of transaction IDs in defined range. - -```js -function getTransactionIds(uint256 from, uint256 to, bool pending, bool executed) public view -returns(_transactionIds uint256[]) -``` - -**Returns** - -Returns array of transaction IDs. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| from | uint256 | Index start position of transaction array. | -| to | uint256 | Index end position of transaction array. | -| pending | bool | Include pending transactions. | -| executed | bool | Include executed transactions. | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/NameHash.md b/docs/docs/NameHash.md deleted file mode 100644 index 48191e98f..000000000 --- a/docs/docs/NameHash.md +++ /dev/null @@ -1,59 +0,0 @@ -# NameHash.sol - -**NameHash** - -## Functions - -- [namehash](#namehash) - -### namehash - -```js -function namehash(string _node) public view -returns(_namehash bytes32) -``` - -**Returns** - -_namehash The result of namehash algorithm applied at _node. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _node | string | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/OracleMgr.md b/docs/docs/OracleMgr.md deleted file mode 100644 index 06d1ee70b..000000000 --- a/docs/docs/OracleMgr.md +++ /dev/null @@ -1,290 +0,0 @@ -# Oracle Manager contract (OracleMgr.sol) - -**contract OracleMgr is [Pausable](Pausable.md), [Initializable](Initializable.md)** - -**OracleMgr** - -## Structs -### OraclePrice - -```js -struct OraclePrice { - uint256 price, - address oracle -} -``` - -### Oracle - -```js -struct Oracle { - uint256 index, - bool isOracle, - bool hasSubmittedPrice -} -``` - -## Contract Members -**Constants & Variables** - -```js -//public members -uint256 public maxNumOracles; -uint256 public syncFrequency; -uint256 public updatePeriod; -uint256 public price; -contract DomainResolver public knsResolver; -//internal members -bytes32 internal nodeNamehash; -//private members -mapping(address => struct OracleMgr.Oracle) private oracleRegistry; -address[] private oraclePool; -struct OracleMgr.OraclePrice[] private prices; -``` - -## Modifiers - -- [onlyOracle](#onlyoracle) -- [onlyNewCandidate](#onlynewcandidate) -- [onlySuperNode](#onlysupernode) -- [onlyOnce](#onlyonce) - -### onlyOracle - -```js -modifier onlyOracle() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -### onlyNewCandidate - -```js -modifier onlyNewCandidate() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -### onlySuperNode - -```js -modifier onlySuperNode() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -### onlyOnce - -```js -modifier onlyOnce() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -## Functions - -- [initialize](#initialize) -- [isOracle](#isoracle) -- [_hasAvailability](#_hasavailability) -- [_deleteOracle](#_deleteoracle) -- [_insertOracle](#_insertoracle) -- [getOracleCount](#getoraclecount) -- [getOracleAtIndex](#getoracleatindex) -- [getPriceCount](#getpricecount) -- [getPriceAtIndex](#getpriceatindex) -- [registerOracle](#registeroracle) -- [deregisterOracle](#deregisteroracle) -- [submitPrice](#submitprice) - -### initialize - -```js -function initialize(uint256 _maxNumOracles, uint256 _syncFrequency, uint256 _updatePeriod, address _resolverAddr) public isInitializer -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _maxNumOracles | uint256 | Maximum numbers of Oracles. | -| _syncFrequency | uint256 | Synchronize frequency for Oracles. | -| _updatePeriod | uint256 | Update period. | -| _resolverAddr | address | Address of KNS Resolver. | - -### isOracle - -Checks if given address is Oracle - -```js -function isOracle(address identity) public view -returns(isIndeed bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| identity | address | Address of an Oracle. | - -### _hasAvailability - -Checks availability of OraclePool - -```js -function _hasAvailability() private view -returns(available bool) -``` - -### _deleteOracle - -Deletes given oracle - -```js -function _deleteOracle(address identity) private -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| identity | address | Address of an Oracle. | - -### _insertOracle - -Inserts oracle - -```js -function _insertOracle(address identity, uint256 deposit) private -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| identity | address | Address of an Oracle. | -| deposit | uint256 | Deposit ammount | - -### getOracleCount - -Get Oracle count - -```js -function getOracleCount() public view -returns(count uint256) -``` - -### getOracleAtIndex - -Get Oracle information - -```js -function getOracleAtIndex(uint256 index) public view -returns(code address) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| index | uint256 | index of an Oracle to check. | - -### getPriceCount - -Get submissions count - -```js -function getPriceCount() public view -returns(count uint256) -``` - -### getPriceAtIndex - -Get submissions information - -```js -function getPriceAtIndex(uint256 index) public view -returns(price uint256, oracle address) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| index | uint256 | index of a submission to check. | - -### registerOracle - -Registers a new candidate as oracle - -```js -function registerOracle() public payable payable whenNotPaused onlyNewCandidate onlySuperNode -``` - -### deregisterOracle - -Deregisters the msg sender from the oracle set - -```js -function deregisterOracle() public whenNotPaused onlyOracle -``` - -### submitPrice - -Adds price - -```js -function submitPrice(uint256 _price) public whenNotPaused onlyOracle onlyOnce -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _price | uint256 | price | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/Ownable.md b/docs/docs/Ownable.md deleted file mode 100644 index 975162f7c..000000000 --- a/docs/docs/Ownable.md +++ /dev/null @@ -1,116 +0,0 @@ -# Ownable (Ownable.sol) - -**Ownable** - -The Ownable contract has an owner address, and provides basic authorization control -functions, this simplifies the implementation of "user permissions". - -## Contract Members -**Constants & Variables** - -```js -address public owner; -``` - -**Events** - -```js -event OwnershipRenounced(address indexed previousOwner); -event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); -``` - -## Modifiers - -- [onlyOwner](#onlyowner) - -### onlyOwner - -Throws if called by any account other than the owner. - -```js -modifier onlyOwner() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -## Functions - -- [renounceOwnership](#renounceownership) -- [transferOwnership](#transferownership) -- [_transferOwnership](#_transferownership) - -### renounceOwnership - -Renouncing to ownership will leave the contract without an owner. -It will not be possible to call the functions with the `onlyOwner` -modifier anymore. - -```js -function renounceOwnership() public onlyOwner -``` - -### transferOwnership - -Allows the current owner to transfer control of the contract to a newOwner. - -```js -function transferOwnership(address _newOwner) public onlyOwner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _newOwner | address | The address to transfer ownership to. | - -### _transferOwnership - -Transfers control of the contract to a newOwner. - -```js -function _transferOwnership(address _newOwner) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _newOwner | address | The address to transfer ownership to. | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/Pausable.md b/docs/docs/Pausable.md deleted file mode 100644 index 696f44eac..000000000 --- a/docs/docs/Pausable.md +++ /dev/null @@ -1,108 +0,0 @@ -# Pausable (Pausable.sol) - -**contract Pausable is [Ownable](Ownable.md)** - -**Pausable** - -Base contract which allows children to implement an emergency stop mechanism. - -## Contract Members -**Constants & Variables** - -```js -bool public paused; -``` - -**Events** - -```js -event Pause(); -event Unpause(); -``` - -## Modifiers - -- [whenNotPaused](#whennotpaused) -- [whenPaused](#whenpaused) - -### whenNotPaused - -Modifier to make a function callable only when the contract is not paused. - -```js -modifier whenNotPaused() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -### whenPaused - -Modifier to make a function callable only when the contract is paused. - -```js -modifier whenPaused() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -## Functions - -- [pause](#pause) -- [unpause](#unpause) - -### pause - -called by the owner to pause, triggers stopped state - -```js -function pause() public onlyOwner whenNotPaused -``` - -### unpause - -called by the owner to unpause, returns to normal state - -```js -function unpause() public onlyOwner whenPaused -``` - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/PriceProvider.md b/docs/docs/PriceProvider.md deleted file mode 100644 index 2c1afd64f..000000000 --- a/docs/docs/PriceProvider.md +++ /dev/null @@ -1,49 +0,0 @@ -# PriceProvider interface (PriceProvider.sol) - -**PriceProvider** - -## Functions - -- [price](#price) - -### price - -```js -function price() public view -returns(uint256) -``` - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/PublicResolver.md b/docs/docs/PublicResolver.md deleted file mode 100644 index 5f283a13c..000000000 --- a/docs/docs/PublicResolver.md +++ /dev/null @@ -1,373 +0,0 @@ -# PublicResolver.sol - -**contract PublicResolver is [Initializable](Initializable.md)** - -**PublicResolver** - -## Structs -### PublicKey - -```js -struct PublicKey { - bytes32 x, - bytes32 y -} -``` - -### Record - -```js -struct Record { - address addr, - bytes32 content, - string name, - struct PublicResolver.PublicKey pubkey, - mapping(string => string) text, - mapping(uint256 => bytes) abis, - bytes multihash -} -``` - -## Contract Members -**Constants & Variables** - -```js -bytes4 internal constant INTERFACE_META_ID; -bytes4 internal constant ADDR_INTERFACE_ID; -bytes4 internal constant CONTENT_INTERFACE_ID; -bytes4 internal constant NAME_INTERFACE_ID; -bytes4 internal constant ABI_INTERFACE_ID; -bytes4 internal constant PUBKEY_INTERFACE_ID; -bytes4 internal constant TEXT_INTERFACE_ID; -bytes4 internal constant MULTIHASH_INTERFACE_ID; -contract KNS internal kns; -mapping(bytes32 => struct PublicResolver.Record) internal records; -``` - -**Events** - -```js -event AddrChanged(bytes32 indexed node, address a); -event ContentChanged(bytes32 indexed node, bytes32 hash); -event NameChanged(bytes32 indexed node, string name); -event ABIChanged(bytes32 indexed node, uint256 indexed contentType); -event PubkeyChanged(bytes32 indexed node, bytes32 x, bytes32 y); -event TextChanged(bytes32 indexed node, string indexedKey, string key); -event MultihashChanged(bytes32 indexed node, bytes hash); -``` - -## Modifiers - -- [only_owner](#only_owner) - -### only_owner - -```js -modifier only_owner(bytes32 node) internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | | - -## Functions - -- [initialize](#initialize) -- [setAddr](#setaddr) -- [setContent](#setcontent) -- [setMultihash](#setmultihash) -- [setName](#setname) -- [setABI](#setabi) -- [setPubkey](#setpubkey) -- [setText](#settext) -- [text](#text) -- [pubkey](#pubkey) -- [ABI](#abi) -- [name](#name) -- [content](#content) -- [multihash](#multihash) -- [addr](#addr) -- [supportsInterface](#supportsinterface) - -### initialize - -initialize function for Proxy Pattern. - -```js -function initialize(KNS knsAddr) public isInitializer -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| knsAddr | KNS | The address of the KNS registry. | - -### setAddr - -```js -function setAddr(bytes32 node, address addr) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| addr | address | The address to set. | - -### setContent - -```js -function setContent(bytes32 node, bytes32 hash) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| hash | bytes32 | The content hash to set | - -### setMultihash - -```js -function setMultihash(bytes32 node, bytes hash) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| hash | bytes | The multihash to set | - -### setName - -```js -function setName(bytes32 node, string name) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| name | string | The name to set. | - -### setABI - -```js -function setABI(bytes32 node, uint256 contentType, bytes data) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| contentType | uint256 | The content type of the ABI | -| data | bytes | The ABI data. | - -### setPubkey - -```js -function setPubkey(bytes32 node, bytes32 x, bytes32 y) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The KNS node to query | -| x | bytes32 | the X coordinate of the curve point for the public key. | -| y | bytes32 | the Y coordinate of the curve point for the public key. | - -### setText - -```js -function setText(bytes32 node, string key, string value) public only_owner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The node to update. | -| key | string | The key to set. | -| value | string | The text data value to set. | - -### text - -```js -function text(bytes32 node, string key) public view -returns(string) -``` - -**Returns** - -The associated text data. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The KNS node to query. | -| key | string | The text data key to query. | - -### pubkey - -```js -function pubkey(bytes32 node) public view -returns(x bytes32, y bytes32) -``` - -**Returns** - -x, y the X and Y coordinates of the curve point for the public key. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The KNS node to query | - -### ABI - -```js -function ABI(bytes32 node, uint256 contentTypes) public view -returns(contentType uint256, data bytes) -``` - -**Returns** - -contentType The content type of the return value - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The KNS node to query | -| contentTypes | uint256 | A bitwise OR of the ABI formats accepted by the caller. | - -### name - -```js -function name(bytes32 node) public view -returns(string) -``` - -**Returns** - -The associated name. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The KNS node to query. | - -### content - -```js -function content(bytes32 node) public view -returns(bytes32) -``` - -**Returns** - -The associated content hash. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The KNS node to query. | - -### multihash - -```js -function multihash(bytes32 node) public view -returns(bytes) -``` - -**Returns** - -The associated multihash. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The KNS node to query. | - -### addr - -```js -function addr(bytes32 node) public view -returns(address) -``` - -**Returns** - -The associated address. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| node | bytes32 | The KNS node to query. | - -### supportsInterface - -```js -function supportsInterface(bytes4 interfaceID) public pure -returns(bool) -``` - -**Returns** - -True if the contract implements the requested interface. - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| interfaceID | bytes4 | The ID of the interface to check for. | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/SafeMath.md b/docs/docs/SafeMath.md deleted file mode 100644 index a53dc55f5..000000000 --- a/docs/docs/SafeMath.md +++ /dev/null @@ -1,109 +0,0 @@ -# SafeMath.sol - -**SafeMath** - -## Functions - -- [mul](#mul) -- [div](#div) -- [sub](#sub) -- [add](#add) - -### mul - -Multiplies two numbers, throws on overflow. - -```js -function mul(uint256 _a, uint256 _b) internal pure -returns(c uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _a | uint256 | | -| _b | uint256 | | - -### div - -Integer division of two numbers, truncating the quotient. - -```js -function div(uint256 _a, uint256 _b) internal pure -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _a | uint256 | | -| _b | uint256 | | - -### sub - -Subtracts two numbers, throws on overflow (i.e. if subtrahend is greater than minuend). - -```js -function sub(uint256 _a, uint256 _b) internal pure -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _a | uint256 | | -| _b | uint256 | | - -### add - -Adds two numbers, throws on overflow. - -```js -function add(uint256 _a, uint256 _b) internal pure -returns(c uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _a | uint256 | | -| _b | uint256 | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/Stability.md b/docs/docs/Stability.md deleted file mode 100644 index 233b2354f..000000000 --- a/docs/docs/Stability.md +++ /dev/null @@ -1,182 +0,0 @@ -# Stability contract supports network utility (Stability.sol) - -**contract Stability is [Pausable](Pausable.md), [Initializable](Initializable.md)** - -**Stability** - -## Structs -### Subscription - -```js -struct Subscription { - uint256 index, - bool hasSubscription, - uint256 deposit -} -``` - -## Contract Members -**Constants & Variables** - -```js -//internal members -uint256 internal constant ONE; -contract PriceProvider internal priceProvider; -//public members -uint256 public minDeposit; -//private members -mapping(address => struct Stability.Subscription) private subscriptionRegistry; -address[] private subscriptions; -``` - -## Modifiers - -- [onlySubscriber](#onlysubscriber) -- [onlyWithMinDeposit](#onlywithmindeposit) -- [whenPriceGreaterEqualOne](#whenpricegreaterequalone) - -### onlySubscriber - -```js -modifier onlySubscriber() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -### onlyWithMinDeposit - -```js -modifier onlyWithMinDeposit() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -### whenPriceGreaterEqualOne - -```js -modifier whenPriceGreaterEqualOne() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -## Functions - -- [initialize](#initialize) -- [getSubscriptionCount](#getsubscriptioncount) -- [getSubscriptionAtIndex](#getsubscriptionatindex) -- [_hasSubscription](#_hassubscription) -- [_insertSubscription](#_insertsubscription) -- [subscribe](#subscribe) -- [unsubscribe](#unsubscribe) - -### initialize - -```js -function initialize(uint256 _minDeposit, address _priceProviderAddr) public isInitializer -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _minDeposit | uint256 | minimum deposit required to subscribe to the service | -| _priceProviderAddr | address | address of system variables contract | - -### getSubscriptionCount - -```js -function getSubscriptionCount() public view -returns(count uint256) -``` - -### getSubscriptionAtIndex - -```js -function getSubscriptionAtIndex(uint256 index) public view -returns(code address, deposit uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| index | uint256 | | - -### _hasSubscription - -```js -function _hasSubscription(address identity) private view -returns(isIndeed bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| identity | address | | - -### _insertSubscription - -```js -function _insertSubscription() private onlyWithMinDeposit -``` - -### subscribe - -Subscribe to the stability contract service - -```js -function subscribe() public payable payable whenNotPaused -``` - -### unsubscribe - -Unsubscribe the service - -```js -function unsubscribe() public onlySubscriber whenPriceGreaterEqualOne -``` - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/SystemVars.md b/docs/docs/SystemVars.md deleted file mode 100644 index 50f432089..000000000 --- a/docs/docs/SystemVars.md +++ /dev/null @@ -1,139 +0,0 @@ -# System Variables (SystemVars.sol) - -**contract SystemVars is [Initializable](Initializable.md)** - -**SystemVars** - -## Contract Members -**Constants & Variables** - -```js -//internal members -uint256 internal constant INITIAL_MINTED_AMOUNT; -uint256 internal constant INITIAL_CAP; -uint256 internal constant STABILIZED_PRICE; -uint256 internal constant ADJUSTMENT_FACTOR; -uint256 internal constant LOW_SUPPLY_METRIC; -uint256 internal constant MAX_UNDER_NORMAL_CONDITIONS; -uint256 internal constant DEFAULT_ORACLE_REWARD; -uint256 internal constant ORACLE_DEDUCTION_FRACTION; -//public members -uint256 public prevCurrencyPrice; -uint256 public currencyPrice; -uint256 public currencySupply; -uint256 public mintedReward; -``` - -## Functions - -- [initialize](#initialize) -- [_hasEnoughSupply](#_hasenoughsupply) -- [_cap](#_cap) -- [price](#price) -- [mintedAmount](#mintedamount) -- [oracleDeduction](#oraclededuction) -- [oracleReward](#oraclereward) - -### initialize - -```js -function initialize(uint256 _initialPrice, uint256 _initialSupply) public isInitializer -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _initialPrice | uint256 | initial price for the system's currency | -| _initialSupply | uint256 | minted amount on the genesis block | - -### _hasEnoughSupply - -```js -function _hasEnoughSupply() private view -returns(bool) -``` - -### _cap - -```js -function _cap() private view -returns(amount uint256) -``` - -### price - -Get the current system's currency price - -```js -function price() public view -returns(price uint256) -``` - -### mintedAmount - -Get the amount of coins that should be minted - -```js -function mintedAmount() public view -returns(uint256) -``` - -### oracleDeduction - -Get the oracle deduction - -```js -function oracleDeduction(uint256 mintedAmount) public view -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| mintedAmount | uint256 | the minted amount for the current block. | - -### oracleReward - -Get the oracle reward - -```js -function oracleReward() public view -returns(uint256) -``` - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/Token.md b/docs/docs/Token.md deleted file mode 100644 index 7e879a4bb..000000000 --- a/docs/docs/Token.md +++ /dev/null @@ -1,212 +0,0 @@ -# Token.sol - -**contract Token is [KRC223](KRC223.md), [Initializable](Initializable.md)** - -**Token** - -## Contract Members -**Constants & Variables** - -```js -//internal members -mapping(address => uint256) internal balances; -//public members -string public name; -string public symbol; -uint8 public decimals; -uint256 public totalSupply; -``` - -## Functions - -- [name](#name) -- [symbol](#symbol) -- [decimals](#decimals) -- [totalSupply](#totalsupply) -- [transfer](#transfer) -- [transfer](#transfer) -- [transfer](#transfer) -- [isContract](#iscontract) -- [transferToAddress](#transfertoaddress) -- [transferToContract](#transfertocontract) -- [balanceOf](#balanceof) - -### name - -:small_red_triangle: overrides [KRC223.name](KRC223.md#name) - -```js -function name() public view -returns(_name string) -``` - -### symbol - -:small_red_triangle: overrides [KRC223.symbol](KRC223.md#symbol) - -```js -function symbol() public view -returns(_symbol string) -``` - -### decimals - -:small_red_triangle: overrides [KRC223.decimals](KRC223.md#decimals) - -```js -function decimals() public view -returns(_decimals uint8) -``` - -### totalSupply - -:small_red_triangle: overrides [KRC223.totalSupply](KRC223.md#totalsupply) - -```js -function totalSupply() public view -returns(_totalSupply uint256) -``` - -### transfer - -:small_red_triangle: overrides [KRC223.transfer](KRC223.md#transfer) - -```js -function transfer(address _to, uint256 _value, bytes _data) public -returns(success bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _to | address | | -| _value | uint256 | | -| _data | bytes | | - -### transfer - -:small_red_triangle: overrides [KRC223.transfer](KRC223.md#transfer) - -```js -function transfer(address _to, uint256 _value, bytes _data, string _custom_fallback) public -returns(success bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _to | address | | -| _value | uint256 | | -| _data | bytes | | -| _custom_fallback | string | | - -### transfer - -:small_red_triangle: overrides [KRC223.transfer](KRC223.md#transfer) - -```js -function transfer(address _to, uint256 _value) public -returns(success bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _to | address | | -| _value | uint256 | | - -### isContract - -```js -function isContract(address _addr) private view -returns(is_contract bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _addr | address | | - -### transferToAddress - -```js -function transferToAddress(address _to, uint256 _value, bytes _data) private -returns(success bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _to | address | | -| _value | uint256 | | -| _data | bytes | | - -### transferToContract - -```js -function transferToContract(address _to, uint256 _value, bytes _data) private -returns(success bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _to | address | | -| _value | uint256 | | -| _data | bytes | | - -### balanceOf - -:small_red_triangle: overrides [KRC223.balanceOf](KRC223.md#balanceof) - -```js -function balanceOf(address _owner) public view -returns(balance uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _owner | address | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/TokenMock.md b/docs/docs/TokenMock.md deleted file mode 100644 index 7545be44d..000000000 --- a/docs/docs/TokenMock.md +++ /dev/null @@ -1,151 +0,0 @@ -# TokenMock.sol - -**TokenMock** - -## Contract Members -**Constants & Variables** - -```js -//public members -uint256 public totalSupply; -//private members -mapping(address => uint256) private balances; -``` - -**Events** - -```js -event Transfer(address indexed from, address indexed to, uint256 value, bytes indexed data); -``` - -## Functions - -- [balanceOf](#balanceof) -- [name](#name) -- [symbol](#symbol) -- [decimals](#decimals) -- [totalSupply](#totalsupply) -- [transfer](#transfer) -- [transfer](#transfer) -- [transfer](#transfer) - -### balanceOf - -```js -function balanceOf(address who) public view -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| who | address | | - -### name - -```js -function name() public view -returns(_name string) -``` - -### symbol - -```js -function symbol() public view -returns(_symbol string) -``` - -### decimals - -```js -function decimals() public view -returns(_decimals uint8) -``` - -### totalSupply - -```js -function totalSupply() public view -returns(_supply uint256) -``` - -### transfer - -```js -function transfer(address to, uint256 value) public -returns(ok bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| to | address | | -| value | uint256 | | - -### transfer - -```js -function transfer(address to, uint256 value, bytes data) public -returns(ok bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| to | address | | -| value | uint256 | | -| data | bytes | | - -### transfer - -```js -function transfer(address to, uint256 value, bytes data, string custom_fallback) public -returns(ok bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| to | address | | -| value | uint256 | | -| data | bytes | | -| custom_fallback | string | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/TokenReceiver.md b/docs/docs/TokenReceiver.md deleted file mode 100644 index a06c0dc88..000000000 --- a/docs/docs/TokenReceiver.md +++ /dev/null @@ -1,56 +0,0 @@ -# TokenReceiver.sol - -**TokenReceiver** - -## Functions - -- [tokenFallback](#tokenfallback) - -### tokenFallback - -```js -function tokenFallback(address _from, uint256 _value, bytes _data) public -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _from | address | | -| _value | uint256 | | -| _data | bytes | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/ValidatorMgr.md b/docs/docs/ValidatorMgr.md deleted file mode 100644 index 1d362730e..000000000 --- a/docs/docs/ValidatorMgr.md +++ /dev/null @@ -1,405 +0,0 @@ -# Validator Manager for PoS consensus (ValidatorMgr.sol) - -**contract ValidatorMgr is [Pausable](Pausable.md), [Initializable](Initializable.md)** - -**ValidatorMgr** - -## Structs -### Deposit - -```js -struct Deposit { - uint256 amount, - uint256 availableAt -} -``` - -### Validator - -```js -struct Validator { - uint256 index, - bool isValidator, - bool isGenesis, - struct ValidatorMgr.Deposit[] deposits -} -``` - -### TKN - -```js -struct TKN { - address sender, - uint256 value -} -``` - -## Contract Members -**Constants & Variables** - -```js -//public members -uint256 public baseDeposit; -uint256 public maxNumValidators; -uint256 public freezePeriod; -bytes32 public validatorsChecksum; -uint256 public superNodeAmount; -contract DomainResolver public knsResolver; -//internal members -bytes32 internal nodeNamehash; -address[] internal validatorPool; -struct ValidatorMgr.TKN internal tkn; -//private members -mapping(address => struct ValidatorMgr.Validator) private validatorRegistry; -``` - -## Modifiers - -- [onlyWithMinDeposit](#onlywithmindeposit) -- [onlyValidator](#onlyvalidator) -- [onlyNewCandidate](#onlynewcandidate) - -### onlyWithMinDeposit - -```js -modifier onlyWithMinDeposit() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -### onlyValidator - -```js -modifier onlyValidator() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -### onlyNewCandidate - -```js -modifier onlyNewCandidate() internal -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| - -## Functions - -- [initialize](#initialize) -- [isGenesisValidator](#isgenesisvalidator) -- [isValidator](#isvalidator) -- [isSuperNode](#issupernode) -- [getValidatorCount](#getvalidatorcount) -- [getValidatorAtIndex](#getvalidatoratindex) -- [_hasAvailability](#_hasavailability) -- [getMinimumDeposit](#getminimumdeposit) -- [_updateChecksum](#_updatechecksum) -- [_insertValidator](#_insertvalidator) -- [setBaseDeposit](#setbasedeposit) -- [setMaxValidators](#setmaxvalidators) -- [_deleteValidator](#_deletevalidator) -- [_deleteSmallestBidder](#_deletesmallestbidder) -- [getDepositCount](#getdepositcount) -- [getDepositAtIndex](#getdepositatindex) -- [_registerValidator](#_registervalidator) -- [deregisterValidator](#deregistervalidator) -- [_removeDeposits](#_removedeposits) -- [releaseDeposits](#releasedeposits) -- [registerValidator](#registervalidator) - -### initialize - -```js -function initialize(uint256 _baseDeposit, uint256 _maxNumValidators, uint256 _freezePeriod, uint256 _superNodeAmount, address _resolverAddr) public isInitializer -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _baseDeposit | uint256 | base deposit for Validator | -| _maxNumValidators | uint256 | Maximum numbers of Validators. | -| _freezePeriod | uint256 | Freeze period for Validator's deposits. | -| _superNodeAmount | uint256 | Amount required to be considered a super node. | -| _resolverAddr | address | Address of KNS Resolver. | - -### isGenesisValidator - -Checks if given address is Genesis Validator - -```js -function isGenesisValidator(address code) public view -returns(isIndeed bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| code | address | Address of an Validator. | - -### isValidator - -Checks if given address is Validator - -```js -function isValidator(address code) public view -returns(isIndeed bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| code | address | Address of a Validator to check. | - -### isSuperNode - -Checks if given address is super node - -```js -function isSuperNode(address code) public view -returns(isIndeed bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| code | address | Address of a supernode to check. | - -### getValidatorCount - -Get Validator count - -```js -function getValidatorCount() public view -returns(count uint256) -``` - -### getValidatorAtIndex - -Get Validator information - -```js -function getValidatorAtIndex(uint256 index) public view -returns(code address, deposit uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| index | uint256 | index of an Validator to check. | - -### _hasAvailability - -```js -function _hasAvailability() public view -returns(available bool) -``` - -### getMinimumDeposit - -returns the base deposit if there are positions available or -the current smallest deposit required if there aren't positions available. - -```js -function getMinimumDeposit() public view -returns(deposit uint256) -``` - -### _updateChecksum - -updates the checksum - -```js -function _updateChecksum() private -``` - -### _insertValidator - -Add new validator - -```js -function _insertValidator(address code, uint256 deposit) private -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| code | address | Address of an Validator. | -| deposit | uint256 | amount to deposit | - -### setBaseDeposit - -Set new base deposit for Validators - -```js -function setBaseDeposit(uint256 deposit) public onlyOwner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| deposit | uint256 | | - -### setMaxValidators - -Set maximum numbers of Validators - -```js -function setMaxValidators(uint256 max) public onlyOwner -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| max | uint256 | number of max Validators | - -### _deleteValidator - -Delete Validator - -```js -function _deleteValidator(address account) private -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| account | address | address of a Validator | - -### _deleteSmallestBidder - -removes the Validator with the smallest deposit - -```js -function _deleteSmallestBidder() private -``` - -### getDepositCount - -Get deposit count - -```js -function getDepositCount() public view -returns(count uint256) -``` - -### getDepositAtIndex - -Get deposit at given index - -```js -function getDepositAtIndex(uint256 index) public view -returns(amount uint256, availableAt uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| index | uint256 | index of a Validator to get deposit | - -### _registerValidator - -Register new Validator - -```js -function _registerValidator() private whenNotPaused onlyNewCandidate onlyWithMinDeposit -``` - -### deregisterValidator - -deregister Validator - -```js -function deregisterValidator() public whenNotPaused onlyValidator -``` - -### _removeDeposits - -remove deposit - -```js -function _removeDeposits(address code, uint256 index) private -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| code | address | address of a Validator | -| index | uint256 | index of a deposit | - -### releaseDeposits - -transfers locked deposit(s) back the user account if they are past the freeze period - -```js -function releaseDeposits() public whenNotPaused -``` - -### registerValidator - -Register Validator - -```js -function registerValidator(address _from, uint256 _value) public -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| _from | address | from address | -| _value | uint256 | value to send | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) diff --git a/docs/docs/strings.md b/docs/docs/strings.md deleted file mode 100644 index 05a716428..000000000 --- a/docs/docs/strings.md +++ /dev/null @@ -1,497 +0,0 @@ -# strings.sol - -**strings** - -## Structs -### slice - -```js -struct slice { - uint256 _len, - uint256 _ptr -} -``` - -## Functions - -- [memcpy](#memcpy) -- [toSlice](#toslice) -- [len](#len) -- [toSliceB32](#tosliceb32) -- [copy](#copy) -- [toString](#tostring) -- [len](#len) -- [empty](#empty) -- [compare](#compare) -- [equals](#equals) -- [nextRune](#nextrune) -- [nextRune](#nextrune) -- [ord](#ord) -- [keccak](#keccak) -- [startsWith](#startswith) -- [beyond](#beyond) -- [endsWith](#endswith) -- [until](#until) -- [findPtr](#findptr) -- [rfindPtr](#rfindptr) -- [find](#find) -- [rfind](#rfind) -- [split](#split) -- [split](#split) -- [rsplit](#rsplit) -- [rsplit](#rsplit) -- [count](#count) -- [contains](#contains) -- [concat](#concat) -- [join](#join) - -### memcpy - -```js -function memcpy(uint256 dest, uint256 src, uint256 len) private -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| dest | uint256 | | -| src | uint256 | | -| len | uint256 | | - -### toSlice - -```js -function toSlice(string self) internal -returns(struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | string | | - -### len - -```js -function len(bytes32 self) internal -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | bytes32 | | - -### toSliceB32 - -```js -function toSliceB32(bytes32 self) internal -returns(ret struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | bytes32 | | - -### copy - -```js -function copy(struct strings.slice self) internal -returns(struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | - -### toString - -```js -function toString(struct strings.slice self) internal -returns(string) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | - -### len - -```js -function len(struct strings.slice self) internal -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | - -### empty - -```js -function empty(struct strings.slice self) internal -returns(bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | - -### compare - -```js -function compare(struct strings.slice self, struct strings.slice other) internal -returns(int256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| other | struct strings.slice | | - -### equals - -```js -function equals(struct strings.slice self, struct strings.slice other) internal -returns(bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| other | struct strings.slice | | - -### nextRune - -```js -function nextRune(struct strings.slice self, struct strings.slice rune) internal -returns(struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| rune | struct strings.slice | | - -### nextRune - -```js -function nextRune(struct strings.slice self) internal -returns(ret struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | - -### ord - -```js -function ord(struct strings.slice self) internal -returns(ret uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | - -### keccak - -```js -function keccak(struct strings.slice self) internal -returns(ret bytes32) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | - -### startsWith - -```js -function startsWith(struct strings.slice self, struct strings.slice needle) internal -returns(bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### beyond - -```js -function beyond(struct strings.slice self, struct strings.slice needle) internal -returns(struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### endsWith - -```js -function endsWith(struct strings.slice self, struct strings.slice needle) internal -returns(bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### until - -```js -function until(struct strings.slice self, struct strings.slice needle) internal -returns(struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### findPtr - -```js -function findPtr(uint256 selflen, uint256 selfptr, uint256 needlelen, uint256 needleptr) private -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| selflen | uint256 | | -| selfptr | uint256 | | -| needlelen | uint256 | | -| needleptr | uint256 | | - -### rfindPtr - -```js -function rfindPtr(uint256 selflen, uint256 selfptr, uint256 needlelen, uint256 needleptr) private -returns(uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| selflen | uint256 | | -| selfptr | uint256 | | -| needlelen | uint256 | | -| needleptr | uint256 | | - -### find - -```js -function find(struct strings.slice self, struct strings.slice needle) internal -returns(struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### rfind - -```js -function rfind(struct strings.slice self, struct strings.slice needle) internal -returns(struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### split - -```js -function split(struct strings.slice self, struct strings.slice needle, struct strings.slice token) internal -returns(struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | -| token | struct strings.slice | | - -### split - -```js -function split(struct strings.slice self, struct strings.slice needle) internal -returns(token struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### rsplit - -```js -function rsplit(struct strings.slice self, struct strings.slice needle, struct strings.slice token) internal -returns(struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | -| token | struct strings.slice | | - -### rsplit - -```js -function rsplit(struct strings.slice self, struct strings.slice needle) internal -returns(token struct strings.slice) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### count - -```js -function count(struct strings.slice self, struct strings.slice needle) internal -returns(count uint256) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### contains - -```js -function contains(struct strings.slice self, struct strings.slice needle) internal -returns(bool) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| needle | struct strings.slice | | - -### concat - -```js -function concat(struct strings.slice self, struct strings.slice other) internal -returns(string) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| other | struct strings.slice | | - -### join - -```js -function join(struct strings.slice self, struct strings.slice[] parts) internal -returns(string) -``` - -**Arguments** - -| Name | Type | Description | -| ------------- |------------- | -----| -| self | struct strings.slice | | -| parts | struct strings.slice[] | | - -## Contracts - -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) -- [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) -- [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) -- [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) -- [Initializable](Initializable.md) -- [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) -- [Stability](Stability.md) -- [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) From 3eb8db993cfb6359489ea79b911b95c51c47e0c4 Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Fri, 5 Oct 2018 14:40:38 +0100 Subject: [PATCH 15/18] Added diff --- Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/Makefile b/Makefile index fddc4d1ca..ff6b5c5aa 100644 --- a/Makefile +++ b/Makefile @@ -123,6 +123,7 @@ docker_solidoc_generate: .PHONY: assert_no_changes assert_no_changes: + git --no-pager diff git status @if ! git diff-index --quiet HEAD; then echo 'There are uncommited generated files.\nRun `make docker_generate` to regenerate all of them.'; exit 1; fi From 2a1ee1728b1811697436c4bb329b025ed6f82ef2 Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Fri, 5 Oct 2018 15:29:28 +0100 Subject: [PATCH 16/18] Added solidoc 1.0.3 --- .drone.yml | 2 +- Makefile | 2 +- docs/docs/smartcontracts/BalanceContract.md | 50 +++++++++---------- docs/docs/smartcontracts/CappedToken.md | 50 +++++++++---------- docs/docs/smartcontracts/Consensus.md | 50 +++++++++---------- docs/docs/smartcontracts/ConsensusMock.md | 50 +++++++++---------- docs/docs/smartcontracts/DomainResolver.md | 50 +++++++++---------- .../docs/smartcontracts/DomainResolverMock.md | 50 +++++++++---------- docs/docs/smartcontracts/ExchangeMgr.md | 50 +++++++++---------- docs/docs/smartcontracts/FIFSRegistrar.md | 50 +++++++++---------- docs/docs/smartcontracts/Initializable.md | 50 +++++++++---------- docs/docs/smartcontracts/KNS.md | 50 +++++++++---------- docs/docs/smartcontracts/KNSRegistry.md | 50 +++++++++---------- docs/docs/smartcontracts/KNSRegistryV1.md | 50 +++++++++---------- docs/docs/smartcontracts/KRC223.md | 50 +++++++++---------- docs/docs/smartcontracts/Math.md | 50 +++++++++---------- docs/docs/smartcontracts/Migrations.md | 50 +++++++++---------- docs/docs/smartcontracts/MiningToken.md | 50 +++++++++---------- docs/docs/smartcontracts/MintableToken.md | 50 +++++++++---------- docs/docs/smartcontracts/MultiSigWallet.md | 50 +++++++++---------- docs/docs/smartcontracts/NameHash.md | 50 +++++++++---------- docs/docs/smartcontracts/OracleMgr.md | 50 +++++++++---------- docs/docs/smartcontracts/Ownable.md | 50 +++++++++---------- docs/docs/smartcontracts/Pausable.md | 50 +++++++++---------- docs/docs/smartcontracts/PriceProvider.md | 50 +++++++++---------- docs/docs/smartcontracts/PublicResolver.md | 50 +++++++++---------- docs/docs/smartcontracts/SafeMath.md | 50 +++++++++---------- docs/docs/smartcontracts/Stability.md | 50 +++++++++---------- docs/docs/smartcontracts/SystemVars.md | 50 +++++++++---------- docs/docs/smartcontracts/Token.md | 50 +++++++++---------- docs/docs/smartcontracts/TokenMock.md | 50 +++++++++---------- docs/docs/smartcontracts/TokenReceiver.md | 50 +++++++++---------- docs/docs/smartcontracts/ValidatorMgr.md | 50 +++++++++---------- docs/docs/smartcontracts/strings.md | 50 +++++++++---------- 34 files changed, 802 insertions(+), 802 deletions(-) diff --git a/.drone.yml b/.drone.yml index b3618059c..12027a8d9 100644 --- a/.drone.yml +++ b/.drone.yml @@ -27,7 +27,7 @@ pipeline: build_solidity_docs: group: solidity_docs - image: kowalatech/solidoc:1.0.2 + image: kowalatech/solidoc:1.0.3 commands: - make solidoc_generate when: diff --git a/Makefile b/Makefile index ff6b5c5aa..b9d053138 100644 --- a/Makefile +++ b/Makefile @@ -119,7 +119,7 @@ docker_go_generate: docker run --rm -v $(PWD):/go/src/github.com/kowala-tech/kcoin -w /go/src/github.com/kowala-tech/kcoin kowalatech/go:1.0.12 make install_tools go_generate docker_solidoc_generate: - docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/docs/docs/smartcontracts:/out kowalatech/solidoc:1.0.2 /src /out + docker run --rm -it -v $(PWD)/client/contracts/truffle/:/src -v $(PWD)/docs/docs/smartcontracts:/out kowalatech/solidoc:1.0.3 /src /out .PHONY: assert_no_changes assert_no_changes: diff --git a/docs/docs/smartcontracts/BalanceContract.md b/docs/docs/smartcontracts/BalanceContract.md index 508eb88fa..d2d87b789 100644 --- a/docs/docs/smartcontracts/BalanceContract.md +++ b/docs/docs/smartcontracts/BalanceContract.md @@ -38,35 +38,35 @@ function tokenFallback(address _from, uint256 _value, bytes _data) public ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/CappedToken.md b/docs/docs/smartcontracts/CappedToken.md index ecc226d56..e90100703 100644 --- a/docs/docs/smartcontracts/CappedToken.md +++ b/docs/docs/smartcontracts/CappedToken.md @@ -41,35 +41,35 @@ A boolean that indicates if the operation was successful. ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/Consensus.md b/docs/docs/smartcontracts/Consensus.md index f2016b986..4108d09fa 100644 --- a/docs/docs/smartcontracts/Consensus.md +++ b/docs/docs/smartcontracts/Consensus.md @@ -21,35 +21,35 @@ returns(bool) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/ConsensusMock.md b/docs/docs/smartcontracts/ConsensusMock.md index 166f11518..3cc5214bb 100644 --- a/docs/docs/smartcontracts/ConsensusMock.md +++ b/docs/docs/smartcontracts/ConsensusMock.md @@ -28,35 +28,35 @@ returns(bool) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/DomainResolver.md b/docs/docs/smartcontracts/DomainResolver.md index f453194b2..1fd75af72 100644 --- a/docs/docs/smartcontracts/DomainResolver.md +++ b/docs/docs/smartcontracts/DomainResolver.md @@ -25,35 +25,35 @@ The associated address. ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/DomainResolverMock.md b/docs/docs/smartcontracts/DomainResolverMock.md index b65b06706..810009ab9 100644 --- a/docs/docs/smartcontracts/DomainResolverMock.md +++ b/docs/docs/smartcontracts/DomainResolverMock.md @@ -28,35 +28,35 @@ returns(address) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/ExchangeMgr.md b/docs/docs/smartcontracts/ExchangeMgr.md index 557c57b6d..617be6637 100644 --- a/docs/docs/smartcontracts/ExchangeMgr.md +++ b/docs/docs/smartcontracts/ExchangeMgr.md @@ -228,35 +228,35 @@ returns(name string) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/FIFSRegistrar.md b/docs/docs/smartcontracts/FIFSRegistrar.md index 2e6c32889..017aaebd0 100644 --- a/docs/docs/smartcontracts/FIFSRegistrar.md +++ b/docs/docs/smartcontracts/FIFSRegistrar.md @@ -63,35 +63,35 @@ function register(bytes32 subnode, address owner) public only_owner ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/Initializable.md b/docs/docs/smartcontracts/Initializable.md index 008c35531..4a025661b 100644 --- a/docs/docs/smartcontracts/Initializable.md +++ b/docs/docs/smartcontracts/Initializable.md @@ -38,35 +38,35 @@ modifier isInitializer() internal ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/KNS.md b/docs/docs/smartcontracts/KNS.md index a76e32125..d5dc558d4 100644 --- a/docs/docs/smartcontracts/KNS.md +++ b/docs/docs/smartcontracts/KNS.md @@ -115,35 +115,35 @@ returns(uint64) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/KNSRegistry.md b/docs/docs/smartcontracts/KNSRegistry.md index fee6b80ab..e851f3182 100644 --- a/docs/docs/smartcontracts/KNSRegistry.md +++ b/docs/docs/smartcontracts/KNSRegistry.md @@ -197,35 +197,35 @@ ttl of the node. ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/KNSRegistryV1.md b/docs/docs/smartcontracts/KNSRegistryV1.md index e27194b13..be1341174 100644 --- a/docs/docs/smartcontracts/KNSRegistryV1.md +++ b/docs/docs/smartcontracts/KNSRegistryV1.md @@ -203,35 +203,35 @@ ttl of the node. ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/KRC223.md b/docs/docs/smartcontracts/KRC223.md index bad84499a..bd1c6e2e7 100644 --- a/docs/docs/smartcontracts/KRC223.md +++ b/docs/docs/smartcontracts/KRC223.md @@ -114,35 +114,35 @@ returns(ok bool) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/Math.md b/docs/docs/smartcontracts/Math.md index 89febaa3b..cf4be176b 100644 --- a/docs/docs/smartcontracts/Math.md +++ b/docs/docs/smartcontracts/Math.md @@ -67,35 +67,35 @@ returns(uint256) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/Migrations.md b/docs/docs/smartcontracts/Migrations.md index 2f52b8474..736dfce67 100644 --- a/docs/docs/smartcontracts/Migrations.md +++ b/docs/docs/smartcontracts/Migrations.md @@ -56,35 +56,35 @@ function upgrade(address new_address) public restricted ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/MiningToken.md b/docs/docs/smartcontracts/MiningToken.md index f9a1ec60f..c1d1d7d62 100644 --- a/docs/docs/smartcontracts/MiningToken.md +++ b/docs/docs/smartcontracts/MiningToken.md @@ -45,35 +45,35 @@ returns(address) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/MintableToken.md b/docs/docs/smartcontracts/MintableToken.md index a9ae2dc1e..2702fd2c9 100644 --- a/docs/docs/smartcontracts/MintableToken.md +++ b/docs/docs/smartcontracts/MintableToken.md @@ -73,35 +73,35 @@ True if the operation was successful. ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/MultiSigWallet.md b/docs/docs/smartcontracts/MultiSigWallet.md index 4c337b242..8707ef3ad 100644 --- a/docs/docs/smartcontracts/MultiSigWallet.md +++ b/docs/docs/smartcontracts/MultiSigWallet.md @@ -477,35 +477,35 @@ Returns array of transaction IDs. ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/NameHash.md b/docs/docs/smartcontracts/NameHash.md index 48191e98f..ac834ec53 100644 --- a/docs/docs/smartcontracts/NameHash.md +++ b/docs/docs/smartcontracts/NameHash.md @@ -25,35 +25,35 @@ _namehash The result of namehash algorithm applied at _node. ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/OracleMgr.md b/docs/docs/smartcontracts/OracleMgr.md index 06d1ee70b..01fc8101a 100644 --- a/docs/docs/smartcontracts/OracleMgr.md +++ b/docs/docs/smartcontracts/OracleMgr.md @@ -256,35 +256,35 @@ function submitPrice(uint256 _price) public whenNotPaused onlyOracle onlyOnce ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/Ownable.md b/docs/docs/smartcontracts/Ownable.md index 975162f7c..bda200b49 100644 --- a/docs/docs/smartcontracts/Ownable.md +++ b/docs/docs/smartcontracts/Ownable.md @@ -82,35 +82,35 @@ function _transferOwnership(address _newOwner) internal ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/Pausable.md b/docs/docs/smartcontracts/Pausable.md index 696f44eac..2d860cf0e 100644 --- a/docs/docs/smartcontracts/Pausable.md +++ b/docs/docs/smartcontracts/Pausable.md @@ -74,35 +74,35 @@ function unpause() public onlyOwner whenPaused ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/PriceProvider.md b/docs/docs/smartcontracts/PriceProvider.md index 2c1afd64f..c26867c88 100644 --- a/docs/docs/smartcontracts/PriceProvider.md +++ b/docs/docs/smartcontracts/PriceProvider.md @@ -15,35 +15,35 @@ returns(uint256) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/PublicResolver.md b/docs/docs/smartcontracts/PublicResolver.md index 5f283a13c..14413b4fb 100644 --- a/docs/docs/smartcontracts/PublicResolver.md +++ b/docs/docs/smartcontracts/PublicResolver.md @@ -339,35 +339,35 @@ True if the contract implements the requested interface. ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/SafeMath.md b/docs/docs/smartcontracts/SafeMath.md index a53dc55f5..837e99cf4 100644 --- a/docs/docs/smartcontracts/SafeMath.md +++ b/docs/docs/smartcontracts/SafeMath.md @@ -75,35 +75,35 @@ returns(c uint256) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/Stability.md b/docs/docs/smartcontracts/Stability.md index 233b2354f..767389a0c 100644 --- a/docs/docs/smartcontracts/Stability.md +++ b/docs/docs/smartcontracts/Stability.md @@ -148,35 +148,35 @@ function unsubscribe() public onlySubscriber whenPriceGreaterEqualOne ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/SystemVars.md b/docs/docs/smartcontracts/SystemVars.md index 50f432089..fc5d7dea7 100644 --- a/docs/docs/smartcontracts/SystemVars.md +++ b/docs/docs/smartcontracts/SystemVars.md @@ -105,35 +105,35 @@ returns(uint256) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/Token.md b/docs/docs/smartcontracts/Token.md index 7e879a4bb..1cb8c1b76 100644 --- a/docs/docs/smartcontracts/Token.md +++ b/docs/docs/smartcontracts/Token.md @@ -178,35 +178,35 @@ returns(balance uint256) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/TokenMock.md b/docs/docs/smartcontracts/TokenMock.md index 7545be44d..fe7e7754f 100644 --- a/docs/docs/smartcontracts/TokenMock.md +++ b/docs/docs/smartcontracts/TokenMock.md @@ -117,35 +117,35 @@ returns(ok bool) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/TokenReceiver.md b/docs/docs/smartcontracts/TokenReceiver.md index a06c0dc88..08eb7309d 100644 --- a/docs/docs/smartcontracts/TokenReceiver.md +++ b/docs/docs/smartcontracts/TokenReceiver.md @@ -22,35 +22,35 @@ function tokenFallback(address _from, uint256 _value, bytes _data) public ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/ValidatorMgr.md b/docs/docs/smartcontracts/ValidatorMgr.md index 1d362730e..2bfa5a770 100644 --- a/docs/docs/smartcontracts/ValidatorMgr.md +++ b/docs/docs/smartcontracts/ValidatorMgr.md @@ -371,35 +371,35 @@ function registerValidator(address _from, uint256 _value) public ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) diff --git a/docs/docs/smartcontracts/strings.md b/docs/docs/smartcontracts/strings.md index 05a716428..0a924f5a6 100644 --- a/docs/docs/smartcontracts/strings.md +++ b/docs/docs/smartcontracts/strings.md @@ -463,35 +463,35 @@ returns(string) ## Contracts -- [DomainResolverMock](DomainResolverMock.md) -- [ValidatorMgr](ValidatorMgr.md) -- [SafeMath](SafeMath.md) -- [MintableToken](MintableToken.md) -- [Ownable](Ownable.md) -- [KRC223](KRC223.md) -- [KNSRegistry](KNSRegistry.md) -- [Token](Token.md) -- [OracleMgr](OracleMgr.md) -- [NameHash](NameHash.md) -- [KNS](KNS.md) -- [Pausable](Pausable.md) -- [TokenMock](TokenMock.md) -- [strings](strings.md) -- [Math](Math.md) - [BalanceContract](BalanceContract.md) -- [PublicResolver](PublicResolver.md) -- [MultiSigWallet](MultiSigWallet.md) -- [KNSRegistryV1](KNSRegistryV1.md) +- [CappedToken](CappedToken.md) +- [Consensus](Consensus.md) +- [ConsensusMock](ConsensusMock.md) +- [DomainResolver](DomainResolver.md) +- [DomainResolverMock](DomainResolverMock.md) - [ExchangeMgr](ExchangeMgr.md) -- [Migrations](Migrations.md) -- [SystemVars](SystemVars.md) - [FIFSRegistrar](FIFSRegistrar.md) -- [PriceProvider](PriceProvider.md) - [Initializable](Initializable.md) +- [KNS](KNS.md) +- [KNSRegistry](KNSRegistry.md) +- [KNSRegistryV1](KNSRegistryV1.md) +- [KRC223](KRC223.md) +- [Math](Math.md) +- [Migrations](Migrations.md) - [MiningToken](MiningToken.md) -- [ConsensusMock](ConsensusMock.md) +- [MintableToken](MintableToken.md) +- [MultiSigWallet](MultiSigWallet.md) +- [NameHash](NameHash.md) +- [OracleMgr](OracleMgr.md) +- [Ownable](Ownable.md) +- [Pausable](Pausable.md) +- [PriceProvider](PriceProvider.md) +- [PublicResolver](PublicResolver.md) +- [SafeMath](SafeMath.md) - [Stability](Stability.md) +- [strings](strings.md) +- [SystemVars](SystemVars.md) +- [Token](Token.md) +- [TokenMock](TokenMock.md) - [TokenReceiver](TokenReceiver.md) -- [DomainResolver](DomainResolver.md) -- [CappedToken](CappedToken.md) -- [Consensus](Consensus.md) +- [ValidatorMgr](ValidatorMgr.md) From eae67bc946af5be894cb855865770ae250b5ba10 Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Fri, 5 Oct 2018 15:39:34 +0100 Subject: [PATCH 17/18] Fixed typo --- client/contracts/truffle/contracts/oracle/ExchangeMgr.sol | 6 +++--- docs/docs/smartcontracts/ExchangeMgr.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/client/contracts/truffle/contracts/oracle/ExchangeMgr.sol b/client/contracts/truffle/contracts/oracle/ExchangeMgr.sol index 2d642a87d..f729210ac 100644 --- a/client/contracts/truffle/contracts/oracle/ExchangeMgr.sol +++ b/client/contracts/truffle/contracts/oracle/ExchangeMgr.sol @@ -107,7 +107,7 @@ contract ExchangeMgr is Pausable, Initializable { } /** - * @dev checks whether the given name is an whitelisted exchange or not + * @dev checks whether the given name is a whitelisted exchange or not * @param name exchange name. */ function isExchange(string name) public view returns (bool isIndeed) { @@ -115,7 +115,7 @@ contract ExchangeMgr is Pausable, Initializable { } /** - * @dev checks whether the given name is an whitelisted exchange or not + * @dev checks whether the given name is a whitelisted exchange or not * @param name exchange name. */ function isWhitelistedExchange(string name) public view returns (bool isIndeed) { @@ -144,4 +144,4 @@ contract ExchangeMgr is Pausable, Initializable { function getWhitelistedExchangeAtIndex(uint index) public view returns (string name) { return whitelist[index]; } -} \ No newline at end of file +} diff --git a/docs/docs/smartcontracts/ExchangeMgr.md b/docs/docs/smartcontracts/ExchangeMgr.md index 617be6637..5433d4dcf 100644 --- a/docs/docs/smartcontracts/ExchangeMgr.md +++ b/docs/docs/smartcontracts/ExchangeMgr.md @@ -159,7 +159,7 @@ function blacklistExchange(string name) public whenNotPaused onlyOwner onlyWhite ### isExchange -checks whether the given name is an whitelisted exchange or not +checks whether the given name is a whitelisted exchange or not ```js function isExchange(string name) public view @@ -174,7 +174,7 @@ returns(isIndeed bool) ### isWhitelistedExchange -checks whether the given name is an whitelisted exchange or not +checks whether the given name is a whitelisted exchange or not ```js function isWhitelistedExchange(string name) public view From f1a9565f082063d8777a5639ffe2b3c6122c5497 Mon Sep 17 00:00:00 2001 From: Paul M Fox Date: Fri, 5 Oct 2018 15:47:33 +0100 Subject: [PATCH 18/18] Update go_generate --- Makefile | 1 - client/contracts/bindings/oracle/build/ExchangeMgr.bin | 2 +- client/contracts/bindings/oracle/gen_exchange.go | 2 +- .../contracts/bindings/oracle/testfiles/build/ExchangeMgr.bin | 2 +- client/contracts/bindings/oracle/testfiles/gen_exchange.go | 2 +- 5 files changed, 4 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index b9d053138..1d0db1173 100644 --- a/Makefile +++ b/Makefile @@ -123,7 +123,6 @@ docker_solidoc_generate: .PHONY: assert_no_changes assert_no_changes: - git --no-pager diff git status @if ! git diff-index --quiet HEAD; then echo 'There are uncommited generated files.\nRun `make docker_generate` to regenerate all of them.'; exit 1; fi diff --git a/client/contracts/bindings/oracle/build/ExchangeMgr.bin b/client/contracts/bindings/oracle/build/ExchangeMgr.bin index 9e13c3d5d..b2d56d4d3 100644 --- a/client/contracts/bindings/oracle/build/ExchangeMgr.bin +++ b/client/contracts/bindings/oracle/build/ExchangeMgr.bin @@ -1 +1 @@ -608060405260008060146101000a81548160ff021916908315150217905550336000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550611abb8061006d6000396000f3006080604052600436106100f1576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063158ef93e146100f65780633b56711b146101255780633f4ba83a1461018e5780634bbc5a61146101a5578063569bca69146102265780635c975abb146102a757806364dfaff8146102d65780636fcceefe14610357578063715018a6146103825780637ebd1b30146103995780638456cb591461043f5780638da5cb5b1461045657806393a25542146104ad578063a7e71ee314610516578063ad6a23b21461057f578063f2fde38b146105e8578063fc44d0b41461062b575b600080fd5b34801561010257600080fd5b5061010b6106d1565b604051808215151515815260200191505060405180910390f35b34801561013157600080fd5b5061018c600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506106e4565b005b34801561019a57600080fd5b506101a3610a23565b005b3480156101b157600080fd5b5061020c600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610ae1565b604051808215151515815260200191505060405180910390f35b34801561023257600080fd5b5061028d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610b66565b604051808215151515815260200191505060405180910390f35b3480156102b357600080fd5b506102bc610bfc565b604051808215151515815260200191505060405180910390f35b3480156102e257600080fd5b5061033d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610c0f565b604051808215151515815260200191505060405180910390f35b34801561036357600080fd5b5061036c610ca6565b6040518082815260200191505060405180910390f35b34801561038e57600080fd5b50610397610cb3565b005b3480156103a557600080fd5b506103c460048036038101908080359060200190929190505050610db5565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156104045780820151818401526020810190506103e9565b50505050905090810190601f1680156104315780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561044b57600080fd5b50610454610e70565b005b34801561046257600080fd5b5061046b610f30565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b3480156104b957600080fd5b50610514600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610f55565b005b34801561052257600080fd5b5061057d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611249565b005b34801561058b57600080fd5b506105e6600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611474565b005b3480156105f457600080fd5b50610629600480360381019080803573ffffffffffffffffffffffffffffffffffffffff1690602001909291905050506116a7565b005b34801561063757600080fd5b506106566004803603810190808035906020019092919050505061170e565b6040518080602001828103825283818151815260200191508051906020019080838360005b8381101561069657808201518184015260208101905061067b565b50505050905090810190601f1680156106c35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b600060159054906101000a900460ff1681565b60008060008060149054906101000a900460ff1615151561070457600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561075f57600080fd5b8361076981610b66565b1515610803576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f7420612077686974656c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b6001856040518082805190602001908083835b60208310151561083b5780518252602082019150602081019050602083039250610816565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902093508360000154925060008460010160016101000a81548160ff02191690831515021790555060026001600280549050038154811015156108ab57fe5b906000526020600020019150816002848154811015156108c757fe5b9060005260206000200190805460018160011615610100020316600290046108f09291906118c3565b508260018360405180828054600181600116156101000203166002900480156109505780601f1061092e576101008083540402835291820191610950565b820191906000526020600020905b81548152906001019060200180831161093c575b5050915050908152602001604051809103902060000181905550600280548091906001900361097f919061194a565b507f81e32445db1ab3f971a6e0ae415ce6f58f8ad4ac1e87f6eaf42067e404f81dae856040518080602001828103825283818151815260200191508051906020019080838360005b838110156109e25780820151818401526020810190506109c7565b50505050905090810190601f168015610a0f5780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050505050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610a7e57600080fd5b600060149054906101000a900460ff161515610a9957600080fd5b60008060146101000a81548160ff0219169083151502179055507f7805862f689e2f13df9f062ff482ad3ad112aca9e0847911ed832e158c525b3360405160405180910390a1565b60006001826040518082805190602001908083835b602083101515610b1b5780518252602082019150602081019050602083039250610af6565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160009054906101000a900460ff169050919050565b6000610b7182610ae1565b8015610bf557506001826040518082805190602001908083835b602083101515610bb05780518252602082019150602081019050602083039250610b8b565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff165b9050919050565b600060149054906101000a900460ff1681565b6000610c1a82610ae1565b8015610c9f57506001826040518082805190602001908083835b602083101515610c595780518252602082019150602081019050602083039250610c34565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff16155b9050919050565b6000600280549050905090565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610d0e57600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167ff8df31144d9c2f0f6b59d69b8b98abd5459d07f2742c4df920b25aae33c6482060405160405180910390a260008060006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550565b600281815481101515610dc457fe5b906000526020600020016000915090508054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610e685780601f10610e3d57610100808354040283529160200191610e68565b820191906000526020600020905b815481529060010190602001808311610e4b57829003601f168201915b505050505081565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610ecb57600080fd5b600060149054906101000a900460ff16151515610ee757600080fd5b6001600060146101000a81548160ff0219169083151502179055507f6985a02210a168e66602d3235cb6db0e70f92b3ba4d376a33c0f3d9434bff62560405160405180910390a1565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b600060149054906101000a900460ff16151515610f7157600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610fcc57600080fd5b80610fd681610c0f565b1515611070576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f74206120626c61636b6c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b600160028390806001815401808255809150509060018203906000526020600020016000909192909190915090805190602001906110af929190611976565b50036001836040518082805190602001908083835b6020831015156110e957805182526020820191506020810190506020830392506110c4565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060000181905550600180836040518082805190602001908083835b60208310151561115c5780518252602082019150602081019050602083039250611137565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160016101000a81548160ff0219169083151502179055507fce09318849d53fa41700de1700ae3708b944cb20a5a4a4fd51a331625ce72a7a826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561120b5780820151818401526020810190506111f0565b50505050905090810190601f1680156112385780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b60008060149054906101000a900460ff1615151561126657600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156112c157600080fd5b816112cb81610ae1565b151515611340576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260178152602001807f65786368616e676520616c72656164792065786973747300000000000000000081525060200191505060405180910390fd5b6001836040518082805190602001908083835b6020831015156113785780518252602082019150602081019050602083039250611353565b6001836020036101000a0380198251168184511680821785525050505050509050019150509081526020016040518091039020915060018260010160006101000a81548160ff0219169083151502179055507f9874713fe684a190f03252911ed81f4e7754af845b47e2734570c0a8d78417a8836040518080602001828103825283818151815260200191508051906020019080838360005b8381101561142c578082015181840152602081019050611411565b50505050905090810190601f1680156114595780820380516001836020036101000a031916815260200191505b509250505060405180910390a161146f83610f55565b505050565b600060149054906101000a900460ff1615151561149057600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156114eb57600080fd5b806114f581610ae1565b1515611569576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252601d8152602001807f676976656e206e616d65206973206e6f7420616e2065786368616e676500000081525060200191505060405180910390fd5b6001826040518082805190602001908083835b6020831015156115a1578051825260208201915060208101905060208303925061157c565b6001836020036101000a03801982511681845116808217855250505050505090500191505090815260200160405180910390206000808201600090556001820160006101000a81549060ff02191690556001820160016101000a81549060ff021916905550507f9751cac4d5046f38f52784e809c6e39f08eb2846a96993b1ea7528937f380e1b826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561166957808201518184015260208101905061164e565b50505050905090810190601f1680156116965780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561170257600080fd5b61170b816117c9565b50565b606060028281548110151561171f57fe5b906000526020600020018054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156117bd5780601f10611792576101008083540402835291602001916117bd565b820191906000526020600020905b8154815290600101906020018083116117a057829003601f168201915b50505050509050919050565b600073ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff161415151561180557600080fd5b8073ffffffffffffffffffffffffffffffffffffffff166000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106118fc5780548555611939565b8280016001018555821561193957600052602060002091601f016020900482015b8281111561193857825482559160010191906001019061191d565b5b50905061194691906119f6565b5090565b815481835581811115611971578183600052602060002091820191016119709190611a1b565b5b505050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106119b757805160ff19168380011785556119e5565b828001600101855582156119e5579182015b828111156119e45782518255916020019190600101906119c9565b5b5090506119f291906119f6565b5090565b611a1891905b80821115611a145760008160009055506001016119fc565b5090565b90565b611a4491905b80821115611a405760008181611a379190611a47565b50600101611a21565b5090565b90565b50805460018160011615610100020316600290046000825580601f10611a6d5750611a8c565b601f016020900490600052602060002090810190611a8b91906119f6565b5b505600a165627a7a723058207c4afb3d3bcd282a6faa2c0c845fb95f78ff6eb95024e6f767d674b5638f16630029 \ No newline at end of file +608060405260008060146101000a81548160ff021916908315150217905550336000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550611abb8061006d6000396000f3006080604052600436106100f1576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063158ef93e146100f65780633b56711b146101255780633f4ba83a1461018e5780634bbc5a61146101a5578063569bca69146102265780635c975abb146102a757806364dfaff8146102d65780636fcceefe14610357578063715018a6146103825780637ebd1b30146103995780638456cb591461043f5780638da5cb5b1461045657806393a25542146104ad578063a7e71ee314610516578063ad6a23b21461057f578063f2fde38b146105e8578063fc44d0b41461062b575b600080fd5b34801561010257600080fd5b5061010b6106d1565b604051808215151515815260200191505060405180910390f35b34801561013157600080fd5b5061018c600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506106e4565b005b34801561019a57600080fd5b506101a3610a23565b005b3480156101b157600080fd5b5061020c600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610ae1565b604051808215151515815260200191505060405180910390f35b34801561023257600080fd5b5061028d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610b66565b604051808215151515815260200191505060405180910390f35b3480156102b357600080fd5b506102bc610bfc565b604051808215151515815260200191505060405180910390f35b3480156102e257600080fd5b5061033d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610c0f565b604051808215151515815260200191505060405180910390f35b34801561036357600080fd5b5061036c610ca6565b6040518082815260200191505060405180910390f35b34801561038e57600080fd5b50610397610cb3565b005b3480156103a557600080fd5b506103c460048036038101908080359060200190929190505050610db5565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156104045780820151818401526020810190506103e9565b50505050905090810190601f1680156104315780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561044b57600080fd5b50610454610e70565b005b34801561046257600080fd5b5061046b610f30565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b3480156104b957600080fd5b50610514600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610f55565b005b34801561052257600080fd5b5061057d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611249565b005b34801561058b57600080fd5b506105e6600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611474565b005b3480156105f457600080fd5b50610629600480360381019080803573ffffffffffffffffffffffffffffffffffffffff1690602001909291905050506116a7565b005b34801561063757600080fd5b506106566004803603810190808035906020019092919050505061170e565b6040518080602001828103825283818151815260200191508051906020019080838360005b8381101561069657808201518184015260208101905061067b565b50505050905090810190601f1680156106c35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b600060159054906101000a900460ff1681565b60008060008060149054906101000a900460ff1615151561070457600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561075f57600080fd5b8361076981610b66565b1515610803576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f7420612077686974656c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b6001856040518082805190602001908083835b60208310151561083b5780518252602082019150602081019050602083039250610816565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902093508360000154925060008460010160016101000a81548160ff02191690831515021790555060026001600280549050038154811015156108ab57fe5b906000526020600020019150816002848154811015156108c757fe5b9060005260206000200190805460018160011615610100020316600290046108f09291906118c3565b508260018360405180828054600181600116156101000203166002900480156109505780601f1061092e576101008083540402835291820191610950565b820191906000526020600020905b81548152906001019060200180831161093c575b5050915050908152602001604051809103902060000181905550600280548091906001900361097f919061194a565b507f81e32445db1ab3f971a6e0ae415ce6f58f8ad4ac1e87f6eaf42067e404f81dae856040518080602001828103825283818151815260200191508051906020019080838360005b838110156109e25780820151818401526020810190506109c7565b50505050905090810190601f168015610a0f5780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050505050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610a7e57600080fd5b600060149054906101000a900460ff161515610a9957600080fd5b60008060146101000a81548160ff0219169083151502179055507f7805862f689e2f13df9f062ff482ad3ad112aca9e0847911ed832e158c525b3360405160405180910390a1565b60006001826040518082805190602001908083835b602083101515610b1b5780518252602082019150602081019050602083039250610af6565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160009054906101000a900460ff169050919050565b6000610b7182610ae1565b8015610bf557506001826040518082805190602001908083835b602083101515610bb05780518252602082019150602081019050602083039250610b8b565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff165b9050919050565b600060149054906101000a900460ff1681565b6000610c1a82610ae1565b8015610c9f57506001826040518082805190602001908083835b602083101515610c595780518252602082019150602081019050602083039250610c34565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff16155b9050919050565b6000600280549050905090565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610d0e57600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167ff8df31144d9c2f0f6b59d69b8b98abd5459d07f2742c4df920b25aae33c6482060405160405180910390a260008060006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550565b600281815481101515610dc457fe5b906000526020600020016000915090508054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610e685780601f10610e3d57610100808354040283529160200191610e68565b820191906000526020600020905b815481529060010190602001808311610e4b57829003601f168201915b505050505081565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610ecb57600080fd5b600060149054906101000a900460ff16151515610ee757600080fd5b6001600060146101000a81548160ff0219169083151502179055507f6985a02210a168e66602d3235cb6db0e70f92b3ba4d376a33c0f3d9434bff62560405160405180910390a1565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b600060149054906101000a900460ff16151515610f7157600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610fcc57600080fd5b80610fd681610c0f565b1515611070576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f74206120626c61636b6c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b600160028390806001815401808255809150509060018203906000526020600020016000909192909190915090805190602001906110af929190611976565b50036001836040518082805190602001908083835b6020831015156110e957805182526020820191506020810190506020830392506110c4565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060000181905550600180836040518082805190602001908083835b60208310151561115c5780518252602082019150602081019050602083039250611137565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160016101000a81548160ff0219169083151502179055507fce09318849d53fa41700de1700ae3708b944cb20a5a4a4fd51a331625ce72a7a826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561120b5780820151818401526020810190506111f0565b50505050905090810190601f1680156112385780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b60008060149054906101000a900460ff1615151561126657600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156112c157600080fd5b816112cb81610ae1565b151515611340576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260178152602001807f65786368616e676520616c72656164792065786973747300000000000000000081525060200191505060405180910390fd5b6001836040518082805190602001908083835b6020831015156113785780518252602082019150602081019050602083039250611353565b6001836020036101000a0380198251168184511680821785525050505050509050019150509081526020016040518091039020915060018260010160006101000a81548160ff0219169083151502179055507f9874713fe684a190f03252911ed81f4e7754af845b47e2734570c0a8d78417a8836040518080602001828103825283818151815260200191508051906020019080838360005b8381101561142c578082015181840152602081019050611411565b50505050905090810190601f1680156114595780820380516001836020036101000a031916815260200191505b509250505060405180910390a161146f83610f55565b505050565b600060149054906101000a900460ff1615151561149057600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156114eb57600080fd5b806114f581610ae1565b1515611569576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252601d8152602001807f676976656e206e616d65206973206e6f7420616e2065786368616e676500000081525060200191505060405180910390fd5b6001826040518082805190602001908083835b6020831015156115a1578051825260208201915060208101905060208303925061157c565b6001836020036101000a03801982511681845116808217855250505050505090500191505090815260200160405180910390206000808201600090556001820160006101000a81549060ff02191690556001820160016101000a81549060ff021916905550507f9751cac4d5046f38f52784e809c6e39f08eb2846a96993b1ea7528937f380e1b826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561166957808201518184015260208101905061164e565b50505050905090810190601f1680156116965780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561170257600080fd5b61170b816117c9565b50565b606060028281548110151561171f57fe5b906000526020600020018054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156117bd5780601f10611792576101008083540402835291602001916117bd565b820191906000526020600020905b8154815290600101906020018083116117a057829003601f168201915b50505050509050919050565b600073ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff161415151561180557600080fd5b8073ffffffffffffffffffffffffffffffffffffffff166000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106118fc5780548555611939565b8280016001018555821561193957600052602060002091601f016020900482015b8281111561193857825482559160010191906001019061191d565b5b50905061194691906119f6565b5090565b815481835581811115611971578183600052602060002091820191016119709190611a1b565b5b505050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106119b757805160ff19168380011785556119e5565b828001600101855582156119e5579182015b828111156119e45782518255916020019190600101906119c9565b5b5090506119f291906119f6565b5090565b611a1891905b80821115611a145760008160009055506001016119fc565b5090565b90565b611a4491905b80821115611a405760008181611a379190611a47565b50600101611a21565b5090565b90565b50805460018160011615610100020316600290046000825580601f10611a6d5750611a8c565b601f016020900490600052602060002090810190611a8b91906119f6565b5b505600a165627a7a72305820fb912d3c1da6f584a618ef20d20e75f71da132d040f67e2bee4c4d339c24458a0029 \ No newline at end of file diff --git a/client/contracts/bindings/oracle/gen_exchange.go b/client/contracts/bindings/oracle/gen_exchange.go index ee8fe28ae..0a4f648ae 100644 --- a/client/contracts/bindings/oracle/gen_exchange.go +++ b/client/contracts/bindings/oracle/gen_exchange.go @@ -19,7 +19,7 @@ import ( const ExchangeMgrABI = "[{\"constant\":true,\"inputs\":[],\"name\":\"initialized\",\"outputs\":[{\"name\":\"\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"blacklistExchange\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[],\"name\":\"unpause\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"isExchange\",\"outputs\":[{\"name\":\"isIndeed\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"isWhitelistedExchange\",\"outputs\":[{\"name\":\"isIndeed\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"paused\",\"outputs\":[{\"name\":\"\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"isBlacklistedExchange\",\"outputs\":[{\"name\":\"isIndeed\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"getWhitelistedExchangeCount\",\"outputs\":[{\"name\":\"count\",\"type\":\"uint256\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[],\"name\":\"renounceOwnership\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"\",\"type\":\"uint256\"}],\"name\":\"whitelist\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[],\"name\":\"pause\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"owner\",\"outputs\":[{\"name\":\"\",\"type\":\"address\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"whitelistExchange\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"addExchange\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"removeExchange\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"_newOwner\",\"type\":\"address\"}],\"name\":\"transferOwnership\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"index\",\"type\":\"uint256\"}],\"name\":\"getWhitelistedExchangeAtIndex\",\"outputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"exchange\",\"type\":\"string\"}],\"name\":\"Whitelisted\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"exchange\",\"type\":\"string\"}],\"name\":\"Blacklisted\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"exchange\",\"type\":\"string\"}],\"name\":\"Addition\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"exchange\",\"type\":\"string\"}],\"name\":\"Removal\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[],\"name\":\"Pause\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[],\"name\":\"Unpause\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"previousOwner\",\"type\":\"address\"}],\"name\":\"OwnershipRenounced\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"previousOwner\",\"type\":\"address\"},{\"indexed\":true,\"name\":\"newOwner\",\"type\":\"address\"}],\"name\":\"OwnershipTransferred\",\"type\":\"event\"}]" // ExchangeMgrBin is the compiled bytecode used for deploying new contracts. -const ExchangeMgrBin = `608060405260008060146101000a81548160ff021916908315150217905550336000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550611abb8061006d6000396000f3006080604052600436106100f1576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063158ef93e146100f65780633b56711b146101255780633f4ba83a1461018e5780634bbc5a61146101a5578063569bca69146102265780635c975abb146102a757806364dfaff8146102d65780636fcceefe14610357578063715018a6146103825780637ebd1b30146103995780638456cb591461043f5780638da5cb5b1461045657806393a25542146104ad578063a7e71ee314610516578063ad6a23b21461057f578063f2fde38b146105e8578063fc44d0b41461062b575b600080fd5b34801561010257600080fd5b5061010b6106d1565b604051808215151515815260200191505060405180910390f35b34801561013157600080fd5b5061018c600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506106e4565b005b34801561019a57600080fd5b506101a3610a23565b005b3480156101b157600080fd5b5061020c600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610ae1565b604051808215151515815260200191505060405180910390f35b34801561023257600080fd5b5061028d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610b66565b604051808215151515815260200191505060405180910390f35b3480156102b357600080fd5b506102bc610bfc565b604051808215151515815260200191505060405180910390f35b3480156102e257600080fd5b5061033d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610c0f565b604051808215151515815260200191505060405180910390f35b34801561036357600080fd5b5061036c610ca6565b6040518082815260200191505060405180910390f35b34801561038e57600080fd5b50610397610cb3565b005b3480156103a557600080fd5b506103c460048036038101908080359060200190929190505050610db5565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156104045780820151818401526020810190506103e9565b50505050905090810190601f1680156104315780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561044b57600080fd5b50610454610e70565b005b34801561046257600080fd5b5061046b610f30565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b3480156104b957600080fd5b50610514600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610f55565b005b34801561052257600080fd5b5061057d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611249565b005b34801561058b57600080fd5b506105e6600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611474565b005b3480156105f457600080fd5b50610629600480360381019080803573ffffffffffffffffffffffffffffffffffffffff1690602001909291905050506116a7565b005b34801561063757600080fd5b506106566004803603810190808035906020019092919050505061170e565b6040518080602001828103825283818151815260200191508051906020019080838360005b8381101561069657808201518184015260208101905061067b565b50505050905090810190601f1680156106c35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b600060159054906101000a900460ff1681565b60008060008060149054906101000a900460ff1615151561070457600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561075f57600080fd5b8361076981610b66565b1515610803576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f7420612077686974656c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b6001856040518082805190602001908083835b60208310151561083b5780518252602082019150602081019050602083039250610816565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902093508360000154925060008460010160016101000a81548160ff02191690831515021790555060026001600280549050038154811015156108ab57fe5b906000526020600020019150816002848154811015156108c757fe5b9060005260206000200190805460018160011615610100020316600290046108f09291906118c3565b508260018360405180828054600181600116156101000203166002900480156109505780601f1061092e576101008083540402835291820191610950565b820191906000526020600020905b81548152906001019060200180831161093c575b5050915050908152602001604051809103902060000181905550600280548091906001900361097f919061194a565b507f81e32445db1ab3f971a6e0ae415ce6f58f8ad4ac1e87f6eaf42067e404f81dae856040518080602001828103825283818151815260200191508051906020019080838360005b838110156109e25780820151818401526020810190506109c7565b50505050905090810190601f168015610a0f5780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050505050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610a7e57600080fd5b600060149054906101000a900460ff161515610a9957600080fd5b60008060146101000a81548160ff0219169083151502179055507f7805862f689e2f13df9f062ff482ad3ad112aca9e0847911ed832e158c525b3360405160405180910390a1565b60006001826040518082805190602001908083835b602083101515610b1b5780518252602082019150602081019050602083039250610af6565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160009054906101000a900460ff169050919050565b6000610b7182610ae1565b8015610bf557506001826040518082805190602001908083835b602083101515610bb05780518252602082019150602081019050602083039250610b8b565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff165b9050919050565b600060149054906101000a900460ff1681565b6000610c1a82610ae1565b8015610c9f57506001826040518082805190602001908083835b602083101515610c595780518252602082019150602081019050602083039250610c34565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff16155b9050919050565b6000600280549050905090565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610d0e57600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167ff8df31144d9c2f0f6b59d69b8b98abd5459d07f2742c4df920b25aae33c6482060405160405180910390a260008060006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550565b600281815481101515610dc457fe5b906000526020600020016000915090508054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610e685780601f10610e3d57610100808354040283529160200191610e68565b820191906000526020600020905b815481529060010190602001808311610e4b57829003601f168201915b505050505081565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610ecb57600080fd5b600060149054906101000a900460ff16151515610ee757600080fd5b6001600060146101000a81548160ff0219169083151502179055507f6985a02210a168e66602d3235cb6db0e70f92b3ba4d376a33c0f3d9434bff62560405160405180910390a1565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b600060149054906101000a900460ff16151515610f7157600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610fcc57600080fd5b80610fd681610c0f565b1515611070576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f74206120626c61636b6c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b600160028390806001815401808255809150509060018203906000526020600020016000909192909190915090805190602001906110af929190611976565b50036001836040518082805190602001908083835b6020831015156110e957805182526020820191506020810190506020830392506110c4565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060000181905550600180836040518082805190602001908083835b60208310151561115c5780518252602082019150602081019050602083039250611137565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160016101000a81548160ff0219169083151502179055507fce09318849d53fa41700de1700ae3708b944cb20a5a4a4fd51a331625ce72a7a826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561120b5780820151818401526020810190506111f0565b50505050905090810190601f1680156112385780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b60008060149054906101000a900460ff1615151561126657600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156112c157600080fd5b816112cb81610ae1565b151515611340576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260178152602001807f65786368616e676520616c72656164792065786973747300000000000000000081525060200191505060405180910390fd5b6001836040518082805190602001908083835b6020831015156113785780518252602082019150602081019050602083039250611353565b6001836020036101000a0380198251168184511680821785525050505050509050019150509081526020016040518091039020915060018260010160006101000a81548160ff0219169083151502179055507f9874713fe684a190f03252911ed81f4e7754af845b47e2734570c0a8d78417a8836040518080602001828103825283818151815260200191508051906020019080838360005b8381101561142c578082015181840152602081019050611411565b50505050905090810190601f1680156114595780820380516001836020036101000a031916815260200191505b509250505060405180910390a161146f83610f55565b505050565b600060149054906101000a900460ff1615151561149057600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156114eb57600080fd5b806114f581610ae1565b1515611569576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252601d8152602001807f676976656e206e616d65206973206e6f7420616e2065786368616e676500000081525060200191505060405180910390fd5b6001826040518082805190602001908083835b6020831015156115a1578051825260208201915060208101905060208303925061157c565b6001836020036101000a03801982511681845116808217855250505050505090500191505090815260200160405180910390206000808201600090556001820160006101000a81549060ff02191690556001820160016101000a81549060ff021916905550507f9751cac4d5046f38f52784e809c6e39f08eb2846a96993b1ea7528937f380e1b826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561166957808201518184015260208101905061164e565b50505050905090810190601f1680156116965780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561170257600080fd5b61170b816117c9565b50565b606060028281548110151561171f57fe5b906000526020600020018054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156117bd5780601f10611792576101008083540402835291602001916117bd565b820191906000526020600020905b8154815290600101906020018083116117a057829003601f168201915b50505050509050919050565b600073ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff161415151561180557600080fd5b8073ffffffffffffffffffffffffffffffffffffffff166000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106118fc5780548555611939565b8280016001018555821561193957600052602060002091601f016020900482015b8281111561193857825482559160010191906001019061191d565b5b50905061194691906119f6565b5090565b815481835581811115611971578183600052602060002091820191016119709190611a1b565b5b505050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106119b757805160ff19168380011785556119e5565b828001600101855582156119e5579182015b828111156119e45782518255916020019190600101906119c9565b5b5090506119f291906119f6565b5090565b611a1891905b80821115611a145760008160009055506001016119fc565b5090565b90565b611a4491905b80821115611a405760008181611a379190611a47565b50600101611a21565b5090565b90565b50805460018160011615610100020316600290046000825580601f10611a6d5750611a8c565b601f016020900490600052602060002090810190611a8b91906119f6565b5b505600a165627a7a723058207c4afb3d3bcd282a6faa2c0c845fb95f78ff6eb95024e6f767d674b5638f16630029` +const ExchangeMgrBin = `608060405260008060146101000a81548160ff021916908315150217905550336000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550611abb8061006d6000396000f3006080604052600436106100f1576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063158ef93e146100f65780633b56711b146101255780633f4ba83a1461018e5780634bbc5a61146101a5578063569bca69146102265780635c975abb146102a757806364dfaff8146102d65780636fcceefe14610357578063715018a6146103825780637ebd1b30146103995780638456cb591461043f5780638da5cb5b1461045657806393a25542146104ad578063a7e71ee314610516578063ad6a23b21461057f578063f2fde38b146105e8578063fc44d0b41461062b575b600080fd5b34801561010257600080fd5b5061010b6106d1565b604051808215151515815260200191505060405180910390f35b34801561013157600080fd5b5061018c600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506106e4565b005b34801561019a57600080fd5b506101a3610a23565b005b3480156101b157600080fd5b5061020c600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610ae1565b604051808215151515815260200191505060405180910390f35b34801561023257600080fd5b5061028d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610b66565b604051808215151515815260200191505060405180910390f35b3480156102b357600080fd5b506102bc610bfc565b604051808215151515815260200191505060405180910390f35b3480156102e257600080fd5b5061033d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610c0f565b604051808215151515815260200191505060405180910390f35b34801561036357600080fd5b5061036c610ca6565b6040518082815260200191505060405180910390f35b34801561038e57600080fd5b50610397610cb3565b005b3480156103a557600080fd5b506103c460048036038101908080359060200190929190505050610db5565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156104045780820151818401526020810190506103e9565b50505050905090810190601f1680156104315780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561044b57600080fd5b50610454610e70565b005b34801561046257600080fd5b5061046b610f30565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b3480156104b957600080fd5b50610514600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610f55565b005b34801561052257600080fd5b5061057d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611249565b005b34801561058b57600080fd5b506105e6600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611474565b005b3480156105f457600080fd5b50610629600480360381019080803573ffffffffffffffffffffffffffffffffffffffff1690602001909291905050506116a7565b005b34801561063757600080fd5b506106566004803603810190808035906020019092919050505061170e565b6040518080602001828103825283818151815260200191508051906020019080838360005b8381101561069657808201518184015260208101905061067b565b50505050905090810190601f1680156106c35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b600060159054906101000a900460ff1681565b60008060008060149054906101000a900460ff1615151561070457600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561075f57600080fd5b8361076981610b66565b1515610803576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f7420612077686974656c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b6001856040518082805190602001908083835b60208310151561083b5780518252602082019150602081019050602083039250610816565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902093508360000154925060008460010160016101000a81548160ff02191690831515021790555060026001600280549050038154811015156108ab57fe5b906000526020600020019150816002848154811015156108c757fe5b9060005260206000200190805460018160011615610100020316600290046108f09291906118c3565b508260018360405180828054600181600116156101000203166002900480156109505780601f1061092e576101008083540402835291820191610950565b820191906000526020600020905b81548152906001019060200180831161093c575b5050915050908152602001604051809103902060000181905550600280548091906001900361097f919061194a565b507f81e32445db1ab3f971a6e0ae415ce6f58f8ad4ac1e87f6eaf42067e404f81dae856040518080602001828103825283818151815260200191508051906020019080838360005b838110156109e25780820151818401526020810190506109c7565b50505050905090810190601f168015610a0f5780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050505050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610a7e57600080fd5b600060149054906101000a900460ff161515610a9957600080fd5b60008060146101000a81548160ff0219169083151502179055507f7805862f689e2f13df9f062ff482ad3ad112aca9e0847911ed832e158c525b3360405160405180910390a1565b60006001826040518082805190602001908083835b602083101515610b1b5780518252602082019150602081019050602083039250610af6565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160009054906101000a900460ff169050919050565b6000610b7182610ae1565b8015610bf557506001826040518082805190602001908083835b602083101515610bb05780518252602082019150602081019050602083039250610b8b565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff165b9050919050565b600060149054906101000a900460ff1681565b6000610c1a82610ae1565b8015610c9f57506001826040518082805190602001908083835b602083101515610c595780518252602082019150602081019050602083039250610c34565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff16155b9050919050565b6000600280549050905090565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610d0e57600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167ff8df31144d9c2f0f6b59d69b8b98abd5459d07f2742c4df920b25aae33c6482060405160405180910390a260008060006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550565b600281815481101515610dc457fe5b906000526020600020016000915090508054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610e685780601f10610e3d57610100808354040283529160200191610e68565b820191906000526020600020905b815481529060010190602001808311610e4b57829003601f168201915b505050505081565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610ecb57600080fd5b600060149054906101000a900460ff16151515610ee757600080fd5b6001600060146101000a81548160ff0219169083151502179055507f6985a02210a168e66602d3235cb6db0e70f92b3ba4d376a33c0f3d9434bff62560405160405180910390a1565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b600060149054906101000a900460ff16151515610f7157600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610fcc57600080fd5b80610fd681610c0f565b1515611070576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f74206120626c61636b6c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b600160028390806001815401808255809150509060018203906000526020600020016000909192909190915090805190602001906110af929190611976565b50036001836040518082805190602001908083835b6020831015156110e957805182526020820191506020810190506020830392506110c4565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060000181905550600180836040518082805190602001908083835b60208310151561115c5780518252602082019150602081019050602083039250611137565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160016101000a81548160ff0219169083151502179055507fce09318849d53fa41700de1700ae3708b944cb20a5a4a4fd51a331625ce72a7a826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561120b5780820151818401526020810190506111f0565b50505050905090810190601f1680156112385780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b60008060149054906101000a900460ff1615151561126657600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156112c157600080fd5b816112cb81610ae1565b151515611340576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260178152602001807f65786368616e676520616c72656164792065786973747300000000000000000081525060200191505060405180910390fd5b6001836040518082805190602001908083835b6020831015156113785780518252602082019150602081019050602083039250611353565b6001836020036101000a0380198251168184511680821785525050505050509050019150509081526020016040518091039020915060018260010160006101000a81548160ff0219169083151502179055507f9874713fe684a190f03252911ed81f4e7754af845b47e2734570c0a8d78417a8836040518080602001828103825283818151815260200191508051906020019080838360005b8381101561142c578082015181840152602081019050611411565b50505050905090810190601f1680156114595780820380516001836020036101000a031916815260200191505b509250505060405180910390a161146f83610f55565b505050565b600060149054906101000a900460ff1615151561149057600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156114eb57600080fd5b806114f581610ae1565b1515611569576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252601d8152602001807f676976656e206e616d65206973206e6f7420616e2065786368616e676500000081525060200191505060405180910390fd5b6001826040518082805190602001908083835b6020831015156115a1578051825260208201915060208101905060208303925061157c565b6001836020036101000a03801982511681845116808217855250505050505090500191505090815260200160405180910390206000808201600090556001820160006101000a81549060ff02191690556001820160016101000a81549060ff021916905550507f9751cac4d5046f38f52784e809c6e39f08eb2846a96993b1ea7528937f380e1b826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561166957808201518184015260208101905061164e565b50505050905090810190601f1680156116965780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561170257600080fd5b61170b816117c9565b50565b606060028281548110151561171f57fe5b906000526020600020018054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156117bd5780601f10611792576101008083540402835291602001916117bd565b820191906000526020600020905b8154815290600101906020018083116117a057829003601f168201915b50505050509050919050565b600073ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff161415151561180557600080fd5b8073ffffffffffffffffffffffffffffffffffffffff166000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106118fc5780548555611939565b8280016001018555821561193957600052602060002091601f016020900482015b8281111561193857825482559160010191906001019061191d565b5b50905061194691906119f6565b5090565b815481835581811115611971578183600052602060002091820191016119709190611a1b565b5b505050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106119b757805160ff19168380011785556119e5565b828001600101855582156119e5579182015b828111156119e45782518255916020019190600101906119c9565b5b5090506119f291906119f6565b5090565b611a1891905b80821115611a145760008160009055506001016119fc565b5090565b90565b611a4491905b80821115611a405760008181611a379190611a47565b50600101611a21565b5090565b90565b50805460018160011615610100020316600290046000825580601f10611a6d5750611a8c565b601f016020900490600052602060002090810190611a8b91906119f6565b5b505600a165627a7a72305820fb912d3c1da6f584a618ef20d20e75f71da132d040f67e2bee4c4d339c24458a0029` // DeployExchangeMgr deploys a new Kowala contract, binding an instance of ExchangeMgr to it. func DeployExchangeMgr(auth *bind.TransactOpts, backend bind.ContractBackend) (common.Address, *types.Transaction, *ExchangeMgr, error) { diff --git a/client/contracts/bindings/oracle/testfiles/build/ExchangeMgr.bin b/client/contracts/bindings/oracle/testfiles/build/ExchangeMgr.bin index 4a4c08e62..cdf85ac41 100644 --- a/client/contracts/bindings/oracle/testfiles/build/ExchangeMgr.bin +++ b/client/contracts/bindings/oracle/testfiles/build/ExchangeMgr.bin @@ -1 +1 @@ -608060405260008060146101000a81548160ff021916908315150217905550336000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550611abb8061006d6000396000f3006080604052600436106100f1576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063158ef93e146100f65780633b56711b146101255780633f4ba83a1461018e5780634bbc5a61146101a5578063569bca69146102265780635c975abb146102a757806364dfaff8146102d65780636fcceefe14610357578063715018a6146103825780637ebd1b30146103995780638456cb591461043f5780638da5cb5b1461045657806393a25542146104ad578063a7e71ee314610516578063ad6a23b21461057f578063f2fde38b146105e8578063fc44d0b41461062b575b600080fd5b34801561010257600080fd5b5061010b6106d1565b604051808215151515815260200191505060405180910390f35b34801561013157600080fd5b5061018c600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506106e4565b005b34801561019a57600080fd5b506101a3610a23565b005b3480156101b157600080fd5b5061020c600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610ae1565b604051808215151515815260200191505060405180910390f35b34801561023257600080fd5b5061028d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610b66565b604051808215151515815260200191505060405180910390f35b3480156102b357600080fd5b506102bc610bfc565b604051808215151515815260200191505060405180910390f35b3480156102e257600080fd5b5061033d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610c0f565b604051808215151515815260200191505060405180910390f35b34801561036357600080fd5b5061036c610ca6565b6040518082815260200191505060405180910390f35b34801561038e57600080fd5b50610397610cb3565b005b3480156103a557600080fd5b506103c460048036038101908080359060200190929190505050610db5565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156104045780820151818401526020810190506103e9565b50505050905090810190601f1680156104315780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561044b57600080fd5b50610454610e70565b005b34801561046257600080fd5b5061046b610f30565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b3480156104b957600080fd5b50610514600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610f55565b005b34801561052257600080fd5b5061057d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611249565b005b34801561058b57600080fd5b506105e6600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611474565b005b3480156105f457600080fd5b50610629600480360381019080803573ffffffffffffffffffffffffffffffffffffffff1690602001909291905050506116a7565b005b34801561063757600080fd5b506106566004803603810190808035906020019092919050505061170e565b6040518080602001828103825283818151815260200191508051906020019080838360005b8381101561069657808201518184015260208101905061067b565b50505050905090810190601f1680156106c35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b600060159054906101000a900460ff1681565b60008060008060149054906101000a900460ff1615151561070457600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561075f57600080fd5b8361076981610b66565b1515610803576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f7420612077686974656c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b6001856040518082805190602001908083835b60208310151561083b5780518252602082019150602081019050602083039250610816565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902093508360000154925060008460010160016101000a81548160ff02191690831515021790555060026001600280549050038154811015156108ab57fe5b906000526020600020019150816002848154811015156108c757fe5b9060005260206000200190805460018160011615610100020316600290046108f09291906118c3565b508260018360405180828054600181600116156101000203166002900480156109505780601f1061092e576101008083540402835291820191610950565b820191906000526020600020905b81548152906001019060200180831161093c575b5050915050908152602001604051809103902060000181905550600280548091906001900361097f919061194a565b507f81e32445db1ab3f971a6e0ae415ce6f58f8ad4ac1e87f6eaf42067e404f81dae856040518080602001828103825283818151815260200191508051906020019080838360005b838110156109e25780820151818401526020810190506109c7565b50505050905090810190601f168015610a0f5780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050505050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610a7e57600080fd5b600060149054906101000a900460ff161515610a9957600080fd5b60008060146101000a81548160ff0219169083151502179055507f7805862f689e2f13df9f062ff482ad3ad112aca9e0847911ed832e158c525b3360405160405180910390a1565b60006001826040518082805190602001908083835b602083101515610b1b5780518252602082019150602081019050602083039250610af6565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160009054906101000a900460ff169050919050565b6000610b7182610ae1565b8015610bf557506001826040518082805190602001908083835b602083101515610bb05780518252602082019150602081019050602083039250610b8b565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff165b9050919050565b600060149054906101000a900460ff1681565b6000610c1a82610ae1565b8015610c9f57506001826040518082805190602001908083835b602083101515610c595780518252602082019150602081019050602083039250610c34565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff16155b9050919050565b6000600280549050905090565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610d0e57600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167ff8df31144d9c2f0f6b59d69b8b98abd5459d07f2742c4df920b25aae33c6482060405160405180910390a260008060006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550565b600281815481101515610dc457fe5b906000526020600020016000915090508054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610e685780601f10610e3d57610100808354040283529160200191610e68565b820191906000526020600020905b815481529060010190602001808311610e4b57829003601f168201915b505050505081565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610ecb57600080fd5b600060149054906101000a900460ff16151515610ee757600080fd5b6001600060146101000a81548160ff0219169083151502179055507f6985a02210a168e66602d3235cb6db0e70f92b3ba4d376a33c0f3d9434bff62560405160405180910390a1565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b600060149054906101000a900460ff16151515610f7157600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610fcc57600080fd5b80610fd681610c0f565b1515611070576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f74206120626c61636b6c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b600160028390806001815401808255809150509060018203906000526020600020016000909192909190915090805190602001906110af929190611976565b50036001836040518082805190602001908083835b6020831015156110e957805182526020820191506020810190506020830392506110c4565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060000181905550600180836040518082805190602001908083835b60208310151561115c5780518252602082019150602081019050602083039250611137565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160016101000a81548160ff0219169083151502179055507fce09318849d53fa41700de1700ae3708b944cb20a5a4a4fd51a331625ce72a7a826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561120b5780820151818401526020810190506111f0565b50505050905090810190601f1680156112385780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b60008060149054906101000a900460ff1615151561126657600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156112c157600080fd5b816112cb81610ae1565b151515611340576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260178152602001807f65786368616e676520616c72656164792065786973747300000000000000000081525060200191505060405180910390fd5b6001836040518082805190602001908083835b6020831015156113785780518252602082019150602081019050602083039250611353565b6001836020036101000a0380198251168184511680821785525050505050509050019150509081526020016040518091039020915060018260010160006101000a81548160ff0219169083151502179055507f9874713fe684a190f03252911ed81f4e7754af845b47e2734570c0a8d78417a8836040518080602001828103825283818151815260200191508051906020019080838360005b8381101561142c578082015181840152602081019050611411565b50505050905090810190601f1680156114595780820380516001836020036101000a031916815260200191505b509250505060405180910390a161146f83610f55565b505050565b600060149054906101000a900460ff1615151561149057600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156114eb57600080fd5b806114f581610ae1565b1515611569576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252601d8152602001807f676976656e206e616d65206973206e6f7420616e2065786368616e676500000081525060200191505060405180910390fd5b6001826040518082805190602001908083835b6020831015156115a1578051825260208201915060208101905060208303925061157c565b6001836020036101000a03801982511681845116808217855250505050505090500191505090815260200160405180910390206000808201600090556001820160006101000a81549060ff02191690556001820160016101000a81549060ff021916905550507f9751cac4d5046f38f52784e809c6e39f08eb2846a96993b1ea7528937f380e1b826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561166957808201518184015260208101905061164e565b50505050905090810190601f1680156116965780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561170257600080fd5b61170b816117c9565b50565b606060028281548110151561171f57fe5b906000526020600020018054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156117bd5780601f10611792576101008083540402835291602001916117bd565b820191906000526020600020905b8154815290600101906020018083116117a057829003601f168201915b50505050509050919050565b600073ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff161415151561180557600080fd5b8073ffffffffffffffffffffffffffffffffffffffff166000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106118fc5780548555611939565b8280016001018555821561193957600052602060002091601f016020900482015b8281111561193857825482559160010191906001019061191d565b5b50905061194691906119f6565b5090565b815481835581811115611971578183600052602060002091820191016119709190611a1b565b5b505050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106119b757805160ff19168380011785556119e5565b828001600101855582156119e5579182015b828111156119e45782518255916020019190600101906119c9565b5b5090506119f291906119f6565b5090565b611a1891905b80821115611a145760008160009055506001016119fc565b5090565b90565b611a4491905b80821115611a405760008181611a379190611a47565b50600101611a21565b5090565b90565b50805460018160011615610100020316600290046000825580601f10611a6d5750611a8c565b601f016020900490600052602060002090810190611a8b91906119f6565b5b505600a165627a7a7230582087d48bce60e613708d842ce9209eac3f78b5b0436755eb466417a51291c37d100029 \ No newline at end of file +608060405260008060146101000a81548160ff021916908315150217905550336000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550611abb8061006d6000396000f3006080604052600436106100f1576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063158ef93e146100f65780633b56711b146101255780633f4ba83a1461018e5780634bbc5a61146101a5578063569bca69146102265780635c975abb146102a757806364dfaff8146102d65780636fcceefe14610357578063715018a6146103825780637ebd1b30146103995780638456cb591461043f5780638da5cb5b1461045657806393a25542146104ad578063a7e71ee314610516578063ad6a23b21461057f578063f2fde38b146105e8578063fc44d0b41461062b575b600080fd5b34801561010257600080fd5b5061010b6106d1565b604051808215151515815260200191505060405180910390f35b34801561013157600080fd5b5061018c600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506106e4565b005b34801561019a57600080fd5b506101a3610a23565b005b3480156101b157600080fd5b5061020c600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610ae1565b604051808215151515815260200191505060405180910390f35b34801561023257600080fd5b5061028d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610b66565b604051808215151515815260200191505060405180910390f35b3480156102b357600080fd5b506102bc610bfc565b604051808215151515815260200191505060405180910390f35b3480156102e257600080fd5b5061033d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610c0f565b604051808215151515815260200191505060405180910390f35b34801561036357600080fd5b5061036c610ca6565b6040518082815260200191505060405180910390f35b34801561038e57600080fd5b50610397610cb3565b005b3480156103a557600080fd5b506103c460048036038101908080359060200190929190505050610db5565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156104045780820151818401526020810190506103e9565b50505050905090810190601f1680156104315780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561044b57600080fd5b50610454610e70565b005b34801561046257600080fd5b5061046b610f30565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b3480156104b957600080fd5b50610514600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610f55565b005b34801561052257600080fd5b5061057d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611249565b005b34801561058b57600080fd5b506105e6600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611474565b005b3480156105f457600080fd5b50610629600480360381019080803573ffffffffffffffffffffffffffffffffffffffff1690602001909291905050506116a7565b005b34801561063757600080fd5b506106566004803603810190808035906020019092919050505061170e565b6040518080602001828103825283818151815260200191508051906020019080838360005b8381101561069657808201518184015260208101905061067b565b50505050905090810190601f1680156106c35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b600060159054906101000a900460ff1681565b60008060008060149054906101000a900460ff1615151561070457600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561075f57600080fd5b8361076981610b66565b1515610803576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f7420612077686974656c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b6001856040518082805190602001908083835b60208310151561083b5780518252602082019150602081019050602083039250610816565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902093508360000154925060008460010160016101000a81548160ff02191690831515021790555060026001600280549050038154811015156108ab57fe5b906000526020600020019150816002848154811015156108c757fe5b9060005260206000200190805460018160011615610100020316600290046108f09291906118c3565b508260018360405180828054600181600116156101000203166002900480156109505780601f1061092e576101008083540402835291820191610950565b820191906000526020600020905b81548152906001019060200180831161093c575b5050915050908152602001604051809103902060000181905550600280548091906001900361097f919061194a565b507f81e32445db1ab3f971a6e0ae415ce6f58f8ad4ac1e87f6eaf42067e404f81dae856040518080602001828103825283818151815260200191508051906020019080838360005b838110156109e25780820151818401526020810190506109c7565b50505050905090810190601f168015610a0f5780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050505050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610a7e57600080fd5b600060149054906101000a900460ff161515610a9957600080fd5b60008060146101000a81548160ff0219169083151502179055507f7805862f689e2f13df9f062ff482ad3ad112aca9e0847911ed832e158c525b3360405160405180910390a1565b60006001826040518082805190602001908083835b602083101515610b1b5780518252602082019150602081019050602083039250610af6565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160009054906101000a900460ff169050919050565b6000610b7182610ae1565b8015610bf557506001826040518082805190602001908083835b602083101515610bb05780518252602082019150602081019050602083039250610b8b565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff165b9050919050565b600060149054906101000a900460ff1681565b6000610c1a82610ae1565b8015610c9f57506001826040518082805190602001908083835b602083101515610c595780518252602082019150602081019050602083039250610c34565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff16155b9050919050565b6000600280549050905090565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610d0e57600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167ff8df31144d9c2f0f6b59d69b8b98abd5459d07f2742c4df920b25aae33c6482060405160405180910390a260008060006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550565b600281815481101515610dc457fe5b906000526020600020016000915090508054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610e685780601f10610e3d57610100808354040283529160200191610e68565b820191906000526020600020905b815481529060010190602001808311610e4b57829003601f168201915b505050505081565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610ecb57600080fd5b600060149054906101000a900460ff16151515610ee757600080fd5b6001600060146101000a81548160ff0219169083151502179055507f6985a02210a168e66602d3235cb6db0e70f92b3ba4d376a33c0f3d9434bff62560405160405180910390a1565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b600060149054906101000a900460ff16151515610f7157600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610fcc57600080fd5b80610fd681610c0f565b1515611070576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f74206120626c61636b6c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b600160028390806001815401808255809150509060018203906000526020600020016000909192909190915090805190602001906110af929190611976565b50036001836040518082805190602001908083835b6020831015156110e957805182526020820191506020810190506020830392506110c4565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060000181905550600180836040518082805190602001908083835b60208310151561115c5780518252602082019150602081019050602083039250611137565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160016101000a81548160ff0219169083151502179055507fce09318849d53fa41700de1700ae3708b944cb20a5a4a4fd51a331625ce72a7a826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561120b5780820151818401526020810190506111f0565b50505050905090810190601f1680156112385780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b60008060149054906101000a900460ff1615151561126657600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156112c157600080fd5b816112cb81610ae1565b151515611340576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260178152602001807f65786368616e676520616c72656164792065786973747300000000000000000081525060200191505060405180910390fd5b6001836040518082805190602001908083835b6020831015156113785780518252602082019150602081019050602083039250611353565b6001836020036101000a0380198251168184511680821785525050505050509050019150509081526020016040518091039020915060018260010160006101000a81548160ff0219169083151502179055507f9874713fe684a190f03252911ed81f4e7754af845b47e2734570c0a8d78417a8836040518080602001828103825283818151815260200191508051906020019080838360005b8381101561142c578082015181840152602081019050611411565b50505050905090810190601f1680156114595780820380516001836020036101000a031916815260200191505b509250505060405180910390a161146f83610f55565b505050565b600060149054906101000a900460ff1615151561149057600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156114eb57600080fd5b806114f581610ae1565b1515611569576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252601d8152602001807f676976656e206e616d65206973206e6f7420616e2065786368616e676500000081525060200191505060405180910390fd5b6001826040518082805190602001908083835b6020831015156115a1578051825260208201915060208101905060208303925061157c565b6001836020036101000a03801982511681845116808217855250505050505090500191505090815260200160405180910390206000808201600090556001820160006101000a81549060ff02191690556001820160016101000a81549060ff021916905550507f9751cac4d5046f38f52784e809c6e39f08eb2846a96993b1ea7528937f380e1b826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561166957808201518184015260208101905061164e565b50505050905090810190601f1680156116965780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561170257600080fd5b61170b816117c9565b50565b606060028281548110151561171f57fe5b906000526020600020018054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156117bd5780601f10611792576101008083540402835291602001916117bd565b820191906000526020600020905b8154815290600101906020018083116117a057829003601f168201915b50505050509050919050565b600073ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff161415151561180557600080fd5b8073ffffffffffffffffffffffffffffffffffffffff166000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106118fc5780548555611939565b8280016001018555821561193957600052602060002091601f016020900482015b8281111561193857825482559160010191906001019061191d565b5b50905061194691906119f6565b5090565b815481835581811115611971578183600052602060002091820191016119709190611a1b565b5b505050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106119b757805160ff19168380011785556119e5565b828001600101855582156119e5579182015b828111156119e45782518255916020019190600101906119c9565b5b5090506119f291906119f6565b5090565b611a1891905b80821115611a145760008160009055506001016119fc565b5090565b90565b611a4491905b80821115611a405760008181611a379190611a47565b50600101611a21565b5090565b90565b50805460018160011615610100020316600290046000825580601f10611a6d5750611a8c565b601f016020900490600052602060002090810190611a8b91906119f6565b5b505600a165627a7a72305820b1cc106e4947dadfaa3705c2652bfc4d1ebcca102c3ef08aaab2ece02ce2f9340029 \ No newline at end of file diff --git a/client/contracts/bindings/oracle/testfiles/gen_exchange.go b/client/contracts/bindings/oracle/testfiles/gen_exchange.go index 5913e6eb5..fedb17623 100644 --- a/client/contracts/bindings/oracle/testfiles/gen_exchange.go +++ b/client/contracts/bindings/oracle/testfiles/gen_exchange.go @@ -19,7 +19,7 @@ import ( const ExchangeMgrABI = "[{\"constant\":true,\"inputs\":[],\"name\":\"initialized\",\"outputs\":[{\"name\":\"\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"blacklistExchange\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[],\"name\":\"unpause\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"isExchange\",\"outputs\":[{\"name\":\"isIndeed\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"isWhitelistedExchange\",\"outputs\":[{\"name\":\"isIndeed\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"paused\",\"outputs\":[{\"name\":\"\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"isBlacklistedExchange\",\"outputs\":[{\"name\":\"isIndeed\",\"type\":\"bool\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"getWhitelistedExchangeCount\",\"outputs\":[{\"name\":\"count\",\"type\":\"uint256\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[],\"name\":\"renounceOwnership\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"\",\"type\":\"uint256\"}],\"name\":\"whitelist\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[],\"name\":\"pause\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"owner\",\"outputs\":[{\"name\":\"\",\"type\":\"address\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"whitelistExchange\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"addExchange\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"name\":\"removeExchange\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"_newOwner\",\"type\":\"address\"}],\"name\":\"transferOwnership\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[{\"name\":\"index\",\"type\":\"uint256\"}],\"name\":\"getWhitelistedExchangeAtIndex\",\"outputs\":[{\"name\":\"name\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"exchange\",\"type\":\"string\"}],\"name\":\"Whitelisted\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"exchange\",\"type\":\"string\"}],\"name\":\"Blacklisted\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"exchange\",\"type\":\"string\"}],\"name\":\"Addition\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"exchange\",\"type\":\"string\"}],\"name\":\"Removal\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[],\"name\":\"Pause\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[],\"name\":\"Unpause\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"previousOwner\",\"type\":\"address\"}],\"name\":\"OwnershipRenounced\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"previousOwner\",\"type\":\"address\"},{\"indexed\":true,\"name\":\"newOwner\",\"type\":\"address\"}],\"name\":\"OwnershipTransferred\",\"type\":\"event\"}]" // ExchangeMgrBin is the compiled bytecode used for deploying new contracts. -const ExchangeMgrBin = `608060405260008060146101000a81548160ff021916908315150217905550336000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550611abb8061006d6000396000f3006080604052600436106100f1576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063158ef93e146100f65780633b56711b146101255780633f4ba83a1461018e5780634bbc5a61146101a5578063569bca69146102265780635c975abb146102a757806364dfaff8146102d65780636fcceefe14610357578063715018a6146103825780637ebd1b30146103995780638456cb591461043f5780638da5cb5b1461045657806393a25542146104ad578063a7e71ee314610516578063ad6a23b21461057f578063f2fde38b146105e8578063fc44d0b41461062b575b600080fd5b34801561010257600080fd5b5061010b6106d1565b604051808215151515815260200191505060405180910390f35b34801561013157600080fd5b5061018c600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506106e4565b005b34801561019a57600080fd5b506101a3610a23565b005b3480156101b157600080fd5b5061020c600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610ae1565b604051808215151515815260200191505060405180910390f35b34801561023257600080fd5b5061028d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610b66565b604051808215151515815260200191505060405180910390f35b3480156102b357600080fd5b506102bc610bfc565b604051808215151515815260200191505060405180910390f35b3480156102e257600080fd5b5061033d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610c0f565b604051808215151515815260200191505060405180910390f35b34801561036357600080fd5b5061036c610ca6565b6040518082815260200191505060405180910390f35b34801561038e57600080fd5b50610397610cb3565b005b3480156103a557600080fd5b506103c460048036038101908080359060200190929190505050610db5565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156104045780820151818401526020810190506103e9565b50505050905090810190601f1680156104315780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561044b57600080fd5b50610454610e70565b005b34801561046257600080fd5b5061046b610f30565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b3480156104b957600080fd5b50610514600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610f55565b005b34801561052257600080fd5b5061057d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611249565b005b34801561058b57600080fd5b506105e6600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611474565b005b3480156105f457600080fd5b50610629600480360381019080803573ffffffffffffffffffffffffffffffffffffffff1690602001909291905050506116a7565b005b34801561063757600080fd5b506106566004803603810190808035906020019092919050505061170e565b6040518080602001828103825283818151815260200191508051906020019080838360005b8381101561069657808201518184015260208101905061067b565b50505050905090810190601f1680156106c35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b600060159054906101000a900460ff1681565b60008060008060149054906101000a900460ff1615151561070457600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561075f57600080fd5b8361076981610b66565b1515610803576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f7420612077686974656c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b6001856040518082805190602001908083835b60208310151561083b5780518252602082019150602081019050602083039250610816565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902093508360000154925060008460010160016101000a81548160ff02191690831515021790555060026001600280549050038154811015156108ab57fe5b906000526020600020019150816002848154811015156108c757fe5b9060005260206000200190805460018160011615610100020316600290046108f09291906118c3565b508260018360405180828054600181600116156101000203166002900480156109505780601f1061092e576101008083540402835291820191610950565b820191906000526020600020905b81548152906001019060200180831161093c575b5050915050908152602001604051809103902060000181905550600280548091906001900361097f919061194a565b507f81e32445db1ab3f971a6e0ae415ce6f58f8ad4ac1e87f6eaf42067e404f81dae856040518080602001828103825283818151815260200191508051906020019080838360005b838110156109e25780820151818401526020810190506109c7565b50505050905090810190601f168015610a0f5780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050505050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610a7e57600080fd5b600060149054906101000a900460ff161515610a9957600080fd5b60008060146101000a81548160ff0219169083151502179055507f7805862f689e2f13df9f062ff482ad3ad112aca9e0847911ed832e158c525b3360405160405180910390a1565b60006001826040518082805190602001908083835b602083101515610b1b5780518252602082019150602081019050602083039250610af6565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160009054906101000a900460ff169050919050565b6000610b7182610ae1565b8015610bf557506001826040518082805190602001908083835b602083101515610bb05780518252602082019150602081019050602083039250610b8b565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff165b9050919050565b600060149054906101000a900460ff1681565b6000610c1a82610ae1565b8015610c9f57506001826040518082805190602001908083835b602083101515610c595780518252602082019150602081019050602083039250610c34565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff16155b9050919050565b6000600280549050905090565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610d0e57600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167ff8df31144d9c2f0f6b59d69b8b98abd5459d07f2742c4df920b25aae33c6482060405160405180910390a260008060006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550565b600281815481101515610dc457fe5b906000526020600020016000915090508054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610e685780601f10610e3d57610100808354040283529160200191610e68565b820191906000526020600020905b815481529060010190602001808311610e4b57829003601f168201915b505050505081565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610ecb57600080fd5b600060149054906101000a900460ff16151515610ee757600080fd5b6001600060146101000a81548160ff0219169083151502179055507f6985a02210a168e66602d3235cb6db0e70f92b3ba4d376a33c0f3d9434bff62560405160405180910390a1565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b600060149054906101000a900460ff16151515610f7157600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610fcc57600080fd5b80610fd681610c0f565b1515611070576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f74206120626c61636b6c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b600160028390806001815401808255809150509060018203906000526020600020016000909192909190915090805190602001906110af929190611976565b50036001836040518082805190602001908083835b6020831015156110e957805182526020820191506020810190506020830392506110c4565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060000181905550600180836040518082805190602001908083835b60208310151561115c5780518252602082019150602081019050602083039250611137565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160016101000a81548160ff0219169083151502179055507fce09318849d53fa41700de1700ae3708b944cb20a5a4a4fd51a331625ce72a7a826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561120b5780820151818401526020810190506111f0565b50505050905090810190601f1680156112385780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b60008060149054906101000a900460ff1615151561126657600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156112c157600080fd5b816112cb81610ae1565b151515611340576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260178152602001807f65786368616e676520616c72656164792065786973747300000000000000000081525060200191505060405180910390fd5b6001836040518082805190602001908083835b6020831015156113785780518252602082019150602081019050602083039250611353565b6001836020036101000a0380198251168184511680821785525050505050509050019150509081526020016040518091039020915060018260010160006101000a81548160ff0219169083151502179055507f9874713fe684a190f03252911ed81f4e7754af845b47e2734570c0a8d78417a8836040518080602001828103825283818151815260200191508051906020019080838360005b8381101561142c578082015181840152602081019050611411565b50505050905090810190601f1680156114595780820380516001836020036101000a031916815260200191505b509250505060405180910390a161146f83610f55565b505050565b600060149054906101000a900460ff1615151561149057600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156114eb57600080fd5b806114f581610ae1565b1515611569576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252601d8152602001807f676976656e206e616d65206973206e6f7420616e2065786368616e676500000081525060200191505060405180910390fd5b6001826040518082805190602001908083835b6020831015156115a1578051825260208201915060208101905060208303925061157c565b6001836020036101000a03801982511681845116808217855250505050505090500191505090815260200160405180910390206000808201600090556001820160006101000a81549060ff02191690556001820160016101000a81549060ff021916905550507f9751cac4d5046f38f52784e809c6e39f08eb2846a96993b1ea7528937f380e1b826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561166957808201518184015260208101905061164e565b50505050905090810190601f1680156116965780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561170257600080fd5b61170b816117c9565b50565b606060028281548110151561171f57fe5b906000526020600020018054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156117bd5780601f10611792576101008083540402835291602001916117bd565b820191906000526020600020905b8154815290600101906020018083116117a057829003601f168201915b50505050509050919050565b600073ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff161415151561180557600080fd5b8073ffffffffffffffffffffffffffffffffffffffff166000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106118fc5780548555611939565b8280016001018555821561193957600052602060002091601f016020900482015b8281111561193857825482559160010191906001019061191d565b5b50905061194691906119f6565b5090565b815481835581811115611971578183600052602060002091820191016119709190611a1b565b5b505050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106119b757805160ff19168380011785556119e5565b828001600101855582156119e5579182015b828111156119e45782518255916020019190600101906119c9565b5b5090506119f291906119f6565b5090565b611a1891905b80821115611a145760008160009055506001016119fc565b5090565b90565b611a4491905b80821115611a405760008181611a379190611a47565b50600101611a21565b5090565b90565b50805460018160011615610100020316600290046000825580601f10611a6d5750611a8c565b601f016020900490600052602060002090810190611a8b91906119f6565b5b505600a165627a7a7230582087d48bce60e613708d842ce9209eac3f78b5b0436755eb466417a51291c37d100029` +const ExchangeMgrBin = `608060405260008060146101000a81548160ff021916908315150217905550336000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550611abb8061006d6000396000f3006080604052600436106100f1576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063158ef93e146100f65780633b56711b146101255780633f4ba83a1461018e5780634bbc5a61146101a5578063569bca69146102265780635c975abb146102a757806364dfaff8146102d65780636fcceefe14610357578063715018a6146103825780637ebd1b30146103995780638456cb591461043f5780638da5cb5b1461045657806393a25542146104ad578063a7e71ee314610516578063ad6a23b21461057f578063f2fde38b146105e8578063fc44d0b41461062b575b600080fd5b34801561010257600080fd5b5061010b6106d1565b604051808215151515815260200191505060405180910390f35b34801561013157600080fd5b5061018c600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506106e4565b005b34801561019a57600080fd5b506101a3610a23565b005b3480156101b157600080fd5b5061020c600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610ae1565b604051808215151515815260200191505060405180910390f35b34801561023257600080fd5b5061028d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610b66565b604051808215151515815260200191505060405180910390f35b3480156102b357600080fd5b506102bc610bfc565b604051808215151515815260200191505060405180910390f35b3480156102e257600080fd5b5061033d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610c0f565b604051808215151515815260200191505060405180910390f35b34801561036357600080fd5b5061036c610ca6565b6040518082815260200191505060405180910390f35b34801561038e57600080fd5b50610397610cb3565b005b3480156103a557600080fd5b506103c460048036038101908080359060200190929190505050610db5565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156104045780820151818401526020810190506103e9565b50505050905090810190601f1680156104315780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561044b57600080fd5b50610454610e70565b005b34801561046257600080fd5b5061046b610f30565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b3480156104b957600080fd5b50610514600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050610f55565b005b34801561052257600080fd5b5061057d600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611249565b005b34801561058b57600080fd5b506105e6600480360381019080803590602001908201803590602001908080601f0160208091040260200160405190810160405280939291908181526020018383808284378201915050505050509192919290505050611474565b005b3480156105f457600080fd5b50610629600480360381019080803573ffffffffffffffffffffffffffffffffffffffff1690602001909291905050506116a7565b005b34801561063757600080fd5b506106566004803603810190808035906020019092919050505061170e565b6040518080602001828103825283818151815260200191508051906020019080838360005b8381101561069657808201518184015260208101905061067b565b50505050905090810190601f1680156106c35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b600060159054906101000a900460ff1681565b60008060008060149054906101000a900460ff1615151561070457600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561075f57600080fd5b8361076981610b66565b1515610803576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f7420612077686974656c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b6001856040518082805190602001908083835b60208310151561083b5780518252602082019150602081019050602083039250610816565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902093508360000154925060008460010160016101000a81548160ff02191690831515021790555060026001600280549050038154811015156108ab57fe5b906000526020600020019150816002848154811015156108c757fe5b9060005260206000200190805460018160011615610100020316600290046108f09291906118c3565b508260018360405180828054600181600116156101000203166002900480156109505780601f1061092e576101008083540402835291820191610950565b820191906000526020600020905b81548152906001019060200180831161093c575b5050915050908152602001604051809103902060000181905550600280548091906001900361097f919061194a565b507f81e32445db1ab3f971a6e0ae415ce6f58f8ad4ac1e87f6eaf42067e404f81dae856040518080602001828103825283818151815260200191508051906020019080838360005b838110156109e25780820151818401526020810190506109c7565b50505050905090810190601f168015610a0f5780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050505050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610a7e57600080fd5b600060149054906101000a900460ff161515610a9957600080fd5b60008060146101000a81548160ff0219169083151502179055507f7805862f689e2f13df9f062ff482ad3ad112aca9e0847911ed832e158c525b3360405160405180910390a1565b60006001826040518082805190602001908083835b602083101515610b1b5780518252602082019150602081019050602083039250610af6565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160009054906101000a900460ff169050919050565b6000610b7182610ae1565b8015610bf557506001826040518082805190602001908083835b602083101515610bb05780518252602082019150602081019050602083039250610b8b565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff165b9050919050565b600060149054906101000a900460ff1681565b6000610c1a82610ae1565b8015610c9f57506001826040518082805190602001908083835b602083101515610c595780518252602082019150602081019050602083039250610c34565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160019054906101000a900460ff16155b9050919050565b6000600280549050905090565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610d0e57600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167ff8df31144d9c2f0f6b59d69b8b98abd5459d07f2742c4df920b25aae33c6482060405160405180910390a260008060006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550565b600281815481101515610dc457fe5b906000526020600020016000915090508054600181600116156101000203166002900480601f016020809104026020016040519081016040528092919081815260200182805460018160011615610100020316600290048015610e685780601f10610e3d57610100808354040283529160200191610e68565b820191906000526020600020905b815481529060010190602001808311610e4b57829003601f168201915b505050505081565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610ecb57600080fd5b600060149054906101000a900460ff16151515610ee757600080fd5b6001600060146101000a81548160ff0219169083151502179055507f6985a02210a168e66602d3235cb6db0e70f92b3ba4d376a33c0f3d9434bff62560405160405180910390a1565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b600060149054906101000a900460ff16151515610f7157600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff16141515610fcc57600080fd5b80610fd681610c0f565b1515611070576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260288152602001807f676976656e206e616d65206973206e6f74206120626c61636b6c69737465642081526020017f65786368616e676500000000000000000000000000000000000000000000000081525060400191505060405180910390fd5b600160028390806001815401808255809150509060018203906000526020600020016000909192909190915090805190602001906110af929190611976565b50036001836040518082805190602001908083835b6020831015156110e957805182526020820191506020810190506020830392506110c4565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060000181905550600180836040518082805190602001908083835b60208310151561115c5780518252602082019150602081019050602083039250611137565b6001836020036101000a038019825116818451168082178552505050505050905001915050908152602001604051809103902060010160016101000a81548160ff0219169083151502179055507fce09318849d53fa41700de1700ae3708b944cb20a5a4a4fd51a331625ce72a7a826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561120b5780820151818401526020810190506111f0565b50505050905090810190601f1680156112385780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b60008060149054906101000a900460ff1615151561126657600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156112c157600080fd5b816112cb81610ae1565b151515611340576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004018080602001828103825260178152602001807f65786368616e676520616c72656164792065786973747300000000000000000081525060200191505060405180910390fd5b6001836040518082805190602001908083835b6020831015156113785780518252602082019150602081019050602083039250611353565b6001836020036101000a0380198251168184511680821785525050505050509050019150509081526020016040518091039020915060018260010160006101000a81548160ff0219169083151502179055507f9874713fe684a190f03252911ed81f4e7754af845b47e2734570c0a8d78417a8836040518080602001828103825283818151815260200191508051906020019080838360005b8381101561142c578082015181840152602081019050611411565b50505050905090810190601f1680156114595780820380516001836020036101000a031916815260200191505b509250505060405180910390a161146f83610f55565b505050565b600060149054906101000a900460ff1615151561149057600080fd5b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff161415156114eb57600080fd5b806114f581610ae1565b1515611569576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252601d8152602001807f676976656e206e616d65206973206e6f7420616e2065786368616e676500000081525060200191505060405180910390fd5b6001826040518082805190602001908083835b6020831015156115a1578051825260208201915060208101905060208303925061157c565b6001836020036101000a03801982511681845116808217855250505050505090500191505090815260200160405180910390206000808201600090556001820160006101000a81549060ff02191690556001820160016101000a81549060ff021916905550507f9751cac4d5046f38f52784e809c6e39f08eb2846a96993b1ea7528937f380e1b826040518080602001828103825283818151815260200191508051906020019080838360005b8381101561166957808201518184015260208101905061164e565b50505050905090810190601f1680156116965780820380516001836020036101000a031916815260200191505b509250505060405180910390a15050565b6000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff163373ffffffffffffffffffffffffffffffffffffffff1614151561170257600080fd5b61170b816117c9565b50565b606060028281548110151561171f57fe5b906000526020600020018054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156117bd5780601f10611792576101008083540402835291602001916117bd565b820191906000526020600020905b8154815290600101906020018083116117a057829003601f168201915b50505050509050919050565b600073ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff161415151561180557600080fd5b8073ffffffffffffffffffffffffffffffffffffffff166000809054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060405160405180910390a3806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106118fc5780548555611939565b8280016001018555821561193957600052602060002091601f016020900482015b8281111561193857825482559160010191906001019061191d565b5b50905061194691906119f6565b5090565b815481835581811115611971578183600052602060002091820191016119709190611a1b565b5b505050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106119b757805160ff19168380011785556119e5565b828001600101855582156119e5579182015b828111156119e45782518255916020019190600101906119c9565b5b5090506119f291906119f6565b5090565b611a1891905b80821115611a145760008160009055506001016119fc565b5090565b90565b611a4491905b80821115611a405760008181611a379190611a47565b50600101611a21565b5090565b90565b50805460018160011615610100020316600290046000825580601f10611a6d5750611a8c565b601f016020900490600052602060002090810190611a8b91906119f6565b5b505600a165627a7a72305820b1cc106e4947dadfaa3705c2652bfc4d1ebcca102c3ef08aaab2ece02ce2f9340029` // DeployExchangeMgr deploys a new Kowala contract, binding an instance of ExchangeMgr to it. func DeployExchangeMgr(auth *bind.TransactOpts, backend bind.ContractBackend) (common.Address, *types.Transaction, *ExchangeMgr, error) {