Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Interface CryptoCreateTransactionBodyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
CryptoCreateTransactionBody, CryptoCreateTransactionBody.Builder
@Generated public interface CryptoCreateTransactionBodyOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.ByteString
    getAlias()
    * Bytes to be used as the account's alias.
    Duration
    getAutoRenewPeriod()
    * The duration between account automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger.
    boolean
    getDeclineReward()
    * A boolean indicating that this account has chosen to decline rewards for staking its balances.
    com.google.protobuf.ByteString
    getDelegationAddress()
    * The initial delegated contract address to set for the new account.
    HookCreationDetails
    getHookCreationDetails(int index)
    * Details of hooks to add immediately after creating this account.
    int
    getHookCreationDetailsCount()
    * Details of hooks to add immediately after creating this account.
    List<HookCreationDetails>
    getHookCreationDetailsList()
    * Details of hooks to add immediately after creating this account.
    long
    getInitialBalance()
    * An amount, in tinybar, to deposit to the newly created account.
    Key
    getKey()
    * The identifying key for this account.
    int
    getMaxAutomaticTokenAssociations()
    * A maximum number of tokens that can be auto-associated with this account.<br/> By default this value is 0 for all accounts except for automatically created accounts (e.g.
    String
    getMemo()
    * A short description of this Account.
    com.google.protobuf.ByteString
    getMemoBytes()
    * A short description of this Account.
    Key
    getNewRealmAdminKey()
    Deprecated.
    proto.CryptoCreateTransactionBody.newRealmAdminKey is deprecated.
    AccountID
    getProxyAccountID()
    Deprecated.
    proto.CryptoCreateTransactionBody.proxyAccountID is deprecated.
    RealmID
    getRealmID()
    * The realm in which this account is created.
    long
    getReceiveRecordThreshold()
    Deprecated.
    proto.CryptoCreateTransactionBody.receiveRecordThreshold is deprecated.
    boolean
    getReceiverSigRequired()
    * A flag indicating the account holder must authorize all incoming token transfers.
    long
    getSendRecordThreshold()
    Deprecated.
    proto.CryptoCreateTransactionBody.sendRecordThreshold is deprecated.
    ShardID
    getShardID()
    * The shard in which this account is created <p> Currently, this MUST be `0`.<br/> If the desired shard is `0`, this SHOULD NOT be set.
    AccountID
    getStakedAccountId()
    * ID of the account to which this account is staking its balances.
    CryptoCreateTransactionBody.StakedIdCase
    getStakedIdCase()
     
    long
    getStakedNodeId()
    * ID of the node this account is staked to.
    boolean
    hasAutoRenewPeriod()
    * The duration between account automatic renewals.<br/> All entities in state may be charged "rent" occasionally (typically every 90 days) to prevent unnecessary growth of the ledger.
    boolean
    hasKey()
    * The identifying key for this account.
    boolean
    hasNewRealmAdminKey()
    Deprecated.
    proto.CryptoCreateTransactionBody.newRealmAdminKey is deprecated.
    boolean
    hasProxyAccountID()
    Deprecated.
    proto.CryptoCreateTransactionBody.proxyAccountID is deprecated.
    boolean
    hasRealmID()
    * The realm in which this account is created.
    boolean
    hasShardID()
    * The shard in which this account is created <p> Currently, this MUST be `0`.<br/> If the desired shard is `0`, this SHOULD NOT be set.
    boolean
    hasStakedAccountId()
    * ID of the account to which this account is staking its balances.
    boolean
    hasStakedNodeId()
    * ID of the node this account is staked to.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • hasKey

      boolean hasKey()
       *
 The identifying key for this account.
 This key represents the account owner, and is required for most actions
 involving this account that do not modify the account itself. This key
 may also identify the account for smart contracts.
 <p>
 This field is REQUIRED.
 This `Key` MUST NOT be an empty `KeyList` and MUST contain at least one
 "primitive" (i.e. cryptographic) key value.
      .proto.Key key = 1;
      Returns:
      Whether the key field is set.

    • getKey

      Key getKey()
       *
 The identifying key for this account.
 This key represents the account owner, and is required for most actions
 involving this account that do not modify the account itself. This key
 may also identify the account for smart contracts.
 <p>
 This field is REQUIRED.
 This `Key` MUST NOT be an empty `KeyList` and MUST contain at least one
 "primitive" (i.e. cryptographic) key value.
      .proto.Key key = 1;
      Returns:
      The key.

    • getInitialBalance

      long getInitialBalance()
       *
 An amount, in tinybar, to deposit to the newly created account.
 <p>
 The deposited amount SHALL be debited to the "payer" account for this
 transaction.
      uint64 initialBalance = 2;
      Returns:
      The initialBalance.

    • hasProxyAccountID

      @Deprecated boolean hasProxyAccountID()
      Deprecated.
      proto.CryptoCreateTransactionBody.proxyAccountID is deprecated. See crypto_create.proto;l=63
       *
 Use `staked_id` instead.<br/>
 An account identifier for a staking proxy.
      .proto.AccountID proxyAccountID = 3 [deprecated = true];
      Returns:
      Whether the proxyAccountID field is set.

    • getProxyAccountID

      @Deprecated AccountID getProxyAccountID()
      Deprecated.
      proto.CryptoCreateTransactionBody.proxyAccountID is deprecated. See crypto_create.proto;l=63
       *
 Use `staked_id` instead.<br/>
 An account identifier for a staking proxy.
      .proto.AccountID proxyAccountID = 3 [deprecated = true];
      Returns:
      The proxyAccountID.

    • getSendRecordThreshold

      @Deprecated long getSendRecordThreshold()
      Deprecated.
      proto.CryptoCreateTransactionBody.sendRecordThreshold is deprecated. See crypto_create.proto;l=71
       *
 Removed prior to the first available history, and may be related to an
 early design dead-end.<br/>
 An amount below which record stream records would not be created for
 a transaction that reduces this account balance.
      uint64 sendRecordThreshold = 6 [deprecated = true];
      Returns:
      The sendRecordThreshold.

    • getReceiveRecordThreshold

      @Deprecated long getReceiveRecordThreshold()
      Deprecated.
      proto.CryptoCreateTransactionBody.receiveRecordThreshold is deprecated. See crypto_create.proto;l=79
       *
 Removed prior to the first available history, and may be related to an
 early design dead-end.<br/>
 An amount below which record stream records would not be created for
 a transaction that increases this account balance.
      uint64 receiveRecordThreshold = 7 [deprecated = true];
      Returns:
      The receiveRecordThreshold.

    • getReceiverSigRequired

      boolean getReceiverSigRequired()
       *
 A flag indicating the account holder must authorize all incoming
 token transfers.
 <p>
 If this flag is set then any transaction that would result in adding
 hbar or other tokens to this account balance MUST be signed by the
 identifying key of this account (that is, the `key` field).<br/>
 If this flag is set, then the account key (`key` field) MUST sign
 this create transaction, in addition to the transaction payer.
      bool receiverSigRequired = 8;
      Returns:
      The receiverSigRequired.

    • hasAutoRenewPeriod

      boolean hasAutoRenewPeriod()
       *
 The duration between account automatic renewals.<br/>
 All entities in state may be charged "rent" occasionally (typically
 every 90 days) to prevent unnecessary growth of the ledger. This value
 sets the interval between such events for this account.
 <p>
 If the account balance (in HBAR) is insufficient to pay the full renewal
 fee, the entire HBAR balance SHALL be consumed and the expiration for
 the account SHALL be extended as far as the available balance can
 support.<br/>
 If the account HBAR balance is `0` when the account must be renewed, then
 the account SHALL be deleted, and subsequently removed from state.
      .proto.Duration autoRenewPeriod = 9;
      Returns:
      Whether the autoRenewPeriod field is set.

    • getAutoRenewPeriod

      Duration getAutoRenewPeriod()
       *
 The duration between account automatic renewals.<br/>
 All entities in state may be charged "rent" occasionally (typically
 every 90 days) to prevent unnecessary growth of the ledger. This value
 sets the interval between such events for this account.
 <p>
 If the account balance (in HBAR) is insufficient to pay the full renewal
 fee, the entire HBAR balance SHALL be consumed and the expiration for
 the account SHALL be extended as far as the available balance can
 support.<br/>
 If the account HBAR balance is `0` when the account must be renewed, then
 the account SHALL be deleted, and subsequently removed from state.
      .proto.Duration autoRenewPeriod = 9;
      Returns:
      The autoRenewPeriod.

    • hasShardID

      boolean hasShardID()
       *
 The shard in which this account is created
 <p>
 Currently, this MUST be `0`.<br/>
 If the desired shard is `0`, this SHOULD NOT be set.
      .proto.ShardID shardID = 10;
      Returns:
      Whether the shardID field is set.

    • getShardID

      ShardID getShardID()
       *
 The shard in which this account is created
 <p>
 Currently, this MUST be `0`.<br/>
 If the desired shard is `0`, this SHOULD NOT be set.
      .proto.ShardID shardID = 10;
      Returns:
      The shardID.

    • hasRealmID

      boolean hasRealmID()
       *
 The realm in which this account is created.
 <p>
 The shard number for this realm MUST match the value in `shardID`.<br/>
 Currently, this MUST be `0` for both fields.<br/>
 If the desired realm is `0`, this SHOULD NOT be set.
      .proto.RealmID realmID = 11;
      Returns:
      Whether the realmID field is set.

    • getRealmID

      RealmID getRealmID()
       *
 The realm in which this account is created.
 <p>
 The shard number for this realm MUST match the value in `shardID`.<br/>
 Currently, this MUST be `0` for both fields.<br/>
 If the desired realm is `0`, this SHOULD NOT be set.
      .proto.RealmID realmID = 11;
      Returns:
      The realmID.

    • hasNewRealmAdminKey

      @Deprecated boolean hasNewRealmAdminKey()
      Deprecated.
      proto.CryptoCreateTransactionBody.newRealmAdminKey is deprecated. See crypto_create.proto;l=129
       *
 This field was never actually used or enabled, and is not expected to
 ever be used in the future.<br/>
      .proto.Key newRealmAdminKey = 12 [deprecated = true];
      Returns:
      Whether the newRealmAdminKey field is set.

    • getNewRealmAdminKey

      @Deprecated Key getNewRealmAdminKey()
      Deprecated.
      proto.CryptoCreateTransactionBody.newRealmAdminKey is deprecated. See crypto_create.proto;l=129
       *
 This field was never actually used or enabled, and is not expected to
 ever be used in the future.<br/>
      .proto.Key newRealmAdminKey = 12 [deprecated = true];
      Returns:
      The newRealmAdminKey.

    • getMemo

      String getMemo()
       *
 A short description of this Account.
 <p>
 This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes`
 (default 100) bytes when encoded as UTF-8.
      string memo = 13;
      Returns:
      The memo.

    • getMemoBytes

      com.google.protobuf.ByteString getMemoBytes()
       *
 A short description of this Account.
 <p>
 This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes`
 (default 100) bytes when encoded as UTF-8.
      string memo = 13;
      Returns:
      The bytes for memo.

    • getMaxAutomaticTokenAssociations

      int getMaxAutomaticTokenAssociations()
       *
 A maximum number of tokens that can be auto-associated
 with this account.<br/>
 By default this value is 0 for all accounts except for automatically
 created accounts (e.g. smart contracts), which default to -1.
 <p>
 If this value is `0`, then this account MUST manually associate to
 a token before holding or transacting in that token.<br/>
 This value MAY also be `-1` to indicate no limit.<br/>
 This value MUST NOT be less than `-1`.
      int32 max_automatic_token_associations = 14;
      Returns:
      The maxAutomaticTokenAssociations.

    • hasStakedAccountId

      boolean hasStakedAccountId()
       *
 ID of the account to which this account is staking its balances.
 <p>
 If this account is not currently staking its balances, then this
 field, if set, MUST be the sentinel value of `0.0.0`.
      .proto.AccountID staked_account_id = 15;
      Returns:
      Whether the stakedAccountId field is set.

    • getStakedAccountId

      AccountID getStakedAccountId()
       *
 ID of the account to which this account is staking its balances.
 <p>
 If this account is not currently staking its balances, then this
 field, if set, MUST be the sentinel value of `0.0.0`.
      .proto.AccountID staked_account_id = 15;
      Returns:
      The stakedAccountId.

    • hasStakedNodeId

      boolean hasStakedNodeId()
       *
 ID of the node this account is staked to.
 <p>
 If this account is not currently staking its balances, then this
 field, if set, SHALL be the sentinel value of `-1`.<br/>
 Wallet software SHOULD surface staking issues to users and provide a
 simple mechanism to update staking to a new node ID in the event the
 prior staked node ID ceases to be valid.
      int64 staked_node_id = 16;
      Returns:
      Whether the stakedNodeId field is set.

    • getStakedNodeId

      long getStakedNodeId()
       *
 ID of the node this account is staked to.
 <p>
 If this account is not currently staking its balances, then this
 field, if set, SHALL be the sentinel value of `-1`.<br/>
 Wallet software SHOULD surface staking issues to users and provide a
 simple mechanism to update staking to a new node ID in the event the
 prior staked node ID ceases to be valid.
      int64 staked_node_id = 16;
      Returns:
      The stakedNodeId.

    • getDeclineReward

      boolean getDeclineReward()
       *
 A boolean indicating that this account has chosen to decline rewards for
 staking its balances.
 <p>
 This account MAY still stake its balances, but SHALL NOT receive reward
 payments for doing so, if this value is set.
      bool decline_reward = 17;
      Returns:
      The declineReward.

    • getAlias

      com.google.protobuf.ByteString getAlias()
       *
 Bytes to be used as the account's alias.
 <p>
 This value, if set, MUST be one of the following values<br/>
 <ul>
 <li>The 32-byte serialized form of the ED25519 account key.</li>
 <li>The 33-byte _compressed_ serialized form of the ECDSA(secp256k1)
 account key.</li>
 <li>The 20-byte EVM address derived from a keccak-256 hash of the
 ECDSA(secp256k1) account key</li>
 </ul>
 All aliases within the network MUST be unique. If this value matches an
 existing account alias, this `create` transaction SHALL fail.<br/>
 If an account exists with a particular alias value, any transaction to
 transfer value _to_ that alias SHALL deposit the transferred value in
 the existing account, and SHALL NOT assess an account creation fee.<br/>
 Once set, an account alias is immutable and MUST NOT be changed.
      bytes alias = 18;
      Returns:
      The alias.

    • getHookCreationDetailsList

      List<HookCreationDetails> getHookCreationDetailsList()
       *
 Details of hooks to add immediately after creating this account.
      repeated .com.hedera.hapi.node.hooks.HookCreationDetails hook_creation_details = 19;

    • getHookCreationDetails

      HookCreationDetails getHookCreationDetails(int index)
       *
 Details of hooks to add immediately after creating this account.
      repeated .com.hedera.hapi.node.hooks.HookCreationDetails hook_creation_details = 19;

    • getHookCreationDetailsCount

      int getHookCreationDetailsCount()
       *
 Details of hooks to add immediately after creating this account.
      repeated .com.hedera.hapi.node.hooks.HookCreationDetails hook_creation_details = 19;

    • getDelegationAddress

      com.google.protobuf.ByteString getDelegationAddress()
       *
 The initial delegated contract address to set for the new account.
 <p>
 If set, the value MUST be 20 bytes long (EVM address).
 A value of `0x0000000000000000000000000000000000000000` will be ignored.

 If this field is set on the account, anytime a call is made to the account's address
 (either an EVM call within HSCS or a child call dispatched by CryptoTransfer)
 the EVM code of the contract referenced by `delegation_address` will be
 executed in the context of the account.
      bytes delegation_address = 20;
      Returns:
      The delegationAddress.

    • getStakedIdCase

      CryptoCreateTransactionBody.StakedIdCase getStakedIdCase()