@caminojs-nikos/caminojs/dist/apis/platformvm/basetx.d.ts

Camino Platform JS Library

/**
 * @packageDocumentation
 * @module API-PlatformVM-BaseTx
 */
import { Buffer } from "buffer/";
import { TransferableOutput } from "./outputs";
import { TransferableInput } from "./inputs";
import { SignerKeyChain, SignerKeyPair, StandardBaseTx, Credential, OutputOwners } from "../../common";
import { SerializedEncoding } from "../../utils/serialization";
/**
 * Class representing a base for all transactions.
 */
export declare class BaseTx extends StandardBaseTx<SignerKeyPair, SignerKeyChain> {
    protected _typeName: string;
    protected _typeID: number;
    protected _outputOwners: OutputOwners[];
    deserialize(fields: object, encoding?: SerializedEncoding): void;
    getOuts(): TransferableOutput[];
    getIns(): TransferableInput[];
    getTotalOuts(): TransferableOutput[];
    /**
     * Returns the id of the [[BaseTx]]
     */
    getTxType(): number;
    /**
     * @returns The outputOwners of inputs, one per input
     */
    getOutputOwners(): OutputOwners[];
    /**
     * @params The outputOwners of inputs, one per input
     */
    setOutputOwners(owners: OutputOwners[]): void;
    /**
     * Takes a {@link https://github.com/feross/buffer|Buffer} containing an [[BaseTx]], parses it, populates the class, and returns the length of the BaseTx in bytes.
     *
     * @param bytes A {@link https://github.com/feross/buffer|Buffer} containing a raw [[BaseTx]]
     *
     * @returns The length of the raw [[BaseTx]]
     *
     * @remarks assume not-checksummed
     */
    fromBuffer(bytes: Buffer, offset?: number): number;
    /**
     * Takes the bytes of an [[UnsignedTx]] and returns an array of [[Credential]]s
     *
     * @param msg A Buffer for the [[UnsignedTx]]
     * @param kc An [[KeyChain]] used in signing
     *
     * @returns An array of [[Credential]]s
     */
    sign(msg: Buffer, kc: SignerKeyChain): Credential[];
    clone(): this;
    create(...args: any[]): this;
    select(id: number, ...args: any[]): this;
    /**
     * Class representing a BaseTx which is the foundation for all transactions.
     *
     * @param networkID Optional networkID, [[DefaultNetworkID]]
     * @param blockchainID Optional blockchainID, default Buffer.alloc(32, 16)
     * @param outs Optional array of the [[TransferableOutput]]s
     * @param ins Optional array of the [[TransferableInput]]s
     * @param memo Optional {@link https://github.com/feross/buffer|Buffer} for the memo field
     */
    constructor(networkID?: number, blockchainID?: Buffer, outs?: TransferableOutput[], ins?: TransferableInput[], memo?: Buffer);
}
//# sourceMappingURL=basetx.d.ts.map