nme-library 2.0.0-RC4

package/dist/src/models/transaction/TimeWindow.js

@@ -0,0 +1,84 @@
+"use strict";
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 NEM
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const js_joda_1 = require("js-joda");
+class TimeWindow {
+    /**
+     * @param deadline - LocalDateTime
+     * @param timeStamp - LocalDateTime
+     */
+    constructor(timeStamp, deadline) {
+        this.deadline = deadline;
+        this.timeStamp = timeStamp;
+    }
+    /**
+     * @param deadline
+     * @param chronoUnit
+     * @returns {TimeWindow}
+     */
+    static createWithDeadline(deadline = 2, chronoUnit = js_joda_1.ChronoUnit.HOURS) {
+        const currentTimeStamp = (new Date()).getTime();
+        const timeStampDateTime = js_joda_1.LocalDateTime.ofInstant(js_joda_1.Instant.ofEpochMilli(currentTimeStamp), js_joda_1.ZoneId.SYSTEM);
+        const deadlineDateTime = timeStampDateTime.plus(deadline, chronoUnit);
+        if (deadline <= 0) {
+            throw new Error("deadline should be greater than 0");
+        }
+        else if (timeStampDateTime.plus(24, js_joda_1.ChronoUnit.HOURS).compareTo(deadlineDateTime) != 1) {
+            throw new Error("deadline should be less than 24 hours");
+        }
+        return new TimeWindow(timeStampDateTime, deadlineDateTime);
+    }
+    /**
+     * @internal
+     * @param timestamp
+     * @param deadline
+     */
+    static createFromDTOInfo(timeStamp, deadline) {
+        return new TimeWindow(TimeWindow.createLocalDateTimeFromNemDate(timeStamp), TimeWindow.createLocalDateTimeFromNemDate(deadline));
+    }
+    /**
+     * @internal
+     * @param dateSeconds
+     * @returns {LocalDateTime}
+     */
+    static createLocalDateTimeFromNemDate(dateSeconds) {
+        return js_joda_1.LocalDateTime.ofInstant(js_joda_1.Instant.ofEpochMilli(1000 * Math.round(dateSeconds + TimeWindow.timestampNemesisBlock)), js_joda_1.ZoneId.SYSTEM);
+    }
+    /**
+     * @internal
+     */
+    deadlineToDTO() {
+        return this.deadline.atZone(js_joda_1.ZoneId.SYSTEM).toEpochSecond() - TimeWindow.timestampNemesisBlock;
+    }
+    /**
+     * @internal
+     */
+    timeStampToDTO() {
+        return this.timeStamp.atZone(js_joda_1.ZoneId.SYSTEM).toEpochSecond() - TimeWindow.timestampNemesisBlock;
+    }
+}
+TimeWindow.timestampNemesisBlock = 1427587585;
+exports.TimeWindow = TimeWindow;
+//# sourceMappingURL=TimeWindow.js.map

package/dist/src/models/transaction/TimeWindow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeWindow.js","sourceRoot":"","sources":["../../../../src/models/transaction/TimeWindow.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;AAEH,qCAAmE;AAEnE;IAcE;;;OAGG;IACH,YACE,SAAwB,EACxB,QAAuB;QAEvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,kBAAkB,CAAC,WAAmB,CAAC,EAAE,aAAyB,oBAAU,CAAC,KAAK;QAC9F,MAAM,gBAAgB,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QAChD,MAAM,iBAAiB,GAAG,uBAAa,CAAC,SAAS,CAAC,iBAAO,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,gBAAM,CAAC,MAAM,CAAC,CAAC;QACzG,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAEtE,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;aAAM,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,EAAE,oBAAU,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE;YACxF,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;SAC1D;QAED,OAAO,IAAI,UAAU,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,SAAiB,EAAE,QAAgB;QACjE,OAAO,IAAI,UAAU,CACnB,UAAU,CAAC,8BAA8B,CAAC,SAAS,CAAC,EACpD,UAAU,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CACpD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,8BAA8B,CAAC,WAAmB;QAC9D,OAAO,uBAAa,CAAC,SAAS,CAAC,iBAAO,CAAC,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC,EAAE,gBAAM,CAAC,MAAM,CAAC,CAAC;IACzI,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,gBAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAChG,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,gBAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,GAAG,UAAU,CAAC,qBAAqB,CAAC;IACjG,CAAC;;AA7Ea,gCAAqB,GAAW,UAAU,CAAC;AAD3D,gCA+EC"}

package/dist/src/models/transaction/Transaction.d.ts

@@ -0,0 +1,56 @@
+import { TransactionDTO } from "../../infrastructure/transaction/TransactionDTO";
+import { PublicAccount } from "../account/PublicAccount";
+import { NetworkTypes } from "../node/NetworkTypes";
+import { TimeWindow } from "./TimeWindow";
+import { TransactionInfo } from "./TransactionInfo";
+/**
+ * An abstract transaction class that serves as the base class of all NEM transactions.
+ */
+export declare abstract class Transaction {
+    /**
+     * The transaction type.
+     */
+    readonly type: number;
+    /**
+     * The version of the structure.
+     */
+    readonly version: number;
+    /**
+     * The transaction signature (missing if part of a multisig transaction).
+     */
+    readonly signature?: string;
+    /**
+     * The public account of the transaction creator.
+     */
+    signer?: PublicAccount;
+    /**
+     * TimeWindow
+     */
+    readonly timeWindow: TimeWindow;
+    /**
+     * The fee for the transaction. The higher the fee, the higher the priority of the transaction. Transactions with high priority get included in a block before transactions with lower priority.
+     */
+    readonly abstract fee: number;
+    /**
+     * Transactions meta data object contains additional information about the transaction.
+     */
+    protected readonly transactionInfo?: TransactionInfo;
+    /**
+     * Checks if the transaction has been confirmed and included in a block
+     */
+    isConfirmed(): boolean;
+    /**
+     * Get transaction info
+     */
+    getTransactionInfo(): TransactionInfo;
+    /**
+     * Create DTO of the transaction
+     */
+    abstract toDTO(): TransactionDTO;
+    /**
+     * sets the network type for a transaction.
+     * This is done automatically when signing a transaction, you should not use it directly.
+     * @param networkType
+     */
+    setNetworkType(networkType: NetworkTypes): void;
+}

package/dist/src/models/transaction/Transaction.js

@@ -0,0 +1,98 @@
+"use strict";
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 NEM
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const _ = require("lodash");
+const NetworkTypes_1 = require("../node/NetworkTypes");
+/**
+ * An abstract transaction class that serves as the base class of all NEM transactions.
+ */
+class Transaction {
+    /**
+     * @internal
+     * @param type
+     * @param version
+     * @param timeWindow
+     * @param signature
+     * @param sender
+     * @param transactionInfo
+     */
+    constructor(type, version, timeWindow, signature, sender, transactionInfo) {
+        if (sender && !sender.hasPublicKey()) {
+            throw new Error("signer key pair is required to create a verifiable entity");
+        }
+        this.type = type;
+        this.version = version;
+        this.timeWindow = timeWindow;
+        this.signature = signature;
+        this.signer = sender ? sender : undefined;
+        this.transactionInfo = transactionInfo;
+    }
+    /**
+     * Checks if the transaction has been confirmed and included in a block
+     */
+    isConfirmed() {
+        return this.transactionInfo !== undefined;
+    }
+    /**
+     * Get transaction info
+     */
+    getTransactionInfo() {
+        if (!this.isConfirmed()) {
+            throw new Error("TransactionInfo is not available when it is not confirmed");
+        }
+        return this.transactionInfo;
+    }
+    /**
+     * Serialize DTO
+     * @internal
+     * @param dto
+     * @returns {any}
+     */
+    serializeDTO(dto) {
+        return _.omitBy(dto, _.isUndefined);
+    }
+    /**
+     * sets the network type for a transaction.
+     * This is done automatically when signing a transaction, you should not use it directly.
+     * @param networkType
+     */
+    setNetworkType(networkType) {
+        if (networkType === NetworkTypes_1.NetworkTypes.MAIN_NET) {
+            this.networkVersion = 0x68000000 | this.version;
+            return;
+        }
+        else if (networkType === NetworkTypes_1.NetworkTypes.TEST_NET) {
+            this.networkVersion = 0x98000000 | this.version;
+            return;
+        }
+        else if (networkType == NetworkTypes_1.NetworkTypes.MIJIN_NET) {
+            this.networkVersion = 0x60000000 | this.version;
+            return;
+        }
+        throw new Error("Unsupported Network Type " + networkType);
+    }
+}
+exports.Transaction = Transaction;
+//# sourceMappingURL=Transaction.js.map

package/dist/src/models/transaction/Transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transaction.js","sourceRoot":"","sources":["../../../../src/models/transaction/Transaction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;AAEH,4BAA4B;AAG5B,uDAAkD;AAIlD;;GAEG;AACH;IA0CE;;;;;;;;OAQG;IACH,YAAY,IAAY,EACZ,OAAe,EACf,UAAsB,EACtB,SAAkB,EAClB,MAAsB,EACtB,eAAiC;QAC3C,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC9E;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,eAAe,KAAK,SAAS,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,kBAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC9E;QACD,OAAO,IAAI,CAAC,eAAgB,CAAC;IAC/B,CAAC;IAOD;;;;;OAKG;IACO,YAAY,CAAC,GAAmB;QACxC,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,CAAmB,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,WAAyB;QAC7C,IAAI,WAAW,KAAK,2BAAY,CAAC,QAAQ,EAAE;YACzC,IAAI,CAAC,cAAc,GAAG,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChD,OAAO;SACR;aAAM,IAAI,WAAW,KAAK,2BAAY,CAAC,QAAQ,EAAE;YAChD,IAAI,CAAC,cAAc,GAAG,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChD,OAAO;SACR;aAAM,IAAI,WAAW,IAAI,2BAAY,CAAC,SAAS,EAAE;YAChD,IAAI,CAAC,cAAc,GAAG,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChD,OAAO;SACR;QACD,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,WAAW,CAAC,CAAC;IAC7D,CAAC;CACF;AAtHD,kCAsHC"}

package/dist/src/models/transaction/TransactionInfo.d.ts

@@ -0,0 +1,39 @@
+export declare class HashData {
+    readonly data: string;
+    constructor(data: string);
+}
+export declare class TransactionInfo {
+    /**
+     * The height of the block in which the transaction was included.
+     */
+    readonly height: number;
+    /**
+     *  The id of the transaction.
+     */
+    readonly id: number;
+    /**
+     *  The transaction hash.
+     */
+    readonly hash: HashData;
+    /**
+     * constructor
+     * @param height
+     * @param id
+     * @param hash
+     */
+    constructor(height: number, id: number, hash: HashData);
+}
+export declare class MultisigTransactionInfo extends TransactionInfo {
+    /**
+     * The hash of the inner transaction. This entry is only available for multisig transactions.
+     */
+    readonly innerHash: HashData;
+    /**
+     * constructor
+     * @param height
+     * @param id
+     * @param hash
+     * @param innerHash
+     */
+    constructor(height: number, id: number, hash: HashData, innerHash: HashData);
+}

package/dist/src/models/transaction/TransactionInfo.js

@@ -0,0 +1,60 @@
+"use strict";
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 NEM
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+class HashData {
+    constructor(data) {
+        this.data = data;
+    }
+}
+exports.HashData = HashData;
+class TransactionInfo {
+    /**
+     * constructor
+     * @param height
+     * @param id
+     * @param hash
+     */
+    constructor(height, id, hash) {
+        this.height = height;
+        this.id = id;
+        this.hash = hash;
+    }
+}
+exports.TransactionInfo = TransactionInfo;
+class MultisigTransactionInfo extends TransactionInfo {
+    /**
+     * constructor
+     * @param height
+     * @param id
+     * @param hash
+     * @param innerHash
+     */
+    constructor(height, id, hash, innerHash) {
+        super(height, id, hash);
+        this.innerHash = innerHash;
+    }
+}
+exports.MultisigTransactionInfo = MultisigTransactionInfo;
+//# sourceMappingURL=TransactionInfo.js.map

package/dist/src/models/transaction/TransactionInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionInfo.js","sourceRoot":"","sources":["../../../../src/models/transaction/TransactionInfo.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;AAEH;IACE,YAAqB,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IACjC,CAAC;CACF;AAHD,4BAGC;AAED;IAgBE;;;;;OAKG;IACH,YACE,MAAc,EACd,EAAU,EACV,IAAc;QAEd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AA/BD,0CA+BC;AAED,6BAAqC,SAAQ,eAAe;IAM1D;;;;;;OAMG;IACH,YAAY,MAAc,EAAE,EAAU,EAAE,IAAc,EAAE,SAAmB;QACzE,KAAK,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAjBD,0DAiBC"}

package/dist/src/models/transaction/TransactionTypes.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Static class containing transaction type constants.
+ */
+export declare class TransactionTypes {
+    /**
+     * Transfer Transaction
+     * @type {number}
+     */
+    static readonly TRANSFER: number;
+    /**
+     * Importance transfer transaction.
+     * @type {number}
+     */
+    static readonly IMPORTANCE_TRANSFER: number;
+    /**
+     * A new asset transaction.
+     * @type {number}
+     */
+    static readonly ASSET_NEW: number;
+    /**
+     * An asset ask transaction.
+     * @type {number}
+     */
+    static readonly ASSET_ASK: number;
+    /**
+     * An asset bid transaction.
+     * @type {number}
+     */
+    static readonly ASSET_BID: number;
+    /**
+     * A snapshot transaction.
+     * @type {number}
+     */
+    static readonly SNAPSHOT: number;
+    /**
+     * A multisig change transaction (e.g. announce an account as multi-sig).
+     * @type {number}
+     */
+    static readonly MULTISIG_AGGREGATE_MODIFICATION: number;
+    /**
+     * A multisig signature transaction.
+     * @type {number}
+     */
+    static readonly MULTISIG_SIGNATURE: number;
+    /**
+     * A multisig transaction.
+     * @type {number}
+     */
+    static readonly MULTISIG: number;
+    /**
+     * A provision namespace transaction.
+     * @type {number}
+     */
+    static readonly PROVISION_NAMESPACE: number;
+    /**
+     * A asset definition creation transaction.
+     * @type {number}
+     */
+    static readonly MOSAIC_DEFINITION_CREATION: number;
+    /**
+     * A asset supply change transaction.
+     * @type {number}
+     */
+    static readonly MOSAIC_SUPPLY_CHANGE: number;
+    /**
+     * Gets all multisig embeddable types.
+     * @returns {number[]}
+     */
+    static getMultisigEmbeddableTypes(): number[];
+    /**
+     * Gets all block embeddable types.
+     * @returns {number[]}
+     */
+    static getBlockEmbeddableTypes(): number[];
+    /**
+     * Gets all active types.
+     * @returns {number[]}
+     */
+    static getActiveTypes(): number[];
+}

package/dist/src/models/transaction/TransactionTypes.js

@@ -0,0 +1,159 @@
+"use strict";
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 NEM
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Static class containing transaction type constants.
+ */
+class TransactionTypes {
+    /**
+     * Gets all multisig embeddable types.
+     * @returns {number[]}
+     */
+    static getMultisigEmbeddableTypes() {
+        return [
+            TransactionTypes.TRANSFER,
+            TransactionTypes.IMPORTANCE_TRANSFER,
+            TransactionTypes.MULTISIG_AGGREGATE_MODIFICATION,
+            TransactionTypes.PROVISION_NAMESPACE,
+            TransactionTypes.MOSAIC_DEFINITION_CREATION,
+            TransactionTypes.MOSAIC_SUPPLY_CHANGE,
+        ];
+    }
+    /**
+     * Gets all block embeddable types.
+     * @returns {number[]}
+     */
+    static getBlockEmbeddableTypes() {
+        const types = TransactionTypes.getMultisigEmbeddableTypes();
+        types.push(TransactionTypes.MULTISIG);
+        return types;
+    }
+    /**
+     * Gets all active types.
+     * @returns {number[]}
+     */
+    static getActiveTypes() {
+        const types = TransactionTypes.getBlockEmbeddableTypes();
+        types.push(TransactionTypes.MULTISIG_SIGNATURE);
+        return types;
+    }
+}
+/**
+ * @internal
+ * @type {number}
+ */
+TransactionTypes.TRANSFER_TYPE = 0x0100;
+/**
+ * @internal
+ * @type {number}
+ */
+TransactionTypes.ASSET_TYPE = 0x0200;
+/**
+ * @internal
+ * @type {number}
+ */
+TransactionTypes.SNAPSHOT_TYPE = 0x0400;
+/**
+ * @internal
+ * @type {number}
+ */
+TransactionTypes.IMPORTANCE_TYPE = 0x0800;
+/**
+ * @internal
+ * @type {number}
+ */
+TransactionTypes.MULTISIG_TYPE = 0x1000;
+/**
+ * @internal
+ * @type {number}
+ */
+TransactionTypes.NAMESPACE_TYPE = 0x2000;
+/**
+ * @internal
+ * @type {number}
+ */
+TransactionTypes.MOSAIC_TYPE = 0x4000;
+/**
+ * Transfer Transaction
+ * @type {number}
+ */
+TransactionTypes.TRANSFER = TransactionTypes.TRANSFER_TYPE | 0x01;
+/**
+ * Importance transfer transaction.
+ * @type {number}
+ */
+TransactionTypes.IMPORTANCE_TRANSFER = TransactionTypes.IMPORTANCE_TYPE | 0x01;
+/**
+ * A new asset transaction.
+ * @type {number}
+ */
+TransactionTypes.ASSET_NEW = TransactionTypes.ASSET_TYPE | 0x01;
+/**
+ * An asset ask transaction.
+ * @type {number}
+ */
+TransactionTypes.ASSET_ASK = TransactionTypes.ASSET_TYPE | 0x02;
+/**
+ * An asset bid transaction.
+ * @type {number}
+ */
+TransactionTypes.ASSET_BID = TransactionTypes.ASSET_TYPE | 0x03;
+/**
+ * A snapshot transaction.
+ * @type {number}
+ */
+TransactionTypes.SNAPSHOT = TransactionTypes.SNAPSHOT_TYPE | 0x01;
+/**
+ * A multisig change transaction (e.g. announce an account as multi-sig).
+ * @type {number}
+ */
+TransactionTypes.MULTISIG_AGGREGATE_MODIFICATION = TransactionTypes.MULTISIG_TYPE | 0x01;
+/**
+ * A multisig signature transaction.
+ * @type {number}
+ */
+TransactionTypes.MULTISIG_SIGNATURE = TransactionTypes.MULTISIG_TYPE | 0x02;
+/**
+ * A multisig transaction.
+ * @type {number}
+ */
+TransactionTypes.MULTISIG = TransactionTypes.MULTISIG_TYPE | 0x04;
+/**
+ * A provision namespace transaction.
+ * @type {number}
+ */
+TransactionTypes.PROVISION_NAMESPACE = TransactionTypes.NAMESPACE_TYPE | 0x01;
+/**
+ * A asset definition creation transaction.
+ * @type {number}
+ */
+TransactionTypes.MOSAIC_DEFINITION_CREATION = TransactionTypes.MOSAIC_TYPE | 0x01;
+/**
+ * A asset supply change transaction.
+ * @type {number}
+ */
+TransactionTypes.MOSAIC_SUPPLY_CHANGE = TransactionTypes.MOSAIC_TYPE | 0x02;
+exports.TransactionTypes = TransactionTypes;
+//# sourceMappingURL=TransactionTypes.js.map

package/dist/src/models/transaction/TransactionTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionTypes.js","sourceRoot":"","sources":["../../../../src/models/transaction/TransactionTypes.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;AAEH;;GAEG;AACH;IAoHE;;;OAGG;IACI,MAAM,CAAC,0BAA0B;QACtC,OAAO;YACL,gBAAgB,CAAC,QAAQ;YACzB,gBAAgB,CAAC,mBAAmB;YACpC,gBAAgB,CAAC,+BAA+B;YAChD,gBAAgB,CAAC,mBAAmB;YACpC,gBAAgB,CAAC,0BAA0B;YAC3C,gBAAgB,CAAC,oBAAoB;SACtC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,uBAAuB;QACnC,MAAM,KAAK,GAAG,gBAAgB,CAAC,0BAA0B,EAAE,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc;QAC1B,MAAM,KAAK,GAAG,gBAAgB,CAAC,uBAAuB,EAAE,CAAC;QACzD,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;;AAnJD;;;GAGG;AACqB,8BAAa,GAAG,MAAM,CAAC;AAE/C;;;GAGG;AACqB,2BAAU,GAAG,MAAM,CAAC;AAE5C;;;GAGG;AACqB,8BAAa,GAAG,MAAM,CAAC;AAE/C;;;GAGG;AACqB,gCAAe,GAAG,MAAM,CAAC;AAEjD;;;GAGG;AACqB,8BAAa,GAAG,MAAM,CAAC;AAE/C;;;GAGG;AACqB,+BAAc,GAAG,MAAM,CAAC;AAEhD;;;GAGG;AACqB,4BAAW,GAAG,MAAM,CAAC;AAE7C;;;GAGG;AACoB,yBAAQ,GAAG,gBAAgB,CAAC,aAAa,GAAG,IAAI,CAAC;AAExE;;;GAGG;AACoB,oCAAmB,GAAG,gBAAgB,CAAC,eAAe,GAAG,IAAI,CAAC;AAErF;;;GAGG;AACoB,0BAAS,GAAG,gBAAgB,CAAC,UAAU,GAAG,IAAI,CAAC;AAEtE;;;GAGG;AACoB,0BAAS,GAAG,gBAAgB,CAAC,UAAU,GAAG,IAAI,CAAC;AAEtE;;;GAGG;AACoB,0BAAS,GAAG,gBAAgB,CAAC,UAAU,GAAG,IAAI,CAAC;AAEtE;;;GAGG;AACoB,yBAAQ,GAAG,gBAAgB,CAAC,aAAa,GAAG,IAAI,CAAC;AAExE;;;GAGG;AACoB,gDAA+B,GAAG,gBAAgB,CAAC,aAAa,GAAG,IAAI,CAAC;AAE/F;;;GAGG;AACoB,mCAAkB,GAAG,gBAAgB,CAAC,aAAa,GAAG,IAAI,CAAC;AAElF;;;GAGG;AACoB,yBAAQ,GAAG,gBAAgB,CAAC,aAAa,GAAG,IAAI,CAAC;AAExE;;;GAGG;AACoB,oCAAmB,GAAG,gBAAgB,CAAC,cAAc,GAAG,IAAI,CAAC;AAEpF;;;GAGG;AACoB,2CAA0B,GAAG,gBAAgB,CAAC,WAAW,GAAG,IAAI,CAAC;AAExF;;;GAGG;AACoB,qCAAoB,GAAG,gBAAgB,CAAC,WAAW,GAAG,IAAI,CAAC;AAlHpF,4CAsJC"}

package/dist/src/models/transaction/TransferTransaction.d.ts

@@ -0,0 +1,78 @@
+import { TransactionDTO } from "../../infrastructure/transaction/TransactionDTO";
+import { Address } from "../account/Address";
+import { Asset } from "../asset/Asset";
+import { AssetId } from "../asset/AssetId";
+import { AssetTransferable } from "../asset/AssetTransferable";
+import { XEM } from "../asset/XEM";
+import { EncryptedMessage } from "./EncryptedMessage";
+import { PlainMessage } from "./PlainMessage";
+import { TimeWindow } from "./TimeWindow";
+import { Transaction } from "./Transaction";
+/**
+ * Transfer transactions contain data about transfers of XEM or assets to another account.
+ */
+export declare class TransferTransaction extends Transaction {
+    /**
+     * The fee for the transaction. The higher the fee, the higher the priority of the transaction. Transactions with high priority get included in a block before transactions with lower priority.
+     */
+    readonly fee: number;
+    /**
+     * The address of the recipient.
+     */
+    readonly recipient: Address;
+    /**
+     * The xem of XEM that is transferred from sender to recipient.
+     */
+    private readonly _xem;
+    /**
+     * Optionally a transaction can contain a message. In this case the transaction contains a message substructure. If not the field is null.
+     */
+    readonly message: PlainMessage | EncryptedMessage;
+    /**
+     * The array of Asset objects.
+     */
+    private readonly _assets?;
+    /**
+     * in case that the transfer transaction contains assets, it throws an error
+     * @returns {XEM}
+     */
+    xem(): XEM;
+    /**
+     * in case that the transfer transaction does not contain assets, it throws an error
+     * @returns {Asset[]}
+     */
+    assets(): Asset[];
+    /**
+     *
+     * @returns {boolean}
+     */
+    containAssets(): boolean;
+    /**
+     * all the Asset Identifiers of the attached assets
+     * @returns {AssetId[]}
+     */
+    assetsIds(): AssetId[];
+    /**
+     * Create DTO of TransferTransaction
+     * @returns {TransferTransactionDTO}
+     */
+    toDTO(): TransactionDTO;
+    /**
+     * Create a TransferTransaction object
+     * @param timeWindow
+     * @param recipient
+     * @param xem
+     * @param message
+     * @returns {TransferTransaction}
+     */
+    static create(timeWindow: TimeWindow, recipient: Address, xem: XEM, message: PlainMessage | EncryptedMessage): TransferTransaction;
+    /**
+     * Create a TransferTransaction object
+     * @param timeWindow
+     * @param recipient
+     * @param assets
+     * @param message
+     * @returns {TransferTransaction}
+     */
+    static createWithAssets(timeWindow: TimeWindow, recipient: Address, assets: AssetTransferable[], message: PlainMessage | EncryptedMessage): TransferTransaction;
+}