package
2.54.0
Repository: https://github.com/hiero-ledger/hiero-sdk-go.git
Documentation: pkg.go.dev

# Functions

AccountIDFromBytes converts wire-format encoding to Account ID.
AccountIDFromEvmAddress constructs an AccountID from a string formatted as 0.0.<evm address>.
Returns an AccountID with EvmPublic address for the use of HIP-583.
AccountIDFromSolidityAddress constructs an AccountID from a string representation of a _Solidity address.
AccountIDFromString constructs an AccountID from a string formatted as `Shard.Realm.Account` (for example "0.0.3").
AccountInfoFlowVerifySignature Verifies signature using AccountInfoQuery.
AccountInfoFlowVerifyTransaction Verifies transaction using AccountInfoQuery.
AccountInfoFromBytes returns an AccountInfo from byte array.
AssessedCustomFeeFromBytes returns a AssessedCustomFee from bytes.
BytesToAddress converts bytes to an address object.
ClientForMainnet returns a preconfigured client for use with the standard Hiero mainnet.
ClientForMirrorNetwork constructs a client given a set of mirror network nodes.
ClientForName set up the client for the selected network.
ClientForNetwork constructs a client given a set of nodes.
ClientForPreviewnet returns a preconfigured client for use with the standard Hiero previewnet.
ClientForTestnet returns a preconfigured client for use with the standard Hiero testnet.
ClientFromConfig takes in the byte slice representation of a JSON string or document and returns Client based on the configuration.
ClientFromConfigFile takes a filename string representing the path to a JSON encoded Client file and returns a Client based on the configuration.
ClientFromConfigWithoutScheduleNetworkUpdate does not schedule network update the user has to call SetNetworkUpdatePeriod manually.
No description provided by the author
ContractFunctionResultFromBytes returns a ContractFunctionResult from the protobuf encoded bytes of a ContractFunctionResult.
ContractIDFromBytes returns a ContractID generated from a byte array.
ContractIDFromEvmAddress constructs a ContractID from a string representation of an EVM address.
ContractIDFromSolidityAddress constructs a ContractID from a string representation of a _Solidity address Does not populate ContractID.EvmAddress Deprecated.
ContractIDFromString constructs a ContractID from a string formatted as `Shard.Realm.Contract` (for example "0.0.3").
ContractInfoFromBytes returns a ContractInfo object deserialized from bytes.
CustomFeeFromBytes returns a CustomFee from a raw protobuf byte array.
Decode decodes the input with a given type.
DecodeStruct decodes the input with a type to a struct.
DelegatableContractIDFromBytes returns a DelegatableContractID generated from a byte array.
DelegatableContractIDFromEvmAddress constructs a DelegatableContractID from a string representation of a _Solidity address.
DelegatableContractIDFromSolidityAddress constructs a DelegatableContractID from a string representation of a _Solidity address Does not populate DelegatableContractID.EvmAddress.
DelegatableContractIDFromString constructs a DelegatableContractID from a string formatted as `Shard.Realm.Contract` (for example "0.0.3").
Encode encodes a value.
No description provided by the author
FromBytes decodes the RLP encoded bytes into an EthereumEIP1559Transaction.
FromBytes decodes the RLP encoded bytes into an EthereumLegacyTransaction.
EthereumTransactionDataFromBytes constructs an EthereumTransactionData from a raw byte array.
ExchangeRateFromString returns an ExchangeRate from a string representation of the exchange rate.
FeeComponentsFromBytes returns the FeeComponents from a byte array representation.
FeeDataFromBytes returns a FeeData struct from a raw byte array.
FeeScheduleFromBytes returns a FeeSchedule from a raw protobuf byte array.
FeeSchedulesFromBytes returns a FeeSchedules object from a raw byte array.
FileIDForAddressBook returns the public node address book for the current network.
FileIDForExchangeRate returns the current exchange rates of HBAR to USD.
FileIDForFeeSchedule returns the current fee schedule for the network.
FileIDFromBytes returns a FileID from a byte array.
FileIDFromSolidityAddress returns a FileID parsed from the given solidity address.
FileIDFromString returns a FileID parsed from the given string.
FileInfoFromBytes returns a FileInfo object from a raw byte array.
FillBytes fills a byte slice with the absolute value of a big integer in big-endian order.
GenerateMnemonic12 generates a random 12-word mnemonic.
GenerateMnemonic generates a random 24-word mnemonic.
Deprecated.
HbarFrom creates a representation of Hbar in tinybar on the unit provided.
HbarFromString returns a Hbar representation of the string provided.
HbarFromTinybar creates a representation of Hbar in tinybars.
Check if the index is hardened.
No description provided by the author
No description provided by the author
NewKeyListWithThreshold creates a new KeyList with the given threshold.
No description provided by the author
LedgerIDFromBytes returns a LedgerID from a byte representation of a ledger ID.
LedgerIDFromNetworkName returns a LedgerID from a NetworkName.
LedgerIDFromString returns a LedgerID from a string representation of a ledger ID.
LiveHashFromBytes returns a LiveHash object from a raw byte array.
MnemonicFromString creates a mnemonic from a string of 24 words separated by spaces Keys are lazily generated.
Deprecated.
NetworkVersionInfoFromBytes returns the NetworkVersionInfo from a raw byte array.
NewABI returns a parsed ABI struct.
nolint.
NewABIFromReader returns an ABI object from a reader.
NewAccountAllowanceApproveTransaction Creates an AccountAloowanceApproveTransaction which creates one or more hbar/token approved allowances relative to the owner account specified in the allowances of tx transaction.
NewAccountAllowanceDeleteTransaction Creates AccountAllowanceDeleteTransaction whoch deletes one or more non-fungible approved allowances from an owner's account.
NewAccountBalanceQuery creates an AccountBalanceQuery query which can be used to construct and execute an AccountBalanceQuery.
NewAccountCreateTransaction creates an AccountCreateTransaction transaction which can be used to construct and execute a Crypto Create Transaction.
NewAccountDeleteTransaction creates AccountDeleteTransaction which marks an account as deleted, moving all its current hbars to another account.
NewAccountInfoQuery Creates an AccountInfoQuery which retrieves all the information about an account, including the balance.
NewAccountRecordsQuery creates an AccountRecordsQuery Query which can be used to construct and execute an AccountRecordsQuery.
NewAccountStakersQuery creates an AccountStakersQuery query which can be used to construct and execute an AccountStakersQuery.
NewAccountUpdateTransaction Creates AccoutnUppdateTransaction which changes properties for the given account.
Query the mirror node for the address book.
NewContractBytecodeQuery creates a ContractBytecodeQuery query which can be used to construct and execute a Contract Get Bytecode Query.
NewContractCallQuery creates a ContractCallQuery query which can be used to construct and execute a Contract Call Local Query.
NewContractCreateFlow creates a new ContractCreateFlow transaction builder object.
NewContractCreateTransaction creates ContractCreateTransaction which is used to start a new smart contract instance.
NewContractDeleteTransaction creates ContractDeleteTransaction which marks a contract as deleted and transfers its remaining hBars, if any, to a designated receiver.
NewContractExecuteTransaction creates a ContractExecuteTransaction transaction which can be used to construct and execute a Contract Call Transaction.
Builder for encoding parameters for a Solidity contract constructor/function call.
NewContractFunctionSelector starts building a selector for a function with a given name.
NewContractInfoQuery creates a ContractInfoQuery query which can be used to construct and execute a Contract Get Info Query.
NewContractUpdateTransaction creates a ContractUpdateTransaction transaction which can be used to construct and execute a Contract Update Transaction.
A fixed fee transfers a specified amount of the token, to the specified collection account(s), each time a token transfer is initiated.
A fractional fee transfers the specified fraction of the total value of the tokens that are being transferred to the specified fee-collecting account.
A royalty fee is a fractional fee that is assessed each time the ownership of an NFT is transferred from person A to person B.
NewError creates a new solidity error object.
nolint NewEthereumEIP1559Transaction creates a new EthereumEIP1559Transaction with the provided fields.
Execute an Ethereum transaction on Hiero.
nolint NewEthereumLegacyTransaction creates a new EthereumLegacyTransaction with the provided fields.
NewEthereumTransaction creates a EthereumTransaction transaction which can be used to construct and execute a Ethereum Transaction.
NewEvent creates a new solidity event object using the signature.
NewEventFromType creates a new solidity event object using the name and type.
NewFileAppendTransaction creates a FileAppendTransaction transaction which can be used to construct and execute a File Append Transaction.
NewFileContentsQuery creates a FileContentsQuery which retrieves the contents of a file.
NewFileCreateTransaction creates a FileCreateTransaction which creates a new file, containing the given contents.
NewFileDeleteTransaction creates a FileDeleteTransaction which deletes the given file.
NewFileInfoQuery creates a FileInfoQuery which can be used to get all of the information about a file, except for its contents.
NewFileUpdateTransaction creates a FileUpdateTransaction which modifies the metadata and/or contents of a file.
No description provided by the author
NewHbar constructs a new Hbar from a possibly fractional amount of hbar.
NewHbarAllowance creates a new HbarAllowance with the given owner, spender, and amount.
NewKeyList creates a new KeyList with no threshold.
LedgerIDMainnet returns a LedgerID for mainnet.
LedgerIDPreviewnet returns a LedgerID for previewnet.
LedgerIDTestnet returns a LedgerID for testnet.
NewLiveHashAddTransaction creates LiveHashAddTransaction which at consensus, attaches the given livehash to the given account.
NewLiveHashDeleteTransaction creates LiveHashDeleteTransaction which at consensus, deletes a livehash associated to the given account.
NewLiveHashQuery creates a LiveHashQuery that requests a livehash associated to an account.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewMnemonic Creates a mnemonic from a slice of 24 strings Keys are lazily generated.
NewNetworkVersionQuery creates a NetworkVersionInfoQuery builder which can be used to construct and execute a Network Get Version Info Query containing the current version of the network's protobuf and services.
No description provided by the author
No description provided by the author
No description provided by the author
NewPrngTransaction creates a PrngTransaction transaction which can be used to construct and execute a Prng Transaction.
NewRLPItem creates a new RLP item.
NewScheduleCreateTransaction creates ScheduleCreateTransaction which creates a new schedule entity (or simply, schedule) in the network's action queue.
NewScheduleDeleteTransaction creates ScheduleDeleteTransaction which marks a schedule in the network's action queue as deleted.
NewScheduleInfoQuery creates ScheduleInfoQuery which gets information about a schedule in the network's action queue.
NewScheduleSignTransaction creates ScheduleSignTransaction which adds zero or more signing keys to a schedule.
NewSystemDeleteTransaction creates a SystemDeleteTransaction transaction which can be used to construct and execute a System Delete Transaction.
NewSystemUndeleteTransaction creates a SystemUndeleteTransaction transaction which can be used to construct and execute a System Undelete Transaction.
No description provided by the author
NewTokenAllowance creates a TokenAllowance with the given tokenID, owner, spender, and amount.
NewTokenAssociateTransaction creates TokenAssociateTransaction which associates the provided account with the provided tokens.
NewTokenBurnTransaction creates TokenBurnTransaction which burns tokens from the Token's treasury Account.
No description provided by the author
No description provided by the author
NewTokenCreateTransaction creates TokenCreateTransaction which creates a new token.
NewTokenDeleteTransaction creates TokenDeleteTransaction which marks a token as deleted, though it will remain in the ledger.
NewTokenDissociateTransaction creates TokenDissociateTransaction which dissociates the provided account with the provided tokens.
NewTokenFeeScheduleUpdateTransaction creates TokenFeeScheduleUpdateTransaction which at consensus, updates a token type's fee schedule to the given list of custom fees.
NewTokenFreezeTransaction creates TokenFreezeTransaction which freezes transfers of the specified token for the account.
NewTokenGrantKycTransaction creates TokenGrantKycTransaction which grants KYC to the account for the given token.
NewTokenInfoQuery creates a TokenInfoQuery which is used get information about Token instance.
NewTokenMintTransaction creates TokenMintTransaction which mints tokens from the Token's treasury Account.
NewTokenNftAllowance creates a TokenNftAllowance delegate for the given tokenID, owner, spender, serialNumbers, approvedForAll, and delegatingSpender.
NewTokenNftInfoQuery creates TokenNftInfoQuery which gets info on a NFT for a given TokenID (of type NON_FUNGIBLE_UNIQUE) and serial number Applicable only to tokens of type NON_FUNGIBLE_UNIQUE.
NewTokenPauseTransaction creates TokenPauseTransaction which pauses the Token from being involved in any kind of Transaction until it is unpaused.
No description provided by the author
No description provided by the author
NewTokenRevokeKycTransaction creates TokenRevokeKycTransaction which revokes KYC to the account for the given token.
NewTokenTransfer creates a TokenTransfer with the given accountID and amount.
NewTokenUnfreezeTransaction creates TokenUnfreezeTransaction which unfreezes transfers of the specified token for the account.
NewTokenUnpauseTransaction creates TokenUnpauseTransaction which unpauses the Token.
No description provided by the author
NewTokenUpdateTransaction creates TokenUpdateTransaction which at consensus, updates an already created token to the given values.
NewTokenWipeTransaction creates TokenWipeTransaction which wipes the provided amount of tokens from the specified Account.
NewTopicCreateTransaction creates a TopicCreateTransaction transaction which can be used to construct and execute a Create Topic Transaction.
NewTopicDeleteTransaction creates a TopicDeleteTransaction which can be used to construct and execute a Consensus Delete Topic Transaction.
NewTopicInfoQuery creates a TopicInfoQuery query which can be used to construct and execute a Get Topic Info Query.
NewTopicMessageQuery creates TopicMessageQuery which listens to messages sent to the specific TopicID.
NewTopicMessageSubmitTransaction createsTopicMessageSubmitTransaction which sends a message/messages to the Topic ID.
NewTopicUpdateTransaction creates a TopicUpdateTransaction transaction which updates all fields on a Topic that are set in the transaction.
NewTransactionIDWithValidStart constructs a new Transaction id struct with the provided AccountID and the valid start time set to a provided time.
NewTransactionReceiptQuery creates TransactionReceiptQuery which gets the receipt of a transaction, given its transaction ID.
NewTransactionRecordQuery creates TransactionRecordQuery which gets the record for a transaction.
NewTransferTransaction creates TransferTransaction which transfers cryptocurrency among two or more accounts by making the desired adjustments to their balances.
No description provided by the author
No description provided by the author
NewType parses a type in string format.
NewTypeFromArgument parses an abi type from an argument.
NftIDFromBytes returns the NftID from a raw byte array.
NewNftID constructs a new NftID from a TokenID and a serial number.
TokenNftTransfersFromBytes returns the TokenNftTransfer from a raw protobuf bytes representation.
NodeAddressBookFromBytes returns the NodeAddressBook from a raw byte array.
PowerOfBig computes a^b as a big integer.
Deprecated the use of raw bytes for a Ed25519 private key is deprecated; use PrivateKeyFromBytesEd25519() instead.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated PrivateKeyFromMnemonic recovers an _Ed25519PrivateKey from a valid 24 word length mnemonic phrase and a passphrase.
No description provided by the author
No description provided by the author
No description provided by the author
The use of raw bytes for a Ed25519 private key is deprecated; use PrivateKeyFromStringEd25519() instead.
PrivateKeyFromStringDer Creates PrivateKey from hex string with a der prefix.
No description provided by the author
Deprecated: use PrivateKeyFromStringECDSA() instead.
No description provided by the author
Deprecated: use `PrivateKeyGenerateEd25519()` instead.
PrivateKeyGenerateEcdsa Generates a new ECDSASecp256K1 key.
PrivateKeyGenerateEd25519 Generates a new Ed25519 key.
PrivateKeyReadKeystore recovers an _Ed25519PrivateKey from an encrypted _Keystore file.
No description provided by the author
Deprecated the use of raw bytes for a Ed25519 private key is deprecated; use PublicKeyFromBytesEd25519() instead.
No description provided by the author
No description provided by the author
No description provided by the author
The use of raw bytes for a Ed25519 public key is deprecated; use PublicKeyFromStringEd25519/ECDSA() instead.
No description provided by the author
No description provided by the author
ScheduleIDFromString constructs an ScheduleID from a string formatted as `Shard.Realm.Account` (for example "0.0.3").
StakingInfoFromBytes returns a StakingInfo object from a raw byte array.
StorageChangeFromBytes returns a StorageChange from a byte array.
To256Bit truncates the input number to a 256-bit two's complement.
To256BitBytes converts a big integer into a 32-byte slice in big-endian order.
Harden the index.
TokenAssociationFromBytes returns a TokenAssociation from a raw protobuf byte array.
TokenIDFromBytes returns a TokenID from a byte array.
TokenIDFromSolidityAddress constructs a TokenID from a string representation of a _Solidity address.
TokenIDFromString constructs an TokenID from a string formatted as `Shard.Realm.TokenID` (for example "0.0.3").
TokenInfoFromBytes returns a TokenInfo struct from a raw protobuf byte array.
TokenNftInfoFromBytes returns the TokenNftInfo from a byte array representation.
No description provided by the author
TokenTransferFromBytes returns a TokenTransfer struct from a protobuf encoded byte array.
ToPaddedBytes converts a big integer into a byte slice in big-endian order, ensuring the slice is at least n bytes long.
TopicIDFromBytes constructs a TopicID from a byte array.
TopicIDFromSolidityAddress constructs an TopicID from a string representation of a _Solidity address.
TopicIDFromString constructs a TopicID from a string formatted as `Shard.Realm.Topic` (for example "0.0.3").
TopicInfoFromBytes returns a TopicInfo object from a byte array.
ToSigned256 converts the input number to its 256-bit two's complement signed representation.
No description provided by the author
No description provided by the author
No description provided by the author
TransactionFromBytes converts transaction bytes to a related *transaction.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TransactionIDFromBytes constructs a TransactionID from a byte array.
TransactionIDFromString constructs a TransactionID from a string representation.
NewTransactionID constructs a new Transaction id struct with the provided AccountID and the valid start time set to the current time - 10 seconds.
TransactionReceiptFromBytes returns the receipt from the byte representation.
TransactionRecordFromBytes returns a TransactionRecord from a raw protobuf byte array.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * SDK needs to provide a way to set an unusable key such as an Ed25519 all-zeros * key, since it is (presumably) impossible to find the 32-byte string whose SHA-512 hash begins with 32 bytes * of zeros.

# Constants

No description provided by the author
No description provided by the author
BitsPerWord represents the number of bits in a big.Word.
BytesPerWord represents the number of bytes in a big.Word.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FULL_VALIDATION performs all token key validations.
No description provided by the author
KindAddress is an address.
KindArray is an array.
KindBool is a boolean.
KindBytes is a bytes array.
KindFixedBytes is a fixed bytes.
KindFixedPoint is a fixed point.
KindFunction is a function.
KindInt is an int.
KindSlice is a slice.
KindString is a string.
KindTuple is a tuple.
KindUInt is an uint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NO_VALIDATION performs no validations at all for all passed token keys.
Create Topic.
Delete Topic.
Get Topic information.
Submit message to topic.
Update Topic.
Contract Auto Renew.
Smart Contract Call.
Smart Contract Call.
Smart Contract Create Contract.
delete contract.
Smart Contract, get the byte code.
Smart Contract get info.
Contract get the transaction records.
Smart Contract update contract.
Create Tx Record.
Crypto Auto Renew.
Add a livehash to a crypto account.
Approve allowance for a spender relative to the owner account.
crypto create account.
crypto delete account.
Deletes granted allowances on owner account.
Delete a livehash from a crypto account.
crypto get account balance.
crypto get account record.
Crypto get info.
Get a live hash from a crypto account.
Crypto, get the stakers for the _Node.
crypto transfe.
crypto update account.
Ethereum Transaction.
File Operation append file.
File Operation create file.
File Operation delete file.
File Operations get file contents.
File Operations get the info of the file.
File Operation update file.
freeze.
Gets all the information about an account, including balance and allowances.
Smart Contract, get by key.
Smart Contract, get by _Solidity ID.
Get Version.
Get execution time(s) by TransactionID, if available.
Create a new node.
Delete a node.
Updates the staking info at the end of staking period.
Update an existing node.
UNSPECIFIED - Need to keep first value as unspecified because first element is ignored and not parsed (0 is ignored by parser).
Generates a pseudorandom number.
Create Scheduled Transaction.
Delete Scheduled Transaction.
Get Scheduled Transaction Information.
Sign Scheduled Transaction.
Submit signature of state root hash.
system delete file.
system undelete file.
Wipe token amount from Account holder.
Airdrop tokens to accounts.
Associate tokens to an account.
Burn tokens from treasury.
Remove pending airdrops from state.
Claim pending airdrops.
Create Token.
Delete Token.
Dissociate tokens from an account.
Update a token's custom fee schedule, if permissible.
Freeze Account.
Get Token Account Nft Information.
Get Token information.
Get Token Nft Information.
Get Token Nft List Information.
Grant KYC to Account.
Mint tokens to treasury.
Pause the Token.
Transfer token balances to treasury.
Revoke KYC from Account.
Unfreeze Account.
Unpause the Token.
Update Token.
Update the metadata of one or more NFT's of a specific token type.
Get a record for a transaction (lasts 180 seconds).
Transaction Get Receipt.
Crypto get the transaction records.
Submit node public TSS encryption key.
TSS Messages for a candidate roster.
Node's signature of block hash using TSS private share.
Vote on TSS validity.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

HbarUnits is a set of HbarUnit.
Various big integer constants for limits.
Various big integer constants for limits.
MaxHbar is the maximum amount the Hbar type can wrap.
MinHbar is the minimum amount the Hbar type can wrap.
ZeroHbar wraps a 0 value of Hbar.

# Structs

ABI represents the ethereum abi format.
AccountAllowanceApproveTransaction Creates one or more hbar/token approved allowances <b>relative to the owner account specified in the allowances of tx transaction</b>.
AccountAllowanceDeleteTransaction Deletes one or more non-fungible approved allowances from an owner's account.
No description provided by the author
AccountBalanceQuery gets the balance of a CryptoCurrency account.
AccountCreateTransaction creates a new account.
AccountDeleteTransaction Mark an account as deleted, moving all its current hbars to another account.
AccountID is the ID for a Hiero account.
AccountInfo is info about the account returned from an AccountInfoQuery.
AccountInfoQuery Get all the information about an account, including the balance.
AccountRecordsQuery gets all of the records for an account for any transfers into it and out of it, that were above the threshold, during the last 25 hours.
AccountStakersQuery gets all of the accounts that are proxy staking to this account.
AccountUpdateTransaction Change properties for the given account.
AddressBookQuery query an address book for its list of nodes.
No description provided by the author
ArgumentStr encodes a type object.
No description provided by the author
BaseTransaction contains all the common fields for all transactions.
Client is the Hiero protocol wrapper for the SDK used by all transaction and query types.
ContractBytecodeQuery retrieves the bytecode for a smart contract instance.
ContractCallQuery calls a function of the given smart contract instance, giving it ContractFunctionParameters as its inputs.
No description provided by the author
ContractCreateTransaction which is used to start a new smart contract instance.
ContractDeleteTransaction marks a contract as deleted and transfers its remaining hBars, if any, to a designated receiver.
ContractExecuteTransaction calls a function of the given smart contract instance, giving it ContractFuncionParams as its inputs.
ContractFunctionParameters is a struct which builds a solidity function call Use the builder methods `Add<Type>()` to add a parameter.
ContractFunctionResult is a struct which allows users to convert between solidity and Go types, and is typically returned by `ContractCallQuery` and is present in the transaction records of `ContractExecuteTransaction`.
A selector for a function with a given name.
ContractID is the ID for a Hiero smart contract.
Current information on the smart contract instance, including its balance.
ContractInfoQuery retrieves information about a smart contract instance.
ContractLogInfo is the log info for events returned by a function.
ContractID is the ID for a Hiero smart contract.
No description provided by the author
ContractUpdateTransaction is used to modify a smart contract instance to have the given parameter values.
Base struct for all custom fees.
A fixed fee transfers a specified amount of the token, to the specified collection account(s), each time a token transfer is initiated.
A fractional fee transfers the specified fraction of the total value of the tokens that are being transferred to the specified fee-collecting account.
A royalty fee is a fractional fee that is assessed each time the ownership of an NFT is transferred from person A to person B.
No description provided by the author
ContractID is the ID for a Hiero smart contract.
No description provided by the author
ErrBadKey is returned if a key is provided in an invalid format or structure.
ErrHederaNetwork is returned in cases where the Hiero _Network cannot be reached or a _Network-side error occurs.
ErrHederaPreCheckStatus is returned by Transaction.Execute and QueryBuilder.Execute if an exceptional status is returned during _Network side validation of the sent transaction.
ErrHederaReceiptStatus is returned by TransactionID.GetReceipt if the status of the receipt is exceptional.
ErrHederaRecordStatus is returned by TransactionID.GetRecord if the status of the record is exceptional.
No description provided by the author
ErrLocalValidation is returned by TransactionBuilder.Build(*Client) and QueryBuilder.Execute(*Client) if the constructed transaction or query fails local sanity checks.
No description provided by the author
ErrMaxQueryPaymentExceeded is returned during query execution if the total cost of the query + estimated fees exceeds the max query payment threshold set on the client or QueryBuilder.
Error is a solidity error object.
EthereumEIP1559Transaction represents the EIP-1559 Ethereum transaction data.
Execute an Ethereum transaction on Hiero.
EthereumLegacyTransaction represents the legacy Ethereum transaction data.
EthereumTransaction is used to create a EthereumTransaction transaction which can be used to construct and execute a Ethereum Transaction.
Represents the data of an Ethereum transaction.
Event is a triggered log mechanism.
ExchangeRate is the exchange rate between HBAR and USD.
nolint.
No description provided by the author
No description provided by the author
No description provided by the author
FileAppendTransaction appends the given contents to the end of the file.
FileContentsQuery retrieves the contents of a file.
FileCreateTransaction creates a new file, containing the given contents.
FileDeleteTransaction Deletes the given file.
A FileID is the ID for a file on the _Network.
FileInfo contains the details about a file stored on Hiero.
FileInfoQuery is a query which can be used to get all of the information about a file, except for its contents.
FileUpdateTransaction Modify the metadata and/or contents of a file.
No description provided by the author
Hbar is a typesafe wrapper around values of HBAR providing foolproof conversions to other denominations.
An approved allowance of hbar transfers for a spender.
KeyList is a list of keys.
No description provided by the author
LiveHash is a hash that is live on the Hiero network.
LiveHashAddTransaction At consensus, attaches the given livehash to the given account.
LiveHashDeleteTransaction At consensus, deletes a livehash associated to the given account.
LiveHashQuery Requests a livehash associated to an account.
No description provided by the author
Method is a callable function in the contract.
MirrorNodeContractCallQuery returns a result from EVM transient simulation of read-write operations.
MirrorNodeContractEstimateGasQuery returns a result from EVM gas estimation of read-write operations.
No description provided by the author
NetworkVersionInfo is the version info for the Hiero network protobuf and services.
NetworkVersionInfoQuery is the query to be executed that would return the current version of the network's protobuf and services.
NftID is the ID for a non-fungible token.
NodeAddress is the address of a node on the Hiero network.
NodeAddressBook is the address book for the nodes on the Hiero network.
* * A transaction to create a new node in the network address book.
* * A transaction to delete a node from the network address book.
* * A transaction to modify address book node attributes.
* * A unique, composite, identifier for a pending airdrop.
No description provided by the author
No description provided by the author
PrngTransaction is used to generate a random number in a given range.
ProxyStaker is an information about a single account that is proxy staking.
No description provided by the author
Query is the struct used to build queries.
RLPItem represents a single RLP item.
ScheduleCreateTransaction Creates a new schedule entity (or simply, schedule) in the network's action queue.
ScheduleDeleteTransaction Marks a schedule in the network's action queue as deleted.
ScheduleID is the ID for a Hiero account.
No description provided by the author
ScheduleInfoQuery Gets information about a schedule in the network's action queue.
ScheduleSignTransaction Adds zero or more signing keys to a schedule.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Delete a file or smart contract - can only be done with a Hiero admin.
Undelete a file or smart contract that was deleted by AdminDelete.
No description provided by the author
An approved allowance of token transfers for a spender.
TokenAssociateTransaction Associates the provided account with the provided tokens.
A token - account association.
No description provided by the author
TokenBurnTransaction Burns tokens from the Token's treasury Account.
No description provided by the author
No description provided by the author
TokenCreateTransaction Create a new token.
No description provided by the author
TokenDeleteTransaction Marks a token as deleted, though it will remain in the ledger.
TokenDissociateTransaction Dissociates the provided account with the provided tokens.
TokenFeeScheduleUpdateTransaction At consensus, updates a token type's fee schedule to the given list of custom fees.
TokenFreezeTransaction Freezes transfers of the specified token for the account.
TokenGrantKycTransaction Grants KYC to the account for the given token.
TokenID is the ID for a Hiero token.
TokenInfo is the information about a token.
TokenInfoQuery Used get information about Token instance.
TokenMintTransaction Mints tokens from the Token's treasury Account.
TokenNftAllowance is a struct to encapsulate the nft methods for token allowance's.
TokenNftInfo is the information about a NFT.
TokenNftInfoQuery Applicable only to tokens of type NON_FUNGIBLE_UNIQUE.
TokenPauseTransaction Pauses the Token from being involved in any kind of Transaction until it is unpaused.
No description provided by the author
* * A transaction body to "reject" undesired tokens.<br/> * This transaction will transfer one or more tokens or token * balances held by the requesting account to the treasury * for each token type.
TokenRelationship is the information about a token relationship.
TokenRevokeKycTransaction Revokes KYC to the account for the given token.
TokenTransfer is a token transfer record.
TokenUnfreezeTransaction Unfreezes transfers of the specified token for the account.
TokenUnpauseTransaction Unpauses the Token.
No description provided by the author
TokenUpdateTransaction At consensus, updates an already created token to the given values.
TokenWipeTransaction Wipes the provided amount of tokens from the specified Account.
A TopicCreateTransaction is for creating a new Topic on HCS.
TopicDeleteTransaction is for deleting a topic on HCS.
TopicID is a unique identifier for a topic (used by the service).
TopicInfo is the information about a topic.
TopicInfo is the Query for retrieving information about a topic stored on the Hiero network.
TopicMessage is a message from a topic}.
TopicMessageChunk is a chunk of a topic message.
TopicMessageQuery Query that listens to messages sent to the specific TopicID.
TopicMessageSubmitTransaction Sends a message/messages to the Topic ID.
TopicUpdateTransaction Updates all fields on a Topic that are set in the transaction.
Transaction is base struct for all transactions that may be built and submitted to hiero.
No description provided by the author
TransactionID is the id used to identify a Transaction on the Hiero _Network.
The consensus result for a transaction, which might not be currently known, or may succeed or fail.
TransactionReceiptQuery Get the receipt of a transaction, given its transaction ID.
The complete record for a transaction on Hiero that has reached consensus.
TransactionRecordQuery Get the record for a transaction.
When the client sends the node a transaction of any kind, the node replies with this, which simply says that the transaction passed the precheck (so the node will submit it to the network) or it failed (so it won't).
Transfer is a transfer of hbars or tokens from one account to another.
TransferTransaction Transfers cryptocurrency among two or more accounts by making the desired adjustments to their balances.
TupleElem is an element of a tuple.
Type is an ABI type.

# Interfaces

EntityID is an interface for various IDs of entities (Account, Contract, File, etc).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Interface that all concrete transactions must implement, eg.

# Type aliases

AbiTypeKind represents the kind of abi type.
Address is an Ethereum address.
No description provided by the author
No description provided by the author
Hash represents the 32 byte Keccak256 hash of arbitrary data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RLPType represents the type of RLP item.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TransactionSigner is a closure or function that defines how transactions will be signed.