temporary-sandbox-public/apidoc.toml at master · autonity/temporary-sandbox-public · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# API reference documentation generator configuration
# See: ./_apidocgen/README.md

[autonity]
build_dir = "params/generated"
src_dir = "autonity/solidity/contracts"
github_url = "https://github.com/autonity/autonity"

[contracts]
output_dir = "reference/api"

[contracts.Accountability]
excludes = [
  # onlyAutonity
  "distributeRewards",
  "finalize",
  "setEpochPeriod",
  # onlyValidator
  "handleEvent",
]

[contracts.ACU]
excludes = [
  # onlyAutonity
  "setOperator",
  "setOracle",
  "update",
]

[contracts.Autonity]
excludes = [
  # onlyAccountability
  "updateValidatorAndTransferSlashedFunds",
  # onlyOperator
  "burn",
  "mint",
  "setAccountabilityContract",
  "setAcuContract",
  "setCommitteeSize",
  "setEpochPeriod",
  "setInflationControllerContract",
  "setMaxBondAppliedGas",
  "setMaxRewardsDistributionGas",
  "setMaxUnbondAppliedGas",
  "setMaxUnbondReleasedGas",
  "setMinimumBaseFee",
  "setNonStakableVestingContract",
  "setOperatorAccount",
  "setOracleContract",
  "setStabilizationContract",
  "setStakingGasPrice",
  "setSupplyControlContract",
  "setTreasuryAccount",
  "setTreasuryFee",
  "setUnbondingPeriod",
  "setUpgradeManagerContract",
  # onlyProtocol
  "computeCommittee",
  "finalize",
  "finalizeInitialization",
]

[contracts.Liquid]
display_name = "Liquid Newton"
excludes = [
  # onlyAutonity
  "burn",
  "lock",
  "mint",
  "redistribute",
  "setCommissionRate",
  "unlock",
]

[contracts.Oracle]
excludes = [
  # onlyAutonity
  "finalize",
  "setOperator",
  "setVoters",
  # onlyOperator
  "setSymbols",
  # onlyVoters
  "vote",
]

[contracts.Stabilization]
excludes = [
  # onlyAutonity
  "setOperator",
  "setOracle",
  # onlyOperator
  "setLiquidationRatio",
  "setMinCollateralizationRatio",
  "setMinDebtRequirement",
  "setSupplyControl",
]

[contracts.SupplyControl]
display_name = "Supply Control"
excludes = [
  # onlyAutonity
  "setOperator",
  # onlyOperator
  "setStabilizer",
  # onlyStabilizer
  "burn",
  "mint",
]