From 22f98da7e5f39c7fc1bf3dee9a1214e5d78839e0 Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 5 Nov 2024 17:52:49 -0500 Subject: [PATCH 01/16] Update status-app-protocols.md --- status/raw/status-app-protocols.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/status/raw/status-app-protocols.md b/status/raw/status-app-protocols.md index 14d09d22..a88a6537 100644 --- a/status/raw/status-app-protocols.md +++ b/status/raw/status-app-protocols.md @@ -92,17 +92,18 @@ All Status messages MUST have one of these functional scopes: #### Community scope -3. _Community control_: messages enabling the basic functioning of the app to control features _only relevant to members of a specific community_. Examples include Community Membership Updates, community Status Updates, etc. -4. _Community content_: messages carrying user-generated content _only for members of a specific community_. +1._Community control_: messages enabling the basic functioning of the app to control features _only relevant to members of a specific community_. Examples include Community Membership Updates, community Status Updates, etc. +2. _Community content_: messages carrying user-generated content _only for members of a specific community_. #### Local scope -5. _Local_: messages related to functions that are only relevant to a single user. Also known as _self-addressed messages_. Examples include messages used to exchange information between app installations, such as User Backup and Sync messages. +1. _Local_: messages related to functions that are only relevant to a single user. Also known as _self-addressed messages_. Examples include messages used to exchange information between app installations, such as User Backup and Sync messages. Note that the functional scope is a logical property of Status messages. It SHOULD however inform the underlying [transport layer sharding](#pubsub-topics-and-sharding) and [transport layer subscriptions](#subscribing). In general a Status client SHOULD subscribe to participate in: -- all global functions, + +- all global functions - (only) the community functions for communities of which it is a member, and - its own local functions. From 9d901ec6f9037a2eafb41268486e3eac2547d82e Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 5 Nov 2024 18:28:01 -0500 Subject: [PATCH 02/16] Create .gitignore --- .github/workflows/.gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/workflows/.gitignore diff --git a/.github/workflows/.gitignore b/.github/workflows/.gitignore new file mode 100644 index 00000000..e43b0f98 --- /dev/null +++ b/.github/workflows/.gitignore @@ -0,0 +1 @@ +.DS_Store From 7184a8f1e72cced16feaa01af6bb57e003c41fea Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 5 Nov 2024 18:31:02 -0500 Subject: [PATCH 03/16] Delete .DS_Store --- .DS_Store | Bin 8196 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 .DS_Store diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 91ab2450345f6442f4293d4fb5da410fd53b6ffc..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8196 zcmeI1&u-H|5XNVlq;*sw2IB=;E8~_D7j=-wxt>U;wiX!<~ z#5?c`+;|k;g%f=Hr&jDxj%gKUq}gx1JJa?4lCC>05s7{l?i1}0kpoxS*+%mhQ}fD~ zY{QOppaS_spI^js6vQ%Eisb<&zyz286JP>N;ARlOGh3N+#dF`xa?1pmz<)_VoewTt zY0qk5R39B^bO``$VptpcsvJ-`uGOB^!YF27!lXh?s<0)7FzFa~ZCuZ4Vbr9Pu*HY4 zD+^np2)#OfzN^DY^o(-L1em}w0rl(Bq7g|7Xbs;jy(=%J?{|L_F zD4lk@KgC9)+1lK4ww!I}z4uAx-qfFFY2Tl`RadX1jDyR*AH0sn`LJ{QP$pA9O2!kN z5QSreyn7QRq0IX-OTtv=dS=3DJMCfT?rhfGbsy~?%y-?{lc$f-e|RvTx1BrpA3QrA zp2Vk#ywG<{!X6lO%UqZ37xWhPbM8%&SSBAasxn%XfXOL5U3jOVn0$v7^5I#Xqxkx-*tH;8*?o;=gU-QaRO9!n#>7Ug z1r58G8iyw3;BZ1&m4rTdzAcqHT>i?sw-~X@ZZg?3c zzyz*?fM^c9K_4q${;6EQ2~}&m@DFfhDy}f9Q_xgi1mL>-havhdLRC)BYGD*3u$8|E RxCwO!KmYY-&&~A__yhh&s1^VK From 9ed0689d1a294ec51395696259d4c0165db27a9d Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 5 Nov 2024 18:31:29 -0500 Subject: [PATCH 04/16] Delete waku/.DS_Store --- waku/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 waku/.DS_Store diff --git a/waku/.DS_Store b/waku/.DS_Store deleted file mode 100644 index b86f5c407a30c862b37ee39418564b564450e4ac..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKL2uJA6n@?cOEyjF0njc;k+@Ey69|U5gswYq;Ibe%04m86AR@D?B&CO{QjQ>g z3^#rXe+Ry2dx)mpdPAuAN$-8n_WP3hQ*FmYB>Lm@kf=*U9-OhWjj+UcoPEJIY!CB< zenv)T6jMzZr3=-r!ztht_}3KRwY!bgn$d_##NX@pX`#-NLM0gI&EX0B;HNfZmvE9v zHL{%V$*9Pyy4U+5Ha0ugu5Wo;-j4Ss`k*FJ9oOTkAD6GV^<1eUxya+>MV?KD-5bYB z)^RSgQWNqtL&@uxxlGlhuf{U1G&eE>p6~g??yc#xw;$X;JeutX(}#~9AisAsoB7_& zJ9i(S4nG#>QhnCHodk9(ZMzmP;0uzaYJ7@HSt$7) Date: Tue, 5 Nov 2024 18:31:41 -0500 Subject: [PATCH 05/16] Delete vac/.DS_Store --- vac/.DS_Store | Bin 8196 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 vac/.DS_Store diff --git a/vac/.DS_Store b/vac/.DS_Store deleted file mode 100644 index e7408ba5453bd50421cf4e081dcd2ca8d0f65f96..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8196 zcmeHM%Wl&^6upxK>L^0Wf=4$3*|Y-$7xK*7clM7W+Paq2}B$;%@C zfnQ+9r|>VV;LM}Qp0qoJB6qGdbLMfc?Q`tR_&P+yhRdi+v`a(|iokXY)g>n8McJ^L z9=Qi(h$kMR)kZneGZw4@RspMkRlq7>71%ZfuxAT%uGsh0tgWpAR)K4&fLI?~6oH<` zT%lY#P{|Yk*ubzfv_%3SVqA@$##|w0U`&MqRVdRb22LdNX-)xU zW&R}AzT*AYUX{>5b1`&i(g_{od-aH30Qc#XqOvATtO!L-T9ncRelv=pplDwfC7z^W z6uMhyb#+C%BL6?W`uqRZUAMg;tAJJD-zmTvBY!l+@h)DS%|nY^+eLYgB24(@3S|hY o(uV-_|Ndc!whLDg<7vzlVg&ZzKLixt{q6o=&im~Ce{J^vKYX600RR91 From 4c8b2ff8e71fcbac579de4cfbb48eb495003e8ff Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 5 Nov 2024 18:31:55 -0500 Subject: [PATCH 06/16] Delete status/.DS_Store --- status/.DS_Store | Bin 10244 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 status/.DS_Store diff --git a/status/.DS_Store b/status/.DS_Store deleted file mode 100644 index 8043d3f212400d2f61670a624b10d3b85bca1a20..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 10244 zcmeI1&2G~`5XWbeKphoO4!{jzi3^9S&JfieNA-5bz{gC}wN)~Mh2e@c@<(kIO3=i296cpgXdMYsE1 zG@7j|S9h!(Yu9@1zfUuN5iFMTVK941N6*qU4maZ&1+ap&gaG+6{uGM&kQXfj2Y zS1+Pul4iqnnM~#~)>kL2w$&bYZm(9|J^P^NuJ`QK(L)Ev19!b{Tet2#I6fVJh|iMr zqgtTQNdm4L3;wiO?S(%};xu`O$K*?^a}5Gtao!~0)`oyvB5(+YMFQeZi2(Z4gaEFj zf`DTX_*_B2sSN?AM8JWbLEuM;0Q%H~0IsBhK)*;p?qq%`WI_k}wIR^2ATTfpP$o19 z3~EDQP(h$76Pg6-k_nxPOn6kv1C$Ai1kk4@p8;Hn@fm2s3THT zF##s;Y9!*(02TNY~ Date: Tue, 5 Nov 2024 18:32:11 -0500 Subject: [PATCH 07/16] Delete nomos/.DS_Store --- nomos/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 nomos/.DS_Store diff --git a/nomos/.DS_Store b/nomos/.DS_Store deleted file mode 100644 index 89dcafab44c70cbcd56d1a552d0853b27be4500d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKy-ve05I(nsCPGLZ05L{lMWs~{6tRTT4h$>=!2qZLTH}!lVr?D4pGn=ek6Ug zX|X*s$MClqpl_Ff3RDjwdG+D@6N!U)Bg{6HN4_aZ|?x}zTnRI_z>pF!c-_iJssC~lsgDlBe%=|Gce6SR(A_@{x`m_|EGhv#|$t7|B3;Tt9$ht zrex06Ps!0)>!4nul8|4j@ht=mbrhp79mT7tN^smE1JN~@YQzx~z6dB9xM2o Date: Tue, 5 Nov 2024 18:33:00 -0500 Subject: [PATCH 08/16] Delete waku/informational/.DS_Store --- waku/informational/.DS_Store | Bin 8196 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 waku/informational/.DS_Store diff --git a/waku/informational/.DS_Store b/waku/informational/.DS_Store deleted file mode 100644 index c402fd6991dc77fa02057b567ae9641df13598fe..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8196 zcmeI1O;6iE5QcX{07nRs10XI)mU=}HFd{@;ObUly>#98f3NeXV3*$xkAcrWDk05?b zZ~T=0m!9Z5yPHZl=G-ctk#^txn29w{B-^tVLdfQ@voFM!5W+ztt*)TUG1{j#V^0Vco%m;e*_zX;%&P3FAw+&8=2GXW-0NCI?!aM4J8tEo|a z>p-VV0B9M@+AyZqe~NLf`c_k;*nvqC3N@k9mKf56W8JlWzSY#I2^Z29AJSe~+6qPL ztK;`w?JlHmlzS$?1ZD|P?OqZG;^0%PZZh@z?yEK(qH4a|m9aVo9q=6GD&aS!*8Cp+%A-Z;Y8JDyA`&c=tmlh3W&_%2b8CP8U$ z5@I!z@Y6KghoG0lD*28%`BHXXhQLp(X9;+7L%_=+P=8B6Zs!oF&kcck4uM97z;h0P z#@rBS%n Date: Tue, 5 Nov 2024 18:33:22 -0500 Subject: [PATCH 09/16] Delete waku/deprecated/.DS_Store --- waku/deprecated/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 waku/deprecated/.DS_Store diff --git a/waku/deprecated/.DS_Store b/waku/deprecated/.DS_Store deleted file mode 100644 index 57773832297c24f6fc37aca76a3859fb4ce45966..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKO>fgc5S>j@>QGh6fmU3QEOD($qC)G6iyM*y2QD>&1E4gnBWl(4R{0=@D3XsL zehfE$3V#RQ>`o7M%MDe?+L318?Ci|i^Q8SEBGq3cJ)#Z~c~HjILo{~?kF(yAhIlwn z@f>lcW7s^|4;gdd7;p^yzYOr&ZBUO6UuXKfvVQk}8!BgI*(rId_GR|$&#~+a$_%I{@K+fKYQsQKVL;J~a{Y8tsUH!ws2+7x zYH!mi4N>oa-T?RMijp!H>U)I?bZa28O1!Na)Z$8T3^)e8 zRA|w)jseF&nSrM5cKG}s{{8)5PI5iRfMcLm45-#18uU?;oUONto Date: Tue, 5 Nov 2024 18:33:33 -0500 Subject: [PATCH 10/16] Delete waku/standards/.DS_Store --- waku/standards/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 waku/standards/.DS_Store diff --git a/waku/standards/.DS_Store b/waku/standards/.DS_Store deleted file mode 100644 index 92eaf99563ddf2379dba61bdaf77bd59d5863281..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHK&rjPh6n=(`rc{%97!wzyNL~~;z}`ZpXYCOoXU2T$_N>}JbZZVCQZ!{jn(z5errQ%lHntKsk$zhO(`Jmqnd*Ar(RLV4ZjKk)7E vyw`g0A8Nz!3bP%nfVbjxxH7bP8~}ZTg+|oC?2mww!4_75|Ej=W@>lHI From a5c6a19ddb375e0e64bcab46b5775b90d5aface1 Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 5 Nov 2024 18:33:44 -0500 Subject: [PATCH 11/16] Delete waku/standards/legacy/.DS_Store --- waku/standards/legacy/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 waku/standards/legacy/.DS_Store diff --git a/waku/standards/legacy/.DS_Store b/waku/standards/legacy/.DS_Store deleted file mode 100644 index 895ae261445c9735d43b6a5d971c55929d8b4312..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKJx{|h5VhMvQwmZCKrBd+SSx4+Y7?=9PzF|lU;tDaT0umJtA3E7s+1ALk747d z@OR+Oz7A<%MX2&g_B-GCoW3X7t{G$89e3-DRTyIiG{nLRbUzs8v1KerkySvBYX~1a zT35RD498&MAFs>XYdLR z@ObtHQ7EE&Il@SDj{7@g(%hR1!o8W{Zl$^N?F@HoLAYBP?)Dt_w+wfCLAcv<+<~Yx z+9^hP7SN~_&VWLnT9ni@q0AK;a(!j?D0M?j<4q>7YGGJVl0;*C@ zPYkZgA#TzRv0L6-X Date: Tue, 5 Nov 2024 18:34:00 -0500 Subject: [PATCH 12/16] Delete waku/standards/core/.DS_Store --- waku/standards/core/.DS_Store | Bin 10244 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 waku/standards/core/.DS_Store diff --git a/waku/standards/core/.DS_Store b/waku/standards/core/.DS_Store deleted file mode 100644 index 1807b8242f0eb294207e39a4d070f2b91231c8d5..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 10244 zcmeI1&5qMB5XbFqVN)%j9)KHCBsg$bLDID8R$M|^4qOR>1EA8-3L>)csvq=FRmu^> zJMaqJcog1+6U^8yQXKCUAu}V{f5(|=<)5rc#$k-{@p=|A<}=1TXsF#Q&{+)cV{2GT z&)fm!5YMtgWH9bRd#LY`5CI}U1c(3;AOimu0eEJkc}GgACjvx(2>c;{`N4;VnrN+* z%G3d!ECE2`E_4~bF(qxeI$u`S#?ejf5FY@Io2!8O^ zLHp9>L+{W#@?NL!#U@=%SL@|?x_F6K&x9zl{dk%^&*z&-_xdAIuBLf8U&w%bHV2ni zFYrA>gx7*;@?}sP5V}Cmw#W0RecDs&uFg z3*ArLnR#LRdWU?$|(YMBsx93cQJ zu@Er!0E0}}AmGX#h?%(uV8fFU0V3cifdjQJAJ6|EU;O>w(bdzkhyW2l0=#{io{n*F z0S`QD_o2OkhK7EXQW*kW?Lz=u;Bow2Xy_ZDqQN-PS}B#`FfYSF|I){R{W)OsoiAim M|5N?{AJqT90bX_h?f?J) From 0c3a750f126f4f118c24f4c61aef99d79eca9c69 Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 5 Nov 2024 18:34:11 -0500 Subject: [PATCH 13/16] Delete waku/standards/application/.DS_Store --- waku/standards/application/.DS_Store | Bin 8196 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 waku/standards/application/.DS_Store diff --git a/waku/standards/application/.DS_Store b/waku/standards/application/.DS_Store deleted file mode 100644 index 32b85ce7aaf53e4494bb1ec1e9cca876606eab3a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8196 zcmeI1O;6iE5QcX{S{xzN99qPsk|nNDi6I24UQ8Mez1D~x0EL)Dt%dPM`DhMNBp+M# z$Mn{p(*ME<-r3zC;h1x)ct+ZN_hTm3JdteAS_mOqlb$EUwh+QWBduqL=DBZnxn}}QppXRU{@|jK`c_k; z`qqI?mjKW*mbGC_um2R|TJ^1_MzI5vCKPHyr7ba}3CFr?{d}vbQ4=ntEk2~Zva}V7 z)K|yvyV_ky-zfJ?fC(%UpxV78_C)I!OD3)6u~C{0RqfG#c0Ie`RT{ z{Nm-hv+is-m%%qR4aVK^WYp>o&uMn5R2(kG-S8~xPdnAuA5}8$MoE9D1EO9ZE*D>- zq^G7WHA#9S9UGVpr{YvP)vejAUUM7X(Y)r)4&OI1-anepE6$sp-4CBTH}P$vewYNM zy-A48Ou|1G*?td(Nvx8un3FGM=Vb`|#(I{3w=x9090JX!1mxQs0?m~n&|D&LAoeo^ zek~Dz&x#O0COHHe83K1X1R5(tpphYfWZ9TNK?tmwJh!R-KY9NAzaTU?O(sxG0LHFb!0Q1KWh8VkWr5N98Y7{H5e{v9D>VN~m&wu?N Ia92D64_TpMF8}}l From 6931f4df4345d1f7734b9328056156cce1fd7c43 Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 5 Nov 2024 18:34:50 -0500 Subject: [PATCH 14/16] Delete waku/standards/core/12/.DS_Store --- waku/standards/core/12/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 waku/standards/core/12/.DS_Store diff --git a/waku/standards/core/12/.DS_Store b/waku/standards/core/12/.DS_Store deleted file mode 100644 index 18d011994b243d3fa4628c1b5ef8ebb292d36ac0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKO>5gg5S?}0Mj`|ZZAy-UUei<|rA_HYagsx>RY?y`ajZyfMHQ{Ffkz5JD+o24>&v?99k|EAIypsqQGBju&)1=S|M)}j&g>GIMfkpI$2AJuL&XK2S zL>0Y&&DoXll)#X}!(y(=<=v_z<7(i3%gm+kf#|!jz8vQs>fYDD$~m3#&*E-J-^p^ zHkpJQ!K-uu From 9ba2a0b99d4bada8e239607eb271f2ff1152f0b3 Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Tue, 5 Nov 2024 18:43:42 -0500 Subject: [PATCH 15/16] Update rln-relay.md --- waku/standards/core/17/rln-relay.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/waku/standards/core/17/rln-relay.md b/waku/standards/core/17/rln-relay.md index 5a1ff909..b199181c 100644 --- a/waku/standards/core/17/rln-relay.md +++ b/waku/standards/core/17/rln-relay.md @@ -18,7 +18,7 @@ This specification describes the `17/WAKU2-RLN-RELAY` protocol, which is an extension of [`11/WAKU2-RELAY`](../11/relay.md) to provide spam protection using [Rate Limiting Nullifiers (RLN)](../../../../vac/32/rln-v1.md). -The security objective is to contain spam activity in the (64/WAKU-NETWORK)[] +The security objective is to contain spam activity in the [64/WAKU-NETWORK](../64/network.md) by enforcing a global messaging rate to all the peers. Peers that violate the messaging rate are considered spammers and their message is considered spam. @@ -374,9 +374,10 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public ## References 1. [`11/WAKU2-RELAY`](../11/relay.md) -2. [RLN](../../../../vac/32/rln-v1.md) -3. [14/WAKU2-MESSAGE](../14/message.md) -4. [RLN documentation](https://hackmd.io/tMTLMYmTR5eynw2lwK9n1w?view) -5. [Public inputs to the RLN circuit](https://hackmd.io/tMTLMYmTR5eynw2lwK9n1w?view#Public-Inputs) -6. [Shamir secret sharing scheme used in RLN](https://hackmd.io/tMTLMYmTR5eynw2lwK9n1w?view#Linear-Equation-amp-SSS) -7. [RLN internal nullifier](https://hackmd.io/tMTLMYmTR5eynw2lwK9n1w?view#Nullifiers) +2. [64/WAKU-NETWORK](../64/network.md) +3. [RLN](../../../../vac/32/rln-v1.md) +4. [14/WAKU2-MESSAGE](../14/message.md) +5. [RLN documentation](https://hackmd.io/tMTLMYmTR5eynw2lwK9n1w?view) +6. [Public inputs to the RLN circuit](https://hackmd.io/tMTLMYmTR5eynw2lwK9n1w?view#Public-Inputs) +7. [Shamir secret sharing scheme used in RLN](https://hackmd.io/tMTLMYmTR5eynw2lwK9n1w?view#Linear-Equation-amp-SSS) +8. [RLN internal nullifier](https://hackmd.io/tMTLMYmTR5eynw2lwK9n1w?view#Nullifiers) From 4608aec1802eb4e80c390022d4f2778deb357eaa Mon Sep 17 00:00:00 2001 From: Jimmy Debe <91767824+jimstir@users.noreply.github.com> Date: Wed, 6 Nov 2024 16:32:24 -0500 Subject: [PATCH 16/16] Update status-app-protocols.md --- status/raw/status-app-protocols.md | 46 +++++++++++++++--------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/status/raw/status-app-protocols.md b/status/raw/status-app-protocols.md index a88a6537..150e9584 100644 --- a/status/raw/status-app-protocols.md +++ b/status/raw/status-app-protocols.md @@ -58,8 +58,8 @@ Status currently defines functionality to support three main application feature Each application-level function, regardless which feature set it supports, has the following properties: 1. Functional scope -1. Content topic -1. Ephemerality +2. Content topic +3. Ephemerality ### Functional Scope @@ -141,7 +141,7 @@ App-level messages that are considered ephemeral, MUST set the `ephemeral` field The end-to-end reliability layer contains the functions related to one of the two end-to-end reliability schemes defined for Status app messages: 1. Minimum Viable protocol for Data Synchronisation, or MVDS (see [STATUS-MVDS-USAGE](./status-mvds.md)) -1. Scalable distributed log reliability (spec and a punchier name TBD, see the [original forum post announcement](https://forum.vac.dev/t/end-to-end-reliability-for-scalable-distributed-logs/293/16)) +2. Scalable distributed log reliability (spec and a punchier name TBD, see the [original forum post announcement](https://forum.vac.dev/t/end-to-end-reliability-for-scalable-distributed-logs/293/16)) Ephemeral messages SHOULD omit this layer. Non-ephemeral 1:1 chat messages SHOULD make use of MVDS to achieve reliable data synchronisation between the two parties involved in the communication. @@ -244,8 +244,8 @@ useful for the user functions specific to that instance of the application. The specific Waku discovery protocol used for discovery depends on the use case and resource-availability of the client. 1. [EIP-1459: DNS-based discovery](https://eips.ethereum.org/EIPS/eip-1459) is useful for initial connection to bootstrap peers. -1. [33/WAKU2-DISCV5](../../waku/standards/core/33/discv5.md) allows decentralized discovery of Waku peers. -1. [34/WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/315264c202e0973476e2f1e2d0b01bea4fe1ad31/standards/core/peer-exchange.md) allows requesting peers from a service node +2. [33/WAKU2-DISCV5](../../waku/standards/core/33/discv5.md) allows decentralized discovery of Waku peers. +3. [34/WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/315264c202e0973476e2f1e2d0b01bea4fe1ad31/standards/core/peer-exchange.md) allows requesting peers from a service node and is appropriate for resource-restricted discovery. All clients SHOULD use DNS-based discovery on startup @@ -264,14 +264,14 @@ and to enable the user functions specific to that instance of the application. The specific Waku protocol used for subscription depends on the resource-availability of the client: 1. Filter client protocol, as specified in [12/WAKU2-FILTER](../../waku/standards/core/12/filter.md), allows subscribing for traffic with content topic granularity and is appropriate for resource-restricted subscriptions. -1. Relay protocol, as specified in [11/WAKU2-RELAY](../../waku/standards/core/11/relay.md), allows subscribing to traffic only with pubsub topic granularity and therefore is more resource-intensive. Relay subscription also allows the application instance to contribute to the overall routing infrastructure, which adds to its overall higher resource usage but benefits the ecosystem. +2. Relay protocol, as specified in [11/WAKU2-RELAY](../../waku/standards/core/11/relay.md), allows subscribing to traffic only with pubsub topic granularity and therefore is more resource-intensive. Relay subscription also allows the application instance to contribute to the overall routing infrastructure, which adds to its overall higher resource usage but benefits the ecosystem. Full clients SHOULD use relay protocol as preferred method to subscribe to pubsub topics matching the scopes: 1. Global control -1. Global content -1. Community control, for each community of which the app user is a member -1. Community content, for each community of which the app user is a member +2. Global content +3. Community control, for each community of which the app user is a member +4. Community content, for each community of which the app user is a member Light clients SHOULD use filter protocol to subscribe only to the content topics relevant to the user. @@ -291,14 +291,14 @@ The application MUST publish user and app generated messages via the Waku transp The specific Waku protocol used for publishing depends on the resource-availability of the client: 1. Lightpush protocol, as specified in [19/WAKU2-LIGHTPUSH](../../waku/standards/core/19/lightpush.md) allows publishing to a pubsub topic via an intermediate "full node" and is more appropriate for resource-restricted publishing. -1. Relay protocol, as specified in [11/WAKU2-RELAY](../../waku/standards/core/11/relay.md), allows publishing directly into the relay routing network and is therefore more resource-intensive. +2. Relay protocol, as specified in [11/WAKU2-RELAY](../../waku/standards/core/11/relay.md), allows publishing directly into the relay routing network and is therefore more resource-intensive. Full clients SHOULD use relay protocol to publish to pubsub topics matching the scopes: 1. Global control -1. Global content -1. Community control, for each community of which the app user is a member -1. Community content, for each community of which the app user is a member +2. Global content +3. Community control, for each community of which the app user is a member +4. Community content, for each community of which the app user is a member Light clients SHOULD use lightpush protocol to publish control and content messages. @@ -398,13 +398,13 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public ## References 1. [55/STATUS-1TO1-CHAT](../55/1to1-chat.md) -1. [56/STATUS-COMMUNITIES](../56/communities.md) -1. [10/WAKU2](../../waku/standards/core/10/waku2.md) -1. [11/WAKU2-RELAY](../../waku/standards/core/11/relay.md) -1. [12/WAKU2-FILTER](../../waku/standards/core/12/filter.md) -1. [14/WAKU2-MESSAGE](../../waku/standards/core/14/message.md) -1. [23/WAKU2-TOPICS](../../waku/informational/23/topics.md) -1. [19/WAKU2-LIGHTPUSH](../../waku/standards/core/19/lightpush.md) -1. [Scalable distributed log reliability](https://forum.vac.dev/t/end-to-end-reliability-for-scalable-distributed-logs/293/16) -1. [STATUS-MVDS-USAGE](./status-mvds.md) -1. [WAKU2-STORE](https://github.com/waku-org/specs/blob/8fea97c36c7bbdb8ddc284fa32aee8d00a2b4467/standards/core/store.md) +2. [56/STATUS-COMMUNITIES](../56/communities.md) +3. [10/WAKU2](../../waku/standards/core/10/waku2.md) +4. [11/WAKU2-RELAY](../../waku/standards/core/11/relay.md) +5. [12/WAKU2-FILTER](../../waku/standards/core/12/filter.md) +6. [14/WAKU2-MESSAGE](../../waku/standards/core/14/message.md) +7. [23/WAKU2-TOPICS](../../waku/informational/23/topics.md) +8. [19/WAKU2-LIGHTPUSH](../../waku/standards/core/19/lightpush.md) +9. [Scalable distributed log reliability](https://forum.vac.dev/t/end-to-end-reliability-for-scalable-distributed-logs/293/16) +10. [STATUS-MVDS-USAGE](./status-mvds.md) +11. [WAKU2-STORE](https://github.com/waku-org/specs/blob/8fea97c36c7bbdb8ddc284fa32aee8d00a2b4467/standards/core/store.md)