@aeternity/aepp-sdk 10.0.0-beta.1 → 11.0.1

package/src/contract/ga/helpers.js

@@ -1,15 +1,19 @@
 import BigNumber from 'bignumber.js'
 import { MAX_AUTH_FUN_GAS } from '../../tx/builder/schema'
+import { InvalidAuthDataError } from '../../utils/errors'
 
 export const prepareGaParams = (ins) => async (authData, authFnName) => {
-  if (typeof authData !== 'object') throw new Error('AuthData must be an object')
-  if (authData.gas && BigNumber(authData.gas).gt(MAX_AUTH_FUN_GAS)) throw new Error(`the maximum gas value for ga authFun is ${MAX_AUTH_FUN_GAS}, got ${authData.gas}`)
+  if (typeof authData !== 'object') throw new InvalidAuthDataError('AuthData must be an object')
+  if (authData.gas && BigNumber(authData.gas).gt(MAX_AUTH_FUN_GAS)) { throw new InvalidAuthDataError(`the maximum gas value for ga authFun is ${MAX_AUTH_FUN_GAS}, got ${authData.gas}`) }
   const gas = authData.gas || MAX_AUTH_FUN_GAS
   if (authData.callData) {
-    if (authData.callData.split('_')[0] !== 'cb') throw new Error('Auth data must be a string with "cb" prefix.')
+    if (authData.callData.split('_')[0] !== 'cb') throw new InvalidAuthDataError('Auth data must be a string with "cb" prefix.')
     return { authCallData: authData.callData, gas }
-  } else {
-    if (!authData.source || !authData.args) throw new Error('Auth data must contain source code and arguments.')
-    return { authCallData: await ins.contractEncodeCallDataAPI(authData.source, authFnName, authData.args), gas }
+  }
+  if (!authData.source || !authData.args) throw new InvalidAuthDataError('Auth data must contain source code and arguments.')
+  const contract = await ins.getContractInstance({ source: authData.source })
+  return {
+    authCallData: contract.calldata.encode(contract._name, authFnName, authData.args),
+    gas
   }
 }

package/src/contract/ga/index.js

@@ -1,6 +1,6 @@
 /*
  * ISC License (ISC)
- * Copyright (c) 2018 aeternity developers
+ * 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
@@ -16,50 +16,53 @@
  */
 
 /**
- * Generalize Account module - routines to use generalize account
+ * Generalized Account module - routines to use generalized account
  *
  * @module @aeternity/aepp-sdk/es/contract/ga
- * @export GeneralizeAccount
- * @example import { GeneralizeAccount } from '@aeternity/aepp-sdk'
+ * @export GeneralizedAccount
+ * @example import { GeneralizedAccount } from '@aeternity/aepp-sdk'
  */
-import { ContractAPI } from '../../ae/contract'
+import Contract from '../../ae/contract'
 import { TX_TYPE } from '../../tx/builder/schema'
 import { buildTx, unpackTx } from '../../tx/builder'
 import { prepareGaParams } from './helpers'
 import { hash } from '../../utils/crypto'
+import { IllegalArgumentError, MissingParamError } from '../../utils/errors'
 
 /**
- * GeneralizeAccount Stamp
+ * GeneralizedAccount Stamp
  *
- * Provide Generalize Account implementation
+ * Provide Generalized Account implementation
  * {@link module:@aeternity/aepp-sdk/es/contract/ga} clients.
  * @function
  * @alias module:@aeternity/aepp-sdk/es/contract/ga
  * @rtype Stamp
  * @param {Object} [options={}] - Initializer object
- * @return {Object} GeneralizeAccount instance
+ * @return {Object} GeneralizedAccount instance
  * @example
  * const authContract = ``
- * await client.createGeneralizeAccount(authFnName, authContract, [...authFnArguments]
+ * await aeSdk.createGeneralizedAccount(authFnName, authContract, [...authFnArguments]
  * // Make spend using GA
  * const callData = 'cb_...' // encoded call data for auth contract
- * await client.spend(10000, receiverPub, { authData: { callData } })
+ * await aeSdk.spend(10000, receiverPub, { authData: { callData } })
  * // or
- * await client.spend(10000, receiverPub, { authData: { source: authContract, args: [...authContractArgs] } }) // sdk will prepare callData itself
+ * await aeSdk.spend(10000, receiverPub, {
+ *   authData: { source: authContract, args: [...authContractArgs] }
+ * }) // sdk will prepare callData itself
  */
-export const GeneralizeAccount = ContractAPI.compose({
+export const GeneralizedAccount = Contract.compose({
   methods: {
-    createGeneralizeAccount,
+    createGeneralizedAccount,
     createMetaTx,
     isGA
   }
 })
-export default GeneralizeAccount
+export default GeneralizedAccount
 
 /**
  * @alias module:@aeternity/aepp-sdk/es/contract/ga
  * @function
- * Check if account is GA account
+ * Check if account is GA
  * @param {String} address - Account address
  * @return {Boolean}
  */
@@ -69,26 +72,30 @@ async function isGA (address) {
 }
 
 /**
- * Convert current account to GA account
+ * Convert current account to GA
  * @alias module:@aeternity/aepp-sdk/es/contract/ga
  * @function
  * @param {String} authFnName - Authorization function name
  * @param {String} source - Auth contract source code
  * @param {Array} [args] - init arguments
  * @param {Object} [options] - Options
- * @return {Promise<Readonly<{result: *, owner: *, createdAt: Date, address, rawTx: *, transaction: *}>>}
+ * @return {Promise<Readonly<{
+ *   result: *, owner: *, address, rawTx: *, transaction: *
+ * }>>}
  */
-async function createGeneralizeAccount (authFnName, source, args = [], options = {}) {
+async function createGeneralizedAccount (authFnName, source, args = [], options = {}) {
   const opt = { ...this.Ae.defaults, ...options }
   const ownerId = await this.address(opt)
+  if (await this.isGA(ownerId)) throw new IllegalArgumentError(`Account ${ownerId} is already GA`)
 
-  if (await this.isGA(ownerId)) throw new Error(`Account ${ownerId} is already GA`)
-
+  const contract = await this.getContractInstance({ source })
+  await contract.compile()
   const { tx, contractId } = await this.gaAttachTx({
     ...opt,
+    gas: opt.gas ?? await contract._estimateGas('init', args, opt),
     ownerId,
-    code: (await this.contractCompile(source)).bytecode,
-    callData: await this.contractEncodeCallDataAPI(source, 'init', args),
+    code: contract.bytecode,
+    callData: contract.calldata.encode(contract._name, 'init', args),
     authFun: hash(authFnName)
   })
 
@@ -115,7 +122,7 @@ const wrapInEmptySignedTx = (tx) => buildTx({ encodedTx: tx, signatures: [] }, T
  * @return {String}
  */
 async function createMetaTx (rawTransaction, authData, authFnName, options = {}) {
-  if (!authData) throw new Error('authData is required')
+  if (!authData) throw new MissingParamError('authData is required')
   // Check if authData is callData or if it's an object prepare a callData from source and args
   const { authCallData, gas } = await prepareGaParams(this)(authData, authFnName)
   const opt = { ...this.Ae.defaults, ...options }
@@ -128,7 +135,7 @@ async function createMetaTx (rawTransaction, authData, authFnName, options = {})
       tx: wrappedTx.txObject
     },
     gaId: await this.address(opt),
-    abiVersion: abiVersion,
+    abiVersion,
     authData: authCallData,
     gas,
     vsn: 2

package/src/index.js

@@ -1,6 +1,6 @@
 /*
  * ISC License (ISC)
- * Copyright (c) 2018 aeternity developers
+ * 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
@@ -21,9 +21,8 @@ import * as Bytes from './utils/bytes'
 import * as TxBuilder from './tx/builder'
 import * as TxBuilderHelper from './tx/builder/helpers'
 import * as SCHEMA from './tx/builder/schema'
-import * as ACITransformation from './contract/aci/transformation'
 import * as AmountFormatter from './utils/amount-formatter'
-import HdWallet from './utils/hd-wallet'
+import * as HdWallet from './utils/hd-wallet'
 
 import Ae from './ae'
 import Chain from './chain'
@@ -38,8 +37,8 @@ import AccountMultiple from './account/multiple'
 import MemoryAccount from './account/memory'
 import Aens from './ae/aens'
 import Contract from './ae/contract'
-import GeneralizeAccount from './contract/ga'
-import ContractCompilerAPI from './contract/compiler'
+import GeneralizedAccount from './contract/ga'
+import ContractCompilerHttp from './contract/compiler'
 import RpcAepp from './ae/aepp'
 import RpcWallet from './ae/wallet'
 import Oracle from './ae/oracle'
@@ -53,6 +52,9 @@ export * as AeppWalletSchema from './utils/aepp-wallet-communication/schema'
 export { default as WalletDetector } from './utils/aepp-wallet-communication/wallet-detector'
 export { default as BrowserRuntimeConnection } from './utils/aepp-wallet-communication/connection/browser-runtime'
 export { default as BrowserWindowMessageConnection } from './utils/aepp-wallet-communication/connection/browser-window-message'
+export * from './utils/errors'
+
+export const getDefaultPointerKey = TxBuilderHelper.getDefaultPointerKey
 
 export {
   AmountFormatter,
@@ -62,8 +64,7 @@ export {
   Aens,
   Bytes,
   Contract,
-  ContractCompilerAPI,
-  ACITransformation,
+  ContractCompilerHttp,
   ChainNode,
   RpcAepp,
   RpcWallet,
@@ -71,7 +72,7 @@ export {
   Crypto,
   Keystore,
   Chain,
-  GeneralizeAccount,
+  GeneralizedAccount,
   HdWallet,
   MemoryAccount,
   Node,

package/src/node-pool/index.js

@@ -6,6 +6,7 @@
  */
 import stampit from '@stamp/it'
 import { getNetworkId } from '../node'
+import { DisconnectedError, DuplicateNodeError, NodeNotFoundError, TypeError } from '../utils/errors'
 
 /**
  * Node Pool Stamp
@@ -34,7 +35,7 @@ export default stampit({
       configurable: false,
       get () {
         if (!this.selectedNode || !this.selectedNode.instance) {
-          throw new Error('You can\'t use Node API. Node is not connected or not defined!')
+          throw new NodeNotFoundError('You can\'t use Node API. Node is not connected or not defined!')
         }
         return this.selectedNode.instance.api
       }
@@ -51,10 +52,11 @@ export default stampit({
      * @param {Boolean} select - Select this node as current
      * @return {void}
      * @example
-     * nodePool.addNode('testNode', awaitNode({ url, internalUrl }), true) // add and select new node with name 'testNode'
+     * // add and select new node with name 'testNode'
+     * nodePool.addNode('testNode', awaitNode({ url, internalUrl }), true)
      */
     addNode (name, node, select = false) {
-      if (this.pool.has(name)) throw new Error(`Node with name ${name} already exist`)
+      if (this.pool.has(name)) throw new DuplicateNodeError(name)
 
       this.validateNodes([{ name, instance: node }])
 
@@ -82,7 +84,7 @@ export default stampit({
      * nodePool.selectNode('testNode')
      */
     selectNode (name) {
-      if (!this.pool.has(name)) throw new Error(`Node with name ${name} not in pool`)
+      if (!this.pool.has(name)) throw new NodeNotFoundError(`Node with name ${name} not in pool`)
 
       this.selectedNode = this.pool.get(name)
     },
@@ -118,7 +120,7 @@ export default stampit({
      * nodePool.getNodeInfo() // { name, version, networkId, protocol, ... }
      */
     getNodeInfo () {
-      if (!this.isNodeConnected()) throw new Error('Can not get node info. Node is not connected')
+      if (!this.isNodeConnected()) throw new DisconnectedError()
       return {
         name: this.selectedNode.name,
         ...this.selectedNode.instance.getNodeInfo()
@@ -140,13 +142,14 @@ export default stampit({
       }))
     },
     validateNodes (nodes) {
-      // TODO: validate it on TypeScript level instead (to speedup development, save runtime resources)
-      if (!Array.isArray(nodes)) throw new Error('"nodes" should be an array')
+      // TODO: validate it on TypeScript level instead
+      // (to speedup development, save runtime resources)
+      if (!Array.isArray(nodes)) throw new TypeError('"nodes" should be an array')
       const notObject = nodes.map(n => typeof n).find(t => t !== 'object')
-      if (notObject) throw new Error(`Each node should be an object, got ${notObject} instead`)
+      if (notObject) throw new TypeError(`Each node should be an object, got ${notObject} instead`)
       const wrongFields = nodes.find(n => typeof n.name !== 'string' || typeof n.instance !== 'object')
       if (notObject) {
-        throw new Error(
+        throw new TypeError(
           'Each node should have name (string), instance (object) ' +
           `fields, got ${JSON.stringify(wrongFields)} instead`
         )
@@ -156,7 +159,7 @@ export default stampit({
         .find(i => typeof i.api !== 'object' || typeof i.genesisHash !== 'string' ||
           typeof i.consensusProtocolVersion !== 'number')
       if (wrongInstanceFields) {
-        throw new Error(
+        throw new TypeError(
           'Each node instance should have api (object), consensusProtocolVersion (number), ' +
           `genesisHash (string) fields, got ${JSON.stringify(wrongInstanceFields)} instead`
         )

package/src/node.js

@@ -25,6 +25,7 @@
 import AsyncInit from './utils/async-init'
 import genSwaggerClient from './utils/swagger'
 import semverSatisfies from './utils/semver-satisfies'
+import { MissingParamError, UnsupportedVersionError } from './utils/errors'
 
 /**
  * Obtain networkId from account or node
@@ -34,9 +35,10 @@ import semverSatisfies from './utils/semver-satisfies'
  * @return {String} NetworkId
  */
 export function getNetworkId ({ networkId, force = false } = {}) {
-  if (!force && !networkId && !this.networkId && (!this.selectedNode || !this.selectedNode.networkId)) throw new Error('networkId is not provided')
-  if (force && !networkId && !this.networkId && (!this.selectedNode || !this.selectedNode.networkId)) return null
-  return networkId || this.networkId || this.selectedNode.networkId
+  const res = networkId || this.networkId || this.selectedNode?.networkId
+  if (!force && !res) throw new MissingParamError('networkId is not provided')
+  if (force && !res) return null
+  return res
 }
 
 /**
@@ -47,15 +49,17 @@ export function getNetworkId ({ networkId, force = false } = {}) {
  * @param {Object} [options={}] - Options
  * @param {String} options.url - Base URL for Node
  * @param {String} options.internalUrl - Base URL for internal requests
- * @param {String} options.axiosConfig - Object with axios configuration. Example { config: {}, errorHandler: (err) => throw err }
+ * @param {Object} options.axiosConfig - Object with axios configuration
+ * @param {Object} options.axiosConfig.config
+ * @param {Function} options.axiosConfig.errorHandler - (err) => throw err
  * @return {Object} Node client
  * @example Node({url: 'https://testnet.aeternity.io'})
  */
 const Node = AsyncInit.compose({
   async init ({ url, internalUrl, ignoreVersion }) {
-    if (!url) throw new Error('"url" required')
+    if (!url) throw new MissingParamError('"url" required')
     this.url = url.replace(/\/$/, '')
-    this.internalUrl = internalUrl ? internalUrl.replace(/\/$/, '') : this.url
+    this.internalUrl = internalUrl?.replace(/\/$/, '')
     const client = await genSwaggerClient(`${this.url}/api?oas3`, {
       internalUrl: this.internalUrl,
       responseInterceptor: response => {
@@ -70,10 +74,7 @@ const Node = AsyncInit.compose({
       !semverSatisfies(this.version, NODE_GE_VERSION, NODE_LT_VERSION) &&
       !ignoreVersion
     ) {
-      throw new Error(
-        `Unsupported node version ${this.version}. ` +
-        `Supported: >= ${NODE_GE_VERSION} < ${NODE_LT_VERSION}`
-      )
+      throw new UnsupportedVersionError('node', this.version, NODE_GE_VERSION, NODE_LT_VERSION)
     }
     this.api = client.api
 

package/src/tx/builder/constants.js

@@ -0,0 +1,100 @@
+import BigNumber from 'bignumber.js'
+import { mapObject } from '../../utils/other'
+
+// # AENS
+export const NAME_TTL = 180000
+// # max number of block into the future that the name is going to be available
+// # https://github.com/aeternity/protocol/blob/epoch-v0.22.0/AENS.md#update
+// # https://github.com/aeternity/protocol/blob/44a93d3aab957ca820183c3520b9daf6b0fedff4/AENS.md#aens-entry
+export const NAME_MAX_TTL = 36000
+export const NAME_MAX_CLIENT_TTL = 84600
+export const CLIENT_TTL = NAME_MAX_CLIENT_TTL
+// # see https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L67
+export const NAME_FEE_MULTIPLIER = 1e14 // 100000000000000
+export const NAME_FEE_BID_INCREMENT = 0.05 // # the increment is in percentage
+// # see https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L272
+export const NAME_BID_TIMEOUT_BLOCKS = 480 // # ~1 day
+// # this is the max length for a domain that requires a base fee to be paid
+export const NAME_MAX_LENGTH_FEE = 31
+export const NAME_BID_MAX_LENGTH = 12 // # this is the max length for a domain to be part of a bid
+export const POINTER_KEY_BY_PREFIX = {
+  ak: 'account_pubkey',
+  ok: 'oracle_pubkey',
+  ct: 'contract_pubkey',
+  ch: 'channel'
+}
+// # https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L290
+// # https://github.com/aeternity/protocol/blob/master/AENS.md#protocol-fees-and-protection-times
+// # bid ranges:
+export const NAME_BID_RANGES = mapObject({
+  31: 3,
+  30: 5,
+  29: 8,
+  28: 13,
+  27: 21,
+  26: 34,
+  25: 55,
+  24: 89,
+  23: 144,
+  22: 233,
+  21: 377,
+  20: 610,
+  19: 987,
+  18: 1597,
+  17: 2584,
+  16: 4181,
+  15: 6765,
+  14: 10946,
+  13: 17711,
+  12: 28657,
+  11: 46368,
+  10: 75025,
+  9: 121393,
+  8: 196418,
+  7: 317811,
+  6: 514229,
+  5: 832040,
+  4: 1346269,
+  3: 2178309,
+  2: 3524578,
+  1: 5702887
+}, ([key, value]) => [key, new BigNumber(value).times(NAME_FEE_MULTIPLIER)])
+
+// # ref: https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L273
+// # name bid timeouts
+export const NAME_BID_TIMEOUTS = {
+  13: BigNumber(0),
+  12: BigNumber(NAME_BID_TIMEOUT_BLOCKS), // # 480 blocks
+  8: BigNumber(31).times(NAME_BID_TIMEOUT_BLOCKS), // # 14880 blocks
+  4: BigNumber(62).times(NAME_BID_TIMEOUT_BLOCKS) // # 29760 blocks
+}
+
+// # Tag constant for ids (type uint8)
+// # see https://github.com/aeternity/protocol/blob/master/serializations.md#the-id-type
+// # <<Tag:1/unsigned-integer-unit:8, Hash:32/binary-unit:8>>
+const ID_TAG_ACCOUNT = 1
+const ID_TAG_NAME = 2
+const ID_TAG_COMMITMENT = 3
+const ID_TAG_ORACLE = 4
+const ID_TAG_CONTRACT = 5
+const ID_TAG_CHANNEL = 6
+
+export const ID_TAG = {
+  account: ID_TAG_ACCOUNT,
+  name: ID_TAG_NAME,
+  commitment: ID_TAG_COMMITMENT,
+  oracle: ID_TAG_ORACLE,
+  contract: ID_TAG_CONTRACT,
+  channel: ID_TAG_CHANNEL
+}
+
+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
+}
+
+export const ID_TAG_PREFIX = mapObject(PREFIX_ID_TAG, ([key, value]) => [value, key])

package/src/tx/builder/field-types.js

@@ -0,0 +1,61 @@
+import {
+  writeId, readId, isNameValid, produceNameId, ensureNameValid, getMinimumNameFee, readInt, writeInt
+} from './helpers'
+import { InsufficientNameFeeError, IllegalArgumentError } from '../../utils/errors'
+
+export class Field {
+  static serialize (value) {
+    return value
+  }
+
+  static deserialize (value) {
+    return value
+  }
+}
+
+export class Name extends Field {
+  static serialize (value) {
+    ensureNameValid(value)
+    return Buffer.from(value)
+  }
+
+  static deserialize (value) {
+    return value.toString()
+  }
+}
+
+export class NameId extends Field {
+  static serialize (value) {
+    return writeId(isNameValid(value) ? produceNameId(value) : value)
+  }
+
+  static deserialize (value) {
+    return readId(value)
+  }
+}
+
+export class NameFee extends Field {
+  static serialize (value, { name }) {
+    const minNameFee = getMinimumNameFee(name)
+    value ??= minNameFee
+    if (minNameFee.gt(value)) {
+      throw new InsufficientNameFeeError(value, minNameFee)
+    }
+    return writeInt(value)
+  }
+
+  static deserialize (value) {
+    return readInt(value)
+  }
+}
+
+export class Deposit extends Field {
+  static serialize (value, { name }) {
+    if (+value) throw new IllegalArgumentError(`Contract deposit is not refundable, so it should be equal 0, got ${value} instead`)
+    return writeInt(0)
+  }
+
+  static deserialize (value) {
+    return readInt(value)
+  }
+}