@aeternity/aepp-sdk 13.3.2 → 14.0.0

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

@@ -1,143 +0,0 @@
-/* eslint-disable */
-// This file generated by `npm run build:generate`, don't edit manually.
-
-import { DlgParams as DlgParamsComplex, DlgUnpacked as DlgUnpackedComplex } from "./schema";
-import { DelegationTag as Tag } from "./schema";
-/**
- * @category delegation signature
- */
-type DlgParamsAensWildcard1Type = Omit<DlgParamsComplex & {
-    tag: Tag.AensWildcard;
-    version: 1;
-}, "version"> & {
-    version?: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgParamsAensWildcard1 extends DlgParamsAensWildcard1Type {
-}
-/**
- * @category delegation signature
- */
-type DlgUnpackedAensWildcard1Type = DlgUnpackedComplex & {
-    tag: Tag.AensWildcard;
-    version: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgUnpackedAensWildcard1 extends DlgUnpackedAensWildcard1Type {
-}
-/**
- * @category delegation signature
- */
-type DlgParamsAensName1Type = Omit<DlgParamsComplex & {
-    tag: Tag.AensName;
-    version: 1;
-}, "version"> & {
-    version?: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgParamsAensName1 extends DlgParamsAensName1Type {
-}
-/**
- * @category delegation signature
- */
-type DlgUnpackedAensName1Type = DlgUnpackedComplex & {
-    tag: Tag.AensName;
-    version: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgUnpackedAensName1 extends DlgUnpackedAensName1Type {
-}
-/**
- * @category delegation signature
- */
-type DlgParamsAensPreclaim1Type = Omit<DlgParamsComplex & {
-    tag: Tag.AensPreclaim;
-    version: 1;
-}, "version"> & {
-    version?: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgParamsAensPreclaim1 extends DlgParamsAensPreclaim1Type {
-}
-/**
- * @category delegation signature
- */
-type DlgUnpackedAensPreclaim1Type = DlgUnpackedComplex & {
-    tag: Tag.AensPreclaim;
-    version: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgUnpackedAensPreclaim1 extends DlgUnpackedAensPreclaim1Type {
-}
-/**
- * @category delegation signature
- */
-type DlgParamsOracle1Type = Omit<DlgParamsComplex & {
-    tag: Tag.Oracle;
-    version: 1;
-}, "version"> & {
-    version?: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgParamsOracle1 extends DlgParamsOracle1Type {
-}
-/**
- * @category delegation signature
- */
-type DlgUnpackedOracle1Type = DlgUnpackedComplex & {
-    tag: Tag.Oracle;
-    version: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgUnpackedOracle1 extends DlgUnpackedOracle1Type {
-}
-/**
- * @category delegation signature
- */
-type DlgParamsOracleResponse1Type = Omit<DlgParamsComplex & {
-    tag: Tag.OracleResponse;
-    version: 1;
-}, "version"> & {
-    version?: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgParamsOracleResponse1 extends DlgParamsOracleResponse1Type {
-}
-/**
- * @category delegation signature
- */
-type DlgUnpackedOracleResponse1Type = DlgUnpackedComplex & {
-    tag: Tag.OracleResponse;
-    version: 1;
-};
-/**
- * @category delegation signature
- */
-export interface DlgUnpackedOracleResponse1 extends DlgUnpackedOracleResponse1Type {
-}
-/**
- * @category delegation signature
- */
-export type DlgParams = DlgParamsAensWildcard1 | DlgParamsAensName1 | DlgParamsAensPreclaim1 | DlgParamsOracle1 | DlgParamsOracleResponse1;
-/**
- * @category delegation signature
- */
-export type DlgUnpacked = DlgUnpackedAensWildcard1 | DlgUnpackedAensName1 | DlgUnpackedAensPreclaim1 | DlgUnpackedOracle1 | DlgUnpackedOracleResponse1;

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

@@ -1,61 +0,0 @@
-import SchemaTypes from '../SchemaTypes';
-import { address, nameId, shortUIntConst } from '../field-types';
-import {
-  Encoded, Encoding, decode, encode,
-} from '../../../utils/encoder';
-
-/**
- * @category delegation signature
- */
-export enum DelegationTag {
-  AensWildcard = 1,
-  AensName = 2,
-  AensPreclaim = 3,
-  Oracle = 4,
-  OracleResponse = 5,
-}
-
-const oracleAddressField = address(Encoding.OracleAddress);
-const queryIdField = {
-  serialize(value: Encoded.OracleQueryId): Buffer {
-    return oracleAddressField.serialize(encode(decode(value), Encoding.OracleAddress));
-  },
-  deserialize(value: Buffer): Encoded.OracleQueryId {
-    return encode(decode(oracleAddressField.deserialize(value)), Encoding.OracleQueryId);
-  },
-} as const;
-
-/**
- * @see {@link https://github.com/aeternity/protocol/blob/8a9d1d1206174627f6aaef86159dc9c643080653/contracts/fate.md#from-ceres-serialized-signature-data}
- */
-export const schemas = [{
-  tag: shortUIntConst(DelegationTag.AensWildcard),
-  version: shortUIntConst(1, true),
-  accountAddress: address(Encoding.AccountAddress),
-  contractAddress: address(Encoding.ContractAddress),
-}, {
-  tag: shortUIntConst(DelegationTag.AensName),
-  version: shortUIntConst(1, true),
-  accountAddress: address(Encoding.AccountAddress),
-  nameId,
-  contractAddress: address(Encoding.ContractAddress),
-}, {
-  tag: shortUIntConst(DelegationTag.AensPreclaim),
-  version: shortUIntConst(1, true),
-  accountAddress: address(Encoding.AccountAddress),
-  contractAddress: address(Encoding.ContractAddress),
-}, {
-  tag: shortUIntConst(DelegationTag.Oracle),
-  version: shortUIntConst(1, true),
-  accountAddress: address(Encoding.AccountAddress),
-  contractAddress: address(Encoding.ContractAddress),
-}, {
-  tag: shortUIntConst(DelegationTag.OracleResponse),
-  version: shortUIntConst(1, true),
-  queryId: queryIdField,
-  contractAddress: address(Encoding.ContractAddress),
-}] as const;
-
-type Schemas = SchemaTypes<typeof schemas>;
-export type DlgParams = Schemas['TxParams'];
-export type DlgUnpacked = Schemas['TxUnpacked'];

package/src/tx/builder/field-types/abi-version.ts

@@ -1,44 +0,0 @@
-import { Tag, ConsensusProtocolVersion, AbiVersion } from '../constants';
-import { getProtocolDetails } from './ct-version';
-import Node from '../../../Node';
-
-export default {
-  _getProtocolDetails(c: ConsensusProtocolVersion, tag: Tag): AbiVersion {
-    const kind = Tag.ContractCallTx === tag || Tag.GaMetaTx === tag
-      ? 'contract-call' : 'oracle-call';
-    return getProtocolDetails(c, kind).abiVersion;
-  },
-
-  serialize(
-    value: AbiVersion | undefined,
-    { tag }: { tag: Tag },
-    { consensusProtocolVersion = ConsensusProtocolVersion.Iris }:
-    { consensusProtocolVersion?: ConsensusProtocolVersion },
-  ): Buffer {
-    const result = value ?? this._getProtocolDetails(consensusProtocolVersion, tag);
-
-    return Buffer.from([result]);
-  },
-
-  async prepare(
-    value: AbiVersion | undefined,
-    { tag }: { tag: Tag },
-    // TODO: { consensusProtocolVersion: ConsensusProtocolVersion } | { onNode: Node } | {}
-    options: { consensusProtocolVersion?: ConsensusProtocolVersion; onNode?: Node },
-  ): Promise<AbiVersion | undefined> {
-    if (value != null) return value;
-    if (options.consensusProtocolVersion != null) return undefined;
-    if (Object.keys(ConsensusProtocolVersion).length === 2) return undefined;
-    if (options.onNode != null) {
-      return this._getProtocolDetails(
-        (await options.onNode.getNodeInfo()).consensusProtocolVersion,
-        tag,
-      );
-    }
-    return undefined;
-  },
-
-  deserialize(buffer: Buffer): AbiVersion {
-    return buffer[0];
-  },
-};

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

@@ -1,62 +0,0 @@
-import { ArgumentError, PrefixNotFoundError, TagNotFoundError } from '../../../utils/errors';
-import { toBytes } from '../../../utils/bytes';
-import {
-  decode, encode, Encoded, Encoding,
-} from '../../../utils/encoder';
-import { isItemOfArray } from '../../../utils/other';
-
-/**
- * Map of prefix to ID tag constant
- * @see {@link https://github.com/aeternity/protocol/blob/master/serializations.md#the-id-type}
- * @see {@link https://github.com/aeternity/aeserialization/blob/eb68fe331bd476910394966b7f5ede7a74d37e35/src/aeser_id.erl#L97-L102}
- * @see {@link https://github.com/aeternity/aeserialization/blob/eb68fe331bd476910394966b7f5ede7a74d37e35/src/aeser_api_encoder.erl#L163-L168}
- */
-export const idTagToEncoding = [
-  Encoding.AccountAddress,
-  Encoding.Name,
-  Encoding.Commitment,
-  Encoding.OracleAddress,
-  Encoding.ContractAddress,
-  Encoding.Channel,
-] as const;
-
-export type AddressEncodings = typeof idTagToEncoding[number];
-
-export default function genAddressField<Encoding extends AddressEncodings>(
-  ...encodings: Encoding[]
-): {
-    serialize: (value: Encoded.Generic<Encoding>) => Buffer;
-    deserialize: (value: Buffer) => Encoded.Generic<Encoding>;
-  } {
-  return {
-    /**
-     * Utility function to create and _id type
-     * @param hashId - Encoded hash
-     * @returns Buffer Buffer with ID tag and decoded HASh
-     */
-    serialize(hashId) {
-      const enc = hashId.slice(0, 2);
-      if (!isItemOfArray(enc, idTagToEncoding)) throw new TagNotFoundError(enc);
-      if (!isItemOfArray(enc, encodings)) {
-        throw new ArgumentError('Address encoding', encodings.join(', '), enc);
-      }
-      const idTag = idTagToEncoding.indexOf(enc) + 1;
-      return Buffer.from([...toBytes(idTag), ...decode(hashId)]);
-    },
-
-    /**
-     * Utility function to read and _id type
-     * @param buf - Data
-     * @returns Encoded hash string with prefix
-     */
-    deserialize(buf) {
-      const idTag = Buffer.from(buf).readUIntBE(0, 1);
-      const enc = idTagToEncoding[idTag - 1];
-      if (enc == null) throw new PrefixNotFoundError(idTag);
-      if (!isItemOfArray(enc, encodings)) {
-        throw new ArgumentError('Address encoding', encodings.join(', '), enc);
-      }
-      return encode(buf.subarray(1), enc) as Encoded.Generic<Encoding>;
-    },
-  };
-}

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

@@ -1,19 +0,0 @@
-export default function genArrayField<Input, Output, Binary>(
-  itemHandler: {
-    serialize: (value: Input, params: unknown) => Binary;
-    deserialize: (value: Binary, params: unknown) => Output;
-  },
-): {
-    serialize: (value: readonly Input[], params: unknown) => Binary[];
-    deserialize: (value: Binary[], params: unknown) => Output[];
-  } {
-  return {
-    serialize(items, params) {
-      return items.map((item) => itemHandler.serialize(item, params));
-    },
-
-    deserialize(buffers, params) {
-      return buffers.map((buffer) => itemHandler.deserialize(buffer, params));
-    },
-  };
-}

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

@@ -1,9 +0,0 @@
-export default {
-  serialize(value: boolean): Buffer {
-    return Buffer.from([value ? 1 : 0]);
-  },
-
-  deserialize(buffer: Buffer): boolean {
-    return buffer[0] === 1;
-  },
-};

package/src/tx/builder/field-types/coin-amount.ts

@@ -1,26 +0,0 @@
-import uInt from './u-int';
-import { Int } from '../constants';
-import { AE_AMOUNT_FORMATS, formatAmount } from '../../../utils/amount-formatter';
-
-export default {
-  ...uInt,
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  serializeAettos(value: string | undefined, params: {}, options: {}): string {
-    return value ?? '0';
-  },
-
-  serialize(
-    value: Int | undefined,
-    params: {},
-    { denomination = AE_AMOUNT_FORMATS.AETTOS, ...options }: { denomination?: AE_AMOUNT_FORMATS },
-  ): Buffer {
-    return uInt.serialize(
-      this.serializeAettos(
-        value != null ? formatAmount(value, { denomination }) : value,
-        params,
-        options,
-      ),
-    );
-  },
-};

package/src/tx/builder/field-types/ct-version.ts

@@ -1,83 +0,0 @@
-import { ConsensusProtocolVersion, VmVersion, AbiVersion } from '../constants';
-import Node from '../../../Node';
-
-/*
- * First abi/vm by default
- * @see {@link https://github.com/aeternity/protocol/blob/71cf111/contracts/contract_vms.md#virtual-machines-on-the-æternity-blockchain}
- */
-export const ProtocolToVmAbi = {
-  [ConsensusProtocolVersion.Iris]: {
-    'contract-create': {
-      vmVersion: [VmVersion.Fate2], abiVersion: [AbiVersion.Fate],
-    },
-    'contract-call': {
-      vmVersion: [], abiVersion: [AbiVersion.Fate, AbiVersion.Sophia],
-    },
-    'oracle-call': {
-      vmVersion: [], abiVersion: [AbiVersion.NoAbi, AbiVersion.Fate],
-    },
-  },
-  [ConsensusProtocolVersion.Ceres]: {
-    'contract-create': {
-      vmVersion: [VmVersion.Fate3], abiVersion: [AbiVersion.Fate],
-    },
-    'contract-call': {
-      vmVersion: [], abiVersion: [AbiVersion.Fate],
-    },
-    'oracle-call': {
-      vmVersion: [], abiVersion: [AbiVersion.NoAbi, AbiVersion.Fate],
-    },
-  },
-} as const;
-
-export interface CtVersion {
-  vmVersion: VmVersion;
-  abiVersion: AbiVersion;
-}
-
-export function getProtocolDetails(
-  protocolVersion: ConsensusProtocolVersion,
-  type: 'contract-create' | 'contract-call' | 'oracle-call',
-): CtVersion {
-  const protocol = ProtocolToVmAbi[protocolVersion][type];
-  return {
-    vmVersion: protocol.vmVersion[0] ?? VmVersion.Fate2,
-    abiVersion: protocol.abiVersion[0],
-  };
-}
-
-export default {
-  serialize(
-    value: CtVersion | undefined,
-    params: {},
-    { consensusProtocolVersion = ConsensusProtocolVersion.Iris }:
-    { consensusProtocolVersion?: ConsensusProtocolVersion },
-  ): Buffer {
-    value ??= getProtocolDetails(consensusProtocolVersion, 'contract-create');
-
-    return Buffer.from([value.vmVersion, 0, value.abiVersion]);
-  },
-
-  async prepare(
-    value: CtVersion | undefined,
-    params: {},
-    // TODO: { consensusProtocolVersion: ConsensusProtocolVersion } | { onNode: Node } | {}
-    options: { consensusProtocolVersion?: ConsensusProtocolVersion; onNode?: Node },
-  ): Promise<CtVersion | undefined> {
-    if (value != null) return value;
-    if (options.consensusProtocolVersion != null) return undefined;
-    if (Object.keys(ConsensusProtocolVersion).length === 2) return undefined;
-    if (options.onNode != null) {
-      return getProtocolDetails(
-        (await options.onNode.getNodeInfo()).consensusProtocolVersion,
-        'contract-create',
-      );
-    }
-    return undefined;
-  },
-
-  deserialize(buffer: Buffer): CtVersion {
-    const [vm, , abi] = buffer;
-    return { vmVersion: +vm, abiVersion: +abi };
-  },
-};

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

@@ -1,27 +0,0 @@
-import {
-  decode, encode, Encoded, Encoding,
-} from '../../../utils/encoder';
-import { ArgumentError } from '../../../utils/errors';
-
-export default function genEncodedField<E extends Encoding, Optional extends boolean = false>(
-  encoding: E,
-  optional?: Optional,
-): {
-    serialize: Optional extends true
-      ? (value?: Encoded.Generic<E>) => Buffer : (value: Encoded.Generic<E>) => Buffer;
-    deserialize: (value: Buffer) => Encoded.Generic<E>;
-  } {
-  return {
-    serialize(encodedData?: Encoded.Generic<E>) {
-      if (encodedData == null) {
-        if (optional === true) return Buffer.from([]);
-        throw new ArgumentError('Encoded data', 'provided', encodedData);
-      }
-      return decode(encodedData);
-    },
-
-    deserialize(buffer) {
-      return encode(buffer, encoding);
-    },
-  };
-}

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

@@ -1,33 +0,0 @@
-import {
-  decode, encode, Encoded, Encoding,
-} from '../../../utils/encoder';
-import { Tag } from '../constants';
-import type { unpackTx as unpackTxType, buildTx as buildTxType } from '../index';
-
-export default function genEntryField<T extends Tag = Tag>(tag?: T): {
-  serialize: (
-    // TODO: replace with `TxParams & { tag: T }`,
-    //  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 }`,
-    //  TS2577 Return type annotation circularly references itself
-  ) => any;
-} {
-  return {
-    serialize(txParams, { buildTx }) {
-      if (ArrayBuffer.isView(txParams)) return Buffer.from(txParams as any);
-      if (typeof txParams === 'string' && txParams.startsWith('tx_')) {
-        return decode(txParams as Encoded.Transaction);
-      }
-      return decode(buildTx({ ...txParams, ...tag != null && { tag } }));
-    },
-
-    deserialize(buf, { unpackTx }) {
-      return unpackTx(encode(buf, Encoding.Transaction), tag);
-    },
-  };
-}

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

@@ -1,32 +0,0 @@
-import { ArgumentError } from '../../../utils/errors';
-import { isItemOfArray } from '../../../utils/other';
-
-export default function genEnumerationField<
-  Enum extends { [key: string]: number | string },
->(enm: Enum): {
-  serialize: (value: Enum[keyof Enum]) => Buffer;
-  deserialize: (value: Buffer) => Enum[keyof Enum];
-} {
-  const values = Object.values(enm).filter((v) => typeof v === 'number');
-  return {
-    serialize(value) {
-      if (typeof value !== 'number') throw new ArgumentError('value', 'to be a number', value);
-      if (value > 0xff) throw new ArgumentError('value', 'to be less than 256', value);
-      if (!isItemOfArray(value, values)) {
-        throw new ArgumentError('value', 'to be a value of Enum', value);
-      }
-      return Buffer.from([value]);
-    },
-
-    deserialize(buffer) {
-      if (buffer.length !== 1) {
-        throw new ArgumentError('buffer', 'to have single element', buffer.length);
-      }
-      const value = buffer[0];
-      if (!isItemOfArray(value, values)) {
-        throw new ArgumentError('value', 'to be a value of Enum', value);
-      }
-      return value as Enum[keyof Enum];
-    },
-  };
-}