@aeternity/aepp-sdk 12.1.3 → 13.0.0-alpha.1

package/src/contract/methods.ts

@@ -1,123 +0,0 @@
-/*
- * ISC License (ISC)
- * Copyright (c) 2022 aeternity developers
- *
- *  Permission to use, copy, modify, and/or distribute this software for any
- *  purpose with or without fee is hereby granted, provided that the above
- *  copyright notice and this permission notice appear in all copies.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- *  PERFORMANCE OF THIS SOFTWARE.
- */
-
-/**
- * Contract module - routines to interact with the æternity contract
- *
- * High level documentation of the contracts are available at
- * https://github.com/aeternity/protocol/tree/master/contracts and
- */
-
-import { AensName } from '../tx/builder/constants';
-import { produceNameId } from '../tx/builder/helpers';
-import { concatBuffers } from '../utils/other';
-import { decode, Encoded } from '../utils/encoder';
-import AccountBase from '../account/Base';
-import Node from '../Node';
-
-export { default as getContractInstance } from './aci';
-
-/**
- * Utility method to create a delegate signature for a contract
- * @category contract
- * @param ids - The list of id's to prepend
- * @param opt - Options
- * @param opt.onNode - Node to use
- * @param opt.onAccount - Account to use
- * @returns Signature in hex representation
- */
-async function delegateSignatureCommon(
-  ids: Encoded.Any[],
-  { onAccount, onNode, ...opt }:
-  { onAccount: AccountBase; onNode: Node } & Parameters<AccountBase['sign']>[1],
-): Promise<string> {
-  const signature = await onAccount.sign(
-    concatBuffers([
-      Buffer.from((await onNode.getStatus()).networkId),
-      ...ids.map((e) => decode(e)),
-    ]),
-    opt,
-  );
-  return Buffer.from(signature).toString('hex');
-}
-
-/**
- * Helper to generate a signature to delegate pre-claim/claim/transfer/revoke of a name to
- * a contract.
- * @category contract
- * @param contractId - Contract Id
- * @param opt - Options
- * @param opt.name - The name
- * @returns Signature for delegation
- * @example
- * ```js
- * const aeSdk = new AeSdk({ ... })
- * const contractId = 'ct_asd2ks...' // contract address
- * const name = 'example.chain' // AENS name
- * const onAccount = await aeSdk.address() // Sign with a specific account
- * // Preclaim signature
- * const preclaimSig = await aeSdk.createAensDelegationSignature(contractId, { onAccount: current })
- * // Claim, transfer and revoke signature
- * const aensDelegationSig = await contract.createAensDelegationSignature(
- *   contractId, { name, onAccount: current }
- * )
- * ```
- */
-export async function createAensDelegationSignature(
-  contractId: Encoded.ContractAddress,
-  opt: Parameters<AccountBase['address']>[0] & Parameters<typeof delegateSignatureCommon>[1] &
-  { name?: AensName },
-): Promise<string> {
-  return delegateSignatureCommon(
-    [
-      await opt.onAccount.address(opt),
-      ...opt.name != null ? [produceNameId(opt.name)] : [],
-      contractId,
-    ],
-    opt,
-  );
-}
-
-/**
- * Helper to generate a signature to delegate register/extend/respond of a Oracle to a contract.
- * @category contract
- * @param contractId - Contract Id
- * @param opt - Options
- * @param opt.queryId - Oracle Query Id
- * @returns Signature for delegation
- * @example
- * ```js
- * const aeSdk = new AeSdk({ ... })
- * const contractId = 'ct_asd2ks...' // contract address
- * const queryId = 'oq_...' // Oracle Query Id
- * const onAccount = await aeSdk.address() // Sign with a specific account
- * // Oracle register and extend signature
- * const oracleDelegationSig = await aeSdk.createOracleDelegationSignature(contractId)
- * // Oracle respond signature
- * const respondSig = await aeSdk.createOracleDelegationSignature(contractId, { queryId })
- * ```
- */
-export async function createOracleDelegationSignature(
-  contractId: Encoded.ContractAddress,
-  opt: Parameters<AccountBase['address']>[0] & Parameters<typeof delegateSignatureCommon>[1] &
-  { queryId?: Encoded.OracleQueryId },
-): Promise<string> {
-  return delegateSignatureCommon(
-    [opt.queryId ?? await opt.onAccount.address(opt), contractId],
-    opt,
-  );
-}

package/src/deprecated/index.ts

@@ -1,172 +0,0 @@
-import BigNumber from 'bignumber.js';
-import { buildTx } from '../tx/builder';
-import { Tag } from '../tx/builder/constants';
-import { calculateMinFee as calculateMinFeeInternal } from '../tx/builder/field-types/fee';
-import { TxParamsCommon } from '../tx/builder/schema';
-import { AE_AMOUNT_FORMATS } from '../utils/amount-formatter';
-import { mapObject } from '../utils/other';
-import { Encoding } from '../utils/encoder';
-
-export * from './methods';
-
-/**
- * @deprecated use NamePointer from apis/node instead
- * @hidden
- */
-export interface Pointer {
-  key: string;
-  id: string;
-}
-
-/**
- * @deprecated use genSalt instead
- * @hidden
- */
-export function salt(): number {
-  return Math.floor(Math.random() * Math.floor(Number.MAX_SAFE_INTEGER));
-}
-
-/**
- * @deprecated use genSalt instead
- * @hidden
- */
-export const createSalt = salt;
-
-/**
- * Calculate min fee
- * @category transaction builder
- * @param txType - Transaction type
- * @param options - Options object
- * @param options.params - Tx params
- * @deprecated use buildTx to generate transaction, unpack it and refer to `fee` field
- * @hidden
- * @example
- * ```js
- * calculateMinFee('spendTx', { gasLimit, params })
- * ```
- */
-export function calculateMinFee(
-  txType: Tag,
-  { params, vsn, denomination }: CalculateMinFeeOptions,
-): BigNumber {
-  return calculateMinFeeInternal(
-    txType,
-    (fee: BigNumber) => (
-      // @ts-expect-error anyway this planned to be removed
-      buildTx({ ...params, _computingMinFee: fee }, txType, { vsn, denomination })
-    ),
-  );
-}
-
-interface CalculateMinFeeOptions {
-  params: TxParamsCommon;
-  vsn?: number;
-  denomination?: AE_AMOUNT_FORMATS;
-}
-
-/**
- * @deprecated Maximum gas limit depends on transaction size, this value is outdated,
- * sdk check/provides gasLimit by itself while building a transaction
- * @hidden
- */
-export const GAS_MAX = 1600000 - 21000;
-
-/**
- * @deprecated use `Tag`
- * @hidden
- */
-export enum TX_TYPE {
-  account = 10,
-  signed = 11,
-  spend = 12,
-  oracleRegister = 22,
-  oracleQuery = 23,
-  oracleResponse = 24,
-  oracleExtend = 25,
-  nameClaim = 32,
-  namePreClaim = 33,
-  nameUpdate = 34,
-  nameRevoke = 35,
-  nameTransfer = 36,
-  contract = 40,
-  contractCallResult = 41,
-  contractCreate = 42,
-  contractCall = 43,
-  channelCreate = 50,
-  channelDeposit = 51,
-  channelWithdraw = 52,
-  channelCloseMutual = 53,
-  channelCloseSolo = 54,
-  channelSlash = 55,
-  channelSettle = 56,
-  channelOffChain = 57,
-  channel = 58,
-  channelSnapshotSolo = 59,
-  proofOfInclusion = 60,
-  stateTrees = 62,
-  merklePatriciaTree = 63,
-  merklePatriciaTreeValue = 64,
-  sophiaByteCode = 70,
-  gaAttach = 80,
-  gaMeta = 81,
-  payingFor = 82,
-  channelForceProgress = 521,
-  channelOffChainUpdateTransfer = 570,
-  channelOffChainUpdateDeposit = 571,
-  channelOffChainUpdateWithdrawal = 572,
-  channelOffChainCreateContract = 573,
-  channelOffChainCallContract = 574,
-  channelReconnect = 575,
-  contractsTree = 621,
-  contractCallsTree = 622,
-  channelsTree = 623,
-  nameserviceTree = 624,
-  oraclesTree = 625,
-  accountsTree = 626,
-}
-
-/**
- * @deprecated use `readId`, `writeId`
- * @hidden
- */
-export const ID_TAG = {
-  account: 1,
-  name: 2,
-  commitment: 3,
-  oracle: 4,
-  contract: 5,
-  channel: 6,
-} as const;
-
-/**
- * @deprecated use `readId`, `writeId`
- * @hidden
- */
-export const PREFIX_ID_TAG = {
-  ak: ID_TAG.account,
-  nm: ID_TAG.name,
-  cm: ID_TAG.commitment,
-  ok: ID_TAG.oracle,
-  ct: ID_TAG.contract,
-  ch: ID_TAG.channel,
-} as const;
-
-/**
- * @deprecated use `readId`, `writeId`
- * @hidden
- */
-export const ID_TAG_PREFIX = mapObject(
-  PREFIX_ID_TAG,
-  ([key, value]: [Encoding, number]) => [value, key],
-);
-
-/**
- * @deprecated use `getDefaultPointerKey`
- * @hidden
- */
-export enum POINTER_KEY_BY_PREFIX {
-  ak = 'account_pubkey',
-  ok = 'oracle_pubkey',
-  ct = 'contract_pubkey',
-  ch = 'channel',
-}

package/src/deprecated/methods.ts

@@ -1,25 +0,0 @@
-import { Encoded } from '../utils/encoder';
-import { createMetaTx } from '../contract/ga';
-import Node from '../Node';
-
-/**
- * @deprecated Use createMetaTx instead
- * @hidden
- */
-export async function signUsingGA(
-  tx: Encoded.Transaction,
-  { authData, authFun, ...options }: {
-    authData: Parameters<typeof createMetaTx>[1];
-    authFun: Parameters<typeof createMetaTx>[2];
-  } & Parameters<typeof createMetaTx>[3],
-): Promise<Encoded.Transaction> {
-  return createMetaTx(tx, authData, authFun, options);
-}
-
-/**
- * @deprecated Use getHeight instead
- * @hidden
- */
-export async function height({ onNode }: { onNode: Node }): Promise<number> {
-  return (await onNode.getCurrentKeyBlockHeight()).height;
-}

package/src/tx/builder/address.ts

@@ -1,50 +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}
- */
-const idTagToEncoding = [
-  Encoding.AccountAddress,
-  Encoding.Name,
-  Encoding.Commitment,
-  Encoding.OracleAddress,
-  Encoding.ContractAddress,
-  Encoding.Channel,
-] as const;
-
-type AddressEncodings = typeof idTagToEncoding[number];
-
-/**
- * Utility function to create and _id type
- * @category transaction builder
- * @param hashId - Encoded hash
- * @returns Buffer Buffer with ID tag and decoded HASh
- */
-export function writeId(hashId: Encoded.Generic<AddressEncodings>): Buffer {
-  if (typeof hashId !== 'string') throw new ArgumentError('hashId', 'a string', hashId);
-  const encoding = hashId.slice(0, 2);
-  if (!isItemOfArray(encoding, idTagToEncoding)) throw new TagNotFoundError(encoding);
-  const idTag = idTagToEncoding.indexOf(encoding) + 1;
-  return Buffer.from([...toBytes(idTag), ...decode(hashId)]);
-}
-
-/**
- * Utility function to read and _id type
- * @category transaction builder
- * @param buf - Data
- * @returns Encoided hash string with prefix
- */
-export function readId(buf: Buffer): Encoded.Generic<AddressEncodings> {
-  const idTag = Buffer.from(buf).readUIntBE(0, 1);
-  const encoding = idTagToEncoding[idTag - 1];
-  if (encoding == null) throw new PrefixNotFoundError(idTag);
-  return encode(buf.slice(1, buf.length), encoding);
-}

package/src/typings/@aeternity__argon2-browser/index.d.ts

@@ -1,3 +0,0 @@
-declare module '@aeternity/argon2-browser/dist/argon2-bundled.min.js' {
-  export * from 'argon2-browser';
-}

package/src/utils/mptree.ts

@@ -1,145 +0,0 @@
-/*
- * ISC License (ISC)
- * Copyright (c) 2021 aeternity developers
- *
- *  Permission to use, copy, modify, and/or distribute this software for any
- *  purpose with or without fee is hereby granted, provided that the above
- *  copyright notice and this permission notice appear in all copies.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- *  PERFORMANCE OF THIS SOFTWARE.
- */
-
-/* eslint-disable default-case */
-import { encode as rlpEncode } from 'rlp';
-import type { Input } from 'rlp';
-import { hash } from './crypto';
-import {
-  MerkleTreeHashMismatchError,
-  MissingNodeInTreeError,
-  UnknownPathNibbleError,
-  UnknownNodeLengthError,
-} from './errors';
-
-enum NodeType {
-  Branch,
-  Extension,
-  Leaf,
-}
-
-export type MPTreeBinary = [Buffer, Array<[Buffer, Buffer[]]>];
-
-export default class MPTree {
-  private readonly rootHash: string;
-
-  private readonly nodes: { [key: string]: Buffer[] };
-
-  private static nodeHash(node: Input): string {
-    return Buffer.from(hash(rlpEncode(node))).toString('hex');
-  }
-
-  /**
-   * Deserialize Merkle Patricia Tree
-   * @param binary - Binary
-   * @returns Merkle Patricia Tree
-   */
-  constructor(binary: MPTreeBinary) {
-    this.rootHash = binary[0].toString('hex');
-    this.nodes = Object.fromEntries(
-      binary[1].map((node) => [node[0].toString('hex'), node[1]]),
-    );
-
-    if (this.nodes[this.rootHash] === undefined) throw new MissingNodeInTreeError('Can\'t find a node by root hash');
-    Object.entries(this.nodes).forEach(([key, node]) => {
-      if (MPTree.nodeHash(node) !== key) throw new MerkleTreeHashMismatchError();
-      const { type, payload } = MPTree.parseNode(node);
-      switch (type) {
-        case NodeType.Branch:
-          payload
-            .slice(0, 16)
-            .filter((n) => n.length)
-            .forEach((n) => {
-              if (this.nodes[n.toString('hex')] === undefined) {
-                throw new MissingNodeInTreeError('Can\'t find a node by hash in branch node');
-              }
-            });
-          break;
-        case NodeType.Extension:
-          if (this.nodes[payload[0].toString('hex')] === undefined) {
-            throw new MissingNodeInTreeError('Can\'t find a node by hash in extension node');
-          }
-      }
-    });
-  }
-
-  isEqual(tree: MPTree): boolean {
-    return this.rootHash === tree.rootHash;
-  }
-
-  private static parseNode(node: Buffer[]): {
-    type: NodeType;
-    payload: Buffer[];
-    path: string | null;
-  } {
-    switch (node.length) {
-      case 17:
-        return { type: NodeType.Branch, payload: node, path: null };
-      case 2: {
-        const nibble = node[0][0] >> 4; // eslint-disable-line no-bitwise
-        if (nibble > 3) throw new UnknownPathNibbleError(nibble);
-        const type = nibble <= 1 ? NodeType.Extension : NodeType.Leaf;
-        const slice = [0, 2].includes(nibble) ? 2 : 1;
-        return { type, payload: [node[1]], path: node[0].toString('hex').slice(slice) };
-      }
-      default:
-        throw new UnknownNodeLengthError(node.length);
-    }
-  }
-
-  /**
-   * Serialize Merkle Patricia Tree
-   * @returns Binary
-   */
-  serialize(): MPTreeBinary {
-    return [
-      Buffer.from(this.rootHash, 'hex'),
-      Object.entries(this.nodes).map(([mptHash, value]) => ([
-        Buffer.from(mptHash, 'hex'),
-        value,
-      ])),
-    ];
-  }
-
-  /**
-   * Retrieve value from Merkle Patricia Tree
-   * @param _key - The key of the element to retrieve
-   * @returns Value associated to the specified key
-   */
-  get(_key: string): Buffer | undefined {
-    let searchFrom = this.rootHash;
-    let key = _key;
-    while (true) { // eslint-disable-line no-constant-condition
-      const { type, payload, path } = MPTree.parseNode(this.nodes[searchFrom]);
-      switch (type) {
-        case NodeType.Branch:
-          if (key.length === 0) return payload[16];
-          searchFrom = payload[+`0x${key[0]}`].toString('hex');
-          key = key.substring(1);
-          break;
-        case NodeType.Extension:
-          if (key.substring(0, path?.length) !== path) return undefined;
-          searchFrom = payload[0].toString('hex');
-          key = key.substring(path.length);
-          break;
-        case NodeType.Leaf:
-          if (path !== key) return undefined;
-          return payload[0];
-      }
-    }
-  }
-}