Skip to content

Latest commit

 

History

History
692 lines (446 loc) · 21.3 KB

CHANGELOG.md

File metadata and controls

692 lines (446 loc) · 21.3 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

  • Fixed bugs in [to|from]Bytes() in TopicUpdateTransaction and TokenUpdateTransaction
  • Deprecated Client.setMax[TransactionFee|QueryPayment](), added Client.setDefaultMax[TransactionFee|QueryPayment]() and Client.getDefaultMax[TransactionFee|QueryPayment]()
  • Added FeeAssessmentMethod.
  • Added [get|set]AssessmentMethod() to CustomFractionalFee
  • Added CustomRoyaltyFee
  • Added payerAccountIdList to AssessedCustomFee
  • Added fields to FreezeTransaction
  • Added [min|max]Backoff to Client and Executable

v2.0.11

Added

  • ChunkedTransaction.getAllSignatures()

Fixed

  • Transaction.getSignatures() incorrectly building signature list
  • TopicMessageQuery pending messages being discarded on retry
  • ChunkedTransaction.getAllTransactionHashesPerNode() incorrectly building signature map
  • ScheduleInfo.getScheduledTransaction() still not setting max fee appropriately

Changed

  • *.setSerials() will now clone list passed in to prevent changes

v2.0.10

Added

  • Client.getRequestTimeout()
  • Client.pingAsync() and Client.pingAllAsync() useful for validating all nodes within the network before executing any real request
  • Client.[set|get]MaxAttempts() default max attempts for all transactions
  • Client.[set|get]MaxNodeAttempts() set max attempts to retry a node which returns bad gRPC status such as UNAVAILBLE
  • Client.[set|get]NodeWaitTime() change the default delay before attempting a node again which has returned a bad gRPC status
  • Client.setAutoValidateChecksums() set whether checksums on ids will be automatically validated upon attempting to execute a transaction or query. Disabled by default. Check status with Client.isAutoValidateChecksumsEnabled()
  • *Id.toString() no longer stringifies with checksums. Use *Id.getChecksum() to get the checksum that was parsed, or use *Id.toStringWithChecksum(client) to stringify with the correct checksum for that ID on the client's network.
  • *Id.validateChecksum() to validate a checksum. Throws new BadEntityIdException
  • Client.[set|get]NetworkName() declare which network this client is connected to, for purposes of checksum validation.
  • CustomFixedFee.[set|get]HbarAmount() makes this fixed fee an Hbar fee of the specified amount
  • CustomFixedFee.setDenominatingTokenToSameToken() this fixed fee will be charged in the same token.

Deprecated

  • *Id.validate() use *Id.validateChecksum() instead

Fixed

  • ScheduleInfo.getTransaction() incorrectly setting max transaction fee to 2 Hbars

v2.0.9

Fixed

  • PrivateKey.legacyDerive() should behave the same as other SDKs

Removed

  • *.addCustomFee() use *.setCustomFees() instead

v2.0.9-beta.2

Fixed

  • TokenUpdateTransaction.clearAutoRenewAccountId()
  • Scheduled TransferTransaction

v2.0.9-beta.1

Added

  • Support for NFTS
    • Creating NFT tokens
    • Minting NFTs
    • Burning NFTs
    • Transfering NFTs
    • Wiping NFTs
    • Query NFT information
  • Support for Custom Fees on tokens:
    • Setting custom fees on a token
    • Updating custom fees on an existing token

v2.0.8

Added

  • Sign on demand functionality which should improve performance slightly

Fixed

  • AccountBalance.tokenDecimals incorrectly using Long as the key in the map instead of TokenId. Since this was a major bug making tokenDecimals completely unusable, the change has been made directly on tokenDecimals instead of deprecating and adding another field.

v2.0.7

Added

  • Support for entity ID checksums which are validated whenever a request begins execution. This includes the IDs within the request, the account ID within the transaction ID, and query responses will contain entity IDs with a checksum for the network the query was executed on.
  • Node validation before execution
  • Null checks for most parameters to catch stray NullPointerException's

Fixed

  • RequestType missing UNCHECKED_SUBMIT for toString() and valueOf() methods.
  • FeeSchedules incorrectly serializing nulls causing NullPointerException

v2.0.6

Added

  • Add FeeSchedule type to allow a structured parse of file 0.0.111

  • Support for setting maxBackoff, maxAttempts, retryHandler, and completionHandler in TopicMessageQuery

  • Default logging behavior to TopicMessageQuery if an error handler or completion handler was not set

  • (Internal) CI is run significantly more often, and against previewnet and the master branch of hedera-services.

  • Expose tokenDecimals from AccountBalance

Fixed

  • TopicMessageQuery retry handling; this should retry on more gRPC errors

  • TopicMessageQuery max retry timeout; before this would could wait up to 4m with no feedback

  • Client should be more thread safe

v2.0.5

Added

  • Support memo for Tokens, Accounts, and Files.

Fixed

  • Scheduled transaction support: ScheduleCreateTransaction, ScheduleDeleteTransaction, and ScheduleSignTransaction
  • HMAC Calculation Does Not Include IV [NCC-E001154-010]
  • Non-Constant Time Lookup of Mnemonic Words [NCC-E001154-009]
  • Decreased CHUNK_SIZE 4096->1024 and increased default max chunks 10->20
  • Remove use of computeIfAbsent and putIfAbsent from JDK7 builds

Deprecated

  • new TransactionId(AccountId, Instant) - Use TransactionId.withValidStart() instead.

v2.0.5-beta.9

Fixed

  • TransferTransaction.addTokenTransfer() was correctly adding tokens
  • HMAC Calculation Does Not Include IV [NCC-E001154-010]
  • Non-Constant Time Lookup of Mnemonic Words [NCC-E001154-009]
  • Decreased CHUNK_SIZE 4096->1024 and increased default max chunks 10->20
  • Renamed ScheduleInfo.getTransaction() -> ScheduleInfo.getScheduledTransaction()

v2.0.5-beta.8

Fixed

  • Remove use of computeIfAbsent and putIfAbsent from JDK7 builds

v2.0.5-beta.7

Fixed

  • Scheduled transactions should use new HAPI protobufs
  • ReceiptPrecheckException should be thrown when the erroring status was in the TransactionReceipt
  • Removed nonce from TransactionId
  • Transaction[Receipt|Record]Query should not error for status IDENTICAL_SCHEDULE_ALREADY_CREATED because the other fields on the receipt are present with that status.
  • ScheduleMultiSigExample should use updated scheduled transaction API

Removed

  • ScheduleCreateTransaction.addScheduledSignature()
  • ScheduleCreateTransaction.getScheduledSignatures()
  • ScheduleSignTransaction.addScheduledSignature()
  • ScheduleSignTransaction.getScheduledSignatures()

v2.0.5-beta.6

Added

  • Support for old proto.Transaction raw bytes in Transaction.fromBytes()

v2.0.5-beta.5

Added

  • TransactionRecord.scheduleRef - Reference to the scheduled transaction
  • TransactionReceipt.scheduledTransactionId
  • ScheduleInfo.scheduledTransactionId
  • Feature to copy TransactionId of a transaction being scheduled to the parent ScheduleCreateTransaction if one is set.

Fixed

  • TransactionId.toBytes() should support nonce if set
  • TransactionId.fromBytes() should support nonce if set

v2.0.5-beta.4

Added

  • Support memo for Tokens, Accounts, and Files.
  • TransactionId.fromString() should support nonce and scheduled.

v2.0.5-beta.3

Changed

  • TransactionId.toString() will append ?scheduled for scheduled transaction IDs, and transaction IDs created from nonce will print in hex.

Added

  • Support for scheduled and nonce in TransactionId
    • TransactionId.withNonce() - Supports creating transaction ID with random bytes.
    • TransactionId.[set|get]Scheduled() - Supports scheduled transaction IDs.
  • TransactionId.withValidStart()

Fixed

  • ScheduleCreateTransaction.setTransaction() and Transaction.schedule() not correctly setting existing signatures.

Deprecated

  • new TransactionId(AccountId, Instant) - Use TransactionId.withValidStart() instead.

v2.0.5-beta.2

Fixed

  • Schedule[Create|Sign]Transaction.addScheduleSignature() didn't save added signatures correctly.

v2.0.5-beta.1

Added

  • Support for scheduled transactions.
    • ScheduleCreateTransaction - Create a new scheduled transaction
    • ScheduleSignTransaction - Sign an existing scheduled transaction on the network
    • ScheduleDeleteTransaction - Delete a scheduled transaction
    • ScheduleInfoQuery - Query the info including bodyBytes of a scheduled transaction
    • ScheduleId

v2.0.2

Changes

  • Implement Client.forName() to support construction of client from network name.
  • Implement PrivateKey.verifyTransaction() to allow a user to verify a transaction was signed with a partiular key.
  • Rename HederaPreCheckStatusException to PrecheckStatusException and deprecate HederaPreCheckStatusException
  • Rename HederaReceipStatusException to ReceipStatusException and deprecate HederaReceipStatusException

v2.0.1

Bug Fixes

TokenCreateTransaction

  • long getAutoRenewPeriod() -> Duration getAutoRenewPeriod()
  • setAutoRenewPeriod(long) -> setAutoRenewPeriod(Duration)
  • long getExpirationTime() -> Instant getExpirationTime()
  • setExpirationTime(long) -> setExpirationTime(Instant)

TokenUpdateTransaction

  • long getAutoRenewPeriod() -> Duration getAutoRenewPeriod()
  • setAutoRenewPeriod(long) -> setAutoRenewPeriod(Duration)
  • long getExpirationTime() -> Instant getExpirationTime()
  • setExpirationTime(long) -> setExpirationTime(Instant)

TokenInfo

  • AccountId treasury() -> AccountId treasuryAccountId()
  • long autoRenewPeriod() -> Duration autoRenewPeriod()
  • long expirationTime() -> Instant expirationTime()

v2.0.0

General changes

  • No longer support the use of long for Hbar parameters. Meaning you can no longer do AccountCreateTransaction().setInitialBalance(5) and instead must AccountCreateTransaction().setInitialBalance(new Hbar(5)). This of course applies to more than just setInitialBalance().
  • Any method that used to require a PublicKey will now require Key.
    • AccountCreateTransaction.setKey(PublicKey) is now AccountCreateTransaction.setKey(Key) as an example.
  • All Id types (Account, File, Contract, Topic, and TransactionId)
    • Support fromBytes() and toBytes()
    • No longer have the toProto() method.
  • The use of Duration in the SDK will be either java.time.Duration or org.threeten.bp.Duration depending on which JDK and platform you're developing on.
  • The use of Instant in the SDK will be either java.time.Instant or org.threeten.bp.Instant depending on which JDK and platform you're developing on.
  • All transactions and queries will now attempt to execute on more than one node.
  • More getCostAsync and executeAsync variants
    • void executeAsync(Client)
    • Future executeAsync(Client, BiConsumer<O, T>)
    • void executeAsync(Client, Duration timeout, BiConsumer<O, T>)
    • void getCostAsync(Client)
    • Future getCostAsync(Client, BiConsumer<O, T>)
    • void getCostAsync(Client, Duration timeout, BiConsumer<O, T>)
  • Building different types from a protobuf type is no longer supported. Use fromBytes instead.
  • getSignatureCase() is no longer accessible
  • Field which were byte[] are now ByteString to prevent extra copy operation. This includes the response type of FileContentsQuery

Renamed Classes

  • ConsensusSubmitMessageTransaction -> MessageSubmitTransaction
  • ConsensusTopicCreateTransaction -> TopicCreateTransaction
  • ConsensusTopicDeleteTransaction -> TopicDeleteTransaction
  • ConsensusTopicUpdateTransaction -> TopicUpdateTransaction
  • ConsensusTopicId -> TopicId
  • Ed25519PublicKey -> PublicKey
  • Ed25519PrivateKey -> PrivateKey

Removed Classes

  • HederaNetworkException
  • MnemonicValidationResult
  • HederaConstants
  • ThresholdKey use KeyList.withThreshold() instead.

New Classes

  • LiveHash: Support for Hedera LiveHashes
  • Key: A common base for the signing authority or key entities in Hedera may have.

Client

Renamed

  • Client() -> Client.forNetwork()
  • Client.fromFile() -> Client.fromJsonFile()
  • Client.replaceNodes() -> Client.setNetwork()

PrivateKey

Changes

  • sign() no longer requires offset or length parameters

Removed

  • writePem()

PublicKey

Added

  • verify() verifies the message was signed by public key

Hbar

Renamed

  • as() -> to()
  • asTinybar() -> toTinybars()
  • fromTinybar() -> fromTinybars()

Added

  • negated()
  • getValue()

Removed

  • Hbar(BigDecimal, HbarUnit)
  • Hbar.from(long)
  • Hbar.from(BigDecimal)
  • Hbar.of()

KeyList

Added

  • KeyList.withThreshold()
  • size()
  • isEmpty()
  • contains()
  • containsAll()
  • iterator()
  • toArray()
  • remove()
  • removeAll()
  • retainAll()
  • clear()
  • toString()

Mnemonic

Renamed

  • Mnemonic(List<? extends CharSequence>) -> Mnemonic.fromWords() throws BadMnemonicException

ContractId

Added

  • ContractId(long)

Removed

  • toKeyProto()
  • implements PublicKey meaning it can no longer be used in place of a Key

FileId

Added

  • FileId(long)

Removed

  • fromSolidityAddress()
  • toSolidityAddress()

TransactionId

Added

  • TransactionId.withValidStart()
  • TransactionId.generate()

Transaction

Added

  • Transaction.hash()
  • Transaction.signWithOperator()

Removed

  • getReceipt()
  • getRecord()

QueryBuilder

Removed

  • toProto()
  • setPaymentTransaction()

TransactionBuilder

AccountInfo

Added

  • List<LiveHash> liveHashes

AccountDeleteTransaction

Renamed

  • setDeleteAccountId() -> setAccountId()
  • Removed addKey(), use setKeys(Key...) instead.

FileUpdateTransaction

  • Removed addKey(), use setKeys(Key...) instead.

v1.1.4

Added

  • Support for loading Ed25519 keys from encrypted PEM files (generated from OpenSSL).

  • Add a method to validate a mnemonic word list for accurate entry.

Fixed

  • Fixed TransactionReceiptQuery not waiting for consensus some times.

v1.1.3

Added

  • Add additional error classes to allow more introspection on errors:
    • HederaPrecheckStatusException - Thrown when the transaction fails at the node (the precheck)
    • HederaReceiptStatusException - Thrown when the receipt is checked and has a failing status. The error object contains the full receipt.
    • HederaRecordStatusException - Thrown when the record is checked and it has a failing status. The error object contains the full record.

Fixed

  • Add missing setTransferAccountId and setTransferContractId methods to ContractDeleteTransaction

  • Override executeAsync to sign by the operator (if not already)

Deprecated

  • Deprecate toSolidityAddress and fromSolidityAddress on FileId

v1.1.2

Fixed

v1.1.1

Fixed

v1.1.0

Added

Add support for Hedera Consensus Service (HCS).

  • Add ConsensusTopicCreateTransaction, ConsensusTopicUpdateTransaction, ConsensusTopicDeleteTransaction, and ConsensusMessageSubmitTransaction transactions

  • Add ConsensusTopicInfoQuery query (returns ConsensusTopicInfo)

  • Add MirrorClient and MirrorConsensusTopicQuery which can be used to listen for HCS messages from a mirror node

v1.0.0

Removed all deprecated APIs from v1.0.0.

Changed

  • Instead of returning ResponseCodeEnum from the generated protos, return a new Status type that wraps that and provides some Java conveniences.

  • Rename HederaException to HederaStatusException

  • Rename QueryBuilder.MaxPaymentExceededException to MaxQueryPaymentExceededException

  • Change AccountBalanceQuery to return Hbar (instead of Long)

  • Change ContractGetBytecodeQuery to return byte[] (instead of the internal proto type)

  • Remove GetBySolidityIdQuery. Instead, you should use AccountId.toSolidityAddress.

  • Change ContractRecordsQuery to return TransactionRecord[]

v0.9.0

Changed

All changes are not immediately breaking as the previous method still should exist and be working. The previous methods are flagged as deprecated and will be removed upon v1.0.

  • Transactions and queries do not take Client in the constructor; instead, Client is passed to execute.

  • Removed Transaction.executeForReceipt and Transaction.executeForRecord

    These methods have been identified as harmful as they hide too much. If one fails, you do not know if the transaction failed to execute; or, the receipt/record could not be retrieved. In a mission-critical application, that is, of course, an important distinction.

    Now there is only Transaction.execute which returns a TransactionId. If you don't care about waiting for consensus or retrieving a receipt/record in your application, you're done. Otherwise you can now use any TransactionId and ask for the receipt/record (with a stepped retry interval until consensus) with TransactionId.getReceipt and TransactionId.getRecord.

    v0.8.x and below

    AccountId newAccountId = new AccountCreateTransaction(hederaClient)
    .setKey(newKey.getPublicKey())
    .setInitialBalance(1000)
    .executeForReceipt() // TransactionReceipt
    .getAccountId();

    v0.9.x

    AccountId newAccountId = new AccountCreateTransaction()
    .setKey(newKey.getPublicKey())
    .setInitialBalance(1000)
    .execute(hederaClient) // TranactionId
    .getReceipt(hederaClient) // TransactionReceipt
    .getAccountId();

  • TransactionReceipt, AccountInfo, TransactionRecord, etc. now expose public final fields instead of getters (where possible and it makes sense).

  • Rename getCallResult and getCreateResult to getContractExecuteResult and getContractCreateResult for consistency

  • TransactionBuilder.setMemo is renamed to TransactionBuilder.setTransactionMemo to avoid confusion as there are 2 other kinds of memos on transactions

  • CallParams is removed in favor of ContractFunctionParams and closely mirrors type names from solidity

    • addInt32
    • addInt256Array
    • addString
    • etc.

  • ContractFunctionResult now closely mirrors the solidity type names

    • getInt32
    • etc.

  • setFunctionParams(params) on ContractCallQuery and ContractExecuteTransaction is now setFunction(name, params)

Added

  • TransactionId.getReceipt

  • TransactionId.getRecord

  • FileId.ADDRESS_BOOK, FileId.FEE_SCHEDULE, FileId.EXCHANGE_RATES

  • Experimental support for the Hedera Consensus Service (HCS). HCS is not yet generally available but if you have access the SDK can work with the current iteration of it. Due to its experimental nature, a system property must be set before use.

    System.setPropery("com.hedera.hashgraph.sdk.experimental", "true")

  • Client.forTestnet makes a new client configured to talk to TestNet (use .setOperator to set an operater)

  • Client.forMainnet makes a new client configured to talk to Mainnet (use .setOperator to set an operater)

Fixes

  • FileCreateTransaction sets a default expiration time; fixes AUTORENEW_DURATION_NOT_IN_RANGE.

  • BUSY is now internally retried in all cases.

  • The maximum query payment is now defaulted to 1 Hbar. By default, just before a query is executed we ask Hedera how much the query will cost and if it costs under the defined maximum, an exact payment is sent.

Removed

  • Transaction and Query types related to claims

v0.8.0

Fixes compatibility with Android.

Breaking Changes

  • The Key interface has been renamed to PublicKey
  • You are now required to depend on the gRPC transport dependency for your specific environment

Maven

<!-- SELECT ONE: -->
<!-- netty transport (for server or desktop applications) -->
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-netty-shaded</artifactId>
  <version>1.24.0</version>
</dependency>
<!-- netty transport, unshaded (if you have a matching Netty dependency already) -->
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-netty</artifactId>
  <version>1.24.0</version>
</dependency>
<!-- okhttp transport (for lighter-weight applications or Android) -->
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-okhttp</artifactId>
  <version>1.24.0</version>
</dependency>

Gradle

// SELECT ONE:
// netty transport (for high throughput applications)
implementation 'io.grpc:grpc-netty-shaded:1.24.0'
// netty transport, unshaded (if you have a matching Netty dependency already)
implementation 'io.grpc:grpc-netty:1.24.0'
// okhttp transport (for lighter-weight applications or Android)
implementation 'io.grpc:grpc-okhttp:1.24.0'