blockfrost_openapi/models/tx_content.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> </tbody> </table> ## 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.83
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 TxContent {
16 /// Transaction hash
17 #[serde(rename = "hash")]
18 pub hash: String,
19 /// Block hash
20 #[serde(rename = "block")]
21 pub block: String,
22 /// Block number
23 #[serde(rename = "block_height")]
24 pub block_height: i32,
25 /// Block creation time in UNIX time
26 #[serde(rename = "block_time")]
27 pub block_time: i32,
28 /// Slot number
29 #[serde(rename = "slot")]
30 pub slot: i32,
31 /// Transaction index within the block
32 #[serde(rename = "index")]
33 pub index: i32,
34 #[serde(rename = "output_amount")]
35 pub output_amount: Vec<models::TxContentOutputAmountInner>,
36 /// Fees of the transaction in Lovelaces
37 #[serde(rename = "fees")]
38 pub fees: String,
39 /// Deposit within the transaction in Lovelaces
40 #[serde(rename = "deposit")]
41 pub deposit: String,
42 /// Size of the transaction in Bytes
43 #[serde(rename = "size")]
44 pub size: i32,
45 /// Left (included) endpoint of the timelock validity intervals
46 #[serde(rename = "invalid_before", deserialize_with = "Option::deserialize")]
47 pub invalid_before: Option<String>,
48 /// Right (excluded) endpoint of the timelock validity intervals
49 #[serde(rename = "invalid_hereafter", deserialize_with = "Option::deserialize")]
50 pub invalid_hereafter: Option<String>,
51 /// Count of UTXOs within the transaction
52 #[serde(rename = "utxo_count")]
53 pub utxo_count: i32,
54 /// Count of the withdrawals within the transaction
55 #[serde(rename = "withdrawal_count")]
56 pub withdrawal_count: i32,
57 /// Count of the MIR certificates within the transaction
58 #[serde(rename = "mir_cert_count")]
59 pub mir_cert_count: i32,
60 /// Count of the delegations within the transaction
61 #[serde(rename = "delegation_count")]
62 pub delegation_count: i32,
63 /// Count of the stake keys (de)registration within the transaction
64 #[serde(rename = "stake_cert_count")]
65 pub stake_cert_count: i32,
66 /// Count of the stake pool registration and update certificates within the transaction
67 #[serde(rename = "pool_update_count")]
68 pub pool_update_count: i32,
69 /// Count of the stake pool retirement certificates within the transaction
70 #[serde(rename = "pool_retire_count")]
71 pub pool_retire_count: i32,
72 /// Count of asset mints and burns within the transaction
73 #[serde(rename = "asset_mint_or_burn_count")]
74 pub asset_mint_or_burn_count: i32,
75 /// Count of redeemers within the transaction
76 #[serde(rename = "redeemer_count")]
77 pub redeemer_count: i32,
78 /// True if contract script passed validation
79 #[serde(rename = "valid_contract")]
80 pub valid_contract: bool,
81}
82
83impl TxContent {
84 pub fn new(hash: String, block: String, block_height: i32, block_time: i32, slot: i32, index: i32, output_amount: Vec<models::TxContentOutputAmountInner>, fees: String, deposit: String, size: i32, invalid_before: Option<String>, invalid_hereafter: Option<String>, utxo_count: i32, withdrawal_count: i32, mir_cert_count: i32, delegation_count: i32, stake_cert_count: i32, pool_update_count: i32, pool_retire_count: i32, asset_mint_or_burn_count: i32, redeemer_count: i32, valid_contract: bool) -> TxContent {
85 TxContent {
86 hash,
87 block,
88 block_height,
89 block_time,
90 slot,
91 index,
92 output_amount,
93 fees,
94 deposit,
95 size,
96 invalid_before,
97 invalid_hereafter,
98 utxo_count,
99 withdrawal_count,
100 mir_cert_count,
101 delegation_count,
102 stake_cert_count,
103 pool_update_count,
104 pool_retire_count,
105 asset_mint_or_burn_count,
106 redeemer_count,
107 valid_contract,
108 }
109 }
110}
111