@aeternity/aepp-sdk 11.0.0 → 12.1.0

package/es/tx/index.mjs

@@ -1,6 +1,8 @@
+import _includesInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/includes";
+
 /*
  * ISC License (ISC)
- * Copyright (c) 2018 aeternity developers
+ * Copyright (c) 2022 aeternity developers
  *
  *  Permission to use, copy, modify, and/or distribute this software for any
  *  purpose with or without fee is hereby granted, provided that the above
@@ -16,288 +18,172 @@
  */
 
 /**
- * Tx module
- * @module @aeternity/aepp-sdk/es/tx
- * @export Tx
- * @example import { Tx } from '@aeternity/aepp-sdk'
- */
-import stampit from '@stamp/it';
-import _stampRequired from '@stamp/required';
-/**
- * Basic Tx Stamp
+ * Transaction methods
  *
- * Attempting to create instances from the Stamp without overwriting all
- * abstract methods using composition will result in an exception.
- *
- * Tx is one of the three basic building blocks of an
- * {@link module:@aeternity/aepp-sdk/es/ae--Ae} client and provides methods to
- * create aeternity transactions.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @return {Object} Tx instance
- * @example Tx()
- */
+ * This is implementation of [Tx](api/tx.md) relays
+ * the creation of transactions to {@link Node}.
+ * These methods provide ability to create native transactions.
+ */
+import { ABI_VERSIONS, PROTOCOL_VM_ABI, TX_TTL } from "./builder/schema.mjs";
+import { Tag } from "./builder/constants.mjs";
+import { ArgumentError, UnsupportedProtocolError, UnknownTxError, InvalidTxParamsError } from "../utils/errors.mjs";
+import { buildTx as syncBuildTx, unpackTx } from "./builder/index.mjs";
+import { isKeyOfObject } from "../utils/other.mjs";
+export async function getVmVersion(txType, _ref) {
+  var _abiVersion, _vmVersion;
+
+  let {
+    vmVersion,
+    abiVersion,
+    onNode
+  } = _ref;
+  const {
+    consensusProtocolVersion
+  } = await onNode.getNodeInfo();
 
-const {
-  required
-} = _stampRequired;
-const Tx = stampit(required({
-  methods: {
-    spendTx: required,
-    namePreclaimTx: required,
-    nameClaimTx: required,
-    nameTransferTx: required,
-    nameUpdateTx: required,
-    nameRevokeTx: required,
-    contractCreateTx: required,
-    contractCallTx: required,
-    oracleRegisterTx: required,
-    oracleExtendTx: required,
-    oraclePostQueryTx: required,
-    oracleRespondTx: required,
-    getAccountNonce: required,
-    channelCloseSoloTx: required,
-    channelSlashTx: required,
-    channelSettleTx: required,
-    channelSnapshotSoloTx: required,
-    gaAttachTx: required,
-    getVmVersion: required,
-    prepareTxParams: required
+  if (!isKeyOfObject(consensusProtocolVersion, PROTOCOL_VM_ABI)) {
+    throw new UnsupportedProtocolError('Not supported consensus protocol version');
   }
-}));
-/**
- * Create a `spend_tx` transaction
- * @function spendTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   sender?: String,
- *   recipientId: String,
- *   amount: Number,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number,
- *   payload?: String
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `spend_tx` transaction
- */
 
-/**
- * Create a `name_preclaim_tx` transaction
- * @function namePreclaimTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String, commitment: String, fee?: Number, ttl?: Number, nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_preclaim_tx` transaction
- */
+  const supportedProtocol = PROTOCOL_VM_ABI[consensusProtocolVersion];
 
-/**
- * Create a `name_claim_tx` transaction
- * @function nameClaimTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String, name: String, nameSalt: String, fee?: Number, ttl?: Number, nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_claim_tx` transaction
- */
+  if (!isKeyOfObject(txType, supportedProtocol)) {
+    throw new UnknownTxError('Not supported tx type');
+  }
 
+  const protocolForTX = supportedProtocol[txType];
+  (_abiVersion = abiVersion) !== null && _abiVersion !== void 0 ? _abiVersion : abiVersion = protocolForTX.abiVersion[0];
+  (_vmVersion = vmVersion) !== null && _vmVersion !== void 0 ? _vmVersion : vmVersion = protocolForTX.vmVersion[0];
+  return {
+    vmVersion,
+    abiVersion
+  };
+}
 /**
- * Create a `name_transfer_tx` transaction
- * @function nameTransferTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String,
- *   nameId: String,
- *   recipientId: String,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_transfer_tx` transaction
+ * Calculate fee, get absolute ttl (ttl + height), get account nonce
+ * @category transaction builder
+ * @param txType - Type of transaction
+ * @param params - Object which contains all tx data
+ * @returns Object with account nonce, absolute ttl and transaction fee
  */
 
-/**
- * Create a `name_update_tx` transaction
- * @function nameUpdateTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String,
- *   nameId: String,
- *   pointers: Object,
- *   nameTtl: Number,
- *   clientTtl: Number,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_update_tx` transaction
- */
+export async function prepareTxParams(txType, _ref2) {
+  var _nonce;
 
-/**
- * Create a `name_revoke_tx` transaction
- * @function nameRevokeTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String, nameId: String, fee?: Number, ttl?: Number, nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_revoke_tx` transaction
- */
+  let {
+    senderId,
+    nonce,
+    ttl = TX_TTL,
+    absoluteTtl,
+    strategy,
+    onNode
+  } = _ref2;
+  (_nonce = nonce) !== null && _nonce !== void 0 ? _nonce : nonce = (await onNode.getAccountNextNonce(senderId, {
+    strategy
+  }).catch(() => ({
+    nextNonce: 1
+  }))).nextNonce;
 
-/**
- * Create a `contract_create_tx` transaction
- * @function contractCreateTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   owner: String,
- *   code: String,
- *   callData: String,
- *   vmVersion: Number,
- *   deposit: Number,
- *   amount: Number,
- *   gas: Number,
- *   gasPrice: Number,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `contract_create_tx` transaction
- */
+  if (ttl !== 0) {
+    if (ttl < 0) throw new ArgumentError('ttl', 'greater or equal to 0', ttl);
+    ttl += absoluteTtl === true ? 0 : (await onNode.getCurrentKeyBlock()).height;
+  }
 
-/**
- * Create a `contract_call_tx` transaction
- * @function contractCallTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   callerId: String,
- *   contract: String,
- *   callData: String,
- *   vmVersion: Number,
- *   amount: Number,
- *   gas: Number,
- *   gasPrice: Number,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `contract_call_tx` transaction
- */
+  return {
+    ttl,
+    nonce
+  };
+}
+// TODO: find a better name or rearrange methods
 
 /**
- * Create a `oracle_register_tx` transaction
- * @function oracleRegisterTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   accountId: String,
- *   queryFormat: String,
- *   responseFormat: String,
- *   queryFee: String|Number,
- *   oracleTtl: Object,
- *   vmVersion: Number = ORACLE_VM_VERSION,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `oracle_register_tx` transaction
+ * @category transaction builder
  */
+export async function _buildTx(txType, _ref3) {
+  var _context;
 
-/**
- * Create a `oracle_extend_tx` transaction
- * @function oracleExtendTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   oracleId: String,
- *   callerId: String,
- *   oracleTtl: Object,
- *   fee?: Number,
- *   ttl: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `oracle_extend_tx` transaction
- */
+  let {
+    denomination,
+    absoluteTtl,
+    ..._params
+  } = _ref3;
+  // TODO: avoid this assertion
+  const params = _params;
+  let senderKey;
 
-/**
- * Create a `oracle_post_query_tx` transaction
- * @function oraclePostQuery
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   oracleId: String,
- *   responseTtl: Object,
- *   query: String,
- *   queryTtl: Object,
- *   queryFee: String|Number,
- *   senderId: String,
- *   fee?: Number,
- *   ttl: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `oracle_post_query_tx` transaction
- */
+  switch (txType) {
+    case Tag.SpendTx:
+    case Tag.OracleQueryTx:
+      senderKey = 'senderId';
+      break;
 
-/**
- * Create a `oracle_respond_tx` transaction
- * @function oracleRespondTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   oracleId: String,
- *   callerId: String,
- *   responseTtl: Object,
- *   queryId: String,
- *   response: String,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `oracle_respond_tx` transaction
- */
+    case Tag.NameClaimTx:
+    case Tag.NameUpdateTx:
+    case Tag.NameRevokeTx:
+    case Tag.NameTransferTx:
+    case Tag.NamePreclaimTx:
+    case Tag.OracleRegisterTx:
+      senderKey = 'accountId';
+      break;
 
-/**
- * Get Account Nonce
- * @function getAccountNonce
- * @instance
- * @abstract
- * @category async
- * @rtype (address) => result: Number
- * @param {String} address - Account public key
- * @return {Number} Result
- */
+    case Tag.ContractCreateTx:
+    case Tag.GaAttachTx:
+      senderKey = 'ownerId';
+      break;
+
+    case Tag.ContractCallTx:
+    case Tag.OracleExtendTx:
+    case Tag.OracleResponseTx:
+      senderKey = 'callerId';
+      break;
+
+    case Tag.ChannelCloseSoloTx:
+    case Tag.ChannelSlashTx:
+    case Tag.ChannelSettleTx:
+    case Tag.ChannelSnapshotSoloTx:
+      senderKey = 'fromId';
+      break;
+
+    case Tag.PayingForTx:
+      senderKey = 'payerId';
+      break;
+
+    default:
+      throw new ArgumentError('txType', 'valid transaction type', txType);
+  } // TODO: move specific cases to field-types
+
+
+  if (_includesInstanceProperty(_context = [Tag.ContractCreateTx, Tag.GaAttachTx]).call(_context, txType)) {
+    params.ctVersion = await getVmVersion(Tag.ContractCreateTx, { ...params,
+      ...params.ctVersion
+    });
+  }
+
+  if (txType === Tag.ContractCallTx) {
+    params.abiVersion = (await getVmVersion(Tag.ContractCallTx, params)).abiVersion;
+  }
+
+  if (txType === Tag.OracleRegisterTx) {
+    var _params$abiVersion;
+
+    (_params$abiVersion = params.abiVersion) !== null && _params$abiVersion !== void 0 ? _params$abiVersion : params.abiVersion = ABI_VERSIONS.NO_ABI;
+  }
+
+  if (txType === Tag.PayingForTx) {
+    params.tx = unpackTx(params.tx);
+  }
+
+  const senderId = params[senderKey]; // TODO: do this check on TypeScript level
 
-export default Tx;
+  if (senderId == null) throw new InvalidTxParamsError(`Transaction field ${senderKey} is missed`);
+  const extraParams = await prepareTxParams(txType, { ...params,
+    senderId,
+    absoluteTtl
+  });
+  return syncBuildTx({ ...params,
+    ...extraParams
+  }, txType, {
+    denomination
+  }).tx;
+}
 //# sourceMappingURL=index.mjs.map

package/es/tx/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tx/index.js"],"names":["stampit","Tx","required","methods","spendTx","namePreclaimTx","nameClaimTx","nameTransferTx","nameUpdateTx","nameRevokeTx","contractCreateTx","contractCallTx","oracleRegisterTx","oracleExtendTx","oraclePostQueryTx","oracleRespondTx","getAccountNonce","channelCloseSoloTx","channelSlashTx","channelSettleTx","channelSnapshotSoloTx","gaAttachTx","getVmVersion","prepareTxParams"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AAEA,OAAOA,OAAP,MAAoB,WAApB;AACA,2BAAyB,iBAAzB;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;;AACA,MAAMC,EAAE,GAAGD,OAAO,CAACE,QAAQ,CAAC;AAC1BC,EAAAA,OAAO,EAAE;AACPC,IAAAA,OAAO,EAAEF,QADF;AAEPG,IAAAA,cAAc,EAAEH,QAFT;AAGPI,IAAAA,WAAW,EAAEJ,QAHN;AAIPK,IAAAA,cAAc,EAAEL,QAJT;AAKPM,IAAAA,YAAY,EAAEN,QALP;AAMPO,IAAAA,YAAY,EAAEP,QANP;AAOPQ,IAAAA,gBAAgB,EAAER,QAPX;AAQPS,IAAAA,cAAc,EAAET,QART;AASPU,IAAAA,gBAAgB,EAAEV,QATX;AAUPW,IAAAA,cAAc,EAAEX,QAVT;AAWPY,IAAAA,iBAAiB,EAAEZ,QAXZ;AAYPa,IAAAA,eAAe,EAAEb,QAZV;AAaPc,IAAAA,eAAe,EAAEd,QAbV;AAcPe,IAAAA,kBAAkB,EAAEf,QAdb;AAePgB,IAAAA,cAAc,EAAEhB,QAfT;AAgBPiB,IAAAA,eAAe,EAAEjB,QAhBV;AAiBPkB,IAAAA,qBAAqB,EAAElB,QAjBhB;AAkBPmB,IAAAA,UAAU,EAAEnB,QAlBL;AAmBPoB,IAAAA,YAAY,EAAEpB,QAnBP;AAoBPqB,IAAAA,eAAe,EAAErB;AApBV;AADiB,CAAD,CAAT,CAAlB;AAyBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,eAAeD,EAAf","sourcesContent":["/*\n * ISC License (ISC)\n * Copyright (c) 2018 aeternity developers\n *\n *  Permission to use, copy, modify, and/or distribute this software for any\n *  purpose with or without fee is hereby granted, provided that the above\n *  copyright notice and this permission notice appear in all copies.\n *\n *  THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\n *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\n *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\n *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\n *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\n *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\n *  PERFORMANCE OF THIS SOFTWARE.\n */\n\n/**\n * Tx module\n * @module @aeternity/aepp-sdk/es/tx\n * @export Tx\n * @example import { Tx } from '@aeternity/aepp-sdk'\n */\n\nimport stampit from '@stamp/it'\nimport { required } from '@stamp/required'\n\n/**\n * Basic Tx Stamp\n *\n * Attempting to create instances from the Stamp without overwriting all\n * abstract methods using composition will result in an exception.\n *\n * Tx is one of the three basic building blocks of an\n * {@link module:@aeternity/aepp-sdk/es/ae--Ae} client and provides methods to\n * create aeternity transactions.\n * @function\n * @alias module:@aeternity/aepp-sdk/es/tx\n * @rtype Stamp\n * @param {Object} [options={}] - Initializer object\n * @return {Object} Tx instance\n * @example Tx()\n */\nconst Tx = stampit(required({\n  methods: {\n    spendTx: required,\n    namePreclaimTx: required,\n    nameClaimTx: required,\n    nameTransferTx: required,\n    nameUpdateTx: required,\n    nameRevokeTx: required,\n    contractCreateTx: required,\n    contractCallTx: required,\n    oracleRegisterTx: required,\n    oracleExtendTx: required,\n    oraclePostQueryTx: required,\n    oracleRespondTx: required,\n    getAccountNonce: required,\n    channelCloseSoloTx: required,\n    channelSlashTx: required,\n    channelSettleTx: required,\n    channelSnapshotSoloTx: required,\n    gaAttachTx: required,\n    getVmVersion: required,\n    prepareTxParams: required\n  }\n}))\n\n/**\n * Create a `spend_tx` transaction\n * @function spendTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   sender?: String,\n *   recipientId: String,\n *   amount: Number,\n *   fee?: Number,\n *   ttl?: Number,\n *   nonce?: Number,\n *   payload?: String\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `spend_tx` transaction\n */\n\n/**\n * Create a `name_preclaim_tx` transaction\n * @function namePreclaimTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   account?: String, commitment: String, fee?: Number, ttl?: Number, nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `name_preclaim_tx` transaction\n */\n\n/**\n * Create a `name_claim_tx` transaction\n * @function nameClaimTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   account?: String, name: String, nameSalt: String, fee?: Number, ttl?: Number, nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `name_claim_tx` transaction\n */\n\n/**\n * Create a `name_transfer_tx` transaction\n * @function nameTransferTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   account?: String,\n *   nameId: String,\n *   recipientId: String,\n *   fee?: Number,\n *   ttl?: Number,\n *   nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `name_transfer_tx` transaction\n */\n\n/**\n * Create a `name_update_tx` transaction\n * @function nameUpdateTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   account?: String,\n *   nameId: String,\n *   pointers: Object,\n *   nameTtl: Number,\n *   clientTtl: Number,\n *   fee?: Number,\n *   ttl?: Number,\n *   nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `name_update_tx` transaction\n */\n\n/**\n * Create a `name_revoke_tx` transaction\n * @function nameRevokeTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   account?: String, nameId: String, fee?: Number, ttl?: Number, nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `name_revoke_tx` transaction\n */\n\n/**\n * Create a `contract_create_tx` transaction\n * @function contractCreateTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   owner: String,\n *   code: String,\n *   callData: String,\n *   vmVersion: Number,\n *   deposit: Number,\n *   amount: Number,\n *   gas: Number,\n *   gasPrice: Number,\n *   fee?: Number,\n *   ttl?: Number,\n *   nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `contract_create_tx` transaction\n */\n\n/**\n * Create a `contract_call_tx` transaction\n * @function contractCallTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   callerId: String,\n *   contract: String,\n *   callData: String,\n *   vmVersion: Number,\n *   amount: Number,\n *   gas: Number,\n *   gasPrice: Number,\n *   fee?: Number,\n *   ttl?: Number,\n *   nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `contract_call_tx` transaction\n */\n\n/**\n * Create a `oracle_register_tx` transaction\n * @function oracleRegisterTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   accountId: String,\n *   queryFormat: String,\n *   responseFormat: String,\n *   queryFee: String|Number,\n *   oracleTtl: Object,\n *   vmVersion: Number = ORACLE_VM_VERSION,\n *   fee?: Number,\n *   ttl?: Number,\n *   nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `oracle_register_tx` transaction\n */\n\n/**\n * Create a `oracle_extend_tx` transaction\n * @function oracleExtendTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   oracleId: String,\n *   callerId: String,\n *   oracleTtl: Object,\n *   fee?: Number,\n *   ttl: Number,\n *   nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `oracle_extend_tx` transaction\n */\n\n/**\n * Create a `oracle_post_query_tx` transaction\n * @function oraclePostQuery\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   oracleId: String,\n *   responseTtl: Object,\n *   query: String,\n *   queryTtl: Object,\n *   queryFee: String|Number,\n *   senderId: String,\n *   fee?: Number,\n *   ttl: Number,\n *   nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `oracle_post_query_tx` transaction\n */\n\n/**\n * Create a `oracle_respond_tx` transaction\n * @function oracleRespondTx\n * @instance\n * @abstract\n * @category async\n * @rtype ({\n *   oracleId: String,\n *   callerId: String,\n *   responseTtl: Object,\n *   queryId: String,\n *   response: String,\n *   fee?: Number,\n *   ttl?: Number,\n *   nonce?: Number\n * }) => tx: Promise[String]\n * @param {Object} options - The object to extract properties from\n * @return {String} `oracle_respond_tx` transaction\n */\n\n/**\n * Get Account Nonce\n * @function getAccountNonce\n * @instance\n * @abstract\n * @category async\n * @rtype (address) => result: Number\n * @param {String} address - Account public key\n * @return {Number} Result\n */\n\nexport default Tx\n"],"file":"index.mjs"}
+{"version":3,"file":"index.mjs","names":["ABI_VERSIONS","PROTOCOL_VM_ABI","TX_TTL","Tag","ArgumentError","UnsupportedProtocolError","UnknownTxError","InvalidTxParamsError","buildTx","syncBuildTx","unpackTx","isKeyOfObject","getVmVersion","txType","vmVersion","abiVersion","onNode","consensusProtocolVersion","getNodeInfo","supportedProtocol","protocolForTX","prepareTxParams","senderId","nonce","ttl","absoluteTtl","strategy","getAccountNextNonce","catch","nextNonce","getCurrentKeyBlock","height","_buildTx","denomination","_params","params","senderKey","SpendTx","OracleQueryTx","NameClaimTx","NameUpdateTx","NameRevokeTx","NameTransferTx","NamePreclaimTx","OracleRegisterTx","ContractCreateTx","GaAttachTx","ContractCallTx","OracleExtendTx","OracleResponseTx","ChannelCloseSoloTx","ChannelSlashTx","ChannelSettleTx","ChannelSnapshotSoloTx","PayingForTx","ctVersion","NO_ABI","tx","extraParams"],"sources":["../../src/tx/index.ts"],"sourcesContent":["/*\n * ISC License (ISC)\n * Copyright (c) 2022 aeternity developers\n *\n *  Permission to use, copy, modify, and/or distribute this software for any\n *  purpose with or without fee is hereby granted, provided that the above\n *  copyright notice and this permission notice appear in all copies.\n *\n *  THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\n *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\n *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\n *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\n *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\n *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\n *  PERFORMANCE OF THIS SOFTWARE.\n */\n\n/**\n * Transaction methods\n *\n * This is implementation of [Tx](api/tx.md) relays\n * the creation of transactions to {@link Node}.\n * These methods provide ability to create native transactions.\n */\nimport BigNumber from 'bignumber.js';\nimport {\n  ABI_VERSIONS, CtVersion, PROTOCOL_VM_ABI, TX_TTL, TxParamsCommon,\n} from './builder/schema';\nimport { Tag } from './builder/constants';\nimport {\n  ArgumentError, UnsupportedProtocolError, UnknownTxError, InvalidTxParamsError,\n} from '../utils/errors';\nimport Node from '../Node';\nimport { Encoded } from '../utils/encoder';\nimport { buildTx as syncBuildTx, unpackTx } from './builder/index';\nimport { isKeyOfObject } from '../utils/other';\nimport { AE_AMOUNT_FORMATS } from '../utils/amount-formatter';\n\ntype Int = number | string | BigNumber;\n\nexport type BuildTxOptions <TxType extends Tag, OmitFields extends string> =\n  Omit<Parameters<typeof _buildTx<TxType>>[1], OmitFields>;\n\n/**\n * Validated vm/abi version or get default based on transaction type and NODE version\n * @category transaction builder\n * @param txType - Type of transaction\n * @param ctVersion - Object with vm and abi version fields\n * @returns Object with vm/abi version\n */\nexport async function getVmVersion(\n  txType: Tag.ContractCreateTx, ctVersion: Partial<CtVersion> & { onNode: Node }\n): Promise<CtVersion>;\nexport async function getVmVersion(\n  txType: Tag, ctVersion: Partial<Pick<CtVersion, 'abiVersion'>> & { onNode: Node }\n): Promise<Pick<CtVersion, 'abiVersion'>>;\nexport async function getVmVersion(\n  txType: Tag,\n  { vmVersion, abiVersion, onNode }: Partial<CtVersion> & { onNode: Node },\n): Promise<Partial<CtVersion>> {\n  const { consensusProtocolVersion } = await onNode.getNodeInfo();\n  if (!isKeyOfObject(consensusProtocolVersion, PROTOCOL_VM_ABI)) {\n    throw new UnsupportedProtocolError('Not supported consensus protocol version');\n  }\n  const supportedProtocol = PROTOCOL_VM_ABI[consensusProtocolVersion];\n  if (!isKeyOfObject(txType, supportedProtocol)) {\n    throw new UnknownTxError('Not supported tx type');\n  }\n  const protocolForTX = supportedProtocol[txType];\n  abiVersion ??= protocolForTX.abiVersion[0];\n  vmVersion ??= protocolForTX.vmVersion[0];\n  return { vmVersion, abiVersion };\n}\n\n/**\n * Calculate fee, get absolute ttl (ttl + height), get account nonce\n * @category transaction builder\n * @param txType - Type of transaction\n * @param params - Object which contains all tx data\n * @returns Object with account nonce, absolute ttl and transaction fee\n */\nexport async function prepareTxParams(\n  txType: Tag,\n  {\n    senderId,\n    nonce,\n    ttl = TX_TTL,\n    absoluteTtl,\n    strategy,\n    onNode,\n  }: PrepareTxParamsOptions,\n): Promise<{ ttl: number; nonce: number }> {\n  nonce ??= (\n    await onNode.getAccountNextNonce(senderId, { strategy }).catch(() => ({ nextNonce: 1 }))\n  ).nextNonce;\n\n  if (ttl !== 0) {\n    if (ttl < 0) throw new ArgumentError('ttl', 'greater or equal to 0', ttl);\n    ttl += absoluteTtl === true ? 0 : (await onNode.getCurrentKeyBlock()).height;\n  }\n\n  return { ttl, nonce };\n}\n\ninterface PrepareTxParamsOptions extends Pick<TxParamsCommon, 'nonce' | 'ttl'> {\n  senderId: Encoded.AccountAddress;\n  absoluteTtl?: boolean;\n  strategy?: 'continuity' | 'max';\n  onNode: Node;\n}\n\n// TODO: find a better name or rearrange methods\n/**\n * @category transaction builder\n */\nexport async function _buildTx<TxType extends Tag>(\n  txType: TxType,\n  { denomination, absoluteTtl, ..._params }:\n  Omit<Parameters<typeof syncBuildTx<TxType, 'tx'>>[0], 'fee' | 'nonce' | 'ttl' | 'ctVersion' | 'abiVersion'>\n  & {\n    onNode: Node;\n    fee?: Int;\n    nonce?: number;\n    ttl?: number;\n    denomination?: AE_AMOUNT_FORMATS;\n    absoluteTtl?: boolean;\n  }\n  & (TxType extends Tag.OracleExtendTx | Tag.OracleResponseTx\n    ? { callerId: Encoded.AccountAddress } : {})\n  & (TxType extends Tag.ContractCreateTx | Tag.GaAttachTx ? { ctVersion?: CtVersion } : {})\n  & (TxType extends Tag.ContractCallTx | Tag.OracleRegisterTx\n    ? { abiVersion?: ABI_VERSIONS } : {}),\n): Promise<Encoded.Transaction> {\n  // TODO: avoid this assertion\n  const params = _params as unknown as TxParamsCommon & { onNode: Node };\n  let senderKey: keyof TxParamsCommon | '<absent>';\n  switch (txType) {\n    case Tag.SpendTx:\n    case Tag.OracleQueryTx:\n      senderKey = 'senderId';\n      break;\n    case Tag.NameClaimTx:\n    case Tag.NameUpdateTx:\n    case Tag.NameRevokeTx:\n    case Tag.NameTransferTx:\n    case Tag.NamePreclaimTx:\n    case Tag.OracleRegisterTx:\n      senderKey = 'accountId';\n      break;\n    case Tag.ContractCreateTx:\n    case Tag.GaAttachTx:\n      senderKey = 'ownerId';\n      break;\n    case Tag.ContractCallTx:\n    case Tag.OracleExtendTx:\n    case Tag.OracleResponseTx:\n      senderKey = 'callerId';\n      break;\n    case Tag.ChannelCloseSoloTx:\n    case Tag.ChannelSlashTx:\n    case Tag.ChannelSettleTx:\n    case Tag.ChannelSnapshotSoloTx:\n      senderKey = 'fromId';\n      break;\n    case Tag.PayingForTx:\n      senderKey = 'payerId';\n      break;\n    default:\n      throw new ArgumentError('txType', 'valid transaction type', txType);\n  }\n  // TODO: move specific cases to field-types\n  if ([Tag.ContractCreateTx, Tag.GaAttachTx].includes(txType)) {\n    params.ctVersion = await getVmVersion(\n      Tag.ContractCreateTx,\n      { ...params, ...params.ctVersion },\n    );\n  }\n  if (txType === Tag.ContractCallTx) {\n    params.abiVersion = (await getVmVersion(Tag.ContractCallTx, params)).abiVersion;\n  }\n  if (txType === Tag.OracleRegisterTx) {\n    params.abiVersion ??= ABI_VERSIONS.NO_ABI;\n  }\n  if (txType === Tag.PayingForTx) {\n    params.tx = unpackTx(params.tx);\n  }\n  const senderId = params[senderKey];\n  // TODO: do this check on TypeScript level\n  if (senderId == null) throw new InvalidTxParamsError(`Transaction field ${senderKey} is missed`);\n  const extraParams = await prepareTxParams(txType, { ...params, senderId, absoluteTtl });\n  return syncBuildTx({ ...params, ...extraParams } as any, txType, { denomination }).tx;\n}\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;SAGEA,Y,EAAyBC,e,EAAiBC,M;SAEnCC,G;SAEPC,a,EAAeC,wB,EAA0BC,c,EAAgBC,oB;SAIlDC,OAAO,IAAIC,W,EAAaC,Q;SACxBC,a;AAqBT,OAAO,eAAeC,YAAf,CACLC,MADK,QAGwB;EAAA;;EAAA,IAD7B;IAAEC,SAAF;IAAaC,UAAb;IAAyBC;EAAzB,CAC6B;EAC7B,MAAM;IAAEC;EAAF,IAA+B,MAAMD,MAAM,CAACE,WAAP,EAA3C;;EACA,IAAI,CAACP,aAAa,CAACM,wBAAD,EAA2BhB,eAA3B,CAAlB,EAA+D;IAC7D,MAAM,IAAII,wBAAJ,CAA6B,0CAA7B,CAAN;EACD;;EACD,MAAMc,iBAAiB,GAAGlB,eAAe,CAACgB,wBAAD,CAAzC;;EACA,IAAI,CAACN,aAAa,CAACE,MAAD,EAASM,iBAAT,CAAlB,EAA+C;IAC7C,MAAM,IAAIb,cAAJ,CAAmB,uBAAnB,CAAN;EACD;;EACD,MAAMc,aAAa,GAAGD,iBAAiB,CAACN,MAAD,CAAvC;EACA,eAAAE,UAAU,UAAV,2CAAAA,UAAU,GAAKK,aAAa,CAACL,UAAd,CAAyB,CAAzB,CAAf;EACA,cAAAD,SAAS,UAAT,yCAAAA,SAAS,GAAKM,aAAa,CAACN,SAAd,CAAwB,CAAxB,CAAd;EACA,OAAO;IAAEA,SAAF;IAAaC;EAAb,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,eAAeM,eAAf,CACLR,MADK,SAUoC;EAAA;;EAAA,IARzC;IACES,QADF;IAEEC,KAFF;IAGEC,GAAG,GAAGtB,MAHR;IAIEuB,WAJF;IAKEC,QALF;IAMEV;EANF,CAQyC;EACzC,UAAAO,KAAK,UAAL,iCAAAA,KAAK,GAAK,CACR,MAAMP,MAAM,CAACW,mBAAP,CAA2BL,QAA3B,EAAqC;IAAEI;EAAF,CAArC,EAAmDE,KAAnD,CAAyD,OAAO;IAAEC,SAAS,EAAE;EAAb,CAAP,CAAzD,CADE,EAERA,SAFF;;EAIA,IAAIL,GAAG,KAAK,CAAZ,EAAe;IACb,IAAIA,GAAG,GAAG,CAAV,EAAa,MAAM,IAAIpB,aAAJ,CAAkB,KAAlB,EAAyB,uBAAzB,EAAkDoB,GAAlD,CAAN;IACbA,GAAG,IAAIC,WAAW,KAAK,IAAhB,GAAuB,CAAvB,GAA2B,CAAC,MAAMT,MAAM,CAACc,kBAAP,EAAP,EAAoCC,MAAtE;EACD;;EAED,OAAO;IAAEP,GAAF;IAAOD;EAAP,CAAP;AACD;AASD;;AACA;AACA;AACA;AACA,OAAO,eAAeS,QAAf,CACLnB,MADK,SAiByB;EAAA;;EAAA,IAf9B;IAAEoB,YAAF;IAAgBR,WAAhB;IAA6B,GAAGS;EAAhC,CAe8B;EAC9B;EACA,MAAMC,MAAM,GAAGD,OAAf;EACA,IAAIE,SAAJ;;EACA,QAAQvB,MAAR;IACE,KAAKV,GAAG,CAACkC,OAAT;IACA,KAAKlC,GAAG,CAACmC,aAAT;MACEF,SAAS,GAAG,UAAZ;MACA;;IACF,KAAKjC,GAAG,CAACoC,WAAT;IACA,KAAKpC,GAAG,CAACqC,YAAT;IACA,KAAKrC,GAAG,CAACsC,YAAT;IACA,KAAKtC,GAAG,CAACuC,cAAT;IACA,KAAKvC,GAAG,CAACwC,cAAT;IACA,KAAKxC,GAAG,CAACyC,gBAAT;MACER,SAAS,GAAG,WAAZ;MACA;;IACF,KAAKjC,GAAG,CAAC0C,gBAAT;IACA,KAAK1C,GAAG,CAAC2C,UAAT;MACEV,SAAS,GAAG,SAAZ;MACA;;IACF,KAAKjC,GAAG,CAAC4C,cAAT;IACA,KAAK5C,GAAG,CAAC6C,cAAT;IACA,KAAK7C,GAAG,CAAC8C,gBAAT;MACEb,SAAS,GAAG,UAAZ;MACA;;IACF,KAAKjC,GAAG,CAAC+C,kBAAT;IACA,KAAK/C,GAAG,CAACgD,cAAT;IACA,KAAKhD,GAAG,CAACiD,eAAT;IACA,KAAKjD,GAAG,CAACkD,qBAAT;MACEjB,SAAS,GAAG,QAAZ;MACA;;IACF,KAAKjC,GAAG,CAACmD,WAAT;MACElB,SAAS,GAAG,SAAZ;MACA;;IACF;MACE,MAAM,IAAIhC,aAAJ,CAAkB,QAAlB,EAA4B,wBAA5B,EAAsDS,MAAtD,CAAN;EAhCJ,CAJ8B,CAsC9B;;;EACA,IAAI,sCAACV,GAAG,CAAC0C,gBAAL,EAAuB1C,GAAG,CAAC2C,UAA3B,kBAAgDjC,MAAhD,CAAJ,EAA6D;IAC3DsB,MAAM,CAACoB,SAAP,GAAmB,MAAM3C,YAAY,CACnCT,GAAG,CAAC0C,gBAD+B,EAEnC,EAAE,GAAGV,MAAL;MAAa,GAAGA,MAAM,CAACoB;IAAvB,CAFmC,CAArC;EAID;;EACD,IAAI1C,MAAM,KAAKV,GAAG,CAAC4C,cAAnB,EAAmC;IACjCZ,MAAM,CAACpB,UAAP,GAAoB,CAAC,MAAMH,YAAY,CAACT,GAAG,CAAC4C,cAAL,EAAqBZ,MAArB,CAAnB,EAAiDpB,UAArE;EACD;;EACD,IAAIF,MAAM,KAAKV,GAAG,CAACyC,gBAAnB,EAAqC;IAAA;;IACnC,sBAAAT,MAAM,CAACpB,UAAP,mEAAAoB,MAAM,CAACpB,UAAP,GAAsBf,YAAY,CAACwD,MAAnC;EACD;;EACD,IAAI3C,MAAM,KAAKV,GAAG,CAACmD,WAAnB,EAAgC;IAC9BnB,MAAM,CAACsB,EAAP,GAAY/C,QAAQ,CAACyB,MAAM,CAACsB,EAAR,CAApB;EACD;;EACD,MAAMnC,QAAQ,GAAGa,MAAM,CAACC,SAAD,CAAvB,CAtD8B,CAuD9B;;EACA,IAAId,QAAQ,IAAI,IAAhB,EAAsB,MAAM,IAAIf,oBAAJ,CAA0B,qBAAoB6B,SAAU,YAAxD,CAAN;EACtB,MAAMsB,WAAW,GAAG,MAAMrC,eAAe,CAACR,MAAD,EAAS,EAAE,GAAGsB,MAAL;IAAab,QAAb;IAAuBG;EAAvB,CAAT,CAAzC;EACA,OAAOhB,WAAW,CAAC,EAAE,GAAG0B,MAAL;IAAa,GAAGuB;EAAhB,CAAD,EAAuC7C,MAAvC,EAA+C;IAAEoB;EAAF,CAA/C,CAAX,CAA4EwB,EAAnF;AACD"}

package/es/tx/validator.d.ts

@@ -0,0 +1,20 @@
+import { Tag } from './builder/constants';
+import { Encoded } from '../utils/encoder';
+import Node from '../Node';
+export interface ValidatorResult {
+    message: string;
+    key: string;
+    checkedKeys: string[];
+}
+/**
+ * Transaction Validator
+ * This function validates some of transaction properties,
+ * to make sure it can be posted it to the chain
+ * @category transaction builder
+ * @param transaction - Base64Check-encoded transaction
+ * @param node - Node to validate transaction against
+ * @param parentTxTypes - Types of parent transactions
+ * @returns Array with verification errors
+ * @example const errors = await verifyTransaction(transaction, node)
+ */
+export default function verifyTransaction(transaction: Encoded.Transaction | Encoded.Poi, node: Node, parentTxTypes?: Tag[]): Promise<ValidatorResult[]>;