@aeternity/aepp-sdk 13.2.2 → 13.3.1

package/src/tx/builder/field-types/ttl.ts

@@ -1,7 +1,11 @@
 import shortUInt from './short-u-int';
 import Node from '../../../Node';
 import { ArgumentError } from '../../../utils/errors';
+import { _getPollInterval, getHeight } from '../../../chain';
 
+/**
+ * Time to leave
+ */
 export default {
   ...shortUInt,
 
@@ -13,11 +17,17 @@ export default {
     value: number | undefined,
     params: {},
     // TODO: { absoluteTtl: true } | { absoluteTtl: false, onNode: Node }
-    { onNode, absoluteTtl }: { onNode?: Node; absoluteTtl?: boolean },
+    {
+      onNode, absoluteTtl, _isInternalBuild, ...options
+    }: {
+      onNode?: Node;
+      absoluteTtl?: boolean;
+      _isInternalBuild?: boolean;
+    } & Parameters<typeof _getPollInterval>[1],
   ) {
-    if (absoluteTtl !== true && value !== 0 && value != null) {
+    if (absoluteTtl !== true && value !== 0 && (value != null || _isInternalBuild === true)) {
       if (onNode == null) throw new ArgumentError('onNode', 'provided', onNode);
-      value += (await onNode.getCurrentKeyBlock()).height;
+      value = (value ?? 3) + await getHeight({ ...options, onNode, cached: true });
     }
     return value;
   },

package/src/tx/builder/field-types/with-default.ts

@@ -0,0 +1,18 @@
+export default function withDefault<Input, Output, Binary>(
+  defaultValue: Input,
+  field: {
+    serialize: (value: Input, params: unknown) => Binary;
+    deserialize: (value: Binary, params: unknown) => Output;
+  },
+): {
+    serialize: (value: Input | undefined, params: unknown) => Binary;
+    deserialize: (value: Binary, params: unknown) => Output;
+  } {
+  return {
+    ...field,
+
+    serialize(value, params) {
+      return field.serialize(value ?? defaultValue, params);
+    },
+  };
+}

package/src/tx/builder/field-types/with-formatting.ts

@@ -0,0 +1,18 @@
+export default function withFormatting<Input, Output, Binary, Params, Options>(
+  format: (v: Input | undefined) => Input,
+  field: {
+    serialize: (value: Input, params: Params, options: Options) => Binary;
+    deserialize: (value: Binary) => Output;
+  },
+): {
+    serialize: (value: Input | undefined, params: Params, options: Options) => Binary;
+    deserialize: (value: Binary) => Output;
+  } {
+  return {
+    ...field,
+
+    serialize(value, params, options) {
+      return field.serialize(format(value), params, options);
+    },
+  };
+}

package/src/tx/builder/helpers.ts

@@ -136,7 +136,7 @@ export function readInt(buf: Buffer = Buffer.from([])): string {
 /**
  * Ensure that name is valid AENS name, would throw an exception otherwise
  * @category AENS
- * @param name - AENS name
+ * @param maybeName - AENS name
  */
 export function ensureName(maybeName: string): asserts maybeName is AensName {
   nameToPunycode(maybeName);
@@ -145,7 +145,7 @@ export function ensureName(maybeName: string): asserts maybeName is AensName {
 /**
  * Is AENS name valid
  * @category AENS
- * @param name - AENS name
+ * @param maybeName - AENS name
  */
 // TODO: consider renaming to isName
 export function isNameValid(maybeName: string): maybeName is AensName {

package/src/tx/builder/index.ts

@@ -1,71 +1,65 @@
-import { decode as rlpDecode, encode as rlpEncode } from 'rlp';
 import {
   decode, encode, Encoded, Encoding,
 } from '../../utils/encoder';
 import { hash } from '../../utils/crypto';
-import { BinaryData, Field } from './field-types';
+import { Field } from './field-types';
 import { txSchema } from './schema';
 import { TxUnpacked, TxParams, TxParamsAsync } from './schema.generated';
 import { Tag } from './constants';
-import { buildContractId, readInt } from './helpers';
-import { ArgumentError, DecodeError, SchemaNotFoundError } from '../../utils/errors';
+import { buildContractId } from './helpers';
+import { getSchema as getSchemaCommon, packRecord, unpackRecord } from './common';
+import { ArgumentError } from '../../utils/errors';
 
 /**
  * JavaScript-based Transaction builder
  */
 
 export function getSchema(tag: Tag, version?: number): Array<[string, Field]> {
-  const schemas = txSchema.filter((s) => s.tag.constValue === tag);
-  if (schemas.length === 0) throw new SchemaNotFoundError(`${Tag[tag]} (${tag})`, 0);
-  version ??= Math.max(...schemas.map((schema) => schema.version.constValue));
-  const schema = schemas.find((s) => s.version.constValue === version);
-  if (schema == null) throw new SchemaNotFoundError(`${Tag[tag]} (${tag})`, version);
-  return Object.entries(schema);
+  return getSchemaCommon(txSchema, Tag, tag, version);
 }
 
 type TxEncoding = Encoding.Transaction | Encoding.Poi | Encoding.StateTrees
 | Encoding.CallStateTree;
 
 /**
- * Build transaction hash
+ * Build transaction
  * @category transaction builder
- * @param params - Object with tx params
- * @param options - options
- * @param options.prefix - Prefix of transaction
- * @returns object Base64Check transaction hash with 'tx_' prefix
+ * @param params - Transaction params
  */
-export function buildTx<E extends TxEncoding = Encoding.Transaction>(
+export function buildTx(params: TxParams): Encoded.Transaction;
+/**
+ * Build node entry with a custom encoding
+ * @param params - Entry params
+ * @param options - Options
+ * @param options.prefix - Output encoding
+ */
+export function buildTx<E extends TxEncoding>(
   params: TxParams,
-  { prefix }: { prefix?: E } = {},
-): Encoded.Generic<E> {
-  const schema = getSchema(params.tag, params.version);
-
-  const binary = schema.map(([key, field]) => (
-    field.serialize(
-      // @ts-expect-error the type of `params[key]` can't be determined accurately
-      params[key],
-      {
-        ...params,
-        // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        unpackTx,
-        buildTx,
-        rebuildTx: (overrideParams: any) => buildTx(
-          { ...params, ...overrideParams },
-        ),
-      },
-      params,
-    )
-  ));
-
-  // @ts-expect-error looks like a TypeScript edge case
-  return encode(rlpEncode(binary), prefix ?? Encoding.Transaction);
+  { prefix }: { prefix: E },
+): Encoded.Generic<E>;
+export function buildTx(
+  params: TxParams,
+  { prefix }: { prefix?: TxEncoding } = {},
+): Encoded.Generic<TxEncoding> {
+  return packRecord(txSchema, Tag, params, {
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    unpackTx,
+    buildTx,
+    rebuildTx: (overrideParams: any) => buildTx(
+      { ...params, ...overrideParams },
+    ),
+  }, prefix ?? Encoding.Transaction);
 }
 
 export type BuildTxOptions <TxType extends Tag, OmitFields extends string> =
   Omit<TxParamsAsync & { tag: TxType }, 'tag' | OmitFields>;
 
+// TODO: require onNode because it is the only reason this builder is async [breaking change]
 /**
+ * Build transaction async (may request node for additional data)
  * @category transaction builder
+ * @param params - Transaction params
+ * @returns tx_-encoded transaction
  */
 export async function buildTxAsync(params: TxParamsAsync): Promise<Encoded.Transaction> {
   await Promise.all(
@@ -84,30 +78,18 @@ export async function buildTxAsync(params: TxParamsAsync): Promise<Encoded.Trans
 /**
  * Unpack transaction encoded as string
  * @category transaction builder
- * @param encodedTx - Transaction to unpack
+ * @param encodedTx - Encoded transaction
  * @param txType - Expected transaction type
- * @returns Object with transaction param's
+ * @returns Transaction params
  */
 export function unpackTx<TxType extends Tag>(
   encodedTx: Encoded.Generic<TxEncoding>,
   txType?: TxType,
 ): TxUnpacked & { tag: TxType } {
-  const binary = rlpDecode(decode(encodedTx));
-  const tag = +readInt(binary[0] as Buffer);
-  const version = +readInt(binary[1] as Buffer);
-  const schema = getSchema(tag, version);
-  if (txType != null && txType !== tag) throw new DecodeError(`Expected transaction to have ${Tag[txType]} tag, got ${Tag[tag]} instead`);
-  if (binary.length !== schema.length) {
-    throw new ArgumentError('Transaction RLP length', schema.length, binary.length);
-  }
-  return schema.reduce<any>(
-    (acc, [name, field], index) => {
-      // eslint-disable-next-line @typescript-eslint/no-use-before-define
-      const deserialized = field.deserialize(binary[index] as BinaryData, { unpackTx });
-      return { ...acc, [name]: deserialized };
-    },
-    {},
-  ) as any;
+  return unpackRecord(txSchema, Tag, encodedTx, txType, {
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    unpackTx,
+  }) as any;
 }
 
 /**
@@ -124,7 +106,7 @@ export function buildTxHash(rawTx: Encoded.Transaction | Uint8Array): Encoded.Tx
 }
 
 /**
- * Build a contract public key by contractCreateTx or gaAttach
+ * Build a contract public key by contractCreateTx, gaAttach or signedTx
  * @category contract
  * @param contractTx - Transaction
  * @returns Contract public key
@@ -132,7 +114,8 @@ export function buildTxHash(rawTx: Encoded.Transaction | Uint8Array): Encoded.Tx
 export function buildContractIdByContractTx(
   contractTx: Encoded.Transaction,
 ): Encoded.ContractAddress {
-  const params = unpackTx(contractTx);
+  let params = unpackTx(contractTx);
+  if (Tag.SignedTx === params.tag) params = params.encodedTx;
   if (Tag.ContractCreateTx !== params.tag && Tag.GaAttachTx !== params.tag) {
     throw new ArgumentError('contractTx', 'a contractCreateTx or gaAttach', params.tag);
   }

package/src/tx/builder/schema.generated.ts

@@ -319,6 +319,42 @@ type TxUnpackedNameUpdateTx1Type = TxUnpackedComplex & {
  */
 export interface TxUnpackedNameUpdateTx1 extends TxUnpackedNameUpdateTx1Type {
 }
+/**
+ * @category transaction builder
+ */
+type TxParamsNameUpdateTx2Type = TxParamsComplex & {
+    tag: Tag.NameUpdateTx;
+    version: 2;
+};
+/**
+ * @category transaction builder
+ */
+export interface TxParamsNameUpdateTx2 extends TxParamsNameUpdateTx2Type {
+}
+/**
+ * @category transaction builder
+ */
+type TxParamsAsyncNameUpdateTx2Type = TxParamsAsyncComplex & {
+    tag: Tag.NameUpdateTx;
+    version: 2;
+};
+/**
+ * @category transaction builder
+ */
+export interface TxParamsAsyncNameUpdateTx2 extends TxParamsAsyncNameUpdateTx2Type {
+}
+/**
+ * @category transaction builder
+ */
+type TxUnpackedNameUpdateTx2Type = TxUnpackedComplex & {
+    tag: Tag.NameUpdateTx;
+    version: 2;
+};
+/**
+ * @category transaction builder
+ */
+export interface TxUnpackedNameUpdateTx2 extends TxUnpackedNameUpdateTx2Type {
+}
 /**
  * @category transaction builder
  */
@@ -2002,12 +2038,12 @@ export interface TxUnpackedGaMetaTxAuthData1 extends TxUnpackedGaMetaTxAuthData1
 /**
  * @category transaction builder
  */
-export type TxParams = TxParamsAccount1 | TxParamsAccount2 | TxParamsSignedTx1 | TxParamsSpendTx1 | TxParamsName1 | TxParamsNamePreclaimTx1 | TxParamsNameClaimTx2 | TxParamsNameUpdateTx1 | TxParamsNameTransferTx1 | TxParamsNameRevokeTx1 | TxParamsContract1 | TxParamsContractCreateTx1 | TxParamsContractCallTx1 | TxParamsContractCall2 | TxParamsOracle1 | TxParamsOracleRegisterTx1 | TxParamsOracleExtendTx1 | TxParamsOracleQueryTx1 | TxParamsOracleResponseTx1 | TxParamsChannelCreateTx2 | TxParamsChannelCloseMutualTx1 | TxParamsChannelCloseSoloTx1 | TxParamsChannelSlashTx1 | TxParamsChannelDepositTx1 | TxParamsChannelWithdrawTx1 | TxParamsChannelSettleTx1 | TxParamsChannelForceProgressTx1 | TxParamsChannelOffChainTx2 | TxParamsChannel3 | TxParamsChannelSnapshotSoloTx1 | TxParamsChannelOffChainUpdateTransfer1 | TxParamsChannelOffChainUpdateDeposit1 | TxParamsChannelOffChainUpdateWithdraw1 | TxParamsChannelOffChainUpdateCreateContract1 | TxParamsChannelOffChainUpdateCallContract1 | TxParamsChannelClientReconnectTx1 | TxParamsTreesPoi1 | TxParamsStateTrees0 | TxParamsMtree1 | TxParamsMtreeValue1 | TxParamsContractsMtree1 | TxParamsCallsMtree1 | TxParamsChannelsMtree1 | TxParamsNameserviceMtree1 | TxParamsOraclesMtree1 | TxParamsAccountsMtree1 | TxParamsGaAttachTx1 | TxParamsGaMetaTx2 | TxParamsPayingForTx1 | TxParamsGaMetaTxAuthData1;
+export type TxParams = TxParamsAccount1 | TxParamsAccount2 | TxParamsSignedTx1 | TxParamsSpendTx1 | TxParamsName1 | TxParamsNamePreclaimTx1 | TxParamsNameClaimTx2 | TxParamsNameUpdateTx1 | TxParamsNameUpdateTx2 | TxParamsNameTransferTx1 | TxParamsNameRevokeTx1 | TxParamsContract1 | TxParamsContractCreateTx1 | TxParamsContractCallTx1 | TxParamsContractCall2 | TxParamsOracle1 | TxParamsOracleRegisterTx1 | TxParamsOracleExtendTx1 | TxParamsOracleQueryTx1 | TxParamsOracleResponseTx1 | TxParamsChannelCreateTx2 | TxParamsChannelCloseMutualTx1 | TxParamsChannelCloseSoloTx1 | TxParamsChannelSlashTx1 | TxParamsChannelDepositTx1 | TxParamsChannelWithdrawTx1 | TxParamsChannelSettleTx1 | TxParamsChannelForceProgressTx1 | TxParamsChannelOffChainTx2 | TxParamsChannel3 | TxParamsChannelSnapshotSoloTx1 | TxParamsChannelOffChainUpdateTransfer1 | TxParamsChannelOffChainUpdateDeposit1 | TxParamsChannelOffChainUpdateWithdraw1 | TxParamsChannelOffChainUpdateCreateContract1 | TxParamsChannelOffChainUpdateCallContract1 | TxParamsChannelClientReconnectTx1 | TxParamsTreesPoi1 | TxParamsStateTrees0 | TxParamsMtree1 | TxParamsMtreeValue1 | TxParamsContractsMtree1 | TxParamsCallsMtree1 | TxParamsChannelsMtree1 | TxParamsNameserviceMtree1 | TxParamsOraclesMtree1 | TxParamsAccountsMtree1 | TxParamsGaAttachTx1 | TxParamsGaMetaTx2 | TxParamsPayingForTx1 | TxParamsGaMetaTxAuthData1;
 /**
  * @category transaction builder
  */
-export type TxParamsAsync = TxParamsAsyncAccount1 | TxParamsAsyncAccount2 | TxParamsAsyncSignedTx1 | TxParamsAsyncSpendTx1 | TxParamsAsyncName1 | TxParamsAsyncNamePreclaimTx1 | TxParamsAsyncNameClaimTx2 | TxParamsAsyncNameUpdateTx1 | TxParamsAsyncNameTransferTx1 | TxParamsAsyncNameRevokeTx1 | TxParamsAsyncContract1 | TxParamsAsyncContractCreateTx1 | TxParamsAsyncContractCallTx1 | TxParamsAsyncContractCall2 | TxParamsAsyncOracle1 | TxParamsAsyncOracleRegisterTx1 | TxParamsAsyncOracleExtendTx1 | TxParamsAsyncOracleQueryTx1 | TxParamsAsyncOracleResponseTx1 | TxParamsAsyncChannelCreateTx2 | TxParamsAsyncChannelCloseMutualTx1 | TxParamsAsyncChannelCloseSoloTx1 | TxParamsAsyncChannelSlashTx1 | TxParamsAsyncChannelDepositTx1 | TxParamsAsyncChannelWithdrawTx1 | TxParamsAsyncChannelSettleTx1 | TxParamsAsyncChannelForceProgressTx1 | TxParamsAsyncChannelOffChainTx2 | TxParamsAsyncChannel3 | TxParamsAsyncChannelSnapshotSoloTx1 | TxParamsAsyncChannelOffChainUpdateTransfer1 | TxParamsAsyncChannelOffChainUpdateDeposit1 | TxParamsAsyncChannelOffChainUpdateWithdraw1 | TxParamsAsyncChannelOffChainUpdateCreateContract1 | TxParamsAsyncChannelOffChainUpdateCallContract1 | TxParamsAsyncChannelClientReconnectTx1 | TxParamsAsyncTreesPoi1 | TxParamsAsyncStateTrees0 | TxParamsAsyncMtree1 | TxParamsAsyncMtreeValue1 | TxParamsAsyncContractsMtree1 | TxParamsAsyncCallsMtree1 | TxParamsAsyncChannelsMtree1 | TxParamsAsyncNameserviceMtree1 | TxParamsAsyncOraclesMtree1 | TxParamsAsyncAccountsMtree1 | TxParamsAsyncGaAttachTx1 | TxParamsAsyncGaMetaTx2 | TxParamsAsyncPayingForTx1 | TxParamsAsyncGaMetaTxAuthData1;
+export type TxParamsAsync = TxParamsAsyncAccount1 | TxParamsAsyncAccount2 | TxParamsAsyncSignedTx1 | TxParamsAsyncSpendTx1 | TxParamsAsyncName1 | TxParamsAsyncNamePreclaimTx1 | TxParamsAsyncNameClaimTx2 | TxParamsAsyncNameUpdateTx1 | TxParamsAsyncNameUpdateTx2 | TxParamsAsyncNameTransferTx1 | TxParamsAsyncNameRevokeTx1 | TxParamsAsyncContract1 | TxParamsAsyncContractCreateTx1 | TxParamsAsyncContractCallTx1 | TxParamsAsyncContractCall2 | TxParamsAsyncOracle1 | TxParamsAsyncOracleRegisterTx1 | TxParamsAsyncOracleExtendTx1 | TxParamsAsyncOracleQueryTx1 | TxParamsAsyncOracleResponseTx1 | TxParamsAsyncChannelCreateTx2 | TxParamsAsyncChannelCloseMutualTx1 | TxParamsAsyncChannelCloseSoloTx1 | TxParamsAsyncChannelSlashTx1 | TxParamsAsyncChannelDepositTx1 | TxParamsAsyncChannelWithdrawTx1 | TxParamsAsyncChannelSettleTx1 | TxParamsAsyncChannelForceProgressTx1 | TxParamsAsyncChannelOffChainTx2 | TxParamsAsyncChannel3 | TxParamsAsyncChannelSnapshotSoloTx1 | TxParamsAsyncChannelOffChainUpdateTransfer1 | TxParamsAsyncChannelOffChainUpdateDeposit1 | TxParamsAsyncChannelOffChainUpdateWithdraw1 | TxParamsAsyncChannelOffChainUpdateCreateContract1 | TxParamsAsyncChannelOffChainUpdateCallContract1 | TxParamsAsyncChannelClientReconnectTx1 | TxParamsAsyncTreesPoi1 | TxParamsAsyncStateTrees0 | TxParamsAsyncMtree1 | TxParamsAsyncMtreeValue1 | TxParamsAsyncContractsMtree1 | TxParamsAsyncCallsMtree1 | TxParamsAsyncChannelsMtree1 | TxParamsAsyncNameserviceMtree1 | TxParamsAsyncOraclesMtree1 | TxParamsAsyncAccountsMtree1 | TxParamsAsyncGaAttachTx1 | TxParamsAsyncGaMetaTx2 | TxParamsAsyncPayingForTx1 | TxParamsAsyncGaMetaTxAuthData1;
 /**
  * @category transaction builder
  */
-export type TxUnpacked = TxUnpackedAccount1 | TxUnpackedAccount2 | TxUnpackedSignedTx1 | TxUnpackedSpendTx1 | TxUnpackedName1 | TxUnpackedNamePreclaimTx1 | TxUnpackedNameClaimTx2 | TxUnpackedNameUpdateTx1 | TxUnpackedNameTransferTx1 | TxUnpackedNameRevokeTx1 | TxUnpackedContract1 | TxUnpackedContractCreateTx1 | TxUnpackedContractCallTx1 | TxUnpackedContractCall2 | TxUnpackedOracle1 | TxUnpackedOracleRegisterTx1 | TxUnpackedOracleExtendTx1 | TxUnpackedOracleQueryTx1 | TxUnpackedOracleResponseTx1 | TxUnpackedChannelCreateTx2 | TxUnpackedChannelCloseMutualTx1 | TxUnpackedChannelCloseSoloTx1 | TxUnpackedChannelSlashTx1 | TxUnpackedChannelDepositTx1 | TxUnpackedChannelWithdrawTx1 | TxUnpackedChannelSettleTx1 | TxUnpackedChannelForceProgressTx1 | TxUnpackedChannelOffChainTx2 | TxUnpackedChannel3 | TxUnpackedChannelSnapshotSoloTx1 | TxUnpackedChannelOffChainUpdateTransfer1 | TxUnpackedChannelOffChainUpdateDeposit1 | TxUnpackedChannelOffChainUpdateWithdraw1 | TxUnpackedChannelOffChainUpdateCreateContract1 | TxUnpackedChannelOffChainUpdateCallContract1 | TxUnpackedChannelClientReconnectTx1 | TxUnpackedTreesPoi1 | TxUnpackedStateTrees0 | TxUnpackedMtree1 | TxUnpackedMtreeValue1 | TxUnpackedContractsMtree1 | TxUnpackedCallsMtree1 | TxUnpackedChannelsMtree1 | TxUnpackedNameserviceMtree1 | TxUnpackedOraclesMtree1 | TxUnpackedAccountsMtree1 | TxUnpackedGaAttachTx1 | TxUnpackedGaMetaTx2 | TxUnpackedPayingForTx1 | TxUnpackedGaMetaTxAuthData1;
+export type TxUnpacked = TxUnpackedAccount1 | TxUnpackedAccount2 | TxUnpackedSignedTx1 | TxUnpackedSpendTx1 | TxUnpackedName1 | TxUnpackedNamePreclaimTx1 | TxUnpackedNameClaimTx2 | TxUnpackedNameUpdateTx1 | TxUnpackedNameUpdateTx2 | TxUnpackedNameTransferTx1 | TxUnpackedNameRevokeTx1 | TxUnpackedContract1 | TxUnpackedContractCreateTx1 | TxUnpackedContractCallTx1 | TxUnpackedContractCall2 | TxUnpackedOracle1 | TxUnpackedOracleRegisterTx1 | TxUnpackedOracleExtendTx1 | TxUnpackedOracleQueryTx1 | TxUnpackedOracleResponseTx1 | TxUnpackedChannelCreateTx2 | TxUnpackedChannelCloseMutualTx1 | TxUnpackedChannelCloseSoloTx1 | TxUnpackedChannelSlashTx1 | TxUnpackedChannelDepositTx1 | TxUnpackedChannelWithdrawTx1 | TxUnpackedChannelSettleTx1 | TxUnpackedChannelForceProgressTx1 | TxUnpackedChannelOffChainTx2 | TxUnpackedChannel3 | TxUnpackedChannelSnapshotSoloTx1 | TxUnpackedChannelOffChainUpdateTransfer1 | TxUnpackedChannelOffChainUpdateDeposit1 | TxUnpackedChannelOffChainUpdateWithdraw1 | TxUnpackedChannelOffChainUpdateCreateContract1 | TxUnpackedChannelOffChainUpdateCallContract1 | TxUnpackedChannelClientReconnectTx1 | TxUnpackedTreesPoi1 | TxUnpackedStateTrees0 | TxUnpackedMtree1 | TxUnpackedMtreeValue1 | TxUnpackedContractsMtree1 | TxUnpackedCallsMtree1 | TxUnpackedChannelsMtree1 | TxUnpackedNameserviceMtree1 | TxUnpackedOraclesMtree1 | TxUnpackedAccountsMtree1 | TxUnpackedGaAttachTx1 | TxUnpackedGaMetaTx2 | TxUnpackedPayingForTx1 | TxUnpackedGaMetaTxAuthData1;

package/src/tx/builder/schema.ts

@@ -7,11 +7,12 @@
 import { Tag } from './constants';
 import SchemaTypes from './SchemaTypes';
 import {
-  uInt, shortUInt, coinAmount, name, nameId, nameFee, deposit, gasLimit, gasPrice, fee,
-  address, pointers, entry, enumeration, mptree, shortUIntConst, string, encoded, raw,
-  array, boolean, ctVersion, abiVersion, ttl, nonce, map, wrapped,
+  uInt, shortUInt, coinAmount, name, nameId, nameFee, gasLimit, gasPrice, fee, address, pointers,
+  pointers2, queryFee, entry, enumeration, mptree, shortUIntConst, string, encoded, raw,
+  array, boolean, ctVersion, abiVersion, ttl, nonce, map, withDefault, withFormatting, wrapped,
 } from './field-types';
 import { Encoded, Encoding } from '../../utils/encoder';
+import { ArgumentError } from '../../utils/errors';
 import { idTagToEncoding } from './field-types/address';
 
 export enum ORACLE_TTL_TYPES {
@@ -19,16 +20,6 @@ export enum ORACLE_TTL_TYPES {
   block = 1,
 }
 
-// # ORACLE
-export const ORACLE_TTL = { type: ORACLE_TTL_TYPES.delta, value: 500 };
-export const QUERY_TTL = { type: ORACLE_TTL_TYPES.delta, value: 10 };
-export const RESPONSE_TTL = { type: ORACLE_TTL_TYPES.delta, value: 10 };
-// # CONTRACT
-export const DRY_RUN_ACCOUNT = {
-  pub: 'ak_11111111111111111111111111111111273Yts',
-  amount: 100000000000000000000000000000000000n,
-} as const;
-
 export enum CallReturnType {
   Ok = 0,
   Error = 1,
@@ -132,6 +123,19 @@ interface MapOracles {
 
 const mapOracles = map(Encoding.OracleAddress, Tag.Oracle) as unknown as MapOracles;
 
+// TODO: inline after dropping Iris compatibility
+const clientTtl = withDefault(60 * 60, shortUInt);
+// https://github.com/aeternity/protocol/blob/fd17982/AENS.md#update
+const nameTtl = withFormatting(
+  (value) => {
+    const NAME_TTL = 180000;
+    value ??= NAME_TTL;
+    if (value >= 1 && value <= NAME_TTL) return value;
+    throw new ArgumentError('nameTtl', `a number between 1 and ${NAME_TTL} blocks`, value);
+  },
+  shortUInt,
+);
+
 /**
  * @see {@link https://github.com/aeternity/protocol/blob/c007deeac4a01e401238412801ac7084ac72d60e/serializations.md#accounts-version-1-basic-accounts}
  */
@@ -157,7 +161,8 @@ export const txSchema = [{
   tag: shortUIntConst(Tag.SpendTx),
   version: shortUIntConst(1, true),
   senderId: address(Encoding.AccountAddress),
-  recipientId: address(Encoding.AccountAddress, Encoding.Name),
+  // TODO: accept also an AENS name
+  recipientId: address(Encoding.AccountAddress, Encoding.ContractAddress, Encoding.Name),
   amount: coinAmount,
   fee,
   ttl,
@@ -195,9 +200,20 @@ export const txSchema = [{
   accountId: address(Encoding.AccountAddress),
   nonce: nonce('accountId'),
   nameId,
-  nameTtl: shortUInt,
+  nameTtl,
   pointers,
-  clientTtl: shortUInt,
+  clientTtl,
+  fee,
+  ttl,
+}, {
+  tag: shortUIntConst(Tag.NameUpdateTx),
+  version: shortUIntConst(2),
+  accountId: address(Encoding.AccountAddress),
+  nonce: nonce('accountId'),
+  nameId,
+  nameTtl,
+  pointers: pointers2,
+  clientTtl,
   fee,
   ttl,
 }, {
@@ -206,6 +222,7 @@ export const txSchema = [{
   accountId: address(Encoding.AccountAddress),
   nonce: nonce('accountId'),
   nameId,
+  // TODO: accept also an AENS name
   recipientId: address(Encoding.AccountAddress, Encoding.Name),
   fee,
   ttl,
@@ -226,7 +243,7 @@ export const txSchema = [{
   log: encoded(Encoding.ContractBytearray),
   active: boolean,
   referers: array(address(Encoding.AccountAddress)),
-  deposit,
+  deposit: coinAmount,
 }, {
   tag: shortUIntConst(Tag.ContractCreateTx),
   version: shortUIntConst(1, true),
@@ -236,7 +253,13 @@ export const txSchema = [{
   ctVersion,
   fee,
   ttl,
-  deposit,
+  deposit: withFormatting(
+    (value = 0) => {
+      if (+value === 0) return value;
+      throw new ArgumentError('deposit', 'equal 0 (because is not refundable)', value);
+    },
+    coinAmount,
+  ),
   amount: coinAmount,
   gasLimit,
   gasPrice,
@@ -246,6 +269,7 @@ export const txSchema = [{
   version: shortUIntConst(1, true),
   callerId: address(Encoding.AccountAddress),
   nonce: nonce('callerId'),
+  // TODO: accept also an AENS name
   contractId: address(Encoding.ContractAddress, Encoding.Name),
   abiVersion,
   fee,
@@ -286,18 +310,19 @@ export const txSchema = [{
   queryFormat: string,
   responseFormat: string,
   queryFee: coinAmount,
-  oracleTtlType: enumeration(ORACLE_TTL_TYPES),
-  oracleTtlValue: shortUInt,
+  oracleTtlType: withDefault(ORACLE_TTL_TYPES.delta, enumeration(ORACLE_TTL_TYPES)),
+  oracleTtlValue: withDefault(500, shortUInt),
   fee,
   ttl,
   abiVersion,
 }, {
   tag: shortUIntConst(Tag.OracleExtendTx),
   version: shortUIntConst(1, true),
+  // TODO: accept also an AENS name
   oracleId: address(Encoding.OracleAddress, Encoding.Name),
   nonce: nonce('oracleId'),
-  oracleTtlType: enumeration(ORACLE_TTL_TYPES),
-  oracleTtlValue: shortUInt,
+  oracleTtlType: withDefault(ORACLE_TTL_TYPES.delta, enumeration(ORACLE_TTL_TYPES)),
+  oracleTtlValue: withDefault(500, shortUInt),
   fee,
   ttl,
 }, {
@@ -305,13 +330,14 @@ export const txSchema = [{
   version: shortUIntConst(1, true),
   senderId: address(Encoding.AccountAddress),
   nonce: nonce('senderId'),
+  // TODO: accept also an AENS name
   oracleId: address(Encoding.OracleAddress, Encoding.Name),
   query: string,
-  queryFee: coinAmount,
-  queryTtlType: enumeration(ORACLE_TTL_TYPES),
-  queryTtlValue: shortUInt,
-  responseTtlType: enumeration(ORACLE_TTL_TYPES),
-  responseTtlValue: shortUInt,
+  queryFee,
+  queryTtlType: withDefault(ORACLE_TTL_TYPES.delta, enumeration(ORACLE_TTL_TYPES)),
+  queryTtlValue: withDefault(10, shortUInt),
+  responseTtlType: withDefault(ORACLE_TTL_TYPES.delta, enumeration(ORACLE_TTL_TYPES)),
+  responseTtlValue: withDefault(10, shortUInt),
   fee,
   ttl,
 }, {
@@ -321,8 +347,8 @@ export const txSchema = [{
   nonce: nonce('oracleId'),
   queryId: encoded(Encoding.OracleQueryId),
   response: string,
-  responseTtlType: enumeration(ORACLE_TTL_TYPES),
-  responseTtlValue: shortUInt,
+  responseTtlType: withDefault(ORACLE_TTL_TYPES.delta, enumeration(ORACLE_TTL_TYPES)),
+  responseTtlValue: withDefault(10, shortUInt),
   fee,
   ttl,
 }, {

package/src/tx/execution-cost.ts

@@ -29,10 +29,11 @@ import getTransactionSignerAddress from './transaction-signer';
  * the SDK calculates the overall price of any transaction on its side.
  *
  * @param transaction - Transaction to calculate the cost of
- * @param innerTx - Should be provided if transaction wrapped with Tag.PayingForTx
- * @param gasUsed - Amount of gas actually used to make calculation more accurate
- * @param queryFee - Oracle query fee
- * @param isInitiator - Is transaction signer an initiator of state channel
+ * @param options - Options
+ * @param options.innerTx - Should be provided if transaction wrapped with Tag.PayingForTx
+ * @param options.gasUsed - Amount of gas actually used to make calculation more accurate
+ * @param options.queryFee - Oracle query fee
+ * @param options.isInitiator - Is transaction signer an initiator of state channel
  */
 export function getExecutionCost(
   transaction: Encoded.Transaction,
@@ -122,8 +123,8 @@ export function getExecutionCostBySignedTx(
  * Calculates the cost of signed and not signed transaction execution using node
  * @param transaction - Transaction to calculate the cost of
  * @param node - Node to use
- * @param isMined - Is transaction already mined or not
  * @param options - Options
+ * @param options.isMined - Is transaction already mined or not
  */
 export async function getExecutionCostUsingNode(
   transaction: Encoded.Transaction,

package/src/tx/validator.ts

@@ -1,11 +1,11 @@
 import { RestError } from '@azure/core-rest-pipeline';
-import { hash, verify } from '../utils/crypto';
+import { hash, isAddressValid, verify } from '../utils/crypto';
 import { TxUnpacked } from './builder/schema.generated';
 import { CtVersion, ProtocolToVmAbi } from './builder/field-types/ct-version';
 import { Tag, ConsensusProtocolVersion } from './builder/constants';
 import { buildTx, unpackTx } from './builder';
 import { concatBuffers, isAccountNotFoundError } from '../utils/other';
-import { Encoded, decode } from '../utils/encoder';
+import { Encoded, Encoding, decode } from '../utils/encoder';
 import Node, { TransformNodeType } from '../Node';
 import { Account } from '../apis/node';
 import { genAggressiveCacheGetResponsesPolicy } from '../utils/autorest';
@@ -48,7 +48,7 @@ async function verifyTransactionInternal(
       })
       // TODO: remove after fixing https://github.com/aeternity/aepp-sdk-js/issues/1537
       .then((acc) => ({ ...acc, id: acc.id as Encoded.AccountAddress })),
-    node.getCurrentKeyBlockHeight(),
+    node.getCurrentKeyBlockHeight(), // TODO: don't request height on each validation, use caching
     node.getNodeInfo(),
   ]);
 
@@ -115,7 +115,7 @@ validators.push(
   },
   (tx, { height }) => {
     if (!('ttl' in tx)) return [];
-    if (tx.ttl === 0 || tx.ttl >= height) return [];
+    if (tx.ttl === 0 || tx.ttl > height) return [];
     return [{
       message: `TTL ${tx.ttl} is already expired, current height is ${height}`,
       key: 'ExpiredTTL',
@@ -132,6 +132,19 @@ validators.push(
       checkedKeys: ['amount', 'fee', 'nameFee', 'gasLimit', 'gasPrice'],
     }];
   },
+  async (tx, { node }) => {
+    if (tx.tag !== Tag.SpendTx || isAddressValid(tx.recipientId, Encoding.Name)) return [];
+    const recipient = await node.getAccountByPubkey(tx.recipientId).catch((error) => {
+      if (!isAccountNotFoundError(error)) throw error;
+      return null;
+    });
+    if (recipient == null || recipient.payable === true) return [];
+    return [{
+      message: 'Recipient account is not payable',
+      key: 'RecipientAccountNotPayable',
+      checkedKeys: ['recipientId'],
+    }];
+  },
   (tx, { account }) => {
     let message;
     if (tx.tag === Tag.SignedTx && account.kind === 'generalized' && tx.signatures.length !== 0) {
@@ -146,7 +159,7 @@ validators.push(
   // TODO: revert nonce check
   // TODO: ensure nonce valid when paying for own tx
   (tx, { consensusProtocolVersion }) => {
-    const oracleCall = Tag.Oracle === tx.tag || Tag.OracleRegisterTx === tx.tag;
+    const oracleCall = Tag.OracleRegisterTx === tx.tag;
     const contractCreate = Tag.ContractCreateTx === tx.tag || Tag.GaAttachTx === tx.tag;
     const contractCall = Tag.ContractCallTx === tx.tag || Tag.GaMetaTx === tx.tag;
     const type = (oracleCall ? 'oracle-call' : null)
@@ -176,6 +189,8 @@ validators.push(
   },
   async (tx, { node }) => {
     if (Tag.ContractCallTx !== tx.tag) return [];
+    // TODO: remove after solving https://github.com/aeternity/aeternity/issues/3669
+    if (tx.contractId.startsWith('nm_')) return [];
     try {
       const { active } = await node.getContract(tx.contractId);
       if (active) return [];
@@ -193,4 +208,15 @@ validators.push(
       }];
     }
   },
+  // TODO: move to fee field of tx builder after dropping Iris
+  (tx, { consensusProtocolVersion }) => ((
+    Tag.GaAttachTx === tx.tag
+      && ConsensusProtocolVersion.Ceres === consensusProtocolVersion
+      && tx.nonce !== 1
+  ) ? [{
+      message: `Account ${tx.ownerId} can't become generalized because it is already used`,
+      key: 'AccountUsed',
+      checkedKeys: ['nonce'],
+    }]
+    : []),
 );