uniswap 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b64f10df9f1cb893dbf1e22e0c7fbbbc1a3b077c5f362d2c385ec46e321f16
-  data.tar.gz: edb9d0db8f5edd36a5ac62ff456483f6dad7e480ee7a911377bf48c9d83c12da
+  metadata.gz: e7d8b1c3465c77d203dd9115bc85450186737da44459e465a822e275f48eb763
+  data.tar.gz: df43be0573452e9a5494fb4b4bec31c3a2d3df87d47fd2d1126d0d2f68a211f2
 SHA512:
-  metadata.gz: 7264444379e503aa697de99c6fbd16d39fbcce95411d91a7a4ca053dd761886dc2fcddf9c2efa9fe4678b585dc248b4f0d54dd8eb8910d2fa4b62a46bc257560
-  data.tar.gz: 6b0f03feb962ad4881c5393239ab7b41f55715e7afe2160e2fcb7c38719b58d6aae903d1c821de8bb2cb3c2135bf4a474ff2c883f7aad4e1f3d3e9ca3602a7e3
+  metadata.gz: 543cba8830a88c50fbc13b12a9ca836716f24aa16ab4a5388225faa35a235e44689e36ab0fad8184a8b85ce9c14e360c1c17e0443f24e7d6243d437e4d602b1e
+  data.tar.gz: 36d2dfc428ca42558eb60c7664abe94c81265eaa4f977f75f40ea66fd2d00bc36b7e20dd8f8326cb02ad607ca22b22bb3090550692ecbb0e40eb5d01f2f66826

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+### 0.1.0
 ### 0.0.1 / 2023-11-04
 
 * Everything is new. First release

data/README.md

@@ -35,8 +35,10 @@ See the [**Facetswap App / Service**](https://facetswap.com)
 Available contracts include:
 
 - [ERC20](lib/uniswap/ERC20.rb)
+- [PublicMintERC20 (is ERC20)](lib/uniswap/PublicMintERC20.rb)
 - [UniswapV2ERC20 (is ERC20)](lib/uniswap/UniswapV2ERC20.rb)
 - [UniswapV2Pair (is UniswapV2ERC20)](lib/uniswap/UniswapV2Pair.rb)
+- [UniswapV2Factory](lib/uniswap/UniswapV2Factory.rb)
 - ...
 
 And so on.  To be continued ...

data/Rakefile

@@ -3,7 +3,7 @@ require 'hoe'
 
 
 Hoe.spec 'uniswap' do
-  self.version = '0.0.1'   # Rubidity::Module::Uniswap::VERSION
+  self.version = '0.1.0'   # Rubidity::Module::Uniswap::VERSION
 
   self.summary = 'uniswap - core uniswap v2 (dumb) contracts for ruby (rubidity) for layer 1 (l1) with "off-chain" indexer'
   self.description = summary

data/lib/uniswap/PublicMintERC20.rb

@@ -1,39 +1,37 @@
-pragma :rubidity, "1.0.0"
 
-import 'ERC20'
+class PublicMintERC20 < ERC20
 
-contract :PublicMintERC20, is: :ERC20 do
-  uint256 :public, :maxSupply
-  uint256 :public, :perMintLimit
+  storage maxSupply:    UInt,
+          perMintLimit: UInt
   
-  constructor(
-    name: :string,
-    symbol: :string,
-    maxSupply: :uint256,
-    perMintLimit: :uint256,
-    decimals: :uint8
-  ) do
-    super(name: name, symbol: symbol, decimals: decimals)
-    s.maxSupply = maxSupply
-    s.perMintLimit = perMintLimit
+  sig [String, String, UInt, UInt, UInt]
+  def constructor(
+    name:,
+    symbol:,
+    maxSupply:,
+    perMintLimit:,
+    decimals: 
+    )
+    super( name: name, symbol: symbol, decimals: decimals )
+    @maxSupply    = maxSupply
+    @perMintLimit = perMintLimit
   end
   
-  
-  function :mint, { amount: :uint256 }, :public do
-    require(amount > 0, 'Amount must be positive')
-    require(amount <= s.perMintLimit, 'Exceeded mint limit')
-    
-    require(s.totalSupply + amount <= s.maxSupply, 'Exceeded max supply')
+  sig [UInt]  
+  def mint( amount: )
+    assert amount > 0, 'Amount must be positive'
+    assert amount <= @perMintLimit, 'Exceeded mint limit'    
+    assert @totalSupply + amount <= @maxSupply, 'Exceeded max supply'
     
-    _mint(to: msg.sender, amount: amount)
+    _mint( to: msg.sender, amount: amount )
   end
   
-  function :airdrop, { to: :address, amount: :uint256 }, :public do
-    require(amount > 0, 'Amount must be positive')
-    require(amount <= s.perMintLimit, 'Exceeded mint limit')
-    
-    require(s.totalSupply + amount <= s.maxSupply, 'Exceeded max supply')
+  sig [Address, UInt]
+  def airdrop( to:, amount: )
+    assert amount > 0, 'Amount must be positive'
+    assert amount <= @perMintLimit, 'Exceeded mint limit'
+    assert @totalSupply + amount <= @maxSupply, 'Exceeded max supply'
     
-    _mint(to: to, amount: amount)
+    _mint( to: to, amount: amount )
   end
-end
+end  # class PublicMintERC20

data/lib/uniswap/UniswapV2Factory.rb

@@ -1,36 +1,39 @@
-pragma :rubidity, "1.0.0"
 
-import 'UniswapV2Pair'
+class UniswapV2Factory < Contract
 
+  event :PairCreated, token0:     Address, 
+                      token1:     Address, 
+                      pair:       Address, 
+                      pairLength: UInt
 
-contract :UniswapV2Factory do
-  address :public, :feeTo
-  address :public, :feeToSetter
+  storage feeTo:       Address,
+          feeToSetter: Address,
+          getPair:     mapping( Address, mapping( Address, Address)),
+          allPairs:    array( Address )
 
-  mapping ({ address: mapping({ address: :address })}), :public, :getPair
-  array :address, :public, :allPairs
-
-  event :PairCreated, { token0: :address, token1: :address, pair: :address, pairLength: :uint256 }
-
-  constructor(_feeToSetter: :address) do
-    s.feeToSetter = _feeToSetter
+  sig [Address]
+  def constructor( feeToSetter: ) 
+    @feeToSetter = feeToSetter
   end
 
-  function :allPairsLength, {}, :public, :view, returns: :uint256 do
-    return s.allPairs.length
+  sig [], :view, returns: UInt
+  def allPairsLength
+    @allPairs.length
   end
-  
-  function :getAllPairs, {}, :public, :view, returns: [:address] do
-    return s.allPairs
+
+  sig [], :view, returns: array(Address)
+  def getAllPairs
+    @allPairs
   end
 
-  function :createPair, { tokenA: :address, tokenB: :address }, :public, returns: :address do
-    require(tokenA != tokenB, 'Scribeswap: IDENTICAL_ADDRESSES')
+  sig [Address, Address], returns: Address
+  def createPair( tokenA:, tokenB: )
+    assert  tokenA != tokenB, 'Scribeswap: IDENTICAL_ADDRESSES'
     
-    token0, token1 = uint256( tokenA ) < uint256( tokenB ) ? [tokenA, tokenB] : [tokenB, tokenA]
+    token0, token1 = uint( tokenA ) < uint( tokenB ) ? [tokenA, tokenB] : [tokenB, tokenA]
     
-    require(token0 != address(0), "Scribeswap: ZERO_ADDRESS");
-    require(s.getPair[token0][token1] == address(0), "Scribeswap: PAIR_EXISTS");
+    assert token0 != address(0), "Scribeswap: ZERO_ADDRESS"
+    assert @getPair[token0][token1] == address(0), "Scribeswap: PAIR_EXISTS"
 
 =begin    
     salt = keccak256(abi.encodePacked(token0, token1))
@@ -52,30 +55,26 @@ contract :UniswapV2Factory do
     pair = UniswapV2Pair.construct
     pair.init( token0, token1 )
 
-    s.getPair[token0][token1] = pair.__address__
-    s.getPair[token1][token0] = pair.__address__
+    @getPair[token0][token1] = pair.__address__
+    @getPair[token1][token0] = pair.__address__
 
-    s.allPairs.push( pair.__address__ )
-    emit :PairCreated, token0: token0, token1: token1, pair: pair.__address__, pairLength: s.allPairs.length
+    @allPairs.push( pair.__address__ )
+    log PairCreated, token0: token0, token1: token1, pair: pair.__address__, pairLength: @allPairs.length
 
-    return pair.__address__
+    pair.__address__
   end
-
   
-
-  function :setFeeTo, { _feeTo: :address }, :public do
-    require(msg.sender == feeToSetter, "Scribeswap: FORBIDDEN")
+  sig [Address]
+  def setFeeTo( feeTo: )
+    assert msg.sender == @feeToSetter, "Scribeswap: FORBIDDEN"
     
-    s.feeTo = _feeTo
-    
-    return nil
+    @feeTo = feeTo
   end
 
-  function :setFeeToSetter, { _feeToSetter: :address }, :public do
-    require(msg.sender == feeToSetter, "Scribeswap: FORBIDDEN")
-    
-    s.feeToSetter = _feeToSetter
+  sig [Address]
+  def setFeeToSetter( feeToSetter: )
+    assert msg.sender == @feeToSetter, "Scribeswap: FORBIDDEN"
     
-    return nil
+    @feeToSetter = feeToSetter
   end
-end
+end   # class UniswapV2Factory

data/lib/uniswap/UniswapV2Pair.rb

@@ -50,8 +50,8 @@ class UniswapV2Pair < UniswapV2ERC20
   sig []
   def constructor
     super
-    @factory  = msg.sender
-    @unlocked = uint256( 1 )
+    @factory   = msg.sender
+    @_unlocked = uint( 1 )
   end
         
   # note: can't name method initialize because of ruby
@@ -77,109 +77,107 @@ class UniswapV2Pair < UniswapV2ERC20
     assert result, "ScribeSwap: TRANSFER_FAILED"
   end
   
-end  # class UniswapV2Pair
-
-__END__
 
-  
-  function :_update, {
-    balance0: :uint256,
-    balance1: :uint256,
-    _reserve0: :uint112,
-    _reserve1: :uint112
-  }, :private do
-    require(balance0 <= (2 ** 112 - 1) && balance1 <= (2 ** 112 - 1), 'ScribeSwap: OVERFLOW')
+  sig [UInt, UInt, UInt, UInt]
+  def _update(
+    balance0:,
+    balance1:,
+    reserve0:,
+    reserve1: )
+    assert balance0 <= (2 ** 112 - 1) && balance1 <= (2 ** 112 - 1), 'ScribeSwap: OVERFLOW'
     
     # blockTimestamp = uint32(block.timestamp % 2 ** 32)
-    blockTimestamp = block.timestamp 
-    timeElapsed = blockTimestamp - s.blockTimestampLast # overflow is desired
+    # overflow is desired  - why??
+    timeElapsed = block.timestamp - @_blockTimestampLast   
     
-    if timeElapsed > 0 && _reserve0 != 0 && _reserve1 != 0
+    if timeElapsed > 0 && reserve0 != 0 && reserve1 != 0
       # * never overflows, and + overflow is desired
-      s.price0CumulativeLast += uint256(uqdiv(encode(_reserve1), _reserve0)) * timeElapsed
-      s.price1CumulativeLast += uint256(uqdiv(encode(_reserve0), _reserve1)) * timeElapsed
+      #   up reserve1 from 112 to 224 bit (shift by 112bit)
+      #   up reserve2 from 112 to 224 bit (shift by 112bit)
+      @price0CumulativeLast +=  (reserve1*(2 ** 112)) / reserve0  * timeElapsed
+      @price1CumulativeLast +=  (reserve0*(2 ** 112)) / reserve1  * timeElapsed
     end
     
-    emit :PreSwapReserves, reserve0: s.reserve0, reserve1: s.reserve1
+    log PreSwapReserves, reserve0: @_reserve0, reserve1: @_reserve1
     
-    s.reserve0 = uint112(balance0)
-    s.reserve1 = uint112(balance1)
+    @_reserve0 = balance0   ## was uint112()
+    @_reserve1 = balance1
     
-    s.blockTimestampLast = blockTimestamp
-    emit :Sync, reserve0: s.reserve0, reserve1: s.reserve1
-  end
-  
-  function :encode, { y: :uint112 }, :internal, :pure, returns: :uint224 do
-    return uint224(y) * (2 ** 112)
-  end
-
-  function :uqdiv, { x: :uint224, y: :uint112 }, :internal, :pure, returns: :uint224 do
-    return x / uint224(y)
+    @_blockTimestampLast = block.timestamp
+    log Sync, reserve0: @_reserve0, reserve1: @_reserve1
   end
   
-  function :_mintFee, { _reserve0: :uint112, _reserve1: :uint112 }, :private, returns: :bool do
-    feeTo = UniswapV2Factory.at( s.factory ).feeTo
+ 
+  sig [UInt, UInt], returns: Bool  ## was uint112, uint112
+  def _mintFee( reserve0:, reserve1: )
+    feeTo = UniswapV2Factory.at( @factory ).feeTo
     feeOn = feeTo != address(0)
-    _kLast = s.kLast
+    kLast = @kLast
     
-
     if feeOn
-      if _kLast != 0
+      if kLast != 0
         ## note: sqrt NOT built-in - double check
-        rootK = Integer.sqrt(_reserve0 * _reserve1)
-        rootKLast = Integer.sqrt(_kLast)
+        rootK = Integer.sqrt( reserve0 * reserve1 )
+        rootKLast = Integer.sqrt( kLast )
         if rootK > rootKLast
-          numerator = totalSupply * (rootK - rootKLast)
+          numerator = @totalSupply * (rootK - rootKLast)
           denominator = rootK * 5 + rootKLast
           liquidity = numerator.div(denominator)
-          _mint(feeTo, liquidity)   if liquidity > 0
+          _mint( feeTo, liquidity )   if liquidity > 0
         end
       end
-    elsif _kLast != 0
-      s.kLast = 0
+    elsif kLast != 0
+      @kLast = 0
     end
     feeOn
   end
   
-  function :mint, { to: :address }, :public, returns: :uint256 do
-    require(s.unlocked == 1, 'ScribeSwap: LOCKED')
+  sig [Address], returns: UInt
+  def mint( to: )
+    assert @_unlocked == 1, 'ScribeSwap: LOCKED'
     
-    _reserve0, _reserve1, _ = getReserves
+    reserve0, reserve1, _ = getReserves
     
-    balance0 = ERC20.at(s.token0).balanceOf( __address__ ) ## address(this)
-    balance1 = ERC20.at(s.token1).balanceOf( __address__ ) ## address(this)
+    balance0 = ERC20.at( @token0 ).balanceOf( __address__ ) ## address(this)
+    balance1 = ERC20.at( @token1 ).balanceOf( __address__ ) ## address(this)
  
-    amount0 = balance0 - _reserve0
-    amount1 = balance1 - _reserve1
+    amount0 = balance0 - reserve0
+    amount1 = balance1 - reserve1
     
-    feeOn = _mintFee(_reserve0, _reserve1)
-    _totalSupply = s.totalSupply
+    feeOn = _mintFee( reserve0, reserve1)
+    totalSupply = @totalSupply
 
  
-
-    if _totalSupply == 0
+    if totalSupply == 0
       ## note: sqrt NOT built-in - double check
-      liquidity = uint256( Integer.sqrt(amount0 * amount1)) - s.MINIMUM_LIQUIDITY
-      _mint(address(0), s.MINIMUM_LIQUIDITY)
+      ##  move "upstream" into contract base (for all) - why? why not?
+      liquidity = uint( Integer.sqrt(amount0 * amount1)) - MINIMUM_LIQUIDITY
+      _mint( address(0), MINIMUM_LIQUIDITY )
     else
       liquidity = [
-        (amount0 * _totalSupply).div(_reserve0),
-        (amount1 * _totalSupply).div(_reserve1)
+        (amount0 * totalSupply).div(reserve0),
+        (amount1 * totalSupply).div(reserve1)
       ].min
     end
 
-    require(liquidity > 0, 'ScribeSwap: INSUFFICIENT_LIQUIDITY_MINTED')
-    _mint(to, liquidity)
+    assert liquidity > 0, 'ScribeSwap: INSUFFICIENT_LIQUIDITY_MINTED'
+    _mint( to, liquidity )
  
   
-    _update(balance0, balance1, _reserve0, _reserve1)
-    s.kLast = s.reserve0 * s.reserve1   if feeOn
+    _update( balance0, balance1, reserve0, reserve1 )
+    @kLast = @_reserve0 * @_reserve1    if feeOn
     
-    emit :Mint, sender: msg.sender, amount0: amount0, amount1: amount1
+    log Mint, sender: msg.sender, amount0: amount0, amount1: amount1
     
-    return liquidity
+    liquidity
   end
+end  # class UniswapV2Pair
+
+__END__
+
   
+
+
   function :burn, { to: :address }, :external, :lock, returns: { amount0: :uint256, amount1: :uint256 } do
     require(s.unlocked == 1, 'ScribeSwap: LOCKED')
 

data/lib/uniswap.rb

@@ -5,7 +5,10 @@ require 'rubidity'
 
 ## our own code
 require_relative 'uniswap/ERC20'
+require_relative 'uniswap/PublicMintERC20'
 require_relative 'uniswap/UniswapV2ERC20'
 require_relative 'uniswap/UniswapV2Pair'
+require_relative 'uniswap/UniswapV2Factory'
+
 
 puts "bye"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uniswap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer