Skip to content

Latest commit

 

History

History
170 lines (120 loc) · 7.08 KB

CHANGELOG.md

File metadata and controls

170 lines (120 loc) · 7.08 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

  • Simpler start boilerplate, simpler structures to deal with!

Breaking changes

This version introduces a different much simplified concept of Lake Framework usage. Thus it brings breaking changes.

We introduce near-lake-primitives crate with simplified primitive structures (e.g Block, Transaction, StateChange, etc.) which is heavily used by Lake Framework since now.

And some other changes:

  • LakeConfig is renamed to be just Lake. It is done because since this update Lake is accepting the indexing function from a user and runs the streamer implicitly. Thus shortening and simplifying the start boilerplate to something like this:

    fn main() -> anyhow::Result<()> {
    // Lake Framework start boilerplate
    near_lake_framework::LakeBuilder::default()
        .mainnet()
        .start_block_height(80504433)
        .build()?
        .run(handle_block) // user-defined asynchronous function that handles each block
}

    Please note your main function isn't required to be asynchronous anymore! It is now handled by Lake Framework under the hood.

0.7.2

  • Upgrade near primitives crate to 0.17.0
  • Upgrade tokio version to the latest (1.28.2)

0.7.1

  • Refactor s3_fetchers to allow testing
  • Fix betanet default region (the corresponding bucket is in different region)

0.7.0

  • Add support for Meta Transactions NEP-366 by upgrading near-indexer-primitives to 0.16
  • Add helper function for connecting to betanet lake

Breaking change

  • Delegate action has been introduced in near-primitives::views::ActionView, this should be handled everywhere you are handling ActionView

0.6.1

  • Fix of possible silent stops of the streamer (firing logs and returning errors where necessary)
  • Fix the issue the streamer was always 1 block behind
  • Renamed a few internal methods to reflect what they do
  • Added debug and error logs in a few places
  • Introduced a LakeError enum using thiserror (#42), but not exposing it yet to avoid breaking changes to the framework (for now, it will be done in 0.7.0)
  • Added proper error handling in a few places
  • Updated the dependencies version of AWS crates

0.6.0

  • Upgrade underlying dependency near-indexer-primitives to versions between 0.15 and 0.16

Breaking change

near-indexer-primitives reflects some breaking changes in the data types. Some of the fields that were previously a base64-encoded String that now became raw Vec<u8>:

  • views::ActionView::FunctionCall.args
  • views::QueryResponseKind::ViewState
  • views::ExecutionStatusView::SuccessValue

Refer to this nearcore commit to find all the changes of this kind.

0.5.2

  • Fixed the bug that caused a lag by 100 blocks that was introduced in 0.5.1

0.5.1

  • Avoid spiky latency with streaming block heights preload

0.5.0 - 2022-06-16

  • Cleaned up unused depdendencies
  • Added the configuration option to control the size of the pool of preloaded blocks blocks_preload_pool_size (100 remains to be the default)
  • Update AWS dependencies to 0.13.0

Breaking change

  • Dropped the previously allowed way to instantiate LakeConfig by manually initializing the public fields in favor of the builder pattern

0.4.1 - 2022-06-14

  • Bumped the minimum required version of serde_json to 1.0.75 to avoid confusing errors when arbitrary_precision feature is enabled.
  • Extended the list of supported near-primitives versions from 0.12.0 to >=0.12.0,<0.15.0 to help downstream project avoid duplicate versions of near-primitives and its dependencies.
  • Reduced verbosity level of recoverable errors from ERROR to WARN

0.4.0 - 2022-05-17

  • Remove calls to .unwrap() and .expect() within the stream sender that could panic. Instead, a Result is returned from the sender task.
  • Remove calls to .unwrap() and .expect() within s3_fetchers module

Breaking change

  • The streamer() function now returns a tuple, with the first element being a JoinHandle<Result<(), Error>> that you can use to gracefully capture any errors that occurred within the sender task. If you don't care about errors, you can easily adapt to this change by changing: 
    let receiver = near_lake_framework::streamer(settings);
    to this instead: 
    let (_, receiver) = near_lake_framework::streamer(settings);

0.3.0 - 2022-05-10

  • Introduce LakeConfigBuilder for creating configs 
    let config = LakeConfigBuilder.default()
  .testnet()
  .start_block_height(88220926)
  .build()
  .expect("Failed to build LakeConfig");
  • Now you can provide custom AWS SDK S3 Config 
    use aws_sdk_s3::Endpoint;
use http::Uri;
use near_lake_framework::LakeConfigBuilder;

let aws_config = aws_config::from_env().load().await;
let mut s3_conf = aws_sdk_s3::config::Builder::from(&aws_config);
s3_conf = s3_conf
  .endpoint_resolver(
    Endpoint::immutable("http://0.0.0.0:9000".parse::<Uri>().unwrap()))
  .build();

let config = LakeConfigBuilder::default()
  .s3_config(s3_conf)
  .s3_bucket_name("near-lake-data-custom")
  .start_block_height(1)
  .build()
  .expect("Failed to build LakeConfig");

Breaking change

LakeConfig has a breaking change as we've removed s3_endpoint and added s3_config. Please, consider migrating to use LakeConfigBuilder instead of directly crafting the Lakeconfig

0.2.0 - 2022-04-25

The first public release. See announcement on NEAR Gov Forum

Release Page: https://github.com/near/near-lake-framework/releases/tag/v0.2.0