blockfrost_openapi/models/proposal_parameters_parameters.rs
1/*
2 * Blockfrost.io ~ API Documentation
3 *
4 * Blockfrost is an API as a service that allows users to interact with the Cardano blockchain and parts of its ecosystem. ## Tokens After signing up on https://blockfrost.io, a `project_id` token is automatically generated for each project. HTTP header of your request MUST include this `project_id` in order to authenticate against Blockfrost servers. ## Available networks At the moment, you can use the following networks. Please, note that each network has its own `project_id`. <table> <tbody> <tr> <td> <b>Network</b> </td> <td> <b>Endpoint</b> </td> </tr> <tr> <td>Cardano mainnet</td> <td> <code>https://cardano-mainnet.blockfrost.io/api/v0</code> </td> </tr> <tr> <td>Cardano preprod</td> <td> <code>https://cardano-preprod.blockfrost.io/api/v0</code> </td> </tr> <tr> <td>Cardano preview</td> <td> <code>https://cardano-preview.blockfrost.io/api/v0</code> </td> </tr> <tr> <td>InterPlanetary File System</td> <td> <code>https://ipfs.blockfrost.io/api/v0</code> </td> </tr> <tr> <td>Milkomeda mainnet</td> <td> <code>https://milkomeda-mainnet.blockfrost.io/api/v0</code> </td> </tr> <tr> <td>Milkomeda testnet</td> <td> <code>https://milkomeda-testnet.blockfrost.io/api/v0</code> </td> </tr> </tbody> </table> ## Milkomeda <p> <span> For more information about how to use Milkomeda as well as the list of available endpoints, see the <a href=\"https://blockfrost.dev/start-building/milkomeda\" target=\"_blank\">Milkomeda section</a>. </span> </p> ## Concepts * All endpoints return either a JSON object or an array. * Data is returned in *ascending* (oldest first, newest last) order, if not stated otherwise. * You might use the `?order=desc` query parameter to reverse this order. * By default, we return 100 results at a time. You have to use `?page=2` to list through the results. * All time and timestamp related fields (except `server_time`) are in seconds of UNIX time. * All amounts are returned in Lovelaces, where 1 ADA = 1 000 000 Lovelaces. * Addresses, accounts and pool IDs are in Bech32 format. * All values are case sensitive. * All hex encoded values are lower case. * Examples are not based on real data. Any resemblance to actual events is purely coincidental. * We allow to upload files up to 100MB of size to IPFS. This might increase in the future. * Only pinned IPFS files are counted towards the IPFS quota. * Non-pinned IPFS files are subject to regular garbage collection and will be removed unless pinned. * We allow maximum of 100 queued pins per IPFS user. ## Errors ### HTTP Status codes The following are HTTP status code your application might receive when reaching Blockfrost endpoints and it should handle all of these cases. * HTTP `400` return code is used when the request is not valid. * HTTP `402` return code is used when the projects exceed their daily request limit. * HTTP `403` return code is used when the request is not authenticated. * HTTP `404` return code is used when the resource doesn't exist. * HTTP `418` return code is used when the user has been auto-banned for flooding too much after previously receiving error code `402` or `429`. * HTTP `425` return code is used in Cardano networks, when the user has submitted a transaction when the mempool is already full, not accepting new txs straight away. * HTTP `425` return code is used in IPFS network, when the user has submitted a pin when the pin queue is already full, not accepting new pins straight away. * HTTP `429` return code is used when the user has sent too many requests in a given amount of time and therefore has been rate-limited. * HTTP `500` return code is used when our endpoints are having a problem. ### Error codes An internal error code number is used for better indication of the error in question. It is passed using the following payload. ```json { \"status_code\": 403, \"error\": \"Forbidden\", \"message\": \"Invalid project token.\" } ``` ## Limits There are two types of limits we are enforcing: The first depends on your plan and is the number of request we allow per day. We defined the day from midnight to midnight of UTC time. The second is rate limiting. We limit an end user, distinguished by IP address, to 10 requests per second. On top of that, we allow each user to send burst of 500 requests, which cools off at rate of 10 requests per second. In essence, a user is allowed to make another whole burst after (currently) 500/10 = 50 seconds. E.g. if a user attempts to make a call 3 seconds after whole burst, 30 requests will be processed. We believe this should be sufficient for most of the use cases. If it is not and you have a specific use case, please get in touch with us, and we will make sure to take it into account as much as we can. ## SDKs We support a number of SDKs that will help you in developing your application on top of Blockfrost. <table> <tbody> <tr> <td><b>Programming language</b></td> <td><b>SDK</b></td> </tr> <tr> <td>JavaScript</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-js\">blockfrost-js</a> </td> </tr> <tr> <td>Haskell</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-haskell\">blockfrost-haskell</a> </td> </tr> <tr> <td>Python</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-python\">blockfrost-python</a> </td> </tr> <tr> <td>Rust</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-rust\">blockfrost-rust</a> </td> </tr> <tr> <td>Golang</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-go\">blockfrost-go</a> </td> </tr> <tr> <td>Ruby</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-ruby\">blockfrost-ruby</a> </td> </tr> <tr> <td>Java</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-java\">blockfrost-java</a> </td> </tr> <tr> <td>Scala</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-scala\">blockfrost-scala</a> </td> </tr> <tr> <td>Swift</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-swift\">blockfrost-swift</a> </td> </tr> <tr> <td>Kotlin</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-kotlin\">blockfrost-kotlin</a> </td> </tr> <tr> <td>Elixir</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-elixir\">blockfrost-elixir</a> </td> </tr> <tr> <td>.NET</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-dotnet\">blockfrost-dotnet</a> </td> </tr> <tr> <td>Arduino</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-arduino\">blockfrost-arduino</a> </td> </tr> <tr> <td>PHP</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-php\">blockfrost-php</a> </td> </tr> <tr> <td>Crystal</td> <td> <a href=\"https://github.com/blockfrost/blockfrost-crystal\">blockfrost-crystal</a> </td> </tr> </tbody> </table>
5 *
6 * The version of the OpenAPI document: 0.1.69
7 * Contact: contact@blockfrost.io
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct ProposalParametersParameters {
16 /// Epoch number
17 #[serde(rename = "epoch", skip_serializing_if = "Option::is_none")]
18 pub epoch: Option<i32>,
19 /// The linear factor for the minimum fee calculation for given epoch
20 #[serde(rename = "min_fee_a")]
21 pub min_fee_a: i32,
22 /// The constant factor for the minimum fee calculation
23 #[serde(rename = "min_fee_b")]
24 pub min_fee_b: i32,
25 /// Maximum block body size in Bytes
26 #[serde(rename = "max_block_size")]
27 pub max_block_size: i32,
28 /// Maximum transaction size
29 #[serde(rename = "max_tx_size")]
30 pub max_tx_size: i32,
31 /// Maximum block header size
32 #[serde(rename = "max_block_header_size")]
33 pub max_block_header_size: i32,
34 /// The amount of a key registration deposit in Lovelaces
35 #[serde(rename = "key_deposit")]
36 pub key_deposit: String,
37 /// The amount of a pool registration deposit in Lovelaces
38 #[serde(rename = "pool_deposit")]
39 pub pool_deposit: String,
40 /// Epoch bound on pool retirement
41 #[serde(rename = "e_max")]
42 pub e_max: i32,
43 /// Desired number of pools
44 #[serde(rename = "n_opt")]
45 pub n_opt: i32,
46 /// Pool pledge influence
47 #[serde(rename = "a0")]
48 pub a0: f64,
49 /// Monetary expansion
50 #[serde(rename = "rho")]
51 pub rho: f64,
52 /// Treasury expansion
53 #[serde(rename = "tau")]
54 pub tau: f64,
55 /// Percentage of blocks produced by federated nodes
56 #[serde(rename = "decentralisation_param")]
57 pub decentralisation_param: f64,
58 /// Seed for extra entropy
59 #[serde(rename = "extra_entropy", deserialize_with = "Option::deserialize")]
60 pub extra_entropy: Option<String>,
61 /// Accepted protocol major version
62 #[serde(rename = "protocol_major_ver")]
63 pub protocol_major_ver: i32,
64 /// Accepted protocol minor version
65 #[serde(rename = "protocol_minor_ver")]
66 pub protocol_minor_ver: i32,
67 /// Minimum UTXO value
68 #[serde(rename = "min_utxo")]
69 pub min_utxo: String,
70 /// Minimum stake cost forced on the pool
71 #[serde(rename = "min_pool_cost")]
72 pub min_pool_cost: String,
73 /// Epoch number only used once
74 #[serde(rename = "nonce")]
75 pub nonce: String,
76 /// Cost models parameters for Plutus Core scripts in raw list form
77 #[serde(rename = "cost_models", deserialize_with = "Option::deserialize")]
78 pub cost_models: Option<std::collections::HashMap<String, serde_json::Value>>,
79 /// The per word cost of script memory usage
80 #[serde(rename = "price_mem", deserialize_with = "Option::deserialize")]
81 pub price_mem: Option<f64>,
82 /// The cost of script execution step usage
83 #[serde(rename = "price_step", deserialize_with = "Option::deserialize")]
84 pub price_step: Option<f64>,
85 /// The maximum number of execution memory allowed to be used in a single transaction
86 #[serde(rename = "max_tx_ex_mem", deserialize_with = "Option::deserialize")]
87 pub max_tx_ex_mem: Option<String>,
88 /// The maximum number of execution steps allowed to be used in a single transaction
89 #[serde(rename = "max_tx_ex_steps", deserialize_with = "Option::deserialize")]
90 pub max_tx_ex_steps: Option<String>,
91 /// The maximum number of execution memory allowed to be used in a single block
92 #[serde(rename = "max_block_ex_mem", deserialize_with = "Option::deserialize")]
93 pub max_block_ex_mem: Option<String>,
94 /// The maximum number of execution steps allowed to be used in a single block
95 #[serde(rename = "max_block_ex_steps", deserialize_with = "Option::deserialize")]
96 pub max_block_ex_steps: Option<String>,
97 /// The maximum Val size
98 #[serde(rename = "max_val_size", deserialize_with = "Option::deserialize")]
99 pub max_val_size: Option<String>,
100 /// The percentage of the transactions fee which must be provided as collateral when including non-native scripts
101 #[serde(rename = "collateral_percent", deserialize_with = "Option::deserialize")]
102 pub collateral_percent: Option<i32>,
103 /// The maximum number of collateral inputs allowed in a transaction
104 #[serde(rename = "max_collateral_inputs", deserialize_with = "Option::deserialize")]
105 pub max_collateral_inputs: Option<i32>,
106 /// Cost per UTxO word for Alonzo. Cost per UTxO byte for Babbage and later.
107 #[serde(rename = "coins_per_utxo_size", deserialize_with = "Option::deserialize")]
108 pub coins_per_utxo_size: Option<String>,
109 /// Cost per UTxO word for Alonzo. Cost per UTxO byte for Babbage and later.
110 #[serde(rename = "coins_per_utxo_word", deserialize_with = "Option::deserialize")]
111 pub coins_per_utxo_word: Option<String>,
112 /// Pool Voting threshold for motion of no-confidence. New in 13.2-Conway.
113 #[serde(rename = "pvt_motion_no_confidence", deserialize_with = "Option::deserialize")]
114 pub pvt_motion_no_confidence: Option<f64>,
115 /// Pool Voting threshold for new committee/threshold (normal state). New in 13.2-Conway.
116 #[serde(rename = "pvt_committee_normal", deserialize_with = "Option::deserialize")]
117 pub pvt_committee_normal: Option<f64>,
118 /// Pool Voting threshold for new committee/threshold (state of no-confidence). New in 13.2-Conway.
119 #[serde(rename = "pvt_committee_no_confidence", deserialize_with = "Option::deserialize")]
120 pub pvt_committee_no_confidence: Option<f64>,
121 /// Pool Voting threshold for hard-fork initiation. New in 13.2-Conway.
122 #[serde(rename = "pvt_hard_fork_initiation", deserialize_with = "Option::deserialize")]
123 pub pvt_hard_fork_initiation: Option<f64>,
124 /// DRep Vote threshold for motion of no-confidence. New in 13.2-Conway.
125 #[serde(rename = "dvt_motion_no_confidence", deserialize_with = "Option::deserialize")]
126 pub dvt_motion_no_confidence: Option<f64>,
127 /// DRep Vote threshold for new committee/threshold (normal state). New in 13.2-Conway.
128 #[serde(rename = "dvt_committee_normal", deserialize_with = "Option::deserialize")]
129 pub dvt_committee_normal: Option<f64>,
130 /// DRep Vote threshold for new committee/threshold (state of no-confidence). New in 13.2-Conway.
131 #[serde(rename = "dvt_committee_no_confidence", deserialize_with = "Option::deserialize")]
132 pub dvt_committee_no_confidence: Option<f64>,
133 /// DRep Vote threshold for update to the Constitution. New in 13.2-Conway.
134 #[serde(rename = "dvt_update_to_constitution", deserialize_with = "Option::deserialize")]
135 pub dvt_update_to_constitution: Option<f64>,
136 /// DRep Vote threshold for hard-fork initiation. New in 13.2-Conway.
137 #[serde(rename = "dvt_hard_fork_initiation", deserialize_with = "Option::deserialize")]
138 pub dvt_hard_fork_initiation: Option<f64>,
139 /// DRep Vote threshold for protocol parameter changes, network group. New in 13.2-Conway.
140 #[serde(rename = "dvt_p_p_network_group", deserialize_with = "Option::deserialize")]
141 pub dvt_p_p_network_group: Option<f64>,
142 /// DRep Vote threshold for protocol parameter changes, economic group. New in 13.2-Conway.
143 #[serde(rename = "dvt_p_p_economic_group", deserialize_with = "Option::deserialize")]
144 pub dvt_p_p_economic_group: Option<f64>,
145 /// DRep Vote threshold for protocol parameter changes, technical group. New in 13.2-Conway.
146 #[serde(rename = "dvt_p_p_technical_group", deserialize_with = "Option::deserialize")]
147 pub dvt_p_p_technical_group: Option<f64>,
148 /// DRep Vote threshold for protocol parameter changes, governance group. New in 13.2-Conway.
149 #[serde(rename = "dvt_p_p_gov_group", deserialize_with = "Option::deserialize")]
150 pub dvt_p_p_gov_group: Option<f64>,
151 /// DRep Vote threshold for treasury withdrawal. New in 13.2-Conway.
152 #[serde(rename = "dvt_treasury_withdrawal", deserialize_with = "Option::deserialize")]
153 pub dvt_treasury_withdrawal: Option<f64>,
154 /// Minimal constitutional committee size. New in 13.2-Conway.
155 #[serde(rename = "committee_min_size", deserialize_with = "Option::deserialize")]
156 pub committee_min_size: Option<String>,
157 /// Constitutional committee term limits. New in 13.2-Conway.
158 #[serde(rename = "committee_max_term_length", deserialize_with = "Option::deserialize")]
159 pub committee_max_term_length: Option<String>,
160 /// Governance action expiration. New in 13.2-Conway.
161 #[serde(rename = "gov_action_lifetime", deserialize_with = "Option::deserialize")]
162 pub gov_action_lifetime: Option<String>,
163 /// Governance action deposit. New in 13.2-Conway.
164 #[serde(rename = "gov_action_deposit", deserialize_with = "Option::deserialize")]
165 pub gov_action_deposit: Option<String>,
166 /// DRep deposit amount. New in 13.2-Conway.
167 #[serde(rename = "drep_deposit", deserialize_with = "Option::deserialize")]
168 pub drep_deposit: Option<String>,
169 /// DRep activity period. New in 13.2-Conway.
170 #[serde(rename = "drep_activity", deserialize_with = "Option::deserialize")]
171 pub drep_activity: Option<String>,
172 /// Pool Voting threshold for security-relevant protocol parameters changes. Renamed to pvt_p_p_security_group.
173 #[serde(rename = "pvtpp_security_group", deserialize_with = "Option::deserialize")]
174 pub pvtpp_security_group: Option<f64>,
175 /// Pool Voting threshold for security-relevant protocol parameters changes.
176 #[serde(rename = "pvt_p_p_security_group", deserialize_with = "Option::deserialize")]
177 pub pvt_p_p_security_group: Option<f64>,
178 #[serde(rename = "min_fee_ref_script_cost_per_byte", deserialize_with = "Option::deserialize")]
179 pub min_fee_ref_script_cost_per_byte: Option<f64>,
180}
181
182impl ProposalParametersParameters {
183 pub fn new(min_fee_a: i32, min_fee_b: i32, max_block_size: i32, max_tx_size: i32, max_block_header_size: i32, key_deposit: String, pool_deposit: String, e_max: i32, n_opt: i32, a0: f64, rho: f64, tau: f64, decentralisation_param: f64, extra_entropy: Option<String>, protocol_major_ver: i32, protocol_minor_ver: i32, min_utxo: String, min_pool_cost: String, nonce: String, cost_models: Option<std::collections::HashMap<String, serde_json::Value>>, price_mem: Option<f64>, price_step: Option<f64>, max_tx_ex_mem: Option<String>, max_tx_ex_steps: Option<String>, max_block_ex_mem: Option<String>, max_block_ex_steps: Option<String>, max_val_size: Option<String>, collateral_percent: Option<i32>, max_collateral_inputs: Option<i32>, coins_per_utxo_size: Option<String>, coins_per_utxo_word: Option<String>, pvt_motion_no_confidence: Option<f64>, pvt_committee_normal: Option<f64>, pvt_committee_no_confidence: Option<f64>, pvt_hard_fork_initiation: Option<f64>, dvt_motion_no_confidence: Option<f64>, dvt_committee_normal: Option<f64>, dvt_committee_no_confidence: Option<f64>, dvt_update_to_constitution: Option<f64>, dvt_hard_fork_initiation: Option<f64>, dvt_p_p_network_group: Option<f64>, dvt_p_p_economic_group: Option<f64>, dvt_p_p_technical_group: Option<f64>, dvt_p_p_gov_group: Option<f64>, dvt_treasury_withdrawal: Option<f64>, committee_min_size: Option<String>, committee_max_term_length: Option<String>, gov_action_lifetime: Option<String>, gov_action_deposit: Option<String>, drep_deposit: Option<String>, drep_activity: Option<String>, pvtpp_security_group: Option<f64>, pvt_p_p_security_group: Option<f64>, min_fee_ref_script_cost_per_byte: Option<f64>) -> ProposalParametersParameters {
184 ProposalParametersParameters {
185 epoch: None,
186 min_fee_a,
187 min_fee_b,
188 max_block_size,
189 max_tx_size,
190 max_block_header_size,
191 key_deposit,
192 pool_deposit,
193 e_max,
194 n_opt,
195 a0,
196 rho,
197 tau,
198 decentralisation_param,
199 extra_entropy,
200 protocol_major_ver,
201 protocol_minor_ver,
202 min_utxo,
203 min_pool_cost,
204 nonce,
205 cost_models,
206 price_mem,
207 price_step,
208 max_tx_ex_mem,
209 max_tx_ex_steps,
210 max_block_ex_mem,
211 max_block_ex_steps,
212 max_val_size,
213 collateral_percent,
214 max_collateral_inputs,
215 coins_per_utxo_size,
216 coins_per_utxo_word,
217 pvt_motion_no_confidence,
218 pvt_committee_normal,
219 pvt_committee_no_confidence,
220 pvt_hard_fork_initiation,
221 dvt_motion_no_confidence,
222 dvt_committee_normal,
223 dvt_committee_no_confidence,
224 dvt_update_to_constitution,
225 dvt_hard_fork_initiation,
226 dvt_p_p_network_group,
227 dvt_p_p_economic_group,
228 dvt_p_p_technical_group,
229 dvt_p_p_gov_group,
230 dvt_treasury_withdrawal,
231 committee_min_size,
232 committee_max_term_length,
233 gov_action_lifetime,
234 gov_action_deposit,
235 drep_deposit,
236 drep_activity,
237 pvtpp_security_group,
238 pvt_p_p_security_group,
239 min_fee_ref_script_cost_per_byte,
240 }
241 }
242}
243