added docs

.gitignore

@@ -11,9 +11,6 @@ coverage/
 /broadcast/*/84532/
 /broadcast/**/dry-run/
 
-# Docs
-docs/
-
 # Forge files
 cache/
 out/

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/firstbatchxyz/swan-contracts"
+
+[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,121 @@
+# Swan Protocol
+
+This document provides instructions for swan contracts using Foundry.
+
+## Test
+
+Compile the contracts:
+
+```sh
+make build
+```
+
+> [!NOTE]
+>
+> Please prepare a valid `.env` according to `.env.example` before running tests.
+
+Run tests on forked base-sepolia:
+
+```sh
+make test
+```
+
+## Coverage
+
+Check coverages with:
+
+```sh
+bash coverage.sh
+```
+
+You can see coverages under the coverage directory.
+
+## Storage Layout
+
+Get storage layout with:
+
+```sh
+bash storage.sh
+```
+
+You can see storage layouts under the storage directory.
+
+## Deployment
+
+**Step 1.**
+Import your `PUBLIC_KEY` and `ETHERSCAN_API_KEY` to env file.
+
+> [!NOTE]
+>
+> Foundry expects the API key to be defined as `ETHERSCAN_API_KEY` even though you're using another explorer.
+
+**Step 2.**
+Create keystores for deployment. [See more for keystores](https://eips.ethereum.org/EIPS/eip-2335)
+
+```sh
+make local-key
+```
+
+or for Base Sepolia
+
+```sh
+make base-sepolia-key
+```
+
+> [!NOTE]
+>
+> Recommended to create keystores on directly on your shell.
+> You HAVE to type your password on the terminal to be able to use your keys. (e.g when deploying a contract)
+
+**Step 3.**
+Enter your private key (associated with the public key you added to env file) and password on terminal. You'll see your public key on terminal.
+
+> [!NOTE]
+>
+> If you want to deploy contracts on localhost please provide localhost public key for the command above.
+
+**Step 4.** Required only for local deployment.
+
+Start a local node with:
+
+```sh
+make anvil
+```
+
+**Step 5.**
+Deploy the contracts on localhost (forked Base Sepolia by default) using Deploy script:
+
+```sh
+make deploy
+```
+
+or Base Sepolia with the command below:
+
+```sh
+make deploy base-sepolia
+```
+
+You can see deployed contract addresses under the `deployment/<chainid>.json`
+
+## Gas Snapshot
+
+Take the gas snapshot with:
+
+```sh
+make snapshot
+```
+
+You can see the snapshot `.gas-snapshot` in the current directory.
+
+## Generate documentation
+
+```sh
+make doc
+```
+
+You can also use the command below if you want to see docs locally with the given port number.
+
+```sh
+make doc --serve --port <port-number>
+
+```

docs/src/SUMMARY.md

@@ -0,0 +1,27 @@
+# Summary
+- [Home](README.md)
+# contracts
+  - [❱ libraries](contracts/libraries/README.md)
+    - [Statistics](contracts/libraries/Statistics.sol/library.Statistics.md)
+  - [❱ llm](contracts/llm/README.md)
+    - [LLMOracleCoordinator](contracts/llm/LLMOracleCoordinator.sol/contract.LLMOracleCoordinator.md)
+    - [LLMOracleManager](contracts/llm/LLMOracleManager.sol/contract.LLMOracleManager.md)
+    - [LLMOracleKind](contracts/llm/LLMOracleRegistry.sol/enum.LLMOracleKind.md)
+    - [LLMOracleRegistry](contracts/llm/LLMOracleRegistry.sol/contract.LLMOracleRegistry.md)
+    - [LLMOracleTaskParameters](contracts/llm/LLMOracleTask.sol/struct.LLMOracleTaskParameters.md)
+    - [LLMOracleTask](contracts/llm/LLMOracleTask.sol/interface.LLMOracleTask.md)
+  - [❱ mock](contracts/mock/README.md)
+    - [LLMOracleCoordinatorV2](contracts/mock/LLMOracleCoordinatorV2.sol/contract.LLMOracleCoordinatorV2.md)
+    - [LLMOracleRegistryV2](contracts/mock/LLMOracleRegistryV2.sol/contract.LLMOracleRegistryV2.md)
+    - [SwanV2](contracts/mock/SwanV2.sol/contract.SwanV2.md)
+  - [❱ swan](contracts/swan/README.md)
+    - [BuyerAgentFactory](contracts/swan/BuyerAgent.sol/contract.BuyerAgentFactory.md)
+    - [BuyerAgent](contracts/swan/BuyerAgent.sol/contract.BuyerAgent.md)
+    - [Swan](contracts/swan/Swan.sol/contract.Swan.md)
+    - [Swan constants](contracts/swan/Swan.sol/constants.Swan.md)
+    - [SwanAssetFactory](contracts/swan/SwanAsset.sol/contract.SwanAssetFactory.md)
+    - [SwanAsset](contracts/swan/SwanAsset.sol/contract.SwanAsset.md)
+    - [SwanMarketParameters](contracts/swan/SwanManager.sol/struct.SwanMarketParameters.md)
+    - [SwanManager](contracts/swan/SwanManager.sol/abstract.SwanManager.md)
+  - [❱ token](contracts/token/README.md)
+    - [WETH9](contracts/token/WETH9.sol/contract.WETH9.md)

docs/src/contracts/README.md

@@ -0,0 +1,8 @@
+
+
+# Contents
+- [libraries](/contracts/libraries)
+- [llm](/contracts/llm)
+- [mock](/contracts/mock)
+- [swan](/contracts/swan)
+- [token](/contracts/token)

docs/src/contracts/libraries/README.md

@@ -0,0 +1,4 @@
+
+
+# Contents
+- [Statistics](Statistics.sol/library.Statistics.md)

docs/src/contracts/libraries/Statistics.sol/library.Statistics.md

@@ -0,0 +1,71 @@
+# Statistics
+[Git Source](https://github.com/firstbatchxyz/swan-contracts/blob/ceefa4b0353ce4c0f1536b7318fa82b208305342/contracts/libraries/Statistics.sol)
+
+Simple statistic library for uint256 arrays, numbers are treat as fixed-precision floats.
+
+
+## Functions
+### avg
+
+Compute the mean of the data.
+
+
+```solidity
+function avg(uint256[] memory data) internal pure returns (uint256 ans);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`data`|`uint256[]`|The data to compute the mean for.|
+
+
+### variance
+
+Compute the variance of the data.
+
+
+```solidity
+function variance(uint256[] memory data) internal pure returns (uint256 ans, uint256 mean);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`data`|`uint256[]`|The data to compute the variance for.|
+
+
+### stddev
+
+Compute the standard deviation of the data.
+
+*Computes variance, and takes the square root.*
+
+
+```solidity
+function stddev(uint256[] memory data) internal pure returns (uint256 ans, uint256 mean);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`data`|`uint256[]`|The data to compute the standard deviation for.|
+
+
+### sqrt
+
+Compute the square root of a number.
+
+*Uses Babylonian method.*
+
+
+```solidity
+function sqrt(uint256 x) internal pure returns (uint256 y);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`x`|`uint256`|The number to compute the square root for.|
+
+