raiden-ts

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>RaidenError | raiden-ts - v3.1.1</title> <meta name="description" content="Documentation for raiden-ts - v3.1.1"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/pages.css"> <script async src="../assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">raiden-ts - v3.1.1</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> All <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">raiden-ts - v3.1.1</a> </li> <li> <a href="RaidenError.html">RaidenError</a> </li> </ul> <h1>Class RaidenError</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> Error <ul class="tsd-hierarchy"> <li> RaidenError </li> </ul> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="RaidenError.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="RaidenError.html#details" class="tsd-kind-icon">details</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="RaidenError.html#name" class="tsd-kind-icon">name</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="RaidenError.html#code" class="tsd-kind-icon">code</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">new RaidenError(message?: string, details?: unknown): <a href="RaidenError.html" class="tsd-signature-type" data-tsd-kind="Class">RaidenError</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> Overrides Error.constructor <ul> <li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/utils/error.ts#L127">utils/error.ts:127</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>Optional message: string</h5> </li> <li> <h5>Optional details: unknown</h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="RaidenError.html" class="tsd-signature-type" data-tsd-kind="Class">RaidenError</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="details" class="tsd-anchor"></a> <h3>Optional details</h3> <div class="tsd-signature tsd-kind-icon">details: unknown</div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"> <a name="name" class="tsd-anchor"></a> <h3>name</h3> <div class="tsd-signature tsd-kind-icon">name: string = 'RaidenError'</div> <aside class="tsd-sources"> Overrides Error.name <ul> <li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/utils/error.ts#L125">utils/error.ts:125</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="code" class="tsd-anchor"></a> <h3>code</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get code(): "PFS_EMPTY_URL" | "PFS_INVALID_URL" | "PFS_INVALID_INFO" | "PFS_TOO_EXPENSIVE" | "PFS_NO_ROUTES_FOUND" | "PFS_ERROR_RESPONSE" | "PFS_DISABLED" | "PFS_UNKNOWN_TOKEN_NETWORK" | "PFS_TARGET_OFFLINE" | "PFS_TARGET_NO_RECEIVE" | "PFS_LAST_IOU_REQUEST_FAILED" | "PFS_IOU_SIGNATURE_MISMATCH" | "PFS_NO_ROUTES_BETWEEN_NODES" | "CNL_INVALID_STATE" | "CNL_NO_OPEN_CHANNEL_FOUND" | "CNL_NO_OPEN_OR_CLOSING_CHANNEL_FOUND" | "CNL_NO_SETTLEABLE_OR_SETTLING_CHANNEL_FOUND" | "CNL_OPENCHANNEL_FAILED" | "CNL_SETTOTALDEPOSIT_FAILED" | "CNL_CLOSECHANNEL_FAILED" | "CNL_SETTLE_INVALID_BALANCEHASH" | "CNL_SETTLE_FAILED" | "CNL_COOP_SETTLE_FAILED" | "CNL_SETTLE_AUTO_ENABLED" | "CNL_UPDATE_NONCLOSING_BP_FAILED" | "CNL_ONCHAIN_UNLOCK_FAILED" | "CNL_WITHDRAW_PENDING" | "CNL_WITHDRAW_RETRY_CONFIRMATION" | "CNL_WITHDRAW_TRANSACTION_FAILED" | "CNL_WITHDRAW_EXPIRES_SOON" | "CNL_WITHDRAW_EXPIRED" | "CNL_WITHDRAW_AMOUNT_TOO_LOW" | "CNL_WITHDRAW_AMOUNT_TOO_HIGH" | "CNL_COOP_SETTLE_NOT_POSSIBLE" | "XFER_EXPIRED" | "XFER_CHANNEL_CLOSED_PREMATURELY" | "XFER_REFUNDED" | "XFER_INVALID_SECRETREQUEST" | "XFER_ALREADY_COMPLETED" | "XFER_REGISTERSECRET_TX_FAILED" | "TRNS_NO_MATRIX_SERVERS" | "TRNS_NO_VALID_USER" | "TRNS_NO_SERVERNAME" | "TRNS_MESSAGE_SIGNATURE_MISMATCH" | "RDN_GENERAL_ERROR" | "RDN_ASSERT_ERROR" | "RDN_MINT_FAILED" | "RDN_MINT_MAINNET" | "RDN_REGISTER_TOKEN_FAILED" | "RDN_REGISTER_TOKEN_MAINNET" | "RDN_REGISTER_TOKEN_REGISTERED" | "RDN_TRANSACTION_FAILED" | "RDN_APPROVE_TRANSACTION_FAILED" | "RDN_DEPOSIT_TRANSACTION_FAILED" | "RDN_TRANSFER_ONCHAIN_BALANCE_FAILED" | "RDN_TRANSFER_ONCHAIN_TOKENS_FAILED" | "RDN_UNRECOGNIZED_NETWORK" | "RDN_SIGNER_NOT_CONNECTED" | "RDN_ACCOUNT_NOT_FOUND" | "RDN_STRING_ACCOUNT_INVALID" | "RDN_TRANSACTION_REORG" | "RDN_STATE_MIGRATION" | "RDN_INSUFFICIENT_BALANCE" | "RDN_INSUFFICIENT_ALLOWANCE" | "RDN_NOT_A_TOKEN" | "RDN_STATE_ADDRESS_MISMATCH" | "RDN_STATE_NETWORK_MISMATCH" | "RDN_ALREADY_STARTED" | "RDN_UNKNOWN_TOKEN_NETWORK" | "RDN_INVALID_SECRET" | "RDN_INVALID_SECRETHASH" | "RDN_SECRET_SECRETHASH_MISMATCH" | "RDN_UNKNOWN_TRANSFER" | "RDN_DATABASE_DELETED" | "DTA_NEGATIVE_NUMBER" | "DTA_NUMBER_TOO_LARGE" | "DTA_ARRAY_LENGTH_DIFFERENCE" | "DTA_UNENCODABLE_DATA" | "DTA_NON_POSITIVE_NUMBER" | "DTA_INVALID_ADDRESS" | "DTA_INVALID_DEPOSIT" | "DTA_INVALID_TIMEOUT" | "DTA_INVALID_AMOUNT" | "DTA_INVALID_PAYMENT_ID" | "DTA_INVALID_PATH" | "DTA_INVALID_PFS" | "UDC_DEPOSIT_OUTDATED" | "UDC_PLAN_WITHDRAW_FAILED" | "UDC_PLAN_WITHDRAW_GT_ZERO" | "UDC_PLAN_WITHDRAW_EXCEEDS_AVAILABLE" | "UDC_WITHDRAW_NO_BALANCE" | "UDC_WITHDRAW_FAILED" | "UDC_WITHDRAW_AUTO_ENABLED" | "UDC_WITHDRAW_NO_PLAN" | "UDC_WITHDRAW_TOO_LARGE"</li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/raiden-network/light-client/blob/b5c9d8885/raiden-ts/src/utils/error.ts#L132">utils/error.ts:132</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns "PFS_EMPTY_URL" | "PFS_INVALID_URL" | "PFS_INVALID_INFO" | "PFS_TOO_EXPENSIVE" | "PFS_NO_ROUTES_FOUND" | "PFS_ERROR_RESPONSE" | "PFS_DISABLED" | "PFS_UNKNOWN_TOKEN_NETWORK" | "PFS_TARGET_OFFLINE" | "PFS_TARGET_NO_RECEIVE" | "PFS_LAST_IOU_REQUEST_FAILED" | "PFS_IOU_SIGNATURE_MISMATCH" | "PFS_NO_ROUTES_BETWEEN_NODES" | "CNL_INVALID_STATE" | "CNL_NO_OPEN_CHANNEL_FOUND" | "CNL_NO_OPEN_OR_CLOSING_CHANNEL_FOUND" | "CNL_NO_SETTLEABLE_OR_SETTLING_CHANNEL_FOUND" | "CNL_OPENCHANNEL_FAILED" | "CNL_SETTOTALDEPOSIT_FAILED" | "CNL_CLOSECHANNEL_FAILED" | "CNL_SETTLE_INVALID_BALANCEHASH" | "CNL_SETTLE_FAILED" | "CNL_COOP_SETTLE_FAILED" | "CNL_SETTLE_AUTO_ENABLED" | "CNL_UPDATE_NONCLOSING_BP_FAILED" | "CNL_ONCHAIN_UNLOCK_FAILED" | "CNL_WITHDRAW_PENDING" | "CNL_WITHDRAW_RETRY_CONFIRMATION" | "CNL_WITHDRAW_TRANSACTION_FAILED" | "CNL_WITHDRAW_EXPIRES_SOON" | "CNL_WITHDRAW_EXPIRED" | "CNL_WITHDRAW_AMOUNT_TOO_LOW" | "CNL_WITHDRAW_AMOUNT_TOO_HIGH" | "CNL_COOP_SETTLE_NOT_POSSIBLE" | "XFER_EXPIRED" | "XFER_CHANNEL_CLOSED_PREMATURELY" | "XFER_REFUNDED" | "XFER_INVALID_SECRETREQUEST" | "XFER_ALREADY_COMPLETED" | "XFER_REGISTERSECRET_TX_FAILED" | "TRNS_NO_MATRIX_SERVERS" | "TRNS_NO_VALID_USER" | "TRNS_NO_SERVERNAME" | "TRNS_MESSAGE_SIGNATURE_MISMATCH" | "RDN_GENERAL_ERROR" | "RDN_ASSERT_ERROR" | "RDN_MINT_FAILED" | "RDN_MINT_MAINNET" | "RDN_REGISTER_TOKEN_FAILED" | "RDN_REGISTER_TOKEN_MAINNET" | "RDN_REGISTER_TOKEN_REGISTERED" | "RDN_TRANSACTION_FAILED" | "RDN_APPROVE_TRANSACTION_FAILED" | "RDN_DEPOSIT_TRANSACTION_FAILED" | "RDN_TRANSFER_ONCHAIN_BALANCE_FAILED" | "RDN_TRANSFER_ONCHAIN_TOKENS_FAILED" | "RDN_UNRECOGNIZED_NETWORK" | "RDN_SIGNER_NOT_CONNECTED" | "RDN_ACCOUNT_NOT_FOUND" | "RDN_STRING_ACCOUNT_INVALID" | "RDN_TRANSACTION_REORG" | "RDN_STATE_MIGRATION" | "RDN_INSUFFICIENT_BALANCE" | "RDN_INSUFFICIENT_ALLOWANCE" | "RDN_NOT_A_TOKEN" | "RDN_STATE_ADDRESS_MISMATCH" | "RDN_STATE_NETWORK_MISMATCH" | "RDN_ALREADY_STARTED" | "RDN_UNKNOWN_TOKEN_NETWORK" | "RDN_INVALID_SECRET" | "RDN_INVALID_SECRETHASH" | "RDN_SECRET_SECRETHASH_MISMATCH" | "RDN_UNKNOWN_TRANSFER" | "RDN_DATABASE_DELETED" | "DTA_NEGATIVE_NUMBER" | "DTA_NUMBER_TOO_LARGE" | "DTA_ARRAY_LENGTH_DIFFERENCE" | "DTA_UNENCODABLE_DATA" | "DTA_NON_POSITIVE_NUMBER" | "DTA_INVALID_ADDRESS" | "DTA_INVALID_DEPOSIT" | "DTA_INVALID_TIMEOUT" | "DTA_INVALID_AMOUNT" | "DTA_INVALID_PAYMENT_ID" | "DTA_INVALID_PATH" | "DTA_INVALID_PFS" | "UDC_DEPOSIT_OUTDATED" | "UDC_PLAN_WITHDRAW_FAILED" | "UDC_PLAN_WITHDRAW_GT_ZERO" | "UDC_PLAN_WITHDRAW_EXCEEDS_AVAILABLE" | "UDC_WITHDRAW_NO_BALANCE" | "UDC_WITHDRAW_FAILED" | "UDC_WITHDRAW_AUTO_ENABLED" | "UDC_WITHDRAW_NO_PLAN" | "UDC_WITHDRAW_TOO_LARGE"</h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="label pp-nav pp-group"> Get Started </li> <li class=" pp-nav pp-page"> <a href="../pages/Get Started/prerequisites.html">Prerequisites</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Get Started/installing-sdk.html">Installing the SDK</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Get Started/installing-dapp.html">Installing the dApp</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Get Started/connecting.html">Connecting</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Get Started/private-chain.html">Private chains</a> </li> <li class="label pp-nav pp-group"> Usage </li> <li class=" pp-nav pp-page"> <a href="../pages/Usage/opening-channel.html">Opening a channel</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Usage/funding-channel.html">Funding a channel</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Usage/direct-transfer.html">Transferring</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Usage/closing-channel.html">Closing a channel</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Usage/settling-channel.html">Settling a channel</a> </li> <li class="label pp-nav pp-group"> Using the Raiden dApp </li> <li class=" pp-nav pp-page"> <a href="../pages/Using the Raiden dApp/using-dapp.html">Overview</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Using the Raiden dApp/navigate-dapp.html">Navigate the Raiden dApp</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Using the Raiden dApp/hub-selection-channel-opening.html">Hub Selection and Channel Opening</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Using the Raiden dApp/transfers.html">Transfers</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Using the Raiden dApp/channels.html">Channels</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Using the Raiden dApp/account.html">Accounts</a> </li> <li class="label pp-nav pp-group"> Using the Raiden CLI </li> <li class=" pp-nav pp-page"> <a href="../pages/Using the Raiden CLI/README.html">Overview</a> </li> <li class=" pp-nav pp-page"> <a href="../pages/Using the Raiden CLI/raspberrypi.html">Running raiden-cli on the raspberry pi</a> </li> <li class=" "> <a href="../modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="RaidenError.html" class="tsd-kind-icon">RaidenError</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a href="RaidenError.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="RaidenError.html#details" class="tsd-kind-icon">details</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"> <a href="RaidenError.html#name" class="tsd-kind-icon">name</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="RaidenError.html#code" class="tsd-kind-icon">code</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class">Constructor</li> <li class="tsd-kind-property tsd-parent-kind-class">Property</li> <li class="tsd-kind-method tsd-parent-kind-class">Method</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface">Property</li> <li class="tsd-kind-method tsd-parent-kind-interface">Method</li> </ul> </div> </div> </footer> <div class="container tsd-generator"> Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>