Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blockcoders/nestjs-matic
Matic PoS and Plasma utilities for NestJS based on matic.js
https://github.com/blockcoders/nestjs-matic
blockchain matic maticjs nest nestjs polygon polygonjs
Last synced: 8 days ago
JSON representation
Matic PoS and Plasma utilities for NestJS based on matic.js
- Host: GitHub
- URL: https://github.com/blockcoders/nestjs-matic
- Owner: blockcoders
- License: apache-2.0
- Created: 2021-04-15T19:24:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-24T14:05:37.000Z (over 2 years ago)
- Last Synced: 2024-10-11T23:50:33.535Z (about 1 month ago)
- Topics: blockchain, matic, maticjs, nest, nestjs, polygon, polygonjs
- Language: TypeScript
- Homepage:
- Size: 633 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJS-Matic
[](https://www.npmjs.com/package/nestjs-matic)
[](https://circleci.com/gh/blockcoders/nestjs-matic/tree/main)
[](https://coveralls.io/github/blockcoders/nestjs-matic?branch=main)
[](https://snyk.io/test/github/blockcoders/nestjs-matic)
[](https://img.shields.io/badge/platforms-Express%20%26%20Fastify-green)
Matic PoS and Plasma utilities for NestJS based on [matic.js](https://github.com/maticnetwork/matic.js/)
## Install
```sh
npm i nestjs-matic
```
## Register module
### Configuration params
`nestjs-matic` can be configured with this options:
```ts
interface MaticModuleOptions {
/**
* Optional parameter for connection, must be a MaticNetworks enum.
* Take 'mainnet' or 'testnet' as possible values.
* If no network is provided, mainnnet is used.
* @see {@link https://maticnetwork.github.io/matic.js/docs/plasma/initialize#options}
*/
network?: MaticNetworks;
/**
* Optional parameter for version, must be a MaticVersions enum.
* Take 'v1' or 'mumbai' as possible values.
* If no version is provided, v1 is used.
* @see {@link https://maticnetwork.github.io/matic.js/docs/plasma/initialize#options}
*/
version?: MaticVersions;
/**
* Optional parameter for maticProvider, can be a web3-core provider.
* If no maticProvider is provided, empty object is used
* The maticProvider may also be a URL to connect to,
* such as https://rpc-mumbai.matic.today
* @see {@link https://github.com/ChainSafe/web3.js/blob/1.x/packages/web3-core/types/index.d.ts#L436}
*/
maticProvider?: web3-core.provider;
/**
* Required parameter for parentProvider, can be a web3-core provider.
* @see {@link https://github.com/ChainSafe/web3.js/blob/1.x/packages/web3-core/types/index.d.ts#L436}
*/
parentProvider: web3-core.provider;
/**
* Optional parameter for parentDefaultOptions, must be a Matic
* SendOptions type.
* If no parentDefaultOptions is provided, empty object is used.
* @see {@link https://github.com/maticnetwork/matic.js/blob/master/src/types/Common.ts#L3}
*/
parentDefaultOptions?: SendOptions;
/**
* Optional parameter for maticDefaultOptions, must be a Matic
* SendOptions type.
* If no parentDefaultOptions is provided, empty object is used.
* @see {@link https://github.com/maticnetwork/matic.js/blob/master/src/types/Common.ts#L3}
*/
maticDefaultOptions?: SendOptions;
/**
* Optional parameter for maticClient, must be a string.
* Take 'Plasma' or 'PoS' as possible values.
* If no maticClient is provided, 'PoS" is used.
*/
maticClient?: MaticClients;
}
```
### Synchronous configuration
Use `MaticModule.forRoot` method with [Options interface](#configuration-params):
```ts
import { MaticModule } from 'nestjs-matic';
import { MaticClients, MaticNetworks, MaticVersions } from 'nestjs-matic/dist/matic.interface';
@Module({
imports: [
MaticModule.forRoot({
network: MaticNetworks.Testnet,
version: MaticVersions.Mumbai
maticProvider: 'https://rpc-mumbai.matic.today',
parentProvider: 'https://rpc.goerli.mudit.blog',
parentDefaultOptions: {
from: '0x9aCd457193F4788Ef7989c88dA89DF7b2754670c',
},
maticDefaultOptions: {
from: '0x54aff400858Dcac39797a81894D9920f16972D1D',
},
maticClient: MaticClients.PoS
})
],
...
})
class MyModule {}
```
### Asynchronous configuration
With `MaticModule.forRootAsync` allows you, for example, inject `ConfigService` to use it in Nest `useFactory` method.
`useFactory` should return object with [Options interface](#configuration-params).
```ts
import { MaticModule } from 'nestjs-matic';
import { MaticClients, MaticNetworks, MaticVersions } from 'nestjs-matic/dist/matic.interface';
@Injectable()
class ConfigService {
public readonly network = MaticNetworks.Testnet;
public readonly version = MaticVersions.Mumbai;
public readonly maticProvider = 'https://rpc-mumbai.matic.today';
public readonly parentProvider = 'https://rpc.goerli.mudit.blog';
public readonly maticDefaultOptions = { from '0x....' };;
}
@Module({
providers: [ConfigService],
exports: [ConfigService]
})
class ConfigModule {}
@Module({
imports: [
MaticModule.forRootAsync({
imports: [ConfigModule],
inject: [ConfigService],
useFactory: async (config: ConfigService) => {
await somePromise();
return {
network: config.network,
version: config.version,
maticProvider: config.maticProvider,
parentProvider: config.parentProvider,
maticDefaultOptions: config.maticDefaultOptions,
parentDefaultOptions: config.maticDefaultOptions,
maticClient: MaticClients.PoS,
};
},
}),
],
...
})
class TestModule {}
```
Or you can just pass `ConfigService` to `providers`, if you don't have any `ConfigModule`:
```ts
import {
MaticModule,
MaticNetworks,
MaticVersions,
} from 'nestjs-matic';
@Injectable()
class ConfigService {
public readonly network = MaticNetworks.Testnet;
public readonly version = MaticVersions.Mumbai;
public readonly maticProvider = 'https://rpc-mumbai.matic.today';
public readonly parentProvider = 'https://rpc.goerli.mudit.blog';
public readonly maticDefaultOptions = { from '0x....' };
}
@Module({
imports: [
MaticModule.forRootAsync({
providers: [ConfigService],
inject: [ConfigService],
useFactory: (config: ConfigService) => {
return {
network: config.network,
version: config.version,
maticProvider: config.maticProvider,
parentProvider: config.parentProvider,
maticDefaultOptions: config.maticDefaultOptions,
parentDefaultOptions: config.maticDefaultOptions,
maticClient: MaticClients.PoS,
};
}
})
],
controllers: [TestController]
})
class MyModule {}
```
## MaticClients
- `MaticPlasmaClient` implements standard [PlasmaClient](https://maticnetwork.github.io/matic.js/docs/plasma/initialize).
- `MaticPOSClient` implements standard [POSClient](https://maticnetwork.github.io/matic.js/docs/pos/initialize).
If you are familiar with it, you are ready to go.
```ts
import { InjectMaticProvider, MaticPOSClient } from 'nestjs-matic';
@Injectable()
export class TestService {
constructor(
@InjectMaticProvider()
private readonly maticClient: MaticPOSClient,
) {}
async someMethod(): Promise<{ nftBalance: string }> {
const nftBalance: number = await this.maticClient.balanceOfERC721('0x....', '0x....')
return { nftBalance: nftBalance.toString() };
}
}
```
## Testing a class that uses @InjectMaticProvider
This package exposes a `getMaticToken()` function that returns a prepared injection token based on the provided context.
Using this token, you can easily provide a mock implementation of the [SDKClient](https://github.com/maticnetwork/matic.js/blob/master/src/common/SDKClient.ts) using any of the standard custom provider techniques, including useClass, useValue, and useFactory.
```ts
const module: TestingModule = await Test.createTestingModule({
providers: [
MyService,
{
provide: getMaticToken(),
useValue: mockProvider,
},
],
}).compile();
```
## Change Log
See [Changelog](CHANGELOG.md) for more information.
## Contributing
Contributions welcome! See [Contributing](CONTRIBUTING.md).
## Collaborators
* [__Jose Ramirez__](https://github.com/0xslipk)
* [__Ana Riera__](https://github.com/AnnRiera)
## License
Licensed under the Apache 2.0 - see the [LICENSE](LICENSE) file for details.