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

package/src/channel/index.js

@@ -338,7 +338,8 @@ function shutdown (sign) {
  * @param {Number} amount - Amount of tokens to withdraw
  * @param {Function} sign - Function which verifies and signs withdraw transaction
  * @param {Object} [callbacks]
- * @param {Function} [callbacks.onOnChainTx] - Called when withdraw transaction has been posted on chain
+ * @param {Function} [callbacks.onOnChainTx] - Called when withdraw transaction has been posted
+ * on chain
  * @param {Function} [callbacks.onOwnWithdrawLocked]
  * @param {Function} [callbacks.onWithdrawLocked]
  * @return {Promise<Object>}
@@ -407,7 +408,8 @@ function withdraw (amount, sign, { onOnChainTx, onOwnWithdrawLocked, onWithdrawL
  * @param {Number} amount - Amount of tokens to deposit
  * @param {Function} sign - Function which verifies and signs deposit transaction
  * @param {Object} [callbacks]
- * @param {Function} [callbacks.onOnChainTx] - Called when deposit transaction has been posted on chain
+ * @param {Function} [callbacks.onOnChainTx] - Called when deposit transaction has been posted
+ * on chain
  * @param {Function} [callbacks.onOwnDepositLocked]
  * @param {Function} [callbacks.onDepositLocked]
  * @return {Promise<Object>}
@@ -597,7 +599,11 @@ function callContract ({ amount, callData, contract, abiVersion }, sign) {
  *   }
  * })
  */
-function forceProgress ({ amount, callData, contract, abiVersion, gas = 1000000, gasPrice = 1000000000, nonce }, sign, { onOnChainTx } = {}) {
+function forceProgress (
+  { amount, callData, contract, abiVersion, gas = 1000000, gasPrice = 1000000000, nonce },
+  sign,
+  { onOnChainTx } = {}
+) {
   return new Promise((resolve, reject) => {
     enqueueAction(
       this,
@@ -800,23 +806,42 @@ async function reconnect (options, txParams) {
  * @param {String} options.initiatorId - Initiator's public key
  * @param {String} options.responderId - Responder's public key
  * @param {Number} options.pushAmount - Initial deposit in favour of the responder by the initiator
- * @param {Number} options.initiatorAmount - Amount of tokens the initiator has committed to the channel
- * @param {Number} options.responderAmount - Amount of tokens the responder has committed to the channel
+ * @param {Number} options.initiatorAmount - Amount of tokens the initiator has committed to
+ * the channel
+ * @param {Number} options.responderAmount - Amount of tokens the responder has committed to
+ * the channel
  * @param {Number} options.channelReserve - The minimum amount both peers need to maintain
  * @param {Number} [options.ttl] - Minimum block height to include the channel_create_tx
  * @param {String} options.host - Host of the responder's node
  * @param {Number} options.port - The port of the responders node
  * @param {Number} options.lockPeriod - Amount of blocks for disputing a solo close
- * @param {Number} [options.existingChannelId] - Existing channel id (required if reestablishing a channel)
- * @param {Number} [options.offchainTx] - Offchain transaction (required if reestablishing a channel)
- * @param {Number} [options.timeoutIdle] - The time waiting for a new event to be initiated (default: 600000)
- * @param {Number} [options.timeoutFundingCreate] - The time waiting for the initiator to produce the create channel transaction after the noise session had been established (default: 120000)
- * @param {Number} [options.timeoutFundingSign] - The time frame the other client has to sign an off-chain update after our client had initiated and signed it. This applies only for double signed on-chain intended updates: channel create transaction, deposit, withdrawal and etc. (default: 120000)
- * @param {Number} [options.timeoutFundingLock] - The time frame the other client has to confirm an on-chain transaction reaching maturity (passing minimum depth) after the local node has detected this. This applies only for double signed on-chain intended updates: channel create transaction, deposit, withdrawal and etc. (default: 360000)
- * @param {Number} [options.timeoutSign] - The time frame the client has to return a signed off-chain update or to decline it. This applies for all off-chain updates (default: 500000)
- * @param {Number} [options.timeoutAccept] - The time frame the other client has to react to an event. This applies for all off-chain updates that are not meant to land on-chain, as well as some special cases: opening a noise connection, mutual closing acknowledgement and reestablishing an existing channel (default: 120000)
- * @param {Number} [options.timeoutInitialized] - the time frame the responder has to accept an incoming noise session. Applicable only for initiator (default: timeout_accept's value)
- * @param {Number} [options.timeoutAwaitingOpen] - The time frame the initiator has to start an outgoing noise session to the responder's node. Applicable only for responder (default: timeout_idle's value)
+ * @param {Number} [options.existingChannelId] - Existing channel id (required if reestablishing a
+ * channel)
+ * @param {Number} [options.offchainTx] - Offchain transaction (required if reestablishing
+ * a channel)
+ * @param {Number} [options.timeoutIdle] - The time waiting for a new event to be initiated
+ * (default: 600000)
+ * @param {Number} [options.timeoutFundingCreate] - The time waiting for the initiator to produce
+ * the create channel transaction after the noise session had been established (default: 120000)
+ * @param {Number} [options.timeoutFundingSign] - The time frame the other client has to sign an
+ * off-chain update after our client had initiated and signed it. This applies only for double
+ * signed on-chain intended updates: channel create transaction, deposit, withdrawal and etc.
+ * (default: 120000)
+ * @param {Number} [options.timeoutFundingLock] - The time frame the other client has to confirm an
+ * on-chain transaction reaching maturity (passing minimum depth) after the local node has detected
+ * this. This applies only for double signed on-chain intended updates: channel create transaction,
+ * deposit, withdrawal and etc. (default: 360000)
+ * @param {Number} [options.timeoutSign] - The time frame the client has to return a signed
+ * off-chain update or to decline it. This applies for all off-chain updates (default: 500000)
+ * @param {Number} [options.timeoutAccept] - The time frame the other client has to react to an
+ * event. This applies for all off-chain updates that are not meant to land on-chain, as well as
+ * some special cases: opening a noise connection, mutual closing acknowledgement and
+ * reestablishing an existing channel (default: 120000)
+ * @param {Number} [options.timeoutInitialized] - the time frame the responder has to accept an
+ * incoming noise session. Applicable only for initiator (default: timeout_accept's value)
+ * @param {Number} [options.timeoutAwaitingOpen] - The time frame the initiator has to start an
+ * outgoing noise session to the responder's node. Applicable only for responder (default:
+ * timeout_idle's value)
  * @param {Number} [options.debug=false] - Log websocket communication
  * @param {Function} options.sign - Function which verifies and signs transactions
  * @return {Promise<Object>} Channel instance

package/src/contract/aci/index.js

@@ -56,7 +56,8 @@ function getFunctionACI (aci, name, external) {
 }
 
 /**
- * Generate contract ACI object with predefined js methods for contract usage - can be used for creating a reference to already deployed contracts
+ * Generate contract ACI object with predefined js methods for contract usage - can be used for
+ * creating a reference to already deployed contracts
  * @alias module:@aeternity/aepp-sdk/es/contract/aci
  * @param {Object} [options={}] Options object
  * @param {String} [options.source] Contract source code
@@ -69,10 +70,13 @@ function getFunctionACI (aci, name, external) {
  * @example
  * const contractIns = await client.getContractInstance({ source })
  * await contractIns.deploy([321]) or await contractIns.methods.init(321)
- * const callResult = await contractIns.call('setState', [123]) or await contractIns.methods.setState.send(123, options)
- * const staticCallResult = await contractIns.call('setState', [123], { callStatic: true }) or await contractIns.methods.setState.get(123, options)
+ * const callResult = await contractIns.call('setState', [123]) or
+ * await contractIns.methods.setState.send(123, options)
+ * const staticCallResult = await contractIns.call('setState', [123], { callStatic: true }) or
+ * await contractIns.methods.setState.get(123, options)
  * Also you can call contract like: await contractIns.methods.setState(123, options)
- * Then sdk decide to make on-chain or static call(dry-run API) transaction based on function is stateful or not
+ * Then sdk decide to make on-chain or static call(dry-run API) transaction based on function is
+ * stateful or not
  */
 export default async function getContractInstance ({
   source,
@@ -86,7 +90,7 @@ export default async function getContractInstance ({
   aci = aci || (source && await this.contractGetACI(source, { filesystem }))
   if (!aci) throw new Error('Either ACI or source code is required')
   contractAddress = contractAddress && await this.resolveName(
-    contractAddress, 'ct', { resolveByNode: true }
+    contractAddress, 'contract_pubkey', { resolveByNode: true }
   )
   if (!contractAddress && !source && !bytecode) throw new Error('Can\'t create instance by ACI without address')
 
@@ -100,7 +104,7 @@ export default async function getContractInstance ({
     interface: R.defaultTo(null, R.prop('interface', aci)),
     aci: R.defaultTo(null, R.path(['encoded_aci', 'contract'], aci)),
     calldata: new Calldata([aci.encoded_aci, ...aci.external_encoded_aci]),
-    externalAci: aci.external_encoded_aci ? aci.external_encoded_aci.map(a => a.contract || a.namespace) : [],
+    externalAci: (aci.external_encoded_aci ?? []).map(a => a.contract || a.namespace),
     source,
     bytecode,
     deployInfo: { address: contractAddress },
@@ -131,7 +135,9 @@ export default async function getContractInstance ({
   instance.compile = async (options = {}) => {
     if (instance.bytecode) throw new Error('Contract already compiled')
     if (!instance.source) throw new Error('Can\'t compile without source code')
-    const { bytecode } = await this.contractCompile(instance.source, { ...instance.options, ...options })
+    const { bytecode } = await this.contractCompile(
+      instance.source, { ...instance.options, ...options }
+    )
     instance.bytecode = bytecode
     return instance.bytecode
   }
@@ -279,7 +285,8 @@ export default async function getContractInstance ({
   /**
    * Generate proto function based on contract function using Contract ACI schema
    * All function can be called like:
-   * 'await contract.methods.testFunction()' -> then sdk will decide to use dry-run or send tx on-chain base on if function stateful or not.
+   * 'await contract.methods.testFunction()' -> then sdk will decide to use dry-run or send tx
+   * on-chain base on if function stateful or not.
    * Also you can manually do that:
    * `await contract.methods.testFunction.get()` -> use call-static(dry-run)
    * `await contract.methods.testFunction.send()` -> send tx on-chain

package/src/contract/compiler.js

@@ -149,7 +149,9 @@ export default AsyncInit.compose(ContractBase, {
      * @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')lt
+     * const decodedData = await sdk.contractDecodeCallResultAPI(
+     *   SourceCode ,'functionName', 'cb_asdasdasd...', 'ok|revert'
+     * )
      */
     contractDecodeCallResultAPI (source, fn, callValue, callResult, options) {
       this._ensureCompilerReady()
@@ -172,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()

package/src/contract/ga/helpers.js

@@ -8,8 +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.contractEncodeCallDataAPI(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
   }
 }

package/src/contract/ga/index.js

@@ -45,7 +45,9 @@ import { hash } 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: {
@@ -76,7 +78,9 @@ 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 = { ...this.Ae.defaults, ...options }

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

@@ -54,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,

package/src/node-pool/index.js

@@ -51,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`)
@@ -140,7 +141,8 @@ export default stampit({
       }))
     },
     validateNodes (nodes) {
-      // TODO: validate it on TypeScript level instead (to speedup development, save runtime resources)
+      // 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`)

package/src/node.js

@@ -34,9 +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
+  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
 }
 
 /**
@@ -47,7 +48,9 @@ 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'})
  */

package/src/tx/builder/helpers.js

@@ -18,7 +18,7 @@ import {
   NAME_FEE_BID_INCREMENT,
   NAME_BID_TIMEOUTS,
   NAME_MAX_LENGTH_FEE,
-  NAME_ID_KEY
+  POINTER_KEY_BY_PREFIX
 } from './schema'
 import { ceil } from '../../utils/bignumber'
 
@@ -110,12 +110,13 @@ 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 Base58check or Base64check encoded and prefixed string (ex tx_..., sg_..., ak_....)
+ * @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, 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})`)
@@ -145,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.`)
@@ -191,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) {
@@ -207,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) {
@@ -249,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`) })()
 }
 
 /**
@@ -305,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))
   )
 }
 

package/src/tx/builder/index.js

@@ -158,7 +158,10 @@ function validateField (value, key, type, prefix) {
     case FIELD_TYPES.amount:
     case FIELD_TYPES.int: {
       const isMinusValue = (!isNaN(value) || BigNumber.isBigNumber(value)) && BigNumber(value).lt(0)
-      return assert((!isNaN(value) || BigNumber.isBigNumber(value)) && BigNumber(value).gte(0), { value, isMinusValue })
+      return assert(
+        (!isNaN(value) || BigNumber.isBigNumber(value)) && BigNumber(value).gte(0),
+        { value, isMinusValue }
+      )
     }
     case FIELD_TYPES.id: {
       const prefixes = Array.isArray(prefix) ? prefix : [prefix]
@@ -181,7 +184,10 @@ function validateField (value, key, type, prefix) {
 function transformParams (params, schema, { denomination } = {}) {
   params = schema
     .filter(([_, t]) => t === FIELD_TYPES.amount)
-    .reduce((acc, [key]) => ({ ...params, [key]: formatAmount(params[key], { denomination }) }), params)
+    .reduce(
+      (acc, [key]) => ({ ...params, [key]: formatAmount(params[key], { denomination }) }),
+      params
+    )
   const schemaKeys = schema.map(([k]) => k)
   return Object
     .entries(params)
@@ -294,7 +300,9 @@ export function validateParams (params, schema, { excludeKeys = [] }) {
   return schema
     .filter(([key]) => !excludeKeys.includes(key) && key !== 'payload')
     .reduce(
-      (acc, [key, type, prefix]) => Object.assign(acc, validateField(params[key], key, type, prefix)),
+      (acc, [key, type, prefix]) => Object.assign(
+        acc, validateField(params[key], key, type, prefix)
+      ),
       {}
     )
 }
@@ -306,12 +314,16 @@ export function validateParams (params, schema, { excludeKeys = [] }) {
  * @param {Object} params Object with tx params
  * @param {Array} schema Transaction schema
  * @param {Object} [options={}] options
- * @param {Array} [options.excludeKeys=[]] excludeKeys Array of keys to exclude for validation and build
- * @param {String} [options.denomination='aettos'] denomination Denomination of amounts (default: aettos)
+ * @param {String[]} [options.excludeKeys=[]] Array of keys to exclude for validation and build
+ * @param {String} [options.denomination='aettos'] Denomination of amounts
  * @throws {Error} Validation error
  * @return {Array} Array with binary fields of transaction
  */
-export function buildRawTx (params, schema, { excludeKeys = [], denomination = AE_AMOUNT_FORMATS.AETTOS } = {}) {
+export function buildRawTx (
+  params,
+  schema,
+  { excludeKeys = [], denomination = AE_AMOUNT_FORMATS.AETTOS } = {}
+) {
   const filteredSchema = schema.filter(([key]) => !excludeKeys.includes(key))
 
   // Transform `amount` type fields to `aettos`
@@ -374,14 +386,25 @@ const getSchema = ({ vsn, objId, type }) => {
  * @param {Object} params Object with tx params
  * @param {String} type Transaction type
  * @param {Object} [options={}] options
- * @param {Object} [options.excludeKeys] excludeKeys Array of keys to exclude for validation and build
+ * @param {String[]} [options.excludeKeys] Array of keys to exclude for validation and build
  * @param {String} [options.prefix] Prefix of transaction
  * @throws {Error} Validation error
- * @return {Object} { tx, rlpEncoded, binary } Object with tx -> Base64Check transaction hash with 'tx_' prefix, rlp encoded transaction and binary transaction
+ * @returns {Object} object
+ * @returns {String} object.tx Base64Check transaction hash with 'tx_' prefix
+ * @returns {Buffer} object.rlpEncoded rlp encoded transaction
+ * @returns {Array<Buffer>} object.binary binary transaction
  */
-export function buildTx (params, type, { excludeKeys = [], prefix = 'tx', vsn = VSN, denomination = AE_AMOUNT_FORMATS.AETTOS } = {}) {
+export function buildTx (
+  params,
+  type,
+  { excludeKeys = [], prefix = 'tx', vsn = VSN, denomination = AE_AMOUNT_FORMATS.AETTOS } = {}
+) {
   const [schema, tag] = getSchema({ type, vsn })
-  const binary = buildRawTx({ ...params, VSN: vsn, tag }, schema, { excludeKeys, denomination: params.denomination || denomination }).filter(e => e !== undefined)
+  const binary = buildRawTx(
+    { ...params, VSN: vsn, tag },
+    schema,
+    { excludeKeys, denomination: params.denomination || denomination }
+  ).filter(e => e !== undefined)
 
   const rlpEncoded = rlpEncode(binary)
   const tx = encode(rlpEncoded, prefix)
@@ -393,10 +416,14 @@ export function buildTx (params, type, { excludeKeys = [], prefix = 'tx', vsn =
  * Unpack transaction hash
  * @function
  * @alias module:@aeternity/aepp-sdk/es/tx/builder
- * @param {String|Buffer} encodedTx String or RLP encoded transaction array (if fromRlpBinary flag is true)
+ * @param {String|Buffer} encodedTx String or RLP encoded transaction array
+ * (if fromRlpBinary flag is true)
  * @param {Boolean} fromRlpBinary Unpack from RLP encoded transaction (default: false)
  * @param {String} prefix - Prefix of data
- * @return {Object} { tx, rlpEncoded, binary } Object with tx -> Object with transaction param's, rlp encoded transaction and binary transaction
+ * @returns {Object} object
+ * @returns {Object} object.tx Object with transaction param's
+ * @returns {Buffer} object.rlpEncoded rlp encoded transaction
+ * @returns {Array<Buffer>} object.binary binary transaction
  */
 export function unpackTx (encodedTx, fromRlpBinary = false, prefix = 'tx') {
   const rlpEncoded = fromRlpBinary ? encodedTx : decode(encodedTx, prefix)
@@ -421,4 +448,13 @@ export function buildTxHash (rawTx) {
   return encode(hash(data), 'th')
 }
 
-export default { calculateMinFee, calculateFee, unpackTx, unpackRawTx, buildTx, buildRawTx, validateParams, buildTxHash }
+export default {
+  calculateMinFee,
+  calculateFee,
+  unpackTx,
+  unpackRawTx,
+  buildTx,
+  buildRawTx,
+  validateParams,
+  buildTxHash
+}

package/src/tx/builder/schema.js

@@ -40,9 +40,10 @@ 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
-export const NAME_MAX_LENGTH_FEE = 31 // # this is the max length for a domain that requires a base fee to be paid
+// # 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 NAME_ID_KEY = {
+export const POINTER_KEY_BY_PREFIX = {
   ak: 'account_pubkey',
   ok: 'oracle_pubkey',
   ct: 'contract_pubkey',
@@ -157,7 +158,8 @@ const OBJECT_TAG_SOPHIA_BYTE_CODE = 70
 const TX_FIELD = (name, type, prefix) => [name, type, prefix]
 const TX_SCHEMA_FIELD = (schema, objectId) => [schema, objectId]
 
-const revertObject = (obj) => Object.entries(obj).reduce((acc, [key, v]) => (acc[v] = key) && acc, {})
+const revertObject = (obj) => Object.entries(obj)
+  .reduce((acc, [key, v]) => (acc[v] = key) && acc, {})
 
 /**
  * @constant
@@ -605,7 +607,8 @@ const CONTRACT_CALL_RESULT_TX = [
   TX_FIELD('gasUsed', FIELD_TYPES.int),
   TX_FIELD('returnValue', FIELD_TYPES.binary, 'cb'),
   TX_FIELD('returnType', FIELD_TYPES.callReturnType),
-  // TODO: add serialization for <log> :: [ { <address> :: id, [ <topics> :: binary() ], <data> :: binary() } ]
+  // TODO: add serialization for
+  //  <log> :: [ { <address> :: id, [ <topics> :: binary() ], <data> :: binary() } ]
   TX_FIELD('log', FIELD_TYPES.rawBinary)
 ]
 
@@ -985,19 +988,29 @@ export const TX_SERIALIZATION_SCHEMA = {
     1: TX_SCHEMA_FIELD(CHANNEL_SNAPSHOT_SOLO_TX, OBJECT_TAG_CHANNEL_SNAPSHOT_SOLO_TX)
   },
   [TX_TYPE.channelOffChainUpdateTransfer]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_UPDATE_TRANSFER_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_TRANSFER_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_UPDATE_TRANSFER_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_TRANSFER_TX
+    )
   },
   [TX_TYPE.channelOffChainUpdateDeposit]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_UPDATE_DEPOSIT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_DEPOSIT_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_UPDATE_DEPOSIT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_DEPOSIT_TX
+    )
   },
   [TX_TYPE.channelOffChainUpdateWithdrawal]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_UPDATE_WITHDRAWAL_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_WITHDRAWAL_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_UPDATE_WITHDRAWAL_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_WITHDRAWAL_TX
+    )
   },
   [TX_TYPE.channelOffChainCreateContract]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_CREATE_CONTRACT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_CREATE_CONTRACT_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_CREATE_CONTRACT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_CREATE_CONTRACT_TX
+    )
   },
   [TX_TYPE.channelOffChainCallContract]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_CALL_CONTRACT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_CALL_CONTRACT_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_CALL_CONTRACT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_CALL_CONTRACT_TX
+    )
   },
   [TX_TYPE.channelReconnect]: {
     1: TX_SCHEMA_FIELD(CHANNEL_RECONNECT_TX, OBJECT_TAG_CHANNEL_RECONNECT_TX)
@@ -1123,19 +1136,29 @@ export const TX_DESERIALIZATION_SCHEMA = {
     1: TX_SCHEMA_FIELD(CHANNEL_SNAPSHOT_SOLO_TX, OBJECT_TAG_CHANNEL_SNAPSHOT_SOLO_TX)
   },
   [OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_TRANSFER_TX]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_UPDATE_TRANSFER_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_TRANSFER_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_UPDATE_TRANSFER_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_TRANSFER_TX
+    )
   },
   [OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_DEPOSIT_TX]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_UPDATE_DEPOSIT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_DEPOSIT_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_UPDATE_DEPOSIT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_DEPOSIT_TX
+    )
   },
   [OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_WITHDRAWAL_TX]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_UPDATE_WITHDRAWAL_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_WITHDRAWAL_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_UPDATE_WITHDRAWAL_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_UPDATE_WITHDRAWAL_TX
+    )
   },
   [OBJECT_TAG_CHANNEL_OFFCHAIN_CREATE_CONTRACT_TX]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_CREATE_CONTRACT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_CREATE_CONTRACT_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_CREATE_CONTRACT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_CREATE_CONTRACT_TX
+    )
   },
   [OBJECT_TAG_CHANNEL_OFFCHAIN_CALL_CONTRACT_TX]: {
-    1: TX_SCHEMA_FIELD(CHANNEL_OFFCHAIN_CALL_CONTRACT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_CALL_CONTRACT_TX)
+    1: TX_SCHEMA_FIELD(
+      CHANNEL_OFFCHAIN_CALL_CONTRACT_TX, OBJECT_TAG_CHANNEL_OFFCHAIN_CALL_CONTRACT_TX
+    )
   },
   [OBJECT_TAG_CHANNEL_RECONNECT_TX]: {
     1: TX_SCHEMA_FIELD(CHANNEL_RECONNECT_TX, OBJECT_TAG_CHANNEL_RECONNECT_TX)