From b6f0e92862685bf5ae794b4e0eccc643121a63e6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 28 Apr 2023 20:03:56 +0000 Subject: [PATCH] deploy: 081d7044ae13ef775fd33053adc288e67888eb2a --- 404.html | 4 ++-- assets/js/8a56e0ba.a5b96727.js | 1 + assets/js/8a56e0ba.abfcd29c.js | 1 - assets/js/{8b564e48.e360ddfb.js => 8b564e48.62bfda74.js} | 2 +- assets/js/{935f2afb.6b71f3f9.js => 935f2afb.1ec4dab0.js} | 2 +- assets/js/{b0580eac.b19bf88d.js => b0580eac.362a9d70.js} | 2 +- ...{runtime~main.42a3487d.js => runtime~main.27539258.js} | 2 +- docs/contributors/foundation.html | 4 ++-- docs/contributors/join.html | 4 ++-- docs/contributors/labs.html | 4 ++-- docs/ecosystem/bounties.html | 4 ++-- docs/ecosystem/grants-funding.html | 4 ++-- docs/ecosystem/partnerships.html | 4 ++-- docs/explorer.html | 4 ++-- docs/intro.html | 4 ++-- docs/nodes/install.html | 4 ++-- docs/nodes/nodes/hardware.html | 4 ++-- docs/nodes/nodes/installation.html | 4 ++-- docs/nodes/nodes/mainnet.html | 4 ++-- docs/nodes/nodes/testnet.html | 4 ++-- docs/nodes/providers/building.html | 4 ++-- docs/nodes/providers/setting_up.html | 4 ++-- docs/nodes/validators/joining.html | 4 ++-- docs/official-links/jackal-foundation.html | 4 ++-- docs/official-links/jackal-labs.html | 4 ++-- docs/official-links/jackal-protocol.html | 4 ++-- docs/overview/jackal-tldr.html | 4 ++-- docs/overview/jkl.html | 4 ++-- docs/overview/why-jackal.html | 4 ++-- docs/protocol/encryption.html | 4 ++-- docs/protocol/modules/dsig.html | 6 +++--- docs/protocol/modules/filetree.html | 8 ++++---- docs/protocol/modules/jklmint.html | 6 +++--- docs/protocol/modules/lp.html | 6 +++--- docs/protocol/modules/module-overview.html | 6 +++--- docs/protocol/modules/rns.html | 6 +++--- docs/protocol/modules/storage.html | 6 +++--- docs/protocol/modules/wasm.html | 6 +++--- docs/protocol/p-o-p.html | 6 +++--- docs/protocol/storageproviders/casual-build.html | 4 ++-- docs/protocol/storageproviders/diy-serious copy.html | 4 ++-- docs/protocol/storageproviders/enterprise.html | 4 ++-- docs/protocol/storageproviders/overview.html | 4 ++-- docs/protocol/tokens.html | 4 ++-- docs/protocol/validators.html | 4 ++-- docs/using-jackal/dashboard.html | 4 ++-- docs/using-jackal/delegate.html | 4 ++-- docs/using-jackal/fund.html | 4 ++-- docs/using-jackal/wallet/keplr.html | 4 ++-- index.html | 4 ++-- markdown-page.html | 4 ++-- 51 files changed, 105 insertions(+), 105 deletions(-) create mode 100644 assets/js/8a56e0ba.a5b96727.js delete mode 100644 assets/js/8a56e0ba.abfcd29c.js rename assets/js/{8b564e48.e360ddfb.js => 8b564e48.62bfda74.js} (99%) rename assets/js/{935f2afb.6b71f3f9.js => 935f2afb.1ec4dab0.js} (99%) rename assets/js/{b0580eac.b19bf88d.js => b0580eac.362a9d70.js} (98%) rename assets/js/{runtime~main.42a3487d.js => runtime~main.27539258.js} (55%) diff --git a/404.html b/404.html index adea35b..33a88cf 100644 --- a/404.html +++ b/404.html @@ -5,13 +5,13 @@ Page Not Found | Jackal Chain Docs - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/8a56e0ba.a5b96727.js b/assets/js/8a56e0ba.a5b96727.js new file mode 100644 index 0000000..fe2f165 --- /dev/null +++ b/assets/js/8a56e0ba.a5b96727.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[8957],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var o=r(7294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function n(e){for(var t=1;t=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var l=o.createContext({}),c=function(e){var t=o.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):n(n({},t),e)),r},d=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},u="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},f=o.forwardRef((function(e,t){var r=e.components,i=e.mdxType,s=e.originalType,l=e.parentName,d=a(e,["components","mdxType","originalType","parentName"]),u=c(r),f=i,h=u["".concat(l,".").concat(f)]||u[f]||p[f]||s;return r?o.createElement(h,n(n({ref:t},d),{},{components:r})):o.createElement(h,n({ref:t},d))}));function h(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var s=r.length,n=new Array(s);n[0]=f;var a={};for(var l in t)hasOwnProperty.call(t,l)&&(a[l]=t[l]);a.originalType=e,a[u]="string"==typeof e?e:i,n[1]=a;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>n,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var o=r(7462),i=(r(7294),r(3905));const s={sidebar_position:8},n="Filetree Module",a={unversionedId:"protocol/modules/filetree",id:"protocol/modules/filetree",title:"Filetree Module",description:"Overview",source:"@site/docs/protocol/modules/filetree.md",sourceDirName:"protocol/modules",slug:"/protocol/modules/filetree",permalink:"/docs/protocol/modules/filetree",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/protocol/modules/filetree.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8},sidebar:"tutorialSidebar",previous:{title:"dsig Module",permalink:"/docs/protocol/modules/dsig"},next:{title:"Jackal Proof-of-Persistence",permalink:"/docs/protocol/p-o-p"}},l={},c=[{value:"Overview",id:"overview",level:2},{value:"Folder Abstraction",id:"folder-abstraction",level:2},{value:"File Entry Structure",id:"file-entry-structure",level:2},{value:"Encrypted Viewing Access",id:"encrypted-viewing-access",level:2}],d={toc:c},u="wrapper";function p(e){let{components:t,...s}=e;return(0,i.kt)(u,(0,o.Z)({},d,s,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"filetree-module"},"Filetree Module"),(0,i.kt)("h2",{id:"overview"},"Overview"),(0,i.kt)("p",null,"The Jackal Filetree module is responsible for organizing and managing user files in a secure and user-friendly way. When a user uploads a file using the Storage module, the file is only accessible from the File ID (FID), which can be challenging to remember for every file uploaded to Jackal. Additionally, every single upload would be required to be public, or the user would need to keep track of every symmetric key used to encrypt the files and manually map them to the FIDs. To address this issue, the File Tree module implements a tree structure to store each file as an entry in the tree. Organizing this structure is also trivial as we can assign children to pseudo files that we call folders. Finally, to keep track of encryption keys, the protocol maps every file to its respective key, emphasizing the security and privacy posture that the File Tree module enables."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"Protocol Overview",src:r(96).Z,width:"542",height:"842"})),(0,i.kt)("h2",{id:"folder-abstraction"},"Folder Abstraction"),(0,i.kt)("p",null,"These, of course, are all abstractions of what's actually under the hood. The File Tree module doesn't actually handle any of the folder logic; the system believes it is storing files that act as metadata stores, which then update to reflect changes in folders. This gives the user experience the feeling that folders and files are separate entities in the tree, but in reality, they are identical."),(0,i.kt)("h2",{id:"file-entry-structure"},"File Entry Structure"),(0,i.kt)("p",null,"Storing file entries on-chain is a challenge since the chain itself is public. This requires the use of client-side encryption before uploading data to the chain itself. The main component of a file is location (Address), allowing users to query the rest of the data from the file. You can think of the location as a key in a traditional key-value store or a path in bucket-based storage. The address is hashed using SHA256 to ensure it is impossible to retrieve the plain-text representation of the file name while still being able to query the file using its given name."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"Protocol Overview",src:r(4965).Z,width:"271",height:"220"})),(0,i.kt)("p",null,"The second most important data point in a file is the content of the file. This field is extremely versatile as it can store any string. Traditionally this is used to store a JSON list of FIDs to point to a file on the Storage Module; however, the protocol can also theoretically use it to store short bits of text like encrypted passwords for a private password manager. The owner tag is a hashed version of the owner, hiding what address owns each file. This field can be changed to reflect the transferral of ownership. When making changes to the file such as deletion, movement, or adding/removing viewers/editors, the owner field is consulted to determine permissions. The same applies to edit access; editors can update the contents but nothing else."),(0,i.kt)("h2",{id:"encrypted-viewing-access"},"Encrypted Viewing Access"),(0,i.kt)("p",null,"For users to view files, they need access to the symmetric keys used to encrypt the files. To do this, the protocol has a map of hashed addresses with each user's respective version of the symmetric key encrypted with that address's corresponding public key. The protocol can then store that map in the file entry to act as an encryption key discovery layer. The addresses in this viewing list are only able to access files and decrypt the data in their client; they have no privileges over the modification of the file entry in any way. This approach ensures that the File Tree module maintains a strong security and privacy posture for user data."))}p.isMDXComponent=!0},96:(e,t,r)=>{r.d(t,{Z:()=>o});const o=r.p+"assets/images/filetree1-e947ab740b90156234b2fadb69a00533.png"},4965:(e,t,r)=>{r.d(t,{Z:()=>o});const o="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQ8AAADcCAYAAABu8iQLAAAenUlEQVR4Xu2dCbAcVRWGQVBxVzQaFwRBEERLUYFIkF0IiwbZFDcWSYDSgCABFQslyqaArHHDrVzADRcEERQsFClQBKOguCEoS9CgICK4tfVd607d15nbc1+/mfzv9fu/qqm86Znp02den7/vvf1y/pUqY4xpwUr1DcYYU4LFwxjTCouHMaYVFg9jTCssHsaYVlg8jDGtsHgYY1ph8TDGtMLiYYxphcXDGNMKi4cxphUWD2NMKywexphWWDyMMa2weBhjWmHxMMa0wuJhjGmFxcMY0wqLhzGmFRYPY0wrLB7GmFZYPIwxrbB4GGNaYfEwxrTC4mGMaYXFwxjTCouHMaYVFg9jTCssHsaYVsjEY6uttqpWWmklP/zwYwIP6kiFTDxI3BgzMZR1JIusTNqYrqCsI1lkZdLGdAVlHckiK5M2piso60gWWZm0MV1BWUeyyMqkjekKyjqSRVYmbUxXUNaRLLIyaWO6grKOZJGVSZuqmj17dvWQhzykWmWVVcY87rzzzuoDH/hA9aY3vSm873GPe1z1hz/8ofZpM1lQ1pEssjJp83/x+MxnPlPfHPj73/9e3XPPPeFni8fkRllHssjKpE2zeORGHt/85jer5z//+dVznvOcascdd6xuv/329GNGgLKOZJGVSZvxi8cdd9xRPf7xj69+9rOfhe0nn3xy9apXvSr9mBGgrCNZZGXS5v/igTA85SlP6T3WXnvt8Fo/8fj0pz9dzZkzp/f5v/3tb9Wqq65a/fvf/+5tMyseZR3JIiuTNv8Xj7POOiuMKOJj6dKl4bV+4sG2Rz3qUdWaa67ZezAS4XNGh7KOZJGVSZvxT1t479y5c2vvNGqUdSSLrEzajF88uIU7Y8aM6le/+lXYfs0111QLFixIP2YEKOtIFlmZtBm/eEC827LOOutUL3zhC6vvf//76ceMAGUdySIrkzamKyjrSBZZmbQxXUFZR7LIyqSN6QrKOpJFViZtTFdQ1pEssjJpY7qCso5kkZVJG9MVlHUki6xM2piuoKwjWWRl0sZ0BWUdySKvtdZaIXE//PCj/YM6UiETDxI3xkwMZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZ5GElvWzZstAeb968efWXxvDBD36w1x2rzmQ1Nrr00kuzx5V2+zLTl2HVURtkkUuS/spXvlLftBxnnnlmtWjRomAb8I9//KP+co/xisdksBR45StfWV111VX1zeHYUlc3M30pqaNRIYtckjS9Mgex8cYbV7/97W+r+fPnV+edd15vO0Ky9957V8985jNDv06a9UbxuPjii6tnP/vZwfkM4cFCAPG49tprqxe84AXV6173umqrrbYK7825pN18883Vy172srCfZz3rWdXxxx/fuP0Xv/hF8ILtB6MI3o8AbrbZZiGfE088sXr4wx8etiGip5xySrXvvvuG43vnO985ZuTB8X/4wx+uXv7yl4fv7Ljjjuvt+4QTTqjWWGON6sUvfnH1kY98JFgmmO5QUkejQha5JOlB4nHDDTcEYYArrrii2mmnnXqvLV68uNp8882rf/3rX9Vf//rXaoMNNgjFxlX7aU97WhCQ+D4MnxGPJUuWBG+SKEJNLmlvfvObq/e+973hZ/a/++67h39z2zFJ+vrXvx62p/zpT3+qnvCEJ1T33ntveP7JT36yOvvss8PPG264YW/kccYZZ4TpGcICqXg88YlPDIICf/zjH6uHPexhYWRy4403VquvvnrI48EHHwzfz6Dv1EwtSupoVMgi55L+xCc+EaYRPCjq+PNHP/rR+lurhQsXVh/60IfCz//973/D1RuLAHj1q19dnXrqqb33vv3tbw/FxgiA/UUYoXAsiAci8YhHPKL6z3/+E15rckl73/veV2255ZbV1Vdf3Xs/5LbnuP/++4NAkcef//znMa+l4sH0bIcddui9VhePn/zkJ73XEKPf/e53YTSSWkKee+65Fo+OkaujFYEscknSTSd6HEE89rGP7QkMw3yG98AQnqt45P3vf38otiuvvHK5ofsjH/nInniwz0iTSxojGqYETGmwaoxCldveBIW/5557hn1vt912ofChLh6vfe1re5+pi8evf/3r3mvxOdOXdJ2H3Ju+UzP1KKmjUSGLXJJ004l+0UUXjbkSA0XImgDstddeYZE08ra3vS0UEkP5dOTBaCIdeTz96U/vvVbqkoYREp9jzaRke45//vOf1dFHH1294hWvCM/r4sFaTKREPLCT3GOPPXrbmY41fadm6lFSR6NCFrkk6aYTHXGIU5YURgc//elPg3CwcElBsq7AlIZi4zlrB9/61rfC+ylCFjL7iUeTS9prXvOa3j6Y+rCm8qMf/Si7PbfmgTgwtYh3ipgq7bzzzuFnjJXivtqIB8fL8TMdIm9GNU3fqZl6lNTRqJBFnkjSf/nLX8LaRLzzkXLooYeGUcZ9991X7bbbbtXMmTOrTTbZJKx57LPPPuE9X/va10ITFYSGxU2mKtwlqYsH5FzSKEzuYLAf7oi8+93vbtyeu9vCushhhx0W7gpxd4a7LSwEw7HHHhumZSyWthEP4Lsgv1mzZoWFWETUdIeJ1NFEkUVWJj2dSBdtL7/88nBr23QHZR3JIiuTni7cdddd1WMe85jq5z//eXi+3377VYccckjtXWYqo6wjWWRl0tMJ/jCMKRR/KMbib/12sJnaKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZ5GElfeGFF1abbrpptdpqqwWbAVr6pV212tDk1FZK2nx5mDTtl2bNEz1uM7UYVh21QRa5JOlBjnEXXHBBaHZzzjnnhD4V9Bw98sgjqyc/+cnV3XffXX97MTmntlKwgaBz+rDJ7Td2C1u6dGmR3YPpDiV1NCpkkUuSHtSsl07pGDHVQUyif8sXv/jF0IV8vfXWq7bYYovQSxROO+20av/99w92Boxc6Dv6+9//fjmnNsCLBce49ddfP5g6YaAEOae2XXfdtVp55ZVD3FtvvbWvIxzgLRMNolLY/+tf//rwfvqscoz4u9T3i3DiSMdx0LM1jjyuv/768N3QiZ2c11133Z7JFY2W2R/73WabbUKP1djb1Uw9SupoVMgilyTdJB64sLEPCj7HLbfcEgorTmPoqkUzZKChMI2C8WCBAw88sOe6lloe0Cz5uc99boiHVwwFfPrpp4fXck5tdGtHgKDJEY6u6jfddFP4OeVLX/pS6HTOSIORBE2Mf/CDH4zZLzBNO+KII8L7IIoHjZxpthw7r2P2hGgBHefpKo+/zG233RYaL+c8fM3kp6SORoUsci7pUsc4hIF9NJlbMwKJNgYQ3eEQAsSD6UkEQXjjG98Yfk7Fg76fjEYidFOPPrY5p7a0yJsc4XLQoZ0u7sRK86uLB/HT6VUqHnRdj2BFgUgA1hBR/ADRtHhMXXJ1tCKQRS5JumnkwTCdfTQtjjKkj4IQwR2Oz9StDNLnqXggPhRpdIx7xjOeEaY4kLM8qBd5zhGuCUYfiBTCOW/evOVGNEC86CkDqXikFhLpc6ZYmFlF6q5yZmpRUkejQha5JOkm8YCXvOQlPV+UlGOOOSZ0DGfkgbN9hAIkLlOIUvGgsFLnuZRS8YjUHeFKwKNm++23Dzaa9f3W45eIBw5yOMlFDjroIIvHFKakjkaFLHJJ0oPE45JLLgnmTwzDudPA46ijjgrdwhEICokrdywwzJOY70OTeKRObbi8MdKIaxasm8TbpfXijc+ZFrHmwOioyREut+ZBPogiaxk8WNhl0TXdL9Tjl4gHnr2MflhLYZ0GQyiLx9SlpI5GhSzysJLmbzI233zzUDgUEwLAQmCE4T8jCe44bLvttr07HU3ikTq1AUN77tbg6IY/btx/vXjT50wP4ppEzhEud7eFEcYuu+wSPoMQMuXBrhLifq+++url4peIBwK00047BSsGRmU46R1wwAG995qpxbDqqA2yyMqkpzvp34Iwwlm4cGHyqplKKOtIFlmZ9HSGaRijMNZ/GM3gw3v++efX32amCMo6kkVWJj2d4W9VDj744HDXiLtH6d+JmKmHso5kkZVJG9MVlHUki6xM2piuoKwjWWRl0sZ0BWUdySIrkzamKyjrSBZZmbQxXUFZR7LIyqSN6QrKOpJFViZtTFdQ1pEssjJpY7qCso5kkZVJG9MVlHUki6xM2piuoKwjWWRl0sZ0BWUdySIrkzamKyjrSBZZmbQxXUFZR7LIyqSN6QrKOpJFHlbS3/jGN6pZs2YFxzi6l9Ml67rrrqu/Tc6yZcuqGTNmhGbGTdAvNdcWkJaKdoQzKcOqozbIIpckPcgxjhaDFBQ9RbE1oLBo64cZ0o033lh/+8igR8YgaHO4aNGiYOTUZBcxXvEoiW26S0kdjQpZ5JKkBzVAxoUNP5Q68+fPD/1B6e9J05sIncJnz57de04XcwQq5/wGeKfQbQvHOHp+3n777WE73cz33Xff4MyG8RNOdDQnzrHxxhuH/qkc23nnndfbjpDsvffeoV8px7ZgwYKeeODyRo7ERng4TsTj2muvDXHpuRo9ZHLHefPNN4emz+yHHqrYUTRtN1OLkjoaFbLIJUk3iQedv9lHPyOlyy67LEwRgEa/WDMCVg08HnjggdA9i/cwnaCRcD/nN9zkKFgaCAPWlnRCB5oj8/nYUJmWfrT46wcNj6NoXXHFFWFqFVm8eHFo4IyDG82JN9hggyAejCjobB5tInkfJliIx5IlS0Kz4yhCTceJPWZsssz+d9999/BvbruZWpTU0aiQRc4lXeoYhy/LqquuOmZbJB0FYPr0hS98IYgEV1rWHLBupKBT86Z+zm/YJMyZM6e3HYEgJoXNNIRO6iXQYDiOkBAtrvbRS5cR0qmnntp7L93MEQ9yIO9IdLuL3dGxnIiNjJuOE5/dLbfcMnRbTxsf57abqUWujlYEssglSTeNPO66666wj1iEKYw8ops86yFvfetbg+csRYw4nXTSScF/5cgjjwzvqVsYxOd4pXCFj25xPLjCc6VHPDCMHkQcQWDlEIUQ4yamPcBUKfrAAL4qiMeVV14Z4qXgdhfFg31Gmo6TEc0JJ5wQpjR8J1GoctvN1KKkjkaFLHJJ0k3iAc973vP6urnR4BeXecAIe9NNNw1m0QgIV3Q8at/whjdU3/72t8N7cuKBLePcuXN721Pqvi85LrroouVGKIxyWLOAvfbaa0wOHCfiwYJvOvJgNJGOPFJflqbjTMGaks+xZlKy3Ux+SupoVMgilyQ9SDxYJOTOCqMJbBkZhTCqwD3+N7/5Te9966+/fvWiF70omCkxbeA5zvesa0BOPNgf6xrRD/aaa64JC5pQF4/cmgfi0G9Rl9EBBtQIB9MprCg5PqY0iAfPiR2d6xhdMBXrJx5Nx4mxddwHUx/WVHCqy203U4uSOhoVssjDSpoCYDHy0Y9+dBiqM6pgPSQFu0Yc3yIsWDLfj+TEA+JdDIQMG0oc7KEuHv3utiBorE3EOx8phx56aBhlYB252267VTNnzqw22WSTsOaxzz77hPcwUsIxDqFhcZOpCndJ6uIBueNESFjbYT/cJo7evrntZmoxrDpqgyyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRJ5o0Vgm0+Ktz0003hUbB9957b2gKXDdJasOw9kPnMDqzRyuI6crHPvax0PUt9nHNcemll2a/95133jn0bm0D3fRpuxg7v0224xkPE62jiSCLXJJ0k2Mc/Tpp8XfPPfeM2f6ud72r1/x46dKlQ7EVGMZ+6KJOK0Q6lk93gyWKNbZabIKWkldddVV9c/hd0OKxyXlvEPScTcVjMh3PeCipo1Ehi1yS9KAGyJtttln18Y9/fMw2+nF+5zvfCT+nIwZ8SnBTo/kxhkcPPvhgOGnSPqS8Fs2fOCEYJWAqFfdz2mmnhX6oWC7QkZ0eoHRnB3qLvvSlLw3HjJMco6LUUoEeo3jIYCq14YYb9rYDPVfx26UvKc2Q8Yxp2s7oih6s5MMxYNMAORe43PZ+fVcju+66a/We97wnXFHpc3rssccGWwgc6oh7/fXXh/fx/dATlu+d951++um9fdBX9sQTT6y23nrr8Jlo71AvVpo7c2zsg98pRlp8DosKtnERwd3vHe94R+jjSkf69Eqfc/yjmPld0QN2m222CX1aY9wm8VAfz3goqaNRIYtckvQg8cAIihMzgpkTto1xlBCLnkbCdEvHEY0RAIXBSc5JwckA+MDQgDjaN9LZnEbC6X5oekxzZPxQ4MADD+yJDeZNNC8GxIsTLR3G7rHHHmHYC5w4NCAGurnTuPj8888Pz+n+jlVDbjtstNFGPRMs9sMJjBjmXOBy23Md34H3IAocB2KFiVQUQ4SE3OHwww8PggqIFIbjt912W3iOdQQjQaAJNN/jLbfcMqZY6RiPSDPNBGKcffbZ4WdENl7paRKNs979998fnqfFmnP8o2s9oolHDcfEuRGtPHPiMRmOZzyU1NGokEXOJV3qGAdMWdLRBSd0PFkhvrbffvuFK0eEUUAUCX6BTEso0qOPPjrMe7E94IRhjSLdD+LB0DWCADGaALqfIzgRrrTxZLr77rvDFT+KGjm+5S1vCT8zckn9WYjNiZTbTvFxPOk0CgvN733ve1kXuNz2JhCPs846K/yM4PL74nuCz372s73vgUKIBQRMzeJIiONPnfgoNszJ02Lls1ypKay6dWharBwPU75IvVj7Of5hL5GOhDg/+hXrZDue8ZCroxWBLHJJ0oNGHsAwEGHgylu3UIhFzy+W16KbGubX0WqSk4aRCa5yF154YRADigzzaYaj6X7qdgvp84c+9KFjFtMYssaTCSFiJBKFEPe4Jz3pSUEQGDkgYHVy2/FW4SSLufBgXxRlzgUut70JiiOddvH74gSHc889N3yn8OMf/ziMUDDyZirHOlS0fSBXRiMR3sdFoD5NoND23HPPULTbbbddb3pWL9b0AlIv1n7WGenvAJg+9CvWyXY846GkjkaFLHJJ0iXicckll4TRwgUXXBCubCmx6PkF9XOWg0996lPVUUcdFU5+RghccSguYsdiKREPCjj1i2H9JJ4oTIfqC21cub/61a+GEQZrA3FEgAiyFpHbznGkI5IcORe43PY6peLBSOOcc87pvY/vLRUPxCXCmhDrBfVijSCmjP5YT4B6sfK5SEmxMlWMoyc46KCD+hbrZDue8VBSR6NCFrkk6RLxoLjWWGONsI6QnsQQi555PSONOI/FpzYWBtMAhCPepmPqwSJZKkQl4sFVlbUAYATDFZiTCdvIpz71qWHtIIWpC072bOekjMfDomxc8+i3HXC/+/znPx9+Zq2GURInX84FLrd90JpHiXhQGFEgyJdRVYyFeGBuBawvcQudtY+0WClGvod4pwLT7rhv1pzivtoUKwu8jBw4R1h7YG2oX7FOtuMZDyV1NCpkkYeZNFeH+LcdKel6CENErpKsPVCEcVEPEKn58+eHn/nFYmF5zDHH9F4vEQ9c3JgWrLvuuuGKwtWKtQFGNXFxMYWFOQSGefWSJUvC6IQpRXpXJbedBUzWbDhu4kU7y5wLXG57092WUvFgSsY0EKFjxMbvgpENoox4UDB4CiPwceExLVa+78MOOyxM0fjdINw33HBDeA0xRozOOOOMVsXKojCiTuwdd9wxLGgfcMAB4T058ZgMxzMehllH40UWWZn0qEgXI1mgZAQynUE8uMLWyU0TRkH6O0E0Fy5cGH7OiceoKTme8aCsI1lkZdKjgDszLN4y3fjlL38ZCife0p2u8B2ki8iRFVWsTMkYmXGblOJMb30rxKP0eMaDso5kkZVJjwKc6pnPMoTnD4w+97nP1d8y7WgSj5I/B58o3GI++OCDw++Eu1JHHHFEEPf6n4NPtuMZD8o6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFnkYSc+ePTt0WOe/MqeP2A6wTvwv4rTgiy0OaQ5Mx6869Nsc9X/RngqU/nf1tOtYnbSj23ip/3f1YRxP2vVrvNSPR80w6qgtssglSTc5xgHiMZ6TIIoHgkEbQKBTduwNGqGR8fbbb1/NnTu3+uEPfzjmtelGSaMcelLQKrEfdM6aqOPeeBv3DDoelbvbKCipo1Ehi1yS9KAGyIPE4+KLLw6NefBQWbRoUbhipSMPep7ST5Iu5dtuu23vczRpoUExTYbpR5ry5S9/OeyPPp3YWj7wwAON2/GIoWMUr9G3kgbAgCVBPxe33PamfqPkRVducqDJDF3ZaayLFQKNnGPv0djLlD6mmGBddtllYTsNjHlOs2K+U/qRXn755eG1tFjp4E5ufJ44dE7D5wQTrZVXXjl8Dh/euptaHHngMseIgT6nW2yxReiqxe8ISt3UhnE8ceQxjONRU1JHo0IWuSTpiYgHXZs4WeLJsHjx4jDFqU9b8DtJRx58jpMRQynaxdEINwoBTZNnzJgRCpz37bLLLsEPJbedNoQUNs2R4eSTTw6duSHn4pbbzgmb63ROg10c5YDO8Li2xQa8OOrRsBjouk43cEAYETS47rrrQrFhYwH42FBIkBYr3xXd0riycwWn9SIufYzi8KWJ1N3UonjwPVB0sQM5x0WDYSh1UxvG8UTxGMbxqCmpo1Ehi5xLejyOcYgHZkucKOmDNv9cqVN/E64kxBwkHjQtxjoyggkUowrA4yV1jENcEJbcdgp1zpw5ve2cdNg2IjA5F7fc9iYQj+gZg9Ulc/II3bmjyRPFQ2xgBMR3B4hH+l1RMIgJRZgWK34sjKwYTaXD/nqx1t3UUvGg+3gEm4tobFXqpjaM40nFY6LHoyZXRysCWeSSpCcy8sDykCFnCvYMg8QDpzBO9iha/BxNf7ARiPaSKbntGCbzeY4jPhiJMCLJubjltjeBeDDqAaYb0Q0POOk5DuDKyhU4mnTHAkA8+n1XGETV1xj4vrB94LuZN29eEMp+xZqKfSoeFHskfV7qpjaM40nFY6LHo6akjkaFLHJJ0hMRD8yW0qspv/BBIw8W0ph+MJeOUMwUMeZKjDBYt4jgMMecOredY2PRdRA5F7fc9jol4oEFAtMZvhfge0jFA6+aaEzFqInvatmyZcsVa4TvikXlU045pW+x8rlIiXiUuqkN43hKxKP0eNSU1NGokEUuSXoi4oFVIEIQ57MUEL/wungwv581a1YoHNZF0ilLhFEFQ1gKEEHCBIjhPycYo4TcdjqqcwyIALBguWDBgvBzzsUtt33Qmscg8aAwsMREGDhG/EKYmjCVQTz4bhBS4DtlsRHSYuU7YOGQ74rH/vvvH/bNmgyfv++++8L76sVaIh6lbmrDOJ4S8Sg9HjUldTQqZJGHkXTu7zy4AgHCgEsaQ3IWITkBKLJUPJhCMM/lpGE4HxcXU7h7EQuS+/wsJs6cOXPMXZXc9ni3hXjYFUYf15yLW257092WEvEARJDvYqONNqq++93vhgVBFggRD4798MMPD656LKSy8AhpsXJFZzGY74vjY4pHIQHDfI6DtZp6sZaIR6mb2jCOp0Q8So9HzTDqqC2yyMqkzVgQD24N9yM3TRgFJW5qk+141CjrSBZZmbQZC+KRmyKuqGItdVObbMejRllHssjKpM1YBolHyZ+DT5RSN7XJdjxqlHUki6xM2piuoKwjWWRl0sZ0BWUdySIrkzamKyjrSBZZmbQxXUFZR7LIyqSN6QrKOpJF5v8jkLgffvjR/kEdqZCJhzFmamPxMMa0wuJhjGmFxcMY0wqLhzGmFRYPY0wrLB7GmFZYPIwxrbB4GGNaYfEwxrTC4mGMaYXFwxjTCouHMaYVFg9jTCssHsaYVlg8jDGtsHgYY1ph8TDGtMLiYYxphcXDGNMKi4cxphUWD2NMKywexphWWDyMMa2weBhjWmHxMMa0wuJhjGmFxcMY0wqLhzGmFRYPY0wrLB7GmFZYPIwxrbB4GGNa8T+Jg9FLWZvRrAAAAABJRU5ErkJggg=="}}]); \ No newline at end of file diff --git a/assets/js/8a56e0ba.abfcd29c.js b/assets/js/8a56e0ba.abfcd29c.js deleted file mode 100644 index e79634c..0000000 --- a/assets/js/8a56e0ba.abfcd29c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[8957],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var o=r(7294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function n(e){for(var t=1;t=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var l=o.createContext({}),c=function(e){var t=o.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):n(n({},t),e)),r},d=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},u="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},f=o.forwardRef((function(e,t){var r=e.components,i=e.mdxType,s=e.originalType,l=e.parentName,d=a(e,["components","mdxType","originalType","parentName"]),u=c(r),f=i,h=u["".concat(l,".").concat(f)]||u[f]||p[f]||s;return r?o.createElement(h,n(n({ref:t},d),{},{components:r})):o.createElement(h,n({ref:t},d))}));function h(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var s=r.length,n=new Array(s);n[0]=f;var a={};for(var l in t)hasOwnProperty.call(t,l)&&(a[l]=t[l]);a.originalType=e,a[u]="string"==typeof e?e:i,n[1]=a;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>n,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var o=r(7462),i=(r(7294),r(3905));const s={sidebar_position:8},n="filetree Module",a={unversionedId:"protocol/modules/filetree",id:"protocol/modules/filetree",title:"filetree Module",description:"Overview",source:"@site/docs/protocol/modules/filetree.md",sourceDirName:"protocol/modules",slug:"/protocol/modules/filetree",permalink:"/docs/protocol/modules/filetree",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/protocol/modules/filetree.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8},sidebar:"tutorialSidebar",previous:{title:"dsig Module",permalink:"/docs/protocol/modules/dsig"},next:{title:"Jackal Proof-of-Persistence",permalink:"/docs/protocol/p-o-p"}},l={},c=[{value:"Overview",id:"overview",level:2},{value:"Folder Abstraction",id:"folder-abstraction",level:2},{value:"File Entry Structure",id:"file-entry-structure",level:2},{value:"Encrypted Viewing Access",id:"encrypted-viewing-access",level:2}],d={toc:c},u="wrapper";function p(e){let{components:t,...s}=e;return(0,i.kt)(u,(0,o.Z)({},d,s,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"filetree-module"},"filetree Module"),(0,i.kt)("h2",{id:"overview"},"Overview"),(0,i.kt)("p",null,"The File Tree module is responsible for keeping records of a user's files and organizing them in a way that is accessible. When a user uploads a file using the Storage module, the file is only accessible from the File ID (FID) which makes the process clunky and obtuse to remember every file uploaded to Jackal. Furthermore, every single upload would be required to be public, or the user would need to keep track of every symmetric key used to encrypt the files and manually map them to the FIDs. The solution to this is a tree structure storing each file as an entry in the tree. Organizing this structure is also trivial as we can assign children to pseudo files that we call folders. Finally to keep track of encryption keys, the protocol maps every file to its respective key."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"Protocol Overview",src:r(96).Z,width:"542",height:"842"})),(0,i.kt)("h2",{id:"folder-abstraction"},"Folder Abstraction"),(0,i.kt)("p",null,"These, of course, are all abstractions of what\u2019s actually under the hood. The File Tree module doesn\u2019t actually handle any of the folder logic, the system believes it is storing files that act as metadata stores, which then update to reflect changes in folders. This gives the user experience the feeling that folders and files are separate entities in the tree, but in reality they are identical."),(0,i.kt)("h2",{id:"file-entry-structure"},"File Entry Structure"),(0,i.kt)("p",null,"Storing file entries on-chain is a hurdle being that the chain itself is public. This requires the use of client-side encryption before uploading data to the chain itself. The main component of a file is location (Address), allowing users to query the rest of the data from the file. You can think of the location as a key in a traditional key-value store or a path in bucket-based storage. The address is hashed using SHA256 to ensure it is impossible to retrieve the plain-text representation of the file name, while still being able to query the file using its given name. "),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"Protocol Overview",src:r(4965).Z,width:"271",height:"220"})),(0,i.kt)("p",null,"The second most important data point in a file is the content of the file, this field is extremely versatile as it can store any string. Traditionally this is used to store a JSON list of FIDs to point to a file on the Storage Module, however, the protocol can also theoretically use it to store short bits of text like encrypted passwords for a private password manager. The owner tag is a hashed version of the owner hiding what address owns each file, this field can be changed to reflect the transferral of ownership. When making changes to the file such as deletion, movement or adding/removing viewers/editors, the owner field is consulted to determine permissions. The same applies for edit access, editors can update the contents but nothing else. "),(0,i.kt)("h2",{id:"encrypted-viewing-access"},"Encrypted Viewing Access"),(0,i.kt)("p",null,"For users to view files, they need access to the symmetric keys used to encrypt the files. To do this, the protocol has a map of hashed addresses with each user\u2019s respective version of the symmetric key encrypted with that address's corresponding public key. The protocol can then store that map in the file entry to act as an encryption key discovery layer. The addresses in this viewing list are only able to access files and decrypt the data in their client, they have no privileges over the modification of the file entry in any way."))}p.isMDXComponent=!0},96:(e,t,r)=>{r.d(t,{Z:()=>o});const o=r.p+"assets/images/filetree1-e947ab740b90156234b2fadb69a00533.png"},4965:(e,t,r)=>{r.d(t,{Z:()=>o});const o="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQ8AAADcCAYAAABu8iQLAAAenUlEQVR4Xu2dCbAcVRWGQVBxVzQaFwRBEERLUYFIkF0IiwbZFDcWSYDSgCABFQslyqaArHHDrVzADRcEERQsFClQBKOguCEoS9CgICK4tfVd607d15nbc1+/mfzv9fu/qqm86Znp02den7/vvf1y/pUqY4xpwUr1DcYYU4LFwxjTCouHMaYVFg9jTCssHsaYVlg8jDGtsHgYY1ph8TDGtMLiYYxphcXDGNMKi4cxphUWD2NMKywexphWWDyMMa2weBhjWmHxMMa0wuJhjGmFxcMY0wqLhzGmFRYPY0wrLB7GmFZYPIwxrbB4GGNaYfEwxrTC4mGMaYXFwxjTCouHMaYVFg9jTCssHsaYVsjEY6uttqpWWmklP/zwYwIP6kiFTDxI3BgzMZR1JIusTNqYrqCsI1lkZdLGdAVlHckiK5M2piso60gWWZm0MV1BWUeyyMqkjekKyjqSRVYmbUxXUNaRLLIyaWO6grKOZJGVSZuqmj17dvWQhzykWmWVVcY87rzzzuoDH/hA9aY3vSm873GPe1z1hz/8ofZpM1lQ1pEssjJp83/x+MxnPlPfHPj73/9e3XPPPeFni8fkRllHssjKpE2zeORGHt/85jer5z//+dVznvOcascdd6xuv/329GNGgLKOZJGVSZvxi8cdd9xRPf7xj69+9rOfhe0nn3xy9apXvSr9mBGgrCNZZGXS5v/igTA85SlP6T3WXnvt8Fo/8fj0pz9dzZkzp/f5v/3tb9Wqq65a/fvf/+5tMyseZR3JIiuTNv8Xj7POOiuMKOJj6dKl4bV+4sG2Rz3qUdWaa67ZezAS4XNGh7KOZJGVSZvxT1t479y5c2vvNGqUdSSLrEzajF88uIU7Y8aM6le/+lXYfs0111QLFixIP2YEKOtIFlmZtBm/eEC827LOOutUL3zhC6vvf//76ceMAGUdySIrkzamKyjrSBZZmbQxXUFZR7LIyqSN6QrKOpJFViZtTFdQ1pEssjJpY7qCso5kkZVJG9MVlHUki6xM2piuoKwjWWRl0sZ0BWUdySKvtdZaIXE//PCj/YM6UiETDxI3xkwMZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZ5GElvWzZstAeb968efWXxvDBD36w1x2rzmQ1Nrr00kuzx5V2+zLTl2HVURtkkUuS/spXvlLftBxnnnlmtWjRomAb8I9//KP+co/xisdksBR45StfWV111VX1zeHYUlc3M30pqaNRIYtckjS9Mgex8cYbV7/97W+r+fPnV+edd15vO0Ky9957V8985jNDv06a9UbxuPjii6tnP/vZwfkM4cFCAPG49tprqxe84AXV6173umqrrbYK7825pN18883Vy172srCfZz3rWdXxxx/fuP0Xv/hF8ILtB6MI3o8AbrbZZiGfE088sXr4wx8etiGip5xySrXvvvuG43vnO985ZuTB8X/4wx+uXv7yl4fv7Ljjjuvt+4QTTqjWWGON6sUvfnH1kY98JFgmmO5QUkejQha5JOlB4nHDDTcEYYArrrii2mmnnXqvLV68uNp8882rf/3rX9Vf//rXaoMNNgjFxlX7aU97WhCQ+D4MnxGPJUuWBG+SKEJNLmlvfvObq/e+973hZ/a/++67h39z2zFJ+vrXvx62p/zpT3+qnvCEJ1T33ntveP7JT36yOvvss8PPG264YW/kccYZZ4TpGcICqXg88YlPDIICf/zjH6uHPexhYWRy4403VquvvnrI48EHHwzfz6Dv1EwtSupoVMgi55L+xCc+EaYRPCjq+PNHP/rR+lurhQsXVh/60IfCz//973/D1RuLAHj1q19dnXrqqb33vv3tbw/FxgiA/UUYoXAsiAci8YhHPKL6z3/+E15rckl73/veV2255ZbV1Vdf3Xs/5LbnuP/++4NAkcef//znMa+l4sH0bIcddui9VhePn/zkJ73XEKPf/e53YTSSWkKee+65Fo+OkaujFYEscknSTSd6HEE89rGP7QkMw3yG98AQnqt45P3vf38otiuvvHK5ofsjH/nInniwz0iTSxojGqYETGmwaoxCldveBIW/5557hn1vt912ofChLh6vfe1re5+pi8evf/3r3mvxOdOXdJ2H3Ju+UzP1KKmjUSGLXJJ004l+0UUXjbkSA0XImgDstddeYZE08ra3vS0UEkP5dOTBaCIdeTz96U/vvVbqkoYREp9jzaRke45//vOf1dFHH1294hWvCM/r4sFaTKREPLCT3GOPPXrbmY41fadm6lFSR6NCFrkk6aYTHXGIU5YURgc//elPg3CwcElBsq7AlIZi4zlrB9/61rfC+ylCFjL7iUeTS9prXvOa3j6Y+rCm8qMf/Si7PbfmgTgwtYh3ipgq7bzzzuFnjJXivtqIB8fL8TMdIm9GNU3fqZl6lNTRqJBFnkjSf/nLX8LaRLzzkXLooYeGUcZ9991X7bbbbtXMmTOrTTbZJKx57LPPPuE9X/va10ITFYSGxU2mKtwlqYsH5FzSKEzuYLAf7oi8+93vbtyeu9vCushhhx0W7gpxd4a7LSwEw7HHHhumZSyWthEP4Lsgv1mzZoWFWETUdIeJ1NFEkUVWJj2dSBdtL7/88nBr23QHZR3JIiuTni7cdddd1WMe85jq5z//eXi+3377VYccckjtXWYqo6wjWWRl0tMJ/jCMKRR/KMbib/12sJnaKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZ5GElfeGFF1abbrpptdpqqwWbAVr6pV212tDk1FZK2nx5mDTtl2bNEz1uM7UYVh21QRa5JOlBjnEXXHBBaHZzzjnnhD4V9Bw98sgjqyc/+cnV3XffXX97MTmntlKwgaBz+rDJ7Td2C1u6dGmR3YPpDiV1NCpkkUuSHtSsl07pGDHVQUyif8sXv/jF0IV8vfXWq7bYYovQSxROO+20av/99w92Boxc6Dv6+9//fjmnNsCLBce49ddfP5g6YaAEOae2XXfdtVp55ZVD3FtvvbWvIxzgLRMNolLY/+tf//rwfvqscoz4u9T3i3DiSMdx0LM1jjyuv/768N3QiZ2c11133Z7JFY2W2R/73WabbUKP1djb1Uw9SupoVMgilyTdJB64sLEPCj7HLbfcEgorTmPoqkUzZKChMI2C8WCBAw88sOe6lloe0Cz5uc99boiHVwwFfPrpp4fXck5tdGtHgKDJEY6u6jfddFP4OeVLX/pS6HTOSIORBE2Mf/CDH4zZLzBNO+KII8L7IIoHjZxpthw7r2P2hGgBHefpKo+/zG233RYaL+c8fM3kp6SORoUsci7pUsc4hIF9NJlbMwKJNgYQ3eEQAsSD6UkEQXjjG98Yfk7Fg76fjEYidFOPPrY5p7a0yJsc4XLQoZ0u7sRK86uLB/HT6VUqHnRdj2BFgUgA1hBR/ADRtHhMXXJ1tCKQRS5JumnkwTCdfTQtjjKkj4IQwR2Oz9StDNLnqXggPhRpdIx7xjOeEaY4kLM8qBd5zhGuCUYfiBTCOW/evOVGNEC86CkDqXikFhLpc6ZYmFlF6q5yZmpRUkejQha5JOkm8YCXvOQlPV+UlGOOOSZ0DGfkgbN9hAIkLlOIUvGgsFLnuZRS8YjUHeFKwKNm++23Dzaa9f3W45eIBw5yOMlFDjroIIvHFKakjkaFLHJJ0oPE45JLLgnmTwzDudPA46ijjgrdwhEICokrdywwzJOY70OTeKRObbi8MdKIaxasm8TbpfXijc+ZFrHmwOioyREut+ZBPogiaxk8WNhl0TXdL9Tjl4gHnr2MflhLYZ0GQyiLx9SlpI5GhSzysJLmbzI233zzUDgUEwLAQmCE4T8jCe44bLvttr07HU3ikTq1AUN77tbg6IY/btx/vXjT50wP4ppEzhEud7eFEcYuu+wSPoMQMuXBrhLifq+++url4peIBwK00047BSsGRmU46R1wwAG995qpxbDqqA2yyMqkpzvp34Iwwlm4cGHyqplKKOtIFlmZ9HSGaRijMNZ/GM3gw3v++efX32amCMo6kkVWJj2d4W9VDj744HDXiLtH6d+JmKmHso5kkZVJG9MVlHUki6xM2piuoKwjWWRl0sZ0BWUdySIrkzamKyjrSBZZmbQxXUFZR7LIyqSN6QrKOpJFViZtTFdQ1pEssjJpY7qCso5kkZVJG9MVlHUki6xM2piuoKwjWWRl0sZ0BWUdySIrkzamKyjrSBZZmbQxXUFZR7LIyqSN6QrKOpJFHlbS3/jGN6pZs2YFxzi6l9Ml67rrrqu/Tc6yZcuqGTNmhGbGTdAvNdcWkJaKdoQzKcOqozbIIpckPcgxjhaDFBQ9RbE1oLBo64cZ0o033lh/+8igR8YgaHO4aNGiYOTUZBcxXvEoiW26S0kdjQpZ5JKkBzVAxoUNP5Q68+fPD/1B6e9J05sIncJnz57de04XcwQq5/wGeKfQbQvHOHp+3n777WE73cz33Xff4MyG8RNOdDQnzrHxxhuH/qkc23nnndfbjpDsvffeoV8px7ZgwYKeeODyRo7ERng4TsTj2muvDXHpuRo9ZHLHefPNN4emz+yHHqrYUTRtN1OLkjoaFbLIJUk3iQedv9lHPyOlyy67LEwRgEa/WDMCVg08HnjggdA9i/cwnaCRcD/nN9zkKFgaCAPWlnRCB5oj8/nYUJmWfrT46wcNj6NoXXHFFWFqFVm8eHFo4IyDG82JN9hggyAejCjobB5tInkfJliIx5IlS0Kz4yhCTceJPWZsssz+d9999/BvbruZWpTU0aiQRc4lXeoYhy/LqquuOmZbJB0FYPr0hS98IYgEV1rWHLBupKBT86Z+zm/YJMyZM6e3HYEgJoXNNIRO6iXQYDiOkBAtrvbRS5cR0qmnntp7L93MEQ9yIO9IdLuL3dGxnIiNjJuOE5/dLbfcMnRbTxsf57abqUWujlYEssglSTeNPO66666wj1iEKYw8ops86yFvfetbg+csRYw4nXTSScF/5cgjjwzvqVsYxOd4pXCFj25xPLjCc6VHPDCMHkQcQWDlEIUQ4yamPcBUKfrAAL4qiMeVV14Z4qXgdhfFg31Gmo6TEc0JJ5wQpjR8J1GoctvN1KKkjkaFLHJJ0k3iAc973vP6urnR4BeXecAIe9NNNw1m0QgIV3Q8at/whjdU3/72t8N7cuKBLePcuXN721Pqvi85LrroouVGKIxyWLOAvfbaa0wOHCfiwYJvOvJgNJGOPFJflqbjTMGaks+xZlKy3Ux+SupoVMgilyQ9SDxYJOTOCqMJbBkZhTCqwD3+N7/5Te9966+/fvWiF70omCkxbeA5zvesa0BOPNgf6xrRD/aaa64JC5pQF4/cmgfi0G9Rl9EBBtQIB9MprCg5PqY0iAfPiR2d6xhdMBXrJx5Nx4mxddwHUx/WVHCqy203U4uSOhoVssjDSpoCYDHy0Y9+dBiqM6pgPSQFu0Yc3yIsWDLfj+TEA+JdDIQMG0oc7KEuHv3utiBorE3EOx8phx56aBhlYB252267VTNnzqw22WSTsOaxzz77hPcwUsIxDqFhcZOpCndJ6uIBueNESFjbYT/cJo7evrntZmoxrDpqgyyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRJ5o0Vgm0+Ktz0003hUbB9957b2gKXDdJasOw9kPnMDqzRyuI6crHPvax0PUt9nHNcemll2a/95133jn0bm0D3fRpuxg7v0224xkPE62jiSCLXJJ0k2Mc/Tpp8XfPPfeM2f6ud72r1/x46dKlQ7EVGMZ+6KJOK0Q6lk93gyWKNbZabIKWkldddVV9c/hd0OKxyXlvEPScTcVjMh3PeCipo1Ehi1yS9KAGyJtttln18Y9/fMw2+nF+5zvfCT+nIwZ8SnBTo/kxhkcPPvhgOGnSPqS8Fs2fOCEYJWAqFfdz2mmnhX6oWC7QkZ0eoHRnB3qLvvSlLw3HjJMco6LUUoEeo3jIYCq14YYb9rYDPVfx26UvKc2Q8Yxp2s7oih6s5MMxYNMAORe43PZ+fVcju+66a/We97wnXFHpc3rssccGWwgc6oh7/fXXh/fx/dATlu+d951++um9fdBX9sQTT6y23nrr8Jlo71AvVpo7c2zsg98pRlp8DosKtnERwd3vHe94R+jjSkf69Eqfc/yjmPld0QN2m222CX1aY9wm8VAfz3goqaNRIYtckvQg8cAIihMzgpkTto1xlBCLnkbCdEvHEY0RAIXBSc5JwckA+MDQgDjaN9LZnEbC6X5oekxzZPxQ4MADD+yJDeZNNC8GxIsTLR3G7rHHHmHYC5w4NCAGurnTuPj8888Pz+n+jlVDbjtstNFGPRMs9sMJjBjmXOBy23Md34H3IAocB2KFiVQUQ4SE3OHwww8PggqIFIbjt912W3iOdQQjQaAJNN/jLbfcMqZY6RiPSDPNBGKcffbZ4WdENl7paRKNs979998fnqfFmnP8o2s9oolHDcfEuRGtPHPiMRmOZzyU1NGokEXOJV3qGAdMWdLRBSd0PFkhvrbffvuFK0eEUUAUCX6BTEso0qOPPjrMe7E94IRhjSLdD+LB0DWCADGaALqfIzgRrrTxZLr77rvDFT+KGjm+5S1vCT8zckn9WYjNiZTbTvFxPOk0CgvN733ve1kXuNz2JhCPs846K/yM4PL74nuCz372s73vgUKIBQRMzeJIiONPnfgoNszJ02Lls1ypKay6dWharBwPU75IvVj7Of5hL5GOhDg/+hXrZDue8ZCroxWBLHJJ0oNGHsAwEGHgylu3UIhFzy+W16KbGubX0WqSk4aRCa5yF154YRADigzzaYaj6X7qdgvp84c+9KFjFtMYssaTCSFiJBKFEPe4Jz3pSUEQGDkgYHVy2/FW4SSLufBgXxRlzgUut70JiiOddvH74gSHc889N3yn8OMf/ziMUDDyZirHOlS0fSBXRiMR3sdFoD5NoND23HPPULTbbbddb3pWL9b0AlIv1n7WGenvAJg+9CvWyXY846GkjkaFLHJJ0iXicckll4TRwgUXXBCubCmx6PkF9XOWg0996lPVUUcdFU5+RghccSguYsdiKREPCjj1i2H9JJ4oTIfqC21cub/61a+GEQZrA3FEgAiyFpHbznGkI5IcORe43PY6peLBSOOcc87pvY/vLRUPxCXCmhDrBfVijSCmjP5YT4B6sfK5SEmxMlWMoyc46KCD+hbrZDue8VBSR6NCFrkk6RLxoLjWWGONsI6QnsQQi555PSONOI/FpzYWBtMAhCPepmPqwSJZKkQl4sFVlbUAYATDFZiTCdvIpz71qWHtIIWpC072bOekjMfDomxc8+i3HXC/+/znPx9+Zq2GURInX84FLrd90JpHiXhQGFEgyJdRVYyFeGBuBawvcQudtY+0WClGvod4pwLT7rhv1pzivtoUKwu8jBw4R1h7YG2oX7FOtuMZDyV1NCpkkYeZNFeH+LcdKel6CENErpKsPVCEcVEPEKn58+eHn/nFYmF5zDHH9F4vEQ9c3JgWrLvuuuGKwtWKtQFGNXFxMYWFOQSGefWSJUvC6IQpRXpXJbedBUzWbDhu4kU7y5wLXG57092WUvFgSsY0EKFjxMbvgpENoox4UDB4CiPwceExLVa+78MOOyxM0fjdINw33HBDeA0xRozOOOOMVsXKojCiTuwdd9wxLGgfcMAB4T058ZgMxzMehllH40UWWZn0qEgXI1mgZAQynUE8uMLWyU0TRkH6O0E0Fy5cGH7OiceoKTme8aCsI1lkZdKjgDszLN4y3fjlL38ZCife0p2u8B2ki8iRFVWsTMkYmXGblOJMb30rxKP0eMaDso5kkZVJjwKc6pnPMoTnD4w+97nP1d8y7WgSj5I/B58o3GI++OCDw++Eu1JHHHFEEPf6n4NPtuMZD8o6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFlmZtDFdQVlHssjKpI3pCso6kkVWJm1MV1DWkSyyMmljuoKyjmSRlUkb0xWUdSSLrEzamK6grCNZZGXSxnQFZR3JIiuTNqYrKOtIFnkYSc+ePTt0WOe/MqeP2A6wTvwv4rTgiy0OaQ5Mx6869Nsc9X/RngqU/nf1tOtYnbSj23ip/3f1YRxP2vVrvNSPR80w6qgtssglSTc5xgHiMZ6TIIoHgkEbQKBTduwNGqGR8fbbb1/NnTu3+uEPfzjmtelGSaMcelLQKrEfdM6aqOPeeBv3DDoelbvbKCipo1Ehi1yS9KAGyIPE4+KLLw6NefBQWbRoUbhipSMPep7ST5Iu5dtuu23vczRpoUExTYbpR5ry5S9/OeyPPp3YWj7wwAON2/GIoWMUr9G3kgbAgCVBPxe33PamfqPkRVducqDJDF3ZaayLFQKNnGPv0djLlD6mmGBddtllYTsNjHlOs2K+U/qRXn755eG1tFjp4E5ufJ44dE7D5wQTrZVXXjl8Dh/euptaHHngMseIgT6nW2yxReiqxe8ISt3UhnE8ceQxjONRU1JHo0IWuSTpiYgHXZs4WeLJsHjx4jDFqU9b8DtJRx58jpMRQynaxdEINwoBTZNnzJgRCpz37bLLLsEPJbedNoQUNs2R4eSTTw6duSHn4pbbzgmb63ROg10c5YDO8Li2xQa8OOrRsBjouk43cEAYETS47rrrQrFhYwH42FBIkBYr3xXd0riycwWn9SIufYzi8KWJ1N3UonjwPVB0sQM5x0WDYSh1UxvG8UTxGMbxqCmpo1Ehi5xLejyOcYgHZkucKOmDNv9cqVN/E64kxBwkHjQtxjoyggkUowrA4yV1jENcEJbcdgp1zpw5ve2cdNg2IjA5F7fc9iYQj+gZg9Ulc/II3bmjyRPFQ2xgBMR3B4hH+l1RMIgJRZgWK34sjKwYTaXD/nqx1t3UUvGg+3gEm4tobFXqpjaM40nFY6LHoyZXRysCWeSSpCcy8sDykCFnCvYMg8QDpzBO9iha/BxNf7ARiPaSKbntGCbzeY4jPhiJMCLJubjltjeBeDDqAaYb0Q0POOk5DuDKyhU4mnTHAkA8+n1XGETV1xj4vrB94LuZN29eEMp+xZqKfSoeFHskfV7qpjaM40nFY6LHo6akjkaFLHJJ0hMRD8yW0qspv/BBIw8W0ph+MJeOUMwUMeZKjDBYt4jgMMecOredY2PRdRA5F7fc9jol4oEFAtMZvhfge0jFA6+aaEzFqInvatmyZcsVa4TvikXlU045pW+x8rlIiXiUuqkN43hKxKP0eNSU1NGokEUuSXoi4oFVIEIQ57MUEL/wungwv581a1YoHNZF0ilLhFEFQ1gKEEHCBIjhPycYo4TcdjqqcwyIALBguWDBgvBzzsUtt33Qmscg8aAwsMREGDhG/EKYmjCVQTz4bhBS4DtlsRHSYuU7YOGQ74rH/vvvH/bNmgyfv++++8L76sVaIh6lbmrDOJ4S8Sg9HjUldTQqZJGHkXTu7zy4AgHCgEsaQ3IWITkBKLJUPJhCMM/lpGE4HxcXU7h7EQuS+/wsJs6cOXPMXZXc9ni3hXjYFUYf15yLW257092WEvEARJDvYqONNqq++93vhgVBFggRD4798MMPD656LKSy8AhpsXJFZzGY74vjY4pHIQHDfI6DtZp6sZaIR6mb2jCOp0Q8So9HzTDqqC2yyMqkzVgQD24N9yM3TRgFJW5qk+141CjrSBZZmbQZC+KRmyKuqGItdVObbMejRllHssjKpM1YBolHyZ+DT5RSN7XJdjxqlHUki6xM2piuoKwjWWRl0sZ0BWUdySIrkzamKyjrSBZZmbQxXUFZR7LIyqSN6QrKOpJF5v8jkLgffvjR/kEdqZCJhzFmamPxMMa0wuJhjGmFxcMY0wqLhzGmFRYPY0wrLB7GmFZYPIwxrbB4GGNaYfEwxrTC4mGMaYXFwxjTCouHMaYVFg9jTCssHsaYVlg8jDGtsHgYY1ph8TDGtMLiYYxphcXDGNMKi4cxphUWD2NMKywexphWWDyMMa2weBhjWmHxMMa0wuJhjGmFxcMY0wqLhzGmFRYPY0wrLB7GmFZYPIwxrbB4GGNa8T+Jg9FLWZvRrAAAAABJRU5ErkJggg=="}}]); \ No newline at end of file diff --git a/assets/js/8b564e48.e360ddfb.js b/assets/js/8b564e48.62bfda74.js similarity index 99% rename from assets/js/8b564e48.e360ddfb.js rename to assets/js/8b564e48.62bfda74.js index 0fd7e0d..8f1a938 100644 --- a/assets/js/8b564e48.e360ddfb.js +++ b/assets/js/8b564e48.62bfda74.js @@ -1 +1 @@ -"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[5689],{3905:(e,t,r)=>{r.d(t,{Zo:()=>h,kt:()=>u});var o=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=o.createContext({}),c=function(e){var t=o.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},h=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},d="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},f=o.forwardRef((function(e,t){var r=e.components,a=e.mdxType,n=e.originalType,l=e.parentName,h=s(e,["components","mdxType","originalType","parentName"]),d=c(r),f=a,u=d["".concat(l,".").concat(f)]||d[f]||p[f]||n;return r?o.createElement(u,i(i({ref:t},h),{},{components:r})):o.createElement(u,i({ref:t},h))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var n=r.length,i=new Array(n);i[0]=f;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>p,frontMatter:()=>n,metadata:()=>s,toc:()=>c});var o=r(7462),a=(r(7294),r(3905));const n={sidebar_position:1},i="Jackal Proof-of-Persistence",s={unversionedId:"protocol/p-o-p",id:"protocol/p-o-p",title:"Jackal Proof-of-Persistence",description:"Jackal Storage functions by a Proof-of-Storage algorithm we call Proof-of-Persistence. The Jackal Proof-of-Persistence (JPOP) works through a series of contracts formed between the storage provider and the user. These contracts contain the Merkle Tree root hash of the file and the information required to prove ownership of the file. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the provider to post the raw chunk of data corresponding to the index of the challenge window alongside the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. These challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle.",source:"@site/docs/protocol/p-o-p.md",sourceDirName:"protocol",slug:"/protocol/p-o-p",permalink:"/docs/protocol/p-o-p",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/protocol/p-o-p.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"filetree Module",permalink:"/docs/protocol/modules/filetree"},next:{title:"Tokens",permalink:"/docs/protocol/tokens"}},l={},c=[{value:"Building the Trees",id:"building-the-trees",level:2},{value:"Proving Data Availability",id:"proving-data-availability",level:2}],h={toc:c},d="wrapper";function p(e){let{components:t,...n}=e;return(0,a.kt)(d,(0,o.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"jackal-proof-of-persistence"},"Jackal Proof-of-Persistence"),(0,a.kt)("p",null,"Jackal Storage functions by a Proof-of-Storage algorithm we call Proof-of-Persistence. The Jackal Proof-of-Persistence (JPOP) works through a series of contracts formed between the storage provider and the user. These contracts contain the Merkle Tree root hash of the file and the information required to prove ownership of the file. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the provider to post the raw chunk of data corresponding to the index of the challenge window alongside the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. These challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle."),(0,a.kt)("p",null,"If a Storage Provider successfully posts a Merkle Proof within the challenge window for the contract and the data is verified by the Validators to be valid Merkle Proofs for the challenge index, the Storage Provider is paid out. Storage Provider rewards are proportional to the file size the contract is associated with relative to every other active contract on the network. If a Storage Provider fails to provide a valid proof within the allotted time frame, the contract is struck with a missed proof. After X missed proofs, the contract is burned, and the User is alerted the next time they query the contract. For every contract burned through missing proofs, the Storage Provider is struck with a penalty that remains on their record for a period of time adjustable through governance."),(0,a.kt)("h2",{id:"building-the-trees"},"Building the Trees"),(0,a.kt)("p",null,"Merkle Trees are a core component of the JPOP mechanism, thus, it is important to outline how these trees are used to create efficient and trustworthy proofs. When saving a file for the first time, providers split each file into many 1kb chunks. Providers must also hash the entire file to create a folder to house every chunk, this is displayed by the following diagram."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"File Tree",src:r(4671).Z,width:"601",height:"382"})),(0,a.kt)("p",null,"These chunks are used as leaves on the Merkle Tree defining each storage contract. Immediately after saving a file to disk, the storage provider builds a tree using each chunk. To create this tree, each chunk is hashed into a respective Hashed Chunk. These chunks are then recursively paired together and hashed until a single root node is created. This is called the Merkle Root, the only piece of data relative to a file that is saved directly on the blockchain itself."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Merkle Roots",src:r(9302).Z,width:"601",height:"512"})),(0,a.kt)("p",null,"In the diagram above, displays how each file is hashed together to create a single root node."),(0,a.kt)("h2",{id:"proving-data-availability"},"Proving Data Availability"),(0,a.kt)("p",null,"These nodes are essential as they only require the nodes below them to prove they are part of the tree. This means that we can create a proof claiming a single chunk belongs to the file using the Merkle Root saved on the chain. In the following diagram, we can see that only the blue nodes are required to build a successful proof. The green nodes represent information that we can generate given the blue nodes. Finally, we can compare the root generated from the proof to the root saved on the chain and determine if the chunk does belong to the contract we are proving. This results in small message sizes due to not needing to send the entire file every proof."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Merkle Roots Graphed",src:r(9614).Z,width:"601",height:"512"})))}p.isMDXComponent=!0},4671:(e,t,r)=>{r.d(t,{Z:()=>o});const o=r.p+"assets/images/tree1-9d95b0b5007debff9495443e8075c918.png"},9302:(e,t,r)=>{r.d(t,{Z:()=>o});const o=r.p+"assets/images/tree2-6ed53d85e2efa8a87bfd1bc6b88757e5.png"},9614:(e,t,r)=>{r.d(t,{Z:()=>o});const o=r.p+"assets/images/tree3-4f9ab62526b9143823b59eebc0f2b724.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[5689],{3905:(e,t,r)=>{r.d(t,{Zo:()=>h,kt:()=>u});var o=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=o.createContext({}),c=function(e){var t=o.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},h=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},d="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},f=o.forwardRef((function(e,t){var r=e.components,a=e.mdxType,n=e.originalType,l=e.parentName,h=s(e,["components","mdxType","originalType","parentName"]),d=c(r),f=a,u=d["".concat(l,".").concat(f)]||d[f]||p[f]||n;return r?o.createElement(u,i(i({ref:t},h),{},{components:r})):o.createElement(u,i({ref:t},h))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var n=r.length,i=new Array(n);i[0]=f;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>p,frontMatter:()=>n,metadata:()=>s,toc:()=>c});var o=r(7462),a=(r(7294),r(3905));const n={sidebar_position:1},i="Jackal Proof-of-Persistence",s={unversionedId:"protocol/p-o-p",id:"protocol/p-o-p",title:"Jackal Proof-of-Persistence",description:"Jackal Storage functions by a Proof-of-Storage algorithm we call Proof-of-Persistence. The Jackal Proof-of-Persistence (JPOP) works through a series of contracts formed between the storage provider and the user. These contracts contain the Merkle Tree root hash of the file and the information required to prove ownership of the file. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the provider to post the raw chunk of data corresponding to the index of the challenge window alongside the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. These challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle.",source:"@site/docs/protocol/p-o-p.md",sourceDirName:"protocol",slug:"/protocol/p-o-p",permalink:"/docs/protocol/p-o-p",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/protocol/p-o-p.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Filetree Module",permalink:"/docs/protocol/modules/filetree"},next:{title:"Tokens",permalink:"/docs/protocol/tokens"}},l={},c=[{value:"Building the Trees",id:"building-the-trees",level:2},{value:"Proving Data Availability",id:"proving-data-availability",level:2}],h={toc:c},d="wrapper";function p(e){let{components:t,...n}=e;return(0,a.kt)(d,(0,o.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"jackal-proof-of-persistence"},"Jackal Proof-of-Persistence"),(0,a.kt)("p",null,"Jackal Storage functions by a Proof-of-Storage algorithm we call Proof-of-Persistence. The Jackal Proof-of-Persistence (JPOP) works through a series of contracts formed between the storage provider and the user. These contracts contain the Merkle Tree root hash of the file and the information required to prove ownership of the file. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the provider to post the raw chunk of data corresponding to the index of the challenge window alongside the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. These challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle."),(0,a.kt)("p",null,"If a Storage Provider successfully posts a Merkle Proof within the challenge window for the contract and the data is verified by the Validators to be valid Merkle Proofs for the challenge index, the Storage Provider is paid out. Storage Provider rewards are proportional to the file size the contract is associated with relative to every other active contract on the network. If a Storage Provider fails to provide a valid proof within the allotted time frame, the contract is struck with a missed proof. After X missed proofs, the contract is burned, and the User is alerted the next time they query the contract. For every contract burned through missing proofs, the Storage Provider is struck with a penalty that remains on their record for a period of time adjustable through governance."),(0,a.kt)("h2",{id:"building-the-trees"},"Building the Trees"),(0,a.kt)("p",null,"Merkle Trees are a core component of the JPOP mechanism, thus, it is important to outline how these trees are used to create efficient and trustworthy proofs. When saving a file for the first time, providers split each file into many 1kb chunks. Providers must also hash the entire file to create a folder to house every chunk, this is displayed by the following diagram."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"File Tree",src:r(4671).Z,width:"601",height:"382"})),(0,a.kt)("p",null,"These chunks are used as leaves on the Merkle Tree defining each storage contract. Immediately after saving a file to disk, the storage provider builds a tree using each chunk. To create this tree, each chunk is hashed into a respective Hashed Chunk. These chunks are then recursively paired together and hashed until a single root node is created. This is called the Merkle Root, the only piece of data relative to a file that is saved directly on the blockchain itself."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Merkle Roots",src:r(9302).Z,width:"601",height:"512"})),(0,a.kt)("p",null,"In the diagram above, displays how each file is hashed together to create a single root node."),(0,a.kt)("h2",{id:"proving-data-availability"},"Proving Data Availability"),(0,a.kt)("p",null,"These nodes are essential as they only require the nodes below them to prove they are part of the tree. This means that we can create a proof claiming a single chunk belongs to the file using the Merkle Root saved on the chain. In the following diagram, we can see that only the blue nodes are required to build a successful proof. The green nodes represent information that we can generate given the blue nodes. Finally, we can compare the root generated from the proof to the root saved on the chain and determine if the chunk does belong to the contract we are proving. This results in small message sizes due to not needing to send the entire file every proof."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Merkle Roots Graphed",src:r(9614).Z,width:"601",height:"512"})))}p.isMDXComponent=!0},4671:(e,t,r)=>{r.d(t,{Z:()=>o});const o=r.p+"assets/images/tree1-9d95b0b5007debff9495443e8075c918.png"},9302:(e,t,r)=>{r.d(t,{Z:()=>o});const o=r.p+"assets/images/tree2-6ed53d85e2efa8a87bfd1bc6b88757e5.png"},9614:(e,t,r)=>{r.d(t,{Z:()=>o});const o=r.p+"assets/images/tree3-4f9ab62526b9143823b59eebc0f2b724.png"}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.6b71f3f9.js b/assets/js/935f2afb.1ec4dab0.js similarity index 99% rename from assets/js/935f2afb.6b71f3f9.js rename to assets/js/935f2afb.1ec4dab0.js index dec8b28..af0d14a 100644 --- a/assets/js/935f2afb.6b71f3f9.js +++ b/assets/js/935f2afb.1ec4dab0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Welcome to Jackal Wiki","href":"/docs/intro","docId":"intro"},{"type":"category","label":"Overview","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Discover the Jackal Protocol","href":"/docs/overview/jackal-tldr","docId":"overview/jackal-tldr"},{"type":"link","label":"What Is The JKL Token?","href":"/docs/overview/jkl","docId":"overview/jkl"},{"type":"link","label":"Why Choose Jackal Protocol","href":"/docs/overview/why-jackal","docId":"overview/why-jackal"}]},{"type":"category","label":"Using Jackal","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Wallets","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Keplr Wallet","href":"/docs/using-jackal/wallet/keplr","docId":"using-jackal/wallet/keplr"}]},{"type":"link","label":"Accessing JKL Tokens on Osmosis and Withdrawing to Jackal Protocol","href":"/docs/using-jackal/fund","docId":"using-jackal/fund"},{"type":"link","label":"How to Delegate JKL Tokens to a Validator","href":"/docs/using-jackal/delegate","docId":"using-jackal/delegate"},{"type":"link","label":"Jackal Dashboard Guide","href":"/docs/using-jackal/dashboard","docId":"using-jackal/dashboard"}]},{"type":"category","label":"Community and Contributors","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Join the Community!","href":"/docs/contributors/join","docId":"contributors/join"},{"type":"link","label":"Jackal Foundation","href":"/docs/contributors/foundation","docId":"contributors/foundation"},{"type":"link","label":"Jackal Labs","href":"/docs/contributors/labs","docId":"contributors/labs"}]},{"type":"category","label":"The Protocol","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Blockchain Modules","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Module Overview","href":"/docs/protocol/modules/module-overview","docId":"protocol/modules/module-overview"},{"type":"link","label":"JKLmint Module","href":"/docs/protocol/modules/jklmint","docId":"protocol/modules/jklmint"},{"type":"link","label":"LP Module (Coming Soon)","href":"/docs/protocol/modules/lp","docId":"protocol/modules/lp"},{"type":"link","label":"Name Service Module","href":"/docs/protocol/modules/rns","docId":"protocol/modules/rns"},{"type":"link","label":"WASM Module","href":"/docs/protocol/modules/wasm","docId":"protocol/modules/wasm"},{"type":"link","label":"JPOP and IDOL Modules","href":"/docs/protocol/modules/storage","docId":"protocol/modules/storage"},{"type":"link","label":"dsig Module","href":"/docs/protocol/modules/dsig","docId":"protocol/modules/dsig"},{"type":"link","label":"filetree Module","href":"/docs/protocol/modules/filetree","docId":"protocol/modules/filetree"}]},{"type":"link","label":"Jackal Proof-of-Persistence","href":"/docs/protocol/p-o-p","docId":"protocol/p-o-p"},{"type":"link","label":"Tokens","href":"/docs/protocol/tokens","docId":"protocol/tokens"},{"type":"link","label":"Encryption","href":"/docs/protocol/encryption","docId":"protocol/encryption"},{"type":"category","label":"Storage Providers","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Overview","href":"/docs/protocol/storageproviders/overview","docId":"protocol/storageproviders/overview"},{"type":"link","label":"Casual Storage Build","href":"/docs/protocol/storageproviders/casual-build","docId":"protocol/storageproviders/casual-build"},{"type":"link","label":"DIY Serious Build","href":"/docs/protocol/storageproviders/diy-serious copy","docId":"protocol/storageproviders/diy-serious copy"},{"type":"link","label":"Enterprise Build","href":"/docs/protocol/storageproviders/enterprise","docId":"protocol/storageproviders/enterprise"}]},{"type":"link","label":"Validators","href":"/docs/protocol/validators","docId":"protocol/validators"}]},{"type":"link","label":"Jackal Explorer","href":"/docs/explorer","docId":"explorer"},{"type":"category","label":"Official Links","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Jackal Protocol Links","href":"/docs/official-links/jackal-protocol","docId":"official-links/jackal-protocol"},{"type":"link","label":"Jackal Foundation Links","href":"/docs/official-links/jackal-foundation","docId":"official-links/jackal-foundation"},{"type":"link","label":"Jackal Labs Links","href":"/docs/official-links/jackal-labs","docId":"official-links/jackal-labs"}]},{"type":"category","label":"Ecosystem","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Grants and Funding","href":"/docs/ecosystem/grants-funding","docId":"ecosystem/grants-funding"},{"type":"link","label":"Partnerships","href":"/docs/ecosystem/partnerships","docId":"ecosystem/partnerships"},{"type":"link","label":"Bounties","href":"/docs/ecosystem/bounties","docId":"ecosystem/bounties"}]},{"type":"category","label":"Nodes & Providers","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Setting Up","href":"/docs/nodes/install","docId":"nodes/install"},{"type":"category","label":"Full Nodes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Hardware","href":"/docs/nodes/nodes/hardware","docId":"nodes/nodes/hardware"},{"type":"link","label":"Installing Canined","href":"/docs/nodes/nodes/installation","docId":"nodes/nodes/installation"},{"type":"link","label":"Joining Testnet","href":"/docs/nodes/nodes/testnet","docId":"nodes/nodes/testnet"},{"type":"link","label":"Joining Mainnet","href":"/docs/nodes/nodes/mainnet","docId":"nodes/nodes/mainnet"}]},{"type":"category","label":"Validators","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating Validator","href":"/docs/nodes/validators/joining","docId":"nodes/validators/joining"}]},{"type":"category","label":"Storage Providers","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating Provider","href":"/docs/nodes/providers/building","docId":"nodes/providers/building"},{"type":"link","label":"Setting Up JProvd","href":"/docs/nodes/providers/setting_up","docId":"nodes/providers/setting_up"}]}]}]},"docs":{"contributors/foundation":{"id":"contributors/foundation","title":"Jackal Foundation","description":"What is the Jackal Foundation?","sidebar":"tutorialSidebar"},"contributors/join":{"id":"contributors/join","title":"Join the Community!","description":"The Jackal Community is open to all.","sidebar":"tutorialSidebar"},"contributors/labs":{"id":"contributors/labs","title":"Jackal Labs","description":"Who is Jackal Labs?","sidebar":"tutorialSidebar"},"ecosystem/bounties":{"id":"ecosystem/bounties","title":"Bounties","description":"The Jackal Foundation often posts bounties which are tasks and projects that maintain the Jackal Protocol. Upon successful completion of a bounty, the reward will be released to the service provider. These bounties range in complexity from creating memes and blog publications to refactoring code.","sidebar":"tutorialSidebar"},"ecosystem/grants-funding":{"id":"ecosystem/grants-funding","title":"Grants and Funding","description":"The Jackal Foundation facilitates non-equity grants, seed funding, and beyond through our various funding programs. Ecosystem funding aims to focus on the following categories;","sidebar":"tutorialSidebar"},"ecosystem/partnerships":{"id":"ecosystem/partnerships","title":"Partnerships","description":"Blockchain and web3 native software engineering teams often wish to become core contributors through a partnership with the Jackal Foundation. In a partnership role, the team would be assigned direct tasks and held to a high standard of execution, professionalism, and accountability. If your team desires to partner with the Jackal Foundation, please reach out directly, we look forward to working with you.","sidebar":"tutorialSidebar"},"explorer":{"id":"explorer","title":"Jackal Explorer","description":"The Jackal Explorer is a \u201cLight Explorer\u201d that fetches data from Cosmos full node via LCD/RPC endpoints. This allows our users to explore transactions on the Jackal Blockchain.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Welcome to Jackal Wiki","description":"Welcome, explorer, to the Jackal Wiki, where you\'ll embark on a journey to discover a more secure, simple, and self-custodial digital world.","sidebar":"tutorialSidebar"},"nodes/install":{"id":"nodes/install","title":"Setting Up","description":"Pre-Requisites","sidebar":"tutorialSidebar"},"nodes/nodes/hardware":{"id":"nodes/nodes/hardware","title":"Hardware","description":"We recommend a minimum hardware requirement of:","sidebar":"tutorialSidebar"},"nodes/nodes/installation":{"id":"nodes/nodes/installation","title":"Installing Canined","description":"Pre-Requisites","sidebar":"tutorialSidebar"},"nodes/nodes/mainnet":{"id":"nodes/nodes/mainnet","title":"Joining Mainnet","description":"Perform the following as the jackal user.","sidebar":"tutorialSidebar"},"nodes/nodes/testnet":{"id":"nodes/nodes/testnet","title":"Joining Testnet","description":"After installing canined. You can join the testnet by following these steps:","sidebar":"tutorialSidebar"},"nodes/providers/building":{"id":"nodes/providers/building","title":"Creating Provider","description":"Disclaimer","sidebar":"tutorialSidebar"},"nodes/providers/setting_up":{"id":"nodes/providers/setting_up","title":"Setting Up JProvd","description":"Pre-Requisites","sidebar":"tutorialSidebar"},"nodes/validators/joining":{"id":"nodes/validators/joining","title":"Creating Validator","description":"This guide assumes you are using the same machine as the full node.","sidebar":"tutorialSidebar"},"official-links/jackal-foundation":{"id":"official-links/jackal-foundation","title":"Jackal Foundation Links","description":"Here are the official website links for Jackal Foundation. Please use and bookmark these links to reduce the likelihood of cyber phishing threats.","sidebar":"tutorialSidebar"},"official-links/jackal-labs":{"id":"official-links/jackal-labs","title":"Jackal Labs Links","description":"Here are the official website links for Jackal Labs. Please use and bookmark these links to reduce the likelihood of cyber phishing threats.","sidebar":"tutorialSidebar"},"official-links/jackal-protocol":{"id":"official-links/jackal-protocol","title":"Jackal Protocol Links","description":"Here are the official website links of the Jackal Protocol. Please use and bookmark these links to reduce the likelihood of cyber phishing threats.","sidebar":"tutorialSidebar"},"overview/jackal-tldr":{"id":"overview/jackal-tldr","title":"Discover the Jackal Protocol","description":"The Jackal Protocol provides a decentralized infrastructure for secure and scalable data storage, enabling individuals, developers, and enterprises to protect their data privacy and improve their cybersecurity posture. It offers a platform for building decentralized applications, managing access control and ownership, transferring encrypted data, and maintaining self-custodial control over data, all without relying on centralized storage providers or intermediaries.","sidebar":"tutorialSidebar"},"overview/jkl":{"id":"overview/jkl","title":"What Is The JKL Token?","description":"The JKL Token is the driving force behind the revolutionary Jackal Protocol. This versatile native token seamlessly integrates with the ecosystem, unlocking endless possibilities for users, developers, and enterprises alike.","sidebar":"tutorialSidebar"},"overview/why-jackal":{"id":"overview/why-jackal","title":"Why Choose Jackal Protocol","description":"The Jackal Protocol offers various advantages for individuals, small businesses, and large enterprises seeking secure, decentralized data storage and management solutions.","sidebar":"tutorialSidebar"},"protocol/encryption":{"id":"protocol/encryption","title":"Encryption","description":"Jackal has two main features that rely on encryption techniques to keep user data private and secure. The two main models are file encryption and file-entry encryption. These reside in different locations within the protocol. The files themselves are stored on Storage Providers, which require files to be encrypted before they are transferred to those machines. The file entries are data structures living directly on-chain in the File Tree blockchain module, again needing to be encrypted on the client\'s device before being sent to the blockchain. The file encryption model is simply performed by taking the file as raw bytes and randomly generating a key in the user\'s client. This key is called a Symmetric Key. We then pass both the key and the file through AES256 encryption, which results in an encrypted file that can safely be sent to the Storage-Providers.","sidebar":"tutorialSidebar"},"protocol/modules/dsig":{"id":"protocol/modules/dsig","title":"dsig Module","description":"Coming Soon","sidebar":"tutorialSidebar"},"protocol/modules/filetree":{"id":"protocol/modules/filetree","title":"filetree Module","description":"Overview","sidebar":"tutorialSidebar"},"protocol/modules/jklmint":{"id":"protocol/modules/jklmint","title":"JKLmint Module","description":"The jklmint module is responsible for the management of the native JKL token within the Jackal Protocol. This module handles the issuance, distribution, and inflation of JKL tokens, ensuring a stable and secure token economy.","sidebar":"tutorialSidebar"},"protocol/modules/lp":{"id":"protocol/modules/lp","title":"LP Module (Coming Soon)","description":"The lp (Liquidity Provision) module is a vital part of the Jackal Protocol, enabling the creation and management of liquidity pools for trading and swapping tokens. This module provides a decentralized solution for users to contribute liquidity to the ecosystem and earn rewards in return.","sidebar":"tutorialSidebar"},"protocol/modules/module-overview":{"id":"protocol/modules/module-overview","title":"Module Overview","description":"Protocol Overview","sidebar":"tutorialSidebar"},"protocol/modules/rns":{"id":"protocol/modules/rns","title":"Name Service Module","description":"The rns (Reverse Name Service) module is an essential component of the Jackal Protocol, providing a user-friendly naming system for blockchain addresses. The RNS module simplifies the process of interacting with complex addresses by mapping them to human-readable names. This module allows users to transfer tokens and permissions to files/folders stored on the Jackal Protocol using human readable names.","sidebar":"tutorialSidebar"},"protocol/modules/storage":{"id":"protocol/modules/storage","title":"JPOP and IDOL Modules","description":"The Jackal Protocol incorporates two crucial algorithms for decentralized storage: Jackal Proof-of-Persistence (JPOP) and Internal Detection Of Loss (IDOL) protocols. This document provides an overview of these algorithms, their functionalities, and their interaction with users and Storage Providers.","sidebar":"tutorialSidebar"},"protocol/modules/wasm":{"id":"protocol/modules/wasm","title":"WASM Module","description":"The wasm module in the Jackal Protocol incorporates the CosmWasm smart contracting platform, which is designed specifically for the Cosmos Ecosystem. This module provides a secure and efficient environment for executing WebAssembly (WASM) smart contracts on the Jackal Protocol.","sidebar":"tutorialSidebar"},"protocol/p-o-p":{"id":"protocol/p-o-p","title":"Jackal Proof-of-Persistence","description":"Jackal Storage functions by a Proof-of-Storage algorithm we call Proof-of-Persistence. The Jackal Proof-of-Persistence (JPOP) works through a series of contracts formed between the storage provider and the user. These contracts contain the Merkle Tree root hash of the file and the information required to prove ownership of the file. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the provider to post the raw chunk of data corresponding to the index of the challenge window alongside the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. These challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle.","sidebar":"tutorialSidebar"},"protocol/storageproviders/casual-build":{"id":"protocol/storageproviders/casual-build","title":"Casual Storage Build","description":"You may be successful contributing to the network with an old computer you may have. If you are looking to purpose build a machine- here are the recommendations for casual a storage provider.","sidebar":"tutorialSidebar"},"protocol/storageproviders/diy-serious copy":{"id":"protocol/storageproviders/diy-serious copy","title":"DIY Serious Build","description":"For DIY individuals looking to power web3 infrastructure and increase your ROI- here is the recommended system for serious individual storage providers.","sidebar":"tutorialSidebar"},"protocol/storageproviders/enterprise":{"id":"protocol/storageproviders/enterprise","title":"Enterprise Build","description":"For teams looking to build a large storage system of ~2.1 Petabytes of storage, the estimated base price of the box with drives is ~$70,000 USD. This does not account for variable expenses including the regional costs of:","sidebar":"tutorialSidebar"},"protocol/storageproviders/overview":{"id":"protocol/storageproviders/overview","title":"Overview","description":"Want to power the storage infrastructure for web3?","sidebar":"tutorialSidebar"},"protocol/tokens":{"id":"protocol/tokens","title":"Tokens","description":"JKL or Jackal","sidebar":"tutorialSidebar"},"protocol/validators":{"id":"protocol/validators","title":"Validators","description":"The Jackal Validators are secure web servers, dedicated machines that participate in the consensus protocol by broadcasting cryptographic signatures, or votes, to agree upon the next block. Voting power is determined by the amount of staking tokens delegated by non-validators and bonded as collateral to earn a reward. These non-validators, or delegators, incur the risk of getting punished (slashed) if the delegate validator gets hacked or violates the protocol.","sidebar":"tutorialSidebar"},"using-jackal/dashboard":{"id":"using-jackal/dashboard","title":"Jackal Dashboard Guide","description":"The Jackal Dashboard is your one-stop destination for interacting with the Jackal Protocol and Cosmos ecosystem. This guide will walk you through the various features and capabilities available on the Jackal Dashboard.","sidebar":"tutorialSidebar"},"using-jackal/delegate":{"id":"using-jackal/delegate","title":"How to Delegate JKL Tokens to a Validator","description":"This guide will help you delegate your JKL tokens to a validator on the Jackal Protocol, which helps secure the network and earns you staking rewards.","sidebar":"tutorialSidebar"},"using-jackal/fund":{"id":"using-jackal/fund","title":"Accessing JKL Tokens on Osmosis and Withdrawing to Jackal Protocol","description":"This guide will help you access JKL tokens on the Osmosis Decentralized Exchange (DEX) and withdraw them to the Jackal Protocol using Inter-Blockchain Communication (IBC).","sidebar":"tutorialSidebar"},"using-jackal/wallet/keplr":{"id":"using-jackal/wallet/keplr","title":"Keplr Wallet","description":"The Keplr browser extension is a wallet for accessing some Jackal applications in the Cosmos ecosystem. Keplr can be used to exchange/manage JKL and other Cosmos-based tokens, participate in governance from the Jackal Dashboard, and use Jackal Storage.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Welcome to Jackal Wiki","href":"/docs/intro","docId":"intro"},{"type":"category","label":"Overview","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Discover the Jackal Protocol","href":"/docs/overview/jackal-tldr","docId":"overview/jackal-tldr"},{"type":"link","label":"What Is The JKL Token?","href":"/docs/overview/jkl","docId":"overview/jkl"},{"type":"link","label":"Why Choose Jackal Protocol","href":"/docs/overview/why-jackal","docId":"overview/why-jackal"}]},{"type":"category","label":"Using Jackal","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Wallets","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Keplr Wallet","href":"/docs/using-jackal/wallet/keplr","docId":"using-jackal/wallet/keplr"}]},{"type":"link","label":"Accessing JKL Tokens on Osmosis and Withdrawing to Jackal Protocol","href":"/docs/using-jackal/fund","docId":"using-jackal/fund"},{"type":"link","label":"How to Delegate JKL Tokens to a Validator","href":"/docs/using-jackal/delegate","docId":"using-jackal/delegate"},{"type":"link","label":"Jackal Dashboard Guide","href":"/docs/using-jackal/dashboard","docId":"using-jackal/dashboard"}]},{"type":"category","label":"Community and Contributors","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Join the Community!","href":"/docs/contributors/join","docId":"contributors/join"},{"type":"link","label":"Jackal Foundation","href":"/docs/contributors/foundation","docId":"contributors/foundation"},{"type":"link","label":"Jackal Labs","href":"/docs/contributors/labs","docId":"contributors/labs"}]},{"type":"category","label":"The Protocol","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Blockchain Modules","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Module Overview","href":"/docs/protocol/modules/module-overview","docId":"protocol/modules/module-overview"},{"type":"link","label":"JKLmint Module","href":"/docs/protocol/modules/jklmint","docId":"protocol/modules/jklmint"},{"type":"link","label":"LP Module (Coming Soon)","href":"/docs/protocol/modules/lp","docId":"protocol/modules/lp"},{"type":"link","label":"Name Service Module","href":"/docs/protocol/modules/rns","docId":"protocol/modules/rns"},{"type":"link","label":"WASM Module","href":"/docs/protocol/modules/wasm","docId":"protocol/modules/wasm"},{"type":"link","label":"JPOP and IDOL Modules","href":"/docs/protocol/modules/storage","docId":"protocol/modules/storage"},{"type":"link","label":"dsig Module","href":"/docs/protocol/modules/dsig","docId":"protocol/modules/dsig"},{"type":"link","label":"Filetree Module","href":"/docs/protocol/modules/filetree","docId":"protocol/modules/filetree"}]},{"type":"link","label":"Jackal Proof-of-Persistence","href":"/docs/protocol/p-o-p","docId":"protocol/p-o-p"},{"type":"link","label":"Tokens","href":"/docs/protocol/tokens","docId":"protocol/tokens"},{"type":"link","label":"Encryption","href":"/docs/protocol/encryption","docId":"protocol/encryption"},{"type":"category","label":"Storage Providers","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Overview","href":"/docs/protocol/storageproviders/overview","docId":"protocol/storageproviders/overview"},{"type":"link","label":"Casual Storage Build","href":"/docs/protocol/storageproviders/casual-build","docId":"protocol/storageproviders/casual-build"},{"type":"link","label":"DIY Serious Build","href":"/docs/protocol/storageproviders/diy-serious copy","docId":"protocol/storageproviders/diy-serious copy"},{"type":"link","label":"Enterprise Build","href":"/docs/protocol/storageproviders/enterprise","docId":"protocol/storageproviders/enterprise"}]},{"type":"link","label":"Validators","href":"/docs/protocol/validators","docId":"protocol/validators"}]},{"type":"link","label":"Jackal Explorer","href":"/docs/explorer","docId":"explorer"},{"type":"category","label":"Official Links","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Jackal Protocol Links","href":"/docs/official-links/jackal-protocol","docId":"official-links/jackal-protocol"},{"type":"link","label":"Jackal Foundation Links","href":"/docs/official-links/jackal-foundation","docId":"official-links/jackal-foundation"},{"type":"link","label":"Jackal Labs Links","href":"/docs/official-links/jackal-labs","docId":"official-links/jackal-labs"}]},{"type":"category","label":"Ecosystem","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Grants and Funding","href":"/docs/ecosystem/grants-funding","docId":"ecosystem/grants-funding"},{"type":"link","label":"Partnerships","href":"/docs/ecosystem/partnerships","docId":"ecosystem/partnerships"},{"type":"link","label":"Bounties","href":"/docs/ecosystem/bounties","docId":"ecosystem/bounties"}]},{"type":"category","label":"Nodes & Providers","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Setting Up","href":"/docs/nodes/install","docId":"nodes/install"},{"type":"category","label":"Full Nodes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Hardware","href":"/docs/nodes/nodes/hardware","docId":"nodes/nodes/hardware"},{"type":"link","label":"Installing Canined","href":"/docs/nodes/nodes/installation","docId":"nodes/nodes/installation"},{"type":"link","label":"Joining Testnet","href":"/docs/nodes/nodes/testnet","docId":"nodes/nodes/testnet"},{"type":"link","label":"Joining Mainnet","href":"/docs/nodes/nodes/mainnet","docId":"nodes/nodes/mainnet"}]},{"type":"category","label":"Validators","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating Validator","href":"/docs/nodes/validators/joining","docId":"nodes/validators/joining"}]},{"type":"category","label":"Storage Providers","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating Provider","href":"/docs/nodes/providers/building","docId":"nodes/providers/building"},{"type":"link","label":"Setting Up JProvd","href":"/docs/nodes/providers/setting_up","docId":"nodes/providers/setting_up"}]}]}]},"docs":{"contributors/foundation":{"id":"contributors/foundation","title":"Jackal Foundation","description":"What is the Jackal Foundation?","sidebar":"tutorialSidebar"},"contributors/join":{"id":"contributors/join","title":"Join the Community!","description":"The Jackal Community is open to all.","sidebar":"tutorialSidebar"},"contributors/labs":{"id":"contributors/labs","title":"Jackal Labs","description":"Who is Jackal Labs?","sidebar":"tutorialSidebar"},"ecosystem/bounties":{"id":"ecosystem/bounties","title":"Bounties","description":"The Jackal Foundation often posts bounties which are tasks and projects that maintain the Jackal Protocol. Upon successful completion of a bounty, the reward will be released to the service provider. These bounties range in complexity from creating memes and blog publications to refactoring code.","sidebar":"tutorialSidebar"},"ecosystem/grants-funding":{"id":"ecosystem/grants-funding","title":"Grants and Funding","description":"The Jackal Foundation facilitates non-equity grants, seed funding, and beyond through our various funding programs. Ecosystem funding aims to focus on the following categories;","sidebar":"tutorialSidebar"},"ecosystem/partnerships":{"id":"ecosystem/partnerships","title":"Partnerships","description":"Blockchain and web3 native software engineering teams often wish to become core contributors through a partnership with the Jackal Foundation. In a partnership role, the team would be assigned direct tasks and held to a high standard of execution, professionalism, and accountability. If your team desires to partner with the Jackal Foundation, please reach out directly, we look forward to working with you.","sidebar":"tutorialSidebar"},"explorer":{"id":"explorer","title":"Jackal Explorer","description":"The Jackal Explorer is a \u201cLight Explorer\u201d that fetches data from Cosmos full node via LCD/RPC endpoints. This allows our users to explore transactions on the Jackal Blockchain.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Welcome to Jackal Wiki","description":"Welcome, explorer, to the Jackal Wiki, where you\'ll embark on a journey to discover a more secure, simple, and self-custodial digital world.","sidebar":"tutorialSidebar"},"nodes/install":{"id":"nodes/install","title":"Setting Up","description":"Pre-Requisites","sidebar":"tutorialSidebar"},"nodes/nodes/hardware":{"id":"nodes/nodes/hardware","title":"Hardware","description":"We recommend a minimum hardware requirement of:","sidebar":"tutorialSidebar"},"nodes/nodes/installation":{"id":"nodes/nodes/installation","title":"Installing Canined","description":"Pre-Requisites","sidebar":"tutorialSidebar"},"nodes/nodes/mainnet":{"id":"nodes/nodes/mainnet","title":"Joining Mainnet","description":"Perform the following as the jackal user.","sidebar":"tutorialSidebar"},"nodes/nodes/testnet":{"id":"nodes/nodes/testnet","title":"Joining Testnet","description":"After installing canined. You can join the testnet by following these steps:","sidebar":"tutorialSidebar"},"nodes/providers/building":{"id":"nodes/providers/building","title":"Creating Provider","description":"Disclaimer","sidebar":"tutorialSidebar"},"nodes/providers/setting_up":{"id":"nodes/providers/setting_up","title":"Setting Up JProvd","description":"Pre-Requisites","sidebar":"tutorialSidebar"},"nodes/validators/joining":{"id":"nodes/validators/joining","title":"Creating Validator","description":"This guide assumes you are using the same machine as the full node.","sidebar":"tutorialSidebar"},"official-links/jackal-foundation":{"id":"official-links/jackal-foundation","title":"Jackal Foundation Links","description":"Here are the official website links for Jackal Foundation. Please use and bookmark these links to reduce the likelihood of cyber phishing threats.","sidebar":"tutorialSidebar"},"official-links/jackal-labs":{"id":"official-links/jackal-labs","title":"Jackal Labs Links","description":"Here are the official website links for Jackal Labs. Please use and bookmark these links to reduce the likelihood of cyber phishing threats.","sidebar":"tutorialSidebar"},"official-links/jackal-protocol":{"id":"official-links/jackal-protocol","title":"Jackal Protocol Links","description":"Here are the official website links of the Jackal Protocol. Please use and bookmark these links to reduce the likelihood of cyber phishing threats.","sidebar":"tutorialSidebar"},"overview/jackal-tldr":{"id":"overview/jackal-tldr","title":"Discover the Jackal Protocol","description":"The Jackal Protocol provides a decentralized infrastructure for secure and scalable data storage, enabling individuals, developers, and enterprises to protect their data privacy and improve their cybersecurity posture. It offers a platform for building decentralized applications, managing access control and ownership, transferring encrypted data, and maintaining self-custodial control over data, all without relying on centralized storage providers or intermediaries.","sidebar":"tutorialSidebar"},"overview/jkl":{"id":"overview/jkl","title":"What Is The JKL Token?","description":"The JKL Token is the driving force behind the revolutionary Jackal Protocol. This versatile native token seamlessly integrates with the ecosystem, unlocking endless possibilities for users, developers, and enterprises alike.","sidebar":"tutorialSidebar"},"overview/why-jackal":{"id":"overview/why-jackal","title":"Why Choose Jackal Protocol","description":"The Jackal Protocol offers various advantages for individuals, small businesses, and large enterprises seeking secure, decentralized data storage and management solutions.","sidebar":"tutorialSidebar"},"protocol/encryption":{"id":"protocol/encryption","title":"Encryption","description":"Jackal has two main features that rely on encryption techniques to keep user data private and secure. The two main models are file encryption and file-entry encryption. These reside in different locations within the protocol. The files themselves are stored on Storage Providers, which require files to be encrypted before they are transferred to those machines. The file entries are data structures living directly on-chain in the File Tree blockchain module, again needing to be encrypted on the client\'s device before being sent to the blockchain. The file encryption model is simply performed by taking the file as raw bytes and randomly generating a key in the user\'s client. This key is called a Symmetric Key. We then pass both the key and the file through AES256 encryption, which results in an encrypted file that can safely be sent to the Storage-Providers.","sidebar":"tutorialSidebar"},"protocol/modules/dsig":{"id":"protocol/modules/dsig","title":"dsig Module","description":"Coming Soon","sidebar":"tutorialSidebar"},"protocol/modules/filetree":{"id":"protocol/modules/filetree","title":"Filetree Module","description":"Overview","sidebar":"tutorialSidebar"},"protocol/modules/jklmint":{"id":"protocol/modules/jklmint","title":"JKLmint Module","description":"The jklmint module is responsible for the management of the native JKL token within the Jackal Protocol. This module handles the issuance, distribution, and inflation of JKL tokens, ensuring a stable and secure token economy.","sidebar":"tutorialSidebar"},"protocol/modules/lp":{"id":"protocol/modules/lp","title":"LP Module (Coming Soon)","description":"The lp (Liquidity Provision) module is a vital part of the Jackal Protocol, enabling the creation and management of liquidity pools for trading and swapping tokens. This module provides a decentralized solution for users to contribute liquidity to the ecosystem and earn rewards in return.","sidebar":"tutorialSidebar"},"protocol/modules/module-overview":{"id":"protocol/modules/module-overview","title":"Module Overview","description":"Protocol Overview","sidebar":"tutorialSidebar"},"protocol/modules/rns":{"id":"protocol/modules/rns","title":"Name Service Module","description":"The rns (Reverse Name Service) module is an essential component of the Jackal Protocol, providing a user-friendly naming system for blockchain addresses. The RNS module simplifies the process of interacting with complex addresses by mapping them to human-readable names. This module allows users to transfer tokens and permissions to files/folders stored on the Jackal Protocol using human readable names.","sidebar":"tutorialSidebar"},"protocol/modules/storage":{"id":"protocol/modules/storage","title":"JPOP and IDOL Modules","description":"The Jackal Protocol incorporates two crucial algorithms for decentralized storage: Jackal Proof-of-Persistence (JPOP) and Internal Detection Of Loss (IDOL) protocols. This document provides an overview of these algorithms, their functionalities, and their interaction with users and Storage Providers.","sidebar":"tutorialSidebar"},"protocol/modules/wasm":{"id":"protocol/modules/wasm","title":"WASM Module","description":"The wasm module in the Jackal Protocol incorporates the CosmWasm smart contracting platform, which is designed specifically for the Cosmos Ecosystem. This module provides a secure and efficient environment for executing WebAssembly (WASM) smart contracts on the Jackal Protocol.","sidebar":"tutorialSidebar"},"protocol/p-o-p":{"id":"protocol/p-o-p","title":"Jackal Proof-of-Persistence","description":"Jackal Storage functions by a Proof-of-Storage algorithm we call Proof-of-Persistence. The Jackal Proof-of-Persistence (JPOP) works through a series of contracts formed between the storage provider and the user. These contracts contain the Merkle Tree root hash of the file and the information required to prove ownership of the file. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the provider to post the raw chunk of data corresponding to the index of the challenge window alongside the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. These challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle.","sidebar":"tutorialSidebar"},"protocol/storageproviders/casual-build":{"id":"protocol/storageproviders/casual-build","title":"Casual Storage Build","description":"You may be successful contributing to the network with an old computer you may have. If you are looking to purpose build a machine- here are the recommendations for casual a storage provider.","sidebar":"tutorialSidebar"},"protocol/storageproviders/diy-serious copy":{"id":"protocol/storageproviders/diy-serious copy","title":"DIY Serious Build","description":"For DIY individuals looking to power web3 infrastructure and increase your ROI- here is the recommended system for serious individual storage providers.","sidebar":"tutorialSidebar"},"protocol/storageproviders/enterprise":{"id":"protocol/storageproviders/enterprise","title":"Enterprise Build","description":"For teams looking to build a large storage system of ~2.1 Petabytes of storage, the estimated base price of the box with drives is ~$70,000 USD. This does not account for variable expenses including the regional costs of:","sidebar":"tutorialSidebar"},"protocol/storageproviders/overview":{"id":"protocol/storageproviders/overview","title":"Overview","description":"Want to power the storage infrastructure for web3?","sidebar":"tutorialSidebar"},"protocol/tokens":{"id":"protocol/tokens","title":"Tokens","description":"JKL or Jackal","sidebar":"tutorialSidebar"},"protocol/validators":{"id":"protocol/validators","title":"Validators","description":"The Jackal Validators are secure web servers, dedicated machines that participate in the consensus protocol by broadcasting cryptographic signatures, or votes, to agree upon the next block. Voting power is determined by the amount of staking tokens delegated by non-validators and bonded as collateral to earn a reward. These non-validators, or delegators, incur the risk of getting punished (slashed) if the delegate validator gets hacked or violates the protocol.","sidebar":"tutorialSidebar"},"using-jackal/dashboard":{"id":"using-jackal/dashboard","title":"Jackal Dashboard Guide","description":"The Jackal Dashboard is your one-stop destination for interacting with the Jackal Protocol and Cosmos ecosystem. This guide will walk you through the various features and capabilities available on the Jackal Dashboard.","sidebar":"tutorialSidebar"},"using-jackal/delegate":{"id":"using-jackal/delegate","title":"How to Delegate JKL Tokens to a Validator","description":"This guide will help you delegate your JKL tokens to a validator on the Jackal Protocol, which helps secure the network and earns you staking rewards.","sidebar":"tutorialSidebar"},"using-jackal/fund":{"id":"using-jackal/fund","title":"Accessing JKL Tokens on Osmosis and Withdrawing to Jackal Protocol","description":"This guide will help you access JKL tokens on the Osmosis Decentralized Exchange (DEX) and withdraw them to the Jackal Protocol using Inter-Blockchain Communication (IBC).","sidebar":"tutorialSidebar"},"using-jackal/wallet/keplr":{"id":"using-jackal/wallet/keplr","title":"Keplr Wallet","description":"The Keplr browser extension is a wallet for accessing some Jackal applications in the Cosmos ecosystem. Keplr can be used to exchange/manage JKL and other Cosmos-based tokens, participate in governance from the Jackal Dashboard, and use Jackal Storage.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/b0580eac.b19bf88d.js b/assets/js/b0580eac.362a9d70.js similarity index 98% rename from assets/js/b0580eac.b19bf88d.js rename to assets/js/b0580eac.362a9d70.js index 375db91..e5615ee 100644 --- a/assets/js/b0580eac.b19bf88d.js +++ b/assets/js/b0580eac.362a9d70.js @@ -1 +1 @@ -"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[7053],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});var o=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function c(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var a=o.createContext({}),s=function(e){var t=o.useContext(a),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},u=function(e){var t=s(e.components);return o.createElement(a.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,a=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),p=s(r),m=n,f=p["".concat(a,".").concat(m)]||p[m]||d[m]||i;return r?o.createElement(f,c(c({ref:t},u),{},{components:r})):o.createElement(f,c({ref:t},u))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,c=new Array(i);c[0]=m;var l={};for(var a in t)hasOwnProperty.call(t,a)&&(l[a]=t[a]);l.originalType=e,l[p]="string"==typeof e?e:n,c[1]=l;for(var s=2;s{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var o=r(7462),n=(r(7294),r(3905));const i={sidebar_position:7},c="dsig Module",l={unversionedId:"protocol/modules/dsig",id:"protocol/modules/dsig",title:"dsig Module",description:"Coming Soon",source:"@site/docs/protocol/modules/dsig.md",sourceDirName:"protocol/modules",slug:"/protocol/modules/dsig",permalink:"/docs/protocol/modules/dsig",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/protocol/modules/dsig.md",tags:[],version:"current",sidebarPosition:7,frontMatter:{sidebar_position:7},sidebar:"tutorialSidebar",previous:{title:"JPOP and IDOL Modules",permalink:"/docs/protocol/modules/storage"},next:{title:"filetree Module",permalink:"/docs/protocol/modules/filetree"}},a={},s=[{value:"Coming Soon",id:"coming-soon",level:2}],u={toc:s},p="wrapper";function d(e){let{components:t,...r}=e;return(0,n.kt)(p,(0,o.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"dsig-module"},"dsig Module"),(0,n.kt)("h2",{id:"coming-soon"},"Coming Soon"))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[7053],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});var o=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function c(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var a=o.createContext({}),s=function(e){var t=o.useContext(a),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},u=function(e){var t=s(e.components);return o.createElement(a.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,a=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),p=s(r),m=n,f=p["".concat(a,".").concat(m)]||p[m]||d[m]||i;return r?o.createElement(f,c(c({ref:t},u),{},{components:r})):o.createElement(f,c({ref:t},u))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,c=new Array(i);c[0]=m;var l={};for(var a in t)hasOwnProperty.call(t,a)&&(l[a]=t[a]);l.originalType=e,l[p]="string"==typeof e?e:n,c[1]=l;for(var s=2;s{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var o=r(7462),n=(r(7294),r(3905));const i={sidebar_position:7},c="dsig Module",l={unversionedId:"protocol/modules/dsig",id:"protocol/modules/dsig",title:"dsig Module",description:"Coming Soon",source:"@site/docs/protocol/modules/dsig.md",sourceDirName:"protocol/modules",slug:"/protocol/modules/dsig",permalink:"/docs/protocol/modules/dsig",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/protocol/modules/dsig.md",tags:[],version:"current",sidebarPosition:7,frontMatter:{sidebar_position:7},sidebar:"tutorialSidebar",previous:{title:"JPOP and IDOL Modules",permalink:"/docs/protocol/modules/storage"},next:{title:"Filetree Module",permalink:"/docs/protocol/modules/filetree"}},a={},s=[{value:"Coming Soon",id:"coming-soon",level:2}],u={toc:s},p="wrapper";function d(e){let{components:t,...r}=e;return(0,n.kt)(p,(0,o.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"dsig-module"},"dsig Module"),(0,n.kt)("h2",{id:"coming-soon"},"Coming Soon"))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.42a3487d.js b/assets/js/runtime~main.27539258.js similarity index 55% rename from assets/js/runtime~main.42a3487d.js rename to assets/js/runtime~main.27539258.js index 89b5f16..125801e 100644 --- a/assets/js/runtime~main.42a3487d.js +++ b/assets/js/runtime~main.27539258.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,t,b,c,r={},f={};function d(e){var a=f[e];if(void 0!==a)return a.exports;var t=f[e]={id:e,loaded:!1,exports:{}};return r[e].call(t.exports,t,t.exports,d),t.loaded=!0,t.exports}d.m=r,d.c=f,e=[],d.O=(a,t,b,c)=>{if(!t){var r=1/0;for(i=0;i=c)&&Object.keys(d.O).every((e=>d.O[e](t[o])))?t.splice(o--,1):(f=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[t,b,c]},d.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return d.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var c=Object.create(null);d.r(c);var r={};a=a||[null,t({}),t([]),t(t)];for(var f=2&b&&e;"object"==typeof f&&!~a.indexOf(f);f=t(f))Object.getOwnPropertyNames(f).forEach((a=>r[a]=()=>e[a]));return r.default=()=>e,d.d(c,r),c},d.d=(e,a)=>{for(var t in a)d.o(a,t)&&!d.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((a,t)=>(d.f[t](e,a),a)),[])),d.u=e=>"assets/js/"+({53:"935f2afb",54:"344debb6",92:"29af3fe3",229:"03cdf430",604:"ab3acb2a",1078:"5402824b",1148:"3e125dc6",1172:"b46b7d8b",1210:"18a433c4",1232:"7d26c06c",1251:"d07de6bd",1344:"723cbd1b",1385:"15018644",1770:"65b97a36",1817:"9c403616",1947:"e1923b53",2782:"f1994572",2891:"f3769d49",3085:"1f391b9e",3298:"ea96f03c",3523:"e289ecfd",4195:"c4f5d8e4",4286:"c97fbebf",4808:"ebbc57e7",4878:"c894e2df",5202:"c1147f98",5275:"5a6f97fe",5533:"874276e5",5689:"8b564e48",5798:"d1f710bd",5863:"bbf127f0",6164:"9093546b",6174:"23f3f2f9",6683:"a4043c8d",7026:"259b7029",7049:"9718a321",7053:"b0580eac",7275:"7b9432de",7414:"393be207",7918:"17896441",8425:"b1fc7db6",8938:"5da52a1e",8957:"8a56e0ba",9042:"0558eea0",9293:"365ebb01",9404:"d07072fe",9514:"1be78505",9671:"0e384e19",9853:"a5b5e7c9",9960:"c933c35c"}[e]||e)+"."+{53:"6b71f3f9",54:"11ce8114",92:"b7aa3bac",229:"8a9a8dc7",604:"8c5a5100",1078:"71c03985",1148:"4cfeb910",1172:"1f4817c2",1210:"5df3b24e",1232:"3c3f36b6",1251:"cf69f933",1344:"9a02f066",1385:"6fe0ce4b",1770:"7909af7d",1817:"2692038c",1947:"d71b1720",2666:"44faa77f",2782:"ad8a18f1",2891:"76bc0d96",3085:"de6d2725",3298:"c0df1e45",3523:"d57d11c2",4195:"9c9906aa",4286:"b26e26ff",4808:"cf14015f",4878:"e4f93de7",4972:"6c3329cb",5202:"0681d850",5275:"2b5dfa6c",5533:"1df1dd8b",5689:"e360ddfb",5798:"6916f84a",5863:"0a335c46",6164:"8ff0d5a1",6174:"54be1c3c",6683:"0fa0107a",7026:"98508766",7049:"2302384d",7053:"b19bf88d",7275:"e298616d",7414:"c08b369d",7918:"6f3cf1c7",8425:"29933fec",8938:"c612a830",8957:"abfcd29c",9042:"dd319e8b",9293:"1e3738c8",9404:"8c40faa0",9514:"d1735d66",9671:"459dce20",9853:"e682b0a5",9960:"bde7bf2d"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},c="canine-docs:",d.l=(e,a,t,r)=>{if(b[e])b[e].push(a);else{var f,o;if(void 0!==t)for(var n=document.getElementsByTagName("script"),i=0;i{f.onerror=f.onload=null,clearTimeout(s);var c=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),c&&c.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=l.bind(null,f.onerror),f.onload=l.bind(null,f.onload),o&&document.head.appendChild(f)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={15018644:"1385",17896441:"7918","935f2afb":"53","344debb6":"54","29af3fe3":"92","03cdf430":"229",ab3acb2a:"604","5402824b":"1078","3e125dc6":"1148",b46b7d8b:"1172","18a433c4":"1210","7d26c06c":"1232",d07de6bd:"1251","723cbd1b":"1344","65b97a36":"1770","9c403616":"1817",e1923b53:"1947",f1994572:"2782",f3769d49:"2891","1f391b9e":"3085",ea96f03c:"3298",e289ecfd:"3523",c4f5d8e4:"4195",c97fbebf:"4286",ebbc57e7:"4808",c894e2df:"4878",c1147f98:"5202","5a6f97fe":"5275","874276e5":"5533","8b564e48":"5689",d1f710bd:"5798",bbf127f0:"5863","9093546b":"6164","23f3f2f9":"6174",a4043c8d:"6683","259b7029":"7026","9718a321":"7049",b0580eac:"7053","7b9432de":"7275","393be207":"7414",b1fc7db6:"8425","5da52a1e":"8938","8a56e0ba":"8957","0558eea0":"9042","365ebb01":"9293",d07072fe:"9404","1be78505":"9514","0e384e19":"9671",a5b5e7c9:"9853",c933c35c:"9960"}[e]||e,d.p+d.u(e)},(()=>{var e={1303:0,532:0};d.f.j=(a,t)=>{var b=d.o(e,a)?e[a]:void 0;if(0!==b)if(b)t.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var c=new Promise(((t,c)=>b=e[a]=[t,c]));t.push(b[2]=c);var r=d.p+d.u(a),f=new Error;d.l(r,(t=>{if(d.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var c=t&&("load"===t.type?"missing":t.type),r=t&&t.target&&t.target.src;f.message="Loading chunk "+a+" failed.\n("+c+": "+r+")",f.name="ChunkLoadError",f.type=c,f.request=r,b[1](f)}}),"chunk-"+a,a)}},d.O.j=a=>0===e[a];var a=(a,t)=>{var b,c,r=t[0],f=t[1],o=t[2],n=0;if(r.some((a=>0!==e[a]))){for(b in f)d.o(f,b)&&(d.m[b]=f[b]);if(o)var i=o(d)}for(a&&a(t);n{"use strict";var e,a,b,t,c,r={},f={};function d(e){var a=f[e];if(void 0!==a)return a.exports;var b=f[e]={id:e,loaded:!1,exports:{}};return r[e].call(b.exports,b,b.exports,d),b.loaded=!0,b.exports}d.m=r,d.c=f,e=[],d.O=(a,b,t,c)=>{if(!b){var r=1/0;for(i=0;i=c)&&Object.keys(d.O).every((e=>d.O[e](b[o])))?b.splice(o--,1):(f=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[b,t,c]},d.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return d.d(a,{a:a}),a},b=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,t){if(1&t&&(e=this(e)),8&t)return e;if("object"==typeof e&&e){if(4&t&&e.__esModule)return e;if(16&t&&"function"==typeof e.then)return e}var c=Object.create(null);d.r(c);var r={};a=a||[null,b({}),b([]),b(b)];for(var f=2&t&&e;"object"==typeof f&&!~a.indexOf(f);f=b(f))Object.getOwnPropertyNames(f).forEach((a=>r[a]=()=>e[a]));return r.default=()=>e,d.d(c,r),c},d.d=(e,a)=>{for(var b in a)d.o(a,b)&&!d.o(e,b)&&Object.defineProperty(e,b,{enumerable:!0,get:a[b]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((a,b)=>(d.f[b](e,a),a)),[])),d.u=e=>"assets/js/"+({53:"935f2afb",54:"344debb6",92:"29af3fe3",229:"03cdf430",604:"ab3acb2a",1078:"5402824b",1148:"3e125dc6",1172:"b46b7d8b",1210:"18a433c4",1232:"7d26c06c",1251:"d07de6bd",1344:"723cbd1b",1385:"15018644",1770:"65b97a36",1817:"9c403616",1947:"e1923b53",2782:"f1994572",2891:"f3769d49",3085:"1f391b9e",3298:"ea96f03c",3523:"e289ecfd",4195:"c4f5d8e4",4286:"c97fbebf",4808:"ebbc57e7",4878:"c894e2df",5202:"c1147f98",5275:"5a6f97fe",5533:"874276e5",5689:"8b564e48",5798:"d1f710bd",5863:"bbf127f0",6164:"9093546b",6174:"23f3f2f9",6683:"a4043c8d",7026:"259b7029",7049:"9718a321",7053:"b0580eac",7275:"7b9432de",7414:"393be207",7918:"17896441",8425:"b1fc7db6",8938:"5da52a1e",8957:"8a56e0ba",9042:"0558eea0",9293:"365ebb01",9404:"d07072fe",9514:"1be78505",9671:"0e384e19",9853:"a5b5e7c9",9960:"c933c35c"}[e]||e)+"."+{53:"1ec4dab0",54:"11ce8114",92:"b7aa3bac",229:"8a9a8dc7",604:"8c5a5100",1078:"71c03985",1148:"4cfeb910",1172:"1f4817c2",1210:"5df3b24e",1232:"3c3f36b6",1251:"cf69f933",1344:"9a02f066",1385:"6fe0ce4b",1770:"7909af7d",1817:"2692038c",1947:"d71b1720",2666:"44faa77f",2782:"ad8a18f1",2891:"76bc0d96",3085:"de6d2725",3298:"c0df1e45",3523:"d57d11c2",4195:"9c9906aa",4286:"b26e26ff",4808:"cf14015f",4878:"e4f93de7",4972:"6c3329cb",5202:"0681d850",5275:"2b5dfa6c",5533:"1df1dd8b",5689:"62bfda74",5798:"6916f84a",5863:"0a335c46",6164:"8ff0d5a1",6174:"54be1c3c",6683:"0fa0107a",7026:"98508766",7049:"2302384d",7053:"362a9d70",7275:"e298616d",7414:"c08b369d",7918:"6f3cf1c7",8425:"29933fec",8938:"c612a830",8957:"a5b96727",9042:"dd319e8b",9293:"1e3738c8",9404:"8c40faa0",9514:"d1735d66",9671:"459dce20",9853:"e682b0a5",9960:"bde7bf2d"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),t={},c="canine-docs:",d.l=(e,a,b,r)=>{if(t[e])t[e].push(a);else{var f,o;if(void 0!==b)for(var n=document.getElementsByTagName("script"),i=0;i{f.onerror=f.onload=null,clearTimeout(s);var c=t[e];if(delete t[e],f.parentNode&&f.parentNode.removeChild(f),c&&c.forEach((e=>e(b))),a)return a(b)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=l.bind(null,f.onerror),f.onload=l.bind(null,f.onload),o&&document.head.appendChild(f)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={15018644:"1385",17896441:"7918","935f2afb":"53","344debb6":"54","29af3fe3":"92","03cdf430":"229",ab3acb2a:"604","5402824b":"1078","3e125dc6":"1148",b46b7d8b:"1172","18a433c4":"1210","7d26c06c":"1232",d07de6bd:"1251","723cbd1b":"1344","65b97a36":"1770","9c403616":"1817",e1923b53:"1947",f1994572:"2782",f3769d49:"2891","1f391b9e":"3085",ea96f03c:"3298",e289ecfd:"3523",c4f5d8e4:"4195",c97fbebf:"4286",ebbc57e7:"4808",c894e2df:"4878",c1147f98:"5202","5a6f97fe":"5275","874276e5":"5533","8b564e48":"5689",d1f710bd:"5798",bbf127f0:"5863","9093546b":"6164","23f3f2f9":"6174",a4043c8d:"6683","259b7029":"7026","9718a321":"7049",b0580eac:"7053","7b9432de":"7275","393be207":"7414",b1fc7db6:"8425","5da52a1e":"8938","8a56e0ba":"8957","0558eea0":"9042","365ebb01":"9293",d07072fe:"9404","1be78505":"9514","0e384e19":"9671",a5b5e7c9:"9853",c933c35c:"9960"}[e]||e,d.p+d.u(e)},(()=>{var e={1303:0,532:0};d.f.j=(a,b)=>{var t=d.o(e,a)?e[a]:void 0;if(0!==t)if(t)b.push(t[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var c=new Promise(((b,c)=>t=e[a]=[b,c]));b.push(t[2]=c);var r=d.p+d.u(a),f=new Error;d.l(r,(b=>{if(d.o(e,a)&&(0!==(t=e[a])&&(e[a]=void 0),t)){var c=b&&("load"===b.type?"missing":b.type),r=b&&b.target&&b.target.src;f.message="Loading chunk "+a+" failed.\n("+c+": "+r+")",f.name="ChunkLoadError",f.type=c,f.request=r,t[1](f)}}),"chunk-"+a,a)}},d.O.j=a=>0===e[a];var a=(a,b)=>{var t,c,r=b[0],f=b[1],o=b[2],n=0;if(r.some((a=>0!==e[a]))){for(t in f)d.o(f,t)&&(d.m[t]=f[t]);if(o)var i=o(d)}for(a&&a(b);n Jackal Foundation | Jackal Chain Docs - +

Jackal Foundation

What is the Jackal Foundation?​

The Jackal Foundation serves as the cornerstone of the Jackal Community. As a non-profit organization, it propels development forward by conducting research, testing software, championing projects, and promoting decentralization.

What is the scope of the Jackal Foundation?​

  • Maintain and enhance the Jackal Protocol.
  • Allocate resources to foster ecosystem growth.
  • Establish and oversee Jackal Collectives.
  • Manage the core governance of the Jackal Protocol.
  • Uphold and implement changes resulting from the governance process.
- + \ No newline at end of file diff --git a/docs/contributors/join.html b/docs/contributors/join.html index 29e6aff..56da5c3 100644 --- a/docs/contributors/join.html +++ b/docs/contributors/join.html @@ -5,13 +5,13 @@ Join the Community! | Jackal Chain Docs - +

Join the Community!

The Jackal Community is open to all.​

The Jackal Protocol is a transparent, open source, and community-driven project. We welcome all who want to help build a self-custodial and secure digital future.

To contribute; please join below.​

- + \ No newline at end of file diff --git a/docs/contributors/labs.html b/docs/contributors/labs.html index a15f031..7cc5d5b 100644 --- a/docs/contributors/labs.html +++ b/docs/contributors/labs.html @@ -5,13 +5,13 @@ Jackal Labs | Jackal Chain Docs - +

Jackal Labs

Who is Jackal Labs?​

Jackal Labs, a Canadian software development company, played a pivotal role in the early development of the Jackal Protocol. As a decentralized and autonomous entity, the Jackal Protocol is not owned or operated by Jackal Labs. Instead, Jackal Labs contributes to the protocol's evolution by proposing changes through on-chain governance.

What is the scope of Jackal Labs?​

  • Spearhead the initial development of the Jackal Protocol.
  • Engage in ongoing research and development for the Protocol.
  • Suggest improvements to the protocol via the governance process.
- + \ No newline at end of file diff --git a/docs/ecosystem/bounties.html b/docs/ecosystem/bounties.html index bfcda0c..d99d974 100644 --- a/docs/ecosystem/bounties.html +++ b/docs/ecosystem/bounties.html @@ -5,13 +5,13 @@ Bounties | Jackal Chain Docs - +

Bounties

The Jackal Foundation often posts bounties which are tasks and projects that maintain the Jackal Protocol. Upon successful completion of a bounty, the reward will be released to the service provider. These bounties range in complexity from creating memes and blog publications to refactoring code.

TODO: To check out the Jackal Bounty Board, click HERE.

- + \ No newline at end of file diff --git a/docs/ecosystem/grants-funding.html b/docs/ecosystem/grants-funding.html index 090e85c..8c8a449 100644 --- a/docs/ecosystem/grants-funding.html +++ b/docs/ecosystem/grants-funding.html @@ -5,13 +5,13 @@ Grants and Funding | Jackal Chain Docs - +

Grants and Funding

The Jackal Foundation facilitates non-equity grants, seed funding, and beyond through our various funding programs. Ecosystem funding aims to focus on the following categories;

  • Research and Development
  • Infrastructure
  • Social Impact
  • dApps
  • Tooling
  • Services

For grants, applications will be reviewed based on the following criteria.

<100k100k - 200k200k+
One round of review.Two rounds of review.Interviews, formal committee review, full pitch.

For seed funding, the Jackal Foundation or Investment Network may support an ecosystem project with equity or token investments. For innovative founders that bring strategic value and adoption to the Jackal Ecosystem, please reach out directly to our team.

- + \ No newline at end of file diff --git a/docs/ecosystem/partnerships.html b/docs/ecosystem/partnerships.html index d33b2c2..3804462 100644 --- a/docs/ecosystem/partnerships.html +++ b/docs/ecosystem/partnerships.html @@ -5,13 +5,13 @@ Partnerships | Jackal Chain Docs - +

Partnerships

Blockchain and web3 native software engineering teams often wish to become core contributors through a partnership with the Jackal Foundation. In a partnership role, the team would be assigned direct tasks and held to a high standard of execution, professionalism, and accountability. If your team desires to partner with the Jackal Foundation, please reach out directly, we look forward to working with you.

- + \ No newline at end of file diff --git a/docs/explorer.html b/docs/explorer.html index af71d68..23999a9 100644 --- a/docs/explorer.html +++ b/docs/explorer.html @@ -5,13 +5,13 @@ Jackal Explorer | Jackal Chain Docs - +

Jackal Explorer

The Jackal Explorer is a “Light Explorer” that fetches data from Cosmos full node via LCD/RPC endpoints. This allows our users to explore transactions on the Jackal Blockchain.

TODO: Explorer How-To

Explorer Images

- + \ No newline at end of file diff --git a/docs/intro.html b/docs/intro.html index 968a859..dd36e85 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -5,13 +5,13 @@ Welcome to Jackal Wiki | Jackal Chain Docs - +

Welcome to Jackal Wiki

Welcome, explorer, to the Jackal Wiki, where you'll embark on a journey to discover a more secure, simple, and self-custodial digital world.

The Jackal Protocol, an open-source and community-driven innovation, fosters a transparent and trustless ecosystem. You've found the ultimate hub for all things Jackal: protocol insights, usage tips, infrastructure knowledge, and unique opportunities.

Our enthusiastic teams at Jackal Labs and the Jackal Foundation diligently maintain the Jackal Wiki. If you happen to spot outdated information, don't hesitate to reach out—your input helps us ensure accuracy for the entire community. Let's shape the future of digital experiences together!

- + \ No newline at end of file diff --git a/docs/nodes/install.html b/docs/nodes/install.html index c045573..670ab1b 100644 --- a/docs/nodes/install.html +++ b/docs/nodes/install.html @@ -5,13 +5,13 @@ Setting Up | Jackal Chain Docs - +

Setting Up

Pre-Requisites​

There are a few things needed before installing.

While logged in as the 'root' or 'admin' user, we add a 'jackal' user and give them root privileges.

Enable Firewall Rules​

Enabling the firewall is important to ensure your hardware remains secure. The following commands will add rules required for access on both validators and providers:

sudo ufw allow 22
sudo ufw allow 80
sudo ufw allow 443

Additional ports are required if you are running a validator:

sudo ufw allow 26657
sudo ufw allow 26658

The only additional port required for a provider is 3333:

sudo ufw allow 3333

If you are running a combined validator/provider, you need to allow all of the above ports. After adding ports to the rules list, you will need to start the firewall:

sudo ufw enable

After starting the firewall, verify all of the required rules are in place by running:

sudo ufw status verbose

Your output should be similar to the following:

Status: active

To                         Action      From
--                         ------      ----
22                         ALLOW       Anywhere
80                         ALLOW       Anywhere
443                        ALLOW       Anywhere
1317                       ALLOW       Anywhere
3333                       ALLOW       Anywhere
26657                      ALLOW       Anywhere
26658                      ALLOW       Anywhere

Create Jackal user​

sudo adduser --gecos "" jackal
sudo usermod -aG sudo jackal

Log in as the jackal user to complete the below steps:

sudo su - jackal

Installing required tools​

This will install the necessary tools to build the jackal chain source, along with lz4 compression tool and jquery tool.

sudo apt update
sudo apt install build-essential lz4 jq

Installing Go​

Follow more in-depth instructions to install Go v1.19 or higher here.

On Ububtu you can install it with:

GOVER=$(curl https://go.dev/VERSION?m=text)
wget https://golang.org/dl/${GOVER}.linux-amd64.tar.gz
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf ${GOVER}.linux-amd64.tar.gz

Add the following golang path info to the current users ~/.profile.

Also add it to the skeleton profile so all new users have it. /etc/skel/.profile

# add environmental variables for Go
if [ -f "/usr/local/go/bin/go" ] ; then
    export GOROOT=/usr/local/go
    export GOPATH=${HOME}/go
    export GOBIN=$GOPATH/bin
    export PATH=${PATH}:${GOROOT}/bin:${GOBIN}
    export GO111MODULE=on
fi

Restarting the shell with youre profile settings or just rebasing them like so is required.

source ~/.profile
- + \ No newline at end of file diff --git a/docs/nodes/nodes/hardware.html b/docs/nodes/nodes/hardware.html index afc22bb..7c4e469 100644 --- a/docs/nodes/nodes/hardware.html +++ b/docs/nodes/nodes/hardware.html @@ -5,13 +5,13 @@ Hardware | Jackal Chain Docs - +

Hardware

We recommend a minimum hardware requirement of:

  • 4 Cores (modern CPU's)
  • 32GB RAM
  • 1TB of storage (SSD or NVME)

We also recommend running an Ubuntu LTS OS as that is what the binaries have been tested against.

- + \ No newline at end of file diff --git a/docs/nodes/nodes/installation.html b/docs/nodes/nodes/installation.html index 111fe7c..e041ae5 100644 --- a/docs/nodes/nodes/installation.html +++ b/docs/nodes/nodes/installation.html @@ -5,13 +5,13 @@ Installing Canined | Jackal Chain Docs - +

Installing Canined

Pre-Requisites​

See Set-up.

Firewall Configuration​

Configure UFW to only accept traffic on ports we use.

ufw limit ssh/tcp comment 'Rate limit for openssh server'
ufw default deny incoming
ufw default allow outgoing
ufw allow 26656/tcp comment 'JACKAL - Cosmos SDK/Tendermint P2P'
ufw allow 26657/tcp comment 'JACKAL - Cosmos SDK/Tendermint P2P'
ufw enable
tip

Perform the next follow steps as your jackal user with 'sudo' permissions

Creating a Service​

You may want the daemon to run without you needing to supervise it. To turn the executable into a service follow these steps.

First create the service file /etc/systemd/system/canined.service

sudo nano /etc/systemd/system/canined.service

Copy and paste the follow into the service file: (you may need to edit it if you've set a custom home directory location)

[Unit]
Description=Jackal Validator
After=network.target

[Service]
Group=jackal
User=jackal
WorkingDirectory=/home/jackal
ExecStart=/home/jackal/go/bin/canined start
Restart=on-failure
RestartSec=3
LimitNOFILE=8192

[Install]
WantedBy=multi-user.target

Update systemd and enable the service file.

sudo systemctl daemon-reload
sudo systemctl enable canined.service

Building from Source​

Replace <VERSION> with the current running version.

git clone https://github.com/JackalLabs/canine-chain.git
cd canine-chain
git fetch -a
git checkout <VERSION>

make install

From there you will be able to use canined, ex:

canined version
- + \ No newline at end of file diff --git a/docs/nodes/nodes/mainnet.html b/docs/nodes/nodes/mainnet.html index 68187e2..ccfc34d 100644 --- a/docs/nodes/nodes/mainnet.html +++ b/docs/nodes/nodes/mainnet.html @@ -5,14 +5,14 @@ Joining Mainnet | Jackal Chain Docs - +

Joining Mainnet

tip

Perform the following as the jackal user.

After installing canined. You can join the mainnet by following these steps:

canined init "NODE_NAME" --chain-id=jackal-1

Then we want to replace our generated genesis file with the one used to start the network.

wget -O ~/.canine/config/genesis.json https://cdn.discordapp.com/attachments/1002389406650466405/1034968352591986859/updated_genesis2.json

SEEDS=$(wget https://raw.githubusercontent.com/JackalLabs/canine-mainnet-genesis/master/genesis/seeds.txt -q -O -)
PEERS=`curl -sL https://raw.githubusercontent.com/JackalLabs/canine-mainnet-genesis/master/genesis/peers.txt | sort -R | head -n $PEERCOUNT | awk '{print $1}' | paste -s -d, -`
GAS="0.002ujkl"

sed -i.bak -e "s/^seeds *=.*/seeds = \"$SEEDS\"/; s/^persistent_peers *=.*/persistent_peers = \"$PEERS\"/" $HOME/.canine/config/config.toml

Backing up key files​

The created node_key.json and priv_validator_key.json cannot be recovered. These files must be backed up.

mkdir ~/key_backup
cp ~/.canine/config/node_key.json ~/key_backup
cp ~/.canine/config/priv_validator_key.json ~/key_backup

You should also keep an offline backup. Using a program like WinSCP, you can easily copy these files to your personal desktop for safe storage/backup.

Syncing to Current Height​

Snapshot method​

Get a snapshot here.

For the sake of this guide, the snapshot we download is named jackal.tar.lz4

If you plan on becoming a validator, before using the unsafe-reset-all flag, always besure to back up your priv_validator_state.json file. 

canined unsafe-reset-all --keep-addr-book
lz4 -c -d jackal.tar.lz4  | tar -x -C $HOME/.canine

Then start the chain again.

State Sync Method​

There are a couple of ways to go about doing state sync. First is the easier route. Visit Ping.pub for Jackals State Sync configuration settings.

Next, copy these settings from Ping.pub to your config.toml in the [statesync] section.

It should look similar to this:

#######################################################
###         State Sync Configuration Options        ###
#######################################################
[statesync]
# State sync rapidly bootstraps a new node by discovering, fetching, and restoring a state machine
# snapshot from peers instead of fetching and replaying historical blocks. Requires some peers in
# the network to take and serve state machine snapshots. State sync is not attempted if the node
# has any local state (LastBlockHeight > 0). The node will have a truncated block history,
# starting from the height of the snapshot.
enable = true

# RPC servers (comma-separated) for light client verification of the synced state machine and
# retrieval of state data for node bootstrapping. Also needs a trusted height and corresponding
# header hash obtained from a trusted source, and a period during which validators can be trusted.
#
# For Cosmos SDK-based chains, trust_period should usually be about 2/3 of the unbonding time (~2
# weeks) during which they can be financially punished (slashed) for misbehavior.
rpc_servers = "https://rpc.jackalprotocol.com:443,https://rpc.jackalprotocol.com:443"
trust_height = 333000
trust_hash = "1685850c2d115a86af9059bd3f36a4fbbb0e8ba7f37863d517b6d2f54116daca"
trust_period = "168h"  # 2/3 of unbonding time

# Time to spend discovering snapshots before initiating a restore.
discovery_time = "15s"

# Temporary directory for state sync snapshot chunks, defaults to the OS tempdir (typically /tmp).
# Will create a new, randomly named directory within, and remove it when done.
temp_dir = ""

# The timeout duration before re-requesting a chunk, possibly from a different
# peer (default: 1 minute).
chunk_request_timeout = "10s"

# The number of concurrent chunk fetchers to run (default: 1).
chunk_fetchers = "42"

State syncing can take up to a few minutes to complete. Watch the logs to ensure it's happening. When a snapshot is found, you will see output in your log that is similar to this:

1PM INF Discovered new snapshot format=1 hash="S.�h�F���\"\x1d6+\x1e���ޅ��`v@�ц�����" height=1810000 module=statesync

It will download, verify, and apply chuncks of blockchain data. When it finishes you will see it catching up to blocks

State Sync Method 2​

The follow commandline code will edit your config.toml with the proper information for state syncing to the most recent snapshot 3000 blocks and beyond.

STATE_SYNC_RPC=https://rpc.jackalprotocol.com:443
LATEST_HEIGHT=$(curl -s $STATE_SYNC_RPC/block | jq -r .result.block.header.height)
SYNC_BLOCK_HEIGHT=$(($LATEST_HEIGHT - 3000))
SYNC_BLOCK_HASH=$(curl -s "$STATE_SYNC_RPC/block?height=$SYNC_BLOCK_HEIGHT" | jq -r .result.block_id.hash)

sed -i.bak -e "s|^enable *=.*|enable = true|" $HOME/.teritorid/config/config.toml
sed -i.bak -e "s|^rpc_servers *=.*|rpc_servers = \"$STATE_SYNC_RPC,$STATE_SYNC_RPC\"|" \
  $HOME/.teritorid/config/config.toml
sed -i.bak -e "s|^trust_height *=.*|trust_height = $SYNC_BLOCK_HEIGHT|" \
  $HOME/.teritorid/config/config.toml
sed -i.bak -e "s|^trust_hash *=.*|trust_hash = \"$SYNC_BLOCK_HASH\"|" \
  $HOME/.teritorid/config/config.toml

When you state sync, you can start with the latest version of canined.

Versions for Sync​

block heightcanined version
453811.1.2
01.1.0

Starting the daemon​

Start the daemon and sync to the current height.

sudo systemctl start jackal
sudo journalctl -u jackal -f

Watch the logs and ensure you are either state syncing correctly, or are syncing up to the current height.

- + \ No newline at end of file diff --git a/docs/nodes/nodes/testnet.html b/docs/nodes/nodes/testnet.html index 50bc716..ea2ad43 100644 --- a/docs/nodes/nodes/testnet.html +++ b/docs/nodes/nodes/testnet.html @@ -5,13 +5,13 @@ Joining Testnet | Jackal Chain Docs - +

Joining Testnet

After installing canined. You can join the testnet by following these steps:

canined init <alias> --chain-id=<chain-id>
note

chain-id for testnet is currently lupulella-2.

Then we want to replace our generated genesis file with the one used to start the network. We also need to set our peers and seeds.

For an updated list of peers & seeds, please check this page.

wget -O ~/.canine/config/genesis.json https://raw.githubusercontent.com/JackalLabs/jackal-chain-assets/main/testnet/genesis.json

export SEEDS="84f520678ef59ea02f942fa6323ec562ca5a3249@45.79.161.178:26656,cecc087977336da1e9ccd2c50097cd9e7d5e1874@141.95.33.39:26656"
sed -i.bak -e "s/^seeds *=.*/seeds = \"$SEEDS\"/" ~/.canine/config/config.toml

As a validator, you'll need to set a minimum gas price like so:

GAS="0.002ujkl"
sed -i.bak -e "s/^minimum-gas-prices *=.*/minimum-gas-prices = \"$GAS\"/" $HOME/.canine/config/app.toml
- + \ No newline at end of file diff --git a/docs/nodes/providers/building.html b/docs/nodes/providers/building.html index c3eb286..5d7f9b2 100644 --- a/docs/nodes/providers/building.html +++ b/docs/nodes/providers/building.html @@ -5,13 +5,13 @@ Creating Provider | Jackal Chain Docs - +

Creating Provider

Disclaimer​

This guide assumes you either have access to a full node over a network connection or are using the same machine as the full node.

Networking​

To allow your provider to be used by the Jackal Protocol Dashboard, please ensure you have a reverse proxy system setup and have a registered domain name pointing to your provider. We recommend using Nginx.

If you have UPNP enabled on your router, your provider will be open to the internet by default at port 3333. You can find the address it can be connected to by running canined network ip.

Setting up ZFS Without Mirroring​

Setting up ZFS allows us to combine multiple drives together, in this case we are merging two drives. We don't recommend you only merge drives with striping and instead we recommend mirroring. However mirroring is a longer process and different for each configuration. In our case, this machine is only running with 24TB across 2 drives. We are less concerned about a drive failing as that would wipe half our storage anyways.

List all drives with :

sudo fdisk -l

You should end up seeing something like this

...

Disk /dev/sda: 12.75 TiB, 14000519643136 bytes, 27344764928 sectors
Disk model: ST14000NM001G-2K
Units: sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 4096 bytes
I/O size (minimum/optimal): 4096 bytes / 4096 bytes
Disklabel type: gpt
Disk identifier: 4DE192A1-7AFF-F64D-93D5-CA48B806DAA0

Disk /dev/sdb: 12.75 TiB, 14000519643136 bytes, 27344764928 sectors
Disk model: ST14000NM001G-2K
Units: sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 4096 bytes
I/O size (minimum/optimal): 4096 bytes / 4096 bytes
Disklabel type: gpt
Disk identifier: D2827F71-7F0A-EE4A-BB12-1B2172641DBE

...

Note down the Disk paths that you wish to use for your storage provider, in this case it is /dev/sdb and /dev/sda.

We install ZFS and create a new pool as follows:

sudo apt install zfsutils-linux

sudo zpool create {pool-name} /dev/sda /dev/sdb ...

sudo zpool status

This folder will now have the drives mounted at /{pool-name}. For more in-depth guides to using zfs, check out this page.

- + \ No newline at end of file diff --git a/docs/nodes/providers/setting_up.html b/docs/nodes/providers/setting_up.html index 9c529b4..57cf57c 100644 --- a/docs/nodes/providers/setting_up.html +++ b/docs/nodes/providers/setting_up.html @@ -5,7 +5,7 @@ Setting Up JProvd | Jackal Chain Docs - + @@ -19,7 +19,7 @@ If you are not running your own tendermint RPC node, Jackal Labs is currently ho Testnet tokens can be obtained at https://testnet-faucet.jackalprotocol.com/ Mainnet tokens can be purchased on https://frontier.osmosis.zone/

  1. Initialize the provider 
jprovd init {FQDN} {STORAGE_IN_BYTES} {KEYBASE_IDENTITY} --home=$PHOME

example:

jprovd init "https://storagep1.chainstrategies.cloud" "9000" "" --home=$PHOME

Please note that 'https://' is required to be included in the FQDN or init will throw an error. Link for TB to Bytes converter: https://www.convertunits.com/from/TB/to/byte

  1. Start the provider 
jprovd start --home=$PHOME
- + \ No newline at end of file diff --git a/docs/nodes/validators/joining.html b/docs/nodes/validators/joining.html index 3779452..e96987e 100644 --- a/docs/nodes/validators/joining.html +++ b/docs/nodes/validators/joining.html @@ -5,13 +5,13 @@ Creating Validator | Jackal Chain Docs - +

Creating Validator

tip

This guide assumes you are using the same machine as the full node.

Perform the following steps as your jackal user.

Creating A Wallet​

We need to create a wallet and set the keyring password.

canined keys add WALLET_NAME --keyring-backend os

This wallet is used to claim rewards, commission and to vote as your validator.

You will see a similar output once created.

- name: WALLET_NAME
  type: local
  address: jkl1hjhglrzggqtdhsh3ag8jp0cckmva5pe976jxel
  pubkey: '{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"Rnrlv1TNrt1cz3+pSq2UDNiJQZINNlgtkNousVlkugZ7"}'
  mnemonic: ""


**Important** write this mnemonic phrase in a safe place.
It is the only way to recover your account if you ever forget your password.

some words forming mnemonic seed will be placed here you have to write them down and keep them safe

Besure to back up the seed phrase of your validator wallet. It's also recommened to keep an offline copy along with your key files. Remember, your key files cannot be restored and must be backed up. See the installation page for instructions.

You should also backup your keyring files.

Change WALLET_NAME to the name of your wallet.

mkdir ~/keyring_backup
cp ~/.canine/WALLET_NAME.info ~/keyring_backup
cp ~/.canine/keyhash ~/keyring_backup

Setting Up​

Configure Gas Prices​

As a validator, you'll need to set a minimum gas price like so:

GAS="0.02ujkl"
sed -i.bak -e "s/^minimum-gas-prices *=.*/minimum-gas-prices = \"$GAS\"/" $HOME/.canine/config/app.toml

Create Your Validator​

Before continuing, please note that commission-max-change and commission-max-rate cannot be changed once you set them. Your commission-rate may be changed once per day.

There are a few things you will need to alter in this command. amount needs to be changed to what you are starting your self bond as. from needs to be the name of your wallet you created earlier. The moniker, details, identity, website, and security-contact should all be filled with the appropiate information.

canined tx staking create-validator \
    --amount 1000000ujkl \
    --commission-max-change-rate 0.10 \
    --commission-max-rate 0.2 \
    --commission-rate 0.1 \
    --from WALLET_NAME \
    --min-self-delegation 1 \
    --moniker "YOUR_MONIKER" \
    --details="YOUR DETAILS" \
    --identity "PGP IDENTITY" \
    --website="https://example.com" \
    --security-contact="your-email@email.com" \
    --pubkey $(canined tendermint show-validator) \
    --chain-id jackal-1 \
    --gas-prices 0.02ujkl
- + \ No newline at end of file diff --git a/docs/official-links/jackal-foundation.html b/docs/official-links/jackal-foundation.html index 3642592..bf840a2 100644 --- a/docs/official-links/jackal-foundation.html +++ b/docs/official-links/jackal-foundation.html @@ -5,13 +5,13 @@ Jackal Foundation Links | Jackal Chain Docs - +

Jackal Foundation Links

Here are the official website links for Jackal Foundation. Please use and bookmark these links to reduce the likelihood of cyber phishing threats.

Jackal Foundation​

Jackal Foundation Twitter

Website: Coming Soon

- + \ No newline at end of file diff --git a/docs/official-links/jackal-labs.html b/docs/official-links/jackal-labs.html index 2a97f5b..b00861e 100644 --- a/docs/official-links/jackal-labs.html +++ b/docs/official-links/jackal-labs.html @@ -5,13 +5,13 @@ Jackal Labs Links | Jackal Chain Docs - +

Jackal Labs Links

Here are the official website links for Jackal Labs. Please use and bookmark these links to reduce the likelihood of cyber phishing threats.

Jackal Labs​

Jackal Labs Twitter

Website: Coming Soon

- + \ No newline at end of file diff --git a/docs/official-links/jackal-protocol.html b/docs/official-links/jackal-protocol.html index e09975c..c8d9e23 100644 --- a/docs/official-links/jackal-protocol.html +++ b/docs/official-links/jackal-protocol.html @@ -5,13 +5,13 @@ Jackal Protocol Links | Jackal Chain Docs - +
- + \ No newline at end of file diff --git a/docs/overview/jackal-tldr.html b/docs/overview/jackal-tldr.html index 690f786..eb66315 100644 --- a/docs/overview/jackal-tldr.html +++ b/docs/overview/jackal-tldr.html @@ -5,13 +5,13 @@ Discover the Jackal Protocol | Jackal Chain Docs - +

Discover the Jackal Protocol

The Jackal Protocol provides a decentralized infrastructure for secure and scalable data storage, enabling individuals, developers, and enterprises to protect their data privacy and improve their cybersecurity posture. It offers a platform for building decentralized applications, managing access control and ownership, transferring encrypted data, and maintaining self-custodial control over data, all without relying on centralized storage providers or intermediaries.

Jackal Protocol stands apart, utilizing both validators and storage providers, enabling developers to create decentralized applications with seamless access to all Jackal Protocol Modules, including storage contracts and file structures. Customize data ownership, share data with other Jackal users or smart contracts, and transfer encrypted data of any size, all without centralized storage providers or middleware. Your data remains self-custodial, ensuring that no one—not even the Jackal team—can access or view it.

Comprising seven interoperable modules — jklMint, lp, rns, wasm, storage, filetree, and dsig — the Jackal Protocol allows for the development of secure, scalable, and truly decentralized applications .

The Jackal Protocol is open source and community-driven, fostering a transparent and trustless ecosystem. Dive into this wiki to access comprehensive information on the protocol, usage, infrastructure, and opportunities.

Maintained by the dedicated Jackal Labs and Jackal Foundation teams, the Jackal Wiki is constantly updated to ensure accuracy. Should you discover anything out-of-date, don't hesitate to reach out, as we strive to keep our documentation impeccable for the community.

- + \ No newline at end of file diff --git a/docs/overview/jkl.html b/docs/overview/jkl.html index 943ed4f..df7c192 100644 --- a/docs/overview/jkl.html +++ b/docs/overview/jkl.html @@ -5,13 +5,13 @@ What Is The JKL Token? | Jackal Chain Docs - +

What Is The JKL Token?

The JKL Token is the driving force behind the revolutionary Jackal Protocol. This versatile native token seamlessly integrates with the ecosystem, unlocking endless possibilities for users, developers, and enterprises alike.

What Does The JKL Token Do?​

Fueling dApps​

JKL Token plays a pivotal role in applications built on the Jackal Protocol, such as Jackal Storage and the RNS Marketplace. By harnessing the power of JKL, these applications can unlock new potentials and further enhance their utility.

Network Security​

At its core, the Jackal Protocol is a Proof-of-Stake (PoS) Cosmos L1 blockchain, relying on JKL delegation to validators for network security. Stake your JKL tokens and contribute to securing the network while earning rewards.

Affordable Transactions​

With JKL, transaction fees on the Jackal Protocol are incredibly cost-effective, ensuring that users have an affordable and seamless experience.

Governance​

Staked JKL tokens grant you the power to participate in on-chain governance within the Jackal Protocol. Make your voice heard by voting on text, software, spending, and other critical governance proposals.

Collateral​

The JKL token serves as versatile collateral for validators, storage providers, and various smart contract use cases, unlocking new possibilities for users and developers.

Liquidity​

Put your JKL tokens to work by allocating them into a liquidity pool and earn JKL rewards in return. Contribute to the ecosystem while reaping the benefits of your investment.

Data Storage​

The JKL token serves as the primary medium of exchange for accessing data storage within the Jackal Protocol, ensuring a smooth and efficient market for users and storage providers alike.

- + \ No newline at end of file diff --git a/docs/overview/why-jackal.html b/docs/overview/why-jackal.html index 670e71f..e2737ec 100644 --- a/docs/overview/why-jackal.html +++ b/docs/overview/why-jackal.html @@ -5,13 +5,13 @@ Why Choose Jackal Protocol | Jackal Chain Docs - +

Why Choose Jackal Protocol

The Jackal Protocol offers various advantages for individuals, small businesses, and large enterprises seeking secure, decentralized data storage and management solutions.

Individuals​

Individuals choose the Jackal Protocol for several reasons:

Enhanced data privacy and security​

The decentralized nature of the Jackal Protocol ensures that your data is stored across multiple nodes, reducing the risk of data breaches and unauthorized access.

Self-custodial storage​

The Jackal Protocol allows individuals to retain full control over their data, ensuring that no third party, not even the Jackal team, can access or view it without the user's consent.

On-chain permissions​

The transparent and secure permissions system enables users to manage access to their data, granting, revoking, or modifying permissions as needed.

Small Businesses​

Small businesses benefit from the Jackal Protocol in various ways:

Cost-effective storage​

With the Jackal Protocol's decentralized storage model, businesses can benefit from competitive pricing, making it more affordable than traditional centralized storage solutions.

Scalability​

The Jackal Protocol is built to scale with your business, ensuring that your data storage capacity can grow as your organization expands.

Simplified compliance​

Jackal Protocol's immutable records of data access and modification make it easier to meet industry-specific regulatory requirements and simplify auditing processes.

Large Enterprises​

Large enterprises can leverage the Jackal Protocol for:

Improved data governance​

The on-chain permissions system allows for transparent and secure management of data access, ensuring that sensitive information remains protected and accessible only to authorized personnel.

Enhanced security​

By leveraging the decentralized infrastructure, Jackal Protocol offers an additional layer of security for enterprise data storage, reducing the risk of cyber-attacks and data breaches.

Customizable solutions​

The Jackal Protocol enables developers to build and deploy a wide range of decentralized applications (dApps) that can interact with user data, opening up new possibilities for services and products that prioritize user privacy and control.

- + \ No newline at end of file diff --git a/docs/protocol/encryption.html b/docs/protocol/encryption.html index fd54016..0ea930d 100644 --- a/docs/protocol/encryption.html +++ b/docs/protocol/encryption.html @@ -5,13 +5,13 @@ Encryption | Jackal Chain Docs - +

Encryption

Jackal has two main features that rely on encryption techniques to keep user data private and secure. The two main models are file encryption and file-entry encryption. These reside in different locations within the protocol. The files themselves are stored on Storage Providers, which require files to be encrypted before they are transferred to those machines. The file entries are data structures living directly on-chain in the File Tree blockchain module, again needing to be encrypted on the client's device before being sent to the blockchain. The file encryption model is simply performed by taking the file as raw bytes and randomly generating a key in the user's client. This key is called a Symmetric Key. We then pass both the key and the file through AES256 encryption, which results in an encrypted file that can safely be sent to the Storage-Providers.

Protocol Overview

What is done with this key is equally important as the encryption performed on the file; if the key were made public, all encryption on the file itself would be naught. Therefore, we need to store this key somewhere safe and immutable. This safe place is the Jackal Chain, specifically the File Tree Module. The key is stored in the encrypted form alongside the file's location to make mapping each key to its respective file easy. To get this key into its encrypted form, we use an Integrated Encryption Scheme based on AES and the Elliptic Curve used to generate Bech32 Addresses [Reference]. To do this, the protocol takes a user's public key and encrypts the private key with it.

Protocol Overview

After this, the protocol ends up with an encrypted key that only the user whose public key was used can decrypt. When looking to decrypt a file, the process is reversed and instead uses the user's private key to decrypt the symmetric key. Following the retrieval of the symmetric key, we can decrypt the file stored on the Storage-Providers, leaving us with the originally uploaded file.

Protocol Overview

When sharing files, we can semi-repeat this process by first decrypting the key from the chain. Then we can grab the public key of an external user from the chain itself and encrypt the files with that key instead of our own. Finally, we append the newly encrypted symmetric key to the file entry giving that user access to the key.

- + \ No newline at end of file diff --git a/docs/protocol/modules/dsig.html b/docs/protocol/modules/dsig.html index 327910e..35e0ea5 100644 --- a/docs/protocol/modules/dsig.html +++ b/docs/protocol/modules/dsig.html @@ -5,13 +5,13 @@ dsig Module | Jackal Chain Docs - +
-
- + + \ No newline at end of file diff --git a/docs/protocol/modules/filetree.html b/docs/protocol/modules/filetree.html index c8dfa64..d2f7c2c 100644 --- a/docs/protocol/modules/filetree.html +++ b/docs/protocol/modules/filetree.html @@ -3,15 +3,15 @@ -filetree Module | Jackal Chain Docs +Filetree Module | Jackal Chain Docs - +
-

filetree Module

Overview​

The File Tree module is responsible for keeping records of a user's files and organizing them in a way that is accessible. When a user uploads a file using the Storage module, the file is only accessible from the File ID (FID) which makes the process clunky and obtuse to remember every file uploaded to Jackal. Furthermore, every single upload would be required to be public, or the user would need to keep track of every symmetric key used to encrypt the files and manually map them to the FIDs. The solution to this is a tree structure storing each file as an entry in the tree. Organizing this structure is also trivial as we can assign children to pseudo files that we call folders. Finally to keep track of encryption keys, the protocol maps every file to its respective key.

Protocol Overview

Folder Abstraction​

These, of course, are all abstractions of what’s actually under the hood. The File Tree module doesn’t actually handle any of the folder logic, the system believes it is storing files that act as metadata stores, which then update to reflect changes in folders. This gives the user experience the feeling that folders and files are separate entities in the tree, but in reality they are identical.

File Entry Structure​

Storing file entries on-chain is a hurdle being that the chain itself is public. This requires the use of client-side encryption before uploading data to the chain itself. The main component of a file is location (Address), allowing users to query the rest of the data from the file. You can think of the location as a key in a traditional key-value store or a path in bucket-based storage. The address is hashed using SHA256 to ensure it is impossible to retrieve the plain-text representation of the file name, while still being able to query the file using its given name.

Protocol Overview

The second most important data point in a file is the content of the file, this field is extremely versatile as it can store any string. Traditionally this is used to store a JSON list of FIDs to point to a file on the Storage Module, however, the protocol can also theoretically use it to store short bits of text like encrypted passwords for a private password manager. The owner tag is a hashed version of the owner hiding what address owns each file, this field can be changed to reflect the transferral of ownership. When making changes to the file such as deletion, movement or adding/removing viewers/editors, the owner field is consulted to determine permissions. The same applies for edit access, editors can update the contents but nothing else.

Encrypted Viewing Access​

For users to view files, they need access to the symmetric keys used to encrypt the files. To do this, the protocol has a map of hashed addresses with each user’s respective version of the symmetric key encrypted with that address's corresponding public key. The protocol can then store that map in the file entry to act as an encryption key discovery layer. The addresses in this viewing list are only able to access files and decrypt the data in their client, they have no privileges over the modification of the file entry in any way.

- +

Filetree Module

Overview​

The Jackal Filetree module is responsible for organizing and managing user files in a secure and user-friendly way. When a user uploads a file using the Storage module, the file is only accessible from the File ID (FID), which can be challenging to remember for every file uploaded to Jackal. Additionally, every single upload would be required to be public, or the user would need to keep track of every symmetric key used to encrypt the files and manually map them to the FIDs. To address this issue, the File Tree module implements a tree structure to store each file as an entry in the tree. Organizing this structure is also trivial as we can assign children to pseudo files that we call folders. Finally, to keep track of encryption keys, the protocol maps every file to its respective key, emphasizing the security and privacy posture that the File Tree module enables.

Protocol Overview

Folder Abstraction​

These, of course, are all abstractions of what's actually under the hood. The File Tree module doesn't actually handle any of the folder logic; the system believes it is storing files that act as metadata stores, which then update to reflect changes in folders. This gives the user experience the feeling that folders and files are separate entities in the tree, but in reality, they are identical.

File Entry Structure​

Storing file entries on-chain is a challenge since the chain itself is public. This requires the use of client-side encryption before uploading data to the chain itself. The main component of a file is location (Address), allowing users to query the rest of the data from the file. You can think of the location as a key in a traditional key-value store or a path in bucket-based storage. The address is hashed using SHA256 to ensure it is impossible to retrieve the plain-text representation of the file name while still being able to query the file using its given name.

Protocol Overview

The second most important data point in a file is the content of the file. This field is extremely versatile as it can store any string. Traditionally this is used to store a JSON list of FIDs to point to a file on the Storage Module; however, the protocol can also theoretically use it to store short bits of text like encrypted passwords for a private password manager. The owner tag is a hashed version of the owner, hiding what address owns each file. This field can be changed to reflect the transferral of ownership. When making changes to the file such as deletion, movement, or adding/removing viewers/editors, the owner field is consulted to determine permissions. The same applies to edit access; editors can update the contents but nothing else.

Encrypted Viewing Access​

For users to view files, they need access to the symmetric keys used to encrypt the files. To do this, the protocol has a map of hashed addresses with each user's respective version of the symmetric key encrypted with that address's corresponding public key. The protocol can then store that map in the file entry to act as an encryption key discovery layer. The addresses in this viewing list are only able to access files and decrypt the data in their client; they have no privileges over the modification of the file entry in any way. This approach ensures that the File Tree module maintains a strong security and privacy posture for user data.

+ \ No newline at end of file diff --git a/docs/protocol/modules/jklmint.html b/docs/protocol/modules/jklmint.html index f1d0848..d93ce69 100644 --- a/docs/protocol/modules/jklmint.html +++ b/docs/protocol/modules/jklmint.html @@ -5,13 +5,13 @@ JKLmint Module | Jackal Chain Docs - +
-

JKLmint Module

The jklmint module is responsible for the management of the native JKL token within the Jackal Protocol. This module handles the issuance, distribution, and inflation of JKL tokens, ensuring a stable and secure token economy.

Overview​

The jklmint module manages the following aspects of the JKL token:

  1. Token Issuance: Determines the initial token supply and distribution.
  2. Inflation: Manages the annual inflation rate, maintaining a consistent token supply growth.
  3. Rewards Distribution: Handles the allocation of newly minted tokens as rewards for validators and delegators.

Parameters​

The jklmint module uses the following parameters to manage the JKL token economy:

  • inflation_rate: The annual percentage rate at which the token supply will grow.
  • inflation_min: The minimum annual inflation rate allowed.
  • inflation_max: The maximum annual inflation rate allowed.
  • goal_bonded: The desired percentage of the total token supply that should be staked by validators and delegators.
  • blocks_per_year: The estimated number of blocks produced in a year.
- +

JKLmint Module

The jklmint module is responsible for the management of the native JKL token within the Jackal Protocol. This module handles the issuance, distribution, and inflation of JKL tokens, ensuring a stable and secure token economy.

Overview​

The jklmint module manages the following aspects of the JKL token:

  1. Token Issuance: Determines the initial token supply and distribution.
  2. Inflation: Manages the annual inflation rate, maintaining a consistent token supply growth.
  3. Rewards Distribution: Handles the allocation of newly minted tokens as rewards for validators and delegators.

Parameters​

The jklmint module uses the following parameters to manage the JKL token economy:

  • inflation_rate: The annual percentage rate at which the token supply will grow.
  • inflation_min: The minimum annual inflation rate allowed.
  • inflation_max: The maximum annual inflation rate allowed.
  • goal_bonded: The desired percentage of the total token supply that should be staked by validators and delegators.
  • blocks_per_year: The estimated number of blocks produced in a year.
+ \ No newline at end of file diff --git a/docs/protocol/modules/lp.html b/docs/protocol/modules/lp.html index a751a5b..7ca8797 100644 --- a/docs/protocol/modules/lp.html +++ b/docs/protocol/modules/lp.html @@ -5,13 +5,13 @@ LP Module (Coming Soon) | Jackal Chain Docs - +
-

LP Module (Coming Soon)

The lp (Liquidity Provision) module is a vital part of the Jackal Protocol, enabling the creation and management of liquidity pools for trading and swapping tokens. This module provides a decentralized solution for users to contribute liquidity to the ecosystem and earn rewards in return.

Overview​

The lp module manages the following aspects of liquidity pools:

  1. Liquidity Pool Creation: Allows the creation of new liquidity pools for token pairs.
  2. Liquidity Provision: Facilitates users to add or remove liquidity from existing pools.
  3. Token Swaps: Enables decentralized trading and swapping of tokens within the liquidity pools.
  4. Rewards: Distributes rewards to liquidity providers proportionate to their contribution.

For a more detailed guide on the 'lp' module, please refer to the module documentation on GitHub.

- +

LP Module (Coming Soon)

The lp (Liquidity Provision) module is a vital part of the Jackal Protocol, enabling the creation and management of liquidity pools for trading and swapping tokens. This module provides a decentralized solution for users to contribute liquidity to the ecosystem and earn rewards in return.

Overview​

The lp module manages the following aspects of liquidity pools:

  1. Liquidity Pool Creation: Allows the creation of new liquidity pools for token pairs.
  2. Liquidity Provision: Facilitates users to add or remove liquidity from existing pools.
  3. Token Swaps: Enables decentralized trading and swapping of tokens within the liquidity pools.
  4. Rewards: Distributes rewards to liquidity providers proportionate to their contribution.

For a more detailed guide on the 'lp' module, please refer to the module documentation on GitHub.

+ \ No newline at end of file diff --git a/docs/protocol/modules/module-overview.html b/docs/protocol/modules/module-overview.html index 0015f2c..bffebd9 100644 --- a/docs/protocol/modules/module-overview.html +++ b/docs/protocol/modules/module-overview.html @@ -5,13 +5,13 @@ Module Overview | Jackal Chain Docs - +
-
- + + \ No newline at end of file diff --git a/docs/protocol/modules/rns.html b/docs/protocol/modules/rns.html index 6d95675..bb56e7f 100644 --- a/docs/protocol/modules/rns.html +++ b/docs/protocol/modules/rns.html @@ -5,13 +5,13 @@ Name Service Module | Jackal Chain Docs - +
-

Name Service Module

The rns (Reverse Name Service) module is an essential component of the Jackal Protocol, providing a user-friendly naming system for blockchain addresses. The RNS module simplifies the process of interacting with complex addresses by mapping them to human-readable names. This module allows users to transfer tokens and permissions to files/folders stored on the Jackal Protocol using human readable names.

Overview​

The rns module manages the following aspects of the Reverse Name Service:

  1. Name Registration: Allows users to register unique names for their blockchain addresses.
  2. Name Management: Facilitates updating, renewing, and transferring RNS names.
  3. Name Resolution: Provides a mechanism for resolving RNS names to their corresponding addresses.
  4. Name Sales: Enables users to buy and sell RNS names through the RNS Marketplace.
  5. Name Transfers: Enables users to transfer RNS names.

For a more detailed guide on integrating the rns module into your application, please refer to the module documentation on GitHub.

- +

Name Service Module

The rns (Reverse Name Service) module is an essential component of the Jackal Protocol, providing a user-friendly naming system for blockchain addresses. The RNS module simplifies the process of interacting with complex addresses by mapping them to human-readable names. This module allows users to transfer tokens and permissions to files/folders stored on the Jackal Protocol using human readable names.

Overview​

The rns module manages the following aspects of the Reverse Name Service:

  1. Name Registration: Allows users to register unique names for their blockchain addresses.
  2. Name Management: Facilitates updating, renewing, and transferring RNS names.
  3. Name Resolution: Provides a mechanism for resolving RNS names to their corresponding addresses.
  4. Name Sales: Enables users to buy and sell RNS names through the RNS Marketplace.
  5. Name Transfers: Enables users to transfer RNS names.

For a more detailed guide on integrating the rns module into your application, please refer to the module documentation on GitHub.

+ \ No newline at end of file diff --git a/docs/protocol/modules/storage.html b/docs/protocol/modules/storage.html index 1a39874..9bc4007 100644 --- a/docs/protocol/modules/storage.html +++ b/docs/protocol/modules/storage.html @@ -5,13 +5,13 @@ JPOP and IDOL Modules | Jackal Chain Docs - +
-

JPOP and IDOL Modules

The Jackal Protocol incorporates two crucial algorithms for decentralized storage: Jackal Proof-of-Persistence (JPOP) and Internal Detection Of Loss (IDOL) protocols. This document provides an overview of these algorithms, their functionalities, and their interaction with users and Storage Providers.

Jackal Proof-of-Persistence (JPOP)​

JPOP is a Proof-of-Storage algorithm that governs the relationship between the storage provider and the user. It operates through a series of contracts containing the Merkle Tree root hash of the file and information required to prove ownership. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain.

The challenge windows require miners to post the raw data chunk and the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. The challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle.

Internal Detection Of Loss (IDOL) Protocol​

The IDOL protocol ensures that data remains available and accessible. When a Storage Provider successfully posts a Merkle Proof within the challenge window, and Validators verify the data, the Storage Provider is rewarded. The rewards are proportional to the file size associated with the contract relative to other active contracts on the network.

If a Storage Provider fails to provide a valid proof within the allotted timeframe, the contract is marked with a missed proof. After a certain number of missed proofs, the contract is burned, and the user is alerted the next time they query the contract. Storage Providers receive penalties for every contract burned due to missed proofs, which remain on their record for an adjustable period.

The IDOL protocol comes into play when contracts with missed proofs are moved to a new list where they can be claimed by other providers. The new provider downloads the file from one of the two online providers storing the same file, resumes the contract's proof action, and restores redundancy to 3x.

Interaction Outline​

  1. A user sends a file to an available Storage Provider. A list of Storage Providers can be found on the blockchain, and miners can deny any incoming request if they do not want to store new files.
  2. After receiving the entire file, the Storage Provider keeps the file in memory and posts a contract to the blockchain.
  3. If the contract is not signed by the sender within a certain number of blocks (configurable by the Storage Provider), the file is removed from memory, and the contract is burned.
  4. If the contract is signed by the user within the given number of blocks, the file is committed to the Storage Provider's hard storage, and the challenge windows start being created for the now active contract.

Client Query Commands​

The client query commands enable users to interact with and query the storage state. Examples of these commands include:

  • list-active-deals
  • show-active-deals
  • list-miners
  • show-miners
  • list-contracts
  • show-contracts
  • find-file
  • freespace
  • get-client-free-space
  • list-pay-blocks
  • show-pay-blocks
  • list-strays
  • show-strays
  • params
  • storage-payment-info

Transactions​

The transaction commands allow users to interact with the storage module. Examples of these commands include:

  • init-miner
  • set-miner-ip
  • set-miner-totalspace
  • sign-contract
  • post-contract
  • postproof
  • buy-storage
  • cancel-contract
  • upgrade-storage

By implementing the JPOP and IDOL protocols, the Jackal Protocol ensures secure, efficient, and reliable decentralized storage management. These protocols, along with the provided client query commands and transactions, enable users and Storage Providers to interact with the Jackal storage ecosystem seamlessly.

Please refer to the respective command documentation for detailed usage and parameters. The Jackal Protocol continues to evolve, and as new features are added, updates to this documentation will be provided accordingly.

- +

JPOP and IDOL Modules

The Jackal Protocol incorporates two crucial algorithms for decentralized storage: Jackal Proof-of-Persistence (JPOP) and Internal Detection Of Loss (IDOL) protocols. This document provides an overview of these algorithms, their functionalities, and their interaction with users and Storage Providers.

Jackal Proof-of-Persistence (JPOP)​

JPOP is a Proof-of-Storage algorithm that governs the relationship between the storage provider and the user. It operates through a series of contracts containing the Merkle Tree root hash of the file and information required to prove ownership. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain.

The challenge windows require miners to post the raw data chunk and the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. The challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle.

Internal Detection Of Loss (IDOL) Protocol​

The IDOL protocol ensures that data remains available and accessible. When a Storage Provider successfully posts a Merkle Proof within the challenge window, and Validators verify the data, the Storage Provider is rewarded. The rewards are proportional to the file size associated with the contract relative to other active contracts on the network.

If a Storage Provider fails to provide a valid proof within the allotted timeframe, the contract is marked with a missed proof. After a certain number of missed proofs, the contract is burned, and the user is alerted the next time they query the contract. Storage Providers receive penalties for every contract burned due to missed proofs, which remain on their record for an adjustable period.

The IDOL protocol comes into play when contracts with missed proofs are moved to a new list where they can be claimed by other providers. The new provider downloads the file from one of the two online providers storing the same file, resumes the contract's proof action, and restores redundancy to 3x.

Interaction Outline​

  1. A user sends a file to an available Storage Provider. A list of Storage Providers can be found on the blockchain, and miners can deny any incoming request if they do not want to store new files.
  2. After receiving the entire file, the Storage Provider keeps the file in memory and posts a contract to the blockchain.
  3. If the contract is not signed by the sender within a certain number of blocks (configurable by the Storage Provider), the file is removed from memory, and the contract is burned.
  4. If the contract is signed by the user within the given number of blocks, the file is committed to the Storage Provider's hard storage, and the challenge windows start being created for the now active contract.

Client Query Commands​

The client query commands enable users to interact with and query the storage state. Examples of these commands include:

  • list-active-deals
  • show-active-deals
  • list-miners
  • show-miners
  • list-contracts
  • show-contracts
  • find-file
  • freespace
  • get-client-free-space
  • list-pay-blocks
  • show-pay-blocks
  • list-strays
  • show-strays
  • params
  • storage-payment-info

Transactions​

The transaction commands allow users to interact with the storage module. Examples of these commands include:

  • init-miner
  • set-miner-ip
  • set-miner-totalspace
  • sign-contract
  • post-contract
  • postproof
  • buy-storage
  • cancel-contract
  • upgrade-storage

By implementing the JPOP and IDOL protocols, the Jackal Protocol ensures secure, efficient, and reliable decentralized storage management. These protocols, along with the provided client query commands and transactions, enable users and Storage Providers to interact with the Jackal storage ecosystem seamlessly.

Please refer to the respective command documentation for detailed usage and parameters. The Jackal Protocol continues to evolve, and as new features are added, updates to this documentation will be provided accordingly.

+ \ No newline at end of file diff --git a/docs/protocol/modules/wasm.html b/docs/protocol/modules/wasm.html index 33bda3f..00986b0 100644 --- a/docs/protocol/modules/wasm.html +++ b/docs/protocol/modules/wasm.html @@ -5,13 +5,13 @@ WASM Module | Jackal Chain Docs - +
-

WASM Module

The wasm module in the Jackal Protocol incorporates the CosmWasm smart contracting platform, which is designed specifically for the Cosmos Ecosystem. This module provides a secure and efficient environment for executing WebAssembly (WASM) smart contracts on the Jackal Protocol.

Overview​

The wasm module manages the following aspects of the CosmWasm platform:

  1. Smart Contract Deployment: Allows developers to deploy smart contracts written in Rust or other languages that compile to WASM.
  2. Smart Contract Execution: Facilitates the execution of smart contract functions on the blockchain.
  3. Smart Contract Interaction: Enables users and other smart contracts to interact with deployed smart contracts.

For a more detailed guide on integrating the wasm module into your application, please refer to the Jackal Protocol GitHub.

- +

WASM Module

The wasm module in the Jackal Protocol incorporates the CosmWasm smart contracting platform, which is designed specifically for the Cosmos Ecosystem. This module provides a secure and efficient environment for executing WebAssembly (WASM) smart contracts on the Jackal Protocol.

Overview​

The wasm module manages the following aspects of the CosmWasm platform:

  1. Smart Contract Deployment: Allows developers to deploy smart contracts written in Rust or other languages that compile to WASM.
  2. Smart Contract Execution: Facilitates the execution of smart contract functions on the blockchain.
  3. Smart Contract Interaction: Enables users and other smart contracts to interact with deployed smart contracts.

For a more detailed guide on integrating the wasm module into your application, please refer to the Jackal Protocol GitHub.

+ \ No newline at end of file diff --git a/docs/protocol/p-o-p.html b/docs/protocol/p-o-p.html index fffefe4..0773684 100644 --- a/docs/protocol/p-o-p.html +++ b/docs/protocol/p-o-p.html @@ -5,13 +5,13 @@ Jackal Proof-of-Persistence | Jackal Chain Docs - +
-

Jackal Proof-of-Persistence

Jackal Storage functions by a Proof-of-Storage algorithm we call Proof-of-Persistence. The Jackal Proof-of-Persistence (JPOP) works through a series of contracts formed between the storage provider and the user. These contracts contain the Merkle Tree root hash of the file and the information required to prove ownership of the file. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the provider to post the raw chunk of data corresponding to the index of the challenge window alongside the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. These challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle.

If a Storage Provider successfully posts a Merkle Proof within the challenge window for the contract and the data is verified by the Validators to be valid Merkle Proofs for the challenge index, the Storage Provider is paid out. Storage Provider rewards are proportional to the file size the contract is associated with relative to every other active contract on the network. If a Storage Provider fails to provide a valid proof within the allotted time frame, the contract is struck with a missed proof. After X missed proofs, the contract is burned, and the User is alerted the next time they query the contract. For every contract burned through missing proofs, the Storage Provider is struck with a penalty that remains on their record for a period of time adjustable through governance.

Building the Trees​

Merkle Trees are a core component of the JPOP mechanism, thus, it is important to outline how these trees are used to create efficient and trustworthy proofs. When saving a file for the first time, providers split each file into many 1kb chunks. Providers must also hash the entire file to create a folder to house every chunk, this is displayed by the following diagram.

File Tree

These chunks are used as leaves on the Merkle Tree defining each storage contract. Immediately after saving a file to disk, the storage provider builds a tree using each chunk. To create this tree, each chunk is hashed into a respective Hashed Chunk. These chunks are then recursively paired together and hashed until a single root node is created. This is called the Merkle Root, the only piece of data relative to a file that is saved directly on the blockchain itself.

Merkle Roots

In the diagram above, displays how each file is hashed together to create a single root node.

Proving Data Availability​

These nodes are essential as they only require the nodes below them to prove they are part of the tree. This means that we can create a proof claiming a single chunk belongs to the file using the Merkle Root saved on the chain. In the following diagram, we can see that only the blue nodes are required to build a successful proof. The green nodes represent information that we can generate given the blue nodes. Finally, we can compare the root generated from the proof to the root saved on the chain and determine if the chunk does belong to the contract we are proving. This results in small message sizes due to not needing to send the entire file every proof.

Merkle Roots Graphed

- +

Jackal Proof-of-Persistence

Jackal Storage functions by a Proof-of-Storage algorithm we call Proof-of-Persistence. The Jackal Proof-of-Persistence (JPOP) works through a series of contracts formed between the storage provider and the user. These contracts contain the Merkle Tree root hash of the file and the information required to prove ownership of the file. Storage Providers are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the provider to post the raw chunk of data corresponding to the index of the challenge window alongside the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. These challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle.

If a Storage Provider successfully posts a Merkle Proof within the challenge window for the contract and the data is verified by the Validators to be valid Merkle Proofs for the challenge index, the Storage Provider is paid out. Storage Provider rewards are proportional to the file size the contract is associated with relative to every other active contract on the network. If a Storage Provider fails to provide a valid proof within the allotted time frame, the contract is struck with a missed proof. After X missed proofs, the contract is burned, and the User is alerted the next time they query the contract. For every contract burned through missing proofs, the Storage Provider is struck with a penalty that remains on their record for a period of time adjustable through governance.

Building the Trees​

Merkle Trees are a core component of the JPOP mechanism, thus, it is important to outline how these trees are used to create efficient and trustworthy proofs. When saving a file for the first time, providers split each file into many 1kb chunks. Providers must also hash the entire file to create a folder to house every chunk, this is displayed by the following diagram.

File Tree

These chunks are used as leaves on the Merkle Tree defining each storage contract. Immediately after saving a file to disk, the storage provider builds a tree using each chunk. To create this tree, each chunk is hashed into a respective Hashed Chunk. These chunks are then recursively paired together and hashed until a single root node is created. This is called the Merkle Root, the only piece of data relative to a file that is saved directly on the blockchain itself.

Merkle Roots

In the diagram above, displays how each file is hashed together to create a single root node.

Proving Data Availability​

These nodes are essential as they only require the nodes below them to prove they are part of the tree. This means that we can create a proof claiming a single chunk belongs to the file using the Merkle Root saved on the chain. In the following diagram, we can see that only the blue nodes are required to build a successful proof. The green nodes represent information that we can generate given the blue nodes. Finally, we can compare the root generated from the proof to the root saved on the chain and determine if the chunk does belong to the contract we are proving. This results in small message sizes due to not needing to send the entire file every proof.

Merkle Roots Graphed

+ \ No newline at end of file diff --git a/docs/protocol/storageproviders/casual-build.html b/docs/protocol/storageproviders/casual-build.html index 2208595..2426c3a 100644 --- a/docs/protocol/storageproviders/casual-build.html +++ b/docs/protocol/storageproviders/casual-build.html @@ -5,13 +5,13 @@ Casual Storage Build | Jackal Chain Docs - +

Casual Storage Build

You may be successful contributing to the network with an old computer you may have. If you are looking to purpose build a machine- here are the recommendations for casual a storage provider.

ComponentRecommendationUnits
CPUAMD Ryzen 5 5600G 3.9 GHz 6-Core Processor.1
MotherboardMSI B450 Tomahawk Max ATX AM4 Motherboard.1
MemoryG.Skill Ripjaws V 32 GB (2 x 16 GB) DDR4-3200 CL 16 Memory1
StorageSeagate EXOS Enterprise 14 TB 3.5 7200 RPM Internal Hard Drive2
StorageKingston NV1 1 TB M.2-2280 NVME Solid State Drive1
CaseCooler Master HAF XB EVO ATX Desktop Case1
Power SupplyEVGA SuperNOVA GA 650 W 80+ Gold Certified Fully Modular ATX Power Supply1
Total Cost Estimate$1061.92 USD
- + \ No newline at end of file diff --git a/docs/protocol/storageproviders/diy-serious copy.html b/docs/protocol/storageproviders/diy-serious copy.html index 675fd54..74bf328 100644 --- a/docs/protocol/storageproviders/diy-serious copy.html +++ b/docs/protocol/storageproviders/diy-serious copy.html @@ -5,13 +5,13 @@ DIY Serious Build | Jackal Chain Docs - +

DIY Serious Build

For DIY individuals looking to power web3 infrastructure and increase your ROI- here is the recommended system for serious individual storage providers.

ComponentRecommendationUnits
CPUAMD Ryzen 7 5700G 3.8 GHz 8-Core Processor1
MotherboardMSI B450 TOMAHAWK MAX II ATX AM4 Motherboard1
MemoryG.Skill Ripjaws V 64 GB (2 x 32 GB) DDR4-2666 CL18 Memory1
StorageKingston A400 960 GB 2.5" Solid State Drive1
StorageSeagate EXOS Enterprise 14 TB 3.5" 7200RPM Internal Hard Drive5
CaseCooler Master N400 ATX Mid Tower Case1
Power SupplyCorsair HX750 Platinum 750 W 80+ Platinum Certified Fully Modular ATX Power Supply1
Case FanNoctua S12B redux-700 33.49 CFM 120 mm Fan2
Total Cost Estimate$1814.08 USD
- + \ No newline at end of file diff --git a/docs/protocol/storageproviders/enterprise.html b/docs/protocol/storageproviders/enterprise.html index 9d86448..24850a5 100644 --- a/docs/protocol/storageproviders/enterprise.html +++ b/docs/protocol/storageproviders/enterprise.html @@ -5,13 +5,13 @@ Enterprise Build | Jackal Chain Docs - +

Enterprise Build

For teams looking to build a large storage system of ~2.1 Petabytes of storage, the estimated base price of the box with drives is ~$70,000 USD. This does not account for variable expenses including the regional costs of:

  • Power
  • Internet
  • HVAC
  • Professionals

Those looking to build an enterprise storage provider, reach out to the team for recommendations and support.

- + \ No newline at end of file diff --git a/docs/protocol/storageproviders/overview.html b/docs/protocol/storageproviders/overview.html index 233ebd4..62375e7 100644 --- a/docs/protocol/storageproviders/overview.html +++ b/docs/protocol/storageproviders/overview.html @@ -5,13 +5,13 @@ Overview | Jackal Chain Docs - +

Overview

Want to power the storage infrastructure for web3?​

A Jackal Storage Provider is a dedicated web server optimized for data storage that accepts incoming files from users and creates contracts for the users to approve. These contracts last until the user either cancels them or the provider itself goes offline.

- + \ No newline at end of file diff --git a/docs/protocol/tokens.html b/docs/protocol/tokens.html index aa31de6..4b16396 100644 --- a/docs/protocol/tokens.html +++ b/docs/protocol/tokens.html @@ -5,13 +5,13 @@ Tokens | Jackal Chain Docs - +

Tokens

JKL or Jackal​

JKL is an inflationary token that powers the Jackal Protocol. The JKL Token has many use cases. Some of these use cases are below.

  • dApps - Applications built leveraging the Jackal Protocol, such as Jackal Storage and the RNS Marketplace, may choose to include the JKL token to expand its utility.

  • Securing the Network - As the Jackal Protocol is a Proof-of-Stake (PoS) Cosmos L1 blockchain, JKL can be delegated to validators to secure the network and earn JKL rewards. Otherwise known as staking or bonded tokens.

  • Transaction Fees - Transactions on the Jackal Protocol must be paid for using JKL. As the protocol is PoS, the cost of transactions is inexpensive.

  • Governance - Staked tokens grant on-chain governance participation within the Jackal Protocol to vote on text, software, spend, and other governance proposals.

  • Collateral - The JKL token can act as collateral for validators, storage providers, and other smart contract use cases.

  • Liquidity Provision - JKL can be allocated into a liquidity pool to earn rewards.

JWL or Jewel​

JWL is an L1 store-of-value token native to the Canine Blockchain. JWL tokens are immutable, meaning they can never be created, changed or destroyed. There is a finite amount of JWL that will be minted at the chain's genesis. Currently, there is no utility for the JWL token and it should be treated as such.

- + \ No newline at end of file diff --git a/docs/protocol/validators.html b/docs/protocol/validators.html index dddc2fd..30dc8b1 100644 --- a/docs/protocol/validators.html +++ b/docs/protocol/validators.html @@ -5,13 +5,13 @@ Validators | Jackal Chain Docs - +

Validators

The Jackal Validators are secure web servers, dedicated machines that participate in the consensus protocol by broadcasting cryptographic signatures, or votes, to agree upon the next block. Voting power is determined by the amount of staking tokens delegated by non-validators and bonded as collateral to earn a reward. These non-validators, or delegators, incur the risk of getting punished (slashed) if the delegate validator gets hacked or violates the protocol.

To set up a validator and become a contributing part of the network, read the installation instructions here

- + \ No newline at end of file diff --git a/docs/using-jackal/dashboard.html b/docs/using-jackal/dashboard.html index 05f09da..f9051aa 100644 --- a/docs/using-jackal/dashboard.html +++ b/docs/using-jackal/dashboard.html @@ -5,13 +5,13 @@ Jackal Dashboard Guide | Jackal Chain Docs - +

Jackal Dashboard Guide

The Jackal Dashboard is your one-stop destination for interacting with the Jackal Protocol and Cosmos ecosystem. This guide will walk you through the various features and capabilities available on the Jackal Dashboard.

1. File Management​

The Jackal Dashboard allows users to upload, download, delete, and share files securely and privately.

Uploading Files​

  1. Navigate to the "Storage" tab on navigation bar of the Jackal Dashboard.
  2. Click "Browse Files" and select the file(s) you want to upload. Users can also drag and drop files into the dashboard directly.
  3. Click "Encrypt & Upload" on the right side of the screen.
  4. Sign the transaction prompt for your Keplr wallet.

Downloading Files​

  1. In the "Storage" tab, locate the file you want to download.
  2. Click the "..." button relative to the file you wish to download.
  3. Click "Download".
  4. The file will be downloaded to your local device.

Sharing Files (Coming Soon)​

2. Buy Tokens​

  1. Navigate to the "Buy Tokens" tab on the Jackal Dashboard.
  2. You will be re-directed to the Osmosis Decentralized Exchange in another tab.

3. Name Service​

The Jackal Dashboard enables users to register and manage RNS names.

Registering RNS Names​

  1. Navigate to the "Name Service" tab on the Jackal Dashboard.
  2. Click "Register"
  3. Enter your desired name and how many years you wish to keep it for.
  4. Confirm the transaction in your connected wallet.

Managing RNS Names​

  1. In the "Name Service" tab, view your owned RNS addresses.
  2. Click on a "..." next to the name you wish to manage.

4. Name Service Marketplace​

The RNS Marketplace allows users to buy and sell RNS names.

  1. Navigate to the "RNS Marketplace" tab on the Jackal Dashboard.
  2. Browse available RNS names or search for a specific name.
  3. Click "Buy" to purchase an RNS name or "Sell" to list one of your RNS names for sale.

5. Hosting Static Websites (Coming Soon)​

6. Governance Participation​

The Jackal Dashboard provides an interface to participate in on-chain governance.

  1. Navigate to the "Governance" tab on the Jackal Dashboard.
  2. View active proposals and click on a proposal to review its details.
  3. Cast your vote by clicking "Vote" and selecting your preferred option and signing the transaction.

7. Delegating Tokens to Validators​

The Jackal Dashboard enables users to delegate tokens to validators, securing the network and earning rewards.

  1. Navigate to the "Validators" tab on the Jackal Dashboard.
  2. Browse the list of active validators and select one.
  3. Click "Delegate" and enter the amount of tokens you want to delegate.
  4. Confirm the transaction in your connected wallet.

Stay tuned for more exciting features and improvements coming to the Jackal Dashboard!

- + \ No newline at end of file diff --git a/docs/using-jackal/delegate.html b/docs/using-jackal/delegate.html index e36e482..86c78ca 100644 --- a/docs/using-jackal/delegate.html +++ b/docs/using-jackal/delegate.html @@ -5,13 +5,13 @@ How to Delegate JKL Tokens to a Validator | Jackal Chain Docs - +

How to Delegate JKL Tokens to a Validator

This guide will help you delegate your JKL tokens to a validator on the Jackal Protocol, which helps secure the network and earns you staking rewards.

Step 1: Set up a Keplr Wallet​

  1. Install the Keplr Wallet browser extension.
  2. Create a new wallet or import an existing one.
  3. Make sure you have some JKL tokens in your wallet.

Step 2: Choose a Dashboard​

  1. Jackal Dashboard
  2. Ping Pub

Step 3: Choose a Validator​

  1. Review the list of active validators and their details, such as commission, uptime, and self-delegation.
  2. Choose a validator that aligns with your preferences and click on "Delegate".

Step 4: Delegate JKL Tokens​

  1. Enter the amount of JKL tokens you want to delegate.
  2. Click "Delegate" and confirm the transaction in your Keplr Wallet.
  3. Once the transaction is complete, you will see your delegated JKL tokens and earned rewards in the "Staking" or "Delegations" tab on the dashboards.

Step 5: Monitor and Manage Your Delegation​

  1. You can redelegate your JKL tokens to another validator or undelegate (unbond) them if you want to withdraw your tokens. Note that there is a 14-day unbonding period during which your tokens are locked and not earning rewards.

Now you have successfully delegated your JKL tokens to a validator on the Jackal Protocol, contributing to the network's security and earning staking rewards.

Reminder​

If you possess JKL tokens, you can temporarily lock them away to secure the protocol, this is called staking or delegating. In exchange for securing the network with your tokens, you receive rewards and the ability to vote on the Protocol’s future. These rewards come from newly generated JKL tokens and transaction fees.

It should be noted that staking or delegating is not risk free, this is why it is important to learn about the risks and participate in sustainable staking practices.

To decrease risk, it’s recommended that you do research on validators and select one you trust as well as delegate to multiple validators.

Slashing by 0.01%​

Occurs if the validator you delegate to is offline for too long.

Slashing by 5%​

Occurs if the validator signs two different blocks at the same block height. This is often caused by bad validator operation practices or malicious intent by the validator.

- + \ No newline at end of file diff --git a/docs/using-jackal/fund.html b/docs/using-jackal/fund.html index c7e40c1..b5e86ac 100644 --- a/docs/using-jackal/fund.html +++ b/docs/using-jackal/fund.html @@ -5,13 +5,13 @@ Accessing JKL Tokens on Osmosis and Withdrawing to Jackal Protocol | Jackal Chain Docs - +

Accessing JKL Tokens on Osmosis and Withdrawing to Jackal Protocol

This guide will help you access JKL tokens on the Osmosis Decentralized Exchange (DEX) and withdraw them to the Jackal Protocol using Inter-Blockchain Communication (IBC).

Step 1: Set up a Keplr Wallet​

  1. Install the Keplr Wallet browser extension.
  2. Create a new wallet or import an existing one.
  3. Make sure you have some OSMO tokens in your wallet for transaction fees.

Step 2: Access the Osmosis DEX​

  1. Visit the Osmosis DEX website.
  2. Connect your Keplr Wallet by clicking "Connect Wallet" in the top right corner.

Step 3: Swap tokens for JKL on Osmosis​

  1. Click "Swap" in the Osmosis navigation bar.
  2. Select the token you want to swap for JKL, such as OSMO or ATOM.
  3. Enter the amount you want to swap and confirm the transaction in your Keplr Wallet.
  4. Once the transaction is complete, you will see the JKL tokens in your wallet.

Step 4: Withdraw JKL tokens to Jackal Protocol via IBC​

  1. Visit the Assets Page.
  2. Find the JKL asset and click "withdraw".
  3. Once you sign the transaction with your Keplr wallet, an IBC transfer has begun and your JKL tokens will be available on the Jackal Protocol shortly.

Now you have successfully accessed JKL tokens on the Osmosis DEX and withdrawn them to the Jackal Protocol using IBC.

- + \ No newline at end of file diff --git a/docs/using-jackal/wallet/keplr.html b/docs/using-jackal/wallet/keplr.html index 2aeccf9..1edd10e 100644 --- a/docs/using-jackal/wallet/keplr.html +++ b/docs/using-jackal/wallet/keplr.html @@ -5,14 +5,14 @@ Keplr Wallet | Jackal Chain Docs - +

Keplr Wallet

The Keplr browser extension is a wallet for accessing some Jackal applications in the Cosmos ecosystem. Keplr can be used to exchange/manage JKL and other Cosmos-based tokens, participate in governance from the Jackal Dashboard, and use Jackal Storage.

Set up Keplr​

More information about setting up a Keplr wallet can be found in the official Keplr Documentation.

Open the Keplr extension on your browser. If you are setting up Keplr for the first time, you can either create a new account or import an existing account.

Create a new account​

There are two ways to create a new Keplr account:

Most Secure

  • Mnemonic/seed phrase.

Easiest

  • One-click login.

Create an account with a Seed Phrase​

  1. In the initial pop-up window, choose Create New Account

    • If you have used Keplr before, click on the silhouette in the upper-right corner, then the blue box labeled Add Account, and select Create New Account.

  2. Choose to have a seed/mnemonic phrase of 24 words, and save the phrase.

  3. Enter a name for your account. This can be changed later.

  4. Once you have transcribed your 24 word seed/mnemonic phrase, click on Next

  5. To confirm the creation of the new account, click on the words on the right order in which they appear in your seed/mnemonic phrase, and press Register.

  6. If you have not used Keplr before, set a password for the Keplr extension, and click Confirm.

Import an existing account​

There are several ways to import an existing account:

  • via a mnemonic/seed phrase/private key.
  • via ledger.

Import with a Seed Phrase

  1. In the initial pop-up window, choose Import Existing Account If you have used Keplr before, click on the silhouette in the upper-right corner, then the blue box labeled Add Account, and select Import Existing Account.

  2. Enter your mnemonic/seed phrase/private key in the appropriate slot, seperating the words with spaces and make sure to check they are spelled correctly.

  3. Make sure you have imported the account with the correct derivation path, viewable by clicking on Advanced.

    • Normally, the derivation path should be m/44'/…’/0/0/0, but if you see that importing the account via mnemonic on Keplr, the Cosmos Mainnet address displayed is different than yours, it is possible the derivation path ends with 1 (or another number) instead of 0.

    • If this is the case, you just have to start the process over, and replace the last 0 with 1

    • Learn more in the Keplr FAQ

  4. If you have not used Keplr before, set a password for the Keplr extension, and click Confirm.

Import with Ledger

  1. In the initial pop-up window, choose Import Ledger.

    • If you have used Keplr before, click on the silhouette in the upper-right corner, then the blue box labeled Add Account, and select Import Ledger.

  2. To complete the connection with your Ledger Nano Hard Wallet, follow the steps described in the pop-up that appears. A detailed tutorial can be found here.

  3. If you have not used Keplr before, set a password for the Keplr extension, and click Confirm.

Connecting Keplr to the Jackal Protocol​

Once you are signed in to the Keplr extension, you can connect the wallet with the Jackal Protocol. Once on the Jackal Dashboard you will be prompted to connect your Keplr wallet.

- + \ No newline at end of file diff --git a/index.html b/index.html index bde9c73..a6d2fd7 100644 --- a/index.html +++ b/index.html @@ -5,13 +5,13 @@ Jackal Chain Docs | Jackal Chain Docs - +
- + \ No newline at end of file diff --git a/markdown-page.html b/markdown-page.html index 12cc50a..73e828d 100644 --- a/markdown-page.html +++ b/markdown-page.html @@ -5,13 +5,13 @@ Markdown page example | Jackal Chain Docs - +

Markdown page example

You don't need React to write simple standalone pages.

- + \ No newline at end of file