- Added a set of functions to support work with
Transaction Author Agreement
concept. This guarantees that every write transaction author agree that the information they submit to the ledger meets the requirements outlined by ledger governance.indy_build_txn_author_agreement_request
to add a new version of Transaction Author Agreement to the ledger.indy_build_get_txn_author_agreement_request
to get a Transaction Author Agreement from the ledger.indy_build_acceptance_mechanisms_request
to add new acceptance mechanisms for transaction author agreement.indy_build_get_acceptance_mechanisms_request
to get acceptance mechanisms from the ledger.indy_append_txn_author_agreement_acceptance_to_request
to append transaction author agreement acceptance data to a request.indy_append_txn_author_agreement_acceptance_to_request
to append transaction author agreement acceptance data to a request.indy_prepare_payment_extra_with_acceptance_data
to prepare payment extra JSON with TAA acceptance data.
- Updated Indy-CLI to use session based approach to support work with
Transaction Author Agreement
concept.- user will be asked if he would like to accept TAA on
pool open
command. - added
pool show-taa
to show and accept TAA.
- user will be asked if he would like to accept TAA on
- Updated Libindy
indy_verifier_verify_proof
function to check restrictions on requested predicates during validation of proof. - Updated Libindy to use Ursa instead of Indy-Crypto.
- Updated Indy-CLI to provide a functionality of saving transactions into CLI context and the following usage of them.
- Added EXPERIMENTAL
Cache API
to Libindy that provides an ability to get and to store schemas and credential definitions into the wallet. *indy_get_cred_def
to get credential definition for specified credential definition id.indy_purge_cred_def_cache
to purge credential definition cache.indy_get_schema
to get schema for specified schema id.indy_purge_schema_cache
to purge schema cache.
- Updated Indy-SDK CD pipeline to build and to publish MacOs artifacts for Libindy, Libnullpay, and Libvcx.
- Implemented
State Proof
verification for some types of GET requests to the ledger. - Bugfixes:
- others minor bugfixes
- Bugfixes:
- Fixed behavior of
auth_rule
andget_auth_rule
request builders - Extended windows packages to contain *.dll.lib file.
- Fixed
boolean
datatype representation for FFI. - others minor bugfixes
- Fixed behavior of
- Added new functions to Libindy Ledger API:
indy_build_auth_rule_request
to change an existing ledger auth rule.indy_build_get_auth_rule_request
to get either specific one or all ledger auth rules.
- Added
ledger auth-rule
andledger get-auth-rule
commands to Indy CLI. - Added function
vcx_get_current_error
to get additional information for last error occurred in Libvcx. - Updated Libvcx wrappers for automatic getting error details:
- Python - added
sdk_error_full_message
,sdk_error_cause
andsdk_error_backtrace
fields toVcxError
object. - Java - added
sdkMessage
,sdkFullMessage
,sdkCause
andsdkBacktrace
fields toVcxException
. - Objective-C - added
error
,message
,cause
,backtrace
fields touserInfo
dictionary inNSError
object.
- Python - added
- Removed Deprecation warnings from
indy_crypto_anon_crypt
andindy_crypto_anon_decrypt
functions. - Changed location of Java artifacts on
repo.sovrin.org
. - Added Postgres wallet storage plugin. Updated Libvcx and Cli to support work with it.
- Updated Vcx to support community A2A protocol.
Added
protocol_type
field to VCX provisioning config with indicates A2A message format will be used.1.0
means the current protocol.2.0
means community (IN PROGRESS) protocol which in the current state includes draft implementation of the following HIPES:
- Set default freshness threshold to 600 seconds.
- Send GET requests to two Nodes.
- Bugfixes:
- Restart catchup in case of outdated pool cache.
- Fixed publishing of nodejs package for VCX wrapper.
- others minor bugfixes
- Bugfixes:
- Set default freshness threshold to u64::MAX -- if you need to change it, look at the
indy_set_runtime_config
call. - Fixed a bug in freshness threshold calculation.
- Fixed a bug with libnullpay and VCX connected to logging initialization.
- Set default freshness threshold to u64::MAX -- if you need to change it, look at the
- Added function
indy_get_current_error
to get additional information for last error occurred in Libindy. - Updated Libindy wrappers for automatic getting error details:
- Python - added
message
andindy_backtrace
fields toIndyError
object. - Java - added
sdkBacktrace
field toIndyException
. Libindyerror message
set as the main forIndyException
. - NodeJS - added
indyMessage
andindyBacktrace
fields toIndyError
object. - Rust - changed type of returning value from enum
ErrorCode
on structureIndyError
witherror_code
,message
,indy_backtrace
fields. - Objective-C - added
message
andindy_backtrace
fields touserInfo
dictionary inNSError
object.
- Python - added
- Updated Indy-Cli to show Libindy error message in some cases.
- Implemented automatic filtering of outdated responses based on comparison of local time with latest transaction ordering time.
- Added EXPERIMENTAL
indy_pack_message
andindy_unpack_message
functions to support Wire Messages described in AMES HIPE - Functions
indy_crypto_anon_crypt
andindy_crypto_anon_decrypt
marked as Deprecated. - Removed
bindgen
folder from Libindy NodeJS wrapper. - Added
NETWORK_MONITOR
role to NYM transaction builder. - Bugfixes
Notes:
- This version of libindy will work slower with older versions of node due to freshness changes.
- There is migration guide about API changes.
- Added VCX - a library built over libindy for Verifiable Credentials eXchange. API is EXPERIMENTAL.
- At the current moment mobile builds are not available - they should be added in future releases.
- Added Logging API
- Added function
indy_get_logger
for plugins to give their logging to libindy - Added function
indy_set_logger
for client apps and wrappers to receive logs from libindy - Integrated libindy logging into Slf4j for Java wrapper and into python logging facade
- Added function
- Updated API of Rust wrapper. Now there is no three methods for each API call, there is only one that returns Future.
- Introduced multithreading for Wallet API and CRED_DEF generation
- Bugfixes
Notes:
- There is migration guide about API changes.
- Fix State Proof verification for some types of GET requests to the ledger
- Additional clean-up for secrets in logs
- Update CLI help
- Supported setting fees in
did rotate-key
CLI command. - Supported hexadecimal seed for did and key creation.
- Removed TGB role.
- Added EXPERIMENTAL Rust wrapper for Libindy.
- Bugfixes.
- Fixed Android build rustflags. Now all architectures have same flags.
- Fixed
ARGON2I
constants usage to be compatible with the latest sodium. - Parameter
submitter_did
set as the optional field for:- Ledger API
indy_build_get_*
functions (exceptindy_build_get_validator_info_request
). - all functions in Payment API.
- Ledger API
- Fixed Android build rustflags for all architectures for libc linking.
- Early API types checks
- Workaround for OS permissions on Android
- Fix Android build ARMv7
- Performed the following changes related to Libindy Wallet API:
- Added separate API function
indy_generate_wallet_key
to generate a random wallet master key. - Updated
key_derivation_method
parameter of walletcredentials
to accept the addition type -RAW
. By using this type, the result ofindy_generate_wallet_key
can be passed as a wallet master key (key derivation will be skipped). - Updated Indy CLI wallet related commands to accept the addition parameter
key_derivation_method
.
- Added separate API function
- Updated
data
parameter ofindy_build_node_request
API function to acceptblskey_pop
(Proof of possession for BLS key). - Bugfixes
- Fixed build flags for Android.s
- Other minor bugfixes.
- Performed the following changes related to Libindy Ledger API:
- Added
indy_submit_action
endpoint that provides the ability to send either GET_VALIDATOR_INFO or POOL_RESTART request to specific nodes and to specify custom timeout for a response from a node. - Updated
indy_build_pool_upgrade_request
API function to accept the additional parameterpackage
that allow specify package to be upgraded.* Bugfixes
- Added
- Added
pool restart
command in Indy CLI. - Updated Libindy CD pipeline to run iOS tests and to publish artifacts for Libindy and Libnullpay.
- Updated wallet
credentials
to accept the additional parameterkey_derivation_method
. This parameter provides the ability to use different crypto algorithms for master key derivation. - Bugfixes
- Fix connection performance issue
- Fix Android publishing
- Integrated tags based search in Anoncreds workflow:
- Updated
indy_prover_store_credential
API function to create tags for a stored credential object. - API functions
indy_prover_get_credentials
andindy_prover_get_credentials_for_proof_req
marked asDeprecated
. - Added two chains of APIs related to credentials search that allows fetching records by batches:
- Simple credentials search -
indy_prover_search_credentials
- Search credentials for proof request -
indy_prover_search_credentials_for_proof_req
- Simple credentials search -
- Supported WQL query language for all search functions in Anoncreds API.
- Updated
- Added
indy_prover_get_credential
API function allows to get human-readable credential by the specific id from Wallet. - Performed changes related to Libindy Wallet behavior:
- Changed Wallet export serialization format to use the same message pack as the rest of LibIndy.
- Removed association between Wallet and Pool.
- Removed persistence of Wallet configuration by Libindy.
- Updated
wallet_create
,wallet_open
,wallet_delete
functions to accept wallet configuration as a single JSON.
- Performed changes related to Libindy Pool behavior:
- Changed Pool connection logic to avoid unnecessary opened connections.
- Changed Catch-up process to get all transactions from a single node.
- Implemented logic of persisting of actual Pool Leger at the end of catch-up process and starting from this point on the next time.
- Updated format of
config
parameter inindy_open_pool_ledger
API function to specify runtime Pool configuration.
- Payment API has been updated to support non-UTXO based crypto payments and traditional payments like VISA.
Performed the following changes related to Libindy Payments API:
- Changed format of input and output parameters.
- Changed format of result values of
indy_parse_response_with_fees
andindy_parse_payment_response
API functions. - Renamed
indy_build_get_utxo_request
andindy_parse_get_utxo_response
API functions. - Added
indy_build_verify_payment_req
andindy_parse_verify_payment_response
API functions. - Removed EXPERIMENTAL notice from endpoints.
- Added
ledger verify-payment-receipt
command in Indy CLI. - Implemented experimental support of Android.
- Bugfixes
Notes:
- There is migration guide about API changes.
- Wallet format of libindy v1.6 isn't compatible with a wallet format of libindy v1.5. As result it is impossible to use wallets created with older libindy versions with libindy v1.6.
- Introduction of Wallet Storage concept:
- In v1.4 libindy allowed to plug different wallet implementations. Plugged wallet in v1.4 handled both security and storage layers. In contrast Libindy v1.5 restricts plugged interface by handling only storage layer. All encryption is performed in libindy. It simplifies plugged wallets and provides warranty of a good security level for 3d party wallets implementations.
- The format of wallet data was changed for better security and support of efficient search
- Added EXPERIMENTAL Wallet Export/Import API and corresponded commands to Indy CLI
indy_list_wallets
endpoint is DEPRECATED and will be removed in the next release. The main idea is avoid maintaining created wallet list on libindy side. It will allow to access wallets from a cluster and solve some problems on mobile platforms.indy_create_wallet
andindy_open_wallet
endpoints will also get related changes in the next release.- Added Non-Secrets API that allows store and read
application specific data in the wallet - Added EXPERIMENTAL Generic Payments API that provides ability to register custom payment method and then create payment addresses, build payment-related transactions, assign fees to transactions
- Added ability to load custom plugins using Indy CLI
- Added the set of commands in Indy CLI providing ability to perform
the main payments operations:
- Creation of payment address
- Listing of payment addresses
- Getting list of UTXO for payment address
- Sending payment transaction
- Adding fees to transactions
- Getting transactions fees amount
- Implemented simple Nullpay payment plugin that provide experience similar to real payments system
- Implemented publishing of Ubuntu and Windows packages for
Nullpay
plugin - Added new Ledger API endpoints and corresponded commands in Indy CLI
- GET Validator Info request builder
- Restart POOL request builder
- Add Multi Signature to request
- Optimized Pool connection process. Libindy v1.5 uses cache of Pool Ledger to speed up opening pool operation.
- Bugfixes
Notes:
- There is migration guide about API changes
- Wallet format of libindy v1.5 isn't compatible with a wallet format of libindy v1.4. As result it is impossible to use wallets created with older libindy versions with libindy v1.5.
- Tails handling contains breaking-change hotfix and blob-storage tails files generated by v1.4 is incompatible with 1.5.
- Indy CLI tool added
- Switching from DID-based crypto to keys-based crypto:
- All DID-based crypto functions (
signus
module) are removed - Added key-based
crypto
module - Added functions to resolve keys for DIDs
- All DID-based crypto functions (
- Agent API moved into
crypto
module - Support the latest version of CL crypto (through
indy-crypto
library):- Added nonce for all protocol steps
- Added consistency proofs for protocol steps
- Representation of Proofs changed (sub-proofs now are ordered)
- Support of complete Credentials Revocation workflow in Anoncreds API:
- Support large Tails handling through BlobStorage API
- Support new Revocation transactions
- Add calls for remote Witness calculation
- State-less approach in Credential issuance process
- Unified reference approach for Anoncreds entities
- Extend DID API: added some methods for iteration over entities in the wallet.
- Bugfixes
Notes:
- There is migration guide about API changes
- The changes for Credential Revocation invalidates any Anoncreds made with SDK 1.3. They must be reissued
- This release is intended for development purposes only. The 1.5.0 release of the SDK will contain changes to the wallet format. If you plan to put durable artifacts in the wallet, let us know so we can discuss migration to the future format
- Encryption option for default wallet is added
- indy_key_for_local_did added
- Replaced Agent2Agent API
- New Crypto API
- Updated Signus API
- Initial release