bestinslot-xyz/brc20-programmable-module v0.16.0

on GitHub

Chore

• update dependencies and tests for bip322
• Update API
• Update dependencies and add new packages
  • Updated alloy to version 1.1.2 and related packages to their latest versions.
  • Updated hyper to version 1.8.1 and jsonrpsee to version 0.26.0.
  • Updated revm and related packages to their latest versions.
  • Updated criterion and insta to their latest versions.
  • Updated tower-http, tracing, and tracing-subscriber to their latest versions.
  • Updated test-utils dependencies to match the main project.
• cargo fmt
• add release configuration file for versioning and changelog generation
• Release brc20-prog version 0.11.5
• cargo fmt
• Cargo fmt
• Run cargo fmt
• Bump version to 0.6.2
• Update package metadata in Cargo.toml
• Move documentation for Brc20ProgApi to top-level module
• Move super:: imports to crates
• Run cargo fmt
• Update dependencies and update RPC authorization middleware to latest jsonrpsee library
• Bump version of brc20_prog to 0.2.0
• Bump version of brc20_prog to 0.1.1 in Cargo files

Documentation

• Add description for txpool_content method in README.md
• Update brc20_deploy, brc20_call, brc20_transact method parameters to include op_return_tx_id field
• Simplify cargo run command in README
  Removed the 'server' feature requirement from the run command, as it's now enabled by default
• Add warning about ticker case sensitivity and format in README
• Add caution note about basic auth and secure connections in README
• Remove warning about zstd compression stack size requirement from README, as it now uses Vec instead of a fixed size slice
• Update README to include note about BRC20 indexer integration and enhance operation checks for deploy/call inscriptions
• Update module documentation for clarity and completeness
• update README with warnings about BRC20 balance server and BIP322_Verifier contract limitations

New Features

• eth_call* and eth_estimateGas* methods now wait for block finalisation instead of failing when they are called mid-block

  • feat: Wait for block finalisation on eth_call* methods

  • test: Update mid-block read contract test to wait for block finalisation

  • fix: Notify waiters when clearing caches to prevent indefinite waiting, and fail gas estimation if block height change during estimation

• Enhance gas estimation logic with binary search adjustments
• Add gas estimation with binary search for estimateGas and estimateGasMany
• Implement eth_callMany with precompile data injection
• Change tx hash computation to use RLP hash from a set block height
• Sort transactions by index in block processing
• Add debug methods for block trace string retrieval
• Add PrecompileData struct and update eth_callMany and eth_estimateGasMany methods to include precompile_data parameter
• Add revm-bytecode dependency to avoid bringing the whole revm for non-server version and update imports
• Update alloy to v1.1.0, revm to v31.0.0, remove revm_state and refactor accordingly
  • Updated dependencies in Cargo.toml to their latest versions, including:
    • alloy to 1.1.0
    • revm to 31.0.0
    • serde to 1.0.228
    • tokio to 1.48.0
    • criterion to 0.7.0
    • tempfile to 3.23.0
  • Updated imports from revm_state to revm::state for consistency.
  • Modified EVM execution logic to use new transaction handling methods.
  • Adjusted precompile functions to utilize U256 for block height instead of u64 (following revm).
  • Added tests to ensure correct behavior with updated block height handling.
• Enhance BRC20 precompiles with op_return_tx_id support (enabled after the prague upgrade)
  • Updated get_evm to accept current_op_return_tx_id and pass it to BRC20Precompiles.
  • Modified hardfork activation heights for mainnet and signet.
  • Introduced get_op_return_tx_id_precompile to retrieve the op return transaction ID.
  • Added gas cost for fetching the op return transaction ID.
  • Updated RPC server methods to include op_return_tx_id parameter.
  • Enhanced tests to validate behavior with and without op return transaction IDs.
• use the block height parameter to eth_call and eth_estimateGas
• implement dynamic EVM spec selection based on block number and network
• enhance error handling for eth_call and eth_estimateGas with status codes and detailed messages in RPC server
• Implement web3_ api in Brc20ProgApi
• Add a global values database to Brc20ProgDatabase and disallow multiple reorgs by storing a global maximum reorg height
• Refactor transaction handling by removing unnecessary fields, and simplify the code
  • Updated the TxED struct to use the new Signature struct, simplifying the transaction data structure.
  • Refactored TxReceiptED by removing unused fields and adjusting the encoding/decoding logic accordingly.
  • Modified the BRC20ProgEngine to utilize the new Signature struct when creating transactions.
  • Updated the RPC server to handle the new transaction receipt structure.
  • Adjusted tests to reflect changes in the transaction and receipt structures, ensuring proper validation of transaction results using "debug_traceTransaction".
  • Incremented database version to 8 to reflect schema changes.
• Add brc20_transact method for sending raw signed transactions and update parameter names
• Add debug_getRaw* methods in the API and update version to 0.10.0
• Add "brc20_transact" method to indexer methods list
• Store and serve v,r,s fields from raw signed transactions, bump version to 0.9.0
• Enhance BRC2.0 with pending transaction management
  • Added a new database structure to handle pending transactions, allowing for efficient retrieval and management of transactions by account and nonce.
  • Implemented methods to set, get, remove, and clear pending transactions, ensuring transactions can be processed in order.
  • Updated BlockCachedDatabase to support new operations for managing key-value pairs, and removals.
  • Modified BRC20ProgEngine to handle pending transactions during block processing, ensuring that transactions are executed in the correct order.
  • Updated RPC server to expose new endpoints for querying pending transactions.
  • Added comprehensive tests to validate the new transaction handling logic, including scenarios for out-of-order transactions and transaction expiration.
• Support using RawBytes and Base64Bytes types together in BRC2.0 API
  • Updated the BRC20ProgEngine to include a TODO for handling future nonces.
  • Replaced EthBytes and InscriptionBytes with RawBytes and Base64Bytes in the API types.
  • Modified the RPC server to accommodate the new data types for deploy and call methods.
  • Added tests to validate the new encoded data handling for transactions and calls.
• Add brc20_transact endpoint to handle signed evm transactions, currently disabled via config
• Gate server-side features under "server" feature, this reduces client compilation time
  • Removed redundant input field from EthCall
  • Moved main.rs in a separate binary setup with the "server" feature required
  • eth_getTransactionCount now correctly returns the account nonce
  • Bumped version to 0.7.0
• Implement TryFrom trait for AddressED and FixedBytesED, add is_zero method to UintED
• Implement TryFrom trait for AddressED and FixedBytesED, add is_zero method to UintED
• Add EVM call gas limit configuration
• Reduce GitHub Actions stack size to 2MB, move long responses in precompile tests into assets
• Implement some precompile tests in rust
• Add zstd compression support with 1MB buffer size, reorganise some internal variables
• Increase block gas limit to 4MB (block size) * 12K (gas per byte)
• Add functionality to retrieve inscription ID by contract address, bump db version to 2
• Handle nada encoding in inscription data (not activated until compression activation height is set)
• Add PROTOCOL_VERSION to configuration and database validation
• Update environment variable name for BITCOIN_RPC_NETWORK, and use a denylist for RPC method auth
• Add dotenv support and update dependencies
• Validate bitcoin network using bitcoin rpc
• Add EVM_RECORD_TRACES to env sample
• Add an environment variable to toggle trace recording
• Refactor contract call methods to redirect invalid transactions to 0xdead
• Add inscription_id field to TxED and implement API method to retrieve it
• Upgrade Solidity compiler to version 0.8.28 and update related dependencies
• Enable optimizer and update output file generation in BRC20_Controller contract
• Add a js script for BRC20_Controller contract to fix solc version
  BytecodeED doesn't return trailing zeroes anymore when serialised
• Implement HTTP Basic Authentication middleware for RPC server, it allows all methods that start with eth_*, and rejects everything else if the request is unauthenticated
• Add basic HTTP authentication support to the brc20_prog RPC server
• Add data_or_input method to EthCall for improved data handling
• Ignore transactions that happen in the future in tx details precompile
  Use a PrecompileCall struct to pass parameters to precompiles
• change ticker parameter type to Bytes in transaction loading functions and add ticker_as_bytes utility function
• include assigned gas limit in txes
• verify new blocks don't already exist in the database, and generate new hashes for new blocks with hashes 0x00..00
• add gas_price and syncing methods to Brc20ProgApi (to enhance explorer compatibility)
• Add transfer tx for sample erc20 contract
• Add an ERC20 contract example

Bug Fixes

• update nonce retrieval to use get_account_nonce for pending transactions
• Update eth_get_storage_at to return full length hex-encoded storage values
• Update expected gas response values in test cases
• keep midpoint instead of gas_used * 2 as upper bound to cover some edge cases
• Clean up properly if transact_one(tx) returns an error
• Clean up properly if transact_one(tx) returns an error
• Add gas usage assertions in deploy_call, precompiles, and transact tests
• Handle None case in get_info_from_raw_tx and update related logic, invalid chain ID shouldn't return error, and just ignore the transaction
• Sort transactions by index in Brc20ProgDatabase
• Update comment to clarify placeholder usage for block hash in get_transaction_and_block_hash_with_overrides
• Rename getBtcTxId to getTxId for consistency in function naming
• Update public API (serde -> serde_core)
• ensure pending transactions are committed, cleared, and reorganized in Brc20ProgDatabase
• allow "mainnet" and "bitcoin" to be used interchangeably
• update generate_block to accept block_hash as a parameter
• reorder block hash setting to avoid race conditions
• revert version bump, this is automated now
• bump version to 0.13.0 in Cargo.toml
• serialize transaction type into hex
• update homepage URL in Cargo.toml
• update pre-release hook to correctly format CHANGELOG.md generation
• update pre-release hook to correctly generate and add CHANGELOG.md
• update read method signature to use lifetime annotation
• update read method signature to use lifetime annotation
• remove test data files for BRC20 balance calls
• bump version to 0.11.4
• remove flag from RawBytes#value() function
• add step to build with no default features in CI workflow
• bump version to 0.11.3
• update keccak256 import from revm to alloy
• bump version to 0.11.2
• update public_api snapshot
• Correct version string format in web3_client_version method
• Improve error handling in contract address resolution
• Refactor Brc20ProgDatabase to remove redundant timestamp and gas methods, they are stored in the block database already
• Migrate back the bip322 crate after the fix and remove the fork
• Simplify reorg logic in BlockHistoryCache and UintED serialization/deserialization
• Enhance bytecode handling with error checks during deserialization and decoding
• Update inconsistent docs
• Fix test_reorg_all_blocks to reorg only 10 blocks
• Bump version of brc20-prog to 0.10.4
• Use a fork of bip322 for a patch where it crashes
• Ensure latest value retrieval from the cache is never empty, and reorgs also panic if there's an attempt to empty the cache
• Update BITCOIN_RPC_URL to use address
• Replace "DB Error" with a static error message and panic instead of returning an error, as it's not recoverable
• Couple of bug fixes for reorg handling on database

  • Use get_next_block_height method in DatabaseCommit methods to fix an off-by-one error in reorgs, which might incorrectly keep old values

  • Use stored values to create the cache for cache misses, otherwise reorgs might cause data loss if reorg happens on a value that hasn't been updated in a long time, and updated just before a reorg happens

  • Chore: bump rocksdb version to 0.24.0 (librocksdb was updated in this version)

  • Chore: bump brc20-prog version to 0.10.3

• Bump version to 0.10.2 for brc20-prog
• Refactor Bitcoin RPC validation logic and remove unnecessary checks
• Clarify initialization process for BRC20_Controller and empty block handling in README
• Bump version to 0.10.1 and ensure raw_block_ed module is conditionally compiled
• Update Discord (badge was broken) and add Telegram link to README
• Prefix hex-encoded strings with "0x" in RawBlock methods
• Correct comment formatting for RawBytes struct documentation
• Handle extra padding in base64 decoding for inscription data
• Correctly increment transaction index in pending transaction execution
• Update DB_VERSION to 5 in configuration
• Update ecrecover call to use adjusted v value and remove ignore from tests
• Ignore raw tx tests as they fail to recover the correct address at the moment
• Remove conditional flags for some imports
• Remove optional flag from nada and zstd-safe dependencies, as clients can use these to generate encoded data
• Rename db.rs > brc20_prog_database.rs
• Update LastBlockInfo to track total processing time
• Reduce gas usage from 100k to 20k for bip322 precompile
• Check if the transaction is in the future in last sat location precompile
• Readjust stack size to 4MB in GitHub Actions workflow (again)
• Update alloy-sol-types dependency version to 1.1.0
• Update result field name from resultBytes to output in transaction receipt
• Remove unused import of E from std::f32::consts
• Return an error if block range is too large for eth_getLogs
• Better eth_getLogs topic and address handling
• Remove unused rust-embed feature "include-exclude"
• Use dotenvy instead of unmainained dotenv, avoid embedding the source for brc20_controller contract to reduce binary size
• Simplify assertions in tests for AccountInfoED conversions
• Serialize block nonce to full hex length
• Make authorisation logic exclusive to brc20_ methods, and fix TraceED encoding
• Simplify serialization and encoding of BytecodeED by using original_bytes
• Return BytecodeED from eth_getCode, so it gets serialised without the trailing zeroes
• Handle missing contract addresses by using Address::ZERO in Brc20ProgApiServer
  This way, receipts for invalid inscriptions are also recorded in the chain
• Move Id import to tests
• Return correct ID ffrom RpcAuthAllowEth
• Fix HttpNonBlockingAuth for allow_all(...)
• update BRC20 locked pkscript precompile result for integration tests
• Include data in returned error instance for eth_call and eth_estimateGas
• prevent deadlock in get_block_by_hash by releasing the mutex after accessing it
• rename block_hash field to blockHash for consistency in serialization
• convert contract bytecode using to_string to add the 0x prefix
• rename block_hash field for serialization
• mine_blocks genesis block count
• Update import path for ERC20 contract in BobCoin.sol
• Show float numbers in test_generator.py
• Make get_range end key comparison exclusive

Other

• Add changelog file (generated by cargo smart-release)
• remove release configuration file and associated pre-release hooks to allow regeneration
• Add support for raw signed transaction inscriptions and update relevant methods in README

Refactor

• Do a first run on eth_estimateGasMany and eth_estimateGas for an early exit in case calls fail
• change inscription_id and inscription_byte_len from Option to required fields in API and update database structures
• remove legacy fields from TxReceiptED struct
• generate receipts for invalid transactions
• Update public api and fix a visibility error
• Add configurable request/response size limits and batch request settings to RPC server
• Remove batch request limit from RPC server configuration
• ditto, improve error message for Bitcoin RPC status check failure
• Improve error handling in Bitcoin RPC status check
• Rename DB_PATH to BRC20_PROG_DB_PATH for consistency in env.sample
• Enhance RPC server configuration with request/response size limits and batch request settings
• Print the error message in get_brc20_balance function when it fails
• Bump version to 0.11.1 and update binary name in Cargo.toml
• Update eth_getCode to return 0x if there's no code present for compliance
• Modify eth_call in RpcServer to return 0x or the revert reason for compliance
• Add legacy fields back in BlockResponseED and TxReceiptED for backwards compatibility
• Add input size limit warning for bip322_verify_precompile to prevent excessive resource usage
• Enhance ConfigDatabase by adding caching and implementing flush functionality
• Use catch_unwind for BRC20 balance server checks to handle potential panics gracefully
• update public api
• Simplify balance retrieval by removing error handling from get_brc20_balance function, it now panics when balance server is unreachable or provides invalid data instead of silencing it
• Remove brc20 event simulator test
• Replace CHAIN_ID with Brc20ProgConfig.chain_id in various modules to enable using different chain IDs for signet and mainnet
• Update raw tx handling to use alloy TxLegacy type
• Fix cargo doc
• Move conditional compilation for Brc20ProgDatabase to a separate line
• Disable logging for common block retrieval calls to reduce noise
• Update database version from 3 to 4 in configuration, as previous gas values need adjustment
• Move gas usage and history size constants to the global package, adjust gas usage for precompiles sending an RPC
• Update BRC20 types to replace EncodedBytes with InscriptionBytes and EthBytes for improved clarity and functionality
• Update decompression buffer to use dynamic Vec instead of fixed array
• Update benchmark functions by removing unused transaction detail cases, add min stack requirement to readme
• Add more test cases for bitcoin mainnet rpc tests and run bitcoin rpc tests sequentially
• Update BTC precompiles to use faster transaction and block height retrieval methods
• Refactor to use a "Transaction" instance instead of "GetRawTransactionResult" in BTC precompiles
• Remove redundant names from instrument attributes in Brc20ProgApiServer implementation
• Refactor Brc20ProgApiClient methods to include 'brc20_' and 'eth_' prefixes and update related client calls
  • Adjusted public API snapshot to match the updated API method signatures.
• Reorganise engine into its own package alongside the evm, and public api types into the API package, add a public_api test to check for changes in the API
• Replace Wrapper types with ED types in API and RPC server
• Handle JSON-RPC error code -5 without panicking
• Remove minimum gas limit constant and handle inscription byte length in tests
• Move dotenv call to Brc20ProgConfig
• Update BRC20Precompiles initialization to use a constructor
• Simplify revm integration
  • Add a TracingInspector to use later
  • block.prevrandao is now set to current block hash
• Simplify EVM setup
• Make tests ignore the result of .initialise(...)
• Remove unused test imports, use alloy_primitives instead of revm re-exports
• Split db/mod.rs into db.rs / mod.rs, rename server_instance.rs to engine.rs
• Use read/write locks for evm database and propagate errors into the RPC layer to wrap and display
  • Renamed ServerInstance to BRC20ProgEngine (will rename the file in a follow-up to keep the diff)
  • Refactored error handling for various operations e.g. transaction validation and block finalization.
  • Created a shared data structure for access to database and block information, RwLocks now allow faster/parallelised reads
• Update module visibility across various files
• Rename variables for clarity in various modules
• Simplify data decoding in decode_brc20_balance_result function
• Refactor calls to unwrap() for Result/Options to avoid unnecessary panics
  Use rust-bitcoincore-rpc library for precompiles
• remove unused FromHex import in brc20_controller
• rename verify_block_does_not_exist to require_block_does_not_exist
• change account parameter type to AddressWrapper in get_transaction_count method
• add chain_id and tx_type fields to TxED and update related structures, run cargo fmt
• change transaction index parameter to be optional
• update EthCall struct to make 'from' field optional and use zero in contract calls if from is empty
• Use LogResponse for eth_getTransactionReceipt for correct eth JSON-RPC format and add v,r,s fields to eth_getTransaction* methods
• streamline byte, string and address conversions to use into() and parse() for type flexibility and consistency
• simplify encode method to return Vec directly instead of Result, as it never fails
• update Brc20ProgApi call and estimate_gas methods to use EthCall struct and optional input data
• Rename block count variables for clarity

Test

• opt-in live signet getTxDetails precompile test

  • test(btc): opt-in live signet getTxDetails precompile test

  Exercises the getTxDetails Bitcoin-RPC precompile end to end against a
  real signet node (no mocking). Opt-in via BRC20_RUN_BTC_RPC_TESTS=1 plus
  signet RPC env; skips cleanly otherwise so it is safe in CI.

• cover validate_config and from_env

  • test(config): cover validate_config and from_env logic

  Config parsing/validation had zero coverage. Adds tests for
  validate_config (valid config, auth-without-credentials rejection,
  empty RPC URL, Bitcoin-URL requirement gated on fail_on_bitcoin_rpc_error)
  and from_env (mainnet vs testnet chain-id selection, malformed numeric
  env falling back to default).

• cover controller helpers and deposit/withdraw/balance

  • test(brc20_controller): cover address verification and balance decoding

  Unit tests for verify_brc20_contract_address (accepts canonical
  address, rejects other/unparseable) and decode_brc20_balance_result
  (None and malformed data decode to zero, valid ABI word decodes to its
  value).

• cover block/tx/code/storage reads and eth_getLogs filtering

  • test(eth): cover block/tx/code/storage read methods

  Integration test exercising the eth_* read surface that lacked
  coverage: eth_getBlockByNumber/ByHash, eth_getBlockTransactionCountBy*,
  eth_getTransactionByHash/ByBlockNumberAndIndex/ByBlockHashAndIndex,
  eth_getTransactionCount, eth_getCode and eth_getStorageAt, all
  cross-checked after a deploy + finalise.

• cover reorg, commit_to_db, clear_caches

  • test(engine): cover reorg happy-path, no-op, and rejection cases

  reorg() had zero coverage despite being a correctness-critical state
  rollback path. Adds inline tests for: rollback discarding blocks above
  the valid height, reorg-to-tip being a no-op, and rejection of
  future/too-far-behind targets without mutating the chain.

• Update tests

• add unit test for Prague spec BLS precompiles inclusion

• Change out of order test to send 3 transactions

• Split benchmark for BTC precompiles

• Split env setup in tests into .env.mainnet and .env.signet

• Add mainnet precompile tests (works with a .env setup)

• Add microsecond and second tests for gas processing times in opcode generator test

• Migrate precompile benchmarks to Rust

• Move test utilities to their own package, add a benchmark for calling the bip322_verify precompile
  Refactored test files to utilize the new test-utils crate for loading files and spawning test servers.

• Add BRC20 balance test and a deploy/call test

• Update test cases to use a non-zero value for inscription byte length

• Add serialization test for BlockResponseED

• Add unit tests for BRC20ProgEngine and RpcServer methods

• Add unit test for HttpNonBlockingAuth allow_all method

New Features (BREAKING)

• Remove BRC20 balance precompile
• Remove BRC20 balance precompile and update version to 0.12.0
  Associated proposal: https://github.com/bestinslot-xyz/brc20-proposals/blob/main/002-prog-brc20-precompile-removal/index.md

Commit Statistics

• 460 commits contributed to the release.
• 260 commits were understood as conventional.
• 6 unique issues were worked on: #4, #5, #6, #7, #8, #9

Commit Details