Skip to main content

RWAClient

The RWAClient is the main entry point for the Mantle RWA SDK. It provides methods for deploying RWA systems and accessing module instances.

Constructor​

import { RWAClient } from '@mantle-rwa/sdk';

const client = new RWAClient(config: RWAClientConfig);

Parameters​

ParameterTypeRequiredDescription
network'mantle' | 'mantle-sepolia'YesNetwork to connect to
privateKeystringNo*Private key for signing transactions
walletClientWalletClientNo*Viem wallet client for browser usage
rpcUrlstringNoCustom RPC endpoint
gasGasConfigNoGas configuration options

*Either privateKey or walletClient is required.

Example​

// Server-side with private key
const client = new RWAClient({
  network: 'mantle-sepolia',
  privateKey: process.env.PRIVATE_KEY,
});

// Browser with wallet client
const client = new RWAClient({
  network: 'mantle-sepolia',
  walletClient: yourWalletClient,
});

Properties​

address​

The address of the connected wallet.

const address: string = client.address;
// '0x1234...'

network​

The current network name.

const network: string = client.network;
// 'mantle-sepolia'

chainId​

The chain ID of the current network.

const chainId: number = client.chainId;
// 5003

Methods​

deployRWASystem​

Deploys a complete RWA token system including all required contracts.

const deployment = await client.deployRWASystem(config: DeployRWASystemConfig): Promise<DeploymentResult>;

Parameters​

ParameterTypeRequiredDescription
tokenNamestringYesName of the token
tokenSymbolstringYesSymbol of the token
initialSupplystringYesInitial token supply
decimalsnumberNoToken decimals (default: 18)
complianceComplianceConfigNoCompliance configuration
yieldYieldConfigNoYield distribution configuration
rolesRolesConfigNoAccess control roles

Returns​

interface DeploymentResult {
  token: TokenModule;
  kycRegistry: KYCModule;
  yieldDistributor: YieldModule;
  assetVault: AssetVaultModule;
  complianceModule: ComplianceModule;
  transactionHash: string;
}

Example​

const deployment = await client.deployRWASystem({
  tokenName: 'Real Estate Token',
  tokenSymbol: 'RET',
  initialSupply: '1000000',
  compliance: {
    maxHolders: 500,
    minInvestment: '100',
    maxInvestment: '100000',
  },
});

console.log('Token address:', deployment.token.address);

token​

Returns a TokenModule instance for an existing token contract.

const token = client.token(address: string): TokenModule;

Example​

const token = client.token('0x1234...');
const balance = await token.balanceOf('0x5678...');

kyc​

Returns a KYCModule instance for an existing KYC registry contract.

const kyc = client.kyc(address: string): KYCModule;

Example​

const kyc = client.kyc('0x1234...');
const isVerified = await kyc.isVerified('0x5678...');

yield​

Returns a YieldModule instance for an existing yield distributor contract.

const yieldModule = client.yield(address: string): YieldModule;

Example​

const yieldModule = client.yield('0x1234...');
await yieldModule.distribute({ amount: '10000', paymentToken: '0x...' });

compliance​

Returns a ComplianceModule instance for an existing compliance contract.

const compliance = client.compliance(address: string): ComplianceModule;

Example​

const compliance = client.compliance('0x1234...');
const canTransfer = await compliance.canTransfer('0xFrom...', '0xTo...', '1000');

Type Definitions​

RWAClientConfig​

interface RWAClientConfig {
  network: 'mantle' | 'mantle-sepolia';
  privateKey?: string;
  walletClient?: WalletClient;
  rpcUrl?: string;
  gas?: {
    maxFeePerGas?: bigint;
    maxPriorityFeePerGas?: bigint;
  };
}

DeployRWASystemConfig​

interface DeployRWASystemConfig {
  tokenName: string;
  tokenSymbol: string;
  initialSupply: string;
  decimals?: number;
  compliance?: {
    maxHolders?: number;
    minInvestment?: string;
    maxInvestment?: string;
    accreditedOnly?: boolean;
    lockupPeriod?: number;
    transferRestrictions?: boolean;
  };
  yield?: {
    paymentToken?: string;
    distributionFrequency?: 'daily' | 'weekly' | 'monthly' | 'quarterly';
  };
  roles?: {
    admin?: string;
    compliance?: string;
    treasury?: string;
  };
}

Error Handling​

import { RWAError, NetworkError, ConfigurationError } from '@mantle-rwa/sdk';

try {
  const client = new RWAClient({
    network: 'mantle-sepolia',
    privateKey: 'invalid-key',
  });
} catch (error) {
  if (error instanceof ConfigurationError) {
    console.log('Invalid configuration:', error.message);
  }
}

See Also​