@aeternity/aepp-sdk 10.0.0 → 12.0.0

package/es/tx/builder/helpers.mjs

@@ -0,0 +1,223 @@
+import _buffer from "buffer";
+const {
+  Buffer: _Buffer
+} = _buffer;
+import BigNumber from 'bignumber.js';
+import { hash, salt } from "../../utils/crypto.mjs";
+import { encode, decode } from "../../utils/encoder.mjs";
+import { toBytes } from "../../utils/bytes.mjs";
+import { concatBuffers } from "../../utils/other.mjs";
+import { ID_TAG_PREFIX, PREFIX_ID_TAG, NAME_BID_RANGES, NAME_FEE_BID_INCREMENT, NAME_BID_TIMEOUT_BLOCKS, NAME_MAX_LENGTH_FEE, POINTER_KEY_BY_PREFIX } from "./constants.mjs";
+import { ceil } from "../../utils/bignumber.mjs";
+import { TagNotFoundError, PrefixNotFoundError, IllegalBidFeeError, ArgumentError } from "../../utils/errors.mjs";
+/**
+ * JavaScript-based Transaction builder helper function's
+ */
+
+export const createSalt = salt;
+export { encode, decode };
+
+/**
+ * Build a contract public key
+ * @param ownerId - The public key of the owner account
+ * @param nonce - the nonce of the transaction
+ * @returns Contract public key
+ */
+export function buildContractId(ownerId, nonce) {
+  const ownerIdAndNonce = _Buffer.from([...decode(ownerId), ...toBytes(nonce)]);
+
+  const b2bHash = hash(ownerIdAndNonce);
+  return encode(b2bHash, 'ct');
+}
+/**
+ * Build a oracle query id
+ * @param senderId - The public key of the sender account
+ * @param nonce - the nonce of the transaction
+ * @param oracleId - The oracle public key
+ * @returns Contract public key
+ */
+
+export function oracleQueryId(senderId, nonce, oracleId) {
+  function _int32(val) {
+    const nonceBE = toBytes(val, true);
+    return concatBuffers([_Buffer.alloc(32 - nonceBE.length), nonceBE]);
+  }
+
+  const b2bHash = hash(_Buffer.from([...decode(senderId), ..._int32(nonce), ...decode(oracleId)]));
+  return encode(b2bHash, 'oq');
+}
+/**
+ * Format the salt into a 64-byte hex string
+ * @param salt - Random number
+ * @returns Zero-padded hex string of salt
+ */
+
+export function formatSalt(salt) {
+  return _Buffer.from(salt.toString(16).padStart(64, '0'), 'hex');
+}
+/**
+ * Encode an AENS name
+ *
+ * @param name - Name to encode
+ * @returns `nm_` prefixed encoded AENS name
+ */
+
+export function produceNameId(name) {
+  return encode(hash(name.toLowerCase()), 'nm');
+}
+/**
+ * Generate the commitment hash by hashing the formatted salt and
+ * name, base 58 encoding the result and prepending 'cm_'
+ *
+ * @param name - Name to be registered
+ * @param salt - Random salt
+ * @returns Commitment hash
+ */
+
+export function commitmentHash(name) {
+  let salt = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : createSalt();
+  return encode(hash(concatBuffers([_Buffer.from(name.toLowerCase()), formatSalt(salt)])), 'cm');
+}
+/**
+ * Utility function to create and _id type
+ * @param hashId - Encoded hash
+ * @returns Buffer Buffer with ID tag and decoded HASh
+ */
+
+export function writeId(hashId) {
+  if (typeof hashId !== 'string') throw new ArgumentError('hashId', 'a string', hashId);
+  const prefix = hashId.slice(0, 2);
+  const idTag = PREFIX_ID_TAG[prefix];
+  if (idTag == null) throw new TagNotFoundError(prefix);
+  return _Buffer.from([...toBytes(idTag), ...decode(hashId)]);
+}
+/**
+ * Utility function to read and _id type
+ * @param buf - Data
+ * @returns Encoided hash string with prefix
+ */
+
+export function readId(buf) {
+  const tag = _Buffer.from(buf).readUIntBE(0, 1);
+
+  const prefix = ID_TAG_PREFIX[tag];
+  if (prefix == null) throw new PrefixNotFoundError(tag);
+  return encode(buf.slice(1, buf.length), prefix);
+}
+/**
+ * Utility function to convert int to bytes
+ * @param val - Value
+ * @returns Buffer Buffer from number(BigEndian)
+ */
+
+export function writeInt(val) {
+  return toBytes(val, true);
+}
+/**
+ * Utility function to convert bytes to int
+ * @param buf - Value
+ * @returns Buffer Buffer from number(BigEndian)
+ */
+
+export function readInt() {
+  let buf = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _Buffer.from([]);
+  return new BigNumber(_Buffer.from(buf).toString('hex'), 16).toString(10);
+}
+/**
+ * Helper function to build pointers for name update TX
+ * @param pointers - Array of pointers
+ * `([ { key: 'account_pubkey', id: 'ak_32klj5j23k23j5423l434l2j3423'} ])`
+ * @returns Serialized pointers array
+ */
+
+export function buildPointers(pointers) {
+  return pointers.map(p => [toBytes(p.key), writeId(p.id)]);
+}
+/**
+ * Helper function to read pointers from name update TX
+ * @param pointers - Array of pointers
+ * @returns Deserialize pointer array
+ */
+
+export function readPointers(pointers) {
+  return pointers.map(_ref => {
+    let [key, id] = _ref;
+    return Object.assign({
+      key: key.toString(),
+      id: readId(id)
+    });
+  });
+}
+const AENS_SUFFIX = '.chain';
+/**
+ * Is AENS name valid
+ * @param name - AENS name
+ */
+
+export function isNameValid(name) {
+  // TODO: probably there are stronger requirements
+  return name.endsWith(AENS_SUFFIX);
+}
+/**
+ * @param identifier - account/oracle/contract address, or channel
+ * @returns default AENS pointer key
+ */
+
+export function getDefaultPointerKey(identifier) {
+  decode(identifier);
+  const prefix = identifier.substring(0, 2);
+  return POINTER_KEY_BY_PREFIX[prefix];
+}
+/**
+ * Get the minimum AENS name fee
+ *
+ * @param name - the AENS name to get the fee for
+ * @returns the minimum fee for the AENS name auction
+ */
+
+export function getMinimumNameFee(name) {
+  const nameLength = name.length - AENS_SUFFIX.length;
+  return NAME_BID_RANGES[Math.min(nameLength, NAME_MAX_LENGTH_FEE)];
+}
+/**
+ * Compute bid fee for AENS auction
+ *
+ * @param name - the AENS name to get the fee for
+ * @param options - Options
+ * @param options.startFee - Auction start fee
+ * @param options.increment - Bid multiplier(In percentage, must be between 0 and 1)
+ * @returns Bid fee
+ */
+
+export function computeBidFee(name) {
+  let {
+    startFee,
+    increment = NAME_FEE_BID_INCREMENT
+  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  if (!(Number(increment) === increment && increment % 1 !== 0)) throw new IllegalBidFeeError(`Increment must be float. Current increment ${increment}`);
+  if (increment < NAME_FEE_BID_INCREMENT) throw new IllegalBidFeeError(`minimum increment percentage is ${NAME_FEE_BID_INCREMENT}`); // FIXME: increment should be used somehow here
+
+  return ceil(new BigNumber(startFee !== null && startFee !== void 0 ? startFee : getMinimumNameFee(name)).times(new BigNumber(NAME_FEE_BID_INCREMENT).plus(1)));
+}
+/**
+ * Compute auction end height
+ *
+ * @param name - Name to compute auction end for
+ * @param claimHeight - Auction starting height
+ * @see {@link https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L273}
+ * @returns Auction end height
+ */
+
+export function computeAuctionEndBlock(name, claimHeight) {
+  const length = name.length - AENS_SUFFIX.length;
+  const h = length <= 4 && 62 * NAME_BID_TIMEOUT_BLOCKS || length <= 8 && 31 * NAME_BID_TIMEOUT_BLOCKS || length <= 12 && NAME_BID_TIMEOUT_BLOCKS || 0;
+  return h + claimHeight;
+}
+/**
+ * Is name accept going to auction
+ */
+
+export function isAuctionName(name) {
+  return name.length < 13 + AENS_SUFFIX.length;
+}
+//# sourceMappingURL=helpers.mjs.map

package/es/tx/builder/helpers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.mjs","names":["BigNumber","hash","salt","encode","decode","toBytes","concatBuffers","ID_TAG_PREFIX","PREFIX_ID_TAG","NAME_BID_RANGES","NAME_FEE_BID_INCREMENT","NAME_BID_TIMEOUT_BLOCKS","NAME_MAX_LENGTH_FEE","POINTER_KEY_BY_PREFIX","ceil","TagNotFoundError","PrefixNotFoundError","IllegalBidFeeError","ArgumentError","createSalt","buildContractId","ownerId","nonce","ownerIdAndNonce","from","b2bHash","oracleQueryId","senderId","oracleId","_int32","val","nonceBE","alloc","length","formatSalt","toString","padStart","produceNameId","name","toLowerCase","commitmentHash","writeId","hashId","prefix","slice","idTag","readId","buf","tag","readUIntBE","writeInt","readInt","buildPointers","pointers","map","p","key","id","readPointers","Object","assign","AENS_SUFFIX","isNameValid","endsWith","getDefaultPointerKey","identifier","substring","getMinimumNameFee","nameLength","Math","min","computeBidFee","startFee","increment","Number","times","plus","computeAuctionEndBlock","claimHeight","h","isAuctionName"],"sources":["../../../src/tx/builder/helpers.ts"],"sourcesContent":["import BigNumber from 'bignumber.js'\nimport { hash, salt } from '../../utils/crypto'\nimport { encode, decode, EncodedData, EncodingType } from '../../utils/encoder'\nimport { toBytes } from '../../utils/bytes'\nimport { concatBuffers } from '../../utils/other'\nimport {\n  ID_TAG_PREFIX,\n  PREFIX_ID_TAG,\n  NAME_BID_RANGES,\n  NAME_FEE_BID_INCREMENT,\n  NAME_BID_TIMEOUT_BLOCKS,\n  NAME_MAX_LENGTH_FEE,\n  POINTER_KEY_BY_PREFIX,\n  AensName\n} from './constants'\nimport { ceil } from '../../utils/bignumber'\nimport {\n  TagNotFoundError,\n  PrefixNotFoundError,\n  IllegalBidFeeError,\n  ArgumentError\n} from '../../utils/errors'\n\n/**\n * JavaScript-based Transaction builder helper function's\n */\n\nexport const createSalt = salt\n\nexport { encode, decode }\n\nexport interface Pointer {\n  key: string\n  id: string\n}\n\n/**\n * Build a contract public key\n * @param ownerId - The public key of the owner account\n * @param nonce - the nonce of the transaction\n * @returns Contract public key\n */\nexport function buildContractId (ownerId: EncodedData<'ak'>, nonce: number | BigNumber): EncodedData<'ct'> {\n  const ownerIdAndNonce = Buffer.from([...decode(ownerId), ...toBytes(nonce)])\n  const b2bHash = hash(ownerIdAndNonce)\n  return encode(b2bHash, 'ct')\n}\n\n/**\n * Build a oracle query id\n * @param senderId - The public key of the sender account\n * @param nonce - the nonce of the transaction\n * @param oracleId - The oracle public key\n * @returns Contract public key\n */\nexport function oracleQueryId (\n  senderId: EncodedData<'ak'>,\n  nonce: number | BigNumber | string,\n  oracleId: EncodedData<'ok'>\n): EncodedData<'oq'> {\n  function _int32 (val: number | string | BigNumber): Buffer {\n    const nonceBE = toBytes(val, true)\n    return concatBuffers([Buffer.alloc(32 - nonceBE.length), nonceBE])\n  }\n\n  const b2bHash = hash(\n    Buffer.from([...decode(senderId), ..._int32(nonce), ...decode(oracleId)]))\n  return encode(b2bHash, 'oq')\n}\n\n/**\n * Format the salt into a 64-byte hex string\n * @param salt - Random number\n * @returns Zero-padded hex string of salt\n */\nexport function formatSalt (salt: number): Buffer {\n  return Buffer.from(salt.toString(16).padStart(64, '0'), 'hex')\n}\n\n/**\n * Encode an AENS name\n *\n * @param name - Name to encode\n * @returns `nm_` prefixed encoded AENS name\n */\nexport function produceNameId (name: AensName): EncodedData<'nm'> {\n  return encode(hash(name.toLowerCase()), 'nm')\n}\n\n/**\n * Generate the commitment hash by hashing the formatted salt and\n * name, base 58 encoding the result and prepending 'cm_'\n *\n * @param name - Name to be registered\n * @param salt - Random salt\n * @returns Commitment hash\n */\nexport function commitmentHash (name: AensName, salt: number = createSalt()): EncodedData<'cm'> {\n  return encode(hash(concatBuffers([Buffer.from(name.toLowerCase()), formatSalt(salt)])), 'cm')\n}\n\n/**\n * Utility function to create and _id type\n * @param hashId - Encoded hash\n * @returns Buffer Buffer with ID tag and decoded HASh\n */\nexport function writeId (hashId: string): Buffer {\n  if (typeof hashId !== 'string') throw new ArgumentError('hashId', 'a string', hashId)\n  const prefix = hashId.slice(0, 2) as keyof typeof PREFIX_ID_TAG\n  const idTag = PREFIX_ID_TAG[prefix]\n  if (idTag == null) throw new TagNotFoundError(prefix)\n  return Buffer.from([...toBytes(idTag), ...decode(hashId as EncodedData<EncodingType>)])\n}\n\n/**\n * Utility function to read and _id type\n * @param buf - Data\n * @returns Encoided hash string with prefix\n */\nexport function readId (buf: Buffer): string {\n  const tag = Buffer.from(buf).readUIntBE(0, 1)\n  const prefix = ID_TAG_PREFIX[tag]\n  if (prefix == null) throw new PrefixNotFoundError(tag)\n  return encode(buf.slice(1, buf.length), prefix)\n}\n\n/**\n * Utility function to convert int to bytes\n * @param val - Value\n * @returns Buffer Buffer from number(BigEndian)\n */\nexport function writeInt (val: number | string | BigNumber): Buffer {\n  return toBytes(val, true)\n}\n\n/**\n * Utility function to convert bytes to int\n * @param buf - Value\n * @returns Buffer Buffer from number(BigEndian)\n */\nexport function readInt (buf: Buffer = Buffer.from([])): string {\n  return new BigNumber(Buffer.from(buf).toString('hex'), 16).toString(10)\n}\n\n/**\n * Helper function to build pointers for name update TX\n * @param pointers - Array of pointers\n * `([ { key: 'account_pubkey', id: 'ak_32klj5j23k23j5423l434l2j3423'} ])`\n * @returns Serialized pointers array\n */\nexport function buildPointers (pointers: Pointer[]): Buffer[][] {\n  return pointers.map(\n    p => [\n      toBytes(p.key),\n      writeId(p.id)\n    ]\n  )\n}\n\n/**\n * Helper function to read pointers from name update TX\n * @param pointers - Array of pointers\n * @returns Deserialize pointer array\n */\nexport function readPointers (pointers: Array<[key: string, id: Buffer]>): Pointer[] {\n  return pointers.map(\n    ([key, id]) => Object.assign({\n      key: key.toString(),\n      id: readId(id)\n    })\n  )\n}\n\nconst AENS_SUFFIX = '.chain'\n\n/**\n * Is AENS name valid\n * @param name - AENS name\n */\nexport function isNameValid (name: string): name is AensName {\n  // TODO: probably there are stronger requirements\n  return name.endsWith(AENS_SUFFIX)\n}\n\n/**\n * @param identifier - account/oracle/contract address, or channel\n * @returns default AENS pointer key\n */\nexport function getDefaultPointerKey (\n  identifier: EncodedData<keyof typeof POINTER_KEY_BY_PREFIX>\n): POINTER_KEY_BY_PREFIX {\n  decode(identifier)\n  const prefix = identifier.substring(0, 2) as keyof typeof POINTER_KEY_BY_PREFIX\n  return POINTER_KEY_BY_PREFIX[prefix]\n}\n\n/**\n * Get the minimum AENS name fee\n *\n * @param name - the AENS name to get the fee for\n * @returns the minimum fee for the AENS name auction\n */\nexport function getMinimumNameFee (name: AensName): BigNumber {\n  const nameLength = name.length - AENS_SUFFIX.length\n  return NAME_BID_RANGES[Math.min(nameLength, NAME_MAX_LENGTH_FEE)]\n}\n\n/**\n * Compute bid fee for AENS auction\n *\n * @param name - the AENS name to get the fee for\n * @param options - Options\n * @param options.startFee - Auction start fee\n * @param options.increment - Bid multiplier(In percentage, must be between 0 and 1)\n * @returns Bid fee\n */\nexport function computeBidFee (\n  name: AensName,\n  { startFee, increment = NAME_FEE_BID_INCREMENT }:\n  { startFee?: number | string | BigNumber, increment?: number } = {}\n): BigNumber {\n  if (!(Number(increment) === increment && increment % 1 !== 0)) throw new IllegalBidFeeError(`Increment must be float. Current increment ${increment}`)\n  if (increment < NAME_FEE_BID_INCREMENT) throw new IllegalBidFeeError(`minimum increment percentage is ${NAME_FEE_BID_INCREMENT}`)\n  // FIXME: increment should be used somehow here\n  return ceil(\n    new BigNumber(startFee ?? getMinimumNameFee(name))\n      .times(new BigNumber(NAME_FEE_BID_INCREMENT).plus(1))\n  )\n}\n\n/**\n * Compute auction end height\n *\n * @param name - Name to compute auction end for\n * @param claimHeight - Auction starting height\n * @see {@link https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L273}\n * @returns Auction end height\n */\nexport function computeAuctionEndBlock (name: AensName, claimHeight: number): number {\n  const length = name.length - AENS_SUFFIX.length\n  const h = (length <= 4 && 62 * NAME_BID_TIMEOUT_BLOCKS) ||\n    (length <= 8 && 31 * NAME_BID_TIMEOUT_BLOCKS) ||\n    (length <= 12 && NAME_BID_TIMEOUT_BLOCKS) ||\n    0\n  return h + claimHeight\n}\n\n/**\n * Is name accept going to auction\n */\nexport function isAuctionName (name: AensName): boolean {\n  return name.length < 13 + AENS_SUFFIX.length\n}\n"],"mappings":";;;;AAAA,OAAOA,SAAP,MAAsB,cAAtB;SACSC,I,EAAMC,I;SACNC,M,EAAQC,M;SACRC,O;SACAC,a;SAEPC,a,EACAC,a,EACAC,e,EACAC,sB,EACAC,uB,EACAC,mB,EACAC,qB;SAGOC,I;SAEPC,gB,EACAC,mB,EACAC,kB,EACAC,a;AAGF;AACA;AACA;;AAEA,OAAO,MAAMC,UAAU,GAAGjB,IAAnB;AAEP,SAASC,MAAT,EAAiBC,MAAjB;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASgB,eAAT,CAA0BC,OAA1B,EAAsDC,KAAtD,EAAoG;EACzG,MAAMC,eAAe,GAAG,QAAOC,IAAP,CAAY,CAAC,GAAGpB,MAAM,CAACiB,OAAD,CAAV,EAAqB,GAAGhB,OAAO,CAACiB,KAAD,CAA/B,CAAZ,CAAxB;;EACA,MAAMG,OAAO,GAAGxB,IAAI,CAACsB,eAAD,CAApB;EACA,OAAOpB,MAAM,CAACsB,OAAD,EAAU,IAAV,CAAb;AACD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,aAAT,CACLC,QADK,EAELL,KAFK,EAGLM,QAHK,EAIc;EACnB,SAASC,MAAT,CAAiBC,GAAjB,EAA2D;IACzD,MAAMC,OAAO,GAAG1B,OAAO,CAACyB,GAAD,EAAM,IAAN,CAAvB;IACA,OAAOxB,aAAa,CAAC,CAAC,QAAO0B,KAAP,CAAa,KAAKD,OAAO,CAACE,MAA1B,CAAD,EAAoCF,OAApC,CAAD,CAApB;EACD;;EAED,MAAMN,OAAO,GAAGxB,IAAI,CAClB,QAAOuB,IAAP,CAAY,CAAC,GAAGpB,MAAM,CAACuB,QAAD,CAAV,EAAsB,GAAGE,MAAM,CAACP,KAAD,CAA/B,EAAwC,GAAGlB,MAAM,CAACwB,QAAD,CAAjD,CAAZ,CADkB,CAApB;EAEA,OAAOzB,MAAM,CAACsB,OAAD,EAAU,IAAV,CAAb;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASS,UAAT,CAAqBhC,IAArB,EAA2C;EAChD,OAAO,QAAOsB,IAAP,CAAYtB,IAAI,CAACiC,QAAL,CAAc,EAAd,EAAkBC,QAAlB,CAA2B,EAA3B,EAA+B,GAA/B,CAAZ,EAAiD,KAAjD,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,aAAT,CAAwBC,IAAxB,EAA2D;EAChE,OAAOnC,MAAM,CAACF,IAAI,CAACqC,IAAI,CAACC,WAAL,EAAD,CAAL,EAA2B,IAA3B,CAAb;AACD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,cAAT,CAAyBF,IAAzB,EAAyF;EAAA,IAAhDpC,IAAgD,uEAAjCiB,UAAU,EAAuB;EAC9F,OAAOhB,MAAM,CAACF,IAAI,CAACK,aAAa,CAAC,CAAC,QAAOkB,IAAP,CAAYc,IAAI,CAACC,WAAL,EAAZ,CAAD,EAAkCL,UAAU,CAAChC,IAAD,CAA5C,CAAD,CAAd,CAAL,EAA2E,IAA3E,CAAb;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASuC,OAAT,CAAkBC,MAAlB,EAA0C;EAC/C,IAAI,OAAOA,MAAP,KAAkB,QAAtB,EAAgC,MAAM,IAAIxB,aAAJ,CAAkB,QAAlB,EAA4B,UAA5B,EAAwCwB,MAAxC,CAAN;EAChC,MAAMC,MAAM,GAAGD,MAAM,CAACE,KAAP,CAAa,CAAb,EAAgB,CAAhB,CAAf;EACA,MAAMC,KAAK,GAAGrC,aAAa,CAACmC,MAAD,CAA3B;EACA,IAAIE,KAAK,IAAI,IAAb,EAAmB,MAAM,IAAI9B,gBAAJ,CAAqB4B,MAArB,CAAN;EACnB,OAAO,QAAOnB,IAAP,CAAY,CAAC,GAAGnB,OAAO,CAACwC,KAAD,CAAX,EAAoB,GAAGzC,MAAM,CAACsC,MAAD,CAA7B,CAAZ,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASI,MAAT,CAAiBC,GAAjB,EAAsC;EAC3C,MAAMC,GAAG,GAAG,QAAOxB,IAAP,CAAYuB,GAAZ,EAAiBE,UAAjB,CAA4B,CAA5B,EAA+B,CAA/B,CAAZ;;EACA,MAAMN,MAAM,GAAGpC,aAAa,CAACyC,GAAD,CAA5B;EACA,IAAIL,MAAM,IAAI,IAAd,EAAoB,MAAM,IAAI3B,mBAAJ,CAAwBgC,GAAxB,CAAN;EACpB,OAAO7C,MAAM,CAAC4C,GAAG,CAACH,KAAJ,CAAU,CAAV,EAAaG,GAAG,CAACd,MAAjB,CAAD,EAA2BU,MAA3B,CAAb;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASO,QAAT,CAAmBpB,GAAnB,EAA6D;EAClE,OAAOzB,OAAO,CAACyB,GAAD,EAAM,IAAN,CAAd;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASqB,OAAT,GAAyD;EAAA,IAAvCJ,GAAuC,uEAAzB,QAAOvB,IAAP,CAAY,EAAZ,CAAyB;EAC9D,OAAO,IAAIxB,SAAJ,CAAc,QAAOwB,IAAP,CAAYuB,GAAZ,EAAiBZ,QAAjB,CAA0B,KAA1B,CAAd,EAAgD,EAAhD,EAAoDA,QAApD,CAA6D,EAA7D,CAAP;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASiB,aAAT,CAAwBC,QAAxB,EAAyD;EAC9D,OAAOA,QAAQ,CAACC,GAAT,CACLC,CAAC,IAAI,CACHlD,OAAO,CAACkD,CAAC,CAACC,GAAH,CADJ,EAEHf,OAAO,CAACc,CAAC,CAACE,EAAH,CAFJ,CADA,CAAP;AAMD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,YAAT,CAAuBL,QAAvB,EAA8E;EACnF,OAAOA,QAAQ,CAACC,GAAT,CACL;IAAA,IAAC,CAACE,GAAD,EAAMC,EAAN,CAAD;IAAA,OAAeE,MAAM,CAACC,MAAP,CAAc;MAC3BJ,GAAG,EAAEA,GAAG,CAACrB,QAAJ,EADsB;MAE3BsB,EAAE,EAAEX,MAAM,CAACW,EAAD;IAFiB,CAAd,CAAf;EAAA,CADK,CAAP;AAMD;AAED,MAAMI,WAAW,GAAG,QAApB;AAEA;AACA;AACA;AACA;;AACA,OAAO,SAASC,WAAT,CAAsBxB,IAAtB,EAAsD;EAC3D;EACA,OAAOA,IAAI,CAACyB,QAAL,CAAcF,WAAd,CAAP;AACD;AAED;AACA;AACA;AACA;;AACA,OAAO,SAASG,oBAAT,CACLC,UADK,EAEkB;EACvB7D,MAAM,CAAC6D,UAAD,CAAN;EACA,MAAMtB,MAAM,GAAGsB,UAAU,CAACC,SAAX,CAAqB,CAArB,EAAwB,CAAxB,CAAf;EACA,OAAOrD,qBAAqB,CAAC8B,MAAD,CAA5B;AACD;AAED;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASwB,iBAAT,CAA4B7B,IAA5B,EAAuD;EAC5D,MAAM8B,UAAU,GAAG9B,IAAI,CAACL,MAAL,GAAc4B,WAAW,CAAC5B,MAA7C;EACA,OAAOxB,eAAe,CAAC4D,IAAI,CAACC,GAAL,CAASF,UAAT,EAAqBxD,mBAArB,CAAD,CAAtB;AACD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAAS2D,aAAT,CACLjC,IADK,EAIM;EAAA,IAFX;IAAEkC,QAAF;IAAYC,SAAS,GAAG/D;EAAxB,CAEW,uEADsD,EACtD;EACX,IAAI,EAAEgE,MAAM,CAACD,SAAD,CAAN,KAAsBA,SAAtB,IAAmCA,SAAS,GAAG,CAAZ,KAAkB,CAAvD,CAAJ,EAA+D,MAAM,IAAIxD,kBAAJ,CAAwB,8CAA6CwD,SAAU,EAA/E,CAAN;EAC/D,IAAIA,SAAS,GAAG/D,sBAAhB,EAAwC,MAAM,IAAIO,kBAAJ,CAAwB,mCAAkCP,sBAAuB,EAAjF,CAAN,CAF7B,CAGX;;EACA,OAAOI,IAAI,CACT,IAAId,SAAJ,CAAcwE,QAAd,aAAcA,QAAd,cAAcA,QAAd,GAA0BL,iBAAiB,CAAC7B,IAAD,CAA3C,EACGqC,KADH,CACS,IAAI3E,SAAJ,CAAcU,sBAAd,EAAsCkE,IAAtC,CAA2C,CAA3C,CADT,CADS,CAAX;AAID;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,sBAAT,CAAiCvC,IAAjC,EAAiDwC,WAAjD,EAA8E;EACnF,MAAM7C,MAAM,GAAGK,IAAI,CAACL,MAAL,GAAc4B,WAAW,CAAC5B,MAAzC;EACA,MAAM8C,CAAC,GAAI9C,MAAM,IAAI,CAAV,IAAe,KAAKtB,uBAArB,IACPsB,MAAM,IAAI,CAAV,IAAe,KAAKtB,uBADb,IAEPsB,MAAM,IAAI,EAAV,IAAgBtB,uBAFT,IAGR,CAHF;EAIA,OAAOoE,CAAC,GAAGD,WAAX;AACD;AAED;AACA;AACA;;AACA,OAAO,SAASE,aAAT,CAAwB1C,IAAxB,EAAiD;EACtD,OAAOA,IAAI,CAACL,MAAL,GAAc,KAAK4B,WAAW,CAAC5B,MAAtC;AACD"}

package/es/tx/builder/index.d.ts

@@ -0,0 +1,75 @@
+import { EncodedData, EncodingType } from './../../utils/encoder';
+import { NestedUint8Array } from 'rlp';
+import { AE_AMOUNT_FORMATS } from '../../utils/amount-formatter';
+import { RawTxObject, TxField, TxTypeSchemas, TX_TYPE, TxSchema } from './schema';
+/**
+ * Validate transaction params
+ * @param params - Object with tx params
+ * @param schema - Transaction schema
+ * @param excludeKeys - Array of keys to exclude for validation
+ * @returns Object with validation errors
+ */
+export declare function validateParams(params: any, schema: TxField[], { excludeKeys }: {
+    excludeKeys: string[];
+}): object;
+/**
+ * Unpack binary transaction
+ * @param binary - Array with binary transaction field's
+ * @param schema - Transaction schema
+ * @returns Object with transaction field's
+ */
+export declare function unpackRawTx<Tx extends TxSchema>(binary: Uint8Array | NestedUint8Array, schema: TxField[]): RawTxObject<Tx>;
+export interface BuiltTx<Tx extends TxSchema, Prefix extends EncodingType> {
+    tx: EncodedData<Prefix>;
+    rlpEncoded: Uint8Array;
+    binary: Uint8Array;
+    txObject: RawTxObject<Tx>;
+}
+/**
+ * Build transaction hash
+ * @param _params - Object with tx params
+ * @param type - Transaction type
+ * @param options - options
+ * @param options.excludeKeys - Array of keys to exclude for validation and build
+ * @param options.denomination - Denomination of amounts
+ * @param options.prefix - Prefix of transaction
+ * @throws {@link InvalidTxParamsError}
+ * @returns object
+ * @returns object.tx Base64Check transaction hash with 'tx_' prefix
+ * @returns object.rlpEncoded rlp encoded transaction
+ * @returns object.binary binary transaction
+ */
+export declare function buildTx<TxType extends TX_TYPE, Prefix>(_params: Omit<TxTypeSchemas[TxType], 'tag' | 'VSN'> & {
+    VSN?: number;
+}, type: TxType, { excludeKeys, prefix, vsn, denomination }?: {
+    excludeKeys?: string[];
+    prefix?: EncodingType;
+    vsn?: number;
+    denomination?: AE_AMOUNT_FORMATS;
+}): BuiltTx<TxSchema, Prefix extends EncodingType ? Prefix : 'tx'>;
+export interface TxUnpacked<Tx extends TxSchema> {
+    txType: TX_TYPE;
+    tx: RawTxObject<Tx>;
+    rlpEncoded: Uint8Array;
+}
+/**
+ * Unpack transaction hash
+ * @param encodedTx - Transaction to unpack
+ * @param txType - Expected transaction type
+ * @returns object
+ * @returns object.tx Object with transaction param's
+ * @returns object.txType Transaction type
+ */
+export declare function unpackTx<TxType extends TX_TYPE>(encodedTx: EncodedData<'tx' | 'pi'>, txType?: TxType): TxUnpacked<TxTypeSchemas[TxType]>;
+/**
+ * Build a transaction hash
+ * @param rawTx - base64 or rlp encoded transaction
+ * @returns Transaction hash
+ */
+export declare function buildTxHash(rawTx: EncodedData<'tx'> | Uint8Array): EncodedData<'th'>;
+/**
+ * Build a contract public key by contractCreateTx or gaAttach
+ * @param contractTx - Transaction
+ * @returns Contract public key
+ */
+export declare function buildContractIdByContractTx(contractTx: EncodedData<'tx'>): EncodedData<'ct'>;