@aeternity/aepp-sdk 11.0.0 → 12.1.0

package/es/utils/errors.mjs

@@ -1,11 +1,8 @@
-/**
- * Error module
- * @module @aeternity/aepp-sdk/es/utils/errors
- * @example import { BytecodeMismatchError } from '@aeternity/aepp-sdk'
- */
+// eslint-disable-next-line max-classes-per-file
 
 /**
  * aepp-sdk originated error
+ * @category exception
  */
 export class BaseError extends Error {
   constructor(message) {
@@ -14,6 +11,10 @@ export class BaseError extends Error {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class AccountError extends BaseError {
   constructor(message) {
     super(message);
@@ -21,6 +22,10 @@ export class AccountError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class AensError extends BaseError {
   constructor(message) {
     super(message);
@@ -28,6 +33,10 @@ export class AensError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class AeppError extends BaseError {
   constructor(message) {
     super(message);
@@ -35,6 +44,10 @@ export class AeppError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class ChannelError extends BaseError {
   constructor(message) {
     super(message);
@@ -42,6 +55,10 @@ export class ChannelError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class CompilerError extends BaseError {
   constructor(message) {
     super(message);
@@ -49,6 +66,10 @@ export class CompilerError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class ContractError extends BaseError {
   constructor(message) {
     super(message);
@@ -56,6 +77,10 @@ export class ContractError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class CryptographyError extends BaseError {
   constructor(message) {
     super(message);
@@ -63,6 +88,10 @@ export class CryptographyError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class NodeError extends BaseError {
   constructor(message) {
     super(message);
@@ -70,6 +99,10 @@ export class NodeError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class TransactionError extends BaseError {
   constructor(message) {
     super(message);
@@ -77,6 +110,10 @@ export class TransactionError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class WalletError extends BaseError {
   constructor(message) {
     super(message);
@@ -84,15 +121,21 @@ export class WalletError extends BaseError {
   }
 
 }
-/* Common error patterns */
+/**
+ * @category exception
+ */
 
 export class ArgumentError extends BaseError {
   constructor(argumentName, requirement, argumentValue) {
-    super(`${argumentName} should be ${requirement}, got ${argumentValue} instead`);
+    super(`${argumentName} should be ${requirement}, got ${String(argumentValue)} instead`);
     this.name = 'ArgumentError';
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class IllegalArgumentError extends CryptographyError {
   constructor(message) {
     super(message);
@@ -100,6 +143,10 @@ export class IllegalArgumentError extends CryptographyError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class ArgumentCountMismatchError extends BaseError {
   constructor(functionName, requiredCount, providedCount) {
     super(`${functionName} expects ${requiredCount} arguments, got ${providedCount} instead`);
@@ -107,6 +154,10 @@ export class ArgumentCountMismatchError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class InsufficientBalanceError extends BaseError {
   constructor(message) {
     super(message);
@@ -114,20 +165,10 @@ export class InsufficientBalanceError extends BaseError {
   }
 
 }
-export class InvalidDenominationError extends BaseError {
-  constructor(message) {
-    super(message);
-    this.name = 'InvalidDenominationError';
-  }
-
-}
-export class InvalidNameError extends BaseError {
-  constructor(message) {
-    super(message);
-    this.name = 'InvalidNameError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class MissingParamError extends BaseError {
   constructor(message) {
     super(message);
@@ -135,13 +176,10 @@ export class MissingParamError extends BaseError {
   }
 
 }
-export class NoBrowserFoundError extends BaseError {
-  constructor() {
-    super('Browser is not detected');
-    this.name = 'NoBrowserFoundError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class NoSerializerFoundError extends BaseError {
   constructor() {
     super('Byte serialization not supported');
@@ -149,25 +187,32 @@ export class NoSerializerFoundError extends BaseError {
   }
 
 }
-export class RequestTimedOutError extends BaseError {
-  constructor(requestTime, currentHeight, height) {
-    if (currentHeight !== undefined && height !== undefined) {
-      super(`Giving up after ${requestTime}ms, current height: ${currentHeight}, desired height: ${height}`);
-    } else {
-      super(`Giving up after ${requestTime} ms`);
-    }
+/**
+ * @category exception
+ */
 
+export class RequestTimedOutError extends BaseError {
+  constructor(height) {
+    super(`Giving up at height ${height}`);
     this.name = 'RequestTimedOutError';
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class TxTimedOutError extends BaseError {
-  constructor(blocks, th, status) {
-    super([`Giving up after ${blocks} blocks mined`, `transaction hash: ${th}`, ...(status ? [`status: ${status}`] : [])].join(', '));
+  constructor(blocks, th) {
+    super([`Giving up after ${blocks} blocks mined`, `transaction hash: ${th}`].join(', '));
     this.name = 'TxTimedOutError';
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class TypeError extends BaseError {
   constructor(message) {
     super(message);
@@ -175,6 +220,10 @@ export class TypeError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnsupportedPlatformError extends BaseError {
   constructor(message) {
     super(message);
@@ -182,6 +231,10 @@ export class UnsupportedPlatformError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnsupportedProtocolError extends BaseError {
   constructor(message) {
     super(message);
@@ -189,6 +242,10 @@ export class UnsupportedProtocolError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class NotImplementedError extends BaseError {
   constructor(message) {
     super(message);
@@ -196,6 +253,10 @@ export class NotImplementedError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnsupportedVersionError extends BaseError {
   constructor(dependency, version, geVersion, ltVersion) {
     super(`Unsupported ${dependency} version ${version}. Supported: >= ${geVersion} < ${ltVersion}`);
@@ -203,6 +264,10 @@ export class UnsupportedVersionError extends BaseError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class InternalError extends BaseError {
   constructor(message) {
     super(message);
@@ -210,7 +275,21 @@ export class InternalError extends BaseError {
   }
 
 }
-/* keypair an account related errors */
+/**
+ * @category exception
+ */
+
+export class UnexpectedTsError extends InternalError {
+  constructor() {
+    let message = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'Expected to not happen, required for TS';
+    super(message);
+    this.name = 'UnexpectedTsError';
+  }
+
+}
+/**
+ * @category exception
+ */
 
 export class InvalidKeypairError extends AccountError {
   constructor(message) {
@@ -219,6 +298,10 @@ export class InvalidKeypairError extends AccountError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnavailableAccountError extends AccountError {
   constructor(address) {
     super(`Account for ${address} not available`);
@@ -226,7 +309,9 @@ export class UnavailableAccountError extends AccountError {
   }
 
 }
-/* errors originating from AENS operation */
+/**
+ * @category exception
+ */
 
 export class AensPointerContextError extends AensError {
   constructor(nameOrId, prefix) {
@@ -235,13 +320,21 @@ export class AensPointerContextError extends AensError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class InsufficientNameFeeError extends AensError {
   constructor(nameFee, minNameFee) {
-    super(`the provided fee ${nameFee} is not enough to execute the claim, required: ${minNameFee}`);
+    super(`the provided fee ${nameFee.toString()} is not enough to execute the claim, required: ${minNameFee.toString()}`);
     this.name = 'InsufficientNameFeeError';
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class InvalidAensNameError extends AensError {
   constructor(message) {
     super(message);
@@ -249,15 +342,10 @@ export class InvalidAensNameError extends AensError {
   }
 
 }
-/* Aepp Errors */
-
-export class DuplicateCallbackError extends AeppError {
-  constructor() {
-    super('Callback Already exist');
-    this.name = 'DuplicateCallbackError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class InvalidRpcMessageError extends AeppError {
   constructor(message) {
     super(`Received invalid message: ${message}`);
@@ -265,6 +353,10 @@ export class InvalidRpcMessageError extends AeppError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class MissingCallbackError extends AeppError {
   constructor(id) {
     super(`Can't find callback for this messageId ${id}`);
@@ -272,6 +364,10 @@ export class MissingCallbackError extends AeppError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnAuthorizedAccountError extends AeppError {
   constructor(onAccount) {
     super(`You do not have access to account ${onAccount}`);
@@ -279,6 +375,10 @@ export class UnAuthorizedAccountError extends AeppError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnknownRpcClientError extends AeppError {
   constructor(id) {
     super(`RpcClient with id ${id} do not exist`);
@@ -286,6 +386,10 @@ export class UnknownRpcClientError extends AeppError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnsubscribedAccountError extends AeppError {
   constructor() {
     super('You are not subscribed for an account.');
@@ -293,7 +397,9 @@ export class UnsubscribedAccountError extends AeppError {
   }
 
 }
-/* Channel originated errors */
+/**
+ * @category exception
+ */
 
 export class ChannelCallError extends ChannelError {
   constructor(message) {
@@ -302,6 +408,10 @@ export class ChannelCallError extends ChannelError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class ChannelConnectionError extends ChannelError {
   constructor(message) {
     super(message);
@@ -309,6 +419,10 @@ export class ChannelConnectionError extends ChannelError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class ChannelPingTimedOutError extends ChannelError {
   constructor() {
     super('Server pong timed out');
@@ -316,6 +430,10 @@ export class ChannelPingTimedOutError extends ChannelError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnexpectedChannelMessageError extends ChannelError {
   constructor(message) {
     super(message);
@@ -323,6 +441,10 @@ export class UnexpectedChannelMessageError extends ChannelError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnknownChannelStateError extends ChannelError {
   constructor() {
     super('State Channels FSM entered unknown state');
@@ -330,9 +452,9 @@ export class UnknownChannelStateError extends ChannelError {
   }
 
 }
-/* compiler issued errors */
-
-/* errors from option validations */
+/**
+ * @category exception
+ */
 
 export class InvalidAuthDataError extends CompilerError {
   constructor(message) {
@@ -341,7 +463,9 @@ export class InvalidAuthDataError extends CompilerError {
   }
 
 }
-/* contract invocation errors */
+/**
+ * @category exception
+ */
 
 export class BytecodeMismatchError extends ContractError {
   constructor(source) {
@@ -350,6 +474,10 @@ export class BytecodeMismatchError extends ContractError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class DuplicateContractError extends ContractError {
   constructor() {
     super('Contract already deployed');
@@ -357,6 +485,10 @@ export class DuplicateContractError extends ContractError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class InactiveContractError extends ContractError {
   constructor(contractAddress) {
     super(`Contract with address ${contractAddress} not active`);
@@ -364,6 +496,10 @@ export class InactiveContractError extends ContractError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class InvalidMethodInvocationError extends ContractError {
   constructor(message) {
     super(message);
@@ -371,6 +507,10 @@ export class InvalidMethodInvocationError extends ContractError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class MissingContractAddressError extends ContractError {
   constructor(message) {
     super(message);
@@ -378,6 +518,10 @@ export class MissingContractAddressError extends ContractError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class MissingContractDefError extends ContractError {
   constructor() {
     super('Either ACI or source code is required');
@@ -385,6 +529,10 @@ export class MissingContractDefError extends ContractError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class MissingFunctionNameError extends ContractError {
   constructor() {
     super('Function name is required');
@@ -392,16 +540,22 @@ export class MissingFunctionNameError extends ContractError {
   }
 
 }
-export class NodeInvocationError extends ContractError {
-  constructor(message) {
-    var _message;
+/**
+ * @category exception
+ */
 
-    message = (_message = message) !== null && _message !== void 0 ? _message : '';
-    super(`Invocation failed${message === '' ? '' : `: "${message}"`}`);
+export class NodeInvocationError extends ContractError {
+  constructor(message, transaction) {
+    super(`Invocation failed${message == null ? '' : `: "${message}"`}`);
     this.name = 'NodeInvocationError';
+    this.transaction = transaction;
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class NoSuchContractFunctionError extends ContractError {
   constructor(name) {
     super(`Function ${name} doesn't exist in contract`);
@@ -409,13 +563,21 @@ export class NoSuchContractFunctionError extends ContractError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class NotPayableFunctionError extends ContractError {
   constructor(amount, fn) {
-    super(`You try to pay "${amount}" to function "${fn}" which is not payable. ` + 'Only payable function can accept tokens');
+    super(`You try to pay "${amount}" to function "${fn}" which is not payable. ` + 'Only payable function can accept coins');
     this.name = 'NotPayableFunctionError';
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class MissingEventDefinitionError extends ContractError {
   constructor(eventNameHash, eventAddress) {
     super(`Can't find definition of ${eventNameHash} event emitted by ${eventAddress}` + ' (use omitUnknown option to ignore events like this)');
@@ -423,6 +585,10 @@ export class MissingEventDefinitionError extends ContractError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class AmbiguousEventDefinitionError extends ContractError {
   constructor(eventAddress, matchedEvents) {
     super(`Found multiple definitions of "${matchedEvents[0][1]}" event emitted by ${eventAddress}` + ` in ${matchedEvents.map(_ref => {
@@ -433,7 +599,9 @@ export class AmbiguousEventDefinitionError extends ContractError {
   }
 
 }
-/* cryptography errors */
+/**
+ * @category exception
+ */
 
 export class InvalidChecksumError extends CryptographyError {
   constructor() {
@@ -442,27 +610,21 @@ export class InvalidChecksumError extends CryptographyError {
   }
 
 }
-export class InvalidDerivationPathError extends CryptographyError {
-  constructor() {
-    super('Invalid path');
-    this.name = 'InvalidDerivationPathError';
-  }
-
-}
-export class InvalidKeyError extends CryptographyError {
-  constructor(message) {
-    super(message);
-    this.name = 'InvalidKeyError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class InvalidPasswordError extends CryptographyError {
-  constructor(message) {
-    super(message);
+  constructor() {
+    super('Invalid password or nonce');
     this.name = 'InvalidPasswordError';
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class MerkleTreeHashMismatchError extends CryptographyError {
   constructor() {
     super('Node hash is not equal to provided one');
@@ -470,6 +632,10 @@ export class MerkleTreeHashMismatchError extends CryptographyError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class MissingNodeInTreeError extends CryptographyError {
   constructor(message) {
     super(message);
@@ -477,20 +643,10 @@ export class MissingNodeInTreeError extends CryptographyError {
   }
 
 }
-export class UnsupportedAlgorithmError extends CryptographyError {
-  constructor(algo) {
-    super(algo + ' is not available');
-    this.name = 'UnsupportedAlgorithmError';
-  }
-
-}
-export class NotHardenedSegmentError extends CryptographyError {
-  constructor(message) {
-    super(message);
-    this.name = 'NotHardenedSegmentError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class UnknownNodeLengthError extends CryptographyError {
   constructor(nodeLength) {
     super(`Unknown node length: ${nodeLength}`);
@@ -498,6 +654,10 @@ export class UnknownNodeLengthError extends CryptographyError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnknownPathNibbleError extends CryptographyError {
   constructor(nibble) {
     super(`Unknown path nibble: ${nibble}`);
@@ -505,22 +665,10 @@ export class UnknownPathNibbleError extends CryptographyError {
   }
 
 }
-export class UnsupportedChildIndexError extends CryptographyError {
-  constructor(index) {
-    super(`Child index #${index} is not supported`);
-    this.name = 'UnsupportedChildIndexError';
-  }
-
-}
-/* Node errors */
-
-export class DisconnectedError extends NodeError {
-  constructor() {
-    super('Can not get node info. Node is not connected');
-    this.name = 'DisconnectedError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class DuplicateNodeError extends NodeError {
   constructor(name) {
     super(`Node with name ${name} already exist`);
@@ -528,6 +676,10 @@ export class DuplicateNodeError extends NodeError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class NodeNotFoundError extends NodeError {
   constructor(message) {
     super(message);
@@ -535,7 +687,9 @@ export class NodeNotFoundError extends NodeError {
   }
 
 }
-/* transaction related errors */
+/**
+ * @category exception
+ */
 
 export class DecodeError extends TransactionError {
   constructor(message) {
@@ -544,13 +698,10 @@ export class DecodeError extends TransactionError {
   }
 
 }
-export class EncodeError extends TransactionError {
-  constructor(message) {
-    super(message);
-    this.name = 'EncodeError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class PayloadLengthError extends TransactionError {
   constructor(message) {
     super(message);
@@ -558,6 +709,10 @@ export class PayloadLengthError extends TransactionError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class DryRunError extends TransactionError {
   constructor(message) {
     super(message);
@@ -565,6 +720,10 @@ export class DryRunError extends TransactionError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class IllegalBidFeeError extends TransactionError {
   constructor(message) {
     super(message);
@@ -572,6 +731,10 @@ export class IllegalBidFeeError extends TransactionError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class InvalidSignatureError extends TransactionError {
   constructor(message) {
     super(message);
@@ -579,13 +742,10 @@ export class InvalidSignatureError extends TransactionError {
   }
 
 }
-export class InvalidTxError extends TransactionError {
-  constructor(message) {
-    super(message);
-    this.name = 'InvalidTxError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class InvalidTxParamsError extends TransactionError {
   constructor(message) {
     super(message);
@@ -593,20 +753,10 @@ export class InvalidTxParamsError extends TransactionError {
   }
 
 }
-export class NoDefaultAensPointerError extends TransactionError {
-  constructor(prefix) {
-    super(`Default AENS pointer key is not defined for ${prefix} prefix`);
-    this.name = 'NoDefaultAensPointerError';
-  }
-
-}
-export class PrefixMismatchError extends TransactionError {
-  constructor(prefix, requiredPrefix) {
-    super(`Encoded string have a wrong type: ${prefix} (expected: ${requiredPrefix})`);
-    this.name = 'PrefixMismatchError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class PrefixNotFoundError extends TransactionError {
   constructor(tag) {
     super(`Prefix for id-tag ${tag} not found.`);
@@ -614,13 +764,21 @@ export class PrefixNotFoundError extends TransactionError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class SchemaNotFoundError extends TransactionError {
-  constructor(message) {
-    super(message);
+  constructor(schemaName, key, version) {
+    super(`Transaction ${schemaName} not implemented for ${key} version ${version}`);
     this.name = 'SchemaNotFoundError';
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class TagNotFoundError extends TransactionError {
   constructor(prefix) {
     super(`Id tag for prefix ${prefix} not found.`);
@@ -628,6 +786,10 @@ export class TagNotFoundError extends TransactionError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class TxNotInChainError extends TransactionError {
   constructor(txHash) {
     super(`Transaction ${txHash} is removed from chain`);
@@ -635,6 +797,10 @@ export class TxNotInChainError extends TransactionError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnknownTxError extends TransactionError {
   constructor(message) {
     super(message);
@@ -642,6 +808,10 @@ export class UnknownTxError extends TransactionError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnsupportedABIversionError extends TransactionError {
   constructor(message) {
     super(message);
@@ -649,6 +819,10 @@ export class UnsupportedABIversionError extends TransactionError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class UnsupportedVMversionError extends TransactionError {
   constructor(message) {
     super(message);
@@ -656,7 +830,9 @@ export class UnsupportedVMversionError extends TransactionError {
   }
 
 }
-/* Wallet Errors */
+/**
+ * @category exception
+ */
 
 export class AlreadyConnectedError extends WalletError {
   constructor(message) {
@@ -665,13 +841,10 @@ export class AlreadyConnectedError extends WalletError {
   }
 
 }
-export class MessageDirectionError extends WalletError {
-  constructor(message) {
-    super(message);
-    this.name = 'MessageDirectionError';
-  }
+/**
+ * @category exception
+ */
 
-}
 export class NoWalletConnectedError extends WalletError {
   constructor(message) {
     super(message);
@@ -679,6 +852,10 @@ export class NoWalletConnectedError extends WalletError {
   }
 
 }
+/**
+ * @category exception
+ */
+
 export class RpcConnectionError extends WalletError {
   constructor(message) {
     super(message);