@sravankumar02/sdk-core 1.0.0

package/out/core/errors.d.ts

@@ -0,0 +1,279 @@
+/**
+ * The base class for exceptions (errors).
+ */
+export declare class Err extends Error {
+    inner: Error | undefined;
+    constructor(message: string, inner?: Error);
+    /**
+     * Returns a pretty, friendly summary for the error or for the chain of errros (if appropriate).
+     */
+    summary(): any[];
+}
+/**
+ * Signals invalid arguments for a function, for an operation.
+ */
+export declare class ErrInvalidArgument extends Err {
+    constructor(message: string, inner?: Error);
+}
+/**
+ * Signals an unsupported operation.
+ */
+export declare class ErrUnsupportedOperation extends Err {
+    constructor(operation: string, reason?: string);
+}
+/**
+ * Signals the provisioning of objects of unexpected (bad) types.
+ */
+export declare class ErrBadType extends Err {
+    constructor(name: string, type: any, value?: any);
+}
+/**
+ * Signals that an invariant failed.
+ */
+export declare class ErrInvariantFailed extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals an unexpected condition.
+ */
+export declare class ErrUnexpectedCondition extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals issues with {@link Address} instantiation.
+ */
+export declare class ErrAddressCannotCreate extends Err {
+    constructor(input: any, inner?: Error);
+}
+/**
+ * Signals issues with the HRP of an {@link Address}.
+ */
+export declare class ErrAddressBadHrp extends Err {
+    constructor(expected: string, got: string);
+}
+/**
+ * Signals the presence of an empty / invalid address.
+ */
+export declare class ErrAddressEmpty extends Err {
+    constructor();
+}
+/**
+ * Signals an invalid value for gas limit.
+ */
+export declare class ErrNotEnoughGas extends Err {
+    constructor(value: number);
+}
+/**
+ * Signals an invalid value for nonce.
+ */
+export declare class ErrNonceInvalid extends Err {
+    constructor(value: number);
+}
+/**
+ * Signals an invalid value for transaction version.
+ */
+export declare class ErrTransactionVersionInvalid extends Err {
+    constructor(value: number);
+}
+/**
+ * Signals an invalid value for transaction options.
+ */
+export declare class ErrTransactionOptionsInvalid extends Err {
+    constructor(value: number);
+}
+/**
+ * Signals an error related to signing a message (a transaction).
+ */
+export declare class ErrSignatureCannotCreate extends Err {
+    constructor(input: any, inner?: Error);
+}
+/**
+ * Signals an invalid value for the name of a {@link ContractFunction}.
+ */
+export declare class ErrInvalidFunctionName extends Err {
+    constructor();
+}
+/**
+ * Signals a failed operation, since the Timer is already running.
+ */
+export declare class ErrAsyncTimerAlreadyRunning extends Err {
+    constructor();
+}
+/**
+ * Signals a failed operation, since the Timer has been aborted.
+ */
+export declare class ErrAsyncTimerAborted extends Err {
+    constructor();
+}
+/**
+ * Signals a timout for a {@link TransactionWatcher}.
+ */
+export declare class ErrTransactionWatcherTimeout extends Err {
+    constructor();
+}
+/**
+ * Signals an issue related to waiting for a specific transaction status.
+ */
+export declare class ErrExpectedTransactionStatusNotReached extends Err {
+    constructor();
+}
+/**
+ * Signals an issue related to waiting for specific transaction events.
+ */
+export declare class ErrExpectedTransactionEventsNotFound extends Err {
+    constructor();
+}
+/**
+ * Signals a generic error in the context of Smart Contracts.
+ */
+export declare class ErrContract extends Err {
+    constructor(message: string);
+}
+export declare class ErrContractHasNoAddress extends ErrContract {
+    constructor();
+}
+/**
+ * Signals an error thrown by the mock-like test objects.
+ */
+export declare class ErrMock extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals a generic type error.
+ */
+export declare class ErrTypingSystem extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals a missing field on a struct.
+ */
+export declare class ErrMissingFieldOnStruct extends Err {
+    constructor(fieldName: string, structName: string);
+}
+/**
+ * Signals a missing field on an enum.
+ */
+export declare class ErrMissingFieldOnEnum extends Err {
+    constructor(fieldName: string, enumName: string);
+}
+/**
+ * Signals an error when parsing the contract results.
+ */
+export declare class ErrCannotParseContractResults extends Err {
+    constructor(details: string);
+}
+/**
+ * Signals an error when parsing the outcome of a transaction (results and logs).
+ */
+export declare class ErrCannotParseTransactionOutcome extends Err {
+    constructor(transactionHash: string, message: string);
+}
+/**
+ * Signals a generic codec (encode / decode) error.
+ */
+export declare class ErrCodec extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals a generic contract interaction error.
+ */
+export declare class ErrContractInteraction extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals that a method is not yet implemented
+ */
+export declare class ErrNotImplemented extends Err {
+    constructor();
+}
+/**
+ * Signals that the `isCompleted` property is missing on the transaction obect and is needed for the Transaction Watcher
+ */
+export declare class ErrIsCompletedFieldIsMissingOnTransaction extends Err {
+    constructor();
+}
+/**
+ * Signals that the provided token identifier is not valid
+ */
+export declare class ErrInvalidTokenIdentifier extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals a generic bad usage error
+ */
+export declare class ErrBadUsage extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals an invalid inner transaction for relayed transactions
+ */
+export declare class ErrInvalidInnerTransaction extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals an error when parsing the logs of a transaction.
+ */
+export declare class ErrParseTransactionOutcome extends Err {
+    constructor(message: string);
+}
+/**
+ * Signals an error when querying a smart contract.
+ */
+export declare class ErrSmartContractQuery extends Err {
+    returnCode: string;
+    constructor(returnCode: string, message: string);
+}
+/**
+ * Signals a wrong mnemonic format.
+ */
+export declare class ErrWrongMnemonic extends Err {
+    constructor();
+}
+/**
+ * Signals a bad mnemonic entropy.
+ */
+export declare class ErrBadMnemonicEntropy extends Err {
+    constructor(inner: Error);
+}
+/**
+ * Signals a bad PEM file.
+ */
+export declare class ErrBadPEM extends Err {
+    constructor(message?: string);
+}
+/**
+ * Signals an error related to signing a message (a transaction).
+ */
+export declare class ErrSignerCannotSign extends Err {
+    constructor(inner: Error);
+}
+/**
+ * Signals a bad address.
+ */
+export declare class ErrBadAddress extends Err {
+    constructor(value: string, inner?: Error);
+}
+/**
+ * Signals an error that happened during a request against the Network.
+ */
+export declare class ErrNetworkProvider extends Err {
+    constructor(url: string, error: string, inner?: Error);
+}
+/**
+ * Signals a generic error in the context of querying Smart Contracts.
+ */
+export declare class ErrContractQuery extends Err {
+    constructor(originalError: Error);
+}
+/**
+ * Signals that the network provider provided is not valid
+ */
+export declare class ErrInvalidNetworkProviderKind extends Err {
+    constructor();
+}
+/**
+ * Signals that the account condition was not reached
+ */
+export declare class ExpectedAccountConditionNotReachedError extends Err {
+    constructor();
+}

package/out/core/errors.js

@@ -0,0 +1,437 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpectedAccountConditionNotReachedError = exports.ErrInvalidNetworkProviderKind = exports.ErrContractQuery = exports.ErrNetworkProvider = exports.ErrBadAddress = exports.ErrSignerCannotSign = exports.ErrBadPEM = exports.ErrBadMnemonicEntropy = exports.ErrWrongMnemonic = exports.ErrSmartContractQuery = exports.ErrParseTransactionOutcome = exports.ErrInvalidInnerTransaction = exports.ErrBadUsage = exports.ErrInvalidTokenIdentifier = exports.ErrIsCompletedFieldIsMissingOnTransaction = exports.ErrNotImplemented = exports.ErrContractInteraction = exports.ErrCodec = exports.ErrCannotParseTransactionOutcome = exports.ErrCannotParseContractResults = exports.ErrMissingFieldOnEnum = exports.ErrMissingFieldOnStruct = exports.ErrTypingSystem = exports.ErrMock = exports.ErrContractHasNoAddress = exports.ErrContract = exports.ErrExpectedTransactionEventsNotFound = exports.ErrExpectedTransactionStatusNotReached = exports.ErrTransactionWatcherTimeout = exports.ErrAsyncTimerAborted = exports.ErrAsyncTimerAlreadyRunning = exports.ErrInvalidFunctionName = exports.ErrSignatureCannotCreate = exports.ErrTransactionOptionsInvalid = exports.ErrTransactionVersionInvalid = exports.ErrNonceInvalid = exports.ErrNotEnoughGas = exports.ErrAddressEmpty = exports.ErrAddressBadHrp = exports.ErrAddressCannotCreate = exports.ErrUnexpectedCondition = exports.ErrInvariantFailed = exports.ErrBadType = exports.ErrUnsupportedOperation = exports.ErrInvalidArgument = exports.Err = void 0;
+/**
+ * The base class for exceptions (errors).
+ */
+class Err extends Error {
+    constructor(message, inner) {
+        super(message);
+        this.inner = undefined;
+        this.inner = inner;
+    }
+    /**
+     * Returns a pretty, friendly summary for the error or for the chain of errros (if appropriate).
+     */
+    summary() {
+        const result = [];
+        result.push({ name: this.name, message: this.message });
+        let inner = this.inner;
+        while (inner) {
+            result.push({ name: inner.name, message: inner.message });
+            inner = inner.inner;
+        }
+        return result;
+    }
+}
+exports.Err = Err;
+/**
+ * Signals invalid arguments for a function, for an operation.
+ */
+class ErrInvalidArgument extends Err {
+    constructor(message, inner) {
+        super(`Invalid argument: ${message}`, inner);
+    }
+}
+exports.ErrInvalidArgument = ErrInvalidArgument;
+/**
+ * Signals an unsupported operation.
+ */
+class ErrUnsupportedOperation extends Err {
+    constructor(operation, reason = "not specified") {
+        super(`Operation "${operation}" not supported. Reason: ${reason}`);
+    }
+}
+exports.ErrUnsupportedOperation = ErrUnsupportedOperation;
+/**
+ * Signals the provisioning of objects of unexpected (bad) types.
+ */
+class ErrBadType extends Err {
+    constructor(name, type, value) {
+        super(`Bad type of "${name}": ${value}. Expected type: ${type}`);
+    }
+}
+exports.ErrBadType = ErrBadType;
+/**
+ * Signals that an invariant failed.
+ */
+class ErrInvariantFailed extends Err {
+    constructor(message) {
+        super(`Invariant failed: [${message}]`);
+    }
+}
+exports.ErrInvariantFailed = ErrInvariantFailed;
+/**
+ * Signals an unexpected condition.
+ */
+class ErrUnexpectedCondition extends Err {
+    constructor(message) {
+        super(`Unexpected condition: [${message}]`);
+    }
+}
+exports.ErrUnexpectedCondition = ErrUnexpectedCondition;
+/**
+ * Signals issues with {@link Address} instantiation.
+ */
+class ErrAddressCannotCreate extends Err {
+    constructor(input, inner) {
+        const message = `Cannot create address from: ${input}`;
+        super(message, inner);
+    }
+}
+exports.ErrAddressCannotCreate = ErrAddressCannotCreate;
+/**
+ * Signals issues with the HRP of an {@link Address}.
+ */
+class ErrAddressBadHrp extends Err {
+    constructor(expected, got) {
+        super(`Wrong address HRP. Expected: ${expected}, got ${got}`);
+    }
+}
+exports.ErrAddressBadHrp = ErrAddressBadHrp;
+/**
+ * Signals the presence of an empty / invalid address.
+ */
+class ErrAddressEmpty extends Err {
+    constructor() {
+        super(`Address is empty`);
+    }
+}
+exports.ErrAddressEmpty = ErrAddressEmpty;
+/**
+ * Signals an invalid value for gas limit.
+ */
+class ErrNotEnoughGas extends Err {
+    constructor(value) {
+        super(`Not enough gas provided: ${value}`);
+    }
+}
+exports.ErrNotEnoughGas = ErrNotEnoughGas;
+/**
+ * Signals an invalid value for nonce.
+ */
+class ErrNonceInvalid extends Err {
+    constructor(value) {
+        super(`Invalid nonce: ${value}`);
+    }
+}
+exports.ErrNonceInvalid = ErrNonceInvalid;
+/**
+ * Signals an invalid value for transaction version.
+ */
+class ErrTransactionVersionInvalid extends Err {
+    constructor(value) {
+        super(`Invalid transaction version: ${value}`);
+    }
+}
+exports.ErrTransactionVersionInvalid = ErrTransactionVersionInvalid;
+/**
+ * Signals an invalid value for transaction options.
+ */
+class ErrTransactionOptionsInvalid extends Err {
+    constructor(value) {
+        super(`Invalid transaction options: ${value}`);
+    }
+}
+exports.ErrTransactionOptionsInvalid = ErrTransactionOptionsInvalid;
+/**
+ * Signals an error related to signing a message (a transaction).
+ */
+class ErrSignatureCannotCreate extends Err {
+    constructor(input, inner) {
+        const message = `Cannot create signature from: ${input}`;
+        super(message, inner);
+    }
+}
+exports.ErrSignatureCannotCreate = ErrSignatureCannotCreate;
+/**
+ * Signals an invalid value for the name of a {@link ContractFunction}.
+ */
+class ErrInvalidFunctionName extends Err {
+    constructor() {
+        super(`Invalid function name`);
+    }
+}
+exports.ErrInvalidFunctionName = ErrInvalidFunctionName;
+/**
+ * Signals a failed operation, since the Timer is already running.
+ */
+class ErrAsyncTimerAlreadyRunning extends Err {
+    constructor() {
+        super("Async timer already running");
+    }
+}
+exports.ErrAsyncTimerAlreadyRunning = ErrAsyncTimerAlreadyRunning;
+/**
+ * Signals a failed operation, since the Timer has been aborted.
+ */
+class ErrAsyncTimerAborted extends Err {
+    constructor() {
+        super("Async timer aborted");
+    }
+}
+exports.ErrAsyncTimerAborted = ErrAsyncTimerAborted;
+/**
+ * Signals a timout for a {@link TransactionWatcher}.
+ */
+class ErrTransactionWatcherTimeout extends Err {
+    constructor() {
+        super(`TransactionWatcher has timed out`);
+    }
+}
+exports.ErrTransactionWatcherTimeout = ErrTransactionWatcherTimeout;
+/**
+ * Signals an issue related to waiting for a specific transaction status.
+ */
+class ErrExpectedTransactionStatusNotReached extends Err {
+    constructor() {
+        super(`Expected transaction status not reached`);
+    }
+}
+exports.ErrExpectedTransactionStatusNotReached = ErrExpectedTransactionStatusNotReached;
+/**
+ * Signals an issue related to waiting for specific transaction events.
+ */
+class ErrExpectedTransactionEventsNotFound extends Err {
+    constructor() {
+        super(`Expected transaction events not found`);
+    }
+}
+exports.ErrExpectedTransactionEventsNotFound = ErrExpectedTransactionEventsNotFound;
+/**
+ * Signals a generic error in the context of Smart Contracts.
+ */
+class ErrContract extends Err {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ErrContract = ErrContract;
+class ErrContractHasNoAddress extends ErrContract {
+    constructor() {
+        super(`
+The smart contract has no address set. Make sure you provide the address in the constructor, or call setAddress() appropriately.
+If you need to recompute the address of the contract, make use of SmartContract.computeAddress() (static method). 
+`);
+    }
+}
+exports.ErrContractHasNoAddress = ErrContractHasNoAddress;
+/**
+ * Signals an error thrown by the mock-like test objects.
+ */
+class ErrMock extends Err {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ErrMock = ErrMock;
+/**
+ * Signals a generic type error.
+ */
+class ErrTypingSystem extends Err {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ErrTypingSystem = ErrTypingSystem;
+/**
+ * Signals a missing field on a struct.
+ */
+class ErrMissingFieldOnStruct extends Err {
+    constructor(fieldName, structName) {
+        super(`field ${fieldName} does not exist on struct ${structName}`);
+    }
+}
+exports.ErrMissingFieldOnStruct = ErrMissingFieldOnStruct;
+/**
+ * Signals a missing field on an enum.
+ */
+class ErrMissingFieldOnEnum extends Err {
+    constructor(fieldName, enumName) {
+        super(`field ${fieldName} does not exist on enum ${enumName}`);
+    }
+}
+exports.ErrMissingFieldOnEnum = ErrMissingFieldOnEnum;
+/**
+ * Signals an error when parsing the contract results.
+ */
+class ErrCannotParseContractResults extends Err {
+    constructor(details) {
+        super(`cannot parse contract results: ${details}`);
+    }
+}
+exports.ErrCannotParseContractResults = ErrCannotParseContractResults;
+/**
+ * Signals an error when parsing the outcome of a transaction (results and logs).
+ */
+class ErrCannotParseTransactionOutcome extends Err {
+    constructor(transactionHash, message) {
+        super(`cannot parse outcome of transaction ${transactionHash}: ${message}`);
+    }
+}
+exports.ErrCannotParseTransactionOutcome = ErrCannotParseTransactionOutcome;
+/**
+ * Signals a generic codec (encode / decode) error.
+ */
+class ErrCodec extends Err {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ErrCodec = ErrCodec;
+/**
+ * Signals a generic contract interaction error.
+ */
+class ErrContractInteraction extends Err {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ErrContractInteraction = ErrContractInteraction;
+/**
+ * Signals that a method is not yet implemented
+ */
+class ErrNotImplemented extends Err {
+    constructor() {
+        super("Method not yet implemented");
+    }
+}
+exports.ErrNotImplemented = ErrNotImplemented;
+/**
+ * Signals that the `isCompleted` property is missing on the transaction obect and is needed for the Transaction Watcher
+ */
+class ErrIsCompletedFieldIsMissingOnTransaction extends Err {
+    constructor() {
+        super("The transaction watcher requires the `isCompleted` property to be defined on the transaction object. Perhaps you've used the sdk-network-provider's `ProxyNetworkProvider.getTransaction()` and in that case you should also pass `withProcessStatus=true`.");
+    }
+}
+exports.ErrIsCompletedFieldIsMissingOnTransaction = ErrIsCompletedFieldIsMissingOnTransaction;
+/**
+ * Signals that the provided token identifier is not valid
+ */
+class ErrInvalidTokenIdentifier extends Err {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ErrInvalidTokenIdentifier = ErrInvalidTokenIdentifier;
+/**
+ * Signals a generic bad usage error
+ */
+class ErrBadUsage extends Err {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ErrBadUsage = ErrBadUsage;
+/**
+ * Signals an invalid inner transaction for relayed transactions
+ */
+class ErrInvalidInnerTransaction extends Err {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ErrInvalidInnerTransaction = ErrInvalidInnerTransaction;
+/**
+ * Signals an error when parsing the logs of a transaction.
+ */
+class ErrParseTransactionOutcome extends Err {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ErrParseTransactionOutcome = ErrParseTransactionOutcome;
+/**
+ * Signals an error when querying a smart contract.
+ */
+class ErrSmartContractQuery extends Err {
+    constructor(returnCode, message) {
+        super(message);
+        this.returnCode = returnCode;
+    }
+}
+exports.ErrSmartContractQuery = ErrSmartContractQuery;
+/**
+ * Signals a wrong mnemonic format.
+ */
+class ErrWrongMnemonic extends Err {
+    constructor() {
+        super("Wrong mnemonic format");
+    }
+}
+exports.ErrWrongMnemonic = ErrWrongMnemonic;
+/**
+ * Signals a bad mnemonic entropy.
+ */
+class ErrBadMnemonicEntropy extends Err {
+    constructor(inner) {
+        super("Bad mnemonic entropy", inner);
+    }
+}
+exports.ErrBadMnemonicEntropy = ErrBadMnemonicEntropy;
+/**
+ * Signals a bad PEM file.
+ */
+class ErrBadPEM extends Err {
+    constructor(message) {
+        super(message ? `Bad PEM: ${message}` : `Bad PEM`);
+    }
+}
+exports.ErrBadPEM = ErrBadPEM;
+/**
+ * Signals an error related to signing a message (a transaction).
+ */
+class ErrSignerCannotSign extends Err {
+    constructor(inner) {
+        super(`Cannot sign`, inner);
+    }
+}
+exports.ErrSignerCannotSign = ErrSignerCannotSign;
+/**
+ * Signals a bad address.
+ */
+class ErrBadAddress extends Err {
+    constructor(value, inner) {
+        super(`Bad address: ${value}`, inner);
+    }
+}
+exports.ErrBadAddress = ErrBadAddress;
+/**
+ * Signals an error that happened during a request against the Network.
+ */
+class ErrNetworkProvider extends Err {
+    constructor(url, error, inner) {
+        const message = `Request error on url [${url}]: [${error}]`;
+        super(message, inner);
+    }
+}
+exports.ErrNetworkProvider = ErrNetworkProvider;
+/**
+ * Signals a generic error in the context of querying Smart Contracts.
+ */
+class ErrContractQuery extends Err {
+    constructor(originalError) {
+        super(originalError.message.replace("executeQuery:", ""));
+    }
+}
+exports.ErrContractQuery = ErrContractQuery;
+/**
+ * Signals that the network provider provided is not valid
+ */
+class ErrInvalidNetworkProviderKind extends Err {
+    constructor() {
+        super("Invalid network provider kind. Choose between `api` and `proxy`.");
+    }
+}
+exports.ErrInvalidNetworkProviderKind = ErrInvalidNetworkProviderKind;
+/**
+ * Signals that the account condition was not reached
+ */
+class ExpectedAccountConditionNotReachedError extends Err {
+    constructor() {
+        super("The expected account condition was not reached.");
+    }
+}
+exports.ExpectedAccountConditionNotReachedError = ExpectedAccountConditionNotReachedError;
+//# sourceMappingURL=errors.js.map