From 1401c14b298e28c1fddb080bb1d4f0db2c6c8d03 Mon Sep 17 00:00:00 2001 From: Matthew Krak Date: Mon, 19 Feb 2024 12:31:53 -0800 Subject: [PATCH] Update README.md to OFTV1.2 --- contracts/token/oft/v2/README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/contracts/token/oft/v2/README.md b/contracts/token/oft/v2/README.md index 5754e90f..1b5d8060 100644 --- a/contracts/token/oft/v2/README.md +++ b/contracts/token/oft/v2/README.md @@ -1,5 +1,18 @@ -## IMPORTANT: OFTV2 +## Clarification on OFT Versions -In order to make the token balance compatible on Aptos e.g. using uint64 to represent balance, OFTV2 has a shared decimal point setting to normalize the data type difference. +### OFTV1.2 -It is recommended to use a smaller shared decimal point on all chains so that your token can have a larger balance. For example, if the decimal point is 18, then you can not have more than approximately 18 * 10^18 tokens bounded by the uint64.max +> [!IMPORTANT] +> Please note that this repo contains OFTV1.2, and is NOT the LayerZero V2 OFT Standard, but rather a second version of OFT built on Endpoint V1. + +We recommend new developers use the [LayerZero V2 OFT Standard](https://github.com/LayerZero-Labs/LayerZero-v2/blob/main/oapp/contracts/oft/OFT.sol) (found in the LayerZero V2 repo) over both the Endpoint V1 OFT V1 and Endpoint V1 OFT V1.2 implementations, as the protocol update comes with improved interfaces, gas optimizations, and greater composability. + +#### When to use LayerZero V2 OFT + +With the release of LayerZero V2, you should consider only using this V2 OFT Standard for your deployments. LayerZero V2 offers developers a smoother developer experience and optimizations to core protocol contracts. + +Read the full [LayerZero V2 Overview](https://docs.layerzero.network/contracts/oft) to learn more. + +#### When to use LayerZero V1 OFT V1.2 + +What if you want to build an Omnichain Fungible Token that supports EVMs and non-EVMs (e.g., Aptos)? In this case, you should use our Endpoint V1 OFT V1.2 which supports both. This version has fees, shared decimals, and composability built in. This Endpoint V1 version of OFT is currently being used in projects such as BTCb.