Nestjs-chainlist NPM

Nest.js Chainlist

chainlist module for Nest framework (node.js)

⚠️ This package is still in the development stage, please do not use it in the production environment!!!

Features

ChainsModule

import { ChainsModule } from 'nestjs-chainlist';

@Module({
    imports: [
        ChainsModule.forRootAsync({
            isGlobal: true,
            useFactory: (configService: ConfigService) => {
                const data = configService.get('chains') as any[];
                const lists = configService.get('chain_lists') as Record<string, number[]>;

                return { data, lists };
            },
            inject: [ConfigService],
        }),
    ]
})
export class TestModule {}

ChainsService
Provide ChainsService to access all chain and list.
it was extends to Chains class, see chainlist for details.

import { ChainsService } from 'nestjs-chainlist';

export class TestService {
    constructor(
    @Inject() 
    private readonly chainsService: ChainsService,
    ){}
}

@Chains() decorator

import { Chains } from 'nestjs-chainlist';

export class TestService {
    constructor(
    @Chains('list name') 
    private readonly chainlist: ChainList,
    ){}
}

Route params decorator
Extract chain_id from req.query:

@Get('/')
findOne(@QueryChain('chain_id') chain: Chain) {}

Extract chainId from req.body:

@Post('/')
create(@BodyChain('chainIds') chains: Chain[]) {}

Extract chainId from req.params:

@Get('/')
findOne(@ParamChain('chainId') chain: Chain) {}

Extract x-chain-id from req.headers:

@Get('/')
findOne(@HeaderChain('x-chain-id') chain: Chain) {}

Installation

npm i nestjs-chainlist

yarn add nestjs-chainlist

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request. Make sure to read the contribution guidelines before getting started.