@aeternity/aepp-sdk 8.2.1 → 10.0.0

package/src/tx/index.js

@@ -72,7 +72,15 @@ const Tx = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype ({sender?: String, recipientId: String, amount: Number, fee?: Number, ttl?: Number, nonce?: Number, payload?: String}) => tx: Promise[String]
+ * @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
  */
@@ -83,7 +91,9 @@ const Tx = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype ({account?: String, commitment: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]
+ * @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
  */
@@ -94,7 +104,9 @@ const Tx = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype ({account?: String, name: String, nameSalt: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]
+ * @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
  */
@@ -105,7 +117,14 @@ const Tx = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype ({account?: String, nameId: String, recipientId: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]
+ * @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
  */
@@ -116,7 +135,16 @@ const Tx = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype ({account?: String, nameId: String, pointers: Object, nameTtl: Number, clientTtl: Number, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]
+ * @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
  */
@@ -127,7 +155,9 @@ const Tx = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype ({account?: String, nameId: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]
+ * @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
  */
@@ -138,7 +168,19 @@ const Tx = stampit(required({
  * @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]
+ * @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
  */
@@ -149,7 +191,18 @@ const Tx = stampit(required({
  * @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]
+ * @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
  */
@@ -160,7 +213,17 @@ const Tx = stampit(required({
  * @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]
+ * @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
  */
@@ -171,7 +234,14 @@ const Tx = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype ({ oracleId: String, callerId: String, oracleTtl: Object, fee?: Number, ttl: Number, nonce?: Number}) => tx: Promise[String]
+ * @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
  */
@@ -182,7 +252,17 @@ const Tx = stampit(required({
  * @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]
+ * @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
  */
@@ -193,7 +273,16 @@ const Tx = stampit(required({
  * @instance
  * @abstract
  * @category async
- * @rtype ({ oracleId: String, callerId: String, responseTtl: Object, queryId: String, response: String, fee?: Number, ttl?: Number, nonce?: Number}) => tx: Promise[String]
+ * @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
  */

package/src/tx/tx-object.js

@@ -5,7 +5,6 @@
  * @example import TxObject from '@aeternity/aepp-sdk/es/tx/tx-object'
  */
 import stampit from '@stamp/it'
-import { assertedType } from '../utils/crypto'
 import { buildTx, calculateFee, unpackTx } from './builder'
 import { TX_TYPE } from './builder/schema'
 import { encode } from './builder/helpers'
@@ -18,13 +17,17 @@ import { isHex } from '../utils/string'
  * @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 }}
+ * @return {{
+ *   encodedTx: String, binary: Array<Buffer>, rlpEncoded: Buffer, params: Object, type: String
+ * }}
  */
 const buildTransaction = (type, params, options = {}) => {
   if (typeof params !== 'object') throw new Error('"params" should be an object')
   if (typeof type !== 'string' || !Object.values(TX_TYPE).includes(type)) throw new Error(`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 })
+  const { rlpEncoded, binary, tx: encodedTx, txObject } = buildTx(
+    { ...params, fee }, type, { vsn: params.vsn, ...options }
+  )
   return { rlpEncoded, binary, encodedTx, params: txObject, type }
 }
 
@@ -33,12 +36,13 @@ const buildTransaction = (type, params, options = {}) => {
  * @alias module:@aeternity/aepp-sdk/es/tx/tx-object
  * @param {Buffer|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 }}
+ * @return {{
+ *   encodedTx: String, binary: Array<Buffer>, rlpEncoded: Buffer, type: String, params: Object
+ * }}
  */
 const unpackTransaction = (tx) => {
   if (!tx) throw new Error(`Invalid transaction: ${tx}`)
   if (typeof tx === 'string') {
-    if (!assertedType(tx, 'tx', true)) throw new Error('Invalid transaction string. Tx should be `tx` prefixed base58c string')
     const { txType: type, tx: params, rlpEncoded, binary } = unpackTx(tx)
     return { encodedTx: tx, type, params, rlpEncoded, binary }
   }
@@ -57,7 +61,9 @@ const unpackTransaction = (tx) => {
  * @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}}
+ * @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)
@@ -124,7 +130,12 @@ export const TxObject = stampit({
       if (typeof props !== 'object') throw new Error('Props should be an object')
       this.isSigned = false
       this.signatures = []
-      Object.assign(this, buildTransaction(this.type, { ...this.params, ...props, fee: null }, { ...this.options, ...options }))
+      Object.assign(
+        this,
+        buildTransaction(
+          this.type, { ...this.params, ...props, fee: null }, { ...this.options, ...options }
+        )
+      )
       return this
     },
     /**
@@ -145,7 +156,13 @@ export const TxObject = stampit({
     addSignature (signature) {
       signature = isHex(signature) ? Buffer.from(signature, 'hex') : signature
       if (!Buffer.isBuffer(signature) && !(signature instanceof Uint8Array)) throw new Error('Invalid signature, signature must be of type Buffer or Uint8Array')
-      Object.assign(this, buildTransaction(TX_TYPE.signed, { encodedTx: this.rlpEncoded, signatures: [[...this.signatures, signature]] }))
+      Object.assign(
+        this,
+        buildTransaction(
+          TX_TYPE.signed,
+          { encodedTx: this.rlpEncoded, signatures: [[...this.signatures, signature]] }
+        )
+      )
 
       const { signatures, encodedTx: { txType, tx } } = this.params
       this.signatures = signatures