@aeternity/aepp-sdk 8.2.1 → 10.0.0

package/src/contract/ga/index.js

@@ -22,13 +22,11 @@
  * @export GeneralizeAccount
  * @example import { GeneralizeAccount } from '@aeternity/aepp-sdk'
  */
-import * as R from 'ramda'
-
 import { ContractAPI } from '../../ae/contract'
 import { TX_TYPE } from '../../tx/builder/schema'
-import { buildTx } from '../../tx/builder'
-import { getContractAuthFan, prepareGaParams, wrapInEmptySignedTx } from './helpers'
-import { assertedType, decodeBase64Check } from '../../utils/crypto'
+import { buildTx, unpackTx } from '../../tx/builder'
+import { prepareGaParams } from './helpers'
+import { hash } from '../../utils/crypto'
 
 /**
  * GeneralizeAccount Stamp
@@ -47,7 +45,9 @@ import { assertedType, decodeBase64Check } from '../../utils/crypto'
  * const callData = 'cb_...' // encoded call data for auth contract
  * await client.spend(10000, receiverPub, { authData: { callData } })
  * // or
- * await client.spend(10000, receiverPub, { authData: { source: authContract, args: [...authContractArgs] } }) // sdk will prepare callData itself
+ * await client.spend(10000, receiverPub, {
+ *   authData: { source: authContract, args: [...authContractArgs] }
+ * }) // sdk will prepare callData itself
  */
 export const GeneralizeAccount = ContractAPI.compose({
   methods: {
@@ -78,29 +78,36 @@ async function isGA (address) {
  * @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: *, createdAt: Date, address, rawTx: *, transaction: *
+ * }>>}
  */
 async function createGeneralizeAccount (authFnName, source, args = [], options = {}) {
-  const opt = R.merge(this.Ae.defaults, options)
+  const opt = { ...this.Ae.defaults, ...options }
   const ownerId = await this.address(opt)
 
   if (await this.isGA(ownerId)) throw new Error(`Account ${ownerId} is already GA`)
 
-  const { authFun, bytecode } = await getContractAuthFan(this)(source, authFnName)
-  const callData = await this.contractEncodeCall(source, 'init', args)
-
-  const { tx, contractId } = await this.gaAttachTx(R.merge(opt, { ownerId, code: bytecode, callData, authFun }))
+  const { tx, contractId } = await this.gaAttachTx({
+    ...opt,
+    ownerId,
+    code: (await this.contractCompile(source)).bytecode,
+    callData: await this.contractEncodeCallDataAPI(source, 'init', args),
+    authFun: hash(authFnName)
+  })
 
-  const { hash, rawTx } = await this.send(tx, opt)
+  const { hash: transaction, rawTx } = await this.send(tx, opt)
 
   return Object.freeze({
     owner: ownerId,
-    transaction: hash,
+    transaction,
     rawTx,
     gaContractId: contractId
   })
 }
 
+const wrapInEmptySignedTx = (tx) => buildTx({ encodedTx: tx, signatures: [] }, TX_TYPE.signed)
+
 /**
  * Create a metaTx transaction
  * @alias module:@aeternity/aepp-sdk/es/contract/ga
@@ -115,33 +122,26 @@ async function createMetaTx (rawTransaction, authData, authFnName, options = {})
   if (!authData) throw new Error('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 = R.merge(this.Ae.defaults, options)
-  // Get transaction rlp binary
-  const rlpBinaryTx = decodeBase64Check(assertedType(rawTransaction, 'tx'))
-  // Wrap in SIGNED tx with empty signatures
-  const { rlpEncoded } = wrapInEmptySignedTx(rlpBinaryTx)
-  // Get abi
+  const opt = { ...this.Ae.defaults, ...options }
   const { abiVersion } = await this.getVmVersion(TX_TYPE.contractCall)
-  // Prepare params for META tx
+  const wrappedTx = wrapInEmptySignedTx(unpackTx(rawTransaction))
   const params = {
     ...opt,
-    tx: rlpEncoded,
+    tx: {
+      ...wrappedTx,
+      tx: wrappedTx.txObject
+    },
     gaId: await this.address(opt),
     abiVersion: abiVersion,
     authData: authCallData,
     gas,
     vsn: 2
   }
-  // Calculate fee, get absolute ttl (ttl + height), get account nonce
   const { fee } = await this.prepareTxParams(TX_TYPE.gaMeta, params)
-  // Build META tx
   const { rlpEncoded: metaTxRlp } = buildTx(
     { ...params, fee: `${fee}` },
     TX_TYPE.gaMeta,
     { vsn: 2 }
   )
-  // Wrap in empty signed tx
-  const { tx } = wrapInEmptySignedTx(metaTxRlp)
-  // Send tx to the chain
-  return tx
+  return wrapInEmptySignedTx(metaTxRlp).tx
 }

package/src/contract/index.js

@@ -85,7 +85,9 @@ const ContractBase = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype (source: String, fn: String, callValue: String, callResult: String, options: Array) => decodedResult: Promise[String]
+ * @rtype (
+ *   source: String, fn: String, callValue: String, callResult: String, options: Array
+ * ) => decodedResult: Promise[String]
  * @param {String} source - Contract source
  * @param {String} fn - Fn name
  * @param {String} callValue - result data (cb_das...)
@@ -101,7 +103,9 @@ const ContractBase = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype (source: String, function: String, callData: String, options: Array) => decodedResult: Promise[String]
+ * @rtype (
+ *   source: String, function: String, callData: String, options: Array
+ * ) => decodedResult: Promise[String]
  * @param {String} source - contract source
  * @param {String} function - function name
  * @param {String} callData - Encoded contract call data

package/src/index.js

@@ -21,7 +21,6 @@ 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 ACIHelpers from './contract/aci/helpers'
 import * as ACITransformation from './contract/aci/transformation'
 import * as AmountFormatter from './utils/amount-formatter'
 import HdWallet from './utils/hd-wallet'
@@ -33,7 +32,7 @@ import Node from './node'
 import NodePool from './node-pool'
 import Tx from './tx'
 import Transaction from './tx/tx'
-import TransactionValidator from './tx/validator'
+import verifyTransaction from './tx/validator'
 import AccountBase from './account/base'
 import AccountMultiple from './account/multiple'
 import MemoryAccount from './account/memory'
@@ -55,6 +54,8 @@ export { default as WalletDetector } from './utils/aepp-wallet-communication/wal
 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 const getDefaultPointerKey = TxBuilderHelper.getDefaultPointerKey
+
 export {
   AmountFormatter,
   AccountBase,
@@ -64,7 +65,6 @@ export {
   Bytes,
   Contract,
   ContractCompilerAPI,
-  ACIHelpers,
   ACITransformation,
   ChainNode,
   RpcAepp,
@@ -81,7 +81,7 @@ export {
   Oracle,
   genSwaggerClient,
   Transaction,
-  TransactionValidator,
+  verifyTransaction,
   Tx,
   TxBuilder,
   TxBuilderHelper,

package/src/node-pool/index.js

@@ -5,7 +5,6 @@
  * @example import { NodePool } from '@aeternity/aepp-sdk'
  */
 import stampit from '@stamp/it'
-import Joi from 'joi-browser'
 import { getNetworkId } from '../node'
 
 /**
@@ -52,7 +51,8 @@ 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`)
@@ -141,17 +141,28 @@ export default stampit({
       }))
     },
     validateNodes (nodes) {
-      const { error } = Joi.array().items(
-        Joi.object({
-          name: Joi.string().required(),
-          instance: Joi.object({
-            api: Joi.object().required(),
-            consensusProtocolVersion: Joi.number().required(),
-            genesisHash: Joi.string().required()
-          }).unknown()
-        })
-      ).label('node').validate(nodes)
-      if (error) throw error
+      // 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')
+      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`)
+      const wrongFields = nodes.find(n => typeof n.name !== 'string' || typeof n.instance !== 'object')
+      if (notObject) {
+        throw new Error(
+          'Each node should have name (string), instance (object) ' +
+          `fields, got ${JSON.stringify(wrongFields)} instead`
+        )
+      }
+      const wrongInstanceFields = nodes
+        .map(n => n.instance)
+        .find(i => typeof i.api !== 'object' || typeof i.genesisHash !== 'string' ||
+          typeof i.consensusProtocolVersion !== 'number')
+      if (wrongInstanceFields) {
+        throw new Error(
+          'Each node instance should have api (object), consensusProtocolVersion (number), ' +
+          `genesisHash (string) fields, got ${JSON.stringify(wrongInstanceFields)} instead`
+        )
+      }
     }
   },
   props: {

package/src/node.js

@@ -34,29 +34,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
-}
-
-/**
- * get consensus protocol version
- * @param {Array} protocols Array of protocols
- * @param {Number} height Height
- * @return {Number} version Protocol version
- */
-async function getConsensusProtocolVersion (protocols = [], height) {
-  if (!protocols) throw new Error('Protocols must be an array')
-  if (!height) height = (await this.api.getCurrentKeyBlock()).height
-  if (height < 0) throw new Error('height must be a number >= 0')
-
-  return protocols
-    .filter(({ effectiveAtHeight }) => height >= effectiveAtHeight)
-    .reduce(
-      (acc, p) => p.effectiveAtHeight > acc.effectiveAtHeight ? p : acc,
-      { effectiveAtHeight: -1, version: 0 }
-    )
-    .version
+  const res = networkId || this.networkId || this.selectedNode?.networkId
+  if (!force && !res) throw new Error('networkId is not provided')
+  if (force && !res) return null
+  return res
 }
 
 /**
@@ -67,7 +48,9 @@ async function getConsensusProtocolVersion (protocols = [], height) {
  * @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'})
  */
@@ -76,7 +59,15 @@ const Node = AsyncInit.compose({
     if (!url) throw new Error('"url" required')
     this.url = url.replace(/\/$/, '')
     this.internalUrl = internalUrl ? internalUrl.replace(/\/$/, '') : this.url
-    const client = await genSwaggerClient(`${this.url}/api?oas3`, { internalUrl: this.internalUrl })
+    const client = await genSwaggerClient(`${this.url}/api?oas3`, {
+      internalUrl: this.internalUrl,
+      responseInterceptor: response => {
+        if (response.ok) return
+        return Object.assign(response, {
+          statusText: `${new URL(response.url).pathname.slice(1)} error: ` + response.body.reason
+        })
+      }
+    })
     this.version = client.spec.info.version
     if (
       !semverSatisfies(this.version, NODE_GE_VERSION, NODE_LT_VERSION) &&
@@ -89,8 +80,17 @@ const Node = AsyncInit.compose({
     }
     this.api = client.api
 
-    const { nodeRevision: revision, genesisKeyBlockHash: genesisHash, networkId, protocols } = await this.api.getStatus()
-    this.consensusProtocolVersion = await this.getConsensusProtocolVersion(protocols)
+    const {
+      nodeRevision: revision, genesisKeyBlockHash: genesisHash, networkId,
+      protocols, topBlockHeight
+    } = await this.api.getStatus()
+    this.consensusProtocolVersion = protocols
+      .filter(({ effectiveAtHeight }) => topBlockHeight >= effectiveAtHeight)
+      .reduce(
+        (acc, p) => p.effectiveAtHeight > acc.effectiveAtHeight ? p : acc,
+        { effectiveAtHeight: -1, version: 0 }
+      )
+      .version
     this.nodeNetworkId = networkId
     return Object.assign(this, { revision, genesisHash })
   },
@@ -103,8 +103,7 @@ const Node = AsyncInit.compose({
         version: this.version,
         consensusProtocolVersion: this.consensusProtocolVersion
       }
-    },
-    getConsensusProtocolVersion
+    }
   },
   props: {
     version: null,
@@ -113,7 +112,7 @@ const Node = AsyncInit.compose({
   }
 })
 
-const NODE_GE_VERSION = '6.0.0'
+const NODE_GE_VERSION = '6.2.0'
 const NODE_LT_VERSION = '7.0.0'
 
 export default Node

package/src/tx/builder/helpers.js

@@ -2,7 +2,6 @@ import * as R from 'ramda'
 import BigNumber from 'bignumber.js'
 
 import {
-  assertedType,
   decodeBase58Check,
   decodeBase64Check,
   encodeBase58Check, encodeBase64Check,
@@ -18,7 +17,8 @@ import {
   NAME_FEE,
   NAME_FEE_BID_INCREMENT,
   NAME_BID_TIMEOUTS,
-  NAME_ID_KEY
+  NAME_MAX_LENGTH_FEE,
+  POINTER_KEY_BY_PREFIX
 } from './schema'
 import { ceil } from '../../utils/bignumber'
 
@@ -47,20 +47,6 @@ export function buildContractId (ownerId, nonce) {
   return encode(b2bHash, 'ct')
 }
 
-/**
- * Build hash
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {String} prefix Transaction hash prefix
- * @param {Buffer} data Rlp encoded transaction buffer
- * @param {Object} options
- * @param {Boolean} options.raw
- * @return {String} Transaction hash
- */
-export function buildHash (prefix, data, options = {}) {
-  return options.raw ? hash(data) : encode(hash(data), prefix)
-}
-
 /**
  * Build a oracle query id
  * @function
@@ -124,15 +110,18 @@ export function commitmentHash (name, salt = createSalt()) {
  * Decode data using the default encoding/decoding algorithm
  * @function
  * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {string} data  An encoded and prefixed string (ex tx_..., sg_..., ak_....)
- * @param {string} type Prefix of Transaction
- * @return {Buffer} Buffer of decoded Base58check or Base64check data
+ * @param {string} data An Base58/64check encoded and prefixed string (ex tx_..., sg_..., ak_....)
+ * @param {string} [requiredPrefix] Ensure that data have this prefix
+ * @return {Buffer} Decoded data
  */
-export function decode (data, type = '') {
-  if (!type) type = data.split('_')[0]
-  return base64Types.includes(type)
-    ? decodeBase64Check(assertedType(data, type))
-    : decodeBase58Check(assertedType(data, type))
+export function decode (data, requiredPrefix) {
+  const [prefix, payload, extra] = data.split('_')
+  if (!payload) throw new Error(`Encoded string missing payload: ${data}`)
+  if (extra) throw new Error(`Encoded string have extra parts: ${data}`)
+  if (requiredPrefix && requiredPrefix !== prefix) {
+    throw new Error(`Encoded string have a wrong type: ${prefix} (expected: ${requiredPrefix})`)
+  }
+  return (base64Types.includes(prefix) ? decodeBase64Check : decodeBase58Check)(payload)
 }
 
 /**
@@ -157,6 +146,9 @@ export function encode (data, type) {
  * @return {Buffer} Buffer Buffer with ID tag and decoded HASh
  */
 export function writeId (hashId) {
+  if (typeof hashId !== 'string') {
+    throw new Error(`Address should be a string, got ${hashId} instead`)
+  }
   const prefix = hashId.slice(0, 2)
   const idTag = PREFIX_ID_TAG[prefix]
   if (!idTag) throw new Error(`Id tag for prefix ${prefix} not found.`)
@@ -203,7 +195,8 @@ export function readInt (buf = Buffer.from([])) {
  * Helper function to build pointers for name update TX
  * @function
  * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {Array} pointers - Array of pointers ([ { key: 'account_pubkey', id: 'ak_32klj5j23k23j5423l434l2j3423'} ])
+ * @param {Array} pointers - Array of pointers
+ * ([ { key: 'account_pubkey', id: 'ak_32klj5j23k23j5423l434l2j3423'} ])
  * @return {Array} Serialized pointers array
  */
 export function buildPointers (pointers) {
@@ -219,7 +212,8 @@ export function buildPointers (pointers) {
  * Helper function to read pointers from name update TX
  * @function
  * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {Array} pointers - Array of pointers ([ { key: 'account_pubkey', id: 'ak_32klj5j23k23j5423l434l2j3423'} ])
+ * @param {Array} pointers - Array of pointers
+ * ([ { key: 'account_pubkey', id: 'ak_32klj5j23k23j5423l434l2j3423'} ])
  * @return {Array} Deserialize pointer array
  */
 export function readPointers (pointers) {
@@ -261,35 +255,15 @@ export function isNameValid (name) {
 }
 
 /**
- * What kind of a hash is this? If it begins with 'ak_' it is an
- * account key, if with 'ok_' it's an oracle key.
- *
- * @param s - the hash.
- * returns the type, or throws an exception if type not found.
- */
-export function classify (s) {
-  if (!s.match(/^[a-z]{2}_.+/)) {
-    throw new Error('Not a valid hash')
-  }
-
-  const klass = s.substr(0, 2)
-  if (klass in NAME_ID_KEY) {
-    return NAME_ID_KEY[klass]
-  } else {
-    throw new Error(`Unknown class ${klass}`)
-  }
-}
-
-/**
- * Validate name pointers array
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {String[]} pointers Pointers array. Allowed values is: account(ak_), oracle(ok_), contract(ct_), channel(ch_)
- * @return {Boolean}
+ * @param identifier - account/oracle/contract address, or channel
+ * @returns {String} default AENS pointer key
+ * @throws exception when default key not defined
  */
-export function validatePointers (pointers = []) {
-  return !pointers
-    .find(p => !p || typeof p !== 'string' || !['ak', 'ok', 'ct', 'ch'].includes(p.split('_')[0]))
+export function getDefaultPointerKey (identifier) {
+  decode(identifier)
+  const prefix = identifier.substr(0, 2)
+  return POINTER_KEY_BY_PREFIX[prefix] ||
+    (() => { throw new Error(`Default AENS pointer key is not defined for ${prefix} prefix`) })()
 }
 
 /**
@@ -301,7 +275,7 @@ export function validatePointers (pointers = []) {
  */
 export function getMinimumNameFee (domain) {
   const nameLength = domain.replace('.chain', '').length
-  return NAME_BID_RANGES[nameLength >= NAME_BID_MAX_LENGTH ? NAME_BID_MAX_LENGTH : nameLength]
+  return NAME_BID_RANGES[nameLength >= NAME_MAX_LENGTH_FEE ? NAME_MAX_LENGTH_FEE : nameLength]
 }
 
 /**
@@ -317,7 +291,8 @@ export function computeBidFee (domain, startFee = NAME_FEE, increment = NAME_FEE
   if (!(Number(increment) === increment && increment % 1 !== 0)) throw new Error(`Increment must be float. Current increment ${increment}`)
   if (increment < NAME_FEE_BID_INCREMENT) throw new Error(`minimum increment percentage is ${NAME_FEE_BID_INCREMENT}`)
   return ceil(
-    BigNumber(BigNumber(startFee).eq(NAME_FEE) ? getMinimumNameFee(domain) : startFee).times(BigNumber(NAME_FEE_BID_INCREMENT).plus(1))
+    BigNumber(BigNumber(startFee).eq(NAME_FEE) ? getMinimumNameFee(domain) : startFee)
+      .times(BigNumber(NAME_FEE_BID_INCREMENT).plus(1))
   )
 }