-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added docs for the Solidity code #799
Merged
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
2e3562d
Added docs for the Solidity code
JuliusBrain 2643d4b
WIP dockerfile
JuliusBrain 7912216
Merge branch 'dev' into feature/solidity_docs
JuliusBrain 6649077
Added solidoc dockerfile
acroca 2a55885
Updated ReadMe and regenerated the docs using the docker tool
JuliusBrain 4f27a91
Added pipeline for drone to create solidity docs
JuliusBrain 1a7b3c1
Updated mkdocs.yml, fixes
JuliusBrain ec5ae91
Better use of the docker image
acroca d4e5893
Merge branch 'dev' into feature/solidity_docs
yourheropaul f9381af
Updated solidoc docker implementation
yourheropaul 38b2306
Merge branch 'feature/solidity_docs' of github.com:kowala-tech/kcoin …
yourheropaul 06b8294
Smart contracts -> Core Contracts
JuliusBrain 4e29320
Build node modules before anything else
yourheropaul cbbf634
Regenerated docs; separated assert and build
yourheropaul 07d363f
Moved docs to proper location
yourheropaul 16a5f98
Added git debugging
yourheropaul 11febda
Moved docs to the proper directory
yourheropaul 3eb8db9
Added diff
yourheropaul 2a1ee17
Added solidoc 1.0.3
yourheropaul eae67bc
Fixed typo
yourheropaul 0c80304
Merge branch 'dev' into feature/solidity_docs
yourheropaul f1a9565
Update go_generate
yourheropaul File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we could build this image once and push it to dockerhub instead of building it every time. It could live in a separate repo too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do that