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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
/*
*
* Hedera Rust SDK
*
* Copyright (C) 2022 - 2023 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
use hedera_proto::services;
use time::{
Duration,
OffsetDateTime,
};
use crate::protobuf::ToProtobuf;
use crate::{
AccountId,
ContractId,
FromProtobuf,
Key,
LedgerId,
StakingInfo,
};
/// Current information on a smart contract instance.
#[derive(Debug, Clone)]
pub struct ContractInfo {
/// ID of the contract instance, in the format used by transactions.
pub contract_id: ContractId,
/// ID of the cryptocurrency account owned by the contract instance,
/// in the format used in transactions.
pub account_id: AccountId,
/// ID of both the contract instance and the cryptocurrency account owned by the contract
/// instance, in the format used by Solidity.
pub contract_account_id: String,
/// The admin key of the contract instance.
pub admin_key: Option<Key>,
/// The current time at which this contract instance (and its account) is set to expire.
pub expiration_time: Option<OffsetDateTime>,
/// The auto renew period for this contract instance.
pub auto_renew_period: Option<Duration>,
/// Number of bytes of storage being used by this instance.
pub storage: u64,
/// The memo associated with the contract.
pub contract_memo: String,
/// The current balance, in tinybars.
pub balance: u64,
/// Whether the contract has been deleted.
pub is_deleted: bool,
/// ID of the an account to charge for auto-renewal of this contract.
pub auto_renew_account_id: Option<AccountId>,
/// The maximum number of tokens that a contract can be implicitly associated with.
pub max_automatic_token_associations: u32,
/// The ledger ID the response was returned from
pub ledger_id: LedgerId,
/// Staking metadata for this contract.
pub staking_info: Option<StakingInfo>,
}
impl ContractInfo {
/// Create a new `StakingInfo` from protobuf-encoded `bytes`.
///
/// # Errors
/// - [`Error::FromProtobuf`](crate::Error::FromProtobuf) if decoding the bytes fails to produce a valid protobuf.
/// - [`Error::FromProtobuf`](crate::Error::FromProtobuf) if decoding the protobuf fails.
pub fn from_bytes(bytes: &[u8]) -> crate::Result<Self> {
FromProtobuf::<services::contract_get_info_response::ContractInfo>::from_bytes(bytes)
}
/// Convert `self` to a protobuf-encoded [`Vec<u8>`].
#[must_use]
pub fn to_bytes(&self) -> Vec<u8> {
ToProtobuf::to_bytes(self)
}
}
impl FromProtobuf<services::response::Response> for ContractInfo {
#[allow(deprecated)]
fn from_protobuf(pb: services::response::Response) -> crate::Result<Self>
where
Self: Sized,
{
let response = pb_getv!(pb, ContractGetInfo, services::response::Response);
let info = pb_getf!(response, contract_info)?;
Self::from_protobuf(info)
}
}
impl FromProtobuf<services::contract_get_info_response::ContractInfo> for ContractInfo {
#[allow(deprecated)]
fn from_protobuf(pb: services::contract_get_info_response::ContractInfo) -> crate::Result<Self>
where
Self: Sized,
{
let contract_id = pb_getf!(pb, contract_id)?;
let account_id = pb_getf!(pb, account_id)?;
let expiration_time = pb.expiration_time.map(Into::into);
let auto_renew_period = pb.auto_renew_period.map(Into::into);
let auto_renew_account_id = Option::from_protobuf(pb.auto_renew_account_id)?;
let admin_key = Option::from_protobuf(pb.admin_key)?;
let ledger_id = LedgerId::from_bytes(pb.ledger_id);
let staking_info = Option::from_protobuf(pb.staking_info)?;
Ok(Self {
contract_id: ContractId::from_protobuf(contract_id)?,
account_id: AccountId::from_protobuf(account_id)?,
contract_account_id: pb.contract_account_id,
is_deleted: pb.deleted,
balance: pb.balance,
expiration_time,
auto_renew_period,
auto_renew_account_id,
contract_memo: pb.memo,
max_automatic_token_associations: pb.max_automatic_token_associations as u32,
admin_key,
storage: pb.storage as u64,
ledger_id,
staking_info,
})
}
}
impl ToProtobuf for ContractInfo {
type Protobuf = services::contract_get_info_response::ContractInfo;
fn to_protobuf(&self) -> Self::Protobuf {
#[allow(deprecated)]
services::contract_get_info_response::ContractInfo {
contract_id: Some(self.contract_id.to_protobuf()),
account_id: Some(self.account_id.to_protobuf()),
contract_account_id: self.contract_account_id.clone(),
admin_key: self.admin_key.to_protobuf(),
expiration_time: self.expiration_time.to_protobuf(),
auto_renew_period: self.auto_renew_period.to_protobuf(),
storage: self.storage as i64,
memo: self.contract_memo.clone(),
balance: self.balance,
deleted: self.is_deleted,
ledger_id: self.ledger_id.to_bytes(),
auto_renew_account_id: self.auto_renew_account_id.to_protobuf(),
max_automatic_token_associations: self.max_automatic_token_associations as i32,
staking_info: self.staking_info.to_protobuf(),
// unimplemented fields
token_relationships: Vec::new(),
}
}
}
#[cfg(test)]
mod tests {
use expect_test::expect;
use hedera_proto::services;
use prost::Message;
use crate::protobuf::{
FromProtobuf,
ToProtobuf,
};
use crate::{
ContractInfo,
LedgerId,
};
fn make_info() -> services::contract_get_info_response::ContractInfo {
services::contract_get_info_response::ContractInfo {
contract_id: Some(services::ContractId {
shard_num: 0,
realm_num: 0,
contract: Some(services::contract_id::Contract::ContractNum(1)),
}),
account_id: Some(services::AccountId {
shard_num: 0,
realm_num: 0,
account: Some(services::account_id::Account::AccountNum(2)),
}),
contract_account_id: "0.0.3".to_owned(),
expiration_time: Some(services::Timestamp { seconds: 0, nanos: 4_000 }),
auto_renew_period: Some(services::Duration { seconds: 24 * 60 * 60 }),
storage: 6,
memo: "7".to_owned(),
balance: 8,
ledger_id: LedgerId::testnet().to_bytes(),
..Default::default()
}
}
#[test]
fn from_protobuf() {
expect![[r#"
ContractInfo {
contract_id: "0.0.1",
account_id: "0.0.2",
contract_account_id: "0.0.3",
admin_key: None,
expiration_time: Some(
1970-01-01 0:00:00.000004 +00:00:00,
),
auto_renew_period: Some(
Duration {
seconds: 86400,
nanoseconds: 0,
},
),
storage: 6,
contract_memo: "7",
balance: 8,
is_deleted: false,
auto_renew_account_id: None,
max_automatic_token_associations: 0,
ledger_id: "testnet",
staking_info: None,
}
"#]]
.assert_debug_eq(&ContractInfo::from_protobuf(make_info()).unwrap());
}
#[test]
fn to_protobuf() {
expect![[r#"
ContractInfo {
contract_id: Some(
ContractId {
shard_num: 0,
realm_num: 0,
contract: Some(
ContractNum(
1,
),
),
},
),
account_id: Some(
AccountId {
shard_num: 0,
realm_num: 0,
account: Some(
AccountNum(
2,
),
),
},
),
contract_account_id: "0.0.3",
admin_key: None,
expiration_time: Some(
Timestamp {
seconds: 0,
nanos: 4000,
},
),
auto_renew_period: Some(
Duration {
seconds: 86400,
},
),
storage: 6,
memo: "7",
balance: 8,
deleted: false,
token_relationships: [],
ledger_id: [
1,
],
auto_renew_account_id: None,
max_automatic_token_associations: 0,
staking_info: None,
}
"#]]
.assert_debug_eq(&ContractInfo::from_protobuf(make_info()).unwrap().to_protobuf())
}
#[test]
fn from_bytes() {
expect![[r#"
ContractInfo {
contract_id: "0.0.1",
account_id: "0.0.2",
contract_account_id: "0.0.3",
admin_key: None,
expiration_time: Some(
1970-01-01 0:00:00.000004 +00:00:00,
),
auto_renew_period: Some(
Duration {
seconds: 86400,
nanoseconds: 0,
},
),
storage: 6,
contract_memo: "7",
balance: 8,
is_deleted: false,
auto_renew_account_id: None,
max_automatic_token_associations: 0,
ledger_id: "testnet",
staking_info: None,
}
"#]]
.assert_debug_eq(&ContractInfo::from_bytes(&make_info().encode_to_vec()).unwrap());
}
}