@aeternity/aepp-sdk 13.3.3 → 14.0.0

package/es/oracle/OracleBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OracleBase.js","names":["decode","decodeQuery","queryEntry","id","decodedQuery","query","toString","decodedResponse","response","OracleBase","constructor","address","options","getState","opt","onNode","getOracleByPubkey","getQuery","queryId","getOracleQueryByPubkeyAndQueryId"],"sources":["../../src/oracle/OracleBase.ts"],"sourcesContent":["import { decode, Encoded } from '../utils/encoder.js';\nimport Node from '../Node.js';\n\ntype OracleQueryNode = Awaited<\n  ReturnType<Node['getOracleQueriesByPubkey']>\n>['oracleQueries'][number];\nexport interface OracleQuery extends OracleQueryNode {\n  // TODO: type should be corrected in node api\n  id: Encoded.OracleQueryId;\n  decodedQuery: string;\n  decodedResponse: string;\n}\n\nexport function decodeQuery(queryEntry: OracleQueryNode): OracleQuery {\n  return {\n    ...queryEntry,\n    id: queryEntry.id as Encoded.OracleQueryId,\n    decodedQuery: decode(queryEntry.query as Encoded.OracleQuery).toString(),\n    decodedResponse: decode(queryEntry.response as Encoded.OracleResponse).toString(),\n  };\n}\n\n/**\n * This class is needed because `getOracleQuery` would return different values depending on the\n * oracle type.\n */\nexport default class OracleBase {\n  /**\n   * @param address - Oracle public key\n   */\n  constructor(\n    public readonly address: Encoded.OracleAddress,\n    public options: { onNode: Node },\n  ) {}\n\n  /**\n   * Get oracle entry from the node\n   * @param options - Options object\n   */\n  async getState(options: { onNode?: Node } = {}): ReturnType<Node['getOracleByPubkey']> {\n    const opt = { ...this.options, ...options };\n    return opt.onNode.getOracleByPubkey(this.address);\n  }\n\n  /**\n   * Get oracle query entry from the node\n   * @param queryId - Oracle query ID\n   * @param options - Options object\n   */\n  async getQuery(\n    queryId: Encoded.OracleQueryId,\n    options: { onNode?: Node } = {},\n  ): Promise<OracleQuery> {\n    const { onNode } = { ...this.options, ...options };\n    const queryEntry = await onNode.getOracleQueryByPubkeyAndQueryId(this.address, queryId);\n    return decodeQuery(queryEntry);\n  }\n}\n"],"mappings":"AAAA,SAASA,MAAM,QAAiB,qBAAqB;AAarD,OAAO,SAASC,WAAWA,CAACC,UAA2B,EAAe;EACpE,OAAO;IACL,GAAGA,UAAU;IACbC,EAAE,EAAED,UAAU,CAACC,EAA2B;IAC1CC,YAAY,EAAEJ,MAAM,CAACE,UAAU,CAACG,KAA4B,CAAC,CAACC,QAAQ,CAAC,CAAC;IACxEC,eAAe,EAAEP,MAAM,CAACE,UAAU,CAACM,QAAkC,CAAC,CAACF,QAAQ,CAAC;EAClF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,eAAe,MAAMG,UAAU,CAAC;EAC9B;AACF;AACA;EACEC,WAAWA,CACOC,OAA8B,EACvCC,OAAyB,EAChC;IAAA,KAFgBD,OAA8B,GAA9BA,OAA8B;IAAA,KACvCC,OAAyB,GAAzBA,OAAyB;EAC/B;;EAEH;AACF;AACA;AACA;EACE,MAAMC,QAAQA,CAACD,OAA0B,GAAG,CAAC,CAAC,EAAyC;IACrF,MAAME,GAAG,GAAG;MAAE,GAAG,IAAI,CAACF,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAC3C,OAAOE,GAAG,CAACC,MAAM,CAACC,iBAAiB,CAAC,IAAI,CAACL,OAAO,CAAC;EACnD;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMM,QAAQA,CACZC,OAA8B,EAC9BN,OAA0B,GAAG,CAAC,CAAC,EACT;IACtB,MAAM;MAAEG;IAAO,CAAC,GAAG;MAAE,GAAG,IAAI,CAACH,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAClD,MAAMV,UAAU,GAAG,MAAMa,MAAM,CAACI,gCAAgC,CAAC,IAAI,CAACR,OAAO,EAAEO,OAAO,CAAC;IACvF,OAAOjB,WAAW,CAACC,UAAU,CAAC;EAChC;AACF","ignoreList":[]}

package/es/oracle/OracleClient.d.ts

@@ -0,0 +1,57 @@
+import { Optional } from '../utils/other.js';
+import { BuildTxOptions } from '../tx/builder/index.js';
+import { Tag } from '../tx/builder/constants.js';
+import { Encoded } from '../utils/encoder.js';
+import { _getPollInterval } from '../chain.js';
+import { sendTransaction } from '../send-transaction.js';
+import Node from '../Node.js';
+import AccountBase from '../account/Base.js';
+import OracleBase from './OracleBase.js';
+interface OracleClientPostQueryOptions extends Optional<Parameters<typeof sendTransaction>[1], 'onNode' | 'onAccount'>, BuildTxOptions<Tag.OracleQueryTx, 'oracleId' | 'senderId' | 'query'> {
+}
+/**
+ * @category oracle
+ */
+export default class OracleClient extends OracleBase {
+    options: {
+        onAccount: AccountBase;
+        onNode: Node;
+    } & Parameters<OracleClient['query']>[1];
+    /**
+     * @param address - Oracle public key
+     * @param options - Options object
+     * @param options.onAccount - Account to use
+     * @param options.onNode - Node to use
+     */
+    constructor(address: Encoded.OracleAddress, options: {
+        onAccount: AccountBase;
+        onNode: Node;
+    } & Parameters<OracleClient['query']>[1]);
+    /**
+     * Post query to oracle
+     * @param query - Query to oracle
+     * @param options - Options object
+     * @returns Transaction details and query ID
+     */
+    postQuery(query: string, options?: OracleClientPostQueryOptions): Promise<Awaited<ReturnType<typeof sendTransaction>> & {
+        queryId: Encoded.OracleQueryId;
+    }>;
+    /**
+     * Poll for oracle response to query
+     * @param queryId - Oracle Query id
+     * @param options - Options object
+     * @param options.interval - Poll interval
+     * @returns Oracle response
+     */
+    pollForResponse(queryId: Encoded.OracleQueryId, options?: {
+        interval?: number;
+    } & Partial<Parameters<typeof _getPollInterval>[1]>): Promise<string>;
+    /**
+     * Post query to oracle and wait for response
+     * @param query - Query to oracle
+     * @param options - Options object
+     * @returns Oracle response
+     */
+    query(query: string, options?: OracleClientPostQueryOptions & Parameters<OracleClient['pollForResponse']>[1]): Promise<string>;
+}
+export {};

package/es/oracle/OracleClient.js

@@ -0,0 +1,100 @@
+import { pause } from '../utils/other.js';
+import { oracleQueryId } from '../tx/builder/helpers.js';
+import { unpackTx, buildTxAsync } from '../tx/builder/index.js';
+import { Tag } from '../tx/builder/constants.js';
+import { RequestTimedOutError } from '../utils/errors.js';
+import { decode } from '../utils/encoder.js';
+import { _getPollInterval, getHeight } from '../chain.js';
+import { sendTransaction } from '../send-transaction.js';
+import OracleBase from './OracleBase.js';
+/**
+ * @category oracle
+ */
+export default class OracleClient extends OracleBase {
+  /**
+   * @param address - Oracle public key
+   * @param options - Options object
+   * @param options.onAccount - Account to use
+   * @param options.onNode - Node to use
+   */
+  constructor(address, options) {
+    super(address, options);
+    this.options = options;
+  }
+
+  /**
+   * Post query to oracle
+   * @param query - Query to oracle
+   * @param options - Options object
+   * @returns Transaction details and query ID
+   */
+  async postQuery(query, options = {}) {
+    const opt = {
+      ...this.options,
+      ...options
+    };
+    const senderId = opt.onAccount.address;
+    const oracleQueryTx = await buildTxAsync({
+      _isInternalBuild: true,
+      ...opt,
+      tag: Tag.OracleQueryTx,
+      oracleId: this.address,
+      senderId,
+      query
+    });
+    const {
+      nonce
+    } = unpackTx(oracleQueryTx, Tag.OracleQueryTx);
+    return {
+      ...(await sendTransaction(oracleQueryTx, opt)),
+      queryId: oracleQueryId(senderId, nonce, this.address)
+    };
+  }
+
+  /**
+   * Poll for oracle response to query
+   * @param queryId - Oracle Query id
+   * @param options - Options object
+   * @param options.interval - Poll interval
+   * @returns Oracle response
+   */
+  async pollForResponse(queryId, options = {}) {
+    var _opt$interval;
+    const opt = {
+      ...this.options,
+      ...options
+    };
+    const interval = (_opt$interval = opt.interval) !== null && _opt$interval !== void 0 ? _opt$interval : await _getPollInterval('micro-block', opt);
+    let height;
+    let ttl;
+    let response;
+    do {
+      ({
+        response,
+        ttl
+      } = await opt.onNode.getOracleQueryByPubkeyAndQueryId(this.address, queryId));
+      const responseBuffer = decode(response);
+      if (responseBuffer.length > 0) return responseBuffer.toString();
+      await pause(interval);
+      height = await getHeight({
+        ...opt,
+        cached: true
+      });
+    } while (ttl >= height);
+    throw new RequestTimedOutError(height);
+  }
+
+  /**
+   * Post query to oracle and wait for response
+   * @param query - Query to oracle
+   * @param options - Options object
+   * @returns Oracle response
+   */
+  async query(query, options = {}) {
+    const {
+      queryId
+    } = await this.postQuery(query, options);
+    return this.pollForResponse(queryId, options);
+  }
+}
+//# sourceMappingURL=OracleClient.js.map

package/es/oracle/OracleClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OracleClient.js","names":["pause","oracleQueryId","unpackTx","buildTxAsync","Tag","RequestTimedOutError","decode","_getPollInterval","getHeight","sendTransaction","OracleBase","OracleClient","constructor","address","options","postQuery","query","opt","senderId","onAccount","oracleQueryTx","_isInternalBuild","tag","OracleQueryTx","oracleId","nonce","queryId","pollForResponse","_opt$interval","interval","height","ttl","response","onNode","getOracleQueryByPubkeyAndQueryId","responseBuffer","length","toString","cached"],"sources":["../../src/oracle/OracleClient.ts"],"sourcesContent":["import { pause, Optional } from '../utils/other.js';\nimport { oracleQueryId } from '../tx/builder/helpers.js';\nimport { unpackTx, buildTxAsync, BuildTxOptions } from '../tx/builder/index.js';\nimport { Tag } from '../tx/builder/constants.js';\nimport { RequestTimedOutError } from '../utils/errors.js';\nimport { decode, Encoded } from '../utils/encoder.js';\nimport { _getPollInterval, getHeight } from '../chain.js';\nimport { sendTransaction } from '../send-transaction.js';\nimport Node from '../Node.js';\nimport AccountBase from '../account/Base.js';\nimport OracleBase from './OracleBase.js';\n\ninterface OracleClientPostQueryOptions\n  extends Optional<Parameters<typeof sendTransaction>[1], 'onNode' | 'onAccount'>,\n    BuildTxOptions<Tag.OracleQueryTx, 'oracleId' | 'senderId' | 'query'> {}\n\n/**\n * @category oracle\n */\nexport default class OracleClient extends OracleBase {\n  /**\n   * @param address - Oracle public key\n   * @param options - Options object\n   * @param options.onAccount - Account to use\n   * @param options.onNode - Node to use\n   */\n  constructor(\n    address: Encoded.OracleAddress,\n    public override options: { onAccount: AccountBase; onNode: Node } & Parameters<\n      OracleClient['query']\n    >[1],\n  ) {\n    super(address, options);\n  }\n\n  /**\n   * Post query to oracle\n   * @param query - Query to oracle\n   * @param options - Options object\n   * @returns Transaction details and query ID\n   */\n  async postQuery(\n    query: string,\n    options: OracleClientPostQueryOptions = {},\n  ): Promise<Awaited<ReturnType<typeof sendTransaction>> & { queryId: Encoded.OracleQueryId }> {\n    const opt = { ...this.options, ...options };\n    const senderId = opt.onAccount.address;\n\n    const oracleQueryTx = await buildTxAsync({\n      _isInternalBuild: true,\n      ...opt,\n      tag: Tag.OracleQueryTx,\n      oracleId: this.address,\n      senderId,\n      query,\n    });\n    const { nonce } = unpackTx(oracleQueryTx, Tag.OracleQueryTx);\n    return {\n      ...(await sendTransaction(oracleQueryTx, opt)),\n      queryId: oracleQueryId(senderId, nonce, this.address),\n    };\n  }\n\n  /**\n   * Poll for oracle response to query\n   * @param queryId - Oracle Query id\n   * @param options - Options object\n   * @param options.interval - Poll interval\n   * @returns Oracle response\n   */\n  async pollForResponse(\n    queryId: Encoded.OracleQueryId,\n    options: { interval?: number } & Partial<Parameters<typeof _getPollInterval>[1]> = {},\n  ): Promise<string> {\n    const opt = { ...this.options, ...options };\n    const interval = opt.interval ?? (await _getPollInterval('micro-block', opt));\n    let height;\n    let ttl;\n    let response;\n    do {\n      ({ response, ttl } = await opt.onNode.getOracleQueryByPubkeyAndQueryId(\n        this.address,\n        queryId,\n      ));\n      const responseBuffer = decode(response as Encoded.OracleResponse);\n      if (responseBuffer.length > 0) return responseBuffer.toString();\n      await pause(interval);\n      height = await getHeight({ ...opt, cached: true });\n    } while (ttl >= height);\n    throw new RequestTimedOutError(height);\n  }\n\n  /**\n   * Post query to oracle and wait for response\n   * @param query - Query to oracle\n   * @param options - Options object\n   * @returns Oracle response\n   */\n  async query(\n    query: string,\n    options: OracleClientPostQueryOptions & Parameters<OracleClient['pollForResponse']>[1] = {},\n  ): Promise<string> {\n    const { queryId } = await this.postQuery(query, options);\n    return this.pollForResponse(queryId, options);\n  }\n}\n"],"mappings":"AAAA,SAASA,KAAK,QAAkB,mBAAmB;AACnD,SAASC,aAAa,QAAQ,0BAA0B;AACxD,SAASC,QAAQ,EAAEC,YAAY,QAAwB,wBAAwB;AAC/E,SAASC,GAAG,QAAQ,4BAA4B;AAChD,SAASC,oBAAoB,QAAQ,oBAAoB;AACzD,SAASC,MAAM,QAAiB,qBAAqB;AACrD,SAASC,gBAAgB,EAAEC,SAAS,QAAQ,aAAa;AACzD,SAASC,eAAe,QAAQ,wBAAwB;AAGxD,OAAOC,UAAU,MAAM,iBAAiB;AAMxC;AACA;AACA;AACA,eAAe,MAAMC,YAAY,SAASD,UAAU,CAAC;EACnD;AACF;AACA;AACA;AACA;AACA;EACEE,WAAWA,CACTC,OAA8B,EACdC,OAEZ,EACJ;IACA,KAAK,CAACD,OAAO,EAAEC,OAAO,CAAC;IAAC,KAJRA,OAEZ,GAFYA,OAEZ;EAGN;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMC,SAASA,CACbC,KAAa,EACbF,OAAqC,GAAG,CAAC,CAAC,EACiD;IAC3F,MAAMG,GAAG,GAAG;MAAE,GAAG,IAAI,CAACH,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAC3C,MAAMI,QAAQ,GAAGD,GAAG,CAACE,SAAS,CAACN,OAAO;IAEtC,MAAMO,aAAa,GAAG,MAAMjB,YAAY,CAAC;MACvCkB,gBAAgB,EAAE,IAAI;MACtB,GAAGJ,GAAG;MACNK,GAAG,EAAElB,GAAG,CAACmB,aAAa;MACtBC,QAAQ,EAAE,IAAI,CAACX,OAAO;MACtBK,QAAQ;MACRF;IACF,CAAC,CAAC;IACF,MAAM;MAAES;IAAM,CAAC,GAAGvB,QAAQ,CAACkB,aAAa,EAAEhB,GAAG,CAACmB,aAAa,CAAC;IAC5D,OAAO;MACL,IAAI,MAAMd,eAAe,CAACW,aAAa,EAAEH,GAAG,CAAC,CAAC;MAC9CS,OAAO,EAAEzB,aAAa,CAACiB,QAAQ,EAAEO,KAAK,EAAE,IAAI,CAACZ,OAAO;IACtD,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAMc,eAAeA,CACnBD,OAA8B,EAC9BZ,OAAgF,GAAG,CAAC,CAAC,EACpE;IAAA,IAAAc,aAAA;IACjB,MAAMX,GAAG,GAAG;MAAE,GAAG,IAAI,CAACH,OAAO;MAAE,GAAGA;IAAQ,CAAC;IAC3C,MAAMe,QAAQ,IAAAD,aAAA,GAAGX,GAAG,CAACY,QAAQ,cAAAD,aAAA,cAAAA,aAAA,GAAK,MAAMrB,gBAAgB,CAAC,aAAa,EAAEU,GAAG,CAAE;IAC7E,IAAIa,MAAM;IACV,IAAIC,GAAG;IACP,IAAIC,QAAQ;IACZ,GAAG;MACD,CAAC;QAAEA,QAAQ;QAAED;MAAI,CAAC,GAAG,MAAMd,GAAG,CAACgB,MAAM,CAACC,gCAAgC,CACpE,IAAI,CAACrB,OAAO,EACZa,OACF,CAAC;MACD,MAAMS,cAAc,GAAG7B,MAAM,CAAC0B,QAAkC,CAAC;MACjE,IAAIG,cAAc,CAACC,MAAM,GAAG,CAAC,EAAE,OAAOD,cAAc,CAACE,QAAQ,CAAC,CAAC;MAC/D,MAAMrC,KAAK,CAAC6B,QAAQ,CAAC;MACrBC,MAAM,GAAG,MAAMtB,SAAS,CAAC;QAAE,GAAGS,GAAG;QAAEqB,MAAM,EAAE;MAAK,CAAC,CAAC;IACpD,CAAC,QAAQP,GAAG,IAAID,MAAM;IACtB,MAAM,IAAIzB,oBAAoB,CAACyB,MAAM,CAAC;EACxC;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMd,KAAKA,CACTA,KAAa,EACbF,OAAsF,GAAG,CAAC,CAAC,EAC1E;IACjB,MAAM;MAAEY;IAAQ,CAAC,GAAG,MAAM,IAAI,CAACX,SAAS,CAACC,KAAK,EAAEF,OAAO,CAAC;IACxD,OAAO,IAAI,CAACa,eAAe,CAACD,OAAO,EAAEZ,OAAO,CAAC;EAC/C;AACF","ignoreList":[]}

package/es/send-transaction.d.ts

@@ -1,10 +1,10 @@
-import { ValidatorResult } from './tx/validator';
-import { TransactionError } from './utils/errors';
-import Node, { TransformNodeType } from './Node';
-import { SignedTx } from './apis/node';
-import { Encoded } from './utils/encoder';
-import AccountBase from './account/Base';
-import { poll, waitForTxConfirm } from './chain';
+import { ValidatorResult } from './tx/validator.js';
+import { TransactionError } from './utils/errors.js';
+import Node from './Node.js';
+import { SignedTx } from './apis/node/index.js';
+import { Encoded } from './utils/encoder.js';
+import AccountBase from './account/Base.js';
+import { poll, waitForTxConfirm } from './chain.js';
 /**
  * @category exception
  */
@@ -45,7 +45,7 @@ type SendTransactionOptionsType = {
 } & Parameters<typeof poll>[1] & Omit<Parameters<typeof waitForTxConfirm>[1], 'confirm'> & Parameters<AccountBase['signTransaction']>[1];
 export interface SendTransactionOptions extends SendTransactionOptionsType {
 }
-interface SendTransactionReturnType extends Partial<TransformNodeType<SignedTx>> {
+interface SendTransactionReturnType extends Partial<SignedTx> {
     hash: Encoded.TxHash;
     rawTx: Encoded.Transaction;
     confirmationHeight?: number;

package/es/send-transaction.js

@@ -0,0 +1,110 @@
+import verifyTransaction from './tx/validator.js';
+import { ensureError } from './utils/other.js';
+import { TransactionError } from './utils/errors.js';
+import { buildTxHash } from './tx/builder/index.js';
+import { poll, waitForTxConfirm } from './chain.js';
+
+/**
+ * @category exception
+ */
+export class InvalidTxError extends TransactionError {
+  constructor(message, validation, transaction) {
+    super(message);
+    this.name = 'InvalidTxError';
+    this.validation = validation;
+    this.transaction = transaction;
+  }
+}
+
+/**
+ * Signs and submits transaction for mining
+ * @category chain
+ * @param txUnsigned - Transaction to sign and submit
+ * @param options - Options
+ * @returns Transaction details
+ */
+export async function sendTransaction(txUnsigned, {
+  onNode,
+  onAccount,
+  verify = true,
+  waitMined = true,
+  confirm,
+  innerTx,
+  ...options
+}) {
+  const tx = await onAccount.signTransaction(txUnsigned, {
+    ...options,
+    onNode,
+    innerTx,
+    networkId: await onNode.getNetworkId()
+  });
+  if (innerTx === true) return {
+    hash: buildTxHash(tx),
+    rawTx: tx
+  };
+  if (verify) {
+    const validation = await verifyTransaction(tx, onNode);
+    if (validation.length > 0) {
+      const message = `Transaction verification errors: ${validation.map(v => v.message).join(', ')}`;
+      throw new InvalidTxError(message, validation, tx);
+    }
+  }
+  try {
+    let __queue;
+    try {
+      __queue = onAccount != null ? `tx-${onAccount.address}` : null;
+    } catch (error) {
+      __queue = null;
+    }
+    const {
+      txHash
+    } = await onNode.postTransaction({
+      tx
+    }, {
+      requestOptions: {
+        customHeaders: {
+          // TODO: remove __retry-code after fixing https://github.com/aeternity/aeternity/issues/3803
+          '__retry-code': '400',
+          ...(__queue != null ? {
+            __queue
+          } : {})
+        }
+      }
+    });
+    if (waitMined) {
+      const pollResult = await poll(txHash, {
+        onNode,
+        ...options
+      });
+      const txData = {
+        ...pollResult,
+        hash: pollResult.hash,
+        rawTx: tx
+      };
+      // wait for transaction confirmation
+      if (confirm != null && +confirm > 0) {
+        const c = typeof confirm === 'boolean' ? undefined : confirm;
+        return {
+          ...txData,
+          confirmationHeight: await waitForTxConfirm(txHash, {
+            onNode,
+            confirm: c,
+            ...options
+          })
+        };
+      }
+      return txData;
+    }
+    return {
+      hash: txHash,
+      rawTx: tx
+    };
+  } catch (error) {
+    ensureError(error);
+    throw Object.assign(error, {
+      rawTx: tx,
+      verifyTx: async () => verifyTransaction(tx, onNode)
+    });
+  }
+}
+//# sourceMappingURL=send-transaction.js.map

package/es/send-transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-transaction.js","names":["verifyTransaction","ensureError","TransactionError","buildTxHash","poll","waitForTxConfirm","InvalidTxError","constructor","message","validation","transaction","name","sendTransaction","txUnsigned","onNode","onAccount","verify","waitMined","confirm","innerTx","options","tx","signTransaction","networkId","getNetworkId","hash","rawTx","length","map","v","join","__queue","address","error","txHash","postTransaction","requestOptions","customHeaders","pollResult","txData","c","undefined","confirmationHeight","Object","assign","verifyTx"],"sources":["../src/send-transaction.ts"],"sourcesContent":["import verifyTransaction, { ValidatorResult } from './tx/validator.js';\nimport { ensureError } from './utils/other.js';\nimport { TransactionError } from './utils/errors.js';\nimport Node from './Node.js';\nimport { SignedTx } from './apis/node/index.js';\nimport { Encoded } from './utils/encoder.js';\nimport AccountBase from './account/Base.js';\nimport { buildTxHash } from './tx/builder/index.js';\nimport { poll, waitForTxConfirm } from './chain.js';\n\n/**\n * @category exception\n */\nexport class InvalidTxError extends TransactionError {\n  validation: ValidatorResult[];\n\n  transaction: Encoded.Transaction;\n\n  constructor(message: string, validation: ValidatorResult[], transaction: Encoded.Transaction) {\n    super(message);\n    this.name = 'InvalidTxError';\n    this.validation = validation;\n    this.transaction = transaction;\n  }\n}\n\n/**\n * Signs and submits transaction for mining\n * @category chain\n * @param txUnsigned - Transaction to sign and submit\n * @param options - Options\n * @returns Transaction details\n */\nexport async function sendTransaction(\n  txUnsigned: Encoded.Transaction,\n  {\n    onNode,\n    onAccount,\n    verify = true,\n    waitMined = true,\n    confirm,\n    innerTx,\n    ...options\n  }: SendTransactionOptions,\n): Promise<SendTransactionReturnType> {\n  const tx = await onAccount.signTransaction(txUnsigned, {\n    ...options,\n    onNode,\n    innerTx,\n    networkId: await onNode.getNetworkId(),\n  });\n\n  if (innerTx === true) return { hash: buildTxHash(tx), rawTx: tx };\n\n  if (verify) {\n    const validation = await verifyTransaction(tx, onNode);\n    if (validation.length > 0) {\n      const message = `Transaction verification errors: ${validation\n        .map((v: { message: string }) => v.message)\n        .join(', ')}`;\n      throw new InvalidTxError(message, validation, tx);\n    }\n  }\n\n  try {\n    let __queue;\n    try {\n      __queue = onAccount != null ? `tx-${onAccount.address}` : null;\n    } catch (error) {\n      __queue = null;\n    }\n    const { txHash } = await onNode.postTransaction(\n      { tx },\n      {\n        requestOptions: {\n          customHeaders: {\n            // TODO: remove __retry-code after fixing https://github.com/aeternity/aeternity/issues/3803\n            '__retry-code': '400',\n            ...(__queue != null ? { __queue } : {}),\n          },\n        },\n      },\n    );\n\n    if (waitMined) {\n      const pollResult = await poll(txHash, { onNode, ...options });\n      const txData = {\n        ...pollResult,\n        hash: pollResult.hash as Encoded.TxHash,\n        rawTx: tx,\n      };\n      // wait for transaction confirmation\n      if (confirm != null && +confirm > 0) {\n        const c = typeof confirm === 'boolean' ? undefined : confirm;\n        return {\n          ...txData,\n          confirmationHeight: await waitForTxConfirm(txHash, { onNode, confirm: c, ...options }),\n        };\n      }\n      return txData;\n    }\n    return { hash: txHash, rawTx: tx };\n  } catch (error) {\n    ensureError(error);\n    throw Object.assign(error, {\n      rawTx: tx,\n      verifyTx: async () => verifyTransaction(tx, onNode),\n    });\n  }\n}\n\ntype SendTransactionOptionsType = {\n  /**\n   * Node to use\n   */\n  onNode: Node;\n  /**\n   * Account to use\n   */\n  onAccount: AccountBase;\n  /**\n   * Verify transaction before broadcast, throw error if not\n   */\n  verify?: boolean;\n  /**\n   * Ensure that transaction get into block\n   */\n  waitMined?: boolean;\n  /**\n   * Number of micro blocks that should be mined after tx get included\n   */\n  confirm?: boolean | number;\n} & Parameters<typeof poll>[1] &\n  Omit<Parameters<typeof waitForTxConfirm>[1], 'confirm'> &\n  Parameters<AccountBase['signTransaction']>[1];\nexport interface SendTransactionOptions extends SendTransactionOptionsType {}\ninterface SendTransactionReturnType extends Partial<SignedTx> {\n  hash: Encoded.TxHash;\n  // TODO: use `SignedTx.encodedTx` instead\n  rawTx: Encoded.Transaction;\n  confirmationHeight?: number;\n}\n"],"mappings":"AAAA,OAAOA,iBAAiB,MAA2B,mBAAmB;AACtE,SAASC,WAAW,QAAQ,kBAAkB;AAC9C,SAASC,gBAAgB,QAAQ,mBAAmB;AAKpD,SAASC,WAAW,QAAQ,uBAAuB;AACnD,SAASC,IAAI,EAAEC,gBAAgB,QAAQ,YAAY;;AAEnD;AACA;AACA;AACA,OAAO,MAAMC,cAAc,SAASJ,gBAAgB,CAAC;EAKnDK,WAAWA,CAACC,OAAe,EAAEC,UAA6B,EAAEC,WAAgC,EAAE;IAC5F,KAAK,CAACF,OAAO,CAAC;IACd,IAAI,CAACG,IAAI,GAAG,gBAAgB;IAC5B,IAAI,CAACF,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACC,WAAW,GAAGA,WAAW;EAChC;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeE,eAAeA,CACnCC,UAA+B,EAC/B;EACEC,MAAM;EACNC,SAAS;EACTC,MAAM,GAAG,IAAI;EACbC,SAAS,GAAG,IAAI;EAChBC,OAAO;EACPC,OAAO;EACP,GAAGC;AACmB,CAAC,EACW;EACpC,MAAMC,EAAE,GAAG,MAAMN,SAAS,CAACO,eAAe,CAACT,UAAU,EAAE;IACrD,GAAGO,OAAO;IACVN,MAAM;IACNK,OAAO;IACPI,SAAS,EAAE,MAAMT,MAAM,CAACU,YAAY,CAAC;EACvC,CAAC,CAAC;EAEF,IAAIL,OAAO,KAAK,IAAI,EAAE,OAAO;IAAEM,IAAI,EAAEtB,WAAW,CAACkB,EAAE,CAAC;IAAEK,KAAK,EAAEL;EAAG,CAAC;EAEjE,IAAIL,MAAM,EAAE;IACV,MAAMP,UAAU,GAAG,MAAMT,iBAAiB,CAACqB,EAAE,EAAEP,MAAM,CAAC;IACtD,IAAIL,UAAU,CAACkB,MAAM,GAAG,CAAC,EAAE;MACzB,MAAMnB,OAAO,GAAG,oCAAoCC,UAAU,CAC3DmB,GAAG,CAAEC,CAAsB,IAAKA,CAAC,CAACrB,OAAO,CAAC,CAC1CsB,IAAI,CAAC,IAAI,CAAC,EAAE;MACf,MAAM,IAAIxB,cAAc,CAACE,OAAO,EAAEC,UAAU,EAAEY,EAAE,CAAC;IACnD;EACF;EAEA,IAAI;IACF,IAAIU,OAAO;IACX,IAAI;MACFA,OAAO,GAAGhB,SAAS,IAAI,IAAI,GAAG,MAAMA,SAAS,CAACiB,OAAO,EAAE,GAAG,IAAI;IAChE,CAAC,CAAC,OAAOC,KAAK,EAAE;MACdF,OAAO,GAAG,IAAI;IAChB;IACA,MAAM;MAAEG;IAAO,CAAC,GAAG,MAAMpB,MAAM,CAACqB,eAAe,CAC7C;MAAEd;IAAG,CAAC,EACN;MACEe,cAAc,EAAE;QACdC,aAAa,EAAE;UACb;UACA,cAAc,EAAE,KAAK;UACrB,IAAIN,OAAO,IAAI,IAAI,GAAG;YAAEA;UAAQ,CAAC,GAAG,CAAC,CAAC;QACxC;MACF;IACF,CACF,CAAC;IAED,IAAId,SAAS,EAAE;MACb,MAAMqB,UAAU,GAAG,MAAMlC,IAAI,CAAC8B,MAAM,EAAE;QAAEpB,MAAM;QAAE,GAAGM;MAAQ,CAAC,CAAC;MAC7D,MAAMmB,MAAM,GAAG;QACb,GAAGD,UAAU;QACbb,IAAI,EAAEa,UAAU,CAACb,IAAsB;QACvCC,KAAK,EAAEL;MACT,CAAC;MACD;MACA,IAAIH,OAAO,IAAI,IAAI,IAAI,CAACA,OAAO,GAAG,CAAC,EAAE;QACnC,MAAMsB,CAAC,GAAG,OAAOtB,OAAO,KAAK,SAAS,GAAGuB,SAAS,GAAGvB,OAAO;QAC5D,OAAO;UACL,GAAGqB,MAAM;UACTG,kBAAkB,EAAE,MAAMrC,gBAAgB,CAAC6B,MAAM,EAAE;YAAEpB,MAAM;YAAEI,OAAO,EAAEsB,CAAC;YAAE,GAAGpB;UAAQ,CAAC;QACvF,CAAC;MACH;MACA,OAAOmB,MAAM;IACf;IACA,OAAO;MAAEd,IAAI,EAAES,MAAM;MAAER,KAAK,EAAEL;IAAG,CAAC;EACpC,CAAC,CAAC,OAAOY,KAAK,EAAE;IACdhC,WAAW,CAACgC,KAAK,CAAC;IAClB,MAAMU,MAAM,CAACC,MAAM,CAACX,KAAK,EAAE;MACzBP,KAAK,EAAEL,EAAE;MACTwB,QAAQ,EAAE,MAAAA,CAAA,KAAY7C,iBAAiB,CAACqB,EAAE,EAAEP,MAAM;IACpD,CAAC,CAAC;EACJ;AACF","ignoreList":[]}

package/es/spend.d.ts

@@ -1,9 +1,9 @@
-import { resolveName } from './chain';
-import { sendTransaction, SendTransactionOptions } from './send-transaction';
-import { BuildTxOptions } from './tx/builder';
-import { Encoded } from './utils/encoder';
-import { Tag, AensName } from './tx/builder/constants';
-import AccountBase from './account/Base';
+import { resolveName } from './chain.js';
+import { sendTransaction, SendTransactionOptions } from './send-transaction.js';
+import { BuildTxOptions } from './tx/builder/index.js';
+import { Encoded } from './utils/encoder.js';
+import { Tag, AensName } from './tx/builder/constants.js';
+type ResolveNameOptions = Omit<Parameters<typeof resolveName>[2], 'onNode' | 'verify'>;
 /**
  * Send coins to another account
  * @category chain
@@ -13,9 +13,7 @@ import AccountBase from './account/Base';
  * @returns Transaction
  */
 export declare function spend(amount: number | string, recipientIdOrName: Encoded.AccountAddress | Encoded.ContractAddress | AensName, options: SpendOptions): ReturnType<typeof sendTransaction>;
-type SpendOptionsType = BuildTxOptions<Tag.SpendTx, 'senderId' | 'recipientId' | 'amount'> & Parameters<typeof resolveName>[2] & {
-    onAccount: AccountBase;
-} & SendTransactionOptions;
+type SpendOptionsType = BuildTxOptions<Tag.SpendTx, 'senderId' | 'recipientId' | 'amount' | 'onNode'> & ResolveNameOptions & SendTransactionOptions;
 interface SpendOptions extends SpendOptionsType {
 }
 /**
@@ -37,9 +35,7 @@ interface SpendOptions extends SpendOptionsType {
  */
 export declare function transferFunds(fraction: number | string, // TODO: accept only number
 recipientIdOrName: AensName | Encoded.AccountAddress | Encoded.ContractAddress, options: TransferFundsOptions): ReturnType<typeof sendTransaction>;
-type TransferFundsOptionsType = BuildTxOptions<Tag.SpendTx, 'senderId' | 'recipientId' | 'amount'> & Parameters<typeof resolveName>[2] & {
-    onAccount: AccountBase;
-} & SendTransactionOptions;
+type TransferFundsOptionsType = BuildTxOptions<Tag.SpendTx, 'senderId' | 'recipientId' | 'amount' | 'onNode'> & ResolveNameOptions & SendTransactionOptions;
 interface TransferFundsOptions extends TransferFundsOptionsType {
 }
 /**
@@ -51,6 +47,5 @@ interface TransferFundsOptions extends TransferFundsOptionsType {
  */
 export declare function payForTransaction(transaction: Encoded.Transaction, options: PayForTransactionOptions): ReturnType<typeof sendTransaction>;
 interface PayForTransactionOptions extends BuildTxOptions<Tag.PayingForTx, 'payerId' | 'tx' | 'onNode'>, SendTransactionOptions {
-    onAccount: AccountBase;
 }
 export {};

package/es/spend.js

@@ -0,0 +1,93 @@
+import { BigNumber } from 'bignumber.js';
+import { getBalance, resolveName } from './chain.js';
+import { sendTransaction } from './send-transaction.js';
+import { buildTxAsync, unpackTx } from './tx/builder/index.js';
+import { ArgumentError } from './utils/errors.js';
+import { Tag } from './tx/builder/constants.js';
+
+// TODO: name verify should not overlap with transaction verify
+
+/**
+ * Send coins to another account
+ * @category chain
+ * @param amount - Amount to spend
+ * @param recipientIdOrName - Address or name of recipient account
+ * @param options - Options
+ * @returns Transaction
+ */
+export async function spend(amount, recipientIdOrName, options) {
+  return sendTransaction(await buildTxAsync({
+    _isInternalBuild: true,
+    ...options,
+    tag: Tag.SpendTx,
+    senderId: options.onAccount.address,
+    recipientId: await resolveName(recipientIdOrName, 'account_pubkey', options),
+    amount
+  }), options);
+}
+// TODO: Rename to spendFraction
+/**
+ * Spend a fraction of coin balance to another account. Useful if needed to drain account balance
+ * completely, sending funds to another account (with fraction set to 1).
+ * @category chain
+ * @param fraction - Fraction of balance to spend (between 0 and 1)
+ * @param recipientIdOrName - Address or name of recipient account
+ * @param options - Options
+ * @example
+ * ```js
+ * // `fraction` * 100 = % of AE to be transferred (e.g. `0.42` for 42% or `1` for 100%)
+ * const { blockHeight } = await aeSdk.transferFunds(
+ *   0.42,
+ *   'ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E',
+ * );
+ * console.log('Transaction mined at', blockHeight);
+ * ```
+ */
+export async function transferFunds(fraction,
+// TODO: accept only number
+recipientIdOrName, options) {
+  if (+fraction < 0 || +fraction > 1) {
+    throw new ArgumentError('fraction', 'a number between 0 and 1', fraction);
+  }
+  const recipientId = await resolveName(recipientIdOrName, 'account_pubkey', options);
+  const senderId = options.onAccount.address;
+  const balance = new BigNumber(await getBalance.bind(options.onAccount)(senderId, options));
+  const desiredAmount = balance.times(fraction).integerValue(BigNumber.ROUND_HALF_UP);
+  const {
+    fee
+  } = unpackTx(await buildTxAsync({
+    _isInternalBuild: true,
+    ...options,
+    tag: Tag.SpendTx,
+    senderId,
+    recipientId,
+    amount: desiredAmount
+  }), Tag.SpendTx);
+  // Reducing of the amount may reduce transaction fee, so this is not completely accurate
+  const amount = desiredAmount.plus(fee).gt(balance) ? balance.minus(fee) : desiredAmount;
+  return sendTransaction(await buildTxAsync({
+    _isInternalBuild: true,
+    ...options,
+    tag: Tag.SpendTx,
+    senderId,
+    recipientId,
+    amount
+  }), options);
+}
+/**
+ * Submit transaction of another account paying for it (fee and gas)
+ * @category chain
+ * @param transaction - tx_<base64>-encoded transaction
+ * @param options - Options
+ * @returns Object Transaction
+ */
+export async function payForTransaction(transaction, options) {
+  return sendTransaction(await buildTxAsync({
+    _isInternalBuild: true,
+    ...options,
+    tag: Tag.PayingForTx,
+    payerId: options.onAccount.address,
+    tx: transaction
+  }), options);
+}
+//# sourceMappingURL=spend.js.map

package/es/spend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spend.js","names":["BigNumber","getBalance","resolveName","sendTransaction","buildTxAsync","unpackTx","ArgumentError","Tag","spend","amount","recipientIdOrName","options","_isInternalBuild","tag","SpendTx","senderId","onAccount","address","recipientId","transferFunds","fraction","balance","bind","desiredAmount","times","integerValue","ROUND_HALF_UP","fee","plus","gt","minus","payForTransaction","transaction","PayingForTx","payerId","tx"],"sources":["../src/spend.ts"],"sourcesContent":["import { BigNumber } from 'bignumber.js';\nimport { getBalance, resolveName } from './chain.js';\nimport { sendTransaction, SendTransactionOptions } from './send-transaction.js';\nimport { buildTxAsync, BuildTxOptions, unpackTx } from './tx/builder/index.js';\nimport { ArgumentError } from './utils/errors.js';\nimport { Encoded } from './utils/encoder.js';\nimport { Tag, AensName } from './tx/builder/constants.js';\n\n// TODO: name verify should not overlap with transaction verify\ntype ResolveNameOptions = Omit<Parameters<typeof resolveName>[2], 'onNode' | 'verify'>;\n\n/**\n * Send coins to another account\n * @category chain\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: Encoded.AccountAddress | Encoded.ContractAddress | AensName,\n  options: SpendOptions,\n): ReturnType<typeof sendTransaction> {\n  return sendTransaction(\n    await buildTxAsync({\n      _isInternalBuild: true,\n      ...options,\n      tag: Tag.SpendTx,\n      senderId: options.onAccount.address,\n      recipientId: await resolveName(recipientIdOrName, 'account_pubkey', options),\n      amount,\n    }),\n    options,\n  );\n}\n\ntype SpendOptionsType = BuildTxOptions<\n  Tag.SpendTx,\n  'senderId' | 'recipientId' | 'amount' | 'onNode'\n> &\n  ResolveNameOptions &\n  SendTransactionOptions;\ninterface SpendOptions extends SpendOptionsType {}\n\n// TODO: Rename to spendFraction\n/**\n * Spend a fraction of coin balance to another account. Useful if needed to drain account balance\n * completely, sending funds to another account (with fraction set to 1).\n * @category chain\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 * @example\n * ```js\n * // `fraction` * 100 = % of AE to be transferred (e.g. `0.42` for 42% or `1` for 100%)\n * const { blockHeight } = await aeSdk.transferFunds(\n *   0.42,\n *   'ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E',\n * );\n * console.log('Transaction mined at', blockHeight);\n * ```\n */\nexport async function transferFunds(\n  fraction: number | string, // TODO: accept only number\n  recipientIdOrName: AensName | Encoded.AccountAddress | Encoded.ContractAddress,\n  options: TransferFundsOptions,\n): ReturnType<typeof sendTransaction> {\n  if (+fraction < 0 || +fraction > 1) {\n    throw new ArgumentError('fraction', 'a number between 0 and 1', fraction);\n  }\n  const recipientId = await resolveName(recipientIdOrName, 'account_pubkey', options);\n  const senderId = options.onAccount.address;\n  const balance = new BigNumber(await getBalance.bind(options.onAccount)(senderId, options));\n  const desiredAmount = balance.times(fraction).integerValue(BigNumber.ROUND_HALF_UP);\n  const { fee } = unpackTx(\n    await buildTxAsync({\n      _isInternalBuild: true,\n      ...options,\n      tag: Tag.SpendTx,\n      senderId,\n      recipientId,\n      amount: desiredAmount,\n    }),\n    Tag.SpendTx,\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 sendTransaction(\n    await buildTxAsync({\n      _isInternalBuild: true,\n      ...options,\n      tag: Tag.SpendTx,\n      senderId,\n      recipientId,\n      amount,\n    }),\n    options,\n  );\n}\n\ntype TransferFundsOptionsType = BuildTxOptions<\n  Tag.SpendTx,\n  'senderId' | 'recipientId' | 'amount' | 'onNode'\n> &\n  ResolveNameOptions &\n  SendTransactionOptions;\ninterface TransferFundsOptions extends TransferFundsOptionsType {}\n\n/**\n * Submit transaction of another account paying for it (fee and gas)\n * @category chain\n * @param transaction - tx_<base64>-encoded transaction\n * @param options - Options\n * @returns Object Transaction\n */\nexport async function payForTransaction(\n  transaction: Encoded.Transaction,\n  options: PayForTransactionOptions,\n): ReturnType<typeof sendTransaction> {\n  return sendTransaction(\n    await buildTxAsync({\n      _isInternalBuild: true,\n      ...options,\n      tag: Tag.PayingForTx,\n      payerId: options.onAccount.address,\n      tx: transaction,\n    }),\n    options,\n  );\n}\n\ninterface PayForTransactionOptions\n  extends BuildTxOptions<Tag.PayingForTx, 'payerId' | 'tx' | 'onNode'>,\n    SendTransactionOptions {}\n"],"mappings":"AAAA,SAASA,SAAS,QAAQ,cAAc;AACxC,SAASC,UAAU,EAAEC,WAAW,QAAQ,YAAY;AACpD,SAASC,eAAe,QAAgC,uBAAuB;AAC/E,SAASC,YAAY,EAAkBC,QAAQ,QAAQ,uBAAuB;AAC9E,SAASC,aAAa,QAAQ,mBAAmB;AAEjD,SAASC,GAAG,QAAkB,2BAA2B;;AAEzD;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,KAAKA,CACzBC,MAAuB,EACvBC,iBAA8E,EAC9EC,OAAqB,EACe;EACpC,OAAOR,eAAe,CACpB,MAAMC,YAAY,CAAC;IACjBQ,gBAAgB,EAAE,IAAI;IACtB,GAAGD,OAAO;IACVE,GAAG,EAAEN,GAAG,CAACO,OAAO;IAChBC,QAAQ,EAAEJ,OAAO,CAACK,SAAS,CAACC,OAAO;IACnCC,WAAW,EAAE,MAAMhB,WAAW,CAACQ,iBAAiB,EAAE,gBAAgB,EAAEC,OAAO,CAAC;IAC5EF;EACF,CAAC,CAAC,EACFE,OACF,CAAC;AACH;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeQ,aAAaA,CACjCC,QAAyB;AAAE;AAC3BV,iBAA8E,EAC9EC,OAA6B,EACO;EACpC,IAAI,CAACS,QAAQ,GAAG,CAAC,IAAI,CAACA,QAAQ,GAAG,CAAC,EAAE;IAClC,MAAM,IAAId,aAAa,CAAC,UAAU,EAAE,0BAA0B,EAAEc,QAAQ,CAAC;EAC3E;EACA,MAAMF,WAAW,GAAG,MAAMhB,WAAW,CAACQ,iBAAiB,EAAE,gBAAgB,EAAEC,OAAO,CAAC;EACnF,MAAMI,QAAQ,GAAGJ,OAAO,CAACK,SAAS,CAACC,OAAO;EAC1C,MAAMI,OAAO,GAAG,IAAIrB,SAAS,CAAC,MAAMC,UAAU,CAACqB,IAAI,CAACX,OAAO,CAACK,SAAS,CAAC,CAACD,QAAQ,EAAEJ,OAAO,CAAC,CAAC;EAC1F,MAAMY,aAAa,GAAGF,OAAO,CAACG,KAAK,CAACJ,QAAQ,CAAC,CAACK,YAAY,CAACzB,SAAS,CAAC0B,aAAa,CAAC;EACnF,MAAM;IAAEC;EAAI,CAAC,GAAGtB,QAAQ,CACtB,MAAMD,YAAY,CAAC;IACjBQ,gBAAgB,EAAE,IAAI;IACtB,GAAGD,OAAO;IACVE,GAAG,EAAEN,GAAG,CAACO,OAAO;IAChBC,QAAQ;IACRG,WAAW;IACXT,MAAM,EAAEc;EACV,CAAC,CAAC,EACFhB,GAAG,CAACO,OACN,CAAC;EACD;EACA,MAAML,MAAM,GAAGc,aAAa,CAACK,IAAI,CAACD,GAAG,CAAC,CAACE,EAAE,CAACR,OAAO,CAAC,GAAGA,OAAO,CAACS,KAAK,CAACH,GAAG,CAAC,GAAGJ,aAAa;EACvF,OAAOpB,eAAe,CACpB,MAAMC,YAAY,CAAC;IACjBQ,gBAAgB,EAAE,IAAI;IACtB,GAAGD,OAAO;IACVE,GAAG,EAAEN,GAAG,CAACO,OAAO;IAChBC,QAAQ;IACRG,WAAW;IACXT;EACF,CAAC,CAAC,EACFE,OACF,CAAC;AACH;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeoB,iBAAiBA,CACrCC,WAAgC,EAChCrB,OAAiC,EACG;EACpC,OAAOR,eAAe,CACpB,MAAMC,YAAY,CAAC;IACjBQ,gBAAgB,EAAE,IAAI;IACtB,GAAGD,OAAO;IACVE,GAAG,EAAEN,GAAG,CAAC0B,WAAW;IACpBC,OAAO,EAAEvB,OAAO,CAACK,SAAS,CAACC,OAAO;IAClCkB,EAAE,EAAEH;EACN,CAAC,CAAC,EACFrB,OACF,CAAC;AACH","ignoreList":[]}

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

@@ -1,5 +1,5 @@
-import { Field as OriginalField } from './field-types';
-import { UnionToIntersection } from '../../utils/other';
+import { Field as OriginalField } from './field-types/interface.js';
+import { UnionToIntersection } from '../../utils/other.js';
 export interface Field extends OriginalField {
     serialize: (...args: any[]) => any;
 }
@@ -14,7 +14,7 @@ type TxParamsBySchemaInternalParams<SchemaItem, SchemaItemValues = SchemaItem[ke
 type PickIsRec<SchemaItem, Recursive extends boolean> = {
     [Key in keyof SchemaItem as SchemaItem[Key] extends Field & {
         recursiveType: true;
-    } ? (Recursive extends true ? Key : never) : (Recursive extends true ? never : Key)]: SchemaItem[Key];
+    } ? Recursive extends true ? Key : never : Recursive extends true ? never : Key]: SchemaItem[Key];
 };
 type TxParamsBySchema<SchemaItem> = SchemaItem extends Object ? TxParamsBySchemaInternal<PickIsRec<SchemaItem, true>> & NullablePartial<TxParamsBySchemaInternal<PickIsRec<SchemaItem, false>>> & TxParamsBySchemaInternalParams<PickIsRec<SchemaItem, false>> : never;
 type TxParamsAsyncBySchemaInternal<SchemaItem> = {

package/es/tx/builder/SchemaTypes.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=SchemaTypes.js.map

package/es/tx/builder/SchemaTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaTypes.js","names":[],"sources":["../../../src/tx/builder/SchemaTypes.ts"],"sourcesContent":["import { Field as OriginalField } from './field-types/interface.js';\nimport { UnionToIntersection } from '../../utils/other.js';\n\n// TODO: figure out why this override is necessary\nexport interface Field extends OriginalField {\n  serialize: (...args: any[]) => any;\n}\n\ntype NullablePartial<\n  T,\n  NK extends keyof T = { [K in keyof T]: undefined extends T[K] ? K : never }[keyof T],\n> = Partial<Pick<T, NK>> & Omit<T, NK>;\n\ntype Or<A, B> = A extends undefined ? B : A;\n\ntype TxParamsBySchemaInternal<SchemaItem> = {\n  -readonly [key in keyof SchemaItem]: SchemaItem[key] extends Field\n    ? Parameters<SchemaItem[key]['serialize']>[0]\n    : never;\n};\n\ntype TxParamsBySchemaInternalParams<\n  SchemaItem,\n  SchemaItemValues = SchemaItem[keyof SchemaItem],\n> = UnionToIntersection<\n  SchemaItemValues extends Field ? Or<Parameters<SchemaItemValues['serialize']>[2], {}> : never\n>;\n\ntype PickIsRec<SchemaItem, Recursive extends boolean> = {\n  [Key in keyof SchemaItem as SchemaItem[Key] extends Field & { recursiveType: true }\n    ? Recursive extends true\n      ? Key\n      : never\n    : Recursive extends true\n      ? never\n      : Key]: SchemaItem[Key];\n};\n\ntype TxParamsBySchema<SchemaItem> = SchemaItem extends Object\n  ? TxParamsBySchemaInternal<PickIsRec<SchemaItem, true>> &\n      NullablePartial<TxParamsBySchemaInternal<PickIsRec<SchemaItem, false>>> &\n      TxParamsBySchemaInternalParams<PickIsRec<SchemaItem, false>>\n  : never;\n\ntype TxParamsAsyncBySchemaInternal<SchemaItem> = {\n  -readonly [key in keyof SchemaItem]: SchemaItem[key] extends Field & { prepare: Function }\n    ? Parameters<SchemaItem[key]['prepare']>[0]\n    : SchemaItem[key] extends Field\n      ? Parameters<SchemaItem[key]['serialize']>[0]\n      : never;\n};\n\ntype TxParamsAsyncBySchemaInternalParams<\n  SchemaItem,\n  SchemaItemValues = SchemaItem[keyof SchemaItem],\n> = UnionToIntersection<\n  SchemaItemValues extends Field & { prepare: Function }\n    ? Or<Parameters<SchemaItemValues['prepare']>[2], {}>\n    : {}\n>;\n\ntype TxParamsAsyncBySchema<SchemaItem> = SchemaItem extends Object\n  ? TxParamsAsyncBySchemaInternal<PickIsRec<SchemaItem, true>> &\n      NullablePartial<TxParamsAsyncBySchemaInternal<PickIsRec<SchemaItem, false>>> &\n      TxParamsAsyncBySchemaInternalParams<PickIsRec<SchemaItem, false>> &\n      TxParamsBySchemaInternalParams<PickIsRec<SchemaItem, false>>\n  : never;\n\ntype TxUnpackedBySchema<SchemaItem> = {\n  -readonly [key in keyof SchemaItem]: SchemaItem[key] extends Field\n    ? ReturnType<SchemaItem[key]['deserialize']>\n    : never;\n};\n\nexport default interface SchemaTypes<Schema extends readonly any[], SchemaItems = Schema[number]> {\n  TxParams: TxParamsBySchema<SchemaItems>;\n  TxParamsAsync: TxParamsAsyncBySchema<SchemaItems>;\n  TxUnpacked: TxUnpackedBySchema<SchemaItems>;\n}\n"],"mappings":"","ignoreList":[]}

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

@@ -1,5 +1,5 @@
-import { Field } from './field-types';
-import { Encoding, Encoded } from '../../utils/encoder';
+import { Field } from './field-types/interface.js';
+import { Encoding, Encoded } from '../../utils/encoder.js';
 type Schemas = ReadonlyArray<{
     tag: {
         constValue: number;

package/es/tx/builder/common.js

@@ -0,0 +1,38 @@
+import { decode as rlpDecode, encode as rlpEncode } from 'rlp';
+import { ArgumentError, DecodeError, SchemaNotFoundError, InternalError } from '../../utils/errors.js';
+import { encode, decode } from '../../utils/encoder.js';
+import { readInt } from './helpers.js';
+export function getSchema(schemas, Tag, tag, version) {
+  const subSchemas = schemas.filter(s => s.tag.constValue === tag);
+  if (subSchemas.length === 0) throw new SchemaNotFoundError(`${Tag[tag]} (${tag})`, 0);
+  if (version == null) {
+    const defaultSchema = subSchemas.find(schema => schema.version.constValueOptional);
+    if (defaultSchema == null) throw new InternalError(`Can't find default schema of ${Tag[tag]} (${tag})`);
+    version = defaultSchema.version.constValue;
+  }
+  const schema = subSchemas.find(s => s.version.constValue === version);
+  if (schema == null) throw new SchemaNotFoundError(`${Tag[tag]} (${tag})`, version);
+  return Object.entries(schema);
+}
+export function packRecord(schemas, Tag, params, extraParams, encoding) {
+  const schema = getSchema(schemas, Tag, params.tag, params.version);
+  const binary = schema.map(([key, field]) => field.serialize(params[key], {
+    ...params,
+    ...extraParams
+  }, params));
+  return encode(rlpEncode(binary), encoding);
+}
+export function unpackRecord(schemas, Tag, encodedRecord, expectedTag, extraParams) {
+  const binary = rlpDecode(decode(encodedRecord));
+  const tag = +readInt(binary[0]);
+  const version = +readInt(binary[1]);
+  const schema = getSchema(schemas, Tag, tag, version);
+  if (expectedTag != null && expectedTag !== tag) {
+    throw new DecodeError(`Expected ${Tag[expectedTag]} tag, got ${Tag[tag]} instead`);
+  }
+  if (binary.length !== schema.length) {
+    throw new ArgumentError('RLP length', schema.length, binary.length);
+  }
+  return Object.fromEntries(schema.map(([name, field], index) => [name, field.deserialize(binary[index], extraParams)]));
+}
+//# sourceMappingURL=common.js.map

package/es/tx/builder/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","names":["decode","rlpDecode","encode","rlpEncode","ArgumentError","DecodeError","SchemaNotFoundError","InternalError","readInt","getSchema","schemas","Tag","tag","version","subSchemas","filter","s","constValue","length","defaultSchema","find","schema","constValueOptional","Object","entries","packRecord","params","extraParams","encoding","binary","map","key","field","serialize","unpackRecord","encodedRecord","expectedTag","fromEntries","name","index","deserialize"],"sources":["../../../src/tx/builder/common.ts"],"sourcesContent":["import { decode as rlpDecode, encode as rlpEncode } from 'rlp';\nimport { Field, BinaryData } from './field-types/interface.js';\nimport {\n  ArgumentError,\n  DecodeError,\n  SchemaNotFoundError,\n  InternalError,\n} from '../../utils/errors.js';\nimport { Encoding, Encoded, encode, decode } from '../../utils/encoder.js';\nimport { readInt } from './helpers.js';\n\ntype Schemas = ReadonlyArray<{\n  tag: { constValue: number } & Field;\n  version: { constValue: number; constValueOptional: boolean } & Field;\n}>;\n\nexport function getSchema(\n  schemas: Schemas,\n  Tag: { [key: number]: string },\n  tag: number,\n  version: number | undefined,\n): Array<[string, Field]> {\n  const subSchemas = schemas.filter((s) => s.tag.constValue === tag);\n  if (subSchemas.length === 0) throw new SchemaNotFoundError(`${Tag[tag]} (${tag})`, 0);\n  if (version == null) {\n    const defaultSchema = subSchemas.find((schema) => schema.version.constValueOptional);\n    if (defaultSchema == null)\n      throw new InternalError(`Can't find default schema of ${Tag[tag]} (${tag})`);\n    version = defaultSchema.version.constValue;\n  }\n  const schema = subSchemas.find((s) => s.version.constValue === version);\n  if (schema == null) throw new SchemaNotFoundError(`${Tag[tag]} (${tag})`, version);\n  return Object.entries(schema);\n}\n\nexport function packRecord<E extends Encoding>(\n  schemas: Schemas,\n  Tag: { [key: number]: string },\n  params: {\n    tag: number;\n    version?: number;\n    [k: string]: unknown;\n  },\n  extraParams: { [k: string]: unknown },\n  encoding: E,\n): Encoded.Generic<E> {\n  const schema = getSchema(schemas, Tag, params.tag, params.version);\n  const binary = schema.map(([key, field]) =>\n    field.serialize(params[key], { ...params, ...extraParams }, params),\n  );\n  return encode(rlpEncode(binary), encoding);\n}\n\nexport function unpackRecord(\n  schemas: Schemas,\n  Tag: { [key: number]: string },\n  encodedRecord: Encoded.Any,\n  expectedTag: number | undefined,\n  extraParams: { [k: string]: unknown },\n): unknown {\n  const binary = rlpDecode(decode(encodedRecord));\n  const tag = +readInt(binary[0] as Buffer);\n  const version = +readInt(binary[1] as Buffer);\n  const schema = getSchema(schemas, Tag, tag, version);\n  if (expectedTag != null && expectedTag !== tag) {\n    throw new DecodeError(`Expected ${Tag[expectedTag]} tag, got ${Tag[tag]} instead`);\n  }\n  if (binary.length !== schema.length) {\n    throw new ArgumentError('RLP length', schema.length, binary.length);\n  }\n  return Object.fromEntries(\n    schema.map(([name, field], index) => [\n      name,\n      field.deserialize(binary[index] as BinaryData, extraParams),\n    ]),\n  );\n}\n"],"mappings":"AAAA,SAASA,MAAM,IAAIC,SAAS,EAAEC,MAAM,IAAIC,SAAS,QAAQ,KAAK;AAE9D,SACEC,aAAa,EACbC,WAAW,EACXC,mBAAmB,EACnBC,aAAa,QACR,uBAAuB;AAC9B,SAA4BL,MAAM,EAAEF,MAAM,QAAQ,wBAAwB;AAC1E,SAASQ,OAAO,QAAQ,cAAc;AAOtC,OAAO,SAASC,SAASA,CACvBC,OAAgB,EAChBC,GAA8B,EAC9BC,GAAW,EACXC,OAA2B,EACH;EACxB,MAAMC,UAAU,GAAGJ,OAAO,CAACK,MAAM,CAAEC,CAAC,IAAKA,CAAC,CAACJ,GAAG,CAACK,UAAU,KAAKL,GAAG,CAAC;EAClE,IAAIE,UAAU,CAACI,MAAM,KAAK,CAAC,EAAE,MAAM,IAAIZ,mBAAmB,CAAC,GAAGK,GAAG,CAACC,GAAG,CAAC,KAAKA,GAAG,GAAG,EAAE,CAAC,CAAC;EACrF,IAAIC,OAAO,IAAI,IAAI,EAAE;IACnB,MAAMM,aAAa,GAAGL,UAAU,CAACM,IAAI,CAAEC,MAAM,IAAKA,MAAM,CAACR,OAAO,CAACS,kBAAkB,CAAC;IACpF,IAAIH,aAAa,IAAI,IAAI,EACvB,MAAM,IAAIZ,aAAa,CAAC,gCAAgCI,GAAG,CAACC,GAAG,CAAC,KAAKA,GAAG,GAAG,CAAC;IAC9EC,OAAO,GAAGM,aAAa,CAACN,OAAO,CAACI,UAAU;EAC5C;EACA,MAAMI,MAAM,GAAGP,UAAU,CAACM,IAAI,CAAEJ,CAAC,IAAKA,CAAC,CAACH,OAAO,CAACI,UAAU,KAAKJ,OAAO,CAAC;EACvE,IAAIQ,MAAM,IAAI,IAAI,EAAE,MAAM,IAAIf,mBAAmB,CAAC,GAAGK,GAAG,CAACC,GAAG,CAAC,KAAKA,GAAG,GAAG,EAAEC,OAAO,CAAC;EAClF,OAAOU,MAAM,CAACC,OAAO,CAACH,MAAM,CAAC;AAC/B;AAEA,OAAO,SAASI,UAAUA,CACxBf,OAAgB,EAChBC,GAA8B,EAC9Be,MAIC,EACDC,WAAqC,EACrCC,QAAW,EACS;EACpB,MAAMP,MAAM,GAAGZ,SAAS,CAACC,OAAO,EAAEC,GAAG,EAAEe,MAAM,CAACd,GAAG,EAAEc,MAAM,CAACb,OAAO,CAAC;EAClE,MAAMgB,MAAM,GAAGR,MAAM,CAACS,GAAG,CAAC,CAAC,CAACC,GAAG,EAAEC,KAAK,CAAC,KACrCA,KAAK,CAACC,SAAS,CAACP,MAAM,CAACK,GAAG,CAAC,EAAE;IAAE,GAAGL,MAAM;IAAE,GAAGC;EAAY,CAAC,EAAED,MAAM,CACpE,CAAC;EACD,OAAOxB,MAAM,CAACC,SAAS,CAAC0B,MAAM,CAAC,EAAED,QAAQ,CAAC;AAC5C;AAEA,OAAO,SAASM,YAAYA,CAC1BxB,OAAgB,EAChBC,GAA8B,EAC9BwB,aAA0B,EAC1BC,WAA+B,EAC/BT,WAAqC,EAC5B;EACT,MAAME,MAAM,GAAG5B,SAAS,CAACD,MAAM,CAACmC,aAAa,CAAC,CAAC;EAC/C,MAAMvB,GAAG,GAAG,CAACJ,OAAO,CAACqB,MAAM,CAAC,CAAC,CAAW,CAAC;EACzC,MAAMhB,OAAO,GAAG,CAACL,OAAO,CAACqB,MAAM,CAAC,CAAC,CAAW,CAAC;EAC7C,MAAMR,MAAM,GAAGZ,SAAS,CAACC,OAAO,EAAEC,GAAG,EAAEC,GAAG,EAAEC,OAAO,CAAC;EACpD,IAAIuB,WAAW,IAAI,IAAI,IAAIA,WAAW,KAAKxB,GAAG,EAAE;IAC9C,MAAM,IAAIP,WAAW,CAAC,YAAYM,GAAG,CAACyB,WAAW,CAAC,aAAazB,GAAG,CAACC,GAAG,CAAC,UAAU,CAAC;EACpF;EACA,IAAIiB,MAAM,CAACX,MAAM,KAAKG,MAAM,CAACH,MAAM,EAAE;IACnC,MAAM,IAAId,aAAa,CAAC,YAAY,EAAEiB,MAAM,CAACH,MAAM,EAAEW,MAAM,CAACX,MAAM,CAAC;EACrE;EACA,OAAOK,MAAM,CAACc,WAAW,CACvBhB,MAAM,CAACS,GAAG,CAAC,CAAC,CAACQ,IAAI,EAAEN,KAAK,CAAC,EAAEO,KAAK,KAAK,CACnCD,IAAI,EACJN,KAAK,CAACQ,WAAW,CAACX,MAAM,CAACU,KAAK,CAAC,EAAgBZ,WAAW,CAAC,CAC5D,CACH,CAAC;AACH","ignoreList":[]}