Description

Nest framework TypeScript Module for interacting with XUMM wallet.

How to use it

Base kyc module

• Import and register KycModule in AppModule and apply Signature middleware for SumsubController

1import { Module, NestModule, MiddlewareConsumer } from "@nestjs/common";
2import { KycModule, SignatureMiddleware, SumsubController, OrmType } from "@peersyst/kyc-module";
3
4@Module({
5    imports: [
6        ConfigModule.forRoot(...),
7        TypeOrmModule.forRootAsync(...),
8        UserModule,
9        KycModule.register(UserModule, ConfigModule, {
10          ormType: OrmType.TYPEORM,
11        }),
12    ],
13})
14export class AppModule implements NestModule {
15  configure(consumer: MiddlewareConsumer) {
16    consumer.apply(SignatureMiddleware).forRoutes(SumsubController);
17  }
18}

• Add configService configuration variables

1export default (): any => ({
2    sumsub: {
3        secretKey: process.env.SUMSUB_SECRET_KEY,
4        baseUrl: process.env.SUMSUB_BASE_URL,
5        appToken: process.env.APP_TOKEN,
6    },
7});

• Add KycErrorCode and KycErrorBody to app ErrorCodes

1import { HttpStatus } from "@nestjs/common";
2import { KycErrorCode, KycErrorBody } from "@peersyst/kyc-module";
3
4// Define app error codes
5enum AppErrorCode {}
6
7export const ErrorCode = { ...AppErrorCode, ...KycErrorCode };
8export type ErrorCodeType = AppErrorCode | KycErrorCode;
9
10export const ErrorBody: { [code in ErrorCodeType]: { statusCode: HttpStatus; message: string } } = {
11    // Define app error code bodies
12    ...KycErrorBody,
13};

• If ormType is sequelize: create model in your models folder with name KycModel

1export { KycModel } from "@peersyst/kyc-module";

• If ormType is typeorm: create entity in your entities folder with name KycEntity

1export { KycEntity } from "@peersyst/kyc-module";

Add Notifications

• Set notifications to true in register module and add NotificationService

1KycModule.register(UserModule, ConfigModule, {
2    ...
3    notifications: true,
4    NotificationService: MyNotificationService,
5}),

• Implement KycNotificationInterface for your NotificationService

1import { KycNotificationInterface } from "@peersyst/kyc-module";
2
3@Injectable()
4export class MyNotificationService implements KycNotificationInterface {...}

License

Nest is MIT licensed.