-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Split contracts API doc into multiple files
Having all the contracts documented in one common file turned out to be hard to render by the GitBook. We're switching to documenting each contract file in a separate Markdown file. The docs got published in previous commits, in this commit we update the GitBook;s navigation.
- Loading branch information
1 parent
5339806
commit 8a83281
Showing
7 changed files
with
255 additions
and
8 deletions.
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
42 changes: 42 additions & 0 deletions
42
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 |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # 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) |
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,3 @@ | ||
| # Staking Contract and DAO | ||
|
|
||
| To get familiarized with API of contracts related to staking and DAO, go [here](staking-contracts-and-dao-api/generated-docs/index.md). | ||
| To get familiarized with API of contracts related to staking and DAO, go [here](staking-contract-and-dao-api/generated-docs/index.md). |
40 changes: 40 additions & 0 deletions
40
...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 |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # 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) |
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,5 @@ | ||
| # TBTCv2 | ||
| # tBTC | ||
|
|
||
| To get familiarized with ECDSA contracts API, go [here](ecdsa-api/generated-docs/index.md). | ||
|
|
||
| To get familiarized with ECDSA contracts API, go [here](tbtc-v2-api/generated-docs/index.md). | ||
| To get familiarized with Bridge contracts API, go [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 |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # 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) |
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,66 @@ | ||
| # Bridge API | ||
|
|
||
| You can learn about APIs of contracts related to the Bridge 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) |