From 48d69ce74c33c6ce783b31f97af39e3153e8ed6c Mon Sep 17 00:00:00 2001 From: lash Date: Thu, 3 Aug 2023 10:34:38 +0100 Subject: [PATCH] clarify limiter functionality --- README.md | 6 ++++++ doc/texinfo/tokenlimit.sol.texi | 4 ++++ python/README.md | 6 ++++++ 3 files changed, 16 insertions(+) diff --git a/README.md b/README.md index 9af02ee..0d2b702 100644 --- a/README.md +++ b/README.md @@ -637,6 +637,12 @@ Use cases of sealing include: Define limits of value amounts of tokens that individual addresses can hold. +Limits are inclusive; a limit for 42 means transfer resulting in a token +balance \_higher\_ than 42 should be rejected. + +A return value of 0 indicates that the token is categorically not +accepted by the holder. + #### ERC165 Interface identifier 23778613 diff --git a/doc/texinfo/tokenlimit.sol.texi b/doc/texinfo/tokenlimit.sol.texi index 8aa45ba..a63bc42 100644 --- a/doc/texinfo/tokenlimit.sol.texi +++ b/doc/texinfo/tokenlimit.sol.texi @@ -2,6 +2,10 @@ Define limits of value amounts of tokens that individual addresses can hold. +Limits are inclusive; a limit for 42 means transfer resulting in a token balance _higher_ than 42 should be rejected. + +A return value of 0 indicates that the token is categorically not accepted by the holder. + @subsubsection ERC165 Interface identifier @include ../../build/TokenLimit.interface diff --git a/python/README.md b/python/README.md index 9af02ee..0d2b702 100644 --- a/python/README.md +++ b/python/README.md @@ -637,6 +637,12 @@ Use cases of sealing include: Define limits of value amounts of tokens that individual addresses can hold. +Limits are inclusive; a limit for 42 means transfer resulting in a token +balance \_higher\_ than 42 should be rejected. + +A return value of 0 indicates that the token is categorically not +accepted by the holder. + #### ERC165 Interface identifier 23778613