@fruitsjs/core/src/typings/args/createSubscriptionArgs.ts

Principal package with functions and models for building Fruits Eco-Blockchain applications.

import {Attachment} from '../attachment';

/**
 * The argument object for [[TransactionApi.createSubscription]]
 *
 * @param amountPlanck The amount to be sent as Planck value
 * @param feePlanck The fee as Planck value
 * @param frequency The frequency of the recurring payments in seconds. Minimum is 3600 seconds
 * @param recipientId The id of the recipient
 * @param recipientPublicKey The _optional_ recipients public key in hex format.
 * Using this arg allows to activate a recipients account, if not activated yet
 * @param senderPublicKey The senders public key for sending an _unsigned_ message
 * @param senderPrivateKey The senders private key to _sign_ the message
 * @param attachment An _optional_ attachment
 * @param deadline The _optional_ transactions deadline in minutes until it's being removed from mempool.
 * This may happen on low fees. Defaults to 1440 (maximum)
 *
 * @module core
 */
export interface CreateSubscriptionArgs {
    amountPlanck: string;
    feePlanck: string;
    frequency: number;
    recipientId: string;
    recipientPublicKey?: string;
    senderPublicKey: string;
    senderPrivateKey: string;
    attachment?: Attachment;
    deadline?: number;
}