diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 6f0920b..6a2a3d8 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -31,7 +31,8 @@ jobs: run: | echo Foundry profile: $FOUNDRY_PROFILE forge --version - forge build --sizes + forge build + forge build --sizes src/* id: build - name: Run Forge tests diff --git a/docs/autogen/.gitignore b/docs/autogen/.gitignore deleted file mode 100644 index 4e42a1b..0000000 --- a/docs/autogen/.gitignore +++ /dev/null @@ -1 +0,0 @@ -book/ \ No newline at end of file diff --git a/docs/autogen/book.css b/docs/autogen/book.css deleted file mode 100644 index b5ce903..0000000 --- a/docs/autogen/book.css +++ /dev/null @@ -1,13 +0,0 @@ -table { - margin: 0 auto; - border-collapse: collapse; - width: 100%; -} - -table td:first-child { - width: 15%; -} - -table td:nth-child(2) { - width: 25%; -} \ No newline at end of file diff --git a/docs/autogen/book.toml b/docs/autogen/book.toml deleted file mode 100644 index 6654d46..0000000 --- a/docs/autogen/book.toml +++ /dev/null @@ -1,13 +0,0 @@ -[book] -src = "src" -title = "" - -[output.html] -no-section-label = true -additional-js = ["solidity.min.js"] -additional-css = ["book.css"] -mathjax-support = true -git-repository-url = "https://github.com/Uniswap/foundry-template" - -[output.html.fold] -enable = true diff --git a/docs/autogen/solidity.min.js b/docs/autogen/solidity.min.js deleted file mode 100644 index 1924932..0000000 --- a/docs/autogen/solidity.min.js +++ /dev/null @@ -1,74 +0,0 @@ -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,"(?{ -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()?"(? --verify -``` - -## Docs - -The documentation and architecture diagrams for the contracts within this repo can be found [here](docs/). -Detailed documentation generated from the NatSpec documentation of the contracts can be found [here](docs/autogen/src/src/). -When exploring the contracts within this repository, it is recommended to start with the interfaces first and then move on to the implementation as outlined [here](CONTRIBUTING.md#natspec--comments) - -## Contributing - -If you want to contribute to this project, please check [CONTRIBUTING.md](CONTRIBUTING.md) first. diff --git a/docs/autogen/src/SUMMARY.md b/docs/autogen/src/SUMMARY.md deleted file mode 100644 index 5890735..0000000 --- a/docs/autogen/src/SUMMARY.md +++ /dev/null @@ -1,6 +0,0 @@ -# Summary -- [Home](README.md) -# src - - [❱ interfaces](src/interfaces/README.md) - - [ICounter](src/interfaces/ICounter.sol/interface.ICounter.md) - - [Counter](src/Counter.sol/contract.Counter.md) diff --git a/docs/autogen/src/src/Counter.sol/contract.Counter.md b/docs/autogen/src/src/Counter.sol/contract.Counter.md deleted file mode 100644 index 150384a..0000000 --- a/docs/autogen/src/src/Counter.sol/contract.Counter.md +++ /dev/null @@ -1,47 +0,0 @@ -# Counter -[Git Source](https://github.com/Uniswap/foundry-template/blob/0864bd3fda3ae2b97362ae80691cd59ca9cf5090/src/Counter.sol) - -**Inherits:** -[ICounter](/src/interfaces/ICounter.sol/interface.ICounter.md) - - -## State Variables -### number - -```solidity -uint256 public number; -``` - - -## Functions -### constructor - - -```solidity -constructor(uint256 initialNumber); -``` - -### setNumber - -Sets the number - - -```solidity -function setNumber(uint256 newNumber) public; -``` -**Parameters** - -|Name|Type|Description| -|----|----|-----------| -|`newNumber`|`uint256`|The new number| - - -### increment - -Increments the number by 1 - - -```solidity -function increment() public; -``` - diff --git a/docs/autogen/src/src/README.md b/docs/autogen/src/src/README.md deleted file mode 100644 index c0bac33..0000000 --- a/docs/autogen/src/src/README.md +++ /dev/null @@ -1,5 +0,0 @@ - - -# Contents -- [interfaces](/src/interfaces) -- [Counter](Counter.sol/contract.Counter.md) diff --git a/docs/autogen/src/src/interfaces/ICounter.sol/interface.ICounter.md b/docs/autogen/src/src/interfaces/ICounter.sol/interface.ICounter.md deleted file mode 100644 index a5347fb..0000000 --- a/docs/autogen/src/src/interfaces/ICounter.sol/interface.ICounter.md +++ /dev/null @@ -1,42 +0,0 @@ -# ICounter -[Git Source](https://github.com/Uniswap/foundry-template/blob/0864bd3fda3ae2b97362ae80691cd59ca9cf5090/src/interfaces/ICounter.sol) - - -## Functions -### number - - -```solidity -function number() external view returns (uint256); -``` -**Returns** - -|Name|Type|Description| -|----|----|-----------| -|``|`uint256`|The current number| - - -### setNumber - -Sets the number - - -```solidity -function setNumber(uint256 newNumber) external; -``` -**Parameters** - -|Name|Type|Description| -|----|----|-----------| -|`newNumber`|`uint256`|The new number| - - -### increment - -Increments the number by 1 - - -```solidity -function increment() external; -``` - diff --git a/docs/autogen/src/src/interfaces/README.md b/docs/autogen/src/src/interfaces/README.md deleted file mode 100644 index c06ad63..0000000 --- a/docs/autogen/src/src/interfaces/README.md +++ /dev/null @@ -1,4 +0,0 @@ - - -# Contents -- [ICounter](ICounter.sol/interface.ICounter.md)