com.hedera.hashgraph.sdk.AccountInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-jdk7 Show documentation
Show all versions of sdk-jdk7 Show documentation
Hedera™ Hashgraph SDK for Java
The newest version!
/*-
*
* Hedera Java SDK
*
* Copyright (C) 2020 - 2022 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.CryptoGetInfoResponse;
import java8.util.J8Arrays;
import java8.util.stream.Collectors;
import org.threeten.bp.Duration;
import org.threeten.bp.Instant;
import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Current information about an account, including the balance.
*/
public final class AccountInfo {
/**
* The account ID for which this information applies.
*/
public final AccountId accountId;
/**
* The Contract Account ID comprising both the contract instance and the cryptocurrency
* account owned by the contract instance, in the format used by Solidity.
*/
public final String contractAccountId;
/**
* If true, then this account has been deleted, it will disappear when it expires, and
* all transactions for it will fail except the transaction to extend its expiration date.
*/
public final boolean isDeleted;
/**
* The Account ID of the account to which this is proxy staked. If proxyAccountID is null,
* or is an invalid account, or is an account that isn't a node, then this account is
* automatically proxy staked to a node chosen by the network, but without earning payments.
* If the proxyAccountID account refuses to accept proxy staking , or if it is not currently
* running a node, then it will behave as if proxyAccountID was null.
*/
@Nullable
public final AccountId proxyAccountId;
/**
* The total proxy staked to this account.
*/
public final Hbar proxyReceived;
/**
* The key for the account, which must sign in order to transfer out, or to modify the account
* in any way other than extending its expiration date.
*/
public final Key key;
/**
* The current balance of account.
*/
public final Hbar balance;
/**
* The threshold amount for which an account record is created (and this account
* charged for them) for any send/withdraw transaction.
*/
public final Hbar sendRecordThreshold;
/**
* The threshold amount for which an account record is created
* (and this account charged for them) for any transaction above this amount.
*/
public final Hbar receiveRecordThreshold;
/**
* If true, no transaction can transfer to this account unless signed by this account's key.
*/
public final boolean isReceiverSignatureRequired;
/**
* The time at which this account is set to expire.
*/
public final Instant expirationTime;
/**
* The duration for expiration time will extend every this many seconds. If there are
* insufficient funds, then it extends as long as possible. If it is empty when it
* expires, then it is deleted.
*/
public final Duration autoRenewPeriod;
/**
* All the livehashes attached to the account (each of which is a hash along with the
* keys that authorized it and can delete it)
*/
public final List liveHashes;
/**
* @deprecated use a mirror node query instead
*/
@Deprecated
public final Map tokenRelationships;
/**
* The memo associated with the account
*/
public final String accountMemo;
/**
* The number of NFTs owned by this account
*/
public final long ownedNfts;
/**
* The maximum number of tokens that an Account can be implicitly associated with.
*/
public final int maxAutomaticTokenAssociations;
/**
* The public key which aliases to this account.
*/
@Nullable
public final PublicKey aliasKey;
/**
* The ledger ID the response was returned from; please see HIP-198 for the network-specific IDs.
*/
public final LedgerId ledgerId;
/**
* The ethereum transaction nonce associated with this account.
*/
public final long ethereumNonce;
/**
* List of Hbar allowances
*/
@Deprecated
public final List hbarAllowances;
/**
* List of token allowances
*/
@Deprecated
public final List tokenAllowances;
/**
* List of NFT allowances
*/
@Deprecated
public final List tokenNftAllowances;
/**
* Staking metadata for this account.
*/
@Nullable
public final StakingInfo stakingInfo;
/**
* Constructor.
*
* @param accountId the account id
* @param contractAccountId the contracts account id
* @param isDeleted is it deleted
* @param proxyAccountId the proxy account's id
* @param proxyReceived amount of proxy received
* @param key signing key
* @param balance account balance
* @param sendRecordThreshold @depreciated no replacement
* @param receiveRecordThreshold @depreciated no replacement
* @param receiverSignatureRequired is the receiver's signature required
* @param expirationTime the expiration time
* @param autoRenewPeriod the auto renew period
* @param liveHashes the live hashes
* @param tokenRelationships list of token id and token relationship records
* @param accountMemo the account memo
* @param ownedNfts number of nft's
* @param maxAutomaticTokenAssociations max number of token associations
* @param aliasKey public alias key
* @param ledgerId the ledger id
*/
private AccountInfo(
AccountId accountId,
String contractAccountId,
boolean isDeleted,
@Nullable AccountId proxyAccountId,
long proxyReceived,
Key key,
long balance,
long sendRecordThreshold,
long receiveRecordThreshold,
boolean receiverSignatureRequired,
Instant expirationTime,
Duration autoRenewPeriod,
List liveHashes,
Map tokenRelationships,
String accountMemo,
long ownedNfts,
int maxAutomaticTokenAssociations,
@Nullable PublicKey aliasKey,
LedgerId ledgerId,
long ethereumNonce,
@Nullable StakingInfo stakingInfo
) {
this.accountId = accountId;
this.contractAccountId = contractAccountId;
this.isDeleted = isDeleted;
this.proxyAccountId = proxyAccountId;
this.proxyReceived = Hbar.fromTinybars(proxyReceived);
this.key = key;
this.balance = Hbar.fromTinybars(balance);
this.sendRecordThreshold = Hbar.fromTinybars(sendRecordThreshold);
this.receiveRecordThreshold = Hbar.fromTinybars(receiveRecordThreshold);
this.isReceiverSignatureRequired = receiverSignatureRequired;
this.expirationTime = expirationTime;
this.autoRenewPeriod = autoRenewPeriod;
this.liveHashes = liveHashes;
this.tokenRelationships = Collections.unmodifiableMap(tokenRelationships);
this.accountMemo = accountMemo;
this.ownedNfts = ownedNfts;
this.maxAutomaticTokenAssociations = maxAutomaticTokenAssociations;
this.aliasKey = aliasKey;
this.ledgerId = ledgerId;
this.ethereumNonce = ethereumNonce;
this.hbarAllowances = Collections.emptyList();
this.tokenAllowances = Collections.emptyList();
this.tokenNftAllowances = Collections.emptyList();
this.stakingInfo = stakingInfo;
}
/**
* Retrieve the account info from a protobuf.
*
* @param accountInfo the account info protobuf
* @return the account info object
*/
static AccountInfo fromProtobuf(CryptoGetInfoResponse.AccountInfo accountInfo) {
var accountId = AccountId.fromProtobuf(accountInfo.getAccountID());
var proxyAccountId = accountInfo.getProxyAccountID().getAccountNum() > 0
? AccountId.fromProtobuf(accountInfo.getProxyAccountID())
: null;
var liveHashes = J8Arrays.stream(accountInfo.getLiveHashesList().toArray())
.map((liveHash) -> LiveHash.fromProtobuf((com.hedera.hashgraph.sdk.proto.LiveHash) liveHash))
.collect(Collectors.toList());
Map relationships = new HashMap<>();
for (com.hedera.hashgraph.sdk.proto.TokenRelationship relationship : accountInfo.getTokenRelationshipsList()) {
TokenId tokenId = TokenId.fromProtobuf(relationship.getTokenId());
relationships.put(tokenId, TokenRelationship.fromProtobuf(relationship));
}
@Nullable
var aliasKey = PublicKey.fromAliasBytes(accountInfo.getAlias());
return new AccountInfo(
accountId,
accountInfo.getContractAccountID(),
accountInfo.getDeleted(),
proxyAccountId,
accountInfo.getProxyReceived(),
Key.fromProtobufKey(accountInfo.getKey()),
accountInfo.getBalance(),
accountInfo.getGenerateSendRecordThreshold(),
accountInfo.getGenerateReceiveRecordThreshold(),
accountInfo.getReceiverSigRequired(),
InstantConverter.fromProtobuf(accountInfo.getExpirationTime()),
DurationConverter.fromProtobuf(accountInfo.getAutoRenewPeriod()),
liveHashes,
relationships,
accountInfo.getMemo(),
accountInfo.getOwnedNfts(),
accountInfo.getMaxAutomaticTokenAssociations(),
aliasKey,
LedgerId.fromByteString(accountInfo.getLedgerId()),
accountInfo.getEthereumNonce(),
accountInfo.hasStakingInfo() ? StakingInfo.fromProtobuf(accountInfo.getStakingInfo()) : null
);
}
/**
* Retrieve the account info from a protobuf byte array.
*
* @param bytes a byte array representing the protobuf
* @return the account info object
* @throws InvalidProtocolBufferException when there is an issue with the protobuf
*/
public static AccountInfo fromBytes(byte[] bytes) throws InvalidProtocolBufferException {
return fromProtobuf(CryptoGetInfoResponse.AccountInfo.parseFrom(bytes).toBuilder().build());
}
/**
* Convert an account info object into a protobuf.
*
* @return the protobuf object
*/
CryptoGetInfoResponse.AccountInfo toProtobuf() {
var hashes = J8Arrays.stream(liveHashes.toArray())
.map((liveHash) -> ((LiveHash) liveHash).toProtobuf())
.collect(Collectors.toList());
var accountInfoBuilder = CryptoGetInfoResponse.AccountInfo.newBuilder()
.setAccountID(accountId.toProtobuf())
.setDeleted(isDeleted)
.setProxyReceived(proxyReceived.toTinybars())
.setKey(key.toProtobufKey())
.setBalance(balance.toTinybars())
.setGenerateSendRecordThreshold(sendRecordThreshold.toTinybars())
.setGenerateReceiveRecordThreshold(receiveRecordThreshold.toTinybars())
.setReceiverSigRequired(isReceiverSignatureRequired)
.setExpirationTime(InstantConverter.toProtobuf(expirationTime))
.setAutoRenewPeriod(DurationConverter.toProtobuf(autoRenewPeriod))
.addAllLiveHashes(hashes)
.setMemo(accountMemo)
.setOwnedNfts(ownedNfts)
.setMaxAutomaticTokenAssociations(maxAutomaticTokenAssociations)
.setLedgerId(ledgerId.toByteString())
.setEthereumNonce(ethereumNonce);
if (contractAccountId != null) {
accountInfoBuilder.setContractAccountID(contractAccountId);
}
if (proxyAccountId != null) {
accountInfoBuilder.setProxyAccountID(proxyAccountId.toProtobuf());
}
if (aliasKey != null) {
accountInfoBuilder.setAlias(aliasKey.toProtobufKey().toByteString());
}
if (stakingInfo != null) {
accountInfoBuilder.setStakingInfo(stakingInfo.toProtobuf());
}
return accountInfoBuilder.build();
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("accountId", accountId)
.add("contractAccountId", contractAccountId)
.add("deleted", isDeleted)
.add("proxyAccountId", proxyAccountId)
.add("proxyReceived", proxyReceived)
.add("key", key)
.add("balance", balance)
.add("sendRecordThreshold", sendRecordThreshold)
.add("receiveRecordThreshold", receiveRecordThreshold)
.add("receiverSignatureRequired", isReceiverSignatureRequired)
.add("expirationTime", expirationTime)
.add("autoRenewPeriod", autoRenewPeriod)
.add("liveHashes", liveHashes)
.add("tokenRelationships", tokenRelationships)
.add("accountMemo", accountMemo)
.add("ownedNfts", ownedNfts)
.add("maxAutomaticTokenAssociations", maxAutomaticTokenAssociations)
.add("aliasKey", aliasKey)
.add("ledgerId", ledgerId)
.add("ethereumNonce", ethereumNonce)
.add("stakingInfo", stakingInfo)
.toString();
}
/**
* Extract a byte array representation.
*
* @return a byte array representation
*/
public byte[] toBytes() {
return toProtobuf().toByteArray();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy