SRC-21: add out-of-band fee-on-transfer token standard

SNIPS/snip-x.md

@@ -0,0 +1,63 @@
+---
+snip: $SNIP_ID
+title: Out-of-band fee-on-transfer tokens
+author: Moody Salem <[email protected]>
+status: Living
+type: SRC
+created: 2024-07-29
+---
+
+## Simple Summary
+
+Defines a standard for fee-on-transfer tokens that maintains the semantics of fungible token transfers and has no changes to the existing tokens interface.
+
+## Abstract
+
+Fee-on-transfer is the idea of charging a fee whenever fungible tokens are transferred from one address to another. Such tokens are very popular on other networks. These tokens have inconsistent implementations and do not work well with many DeFi protocols, but are still popular for the deflationary aspect.
+
+In particular, some DeFi protocols such as Ekubo Protocol do not require tokens to be transferred to swap or add liquidity. This allows liquidity providers and swappers to entirely circumvent any possible implementation of a fee taken on transfer--the token contract does not need to be called at all in order to interact with Ekubo pools.
+
+## Motivation
+
+Due to the demand for this functionality, it's important to define a mechanism that makes the best use of Starknet's capabilities. This SRC defines an implementation of fee-on-transfer tokens that maintains the semantics of fungible token transfers, allowing it to be broadly compatible with Starknet DeFi, and also requires no changes to the token interface. This is possible because of Starknet's native account abstraction and multicall.
+
+## Specification
+
+```cairo
+#[starknet::interface]
+pub trait IFeeOnTransferToken<TContractState> {
+    // Gets the amount of fees already paid for the given sender
+    fn get_fees_paid(self: @TContractState, sender: ContractAddress) -> ContractAddress;
+
+    // Returns the amount of fees required to transfer the specified amount of tokens from the given sender to the given recipient.
+    fn compute_fees_required(
+        self: @TContractState, sender: ContractAddress, recipient: ContractAddress, amount: u128
+    ) -> u128;
+
+    // Pay fees from the given address for the specified sender.
+    // If `from` is the caller, then it pays from the caller's balance.
+    // Otherwise, it pays from the allowance of the `from` address to the caller as the spender.
+    fn pay_fees_from(
+        ref self: TContractState, from: ContractAddress, sender: ContractAddress
+    ) -> u128;
+
+    // Withdraws any fees paid for the given sender to the specified recipient address.
+    // This can be called  by anyone for any address--fees are a transient payment location to enable transfers for a given address. Leftover fees should always be withdrawn in the same transaction.
+    // Returns the amount of fees that were withdrawn.
+    fn withdraw_fees_paid(
+        ref self: TContractState, sender: ContractAddress, recipient: ContractAddress
+    ) -> u128;
+}
+```
+
+## Implementation
+
+TBD
+
+## History
+
+- Created 2024-07-29
+
+## Copyright
+
+Copyright and related rights waived via [MIT](../LICENSE).