JavaScript/ TypeScript

Easily integrate in your JS/TS application using the sdk.

LYNC Paymaster SDK on npmjs: https://www.npmjs.com/package/lync-paymaster-sdk

Install the SDK

npm install lync-paymaster-sdk --save

Import the dependencies

import { performPaymasterTransaction } from "lync-paymaster-sdk";
import { Network } from "@aptos-labs/ts-sdk";

Get API Keys from LYNC Dashboard

// From LYNC Dashboard
const apiKey = "LYNC API KEY Dashboard";

// Get this from LYNC
const lyncAuthKey = "Get this from LYNC Support";

The performPaymasterTransaction function

import { 
  CommittedTransactionResponse, 
  InputEntryFunctionData, 
  Network 
} from "@aptos-labs/ts-sdk";

/**
 * The data returned from a paymaster transaction.
 * @param {CommittedTransactionResponse} receipt - The transaction receipt.
 * @param {CommittedTransactionResponse} accountCreationReceipt - The account creation receipt.
 * @param {string} privateKey - The private key for the account.
 */
interface PaymasterTransactionReturnData {
  receipt: CommittedTransactionResponse;
  accountCreationReceipt: CommittedTransactionResponse;
  privateKey: string;
}

/**
 * The account information.
 * @param {string} privateKey - The private key for the account.
 * @param {string} accountAddress - The account address.
 */
interface AccountInfo {
  privateKey: string;
  accountAddress: string;
}

/**
 * Performs a paymaster transaction on the specific Aptos network using the LYNC paymaster API.
 *
 * @param {string} lyncAuthKey - The LYNC API key for authentication.
 * @param {Network} network - The network to perform the transaction on.
 * @param {string} apiKey - The LYNC API key for authentication.
 * @param {InputEntryFunctionData} inputTransaction - The input data for the transaction.
 * @param {boolean} showLogs - Whether to show logs or not.
 * @param {AccountInfo} accountData - The account data(privateKey and accountAddress) for the transaction(optional). If not provided, a new account will be generated.
 * @returns {Promise<PaymasterTransactionReturnData>} The data returned from a paymaster transaction.
 */
async function performPaymasterTransaction(
  lyncAuthKey: string,
  network: Network,
  apiKey: string,
  inputTransaction: InputEntryFunctionData,
  showLogs: boolean,
  accountData?: AccountInfo,
): Promise<PaymasterTransactionReturnData>;

Using the performPaymasterTransaction function

const accountData = {
  privateKey: "0x....",
  accountAddress: "0x...."
};

const data = await performPaymasterTransaction(
  lyncAuthKey,
  Network.TESTNET,
  apiKey,
  {
    function: "0x1::aptos_account::transfer", // entry function
    functionArguments: [
      "0x587f66c999fed81c8872c5ddabed1e7049c790d750d2a796313a32702dcff962", // to address
      "100000000" // 1 APT = 100000000
    ]
  },
  false, // show logs or not
  accountData // optional - will generate a new account if not provided
);

console.log(data);