Skip to main content

SDK Integration

Quick guide to integrate the Mass Payout SDK in your project.

Installation​

npm install @hashgraph/mass-payout-sdk @hashgraph/mass-payout-contracts

Peer dependencies:

npm install @nestjs/config joi

Setup​

import { Module } from "@nestjs/common";
import { ConfigModule } from "@nestjs/config";
import { MassPayoutSdkModule } from "@hashgraph/mass-payout-sdk";

@Module({
  imports: [
    ConfigModule.forRoot(),
    MassPayoutSdkModule.forRoot({
      network: process.env.HEDERA_NETWORK,
      mirrorNodeUrl: process.env.HEDERA_MIRROR_NODE_URL,
      rpcUrl: process.env.HEDERA_JSON_RPC_RELAY_URL,
    }),
  ],
})
export class AppModule {}

Configure DFNS Wallet​

The SDK requires DFNS for transaction signing.

import { Network } from "@hashgraph/mass-payout-sdk";

const network = new Network();
await network.connect({
  wallet: "DFNS",
  custodialWalletSettings: {
    serviceAccountAuthToken: process.env.DFNS_SERVICE_ACCOUNT_AUTHORIZATION_TOKEN,
    serviceAccountCredentialId: process.env.DFNS_SERVICE_ACCOUNT_CREDENTIAL_ID,
    serviceAccountPrivateKey: process.env.DFNS_SERVICE_ACCOUNT_PRIVATE_KEY_OR_PATH,
    appId: process.env.DFNS_APP_ID,
    appOrigin: process.env.DFNS_APP_ORIGIN,
    baseUrl: process.env.DFNS_BASE_URL,
    walletId: process.env.DFNS_WALLET_ID,
    walletPublicKey: process.env.DFNS_WALLET_PUBLIC_KEY,
    hederaAccountId: process.env.DFNS_HEDERA_ACCOUNT_ID,
  },
});

Environment variables:

DFNS_SERVICE_ACCOUNT_AUTHORIZATION_TOKEN=eyJ0eXAiOiJKV1QiLCJhbGc...
DFNS_SERVICE_ACCOUNT_CREDENTIAL_ID=cr-xxxxx-xxxxx-xxxxx
DFNS_SERVICE_ACCOUNT_PRIVATE_KEY_OR_PATH="-----BEGIN EC PRIVATE KEY-----\n...\n-----END EC PRIVATE KEY-----"
DFNS_APP_ID=ap-xxxxx-xxxxx-xxxxx
DFNS_APP_ORIGIN=http://localhost:3000
DFNS_BASE_URL=https://api.dfns.ninja
DFNS_WALLET_ID=wa-xxxxx-xxxxx-xxxxx
DFNS_WALLET_PUBLIC_KEY=your_public_key_here
DFNS_HEDERA_ACCOUNT_ID=0.0.123456

Basic Usage​

Deploy Contract​

import { DeployCommand } from "@hashgraph/mass-payout-sdk";

const command = new DeployCommand({
  tokenAddress: "0.0.789012",
  paymentTokenAddress: "0.0.429274",
});

const result = await commandBus.execute(command);

Execute Distribution​

import { ExecuteDistributionCommand } from "@hashgraph/mass-payout-sdk";

const command = new ExecuteDistributionCommand({
  contractId: "0.0.123456",
  holderAddresses: ["0xabc...", "0xdef..."],
  amounts: ["100", "200"],
  startIndex: 0,
  endIndex: 100,
});

await commandBus.execute(command);

Query Contract​

import { GetPaymentTokenQuery } from "@hashgraph/mass-payout-sdk";

const paymentToken = await queryBus.execute(new GetPaymentTokenQuery({ contractId: "0.0.123456" }));

Next Steps​