Change Log

November 2024

🆕 New Features

• Introduced HSM secured interactions for pledge, settlement, arbitration, and withdrawal.

🆕 API Updates

• GET /pledges : Modified response structure.
• GET /pledges/{pledge_id} : Restructured the response properties
• GET /settlements : Restructured the response properties
• GET /settlements/{settlement_id} : Restructured the response properties
• POST /requests : Restructured the request properties
• POST /settlements : Restructured the request and response properties

January 2024

🆕 New authentication method

• Introducing API Operator :
  • A streamlined authentication feature designed to simplify API setup, saving time and costs. This new auth model enhances onboarding processes, offering conventional and secure access, while enabling seamless interactions with partners and facilitating transactions through standard APIs. Upgrades provide industry-standard onboarding, reporting, and notification capabilities, eliminating the need for frequent Docker image updates as it was required with the LAM ( Ledger Authentication Module ).
  • You can start right now the setup of your API Operator following our user guide .
  • This new standard way to interact with Ledger Enterprise API is called API Operator, API Admin. All previous operators created using the LAM (Ledger Authentication Module), will now be referred as LAM Operator.
• New endpoints :
  • As an API operator you can now Create Request to new create transaction request
  • As an API operator you can now Get Request challenge to retrieve the HSM challenge and sign it
  • As an API operator you can now Approve a Request or Reject a Request
  • Since we offer a new interface to create transaction request you can now also estimate fees using this new request payload

🆕 New Features

• Labels on transactions & accounts :
  • Support labeling as ‘spam’ suspicious accounts and transactions on Ledger Vault, in order to create awareness in terms of malicious interactions recognition. This will in the future allow the custom flagging of your accounts and transactions with your custom labels.
  • New field :
    • Get Transaction by Id : You can now find a label field in your transaction object.
    • Get Account by Id : You can now find a label field in your account object.
  • New endpoints :
    • You can now get label by ID , search , create , delete an update labels
    • You can also find new endpoint to get and set theses labels on a transactions and accounts
• Improved Balance Display on Bitcoin: Account balance details now include aggregated information on bitcoin Unspent Transaction Outputs (UTXOs). This update provides insights into whether UTXOs are currently in the mempool, in the process of confirmation, or finalized on the network. Additionally, it includes information on your dust and worthless amount, offering a more detailed overview of your Bitcoin holdings.

December 2023

🆕 New Features

• Compliance Screening via API :
  • New field
    • Get Transaction by Id : You can now find a compliance field in your transaction object, with the risk associated to a transaction broadcasted and screened by your compliance provider
  • New endpoints :
    • Get Address Risk
    • Check if an address is sanctioned

October 2023

🆕 New Features

• MATIC Staking reporting via API : We have updated our GET/account endpoint on MATIC ERC20 accounts, so that you can fetch your staking reporting data across our three partners: Figment, Kiln (🆕) and Blockdaemon (🆕). Please refer to the endpoint documentation for more information.
• Fetch a request’s governance history & status via API : We are excited to introduce a significant update to our platform with the addition of a new API endpoint: GET /requests/{request_id}/status . This new endpoint empowers you with enhanced capabilities to streamline your workspace operations and governance workflows.
• Secure comprehensive audit trails for all workspace operations: transactions & workspace management (user, account, whitelist modifications)
• Facilitate the tracking of request’s approvals to speed up governance workflows Please refer to the endpoint documentation

August 2023

🆕 New Features

• Smart Contract Deployment via API : You can now initiate and approve Smart Contract deployment requests via API on Ethereum and Goerli. Along with sending transactions, interacting with contracts, and signing messages, we now enable users to deploy smart contracts directly from their workspace. This comprehensive functionality allows our enterprise and institutional clients to perform virtually any operation on EVM networks, with governance, security and auditability. Please refer to the Help Center documentation to learn more on how to activate this feature, and to the updated POST/transactions endpoint to learn how to deploy contracts via API.
• Additional supported networks : Access reporting data relative to the vault signer capabilities, on account and whitelists.
  • Cosmos
  • Near
  • Tron

🆙 Improvements

• Solana and Tezos Staking Simplification : The API for staking on Solana and Tezos has been enhanced to make the staking process simpler and more user-friendly. Changes you need to be aware of if you are staking via API on these networks:
  • Solana Staking :
    • All endpoints enabling users to perform an action on their stakes (i.e. POST endpoints) have been modified.
    • Path parameters: "stake uid" has been replaced by "stake id".
    • The responses of these endpoints will now return the "Vault Stake" object instead of the "Transaction to approve" object.
    • The query parameters have also been amended. You will now need to pass the "account name" inside the request body, and you will also need to pass the "stake account" inside the request body (except for the POST/create_stake endpoint).
    • On the POST/merge stake endpoint, "destination stake uid" has been renamed to "destination stake_account".
    • The GET/stakes/stake_uid endpoint has been removed, in favor of enhancing the GET/stakes endpoint with query parameters.
  • Tezos Staking :
    • The GET/stakes/stake_uid endpoint has been removed, in favor of enhancing the GET/stakes endpoint with query parameters.

July 2023

🆕 New Features

• Ethereum Staking via API - Creation with Kiln : Using the new Ethereum staking endpoints for Ethereum staking simplifies the process for our users. You can now interact programmatically with our staking infrastructure, allowing you to stake ETH, manage your staking positions, and monitor your staking rewards.
• Trusted Address Retrieval for an account : In addition to the Get receiving addresses of an account , we added a POST endpoint to receiving addresses of an account that allows you to generate the address directly from the HSM, this endpoint can be slower yet offers a more trusted way of retrieving accounts addresses.

🆙 Improvements

• Smart contract interactions - 'EXECUTE_CONTRACT' Transaction Type : The transaction type SEND was previously used for both standards transactions and smart contract interactions. Smart Contract Interactions will now be labelled with the EXECUTE_CONTRACT transaction type for more clarity. Please find the updated API reference on the transaction endpoints . Note that smart contract deployment transactions, which will be introduced in an upcoming release, will be labeled with the DEPLOY_CONTRACT transaction type.
• Smart contract interactions - 'contract_interaction' object : To prepare for the introduction of smart contract deployments in an upcoming release, we have renamed the smart_contract object in the transaction's coin_fields to contract_interaction .

  ⚠️ This represents a breaking change when creating or approving smart contract interactions with the POST /transactions and POST /transactions/{transaction_id}/approve endpoints. The transaction's contract data should now be included in a coin_fields.contract_interaction object, rather than coin_fields.smart_contract object.
  
  Note that smart contract deployment transactions, which will be introduced in an upcoming release, will expose a coin_fields.contract_deployment object for their contract deployment data.

• Improved Cardano Transaction Metadata Schema : We have fixed an issue with the Cardano transaction metadata schema, ensuring more accurate and reliable transactions.
• Enhanced Cardano Transaction Schema : An issue with the Cardano transaction schema has been resolved.
• Polkadot Balance Model Handling : We have addressed a problem with the new Polkadot balance model, ensuring seamless integration and accurate balance calculations after the recent polkadot network udpate. Fields fee_frozen and misc_frozen where removed and all frozen balance is now under frozen , please find more information in the coin_fields for polkadot accounts .

⚙️ Miscellaneous

• Enhanced Security : In the last release of the LAM, we have hidden the PyPI deploy token from the local docker image, increased security and protection of our systems while running the APIs.

June 2023

🆕 Ethereum: Monitor your staking rewards via API

If you have staked ETH from your Ethereum accounts, you can now track their entire rewads history with our dedicated Ethereum rewards API endpoint.

May 2023

🆕 NFT & ERC-20 Portfolio Monitoring

If your EVM accounts (Ethereum, Polygon, BNB & many more coming soon) hold NFTs or ERC-20 tokens, you can now track their entire token portfolio with our dedicated NFT & ERC-20 API endpoints:

• Track your NFT Portfolio
• Retrieve your NFT Collections
• Retrieve your NFTs
• Retrieve your ERC-20 child accounts

April 2023

🆕 Reporting API Keys

Workspace administrators can now generate and manage reporting API keys to access reporting and notification endpoints. This feature provides enhanced security and flexibility, enabling administrators to grant access to reporting data only to authorized users.

March 2023

⚠️ Breaking change announcement for POST /transactions and POST /transactions/{transaction_id}/approve. From release 4.21 onwards, we will only support base unit inputs for the transaction amount and max_fees.

🆕 Staking Reporting: Tezos stakes & rewards + Solana rewards

You can now monitor your Tezos Stakes, as well as your Solana Staking Rewards. See our Help Center for more details on staking Tezos and Solana with Ledger Enterprise.

🆙 New DApp configuration notification for EVM accounts: EDIT_DAPPS_CONFIG

If you have subscribed to notifications, you will receive webhooks when the DApp configuration of your EVM account is edited. See our Help Center for more details on the configuration of DApps for EVM accounts.

🆙 Solana Staking - Stake Add fields - 1.14.1

On Retrive all Solana Stakes you can now find the activation_date and deactivation_date in the blockchain_state

February 2023

Note that an update of the Ledger Authentication Module (LAM) to the image version 1.8.0 is required to benefits from the following changes

🆕 New LAM version 1.8.0

A new LAM version was release for technical updates to be compatible with incoming noise chanel v2 upgrade. Reach out to your account manager for more information.

🆕 Ethereum Staking reporting Endpoints

You can use the new convenient Ethereum staking endpoints to access staking specific information in Ethereum account coin_fields and have a listing of all the current stakes via the /stakes. In the next release we will keep enhancing the reporting capabilities.

🆕 New Account Balance endpoint

Each network feature it's own set of specificities, therefore to display network specific balances for DeFi or staking for example you will have enhance balance reporting via the /balance on each accounts. At all time it will include the balances from the get account endpoint.

🆙 New List All Available Tokens and remove endpoint to list ERC20 only

Ledger Enterprise now support multiple emv compatible chains a new endpoint was created to keep track of all available tokens that can be secured in your vault. The previous endpoint specialized in listing ERC20 tokens via the /erc20s/{contractaddress}. You can now list all tokens via the [/currencies/tokens](/openapi/leapi/operation/get_tokens/)

🆙 Transaction Endpoint Update

Transaction senders field: we now return transactions’ sender(s) as a dedicated Transaction response field when you query transactions through the GET /transactions endpoints

January 2023

Note that an update of the Ledger Authentication Module (LAM) to the image version 1.7.1 is required to benefits from the following changes

🆕 Solana Staking

It is now possible to stake directly via our API for the Solana network. You can use the new convenient solana staking endpoints to create stakes, get stakes, undelegate, withdraw, delegate, split, split&deactivte and merge.

December 2022

Note that an update of the Ledger Authentication Module (LAM) to the image version 1.6.0 is required to benefits from the following changes

🆕 Polkadot Staking

It is now possible to stake directly via our API for the Polkadot network. You can use the Transaction endpoint and dedicated coinfields or use the new convenient staking endpoints for polkadot, SEND, BOND, BONDEXTRA, UNBOND, REBOND, SET_PAYEE.

🆕 Smart contract interactions via API - New option: contract inputs in ABI format

Reminder: The Ledger Enterprise API lets you interact with any smart contract on the Ethereum blockchain. The transaction creation & approval endpoints make it possible to trade on decentralized exchanges, deposit liquidity on DeFi protocols, mint or transfer NFTs programmatically and at scale, all while using Vault Ethereum accounts (other EVM networks will follow very soon). New option: We have added optional fields to our Create a transaction & Approve Transaction endpoints, to facilitate the creation & approval of smart contract interactions. API operators who do not wish to encode contract data inputs can now provide the contract ABI, and name the contract functions and arguments they wish to execute, following the ABI specification. For more information on how to conduct smart contract interactions on the Ledger Enterprise platform see this article: Smart Contract Interactions on the Vault.

🆙 Existing endpoint improvements:

Transactions can now be searched by note title or content, using the label query param Transactions queried by API now include a block confirmation object to facilitate on-chain tracking Whitelists queried by API now include XRP tags We’ve improved the generation of fresh receiving addresses for UTXO-based coins

November 2022

Note that an update of the Ledger Authentication Module (LAM) to the image version 1.5.1 is required to benefits from the following changes

🆙 API whitelist field change

In the whitelist section, the field destinationtag, which was an integer, has now become: destinationtags: array of integers You can see the change in our API documentation here.

September 2022

Note that an update of the Ledger Authentication Module (LAM) to the image version 1.5.1 is required to benefits from the following changes

🆕 Estimate fees via our API

The Ledger Enterprise API now lets you estimate transaction fees before you initiate a transaction request. API operators can assess the maximum fees required for their desired transaction attributes and speed, using our new transaction fee endpoint. See our API documentation and transaction fee documentation for details.

September 2022

Note that an update of the Ledger Authentication Module (LAM) to the image version 1.4.2 is required to benefits from the following changes

🆕 API and smart contract interactions

The Ledger Enterprise API now lets you interact with any smart contract on the Ethereum blockchain. The transaction creation & approval endpoints make it possible to trade on decentralized exchanges, deposit liquidity on DeFi protocols, mint or transfer NFTs programmatically and at scale, all while using Vault Ethereum accounts. A new field now lets API operators add smart contract data to their API transaction creation requests (see our API documentation). Such API requests will trigger the creation of a smart contract interaction transaction, which will follow the account’s smart contract governance rule. Note that an update of the Ledger Authentication Module (LAM) to the image version (1.4.2) is required to benefits from the following changes smart contract interactions with the Ledger Enterprise API. See Step 3 of the LAM installation process: Get started with the Ledger Vault's API. For more information on how to conduct smart contract interactions on the Ledger Enterprise platform see this article: Smart Contract Interactions on the Vault.

August 2022

Note that an update of the Ledger Authentication Module (LAM) to the image version 1.4.2 is required to benefits from the following changes

🆕 New webhook notifications: workspace management events

To help you monitor and optimize your operations beyond crypto transactions, we've extended webhook notifications to new event types on Ledger Vault. The Ledger Vault API can now notify you about all requests and events related to the management of your workspace: When you create or edit accounts & entities When you add or revoke users & groups When you create or edit whitelists Find more information on notifications in our API guidelines here: API documentation

July 2022

Note that an update of the Ledger Authentication Module (LAM) to the image version 1.4.2 is required to benefits from the following changes

🆙 API and smart contract interactions

We're currently working on supporting smart contract interactions via our API. To that end, a few small changes have been made under the curtain.

June 2022

Note that an update of the Ledger Authentication Module (LAM) to the image version 1.4.0 is required to benefits from the following changes

🆙 LAM/ HSM integration new secure channel

We're currently working on supporting smart contract interactions via our API. To that end, a few small changes have been made under the curtain.