@aeternity/aepp-sdk 10.0.0 → 12.0.0

package/src/node-pool/index.js

@@ -1,171 +0,0 @@
-/**
- * NodePool module
- * @module @aeternity/aepp-sdk/es/node-pool
- * @export NodePool
- * @example import { NodePool } from '@aeternity/aepp-sdk'
- */
-import stampit from '@stamp/it'
-import { getNetworkId } from '../node'
-
-/**
- * Node Pool Stamp
- * This stamp allow you to make basic manipulation(add, remove, select) on list of nodes
- * @function
- * @alias module:@aeternity/aepp-sdk/es/node-pool
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @param {Array} [options.nodes] - Array with Node instances
- * @return {Object} NodePool instance
- */
-export default stampit({
-  init ({ nodes = [] } = {}) {
-    this.pool = new Map()
-    this.validateNodes(nodes)
-
-    nodes.forEach((node, i) => {
-      const { name, instance } = node
-      this.addNode(name, instance, i === 0)
-    })
-    if (nodes.length) this.selectNode(nodes[0].name)
-  },
-  propertyDescriptors: {
-    api: {
-      enumerable: true,
-      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!')
-        }
-        return this.selectedNode.instance.api
-      }
-    }
-  },
-  methods: {
-    /**
-     * Add Node
-     * @function
-     * @alias module:@aeternity/aepp-sdk/es/node-pool
-     * @rtype (name: String, nodeInstance: Object, select: Boolean) => void
-     * @param {String} name - Node name
-     * @param {Object} node - Node instance
-     * @param {Boolean} select - Select this node as current
-     * @return {void}
-     * @example
-     * // 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`)
-
-      this.validateNodes([{ name, instance: node }])
-
-      this.pool.set(name, {
-        name,
-        instance: node,
-        url: node.url,
-        internalUrl: node.internalUrl,
-        networkId: node.nodeNetworkId,
-        version: node.version,
-        consensusProtocolVersion: node.consensusProtocolVersion
-      })
-      if (select || !this.selectedNode) {
-        this.selectNode(name)
-      }
-    },
-    /**
-     * Select Node
-     * @function
-     * @alias module:@aeternity/aepp-sdk/es/node-pool
-     * @rtype (name: String) => void
-     * @param {String} name - Node name
-     * @return {void}
-     * @example
-     * nodePool.selectNode('testNode')
-     */
-    selectNode (name) {
-      if (!this.pool.has(name)) throw new Error(`Node with name ${name} not in pool`)
-
-      this.selectedNode = this.pool.get(name)
-    },
-    /**
-     * Get NetworkId of current Node
-     * @function
-     * @alias module:@aeternity/aepp-sdk/es/node-pool
-     * @rtype () => String
-     * @return {String}
-     * @example
-     * nodePool.getNetworkId()
-     */
-    getNetworkId,
-    /**
-     * Check if you have selected node
-     * @function
-     * @alias module:@aeternity/aepp-sdk/es/node-pool
-     * @rtype () => Boolean
-     * @return {Boolean}
-     * @example
-     * nodePool.isNodeConnected()
-     */
-    isNodeConnected () {
-      return !!this.selectedNode.instance
-    },
-    /**
-     * Get information about node
-     * @function
-     * @alias module:@aeternity/aepp-sdk/es/node-pool
-     * @rtype () => Object
-     * @return {Object}
-     * @example
-     * nodePool.getNodeInfo() // { name, version, networkId, protocol, ... }
-     */
-    getNodeInfo () {
-      if (!this.isNodeConnected()) throw new Error('Can not get node info. Node is not connected')
-      return {
-        name: this.selectedNode.name,
-        ...this.selectedNode.instance.getNodeInfo()
-      }
-    },
-    /**
-     * Get array of available nodes
-     * @function
-     * @alias module:@aeternity/aepp-sdk/es/node-pool
-     * @rtype () => Object[]
-     * @return {Object[]}
-     * @example
-     * nodePool.getNodesInPool()
-     */
-    getNodesInPool () {
-      return Array.from(this.pool.entries()).map(([name, node]) => ({
-        name,
-        ...node.instance.getNodeInfo()
-      }))
-    },
-    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')
-      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: {
-    selectedNode: {}
-  }
-})

package/src/node.js

@@ -1,118 +0,0 @@
-/*
- * ISC License (ISC)
- * 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
- *  copyright notice and this permission notice appear in all copies.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- *  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- *  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- *  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- *  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- *  PERFORMANCE OF THIS SOFTWARE.
- */
-
-/**
- * Node module
- * @module @aeternity/aepp-sdk/es/node
- * @export Node
- * @example import { Node } from '@aeternity/aepp-sdk'
- */
-
-import AsyncInit from './utils/async-init'
-import genSwaggerClient from './utils/swagger'
-import semverSatisfies from './utils/semver-satisfies'
-
-/**
- * Obtain networkId from account or node
- * @instance
- * @category async
- * @rtype () => networkId: String
- * @return {String} NetworkId
- */
-export function getNetworkId ({ networkId, force = false } = {}) {
-  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
-}
-
-/**
- * {@link genSwaggerClient} based Node remote API Stamp
- * @function
- * @alias module:@aeternity/aepp-sdk/es/node
- * @rtype Stamp
- * @param {Object} [options={}] - Options
- * @param {String} options.url - Base URL for Node
- * @param {String} options.internalUrl - Base URL for internal requests
- * @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')
-    this.url = url.replace(/\/$/, '')
-    this.internalUrl = internalUrl ? internalUrl.replace(/\/$/, '') : this.url
-    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) &&
-      !ignoreVersion
-    ) {
-      throw new Error(
-        `Unsupported node version ${this.version}. ` +
-        `Supported: >= ${NODE_GE_VERSION} < ${NODE_LT_VERSION}`
-      )
-    }
-    this.api = client.api
-
-    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 })
-  },
-  methods: {
-    getNodeInfo () {
-      return {
-        url: this.url,
-        internalUrl: this.internalUrl,
-        nodeNetworkId: this.nodeNetworkId,
-        version: this.version,
-        consensusProtocolVersion: this.consensusProtocolVersion
-      }
-    }
-  },
-  props: {
-    version: null,
-    consensusProtocolVersion: null,
-    nodeNetworkId: null
-  }
-})
-
-const NODE_GE_VERSION = '6.2.0'
-const NODE_LT_VERSION = '7.0.0'
-
-export default Node

package/src/tx/builder/helpers.js

@@ -1,325 +0,0 @@
-import * as R from 'ramda'
-import BigNumber from 'bignumber.js'
-
-import {
-  decodeBase58Check,
-  decodeBase64Check,
-  encodeBase58Check, encodeBase64Check,
-  hash,
-  salt
-} from '../../utils/crypto'
-import { toBytes } from '../../utils/bytes'
-import {
-  ID_TAG_PREFIX,
-  PREFIX_ID_TAG,
-  NAME_BID_RANGES,
-  NAME_BID_MAX_LENGTH,
-  NAME_FEE,
-  NAME_FEE_BID_INCREMENT,
-  NAME_BID_TIMEOUTS,
-  NAME_MAX_LENGTH_FEE,
-  POINTER_KEY_BY_PREFIX
-} from './schema'
-import { ceil } from '../../utils/bignumber'
-
-/**
- * JavaScript-based Transaction builder helper function's
- * @module @aeternity/aepp-sdk/es/tx/builder/helpers
- * @export TxBuilderHelper
- * @example import { TxBuilderHelper } from '@aeternity/aepp-sdk'
- */
-
-export const createSalt = salt
-
-const base64Types = ['tx', 'st', 'ss', 'pi', 'ov', 'or', 'cb', 'cs', 'ba']
-
-/**
- * Build a contract public key
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {string} ownerId The public key of the owner account
- * @param {number} nonce the nonce of the transaction
- * @return {string} Contract public key
- */
-export function buildContractId (ownerId, nonce) {
-  const ownerIdAndNonce = Buffer.from([...decode(ownerId, 'ak'), ...toBytes(nonce)])
-  const b2bHash = hash(ownerIdAndNonce)
-  return encode(b2bHash, 'ct')
-}
-
-/**
- * Build a oracle query id
- * @function
- * @function* @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {String} senderId The public key of the sender account
- * @param {Number} nonce the nonce of the transaction
- * @param {Number} oracleId The oracle public key
- * @return {string} Contract public key
- */
-export function oracleQueryId (senderId, nonce, oracleId) {
-  function _int32 (val) {
-    const nonceBE = toBytes(val, true)
-    return Buffer.concat([Buffer.alloc(32 - nonceBE.length), nonceBE])
-  }
-
-  const b2bHash = hash(Buffer.from([...decode(senderId, 'ak'), ..._int32(nonce), ...decode(oracleId, 'ok')]))
-  return encode(b2bHash, 'oq')
-}
-
-/**
- * Format the salt into a 64-byte hex string
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {number} salt
- * @return {string} Zero-padded hex string of salt
- */
-export function formatSalt (salt) {
-  return Buffer.from(salt.toString(16).padStart(64, '0'), 'hex')
-}
-
-/**
- * Encode a domain name
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {String} name Name to encode
- * @return {String} `nm_` prefixed encoded domain name
- */
-export function produceNameId (name) {
-  ensureNameValid(name)
-  return encode(hash(name.toLowerCase()), 'nm')
-}
-
-/**
- * Generate the commitment hash by hashing the formatted salt and
- * name, base 58 encoding the result and prepending 'cm_'
- *
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @function commitmentHash
- * @category async
- * @rtype (name: String, salt?: String) => hash: Promise[String]
- * @param {String} name - Name to be registered
- * @param {Number} salt Random salt
- * @return {String} Commitment hash
- */
-export function commitmentHash (name, salt = createSalt()) {
-  ensureNameValid(name)
-  return `cm_${encodeBase58Check(hash(Buffer.concat([Buffer.from(name.toLowerCase()), formatSalt(salt)])))}`
-}
-
-/**
- * Decode data using the default encoding/decoding algorithm
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @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})`)
-  }
-  return (base64Types.includes(prefix) ? decodeBase64Check : decodeBase58Check)(payload)
-}
-
-/**
- * Encode data using the default encoding/decoding algorithm
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {Buffer|String} data  An decoded data
- * @param {string} type Prefix of Transaction
- * @return {String} Encoded string Base58check or Base64check data
- */
-export function encode (data, type) {
-  return `${type}_${base64Types.includes(type)
-    ? encodeBase64Check(data)
-    : encodeBase58Check(data)}`
-}
-
-/**
- * Utility function to create and _id type
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {string} hashId Encoded hash
- * @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.`)
-  return Buffer.from([...toBytes(idTag), ...decode(hashId, prefix)])
-}
-
-/**
- * Utility function to read and _id type
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {Buffer} buf Data
- * @return {String} Encoided hash string with prefix
- */
-export function readId (buf) {
-  const tag = buf.readUIntBE(0, 1)
-  const prefix = ID_TAG_PREFIX[tag]
-  if (!prefix) throw new Error(`Prefix for id-tag ${tag} not found.`)
-  return encode(buf.slice(1, buf.length), prefix)
-}
-
-/**
- * Utility function to convert int to bytes
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {Number|String|BigNumber} val Value
- * @return {Buffer} Buffer Buffer from number(BigEndian)
- */
-export function writeInt (val) {
-  return toBytes(val, true)
-}
-
-/**
- * Utility function to convert bytes to int
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {Buffer} buf Value
- * @return {String} Buffer Buffer from number(BigEndian)
- */
-export function readInt (buf = Buffer.from([])) {
-  return BigNumber(buf.toString('hex'), 16).toString(10)
-}
-
-/**
- * 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'} ])
- * @return {Array} Serialized pointers array
- */
-export function buildPointers (pointers) {
-  return pointers.map(
-    p => [
-      toBytes(p.key),
-      writeId(p.id)
-    ]
-  )
-}
-
-/**
- * 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'} ])
- * @return {Array} Deserialize pointer array
- */
-export function readPointers (pointers) {
-  return pointers.map(
-    ([key, id]) => Object.assign({
-      key: key.toString(),
-      id: readId(id)
-    })
-  )
-}
-
-/**
- * Ensure that name is valid
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {string} name
- * @return void
- * @throws Error
- */
-export function ensureNameValid (name) {
-  if (!name || typeof name !== 'string') throw new Error('Name must be a string')
-  if (!name.endsWith('.chain')) throw new Error(`Name should end with .chain: ${name}`)
-}
-
-/**
- * Is name valid
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {string} name
- * @return Boolean
- */
-export function isNameValid (name) {
-  try {
-    ensureNameValid(name)
-    return true
-  } catch (error) {
-    return false
-  }
-}
-
-/**
- * @param identifier - account/oracle/contract address, or channel
- * @returns {String} default AENS pointer key
- * @throws exception when default key not defined
- */
-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`) })()
-}
-
-/**
- * Get the minimum name fee for a domain
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {String} domain the domain name to get the fee for
- * @return {String} the minimum fee for the domain auction
- */
-export function getMinimumNameFee (domain) {
-  const nameLength = domain.replace('.chain', '').length
-  return NAME_BID_RANGES[nameLength >= NAME_MAX_LENGTH_FEE ? NAME_MAX_LENGTH_FEE : nameLength]
-}
-
-/**
- * Compute bid fee for AENS auction
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {String} domain the domain name to get the fee for
- * @param {Number|String} startFee Auction start fee
- * @param {Number} [increment=0.5] Bid multiplier(In percentage, must be between 0 and 1)
- * @return {String} Bid fee
- */
-export function computeBidFee (domain, startFee = NAME_FEE, increment = NAME_FEE_BID_INCREMENT) {
-  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))
-  )
-}
-
-/**
- * Compute auction end height
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {String} domain the domain name to get the fee for
- * @param {Number|String} claimHeight Auction starting height
- * @return {String} Auction end height
- */
-export function computeAuctionEndBlock (domain, claimHeight) {
-  return R.cond([
-    [R.lt(5), R.always(NAME_BID_TIMEOUTS[4].plus(claimHeight))],
-    [R.lt(9), R.always(NAME_BID_TIMEOUTS[8].plus(claimHeight))],
-    [R.lte(NAME_BID_MAX_LENGTH), R.always(NAME_BID_TIMEOUTS[12].plus(claimHeight))],
-    [R.T, R.always(BigNumber(claimHeight))]
-  ])(domain.replace('.chain', '').length).toString(10)
-}
-
-/**
- * Is name accept going to auction
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/builder/helpers
- * @param {String} name Transaction abiVersion
- * @return {Boolean}
- */
-export function isAuctionName (name) {
-  return name.replace('.chain', '').length < 13
-}