Struct near_lake_framework::LakeConfigBuilder

pub struct LakeConfigBuilder { /* private fields */ }

Builder for LakeConfig.

Implementations

impl LakeConfigBuilder

pub fn s3_bucket_name<VALUE: Into<String>>(self, value: VALUE) -> Self

AWS S3 Bucket name

pub fn s3_region_name<VALUE: Into<String>>(self, value: VALUE) -> Self

AWS S3 Region name

pub fn start_block_height(self, value: u64) -> Self

Defines the block height to start indexing from

pub fn s3_config(self, value: Config) -> Self

Custom aws_sdk_s3::config::Config

Use-case: custom endpoint

You might want to stream data from the custom S3-compatible source () . In order to do that you’d need to pass aws_sdk_s3::config::Config configured

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");

This field is mutually exclusive with LakeConfigBuilder::s3_client.

pub fn blocks_preload_pool_size(self, value: usize) -> Self

pub fn build(self) -> Result<LakeConfig, LakeConfigBuilderError>

Builds a new LakeConfig.

Errors

If a required field has not been initialized.

impl LakeConfigBuilder

pub fn s3_client<T: S3Client + 'static>(self, s3_client: T) -> Self

pub fn mainnet(self) -> Self

Shortcut to set up LakeConfigBuilder::s3_bucket_name for mainnet

use near_lake_framework::LakeConfigBuilder;

   let config = LakeConfigBuilder::default()
       .mainnet()
       .start_block_height(65231161)
       .build()
       .expect("Failed to build LakeConfig");

pub fn testnet(self) -> Self

Shortcut to set up LakeConfigBuilder::s3_bucket_name for testnet

use near_lake_framework::LakeConfigBuilder;

   let config = LakeConfigBuilder::default()
       .testnet()
       .start_block_height(82422587)
       .build()
       .expect("Failed to build LakeConfig");

pub fn betanet(self) -> Self

Shortcut to set up LakeConfigBuilder::s3_bucket_name for betanet

use near_lake_framework::LakeConfigBuilder;

   let config = LakeConfigBuilder::default()
       .betanet()
       .start_block_height(82422587)
       .build()
       .expect("Failed to build LakeConfig");

Trait Implementations

impl Default for LakeConfigBuilder

fn default() -> Self

Returns the “default value” for a type.