feat(protocols): add SDA (Smart Deposit Address) protocol interface

index.js

@@ -32,6 +32,12 @@ export {
 
 export { IWalletAccount } from './src/wallet-account.js'
 
-export { NotImplementedError, SignerError } from './src/errors.js'
+export {
+  NotImplementedError,
+  SignerError,
+  UnsupportedOperationError,
+  ValueError,
+  NoSuchElementError
+} from './src/errors.js'
 
 export { ISigner } from './src/signer.js'

src/errors.js

@@ -38,3 +38,44 @@ export class SignerError extends Error {
     this.name = 'SignerError'
   }
 }
+
+export class UnsupportedOperationError extends Error {
+  /**
+   * Create a new unsupported operation error. Thrown by an optional operation
+   * that the concrete implementation deliberately does not support.
+   *
+   * @param {string} operation - The name of the operation that is not supported.
+   */
+  constructor (operation) {
+    super(`Operation '${operation}' is not supported by this protocol.`)
+
+    this.name = 'UnsupportedOperationError'
+  }
+}
+
+export class ValueError extends Error {
+  /**
+   * Create a new value error. Thrown when an argument fails validation.
+   *
+   * @param {string} message - The error's message.
+   */
+  constructor (message) {
+    super(message)
+
+    this.name = 'ValueError'
+  }
+}
+
+export class NoSuchElementError extends Error {
+  /**
+   * Create a new no such element error. Thrown when a lookup finds no element for
+   * the given identifier.
+   *
+   * @param {string} message - The error's message.
+   */
+  constructor (message) {
+    super(message)
+
+    this.name = 'NoSuchElementError'
+  }
+}

src/protocols/index.js

@@ -68,6 +68,25 @@
 /** @typedef {import('./swidge-protocol.js').SwidgeSupportedToken} SwidgeSupportedToken */
 /** @typedef {import('./swidge-protocol.js').SwidgeSupportedTokensOptions} SwidgeSupportedTokensOptions */
 
+/** @typedef {import('./sda-protocol.js').Blockchain} Blockchain */
+/** @typedef {import('./sda-protocol.js').SdaToken} SdaToken */
+/** @typedef {import('./sda-protocol.js').SdaDepositAddressLimits} SdaDepositAddressLimits */
+/** @typedef {import('./sda-protocol.js').SdaRoutesOptions} SdaRoutesOptions */
+/** @typedef {import('./sda-protocol.js').SdaRoute} SdaRoute */
+/** @typedef {import('./sda-protocol.js').SdaDepositOptions} SdaDepositOptions */
+/** @typedef {import('./sda-protocol.js').SdaFeeType} SdaFeeType */
+/** @typedef {import('./sda-protocol.js').SdaFee} SdaFee */
+/** @typedef {import('./sda-protocol.js').SdaDepositQuote} SdaDepositQuote */
+/** @typedef {import('./sda-protocol.js').SdaCreateDepositAddressOptions} SdaCreateDepositAddressOptions */
+/** @typedef {import('./sda-protocol.js').SdaDepositAddress} SdaDepositAddress */
+/** @typedef {import('./sda-protocol.js').SdaTransferStatus} SdaTransferStatus */
+/** @typedef {import('./sda-protocol.js').SdaTransfer} SdaTransfer */
+/** @typedef {import('./sda-protocol.js').SdaTransfersOptions} SdaTransfersOptions */
+/** @typedef {import('./sda-protocol.js').SdaRecoverById} SdaRecoverById */
+/** @typedef {import('./sda-protocol.js').SdaRecoverByAddress} SdaRecoverByAddress */
+/** @typedef {import('./sda-protocol.js').SdaRecoveryOptions} SdaRecoveryOptions */
+/** @typedef {import('./sda-protocol.js').SdaRecoveryResult} SdaRecoveryResult */
+
 export { default as SwapProtocol, ISwapProtocol } from './swap-protocol.js'
 
 export { default as BridgeProtocol, IBridgeProtocol } from './bridge-protocol.js'
@@ -77,3 +96,5 @@ export { default as LendingProtocol, ILendingProtocol } from './lending-protocol
 export { default as FiatProtocol, IFiatProtocol } from './fiat-protocol.js'
 
 export { default as SwidgeProtocol, ISwidgeProtocol } from './swidge-protocol.js'
+
+export { default as SdaProtocol, ISdaProtocol } from './sda-protocol.js'