@aeternity/aepp-sdk 11.0.1 → 12.0.0

package/src/tx/index.js

@@ -1,301 +0,0 @@
-/*
- * ISC License (ISC)
- * Copyright (c) 2018 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.
- */
-
-/**
- * Tx module
- * @module @aeternity/aepp-sdk/es/tx
- * @export Tx
- * @example import { Tx } from '@aeternity/aepp-sdk'
- */
-
-import stampit from '@stamp/it'
-import { required } from '@stamp/required'
-
-/**
- * Basic Tx Stamp
- *
- * Attempting to create instances from the Stamp without overwriting all
- * abstract methods using composition will result in an exception.
- *
- * Tx is one of the three basic building blocks of an
- * {@link module:@aeternity/aepp-sdk/es/ae--Ae} client and provides methods to
- * create aeternity transactions.
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @return {Object} Tx instance
- * @example Tx()
- */
-const Tx = stampit(required({
-  methods: {
-    spendTx: required,
-    namePreclaimTx: required,
-    nameClaimTx: required,
-    nameTransferTx: required,
-    nameUpdateTx: required,
-    nameRevokeTx: required,
-    contractCreateTx: required,
-    contractCallTx: required,
-    oracleRegisterTx: required,
-    oracleExtendTx: required,
-    oraclePostQueryTx: required,
-    oracleRespondTx: required,
-    getAccountNonce: required,
-    channelCloseSoloTx: required,
-    channelSlashTx: required,
-    channelSettleTx: required,
-    channelSnapshotSoloTx: required,
-    gaAttachTx: required,
-    getVmVersion: required,
-    prepareTxParams: required
-  }
-}))
-
-/**
- * Create a `spend_tx` transaction
- * @function spendTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   sender?: String,
- *   recipientId: String,
- *   amount: Number,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number,
- *   payload?: String
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `spend_tx` transaction
- */
-
-/**
- * Create a `name_preclaim_tx` transaction
- * @function namePreclaimTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String, commitment: String, fee?: Number, ttl?: Number, nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_preclaim_tx` transaction
- */
-
-/**
- * Create a `name_claim_tx` transaction
- * @function nameClaimTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String, name: String, nameSalt: String, fee?: Number, ttl?: Number, nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_claim_tx` transaction
- */
-
-/**
- * Create a `name_transfer_tx` transaction
- * @function nameTransferTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String,
- *   nameId: String,
- *   recipientId: String,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_transfer_tx` transaction
- */
-
-/**
- * Create a `name_update_tx` transaction
- * @function nameUpdateTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String,
- *   nameId: String,
- *   pointers: Object,
- *   nameTtl: Number,
- *   clientTtl: Number,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_update_tx` transaction
- */
-
-/**
- * Create a `name_revoke_tx` transaction
- * @function nameRevokeTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   account?: String, nameId: String, fee?: Number, ttl?: Number, nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `name_revoke_tx` transaction
- */
-
-/**
- * Create a `contract_create_tx` transaction
- * @function contractCreateTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   owner: String,
- *   code: String,
- *   callData: String,
- *   vmVersion: Number,
- *   deposit: Number,
- *   amount: Number,
- *   gas: Number,
- *   gasPrice: Number,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `contract_create_tx` transaction
- */
-
-/**
- * Create a `contract_call_tx` transaction
- * @function contractCallTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   callerId: String,
- *   contract: String,
- *   callData: String,
- *   vmVersion: Number,
- *   amount: Number,
- *   gas: Number,
- *   gasPrice: Number,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `contract_call_tx` transaction
- */
-
-/**
- * Create a `oracle_register_tx` transaction
- * @function oracleRegisterTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   accountId: String,
- *   queryFormat: String,
- *   responseFormat: String,
- *   queryFee: String|Number,
- *   oracleTtl: Object,
- *   vmVersion: Number = ORACLE_VM_VERSION,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `oracle_register_tx` transaction
- */
-
-/**
- * Create a `oracle_extend_tx` transaction
- * @function oracleExtendTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   oracleId: String,
- *   callerId: String,
- *   oracleTtl: Object,
- *   fee?: Number,
- *   ttl: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `oracle_extend_tx` transaction
- */
-
-/**
- * Create a `oracle_post_query_tx` transaction
- * @function oraclePostQuery
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   oracleId: String,
- *   responseTtl: Object,
- *   query: String,
- *   queryTtl: Object,
- *   queryFee: String|Number,
- *   senderId: String,
- *   fee?: Number,
- *   ttl: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `oracle_post_query_tx` transaction
- */
-
-/**
- * Create a `oracle_respond_tx` transaction
- * @function oracleRespondTx
- * @instance
- * @abstract
- * @category async
- * @rtype ({
- *   oracleId: String,
- *   callerId: String,
- *   responseTtl: Object,
- *   queryId: String,
- *   response: String,
- *   fee?: Number,
- *   ttl?: Number,
- *   nonce?: Number
- * }) => tx: Promise[String]
- * @param {Object} options - The object to extract properties from
- * @return {String} `oracle_respond_tx` transaction
- */
-
-/**
- * Get Account Nonce
- * @function getAccountNonce
- * @instance
- * @abstract
- * @category async
- * @rtype (address) => result: Number
- * @param {String} address - Account public key
- * @return {Number} Result
- */
-
-export default Tx

package/src/tx/tx-object.js

@@ -1,187 +0,0 @@
-/**
- * TxObject module
- * @module @aeternity/aepp-sdk/es/tx/tx-object
- * @export TxObject
- * @example import TxObject from '@aeternity/aepp-sdk/es/tx/tx-object'
- */
-import stampit from '@stamp/it'
-import { buildTx, calculateFee, unpackTx } from './builder'
-import { TX_TYPE } from './builder/schema'
-import { encode } from './builder/helpers'
-import { isHex } from '../utils/string'
-import { InvalidTxError, TypeError, UnknownTxError, InvalidSignatureError } from '../utils/errors'
-
-/**
- * Build transaction from object
- * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
- * @param {String} type Transaction type
- * @param {Object} params Transaction params
- * @param {Object} [options={}] Options
- * @throws {Error} Arguments validation error's
- * @return {{
- *   encodedTx: String, binary: Array<Buffer>, rlpEncoded: Buffer, params: Object, type: String
- * }}
- */
-const buildTransaction = (type, params, options = {}) => {
-  if (typeof params !== 'object') throw new TypeError('tx "params" should be an object')
-  if (typeof type !== 'string' || !Object.values(TX_TYPE).includes(type)) throw new UnknownTxError(`Unknown transaction type ${type}`)
-  const fee = calculateFee(params.fee, type, { gas: params.gas, params, vsn: params.vsn })
-  const { rlpEncoded, binary, tx: encodedTx, txObject } = buildTx(
-    { ...params, fee }, type, { vsn: params.vsn, ...options }
-  )
-  return { rlpEncoded, binary, encodedTx, params: txObject, type }
-}
-
-/**
- * Unpack transaction from RLP encoded binary or base64c string
- * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
- * @param {Uint8Array|String} tx RLP encoded binary or base64c(rlpBinary) string
- * @throws {Error} Arguments validation error's
- * @return {{
- *   encodedTx: String, binary: Array<Buffer>, rlpEncoded: Buffer, type: String, params: Object
- * }}
- */
-const unpackTransaction = (tx) => {
-  if (!tx) throw new InvalidTxError(`Invalid transaction: ${tx}`)
-  if (typeof tx === 'string') {
-    const { txType: type, tx: params, rlpEncoded, binary } = unpackTx(tx)
-    return { encodedTx: tx, type, params, rlpEncoded, binary }
-  }
-  if (tx instanceof Uint8Array) {
-    const { txType: type, tx: params, rlpEncoded, binary } = unpackTx(tx, true)
-    return { encodedTx: encode(tx, 'tx'), type, params, rlpEncoded, binary }
-  }
-  throw new InvalidTxError(`"tx" should be a string or Uint8Array, got ${tx} instead`)
-}
-
-/**
- * Helper which build or unpack transaction base on constructor arguments
- * Need to provide one of arguments: [tx] -> unpack flow or [params, type] -> build flow
- * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
- * @param {Buffer|String} [tx] Transaction rlp binary or vase64c string
- * @param {Object} params Transaction params
- * @param {String} type Transaction type
- * @param {Object} [options={}] Options
- * @throws {Error} Arguments validation error's
- * @return {{
- *   encodedTx: String, binary: Array<Buffer>, rlpEncoded: Buffer, type: String, params: Object
- * }}
- */
-const initTransaction = ({ tx, params, type, options = {} } = {}) => {
-  if (params && type) return buildTransaction(type, params, options)
-  if (tx) return unpackTransaction(tx)
-  throw new InvalidTxError('Invalid TxObject arguments. Please provide one of { tx: "tx_asdasd23..." } or { type: "spendTx", params: {...} }')
-}
-
-/**
- * Transaction Validator Stamp
- * This stamp give us possibility to unpack and validate some of transaction properties,
- * to make sure we can post it to the chain
- * @function
- * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
- * @rtype Stamp
- * @param {Object} [options={}] - Initializer object
- * @param {Buffer|String} [options.tx] - Rlp binary or base64c transaction
- * @param {Object} [options.params] - Transaction params
- * @param {String} [options.type] - Transaction type
- * @param {Object} [options.options] - Build options
- * @return {Object} TxObject instance
- * @example TxObject({ params: {...}, type: 'spendTx' })
- */
-export const TxObject = stampit({
-  init ({ tx, params, type, options = {} } = {}) {
-    this.options = options
-    this.signatures = []
-    Object.assign(this, initTransaction({ tx, params, type, options }))
-
-    if (this.type === TX_TYPE.signed) {
-      const { signatures, encodedTx: { txType, tx } } = this.params
-      this.signatures = signatures
-      this.params = tx
-      this.type = txType
-      this.isSigned = true
-    }
-  },
-  statics: {
-    /**
-     * Create txObject from base64c RLP encoded transaction string with 'tx_' prefix
-     * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
-     * @static
-     * @param {String} tx Transaction string (tx_23fsdgsdfg...)
-     * @return {TxObject}
-     */
-    fromString: (tx) => TxObject({ tx }),
-    /**
-     * Create txObject from transaction RLP binary
-     * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
-     * @static
-     * @param {Buffer} tx Transaction RLP binary
-     * @return {TxObject}
-     */
-    fromRlp: (tx) => TxObject({ tx })
-  },
-  methods: {
-    /**
-     * Rebuild transaction with new params and recalculate fee
-     * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
-     * @param {Object} props Transaction properties for update
-     * @param options
-     * @return {TxObject}
-     */
-    setProp (props = {}, options = {}) {
-      if (typeof props !== 'object') throw new TypeError('Props should be an object')
-      this.isSigned = false
-      this.signatures = []
-      Object.assign(
-        this,
-        buildTransaction(
-          this.type, { ...this.params, ...props, fee: null }, { ...this.options, ...options }
-        )
-      )
-      return this
-    },
-    /**
-     * Get signatures
-     * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
-     * @return {Array} Array of signatures
-     */
-    getSignatures () {
-      return this.signatures
-    },
-    /**
-     * Add signature
-     * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
-     * @param {Buffer|String} signature Signature to add ( Can be: Buffer | Uint8Array | HexString )
-     * @return {void}
-     */
-    addSignature (signature) {
-      signature = isHex(signature) ? Buffer.from(signature, 'hex') : signature
-      if (!Buffer.isBuffer(signature) && !(signature instanceof Uint8Array)) throw new InvalidSignatureError('Invalid signature, signature must be of type Buffer or Uint8Array')
-      Object.assign(
-        this,
-        buildTransaction(
-          TX_TYPE.signed,
-          { encodedTx: this.rlpEncoded, signatures: [[...this.signatures, signature]] }
-        )
-      )
-
-      const { signatures, encodedTx: { txType, tx } } = this.params
-      this.signatures = signatures
-      this.params = tx
-      this.type = txType
-      this.isSigned = true
-    },
-    /**
-     * Calculate fee
-     * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
-     * @param {Object} props
-     * @return {String} fee
-     */
-    calculateMinFee (props = {}) {
-      const params = { ...this.params, ...props }
-      return calculateFee(0, this.type, { gas: params.gas, params, vsn: params.vsn })
-    }
-  }
-})
-
-export default TxObject