@hiero-ledger/sdk 2.70.0

package/lib/file/FileCreateTransaction.d.ts

@@ -0,0 +1,153 @@
+/**
+ * @namespace proto
+ * @typedef {import("@hashgraph/proto").proto.ITransaction} HieroProto.proto.ITransaction
+ * @typedef {import("@hashgraph/proto").proto.ISignedTransaction} HieroProto.proto.ISignedTransaction
+ * @typedef {import("@hashgraph/proto").proto.TransactionBody} HieroProto.proto.TransactionBody
+ * @typedef {import("@hashgraph/proto").proto.ITransactionBody} HieroProto.proto.ITransactionBody
+ * @typedef {import("@hashgraph/proto").proto.ITransactionResponse} HieroProto.proto.ITransactionResponse
+ * @typedef {import("@hashgraph/proto").proto.IFileCreateTransactionBody} HieroProto.proto.IFileCreateTransactionBody
+ */
+/**
+ * @typedef {import("../channel/Channel.js").default} Channel
+ * @typedef {import("../account/AccountId.js").default} AccountId
+ * @typedef {import("../transaction/TransactionId.js").default} TransactionId
+ */
+/**
+ * Create a new Hedera™ crypto-currency file.
+ */
+export default class FileCreateTransaction extends Transaction {
+    /**
+     * @internal
+     * @param {HieroProto.proto.ITransaction[]} transactions
+     * @param {HieroProto.proto.ISignedTransaction[]} signedTransactions
+     * @param {TransactionId[]} transactionIds
+     * @param {AccountId[]} nodeIds
+     * @param {HieroProto.proto.ITransactionBody[]} bodies
+     * @returns {FileCreateTransaction}
+     */
+    static _fromProtobuf(transactions: HieroProto.proto.ITransaction[], signedTransactions: HieroProto.proto.ISignedTransaction[], transactionIds: TransactionId[], nodeIds: AccountId[], bodies: HieroProto.proto.ITransactionBody[]): FileCreateTransaction;
+    /**
+     * @param {object} [props]
+     * @param {Key[] | KeyList} [props.keys]
+     * @param {Timestamp | Date} [props.expirationTime]
+     * @param {Uint8Array | string} [props.contents]
+     * @param {string} [props.fileMemo]
+     */
+    constructor(props?: {
+        keys?: KeyList | Key[] | undefined;
+        expirationTime?: Date | Timestamp | undefined;
+        contents?: string | Uint8Array<ArrayBufferLike> | undefined;
+        fileMemo?: string | undefined;
+    });
+    /**
+     * @private
+     * @type {?Key[]}
+     */
+    private _keys;
+    /**
+     * @private
+     * @type {Timestamp}
+     */
+    private _expirationTime;
+    /**
+     * @private
+     * @type {?Uint8Array}
+     */
+    private _contents;
+    /**
+     * @private
+     * @type {?string}
+     */
+    private _fileMemo;
+    /**
+     * @returns {?Key[]}
+     */
+    get keys(): Key[] | null;
+    /**
+     * Set the keys which must sign any transactions modifying this file. Required.
+     *
+     * All keys must sign to modify the file's contents or keys. No key is required
+     * to sign for extending the expiration time (except the one for the operator account
+     * paying for the transaction). Only one key must sign to delete the file, however.
+     *
+     * To require more than one key to sign to delete a file, add them to a
+     * KeyList and pass that here.
+     *
+     * The network currently requires a file to have at least one key (or key list or threshold key)
+     * but this requirement may be lifted in the future.
+     *
+     * @param {Key[] | KeyList} keys
+     * @returns {this}
+     */
+    setKeys(keys: Key[] | KeyList): this;
+    /**
+     * @returns {Timestamp}
+     */
+    get expirationTime(): Timestamp;
+    /**
+     * Set the instant at which this file will expire, after which its contents will no longer be
+     * available.
+     *
+     * Defaults to 1/4 of a Julian year from the instant FileCreateTransaction
+     * was invoked.
+     *
+     * May be extended using FileUpdateTransaction#setExpirationTime(Timestamp).
+     *
+     * @param {Timestamp | Date} expirationTime
+     * @returns {this}
+     */
+    setExpirationTime(expirationTime: Timestamp | Date): this;
+    /**
+     * @returns {?Uint8Array}
+     */
+    get contents(): Uint8Array | null;
+    /**
+     * Set the given byte array as the file's contents.
+     *
+     * This may be omitted to create an empty file.
+     *
+     * Note that total size for a given transaction is limited to 6KiB (as of March 2020) by the
+     * network; if you exceed this you may receive a HederaPreCheckStatusException
+     * with Status#TransactionOversize.
+     *
+     * In this case, you will need to break the data into chunks of less than ~6KiB and execute this
+     * transaction with the first chunk and then use FileAppendTransaction with
+     * FileAppendTransaction#setContents(Uint8Array) for the remaining chunks.
+     *
+     * @param {Uint8Array | string} contents
+     * @returns {this}
+     */
+    setContents(contents: Uint8Array | string): this;
+    /**
+     * @returns {?string}
+     */
+    get fileMemo(): string | null;
+    /**
+     * @param {string} memo
+     * @returns {this}
+     */
+    setFileMemo(memo: string): this;
+    /**
+     * @override
+     * @protected
+     * @returns {HieroProto.proto.IFileCreateTransactionBody}
+     */
+    protected override _makeTransactionData(): HieroProto.proto.IFileCreateTransactionBody;
+}
+export namespace HieroProto {
+    namespace proto {
+        type ITransaction = import("@hashgraph/proto").proto.ITransaction;
+        type ISignedTransaction = import("@hashgraph/proto").proto.ISignedTransaction;
+        type TransactionBody = import("@hashgraph/proto").proto.TransactionBody;
+        type ITransactionBody = import("@hashgraph/proto").proto.ITransactionBody;
+        type ITransactionResponse = import("@hashgraph/proto").proto.ITransactionResponse;
+        type IFileCreateTransactionBody = import("@hashgraph/proto").proto.IFileCreateTransactionBody;
+    }
+}
+export type Channel = import("../channel/Channel.js").default;
+export type AccountId = import("../account/AccountId.js").default;
+export type TransactionId = import("../transaction/TransactionId.js").default;
+import Transaction from "../transaction/Transaction.js";
+import Key from "../Key.js";
+import KeyList from "../KeyList.js";
+import Timestamp from "../Timestamp.js";

package/lib/file/FileCreateTransaction.js

@@ -0,0 +1,2 @@
+import e from"../Hbar.js";import t,{TRANSACTION_REGISTRY as i,DEFAULT_AUTO_RENEW_PERIOD as o}from"../transaction/Transaction.js";import{encode as n}from"../encoding/utf8.js";import r from"../Timestamp.js";import s from"../Key.js";import a from"../KeyList.js";import m from"long";class l extends t{constructor(t={}){super(),this._keys=null,this._expirationTime=new r(0,0).plusNanos(m.fromNumber(Date.now()).mul(1e6).add(o.mul(1e9))),this._contents=null,this._fileMemo=null,this._defaultMaxTransactionFee=new e(5),null!=t.keys&&this.setKeys(t.keys),null!=t.expirationTime&&this.setExpirationTime(t.expirationTime),null!=t.contents&&this.setContents(t.contents),t.fileMemo&&null!=t.fileMemo&&this.setFileMemo(t.fileMemo)}static _fromProtobuf(e,i,o,n,a){const m=a[0].fileCreate;return t._fromProtobufTransactions(new l({keys:null!=m.keys&&null!=m.keys.keys?m.keys.keys.map((e=>s._fromProtobufKey(e))):void 0,expirationTime:null!=m.expirationTime?r._fromProtobuf(m.expirationTime):void 0,contents:null!=m.contents?m.contents:void 0,fileMemo:null!=m.memo?m.memo:void 0}),e,i,o,n,a)}get keys(){return this._keys}setKeys(e){if(this._requireNotFrozen(),e instanceof a&&null!=e.threshold)throw new Error("Cannot set threshold key as file key");return this._keys=e instanceof a?e.toArray():e,this}get expirationTime(){return this._expirationTime}setExpirationTime(e){return this._requireNotFrozen(),this._expirationTime=e instanceof r?e:r.fromDate(e),this}get contents(){return this._contents}setContents(e){return this._requireNotFrozen(),this._contents=e instanceof Uint8Array?e:n(e),this}get fileMemo(){return this._fileMemo}setFileMemo(e){return this._requireNotFrozen(),this._fileMemo=e,this}_execute(e,t){return e.file.createFile(t)}_getTransactionDataCase(){return"fileCreate"}_makeTransactionData(){return{keys:null!=this._keys?{keys:this._keys.map((e=>e._toProtobufKey()))}:null,expirationTime:this._expirationTime._toProtobuf(),contents:this._contents,memo:this._fileMemo}}_getLogId(){return`FileCreateTransaction:${this._transactionIds.current.validStart.toString()}`}}i.set("fileCreate",l._fromProtobuf);export{l as default};
+//# sourceMappingURL=FileCreateTransaction.js.map

package/lib/file/FileCreateTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileCreateTransaction.js","sources":["../../src/file/FileCreateTransaction.js"],"sourcesContent":["// SPDX-License-Identifier: Apache-2.0\n\nimport Hbar from \"../Hbar.js\";\nimport Transaction, {\n    TRANSACTION_REGISTRY,\n    DEFAULT_AUTO_RENEW_PERIOD,\n} from \"../transaction/Transaction.js\";\nimport * as utf8 from \"../encoding/utf8.js\";\nimport Timestamp from \"../Timestamp.js\";\nimport Key from \"../Key.js\";\nimport KeyList from \"../KeyList.js\";\nimport Long from \"long\";\n\n/**\n * @namespace proto\n * @typedef {import(\"@hashgraph/proto\").proto.ITransaction} HieroProto.proto.ITransaction\n * @typedef {import(\"@hashgraph/proto\").proto.ISignedTransaction} HieroProto.proto.ISignedTransaction\n * @typedef {import(\"@hashgraph/proto\").proto.TransactionBody} HieroProto.proto.TransactionBody\n * @typedef {import(\"@hashgraph/proto\").proto.ITransactionBody} HieroProto.proto.ITransactionBody\n * @typedef {import(\"@hashgraph/proto\").proto.ITransactionResponse} HieroProto.proto.ITransactionResponse\n * @typedef {import(\"@hashgraph/proto\").proto.IFileCreateTransactionBody} HieroProto.proto.IFileCreateTransactionBody\n */\n\n/**\n * @typedef {import(\"../channel/Channel.js\").default} Channel\n * @typedef {import(\"../account/AccountId.js\").default} AccountId\n * @typedef {import(\"../transaction/TransactionId.js\").default} TransactionId\n */\n\n/**\n * Create a new Hedera™ crypto-currency file.\n */\nexport default class FileCreateTransaction extends Transaction {\n    /**\n     * @param {object} [props]\n     * @param {Key[] | KeyList} [props.keys]\n     * @param {Timestamp | Date} [props.expirationTime]\n     * @param {Uint8Array | string} [props.contents]\n     * @param {string} [props.fileMemo]\n     */\n    constructor(props = {}) {\n        super();\n\n        /**\n         * @private\n         * @type {?Key[]}\n         */\n        this._keys = null;\n\n        /**\n         * @private\n         * @type {Timestamp}\n         */\n        this._expirationTime = new Timestamp(0, 0).plusNanos(\n            Long.fromNumber(Date.now())\n                .mul(1000000)\n                .add(DEFAULT_AUTO_RENEW_PERIOD.mul(1000000000)),\n        );\n\n        /**\n         * @private\n         * @type {?Uint8Array}\n         */\n        this._contents = null;\n\n        /**\n         * @private\n         * @type {?string}\n         */\n        this._fileMemo = null;\n\n        this._defaultMaxTransactionFee = new Hbar(5);\n\n        if (props.keys != null) {\n            this.setKeys(props.keys);\n        }\n\n        if (props.expirationTime != null) {\n            this.setExpirationTime(props.expirationTime);\n        }\n\n        if (props.contents != null) {\n            this.setContents(props.contents);\n        }\n\n        if (props.fileMemo && props.fileMemo != null) {\n            this.setFileMemo(props.fileMemo);\n        }\n    }\n\n    /**\n     * @internal\n     * @param {HieroProto.proto.ITransaction[]} transactions\n     * @param {HieroProto.proto.ISignedTransaction[]} signedTransactions\n     * @param {TransactionId[]} transactionIds\n     * @param {AccountId[]} nodeIds\n     * @param {HieroProto.proto.ITransactionBody[]} bodies\n     * @returns {FileCreateTransaction}\n     */\n    static _fromProtobuf(\n        transactions,\n        signedTransactions,\n        transactionIds,\n        nodeIds,\n        bodies,\n    ) {\n        const body = bodies[0];\n        const create =\n            /** @type {HieroProto.proto.IFileCreateTransactionBody} */ (\n                body.fileCreate\n            );\n\n        return Transaction._fromProtobufTransactions(\n            new FileCreateTransaction({\n                keys:\n                    create.keys != null\n                        ? create.keys.keys != null\n                            ? create.keys.keys.map((key) =>\n                                  Key._fromProtobufKey(key),\n                              )\n                            : undefined\n                        : undefined,\n                expirationTime:\n                    create.expirationTime != null\n                        ? Timestamp._fromProtobuf(create.expirationTime)\n                        : undefined,\n                contents: create.contents != null ? create.contents : undefined,\n                fileMemo: create.memo != null ? create.memo : undefined,\n            }),\n            transactions,\n            signedTransactions,\n            transactionIds,\n            nodeIds,\n            bodies,\n        );\n    }\n\n    /**\n     * @returns {?Key[]}\n     */\n    get keys() {\n        return this._keys;\n    }\n\n    /**\n     * Set the keys which must sign any transactions modifying this file. Required.\n     *\n     * All keys must sign to modify the file's contents or keys. No key is required\n     * to sign for extending the expiration time (except the one for the operator account\n     * paying for the transaction). Only one key must sign to delete the file, however.\n     *\n     * To require more than one key to sign to delete a file, add them to a\n     * KeyList and pass that here.\n     *\n     * The network currently requires a file to have at least one key (or key list or threshold key)\n     * but this requirement may be lifted in the future.\n     *\n     * @param {Key[] | KeyList} keys\n     * @returns {this}\n     */\n    setKeys(keys) {\n        this._requireNotFrozen();\n        if (keys instanceof KeyList && keys.threshold != null) {\n            throw new Error(\"Cannot set threshold key as file key\");\n        }\n\n        this._keys = keys instanceof KeyList ? keys.toArray() : keys;\n\n        return this;\n    }\n\n    /**\n     * @returns {Timestamp}\n     */\n    get expirationTime() {\n        return this._expirationTime;\n    }\n\n    /**\n     * Set the instant at which this file will expire, after which its contents will no longer be\n     * available.\n     *\n     * Defaults to 1/4 of a Julian year from the instant FileCreateTransaction\n     * was invoked.\n     *\n     * May be extended using FileUpdateTransaction#setExpirationTime(Timestamp).\n     *\n     * @param {Timestamp | Date} expirationTime\n     * @returns {this}\n     */\n    setExpirationTime(expirationTime) {\n        this._requireNotFrozen();\n        this._expirationTime =\n            expirationTime instanceof Timestamp\n                ? expirationTime\n                : Timestamp.fromDate(expirationTime);\n\n        return this;\n    }\n\n    /**\n     * @returns {?Uint8Array}\n     */\n    get contents() {\n        return this._contents;\n    }\n\n    /**\n     * Set the given byte array as the file's contents.\n     *\n     * This may be omitted to create an empty file.\n     *\n     * Note that total size for a given transaction is limited to 6KiB (as of March 2020) by the\n     * network; if you exceed this you may receive a HederaPreCheckStatusException\n     * with Status#TransactionOversize.\n     *\n     * In this case, you will need to break the data into chunks of less than ~6KiB and execute this\n     * transaction with the first chunk and then use FileAppendTransaction with\n     * FileAppendTransaction#setContents(Uint8Array) for the remaining chunks.\n     *\n     * @param {Uint8Array | string} contents\n     * @returns {this}\n     */\n    setContents(contents) {\n        this._requireNotFrozen();\n        this._contents =\n            contents instanceof Uint8Array ? contents : utf8.encode(contents);\n\n        return this;\n    }\n\n    /**\n     * @returns {?string}\n     */\n    get fileMemo() {\n        return this._fileMemo;\n    }\n\n    /**\n     * @param {string} memo\n     * @returns {this}\n     */\n    setFileMemo(memo) {\n        this._requireNotFrozen();\n        this._fileMemo = memo;\n\n        return this;\n    }\n\n    /**\n     * @override\n     * @internal\n     * @param {Channel} channel\n     * @param {HieroProto.proto.ITransaction} request\n     * @returns {Promise<HieroProto.proto.ITransactionResponse>}\n     */\n    _execute(channel, request) {\n        return channel.file.createFile(request);\n    }\n\n    /**\n     * @override\n     * @protected\n     * @returns {NonNullable<HieroProto.proto.TransactionBody[\"data\"]>}\n     */\n    _getTransactionDataCase() {\n        return \"fileCreate\";\n    }\n\n    /**\n     * @override\n     * @protected\n     * @returns {HieroProto.proto.IFileCreateTransactionBody}\n     */\n    _makeTransactionData() {\n        return {\n            keys:\n                this._keys != null\n                    ? {\n                          keys: this._keys.map((key) => key._toProtobufKey()),\n                      }\n                    : null,\n            expirationTime: this._expirationTime._toProtobuf(),\n            contents: this._contents,\n            memo: this._fileMemo,\n        };\n    }\n\n    /**\n     * @returns {string}\n     */\n    _getLogId() {\n        const timestamp = /** @type {import(\"../Timestamp.js\").default} */ (\n            this._transactionIds.current.validStart\n        );\n        return `FileCreateTransaction:${timestamp.toString()}`;\n    }\n}\n\n// eslint-disable-next-line @typescript-eslint/unbound-method\nTRANSACTION_REGISTRY.set(\"fileCreate\", FileCreateTransaction._fromProtobuf);\n"],"names":["FileCreateTransaction","Transaction","constructor","props","super","this","_keys","_expirationTime","Timestamp","plusNanos","Long","fromNumber","Date","now","mul","add","DEFAULT_AUTO_RENEW_PERIOD","_contents","_fileMemo","_defaultMaxTransactionFee","Hbar","keys","setKeys","expirationTime","setExpirationTime","contents","setContents","fileMemo","setFileMemo","_fromProtobuf","transactions","signedTransactions","transactionIds","nodeIds","bodies","create","_fromProtobufTransactions","map","key","Key","_fromProtobufKey","undefined","memo","_requireNotFrozen","KeyList","threshold","Error","toArray","fromDate","Uint8Array","utf8.encode","_execute","channel","request","file","createFile","_getTransactionDataCase","_makeTransactionData","_toProtobufKey","_toProtobuf","_getLogId","_transactionIds","current","toString","TRANSACTION_REGISTRY","set"],"mappings":"uRAgCe,MAAMA,UAA8BC,EAQ/C,WAAAC,CAAYC,EAAQ,IAChBC,QAMAC,KAAKC,MAAQ,KAMbD,KAAKE,gBAAkB,IAAIC,EAAU,EAAG,GAAGC,UACvCC,EAAKC,WAAWC,KAAKC,OAChBC,IAAI,KACJC,IAAIC,EAA0BF,IAAI,OAO3CT,KAAKY,UAAY,KAMjBZ,KAAKa,UAAY,KAEjBb,KAAKc,0BAA4B,IAAIC,EAAK,GAExB,MAAdjB,EAAMkB,MACNhB,KAAKiB,QAAQnB,EAAMkB,MAGK,MAAxBlB,EAAMoB,gBACNlB,KAAKmB,kBAAkBrB,EAAMoB,gBAGX,MAAlBpB,EAAMsB,UACNpB,KAAKqB,YAAYvB,EAAMsB,UAGvBtB,EAAMwB,UAA8B,MAAlBxB,EAAMwB,UACxBtB,KAAKuB,YAAYzB,EAAMwB,SAEnC,CAWI,oBAAOE,CACHC,EACAC,EACAC,EACAC,EACAC,GAEA,MACMC,EADOD,EAAO,GAIf,WAEL,OAAOjC,EAAYmC,0BACf,IAAIpC,EAAsB,CACtBqB,KACmB,MAAfc,EAAOd,MACmB,MAApBc,EAAOd,KAAKA,KACRc,EAAOd,KAAKA,KAAKgB,KAAKC,GAClBC,EAAIC,iBAAiBF,UAG7BG,EACVlB,eAC6B,MAAzBY,EAAOZ,eACDf,EAAUqB,cAAcM,EAAOZ,qBAC/BkB,EACVhB,SAA6B,MAAnBU,EAAOV,SAAmBU,EAAOV,cAAWgB,EACtDd,SAAyB,MAAfQ,EAAOO,KAAeP,EAAOO,UAAOD,IAElDX,EACAC,EACAC,EACAC,EACAC,EAEZ,CAKI,QAAIb,GACA,OAAOhB,KAAKC,KACpB,CAkBI,OAAAgB,CAAQD,GAEJ,GADAhB,KAAKsC,oBACDtB,aAAgBuB,GAA6B,MAAlBvB,EAAKwB,UAChC,MAAM,IAAIC,MAAM,wCAKpB,OAFAzC,KAAKC,MAAQe,aAAgBuB,EAAUvB,EAAK0B,UAAY1B,EAEjDhB,IACf,CAKI,kBAAIkB,GACA,OAAOlB,KAAKE,eACpB,CAcI,iBAAAiB,CAAkBD,GAOd,OANAlB,KAAKsC,oBACLtC,KAAKE,gBACDgB,aAA0Bf,EACpBe,EACAf,EAAUwC,SAASzB,GAEtBlB,IACf,CAKI,YAAIoB,GACA,OAAOpB,KAAKY,SACpB,CAkBI,WAAAS,CAAYD,GAKR,OAJApB,KAAKsC,oBACLtC,KAAKY,UACDQ,aAAoBwB,WAAaxB,EAAWyB,EAAYzB,GAErDpB,IACf,CAKI,YAAIsB,GACA,OAAOtB,KAAKa,SACpB,CAMI,WAAAU,CAAYc,GAIR,OAHArC,KAAKsC,oBACLtC,KAAKa,UAAYwB,EAEVrC,IACf,CASI,QAAA8C,CAASC,EAASC,GACd,OAAOD,EAAQE,KAAKC,WAAWF,EACvC,CAOI,uBAAAG,GACI,MAAO,YACf,CAOI,oBAAAC,GACI,MAAO,CACHpC,KACkB,MAAdhB,KAAKC,MACC,CACIe,KAAMhB,KAAKC,MAAM+B,KAAKC,GAAQA,EAAIoB,oBAEtC,KACVnC,eAAgBlB,KAAKE,gBAAgBoD,cACrClC,SAAUpB,KAAKY,UACfyB,KAAMrC,KAAKa,UAEvB,CAKI,SAAA0C,GAII,MAAO,yBAFHvD,KAAKwD,gBAAgBC,QACxB,WACyCC,YAClD,EAIAC,EAAqBC,IAAI,aAAcjE,EAAsB6B"}

package/lib/file/FileDeleteTransaction.cjs

@@ -0,0 +1,149 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _Transaction = _interopRequireWildcard(require("../transaction/Transaction.cjs"));
+var _FileId = _interopRequireDefault(require("./FileId.cjs"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @namespace proto
+ * @typedef {import("@hashgraph/proto").proto.ITransaction} HieroProto.proto.ITransaction
+ * @typedef {import("@hashgraph/proto").proto.ISignedTransaction} HieroProto.proto.ISignedTransaction
+ * @typedef {import("@hashgraph/proto").proto.TransactionBody} HieroProto.proto.TransactionBody
+ * @typedef {import("@hashgraph/proto").proto.ITransactionBody} HieroProto.proto.ITransactionBody
+ * @typedef {import("@hashgraph/proto").proto.ITransactionResponse} HieroProto.proto.ITransactionResponse
+ * @typedef {import("@hashgraph/proto").proto.IFileDeleteTransactionBody} HieroProto.proto.IFileDeleteTransactionBody
+ */
+
+/**
+ * @typedef {import("@hashgraph/cryptography").Key} Key
+ * @typedef {import("../channel/Channel.js").default} Channel
+ * @typedef {import("../client/Client.js").default<*, *>} Client
+ * @typedef {import("../account/AccountId.js").default} AccountId
+ * @typedef {import("../transaction/TransactionId.js").default} TransactionId
+ */
+
+/**
+ * A transaction to delete a file on the Hedera network.
+ *
+ * When deleted, a file's contents are truncated to zero length and it can no longer be updated
+ * or appended to, or its expiration time extended. FileContentsQuery and FileInfoQuery
+ * will throw HederaPreCheckStatusException with a status of Status#FileDeleted.
+ *
+ * Only one of the file's keys needs to sign to delete the file, unless the key you have is part
+ * of a KeyList.
+ */
+class FileDeleteTransaction extends _Transaction.default {
+  /**
+   * @param {object} [props]
+   * @param {FileId | string} [props.fileId]
+   */
+  constructor(props = {}) {
+    super();
+
+    /**
+     * @private
+     * @type {?FileId}
+     */
+    this._fileId = null;
+    if (props.fileId != null) {
+      this.setFileId(props.fileId);
+    }
+  }
+
+  /**
+   * @internal
+   * @param {HieroProto.proto.ITransaction[]} transactions
+   * @param {HieroProto.proto.ISignedTransaction[]} signedTransactions
+   * @param {TransactionId[]} transactionIds
+   * @param {AccountId[]} nodeIds
+   * @param {HieroProto.proto.ITransactionBody[]} bodies
+   * @returns {FileDeleteTransaction}
+   */
+  static _fromProtobuf(transactions, signedTransactions, transactionIds, nodeIds, bodies) {
+    const body = bodies[0];
+    const fileDelete = /** @type {HieroProto.proto.IFileDeleteTransactionBody} */
+    body.fileDelete;
+    return _Transaction.default._fromProtobufTransactions(new FileDeleteTransaction({
+      fileId: fileDelete.fileID != null ? _FileId.default._fromProtobuf(fileDelete.fileID) : undefined
+    }), transactions, signedTransactions, transactionIds, nodeIds, bodies);
+  }
+
+  /**
+   * @returns {?FileId}
+   */
+  get fileId() {
+    return this._fileId;
+  }
+
+  /**
+   * Set the file ID which is being deleted in this transaction.
+   *
+   * @param {FileId | string} fileId
+   * @returns {FileDeleteTransaction}
+   */
+  setFileId(fileId) {
+    this._requireNotFrozen();
+    this._fileId = typeof fileId === "string" ? _FileId.default.fromString(fileId) : fileId.clone();
+    return this;
+  }
+
+  /**
+   * @param {Client} client
+   */
+  _validateChecksums(client) {
+    if (this._fileId != null) {
+      this._fileId.validateChecksum(client);
+    }
+  }
+
+  /**
+   * @override
+   * @internal
+   * @param {Channel} channel
+   * @param {HieroProto.proto.ITransaction} request
+   * @returns {Promise<HieroProto.proto.ITransactionResponse>}
+   */
+  _execute(channel, request) {
+    return channel.file.deleteFile(request);
+  }
+
+  /**
+   * @override
+   * @protected
+   * @returns {NonNullable<HieroProto.proto.TransactionBody["data"]>}
+   */
+  _getTransactionDataCase() {
+    return "fileDelete";
+  }
+
+  /**
+   * @override
+   * @protected
+   * @returns {HieroProto.proto.IFileDeleteTransactionBody}
+   */
+  _makeTransactionData() {
+    return {
+      fileID: this._fileId != null ? this._fileId._toProtobuf() : null
+    };
+  }
+
+  /**
+   * @returns {string}
+   */
+  _getLogId() {
+    const timestamp = /** @type {import("../Timestamp.js").default} */
+    this._transactionIds.current.validStart;
+    return `FileDeleteTransaction:${timestamp.toString()}`;
+  }
+}
+
+// eslint-disable-next-line @typescript-eslint/unbound-method
+exports.default = FileDeleteTransaction;
+_Transaction.TRANSACTION_REGISTRY.set("fileDelete", FileDeleteTransaction._fromProtobuf);

package/lib/file/FileDeleteTransaction.d.ts

@@ -0,0 +1,84 @@
+/**
+ * @namespace proto
+ * @typedef {import("@hashgraph/proto").proto.ITransaction} HieroProto.proto.ITransaction
+ * @typedef {import("@hashgraph/proto").proto.ISignedTransaction} HieroProto.proto.ISignedTransaction
+ * @typedef {import("@hashgraph/proto").proto.TransactionBody} HieroProto.proto.TransactionBody
+ * @typedef {import("@hashgraph/proto").proto.ITransactionBody} HieroProto.proto.ITransactionBody
+ * @typedef {import("@hashgraph/proto").proto.ITransactionResponse} HieroProto.proto.ITransactionResponse
+ * @typedef {import("@hashgraph/proto").proto.IFileDeleteTransactionBody} HieroProto.proto.IFileDeleteTransactionBody
+ */
+/**
+ * @typedef {import("@hashgraph/cryptography").Key} Key
+ * @typedef {import("../channel/Channel.js").default} Channel
+ * @typedef {import("../client/Client.js").default<*, *>} Client
+ * @typedef {import("../account/AccountId.js").default} AccountId
+ * @typedef {import("../transaction/TransactionId.js").default} TransactionId
+ */
+/**
+ * A transaction to delete a file on the Hedera network.
+ *
+ * When deleted, a file's contents are truncated to zero length and it can no longer be updated
+ * or appended to, or its expiration time extended. FileContentsQuery and FileInfoQuery
+ * will throw HederaPreCheckStatusException with a status of Status#FileDeleted.
+ *
+ * Only one of the file's keys needs to sign to delete the file, unless the key you have is part
+ * of a KeyList.
+ */
+export default class FileDeleteTransaction extends Transaction {
+    /**
+     * @internal
+     * @param {HieroProto.proto.ITransaction[]} transactions
+     * @param {HieroProto.proto.ISignedTransaction[]} signedTransactions
+     * @param {TransactionId[]} transactionIds
+     * @param {AccountId[]} nodeIds
+     * @param {HieroProto.proto.ITransactionBody[]} bodies
+     * @returns {FileDeleteTransaction}
+     */
+    static _fromProtobuf(transactions: HieroProto.proto.ITransaction[], signedTransactions: HieroProto.proto.ISignedTransaction[], transactionIds: TransactionId[], nodeIds: AccountId[], bodies: HieroProto.proto.ITransactionBody[]): FileDeleteTransaction;
+    /**
+     * @param {object} [props]
+     * @param {FileId | string} [props.fileId]
+     */
+    constructor(props?: {
+        fileId?: string | FileId | undefined;
+    });
+    /**
+     * @private
+     * @type {?FileId}
+     */
+    private _fileId;
+    /**
+     * @returns {?FileId}
+     */
+    get fileId(): FileId | null;
+    /**
+     * Set the file ID which is being deleted in this transaction.
+     *
+     * @param {FileId | string} fileId
+     * @returns {FileDeleteTransaction}
+     */
+    setFileId(fileId: FileId | string): FileDeleteTransaction;
+    /**
+     * @override
+     * @protected
+     * @returns {HieroProto.proto.IFileDeleteTransactionBody}
+     */
+    protected override _makeTransactionData(): HieroProto.proto.IFileDeleteTransactionBody;
+}
+export namespace HieroProto {
+    namespace proto {
+        type ITransaction = import("@hashgraph/proto").proto.ITransaction;
+        type ISignedTransaction = import("@hashgraph/proto").proto.ISignedTransaction;
+        type TransactionBody = import("@hashgraph/proto").proto.TransactionBody;
+        type ITransactionBody = import("@hashgraph/proto").proto.ITransactionBody;
+        type ITransactionResponse = import("@hashgraph/proto").proto.ITransactionResponse;
+        type IFileDeleteTransactionBody = import("@hashgraph/proto").proto.IFileDeleteTransactionBody;
+    }
+}
+export type Key = import("@hashgraph/cryptography").Key;
+export type Channel = import("../channel/Channel.js").default;
+export type Client = import("../client/Client.js").default<any, any>;
+export type AccountId = import("../account/AccountId.js").default;
+export type TransactionId = import("../transaction/TransactionId.js").default;
+import Transaction from "../transaction/Transaction.js";
+import FileId from "./FileId.js";

package/lib/file/FileDeleteTransaction.js

@@ -0,0 +1,2 @@
+import e,{TRANSACTION_REGISTRY as t}from"../transaction/Transaction.js";import i from"./FileId.js";class r extends e{constructor(e={}){super(),this._fileId=null,null!=e.fileId&&this.setFileId(e.fileId)}static _fromProtobuf(t,l,o,s,n){const f=n[0].fileDelete;return e._fromProtobufTransactions(new r({fileId:null!=f.fileID?i._fromProtobuf(f.fileID):void 0}),t,l,o,s,n)}get fileId(){return this._fileId}setFileId(e){return this._requireNotFrozen(),this._fileId="string"==typeof e?i.fromString(e):e.clone(),this}_validateChecksums(e){null!=this._fileId&&this._fileId.validateChecksum(e)}_execute(e,t){return e.file.deleteFile(t)}_getTransactionDataCase(){return"fileDelete"}_makeTransactionData(){return{fileID:null!=this._fileId?this._fileId._toProtobuf():null}}_getLogId(){return`FileDeleteTransaction:${this._transactionIds.current.validStart.toString()}`}}t.set("fileDelete",r._fromProtobuf);export{r as default};
+//# sourceMappingURL=FileDeleteTransaction.js.map

package/lib/file/FileDeleteTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileDeleteTransaction.js","sources":["../../src/file/FileDeleteTransaction.js"],"sourcesContent":["// SPDX-License-Identifier: Apache-2.0\n\nimport Transaction, {\n    TRANSACTION_REGISTRY,\n} from \"../transaction/Transaction.js\";\nimport FileId from \"./FileId.js\";\n\n/**\n * @namespace proto\n * @typedef {import(\"@hashgraph/proto\").proto.ITransaction} HieroProto.proto.ITransaction\n * @typedef {import(\"@hashgraph/proto\").proto.ISignedTransaction} HieroProto.proto.ISignedTransaction\n * @typedef {import(\"@hashgraph/proto\").proto.TransactionBody} HieroProto.proto.TransactionBody\n * @typedef {import(\"@hashgraph/proto\").proto.ITransactionBody} HieroProto.proto.ITransactionBody\n * @typedef {import(\"@hashgraph/proto\").proto.ITransactionResponse} HieroProto.proto.ITransactionResponse\n * @typedef {import(\"@hashgraph/proto\").proto.IFileDeleteTransactionBody} HieroProto.proto.IFileDeleteTransactionBody\n */\n\n/**\n * @typedef {import(\"@hashgraph/cryptography\").Key} Key\n * @typedef {import(\"../channel/Channel.js\").default} Channel\n * @typedef {import(\"../client/Client.js\").default<*, *>} Client\n * @typedef {import(\"../account/AccountId.js\").default} AccountId\n * @typedef {import(\"../transaction/TransactionId.js\").default} TransactionId\n */\n\n/**\n * A transaction to delete a file on the Hedera network.\n *\n * When deleted, a file's contents are truncated to zero length and it can no longer be updated\n * or appended to, or its expiration time extended. FileContentsQuery and FileInfoQuery\n * will throw HederaPreCheckStatusException with a status of Status#FileDeleted.\n *\n * Only one of the file's keys needs to sign to delete the file, unless the key you have is part\n * of a KeyList.\n */\nexport default class FileDeleteTransaction extends Transaction {\n    /**\n     * @param {object} [props]\n     * @param {FileId | string} [props.fileId]\n     */\n    constructor(props = {}) {\n        super();\n\n        /**\n         * @private\n         * @type {?FileId}\n         */\n        this._fileId = null;\n\n        if (props.fileId != null) {\n            this.setFileId(props.fileId);\n        }\n    }\n\n    /**\n     * @internal\n     * @param {HieroProto.proto.ITransaction[]} transactions\n     * @param {HieroProto.proto.ISignedTransaction[]} signedTransactions\n     * @param {TransactionId[]} transactionIds\n     * @param {AccountId[]} nodeIds\n     * @param {HieroProto.proto.ITransactionBody[]} bodies\n     * @returns {FileDeleteTransaction}\n     */\n    static _fromProtobuf(\n        transactions,\n        signedTransactions,\n        transactionIds,\n        nodeIds,\n        bodies,\n    ) {\n        const body = bodies[0];\n        const fileDelete =\n            /** @type {HieroProto.proto.IFileDeleteTransactionBody} */ (\n                body.fileDelete\n            );\n\n        return Transaction._fromProtobufTransactions(\n            new FileDeleteTransaction({\n                fileId:\n                    fileDelete.fileID != null\n                        ? FileId._fromProtobuf(fileDelete.fileID)\n                        : undefined,\n            }),\n            transactions,\n            signedTransactions,\n            transactionIds,\n            nodeIds,\n            bodies,\n        );\n    }\n\n    /**\n     * @returns {?FileId}\n     */\n    get fileId() {\n        return this._fileId;\n    }\n\n    /**\n     * Set the file ID which is being deleted in this transaction.\n     *\n     * @param {FileId | string} fileId\n     * @returns {FileDeleteTransaction}\n     */\n    setFileId(fileId) {\n        this._requireNotFrozen();\n        this._fileId =\n            typeof fileId === \"string\"\n                ? FileId.fromString(fileId)\n                : fileId.clone();\n\n        return this;\n    }\n\n    /**\n     * @param {Client} client\n     */\n    _validateChecksums(client) {\n        if (this._fileId != null) {\n            this._fileId.validateChecksum(client);\n        }\n    }\n\n    /**\n     * @override\n     * @internal\n     * @param {Channel} channel\n     * @param {HieroProto.proto.ITransaction} request\n     * @returns {Promise<HieroProto.proto.ITransactionResponse>}\n     */\n    _execute(channel, request) {\n        return channel.file.deleteFile(request);\n    }\n\n    /**\n     * @override\n     * @protected\n     * @returns {NonNullable<HieroProto.proto.TransactionBody[\"data\"]>}\n     */\n    _getTransactionDataCase() {\n        return \"fileDelete\";\n    }\n\n    /**\n     * @override\n     * @protected\n     * @returns {HieroProto.proto.IFileDeleteTransactionBody}\n     */\n    _makeTransactionData() {\n        return {\n            fileID: this._fileId != null ? this._fileId._toProtobuf() : null,\n        };\n    }\n\n    /**\n     * @returns {string}\n     */\n    _getLogId() {\n        const timestamp = /** @type {import(\"../Timestamp.js\").default} */ (\n            this._transactionIds.current.validStart\n        );\n        return `FileDeleteTransaction:${timestamp.toString()}`;\n    }\n}\n\n// eslint-disable-next-line @typescript-eslint/unbound-method\nTRANSACTION_REGISTRY.set(\"fileDelete\", FileDeleteTransaction._fromProtobuf);\n"],"names":["FileDeleteTransaction","Transaction","constructor","props","super","this","_fileId","fileId","setFileId","_fromProtobuf","transactions","signedTransactions","transactionIds","nodeIds","bodies","fileDelete","_fromProtobufTransactions","fileID","FileId","undefined","_requireNotFrozen","fromString","clone","_validateChecksums","client","validateChecksum","_execute","channel","request","file","deleteFile","_getTransactionDataCase","_makeTransactionData","_toProtobuf","_getLogId","_transactionIds","current","toString","TRANSACTION_REGISTRY","set"],"mappings":"mGAmCe,MAAMA,UAA8BC,EAK/C,WAAAC,CAAYC,EAAQ,IAChBC,QAMAC,KAAKC,QAAU,KAEK,MAAhBH,EAAMI,QACNF,KAAKG,UAAUL,EAAMI,OAEjC,CAWI,oBAAOE,CACHC,EACAC,EACAC,EACAC,EACAC,GAEA,MACMC,EADOD,EAAO,GAIf,WAEL,OAAOb,EAAYe,0BACf,IAAIhB,EAAsB,CACtBO,OACyB,MAArBQ,EAAWE,OACLC,EAAOT,cAAcM,EAAWE,aAChCE,IAEdT,EACAC,EACAC,EACAC,EACAC,EAEZ,CAKI,UAAIP,GACA,OAAOF,KAAKC,OACpB,CAQI,SAAAE,CAAUD,GAON,OANAF,KAAKe,oBACLf,KAAKC,QACiB,iBAAXC,EACDW,EAAOG,WAAWd,GAClBA,EAAOe,QAEVjB,IACf,CAKI,kBAAAkB,CAAmBC,GACK,MAAhBnB,KAAKC,SACLD,KAAKC,QAAQmB,iBAAiBD,EAE1C,CASI,QAAAE,CAASC,EAASC,GACd,OAAOD,EAAQE,KAAKC,WAAWF,EACvC,CAOI,uBAAAG,GACI,MAAO,YACf,CAOI,oBAAAC,GACI,MAAO,CACHf,OAAwB,MAAhBZ,KAAKC,QAAkBD,KAAKC,QAAQ2B,cAAgB,KAExE,CAKI,SAAAC,GAII,MAAO,yBAFH7B,KAAK8B,gBAAgBC,QACxB,WACyCC,YAClD,EAIAC,EAAqBC,IAAI,aAAcvC,EAAsBS"}