-
Notifications
You must be signed in to change notification settings - Fork 7
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
Improvements to the smart contract API README files #37
Open
pdyraga
wants to merge
1
commit into
main
Choose a base branch
from
small-things
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,11 @@ | ||
| # Random Beacon | ||
|
|
||
| To get familiarized with Random Bitcoin contracts API, go [here](random-beacon-api/generated-docs/index.md). | ||
|
|
||
| Threshold Network Random Beacon contracts source code is available in the | ||
| [`keep-network/keep-core`](https://github.com/keep-network/keep-core/tree/main/solidity/random-beacon) | ||
| GitHub repository. | ||
|
|
||
| The smart contract API documentation is generated based on the NatSpec format | ||
| documentation in the smart contract source code. | ||
|
|
||
| The Random Bitcoin contracts API docs are available [here](random-beacon-api/generated-docs/index.md). | ||
62 changes: 22 additions & 40 deletions
62
docs/app-development/random-beacon/random-beacon-api/README.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 |
|---|---|---|
| @@ -1,42 +1,24 @@ | ||
| # Random Beacon API | ||
|
|
||
| You can learn about APIs of contracts related to the Random Beacon under the | ||
| following links: | ||
|
|
||
| [AltBn128](./generated-docs/libraries/AltBn128.md) | ||
|
|
||
| [BeaconAuthorization](./generated-docs/libraries/BeaconAuthorization.md) | ||
|
|
||
| [BeaconDkg](./generated-docs/libraries/BeaconDkg.md) | ||
|
|
||
| [BeaconDkgValidator](./generated-docs/BeaconDkgValidator.md) | ||
|
|
||
| [BeaconInactivity](./generated-docs/libraries/BeaconInactivity.md) | ||
|
|
||
| [BLS](./generated-docs/libraries/BLS.md) | ||
|
|
||
| [BytesLib](./generated-docs/libraries/BytesLib.md) | ||
|
|
||
| [Callback](./generated-docs/libraries/Callback.md) | ||
|
|
||
| [Governable](./generated-docs/Governable.md) | ||
|
|
||
| [Groups](./generated-docs/libraries/Groups.md) | ||
|
|
||
| [IRandomBeacon](./generated-docs/api/IRandomBeacon.md) | ||
|
|
||
| [IRandomBeaconConsumer](./generated-docs/api/IRandomBeaconConsumer.md) | ||
|
|
||
| [ModUtils](./generated-docs/libraries/ModUtils.md) | ||
|
|
||
| [RandomBeacon](./generated-docs/RandomBeacon.md) | ||
|
|
||
| [RandomBeaconChaosnet](./generated-docs/RandomBeaconChaosnet.md) | ||
|
|
||
| [RandomBeaconGovernance](./generated-docs/RandomBeaconGovernance.md) | ||
|
|
||
| [Reimbursable](./generated-docs/Reimbursable.md) | ||
|
|
||
| [ReimbursementPool](./generated-docs/ReimbursementPool.md) | ||
|
|
||
| [Relay](./generated-docs/libraries/Relay.md) | ||
| You can learn about APIs of Random Beacon smart contracts under the following | ||
| links: | ||
|
|
||
| * [AltBn128](./generated-docs/libraries/AltBn128.md) | ||
| * [BeaconAuthorization](./generated-docs/libraries/BeaconAuthorization.md) | ||
| * [BeaconDkg](./generated-docs/libraries/BeaconDkg.md) | ||
| * [BeaconDkgValidator](./generated-docs/BeaconDkgValidator.md) | ||
| * [BeaconInactivity](./generated-docs/libraries/BeaconInactivity.md) | ||
| * [BLS](./generated-docs/libraries/BLS.md) | ||
| * [BytesLib](./generated-docs/libraries/BytesLib.md) | ||
| * [Callback](./generated-docs/libraries/Callback.md) | ||
| * [Governable](./generated-docs/Governable.md) | ||
| * [Groups](./generated-docs/libraries/Groups.md) | ||
| * [IRandomBeacon](./generated-docs/api/IRandomBeacon.md) | ||
| * [IRandomBeaconConsumer](./generated-docs/api/IRandomBeaconConsumer.md) | ||
| * [ModUtils](./generated-docs/libraries/ModUtils.md) | ||
| * [RandomBeacon](./generated-docs/RandomBeacon.md) | ||
| * [RandomBeaconChaosnet](./generated-docs/RandomBeaconChaosnet.md) | ||
| * [RandomBeaconGovernance](./generated-docs/RandomBeaconGovernance.md) | ||
| * [Reimbursable](./generated-docs/Reimbursable.md) | ||
| * [ReimbursementPool](./generated-docs/ReimbursementPool.md) | ||
| * [Relay](./generated-docs/libraries/Relay.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 |
|---|---|---|
| @@ -1,3 +1,10 @@ | ||
| # Staking Contract and DAO | ||
|
|
||
| To get familiarized with API of contracts related to staking and DAO, go [here](staking-contract-and-dao-api/generated-docs/index.md). | ||
| Threshold Network staking and DAO contracts source code is available in the | ||
| [`threshold-network/solidity-contracts`](https://github.com/threshold-network/solidity-contracts) | ||
| GitHub repository. | ||
|
|
||
| The smart contract API documentation is generated based on the NatSpec format | ||
| documentation in the smart contract source code. | ||
|
|
||
| The staking and DAO contracts API docs are available [here](staking-contract-and-dao-api/generated-docs/index.md). |
59 changes: 21 additions & 38 deletions
59
...app-development/staking-contract-and-dao/staking-contract-and-dao-api/README.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 |
|---|---|---|
| @@ -1,40 +1,23 @@ | ||
| # Staking Contract and DAO API | ||
|
|
||
| You can learn about APIs of contracts related to staking and DAO under the | ||
| following links: | ||
|
|
||
| [BaseTokenholderGovernor](./generated-docs/governance/BaseTokenholderGovernor.md) | ||
|
|
||
| [Checkpoints](./generated-docs/governance/Checkpoints.md) | ||
|
|
||
| [GovernorParameters](./generated-docs/governance/GovernorParameters.md) | ||
|
|
||
| [IApplication](./generated-docs/staking/IApplication.md) | ||
|
|
||
| [ILegacyTokenStaking](./generated-docs/staking/ILegacyTokenStaking.md) | ||
|
|
||
| [IStaking](./generated-docs/staking/IStaking.md) | ||
|
|
||
| [IVotesHistory](./generated-docs/governance/IVotesHistory.md) | ||
|
|
||
| [KeepStake](./generated-docs/staking/KeepStake.md) | ||
|
|
||
| [PercentUtils](./generated-docs/utils/PercentUtils.md) | ||
|
|
||
| [ProxyAdminWithDeputy](./generated-docs/governance/ProxyAdminWithDeputy.md) | ||
|
|
||
| [SafeTUpgradeable](./generated-docs/utils/SafeTUpgradeable.md) | ||
|
|
||
| [StakerGovernor](./generated-docs/governance/StakerGovernor.md) | ||
|
|
||
| [StakerGovernorVotes](./generated-docs/governance/StakerGovernorVotes.md) | ||
|
|
||
| [T](./generated-docs/token/T.md) | ||
|
|
||
| [TokenholderGovernor](./generated-docs/governance/TokenholderGovernor.md) | ||
|
|
||
| [TokenholderGovernorVotes](./generated-docs/governance/TokenholderGovernorVotes.md) | ||
|
|
||
| [TokenStaking](./generated-docs/staking/TokenStaking.md) | ||
|
|
||
| [VendingMachine](./generated-docs/vendingVendingMachine.md) | ||
| You can learn about APIs of staking and DAO smart contracts under the following | ||
| links: | ||
|
|
||
| * [BaseTokenholderGovernor](./generated-docs/governance/BaseTokenholderGovernor.md) | ||
| * [Checkpoints](./generated-docs/governance/Checkpoints.md) | ||
| * [GovernorParameters](./generated-docs/governance/GovernorParameters.md) | ||
| * [IApplication](./generated-docs/staking/IApplication.md) | ||
| * [ILegacyTokenStaking](./generated-docs/staking/ILegacyTokenStaking.md) | ||
| * [IStaking](./generated-docs/staking/IStaking.md) | ||
| * [IVotesHistory](./generated-docs/governance/IVotesHistory.md) | ||
| * [KeepStake](./generated-docs/staking/KeepStake.md) | ||
| * [PercentUtils](./generated-docs/utils/PercentUtils.md) | ||
| * [ProxyAdminWithDeputy](./generated-docs/governance/ProxyAdminWithDeputy.md) | ||
| * [SafeTUpgradeable](./generated-docs/utils/SafeTUpgradeable.md) | ||
| * [StakerGovernor](./generated-docs/governance/StakerGovernor.md) | ||
| * [StakerGovernorVotes](./generated-docs/governance/StakerGovernorVotes.md) | ||
| * [T](./generated-docs/token/T.md) | ||
| * [TokenholderGovernor](./generated-docs/governance/TokenholderGovernor.md) | ||
| * [TokenholderGovernorVotes](./generated-docs/governance/TokenholderGovernorVotes.md) | ||
| * [TokenStaking](./generated-docs/staking/TokenStaking.md) | ||
| * [VendingMachine](./generated-docs/vendingVendingMachine.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 |
|---|---|---|
| @@ -1,5 +1,16 @@ | ||
| # tBTC | ||
|
|
||
| To get familiarized with ECDSA contracts API, go [here](ecdsa-api/generated-docs/index.md). | ||
| Threshold Network ECDSA contracts source code is available in the | ||
| [`keep-network/keep-core`](https://github.com/keep-network/keep-core/tree/main/solidity/ecdsa) | ||
| GitHub repository. | ||
|
|
||
| To get familiarized with Bridge contracts API, go [here](tbtc-v2-api/generated-docs/index.md). | ||
| Threshold Network tBTC Bridge contracts source code is available in the | ||
| [`keep-network/tbtc-v2`](https://github.com/keep-network/tbtc-v2/tree/main/solidity) | ||
| GitHub repository. | ||
|
|
||
| The smart contract API documentation is generated based on the NatSpec format | ||
| documentation in the smart contract source code. | ||
|
|
||
| The ECDSA contracts API docs are available [here](ecdsa-api/generated-docs/index.md). | ||
|
|
||
| The tBTC Bridge contracts API docs ara available [here](tbtc-v2-api/generated-docs/index.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 |
|---|---|---|
| @@ -1,22 +1,13 @@ | ||
| # ECDSA API | ||
|
|
||
| You can learn about APIs of contracts related to ECDSA under the following | ||
| links: | ||
|
|
||
| [EcdsaAuthorization](./generated-docs/libraries/EcdsaAuthorization.md) | ||
|
|
||
| [EcdsaDkg](./generated-docs/libraries/EcdsaDkg.md) | ||
|
|
||
| [EcdsaDkgValidator](./generated-docs/EcdsaDkgValidator.md) | ||
|
|
||
| [EcdsaInactivity](./generated-docs/libraries/EcdsaInactivity.md) | ||
|
|
||
| [IWalletOwner](./generated-docs/api/IWalletOwner.md) | ||
|
|
||
| [IWalletRegistry](./generated-docs/api/IWalletRegistry.md) | ||
|
|
||
| [WalletRegistry](./generated-docs/WalletRegistry.md) | ||
|
|
||
| [WalletRegistryGovernance](./generated-docs/WalletRegistryGovernance.md) | ||
|
|
||
| [Wallets](./generated-docs/libraries/Wallets.md) | ||
| You can learn about APIs of ECDSA smart contracts under the following links: | ||
|
|
||
| * [EcdsaAuthorization](./generated-docs/libraries/EcdsaAuthorization.md) | ||
| * [EcdsaDkg](./generated-docs/libraries/EcdsaDkg.md) | ||
| * [EcdsaDkgValidator](./generated-docs/EcdsaDkgValidator.md) | ||
| * [EcdsaInactivity](./generated-docs/libraries/EcdsaInactivity.md) | ||
| * [IWalletOwner](./generated-docs/api/IWalletOwner.md) | ||
| * [IWalletRegistry](./generated-docs/api/IWalletRegistry.md) | ||
| * [WalletRegistry](./generated-docs/WalletRegistry.md) | ||
| * [WalletRegistryGovernance](./generated-docs/WalletRegistryGovernance.md) | ||
| * [Wallets](./generated-docs/libraries/Wallets.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 |
|---|---|---|
| @@ -1,66 +1,36 @@ | ||
| # Bridge API | ||
|
|
||
| You can learn about APIs of contracts related to the Bridge under the following | ||
| You can learn about APIs of tBTC Bridge smart contracts under the following | ||
| links: | ||
|
|
||
| [Bank](./generated-docs/bank/Bank.md) | ||
|
|
||
| [BitcoinTx](./generated-docs/bridge/BitcoinTx.md) | ||
|
|
||
| [Bridge](./generated-docs/bridge/Bridge.md) | ||
|
|
||
| [BridgeGovernance](./generated-docs/bridge/BridgeGovernance.md) | ||
|
|
||
| [BridgeGovernanceParameters](./generated-docs/bridge/BridgeGovernanceParameters.md) | ||
|
|
||
| [BridgeState](./generated-docs/bridge/BridgeState.md) | ||
|
|
||
| [Deposit](./generated-docs/bridge/Deposit.md) | ||
|
|
||
| [DepositSweep](./generated-docs/bridge/DepositSweep.md) | ||
|
|
||
| [DonationVault](./generated-docs/vault/DonationVault.md) | ||
|
|
||
| [EcdsaLib](./generated-docs/bridge/EcdsaLib.md) | ||
|
|
||
| [Fraud](./generated-docs/bridge/Fraud.md) | ||
|
|
||
| [GovernanceUtils](./generated-docs/GovernanceUtils.md) | ||
|
|
||
| [Heartbeat](./generated-docs/bridge/Heartbeat.md) | ||
|
|
||
| [IReceiveBalanceApproval](./generated-docs/bank/IReceiveBalanceApproval.md) | ||
|
|
||
| [IRelay](./generated-docs/bridge/IRelay.md) | ||
|
|
||
| [IVault](./generated-docs/vault/IVault.md) | ||
|
|
||
| [L2TBTC](./generated-docs/l2/L2TBTC.md) | ||
|
|
||
| [L2WormholeGateway](./generated-docs/l2/L2WormholeGateway.md) | ||
|
|
||
| [LightRelay](./generated-docs/relay/LightRelay.md) | ||
|
|
||
| [LightRelayMaintainerProxy](./generated-docs/relay/LightRelayMaintainerProxy.md) | ||
|
|
||
| [MaintainerProxy](./generated-docs/maintainer/MaintainerProxy.md) | ||
|
|
||
| [MovingFunds](./generated-docs/bridge/MovingFunds.md) | ||
|
|
||
| [Redemption](./generated-docs/bridge/Redemption.md) | ||
|
|
||
| [TBTC](./generated-docs/token/TBTC.md) | ||
|
|
||
| [TBTCOptimisticMinting](./generated-docs/vault/TBTCOptimisticMinting.md) | ||
|
|
||
| [TBTCVault](./generated-docs/vault/TBTCVault.md) | ||
|
|
||
| [VendingMachine](./generated-docs/bridge/VendingMachine.md) | ||
|
|
||
| [VendingMachineV2](./generated-docs/bridge/VendingMachineV2.md) | ||
|
|
||
| [VendingMachineV3](./generated-docs/bridge/VendingMachineV3.md) | ||
|
|
||
| [WalletCoordinator](./generated-docs/bridge/WalletCoordinator.md) | ||
|
|
||
| [Wallets](./generated-docs/bridge/Wallets.md) | ||
| * [Bank](./generated-docs/bank/Bank.md) | ||
| * [BitcoinTx](./generated-docs/bridge/BitcoinTx.md) | ||
| * [Bridge](./generated-docs/bridge/Bridge.md) | ||
| * [BridgeGovernance](./generated-docs/bridge/BridgeGovernance.md) | ||
| * [BridgeGovernanceParameters](./generated-docs/bridge/BridgeGovernanceParameters.md) | ||
| * [BridgeState](./generated-docs/bridge/BridgeState.md) | ||
| * [Deposit](./generated-docs/bridge/Deposit.md) | ||
| * [DepositSweep](./generated-docs/bridge/DepositSweep.md) | ||
| * [DonationVault](./generated-docs/vault/DonationVault.md) | ||
| * [EcdsaLib](./generated-docs/bridge/EcdsaLib.md) | ||
| * [Fraud](./generated-docs/bridge/Fraud.md) | ||
| * [GovernanceUtils](./generated-docs/GovernanceUtils.md) | ||
| * [Heartbeat](./generated-docs/bridge/Heartbeat.md) | ||
| * [IReceiveBalanceApproval](./generated-docs/bank/IReceiveBalanceApproval.md) | ||
| * [IRelay](./generated-docs/bridge/IRelay.md) | ||
| * [IVault](./generated-docs/vault/IVault.md) | ||
| * [L2TBTC](./generated-docs/l2/L2TBTC.md) | ||
| * [L2WormholeGateway](./generated-docs/l2/L2WormholeGateway.md) | ||
| * [LightRelay](./generated-docs/relay/LightRelay.md) | ||
| * [LightRelayMaintainerProxy](./generated-docs/relay/LightRelayMaintainerProxy.md) | ||
| * [MaintainerProxy](./generated-docs/maintainer/MaintainerProxy.md) | ||
| * [MovingFunds](./generated-docs/bridge/MovingFunds.md) | ||
| * [Redemption](./generated-docs/bridge/Redemption.md) | ||
| * [TBTC](./generated-docs/token/TBTC.md) | ||
| * [TBTCOptimisticMinting](./generated-docs/vault/TBTCOptimisticMinting.md) | ||
| * [TBTCVault](./generated-docs/vault/TBTCVault.md) | ||
| * [VendingMachine](./generated-docs/bridge/VendingMachine.md) | ||
| * [VendingMachineV2](./generated-docs/bridge/VendingMachineV2.md) | ||
| * [VendingMachineV3](./generated-docs/bridge/VendingMachineV3.md) | ||
| * [WalletCoordinator](./generated-docs/bridge/WalletCoordinator.md) | ||
| * [Wallets](./generated-docs/bridge/Wallets.md) |
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.
After switching from contracts documentation in single file to multiple files, I missed that we should update also this link:
We could update this in this PR. Similar change needed for other project's API's READMEs.