Rhino.fi Swidge API Reference

Community modules are developed and maintained independently by third-party contributors.

Tether and the WDK Team do not endorse or assume responsibility for their code, security, or maintenance. Use your own judgment and proceed at your own risk.

RhinofiProtocol

RhinofiProtocol extends SwidgeProtocol from @tetherto/wdk-wallet/protocols and implements the shared WDK swidge methods.

import RhinofiProtocol, {
  AccountRequiredError,
  ConfigurationError
} from '@rhino.fi/wdk-protocol-swidge-rhinofi'

const rhinofi = new RhinofiProtocol(account, config)

Constructor

new RhinofiProtocol(account?, config)

Account	Available operations
`WalletAccountEvm`	Discovery, quote, status, and execution.
`WalletAccountEvmErc4337`	Discovery, quote, status, and execution through a smart account.
`WalletAccountReadOnlyEvm`	Discovery and quotes for routes that do not need signing.
`undefined`	Discovery and account-independent setup when route context allows it.

Methods

Method	Description
`quoteSwidge(options)`	Returns a non-binding Rhino.fi route quote.
`swidge(options, config?)`	Executes a route and returns when the source deposit is broadcast.
`getSwidgeStatus(id, options?)`	Maps Rhino.fi operation state to WDK `SwidgeStatus`.
`getSupportedChains()`	Returns chains supported by Rhino.fi config.
`getSupportedTokens(options?)`	Returns tokens supported by Rhino.fi config, optionally filtered by chain context.

`quoteSwidge(options)`

quoteSwidge(options: SwidgeOptions): Promise<SwidgeQuote>

The source chain is derived from the account when required by the route.

`swidge(options, config?)`

swidge(
  options: SwidgeOptions,
  config?: RhinofiProtocolConfig
): Promise<SwidgeResult>

Requires a writable WDK EVM account. The method submits the source-chain deposit and returns the operation ID and source transaction hash.

`getSwidgeStatus(id, options?)`

getSwidgeStatus(
  id: string,
  options?: SwidgeStatusOptions
): Promise<SwidgeStatusResult>

Use the id returned by swidge().

Config Type

type RhinofiProtocolConfig = {
  apiKey: string
  apiBaseUrl?: string
  maxNetworkFeeBps?: number | bigint
  maxProtocolFeeBps?: number | bigint
  configTtlMs?: number
}

Status Mapping

Rhino.fi state	WDK status
`PENDING`, `PENDING_CONFIRMATION`, `DEPOSIT_ACCEPTED`, `ACCEPTED`	`pending`
`EXECUTED`	`completed`
`SWAP_FAILED`	`refund-pending`
`SWAP_FAILED_REFUNDED`, `DEPOSIT_RECEIVED_AFTER_GRACE_PERIOD_REFUNDED`	`refunded`
`DEPOSIT_RECEIVED_AFTER_GRACE_PERIOD`	`action-required`
`FAILED`	`failed`
`CANCELLED`	`cancelled`

Fee Mapping

Rhino.fi quote fee	WDK fee type	Legacy field
`gasFee` plus `sourceGasFee`	`network`	`fee`
Platform and percentage fee remainder	`protocol`	`bridgeFee`

The network and protocol fee amounts are itemized in SwidgeFee[] and denominated in the input token.

Error Types

All Rhino.fi module errors extend RhinofiProtocolError.

Error	When thrown
`AccountRequiredError`	`swidge()` is called without a writable account.
`ConfigurationError`	Required configuration is missing, such as `apiKey`.
`UnsupportedChainError`	A chain is unknown, unsupported, or invalid as a source chain.
`UnsupportedTokenError`	A token is unknown or unsupported on the selected chain.
`FeeLimitExceededError`	Quoted fees exceed configured fee caps.
`UnknownOperationError`	Status is requested for an unknown operation ID.
`SwidgeExecutionError`	Rhino.fi quote or execution fails. The `.code` field can carry provider failure codes.