From 047a4b0212ac2352837b8ecb180c9f7a5fa222ca Mon Sep 17 00:00:00 2001 From: Scott Winges Date: Mon, 6 May 2019 17:15:17 -0700 Subject: [PATCH] Updating Readme --- README.md | 15 ++++++++++----- assets/const_product_graph.png | Bin 0 -> 8216 bytes 2 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 assets/const_product_graph.png diff --git a/README.md b/README.md index 60edff9..9806ea3 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ -This repository is a subset of https://github.com/HydroProtocol/hydro-scaffold-dex. It is designed to start a market making bot on an existing Hydro Relayer. +This repository is a Liquidity Module for the Hydro SDK. + +Liquidity Modules allow relayers to instantly fill their orderbooks and bootstrap liquidity with minimal effort. This particular module uses a [Constant Product Market Making Model](https://github.com/HydroProtocol/amm-bots#const-product-amm), discussed in greater detail below. + +#### Using this repository + +This repository is a subset of https://github.com/HydroProtocol/hydro-scaffold-dex. It is designed to start a market making bot to provide liquidity on an existing Hydro Relayer. -The default setup is designed to work with our standard SDK scaffold, which launches onto your local server. This repository will not run on its own without making changes to the underlying structure. *** -# Amm-bots +# AMM Bots -Automated Market Making (AMM) bots can easily provide liquidity to a marketplace through use of algorithmic market making. The algorithm used in this repository is called a [Constant Product Market Making Model](https://github.com/HydroProtocol/amm-bots#const-product-amm), discussed in greater detail below. +Automated Market Making (AMM) bots provide liquidity to a marketplace through use of algorithmic market making. -## How to run? +## Running the AMM Bot This repository is setup to run naturally on the [Hydro Dex Scaffold](https://github.com/HydroProtocol/hydro-scaffold-dex). For use on other marketplaces, you could modify the code snippets below. diff --git a/assets/const_product_graph.png b/assets/const_product_graph.png new file mode 100644 index 0000000000000000000000000000000000000000..33ed7914832b77507a3e4c9a92437bdbb43048b8 GIT binary patch literal 8216 zcmYLOcUV(P)3;I-=^X?NgwT;LU3x+&(z}$&i40LYYV83zc(xqDvu%_{)OP2*n&vgni z(mx$Xbi}B6*7=BK6v2jOnaHm@8e#ydDIxOJ*56sz{KjW zkZl4%X*g^Bjkl=S>FKC=)WnlAJw`^s%CG=RLMT~n` z;igi5O4B=9B$x%^nG!vK`XF!Q=-Bs12rVJ=xdt#B44FEM@?2e)>j5wcZ$mt{FDMtJ zaa|Ig0vbcIYepQK^IR%nC-Gsd+BVyt7)L85ZCJQe>EmXq!z zO#mjTM>c2#7W`SvxahB8PA+liq3S4@h_M9Rl;vO1uzr9G$tc&c|B2e!U97>$r3mf& zKhcnXMXkI@TD$MViZ_dL|M5Ub7^P-fI{)$$?U|T`XUm|%n<-gI%d$d;H~l5DzSc&-q^Yt1}C&@|XJ0LzaS=cLh)X=c4aa4|7I`^*@q)S6Nv@a*>e!3l|By6k!(x z7RUtLxQe~-PMLEa`t}Uf#j^U0A&Sjxq&aIz!Xn0l4k_r%zGQzV!fN%A)C`DRaFD5X z=-|gvcY91zdjO{`DF0bj7*t4i3_A5Iq31$+MFtXQOGTpoGb_{#S1m?H(ukFu|JOMy zkg37X4hYP(G$3ak!#7&ew(BD4P3W4N8WGqQ7GZJd)Ch@B+S?WDzaAgpglPO#>BNkA z*2wzTT5nPyRM2NCG>`M(BO%j`UoMvQHn&Z{BNyIvvFHKR`v!RD1=Z^CcmG>E8sz4;W(YM0jDSn@Xo8H(?AK{o zN+g1hoR*CsNzMO`p(2^j?;7$*2lCb~;;$X?42MqtYUV|$Ec|N+4JnKyBwC&j_}cIQ z>7H&OV?ZE$70SkdZ5g-2$!L;=>fn?hED+D}*duAN(2hG4tBTcEmiJ20hRu1b44_Rb z?=lkKmo5a=gXXmW5M_&O6-}O6l@3HZEVA0fhn{hxN)cYiK z9B`2GFrj3c$8`@Vnz_#%bNz!k&I+}KlD5HVewe?5zZ&m%-vN>^4T8;~QUWW3Ex ziwUk=+E`g}(2LL$bCA%_2{fQXDo`3hG<|L6O8VNrqr`4imUn0UivP!ZXkja1`Y7i; zfVOo6I6JPMok@$!nB_!Zs1i=l;f!B28cdCc0jtIQ`1{w~r8XAG+zvsN-Sq1=i^{5> zUQZ(-lr?l zFe@-0osQDhZLYiCzov3hfsjC^j8Z{L`oDqdd6{v6-9ROs@gIcpMjP_I=2wWLNa3SH z`K>zOs#M#+F->rQ1iu(EzbDyxQFn9T!|Y@f!w4OHh#&b$hNh~iyH6V*DFQXv`nGL< zM$Nr^hcQ8JzVjpW+f00iLarT3`HJ;)>sV+nk4cuvJwrA=n5jnXx1w8sc03+p(=-cz zSomg>pH}4rUb(&6a($ITRrTqzBtXhgXhy8MUJ%yi;vr%p&nbrA_NDIW9;`zdq^w05 zWCcD!!r1#m+kkp4cY8GZu4%6+X!?oU@hOAwHRg<%4L-XyR|mb;K(wl78ahBYl>6n{ z%>vUd>@p(;1|$p)eq=Qfpfp45yLK5JU7fB)|(}K8OCVO#S zK?*~e5<7mT#YW8{UQnfKW=&m$JJ;5Vqu#NHXYcVifUabsQ4JT$5+{-6awQ;dCF2-K z*T{`BSH|-BQjg6fWRJR_&bxOsa>)-QH|D7qa|z&mKQ=2zQ~=kf_LzZ=@H{V~O?>uf zFlsJUDLhUhsI!s>vVw_s#t-=CPJfAGNgWl``=$3RPY_R)&Sv1AeTX`AdhuA{a-ej- zCw(v!jdYOcHb&zEzi@stB(Qu&G%Ykg=S98&nv5>((d zK)vil`#W?(tKqeEN6jkCmWNmBC{Me+g&YH{uXjvu<(G!>aHjWY+=kUIs=9MS%!9-B z!}V5ri)y)3xogB0AZ?wnWz?=$nNyS^t~MfVjlw>lPLiJ*y3P-or#Orh`m$SKsl^MN z1>je`r&Fl9nV(lv&-fVRb#=@d@=RxJcubg&gJd568x=Uj$X)ef~+wh9QAYpv z|NF%5SHYJux zUn?%=;~I0uEw2J>$e&2PjS>_5^KAHz@g|TU1KtfUM6Z6mw(n+K1S}NCYp*NHpL;-B zYPQvDVZ%$|aRiepdlhj!CFHgQF^7l$6^=rY*SP`GTu8JM#T(BZW$jY~Ms08_KW4r@ zR;A?6R2e=nHp>5W8pElWTptyU+ArcuU(I%&C8Ur)E6w*R-_n4O0OhgXU!pm=n~jTwz+>?Ih2*-SpKP$0o@Avjn= zvl+INF1i~n?9Op3Z0fV?NhRt;8R^qcn-|mhmR#LDxdW=ewz1^_u{eEY+W`n-A!y9H zE2Wgzfe7j_yq71mdA|i-xS>37W*~ofuuOR(bQH)Otth!0^cwAGyFpgGoa}kQ42D@`{Vf0H9wkkw)B3RSSq3?HVKmaqNqAnddYNjvwmc3AokuQ3Er2;D*q8lbZYS zLFBN)>kies;umFo*3Q)xULT7W8>?{j-?Ec_Td>RFjjgXR->CWTLL;MGug8*<3oU@o zCTtWv)n5o)^Rg-dX}T*Tsq+~&?^iC@0bN9l%?7>?=sucH9T#CtaPZ;3(!*QH>~8S> zDm?R;+<@A8ws4p}^9k*_KGaq+VuNQftvhtt?TT?zoh9XLDG5!8+u(Dg%(vW#;XP3`a->%Eqi{ zoBx>dQa;AzuG3?3&HfVl1FbfhBy7;$Y9k#D%^bRIh;K9OETG1 zJ?R-Zgo*C;zRXAcp6O-pGB^7}#ryjr3MDGYPSBcb$Ww6BXu8VlRWKf{S2B96R$|Jn{z6aC znG*ao$6sMYWb`prMF0*u}I_ouganFkF)#CXb+T{-H?*Lg=WUA z@(Js^GCqUlOk+N=VFQG>R2X5nxjmOi^QpoXnshEN+PF2m`H@vsts!+U zc{T9Ebf>D5Yvg^3CH=~zLKKXL&&8HDOplNv=?a`_gr}pVrnFCCvmn-q2j^ArVNQAH&`}}34TGzE&qGd$g1@d-SD} z11hQCa|*iqj{=flFHlo@W_$8-H_~A3qf$eQ432!Etgc&H`M9Np1- zZeXbnPX_Uic~CokH90AT9!4XZJR1WAo_jQ}BjT0P8I!OthBOaI@!$O?>;aB`X3-?2 zJ)F*WQgEMp6NP`3uSPR6M5+R^uCs8S)9_c=85|Xk2Su#InIxP`R)xVL6`)kg~!#G2@8iW z5L83i`+ENvaTNfWBvEuVnrKxRv@dszMbJ${Fm1#Sww)>6^%rC@Z`YpdED*ZaL4q(u zj4OCH!B;!djo!_!>!D>cn`RqtlWMb@-_n4x96$nU=rG)!JhER2>_P&6@|Y`Fpy9HT zhVEdd`Z!9eSfx+-E!Vvt#r+;~V?0ug4NJxV&AjDDG*^^G9m>@ejy73WN(UV)Ixf%> z>y%=Y*ymfVM!0iiL!2XpW^{Jh42wvSd`e6#^*~0!XY|km^bJurg&3CyvvjW%E%j!y zRoYc)eH4*B3G#S@uC^T@lqVN5e((Ojgp=U(ruanlr z&f1ZWAk)sw`-iU#@sZ{?BIwlwvsCG8frOGB5ryL3TFiUHbv=>0CcKS?Z-OVTLt#zm zmNl9_3p`7M!3YINc{;sQ?N%C)qZx{!#4#W6D3?7L{>en?v#8Gyu(4_)z^Zu1dKCm zt-r_V9O;Q-D+hYnNX_mI51poSr8+|V6*fcbx3%P%PLNv}zA)_uEYQU>Q~xI$C;N!L zOvF8z(o*3D+mlH+cXiIGY`{By@_^?gq|S^tdz4?{`L?(NWZC*#G#ve|Ci=-b$jP@4YHxg0!Nb#YyeG!eZZowbX)HhSxhm1lEVv;UQO$i_VdM)f)HxHpIf7p9;6pRhK%@3sc{W_g5?qtwnlo z&jjY{XxvWDOv=zNpRmV)z@5?ex@3yRsZLh^BAI0iFHzJ>K@^=ETsI$5pE@BW`GtaY zDpj<uk>mQyAu_>!STYletf^SGKZ8!~kUyT%-ynLyT+e&PrWrCGIrM?Rd}A$gN01XdDu5 zFRgn>Y6$GXEluPznnSaWy(}{3e}l6?n>ko;{XH+BUFWHarJ|x_TzC;$c_M_`97*xn zpKiNF_e8nq;|tb7r)$ED?_`x`4c$&vY~Qh%f6V5|>|YbIRxlA2TXM6yr<~`a0u2Q# zLvKIq^o-%fbG)T^$m8KJk=60my(WoAg$5>?@?5yX;dCSUD*9RYE;l9eX35BT zrbZa9gGmz-dL1jh?8x=5MQXZ*#{s{=<2pdYAL5Wt6xY|rKJ}o#Y2(=(uhsXnuEKbX zp}rJ^yk#sq^6py>XzLUem3D9-1+mEXEBZMh!v+tzwHlGtXdq~lob6zp9r)AFH9c}O ztcI%V^Sl<$?N5so;6rj$4Y1S8i z(?Vz#RTyE{7sqKS%-)3;keh0?CIJcl#RQ+LSoV+eogz1xT++Ou5Hl;9zqu=}r(=51<@3}8yLWaGeb_pYVgv7A> z8jZzvE$gtGzCXOQ(x%*^|RYmIPer<5HdPDLGMasp6u>S3zGYsNw^0fJey3yRd zhi@q?{FQGVxN7=3`wc0sA#U*o%i`uAE8pHO;41>)_2H)a8Pqiz<1^>4i)^X* znG11!r27m>5^xhTOseZh?~5OQZ;(j1zDwyCDB%2i(Q1#WXbw34Ckb+&n3ei}J}Kl$ zHw{|-Iuste{EpCKz_A)s@&aT}etNeWG0rNCPvZ#=7ju1{{DM{|i}l5edR}=>FrrFV zQfzlGkKKWX?&dolB`?F+&MFVJ7oHSOS}8m*AAj$8>vQ8j#;FO{JH4tHVI^ zX>wVTGuS;m?&V!jDWTt$P=Iw!Y$0C?L;4IibrGx(LQI3-OZxi)3F}}u9-9Hb@ zN0$`(yvorA6hx_+B{(XbVr%JUcZPkJa>$p*DzNj;86{>D@-jPWVSsVRb5b!(vqIi> zwZsD2EM1d5_hRR8rLnSw#dp3$Aa(P~w^s4q$l}zNu{`b{KHW-&jTzh;VpF?I+qwh$ z2@$Kd@gCS4cH&GJlRu9udIvHC$$F`Dc&1n&C0XKj7Ai=EoQaufaw731=lt>>s`&XR z-PQ+8m z(*4unG(OD@{~4M-X@@ITd zqsiKLrksB}8eW(vlbPzCU-3(g%W3h+;K$v$*w^+<(=?wXhL#)!WAJtFL2-RfSH@Oh z;!&9d2-|y;l{@cc@GmNGs)rPh`#TDka#iv&ExdFYyB?o8jFb7)k`pWw1cKW(=!#_` zwhX)vk2@tWOto+BA4`MmECgLDg86y3ZmRfN4Ovj?2TXXYWBYXF4%lv~Q=7jJ8t**}O!F@NnrOPu%O=s!aidzls z$#-C)n%Iq^#QMx;-G17tm`>rQp6ygykp6hR+)=oS`S-C}g}vJ$Wt{mY=}qobGhIaI zA5PZ@VaHo9bP$mbm@%P^^f~KJ>`>2iqAe~&Vm4=Fcr=CJ7`I_KAGh{&ORGa0%k9we zBjWf&hk8l>a+t01w-SkLq6c(-cvh=gmF#F~)?xb8S)D6mHL4{iv@MK^3!!bB{e$co zrAW37w1%Btcz2|AIH&rp{EQayf!zA3kHWk{(xa zthERQs+g?)f|Lwsp9pacQy|x*LW>ihT)w?U>9#~al)103;AL^Q_I-Xt*aCwz;p|fO zx8wmOj9*LRSOwyM8TT>uU@~yPfRa6|J$s;m-S}UEXc=f$ It2@O0A6cT~%K!iX literal 0 HcmV?d00001