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

package/src/tx/builder/schema.js

@@ -8,7 +8,9 @@
 // # https://github.com/aeternity/protocol/blob/master/serializations.md#binary-serialization
 
 import BigNumber from 'bignumber.js'
+import { Name, NameId, NameFee, Deposit } from './field-types'
 
+export * from './constants'
 export const VSN = 1
 export const VSN_2 = 2
 
@@ -20,89 +22,11 @@ export const ORACLE_TTL = { type: 'delta', value: 500 }
 export const QUERY_TTL = { type: 'delta', value: 10 }
 export const RESPONSE_TTL = { type: 'delta', value: 10 }
 // # CONTRACT
-export const DEPOSIT = 0
 export const AMOUNT = 0
-export const GAS = 25000
+export const GAS_MAX = 1600000 - 21000
 export const MIN_GAS_PRICE = 1e9
 export const MAX_AUTH_FUN_GAS = 50000
 export const DRY_RUN_ACCOUNT = { pub: 'ak_11111111111111111111111111111111273Yts', amount: '100000000000000000000000000000000000' }
-// # AENS
-export const NAME_TTL = 180000
-// # max number of block into the future that the name is going to be available
-// # https://github.com/aeternity/protocol/blob/epoch-v0.22.0/AENS.md#update
-// # https://github.com/aeternity/protocol/blob/44a93d3aab957ca820183c3520b9daf6b0fedff4/AENS.md#aens-entry
-export const NAME_MAX_TTL = 36000
-export const NAME_MAX_CLIENT_TTL = 84600
-export const CLIENT_TTL = NAME_MAX_CLIENT_TTL
-export const NAME_FEE = 0
-// # see https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L67
-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
-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 = {
-  ak: 'account_pubkey',
-  ok: 'oracle_pubkey',
-  ct: 'contract_pubkey',
-  ch: 'channel'
-}
-// # https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L290
-// # https://github.com/aeternity/protocol/blob/master/AENS.md#protocol-fees-and-protection-times
-// # bid ranges:
-export const NAME_BID_RANGES = {
-  31: BigNumber(3).times(NAME_FEE_MULTIPLIER),
-  30: BigNumber(5).times(NAME_FEE_MULTIPLIER),
-  29: BigNumber(8).times(NAME_FEE_MULTIPLIER),
-  28: BigNumber(13).times(NAME_FEE_MULTIPLIER),
-  27: BigNumber(21).times(NAME_FEE_MULTIPLIER),
-  26: BigNumber(34).times(NAME_FEE_MULTIPLIER),
-  25: BigNumber(55).times(NAME_FEE_MULTIPLIER),
-  24: BigNumber(89).times(NAME_FEE_MULTIPLIER),
-  23: BigNumber(144).times(NAME_FEE_MULTIPLIER),
-  22: BigNumber(233).times(NAME_FEE_MULTIPLIER),
-  21: BigNumber(377).times(NAME_FEE_MULTIPLIER),
-  20: BigNumber(610).times(NAME_FEE_MULTIPLIER),
-  19: BigNumber(987).times(NAME_FEE_MULTIPLIER),
-  18: BigNumber(1597).times(NAME_FEE_MULTIPLIER),
-  17: BigNumber(2584).times(NAME_FEE_MULTIPLIER),
-  16: BigNumber(4181).times(NAME_FEE_MULTIPLIER),
-  15: BigNumber(6765).times(NAME_FEE_MULTIPLIER),
-  14: BigNumber(10946).times(NAME_FEE_MULTIPLIER),
-  13: BigNumber(17711).times(NAME_FEE_MULTIPLIER),
-  12: BigNumber(28657).times(NAME_FEE_MULTIPLIER),
-  11: BigNumber(46368).times(NAME_FEE_MULTIPLIER),
-  10: BigNumber(75025).times(NAME_FEE_MULTIPLIER),
-  9: BigNumber(121393).times(NAME_FEE_MULTIPLIER),
-  8: BigNumber(196418).times(NAME_FEE_MULTIPLIER),
-  7: BigNumber(317811).times(NAME_FEE_MULTIPLIER),
-  6: BigNumber(514229).times(NAME_FEE_MULTIPLIER),
-  5: BigNumber(832040).times(NAME_FEE_MULTIPLIER),
-  4: BigNumber(1346269).times(NAME_FEE_MULTIPLIER),
-  3: BigNumber(2178309).times(NAME_FEE_MULTIPLIER),
-  2: BigNumber(3524578).times(NAME_FEE_MULTIPLIER),
-  1: BigNumber(5702887).times(NAME_FEE_MULTIPLIER)
-}
-
-// # ref: https://github.com/aeternity/aeternity/blob/72e440b8731422e335f879a31ecbbee7ac23a1cf/apps/aecore/src/aec_governance.erl#L273
-// # name bid timeouts
-export const NAME_BID_TIMEOUTS = {
-  13: BigNumber(0),
-  12: BigNumber(NAME_BID_TIMEOUT_BLOCKS), // # 480 blocks
-  8: BigNumber(31).times(NAME_BID_TIMEOUT_BLOCKS), // # 14880 blocks
-  4: BigNumber(62).times(NAME_BID_TIMEOUT_BLOCKS) // # 29760 blocks
-}
-
-// # Tag constant for ids (type uint8)
-// # see https://github.com/aeternity/protocol/blob/master/serializations.md#the-id-type
-// # <<Tag:1/unsigned-integer-unit:8, Hash:32/binary-unit:8>>
-const ID_TAG_ACCOUNT = 1
-const ID_TAG_NAME = 2
-const ID_TAG_COMMITMENT = 3
-const ID_TAG_ORACLE = 4
-const ID_TAG_CONTRACT = 5
-const ID_TAG_CHANNEL = 6
 
 // # OBJECT tags
 // # see https://github.com/aeternity/protocol/blob/master/serializations.md#binary-serialization
@@ -157,8 +81,6 @@ 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, {})
-
 /**
  * @constant
  * @description Object with transaction types
@@ -225,7 +147,6 @@ export const TX_TYPE = {
   nameserviceTree: 'nameserviceTree',
   oraclesTree: 'oraclesTree',
   accountsTree: 'accountsTree',
-  // GA ACCOUNTS
   gaAttach: 'gaAttach',
   gaMeta: 'gaMeta',
   payingFor: 'payingFor',
@@ -325,7 +246,6 @@ export const OBJECT_ID_TX_TYPE = {
   [OBJECT_TAG_NAMESERVICE_TREE]: TX_TYPE.nameserviceTree,
   [OBJECT_TAG_ORACLES_TREE]: TX_TYPE.oraclesTree,
   [OBJECT_TAG_ACCOUNTS_TREE]: TX_TYPE.accountsTree,
-  // GA Accounts
   [OBJECT_TAG_GA_ATTACH]: TX_TYPE.gaAttach,
   [OBJECT_TAG_GA_META]: TX_TYPE.gaMeta,
   [OBJECT_TAG_PAYING_FOR]: TX_TYPE.payingFor,
@@ -402,35 +322,6 @@ export const TX_FEE_OTHER_GAS = (txType, txSize, { relativeTtl, innerTxSize }) =
   }
 }
 
-export const ID_TAG = {
-  account: ID_TAG_ACCOUNT,
-  name: ID_TAG_NAME,
-  commitment: ID_TAG_COMMITMENT,
-  oracle: ID_TAG_ORACLE,
-  contract: ID_TAG_CONTRACT,
-  channel: ID_TAG_CHANNEL
-}
-export const PREFIX_ID_TAG = {
-  ak: ID_TAG.account,
-  nm: ID_TAG.name,
-  cm: ID_TAG.commitment,
-  ok: ID_TAG.oracle,
-  ct: ID_TAG.contract,
-  ch: ID_TAG.channel
-}
-export const ID_TAG_PREFIX = revertObject(PREFIX_ID_TAG)
-const VALIDATION_ERROR = (msg) => msg
-
-export const VALIDATION_MESSAGE = {
-  [FIELD_TYPES.int]: ({ value, isMinusValue }) => isMinusValue ? VALIDATION_ERROR(`${value} must be >= 0`) : VALIDATION_ERROR(`${value} is not of type Number or BigNumber`),
-  [FIELD_TYPES.amount]: ({ value, isMinusValue }) => isMinusValue ? VALIDATION_ERROR(`${value} must be >= 0`) : VALIDATION_ERROR(`${value} is not of type Number or BigNumber`),
-  [FIELD_TYPES.id]: ({ value, prefix }) => VALIDATION_ERROR(`'${value}' prefix doesn't match expected prefix '${prefix}' or ID_TAG for prefix not found`),
-  [FIELD_TYPES.binary]: ({ prefix, value }) => VALIDATION_ERROR(`'${value}' prefix doesn't match expected prefix '${prefix}'`),
-  [FIELD_TYPES.string]: ({ value }) => VALIDATION_ERROR('Not a string'),
-  [FIELD_TYPES.pointers]: ({ value }) => VALIDATION_ERROR('Value must be of type Array and contains only object\'s like \'{key: "account_pubkey", id: "ak_lkamsflkalsdalksdlasdlasdlamd"}\''),
-  [FIELD_TYPES.ctVersion]: ({ value }) => VALIDATION_ERROR('Value must be an object with "vmVersion" and "abiVersion" fields')
-}
-
 const BASE_TX = [
   TX_FIELD('tag', FIELD_TYPES.int),
   TX_FIELD('VSN', FIELD_TYPES.int)
@@ -484,9 +375,9 @@ const NAME_CLAIM_TX_2 = [
   ...BASE_TX,
   TX_FIELD('accountId', FIELD_TYPES.id, 'ak'),
   TX_FIELD('nonce', FIELD_TYPES.int),
-  TX_FIELD('name', FIELD_TYPES.binary, 'nm'),
+  TX_FIELD('name', Name),
   TX_FIELD('nameSalt', FIELD_TYPES.int),
-  TX_FIELD('nameFee', FIELD_TYPES.amount),
+  TX_FIELD('nameFee', NameFee),
   TX_FIELD('fee', FIELD_TYPES.int),
   TX_FIELD('ttl', FIELD_TYPES.int)
 ]
@@ -495,7 +386,7 @@ const NAME_UPDATE_TX = [
   ...BASE_TX,
   TX_FIELD('accountId', FIELD_TYPES.id, 'ak'),
   TX_FIELD('nonce', FIELD_TYPES.int),
-  TX_FIELD('nameId', FIELD_TYPES.id, 'nm'),
+  TX_FIELD('nameId', NameId),
   TX_FIELD('nameTtl', FIELD_TYPES.int),
   TX_FIELD('pointers', FIELD_TYPES.pointers),
   TX_FIELD('clientTtl', FIELD_TYPES.int),
@@ -507,7 +398,7 @@ const NAME_TRANSFER_TX = [
   ...BASE_TX,
   TX_FIELD('accountId', FIELD_TYPES.id, 'ak'),
   TX_FIELD('nonce', FIELD_TYPES.int),
-  TX_FIELD('nameId', FIELD_TYPES.id, 'nm'),
+  TX_FIELD('nameId', NameId),
   TX_FIELD('recipientId', FIELD_TYPES.id, ['ak', 'nm']),
   TX_FIELD('fee', FIELD_TYPES.int),
   TX_FIELD('ttl', FIELD_TYPES.int)
@@ -517,7 +408,7 @@ const NAME_REVOKE_TX = [
   ...BASE_TX,
   TX_FIELD('accountId', FIELD_TYPES.id, 'ak'),
   TX_FIELD('nonce', FIELD_TYPES.int),
-  TX_FIELD('nameId', FIELD_TYPES.id, 'nm'),
+  TX_FIELD('nameId', NameId),
   TX_FIELD('fee', FIELD_TYPES.int),
   TX_FIELD('ttl', FIELD_TYPES.int)
 ]
@@ -530,7 +421,7 @@ const CONTRACT_TX = [
   TX_FIELD('log', FIELD_TYPES.binary, 'cb'),
   TX_FIELD('active', FIELD_TYPES.bool),
   TX_FIELD('referers', FIELD_TYPES.ids, 'ak'),
-  TX_FIELD('deposit', FIELD_TYPES.amount)
+  TX_FIELD('deposit', Deposit)
 ]
 
 const GA_ATTACH_TX = [
@@ -574,7 +465,7 @@ const CONTRACT_CREATE_TX = [
   TX_FIELD('ctVersion', FIELD_TYPES.ctVersion),
   TX_FIELD('fee', FIELD_TYPES.int),
   TX_FIELD('ttl', FIELD_TYPES.int),
-  TX_FIELD('deposit', FIELD_TYPES.amount),
+  TX_FIELD('deposit', Deposit),
   TX_FIELD('amount', FIELD_TYPES.amount),
   TX_FIELD('gas', FIELD_TYPES.int),
   TX_FIELD('gasPrice', FIELD_TYPES.int),
@@ -605,7 +496,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)
 ]
 
@@ -749,8 +641,8 @@ const CHANNEL_FORCE_PROGRESS_TX = [
   TX_FIELD('fromId', FIELD_TYPES.id, 'ak'),
   TX_FIELD('payload', FIELD_TYPES.binary, 'tx'),
   TX_FIELD('round', FIELD_TYPES.int),
-  TX_FIELD('update', FIELD_TYPES.binary),
-  TX_FIELD('stateHash', FIELD_TYPES.binary),
+  TX_FIELD('update', FIELD_TYPES.binary, 'cb'),
+  TX_FIELD('stateHash', FIELD_TYPES.binary, 'st'),
   TX_FIELD('offChainTrees', FIELD_TYPES.stateTree),
   TX_FIELD('ttl', FIELD_TYPES.int),
   TX_FIELD('fee', FIELD_TYPES.int),
@@ -985,19 +877,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 +1025,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)

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

@@ -9,6 +9,7 @@ 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
@@ -17,33 +18,40 @@ 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}`)
+  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 })
+  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 {Buffer|String} tx RLP encoded binary or base64c(rlpBinary) string
+ * @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 }}
+ * @return {{
+ *   encodedTx: String, binary: Array<Buffer>, rlpEncoded: Buffer, type: String, params: Object
+ * }}
  */
 const unpackTransaction = (tx) => {
-  if (!tx) throw new Error(`Invalid transaction: ${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 (Buffer.isBuffer(tx)) {
+  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`)
 }
 
 /**
@@ -55,12 +63,14 @@ 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)
   if (tx) return unpackTransaction(tx)
-  throw new Error('Invalid TxObject arguments. Please provide one of { tx: "tx_asdasd23..." } or { type: "spendTx", params: {...} }')
+  throw new InvalidTxError('Invalid TxObject arguments. Please provide one of { tx: "tx_asdasd23..." } or { type: "spendTx", params: {...} }')
 }
 
 /**
@@ -119,10 +129,15 @@ export const TxObject = stampit({
      * @return {TxObject}
      */
     setProp (props = {}, options = {}) {
-      if (typeof props !== 'object') throw new Error('Props should be an object')
+      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 }))
+      Object.assign(
+        this,
+        buildTransaction(
+          this.type, { ...this.params, ...props, fee: null }, { ...this.options, ...options }
+        )
+      )
       return this
     },
     /**
@@ -131,7 +146,6 @@ export const TxObject = stampit({
      * @return {Array} Array of signatures
      */
     getSignatures () {
-      if (!this.isSigned) throw new Error('Signature not found, transaction is not signed')
       return this.signatures
     },
     /**
@@ -142,8 +156,14 @@ 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]] }))
+      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