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

index.js

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

src/errors.js

@@ -38,3 +38,32 @@ 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, so consumers
+   * can distinguish "not supported here" from an abstract method left unimplemented.
+   *
+   * @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 AccountRequiredError extends Error {
+  /**
+   * Create a new account required error. Thrown when an operation needs a wallet
+   * account to run but none was bound at construction.
+   *
+   * @param {string} operation - The name of the operation that requires a wallet account.
+   */
+  constructor (operation) {
+    super(`Operation '${operation}' requires a wallet account.`)
+
+    this.name = 'AccountRequiredError'
+  }
+}

src/protocols/index.js

@@ -68,6 +68,29 @@
 /** @typedef {import('./swidge-protocol.js').SwidgeSupportedToken} SwidgeSupportedToken */
 /** @typedef {import('./swidge-protocol.js').SwidgeSupportedTokensOptions} SwidgeSupportedTokensOptions */
 
+/** @typedef {import('./sda-protocol.js').SdaRecoveryMode} SdaRecoveryMode */
+/** @typedef {import('./sda-protocol.js').SdaRouteDiscoveryMode} SdaRouteDiscoveryMode */
+/** @typedef {import('./sda-protocol.js').SdaCustodyModel} SdaCustodyModel */
+/** @typedef {import('./sda-protocol.js').SdaActivationModel} SdaActivationModel */
+/** @typedef {import('./sda-protocol.js').Blockchain} Blockchain */
+/** @typedef {import('./sda-protocol.js').SdaToken} SdaToken */
+/** @typedef {import('./sda-protocol.js').SdaLimits} SdaLimits */
+/** @typedef {import('./sda-protocol.js').SdaRoutesOptions} SdaRoutesOptions */
+/** @typedef {import('./sda-protocol.js').SdaRoute} SdaRoute */
+/** @typedef {import('./sda-protocol.js').SdaQuoteOptions} SdaQuoteOptions */
+/** @typedef {import('./sda-protocol.js').SdaFeeType} SdaFeeType */
+/** @typedef {import('./sda-protocol.js').SdaFee} SdaFee */
+/** @typedef {import('./sda-protocol.js').SdaQuote} SdaQuote */
+/** @typedef {import('./sda-protocol.js').SdaCreateOptions} SdaCreateOptions */
+/** @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 +100,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'

types/index.d.ts

@@ -1,12 +1,12 @@
+export { default } from "./src/wallet-manager.js";
+export { IWalletAccount } from "./src/wallet-account.js";
+export { ISigner } from "./src/signer.js";
 export type FeeRates = import("./src/wallet-manager.js").FeeRates;
 export type WalletConfig = import("./src/wallet-manager.js").WalletConfig;
 export type Transaction = import("./src/wallet-account-read-only.js").Transaction;
 export type TransactionResult = import("./src/wallet-account-read-only.js").TransactionResult;
 export type TransferOptions = import("./src/wallet-account-read-only.js").TransferOptions;
 export type TransferResult = import("./src/wallet-account-read-only.js").TransferResult;
 export type KeyPair = import("./src/wallet-account.js").KeyPair;
-export { default } from "./src/wallet-manager.js";
 export { default as WalletAccountReadOnly, IWalletAccountReadOnly } from "./src/wallet-account-read-only.js";
-export { IWalletAccount } from "./src/wallet-account.js";
-export { NotImplementedError, SignerError } from "./src/errors.js";
-export { ISigner } from "./src/signer.js";
+export { NotImplementedError, SignerError, UnsupportedOperationError, AccountRequiredError } from "./src/errors.js";

types/src/errors.d.ts

@@ -14,3 +14,22 @@ export class SignerError extends Error {
      */
     constructor(message: string);
 }
+export class UnsupportedOperationError extends Error {
+    /**
+     * Create a new unsupported operation error. Thrown by an optional operation
+     * that the concrete implementation deliberately does not support, so consumers
+     * can distinguish "not supported here" from an abstract method left unimplemented.
+     *
+     * @param {string} operation - The name of the operation that is not supported.
+     */
+    constructor(operation: string);
+}
+export class AccountRequiredError extends Error {
+    /**
+     * Create a new account required error. Thrown when an operation needs a wallet
+     * account to run but none was bound at construction.
+     *
+     * @param {string} operation - The name of the operation that requires a wallet account.
+     */
+    constructor(operation: string);
+}

types/src/protocols/index.d.ts

@@ -44,8 +44,31 @@ export type SwidgeStatusResult = import("./swidge-protocol.js").SwidgeStatusResu
 export type SwidgeSupportedChain = import("./swidge-protocol.js").SwidgeSupportedChain;
 export type SwidgeSupportedToken = import("./swidge-protocol.js").SwidgeSupportedToken;
 export type SwidgeSupportedTokensOptions = import("./swidge-protocol.js").SwidgeSupportedTokensOptions;
+export type SdaRecoveryMode = import("./sda-protocol.js").SdaRecoveryMode;
+export type SdaRouteDiscoveryMode = import("./sda-protocol.js").SdaRouteDiscoveryMode;
+export type SdaCustodyModel = import("./sda-protocol.js").SdaCustodyModel;
+export type SdaActivationModel = import("./sda-protocol.js").SdaActivationModel;
+export type Blockchain = import("./sda-protocol.js").Blockchain;
+export type SdaToken = import("./sda-protocol.js").SdaToken;
+export type SdaLimits = import("./sda-protocol.js").SdaLimits;
+export type SdaRoutesOptions = import("./sda-protocol.js").SdaRoutesOptions;
+export type SdaRoute = import("./sda-protocol.js").SdaRoute;
+export type SdaQuoteOptions = import("./sda-protocol.js").SdaQuoteOptions;
+export type SdaFeeType = import("./sda-protocol.js").SdaFeeType;
+export type SdaFee = import("./sda-protocol.js").SdaFee;
+export type SdaQuote = import("./sda-protocol.js").SdaQuote;
+export type SdaCreateOptions = import("./sda-protocol.js").SdaCreateOptions;
+export type SdaDepositAddress = import("./sda-protocol.js").SdaDepositAddress;
+export type SdaTransferStatus = import("./sda-protocol.js").SdaTransferStatus;
+export type SdaTransfer = import("./sda-protocol.js").SdaTransfer;
+export type SdaTransfersOptions = import("./sda-protocol.js").SdaTransfersOptions;
+export type SdaRecoverById = import("./sda-protocol.js").SdaRecoverById;
+export type SdaRecoverByAddress = import("./sda-protocol.js").SdaRecoverByAddress;
+export type SdaRecoveryOptions = import("./sda-protocol.js").SdaRecoveryOptions;
+export type SdaRecoveryResult = import("./sda-protocol.js").SdaRecoveryResult;
 export { default as SwapProtocol, ISwapProtocol } from "./swap-protocol.js";
 export { default as BridgeProtocol, IBridgeProtocol } from "./bridge-protocol.js";
 export { default as LendingProtocol, ILendingProtocol } from "./lending-protocol.js";
 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";