@aeternity/aepp-sdk 8.2.1 → 10.0.0

package/src/contract/aci/transformation.js

@@ -1,9 +1,7 @@
-import Joi from 'joi-browser'
-import { isHex } from '../../utils/string'
 import { toBytes } from '../../utils/bytes'
 import { decode } from '../../tx/builder/helpers'
 import { parseBigNumber } from '../../utils/bignumber'
-import { isAddressValid, addressFromDecimal, hash } from '../../utils/crypto'
+import { addressFromDecimal, hash } from '../../utils/crypto'
 
 export const SOPHIA_TYPES = [
   'int',
@@ -24,441 +22,51 @@ export const SOPHIA_TYPES = [
 ].reduce((acc, type) => ({ ...acc, [type]: type }), { ChainTtl: 'Chain.ttl' })
 
 /**
- * Transform decoded event to JS type
- * @param {Object[]} events Array of events
- * @param {Object} [options={}] Options
- * @param {Object} [options.schema=[]] SC function ACI schema
+ * Decode events fields
+ * @param {Object[]} events Array of events with encoded fields
+ * @param {Array} schemas Smart contract event ACI schemas
  * @return {Object}
  */
-export function decodeEvents (events, options = { schema: [] }) {
-  if (!events.length) return []
-
-  return events.map(l => {
-    const [eName, ...eParams] = l.topics
-    const hexHash = toBytes(eName, true).toString('hex')
-    const { schema } = options.schema
-      .reduce(
-        (acc, el) => {
-          if (hash(el.name).toString('hex') === hexHash) {
-            l.name = el.name
-            return {
-              schema: el.types,
-              name: el.name
-            }
-          }
-          return acc
-        },
-        { schema: [] }
-      )
-    const { decoded } = schema.reduce((acc, el) => {
-      if (el === SOPHIA_TYPES.string) {
-        return { decoded: [...acc.decoded, transformEvent(l.data, el)], params: acc.params }
-      }
-      const [event, ...tail] = acc.params
-      return { decoded: [...acc.decoded, transformEvent(event, el)], params: tail }
-    }, { decoded: [], params: eParams })
+export const decodeEvents = (events, schemas = []) => events.reduce((acc, event) => {
+  const [nameHash, ...params] = event.topics
+  const schema = schemas.find((s) => hash(s.name).equals(toBytes(nameHash, true)))
+  if (!schema) return acc
+  const stringCount = schema.types.filter(t => t === SOPHIA_TYPES.string).length
+  if (stringCount > 1) throw new Error(`Event schema contains more than one string: ${schema.types}`)
+  const topicsCount = schema.types.length - stringCount
+  if (topicsCount !== params.length) {
+    throw new Error(`Schema defines ${topicsCount} types, but ${params.length} topics present`)
+  }
 
-    return {
-      ...l,
-      decoded
-    }
+  acc.push({
+    ...event,
+    name: schema.name,
+    decoded: schema.types.map((type) =>
+      decodeEventField(type === SOPHIA_TYPES.string ? event.data : params.shift(), type))
   })
-}
+
+  return acc
+}, [])
 
 /**
  * Transform Event based on type
- * @param {String|Number} event Event data
+ * @param {String|Number} field Event data
  * @param {String} type Event type from schema
  * @return {*}
  */
-export function transformEvent (event, type) {
+function decodeEventField (field, type) {
   switch (type) {
     case SOPHIA_TYPES.int:
-      return parseBigNumber(event)
+      return parseBigNumber(field)
     case SOPHIA_TYPES.bool:
-      return !!event
-    case SOPHIA_TYPES.hash:
-      return toBytes(event, true).toString('hex')
-    case SOPHIA_TYPES.address:
-      return addressFromDecimal(event).split('_')[1]
-    case SOPHIA_TYPES.string:
-      return decode(event).toString('utf-8')
-    default:
-      return toBytes(event, true)
-  }
-}
-
-export function injectVars (t, aciType) {
-  const [[baseType, generic]] = Object.entries(aciType.typedef)
-  const [[, varianValue]] = Object.entries(t)
-  switch (baseType) {
-    case SOPHIA_TYPES.variant:
-      return {
-        [baseType]: generic.map(el => {
-          const [tag, gen] = Object.entries(el)[0]
-          return {
-            [tag]: gen.map(type => {
-              const index = aciType.vars.map(e => e.name).indexOf(type)
-              return index === -1
-                ? type
-                : varianValue[index]
-            })
-          }
-        })
-      }
-  }
-}
-
-/**
- * Ling Type Defs
- * @param t
- * @param bindings
- * @return {Object}
- */
-export function linkTypeDefs (t, bindings) {
-  const [root, typeDef] = typeof t === 'object' ? Object.keys(t)[0].split('.') : t.split('.')
-  const contractTypeDefs = bindings.find(c => c.name === root)
-  const aciType = [
-    ...contractTypeDefs.type_defs,
-    { name: 'state', typedef: contractTypeDefs.state, vars: [] }
-  ].find(({ name }) => name === typeDef)
-  if (aciType.vars.length) {
-    aciType.typedef = injectVars(t, aciType)
-  }
-  return isTypedDefOrState(aciType.typedef, bindings) ? linkTypeDefs(aciType.typedef, bindings) : aciType.typedef
-}
-
-const isTypedDefOrState = (t, bindings) => {
-  if (!['string', 'object'].includes(typeof t)) return false
-
-  t = typeof t === 'object' ? Object.keys(t)[0] : t
-  const [root, ...path] = t.split('.')
-  // Remote Contract Address
-  if (!path.length) return false
-  return bindings.map(c => c.name).includes(root)
-}
-
-const isRemoteAddress = (t) => {
-  if (typeof t !== 'string') return false
-  const [root, ...path] = t.split('.')
-  return !path.length && !Object.values(SOPHIA_TYPES).includes(root)
-}
-
-/**
- * Parse sophia type
- * @param type
- * @param returnType
- * @return {Object}
- */
-export function readType (type, { bindings } = {}) {
-  let [t] = Array.isArray(type) ? type : [type]
-
-  // If remote address
-  if (isRemoteAddress(t)) return { t: SOPHIA_TYPES.address }
-  // Link State and typeDef
-  if (isTypedDefOrState(t, bindings)) t = linkTypeDefs(t, bindings)
-  // Map, Tuple, List, Record, Bytes
-  if (typeof t === 'object') {
-    const [[baseType, generic]] = Object.entries(t)
-    return { t: baseType, generic }
-  }
-  // Base types
-  if (typeof t === 'string') return { t }
-}
-
-// FUNCTION ARGUMENTS TRANSFORMATION ↓↓↓
-
-/**
- * Transform JS type to Sophia-type
- * @param type
- * @param value
- * @param bindings
- * @return {string}
- */
-export function transform (type, value, { bindings } = {}) {
-  const { t, generic } = readType(type, { bindings })
-
-  switch (t) {
-    case SOPHIA_TYPES.ChainTtl:
-      return `${value}`
-    case SOPHIA_TYPES.string:
-      return `"${value}"`
-    case SOPHIA_TYPES.list:
-      return `[${value.map(el => transform(generic, el, { bindings }))}]`
-    case SOPHIA_TYPES.tuple:
-      return `(${value.map((el, i) => transform(generic[i], el, {
-        bindings
-      }))})`
-    case SOPHIA_TYPES.option: {
-      return value === undefined ? 'None' : `Some(${transform(generic, value, {
-        bindings
-      })})`
-    }
+      return !!field
     case SOPHIA_TYPES.hash:
-    case SOPHIA_TYPES.bytes:
-    case SOPHIA_TYPES.signature:
-      if (typeof value === 'string') {
-        if (isHex(value)) return `#${value}`
-        if (isAddressValid(value)) return `#${decode(value).toString('hex')}`
-      }
-      return `#${Buffer.from(value).toString('hex')}`
-    case SOPHIA_TYPES.record:
-      return `{${generic.reduce(
-        (acc, { name, type }, i) => {
-          acc += `${i !== 0 ? ',' : ''}${name} = ${transform(type, value[name], {
-            bindings
-          })}`
-          return acc
-        },
-        ''
-      )}}`
-    case SOPHIA_TYPES.map:
-      return transformMap(value, generic, { bindings })
-    case SOPHIA_TYPES.variant:
-      return transformVariant(value, generic, { bindings })
-  }
-
-  return `${value}`
-}
-
-export function transformVariant (value, generic, { bindings }) {
-  const [[variant, variantArgs]] = typeof value === 'string' ? [[value, []]] : Object.entries(value)
-  const [[v, type]] = Object.entries(generic.find(o => Object.keys(o)[0].toLowerCase() === variant.toLowerCase()))
-  return `${v}${!type.length
-    ? ''
-    : `(${variantArgs.slice(0, type.length).map((el, i) => transform(type[i], el, {
-      bindings
-    }))})`
-  }`
-}
-
-export function transformMap (value, generic, { bindings }) {
-  if (!Array.isArray(value)) {
-    if (value.entries) value = Array.from(value.entries())
-    else if (value instanceof Object) value = Object.entries(value)
-  }
-
-  return [
-    '{',
-    value
-      .map(([key, value]) => [
-        `[${transform(generic[0], key, { bindings })}]`,
-        transform(generic[1], value, { bindings })
-      ].join(' = '))
-      .join(),
-    '}'
-  ].join('')
-}
-
-// FUNCTION RETURN VALUE TRANSFORMATION ↓↓↓
-
-/**
- * Transform decoded data to JS type
- * @param aci
- * @param result
- * @param transformDecodedData
- * @return {*}
- */
-export function transformDecodedData (aci, result, { skipTransformDecoded = false, addressPrefix = 'ak', bindings } = {}) {
-  if (skipTransformDecoded) return result
-  const { t, generic } = readType(aci, { bindings })
-
-  switch (t) {
-    case SOPHIA_TYPES.bool:
-      return !!result
+      return toBytes(field, true).toString('hex')
     case SOPHIA_TYPES.address:
-      return result === 0
-        ? 0
-        : result
-    case SOPHIA_TYPES.hash:
-    case SOPHIA_TYPES.bytes:
-    case SOPHIA_TYPES.signature:
-      return result.split('#')[1]
-    case SOPHIA_TYPES.map: {
-      const [keyT, valueT] = generic
-      return result
-        .reduce(
-          (acc, [key, val]) => {
-            key = transformDecodedData(keyT, key, { bindings })
-            val = transformDecodedData(valueT, val, { bindings })
-            acc.push([key, val])
-            return acc
-          },
-          []
-        )
-    }
-    case SOPHIA_TYPES.option: {
-      if (result === 'None') return undefined
-      const [[variantType, [value]]] = Object.entries(result)
-      return variantType === 'Some' ? transformDecodedData(generic, value, { bindings }) : undefined
-    }
-    case SOPHIA_TYPES.list:
-      return result.map((value) => transformDecodedData(generic, value, { bindings }))
-    case SOPHIA_TYPES.tuple:
-      return result.map((value, i) => { return transformDecodedData(generic[i], value, { bindings }) })
-    case SOPHIA_TYPES.record: {
-      const genericMap = generic.reduce((acc, val) => ({ ...acc, [val.name]: { type: val.type } }), {})
-      return Object.entries(result).reduce(
-        (acc, [name, value]) =>
-          ({
-            ...acc,
-            [name]: transformDecodedData(genericMap[name].type, value, { bindings })
-          }),
-        {}
-      )
-    }
-  }
-  return result
-}
-
-// FUNCTION ARGUMENTS VALIDATION ↓↓↓
-
-/**
- * Prepare Joi validation schema for sophia types
- * @param type
- * @param bindings
- * @return {Object} JoiSchema
- */
-export function prepareSchema (type, { bindings } = {}) {
-  const { t, generic } = readType(type, { bindings })
-
-  switch (t) {
-    case SOPHIA_TYPES.int:
-      return Joi.number().error(getJoiErrorMsg)
-    case SOPHIA_TYPES.variant:
-      return Joi.alternatives().try([
-        Joi.string().valid(
-          ...generic.reduce((acc, el) => {
-            const [[t, g]] = Object.entries(el)
-            if (!g || !g.length) acc.push(t)
-            return acc
-          }, [])
-        ),
-        Joi.object(generic
-          .reduce(
-            (acc, el) => {
-              const variant = Object.keys(el)[0]
-              return { ...acc, [variant]: Joi.array() }
-            },
-            {})
-        ).or(...generic.map(e => Object.keys(e)[0]))
-      ])
-    case SOPHIA_TYPES.ChainTtl:
-      return Joi.string().error(getJoiErrorMsg)
+      return addressFromDecimal(field)
     case SOPHIA_TYPES.string:
-      return Joi.string().error(getJoiErrorMsg)
-    case SOPHIA_TYPES.address:
-      return Joi.string().regex(/^(ak_|ct_|ok_|oq_)/).error(getJoiErrorMsg)
-    case SOPHIA_TYPES.bool:
-      return Joi.boolean().error(getJoiErrorMsg)
-    case SOPHIA_TYPES.list:
-      return Joi.array().items(prepareSchema(generic, { bindings })).error(getJoiErrorMsg)
-    case SOPHIA_TYPES.tuple:
-      return Joi.array().ordered(generic.map(type => prepareSchema(type, { bindings }).required())).label('Tuple argument').error(getJoiErrorMsg)
-    case SOPHIA_TYPES.record:
-      return Joi.object(
-        generic.reduce((acc, { name, type }) => ({ ...acc, [name]: prepareSchema(type, { bindings }) }), {})
-      ).error(getJoiErrorMsg)
-    case SOPHIA_TYPES.hash:
-      return JoiBinary.binary().bufferCheck(32).error(getJoiErrorMsg)
-    case SOPHIA_TYPES.bytes:
-      return JoiBinary.binary().bufferCheck(generic).error(getJoiErrorMsg)
-    case SOPHIA_TYPES.signature:
-      return JoiBinary.binary().bufferCheck(64).error(getJoiErrorMsg)
-    case SOPHIA_TYPES.option:
-      return prepareSchema(generic, { bindings }).optional().error(getJoiErrorMsg)
-    // @Todo Need to transform Map to Array of arrays before validating it
-    // case SOPHIA_TYPES.map:
-    //   return Joi.array().items(Joi.array().ordered(generic.map(type => prepareSchema(type))))
+      return decode(field).toString('utf-8')
     default:
-      return Joi.any()
-  }
-}
-
-/**
- * Parse Joi validation error message
- * @param errors
- * @return {Object} JoiError
- */
-export function getJoiErrorMsg (errors) {
-  return errors.map(err => {
-    const { path, type, context } = err
-    let value = Object.prototype.hasOwnProperty.call(context, 'value') ? context.value : context.label
-    value = typeof value === 'object' ? JSON.stringify(value).slice(1).slice(0, -1) : value
-    switch (type) {
-      case 'string.base':
-        return ({ ...err, message: `Value "${value}" at path: [${path}] not a string` })
-      case 'number.base':
-        return ({ ...err, message: `Value "${value}" at path: [${path}] not a number` })
-      case 'boolean.base':
-        return ({ ...err, message: `Value "${value}" at path: [${path}] not a boolean` })
-      case 'array.base':
-        return ({ ...err, message: `Value "${value}" at path: [${path}] not a array` })
-      case 'object.base':
-        return ({ ...err, message: `Value '${value}' at path: [${path}] not a object` })
-      case 'object.type':
-        return ({ ...err, message: `Value '${value}' at path: [${path}] not a ${context.type}` })
-      case 'binary.bufferCheck':
-        return ({
-          ...err,
-          message: `Value '${Buffer.from(value).toString('hex')}' at path: [${path}] not a ${context.size} bytes`
-        })
-      default:
-        return err
-    }
-  })
-}
-
-/**
- * Custom Joi Validator for binary type
- */
-const JoiBinary = Joi.extend((joi) => ({
-  name: 'binary',
-  base: joi.any(),
-  pre (value, state, options) {
-    if (options.convert && typeof value === 'string') {
-      if (isAddressValid(value)) {
-        return decode(value)
-      }
-      try {
-        return Buffer.from(value, 'hex')
-      } catch (e) { return undefined }
-    }
-
-    return Buffer.from(value)
-  },
-  rules: [
-    {
-      name: 'bufferCheck',
-      params: {
-        size: joi.number().required()
-      },
-      validate (params, value, state, options) {
-        if (!Buffer.isBuffer(value)) {
-          return this.createError('binary.base', { value }, state, options)
-        }
-        if (value.length !== params.size) {
-          return this.createError('binary.bufferCheck', { value, size: params.size }, state, options)
-        }
-
-        return value
-      }
-    }
-  ]
-}))
-
-/**
- * Validation contract function arguments
- * @param aci
- * @param params
- */
-export function validateArguments (aci, params) {
-  const validationSchema = Joi.array().ordered(
-    aci.arguments
-      .map(({ type }, i) => prepareSchema(type, { bindings: aci.bindings }).label(`[${params[i]}]`))
-  ).sparse(true).label('Argument')
-  const { error } = Joi.validate(params, validationSchema, { abortEarly: false })
-  if (error) {
-    throw error
+      return toBytes(field, true)
   }
 }

package/src/contract/compiler.js

@@ -52,12 +52,29 @@ export default AsyncInit.compose(ContractBase, {
       compilerUrl = compilerUrl.replace(/\/$/, '')
       const client = await genSwaggerClient(`${compilerUrl}/api`, {
         disableBigNumbers: true,
-        disableCaseConversion: true
+        disableCaseConversion: true,
+        responseInterceptor: response => {
+          if (response.ok) return
+          let message = `${new URL(response.url).pathname.slice(1)} error`
+          if (response.body.reason) {
+            message += ': ' + response.body.reason +
+              (response.body.parameter ? ` in ${response.body.parameter}` : '') +
+              // TODO: revising after improving documentation https://github.com/aeternity/aesophia_http/issues/78
+              (response.body.info ? ` (${JSON.stringify(response.body.info)})` : '')
+          }
+          if (Array.isArray(response.body)) {
+            message += ':\n' + response.body
+              .map(e => `${e.type}:${e.pos.line}:${e.pos.col}: ${e.message}${e.context ? `(${e.context})` : ''}`)
+              .map(e => e.trim()) // TODO: remove after fixing https://github.com/aeternity/aesophia_http/issues/80
+              .join('\n')
+          }
+          response.statusText = message
+          return response
+        }
       })
       this.compilerVersion = client.spec.info.version
       this._compilerApi = client.api
 
-      this._isCompiler6 = semverSatisfies(this.compilerVersion, COMPILER_6_GE_VERSION, COMPILER_LT_VERSION)
       if (ignoreVersion) return
       if (!semverSatisfies(this.compilerVersion, COMPILER_GE_VERSION, COMPILER_LT_VERSION)) {
         throw new Error(`Unsupported compiler version ${this.compilerVersion}. ` +
@@ -74,6 +91,17 @@ export default AsyncInit.compose(ContractBase, {
       this._ensureCompilerReady()
       return Promise.resolve(this.compilerVersion)
     },
+    /**
+     * Encode call data for contract call
+     * @function
+     * @category async
+     * @param {String} source Contract source code
+     * @param {String} name Name of function to call
+     * @param {Array} args Argument's for call
+     * @param {Object} [options={}]  Options
+     * @param {Object} [options.filesystem={}] Contract external namespaces map
+     * @return {Promise<String>}
+     */
     async contractEncodeCallDataAPI (source, name, args = [], options) {
       this._ensureCompilerReady()
       const { calldata } = await this._compilerApi.encodeCalldata({
@@ -109,6 +137,22 @@ export default AsyncInit.compose(ContractBase, {
         options: this._prepareCompilerOptions(options)
       })
     },
+    /**
+     * Decode contract call result data
+     * @function
+     * @category async
+     * @param {String} source - source code
+     * @param {String } fn - function name
+     * @param {String} callValue - result call data
+     * @param {String} callResult - result status
+     * @param {Object} [options={}]  Options
+     * @param {Object} [options.filesystem={}] Contract external namespaces map
+     * @return {Promise<String>} Result object
+     * @example
+     * const decodedData = await sdk.contractDecodeCallResultAPI(
+     *   SourceCode ,'functionName', 'cb_asdasdasd...', 'ok|revert'
+     * )
+     */
     contractDecodeCallResultAPI (source, fn, callValue, callResult, options) {
       this._ensureCompilerReady()
       return this._compilerApi.decodeCallResult({
@@ -130,7 +174,9 @@ export default AsyncInit.compose(ContractBase, {
     },
     getFateAssembler (bytecode, options) {
       this._ensureCompilerReady()
-      return this._compilerApi.getFateAssemblerCode({ bytecode, options: this._prepareCompilerOptions(options) })
+      return this._compilerApi.getFateAssemblerCode(
+        { bytecode, options: this._prepareCompilerOptions(options) }
+      )
     },
     getBytecodeCompilerVersion (bytecode, options) {
       this._ensureCompilerReady()
@@ -145,6 +191,5 @@ export default AsyncInit.compose(ContractBase, {
   }
 })
 
-const COMPILER_GE_VERSION = '4.1.0'
-const COMPILER_6_GE_VERSION = '6.0.0'
+const COMPILER_GE_VERSION = '6.0.0'
 const COMPILER_LT_VERSION = '7.0.0'

package/src/contract/ga/helpers.js

@@ -1,7 +1,5 @@
 import BigNumber from 'bignumber.js'
-import { MAX_AUTH_FUN_GAS, TX_TYPE } from '../../tx/builder/schema'
-import { buildTx } from '../../tx/builder'
-import { hash } from '../../utils/crypto'
+import { MAX_AUTH_FUN_GAS } from '../../tx/builder/schema'
 
 export const prepareGaParams = (ins) => async (authData, authFnName) => {
   if (typeof authData !== 'object') throw new Error('AuthData must be an object')
@@ -10,16 +8,10 @@ export const prepareGaParams = (ins) => async (authData, authFnName) => {
   if (authData.callData) {
     if (authData.callData.split('_')[0] !== 'cb') throw new Error('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.contractEncodeCall(authData.source, authFnName, authData.args), gas }
+  }
+  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
   }
 }
-
-export const getContractAuthFan = (ins) => async (source, fnName) => {
-  const { bytecode } = await ins.contractCompile(source)
-
-  return { bytecode, authFun: hash(fnName) }
-}
-
-export const wrapInEmptySignedTx = (rlp) => buildTx({ encodedTx: rlp, signatures: [] }, TX_TYPE.signed)