Skip to content

README.md

Latest commit

 

History

History
129 lines (85 loc) · 5.37 KB

README.md

File metadata and controls

129 lines (85 loc) · 5.37 KB
Raw

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

Nest framework TypeScript starter repository.

Installation

$ yarn install

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Requirements

Ensure the data directory is writable The application requires the data directory to have proper write permissions for saving necessary files.

Ensure the data directory exists and is set as writable.

To Set Write Permissions: On Unix-based systems, you can use the following commands:

mkdir -p data           # Create the data directory if it doesn't exist
chmod 775 data          # Grant read, write, and execute permissions
chown -R $USER:$USER data  # Set the directory owner to the current user

Environment Configuration

This application uses several environment variables to configure the supported chains, RPC endpoints, contract addresses, and more. Below are the available configuration options:

Configuration File: .env

# Supported Chains
SUPPORT_CHAINIDS=97, 84532

# RPC URLs for the chains
CHANIDS_RPC=https://bsc-testnet-rpc.publicnode.com, https://sepolia.base.org

# Contract Addresses deployed on the respective chains
CONTRACT_ADDRESS=0x7393Ad72e87A0Ec51Bc9fCB783DBc8F24FE63847, 0xd1Cd760135F6f58b6466B95651a97eFcF52Ab2C3

# Starting block numbers for each chain
STRART_BLOCK_NUMBER=45940422, 18388180

# Number of block confirmations for each chain
CONFIRM_BLOCKs=80, 120

# Filler private key for the operations
FILLER_PK=your_private_key_here

Explanation of the Configurations:

SUPPORT_CHAINIDS

A comma-separated list of supported chain IDs that the application will interact with.

CHANIDS_RPC

A comma-separated list of RPC URLs for the chains. These URLs are used for querying the chain's state.

CONTRACT_ADDRESS

A comma-separated list of across contract addresses deployed on the supported chains. The application interacts with these contracts for cross-chain operations.

STRART_BLOCK_NUMBER

A comma-separated list of starting block numbers for each chain. These are the blocks from which the application will start monitoring.

CONFIRM_BLOCKs

A comma-separated list of the number of block confirmations required before considering a transaction as confirmed on each chain.

FILLER_PK

The private key of the filler wallet used for transactions. Important: Keep this key secure and do not expose it in public repositories.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.