CBP-3: (Compatibility token standard namespace convention) for Comments

CBPs/cbd-0003.md

@@ -0,0 +1,171 @@
+---
+cbp: 3
+title: Compatibility token standard namespace convention
+description: To solve the naming conflict problem between different token standards.
+author: ICLighthouse(@iclighthouse, https://github.com/iclighthouse)
+discussions-to: https://forum.dfinity.org/t/discussion-on-the-compatibility-of-different-token-standards/11246
+status: Draft
+type: Standard
+created: 2022-03-03
+---
+
+## Abstract
+There are multiple different implementations of the Dfinity token (Fungible Token and Non-Fungible Token) standards and no consensus can be formed. This will be detrimental to the development of dApps on IC network.
+
+IC Canister's methods are not allowed polymorphism, and method naming conflicts will create a barrier to token compatibility.
+
+CBP3 is a compatibility token standard namespace convention that provides compatibility and interoperability for different standards implementations. This is a convention (not mandatory) and is minimally intrusive for different implementations.
+
+## Motivation
+
+It enables compatibility between different token standards through namespace conventions and specifications.
+
+To achieve.
+
+- Forward Compatible
+- Horizontally Compatible
+- Scalable
+- Minimally Intrusive
+
+## Specification
+
+The main interface implements a standard scheme using the method names of ERC20. The optional compatibility interface implements self/other standard schemes with the method names plus the namespace (prefix `xxx_`).
+
+### Specific public methods
+
+Returns the list of supported token standards (standard name i. e. namespace), in lowercase letters, separated by "`; `". The format is similar to "`main_standard; compatible_standard1; compatible_standard2`". E.g. "`dip20; drc20`", "`dft`".  
+
+``` candid
+standard: () -> (text) query;
+```
+
+### Main interface
+
+Use the method names of ERC20 to define the main interface, which allows you to implement the main standard of your choice.
+
+``` candid
+For example:
+
+name: () -> (text) query;
+symbol: () -> (text) query;
+decimals: () -> (nat8) query;
+totalSupply: () -> (nat) query;
+balanceOf: (...) -> (...) query;
+transfer: (...) -> (...);
+transferFrom: (...) -> (...);
+approve: (...) -> (...);
+allowance: (...) -> (...);
+...
+```
+
+### Optional compatibility interface
+
+Use the method names prefixed with standard name "xxx_" to define the compatibility interfaces.
+
+``` candid
+For example 1:
+
+dip20_name: () -> (text) query;
+dip20_symbol: () -> (text) query;
+dip20_decimals: () -> (nat8) query;
+dip20_totalSupply: () -> (nat) query;
+dip20_balanceOf: (...) -> (...) query;
+dip20_transfer: (...) -> (...);
+dip20_transferFrom: (...) -> (...);
+dip20_approve: (...) -> (...);
+dip20_allowance: (...) -> (...);
+...
+```
+``` candid
+For example 2:
+
+dft_name: () -> (text) query;
+dft_symbol: () -> (text) query;
+dft_decimals: () -> (nat8) query;
+dft_totalSupply: () -> (nat) query;
+dft_balanceOf: (...) -> (...) query;
+dft_transfer: (...) -> (...);
+dft_transferFrom: (...) -> (...);
+dft_approve: (...) -> (...);
+dft_allowance: (...) -> (...);
+...
+```
+
+## Single-standard compatibility example
+
+``` candid
+standard: () -> (text) query;  // “drc20”
+
+// drc20
+name: () -> (text) query;
+symbol: () -> (text) query;
+decimals: () -> (nat8) query;
+totalSupply: () -> (nat) query;
+balanceOf: (...) -> (...) query;
+transfer: (...) -> (...);
+transferFrom: (...) -> (...);
+approve: (...) -> (...);
+allowance: (...) -> (...);
+...
+
+// drc20 (Compatibility aliases)
+drc20_name: () -> (text) query;
+drc20_symbol: () -> (text) query;
+drc20_decimals: () -> (nat8) query;
+drc20_totalSupply: () -> (nat) query;
+drc20_balanceOf: (...) -> (...) query;
+drc20_transfer: (...) -> (...);
+drc20_transferFrom: (...) -> (...);
+drc20_approve: (...) -> (...);
+drc20_allowance: (...) -> (...);
+...
+```
+
+## Multi-standard compatibility example
+
+``` candid
+standard: () -> (text) query;  // “dft; drc20”
+
+// dft
+name: () -> (text) query;
+symbol: () -> (text) query;
+decimals: () -> (nat8) query;
+totalSupply: () -> (nat) query;
+balanceOf: (...) -> (...) query;
+transfer: (...) -> (...);
+transferFrom: (...) -> (...);
+approve: (...) -> (...);
+allowance: (...) -> (...);
+...
+
+// drc20
+dip20_name: () -> (text) query;
+dip20_symbol: () -> (text) query;
+dip20_decimals: () -> (nat8) query;
+dip20_totalSupply: () -> (nat) query;
+dip20_balanceOf: (...) -> (...) query;
+dip20_transfer: (...) -> (...);
+dip20_transferFrom: (...) -> (...);
+dip20_approve: (...) -> (...);
+dip20_allowance: (...) -> (...);
+...
+```
+
+## Standard List
+(Welcome to add new token standards!)
+
+### Fungible Token
+
+- dip20: https://github.com/Psychedelic/DIP20
+- dft: https://github.com/Deland-Labs/dfinity-fungible-token-standard
+- drc20: https://github.com/iclighthouse/DRC_standards/tree/main/DRC20
+- ext: https://github.com/Toniq-Labs/extendable-token
+- motokotoken: https://github.com/enzoh/motoko-token
+- is20: https://github.com/infinity-swap/IS20
+
+### Non-Fungible Token
+
+- departureLabsnft: https://github.com/DepartureLabsIC/non-fungible-token
+- ext: https://github.com/Toniq-Labs/extendable-token
+- dip721: https://github.com/SuddenlyHazel/DIP721
+- c3nft: https://github.com/C3-Protocol/NFT-standards