@aeternity/aepp-sdk 13.3.3 → 14.1.0

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

@@ -1,18 +0,0 @@
-import field from './field';
-import { AensName } from '../constants';
-
-export default {
-  /**
-   * @param value - AENS name
-   */
-  serialize(value: AensName): Buffer {
-    return field.serialize(value);
-  },
-
-  /**
-   * @param value - AENS name
-   */
-  deserialize(value: Buffer): AensName {
-    return field.deserialize(value) as AensName;
-  },
-};

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

@@ -1,46 +0,0 @@
-import { isAccountNotFoundError } from '../../../utils/other';
-import shortUInt from './short-u-int';
-import Node from '../../../Node';
-import { ArgumentError } from '../../../utils/errors';
-import { NextNonceStrategy } from '../../../apis/node';
-
-export default function genNonceField<SenderKey extends string>(senderKey: SenderKey): {
-  serialize: (value: number) => Buffer;
-  // TODO: (value: number) => Promise<number> | (value: undefined, ...) => Promise<number>
-  prepare: (
-    value: number | undefined,
-    params: {},
-    // TODO: replace `string` with AddressEncodings
-    options: { [key in SenderKey]: string } & {
-      strategy?: NextNonceStrategy;
-      onNode?: Node;
-      _isInternalBuild?: boolean;
-    },
-  ) => Promise<number>;
-  deserialize: (value: Buffer) => number;
-  senderKey: string;
-} {
-  return {
-    ...shortUInt,
-
-    async prepare(value, params, options) {
-      if (value != null) return value;
-      // TODO: uncomment the below line
-      // if (options._isInternalBuild === true) return 0;
-      const { onNode, strategy } = options;
-      const senderId = options[senderKey];
-      const requirement = 'provided (or provide `nonce` instead)';
-      if (onNode == null) throw new ArgumentError('onNode', requirement, onNode);
-      if (senderId == null) throw new ArgumentError('senderId', requirement, senderId);
-      return (
-        await onNode.getAccountNextNonce(senderId.replace(/^ok_/, 'ak_'), { strategy })
-          .catch((error) => {
-            if (!isAccountNotFoundError(error)) throw error;
-            return { nextNonce: 1 };
-          })
-      ).nextNonce;
-    },
-
-    senderKey,
-  };
-}

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

@@ -1,41 +0,0 @@
-import { NamePointer as NamePointerString } from '../../../apis/node';
-import { toBytes } from '../../../utils/bytes';
-import { Encoded } from '../../../utils/encoder';
-import { IllegalArgumentError } from '../../../utils/errors';
-import address, { AddressEncodings, idTagToEncoding } from './address';
-
-const addressAny = address(...idTagToEncoding);
-
-// TODO: remove after fixing node types
-type NamePointer = NamePointerString & {
-  id: Encoded.Generic<AddressEncodings>;
-};
-
-export default {
-  /**
-   * Helper function to build pointers for name update TX
-   * @param pointers - Array of pointers
-   * `([ { key: 'account_pubkey', id: 'ak_32klj5j23k23j5423l434l2j3423'} ])`
-   * @returns Serialized pointers array
-   */
-  serialize(pointers: NamePointer[]): Buffer[][] {
-    if (pointers.length > 32) {
-      throw new IllegalArgumentError(`Expected 32 pointers or less, got ${pointers.length} instead`);
-    }
-
-    return pointers.map(
-      (pointer) => [toBytes(pointer.key), addressAny.serialize(pointer.id)],
-    );
-  },
-
-  /**
-   * Helper function to read pointers from name update TX
-   * @param pointers - Array of pointers
-   * @returns Deserialize pointer array
-   */
-  deserialize(pointers: Array<[key: Buffer, id: Buffer]>): NamePointer[] {
-    return pointers.map(
-      ([key, id]) => ({ key: key.toString(), id: addressAny.deserialize(id) }),
-    );
-  },
-};

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

@@ -1,62 +0,0 @@
-import { NamePointer as NamePointerString } from '../../../apis/node';
-import { toBytes } from '../../../utils/bytes';
-import {
-  Encoded, Encoding, decode, encode,
-} from '../../../utils/encoder';
-import { isAddressValid } from '../../../utils/crypto';
-import { IllegalArgumentError, DecodeError, ArgumentError } from '../../../utils/errors';
-import address, { AddressEncodings, idTagToEncoding } from './address';
-
-const ID_TAG = Buffer.from([1]);
-const DATA_TAG = Buffer.from([2]);
-const DATA_LENGTH_MAX = 1024;
-const addressAny = address(...idTagToEncoding);
-
-// TODO: remove after fixing node types
-type NamePointer = NamePointerString & {
-  id: Encoded.Generic<AddressEncodings | Encoding.Bytearray>;
-};
-
-export default {
-  /**
-   * Helper function to build pointers for name update TX
-   * @param pointers - Array of pointers
-   * `([ { key: 'account_pubkey', id: 'ak_32klj5j23k23j5423l434l2j3423'} ])`
-   * @returns Serialized pointers array
-   */
-  serialize(pointers: NamePointer[]): Buffer[][] {
-    if (pointers.length > 32) {
-      throw new IllegalArgumentError(`Expected 32 pointers or less, got ${pointers.length} instead`);
-    }
-    return pointers.map(({ key, id }) => {
-      let payload;
-      if (isAddressValid(id, ...idTagToEncoding)) payload = [ID_TAG, addressAny.serialize(id)];
-      if (isAddressValid(id, Encoding.Bytearray)) {
-        const data = decode(id);
-        if (data.length > DATA_LENGTH_MAX) {
-          throw new ArgumentError('Raw pointer', `shorter than ${DATA_LENGTH_MAX + 1} bytes`, `${data.length} bytes`);
-        }
-        payload = [DATA_TAG, data];
-      }
-      if (payload == null) throw new DecodeError(`Unknown AENS pointer value: ${id}`);
-      return [toBytes(key), Buffer.concat(payload)];
-    });
-  },
-
-  /**
-   * Helper function to read pointers from name update TX
-   * @param pointers - Array of pointers
-   * @returns Deserialize pointer array
-   */
-  deserialize(pointers: Array<[key: Buffer, id: Buffer]>): NamePointer[] {
-    return pointers.map(([bKey, bId]) => {
-      const tag = bId.subarray(0, 1);
-      const payload = bId.subarray(1);
-      let id;
-      if (tag.equals(ID_TAG)) id = addressAny.deserialize(payload);
-      if (tag.equals(DATA_TAG)) id = encode(payload, Encoding.Bytearray);
-      if (id == null) throw new DecodeError(`Unknown AENS pointer tag: ${tag}`);
-      return { key: bKey.toString(), id };
-    });
-  },
-};

package/src/tx/builder/field-types/query-fee.ts

@@ -1,25 +0,0 @@
-import coinAmount from './coin-amount';
-import { Int } from '../constants';
-import Node from '../../../Node';
-import { Encoded } from '../../../utils/encoder';
-import { ArgumentError } from '../../../utils/errors';
-
-/**
- * Oracle query fee
- */
-export default {
-  ...coinAmount,
-
-  async prepare(
-    value: Int | undefined,
-    params: {},
-    options: { oracleId?: Encoded.OracleAddress; onNode?: Node },
-  ) {
-    if (value != null) return value;
-    const { onNode, oracleId } = options;
-    const requirement = 'provided (or provide `queryFee` instead)';
-    if (onNode == null) throw new ArgumentError('onNode', requirement, onNode);
-    if (oracleId == null) throw new ArgumentError('oracleId', requirement, oracleId);
-    return (await onNode.getOracleByPubkey(oracleId)).queryFee.toString();
-  },
-};

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

@@ -1,9 +0,0 @@
-export default {
-  serialize(buffer: Uint8Array): Buffer {
-    return Buffer.from(buffer);
-  },
-
-  deserialize(buffer: Buffer): Buffer {
-    return buffer;
-  },
-};

package/src/tx/builder/field-types/short-u-int-const.ts

@@ -1,30 +0,0 @@
-import { ArgumentError } from '../../../utils/errors';
-import shortUInt from './short-u-int';
-
-export default function genShortUIntConstField<
-  Value extends number, Optional extends boolean = false,
->(constValue: Value, optional?: Optional): {
-  serialize: Optional extends true ? (value?: Value) => Buffer : (value: Value) => Buffer;
-  deserialize: (value: Buffer) => Value;
-  constValue: Value;
-  constValueOptional: boolean;
-} {
-  return {
-    serialize(value?: Value) {
-      if ((optional !== true || value != null) && value !== constValue) {
-        throw new ArgumentError('ShortUIntConst', constValue, value);
-      }
-      return shortUInt.serialize(constValue);
-    },
-
-    deserialize(buf) {
-      const value = shortUInt.deserialize(buf);
-      if (value !== constValue) throw new ArgumentError('ShortUIntConst', constValue, value);
-      return constValue;
-    },
-
-    constValue,
-
-    constValueOptional: optional === true,
-  };
-}

package/src/tx/builder/field-types/short-u-int.ts

@@ -1,11 +0,0 @@
-import uInt from './u-int';
-
-export default {
-  serialize(value: number): Buffer {
-    return uInt.serialize(value);
-  },
-
-  deserialize(value: Buffer): number {
-    return +uInt.deserialize(value);
-  },
-};

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

@@ -1,11 +0,0 @@
-import { toBytes } from '../../../utils/bytes';
-
-export default {
-  serialize(string: string): Buffer {
-    return toBytes(string);
-  },
-
-  deserialize(buffer: Buffer): string {
-    return buffer.toString();
-  },
-};

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

@@ -1,34 +0,0 @@
-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,
-
-  serialize(value: number | undefined): Buffer {
-    return shortUInt.serialize(value ?? 0);
-  },
-
-  async prepare(
-    value: number | undefined,
-    params: {},
-    // TODO: { absoluteTtl: true } | { absoluteTtl: false, onNode: Node }
-    {
-      onNode, absoluteTtl, _isInternalBuild, ...options
-    }: {
-      onNode?: Node;
-      absoluteTtl?: boolean;
-      _isInternalBuild?: boolean;
-    } & Omit<Parameters<typeof _getPollInterval>[1], 'onNode'>,
-  ) {
-    if (absoluteTtl !== true && value !== 0 && (value != null || _isInternalBuild === true)) {
-      if (onNode == null) throw new ArgumentError('onNode', 'provided', onNode);
-      value = (value ?? 3) + await getHeight({ ...options, onNode, cached: true });
-    }
-    return value;
-  },
-};

package/src/tx/builder/field-types/u-int.ts

@@ -1,15 +0,0 @@
-import { readInt } from '../helpers';
-import { Int } from '../constants';
-import { ArgumentError } from '../../../utils/errors';
-import { toBytes } from '../../../utils/bytes';
-
-export default {
-  serialize(value: Int): Buffer {
-    if (Number(value) < 0) throw new ArgumentError('value', 'greater or equal to 0', value);
-    return toBytes(value, true);
-  },
-
-  deserialize(value: Buffer): string {
-    return readInt(value);
-  },
-};

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

@@ -1,18 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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/field-types/wrapped.ts

@@ -1,32 +0,0 @@
-import { Tag } from '../constants';
-import { encode, Encoding, decode } from '../../../utils/encoder';
-import type { unpackTx as unpackTxType, buildTx as buildTxType } from '../index';
-
-type TagWrapping = Tag.AccountsMtree | Tag.CallsMtree | Tag.ChannelsMtree | Tag.ContractsMtree
-| Tag.NameserviceMtree | Tag.OraclesMtree;
-
-export default function genWrappedField<T extends TagWrapping>(tag: T): {
-  serialize: (
-    // TODO: replace with `(TxParams & { tag: T })['payload']`,
-    //  but fix TS2502 value is referenced directly or indirectly in its own type annotation
-    value: any, options: { buildTx: typeof buildTxType }
-  ) => Buffer;
-  deserialize: (
-    value: Buffer, options: { unpackTx: typeof unpackTxType },
-    // TODO: replace with `(TxUnpacked & { tag: T })['payload']`,
-    //  TS2577 Return type annotation circularly references itself
-  ) => any;
-  recursiveType: true;
-} {
-  return {
-    serialize(payload, { buildTx }) {
-      return decode(buildTx({ tag, payload }));
-    },
-
-    deserialize(buffer, { unpackTx }) {
-      return unpackTx<TagWrapping>(encode(buffer, Encoding.Transaction), tag).payload;
-    },
-
-    recursiveType: true,
-  };
-}

package/src/tx/builder/helpers.ts

@@ -1,252 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { genSalt, hash } from '../../utils/crypto';
-import {
-  decode, encode, Encoded, Encoding,
-} from '../../utils/encoder';
-import { toBytes } from '../../utils/bytes';
-import { concatBuffers } from '../../utils/other';
-import {
-  AensName,
-  NAME_BID_RANGES,
-  NAME_BID_TIMEOUT_BLOCKS,
-  NAME_FEE_BID_INCREMENT,
-  NAME_MAX_LENGTH_FEE,
-} from './constants';
-import { ceil } from '../../utils/bignumber';
-import { ArgumentError, IllegalBidFeeError } from '../../utils/errors';
-
-/**
- * JavaScript-based Transaction builder helper function's
- */
-
-/**
- * Build a contract public key
- * @category contract
- * @param ownerId - The public key of the owner account
- * @param nonce - the nonce of the transaction
- * @returns Contract public key
- */
-export function buildContractId(
-  ownerId: Encoded.AccountAddress,
-  nonce: number | BigNumber,
-): Encoded.ContractAddress {
-  const ownerIdAndNonce = Buffer.from([...decode(ownerId), ...toBytes(nonce)]);
-  const b2bHash = hash(ownerIdAndNonce);
-  return encode(b2bHash, Encoding.ContractAddress);
-}
-
-/**
- * Build a oracle query id
- * @category oracle
- * @param senderId - The public key of the sender account
- * @param nonce - the nonce of the transaction
- * @param oracleId - The oracle public key
- * @returns Contract public key
- */
-export function oracleQueryId(
-  senderId: Encoded.AccountAddress,
-  nonce: number | BigNumber | string,
-  oracleId: Encoded.OracleAddress,
-): Encoded.OracleQueryId {
-  function _int32(val: number | string | BigNumber): Buffer {
-    const nonceBE = toBytes(val, true);
-    return concatBuffers([Buffer.alloc(32 - nonceBE.length), nonceBE]);
-  }
-
-  const b2bHash = hash(
-    Buffer.from([...decode(senderId), ..._int32(nonce), ...decode(oracleId)]),
-  );
-  return encode(b2bHash, Encoding.OracleQueryId);
-}
-
-const AENS_SUFFIX = '.chain';
-
-export function nameToPunycode(maybeName: string): AensName {
-  const [name, suffix, ...other] = maybeName.split('.');
-  if (other.length !== 0) throw new ArgumentError('aens name', 'including only one dot', maybeName);
-  if (suffix !== AENS_SUFFIX.slice(1)) {
-    throw new ArgumentError('aens name', `suffixed with ${AENS_SUFFIX}`, maybeName);
-  }
-  if (/\p{Emoji_Presentation}/u.test(name)) {
-    throw new ArgumentError('aens name', 'not containing emoji', maybeName);
-  }
-  if (name[2] === '-' && name[3] === '-') {
-    throw new ArgumentError('aens name', 'without "-" char in both the third and fourth positions', maybeName);
-  }
-  if (name[0] === '-') {
-    throw new ArgumentError('aens name', 'starting with no "-" char', maybeName);
-  }
-  if (name.at(-1) === '-') {
-    throw new ArgumentError('aens name', 'ending with no "-" char', maybeName);
-  }
-  let punycode;
-  try {
-    const u = new URL(`http://${name}.${suffix}`);
-    if (u.username + u.password + u.port + u.search + u.hash !== '' || u.pathname !== '/') {
-      throw new ArgumentError('aens name', 'valid', maybeName);
-    }
-    punycode = u.host;
-  } catch (error) {
-    if (error instanceof TypeError && error.message.includes('Invalid URL')) {
-      throw new ArgumentError('aens name', 'valid', maybeName);
-    }
-    throw error;
-  }
-  if (!/^[a-z0-9.-]+$/i.test(punycode)) {
-    throw new ArgumentError('aens name', 'without illegal chars', maybeName);
-  }
-  if (punycode.length > 63 + AENS_SUFFIX.length) {
-    throw new ArgumentError('aens name', 'not too long', maybeName);
-  }
-  return punycode as AensName;
-}
-
-/**
- * Encode an AENS name
- * @category AENS
- * @param name - Name to encode
- * @returns `nm_` prefixed encoded AENS name
- */
-export function produceNameId(name: AensName): Encoded.Name {
-  return encode(hash(nameToPunycode(name)), Encoding.Name);
-}
-
-/**
- * Generate the commitment hash by hashing the salt and
- * name, base 58 encoding the result and prepending 'cm_'
- * @category transaction builder
- * @param name - Name to be registered
- * @param salt - Random number
- * @returns Commitment hash
- */
-export function commitmentHash(
-  name: AensName,
-  salt: number = genSalt(),
-): Encoded.Commitment {
-  return encode(
-    hash(concatBuffers([
-      Buffer.from(nameToPunycode(name)),
-      Buffer.from(salt.toString(16).padStart(64, '0'), 'hex'),
-    ])),
-    Encoding.Commitment,
-  );
-}
-
-/**
- * Utility function to convert bytes to int
- * @category transaction builder
- * @param buf - Value
- * @returns Buffer Buffer from number(BigEndian)
- */
-export function readInt(buf: Buffer = Buffer.from([])): string {
-  return new BigNumber(Buffer.from(buf).toString('hex'), 16).toString(10);
-}
-
-/**
- * Ensure that name is valid AENS name, would throw an exception otherwise
- * @category AENS
- * @param maybeName - AENS name
- */
-export function ensureName(maybeName: string): asserts maybeName is AensName {
-  nameToPunycode(maybeName);
-}
-
-/**
- * Is AENS name valid
- * @category AENS
- * @param maybeName - AENS name
- */
-// TODO: consider renaming to isName
-export function isNameValid(maybeName: string): maybeName is AensName {
-  try {
-    ensureName(maybeName);
-    return true;
-  } catch (error) {
-    return false;
-  }
-}
-
-const encodingToPointerKey = [
-  [Encoding.AccountAddress, 'account_pubkey'],
-  [Encoding.OracleAddress, 'oracle_pubkey'],
-  [Encoding.ContractAddress, 'contract_pubkey'],
-  [Encoding.Channel, 'channel'],
-] as const;
-
-/**
- * @category AENS
- * @param identifier - account/oracle/contract address, or channel
- * @returns default AENS pointer key
- */
-export function getDefaultPointerKey(
-  identifier: Encoded.Generic<typeof encodingToPointerKey[number][0]>,
-): typeof encodingToPointerKey[number][1] {
-  decode(identifier);
-  const encoding = identifier.substring(0, 2);
-  const result = encodingToPointerKey.find(([e]) => e === encoding)?.[1];
-  if (result != null) return result;
-  throw new ArgumentError(
-    'identifier',
-    `prefixed with one of ${encodingToPointerKey.map(([e]) => `${e}_`).join(', ')}`,
-    identifier,
-  );
-}
-
-/**
- * Get the minimum AENS name fee
- * @category AENS
- * @param name - the AENS name to get the fee for
- * @returns the minimum fee for the AENS name auction
- */
-export function getMinimumNameFee(name: AensName): BigNumber {
-  const nameLength = nameToPunycode(name).length - AENS_SUFFIX.length;
-  return NAME_BID_RANGES[Math.min(nameLength, NAME_MAX_LENGTH_FEE)];
-}
-
-/**
- * Compute bid fee for AENS auction
- * @category AENS
- * @param name - the AENS name to get the fee for
- * @param options - Options
- * @param options.startFee - Auction start fee
- * @param options.increment - Bid multiplier(In percentage, must be between 0 and 1)
- * @returns Bid fee
- */
-export function computeBidFee(
-  name: AensName,
-  { startFee, increment = NAME_FEE_BID_INCREMENT }:
-  { startFee?: number | string | BigNumber; increment?: number } = {},
-): BigNumber {
-  if (!(Number(increment) === increment && increment % 1 !== 0)) throw new IllegalBidFeeError(`Increment must be float. Current increment ${increment}`);
-  if (increment < NAME_FEE_BID_INCREMENT) throw new IllegalBidFeeError(`minimum increment percentage is ${NAME_FEE_BID_INCREMENT}`);
-  // FIXME: increment should be used somehow here
-  return ceil(
-    new BigNumber(startFee ?? getMinimumNameFee(name))
-      .times(new BigNumber(NAME_FEE_BID_INCREMENT).plus(1)),
-  );
-}
-
-/**
- * Compute auction end height
- * @category AENS
- * @param name - Name to compute auction end for
- * @param claimHeight - Auction starting height
- * @see {@link https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L273}
- * @returns Auction end height
- */
-export function computeAuctionEndBlock(name: AensName, claimHeight: number): number {
-  const length = nameToPunycode(name).length - AENS_SUFFIX.length;
-  const h = (length <= 4 ? 62 * NAME_BID_TIMEOUT_BLOCKS : null)
-    ?? (length <= 8 ? 31 * NAME_BID_TIMEOUT_BLOCKS : null)
-    ?? (length <= 12 ? NAME_BID_TIMEOUT_BLOCKS : null)
-    ?? 0;
-  return h + claimHeight;
-}
-
-/**
- * Is name accept going to auction
- * @category AENS
- */
-export function isAuctionName(name: AensName): boolean {
-  return nameToPunycode(name).length < 13 + AENS_SUFFIX.length;
-}