Releases: utxostack/btc-assets-api
v2.4.2
What's Changed
- fix: amount calculation in the rgbpp address balance endpoint by @ShookLyngs in #206
- fix: duplicated bindings in the activity API by @ShookLyngs in #194
- refactor: optimize performance of
queryBtcTimeLockTxByBtcTx()
by @ShookLyngs in #212 - refactor: use constants to replace local variables by @ShookLyngs in #211
- fix: missing basic validation in route params by @ShookLyngs in #213
- fix: incorrect count of delayed jobs in the enqueueTransaction test by @ShookLyngs in #217
- chore: bump devbox dependencies, also bump axios to 1.7.7 by @ShookLyngs in #219
Full Changelog: release/v2.4.1...release/v2.4.2
v2.4.1
What's Changed
- refactor: Filter invalid btc block for btc time cells unlock by @duanyytop in #200
- fix: make sure
infoCellTxs
are asc-ordered by @Flouse in #201 - feat: add /rgbpp/v1/assets/type for get assets type info by @ahonn in #183
Full Changelog: release/v2.4.0...release/v2.4.1
v2.4.0
What's Changed
- fix: capture unhandled electrs backuper error by @ahonn in #172
- feat: show ckb_address in paymaster info, fill paymaster cell queue when app started by @ahonn in #176
- feat: upgrade rgbpp sdk snap version to support signet by @ahonn in #177
- chore: improve sentry by @ahonn in #179
- feat: check recent confirmed utxos to void missing pending xudt by @ahonn in #180
- feat: add type_hash to rgbpp assets routes by @ahonn in #184
- fix: add missing typeHash response field by @ahonn in #186
- fix: catch bitcoin fallback data provider error by @ahonn in #187
- fix: remove app listen error exit 1 by @ahonn in #188
- docs: add get started section to readme by @ahonn in #189
- feat: add rgbpp address activity api by @ahonn in #182
- fix: fix incorrect filter of L2 to L1 transactions by @ahonn in #190
- refactor: migrate swagger to use [email protected] by @ShookLyngs in #192
- feat: support spore leap transaction by @ahonn in #195
- fix: fix spore leap transaction witnesses by @ahonn in #196
Full Changelog: release/v2.3.1...release/v2.4.0
v2.3.1
v2.3.0
What's Changed
- chore: add token info to sentry tags by @ahonn in #153
- feat(bitcoin): add onlyNonRgbppUTXOs params and calculate rgbpp_satoshi by @ahonn in #154
- fix: fix rgbpp route type_script paramter parse by @ahonn in #157
- feat: add /rgbpp/v1/address/:address/balance for get bound xUDT balance by @ahonn in #146
Full Changelog: release/v2.2.1...release/v2.3.0
v2.2.1
What's Changed
Full Changelog: release/v2.2.0...release/v2.2.1
v2.2.0
What's Changed
- feat: add data cache for UTXO and RGB++ asset cells by @ahonn in #132
- build: upgrade rgbpp-sdk to v0.1.0 by @ahonn in #140
- feat: optimize data cache update mechanism by @ahonn in #137
- feat: parse and check token domain by @ahonn in #138
- feat: add data cache for /bitcoin/v1/address/:address/balance by @ahonn in #141
- docs: update .env.example and simplify default env vars by @ahonn in #139
- fix: fix the error caused by not getting the data field when calling getLiveCells by @ahonn in #143
- feat: trigger utxo data cache update after RGB++ tx confirmed by @ahonn in #142
- fix: validate btc_address in utxo syncer by @ahonn in #144
- fix: fix enqueue utxo sync job with wrong address param by @ahonn in #145
Full Changelog: release/v2.1.0...release/v2.2.0
v2.1.0
What's Changed
Full Changelog: release/v2.0.0...release/v2.1.0
v2.0.0
What's Changed
- fix(error): refactor global error handler to fix inaccurate error message by @ahonn in #111
- feat(bitcoin)!: use mempool.space REST API by @ahonn in #96
- chore(error): add filled count to sentry context by @ahonn in #113
- feat(bitcoin): calculate fees when mempool.space recommend fees api unavailable by @ahonn in #114
- fix: fix the state issue of inactive paymaster cell job by @ahonn in #118
- docs: update env vars and add missing docs by @ahonn in #119
- feat(unlock): add spore BTCTimeLock cells unlock support by @ahonn in #120
- feat(bitcoin): add /bitcoin/v1/transactiona/:btc_txid/hex route by @ahonn in #123
- feat(bitcoin): post btc transaction to multi electrs/btc nodes by @ahonn in #127
- fix: fix bitcoin client error message handle by @ahonn in #129
Full Changelog: release/v1.5.0...release/v2.0.0
Upgrading to V2
We have released v2.0.0 for support mempool.space API as the primary Bitcoin data provider, and it is used to broadcast transactions. But it is still compatible with the electrs used previously.
There are two ways to upgrade:
Upgrading from v1.x.x and use electrs (compatible, by default)
Suppose you do not want to use the mempool.space API as the main data provider, you do not need to make any changes.
But we recommend you remove the following env vars for safety:
BITCOIN_JSON_RPC_URL=<http://bitcoin:8332>
BITCOIN_JSON_RPC_USERNAME=<rpc_username>
BITCOIN_JSON_RPC_PASSWORD=<rpc_password>
and add the following env vars to make sure to use electrs as the primary data provider, and add mempool.space API as a fallback:
BITCOIN_DATA_PROVIDER=electrs # recommend, electrs by default
BITCOIN_MEMPOOL_SPACE_API_URL=https://mempool.space # optional, mempool.space as the fallback
Upgrading from v1.x.x and using mempool.space API
The new feature in v2.0.0, we can use mempool.space API as the primary data provider, and use electrs as a fallback.
Add the following env vars:
BITCOIN_DATA_PROVIDER=mempool
BITCOIN_MEMPOOL_SPACE_API_URL=https://mempool.space
If you want to use the previous electrs as a fallback, keep the original BITCOIN_ELECTRS_API_URL
env var. Otherwise, remove this var to avoid using electrs.
BITCOIN_ELECTRS_API_URL=<http://electrs:3002> # optional, electrs as fallback
Recommended Fees API
If use mempool.space API as the primary data provider, then we can use /bitcoin/v1/fees/recommended
to get the bitcoin fees. and we will calculate fees when mempool.space recommend fees API unavailable (see #114).
use electrs as the primary data provider and didn't set BITCOIN_MEMPOOL_SPACE_API_URL
as a fallback, then recommended fees API will be unavailable