@aeternity/aepp-sdk 10.0.0 → 12.0.0

package/es/spend.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"spend.mjs","names":["sendTransaction","getAccount","getBalance","resolveName","_buildTx","buildTxHash","unpackTx","BigNumber","ArgumentError","createMetaTx","TX_TYPE","send","tx","options","contractId","authFun","undefined","innerTx","onAccount","address","signed","signUsingGA","authData","signTransaction","hash","rawTx","spend","amount","recipientIdOrName","senderId","recipientId","transferFunds","fraction","balance","bind","desiredAmount","times","integerValue","ROUND_HALF_UP","fee","plus","gt","minus","payForTransaction","transaction","payingFor","payerId"],"sources":["../src/spend.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 */\nimport { sendTransaction, getAccount, getBalance, resolveName } from './chain'\nimport { _buildTx, BuildTxOptions } from './tx'\nimport { buildTxHash, unpackTx } from './tx/builder'\nimport BigNumber from 'bignumber.js'\nimport { ArgumentError } from './utils/errors'\nimport { EncodedData } from './utils/encoder'\nimport { createMetaTx } from './contract/ga'\nimport { TX_TYPE, AensName } from './tx/builder/schema'\nimport AccountBase from './account/Base'\n\n/**\n * Sign and post a transaction to the chain\n * @param tx - Transaction\n * @param options - Options\n * @param options.verify - Verify transaction before broadcast, throw error if not\n * valid\n * @returns Transaction\n */\nexport async function send (tx: EncodedData<'tx'>, options: SendOptions): Promise<SendReturnType> {\n  const { contractId, authFun = undefined } = options.innerTx === true\n    ? { contractId: null }\n    : await getAccount(await options.onAccount.address(options), options)\n\n  const signed = contractId != null\n    // TODO: not required arguments become required depending on account type, can ga be extracted?\n    ? await signUsingGA(tx, { authData: {}, ...options, authFun: authFun as string })\n    : await options.onAccount.signTransaction(tx, options)\n\n  return options.innerTx === true\n    ? { hash: buildTxHash(signed), rawTx: signed }\n    : await sendTransaction(signed, options)\n}\n\ntype SendOptionsType = Parameters<AccountBase['signTransaction']>[1] & Parameters<typeof sendTransaction>[1]\n& Partial<Omit<Parameters<typeof signUsingGA>[1], 'onAccount' | 'onCompiler'>>\n& Pick<Parameters<typeof signUsingGA>[1], 'onAccount' | 'onCompiler'>\nexport interface SendOptions extends SendOptionsType {}\ninterface SendReturnType extends Awaited<ReturnType<typeof sendTransaction>> {}\n\nexport async function signUsingGA (\n  tx: EncodedData<'tx'>,\n  { authData, authFun, ...options }: {\n    authData: Parameters<typeof createMetaTx>[1]\n    authFun: Parameters<typeof createMetaTx>[2]\n  } & Parameters<typeof createMetaTx>[3]\n): Promise<EncodedData<'tx'>> {\n  return await createMetaTx(tx, authData, authFun, options)\n}\n\n/**\n * Send coins to another account\n * @param amount - Amount to spend\n * @param recipientIdOrName - Address or name of recipient account\n * @param options - Options\n * @returns Transaction\n */\nexport async function spend (\n  amount: number | string,\n  recipientIdOrName: EncodedData<'ak'> | AensName,\n  options: SpendOptions\n): ReturnType<typeof send> {\n  return await send(\n    await _buildTx(TX_TYPE.spend, {\n      ...options,\n      senderId: await options.onAccount.address(options),\n      recipientId: await resolveName(recipientIdOrName, 'account_pubkey', options),\n      amount\n    }),\n    options\n  )\n}\n\ntype SpendOptionsType = BuildTxOptions<TX_TYPE.spend, 'senderId' | 'recipientId' | 'amount'>\n& Parameters<typeof resolveName>[2] & { onAccount: AccountBase } & SendOptions\ninterface SpendOptions extends SpendOptionsType {}\n\n// TODO: Rename to spendFraction\n/**\n * Send a fraction of coin balance to another account\n * @param fraction - Fraction of balance to spend (between 0 and 1)\n * @param recipientIdOrName - Address or name of recipient account\n * @param options - Options\n * @returns Transaction\n */\nexport async function transferFunds (\n  fraction: number | string,\n  recipientIdOrName: AensName | EncodedData<'ak'>,\n  options: TransferFundsOptions\n): ReturnType<typeof send> {\n  if (fraction < 0 || fraction > 1) {\n    throw new ArgumentError('fraction', 'a number between 0 and 1', fraction)\n  }\n  const recipientId = await resolveName<'ak'>(recipientIdOrName, 'account_pubkey', options)\n  const senderId = await options.onAccount.address(options)\n  const balance = new BigNumber(\n    await getBalance.bind(options.onAccount)(senderId, options)\n  )\n  const desiredAmount = balance.times(fraction).integerValue(BigNumber.ROUND_HALF_UP)\n  const { tx: { fee } } = unpackTx(\n    await _buildTx(TX_TYPE.spend, { ...options, senderId, recipientId, amount: desiredAmount }),\n    TX_TYPE.spend\n  )\n  // Reducing of the amount may reduce transaction fee, so this is not completely accurate\n  const amount = desiredAmount.plus(fee).gt(balance) ? balance.minus(fee) : desiredAmount\n  return await send(\n    await _buildTx(TX_TYPE.spend, { ...options, senderId, recipientId, amount }),\n    options\n  )\n}\n\ntype TransferFundsOptionsType = BuildTxOptions<TX_TYPE.spend, 'senderId' | 'recipientId' | 'amount'>\n& Parameters<typeof resolveName>[2] & { onAccount: AccountBase } & SendOptions\ninterface TransferFundsOptions extends TransferFundsOptionsType {}\n\n/**\n * Submit transaction of another account paying for it (fee and gas)\n * @param transaction - tx_<base64>-encoded transaction\n * @param options - Options\n * @returns Object Transaction\n */\nexport async function payForTransaction (\n  transaction: EncodedData<'tx'>, options: PayForTransactionOptions\n): ReturnType<typeof send> {\n  return await send(\n    await _buildTx(\n      TX_TYPE.payingFor,\n      { ...options, payerId: await options.onAccount.address(options), tx: transaction }\n    ),\n    options\n  )\n}\n\ninterface PayForTransactionOptions extends\n  BuildTxOptions<TX_TYPE.payingFor, 'payerId' | 'tx'>, SendOptions {\n  onAccount: AccountBase\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;SACSA,e,EAAiBC,U,EAAYC,U,EAAYC,W;SACzCC,Q;SACAC,W,EAAaC,Q;AACtB,OAAOC,SAAP,MAAsB,cAAtB;SACSC,a;SAEAC,Y;SACAC,O;;AAGT;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,IAAf,CAAqBC,EAArB,EAA4CC,OAA5C,EAA2F;EAChG,MAAM;IAAEC,UAAF;IAAcC,OAAO,GAAGC;EAAxB,IAAsCH,OAAO,CAACI,OAAR,KAAoB,IAApB,GACxC;IAAEH,UAAU,EAAE;EAAd,CADwC,GAExC,MAAMb,UAAU,CAAC,MAAMY,OAAO,CAACK,SAAR,CAAkBC,OAAlB,CAA0BN,OAA1B,CAAP,EAA2CA,OAA3C,CAFpB;EAIA,MAAMO,MAAM,GAAGN,UAAU,IAAI,IAAd,CACb;EADa,EAEX,MAAMO,WAAW,CAACT,EAAD,EAAK;IAAEU,QAAQ,EAAE,EAAZ;IAAgB,GAAGT,OAAnB;IAA4BE,OAAO,EAAEA;EAArC,CAAL,CAFN,GAGX,MAAMF,OAAO,CAACK,SAAR,CAAkBK,eAAlB,CAAkCX,EAAlC,EAAsCC,OAAtC,CAHV;EAKA,OAAOA,OAAO,CAACI,OAAR,KAAoB,IAApB,GACH;IAAEO,IAAI,EAAEnB,WAAW,CAACe,MAAD,CAAnB;IAA6BK,KAAK,EAAEL;EAApC,CADG,GAEH,MAAMpB,eAAe,CAACoB,MAAD,EAASP,OAAT,CAFzB;AAGD;AAQD,OAAO,eAAeQ,WAAf,CACLT,EADK,QAMuB;EAAA,IAJ5B;IAAEU,QAAF;IAAYP,OAAZ;IAAqB,GAAGF;EAAxB,CAI4B;EAC5B,OAAO,MAAMJ,YAAY,CAACG,EAAD,EAAKU,QAAL,EAAeP,OAAf,EAAwBF,OAAxB,CAAzB;AACD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,OAAO,eAAea,KAAf,CACLC,MADK,EAELC,iBAFK,EAGLf,OAHK,EAIoB;EACzB,OAAO,MAAMF,IAAI,CACf,MAAMP,QAAQ,CAACM,OAAO,CAACgB,KAAT,EAAgB,EAC5B,GAAGb,OADyB;IAE5BgB,QAAQ,EAAE,MAAMhB,OAAO,CAACK,SAAR,CAAkBC,OAAlB,CAA0BN,OAA1B,CAFY;IAG5BiB,WAAW,EAAE,MAAM3B,WAAW,CAACyB,iBAAD,EAAoB,gBAApB,EAAsCf,OAAtC,CAHF;IAI5Bc;EAJ4B,CAAhB,CADC,EAOfd,OAPe,CAAjB;AASD;AAMD;;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAekB,aAAf,CACLC,QADK,EAELJ,iBAFK,EAGLf,OAHK,EAIoB;EACzB,IAAImB,QAAQ,GAAG,CAAX,IAAgBA,QAAQ,GAAG,CAA/B,EAAkC;IAChC,MAAM,IAAIxB,aAAJ,CAAkB,UAAlB,EAA8B,0BAA9B,EAA0DwB,QAA1D,CAAN;EACD;;EACD,MAAMF,WAAW,GAAG,MAAM3B,WAAW,CAAOyB,iBAAP,EAA0B,gBAA1B,EAA4Cf,OAA5C,CAArC;EACA,MAAMgB,QAAQ,GAAG,MAAMhB,OAAO,CAACK,SAAR,CAAkBC,OAAlB,CAA0BN,OAA1B,CAAvB;EACA,MAAMoB,OAAO,GAAG,IAAI1B,SAAJ,CACd,MAAML,UAAU,CAACgC,IAAX,CAAgBrB,OAAO,CAACK,SAAxB,EAAmCW,QAAnC,EAA6ChB,OAA7C,CADQ,CAAhB;EAGA,MAAMsB,aAAa,GAAGF,OAAO,CAACG,KAAR,CAAcJ,QAAd,EAAwBK,YAAxB,CAAqC9B,SAAS,CAAC+B,aAA/C,CAAtB;EACA,MAAM;IAAE1B,EAAE,EAAE;MAAE2B;IAAF;EAAN,IAAkBjC,QAAQ,CAC9B,MAAMF,QAAQ,CAACM,OAAO,CAACgB,KAAT,EAAgB,EAAE,GAAGb,OAAL;IAAcgB,QAAd;IAAwBC,WAAxB;IAAqCH,MAAM,EAAEQ;EAA7C,CAAhB,CADgB,EAE9BzB,OAAO,CAACgB,KAFsB,CAAhC,CAVyB,CAczB;;EACA,MAAMC,MAAM,GAAGQ,aAAa,CAACK,IAAd,CAAmBD,GAAnB,EAAwBE,EAAxB,CAA2BR,OAA3B,IAAsCA,OAAO,CAACS,KAAR,CAAcH,GAAd,CAAtC,GAA2DJ,aAA1E;EACA,OAAO,MAAMxB,IAAI,CACf,MAAMP,QAAQ,CAACM,OAAO,CAACgB,KAAT,EAAgB,EAAE,GAAGb,OAAL;IAAcgB,QAAd;IAAwBC,WAAxB;IAAqCH;EAArC,CAAhB,CADC,EAEfd,OAFe,CAAjB;AAID;;AAMD;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAe8B,iBAAf,CACLC,WADK,EAC2B/B,OAD3B,EAEoB;EACzB,OAAO,MAAMF,IAAI,CACf,MAAMP,QAAQ,CACZM,OAAO,CAACmC,SADI,EAEZ,EAAE,GAAGhC,OAAL;IAAciC,OAAO,EAAE,MAAMjC,OAAO,CAACK,SAAR,CAAkBC,OAAlB,CAA0BN,OAA1B,CAA7B;IAAiED,EAAE,EAAEgC;EAArE,CAFY,CADC,EAKf/B,OALe,CAAjB;AAOD"}

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

@@ -0,0 +1,41 @@
+import { EncodingType } from './../../utils/encoder';
+import BigNumber from 'bignumber.js';
+export declare type AensName = `${string}.chain`;
+export declare const NAME_TTL = 180000;
+export declare const NAME_MAX_TTL = 36000;
+export declare const NAME_MAX_CLIENT_TTL = 84600;
+export declare const CLIENT_TTL = 84600;
+export declare const MIN_GAS_PRICE = 1000000000;
+export declare const NAME_FEE_MULTIPLIER = 100000000000000;
+export declare const NAME_FEE_BID_INCREMENT = 0.05;
+export declare const NAME_BID_TIMEOUT_BLOCKS = 480;
+export declare const NAME_MAX_LENGTH_FEE = 31;
+export declare const NAME_BID_MAX_LENGTH = 12;
+export declare enum POINTER_KEY_BY_PREFIX {
+    ak = "account_pubkey",
+    ok = "oracle_pubkey",
+    ct = "contract_pubkey",
+    ch = "channel"
+}
+export declare const NAME_BID_RANGES: {
+    [k: string]: BigNumber;
+};
+export declare const ID_TAG: {
+    account: number;
+    name: number;
+    commitment: number;
+    oracle: number;
+    contract: number;
+    channel: number;
+};
+export declare const PREFIX_ID_TAG: {
+    readonly ak: number;
+    readonly nm: number;
+    readonly cm: number;
+    readonly ok: number;
+    readonly ct: number;
+    readonly ch: number;
+};
+export declare const ID_TAG_PREFIX: {
+    [k: string]: EncodingType;
+};

package/es/tx/builder/constants.mjs

@@ -0,0 +1,100 @@
+import BigNumber from 'bignumber.js';
+import { mapObject } from "../../utils/other.mjs"; // # AENS
+
+export const NAME_TTL = 180000; // # max number of block into the future that the name is going to be available
+// # https://github.com/aeternity/protocol/blob/epoch-v0.22.0/AENS.md#update
+// # https://github.com/aeternity/protocol/blob/44a93d3aab957ca820183c3520b9daf6b0fedff4/AENS.md#aens-entry
+
+export const NAME_MAX_TTL = 36000;
+export const NAME_MAX_CLIENT_TTL = 84600;
+export const CLIENT_TTL = NAME_MAX_CLIENT_TTL;
+export const MIN_GAS_PRICE = 1e9; // # see https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L67
+
+export const NAME_FEE_MULTIPLIER = 1e14; // 100000000000000
+
+export const NAME_FEE_BID_INCREMENT = 0.05; // # the increment is in percentage
+// # see https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L272
+
+export const NAME_BID_TIMEOUT_BLOCKS = 480; // # ~1 day
+// # this is the max length for a domain that requires a base fee to be paid
+
+export const NAME_MAX_LENGTH_FEE = 31;
+export const NAME_BID_MAX_LENGTH = 12; // # this is the max length for a domain to be part of a bid
+
+export let POINTER_KEY_BY_PREFIX; // # https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L290
+// # https://github.com/aeternity/protocol/blob/master/AENS.md#protocol-fees-and-protection-times
+// # bid ranges:
+
+(function (POINTER_KEY_BY_PREFIX) {
+  POINTER_KEY_BY_PREFIX["ak"] = "account_pubkey";
+  POINTER_KEY_BY_PREFIX["ok"] = "oracle_pubkey";
+  POINTER_KEY_BY_PREFIX["ct"] = "contract_pubkey";
+  POINTER_KEY_BY_PREFIX["ch"] = "channel";
+})(POINTER_KEY_BY_PREFIX || (POINTER_KEY_BY_PREFIX = {}));
+
+export const NAME_BID_RANGES = mapObject({
+  31: 3,
+  30: 5,
+  29: 8,
+  28: 13,
+  27: 21,
+  26: 34,
+  25: 55,
+  24: 89,
+  23: 144,
+  22: 233,
+  21: 377,
+  20: 610,
+  19: 987,
+  18: 1597,
+  17: 2584,
+  16: 4181,
+  15: 6765,
+  14: 10946,
+  13: 17711,
+  12: 28657,
+  11: 46368,
+  10: 75025,
+  9: 121393,
+  8: 196418,
+  7: 317811,
+  6: 514229,
+  5: 832040,
+  4: 1346269,
+  3: 2178309,
+  2: 3524578,
+  1: 5702887
+}, _ref => {
+  let [key, value] = _ref;
+  return [key, new BigNumber(value).times(NAME_FEE_MULTIPLIER)];
+}); // # Tag constant for ids (type uint8)
+// # see https://github.com/aeternity/protocol/blob/master/serializations.md#the-id-type
+// # <<Tag:1/unsigned-integer-unit:8, Hash:32/binary-unit:8>>
+
+const ID_TAG_ACCOUNT = 1;
+const ID_TAG_NAME = 2;
+const ID_TAG_COMMITMENT = 3;
+const ID_TAG_ORACLE = 4;
+const ID_TAG_CONTRACT = 5;
+const ID_TAG_CHANNEL = 6;
+export const ID_TAG = {
+  account: ID_TAG_ACCOUNT,
+  name: ID_TAG_NAME,
+  commitment: ID_TAG_COMMITMENT,
+  oracle: ID_TAG_ORACLE,
+  contract: ID_TAG_CONTRACT,
+  channel: ID_TAG_CHANNEL
+};
+export const PREFIX_ID_TAG = {
+  ak: ID_TAG.account,
+  nm: ID_TAG.name,
+  cm: ID_TAG.commitment,
+  ok: ID_TAG.oracle,
+  ct: ID_TAG.contract,
+  ch: ID_TAG.channel
+};
+export const ID_TAG_PREFIX = mapObject(PREFIX_ID_TAG, _ref2 => {
+  let [key, value] = _ref2;
+  return [value, key];
+});
+//# sourceMappingURL=constants.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","names":["BigNumber","mapObject","NAME_TTL","NAME_MAX_TTL","NAME_MAX_CLIENT_TTL","CLIENT_TTL","MIN_GAS_PRICE","NAME_FEE_MULTIPLIER","NAME_FEE_BID_INCREMENT","NAME_BID_TIMEOUT_BLOCKS","NAME_MAX_LENGTH_FEE","NAME_BID_MAX_LENGTH","POINTER_KEY_BY_PREFIX","NAME_BID_RANGES","key","value","times","ID_TAG_ACCOUNT","ID_TAG_NAME","ID_TAG_COMMITMENT","ID_TAG_ORACLE","ID_TAG_CONTRACT","ID_TAG_CHANNEL","ID_TAG","account","name","commitment","oracle","contract","channel","PREFIX_ID_TAG","ak","nm","cm","ok","ct","ch","ID_TAG_PREFIX"],"sources":["../../../src/tx/builder/constants.ts"],"sourcesContent":["import { EncodingType } from './../../utils/encoder'\nimport BigNumber from 'bignumber.js'\nimport { mapObject } from '../../utils/other'\n\n// # AENS\nexport type AensName = `${string}.chain`\nexport const NAME_TTL = 180000\n// # max number of block into the future that the name is going to be available\n// # https://github.com/aeternity/protocol/blob/epoch-v0.22.0/AENS.md#update\n// # https://github.com/aeternity/protocol/blob/44a93d3aab957ca820183c3520b9daf6b0fedff4/AENS.md#aens-entry\nexport const NAME_MAX_TTL = 36000\nexport const NAME_MAX_CLIENT_TTL = 84600\nexport const CLIENT_TTL = NAME_MAX_CLIENT_TTL\nexport const MIN_GAS_PRICE = 1e9\n// # see https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L67\nexport const NAME_FEE_MULTIPLIER = 1e14 // 100000000000000\nexport const NAME_FEE_BID_INCREMENT = 0.05 // # the increment is in percentage\n// # see https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L272\nexport const NAME_BID_TIMEOUT_BLOCKS = 480 // # ~1 day\n// # this is the max length for a domain that requires a base fee to be paid\nexport const NAME_MAX_LENGTH_FEE = 31\nexport const NAME_BID_MAX_LENGTH = 12 // # this is the max length for a domain to be part of a bid\nexport enum POINTER_KEY_BY_PREFIX {\n  ak = 'account_pubkey',\n  ok = 'oracle_pubkey',\n  ct = 'contract_pubkey',\n  ch = 'channel'\n}\n// # https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L290\n// # https://github.com/aeternity/protocol/blob/master/AENS.md#protocol-fees-and-protection-times\n// # bid ranges:\nexport const NAME_BID_RANGES = mapObject({\n  31: 3,\n  30: 5,\n  29: 8,\n  28: 13,\n  27: 21,\n  26: 34,\n  25: 55,\n  24: 89,\n  23: 144,\n  22: 233,\n  21: 377,\n  20: 610,\n  19: 987,\n  18: 1597,\n  17: 2584,\n  16: 4181,\n  15: 6765,\n  14: 10946,\n  13: 17711,\n  12: 28657,\n  11: 46368,\n  10: 75025,\n  9: 121393,\n  8: 196418,\n  7: 317811,\n  6: 514229,\n  5: 832040,\n  4: 1346269,\n  3: 2178309,\n  2: 3524578,\n  1: 5702887\n}, ([key, value]) => [key, new BigNumber(value).times(NAME_FEE_MULTIPLIER)])\n\n// # Tag constant for ids (type uint8)\n// # see https://github.com/aeternity/protocol/blob/master/serializations.md#the-id-type\n// # <<Tag:1/unsigned-integer-unit:8, Hash:32/binary-unit:8>>\nconst ID_TAG_ACCOUNT = 1\nconst ID_TAG_NAME = 2\nconst ID_TAG_COMMITMENT = 3\nconst ID_TAG_ORACLE = 4\nconst ID_TAG_CONTRACT = 5\nconst ID_TAG_CHANNEL = 6\n\nexport const ID_TAG = {\n  account: ID_TAG_ACCOUNT,\n  name: ID_TAG_NAME,\n  commitment: ID_TAG_COMMITMENT,\n  oracle: ID_TAG_ORACLE,\n  contract: ID_TAG_CONTRACT,\n  channel: ID_TAG_CHANNEL\n}\n\nexport const PREFIX_ID_TAG = {\n  ak: ID_TAG.account,\n  nm: ID_TAG.name,\n  cm: ID_TAG.commitment,\n  ok: ID_TAG.oracle,\n  ct: ID_TAG.contract,\n  ch: ID_TAG.channel\n} as const\n\nexport const ID_TAG_PREFIX = mapObject(\n  PREFIX_ID_TAG, ([key, value]: [EncodingType, number]) => [value, key]\n)\n"],"mappings":"AACA,OAAOA,SAAP,MAAsB,cAAtB;SACSC,S,iCAET;;AAEA,OAAO,MAAMC,QAAQ,GAAG,MAAjB,C,CACP;AACA;AACA;;AACA,OAAO,MAAMC,YAAY,GAAG,KAArB;AACP,OAAO,MAAMC,mBAAmB,GAAG,KAA5B;AACP,OAAO,MAAMC,UAAU,GAAGD,mBAAnB;AACP,OAAO,MAAME,aAAa,GAAG,GAAtB,C,CACP;;AACA,OAAO,MAAMC,mBAAmB,GAAG,IAA5B,C,CAAiC;;AACxC,OAAO,MAAMC,sBAAsB,GAAG,IAA/B,C,CAAoC;AAC3C;;AACA,OAAO,MAAMC,uBAAuB,GAAG,GAAhC,C,CAAoC;AAC3C;;AACA,OAAO,MAAMC,mBAAmB,GAAG,EAA5B;AACP,OAAO,MAAMC,mBAAmB,GAAG,EAA5B,C,CAA+B;;AACtC,WAAYC,qBAAZ,C,CAMA;AACA;AACA;;WARYA,qB;EAAAA,qB;EAAAA,qB;EAAAA,qB;EAAAA,qB;GAAAA,qB,KAAAA,qB;;AASZ,OAAO,MAAMC,eAAe,GAAGZ,SAAS,CAAC;EACvC,IAAI,CADmC;EAEvC,IAAI,CAFmC;EAGvC,IAAI,CAHmC;EAIvC,IAAI,EAJmC;EAKvC,IAAI,EALmC;EAMvC,IAAI,EANmC;EAOvC,IAAI,EAPmC;EAQvC,IAAI,EARmC;EASvC,IAAI,GATmC;EAUvC,IAAI,GAVmC;EAWvC,IAAI,GAXmC;EAYvC,IAAI,GAZmC;EAavC,IAAI,GAbmC;EAcvC,IAAI,IAdmC;EAevC,IAAI,IAfmC;EAgBvC,IAAI,IAhBmC;EAiBvC,IAAI,IAjBmC;EAkBvC,IAAI,KAlBmC;EAmBvC,IAAI,KAnBmC;EAoBvC,IAAI,KApBmC;EAqBvC,IAAI,KArBmC;EAsBvC,IAAI,KAtBmC;EAuBvC,GAAG,MAvBoC;EAwBvC,GAAG,MAxBoC;EAyBvC,GAAG,MAzBoC;EA0BvC,GAAG,MA1BoC;EA2BvC,GAAG,MA3BoC;EA4BvC,GAAG,OA5BoC;EA6BvC,GAAG,OA7BoC;EA8BvC,GAAG,OA9BoC;EA+BvC,GAAG;AA/BoC,CAAD,EAgCrC;EAAA,IAAC,CAACa,GAAD,EAAMC,KAAN,CAAD;EAAA,OAAkB,CAACD,GAAD,EAAM,IAAId,SAAJ,CAAce,KAAd,EAAqBC,KAArB,CAA2BT,mBAA3B,CAAN,CAAlB;AAAA,CAhCqC,CAAjC,C,CAkCP;AACA;AACA;;AACA,MAAMU,cAAc,GAAG,CAAvB;AACA,MAAMC,WAAW,GAAG,CAApB;AACA,MAAMC,iBAAiB,GAAG,CAA1B;AACA,MAAMC,aAAa,GAAG,CAAtB;AACA,MAAMC,eAAe,GAAG,CAAxB;AACA,MAAMC,cAAc,GAAG,CAAvB;AAEA,OAAO,MAAMC,MAAM,GAAG;EACpBC,OAAO,EAAEP,cADW;EAEpBQ,IAAI,EAAEP,WAFc;EAGpBQ,UAAU,EAAEP,iBAHQ;EAIpBQ,MAAM,EAAEP,aAJY;EAKpBQ,QAAQ,EAAEP,eALU;EAMpBQ,OAAO,EAAEP;AANW,CAAf;AASP,OAAO,MAAMQ,aAAa,GAAG;EAC3BC,EAAE,EAAER,MAAM,CAACC,OADgB;EAE3BQ,EAAE,EAAET,MAAM,CAACE,IAFgB;EAG3BQ,EAAE,EAAEV,MAAM,CAACG,UAHgB;EAI3BQ,EAAE,EAAEX,MAAM,CAACI,MAJgB;EAK3BQ,EAAE,EAAEZ,MAAM,CAACK,QALgB;EAM3BQ,EAAE,EAAEb,MAAM,CAACM;AANgB,CAAtB;AASP,OAAO,MAAMQ,aAAa,GAAGpC,SAAS,CACpC6B,aADoC,EACrB;EAAA,IAAC,CAAChB,GAAD,EAAMC,KAAN,CAAD;EAAA,OAA0C,CAACA,KAAD,EAAQD,GAAR,CAA1C;AAAA,CADqB,CAA/B"}

package/es/tx/builder/field-types.d.ts

@@ -0,0 +1,62 @@
+/// <reference types="node" />
+import BigNumber from 'bignumber.js';
+import { AensName } from './constants';
+import { EncodedData } from '../../utils/encoder';
+declare type Int = number | string | BigNumber;
+export declare class Field {
+    prototype: any;
+    static serialize(value: any, _txFields?: object): Buffer;
+    static deserialize(value: Buffer): any;
+}
+export declare class Name extends Field {
+    /**
+     * @param value - AENS name
+     */
+    static serialize(value: AensName): Buffer;
+    /**
+     * @param value - AENS name
+     */
+    static deserialize(value: Buffer): string;
+}
+export declare class NameId extends Field {
+    /**
+     * @param value - AENS name ID
+     */
+    static serialize(value: AensName | EncodedData<'nm'>): Buffer;
+    /**
+     * @param value - AENS name ID Buffer
+     */
+    static deserialize(value: Buffer): string;
+}
+export declare class NameFee extends Field {
+    /**
+     * @param value - AENS name fee Buffer
+     * @param txFields - Transaction fields
+     * @param txFields.name - AENS Name in transaction
+     */
+    static serialize(value: Int | undefined, { name }: {
+        name: AensName;
+    }): Buffer;
+    /**
+     * @param value - AENS name fee Buffer
+     * @returns AENS name fee
+     */
+    static deserialize(value: Buffer): string;
+}
+export declare class Deposit extends Field {
+    /**
+     * @param value - Deposit value in string format. Should be equal to  '0'.
+     * @returns Deposit value Buffer.
+     */
+    static serialize(value?: string): Buffer;
+    /**
+     * @param value - Deposit value Buffer.
+     * @returns Deposit value.
+     */
+    static deserialize(value: Buffer): string;
+}
+export declare class GasPrice extends Field {
+    static serialize(value?: Int): Buffer;
+    static deserialize(value: Buffer): string;
+}
+export {};

package/es/tx/builder/field-types.mjs

@@ -0,0 +1,126 @@
+import _buffer from "buffer";
+const {
+  Buffer: _Buffer
+} = _buffer;
+import { writeId, readId, produceNameId, getMinimumNameFee, readInt, writeInt, isNameValid } from "./helpers.mjs";
+import { InsufficientNameFeeError, IllegalArgumentError } from "../../utils/errors.mjs";
+import BigNumber from 'bignumber.js';
+import { MIN_GAS_PRICE } from "./constants.mjs";
+// todo: update me
+// ? This is a TS workaround because this has to be a class with only static methods
+export class Field {
+  static serialize(value) {
+    let _txFields = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+
+    return _Buffer.from(value);
+  }
+
+  static deserialize(value) {
+    return value.toString();
+  }
+
+}
+export class Name extends Field {
+  /**
+   * @param value - AENS name
+   */
+  static serialize(value) {
+    return _Buffer.from(value);
+  }
+  /**
+   * @param value - AENS name
+   */
+
+
+  static deserialize(value) {
+    return value.toString();
+  }
+
+}
+export class NameId extends Field {
+  /**
+   * @param value - AENS name ID
+   */
+  static serialize(value) {
+    return writeId(isNameValid(value) ? produceNameId(value) : value);
+  }
+  /**
+   * @param value - AENS name ID Buffer
+   */
+
+
+  static deserialize(value) {
+    return readId(value);
+  }
+
+}
+export class NameFee extends Field {
+  /**
+   * @param value - AENS name fee Buffer
+   * @param txFields - Transaction fields
+   * @param txFields.name - AENS Name in transaction
+   */
+  static serialize(value, _ref) {
+    var _value;
+
+    let {
+      name
+    } = _ref;
+    const minNameFee = getMinimumNameFee(name);
+    (_value = value) !== null && _value !== void 0 ? _value : value = minNameFee;
+
+    if (minNameFee.gt(value)) {
+      throw new InsufficientNameFeeError(new BigNumber(value), minNameFee);
+    }
+
+    return writeInt(value);
+  }
+  /**
+   * @param value - AENS name fee Buffer
+   * @returns AENS name fee
+   */
+
+
+  static deserialize(value) {
+    return readInt(value);
+  }
+
+}
+export class Deposit extends Field {
+  /**
+   * @param value - Deposit value in string format. Should be equal to  '0'.
+   * @returns Deposit value Buffer.
+   */
+  static serialize() {
+    let value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '0';
+    if (parseInt(value) !== 0) throw new IllegalArgumentError(`Contract deposit is not refundable, so it should be equal 0, got ${value.toString()} instead`);
+    return writeInt(0);
+  }
+  /**
+   * @param value - Deposit value Buffer.
+   * @returns Deposit value.
+   */
+
+
+  static deserialize(value) {
+    return readInt(value);
+  }
+
+}
+export class GasPrice extends Field {
+  static serialize() {
+    let value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : MIN_GAS_PRICE;
+
+    if (+value < MIN_GAS_PRICE) {
+      throw new IllegalArgumentError(`Gas price ${value.toString()} must be bigger then ${MIN_GAS_PRICE}`);
+    }
+
+    return writeInt(value);
+  }
+
+  static deserialize(value) {
+    return readInt(value);
+  }
+
+}
+//# sourceMappingURL=field-types.mjs.map

package/es/tx/builder/field-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-types.mjs","names":["writeId","readId","produceNameId","getMinimumNameFee","readInt","writeInt","isNameValid","InsufficientNameFeeError","IllegalArgumentError","BigNumber","MIN_GAS_PRICE","Field","serialize","value","_txFields","from","deserialize","toString","Name","NameId","NameFee","name","minNameFee","gt","Deposit","parseInt","GasPrice"],"sources":["../../../src/tx/builder/field-types.ts"],"sourcesContent":["import {\n  writeId, readId, produceNameId, getMinimumNameFee, readInt, writeInt, isNameValid\n} from './helpers'\nimport { InsufficientNameFeeError, IllegalArgumentError } from '../../utils/errors'\nimport BigNumber from 'bignumber.js'\nimport { MIN_GAS_PRICE, AensName } from './constants'\nimport { EncodedData } from '../../utils/encoder'\n\ntype Int = number | string | BigNumber\n\n// todo: update me\n// ? This is a TS workaround because this has to be a class with only static methods\nexport class Field {\n  public prototype: any\n\n  static serialize (value: any, _txFields: object = {}): Buffer {\n    return Buffer.from(value)\n  }\n\n  static deserialize (value: Buffer): any {\n    return value.toString()\n  }\n}\n\nexport class Name extends Field {\n  /**\n   * @param value - AENS name\n   */\n  static serialize (value: AensName): Buffer {\n    return Buffer.from(value)\n  }\n\n  /**\n   * @param value - AENS name\n   */\n  static deserialize (value: Buffer): string {\n    return value.toString()\n  }\n}\n\nexport class NameId extends Field {\n  /**\n   * @param value - AENS name ID\n   */\n  static serialize (value: AensName | EncodedData<'nm'>): Buffer {\n    return writeId(isNameValid(value) ? produceNameId(value) : value)\n  }\n\n  /**\n   * @param value - AENS name ID Buffer\n   */\n  static deserialize (value: Buffer): string {\n    return readId(value)\n  }\n}\n\nexport class NameFee extends Field {\n  /**\n   * @param value - AENS name fee Buffer\n   * @param txFields - Transaction fields\n   * @param txFields.name - AENS Name in transaction\n   */\n  static serialize (value: Int | undefined, { name }: { name: AensName }): Buffer {\n    const minNameFee = getMinimumNameFee(name)\n    value ??= minNameFee\n    if (minNameFee.gt(value)) {\n      throw new InsufficientNameFeeError(new BigNumber(value), minNameFee)\n    }\n    return writeInt(value)\n  }\n\n  /**\n   * @param value - AENS name fee Buffer\n   * @returns AENS name fee\n   */\n  static deserialize (value: Buffer): string {\n    return readInt(value)\n  }\n}\n\nexport class Deposit extends Field {\n  /**\n   * @param value - Deposit value in string format. Should be equal to  '0'.\n   * @returns Deposit value Buffer.\n   */\n  static serialize (value: string = '0'): Buffer {\n    if (parseInt(value) !== 0) throw new IllegalArgumentError(`Contract deposit is not refundable, so it should be equal 0, got ${value.toString()} instead`)\n    return writeInt(0)\n  }\n\n  /**\n   * @param value - Deposit value Buffer.\n   * @returns Deposit value.\n   */\n  static deserialize (value: Buffer): string {\n    return readInt(value)\n  }\n}\n\nexport class GasPrice extends Field {\n  static serialize (value: Int = MIN_GAS_PRICE): Buffer {\n    if (+value < MIN_GAS_PRICE) {\n      throw new IllegalArgumentError(`Gas price ${value.toString()} must be bigger then ${MIN_GAS_PRICE}`)\n    }\n    return writeInt(value)\n  }\n\n  static deserialize (value: Buffer): string {\n    return readInt(value)\n  }\n}\n"],"mappings":";;;;SACEA,O,EAASC,M,EAAQC,a,EAAeC,iB,EAAmBC,O,EAASC,Q,EAAUC,W;SAE/DC,wB,EAA0BC,oB;AACnC,OAAOC,SAAP,MAAsB,cAAtB;SACSC,a;AAKT;AACA;AACA,OAAO,MAAMC,KAAN,CAAY;EAGD,OAATC,SAAS,CAAEC,KAAF,EAA8C;IAAA,IAAhCC,SAAgC,uEAAZ,EAAY;;IAC5D,OAAO,QAAOC,IAAP,CAAYF,KAAZ,CAAP;EACD;;EAEiB,OAAXG,WAAW,CAAEH,KAAF,EAAsB;IACtC,OAAOA,KAAK,CAACI,QAAN,EAAP;EACD;;AATgB;AAYnB,OAAO,MAAMC,IAAN,SAAmBP,KAAnB,CAAyB;EAC9B;AACF;AACA;EACkB,OAATC,SAAS,CAAEC,KAAF,EAA2B;IACzC,OAAO,QAAOE,IAAP,CAAYF,KAAZ,CAAP;EACD;EAED;AACF;AACA;;;EACoB,OAAXG,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOA,KAAK,CAACI,QAAN,EAAP;EACD;;AAb6B;AAgBhC,OAAO,MAAME,MAAN,SAAqBR,KAArB,CAA2B;EAChC;AACF;AACA;EACkB,OAATC,SAAS,CAAEC,KAAF,EAA+C;IAC7D,OAAOb,OAAO,CAACM,WAAW,CAACO,KAAD,CAAX,GAAqBX,aAAa,CAACW,KAAD,CAAlC,GAA4CA,KAA7C,CAAd;EACD;EAED;AACF;AACA;;;EACoB,OAAXG,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOZ,MAAM,CAACY,KAAD,CAAb;EACD;;AAb+B;AAgBlC,OAAO,MAAMO,OAAN,SAAsBT,KAAtB,CAA4B;EACjC;AACF;AACA;AACA;AACA;EACkB,OAATC,SAAS,CAAEC,KAAF,QAAgE;IAAA;;IAAA,IAAtC;MAAEQ;IAAF,CAAsC;IAC9E,MAAMC,UAAU,GAAGnB,iBAAiB,CAACkB,IAAD,CAApC;IACA,UAAAR,KAAK,UAAL,iCAAAA,KAAK,GAAKS,UAAV;;IACA,IAAIA,UAAU,CAACC,EAAX,CAAcV,KAAd,CAAJ,EAA0B;MACxB,MAAM,IAAIN,wBAAJ,CAA6B,IAAIE,SAAJ,CAAcI,KAAd,CAA7B,EAAmDS,UAAnD,CAAN;IACD;;IACD,OAAOjB,QAAQ,CAACQ,KAAD,CAAf;EACD;EAED;AACF;AACA;AACA;;;EACoB,OAAXG,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOT,OAAO,CAACS,KAAD,CAAd;EACD;;AArBgC;AAwBnC,OAAO,MAAMW,OAAN,SAAsBb,KAAtB,CAA4B;EACjC;AACF;AACA;AACA;EACkB,OAATC,SAAS,GAA+B;IAAA,IAA7BC,KAA6B,uEAAb,GAAa;IAC7C,IAAIY,QAAQ,CAACZ,KAAD,CAAR,KAAoB,CAAxB,EAA2B,MAAM,IAAIL,oBAAJ,CAA0B,oEAAmEK,KAAK,CAACI,QAAN,EAAiB,UAA9G,CAAN;IAC3B,OAAOZ,QAAQ,CAAC,CAAD,CAAf;EACD;EAED;AACF;AACA;AACA;;;EACoB,OAAXW,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOT,OAAO,CAACS,KAAD,CAAd;EACD;;AAhBgC;AAmBnC,OAAO,MAAMa,QAAN,SAAuBf,KAAvB,CAA6B;EAClB,OAATC,SAAS,GAAsC;IAAA,IAApCC,KAAoC,uEAAvBH,aAAuB;;IACpD,IAAI,CAACG,KAAD,GAASH,aAAb,EAA4B;MAC1B,MAAM,IAAIF,oBAAJ,CAA0B,aAAYK,KAAK,CAACI,QAAN,EAAiB,wBAAuBP,aAAc,EAA5F,CAAN;IACD;;IACD,OAAOL,QAAQ,CAACQ,KAAD,CAAf;EACD;;EAEiB,OAAXG,WAAW,CAAEH,KAAF,EAAyB;IACzC,OAAOT,OAAO,CAACS,KAAD,CAAd;EACD;;AAViC"}

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

@@ -0,0 +1,131 @@
+/// <reference types="node" />
+import BigNumber from 'bignumber.js';
+import { salt } from '../../utils/crypto';
+import { encode, decode, EncodedData } from '../../utils/encoder';
+import { POINTER_KEY_BY_PREFIX, AensName } from './constants';
+/**
+ * JavaScript-based Transaction builder helper function's
+ */
+export declare const createSalt: typeof salt;
+export { encode, decode };
+export interface Pointer {
+    key: string;
+    id: string;
+}
+/**
+ * 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 declare function buildContractId(ownerId: EncodedData<'ak'>, nonce: number | BigNumber): EncodedData<'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 declare function oracleQueryId(senderId: EncodedData<'ak'>, nonce: number | BigNumber | string, oracleId: EncodedData<'ok'>): EncodedData<'oq'>;
+/**
+ * Format the salt into a 64-byte hex string
+ * @param salt - Random number
+ * @returns Zero-padded hex string of salt
+ */
+export declare function formatSalt(salt: number): Buffer;
+/**
+ * Encode an AENS name
+ *
+ * @param name - Name to encode
+ * @returns `nm_` prefixed encoded AENS name
+ */
+export declare function produceNameId(name: AensName): EncodedData<'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 declare function commitmentHash(name: AensName, salt?: number): EncodedData<'cm'>;
+/**
+ * Utility function to create and _id type
+ * @param hashId - Encoded hash
+ * @returns Buffer Buffer with ID tag and decoded HASh
+ */
+export declare function writeId(hashId: string): Buffer;
+/**
+ * Utility function to read and _id type
+ * @param buf - Data
+ * @returns Encoided hash string with prefix
+ */
+export declare function readId(buf: Buffer): string;
+/**
+ * Utility function to convert int to bytes
+ * @param val - Value
+ * @returns Buffer Buffer from number(BigEndian)
+ */
+export declare function writeInt(val: number | string | BigNumber): Buffer;
+/**
+ * Utility function to convert bytes to int
+ * @param buf - Value
+ * @returns Buffer Buffer from number(BigEndian)
+ */
+export declare function readInt(buf?: Buffer): string;
+/**
+ * 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 declare function buildPointers(pointers: Pointer[]): Buffer[][];
+/**
+ * Helper function to read pointers from name update TX
+ * @param pointers - Array of pointers
+ * @returns Deserialize pointer array
+ */
+export declare function readPointers(pointers: Array<[key: string, id: Buffer]>): Pointer[];
+/**
+ * Is AENS name valid
+ * @param name - AENS name
+ */
+export declare function isNameValid(name: string): name is AensName;
+/**
+ * @param identifier - account/oracle/contract address, or channel
+ * @returns default AENS pointer key
+ */
+export declare function getDefaultPointerKey(identifier: EncodedData<keyof typeof POINTER_KEY_BY_PREFIX>): POINTER_KEY_BY_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 declare function getMinimumNameFee(name: AensName): BigNumber;
+/**
+ * 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 declare function computeBidFee(name: AensName, { startFee, increment }?: {
+    startFee?: number | string | BigNumber;
+    increment?: number;
+}): BigNumber;
+/**
+ * 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 declare function computeAuctionEndBlock(name: AensName, claimHeight: number): number;
+/**
+ * Is name accept going to auction
+ */
+export declare function isAuctionName(name: AensName): boolean;