Errors, Logging and Troubleshooting

Before You Start

Read the following guides before proceeding:

Where Errors Arrive

WirexError

fun describe(error: WirexError): String = when (error.code) {
    WirexError.Code.UNAUTHORIZED -> "refresh the access token"
    WirexError.Code.ACTION_REQUIRED -> "obtain a fresh action token and retry"
    WirexError.Code.UPDATE_REQUIRED -> "ship a newer SDK build"
    WirexError.Code.INVALID_INPUT -> when (error.reason) {
        WirexError.Reason.CARD_ALREADY_LINKED -> "enter a different card"
        WirexError.Reason.CARD_LIMIT_REACHED -> "remove a card first"
        else -> "fix the highlighted field"
    }
    WirexError.Code.TEMPORARY -> if (error.retryable) "retry" else "give up"
    WirexError.Code.FAILED -> "terminal"
}

Other Types

• WirexDeclined is not an error state: the user said no and nothing was sent.
• WirexEnvironmentUnavailable is thrown by WirexEnvironment.resolve(name, chainId) and
  WirexWalletEnvironment.resolve(name): UnknownName, NotBuilt, MalformedEndpoints, MissingChainId.
  The create(...) factories return null for the same conditions. Show the reason; never fall back to another
  environment.

Logging

Logging is off by default. Every logged value passes a redactor; tokens and card data are never handed to a
sink. Sinks are called on arbitrary threads and must not block.

val reveal = WirexReveal.create(
    credentials = credentials, chainId = "<chain id>",
    logging = logcatLogging(WirexLogLevel.INFO),
    timeouts = WirexTimeouts(connectMillis = 10_000, readMillis = 20_000),
)

Log at DEBUG in development builds and WARN in release.

Timeouts

timeouts = WirexTimeouts(connectMillis, readMillis) on create(...). Both default to 15 seconds. A timed-out
request fails with code TEMPORARY and retryable = true.

Troubleshooting