From 776628ae9ef18ba683fd9f6604b7dc08b3c2bef2 Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Thu, 28 Apr 2022 10:22:09 -0700 Subject: [PATCH] Editing readme --- README.md | 16 ++++++++++------ diagrams/bch-api-dependency-graph.dia | Bin 0 -> 1433 bytes diagrams/bch-api-dependency-graph.png | Bin 0 -> 13529 bytes 3 files changed, 10 insertions(+), 6 deletions(-) create mode 100644 diagrams/bch-api-dependency-graph.dia create mode 100644 diagrams/bch-api-dependency-graph.png diff --git a/README.md b/README.md index 7fe0f8e..31764e7 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,21 @@ This is a REST API server, written in node.js JavaScript, using the [Express.js] While developers are encouraged to run and manage their own infrastructure, cloud-based infrastructure is available via [FullStack.cash](https://fullstack.cash). Free and paid tiers are available. You can use this REST API right away with the [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js) JavaScript library. -This repository is intended to be paired with [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js), an npm JavaScript library for building Bitcoin Cash apps. +This repository is intended to be paired with [bch-js](https://github.com/Permissionless-Software-Foundation/bch-js), an npm JavaScript library for building Bitcoin Cash apps. [Code examples](https://github.com/Permissionless-Software-Foundation/bch-js-examples) for common use-cases are available. And the [minimal-slp-wallet](https://www.npmjs.com/package/minimal-slp-wallet) is a front end JavaScript library that incorporates bch-js and provides basic wallet functionality. -![Cash Stack Network Diagram](./generic-network-diagram.png) +![bch-api dependency diagram](./diagrams/bch-api-dependency-graph.png) -Both bch-api and bch-js are part of the 'Cash Stack' [full stack of BCH software](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer). +Both bch-api and bch-js are part of the [Cash Stack](https://cashstack.info). -- [API Documentation](https://fullstack.cash/documentation) -- [Example Code](https://fullstack.cash/examples) +- [CashStack](https://cashstack.info) high-level documentation. +- [bch-api REST API reference](https://api.fullstack.cash/docs/) +- [bch-js JavaScript API reference](https://bchjs.fullstack.cash/) +- [bch-js example code](https://github.com/Permissionless-Software-Foundation/bch-js-examples) +- [Additional documentation on FullStack.cash](https://fullstack.cash/documentation) +- [Additional examples on FullStack.cash](https://fullstack.cash/examples) Have questions? Need help? Join our community support: -[Telegram channel](https://t.me/bch_js_toolkit) +- [Telegram channel](https://t.me/bch_js_toolkit) ## Features The following features set this repository apart from rest.bitcoin.com: diff --git a/diagrams/bch-api-dependency-graph.dia b/diagrams/bch-api-dependency-graph.dia new file mode 100644 index 0000000000000000000000000000000000000000..cb131ae4eae14233c8cc16f22b3140ef3beecc4a GIT binary patch literal 1433 zcmV;K1!npmiwFP!000021MQnzZ=*OA$KU%Y5PeMu=90j4($S7I)y}Hg9c{bMkpnLA z)G^37N%JzFeGQ={+>!}5?RG$FqY!hBZG8T}a~$&V)61GjTf{=_)42>3RhAHSd>2!1 zF8}j*H@4(Yw^tus3_plJkHNJhuApJ`ZZ5Al4?avLyWLJ9`w()UDFknn5KVqSLf}L+ zn#i|Tl5}jqg&aoblCzL=hL;@j~sUHQ-|Y3KOFXVMmuxqSVU9P%VF zG|5;xVLgBzS~3KmtBtGTund( z>qEDalc~M3&Q?0&YsfrIi@wARk;8OoimBVtF$I>XtJ+L|otMkqE&Fvx`gOoM$} z4&F?Q3M=kjyke)*Te8D0UoBobx+Mqe`;M${afp`$mGvG|-kSM+JLdB%Am&7RdBYWV zuvQ5o*Fq*T>ww7HU>AjF7IU^ug{4)}Y;tbi^X(c=jf=y8!2RhVj{N0!4}u|A0C~8VmRB^cSpuBPcNs6x$q4#lIU} zRaA2XL?vO?bBG99FC3rIVxHW}fMWYG%*dsV446C4!==9?vPB#_@L0Mo??GXimEJ5% z%^pTGr&*CHjmzoCQf9Vs9Q}1XWmBUQmAa~?2~s^*A~o>n8kOHrL^tb_tnn1z%5YPa z`b<(7)TaYzfevctbQniqNbq2EPX~3N!$5~pI^3~Hq`y%2s)Q43Oz|3$aY%yk4ibX+ zz>FT40Tg{;MxV^kT3`k+JBJ1^j%o_Kdujl4z{Y@$Qf&PF<>68K?c3M5lz;&qxX=d| zrcp5g1}^l)1-&U3fI8B&4!K}QScu_p1FQ%O+O%UVG#Jr2}|Tz{o5da3+c zexO2YQ~<_EGZZjTp+_nhO{t(8-BLl9t#im-=s(X8PNd@eStx@ z1~Bvu2D622B+c%88%eX$Z6tw;&bN{34ru_xuTU=#=}+H90}y)HKhnVfgcgDDAf(lW z%oRMi#}t(SVcHl7(-G(t2&OXCEo}s1B#0_Op8}CM)cqWB81^O3|F@Kjgoi4??HPDgq1wqt1g}mCre(dB7R%`nZx4x@6dNbYK z45cpGnxFJ3&ai;g*H5IC(2;~h+>gJGl+sVdg4GLgQgSg!E;h3lYsH6Sm3% z%ABPR}Zqb&1;L zrLr%%v)b4L?o#fwoZRWX%3W@BC30sCayQ7`FDZ9MRAL111xW4{)c352#xttk@uDL*Q1CHMRbg5X2b?n6FFD6G8HGgCO1;QViCvv zJd+8fmU+{Rg3>R@yF~~63T9KEK2Ls~^87kY=XwOmt!Cw!F|!j+R79G?FWh}>^s(Vf z(yEMJMOKrE8Uo>eoMY|?g8xHS)+$5yoYwWaxYd`5aIe@iwk96j=sRN}>(V$Mty7eU zbHOM7?JxS=oSgC{ucD)op;BQH5nb)=E;A($G-Q0Y%Og=ca~Vmio;!Se{JKjRZL~qYrbbDL{)LeH1_rX`ZBfa|$rBAhe(P9w{k2WR)nE$iL;D9O zC+CF=7wDyz{8cifoF^NfP*VGDFSl?iM{5NUMoMg3Ua%>?V2zdWBBscPGRQxk3KtKg zJxgpp>lhUsJu@>SxfjCcp3c)YKU{SF{Q2yxELqZg(HedbMP#OsxElO~|4n4%Deu1e z0P557+T~8hwZ1zH@^Hn?UDD!Ut}YWZGczM2@q2bYoNKJy`39-(&@sk?hYno`5q6pR zLP=^YYSo?m<;xu=4l#f9<}FpkH-p~3z8HS} zEEzglS`7wHX=y#uRIG^Qs;AGbThECtKivrI9~{)w)U<7Q8W2!I@b&c_%r_K|>yVYT z_ud<+c^JXIx0r>;u)~zdh57C(d19g;!CM+zh7@M-Q@lY-5 z^XJdmn)wgmeCg6|-=p&L^Gn_#hlvBRgEn_>-n@DD?%f+V0^r>g9t{nRPHzT83=V5u zr{CDr#L2}ayFTionQtKDzAy@7eupb^3LW_D*_)`SVxpb8x_UJ&{w$V{CA?WJRUua& z1y>6U40OYzv29NfR!mAX<*&B4w`~XWXxXJb`hQb9ulV9iYpb)g@9;-+KN4nqYjth~ z7eHU?EhZ&}>1s}t@nW6-J{2Ly&&zw~)~&a)K3iX6MI7e@5ye3^g<5H|i1OD&3jx2v z>eGgX9vtXK1maf8zkcyQ55w0UBj7$k7r`zgY1$ly!x{Pc`K9)h+YJlP$|2{63gg5b zk0Xe+W7(C+Cm`TQ9JZvUVa6>ka&U0e8r2^lWWIa%jyuU)_~OMZ zSY2@2J-$KaMJT3xgKAHhRwG0vLvLqTSVxW=xqbU~Q&ZE3%1D)|vohMp<^`LSn8T<< zK)s;vwg=uJ?ry`vd(pFEmYwm9jW_Y?Bq9NiMU@d_DZ1kiE%E2=gv!85iZS%n_NubS zltyx^!pxp(;qaRuul4iw-Q8T7b(7S;eLGmpXyVhe%*@PO+EOiEm@$Qgg{`fvj~_oa zH#aX8xa{`5p9D_`g9V=j(R1Ye_FI7#FYFx+LG<}~dFbXa7Ll0-db$46abFSv=Ke=5 z-inHf04mz7{QSY@(Z{n1x@8XbD_S`@q<-Yt)2H3Oetu=>x8pXDrGdtZ#RXz-*ow_h zHig1kAV05qgxs!&j*bpVb}bjzcxbWV9kUZU{)!6~J$p{p_ute~?{KLb8ynxc^|{!( z?~#kkX?bfatD#bRT^k!4+kn&Zb3LgoW#hh5zS|oE*_thljWleM4@j{Kt&!Z&v`x*m9mR%0R zALTK5eRJ$St35D0e#=cvD>EG~(&brMHgmn{L3C_c+1V(MWs`>wADWt)UcY|*&YdsS z>tm$GQ>t)L9p324NfVStX^C+|AnZ7AJ7zQu9yfJ$2|z8xjO9r&ma!JV15UL>#C6Q% zTt)(RyR z&8=Iv1es~LB5xl{q-0@XiI5>`jo0|d?QO3lNV#uqZP{QjZY`6r{w*k>NI>V8Mwei7 z-vo5sQ09u9gDNUw@#XN5BhKCuSKXU;f+y_ty!J*mHa1|P%B_46;UA96W)5$jpP$z* zvbe39Mr%=YMOgU9&iZ(gnEktKVk>;b$2*N1QJzU&T`<*QHR;*(8!uL^yr?&ND{LOJ zdJ|Cw+ZgE%SD*N}_ezW0uJdTQbFa(tEuXE`BZm(UeKc?9Gq_3RAv2Z`ST=!GUThv@ z8VmBvKJX6!hHY?$HXxxQwLsb6HxYwkeS!X&P|0#<;qDG+!sTw~*x1fMA1Ol)R z5^h@57JcWfU_A`eg$tP}DL+d|q5SrCfBNaCD_5?djZ4L83`%SU(r!mClux}VG;Lu# zeOmM^?yIaWYAv4rE3&%>406I)tUXV)~ER~)Vc{Yrtnc3F`EGl2G;v;-gyStW; zDRXp}ZuQ$Ejr(mhaMW!7Xos;}K71|SKU%q^kn*AL$Up_1N z_{Ue6!Gvg~XV0F&qTbtRkt=S2&DmiwXQng3YhkqFMi5FU+1j~+eJ(;HQl+v$H)wH8<}V%aI}guB{8 zoWr4Ok((PEmqkU{Bwc?iEkzp%hOx_x)Hmv&BAuO_mY$zDPn;iC*U(7EW~+JW+Xg2j z4P>fkkoy4^8kAN!x!OUPRz+R1DDTaWQ>lo`D@rs&mem6ea9J&_w`)xDhYlVbs+PIo z*`wETEkluRZx;#o$!VoAMVEW$1%vW2%CMT=I~xZ>pH^Yb8>Ur+74UjjJ1{z zt1!q{%qDt~dr_cv`-gb#W;k)fZ*ScXz})NCuj6CiXjofkW@SNLgkFOK#^y3JO`(jx&VZ zIb??ts^^i8&O4;v^f4y>ud}nZs#j`Yy(GY9tzV2s*S^CK=GQKLItFFIheY(5O>qCQ zvXbj4p<6;eGX(_&Y&me>07V}#nE&|N3Nw7O!_l|ziMBnqQdC;n8y?}wlPA#1Ykgs$ zRBHd^&eVrJ&Mq7`YFA${o0qPsS(42Ora-*BNq%WW^(~22dCg%rwmy*xxTp|UPjdb{ zUS3D69`sjvk8NT^jB?nTAP~P~GKR`~(jg>Obaz(5X*~GPC|3!($ zgPl6tfU(iP<^Au-*I)4?ib!to^B)beEG`*AgP^}aV}I(Rya4Uvl!>8aetCO3sdq_u zd#q)_{}fZzk^SB$&w>B#RP-Op!@vCR3)pRW4Qoc9NlAOIegohLBna>hkWQ#P@q17M zTO7u!hL_($*{iCOMyU?VFk*bpgf~BZdSG^zvW^p|teeAVxe$QTrKP2ml$7t^zgJaN z0j-kQEQEq6BC?W)T6jc=8bPTR4bOivMldMRNCtaU0q#er6dZ#;}tKW-Q&lbu+2#s)gk=+_TWZ<3Rgj-v_eS7svDM$*=}if7HvDFQcL!=;`GU%$6sc z6eHO6t2~@tU5i`I9?c{J9A=e5+Cc@T3NVJ{`yXJ~t~34$EM#;Bk$@RQxjPa>D3h-o z!|Cghn7k$%gJFOCNc6yz+HnWwd`8D1tEZ-BT&OiUIT=XLVF0BvoCTmr5Qpz? z_O*ax1@tS;3bg<)Qq!J!U}%^hUa`_CRpx*lnJLuLUe6?mUA*}H^Q-fnO1W9<$SItkeBi{M}uC}KnrER@ZK zv1+fW=I|3IPRMw!G7Fj9^zbMzO?q~Wi3l6&v>BA%;|vUGJZ)8vSKwJ|cDHO}SWN+L z7Z^9VN@9OZx8w2nTvSQIJ`2fFO_GJ$f%96d&frnf*T*Vy_^fVBMWD&WYdQ?e81u3Yd7S-L|os*LjKuvE@>3RVu z1=Mz+2I=YPySuySt&xu?HMOXM0zpj6>C>nAuQY%AW<|Kxl_*0^$7+SmC0y2#Dz<0< zq$utQ)7-XDm_|9hK2%WB^^W?9@IytSnCe z5q!F(Rv0%)Y-)sTrRUmrK+z_^tzJ-TYH0B3SFU!yzX5C;M4~TkZ8mmxAO$=R4z2)F zmEFehcMZ?=|m-06@H`CM7tS}9qJ{4zI&jZ!VD(iVv z2N)xQL(V}guIS@O5U+Ak_A4t!nx39pNxQ2Vemi)>+P$4cHV!&+olT}4krWUULr%B7 z0cH(HD3d_q6_*cgb=#XOwHuS6us4A~WUH%lc7Acu513yNyC=^tzx=|*WdYp+1n-ceYoo~AgfPWJ2d(PiZ4QZ z4WC~NP_?YQ{H=1h$@0gp86}&9-LZ9CrbFzBntc;>pjR2@@YM zhHj}{MN{Z!M1ITPf`cVT4XEO3d|L|d{<9H3M;=6HTAi?NR=j)a&fWC42 z&KWoyuCngqTI0gJx)DgT3EJ0~CqB2Jpy2D*uYTK8 z90}g6h%Bkd>gg5?M(>mH>IVx|nGIZkq0gFzo7);l8oukO@nzdAgg8)@{ibZ? zUe3xb5gdDZJ``XbwV3L*I{E2~!> zfymfLtgn9;4wI*f2js>-`_G!({T)W_W2yiD@)ykbztj;PCjq@`RIdpkMyWZeq=Uid z&~eOlLy6J&D=xiCMEKKv3>OMDs&gsiqLRK7ht~%%YWW9RopmnwPDZP&f1uT0P_~B9 zfcp=$nqgCVzyccZ{Lw%VFZuS65Uzqp2!VM0VD|#8K*OTXJe`DdecbPy#NFTD-K67d zu16Ood8$II{igpdFWu=N5IunI5fv140@!BgyJ_B@k@JE>E{~@ToDa({Z%?qYLh*3C zd?toZ_aR`V5f_Yo*|1Mfx^hfb)|TAfid=5TS5Q;OiYz1CNB}>i2&WLqK&4$vVhlVp zp~6&Ec>}#GvgoMvSWa2X{PN|C&RGy!|6Hzy`fASR(j~Jly|dakG6jlknRi8VbMxrv zD2QP8qvbsdcT|#O6QZIngB%F=o9+_9>MsNOw+-CR#s*j%G9WEMK?ZDEBAebfw<-n> z(w~E1o)8nZz9LIiyy7N_1lM7cLiP^~z(t&AI}@N+_$+%fRFh_t{A%*@RCJ$Gelv+; zJ{}npGdndUV)pqswdtpZ29WeX7A*&82TG(nP6GsO*!<`_--%xO`DYWTWXKjfY^6p< zUsGeFtI;09;RGjD<%r?#j~D<-)dscRn?K;Y&w_$Cl4Fp2~8311u~aans)D=Vvq577V)018LFdL;xk9x55Pp)DX! zC}XF%RUYgMyx`&2-6D_$5k2wdjB5)OsGiS2whk?_mtIDi_^sa}m748r$AckkPLt`QN0#)?;6!mYR#a}_j{!dq5_gL}r@O%ra?>r0T ze5NB#zeX3KGU;wdfz`LLu<-V-TIKa$2o)7N2Pn!E#zTae2IhePKR;RwFu*@?w$h#c zOm!Hr)%A4_U~#tVPd>M{28V_o16%FI3tvLXU=9Z8XsAGqgmrHkV6wEdU+}iMzq>OD zkDnu0fd>@Oo)xPC-DhXNHF_2gRywp9RM7m3W7zJ}S zJ4@20pC_{QftHq)k4^p4Lx8$MQoh8A=VxZNZjtgR4yV8q{SEoh0)C*Q^L=q~{72sN zkQA^Ht?0o@25?bAV$Tw{R{ayBqrle#L_oq+NJxl^BoCr96;Ao_qcGtbkWf&^;T#Vh z^q1HU!m3EvTaZ-6gkMJnOChQ{0lgunWJQsH)q z7H_W$Li&D@d0BtiYcbkk&9X`F1Fncg70S*@wnecM7Ri**@`Z%9p}W@W$_7?e+ylzu zz$AF9n?45DcbM$Bi-GR7PIJ4c={K*M#|x!NGIc&nF5m{C9g%9(`2I&XwcBtnBjgO=}) zIngqW9_I|y#clDrvcNS_?;BsX+-KI0U~T|a_VD?Jm)FB4xOjwqd1d_h=VmABC}!bu z*<%iHk#jFj-argm*5|@0%r<$pJMiqI+#YbdiM))V#2Bzh);HT*H!Gx!?uPNp2TpWq zvE2AIV(o;bg5$L8EQ2u3`fTDQ)AiURddj5s=6B5cPw+*!Yw#rcVJB1j;7O$E2A$qt zg0ba~{}nvz;3MJYv`Vj(MynSzlnGDX2q6j3cXu=9m!B~G-S;LJ(uc*RS*XlP7)?h;b2lK8^T|r^oHB|1muf5v=Yqn#Z*~zc z)xj%=3$n7jHIb(hNDHn?N+CAq`S?2Oalh-&73#Bn@1mljrrTqr>Ua7mNH({R8(Yl(Tg}=D68>T{BNDwqjm2d?vv?qjR-PhFJ3}K zq=@(dJlH-BlxSQ>-pCu>6LS0}G_FthcNI{e=>kY;XlQ^y0J!0RWCLkfdS?`?S9_Ji z!@~h&t0*bG1Mv@(;1v7Cf$W&I9N)hs0q#GX%g@Ke7fV$)N+ziIMeYZHz&#>cLy0m@ zIDf2P7D%iA1djem&~~&X37rWC5E(0I{4^=a5cm&3QX~=yQI#9luY=t<5?|0`rT35S ztu>~-y*=YjEaV+7dv7c)){r_SciY}v0yqN>7R`|(j{zEIXJz77H= zz#}jtxagLF1=T_qR=-(YJJ;TW2(2rdY_nNLNitrgRaM)=mPu@aM*g+6e%{{OPY)d% z*@kG7kGD5DZUpk%;J^TzobTvX)LIU3ELHsNUBIf4JAgP=cvzVC_sk4{t7y9*QBhGS z{aleixq22_?^*BAjK0&AGX<@ANs?|Cxw&Tn;-Z)NsLSx>dY^yn;omVG>b}q9EfN?M)Y9Ax zyvhk&0hk^Ri$RWmuqX+3VjU&@H`hu4y{r;WI0yjgeKZRu6anD+T?Yl3STZ56B=UW4 z8_UoWUFpAef_HDJ?*w0h5tt4Dm3AB?Vd^xQ%#GLX0V&9)C41Wk4jd?Mff&=~QUg6C zOc>h%0a|#4hK7;=tP0>cbTO*nNXI$WWXgaFTvTrap^@HQ378by+uo=Z@6G9$T#g#& zDFp&KI|zOOFJt@iR0~KDKz~bjz{>45SO8v?m6a&xXMpkD{9&%4VQXUp&3e<7$)*5k zZ%epqgkdz5xDL&zEmBfO#s@+yBU9bo_bg@8ii`Wl$K|A@tESbF z;*!ja$B!RpWJISb(&IU7ZEZ2zOW>;$o+KrW1GMh2SOF*u^I$MTmBXF{1U45+jVQ>> zTZL2s?^9Af842?06!UO%Tf$5SKLjZ~v^iA?>^!RrB^}>qY6Ziap2$d|TUk`SLg+0+h;3*d8Fqr9vY2=Ds=Ao9N~= z^I$&ViH|pHdK;&uoxIw+gkm;&B;huyPni|ck}NFNDEa(BIBX+w9Z?t<^-3f`$J~6{ zpMvt8j5#UhW5-VUz5j?H5>pp|65ErKuLV5N*x8&-D#;JmP*;y^HG2m)1De5ZD|ga1 zv8>ijP-{Z+0zw~7E};F<4BRz{oFVm0>^Y~tIzYA)_^}Q+RBp?#Ljn^(E961A3=%|O zSn=@iEUmA*I|;i66B7$hdvV*hM7k1g>*8h`$*GJAmy8r12y?+4u)T7Qi)#kxgU@6z zH&7BjMrDv#U_nq5r>=vi2Wdt~ooFzmzkgr9^=RZlUvFf&37Td{Fr;@xDD!|7|lyY}~=i`cO z-SSP#&tC-bdL06?z#9k9Xe6<vA@3?|AgzcS z)%pMW>%o9}BjMQjn)LZEzIxyOF=CmE0k7^1JG(3d;=t%^Y-|L!&j|Box%n*ETd&~C zIod_!JeDH+S-w#}le7KK(B(ML8v%#{nm%{~VKARn}3JOmIt#R+))hrQ4v z2!DsC|Nfx#zqF(O%OAA1Y~9k(sDF$==rn8&qd*HqTzwsp!b46voIxO@B;?$w{~EQ} z&s+Sz_M)1S1xJ}Il|LyN6kgbZl<>JF4ugRdONYryefPCeA&V3HaS#6>YnSTwr_4*d ze=!V}r0E`3^FF7DfY{`I93{fcoj`7I^N$7(Iv&Q5}J$;O6%@wVx-Mq&vQ(k`r5Xdhv1HzcbGA?+L~Hi?dV$j{67bISnbL(K5#* zH)Sm?EyycJu59in`K$Z-sJk!xU6S9?CkS*AuiedAM;|#v+C7tG=+|=BxfFb-@bl(aCA!s%h z7HtiUH9&2-hP7jozTkla&XIzx418)@svF=uX|f;M_h*$MU43xe6^ePxya*p(E`0l} zm|cMb;Iw~{(@*`gEWZ8re-d0%{y<$PMAkg8%HR?Mf+%T$#1;Q=Mnr@vz*-%h5eNzt z^MP^(IxFN8M>v9LSnflJRA1lc?-Tj=2-p4yq@jJz&;*8r91W<)y=FP!!C`6fLLE&ACeL;>DD$lC@vu(@$=6q zU^u>ie~om)O+(|2nD2iC($bi|c~(i$9wzIc(1WMtp>7+NIp_ziuYf8DUTEIF4_{th z4qH4#=@#Jp(ABzyCeK>UzW1aC^;ofr+VsP3Q|u?E3u^R!Pu9joM?=^*lcx?|OH3Hu|1S0Gzv7UAo%YY7+1wsNbUDxNKwx_){QeK( Nw!F&Cyz53!{|ANHM}`0Z literal 0 HcmV?d00001