feat(types): Make DepositPreauth easier to guard

packages/xrpl/HISTORY.md

@@ -13,6 +13,9 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 * Add type for NFToken object that is stored on a `NFTokenPage`.
 * Add type for `account_info`'s `account_flags` property.
 
+### Changed
+* `DeposityPreauth` has a new type definition that will not allow `Authorize` and `Unauthorize` on the same instance. This provides better guard support.
+
 ## 2.8.0 (2023-06-13)
 
 ### Added

packages/xrpl/src/models/transactions/depositPreauth.ts

@@ -3,23 +3,34 @@ import { ValidationError } from '../../errors'
 
 import { BaseTransaction, validateBaseTransaction } from './common'
 
+export interface DepositPreauthBase extends BaseTransaction {
+  TransactionType: 'DepositPreauth'
+}
+
+export interface DepositPreauthWithAuthorize extends DepositPreauthBase {
+  /** The XRP Ledger address of the sender to preauthorize. */
+  Authorize: string
+  Unauthorize: never
+}
+
+export interface DepositPreauthWithUnauthorize extends DepositPreauthBase {
+  Authorize: never
+  /** The XRP Ledger address of a sender whose preauthorization should be revoked. */
+  Unauthorize: string
+}
+
 /**
  * A DepositPreauth transaction gives another account pre-approval to deliver
  * payments to the sender of this transaction. This is only useful if the sender
  * of this transaction is using (or plans to use) Deposit Authorization.
  *
  * @category Transaction Models
+ *
+ * @interface
  */
-export interface DepositPreauth extends BaseTransaction {
-  TransactionType: 'DepositPreauth'
-  /** The XRP Ledger address of the sender to preauthorize. */
-  Authorize?: string
-  /**
-   * The XRP Ledger address of a sender whose preauthorization should be.
-   * revoked.
-   */
-  Unauthorize?: string
-}
+export type DepositPreauth =
+  | DepositPreauthWithAuthorize
+  | DepositPreauthWithUnauthorize
 
 /**
  * Verify the form and type of a DepositPreauth at runtime.

packages/xrpl/src/models/transactions/index.ts

@@ -10,7 +10,11 @@ export { AccountDelete } from './accountDelete'
 export { CheckCancel } from './checkCancel'
 export { CheckCash } from './checkCash'
 export { CheckCreate } from './checkCreate'
-export { DepositPreauth } from './depositPreauth'
+export {
+  DepositPreauth,
+  DepositPreauthWithAuthorize,
+  DepositPreauthWithUnauthorize,
+} from './depositPreauth'
 export { EscrowCancel } from './escrowCancel'
 export { EscrowCreate } from './escrowCreate'
 export { EscrowFinish } from './escrowFinish'