@signumjs/core/out/typings/args/defaultSendArgs.d.ts

Principal package with functions and models for building Signum Network applications.

import { Attachment } from '../attachment';
/**
 * The base argument object for common transactions
 *
*
* @category args
*/
export interface DefaultSendArgs {
    /**
     * The fee expressed in Planck
     * > It's recommended to use {@link util.Amount}
     */
    feePlanck: string;
    /**
     * The senders public key,  i.e. the {@link crypto.SignKeys.publicKey}
     */
    senderPublicKey: string;
    /**
     * The senders private key, i.e. the {@link crypto.SignKeys.signPrivateKey}
     * If the private key is not given, then the transaction method will return the unsigned byte string.
     * The transaction won't be processed until the unsigned bytes are being signed and broadcasted using
     * {@link TransactionApi.signAndBroadcastTransaction}
     */
    senderPrivateKey?: string;
    /**
     * An optional attachment
     */
    attachment?: Attachment;
    /**
     * The deadline when after how many minutes the transaction will be discarded, if it was not
     * processed, e.g. due to very low fee
     */
    deadline?: number;
    /**
     * Using this field allows to make a transaction dependent on other transactions.
     */
    referencedTransactionFullHash?: string;
    /**
     * Setting this option to `true`, skips the additional security check, i.e. the verification of the
     * unsigned transaction bytes, which detects tampered node responses. By default, the option is `false`.
     * Usually, you won't use this option, but can be useful when a method cannot be verified,
     * because the verification is not implemented yet.
     *
     */
    skipAdditionalSecurityCheck?: boolean;
}