ar.io Docs

# ar.io Release Notes

# Overview

Welcome to the documentation page for the ar.io gateway release notes. Here, you will find detailed information about each version of the ar.io gateway, including the enhancements, bug fixes, and any other changes introduced in every release. This page serves as a comprehensive resource to keep you informed about the latest developments and updates in the ar.io gateway. For those interested in exploring the source code, each release's code is readily accessible at our GitHub repository: ar.io gateway change logs (opens new window). Stay updated with the continuous improvements and advancements in the ar.io gateway by referring to this page for all release-related information.

# [Release 9] - 2024-04-10

  • Added
    • Added experimental Farcaster Frames support, enabling simple Arweave based Frames with button navigation. Transaction and data item data is now served under /local/farcaster/frame/<ID>. /local is used as a prefix to indicate this functionality is both experimental and local to a particular gateway rather than part of the global gateway API. Both GET and POST requests are supported.
    • Added an experimental local ArNS resolver. When enabled it removes dependence on arweave.net for ArNS resolution! Enable it by setting RUN_RESOLVER=TRUE, TRUSTED_ARNS_RESOLVER_TYPE=resolver, and TRUSTED_ARNS_RESOLVER_URL=http://resolver:6000 in your .env file.
    • Added an X-Cached header to data responses to indicate when data is served from the local cache rather than being retrieved from an external source. This is helpful for interfacing with external systems, debugging, and end-to-end testing.
    • Save hashes for unbundled data items during indexing. This enables reduction in data storage via hash based deduplication as well as more efficient peer-to-peer data retrieval in the future.

# [Release 8] - 2024-03-14

  • Added

    • Added GraphQL SQL query debug logging to support trouble-shooting and performance optimization.
    • Added support for indexing data items (not GraphQL querying) based solely on tag name. (example use case: indexing all IPFS CID tagged data items).

  • Changes

    • Observer data sampling now uses randomized ranges to generate content hashes.
    • Reference gateway ArNS resolutions are now cached to improve report generation performance.
    • Contract interactions are now tested before posting using dryWrite to avoid submitting interactions that would fail.
    • /ar-io/observer/info now reports INVALID for wallets that fail to load.

  • Fixed

    • Fix data caching failure caused by incorrect method name in getData circuit breakers.
    • Fix healthcheck when ARNS_ROOT_HOST includes a subdomain.

# [Release 7] - 2024 - 02 - 14

  • Added

    • Add support for notifying other services of transactions and data items using webhooks (see README for details).
    • Add support for filter negation (particularly useful for excluding large bundles from indexint).
    • Improve unbundling throughput by decoupling data fetching from unbundling.
    • Add Envoy and core service ARM builds.

  • Changed

    • Improve resouce cleanup and shutdown behavior.
    • Don't save Redis data to disk by default to help prevent memory issues on startup for small gateways.
    • Reduce the amount of data sampled from large files by the observer.
    • Ensure block poa2 field is not chached to reduce memory consumption.

# [Release 6] - 2024-01-29

  • Fixed
    • Update observer to improve reliability of contract state synchronization and evaluation.

# [Release 5] - 2024-01-25

  • Added

    • Added transaction offset indexing to support future data retrieval capabilities.
    • Enabled IPv6 support in Envoy config.
    • Added ability to configure observer report generation interval via the REPORT_GENERATION_INTERVAL_MS environmental variable. (Intended primarily for development and testing)

  • Changed

    • Updated observer to properly handle FQDN conflicts.
    • Renamed most created_at columns to index to indexed_at for consistency and clarity.

  • Fixed

    • Updated LMDB version to remove Buffer workaround and fix occasional block cache errors.

# [Release 4] - 2024-01-11

  • Added

    • Added circuit breakers around data index access to reduce impact of DB access contention under heavy requests loads.
    • Added support for configuring data source priority via the ON_DEMAND_RETRIEVAL_ORDER environment variable.
    • Updated observer to a version that retrieves epoch start and duration from contract state.

  • Changed

    • Set the Redis max memory eviction policy to allkeys-lru.
    • Reduced default Redis max memory from 2GB to 256MB.
    • Improved predictability and performance of GraphQL queries.
    • Eliminated unbundling worker threads when filters are configured to skip indexing ANS-104 bundles.
    • Reduced the default number of ANS-104 worker threads from 2 to 1 when unbundling is enabled to conserve memory.
    • Increased nodejs max old space size to 8GB when ANS-104 workers > 1.

  • Fixed

    • Adjusted paths for chunks indexed by data root to include the full data root.

# [Release 3] - 2023-12-05

  • Added

  • Changed

    • Used pinned container images tags for releases.
    • Default to Redis header cache when running via docker-compose.
    • Default to LMDB header cache when running via yarn start.

  • Fixed

    • Correct GraphQL pagination for transactions with duplicate tags.