Skip to content

Commit 8a83281

Browse files
michalinaciencialamichalinacienciala
committed
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.
1 parent 5339806 commit 8a83281

7 files changed

Lines changed: 255 additions & 8 deletions

File tree

‎docs/SUMMARY.md‎

Lines changed: 82 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,89 @@
8080
* [Get Started (PRE Mainnet)](app-development/threshold-access-control-tac/advanced-usage/proxy-re-encryption.md)
8181
* [Contribution Guide](app-development/contribution-guide.md)
8282
* [Staking Contract and DAO](app-development/staking-contract-and-dao/README.md)
83-
* [Random Beacon API](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/index.md)
83+
* [Staking Contract and DAO API](app-development/staking-contract-and-dao/staking-contract-and-dao-api/README.md)
84+
* [BaseTokenholderGovernor](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/governance/BaseTokenholderGovernor.md)
85+
* [Checkpoints](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/governance/Checkpoints.md)
86+
* [GovernorParameters](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/governance/GovernorParameters.md)
87+
* [IApplication](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/staking/IApplication.md)
88+
* [ILegacyTokenStaking](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/staking/ILegacyTokenStaking.md)
89+
* [IStaking](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/staking/IStaking.md)
90+
* [IVotesHistory](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/governance/IVotesHistory.md)
91+
* [KeepStake](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/staking/KeepStake.md)
92+
* [PercentUtils](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/utils/PercentUtils.md)
93+
* [ProxyAdminWithDeputy](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/governance/ProxyAdminWithDeputy.md)
94+
* [SafeTUpgradeable](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/utils/SafeTUpgradeable.md)
95+
* [StakerGovernor](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/governance/StakerGovernor.md)
96+
* [StakerGovernorVotes](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/governance/StakerGovernorVotes.md)
97+
* [T](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/token/T.md)
98+
* [TokenholderGovernor](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/governance/TokenholderGovernor.md)
99+
* [TokenholderGovernorVotes](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/governance/TokenholderGovernorVotes.md)
100+
* [TokenStaking](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/staking/TokenStaking.md)
101+
* [VendingMachine](app-development/staking-contract-and-dao/staking-contract-and-dao-api/generated-docs/vendingVendingMachine.md)
84102
* [Random Beacon](app-development/random-beacon/README.md)
85-
* [Random Beacon API](app-development/random-beacon/random-beacon-api/generated-docs/index.md)
86-
* [TBTCv2](app-development/tbtc-v2/README.md)
87-
* [ECDSA API](app-development/tbtc-v2/ecdsa-api/generated-docs/index.md)
88-
* [TBTCv2 API](app-development/tbtc-v2/tbtc-v2-api/generated-docs/index.md)
103+
* [Random Beacon API](app-development/random-beacon/random-beacon-api/README.md)
104+
* [AltBn128](app-development/random-beacon/random-beacon-api/generated-docs/libraries/AltBn128.md)
105+
* [BeaconAuthorization](app-development/random-beacon/random-beacon-api/generated-docs/libraries/BeaconAuthorization.md)
106+
* [BeaconDkg](app-development/random-beacon/random-beacon-api/generated-docs/libraries/BeaconDkg.md)
107+
* [BeaconDkgValidator](app-development/random-beacon/random-beacon-api/generated-docs/BeaconDkgValidator.md)
108+
* [BeaconInactivity](app-development/random-beacon/random-beacon-api/generated-docs/libraries/BeaconInactivity.md)
109+
* [BLS](app-development/random-beacon/random-beacon-api/generated-docs/libraries/BLS.md)
110+
* [BytesLib](app-development/random-beacon/random-beacon-api/generated-docs/libraries/BytesLib.md)
111+
* [Callback](app-development/random-beacon/random-beacon-api/generated-docs/libraries/Callback.md)
112+
* [Governable](app-development/random-beacon/random-beacon-api/generated-docs/Governable.md)
113+
* [Groups](app-development/random-beacon/random-beacon-api/generated-docs/libraries/Groups.md)
114+
* [IRandomBeacon](app-development/random-beacon/random-beacon-api/generated-docs/api/IRandomBeacon.md)
115+
* [IRandomBeaconConsumer](app-development/random-beacon/random-beacon-api/generated-docs/api/IRandomBeaconConsumer.md)
116+
* [ModUtils](app-development/random-beacon/random-beacon-api/generated-docs/libraries/ModUtils.md)
117+
* [RandomBeacon](app-development/random-beacon/random-beacon-api/generated-docs/RandomBeacon.md)
118+
* [RandomBeaconChaosnet](app-development/random-beacon/random-beacon-api/generated-docs/RandomBeaconChaosnet.md)
119+
* [RandomBeaconGovernance](app-development/random-beacon/random-beacon-api/generated-docs/RandomBeaconGovernance.md)
120+
* [Reimbursable](app-development/random-beacon/random-beacon-api/generated-docs/Reimbursable.md)
121+
* [ReimbursementPool](app-development/random-beacon/random-beacon-api/generated-docs/ReimbursementPool.md)
122+
* [Relay](app-development/random-beacon/random-beacon-api/generated-docs/libraries/Relay.md)
123+
* [tBTC](app-development/tbtc-v2/README.md)
124+
* [ECDSA API](app-development/tbtc-v2/ecdsa-api/README.md)
125+
* [EcdsaAuthorization](app-development/tbtc-v2/ecdsa-api/generated-docs/libraries/EcdsaAuthorization.md)
126+
* [EcdsaDkg](app-development/tbtc-v2/ecdsa-api/generated-docs/libraries/EcdsaDkg.md)
127+
* [EcdsaDkgValidator](app-development/tbtc-v2/ecdsa-api/generated-docs/EcdsaDkgValidator.md)
128+
* [EcdsaInactivity](app-development/tbtc-v2/ecdsa-api/generated-docs/libraries/EcdsaInactivity.md)
129+
* [IWalletOwner](app-development/tbtc-v2/ecdsa-api/generated-docs/api/IWalletOwner.md)
130+
* [IWalletRegistry](app-development/tbtc-v2/ecdsa-api/generated-docs/api/IWalletRegistry.md)
131+
* [WalletRegistry](app-development/tbtc-v2/ecdsa-api/generated-docs/WalletRegistry.md)
132+
* [WalletRegistryGovernance](app-development/tbtc-v2/ecdsa-api/generated-docs/WalletRegistryGovernance.md)
133+
* [Wallets](app-development/tbtc-v2/ecdsa-api/generated-docs/libraries/Wallets.md)
134+
* [Bridge API](app-development/tbtc-v2/tbtc-v2-api/README.md)
135+
* [Bank](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bank/Bank.md)
136+
* [BitcoinTx](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/BitcoinTx.md)
137+
* [Bridge](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/Bridge.md)
138+
* [BridgeGovernance](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/BridgeGovernance.md)
139+
* [BridgeGovernanceParameters](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/BridgeGovernanceParameters.md)
140+
* [BridgeState](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/BridgeState.md)
141+
* [Deposit](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/Deposit.md)
142+
* [DepositSweep](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/DepositSweep.md)
143+
* [DonationVault](app-development/tbtc-v2/tbtc-v2-api/generated-docs/vault/DonationVault.md)
144+
* [EcdsaLib](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/EcdsaLib.md)
145+
* [Fraud](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/Fraud.md)
146+
* [GovernanceUtils](app-development/tbtc-v2/tbtc-v2-api/generated-docs/GovernanceUtils.md)
147+
* [Heartbeat](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/Heartbeat.md)
148+
* [IReceiveBalanceApproval](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bank/IReceiveBalanceApproval.md)
149+
* [IRelay](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/IRelay.md)
150+
* [IVault](app-development/tbtc-v2/tbtc-v2-api/generated-docs/vault/IVault.md)
151+
* [L2TBTC](app-development/tbtc-v2/tbtc-v2-api/generated-docs/l2/L2TBTC.md)
152+
* [L2WormholeGateway](app-development/tbtc-v2/tbtc-v2-api/generated-docs/l2/L2WormholeGateway.md)
153+
* [LightRelay](app-development/tbtc-v2/tbtc-v2-api/generated-docs/relay/LightRelay.md)
154+
* [LightRelayMaintainerProxy](app-development/tbtc-v2/tbtc-v2-api/generated-docs/relay/LightRelayMaintainerProxy.md)
155+
* [MaintainerProxy](app-development/tbtc-v2/tbtc-v2-api/generated-docs/maintainer/MaintainerProxy.md)
156+
* [MovingFunds](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/MovingFunds.md)
157+
* [Redemption](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/Redemption.md)
158+
* [TBTC](app-development/tbtc-v2/tbtc-v2-api/generated-docs/token/TBTC.md)
159+
* [TBTCOptimisticMinting](app-development/tbtc-v2/tbtc-v2-api/generated-docs/vault/TBTCOptimisticMinting.md)
160+
* [TBTCVault](app-development/tbtc-v2/tbtc-v2-api/generated-docs/vault/TBTCVault.md)
161+
* [VendingMachine](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/VendingMachine.md)
162+
* [VendingMachineV2](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/VendingMachineV2.md)
163+
* [VendingMachineV3](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/VendingMachineV3.md)
164+
* [WalletCoordinator](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/WalletCoordinator.md)
165+
* [Wallets](app-development/tbtc-v2/tbtc-v2-api/generated-docs/bridge/Wallets.md)
89166

90167
## Resources
91168

‎docs/app-development/random-beacon/random-beacon-api/README.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Random Beacon API
2+
3+
You can learn about APIs of contracts related to the Random Beacon under the
4+
following links:
5+
6+
[AltBn128](./generated-docs/libraries/AltBn128.md)
7+
8+
[BeaconAuthorization](./generated-docs/libraries/BeaconAuthorization.md)
9+
10+
[BeaconDkg](./generated-docs/libraries/BeaconDkg.md)
11+
12+
[BeaconDkgValidator](./generated-docs/BeaconDkgValidator.md)
13+
14+
[BeaconInactivity](./generated-docs/libraries/BeaconInactivity.md)
15+
16+
[BLS](./generated-docs/libraries/BLS.md)
17+
18+
[BytesLib](./generated-docs/libraries/BytesLib.md)
19+
20+
[Callback](./generated-docs/libraries/Callback.md)
21+
22+
[Governable](./generated-docs/Governable.md)
23+
24+
[Groups](./generated-docs/libraries/Groups.md)
25+
26+
[IRandomBeacon](./generated-docs/api/IRandomBeacon.md)
27+
28+
[IRandomBeaconConsumer](./generated-docs/api/IRandomBeaconConsumer.md)
29+
30+
[ModUtils](./generated-docs/libraries/ModUtils.md)
31+
32+
[RandomBeacon](./generated-docs/RandomBeacon.md)
33+
34+
[RandomBeaconChaosnet](./generated-docs/RandomBeaconChaosnet.md)
35+
36+
[RandomBeaconGovernance](./generated-docs/RandomBeaconGovernance.md)
37+
38+
[Reimbursable](./generated-docs/Reimbursable.md)
39+
40+
[ReimbursementPool](./generated-docs/ReimbursementPool.md)
41+
42+
[Relay](./generated-docs/libraries/Relay.md)

‎docs/app-development/staking-contract-and-dao/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Staking Contract and DAO
22

3-
To get familiarized with API of contracts related to staking and DAO, go [here](staking-contracts-and-dao-api/generated-docs/index.md).
3+
To get familiarized with API of contracts related to staking and DAO, go [here](staking-contract-and-dao-api/generated-docs/index.md).

‎docs/app-development/staking-contract-and-dao/staking-contract-and-dao-api/README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Staking Contract and DAO API
2+
3+
You can learn about APIs of contracts related to staking and DAO under the
4+
following links:
5+
6+
[BaseTokenholderGovernor](./generated-docs/governance/BaseTokenholderGovernor.md)
7+
8+
[Checkpoints](./generated-docs/governance/Checkpoints.md)
9+
10+
[GovernorParameters](./generated-docs/governance/GovernorParameters.md)
11+
12+
[IApplication](./generated-docs/staking/IApplication.md)
13+
14+
[ILegacyTokenStaking](./generated-docs/staking/ILegacyTokenStaking.md)
15+
16+
[IStaking](./generated-docs/staking/IStaking.md)
17+
18+
[IVotesHistory](./generated-docs/governance/IVotesHistory.md)
19+
20+
[KeepStake](./generated-docs/staking/KeepStake.md)
21+
22+
[PercentUtils](./generated-docs/utils/PercentUtils.md)
23+
24+
[ProxyAdminWithDeputy](./generated-docs/governance/ProxyAdminWithDeputy.md)
25+
26+
[SafeTUpgradeable](./generated-docs/utils/SafeTUpgradeable.md)
27+
28+
[StakerGovernor](./generated-docs/governance/StakerGovernor.md)
29+
30+
[StakerGovernorVotes](./generated-docs/governance/StakerGovernorVotes.md)
31+
32+
[T](./generated-docs/token/T.md)
33+
34+
[TokenholderGovernor](./generated-docs/governance/TokenholderGovernor.md)
35+
36+
[TokenholderGovernorVotes](./generated-docs/governance/TokenholderGovernorVotes.md)
37+
38+
[TokenStaking](./generated-docs/staking/TokenStaking.md)
39+
40+
[VendingMachine](./generated-docs/vendingVendingMachine.md)

‎docs/app-development/tbtc-v2/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# TBTCv2
1+
# tBTC
22

33
To get familiarized with ECDSA contracts API, go [here](ecdsa-api/generated-docs/index.md).
44

5-
To get familiarized with ECDSA contracts API, go [here](tbtc-v2-api/generated-docs/index.md).
5+
To get familiarized with Bridge contracts API, go [here](tbtc-v2-api/generated-docs/index.md).

‎docs/app-development/tbtc-v2/ecdsa-api/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# ECDSA API
2+
3+
You can learn about APIs of contracts related to ECDSA under the following
4+
links:
5+
6+
[EcdsaAuthorization](./generated-docs/libraries/EcdsaAuthorization.md)
7+
8+
[EcdsaDkg](./generated-docs/libraries/EcdsaDkg.md)
9+
10+
[EcdsaDkgValidator](./generated-docs/EcdsaDkgValidator.md)
11+
12+
[EcdsaInactivity](./generated-docs/libraries/EcdsaInactivity.md)
13+
14+
[IWalletOwner](./generated-docs/api/IWalletOwner.md)
15+
16+
[IWalletRegistry](./generated-docs/api/IWalletRegistry.md)
17+
18+
[WalletRegistry](./generated-docs/WalletRegistry.md)
19+
20+
[WalletRegistryGovernance](./generated-docs/WalletRegistryGovernance.md)
21+
22+
[Wallets](./generated-docs/libraries/Wallets.md)

‎docs/app-development/tbtc-v2/tbtc-v2-api/README.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Bridge API
2+
3+
You can learn about APIs of contracts related to the Bridge under the following
4+
links:
5+
6+
[Bank](./generated-docs/bank/Bank.md)
7+
8+
[BitcoinTx](./generated-docs/bridge/BitcoinTx.md)
9+
10+
[Bridge](./generated-docs/bridge/Bridge.md)
11+
12+
[BridgeGovernance](./generated-docs/bridge/BridgeGovernance.md)
13+
14+
[BridgeGovernanceParameters](./generated-docs/bridge/BridgeGovernanceParameters.md)
15+
16+
[BridgeState](./generated-docs/bridge/BridgeState.md)
17+
18+
[Deposit](./generated-docs/bridge/Deposit.md)
19+
20+
[DepositSweep](./generated-docs/bridge/DepositSweep.md)
21+
22+
[DonationVault](./generated-docs/vault/DonationVault.md)
23+
24+
[EcdsaLib](./generated-docs/bridge/EcdsaLib.md)
25+
26+
[Fraud](./generated-docs/bridge/Fraud.md)
27+
28+
[GovernanceUtils](./generated-docs/GovernanceUtils.md)
29+
30+
[Heartbeat](./generated-docs/bridge/Heartbeat.md)
31+
32+
[IReceiveBalanceApproval](./generated-docs/bank/IReceiveBalanceApproval.md)
33+
34+
[IRelay](./generated-docs/bridge/IRelay.md)
35+
36+
[IVault](./generated-docs/vault/IVault.md)
37+
38+
[L2TBTC](./generated-docs/l2/L2TBTC.md)
39+
40+
[L2WormholeGateway](./generated-docs/l2/L2WormholeGateway.md)
41+
42+
[LightRelay](./generated-docs/relay/LightRelay.md)
43+
44+
[LightRelayMaintainerProxy](./generated-docs/relay/LightRelayMaintainerProxy.md)
45+
46+
[MaintainerProxy](./generated-docs/maintainer/MaintainerProxy.md)
47+
48+
[MovingFunds](./generated-docs/bridge/MovingFunds.md)
49+
50+
[Redemption](./generated-docs/bridge/Redemption.md)
51+
52+
[TBTC](./generated-docs/token/TBTC.md)
53+
54+
[TBTCOptimisticMinting](./generated-docs/vault/TBTCOptimisticMinting.md)
55+
56+
[TBTCVault](./generated-docs/vault/TBTCVault.md)
57+
58+
[VendingMachine](./generated-docs/bridge/VendingMachine.md)
59+
60+
[VendingMachineV2](./generated-docs/bridge/VendingMachineV2.md)
61+
62+
[VendingMachineV3](./generated-docs/bridge/VendingMachineV3.md)
63+
64+
[WalletCoordinator](./generated-docs/bridge/WalletCoordinator.md)
65+
66+
[Wallets](./generated-docs/bridge/Wallets.md)

0 commit comments

Comments
 (0)