From 00416f4c40a4dc20ddee017c1123e71c1ba52a08 Mon Sep 17 00:00:00 2001 From: Hendrik Eeckhaut Date: Wed, 7 Jun 2023 15:42:49 +0200 Subject: [PATCH] Added README, License, Contribution information + added GitHub build action tlsnotary/tlsn#266 --- .github/workflows/rust.yml | 53 +++++++++++++++++++++++++++++++++++++ .gitignore | 5 ++++ CHANGELOG.md | 7 +++++ CONTRIBUTING.md | 36 +++++++++++++++++++++++++ README.md | 30 +++++++++++++++++++++ tlsn-banner.png | Bin 0 -> 20768 bytes 6 files changed, 131 insertions(+) create mode 100644 .github/workflows/rust.yml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 README.md create mode 100644 tlsn-banner.png diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..7165fb3 --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,53 @@ +name: Rust + +on: + push: + branches: [dev] + pull_request: + branches: [dev] + +env: + CARGO_TERM_COLOR: always + CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse + +jobs: + build_and_test: + if: ( ! github.event.pull_request.draft ) + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Stable + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: stable + - uses: Swatinem/rust-cache@v2.0.0 + + - name: "Build" + run: cargo build + + - name: "Test" + run: cargo test --lib --bins --tests --examples --workspace + + - name: "Check documentation" + env: + RUSTDOCFLAGS: -D warnings + run: cargo doc --no-deps --document-private-items --all-features --workspace --examples + + rustfmt: + name: Rustfmt + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Nightly with rustfmt + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: nightly + components: rustfmt + + - name: "Check formatting" + run: cargo +nightly fmt --check --all \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..34e09db --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/target +.cargo-ok +.DS_Store + +Cargo.lock \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ef88a6b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..15aff1e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contribution guidelines + +First off, thank you for contributing to tlsn-utils. + +If your contribution is not straightforward, please first discuss the change you +wish to make by creating a new issue. + +## Reporting issues + +Before reporting an issue on the +[issue tracker](https://github.com/tlsnotary/tlsn-utils/issues), +please check that it has not already been reported by searching for some related +keywords. + +## Pull requests + +Try to do one pull request per change. + +### Updating the changelog + +Update the changes you have made in +[CHANGELOG](CHANGELOG.md) +file under the **Unreleased** section. + +Add the changes of your pull request to one of the following subsections, +depending on the types of changes defined by +[Keep a changelog](https://keepachangelog.com/en/1.0.0/): + +- `Added` for new features. +- `Changed` for changes in existing functionality. +- `Deprecated` for soon-to-be removed features. +- `Removed` for now removed features. +- `Fixed` for any bug fixes. +- `Security` in case of vulnerabilities. + +If the required subsection does not exist yet under **Unreleased**, create it! \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..fff33a7 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +[![CI](https://github.com/tlsnotary/tlsn-utils/actions/workflows/rust.yml/badge.svg)](https://github.com/tlsnotary/tlsn-utils/actions) + +

+ +

+ +# TLSNotary Utils + +Utility functions which are used for the development of [TLSNotary](https://github.com/tlsnotary/tlsn) + +## ⚠️ Notice + +This project is currently under active development and should not be used in production. Expect bugs and regular major breaking changes. + +## License +All crates in this repository are licensed under either of + +- [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) +- [MIT license](http://opensource.org/licenses/MIT) + +at your option. + + +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +See [CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/tlsn-banner.png b/tlsn-banner.png new file mode 100644 index 0000000000000000000000000000000000000000..7ef31c6eb77440b4bd24bd452ade815209a840ec GIT binary patch literal 20768 zcmeHPc~n!^)=#UIs-PgsJXr@&1f_r=vlA$YSfMfqf}jLZjEq61M1562MAQ;2Q=k|I z2M|%2i36jS0D=UWf<$HrMj}%fzDv%zVB2qf|GlrTeaTuZ*2&#DXP>=)`?vQw_nsSe z=%9(vGO1-43`S`GzCDLAnB}z?%;K}(E9g0y#}eo2gFo(d5`)L%RZpEg?d@{>+(}iO7dDQiCxyW%VD|6XY2_b3*hYvD=LA=< z$HoHjGKQ-s>O>{9oc3()oVxI)_s5)d%O6K1r{7Pem%AL@i8sBs*!~yVt=(NFKL=FZ z?_Iy@IjxpdaO9rl&9hIC+4hE=2%sApf786Rusf(2lxDlv`*KS1;x)v@mxRlD_z< z!Z%;(e{pfsx4mC2H23W^TDj0NTK09oLJM>F-!o)#K2SDEP4mZlo{g>V)Ub^lH}X`8 zgoH#W*|JKmCo;kA%lGW75Ub#1+-e^k!4YPw zdZ`0u?534usqT~DCnq)n8!Ry&2qiV0>nihnf2HQU31c=5XDAnkYZ0xP8T@JOu{q!% z9}#m=*Z7iT&bM=oB(*csoL4pl51FzAf-(0)uMRHcfV;H3#Z+&fHm5vpcixIQF${4K zSp8X&P01Z~)#)aA>HziLk$Y_JFj++2c1l1^Sj2Fgo#Q$F@y2s`Ue_3-fM`)2Yr&u8 zcs^*zO?B6l%g34>NYG%XdA|! z<$LVnJm`z8VT{r}8~btuy5_KteD(nM5_g_s2^^H;#3|Oq%HeT^oBi4!Z$B9S&Y*V; zc)!vFI9}$-=q8Wdeud149i9wXY3G5-=(_Emtx?5bY$K*9fSrkl)j;UlV#fzZocmrx z`j4}unV(oAE)A89Yl8uTh~?{n$@|NDe^|%7rA#WP&zwE&v-PNixw$z-5sZ7t1Q^Yz zO_I=>?fLnn{539~Q}!$EJf#QB;E*CJ5xc{~lruJ3N{geH#oN}K)_^XO%9rvWOe~&_ja~Kzyz6=4jI`{qf=}hlM!L95vA6GDM`KYbg3w9j(**#th>D&QTB%nD^rWF zc|u9s;Apk3k1fJy+7p|+2i|&iZ_1h1R{;n_y~xPHmiJ83D~7Z}Hm6!7SOoweVZMP* zv+5=X+Xa2j97w^L;}6IfKIO;&WiQ_V%I-_c&)-Da+7}UAs8!L=8cFfpW7fAH$OtZi z!!#o1cljJnVSmgt&kov;wYnGm<`$5V*aZSyp}5LJ^jBn%p!ZKtGw;`9V-kVCp9zZq ze^0%t%1NzgYsm~x(0Xu96#H~uLIEOTYO5^vw=gcNN%$x|E8=Mw6P>S96r`AT<0p1u zl;ygeHyq-ehhCjjbLCW`nrNE>O^6I<1Vc7&pJEoN+KX^Bp$$OH=EonGX* zF#BH{NR18mUfr88f{xXp4>_u6xq6y;*qrsxj}+WiKW&GCp=demV=T#qwLcplh(jQ? zhx_x>H%OM4`}hk$@*MtwaySg>yE8dKt5h=vU)JPe9Fw@1C-e*lk)Un*f50Ud3Q4T5 zxF#!l+FJE$)?kywRh^!_l*5})OgXLtn36c5-mJKnfU_9P|J<)V^0O@(03Vg1#%sO$ z2Y+Gb&wTdeUL%M1St>?DFGVE+I5>q?8*(3y_dC!{7_qF|+97AqS)T$Sg1NlY+uL%B z;~Pn?A1?B3TaO9ChNuhPKvxT<)TJ1g_pdQyzDN8tag&yQL>Ud&J8(uyPF^kl>OER7 z>zFsxtUbVahboKa8l~P3w)ISwhjke(uCY8!y~PYhtD75~ja02?d3@e*q)@i+^eeYG z?Mw)6;$_Gi=^}64H;_~ZLrwfV!k;L|l-;gdX9k1JO$qHq-TlPr`~7w@NKC8EMM7$7 zDmo!4m=u$YWoJt~>vB_dS&TYy#Qdn;4vj%qYo6_Xys3`SBC3l!Ca##U?E$Jw!3N-* zbWvGvi}0;&?b6f5`gI1B1p(;2^mWmu8^nBRSFiZB3)Ah}*HlDG{ur=|2Nt6?2+D?J z5~(|H{MT=?hZFzEElJ(bMg2{A*??PK<44ObdUuncmk-rLZG}3oA*cC>Bgnf# zjD^T?b8@*Z=@0<8(x@6*M&n_sJB0&cYhDy|`5#xW`~@Wvf5?AR?fGA6*lM_v*yckb zYZ;8dyAqdt2M9H3}%3;RU;!FyJAKyWLy@L+ZUgN!|scMUW^C)!UgoE?qDOf-$z6ZgSj2v!{>Q=-+?rPWp$P?pxytPSVrSS&qrn&)u(O1W_Bl`=AK zv{uLkxa=DSDMXOu-Uo69FxNI2m^nZbtr$Ry&-R$VVh#QmfQvsQKd1e@HmdlD{ofHw zO!@R?hTf@Iqh}oebHc0{$gt0TIN$Yz?qXY0o;T7iz^uG+0bOQ?tb^IsWT-kfM5M)U z@Y;39{2htY@0O#LN0AB?xzx=y^xsVSY%d=u=l__qnwKhwv%BFKNdeOx$$2c2gJ+fF z=ZdRaix0z%lxMRrHEmm8GLxX_+_yp6nPEuCLVE~BFaPUUNS9I2r-GXDXzARFdjc!a zHP?DrLO4}Uzf56VTfTMZD&hQK61~{IOJp(owWFLWtgH6zg5`?H zm6h_5y2HWS3No8yEM_Z4P)jX^i!`PFFhz3YoR)J^kus7>XldpI3#;%zW_2!afG`Wf z#*i8ER&*mr1MZSxG?_;k+~e`oM_QwLAKm&k@vLpMXcgE9I%J6yjH~HwkCZceTjaQo z`iI~=YK@>V8tz=7&a`O{ix#t=;0%rg%x%wOFtrM?W^iMW@qs!@6^n7;YI#1tVjxkU zCg%wIIMjpoQA8zth^w>uoN|}<>t}Ur27p%oi}&kHOf7idV*2C3iWao^Y=ZfZE}v$r zGp7svcM3Sk%$|$Cao+31F2ktP->TiYm?V7h+%~rz7sXCRky5{#y+BHhwevW2>f19> z_RGGTR9n4s!)mcLrVg+6YW|eh)yZnk<@zwj20n}Hwd53iMO+M70)SvC1UhJ~`dz8H z9)=0Hwhu->Xhr@0Cdu!){`YrR{;mT))CruMtCjx5_-){jKvt<3_$#Q`oDzyXrUFN#5picRX z&TaKn+Wqq7ohXdoKf}!bd?4{>I2T8}51)NdOCbOMf&A*Otcl!n1J43r_}OH^*?-8F z$9+fVuBA_Q^~*DhS5j~5U)q3gNz`{4Da}T5g^d?uwn$TTc9c6Pxh4O>5Y^Q}p>x`z zL~6D*Pc5)~m)`iZa*!X8PKdK>cq#pW*ZWS2C-V1B-Np-_IV@hg=p&iik&{)?(qj;- zzsPCrFLCNLp&J1(jub!zKaRr4YP?ng$rz>EIIn(}KYZtx``91^|;FIt? z5-@)t;eX9 zLv(<*FELZfr@5n%Pl5xnHBMEsHVnf+-eVOH7xOEiFDgJI{M%WLkpH`^c_WqIvHx7jh?O z8Cmpor(2qE>3i;62y*&U)sd46U~=QEK;#qM@(v*#K|Qg()x2J7ajrVm1Qv>U@*ebbMFOM zeg=!h2CygFdL=Pj=V@;DF}e=wBaJT)(qm+n z@Sj9)Lcr=khry4FYXz228UYE@FV zU!tvPzbjAhgVC-`;jiE8NV0N|=N*(_39nKx+NZET4R<}RF4p^m-l9I1Bi=BJUO;9H zCvZmVzu1kATE67VYU9Jj-ytF22|VfxjANuK@w=Bi@P7(HgPLhe%V6O|!_uixEnKh` zxHkI|)Oj{f(=4}IDt?qx&%wEbBuDAM^Q@%fX1M+c`(`}nOi&>Gx;U_BNCecyJ8f%QgnA5) zLaU6XIB#mi$sb4n$GU181mO!9Y_hX;@4nsQYkYQ4N?Xi=Of~(JNM11EyA?8qWSw>5 z-R&x+-TLe1XPpQ~(jt3EhdO7(>!b{M^y>)cc#r&9#DZKL;V39;kx!z&cRQ${$5uMkG+hdNL!@Xl|z{ zhj%odm7X{MO{ni>ySLd|kG7a4)IIVW))l#~=y(V1Wj{KQ19f`aifazYlx}v5FUvkP zwhzTF=_J6eM(bUb;2$k ztn=SKt>bH4&-EE;N6ujWN#wxs3<+sJA;d85Fx6l6T$Xpb_0O1EY7^5KfQdTXSYpMEOab*4!( z9)-&ggp0Y$XHp4|Fm4VEN?z-u=b$rghO|(tA*XjIf?9R?C@DuZw+4F9Cd%?H;^MU97;kIOZ4!Xh|FqIID3MI3<^Bs1tH)T zKt9tfjl9Fb*SOlFMOUgO)e()-N(h0ZzBYp1noCz|QfcWKzr4$>d#4@?Eu&x!=R|tw z$2Hm_7M`K*-aV4QWwuQ@qrqbj(}&%Qt1-CFt1}4ixjQ?%>mX1;!S(@l@b}w?<-)Ah zy))EF9==$@YO^lXGWjkbN*_l|{Iu&#yZ%ib7u&NzW7}4QoLBP&CuEFNp=DIM#JLAc znN{K$>IThstBY@(w4GN50>RES!z$9ZMZgjp^mFzIojDkdvxFJu0}0S^t=9?}s<76u zo@oMmCqnKBp`ysI)Px4^LV0amVYdmbbi7z`-o7Xv_KRn>M_R_5y+a${PYS2lP+gQz zeOai!1NG*Cyc{=W=g5%_tLn*`w+!Ti+DB&@YKd5*s@+>FXneWDoW+BuRy5K1Y%{z{5B?(5LO1eMj5r zXJvVr2ow**VN_Ebs|~Tf`b`~XOlygu$jgcv)FvGQaFC}DPj}cHFd#(hFbTnrG8E_X zB5)AK5LS7Q5iK`04ojFOh=_>vP$jR|$DBpM+hGm)z{91t@|W>Z7W0mfEvZaVI`HOp zpz6mEIN_G`BRMw3l&z;;e#{>69HFJ$fp@Em$k2sH(9+-o>u`q50A6rIzBFJ2M>NuO zmA8-Xc@nER)t;HmWcz>G`x32-(jah~X^3Av&kZ{79*z&pMdE*j2InA9#Q+uwwWPUp zn{9QrDOfgeMR{C4UZ@am%dNyh;8Kv9sVQf8&u&)0jMqj#AsLTK2hdB99)y#JN3V`B zu196lz( zhIrP1-;841s4?YmM#}^gLF24(nOWI*P|r+3d~jbgUd?aD&VdGelr)OEkxuBfY7N$~ ztyj<4ay44ESW{n=*9&nH#!&MyiruvzHRTHBr3zOwS_`b})dAC`Z-u!-{9t^s6yo2k zD%&ov4M^%vud)T2Xh2P(q?L68*1djolAMDbf9GB~%^;Kfl8Xq;hrHcmkKs z?jd}tV4D!exoSummw3Ru!n!A`f-~^0;XD|+Arx2*v@rP}<1)Uu6@y6<0n>n&(L@28 tUe5u@K$B>{4J1v_R1p6U{ONn@SB6q?OPXSY*34