upload the doc info

docs/.gitignore

@@ -0,0 +1 @@
+book/

docs/book.css

@@ -0,0 +1,13 @@
+table {
+    margin: 0 auto;
+    border-collapse: collapse;
+    width: 100%;
+}
+
+table td:first-child {
+    width: 15%;
+}
+
+table td:nth-child(2) {
+    width: 25%;
+}

docs/book.toml

@@ -0,0 +1,12 @@
+[book]
+src = "src"
+title = ""
+
+[output.html]
+no-section-label = true
+additional-js = ["solidity.min.js"]
+additional-css = ["book.css"]
+git-repository-url = "https://github.com/WuEcho/pancake-transaction-oracle-hooks"
+
+[output.html.fold]
+enable = true

docs/solidity.min.js

@@ -0,0 +1,74 @@
+hljs.registerLanguage("solidity",(()=>{"use strict";function e(){try{return!0
+}catch(e){return!1}}
+var a=/-?(\b0[xX]([a-fA-F0-9]_?)*[a-fA-F0-9]|(\b[1-9](_?\d)*(\.((\d_?)*\d)?)?|\.\d(_?\d)*)([eE][-+]?\d(_?\d)*)?|\b0)(?!\w|\$)/
+;e()&&(a=a.source.replace(/\\b/g,"(?<!\\$)\\b"));var s={className:"number",
+begin:a,relevance:0},n={
+keyword:"assembly let function if switch case default for leave break continue u256 jump jumpi stop return revert selfdestruct invalid",
+built_in:"add sub mul div sdiv mod smod exp not lt gt slt sgt eq iszero and or xor byte shl shr sar addmod mulmod signextend keccak256 pc pop dup1 dup2 dup3 dup4 dup5 dup6 dup7 dup8 dup9 dup10 dup11 dup12 dup13 dup14 dup15 dup16 swap1 swap2 swap3 swap4 swap5 swap6 swap7 swap8 swap9 swap10 swap11 swap12 swap13 swap14 swap15 swap16 mload mstore mstore8 sload sstore msize gas address balance selfbalance caller callvalue calldataload calldatasize calldatacopy codesize codecopy extcodesize extcodecopy returndatasize returndatacopy extcodehash create create2 call callcode delegatecall staticcall log0 log1 log2 log3 log4 chainid origin gasprice basefee blockhash coinbase timestamp number difficulty gaslimit",
+literal:"true false"},i={className:"string",
+begin:/\bhex'(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?'/},t={className:"string",
+begin:/\bhex"(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?"/};function r(e){
+return e.inherit(e.APOS_STRING_MODE,{begin:/(\bunicode)?'/})}function l(e){
+return e.inherit(e.QUOTE_STRING_MODE,{begin:/(\bunicode)?"/})}var o={
+SOL_ASSEMBLY_KEYWORDS:n,baseAssembly:e=>{
+var a=r(e),o=l(e),c=/[A-Za-z_$][A-Za-z_$0-9.]*/,d=e.inherit(e.TITLE_MODE,{
+begin:/[A-Za-z$_][0-9A-Za-z$_]*/,lexemes:c,keywords:n}),u={className:"params",
+begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,lexemes:c,keywords:n,
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,o,s]},_={
+className:"operator",begin:/:=|->/};return{keywords:n,lexemes:c,
+contains:[a,o,i,t,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,s,_,{
+className:"function",lexemes:c,beginKeywords:"function",end:"{",excludeEnd:!0,
+contains:[d,u,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,_]}]}},
+solAposStringMode:r,solQuoteStringMode:l,HEX_APOS_STRING_MODE:i,
+HEX_QUOTE_STRING_MODE:t,SOL_NUMBER:s,isNegativeLookbehindAvailable:e}
+;const{baseAssembly:c,solAposStringMode:d,solQuoteStringMode:u,HEX_APOS_STRING_MODE:_,HEX_QUOTE_STRING_MODE:m,SOL_NUMBER:b,isNegativeLookbehindAvailable:E}=o
+;return e=>{for(var a=d(e),s=u(e),n=[],i=0;i<32;i++)n[i]=i+1
+;var t=n.map((e=>8*e)),r=[];for(i=0;i<=80;i++)r[i]=i
+;var l=n.map((e=>"bytes"+e)).join(" ")+" ",o=t.map((e=>"uint"+e)).join(" ")+" ",g=t.map((e=>"int"+e)).join(" ")+" ",M=[].concat.apply([],t.map((e=>r.map((a=>e+"x"+a))))),p={
+keyword:"var bool string int uint "+g+o+"byte bytes "+l+"fixed ufixed "+M.map((e=>"fixed"+e)).join(" ")+" "+M.map((e=>"ufixed"+e)).join(" ")+" enum struct mapping address new delete if else for while continue break return throw emit try catch revert unchecked _ function modifier event constructor fallback receive error virtual override constant immutable anonymous indexed storage memory calldata external public internal payable pure view private returns import from as using pragma contract interface library is abstract type assembly",
+literal:"true false wei gwei szabo finney ether seconds minutes hours days weeks years",
+built_in:"self this super selfdestruct suicide now msg block tx abi blockhash gasleft assert require Error Panic sha3 sha256 keccak256 ripemd160 ecrecover addmod mulmod log0 log1 log2 log3 log4"
+},O={className:"operator",begin:/[+\-!~*\/%<>&^|=]/
+},C=/[A-Za-z_$][A-Za-z_$0-9]*/,N={className:"params",begin:/\(/,end:/\)/,
+excludeBegin:!0,excludeEnd:!0,lexemes:C,keywords:p,
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,s,b,"self"]},f={
+begin:/\.\s*/,end:/[^A-Za-z0-9$_\.]/,excludeBegin:!0,excludeEnd:!0,keywords:{
+built_in:"gas value selector address length push pop send transfer call callcode delegatecall staticcall balance code codehash wrap unwrap name creationCode runtimeCode interfaceId min max"
+},relevance:2},y=e.inherit(e.TITLE_MODE,{begin:/[A-Za-z$_][0-9A-Za-z$_]*/,
+lexemes:C,keywords:p}),w={className:"built_in",
+begin:(E()?"(?<!\\$)\\b":"\\b")+"(gas|value|salt)(?=:)"};function x(e,a){return{
+begin:(E()?"(?<!\\$)\\b":"\\b")+e+"\\.\\s*",end:/[^A-Za-z0-9$_\.]/,
+excludeBegin:!1,excludeEnd:!0,lexemes:C,keywords:{built_in:e+" "+a},
+contains:[f],relevance:10}}var h=c(e),v=e.inherit(h,{
+contains:h.contains.concat([{begin:/\./,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,
+excludeEnd:!0,keywords:{built_in:"slot offset length address selector"},
+relevance:2},{begin:/_/,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,excludeEnd:!0,
+keywords:{built_in:"slot offset"},relevance:2}])});return{aliases:["sol"],
+keywords:p,lexemes:C,
+contains:[a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,b,w,O,{
+className:"function",lexemes:C,
+beginKeywords:"function modifier event constructor fallback receive error",
+end:/[{;]/,excludeEnd:!0,
+contains:[y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE],illegal:/%/
+},x("msg","gas value data sender sig"),x("block","blockhash coinbase difficulty gaslimit basefee number timestamp chainid"),x("tx","gasprice origin"),x("abi","decode encode encodePacked encodeWithSelector encodeWithSignature encodeCall"),x("bytes","concat"),f,{
+className:"class",lexemes:C,beginKeywords:"contract interface library",end:"{",
+excludeEnd:!0,illegal:/[:"\[\]]/,contains:[{beginKeywords:"is",lexemes:C
+},y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{lexemes:C,
+beginKeywords:"struct enum",end:"{",excludeEnd:!0,illegal:/[:"\[\]]/,
+contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{
+beginKeywords:"import",end:";",lexemes:C,keywords:"import from as",
+contains:[y,a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{
+beginKeywords:"using",end:";",lexemes:C,keywords:"using for",
+contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{className:"meta",
+beginKeywords:"pragma",end:";",lexemes:C,keywords:{
+keyword:"pragma solidity experimental abicoder",
+built_in:"ABIEncoderV2 SMTChecker v1 v2"},
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(a,{
+className:"meta-string"}),e.inherit(s,{className:"meta-string"})]},{
+beginKeywords:"assembly",end:/\b\B/,
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(v,{begin:"{",
+end:"}",endsParent:!0,contains:v.contains.concat([e.inherit(v,{begin:"{",
+end:"}",contains:v.contains.concat(["self"])})])})]}],illegal:/#/}}})());
+
+// Ugly hack to reload HLJS
+hljs.initHighlightingOnLoad();

docs/src/README.md

@@ -0,0 +1,159 @@
+# pancake-transaction-oracle-hooks
+
+## Overview
+
+This repo creates a simple demo for DEX exclusive-access pools and better filters qualified users by combining off-chain and on-chain transaction data verification. This combination provides a more accurate representation of user transaction activities in a privacy-preserving way, giving applications more flexible filtering criteria. In the PancakeSwap case, a suitable exclusive-access condition could be if a user has a 30-day spot transaction volume exceeding $100000 on a CEX platform and has made an on-chain transaction on the BNB Chain, making this user a target user for DEX.
+
+In this demo, transaction proofs can be submitted from the Primus extension or utilized by Primus's zkTLS SDK to attest the user's on-chain and off-chain transactions. Throughout the entire process, the user’s privacy is fully protected. Whether the user meets the exclusive-access demands could be verified by this hook contract. 
+
+For off-chain transaction proof, [Primus's](https://primuslabs.xyz/) zkTLS and IZK techniques are used to verify whether the user’s 30-day spot transaction volume on CEX platforms, such as Binance or OKX, exceeds $100000 or a specific amount, depending on the application’s requirements.
+
+
+![image](./docs/pics/process.jpeg)
+
+
+## Prerequisite
+
+Install foundry, see https://book.getfoundry.sh/getting-started/installation.
+
+## Install
+
+Get the repo:
+
+```sh
+git clone --recursive https://github.com/primus-labs/pancake-transaction-oracle-hooks.git
+cd pancake-transaction-oracle-hooks
+forge install
+forge build
+```
+
+## Primus AttestionRegistry
+
+The [AttestationRegistry](src/attestation/AttestationRegistry.sol) contract is used to register the attestation contract.
+
+![AttestationRegistry Contract](./docs/src/src/attestation/AttestationRegistry.sol/contract.AttestationRegistry.md)
+
+
+
+## Transaction Oracle Hooks
+
+The [Transaction Oracle Hooks](src/pool-cl/volume/CLTransactionOracleHook.solk.sol) implements the `beforeAddLiquidity` and `beforeSwap` hooks.
+
+![Transaction Oracle Hooks Contract](./docs/class/CLTransactionOracleHook.svg)
+
+
+## BSC-Testnet
+
+### Configurations
+
+1. Copy `./.env.bsc-testnet` to `./.env`, and set your private key (`PRIVATE_KEY`).
+2. The following parameters are already set:
+   - Pancake Swap ([Vault](https://testnet.bscscan.com/address/0x08F012b8E2f3021db8bd2A896A7F422F4041F131), [CLPoolManager](https://testnet.bscscan.com/address/0x969D90aC74A1a5228b66440f8C8326a8dA47A5F9), [CLPositionManager](https://testnet.bscscan.com/address/0x89A7D45D007077485CB5aE2abFB740b1fe4FF574), [UniversalRouter](https://testnet.bscscan.com/address/0x30067B296Edf5BEbB1CB7b593898794DDF6ab7c5)). 
+   - The arguments of Hook ([EAS](https://testnet.bscscan.com/address/0x6c2270298b1e6046898a322acB3Cbad6F99f7CBD), [EASProxy](https://testnet.bscscan.com/address/0x620e84546d71A775A82491e1e527292e94a7165A), [SchemaBytes](https://testnet.bascan.io/schema/0x5f868b117fd34565f3626396ba91ef0c9a607a0e406972655c5137c6d4291af9)).
+
+
+### Deployment
+
+
+- Deploy Token
+
+
+```sh
+source .env
+forge script script/DeployToken.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+```
+
+output (sample):
+
+```log
+TOKEN0=0x772F5b156EDaa4874F3f4F81c5e4479EE7E1669B
+TOKEN1=0x7AA33Aa23aB75D37A9c27B0ba51bb10ed6e41a51
+```
+
+Add/replace the above address in `.env`.
+
+<br/>
+
+- Deploy AttestationRegistry
+
+```sh
+source .env
+forge script script/attestation/AttestationRegistry.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+```
+
+output (sample):
+
+```log
+ATTESTATION_REGISTRY=0x6c2270298b1e6046898a322acB3Cbad6F99f7CBD
+```
+
+<br/>
+
+- Deploy Hook
+
+```sh
+source .env
+forge script script/pool-cl/DeployHook.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+```
+
+output (sample):
+
+```log
+HOOK=0xd9Dd1FEaF845Dd036245A504317cCccE7Bc18f49
+```
+
+Add/replace the above address in `.env`.
+
+
+### Before Testing
+
+- Initialize Pool
+
+```sh
+source .env
+forge script script/pool-cl/Test.s.sol:TestInitializeScript --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+```
+
+This command only needs to be executed once.
+
+<br/>
+
+- Transfer Token (Optional)
+
+Request some tokens from the Token owner. (If necessary)
+
+```sh
+source .env
+export RECEIVER=<the receiver address>
+# export RECEIVER=0x...
+forge script script/Transfer.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+```
+
+<br/>
+
+- Token Approve
+
+Before swap testing, need approve first.
+
+```sh
+source .env
+forge script script/Approve.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+```
+
+### Testing
+
+- Test AddLiquidity
+
+```sh
+source .env
+forge script script/pool-cl/Test.s.sol:TestAddLiquidityScript --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+```
+
+<br/>
+
+- Test Swap
+
+```sh
+source .env
+forge script script/pool-cl/Test.s.sol:TestSwapScript --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+```

docs/src/SUMMARY.md

@@ -0,0 +1,20 @@
+# Summary
+- [Home](README.md)
+# src
+  - [❱ attestation](src/attestation/README.md)
+    - [CexInfo](src/attestation/AttestationRegistry.sol/struct.CexInfo.md)
+    - [AttestationRegistry](src/attestation/AttestationRegistry.sol/contract.AttestationRegistry.md)
+  - [❱ pool-bin](src/pool-bin/README.md)
+    - [❱ volume](src/pool-bin/volume/README.md)
+      - [BinExchangeVolumeHook](src/pool-bin/volume/BinExchangeVolumeHook.sol/contract.BinExchangeVolumeHook.md)
+    - [BinBaseHook](src/pool-bin/BinBaseHook.sol/abstract.BinBaseHook.md)
+  - [❱ pool-cl](src/pool-cl/README.md)
+    - [❱ volume](src/pool-cl/volume/README.md)
+      - [CLExchangeVolumeHook](src/pool-cl/volume/CLExchangeVolumeHook.sol/contract.CLExchangeVolumeHook.md)
+    - [CLBaseHook](src/pool-cl/CLBaseHook.sol/abstract.CLBaseHook.md)
+  - [❱ types](src/types/README.md)
+    - [Attestation](src/types/Common.sol/struct.Attestation.md)
+  - [❱ utils](src/utils/README.md)
+    - [JsonParser](src/utils/JsonParser.sol/library.JsonParser.md)
+  - [BaseFeeDiscountHook](src/BaseFeeDiscountHook.sol/abstract.BaseFeeDiscountHook.md)
+  - [IAttestationRegistry](src/IAttestationRegistry.sol/interface.IAttestationRegistry.md)

docs/src/src/BaseFeeDiscountHook.sol/abstract.BaseFeeDiscountHook.md

@@ -0,0 +1,111 @@
+# BaseFeeDiscountHook
+[Git Source](https://github.com/WuEcho/pancake-transaction-oracle-hooks/blob/feca97195ce7999ef87419eab15c366c609ecf4a/src/BaseFeeDiscountHook.sol)
+
+**Inherits:**
+Ownable
+
+
+## State Variables
+### defaultFee
+
+```solidity
+uint24 private defaultFee = 3000;
+```
+
+
+### baseValue
+
+```solidity
+uint24 private baseValue = 10000;
+```
+
+
+### iAttestationRegistry
+
+```solidity
+IAttestationRegistry internal iAttestationRegistry;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(IAttestationRegistry _iAttestationRegistry, address initialOwner) Ownable(initialOwner);
+```
+
+### getFeeDiscount
+
+
+```solidity
+function getFeeDiscount(address sender, PoolKey memory poolKey) internal view returns (uint24);
+```
+
+### setDefaultFee
+
+
+```solidity
+function setDefaultFee(uint24 fee) external onlyOwner;
+```
+
+### getDefaultFee
+
+
+```solidity
+function getDefaultFee() external view returns (uint24);
+```
+
+### setBaseValue
+
+
+```solidity
+function setBaseValue(uint24 _baseValue) external onlyOwner;
+```
+
+### getBaseValue
+
+
+```solidity
+function getBaseValue() external view returns (uint24);
+```
+
+### _checkAttestations
+
+
+```solidity
+function _checkAttestations(address sender) internal view returns (bool);
+```
+
+## Events
+### BeforeAddLiquidity
+
+```solidity
+event BeforeAddLiquidity(address indexed sender);
+```
+
+### BeforeSwap
+
+```solidity
+event BeforeSwap(address indexed sender);
+```
+
+## Errors
+### NotSupportedExchange
+
+```solidity
+error NotSupportedExchange();
+```
+
+### AttestationExpired
+
+```solidity
+error AttestationExpired();
+```
+
+### NoAttestationEligibility
+
+```solidity
+error NoAttestationEligibility();
+```
+