com.hedera.hashgraph.sdk.ContractInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-full Show documentation
Show all versions of sdk-full Show documentation
Hedera™ Hashgraph SDK for Java
/*-
*
* Hedera Java SDK
*
* Copyright (C) 2020 - 2024 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.
*
*/
package com.hedera.hashgraph.sdk;
import com.google.common.base.MoreObjects;
import com.google.protobuf.InvalidProtocolBufferException;
import com.hedera.hashgraph.sdk.proto.ContractGetInfoResponse;
import java.time.Duration;
import java.time.Instant;
import javax.annotation.Nullable;
import java.util.HashMap;
import java.util.Map;
/**
* Current information on the smart contract instance, including its balance.
*/
public final class ContractInfo {
/**
* ID of the contract instance, in the format used in transactions.
*/
public final ContractId contractId;
/**
* ID of the cryptocurrency account owned by the contract instance,
* in the format used in transactions.
*/
public final AccountId accountId;
/**
* ID of both the contract instance and the cryptocurrency account owned by the contract
* instance, in the format used by Solidity.
*/
public final String contractAccountId;
/**
* The state of the instance and its fields can be modified arbitrarily if this key signs a
* transaction to modify it. If this is null, then such modifications are not possible,
* and there is no administrator that can override the normal operation of this smart
* contract instance. Note that if it is created with no admin keys, then there is no
* administrator to authorize changing the admin keys, so there can never be any admin keys
* for that instance.
*/
@Nullable
public final Key adminKey;
/**
* The current time at which this contract instance (and its account) is set to expire.
*/
public final Instant expirationTime;
/**
* The expiration time will extend every this many seconds. If there are insufficient funds,
* then it extends as long as possible. If the account is empty when it expires,
* then it is deleted.
*/
public final Duration autoRenewPeriod;
/**
* ID of the an account to charge for auto-renewal of this contract. If not set, or set to
* an account with zero hbar balance, the contract's own hbar balance will be used to cover
* auto-renewal fees.
*/
@Nullable
public final AccountId autoRenewAccountId;
/**
* Number of bytes of storage being used by this instance (which affects the cost to
* extend the expiration time).
*/
public final long storage;
/**
* The memo associated with the contract (max 100 bytes).
*/
public final String contractMemo;
/**
* The current balance of the contract.
*/
public final Hbar balance;
/**
* Whether the contract has been deleted
*/
public final boolean isDeleted;
/**
* The tokens associated to the contract
*/
public final Map tokenRelationships;
/**
* The ledger ID the response was returned from; please see HIP-198 for the network-specific IDs.
*/
public final LedgerId ledgerId;
/**
* Staking metadata for this account.
*/
@Nullable
public final StakingInfo stakingInfo;
/**
* Constructor.
*
* @param contractId the contract id
* @param accountId the account id
* @param contractAccountId the account id of the owner
* @param adminKey the key that can modify the contract
* @param expirationTime the time that contract will expire
* @param autoRenewPeriod seconds before contract is renewed (funds must be available)
* @param autoRenewAccountId account ID which will be charged for renewing this account
* @param storage number of bytes used by this contract
* @param contractMemo the memo field 100 bytes
* @param balance current balance
* @param isDeleted does it still exist
* @param tokenRelationships list of compound token id and relationship records
* @param ledgerId the ledger id
*/
private ContractInfo(
ContractId contractId,
AccountId accountId,
String contractAccountId,
@Nullable Key adminKey,
Instant expirationTime,
Duration autoRenewPeriod,
@Nullable AccountId autoRenewAccountId,
long storage,
String contractMemo,
Hbar balance,
boolean isDeleted,
Map tokenRelationships,
LedgerId ledgerId,
@Nullable StakingInfo stakingInfo
) {
this.contractId = contractId;
this.accountId = accountId;
this.contractAccountId = contractAccountId;
this.adminKey = adminKey;
this.expirationTime = expirationTime;
this.autoRenewPeriod = autoRenewPeriod;
this.autoRenewAccountId = autoRenewAccountId;
this.storage = storage;
this.contractMemo = contractMemo;
this.balance = balance;
this.isDeleted = isDeleted;
this.tokenRelationships = tokenRelationships;
this.ledgerId = ledgerId;
this.stakingInfo = stakingInfo;
}
/**
* Extract the contract from the protobuf.
*
* @param contractInfo the protobuf
* @return the contract object
*/
static ContractInfo fromProtobuf(ContractGetInfoResponse.ContractInfo contractInfo) {
var adminKey = contractInfo.hasAdminKey()
? Key.fromProtobufKey(contractInfo.getAdminKey())
: null;
var tokenRelationships = new HashMap(contractInfo.getTokenRelationshipsCount());
for (var relationship : contractInfo.getTokenRelationshipsList()) {
tokenRelationships.put(
TokenId.fromProtobuf(relationship.getTokenId()),
TokenRelationship.fromProtobuf(relationship)
);
}
return new ContractInfo(
ContractId.fromProtobuf(contractInfo.getContractID()),
AccountId.fromProtobuf(contractInfo.getAccountID()),
contractInfo.getContractAccountID(),
adminKey,
InstantConverter.fromProtobuf(contractInfo.getExpirationTime()),
DurationConverter.fromProtobuf(contractInfo.getAutoRenewPeriod()),
contractInfo.hasAutoRenewAccountId() ? AccountId.fromProtobuf(contractInfo.getAutoRenewAccountId()) : null,
contractInfo.getStorage(),
contractInfo.getMemo(),
Hbar.fromTinybars(contractInfo.getBalance()),
contractInfo.getDeleted(),
tokenRelationships,
LedgerId.fromByteString(contractInfo.getLedgerId()),
contractInfo.hasStakingInfo() ? StakingInfo.fromProtobuf(contractInfo.getStakingInfo()) : null
);
}
/**
* Extract the contract from a byte array.
*
* @param bytes the byte array
* @return the extracted contract
* @throws InvalidProtocolBufferException when there is an issue with the protobuf
*/
public static ContractInfo fromBytes(byte[] bytes) throws InvalidProtocolBufferException {
return fromProtobuf(ContractGetInfoResponse.ContractInfo.parseFrom(bytes).toBuilder().build());
}
/**
* Build the protobuf.
*
* @return the protobuf representation
*/
ContractGetInfoResponse.ContractInfo toProtobuf() {
var contractInfoBuilder = ContractGetInfoResponse.ContractInfo.newBuilder()
.setContractID(contractId.toProtobuf())
.setAccountID(accountId.toProtobuf())
.setContractAccountID(contractAccountId)
.setExpirationTime(InstantConverter.toProtobuf(expirationTime))
.setAutoRenewPeriod(DurationConverter.toProtobuf(autoRenewPeriod))
.setStorage(storage)
.setMemo(contractMemo)
.setBalance(balance.toTinybars())
.setLedgerId(ledgerId.toByteString());
if (adminKey != null) {
contractInfoBuilder.setAdminKey(adminKey.toProtobufKey());
}
if (stakingInfo != null) {
contractInfoBuilder.setStakingInfo(stakingInfo.toProtobuf());
}
if (autoRenewAccountId != null) {
contractInfoBuilder.setAutoRenewAccountId(autoRenewAccountId.toProtobuf());
}
return contractInfoBuilder.build();
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("contractId", contractId)
.add("accountId", accountId)
.add("contractAccountId", contractAccountId)
.add("adminKey", adminKey)
.add("expirationTime", expirationTime)
.add("autoRenewPeriod", autoRenewPeriod)
.add("autoRenewAccountId", autoRenewAccountId)
.add("storage", storage)
.add("contractMemo", contractMemo)
.add("balance", balance)
.add("isDeleted", isDeleted)
.add("tokenRelationships", tokenRelationships)
.add("ledgerId", ledgerId)
.add("stakingInfo", stakingInfo)
.toString();
}
/**
* Create a byte array representation.
*
* @return the byte array representation
*/
public byte[] toBytes() {
return toProtobuf().toByteArray();
}
}