diff --git a/404.html b/404.html index 6bcd2d0..49a00de 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/CNAME b/CNAME deleted file mode 100644 index f3782d8..0000000 --- a/CNAME +++ /dev/null @@ -1 +0,0 @@ -docs.jackaldao.com \ No newline at end of file diff --git a/assets/js/0d3eecbe.358b314a.js b/assets/js/0d3eecbe.358b314a.js new file mode 100644 index 0000000..b8cb206 --- /dev/null +++ b/assets/js/0d3eecbe.358b314a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[8353],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>g});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var o=r.createContext({}),c=function(e){var n=r.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):l(l({},n),e)),t},u=function(e){var n=c(e.components);return r.createElement(o.Provider,{value:n},e.children)},d={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},p=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),p=c(t),g=a,m=p["".concat(o,".").concat(g)]||p[g]||d[g]||i;return t?r.createElement(m,l(l({ref:n},u),{},{components:t})):r.createElement(m,l({ref:n},u))}));function g(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,l=new Array(i);l[0]=p;var s={};for(var o in n)hasOwnProperty.call(n,o)&&(s[o]=n[o]);s.originalType=e,s.mdxType="string"==typeof e?e:a,l[1]=s;for(var c=2;c{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var r=t(7462),a=(t(7294),t(3905));const i={sidebar_position:2},l="Installing Canined",s={unversionedId:"nodes/installation",id:"nodes/installation",title:"Installing Canined",description:"Pre-Requisites",source:"@site/docs/nodes/2_installation.md",sourceDirName:"nodes",slug:"/nodes/installation",permalink:"/docs/nodes/installation",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/nodes/2_installation.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Hardware",permalink:"/docs/nodes/hardware"},next:{title:"Joining Testnet",permalink:"/docs/nodes/testnet"}},o={},c=[{value:"Pre-Requisites",id:"pre-requisites",level:2},{value:"Installing Build Essentials",id:"installing-build-essentials",level:3},{value:"Installing Go",id:"installing-go",level:3},{value:"Building from Source",id:"building-from-source",level:2},{value:"Creating a Service",id:"creating-a-service",level:2}],u={toc:c};function d(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"installing-canined"},"Installing Canined"),(0,a.kt)("h2",{id:"pre-requisites"},"Pre-Requisites"),(0,a.kt)("p",null,"There are a few things needed before installing."),(0,a.kt)("h3",{id:"installing-build-essentials"},"Installing Build Essentials"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"sudo apt update\nsudo apt install build-essential\n")),(0,a.kt)("h3",{id:"installing-go"},"Installing Go"),(0,a.kt)("p",null,"Follow more in-depth instructions to install Go v1.18.2 or higher ",(0,a.kt)("a",{parentName:"p",href:"https://golang.org/doc/install"},"here"),"."),(0,a.kt)("p",null,"On Ububtu you can install it with:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"wget https://golang.org/dl/go1.18.2.linux-amd64.tar.gz\nsudo tar -C /usr/local -xzf go1.18.2.linux-amd64.tar.gz\n")),(0,a.kt)("p",null,"Add these lines to the end of ",(0,a.kt)("inlineCode",{parentName:"p"},"~/.profile"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"export GOROOT=/usr/local/go\nexport GOPATH=$HOME/go\nexport GO111MODULE=on\nexport PATH=$PATH:/usr/local/go/bin:$HOME/go/bin\n")),(0,a.kt)("p",null,"Restarting the shell with youre profile settings or just rebasing them like so is required."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"source ~/.profile\n")),(0,a.kt)("h2",{id:"building-from-source"},"Building from Source"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"git clone https://github.com/JackalLabs/canine-chain.git\ncd canine-chain\ngit fetch\ngit checkout \n\nmake install\n")),(0,a.kt)("p",null,"From there you will be able to use ",(0,a.kt)("inlineCode",{parentName:"p"},"canined"),", ex:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"canined version\n")),(0,a.kt)("h2",{id:"creating-a-service"},"Creating a Service"),(0,a.kt)("p",null,"You may want the daemon to run without you needing to supervise it. To turn the executable into a service follow these steps."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},'cd $HOME\necho "[Unit]\nDescription=Jackal Node\nAfter=network-online.target\n[Service]\nUser=${USER}\nExecStart=$(which canined) start\nRestart=always\nRestartSec=3\nLimitNOFILE=4096\n[Install]\nWantedBy=multi-user.target\n" > canined.service\n\nsudo mv canined.service /lib/systemd/system/\nsudo systemctl enable canined.service\n\n# Starting the service\nsudo systemctl start canined.service\n\n# Restarting the service\nsudo systemctl daemon-reload\nsudo systemctl restart canined.service\n')))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0d3eecbe.d354bd41.js b/assets/js/0d3eecbe.d354bd41.js deleted file mode 100644 index 71f3e85..0000000 --- a/assets/js/0d3eecbe.d354bd41.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[8353],{3905:(e,n,t)=>{t.d(n,{Zo:()=>u,kt:()=>g});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),c=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},u=function(e){var n=c(e.components);return r.createElement(s.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),d=c(t),g=a,m=d["".concat(s,".").concat(g)]||d[g]||p[g]||o;return t?r.createElement(m,i(i({ref:n},u),{},{components:t})):r.createElement(m,i({ref:n},u))}));function g(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var o=t.length,i=new Array(o);i[0]=d;var l={};for(var s in n)hasOwnProperty.call(n,s)&&(l[s]=n[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,i[1]=l;for(var c=2;c{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var r=t(7462),a=(t(7294),t(3905));const o={sidebar_position:2},i="Installing Canined",l={unversionedId:"nodes/installation",id:"nodes/installation",title:"Installing Canined",description:"Pre-Requisites",source:"@site/docs/nodes/2_installation.md",sourceDirName:"nodes",slug:"/nodes/installation",permalink:"/docs/nodes/installation",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/nodes/2_installation.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Hardware",permalink:"/docs/nodes/hardware"},next:{title:"Joining Testnet",permalink:"/docs/nodes/testnet"}},s={},c=[{value:"Pre-Requisites",id:"pre-requisites",level:2},{value:"Installing Go",id:"installing-go",level:3},{value:"Building from Source",id:"building-from-source",level:2}],u={toc:c};function p(e){let{components:n,...t}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"installing-canined"},"Installing Canined"),(0,a.kt)("h2",{id:"pre-requisites"},"Pre-Requisites"),(0,a.kt)("p",null,"There are a few things needed before installing."),(0,a.kt)("h3",{id:"installing-go"},"Installing Go"),(0,a.kt)("p",null,"Follow more in-depth instructions to install Go v1.18.2 or higher ",(0,a.kt)("a",{parentName:"p",href:"https://golang.org/doc/install"},"here"),"."),(0,a.kt)("p",null,"On Ububtu you can install it with:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"wget https://golang.org/dl/go1.18.2.linux-amd64.tar.gz\nsudo tar -C /usr/local -xzf go1.18.2.linux-amd64.tar.gz\n")),(0,a.kt)("p",null,"Add these lines to the end of ",(0,a.kt)("inlineCode",{parentName:"p"},"~/.profile"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"export GOROOT=/usr/local/go\nexport GOPATH=$HOME/go\nexport GO111MODULE=on\nexport PATH=$PATH:/usr/local/go/bin:$HOME/go/bin\n")),(0,a.kt)("p",null,"Restarting the shell with youre profile settings or just rebasing them like so is required."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"source ~/.profile\n")),(0,a.kt)("h2",{id:"building-from-source"},"Building from Source"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"git clone https://github.com/JackalLabs/canine-chain.git\ncd canine-chain\ngit fetch\ngit checkout \n\nmake install\n")),(0,a.kt)("p",null,"From there you will be able to use ",(0,a.kt)("inlineCode",{parentName:"p"},"canined"),", ex:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-sh"},"canined version\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.2417b225.js b/assets/js/runtime~main.c3000ffe.js similarity index 67% rename from assets/js/runtime~main.2417b225.js rename to assets/js/runtime~main.c3000ffe.js index 31419f7..a34ab9f 100644 --- a/assets/js/runtime~main.2417b225.js +++ b/assets/js/runtime~main.c3000ffe.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,c,a,r,d={},f={};function b(e){var t=f[e];if(void 0!==t)return t.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,b),c.loaded=!0,c.exports}b.m=d,b.c=f,e=[],b.O=(t,c,a,r)=>{if(!c){var d=1/0;for(i=0;i=r)&&Object.keys(b.O).every((e=>b.O[e](c[o])))?c.splice(o--,1):(f=!1,r0&&e[i-1][2]>r;i--)e[i]=e[i-1];e[i]=[c,a,r]},b.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return b.d(t,{a:t}),t},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,b.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var r=Object.create(null);b.r(r);var d={};t=t||[null,c({}),c([]),c(c)];for(var f=2&a&&e;"object"==typeof f&&!~t.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((t=>d[t]=()=>e[t]));return d.default=()=>e,b.d(r,d),r},b.d=(e,t)=>{for(var c in t)b.o(t,c)&&!b.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:t[c]})},b.f={},b.e=e=>Promise.all(Object.keys(b.f).reduce(((t,c)=>(b.f[c](e,t),t)),[])),b.u=e=>"assets/js/"+({53:"935f2afb",54:"344debb6",229:"03cdf430",604:"ab3acb2a",1078:"5402824b",1092:"17b6a24f",1148:"3e125dc6",1172:"b46b7d8b",1210:"18a433c4",1232:"7d26c06c",1251:"d07de6bd",1344:"723cbd1b",1770:"65b97a36",1817:"9c403616",2782:"f1994572",2891:"f3769d49",3085:"1f391b9e",3298:"ea96f03c",3349:"2dc54001",3523:"e289ecfd",4195:"c4f5d8e4",4512:"2edbca5e",4878:"c894e2df",5202:"c1147f98",5275:"5a6f97fe",5359:"5593d6f2",5533:"874276e5",5561:"e5d01f1f",5689:"8b564e48",6164:"9093546b",6174:"23f3f2f9",7049:"9718a321",7053:"b0580eac",7095:"cccedb4f",7275:"7b9432de",7414:"393be207",7918:"17896441",8353:"0d3eecbe",8425:"b1fc7db6",8957:"8a56e0ba",9042:"0558eea0",9293:"365ebb01",9404:"d07072fe",9514:"1be78505",9671:"0e384e19",9853:"a5b5e7c9",9960:"c933c35c",9980:"10cd7d2f"}[e]||e)+"."+{53:"731ac1ae",54:"f6c185dc",229:"d73494f5",604:"7d90b373",1078:"99445947",1092:"0bee5a84",1148:"d5941de6",1172:"21d76f7a",1210:"91e3ad46",1232:"2c4fc305",1251:"1e10924a",1344:"9d2fbd7a",1770:"b077fc11",1817:"207c9ed8",2666:"c0e3c62f",2782:"3c4b4d92",2891:"34e20451",3085:"63dfc29a",3298:"54015f3a",3349:"52840aa5",3523:"f8d883b5",4195:"2cdf5075",4512:"87f48177",4878:"12dc302d",4972:"1f3b4ce6",5202:"91bc9804",5275:"febd63e3",5359:"6c72c143",5533:"4e7e8a20",5561:"129c86af",5689:"d0188ea3",6164:"408492a1",6174:"f1dcacb9",7049:"df5618fa",7053:"86693754",7095:"2c18c4a4",7275:"edd061b6",7414:"1c40378b",7918:"61bcb5db",8353:"d354bd41",8425:"064c1066",8957:"c86c876a",9042:"b9658663",9293:"9544b39d",9404:"a42d065d",9514:"e7329934",9671:"367e753d",9853:"69bbf936",9960:"b2c34276",9980:"2b39a3c3"}[e]+".js",b.miniCssF=e=>{},b.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),b.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},r="canine-docs:",b.l=(e,t,c,d)=>{if(a[e])a[e].push(t);else{var f,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{f.onerror=f.onload=null,clearTimeout(s);var r=a[e];if(delete a[e],f.parentNode&&f.parentNode.removeChild(f),r&&r.forEach((e=>e(c))),t)return t(c)},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)}},b.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},b.p="/",b.gca=function(e){return e={17896441:"7918","935f2afb":"53","344debb6":"54","03cdf430":"229",ab3acb2a:"604","5402824b":"1078","17b6a24f":"1092","3e125dc6":"1148",b46b7d8b:"1172","18a433c4":"1210","7d26c06c":"1232",d07de6bd:"1251","723cbd1b":"1344","65b97a36":"1770","9c403616":"1817",f1994572:"2782",f3769d49:"2891","1f391b9e":"3085",ea96f03c:"3298","2dc54001":"3349",e289ecfd:"3523",c4f5d8e4:"4195","2edbca5e":"4512",c894e2df:"4878",c1147f98:"5202","5a6f97fe":"5275","5593d6f2":"5359","874276e5":"5533",e5d01f1f:"5561","8b564e48":"5689","9093546b":"6164","23f3f2f9":"6174","9718a321":"7049",b0580eac:"7053",cccedb4f:"7095","7b9432de":"7275","393be207":"7414","0d3eecbe":"8353",b1fc7db6:"8425","8a56e0ba":"8957","0558eea0":"9042","365ebb01":"9293",d07072fe:"9404","1be78505":"9514","0e384e19":"9671",a5b5e7c9:"9853",c933c35c:"9960","10cd7d2f":"9980"}[e]||e,b.p+b.u(e)},(()=>{var e={1303:0,532:0};b.f.j=(t,c)=>{var a=b.o(e,t)?e[t]:void 0;if(0!==a)if(a)c.push(a[2]);else if(/^(1303|532)$/.test(t))e[t]=0;else{var r=new Promise(((c,r)=>a=e[t]=[c,r]));c.push(a[2]=r);var d=b.p+b.u(t),f=new Error;b.l(d,(c=>{if(b.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var r=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+t+" failed.\n("+r+": "+d+")",f.name="ChunkLoadError",f.type=r,f.request=d,a[1](f)}}),"chunk-"+t,t)}},b.O.j=t=>0===e[t];var t=(t,c)=>{var a,r,d=c[0],f=c[1],o=c[2],n=0;if(d.some((t=>0!==e[t]))){for(a in f)b.o(f,a)&&(b.m[a]=f[a]);if(o)var i=o(b)}for(t&&t(c);n{"use strict";var e,t,c,a,r,f={},d={};function b(e){var t=d[e];if(void 0!==t)return t.exports;var c=d[e]={id:e,loaded:!1,exports:{}};return f[e].call(c.exports,c,c.exports,b),c.loaded=!0,c.exports}b.m=f,b.c=d,e=[],b.O=(t,c,a,r)=>{if(!c){var f=1/0;for(i=0;i=r)&&Object.keys(b.O).every((e=>b.O[e](c[o])))?c.splice(o--,1):(d=!1,r0&&e[i-1][2]>r;i--)e[i]=e[i-1];e[i]=[c,a,r]},b.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return b.d(t,{a:t}),t},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,b.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var r=Object.create(null);b.r(r);var f={};t=t||[null,c({}),c([]),c(c)];for(var d=2&a&&e;"object"==typeof d&&!~t.indexOf(d);d=c(d))Object.getOwnPropertyNames(d).forEach((t=>f[t]=()=>e[t]));return f.default=()=>e,b.d(r,f),r},b.d=(e,t)=>{for(var c in t)b.o(t,c)&&!b.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:t[c]})},b.f={},b.e=e=>Promise.all(Object.keys(b.f).reduce(((t,c)=>(b.f[c](e,t),t)),[])),b.u=e=>"assets/js/"+({53:"935f2afb",54:"344debb6",229:"03cdf430",604:"ab3acb2a",1078:"5402824b",1092:"17b6a24f",1148:"3e125dc6",1172:"b46b7d8b",1210:"18a433c4",1232:"7d26c06c",1251:"d07de6bd",1344:"723cbd1b",1770:"65b97a36",1817:"9c403616",2782:"f1994572",2891:"f3769d49",3085:"1f391b9e",3298:"ea96f03c",3349:"2dc54001",3523:"e289ecfd",4195:"c4f5d8e4",4512:"2edbca5e",4878:"c894e2df",5202:"c1147f98",5275:"5a6f97fe",5359:"5593d6f2",5533:"874276e5",5561:"e5d01f1f",5689:"8b564e48",6164:"9093546b",6174:"23f3f2f9",7049:"9718a321",7053:"b0580eac",7095:"cccedb4f",7275:"7b9432de",7414:"393be207",7918:"17896441",8353:"0d3eecbe",8425:"b1fc7db6",8957:"8a56e0ba",9042:"0558eea0",9293:"365ebb01",9404:"d07072fe",9514:"1be78505",9671:"0e384e19",9853:"a5b5e7c9",9960:"c933c35c",9980:"10cd7d2f"}[e]||e)+"."+{53:"731ac1ae",54:"f6c185dc",229:"d73494f5",604:"7d90b373",1078:"99445947",1092:"0bee5a84",1148:"d5941de6",1172:"21d76f7a",1210:"91e3ad46",1232:"2c4fc305",1251:"1e10924a",1344:"9d2fbd7a",1770:"b077fc11",1817:"207c9ed8",2666:"c0e3c62f",2782:"3c4b4d92",2891:"34e20451",3085:"63dfc29a",3298:"54015f3a",3349:"52840aa5",3523:"f8d883b5",4195:"2cdf5075",4512:"87f48177",4878:"12dc302d",4972:"1f3b4ce6",5202:"91bc9804",5275:"febd63e3",5359:"6c72c143",5533:"4e7e8a20",5561:"129c86af",5689:"d0188ea3",6164:"408492a1",6174:"f1dcacb9",7049:"df5618fa",7053:"86693754",7095:"2c18c4a4",7275:"edd061b6",7414:"1c40378b",7918:"61bcb5db",8353:"358b314a",8425:"064c1066",8957:"c86c876a",9042:"b9658663",9293:"9544b39d",9404:"a42d065d",9514:"e7329934",9671:"367e753d",9853:"69bbf936",9960:"b2c34276",9980:"2b39a3c3"}[e]+".js",b.miniCssF=e=>{},b.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),b.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},r="canine-docs:",b.l=(e,t,c,f)=>{if(a[e])a[e].push(t);else{var d,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{d.onerror=d.onload=null,clearTimeout(s);var r=a[e];if(delete a[e],d.parentNode&&d.parentNode.removeChild(d),r&&r.forEach((e=>e(c))),t)return t(c)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=l.bind(null,d.onerror),d.onload=l.bind(null,d.onload),o&&document.head.appendChild(d)}},b.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},b.p="/",b.gca=function(e){return e={17896441:"7918","935f2afb":"53","344debb6":"54","03cdf430":"229",ab3acb2a:"604","5402824b":"1078","17b6a24f":"1092","3e125dc6":"1148",b46b7d8b:"1172","18a433c4":"1210","7d26c06c":"1232",d07de6bd:"1251","723cbd1b":"1344","65b97a36":"1770","9c403616":"1817",f1994572:"2782",f3769d49:"2891","1f391b9e":"3085",ea96f03c:"3298","2dc54001":"3349",e289ecfd:"3523",c4f5d8e4:"4195","2edbca5e":"4512",c894e2df:"4878",c1147f98:"5202","5a6f97fe":"5275","5593d6f2":"5359","874276e5":"5533",e5d01f1f:"5561","8b564e48":"5689","9093546b":"6164","23f3f2f9":"6174","9718a321":"7049",b0580eac:"7053",cccedb4f:"7095","7b9432de":"7275","393be207":"7414","0d3eecbe":"8353",b1fc7db6:"8425","8a56e0ba":"8957","0558eea0":"9042","365ebb01":"9293",d07072fe:"9404","1be78505":"9514","0e384e19":"9671",a5b5e7c9:"9853",c933c35c:"9960","10cd7d2f":"9980"}[e]||e,b.p+b.u(e)},(()=>{var e={1303:0,532:0};b.f.j=(t,c)=>{var a=b.o(e,t)?e[t]:void 0;if(0!==a)if(a)c.push(a[2]);else if(/^(1303|532)$/.test(t))e[t]=0;else{var r=new Promise(((c,r)=>a=e[t]=[c,r]));c.push(a[2]=r);var f=b.p+b.u(t),d=new Error;b.l(f,(c=>{if(b.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var r=c&&("load"===c.type?"missing":c.type),f=c&&c.target&&c.target.src;d.message="Loading chunk "+t+" failed.\n("+r+": "+f+")",d.name="ChunkLoadError",d.type=r,d.request=f,a[1](d)}}),"chunk-"+t,t)}},b.O.j=t=>0===e[t];var t=(t,c)=>{var a,r,f=c[0],d=c[1],o=c[2],n=0;if(f.some((t=>0!==e[t]))){for(a in d)b.o(d,a)&&(b.m[a]=d[a]);if(o)var i=o(b)}for(t&&t(c);n Jackal Foundation | Jackal Chain Docs - +

Jackal Foundation

What is the Jackal Foundation?​

The Jackal Community is anchored by the Jackal Foundation. A non-profit organization that drives the direction of development by researching and testing software, supporting projects, and ensuring decentralization.

What is the scope of the Jackal Foundation?​

  • Maintain the Jackal Protocol.

  • Fund ecosystem development.

  • Create and manage Jackal Collectives.

  • Manage the core governance of the Jackal Protocol.

  • Represent and enforce changes made through the governance process.

- + \ No newline at end of file diff --git a/docs/contributors/join.html b/docs/contributors/join.html index 35d45a8..30c3dd9 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 5ec5052..2ecda54 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 is a Canadian software development company that contributed to the early development of the Jackal Protocol. Jackal Labs does not own or operate the Jackal Protocol as it is decentralized and autonomous. Jackal Labs proposes changes to the Jackal Protocol through on-chain governance.

What is the scope of Jackal Labs?​

  • Contribute to the early development of the Jackal Protocol.

  • Perform continuous research and development for the Protocol.

  • Propose changes to the protocol through governance.

- + \ No newline at end of file diff --git a/docs/ecosystem/bounties.html b/docs/ecosystem/bounties.html index 2f219ad..4829b8f 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 2ed473a..78e9b1a 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 2c836fc..dc7c385 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 0b9cdb5..4f77367 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 3b6681e..4e84e48 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -5,13 +5,13 @@ Getting Started | Jackal Chain Docs - +

Getting Started

You’ve arrived at the Jackal Wiki! Thank you for taking the first steps towards a more secure, simple, and self-custodial digital experience.

The Jackal Protocol is open source and community-driven to facilitate a transparent and trustless system. This wiki is a one-stop shop with information on the protocol, usage, infrastructure, and opportunities.

The Jackal Wiki is maintained by Jackal Labs and the Jackal Foundation teams. We work tirelessly to maintain our documentation, but if you happen to stumble upon something out-of-date, please reach out to our teams so we can keep our documentation accurate in perpetuity.

- + \ No newline at end of file diff --git a/docs/nodes/hardware.html b/docs/nodes/hardware.html index 118c2ef..bb2bab1 100644 --- a/docs/nodes/hardware.html +++ b/docs/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/installation.html b/docs/nodes/installation.html index 9db6818..da71e81 100644 --- a/docs/nodes/installation.html +++ b/docs/nodes/installation.html @@ -5,13 +5,13 @@ Installing Canined | Jackal Chain Docs - +
-

Installing Canined

Pre-Requisites​

There are a few things needed before installing.

Installing Go​

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

On Ububtu you can install it with:

wget https://golang.org/dl/go1.18.2.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.18.2.linux-amd64.tar.gz

Add these lines to the end of ~/.profile:

export GOROOT=/usr/local/go
export GOPATH=$HOME/go
export GO111MODULE=on
export PATH=$PATH:/usr/local/go/bin:$HOME/go/bin

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

source ~/.profile

Building from Source​

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

make install

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

canined version
- +

Installing Canined

Pre-Requisites​

There are a few things needed before installing.

Installing Build Essentials​

sudo apt update
sudo apt install build-essential

Installing Go​

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

On Ububtu you can install it with:

wget https://golang.org/dl/go1.18.2.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.18.2.linux-amd64.tar.gz

Add these lines to the end of ~/.profile:

export GOROOT=/usr/local/go
export GOPATH=$HOME/go
export GO111MODULE=on
export PATH=$PATH:/usr/local/go/bin:$HOME/go/bin

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

source ~/.profile

Building from Source​

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

make install

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

canined version

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.

cd $HOME
echo "[Unit]
Description=Jackal Node
After=network-online.target
[Service]
User=${USER}
ExecStart=$(which canined) start
Restart=always
RestartSec=3
LimitNOFILE=4096
[Install]
WantedBy=multi-user.target
" > canined.service

sudo mv canined.service /lib/systemd/system/
sudo systemctl enable canined.service

# Starting the service
sudo systemctl start canined.service

# Restarting the service
sudo systemctl daemon-reload
sudo systemctl restart canined.service
+ \ No newline at end of file diff --git a/docs/nodes/mainnet.html b/docs/nodes/mainnet.html index 8d79acb..0038194 100644 --- a/docs/nodes/mainnet.html +++ b/docs/nodes/mainnet.html @@ -5,13 +5,13 @@ Joining Mainnet | Jackal Chain Docs - +

Joining Mainnet

info

Mainnet goes live on October 26th 2022! If you are here before that, these docs will not work!

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

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

chain-id for mainnet is currently canine-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://raw.githubusercontent.com/JackalLabs/woof/master/genesis/woof-final.json

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/testnet.html b/docs/nodes/testnet.html index 88ded25..59ea5e8 100644 --- a/docs/nodes/testnet.html +++ b/docs/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 canine-1.

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.

wget -O ~/.canine/config/genesis.json https://raw.githubusercontent.com/JackalLabs/woof/master/genesis/woof-final.json

export SEEDS="052c498dd1cc603b4d32f772035b6a8ca902def3@23.88.73.211:26656,0bdeaaa237b41e3b964a027a110c6ab5bf561177@209.34.206.38:26656,bf7ee27a24e7d5f45653206fbbda8c4b716b74b1@89.58.38.59:26656,9eecc498dd2542c862f5bfb84ed7d2e1e3d922ab@34.201.48.14:26656,bf62b185eef3c185f8ebf81d5cf54bdc064b21d8@85.10.216.157:26656,43e800018a5b52ba119a5410ff45cbeb63182cc8@207.244.127.5:26656,942087a9665e8235f8037d0b9d2a3f8a8c3d562b@104.207.138.181:26656,9d0094606fe8748f1c06b494f7c0cbbd44808ec6@131.153.59.6:26656,6071fe2fc7e4f49caa4b1fd1cfe19007152312e0@34.76.87.33:26656,3f58d7c35ad55ef6cea94f7aa2ffe79df1c01768@78.107.253.133:26656,46cb18ca32ad7329cb82a10316087794ef12150f@185.107.57.74: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/validators/jackalwallet.html b/docs/nodes/validators/jackalwallet.html index f3dda74..6dd6d73 100644 --- a/docs/nodes/validators/jackalwallet.html +++ b/docs/nodes/validators/jackalwallet.html @@ -5,13 +5,13 @@ Jackal Wallet | Jackal Chain Docs - +

Jackal Wallet

Coming Soon​

- + \ No newline at end of file diff --git a/docs/official-links/jackal-foundation.html b/docs/official-links/jackal-foundation.html index 8259d4e..18bc4cb 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 e66d50b..de7fbd2 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 3ee0426..549a764 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 b2627dd..7f9f7ff 100644 --- a/docs/overview/jackal-tldr.html +++ b/docs/overview/jackal-tldr.html @@ -5,13 +5,13 @@ What is the Jackal Protocol? | Jackal Chain Docs - +

What is the Jackal Protocol?

The Jackal Protocol is a fast, scalable, and secure blockchain that empowers individuals, developers, and enterprises to increase their data privacy and cybersecurity posture without sacrificing ease of use. This protocol strives to offer world-class applications to protect the planet’s most important data–your data.

Unlike other blockchains, the Jackal Protocol utilizes both validators and storage providers. The Jackal Protocol allows developers to build decentralized applications with the ability to interface with all Jackal Protocol Modules–including storage contracts and file structure. This allows developers to adjust the ownership of data, share data with other jackal users or smart contracts, and transfer small or large amounts of encrypted data without centralized storage providers or middleware. This data is always self-custodial meaning no one– not even the team at Jackal–can access or view your data.

This blockchain currently consists of seven modules: jklMint, lp, rns, wasm, storage, filetree and dsig. These interoperable modules allow for the creation of secure, scalable, and truly decentralized applications.

- + \ No newline at end of file diff --git a/docs/overview/jkl.html b/docs/overview/jkl.html index be14b29..ff069c1 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 native token that powers the infrastructure of the Jackal Protocol and can be applied in a multitude of different ways.

dApps​

Applications built on the Jackal Protocol, such as Jackal Storage and the RNS Marketplace may choose to leverage 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 staked 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, spending, 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 JKL rewards.

- + \ No newline at end of file diff --git a/docs/overview/why-jackal.html b/docs/overview/why-jackal.html index 2a964f7..3710fe8 100644 --- a/docs/overview/why-jackal.html +++ b/docs/overview/why-jackal.html @@ -5,13 +5,13 @@ Why would I use the Jackal Protocol? | Jackal Chain Docs - +

Why would I use the Jackal Protocol?

Jackal users are empowered with a fast and scalable blockchain while having the ability to be self-custodial of their data. It may be hard to comprehend why many strive for high digital privacy and cyber security posture, so here is a community-compiled list of reasons people use the Jackal Protocol.

  • "I want a transparent, secure, and unified experience with web3."

  • "The same reason we think our phones are listening to us!"

  • "I want better cybersecurity but don’t want to change your passwords every month."

  • "Because I shouldn't have to give up ownership of all my personal information to access basic services on the Internet."

  • "I can't trust third parties that sell your data when 15 million people in the US alone experience identity theft with over 50 billion in financial losses!"

  • "Data breaches have exposed 14 billion of our records including passwords, usernames, emails, IP addresses, phone numbers, VINs, physical addresses, and more!"

  • "I believe in open-source, transparent, ethical and humane technology."

  • "It's empowering to own your data."

  • "Digital privacy is a fundamental human right and cybersecurity should be accessible to all."

  • "Third-party cookies or trackers are invasive and unnecessary."

  • "The only person that can sell my data is me."

- + \ No newline at end of file diff --git a/docs/protocol/encryption.html b/docs/protocol/encryption.html index ed53ed1..a2071cf 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 888d3b0..2a18aa7 100644 --- a/docs/protocol/modules/dsig.html +++ b/docs/protocol/modules/dsig.html @@ -5,13 +5,13 @@ dsig Module | Jackal Chain Docs - +

dsig Module

dsig​

The dsig module is a digital signature service that allows users to collect signatures from multiple users who are registered on the Jackal Blockchain. Users can create 'forms' associated with a unique file stored on Jackal and can add signees (users) to collect their signatures. The signees have the following options to respond: Approve, Deny, Abstain, and No Response (Default). The form can execute a custom function after all users have voted to Approve the form.

- + \ No newline at end of file diff --git a/docs/protocol/modules/filetree.html b/docs/protocol/modules/filetree.html index e493f4f..20c35b4 100644 --- a/docs/protocol/modules/filetree.html +++ b/docs/protocol/modules/filetree.html @@ -5,13 +5,13 @@ 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.

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

jklmint Module

jklmint​

The Jackal Mint module is a replacement for the cosmos-sdk module: Mint. The key differences between this and the pre-existing minting module are that jklmint does not adjust inflation based on the rate of bonded tokens. At genesis, the jklmint module prints 10 JKL per block and distribute it to both the storage module and the default distribution module.

- + \ No newline at end of file diff --git a/docs/protocol/modules/lp.html b/docs/protocol/modules/lp.html index 734d333..456ed48 100644 --- a/docs/protocol/modules/lp.html +++ b/docs/protocol/modules/lp.html @@ -5,13 +5,13 @@ lp Module | Jackal Chain Docs - +

lp Module

lp​

The lp module allows for a native automated market maker (AMM) liquidity pools (LP) to be built directly into the Jackal Blockchain. This allows for local prices for payment mechanisms without the need for oracles, along with the ability to swap tokens directly from the Jackal dashboard or the Jackal Swap service.

- + \ No newline at end of file diff --git a/docs/protocol/modules/module-overview.html b/docs/protocol/modules/module-overview.html index aeebd67..0a60581 100644 --- a/docs/protocol/modules/module-overview.html +++ b/docs/protocol/modules/module-overview.html @@ -5,13 +5,13 @@ Module Overview | Jackal Chain Docs - +

Module Overview

Protocol Overview

- + \ No newline at end of file diff --git a/docs/protocol/modules/rns.html b/docs/protocol/modules/rns.html index ea6841d..2b045a5 100644 --- a/docs/protocol/modules/rns.html +++ b/docs/protocol/modules/rns.html @@ -5,13 +5,13 @@ rns Module | Jackal Chain Docs - +

rns Module

rns​

The rns module is a name service that allows users to manage human-readable names when interacting with the Jackal Blockchain. Users can register names, list names for sale, buy names on the marketplace, and place/accept bids from other users on their names.

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

storage Module

storage​

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. Miners, or as well call them, Storage Providers, are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the miner to post the raw data 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 timeframe, 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.

Interaction Outline​

A user first sends a file to an available Storage Provider. A list of Storage Providers can be found on the blockchain, and providers can deny any incoming request if they wish not to store new files. The Storage Provider, after receiving the entire file, keeps that file in memory and posts a contract to the blockchain. If the contract is not signed by the sender in X blocks (configurable by the Storage Provider), then the file is removed from memory, and the contract is burned. However, if the contract is signed by the user within the given blocks, the file is committed to the Storage Provider's hard storage, and the challenge windows start being created for the now active contract.

- + \ No newline at end of file diff --git a/docs/protocol/modules/wasm.html b/docs/protocol/modules/wasm.html index c26e7f2..29ec496 100644 --- a/docs/protocol/modules/wasm.html +++ b/docs/protocol/modules/wasm.html @@ -5,13 +5,13 @@ wasm Module | Jackal Chain Docs - +

wasm Module

wasm​

Jackal incorporates the CosmWasm smart contracting platform built for the Cosmos Ecosystem. The primary programing language used in this module is Rust for building secure and multichain smart contracts, yet any language that can be compiled into WASM can be supported as they become available.

- + \ No newline at end of file diff --git a/docs/protocol/p-o-p.html b/docs/protocol/p-o-p.html index 4c4485a..3df612f 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

- + \ No newline at end of file diff --git a/docs/protocol/storageproviders/casual-build.html b/docs/protocol/storageproviders/casual-build.html index 6990cc3..685898e 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 0578305..40205b6 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 7f9cae3..e5279b5 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 f20c7a8..ed5938c 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 a6961c9..b013bf9 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 226333c..fb7e975 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 f4f2fe6..58837ae 100644 --- a/docs/using-jackal/dashboard.html +++ b/docs/using-jackal/dashboard.html @@ -5,13 +5,13 @@ Jackal Dashboard | Jackal Chain Docs - +

Jackal Dashboard

What is the Jackal Dashboard?​

The Jackal Dashboard is your unified experience with the Jackal and Cosmos ecosystem. From the Jackal Dashboard, users can;

  • Upload, download, and share files.
  • Access the Jackal Swap interface to swap Cosmos native tokens.
  • Register RNS names.
  • Use the RNS marketplace.
  • Host static websites.
  • Participate in Governance.
  • Delegate tokens to validators.
  • More to come!

TODO: JACKAL DASHBOARD IMAGES AND HOW-TO

- + \ No newline at end of file diff --git a/docs/using-jackal/delegate.html b/docs/using-jackal/delegate.html index 3a4ce6c..295fb12 100644 --- a/docs/using-jackal/delegate.html +++ b/docs/using-jackal/delegate.html @@ -5,13 +5,13 @@ Staking | Jackal Chain Docs - +

Staking

How to Delegate to a Validator​

TODO: How to delegate

- + \ No newline at end of file diff --git a/docs/using-jackal/fund.html b/docs/using-jackal/fund.html index 3edede1..7a6ffbb 100644 --- a/docs/using-jackal/fund.html +++ b/docs/using-jackal/fund.html @@ -5,13 +5,13 @@ Funding your Account | Jackal Chain Docs - +

Funding your Account

How to Fund your Account.​

TODO: Funding

- + \ No newline at end of file diff --git a/docs/using-jackal/wallet/jackalwallet.html b/docs/using-jackal/wallet/jackalwallet.html index 293e114..520b69b 100644 --- a/docs/using-jackal/wallet/jackalwallet.html +++ b/docs/using-jackal/wallet/jackalwallet.html @@ -5,13 +5,13 @@ Jackal Wallet | Jackal Chain Docs - +

Jackal Wallet

Coming Soon​

- + \ No newline at end of file diff --git a/docs/using-jackal/wallet/keplr.html b/docs/using-jackal/wallet/keplr.html index 4c82cf9..caea4ea 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 without privacy.

To use Jackal applications with a high privacy and security posture, create a new Jackal Wallet or import private keys into a Jackal Wallet.

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 6311b61..338cdd8 100644 --- a/index.html +++ b/index.html @@ -5,13 +5,13 @@ Jackal Chain Docs | Jackal Chain Docs - +

Jackal Chain Docs

The who, what, where, why, when, and how to get started with Jackal's blockchain!

Get Started

About Jackal

Get Involved

Decentralize the Network

- + \ No newline at end of file diff --git a/markdown-page.html b/markdown-page.html index 29efddf..d86c36f 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