@aeternity/aepp-sdk 13.3.3 → 14.1.0

package/src/account/Generalized.ts

@@ -1,113 +0,0 @@
-import AccountBase from './Base';
-import {
-  ArgumentError,
-  InternalError,
-  InvalidAuthDataError,
-  NotImplementedError,
-} from '../utils/errors';
-import { decode, Encoded } from '../utils/encoder';
-import { getAccount } from '../chain';
-import Contract from '../contract/Contract';
-import { buildTxAsync, buildTx } from '../tx/builder';
-import { Tag } from '../tx/builder/constants';
-
-/**
- * Generalized account class
- */
-export default class AccountGeneralized extends AccountBase {
-  override readonly address: Encoded.AccountAddress;
-
-  #authFun?: string;
-
-  /**
-   * @param address - Address of generalized account
-   */
-  constructor(address: Encoded.AccountAddress) {
-    super();
-    decode(address);
-    this.address = address;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async sign(): Promise<Uint8Array> {
-    throw new NotImplementedError('Can\'t sign using generalized account');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signMessage(): Promise<Uint8Array> {
-    throw new NotImplementedError('Can\'t sign using generalized account');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signTypedData(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('Can\'t sign using generalized account');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using generalized account');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signNameDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using generalized account');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signAllNamesDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using generalized account');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signOracleQueryDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using generalized account');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signDelegation(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation using generalized account');
-  }
-
-  override async signTransaction(
-    tx: Encoded.Transaction,
-    { authData, onCompiler, onNode }: Parameters<AccountBase['signTransaction']>[1],
-  ): Promise<Encoded.Transaction> {
-    if (authData == null || onCompiler == null || onNode == null) {
-      throw new ArgumentError('authData, onCompiler, onNode', 'provided', null);
-    }
-    const {
-      callData, sourceCode, args, fee, gasLimit, gasPrice,
-    } = typeof authData === 'function' ? await authData(tx) : authData;
-
-    const authCallData = callData ?? await (async () => {
-      if (this.#authFun == null) {
-        const account = await getAccount(this.address, { onNode });
-        if (account.kind !== 'generalized') {
-          throw new ArgumentError('account kind', 'generalized', account.kind);
-        }
-        this.#authFun = account.authFun;
-      }
-      if (this.#authFun == null) {
-        throw new InternalError('Account in generalised, but authFun not provided');
-      }
-
-      if (sourceCode == null || args == null) {
-        throw new InvalidAuthDataError('Auth data must contain sourceCode and args or callData.');
-      }
-      const contract = await Contract.initialize({ onCompiler, onNode, sourceCode });
-      return contract._calldata.encode(contract._name, this.#authFun, args);
-    })();
-
-    const gaMetaTx = await buildTxAsync({
-      tag: Tag.GaMetaTx,
-      tx: { tag: Tag.SignedTx, encodedTx: decode(tx), signatures: [] },
-      gaId: this.address,
-      authData: authCallData,
-      fee,
-      gasLimit,
-      gasPrice,
-      onNode,
-    });
-    return buildTx({ tag: Tag.SignedTx, encodedTx: decode(gaMetaTx), signatures: [] });
-  }
-}

package/src/account/Ledger.ts

@@ -1,161 +0,0 @@
-import type Transport from '@ledgerhq/hw-transport';
-import AccountBase from './Base';
-import { ArgumentError, NotImplementedError } from '../utils/errors';
-import { decode, Encoded } from '../utils/encoder';
-import { buildTx } from '../tx/builder';
-import { Tag } from '../tx/builder/constants';
-
-export const CLA = 0xe0;
-export const GET_ADDRESS = 0x02;
-export const SIGN_TRANSACTION = 0x04;
-export const GET_APP_CONFIGURATION = 0x06;
-export const SIGN_PERSONAL_MESSAGE = 0x08;
-
-/**
- * Ledger wallet account class
- */
-export default class AccountLedger extends AccountBase {
-  readonly transport: Transport;
-
-  override readonly address: Encoded.AccountAddress;
-
-  readonly index: number;
-
-  /**
-   * @param transport - Connection to Ledger to use
-   * @param index - Index of account
-   * @param address - Address of account
-   */
-  constructor(transport: Transport, index: number, address: Encoded.AccountAddress) {
-    super();
-    this.transport = transport;
-    this.index = index;
-    this.address = address;
-    const scrambleKey = 'w0w';
-    transport.decorateAppAPIMethods(this, ['signTransaction', 'signMessage'], scrambleKey);
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async sign(): Promise<Uint8Array> {
-    throw new NotImplementedError('RAW signing using Ledger HW');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signTypedData(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('Typed data signing using Ledger HW');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using Ledger HW');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signNameDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using Ledger HW');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signAllNamesDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using Ledger HW');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signOracleQueryDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using Ledger HW');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  override async signDelegation(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation using Ledger HW');
-  }
-
-  override async signTransaction(
-    tx: Encoded.Transaction,
-    { innerTx, networkId }: { innerTx?: boolean; networkId?: string } = {},
-  ): Promise<Encoded.Transaction> {
-    if (innerTx != null) throw new NotImplementedError('innerTx option in AccountLedger');
-    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);
-
-    const rawTx = decode(tx);
-    let offset = 0;
-    const headerLength = 4 + 1 + 4;
-    const networkIdBuffer = Buffer.from(networkId);
-    const toSend = [];
-    while (offset !== rawTx.length) {
-      const maxChunkSize = offset === 0 ? 150 - headerLength - networkIdBuffer.length : 150;
-      const chunkSize = offset + maxChunkSize > rawTx.length
-        ? rawTx.length - offset : maxChunkSize;
-      const buffer = Buffer.alloc(
-        offset === 0 ? headerLength + networkIdBuffer.length + chunkSize : chunkSize,
-      );
-      if (offset === 0) {
-        let bufferOffset = buffer.writeUInt32BE(this.index, 0);
-        bufferOffset = buffer.writeUInt32BE(rawTx.length, bufferOffset);
-        bufferOffset = buffer.writeUInt8(networkIdBuffer.length, bufferOffset);
-        bufferOffset += networkIdBuffer.copy(
-          buffer,
-          bufferOffset,
-          0,
-          networkIdBuffer.length,
-        );
-        rawTx.copy(buffer, bufferOffset, 0, 150 - bufferOffset);
-      } else {
-        rawTx.copy(buffer, 0, offset, offset + chunkSize);
-      }
-      toSend.push(buffer);
-      offset += chunkSize;
-    }
-    const response = await toSend.reduce(
-      async (previous, data, i) => {
-        await previous;
-        return this.transport.send(
-          CLA,
-          SIGN_TRANSACTION,
-          i === 0 ? 0x00 : 0x80,
-          0x00,
-          data,
-        );
-      },
-      Promise.resolve(Buffer.alloc(0)),
-    );
-    const signatures = [response.subarray(0, 64)];
-
-    return buildTx({ tag: Tag.SignedTx, encodedTx: rawTx, signatures });
-  }
-
-  override async signMessage(messageStr: string): Promise<Uint8Array> {
-    let offset = 0;
-    const message = Buffer.from(messageStr);
-    const toSend = [];
-    while (offset !== message.length) {
-      const maxChunkSize = offset === 0 ? 150 - 4 - 4 : 150;
-      const chunkSize = offset + maxChunkSize > message.length
-        ? message.length - offset : maxChunkSize;
-      const buffer = Buffer.alloc(offset === 0 ? 4 + 4 + chunkSize : chunkSize);
-      if (offset === 0) {
-        buffer.writeUInt32BE(this.index, 0);
-        buffer.writeUInt32BE(message.length, 4);
-        message.copy(buffer, 4 + 4, offset, offset + chunkSize);
-      } else {
-        message.copy(buffer, 0, offset, offset + chunkSize);
-      }
-      toSend.push(buffer);
-      offset += chunkSize;
-    }
-    const response = await toSend.reduce(
-      async (previous, data, i) => {
-        await previous;
-        return this.transport.send(
-          CLA,
-          SIGN_PERSONAL_MESSAGE,
-          i === 0 ? 0x00 : 0x80,
-          0x00,
-          data,
-        );
-      },
-      Promise.resolve(Buffer.alloc(0)),
-    );
-    return response.subarray(0, 64);
-  }
-}

package/src/account/LedgerFactory.ts

@@ -1,86 +0,0 @@
-import type Transport from '@ledgerhq/hw-transport';
-import AccountLedger, { CLA, GET_ADDRESS, GET_APP_CONFIGURATION } from './Ledger';
-import { UnsupportedVersionError } from '../utils/errors';
-import { Encoded } from '../utils/encoder';
-import semverSatisfies from '../utils/semver-satisfies';
-import Node from '../Node';
-
-/**
- * A factory class that generates instances of AccountLedger based on provided transport.
- */
-export default class AccountLedgerFactory {
-  readonly transport: Transport;
-
-  private readonly versionCheckPromise: Promise<void>;
-
-  /**
-   * @param transport - Connection to Ledger to use
-   */
-  constructor(transport: Transport) {
-    this.transport = transport;
-    this.versionCheckPromise = this.getAppConfiguration().then(({ version }) => {
-      const args = [version, '0.4.4', '0.5.0'] as const;
-      if (!semverSatisfies(...args)) throw new UnsupportedVersionError('app on ledger', ...args);
-    });
-    const scrambleKey = 'w0w';
-    transport.decorateAppAPIMethods(this, ['getAddress', 'getAppConfiguration'], scrambleKey);
-  }
-
-  /**
-   * @returns the version of app installed on Ledger wallet
-   */
-  async getAppConfiguration(): Promise<{ version: string }> {
-    await this.versionCheckPromise;
-    const response = await this.transport.send(CLA, GET_APP_CONFIGURATION, 0x00, 0x00);
-    return {
-      version: [response[1], response[2], response[3]].join('.'),
-    };
-  }
-
-  /**
-   * Get `ak_`-prefixed address for a given account index.
-   * @param accountIndex - Index of account
-   * @param verify - Ask user to confirm address by showing it on the device screen
-   */
-  async getAddress(accountIndex: number, verify = false): Promise<Encoded.AccountAddress> {
-    await this.versionCheckPromise;
-    const buffer = Buffer.alloc(4);
-    buffer.writeUInt32BE(accountIndex, 0);
-    const response = await this.transport.send(
-      CLA,
-      GET_ADDRESS,
-      verify ? 0x01 : 0x00,
-      0x00,
-      buffer,
-    );
-    const addressLength = response[0];
-    return response.subarray(1, 1 + addressLength).toString('ascii') as Encoded.AccountAddress;
-  }
-
-  /**
-   * Get an instance of AccountLedger for a given account index.
-   * @param accountIndex - Index of account
-   */
-  async initialize(accountIndex: number): Promise<AccountLedger> {
-    await this.versionCheckPromise;
-    return new AccountLedger(this.transport, accountIndex, await this.getAddress(accountIndex));
-  }
-
-  /**
-   * Discovers accounts on Ledger that already have been used (has any on-chain transactions).
-   * It returns an empty array if none of accounts been used.
-   * If a used account is preceded by an unused account then it would be ignored.
-   * @param node - Instance of Node to get account information from
-   */
-  async discover(node: Node): Promise<AccountLedger[]> {
-    let index = 0;
-    const result = [];
-    let account;
-    do {
-      if (account != null) result.push(account);
-      account = await this.initialize(index);
-      index += 1;
-    } while (await node.getAccountByPubkey(account.address).then(() => true, () => false));
-    return result;
-  }
-}

package/src/account/Memory.ts

@@ -1,218 +0,0 @@
-import AccountBase from './Base';
-import {
-  generateKeyPairFromSecret, sign, generateKeyPair, hash, messageToHash, messagePrefixLength,
-} from '../utils/crypto';
-import { ArgumentError, UnexpectedTsError } from '../utils/errors';
-import {
-  decode, encode, Encoded, Encoding,
-} from '../utils/encoder';
-import { concatBuffers } from '../utils/other';
-import { hashTypedData, AciValue } from '../utils/typed-data';
-import { buildTx } from '../tx/builder';
-import { Tag, AensName, ConsensusProtocolVersion } from '../tx/builder/constants';
-import { produceNameId } from '../tx/builder/helpers';
-import { DelegationTag } from '../tx/builder/delegation/schema';
-import { packDelegation } from '../tx/builder/delegation';
-
-const secretKeys = new WeakMap<AccountMemory, Uint8Array>();
-
-export function getBufferToSign(
-  transaction: Encoded.Transaction,
-  networkId: string,
-  innerTx: boolean,
-): Uint8Array {
-  const prefixes = [networkId];
-  if (innerTx) prefixes.push('inner_tx');
-  const rlpBinaryTx = decode(transaction);
-  return concatBuffers([Buffer.from(prefixes.join('-')), hash(rlpBinaryTx)]);
-}
-
-/**
- * In-memory account class
- */
-export default class AccountMemory extends AccountBase {
-  override readonly address: Encoded.AccountAddress;
-
-  /**
-   * @param secretKey - Secret key
-   */
-  constructor(secretKey: string | Uint8Array) {
-    super();
-    secretKey = typeof secretKey === 'string' ? Buffer.from(secretKey, 'hex') : secretKey;
-    if (secretKey.length !== 64) {
-      throw new ArgumentError('secretKey', '64 bytes', secretKey.length);
-    }
-    secretKeys.set(this, secretKey);
-    this.address = encode(
-      generateKeyPairFromSecret(secretKey).publicKey,
-      Encoding.AccountAddress,
-    );
-  }
-
-  /**
-   * Generates a new AccountMemory using a random secret key
-   */
-  static generate(): AccountMemory {
-    return new AccountMemory(generateKeyPair().secretKey);
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  override async sign(data: string | Uint8Array, options?: any): Promise<Uint8Array> {
-    const secretKey = secretKeys.get(this);
-    if (secretKey == null) throw new UnexpectedTsError();
-    return sign(data, secretKey);
-  }
-
-  override async signTransaction(
-    transaction: Encoded.Transaction,
-    { innerTx, networkId, ...options }: { innerTx?: boolean; networkId?: string } = {},
-  ): Promise<Encoded.Transaction> {
-    if (networkId == null) {
-      throw new ArgumentError('networkId', 'provided', networkId);
-    }
-    const rlpBinaryTx = decode(transaction);
-    const txWithNetworkId = getBufferToSign(transaction, networkId, innerTx === true);
-
-    const signatures = [await this.sign(txWithNetworkId, options)];
-    return buildTx({ tag: Tag.SignedTx, encodedTx: rlpBinaryTx, signatures });
-  }
-
-  override async signMessage(message: string, options?: any): Promise<Uint8Array> {
-    return this.sign(messageToHash(message), options);
-  }
-
-  override async signTypedData(
-    data: Encoded.ContractBytearray,
-    aci: AciValue,
-    {
-      name, version, networkId, contractAddress, ...options
-    }: Parameters<AccountBase['signTypedData']>[2] = {},
-  ): Promise<Encoded.Signature> {
-    const dHash = hashTypedData(data, aci, {
-      name, version, networkId, contractAddress,
-    });
-    const signature = await this.sign(dHash, options);
-    return encode(signature, Encoding.Signature);
-  }
-
-  override async signDelegationToContract(
-    contractAddress: Encoded.ContractAddress,
-    { networkId, consensusProtocolVersion, isOracle }: {
-      networkId?: string;
-      consensusProtocolVersion?: ConsensusProtocolVersion;
-      isOracle?: boolean;
-    } = {},
-  ): Promise<Encoded.Signature> {
-    if (isOracle == null) {
-      const protocol = (consensusProtocolVersion != null) ? ConsensusProtocolVersion[consensusProtocolVersion] : 'unknown';
-      console.warn(`AccountMemory:signDelegationToContract: isOracle is not set. By default, sdk would generate an AENS preclaim delegation signature, but it won't be the same as the oracle delegation signature in Ceres (current protocol is ${protocol}).`);
-    }
-    if (consensusProtocolVersion === ConsensusProtocolVersion.Ceres) {
-      const delegation = packDelegation({
-        tag: isOracle === true ? DelegationTag.Oracle : DelegationTag.AensPreclaim,
-        accountAddress: this.address,
-        contractAddress,
-      });
-      return this.signDelegation(delegation, { networkId });
-    }
-    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);
-    const payload = concatBuffers([
-      Buffer.from(networkId),
-      decode(this.address),
-      decode(contractAddress),
-    ]);
-    const signature = await this.sign(payload);
-    return encode(signature, Encoding.Signature);
-  }
-
-  override async signNameDelegationToContract(
-    contractAddress: Encoded.ContractAddress,
-    name: AensName,
-    { networkId, consensusProtocolVersion }: {
-      networkId?: string;
-      consensusProtocolVersion?: ConsensusProtocolVersion;
-    } = {},
-  ): Promise<Encoded.Signature> {
-    if (consensusProtocolVersion === ConsensusProtocolVersion.Ceres) {
-      const delegation = packDelegation({
-        tag: DelegationTag.AensName, accountAddress: this.address, contractAddress, nameId: name,
-      });
-      return this.signDelegation(delegation, { networkId });
-    }
-    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);
-    const payload = concatBuffers([
-      Buffer.from(networkId),
-      decode(this.address),
-      decode(produceNameId(name)),
-      decode(contractAddress),
-    ]);
-    const signature = await this.sign(payload);
-    return encode(signature, Encoding.Signature);
-  }
-
-  override async signAllNamesDelegationToContract(
-    contractAddress: Encoded.ContractAddress,
-    { networkId, consensusProtocolVersion }: {
-      networkId?: string;
-      consensusProtocolVersion?: ConsensusProtocolVersion;
-    } = {},
-  ): Promise<Encoded.Signature> {
-    if (consensusProtocolVersion === ConsensusProtocolVersion.Ceres) {
-      const delegation = packDelegation({
-        tag: DelegationTag.AensWildcard, accountAddress: this.address, contractAddress,
-      });
-      return this.signDelegation(delegation, { networkId });
-    }
-    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);
-    const payload = concatBuffers([
-      Buffer.from(networkId),
-      decode(this.address),
-      Buffer.from('AENS'),
-      decode(contractAddress),
-    ]);
-    const signature = await this.sign(payload);
-    return encode(signature, Encoding.Signature);
-  }
-
-  override async signOracleQueryDelegationToContract(
-    contractAddress: Encoded.ContractAddress,
-    oracleQueryId: Encoded.OracleQueryId,
-    { networkId, consensusProtocolVersion }: {
-      networkId?: string;
-      consensusProtocolVersion?: ConsensusProtocolVersion;
-    } = {},
-  ): Promise<Encoded.Signature> {
-    if (consensusProtocolVersion === ConsensusProtocolVersion.Ceres) {
-      const delegation = packDelegation({
-        tag: DelegationTag.OracleResponse, queryId: oracleQueryId, contractAddress,
-      });
-      return this.signDelegation(delegation, { networkId });
-    }
-    const oracleQueryIdDecoded = decode(oracleQueryId);
-    const addressDecoded = decode(this.address);
-    // TODO: remove after fixing https://github.com/aeternity/aesophia/issues/475
-    if (oracleQueryIdDecoded.compare(addressDecoded) === 0) {
-      throw new ArgumentError('oracleQueryId', 'not equal to account address', oracleQueryId);
-    }
-    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);
-    const payload = concatBuffers([
-      Buffer.from(networkId),
-      oracleQueryIdDecoded,
-      decode(contractAddress),
-    ]);
-    const signature = await this.sign(payload);
-    return encode(signature, Encoding.Signature);
-  }
-
-  override async signDelegation(
-    delegation: Encoded.Bytearray,
-    { networkId }: { networkId?: string } = {},
-  ): Promise<Encoded.Signature> {
-    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);
-    const payload = concatBuffers([
-      messagePrefixLength, new Uint8Array([1]), Buffer.from(networkId), decode(delegation),
-    ]);
-    const signature = await this.sign(payload);
-    return encode(signature, Encoding.Signature);
-  }
-}