Release Notes

Release Notes - Web3 Services - 2024

2024 release notes for Circle's Web3 Services platform.

October 2024

Release 2024.10.02-v1

We have heard your feedback and have launched a new and improved developer documentation platform. It brings the following features:

New revamped home page: to find all of our developer-centric resources in one place
Interactive API Playground: to quickly test API endpoints
Unified developer portal: combining docs, interactive quickstarts, and APIs - learn.circle.com is now available under developers.circle.com/interactive-quickstarts
Improved User Experience (UX): for easier and faster navigation

And many more features all designed to dramatically improve your experience.

September 2024

Release 2024.09.24-v1

This release adds support to the new Compliance Engine product, including the new Transaction Screening feature and some necessary API additions and updates.

Documentation additions

The following docs have been added to support the new Compliance Engine release with the new Transaction Screening feature:

Compliance Engine
- Transaction Screening

API additions

Added new Compliance Engine APIs:

POST /compliance/screening/addresses

Added new optional transactionScreeningEvaluation field to Transaction schema. The new field contains transaction screening results from the new Compliance Engine. It is available for the following API endpoints:

GET /transactions
GET /transactions/{id}

Release 2024.09.11-v1

Made some API additions to support the Arbitrum blockchain.

API additions

Added enum values ARB and ARB-SEPOLIA to the blockchain request field for the following APIs:

POST /developer/wallets
POST /user/wallets
GET /wallets
GET /transactions
POST /transactions/validateAddress
POST /user/initialize
GET /config/entity/monitoredTokens
GET /contracts
POST /contracts/deploy
POST /contracts/deploy/estimateFee
POST /templates/{id}/deploy
POST /templates/{id}/deploy/estimateFee

Added new networkFee field to the TransactionFee schema, representing the maximum value of native token needed for a transaction. The new field is available for the transaction.estimatedFee field and all estimateFee endpoints:

POST /transactions/transfer/estimateFee
POST /transactions/contractExecution/estimateFee
POST /transactions/contractDeployment/estimateFee
POST /contracts/deploy/estimateFee
POST /templates/{id}/deploy/estimateFee

Release 2024.09.09-v1

Made some API additions and updates for improved parameter preconditions and better error handling.

API additions

Added new sign transaction error SignTransactionRawTransactionTooLarge for Programmable wallet sign transaction APIs when the rawTransaction size exceeds blockchain limit.

POST /user/sign/transaction
POST /developer/sign/transaction

API updates

Fixed a typo in the description of monitoredTokens API endpoint.

GET /config/entity/monitoredTokens

Updated description for contract name field to clarify it only accepts alphanumeric characters.

POST /contracts/import
POST /contracts/deploy
PATCH /contracts/{id}

Release 2024.09.05-v1

Circle's API platform now supports Arbitrum.

Documentation additions

For how to deposit ETH into an Arbitrum wallet, see the tutorial Deposit ETH to Arbitrum.

For a list of APIs that support Arbitrum, see Blockchain Compatibility for Web3 Services APIs.

August 2024

Release 2024.08.22-v1

Made some restructuring of the documentation navigation for improved browsing.

Documentation updates

A new category section was added to our documentation navigation:

SDKs and Sample Apps

All existing documentation for our SDKs and sample apps was moved to this new section.

Release 2024.08.14-v1

This release makes some necessary API additions and updates to support Solana NFTs and Zero balance tokens.

Documentation additions

The following docs have been updated to reflect the supported changes on the Solana network:

API Compatibility for supported blockchains
Testnet Faucets for supported blockchains

API additions

The following new enum values for the standard query parameters and response fields were added:

FungibleAsset
NonFungible
NonFungibleEdition
ProgrammableNonFungible
ProgrammableNonFungibleEdition

for the following API endpoints:

GET /wallets/{id}/nfts
GET /tokens/{id}
POST /user/transactions/transfer
POST /developer/transactions/transfer
GET /transactions
GET /transactions/{id}
GET /config/entity/monitoredTokens
POST /config/entity/monitoredTokens
PUT /config/entity/monitoredTokens

API updates

Made nftTokenId an optional field in the response of the following API endpoints, since Solana doesn't have nftTokenId:

GET /wallets/{id}/nfts

Modified the behavior of several API endpoints related to token balances in a wallet. In particular, tokens with a balance of zero will no longer be included in the API responses for the following endpoints:

GET /wallets/{id}/balances
GET /wallets/{id}/nfts

Note: If you have enabled the monitored token feature, tokens that have a zero balance will still be included in the response.

July 2024

2024.07.25-v1

This release includes two new sign transaction API endpoints for SOL-DEVNET wallets.

API additions

The following endpoints have been added:

POST /user/sign/transaction
POST /developer/sign/transaction

2024.07.23-v1

User-controlled wallets now offer two new authentication methods: social login and email authentication.

Documentation additions

See the following new docs:

API additions

The following new API endpoints have been added:

POST /users/social/token
POST /users/email/token
POST /users/resendOTP
POST /user/token/refresh

API updates

The following API endpoints have been updated for social logins and email authentication:

POST /users/social/token
POST /users/email/token
POST /user/initialize
POST /user/token/refresh
POST /users/resendOTP

The following API endpoints have been updated for PIN authentication:

POST /users
POST /users/token
POST /user/initialize
GET /user
POST /user/pin
PUT /user/pin
POST /user/pin/restore

The following API endpoints have been updated for users:

GET /users
GET /users/{id}
GET /user/challenges
GET /user/challenges/{id}

2024.07.19-v1

This release renames the FT enum to Fungible in the standard query parameters and response fields across multiple API endpoints.

API updates

The FT enum is now the Fungible enum in the standard query parameters and response fields for the following endpoints:

GET wallets/{id}/balances
GET tokens/{id}
GET, POST, PUT config/entity/monitoredTokens

June 2024

2024.06.26-v1

This release includes the FT enum in the standard query parameters and response fields in multiple API endpoints.

API additions

Added the FT enum to the standard query parameters and response fields in the following endpoints:

GET wallets/{id}/balances
GET wallets/{id}/nfts
GET tokens/{id}
GET config/entity/monitoredTokens
POST config/entity/monitoredTokens
PUT config/entity/monitoredTokens

2024.06.20-v1

This release adds a new field to the /contracts/deploy/estimateFee endpoint.

API additions

Added new AbiJson field in the following API endpoint:

POST /contracts/deploy/estimatefee

2024.06.18-v1

A new Smart Contract template is available for Airdrop.

Documentation additions

To learn more about the new Airdrop template, see Airdrop.

2024.06.13-v1

This fix updates the signTypedData API response for both user-controlled wallets and developer-controlled wallets.

Documentation updates

The v value in the signature response has changed from 0/1 to 27/28 to ensure compatibility with most verification methods in the following API calls:

POST /user/sign/typedData
POST /developer/sign/typedData

2024.06.12-v1

New server-side SDKs are available for Node.js and Python.

Documentation updates

A new version of the Node.js SDK is available. To set up the server-side Node.js SDK in your application. See the Node.js SDK guide.

A new server-side Python SDK is available. To set up the Python SDK in your application. See the Python SDK guide.

2024.06.11-v1

Programmable Wallets is now available on Solana.

Documentation additions

To see what's available, see the Programmable Wallets on Solana guide.

API additions

Added enum values SOL and SOL-DEVNET to the blockchain request and response fields for the following APIs:

POST /faucet/drips
POST /developer/wallets
POST /user/wallets
GET /wallets
GET /transactions
POST /transactions/validateAddress
POST /user/initialize
GET /config/entity/monitoredTokens

API updates

Updated description of fee parameters for Solana use case.

Updated description of AccountType for Solana use case.

Fixed blockchain request field to be string enum for the following APIs:

POST /user/transactions/transfer
POST /developer/transactions/transfer
POST /transactions/transfer/estimateFee

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy