Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

uniswapV2LibraryGetAmountsOut summary #50

Merged
merged 4 commits into from
Oct 3, 2024
Merged

uniswapV2LibraryGetAmountsOut summary #50

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7ef0a1
getAmountsOut summary.
mariaKt Sep 30, 2024
4dac6d7
Added comments.
mariaKt Oct 2, 2024
df1585d
Edited end of function summary. Number of expected restoreEnv (closin…
mariaKt Oct 3, 2024
ebd68ff
Added rule to skip unneeded enrironment updates.
mariaKt Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions src/uniswap-summaries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2678,6 +2678,89 @@ module SOLIDITY-UNISWAP-SORTTOKENS-SUMMARY
endmodule
```

```k
module SOLIDITY-UNISWAP-GETAMOUNTSOUT-SUMMARY
imports SOLIDITY-CONFIGURATION
imports SOLIDITY-UNISWAP-TOKENS
imports SOLIDITY-EXPRESSION
imports SOLIDITY-STATEMENT

// Call to GetAmountsOut to beginning of while loop
rule <k> uniswapV2LibraryGetAmountsOut:Id ( v ( V1:MInt{256} , uint256 ) , lv ( I2 , .List , address [ ]:TypeName ) , .TypedVals:CallArgumentList ) ~> K => SsFor ~> restoreEnv((amountIn |-> var(size(STORE), uint256)) (path |-> var(size(STORE) +Int 1, address [ ])) (amounts |-> var(size(STORE) +Int 3, uint256 [ ]))) ~> Ss ~> return amounts ; ~> .K </k>
<summarize> true </summarize>
<this-type> TYPE </this-type>
<contract-id> TYPE </contract-id>
<contract-fn-id> uniswapV2LibraryGetAmountsOut </contract-fn-id>
<contract-fn-body> require ( path . length >= 2 , "UniswapV2Library: INVALID_PATH" , .TypedVals ) ; amounts = new uint256 [ ] ( path . length , .TypedVals ) ; amounts [ 0 ] = amountIn ; { uint256 i ; SsFor:Statements } Ss:Statements </contract-fn-body>
<env> E => (amountIn |-> var(size(STORE), uint256))
(path |-> var(size(STORE) +Int 1, address [ ]))
(amounts |-> var(size(STORE) +Int 3, uint256 [ ]))
(i |-> var(size(STORE) +Int 4, uint256))
</env>
<store> ( _ [ I2 <- V2 ] ) #as STORE =>
STORE ListItem(V1) ListItem(V2) ListItem(default(uint256 [ ]))
ListItem((makeList(size({read(V2, .List, address [ ])}:>List), default(uint256))) [ 0 <- V1 ] )
ListItem(default(uint256))
</store>
<current-function> FUNC => uniswapV2LibraryGetAmountsOut </current-function>
<call-stack>... .List => ListItem(frame(K, E, FUNC)) </call-stack>
requires Int2MInt(size({read(V2, .List, address [ ])}:>List))::MInt{256} >=uMInt 2p256 [priority(40)]

// While loop rewrite and condition evaluation
rule <k> while (( i < path . length - 1 ) #as Cond) Body:Statement Ss:Statements => if (v(Vi <uMInt (Int2MInt(size({read(Vp, .List, address [ ])}:>List))::MInt{256} -MInt 1p256), bool)) {Body while(Cond) Body} else {.Statements} ~> Ss ...</k>
<summarize> true </summarize>
<env>... (i |-> var(Ii, uint256)) (path |-> var(Ip, address [ ])) ...</env>
<store> _ [ Ii <- Vi ] [ Ip <- Vp ] </store>
<current-function> uniswapV2LibraryGetAmountsOut </current-function> [priority(40)]

// While condition evaluated to true until call to uniswapV2LibraryGetReserves
rule <k> if ( v ( true , bool ) ) { { { uint256 [ ] memory reserves = uniswapV2LibraryGetReserves ( path [ i ] , path [ i + 1 ] , .TypedVals ) ; Ss'':Statements } Ss':Statements } Ss:Statements } else { .Statements } => uniswapV2LibraryGetReserves ( v ( read(Vp, ListItem(MInt2Unsigned(Vi)), address []) , address ) , v ( read(Vp, ListItem(MInt2Unsigned(Vi) +Int 1), address []) , address ) , .TypedVals ) ~> freezerVariableDeclarationStatementA ( uint256 [ ] memory reserves ) ~> Ss'' ~> restoreEnv(E) ~> Ss' ~> restoreEnv(E) ~> Ss ~> restoreEnv(E) ...</k>
<summarize> true </summarize>
<env> ( _ (i |-> var(Ii, uint256)) (path |-> var(Ip, address [])) ) #as E </env>
<store> _ [ Ii <- Vi:MInt{256} ] [ Ip <- Vp ] </store>
<current-function> uniswapV2LibraryGetAmountsOut </current-function> [priority(40)]

// uniswapV2LibraryGetReserves return until call to uniswapV2LibraryGetAmountOut
rule <k> v ( ListItem ( V1:MInt{256} ) ListItem ( V2:MInt{256} ) , uint256 [ ] ) ~> freezerVariableDeclarationStatementA ( uint256 [ ] memory reserves ) ~> amounts [ i + 1 ] = uniswapV2LibraryGetAmountOut ( amounts [ i ] , reserves [ 0 ] , reserves [ 1 ] , .TypedVals ) ; Ss:Statements => uniswapV2LibraryGetAmountOut ( v ( read(Va, ListItem(MInt2Unsigned(Vi)), uint256 []) , uint256 ) , v ( V1 , uint256 ) , v ( V2 , uint256 ) , .TypedVals ) ~> freezerAssignment ( amounts [ i + 1 ] ) ~> freezerExpressionStatement ( ) ~> Ss ...</k>
<summarize> true </summarize>
<env>
( _ (i |-> var(Ii, uint256)) (amounts |-> var(Ia, uint256 [])) ) #as E =>
E (reserves |-> var(size(STORE), uint256 [ ]))
</env>
<store> ( _ [ Ii <- Vi:MInt{256} ] [ Ia <- Va ]) #as STORE =>
STORE ListItem(ListItem(V1) ListItem(V2))
</store>
<current-function> uniswapV2LibraryGetAmountsOut </current-function> [priority(40)]

// uniswapV2LibraryGetAmountOut to end of while body
rule <k> v ( V , uint256 ) ~> freezerAssignment ( amounts [ i + 1 ] ) ~> freezerExpressionStatement ( ) ~> .Statements ~> restoreEnv ( ( _ (i |-> var ( Ii , uint256 )) ) #as ENV ) ~> i ++ ; .Statements ~> restoreEnv ( ENV ) => .K ...</k>
<summarize> true </summarize>
<env>
( _ (i |-> var(Ii, uint256)) (amounts |-> var(Ia, uint256 [])) ) => ENV
</env>
<store> ( _ [ Ii <- Vi:MInt{256} ] ) #as STORE =>
STORE [Ia <- write({STORE [ Ia ]}:>Value, ListItem(MInt2Unsigned(Vi) +Int 1), V, uint256[])] [ Ii <- Vi +MInt 1p256 ]
</store>
<current-function> uniswapV2LibraryGetAmountsOut </current-function> [priority(40)]

// Skip environment updates when not needed.
// These occur due to the multiple block statements, introduced by the if
// statement that the while rewrites to.
rule <k> restoreEnv( _:Map ) ~> .Statements ~> restoreEnv( E:Map ) => restoreEnv(E) ...</k>
<summarize> true </summarize>
<current-function> uniswapV2LibraryGetAmountsOut </current-function> [priority(40)]

// End of function: final environment restoration until return from getAmountsOut to caller
rule <k> restoreEnv ( _:Map (amounts |-> var(Ia, uint256 [])) ) ~> .Statements ~> return amounts ; ~> .K => v ( Va , uint256 [] ) ~> K </k>
<summarize> true </summarize>
<env> _ => E </env>
<store> _ [ Ia <- Va ] </store>
<current-function> uniswapV2LibraryGetAmountsOut => FUNC </current-function>
<call-stack>... ListItem(frame(K, E, FUNC)) => .List </call-stack> [priority(40)]

endmodule
```

```k
module SOLIDITY-UNISWAP-GETAMOUNTOUT-SUMMARY
imports SOLIDITY-CONFIGURATION
Expand Down Expand Up @@ -3257,6 +3340,7 @@ endmodule
module SOLIDITY-UNISWAP-SUMMARIES
imports SOLIDITY-UNISWAP-INIT-SUMMARY
imports SOLIDITY-UNISWAP-SORTTOKENS-SUMMARY
imports SOLIDITY-UNISWAP-GETAMOUNTSOUT-SUMMARY
imports SOLIDITY-UNISWAP-GETAMOUNTOUT-SUMMARY
imports SOLIDITY-UNISWAP-UNISWAPV2LIBRARYGETRESERVES-SUMMARY
imports SOLIDITY-UNISWAP-GETAMOUNTIN-SUMMARY
Expand Down