From b68f792bef4b5a6b56aa35adb25401c48fbdccf3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 13 Apr 2024 02:37:48 +0000 Subject: [PATCH] deploy: cc717a7a0498d5d797b89f0853cf89af99330160 --- 404.html | 4 ++-- assets/js/c97fbebf.58b1380a.js | 1 + assets/js/c97fbebf.d5e291ba.js | 1 - .../{runtime~main.b99ad448.js => runtime~main.de15f1c3.js} | 2 +- docs/contributors/foundation.html | 4 ++-- docs/contributors/join.html | 4 ++-- docs/contributors/labs.html | 4 ++-- docs/developers/apis/apis.html | 4 ++-- docs/developers/apis/intro.html | 4 ++-- docs/developers/dAppLibraries/intro.html | 4 ++-- docs/developers/dAppLibraries/jackal_go.html | 4 ++-- docs/developers/dAppLibraries/jackal_js.html | 4 ++-- docs/developers/dAppLibraries/jackal_nodejs.html | 4 ++-- docs/developers/dAppLibraries/jackal_protos.html | 4 ++-- docs/developers/faucet.html | 4 ++-- docs/developers/intro.html | 4 ++-- docs/ecosystem/grants-funding.html | 4 ++-- docs/ecosystem/partnerships.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 | 6 +++--- docs/nodes/nodes/testnet.html | 4 ++-- docs/nodes/providers/building.html | 4 ++-- docs/nodes/providers/hardware/diy-serious copy.html | 4 ++-- docs/nodes/providers/hardware/enterprise.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/filetree.html | 4 ++-- docs/protocol/modules/jklmint.html | 4 ++-- docs/protocol/modules/module-overview.html | 4 ++-- docs/protocol/modules/rns.html | 4 ++-- docs/protocol/modules/storage.html | 4 ++-- docs/protocol/modules/wasm.html | 4 ++-- docs/protocol/p-o-p.html | 4 ++-- docs/protocol/tokens.html | 4 ++-- docs/protocol/validators.html | 4 ++-- docs/using-jackal/cli/cli.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 ++-- 52 files changed, 101 insertions(+), 101 deletions(-) create mode 100644 assets/js/c97fbebf.58b1380a.js delete mode 100644 assets/js/c97fbebf.d5e291ba.js rename assets/js/{runtime~main.b99ad448.js => runtime~main.de15f1c3.js} (98%) diff --git a/404.html b/404.html index b96ec9a..847d8c8 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/c97fbebf.58b1380a.js b/assets/js/c97fbebf.58b1380a.js new file mode 100644 index 0000000..370df01 --- /dev/null +++ b/assets/js/c97fbebf.58b1380a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[4286],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=c(n),h=o,m=d["".concat(l,".").concat(h)]||d[h]||u[h]||r;return n?a.createElement(m,s(s({ref:t},p),{},{components:n})):a.createElement(m,s({ref:t},p))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,s=new Array(r);s[0]=h;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:o,s[1]=i;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var a=n(7462),o=(n(7294),n(3905));const r={sidebar_position:4},s="Joining Mainnet",i={unversionedId:"nodes/nodes/mainnet",id:"nodes/nodes/mainnet",title:"Joining Mainnet",description:"Perform the following as the jackal user.",source:"@site/docs/nodes/nodes/4_mainnet.md",sourceDirName:"nodes/nodes",slug:"/nodes/nodes/mainnet",permalink:"/docs/nodes/nodes/mainnet",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/nodes/nodes/4_mainnet.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Joining Testnet",permalink:"/docs/nodes/nodes/testnet"},next:{title:"Creating Validator",permalink:"/docs/nodes/validators/joining"}},l={},c=[{value:"Backing up key files",id:"backing-up-key-files",level:2},{value:"Syncing to Current Height",id:"syncing-to-current-height",level:2},{value:"Snapshot method",id:"snapshot-method",level:3},{value:"State Sync Method",id:"state-sync-method",level:3},{value:"State Sync Method 2",id:"state-sync-method-2",level:3},{value:"Versions for Sync",id:"versions-for-sync",level:3},{value:"Starting the daemon",id:"starting-the-daemon",level:2}],p={toc:c},d="wrapper";function u(e){let{components:t,...n}=e;return(0,o.kt)(d,(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"joining-mainnet"},"Joining Mainnet"),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"Perform the following as the ",(0,o.kt)("inlineCode",{parentName:"p"},"jackal")," user.")),(0,o.kt)("p",null,"After installing ",(0,o.kt)("inlineCode",{parentName:"p"},"canined"),". You can join the mainnet by following these steps:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'canined init "NODE_NAME" --chain-id=jackal-1\n')),(0,o.kt)("p",null,"Then we want to replace our generated genesis file with the one used to start the network."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'wget -O ~/.canine/config/genesis.json https://cdn.discordapp.com/attachments/1002389406650466405/1034968352591986859/updated_genesis2.json\n\nSEEDS=$(wget https://raw.githubusercontent.com/JackalLabs/canine-mainnet-genesis/master/genesis/seeds.txt -q -O -)\nPEERS=`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, -`\nGAS="0.002ujkl"\n\nsed -i.bak -e "s/^seeds *=.*/seeds = \\"$SEEDS\\"/; s/^persistent_peers *=.*/persistent_peers = \\"$PEERS\\"/" $HOME/.canine/config/config.toml\n')),(0,o.kt)("h2",{id:"backing-up-key-files"},"Backing up key files"),(0,o.kt)("p",null,"The created ",(0,o.kt)("inlineCode",{parentName:"p"},"node_key.json")," and ",(0,o.kt)("inlineCode",{parentName:"p"},"priv_validator_key.json")," cannot be recovered. These files ",(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("em",{parentName:"strong"},"must"))," be backed up."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},"mkdir ~/key_backup\ncp ~/.canine/config/node_key.json ~/key_backup\ncp ~/.canine/config/priv_validator_key.json ~/key_backup\n")),(0,o.kt)("p",null,"You should also keep an offline backup. Using a program like ",(0,o.kt)("inlineCode",{parentName:"p"},"WinSCP"),", you can easily copy these files to your personal\ndesktop for safe storage/backup."),(0,o.kt)("h2",{id:"syncing-to-current-height"},"Syncing to Current Height"),(0,o.kt)("h3",{id:"snapshot-method"},"Snapshot method"),(0,o.kt)("p",null,"Get a snapshot ",(0,o.kt)("a",{parentName:"p",href:"https://polkachu.com/tendermint_snapshots/jackal"},"here"),"."),(0,o.kt)("p",null,"For the sake of this guide, the snapshot we download is named ",(0,o.kt)("inlineCode",{parentName:"p"},"jackal.tar.lz4")),(0,o.kt)("p",null,"If you plan on becoming a validator, before using the ",(0,o.kt)("inlineCode",{parentName:"p"},"unsafe-reset-all")," flag, always besure to back up\nyour ",(0,o.kt)("inlineCode",{parentName:"p"},"priv_validator_state.json")," file."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},"canined unsafe-reset-all --keep-addr-book\nlz4 -c -d jackal.tar.lz4 | tar -x -C $HOME/.canine\n")),(0,o.kt)("p",null,"Then start the chain again."),(0,o.kt)("h3",{id:"state-sync-method"},"State Sync Method"),(0,o.kt)("p",null,"There are a couple of ways to go about doing state sync.\nFirst is the easier route. Visit ",(0,o.kt)("a",{parentName:"p",href:"https://ping.pub/jackal/statesync"},"Ping.pub")," for Jackals State Sync configuration\nsettings."),(0,o.kt)("p",null,"Next, copy these settings from Ping.pub to your ",(0,o.kt)("inlineCode",{parentName:"p"},"config.toml")," in the ",(0,o.kt)("inlineCode",{parentName:"p"},"[statesync]")," section."),(0,o.kt)("p",null,"It should look similar to this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'#######################################################\n### State Sync Configuration Options ###\n#######################################################\n[statesync]\n# State sync rapidly bootstraps a new node by discovering, fetching, and restoring a state machine\n# snapshot from peers instead of fetching and replaying historical blocks. Requires some peers in\n# the network to take and serve state machine snapshots. State sync is not attempted if the node\n# has any local state (LastBlockHeight > 0). The node will have a truncated block history,\n# starting from the height of the snapshot.\nenable = true\n\n# RPC servers (comma-separated) for light client verification of the synced state machine and\n# retrieval of state data for node bootstrapping. Also needs a trusted height and corresponding\n# header hash obtained from a trusted source, and a period during which validators can be trusted.\n#\n# For Cosmos SDK-based chains, trust_period should usually be about 2/3 of the unbonding time (~2\n# weeks) during which they can be financially punished (slashed) for misbehavior.\nrpc_servers = "https://rpc.jackalprotocol.com:443,https://rpc.jackalprotocol.com:443"\ntrust_height = 333000\ntrust_hash = "1685850c2d115a86af9059bd3f36a4fbbb0e8ba7f37863d517b6d2f54116daca"\ntrust_period = "168h" # 2/3 of unbonding time\n\n# Time to spend discovering snapshots before initiating a restore.\ndiscovery_time = "15s"\n\n# Temporary directory for state sync snapshot chunks, defaults to the OS tempdir (typically /tmp).\n# Will create a new, randomly named directory within, and remove it when done.\ntemp_dir = ""\n\n# The timeout duration before re-requesting a chunk, possibly from a different\n# peer (default: 1 minute).\nchunk_request_timeout = "10s"\n\n# The number of concurrent chunk fetchers to run (default: 1).\nchunk_fetchers = "42"\n')),(0,o.kt)("p",null,"State syncing can take up to a few minutes to complete. Watch the logs to ensure it's happening. When a snapshot is\nfound, you will see output in your log that is similar to this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'1PM INF Discovered new snapshot format=1 hash="S.\ufffdh\ufffdF\ufffd\ufffd\ufffd\\"\\x1d6+\\x1e\ufffd\ufffd\ufffd\u0785\ufffd\ufffd`v@\ufffd\u0446\ufffd\ufffd\ufffd\ufffd\ufffd" height=1810000 module=statesync\n')),(0,o.kt)("p",null,"It will download, verify, and apply chuncks of blockchain data. When it finishes you will see it catching up to blocks"),(0,o.kt)("h3",{id:"state-sync-method-2"},"State Sync Method 2"),(0,o.kt)("p",null,"The follow commandline code will edit your ",(0,o.kt)("inlineCode",{parentName:"p"},"config.toml")," with the proper information for state syncing to the most\nrecent snapshot 3000 blocks and beyond."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'STATE_SYNC_RPC=https://rpc.jackalprotocol.com:443\nLATEST_HEIGHT=$(curl -s $STATE_SYNC_RPC/block | jq -r .result.block.header.height)\nSYNC_BLOCK_HEIGHT=$(($LATEST_HEIGHT - 3000))\nSYNC_BLOCK_HASH=$(curl -s "$STATE_SYNC_RPC/block?height=$SYNC_BLOCK_HEIGHT" | jq -r .result.block_id.hash)\n\nsed -i.bak -e "s|^enable *=.*|enable = true|" $HOME/.canine/config/config.toml\nsed -i.bak -e "s|^rpc_servers *=.*|rpc_servers = \\"$STATE_SYNC_RPC,$STATE_SYNC_RPC\\"|" \\\n $HOME/.canine/config/config.toml\nsed -i.bak -e "s|^trust_height *=.*|trust_height = $SYNC_BLOCK_HEIGHT|" \\\n $HOME/.canine/config/config.toml\nsed -i.bak -e "s|^trust_hash *=.*|trust_hash = \\"$SYNC_BLOCK_HASH\\"|" \\\n $HOME/.canine/config/config.toml\n')),(0,o.kt)("p",null,"When you state sync, you can start with the latest version of ",(0,o.kt)("inlineCode",{parentName:"p"},"canined"),"."),(0,o.kt)("h3",{id:"versions-for-sync"},"Versions for Sync"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:null},"block height"),(0,o.kt)("th",{parentName:"tr",align:null},"canined version"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:null},"45381"),(0,o.kt)("td",{parentName:"tr",align:null},"1.1.2")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:null},"0"),(0,o.kt)("td",{parentName:"tr",align:null},"1.1.0")))),(0,o.kt)("h2",{id:"starting-the-daemon"},"Starting the daemon"),(0,o.kt)("p",null,"Start the daemon and sync to the current height."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},"sudo systemctl start jackal\nsudo journalctl -u jackal -f\n")),(0,o.kt)("p",null,"Watch the logs and ensure you are either state syncing correctly, or are syncing up to the current height."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c97fbebf.d5e291ba.js b/assets/js/c97fbebf.d5e291ba.js deleted file mode 100644 index 7eb6ed7..0000000 --- a/assets/js/c97fbebf.d5e291ba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkcanine_docs=self.webpackChunkcanine_docs||[]).push([[4286],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=c(n),h=o,m=d["".concat(l,".").concat(h)]||d[h]||u[h]||r;return n?a.createElement(m,s(s({ref:t},p),{},{components:n})):a.createElement(m,s({ref:t},p))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,s=new Array(r);s[0]=h;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:o,s[1]=i;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var a=n(7462),o=(n(7294),n(3905));const r={sidebar_position:4},s="Joining Mainnet",i={unversionedId:"nodes/nodes/mainnet",id:"nodes/nodes/mainnet",title:"Joining Mainnet",description:"Perform the following as the jackal user.",source:"@site/docs/nodes/nodes/4_mainnet.md",sourceDirName:"nodes/nodes",slug:"/nodes/nodes/mainnet",permalink:"/docs/nodes/nodes/mainnet",draft:!1,editUrl:"https://github.com/JackalLabs/canine-docs/blob/master/docs/nodes/nodes/4_mainnet.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Joining Testnet",permalink:"/docs/nodes/nodes/testnet"},next:{title:"Creating Validator",permalink:"/docs/nodes/validators/joining"}},l={},c=[{value:"Backing up key files",id:"backing-up-key-files",level:2},{value:"Syncing to Current Height",id:"syncing-to-current-height",level:2},{value:"Snapshot method",id:"snapshot-method",level:3},{value:"State Sync Method",id:"state-sync-method",level:3},{value:"State Sync Method 2",id:"state-sync-method-2",level:3},{value:"Versions for Sync",id:"versions-for-sync",level:3},{value:"Starting the daemon",id:"starting-the-daemon",level:2}],p={toc:c},d="wrapper";function u(e){let{components:t,...n}=e;return(0,o.kt)(d,(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"joining-mainnet"},"Joining Mainnet"),(0,o.kt)("admonition",{type:"tip"},(0,o.kt)("p",{parentName:"admonition"},"Perform the following as the ",(0,o.kt)("inlineCode",{parentName:"p"},"jackal")," user.")),(0,o.kt)("p",null,"After installing ",(0,o.kt)("inlineCode",{parentName:"p"},"canined"),". You can join the mainnet by following these steps:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'canined init "NODE_NAME" --chain-id=jackal-1\n')),(0,o.kt)("p",null,"Then we want to replace our generated genesis file with the one used to start the network."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'wget -O ~/.canine/config/genesis.json https://cdn.discordapp.com/attachments/1002389406650466405/1034968352591986859/updated_genesis2.json\n\nSEEDS=$(wget https://raw.githubusercontent.com/JackalLabs/canine-mainnet-genesis/master/genesis/seeds.txt -q -O -)\nPEERS=`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, -`\nGAS="0.002ujkl"\n\nsed -i.bak -e "s/^seeds *=.*/seeds = \\"$SEEDS\\"/; s/^persistent_peers *=.*/persistent_peers = \\"$PEERS\\"/" $HOME/.canine/config/config.toml\n')),(0,o.kt)("h2",{id:"backing-up-key-files"},"Backing up key files"),(0,o.kt)("p",null,"The created ",(0,o.kt)("inlineCode",{parentName:"p"},"node_key.json")," and ",(0,o.kt)("inlineCode",{parentName:"p"},"priv_validator_key.json")," cannot be recovered. These files ",(0,o.kt)("strong",{parentName:"p"},(0,o.kt)("em",{parentName:"strong"},"must"))," be backed up."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},"mkdir ~/key_backup\ncp ~/.canine/config/node_key.json ~/key_backup\ncp ~/.canine/config/priv_validator_key.json ~/key_backup\n")),(0,o.kt)("p",null,"You should also keep an offline backup. Using a program like ",(0,o.kt)("inlineCode",{parentName:"p"},"WinSCP"),", you can easily copy these files to your personal\ndesktop for safe storage/backup."),(0,o.kt)("h2",{id:"syncing-to-current-height"},"Syncing to Current Height"),(0,o.kt)("h3",{id:"snapshot-method"},"Snapshot method"),(0,o.kt)("p",null,"Get a snapshot ",(0,o.kt)("a",{parentName:"p",href:"http://snapshots.autostake.net/jackal-1/"},"here"),"."),(0,o.kt)("p",null,"For the sake of this guide, the snapshot we download is named ",(0,o.kt)("inlineCode",{parentName:"p"},"jackal.tar.lz4")),(0,o.kt)("p",null,"If you plan on becoming a validator, before using the ",(0,o.kt)("inlineCode",{parentName:"p"},"unsafe-reset-all")," flag, always besure to back up\nyour ",(0,o.kt)("inlineCode",{parentName:"p"},"priv_validator_state.json")," file."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},"canined unsafe-reset-all --keep-addr-book\nlz4 -c -d jackal.tar.lz4 | tar -x -C $HOME/.canine\n")),(0,o.kt)("p",null,"Then start the chain again."),(0,o.kt)("h3",{id:"state-sync-method"},"State Sync Method"),(0,o.kt)("p",null,"There are a couple of ways to go about doing state sync.\nFirst is the easier route. Visit ",(0,o.kt)("a",{parentName:"p",href:"https://ping.pub/jackal/statesync"},"Ping.pub")," for Jackals State Sync configuration\nsettings."),(0,o.kt)("p",null,"Next, copy these settings from Ping.pub to your ",(0,o.kt)("inlineCode",{parentName:"p"},"config.toml")," in the ",(0,o.kt)("inlineCode",{parentName:"p"},"[statesync]")," section."),(0,o.kt)("p",null,"It should look similar to this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'#######################################################\n### State Sync Configuration Options ###\n#######################################################\n[statesync]\n# State sync rapidly bootstraps a new node by discovering, fetching, and restoring a state machine\n# snapshot from peers instead of fetching and replaying historical blocks. Requires some peers in\n# the network to take and serve state machine snapshots. State sync is not attempted if the node\n# has any local state (LastBlockHeight > 0). The node will have a truncated block history,\n# starting from the height of the snapshot.\nenable = true\n\n# RPC servers (comma-separated) for light client verification of the synced state machine and\n# retrieval of state data for node bootstrapping. Also needs a trusted height and corresponding\n# header hash obtained from a trusted source, and a period during which validators can be trusted.\n#\n# For Cosmos SDK-based chains, trust_period should usually be about 2/3 of the unbonding time (~2\n# weeks) during which they can be financially punished (slashed) for misbehavior.\nrpc_servers = "https://rpc.jackalprotocol.com:443,https://rpc.jackalprotocol.com:443"\ntrust_height = 333000\ntrust_hash = "1685850c2d115a86af9059bd3f36a4fbbb0e8ba7f37863d517b6d2f54116daca"\ntrust_period = "168h" # 2/3 of unbonding time\n\n# Time to spend discovering snapshots before initiating a restore.\ndiscovery_time = "15s"\n\n# Temporary directory for state sync snapshot chunks, defaults to the OS tempdir (typically /tmp).\n# Will create a new, randomly named directory within, and remove it when done.\ntemp_dir = ""\n\n# The timeout duration before re-requesting a chunk, possibly from a different\n# peer (default: 1 minute).\nchunk_request_timeout = "10s"\n\n# The number of concurrent chunk fetchers to run (default: 1).\nchunk_fetchers = "42"\n')),(0,o.kt)("p",null,"State syncing can take up to a few minutes to complete. Watch the logs to ensure it's happening. When a snapshot is\nfound, you will see output in your log that is similar to this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'1PM INF Discovered new snapshot format=1 hash="S.\ufffdh\ufffdF\ufffd\ufffd\ufffd\\"\\x1d6+\\x1e\ufffd\ufffd\ufffd\u0785\ufffd\ufffd`v@\ufffd\u0446\ufffd\ufffd\ufffd\ufffd\ufffd" height=1810000 module=statesync\n')),(0,o.kt)("p",null,"It will download, verify, and apply chuncks of blockchain data. When it finishes you will see it catching up to blocks"),(0,o.kt)("h3",{id:"state-sync-method-2"},"State Sync Method 2"),(0,o.kt)("p",null,"The follow commandline code will edit your ",(0,o.kt)("inlineCode",{parentName:"p"},"config.toml")," with the proper information for state syncing to the most\nrecent snapshot 3000 blocks and beyond."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},'STATE_SYNC_RPC=https://rpc.jackalprotocol.com:443\nLATEST_HEIGHT=$(curl -s $STATE_SYNC_RPC/block | jq -r .result.block.header.height)\nSYNC_BLOCK_HEIGHT=$(($LATEST_HEIGHT - 3000))\nSYNC_BLOCK_HASH=$(curl -s "$STATE_SYNC_RPC/block?height=$SYNC_BLOCK_HEIGHT" | jq -r .result.block_id.hash)\n\nsed -i.bak -e "s|^enable *=.*|enable = true|" $HOME/.canine/config/config.toml\nsed -i.bak -e "s|^rpc_servers *=.*|rpc_servers = \\"$STATE_SYNC_RPC,$STATE_SYNC_RPC\\"|" \\\n $HOME/.canine/config/config.toml\nsed -i.bak -e "s|^trust_height *=.*|trust_height = $SYNC_BLOCK_HEIGHT|" \\\n $HOME/.canine/config/config.toml\nsed -i.bak -e "s|^trust_hash *=.*|trust_hash = \\"$SYNC_BLOCK_HASH\\"|" \\\n $HOME/.canine/config/config.toml\n')),(0,o.kt)("p",null,"When you state sync, you can start with the latest version of ",(0,o.kt)("inlineCode",{parentName:"p"},"canined"),"."),(0,o.kt)("h3",{id:"versions-for-sync"},"Versions for Sync"),(0,o.kt)("table",null,(0,o.kt)("thead",{parentName:"table"},(0,o.kt)("tr",{parentName:"thead"},(0,o.kt)("th",{parentName:"tr",align:null},"block height"),(0,o.kt)("th",{parentName:"tr",align:null},"canined version"))),(0,o.kt)("tbody",{parentName:"table"},(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:null},"45381"),(0,o.kt)("td",{parentName:"tr",align:null},"1.1.2")),(0,o.kt)("tr",{parentName:"tbody"},(0,o.kt)("td",{parentName:"tr",align:null},"0"),(0,o.kt)("td",{parentName:"tr",align:null},"1.1.0")))),(0,o.kt)("h2",{id:"starting-the-daemon"},"Starting the daemon"),(0,o.kt)("p",null,"Start the daemon and sync to the current height."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-sh"},"sudo systemctl start jackal\nsudo journalctl -u jackal -f\n")),(0,o.kt)("p",null,"Watch the logs and ensure you are either state syncing correctly, or are syncing up to the current height."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.b99ad448.js b/assets/js/runtime~main.de15f1c3.js similarity index 98% rename from assets/js/runtime~main.b99ad448.js rename to assets/js/runtime~main.de15f1c3.js index 837f38f..48dce4d 100644 --- a/assets/js/runtime~main.b99ad448.js +++ b/assets/js/runtime~main.de15f1c3.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,t,c,f,b={},r={};function d(e){var a=r[e];if(void 0!==a)return a.exports;var t=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(t.exports,t,t.exports,d),t.loaded=!0,t.exports}d.m=b,d.c=r,e=[],d.O=(a,t,c,f)=>{if(!t){var b=1/0;for(i=0;i=f)&&Object.keys(d.O).every((e=>d.O[e](t[o])))?t.splice(o--,1):(r=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[t,c,f]},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,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var f=Object.create(null);d.r(f);var b={};a=a||[null,t({}),t([]),t(t)];for(var r=2&c&&e;"object"==typeof r&&!~a.indexOf(r);r=t(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,d.d(f,b),f},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",63:"24b4006e",92:"29af3fe3",229:"03cdf430",316:"dda406b3",604:"ab3acb2a",1078:"5402824b",1148:"3e125dc6",1172:"b46b7d8b",1210:"18a433c4",1232:"7d26c06c",1314:"7f9142bb",1385:"15018644",1770:"65b97a36",1817:"9c403616",1947:"e1923b53",2036:"a78c9ae8",2127:"fd23986e",2782:"f1994572",2855:"d866114a",2891:"f3769d49",3085:"1f391b9e",3298:"ea96f03c",3523:"e289ecfd",4195:"c4f5d8e4",4286:"c97fbebf",4302:"e1e382f1",4808:"ebbc57e7",4878:"c894e2df",5275:"5a6f97fe",5533:"874276e5",5689:"8b564e48",5798:"d1f710bd",5863:"bbf127f0",6164:"9093546b",6174:"23f3f2f9",6216:"b92c85d1",6487:"041d8db4",6683:"a4043c8d",7026:"259b7029",7275:"7b9432de",7414:"393be207",7918:"17896441",8206:"24536a89",8425:"b1fc7db6",8511:"e4750cc4",8938:"5da52a1e",8957:"8a56e0ba",9042:"0558eea0",9061:"ec604ac9",9293:"365ebb01",9404:"d07072fe",9514:"1be78505",9671:"0e384e19"}[e]||e)+"."+{53:"b97b0a75",63:"30737e09",92:"b60f901c",229:"7e02b891",316:"ac290eca",604:"76abcdc6",1078:"4a587681",1148:"0e24697b",1172:"1c0f04c0",1210:"6917106a",1232:"feb8587b",1314:"819d8831",1385:"6fe0ce4b",1770:"a013b9ec",1817:"f33e19b2",1947:"169a8c97",2036:"469448d1",2127:"6b726842",2782:"95359acc",2855:"d0d638cd",2891:"a0189038",3085:"91011971",3298:"023d2762",3523:"4d9bf765",4195:"2b582468",4286:"d5e291ba",4302:"1c788e11",4808:"f8960240",4878:"64f123fb",4972:"6c3329cb",5275:"717599dd",5533:"896c7d69",5689:"edcb4052",5798:"6916f84a",5863:"f450fa8e",6164:"8ff0d5a1",6174:"f7b88f60",6216:"819ca774",6487:"abbd2a0d",6683:"1e7ea833",7026:"7c7113bb",7275:"469181e7",7414:"c08b369d",7918:"cb14df91",8206:"e87a2e60",8425:"29a6e063",8511:"241a4edc",8938:"c10ab025",8957:"b5bf4935",9042:"d0dc91a4",9061:"bcac42c2",9293:"4242157c",9404:"5fe674f0",9455:"9e25e52e",9514:"edbc8ded",9671:"639cda40"}[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),c={},f="canine-docs:",d.l=(e,a,t,b)=>{if(c[e])c[e].push(a);else{var r,o;if(void 0!==t)for(var n=document.getElementsByTagName("script"),i=0;i{r.onerror=r.onload=null,clearTimeout(s);var f=c[e];if(delete c[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=l.bind(null,r.onerror),r.onload=l.bind(null,r.onload),o&&document.head.appendChild(r)}},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","24b4006e":"63","29af3fe3":"92","03cdf430":"229",dda406b3:"316",ab3acb2a:"604","5402824b":"1078","3e125dc6":"1148",b46b7d8b:"1172","18a433c4":"1210","7d26c06c":"1232","7f9142bb":"1314","65b97a36":"1770","9c403616":"1817",e1923b53:"1947",a78c9ae8:"2036",fd23986e:"2127",f1994572:"2782",d866114a:"2855",f3769d49:"2891","1f391b9e":"3085",ea96f03c:"3298",e289ecfd:"3523",c4f5d8e4:"4195",c97fbebf:"4286",e1e382f1:"4302",ebbc57e7:"4808",c894e2df:"4878","5a6f97fe":"5275","874276e5":"5533","8b564e48":"5689",d1f710bd:"5798",bbf127f0:"5863","9093546b":"6164","23f3f2f9":"6174",b92c85d1:"6216","041d8db4":"6487",a4043c8d:"6683","259b7029":"7026","7b9432de":"7275","393be207":"7414","24536a89":"8206",b1fc7db6:"8425",e4750cc4:"8511","5da52a1e":"8938","8a56e0ba":"8957","0558eea0":"9042",ec604ac9:"9061","365ebb01":"9293",d07072fe:"9404","1be78505":"9514","0e384e19":"9671"}[e]||e,d.p+d.u(e)},(()=>{var e={1303:0,532:0};d.f.j=(a,t)=>{var c=d.o(e,a)?e[a]:void 0;if(0!==c)if(c)t.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((t,f)=>c=e[a]=[t,f]));t.push(c[2]=f);var b=d.p+d.u(a),r=new Error;d.l(b,(t=>{if(d.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var f=t&&("load"===t.type?"missing":t.type),b=t&&t.target&&t.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",r.name="ChunkLoadError",r.type=f,r.request=b,c[1](r)}}),"chunk-"+a,a)}},d.O.j=a=>0===e[a];var a=(a,t)=>{var c,f,b=t[0],r=t[1],o=t[2],n=0;if(b.some((a=>0!==e[a]))){for(c in r)d.o(r,c)&&(d.m[c]=r[c]);if(o)var i=o(d)}for(a&&a(t);n{"use strict";var e,a,t,c,f,b={},r={};function d(e){var a=r[e];if(void 0!==a)return a.exports;var t=r[e]={id:e,loaded:!1,exports:{}};return b[e].call(t.exports,t,t.exports,d),t.loaded=!0,t.exports}d.m=b,d.c=r,e=[],d.O=(a,t,c,f)=>{if(!t){var b=1/0;for(i=0;i=f)&&Object.keys(d.O).every((e=>d.O[e](t[o])))?t.splice(o--,1):(r=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[t,c,f]},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,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var f=Object.create(null);d.r(f);var b={};a=a||[null,t({}),t([]),t(t)];for(var r=2&c&&e;"object"==typeof r&&!~a.indexOf(r);r=t(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,d.d(f,b),f},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",63:"24b4006e",92:"29af3fe3",229:"03cdf430",316:"dda406b3",604:"ab3acb2a",1078:"5402824b",1148:"3e125dc6",1172:"b46b7d8b",1210:"18a433c4",1232:"7d26c06c",1314:"7f9142bb",1385:"15018644",1770:"65b97a36",1817:"9c403616",1947:"e1923b53",2036:"a78c9ae8",2127:"fd23986e",2782:"f1994572",2855:"d866114a",2891:"f3769d49",3085:"1f391b9e",3298:"ea96f03c",3523:"e289ecfd",4195:"c4f5d8e4",4286:"c97fbebf",4302:"e1e382f1",4808:"ebbc57e7",4878:"c894e2df",5275:"5a6f97fe",5533:"874276e5",5689:"8b564e48",5798:"d1f710bd",5863:"bbf127f0",6164:"9093546b",6174:"23f3f2f9",6216:"b92c85d1",6487:"041d8db4",6683:"a4043c8d",7026:"259b7029",7275:"7b9432de",7414:"393be207",7918:"17896441",8206:"24536a89",8425:"b1fc7db6",8511:"e4750cc4",8938:"5da52a1e",8957:"8a56e0ba",9042:"0558eea0",9061:"ec604ac9",9293:"365ebb01",9404:"d07072fe",9514:"1be78505",9671:"0e384e19"}[e]||e)+"."+{53:"b97b0a75",63:"30737e09",92:"b60f901c",229:"7e02b891",316:"ac290eca",604:"76abcdc6",1078:"4a587681",1148:"0e24697b",1172:"1c0f04c0",1210:"6917106a",1232:"feb8587b",1314:"819d8831",1385:"6fe0ce4b",1770:"a013b9ec",1817:"f33e19b2",1947:"169a8c97",2036:"469448d1",2127:"6b726842",2782:"95359acc",2855:"d0d638cd",2891:"a0189038",3085:"91011971",3298:"023d2762",3523:"4d9bf765",4195:"2b582468",4286:"58b1380a",4302:"1c788e11",4808:"f8960240",4878:"64f123fb",4972:"6c3329cb",5275:"717599dd",5533:"896c7d69",5689:"edcb4052",5798:"6916f84a",5863:"f450fa8e",6164:"8ff0d5a1",6174:"f7b88f60",6216:"819ca774",6487:"abbd2a0d",6683:"1e7ea833",7026:"7c7113bb",7275:"469181e7",7414:"c08b369d",7918:"cb14df91",8206:"e87a2e60",8425:"29a6e063",8511:"241a4edc",8938:"c10ab025",8957:"b5bf4935",9042:"d0dc91a4",9061:"bcac42c2",9293:"4242157c",9404:"5fe674f0",9455:"9e25e52e",9514:"edbc8ded",9671:"639cda40"}[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),c={},f="canine-docs:",d.l=(e,a,t,b)=>{if(c[e])c[e].push(a);else{var r,o;if(void 0!==t)for(var n=document.getElementsByTagName("script"),i=0;i{r.onerror=r.onload=null,clearTimeout(s);var f=c[e];if(delete c[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=l.bind(null,r.onerror),r.onload=l.bind(null,r.onload),o&&document.head.appendChild(r)}},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","24b4006e":"63","29af3fe3":"92","03cdf430":"229",dda406b3:"316",ab3acb2a:"604","5402824b":"1078","3e125dc6":"1148",b46b7d8b:"1172","18a433c4":"1210","7d26c06c":"1232","7f9142bb":"1314","65b97a36":"1770","9c403616":"1817",e1923b53:"1947",a78c9ae8:"2036",fd23986e:"2127",f1994572:"2782",d866114a:"2855",f3769d49:"2891","1f391b9e":"3085",ea96f03c:"3298",e289ecfd:"3523",c4f5d8e4:"4195",c97fbebf:"4286",e1e382f1:"4302",ebbc57e7:"4808",c894e2df:"4878","5a6f97fe":"5275","874276e5":"5533","8b564e48":"5689",d1f710bd:"5798",bbf127f0:"5863","9093546b":"6164","23f3f2f9":"6174",b92c85d1:"6216","041d8db4":"6487",a4043c8d:"6683","259b7029":"7026","7b9432de":"7275","393be207":"7414","24536a89":"8206",b1fc7db6:"8425",e4750cc4:"8511","5da52a1e":"8938","8a56e0ba":"8957","0558eea0":"9042",ec604ac9:"9061","365ebb01":"9293",d07072fe:"9404","1be78505":"9514","0e384e19":"9671"}[e]||e,d.p+d.u(e)},(()=>{var e={1303:0,532:0};d.f.j=(a,t)=>{var c=d.o(e,a)?e[a]:void 0;if(0!==c)if(c)t.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((t,f)=>c=e[a]=[t,f]));t.push(c[2]=f);var b=d.p+d.u(a),r=new Error;d.l(b,(t=>{if(d.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var f=t&&("load"===t.type?"missing":t.type),b=t&&t.target&&t.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",r.name="ChunkLoadError",r.type=f,r.request=b,c[1](r)}}),"chunk-"+a,a)}},d.O.j=a=>0===e[a];var a=(a,t)=>{var c,f,b=t[0],r=t[1],o=t[2],n=0;if(b.some((a=>0!==e[a]))){for(c in r)d.o(r,c)&&(d.m[c]=r[c]);if(o)var i=o(d)}for(a&&a(t);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 a3ce835..d7ccf89 100644 --- a/docs/contributors/join.html +++ b/docs/contributors/join.html @@ -5,14 +5,14 @@ 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 ba57ce4..1fb00d6 100644 --- a/docs/contributors/labs.html +++ b/docs/contributors/labs.html @@ -5,7 +5,7 @@ Jackal Labs | Jackal Chain Docs - + @@ -13,7 +13,7 @@

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/developers/apis/apis.html b/docs/developers/apis/apis.html index 4406b5e..a27ad6c 100644 --- a/docs/developers/apis/apis.html +++ b/docs/developers/apis/apis.html @@ -5,13 +5,13 @@ APIs | Jackal Chain Docs - +
- + \ No newline at end of file diff --git a/docs/developers/apis/intro.html b/docs/developers/apis/intro.html index ace8ac0..208ba65 100644 --- a/docs/developers/apis/intro.html +++ b/docs/developers/apis/intro.html @@ -5,13 +5,13 @@ About Jackal APIs | Jackal Chain Docs - +

About Jackal APIs

Coming Soon

- + \ No newline at end of file diff --git a/docs/developers/dAppLibraries/intro.html b/docs/developers/dAppLibraries/intro.html index 4b88b79..08fd041 100644 --- a/docs/developers/dAppLibraries/intro.html +++ b/docs/developers/dAppLibraries/intro.html @@ -5,14 +5,14 @@ About These Libraries | Jackal Chain Docs - +

About These Libraries

The following sections outline the basics of how to use the available libraries to interact with the Jackal chain. These are a work in progress and will be expanded on over time.

- + \ No newline at end of file diff --git a/docs/developers/dAppLibraries/jackal_go.html b/docs/developers/dAppLibraries/jackal_go.html index b80a511..451a8fc 100644 --- a/docs/developers/dAppLibraries/jackal_go.html +++ b/docs/developers/dAppLibraries/jackal_go.html @@ -5,13 +5,13 @@ Jackal.go | Jackal Chain Docs - +

Jackal.go

Quickstart​

Setting up your Wallet​

seed := "SEED_PHRASE"
rpc := "https://jackal-testnet-rpc.polkachu.com:443" // testnet rpc for example
chainid := "lupulella-2" // testnet chain-id for example

wallet, err := wallet_handler.NewWalletHandler(
    seed,
    rpc,
    chainid)
if err != nil {
    panic(err)
}

Setting up FileIO​

fileIo, err := file_io_handler.NewFileIoHandler(wallet)
if err != nil {
    panic(err)
}

Generating Root Folder​

operatingRoot := "ROOT_FOLDER_NAME"

_, err = fileIo.DownloadFolder(fmt.Sprintf("s/%s", operatingRoot))
if err != nil {
    _, err = fileIo.GenerateInitialDirs([]string{operatingRoot})
    if err != nil {
        panic(err)
    }
}

Uploading File​

bytes := []bytes{"SOME_FILE_DATA_HERE"}
fileName := "NAME_OF_SOME_FILE"
path := "PARENT_FOLDER_OF_SOME_FILE"

fileUpload, err := file_upload_handler.TrackVirtualFile(bytes, fileName, path)
if err != nil {
    panic(err)
}

folder, err := fileIo.LoadNestedFolder(path)
if err != nil {
    panic(err)
}

_, fids, _, err := fileIo.StaggeredUploadFiles([]*file_upload_handler.FileUploadHandler{fileUpload}, folder, false)

Downloading File​

handler, err := fileIo.DownloadFile("s/" + operatingRoot)
if err != nil {
    panic(err)
}
fileBytes := handler.GetFile().Buffer().Bytes() // do with the filebytes as you please
- + \ No newline at end of file diff --git a/docs/developers/dAppLibraries/jackal_js.html b/docs/developers/dAppLibraries/jackal_js.html index daae5a4..44c884c 100644 --- a/docs/developers/dAppLibraries/jackal_js.html +++ b/docs/developers/dAppLibraries/jackal_js.html @@ -5,7 +5,7 @@ Jackal.js | Jackal Chain Docs - + @@ -18,7 +18,7 @@ The following are the correct options to use. Jackal.js additionally supports ap settings. This requires some redundancy, but allows for greater flexibility in projects.

Wallet Selection​

Currently Jackal,js supports Keplr and Leap wallets. Only a single wallet can be used at any time, but you can switch between them as desired.

const selectedWallet = 'keplr'
// OR
const selectedWallet = 'leap'

Testnet Configuration​

const chainConfig = {
  chainId: 'lupulella-2',
  chainName: 'Jackal Testnet II',
  rpc: 'https://testnet-rpc.jackalprotocol.com',
  rest: 'https://testnet-api.jackalprotocol.com',
  bip44: {
    coinType: 118
  },
  coinType: 118,
  stakeCurrency: {
    coinDenom: 'JKL',
    coinMinimalDenom: 'ujkl',
    coinDecimals: 6
  },
  bech32Config: {
    bech32PrefixAccAddr: 'jkl',
    bech32PrefixAccPub: 'jklpub',
    bech32PrefixValAddr: 'jklvaloper',
    bech32PrefixValPub: 'jklvaloperpub',
    bech32PrefixConsAddr: 'jklvalcons',
    bech32PrefixConsPub: 'jklvalconspub'
  },
  currencies: [
    {
      coinDenom: 'JKL',
      coinMinimalDenom: 'ujkl',
      coinDecimals: 6
    }
  ],
  feeCurrencies: [
    {
      coinDenom: 'JKL',
      coinMinimalDenom: 'ujkl',
      coinDecimals: 6,
      gasPriceStep: {
        low: 0.002,
        average: 0.002,
        high: 0.02
      }
    }
  ],
  features: []
}
const appConfig = {
  signerChain: 'lupulella-2',
  enabledChains: ['lupulella-2'],
  queryAddr: 'https://testnet-grpc.jackalprotocol.com',
  txAddr: 'https://testnet-rpc.jackalprotocol.com'
}

Mainnet Configuration​

const chainConfig = {
  chainId: 'jackal-1',
  chainName: 'Jackal Mainnet',
  rpc: 'https://rpc.jackalprotocol.com',
  rest: 'https://api.jackalprotocol.com',
  bip44: {
    coinType: 118
  },
  coinType: 118,
  stakeCurrency: {
    coinDenom: 'JKL',
    coinMinimalDenom: 'ujkl',
    coinDecimals: 6
  },
  bech32Config: {
    bech32PrefixAccAddr: 'jkl',
    bech32PrefixAccPub: 'jklpub',
    bech32PrefixValAddr: 'jklvaloper',
    bech32PrefixValPub: 'jklvaloperpub',
    bech32PrefixConsAddr: 'jklvalcons',
    bech32PrefixConsPub: 'jklvalconspub'
  },
  currencies: [
    {
      coinDenom: 'JKL',
      coinMinimalDenom: 'ujkl',
      coinDecimals: 6
    }
  ],
  feeCurrencies: [
    {
      coinDenom: 'JKL',
      coinMinimalDenom: 'ujkl',
      coinDecimals: 6,
      gasPriceStep: {
        low: 0.002,
        average: 0.002,
        high: 0.02
      }
    }
  ],
  features: []
}
const appConfig = {
  signerChain: 'jackal-1',
  enabledChains: ['jackal-1'],
  queryAddr: 'https://grpc.jackalprotocol.com',
  txAddr: 'https://rpc.jackalprotocol.com'
}

Bringing the full config together​

const finalWalletConfig = {
  selectedWallet,
  ...appConfig,
  chainConfig
}
// Hooking up the wallet to your app
const wallet = await WalletHandler.trackWallet(finalWalletConfig)

Additionally, a query-only mode for the wallet can get accessed via the following:

const wallet = await WalletHandler.trackQueryWallet('https://grpc.jackalprotocol.com') // Use the gRPC-web address of your choice

Buying Storage Space​

Every account that wishes to use the Jackal Protocol to store data needs to have a paid storage account. This means giving the protocol $8 USD per month per tb. We can do this with Jackal.js!

const storage = await StorageHandler.trackStorage(wallet)
// (Wallet address)
// duration in months (min 1)
// space in terabytes (min .001)
// 2 TB for 1 year:
await storage.buyStorage(WALLET_ADDRESS, 12, 2)

Creating a Root Folder​

const minimumProviderVersion = '1.0.9'
const fileIo = await FileIo.trackIo(wallet, minimumProviderVersion)
const listOfRootFolders = ["Home", ...]
// you can create as many root folders as you would like this way. Home is the Jackal Dashboard default root directory.
// The first time a user connects, they must init the system
const storage = await StorageHandler.trackStorage(wallet)
const msg = storage.makeStorageInitMsg()
await fileIo.generateInitialDirs(msg, listOfRootFolders)
// after the first time, this code can be used instead. this will only create new root folders if they don't already exist
const newFolderCount = await fileIo.verifyFoldersExist(listOfRootFolders)

Creating a Child Folder​

const fileIo = await FileIo.trackIo(wallet)
const parentFolderPath = PARENT_FOLDER_NAME_AND_PATH // for example Dashboard's root folder path is s/Home
const parent = await fileIo.downloadFolder(parentFolderPath)
const listOfChildFolders = ["Movies", "Pictures", ...]
await fileIo.createFolders(parent, listOfChildFolders)

Uploading a File​

const fileIo = await FileIo.trackIo(wallet)
const parentFolderPath = PARENT_FOLDER_NAME_AND_PATH // for example Dashboard's root folder path is s/Home
const parent = await fileIo.downloadFolder(parentFolderPath)
const file = FILE_OBJECT // this MUST be an instance of File() that is in the browser memory
const fileName = file.name
const handler = await FileUploadHandler.trackFile(file, parentFolderPath)
const uploadList = {}
uploadList[fileName] = {
  data: null,
  exists: false,
  handler: handler,
  key: fileName,
  uploadable: await handler.getForUpload()
}
await fileIo.staggeredUploadFiles(uploadList, parent, {counter: 0, complete: 0})

Downloading a File​

const fileIo = await FileIo.trackIo(wallet)
/* optional */
const parentFolderPath = PARENT_FOLDER_NAME_AND_PATH // for example Dashboard's root folder path is s/Home
const parent = await fileIo.downloadFolder(parentFolderPath)
const childrenFiles = parent.getChildFiles()
const pathOfFirstChild = parent.getMyChildPath(childrenFiles[0].name)
/* end optional */
const downloadDetails = {
  rawPath: FILE_PATH, // manual complete file path OR pathOfFirstChild
  owner: OWNER_ADDRESS, // JKL address of file owner
  isFolder: false
}
const fileHanlder = await fileIo.downloadFile(downloadDetails, {track: 0})
const file = fileHanlder.receiveBacon()
// do what you want with the File object returned by receiveBacon
- + \ No newline at end of file diff --git a/docs/developers/dAppLibraries/jackal_nodejs.html b/docs/developers/dAppLibraries/jackal_nodejs.html index d9a8e23..402b351 100644 --- a/docs/developers/dAppLibraries/jackal_nodejs.html +++ b/docs/developers/dAppLibraries/jackal_nodejs.html @@ -5,7 +5,7 @@ Jackal.nodejs | Jackal Chain Docs - + @@ -14,7 +14,7 @@ with NVM.

nvm use 20

Wallet Instantiation​

Jackal.nodejs does not use a traditional wallet like Jackal.js. Instead, MnemonicWallet.create(mnemonic) is used for wallet instantiation.

const appConfig = {
  signerChain: 'lupulella-2',
  queryAddr: 'https://testnet-grpc.jackalprotocol.com',
  txAddr: 'https://testnet-rpc.jackalprotocol.com'
}

const m = await MnemonicWallet.create(mnemonic)

// Hooking up the wallet to your app
const w = await WalletHandler.trackWallet(appConfig, m)

Additionally, a query-only mode for the wallet can get accessed via the following:

const wallet = await WalletHandler.trackQueryWallet('https://testnet-grpc.jackalprotocol.com') // Use the gRPC-web address of your choice

Buying Storage Space​

Every account that wishes to use the Jackal Protocol to store data needs to have a paid storage account. This means giving the protocol $8 USD per month per tb. We can do this with Jackal.js!

const storage = await StorageHandler.trackStorage(wallet)

// (Wallet address)
// duration in months (min 1)
// space in terabytes (min .001)
// 2 TB for 1 year:
await storage.buyStorage(WALLET_ADDRESS, 12, 2)

Creating a Root Folder​

const minimumProviderVersion = '1.0.9'
const fileIo = await FileIo.trackIo(wallet, minimumProviderVersion)

const listOfRootFolders = ["Home", ...]
// you can create as many root folders as you would like this way. Home is the Jackal Dashboard default root directory.
// The first time a user connects, they must init the system
const storage = await StorageHandler.trackStorage(wallet)
const msg = storage.makeStorageInitMsg()
await fileIo.generateInitialDirs(msg, listOfRootFolders)

// after the first time, this code can be used instead. this will only create new root folders if they don't already exist
const newFolderCount = await fileIo.verifyFoldersExist(listOfRootFolders)

Creating a Child Folder​

const fileIo = await FileIo.trackIo(wallet)
const parentFolderPath = PARENT_FOLDER_NAME_AND_PATH // for example Dashboard's root folder path is s/Home
const parent = await fileIo.downloadFolder(parentFolderPath)
const listOfChildFolders = ["Movies", "Pictures", ...]
await fileIo.createFolders(parent, listOfChildFolders)

Uploading a File​

const fileIo = await FileIo.trackIo(wallet)

const parentFolderPath = PARENT_FOLDER_NAME_AND_PATH // for example Dashboard's root folder path is s/Home
const parent = await fileIo.downloadFolder(parentFolderPath)

const file = FILE_OBJECT // this MUST be an instance of File() that is in the browser memory
const fileName = file.name
const handler = await FileUploadHandler.trackFile(file, parentFolderPath)

const uploadList = {}
uploadList[fileName] = {
  data: null,
  exists: false,
  handler: handler,
  key: fileName,
  uploadable: await handler.getForUpload()
}

await fileIo.staggeredUploadFiles(uploadList, parent, {counter: 0, complete: 0})

Downloading a File​

const fileIo = await FileIo.trackIo(wallet)

/* optional */
const parentFolderPath = PARENT_FOLDER_NAME_AND_PATH // for example Dashboard's root folder path is s/Home
const parent = await fileIo.downloadFolder(parentFolderPath)
const childrenFiles = parent.getChildFiles()
const pathOfFirstChild = parent.getMyChildPath(childrenFiles[0].name)
/* end optional */

const downloadDetails = {
  rawPath: FILE_PATH, // manual complete file path OR pathOfFirstChild
  owner: OWNER_ADDRESS, // JKL address of file owner
  isFolder: false
}

const fileHanlder = await fileIo.downloadFile(downloadDetails, { track: 0 })

const file = fileHanlder.receiveBacon()
// do what you want with the File object returned by receiveBacon
- + \ No newline at end of file diff --git a/docs/developers/dAppLibraries/jackal_protos.html b/docs/developers/dAppLibraries/jackal_protos.html index 6e25294..284fd3f 100644 --- a/docs/developers/dAppLibraries/jackal_protos.html +++ b/docs/developers/dAppLibraries/jackal_protos.html @@ -5,7 +5,7 @@ Jackal.js-protos / Jackal.nodejs-protos | Jackal Chain Docs - + @@ -20,7 +20,7 @@ Jackal.nodejs-protos does not need this.

Install dependencies:

(Jackal.js-protos)

npm create vite@latest
npm install jackal.js-protos eciesjs @cosmjs/launchpad @cosmjs/proto-signing @cosmjs/stargate
npm install -D vite-plugin-node-stdlib-browser

OR

(Jackal.nodejs-protos)

npm install jackal.nodejs-protos eciesjs @cosmjs/launchpad @cosmjs/proto-signing @cosmjs/stargate
npm install -D @types/node typescript tscpaths

Updating Vite Config​

(Jackal.js-protos)

// In vite.config.js:
import { defineConfig } from 'vite'
import nodePolyfills from 'vite-plugin-node-stdlib-browser'

export default defineConfig({
  plugins: [
    nodePolyfills()
  ],
})

Next Steps​

Once everything is set up as detailed above, you are free to create as little or as much using the methods exposed by Protos. Full documentation of these methods coming soon.

- + \ No newline at end of file diff --git a/docs/developers/faucet.html b/docs/developers/faucet.html index e30ecc9..a2f75f6 100644 --- a/docs/developers/faucet.html +++ b/docs/developers/faucet.html @@ -5,13 +5,13 @@ Getting Tokens | Jackal Chain Docs - +

Getting Tokens

To get tokens on the Jackal Protocol test-network. Please go to the Jackal Protocol Discord server and head to #faucet in DEVELOPERS.

- + \ No newline at end of file diff --git a/docs/developers/intro.html b/docs/developers/intro.html index c7454c7..46abc8a 100644 --- a/docs/developers/intro.html +++ b/docs/developers/intro.html @@ -5,7 +5,7 @@ Getting Started | Jackal Chain Docs - + @@ -14,7 +14,7 @@ the Jackal.js Quickstart

Server-side​

To get started building server-side apps that leverage Jackal, head over to the Jackal.nodejs Quickstart or Jackalgo Quickstart.

APIs​

To get started building using our APIs, check out API Quickstart.

- + \ No newline at end of file diff --git a/docs/ecosystem/grants-funding.html b/docs/ecosystem/grants-funding.html index 2641a79..7acaee4 100644 --- a/docs/ecosystem/grants-funding.html +++ b/docs/ecosystem/grants-funding.html @@ -5,7 +5,7 @@ Grants and Funding | Jackal Chain Docs - + @@ -14,7 +14,7 @@ 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 72c743e..591238a 100644 --- a/docs/ecosystem/partnerships.html +++ b/docs/ecosystem/partnerships.html @@ -5,7 +5,7 @@ Partnerships | Jackal Chain Docs - + @@ -14,7 +14,7 @@ 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/intro.html b/docs/intro.html index a4cf1f3..e4e04a1 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -5,7 +5,7 @@ Welcome to Jackal Wiki | Jackal Chain Docs - + @@ -17,7 +17,7 @@ usage tips, infrastructure knowledge, and unique opportunities.

Our enthus 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 d230e72..0c0e20f 100644 --- a/docs/nodes/install.html +++ b/docs/nodes/install.html @@ -5,7 +5,7 @@ Setting Up | Jackal Chain Docs - + @@ -13,7 +13,7 @@

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 ed41099..c2bed96 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)
  • 128GB RAM
  • 3TB 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 fcd9036..c935892 100644 --- a/docs/nodes/nodes/installation.html +++ b/docs/nodes/nodes/installation.html @@ -5,7 +5,7 @@ Installing Canined | Jackal Chain Docs - + @@ -13,7 +13,7 @@

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 6ea1059..dc837cf 100644 --- a/docs/nodes/nodes/mainnet.html +++ b/docs/nodes/nodes/mainnet.html @@ -5,19 +5,19 @@ 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 +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/.canine/config/config.toml
sed -i.bak -e "s|^rpc_servers *=.*|rpc_servers = \"$STATE_SYNC_RPC,$STATE_SYNC_RPC\"|" \
  $HOME/.canine/config/config.toml
sed -i.bak -e "s|^trust_height *=.*|trust_height = $SYNC_BLOCK_HEIGHT|" \
  $HOME/.canine/config/config.toml
sed -i.bak -e "s|^trust_hash *=.*|trust_hash = \"$SYNC_BLOCK_HASH\"|" \
  $HOME/.canine/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 02e4f28..37ae59a 100644 --- a/docs/nodes/nodes/testnet.html +++ b/docs/nodes/nodes/testnet.html @@ -5,7 +5,7 @@ Joining Testnet | Jackal Chain Docs - + @@ -13,7 +13,7 @@

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 728d621..9421d7b 100644 --- a/docs/nodes/providers/building.html +++ b/docs/nodes/providers/building.html @@ -5,7 +5,7 @@ Creating Provider | Jackal Chain Docs - + @@ -19,7 +19,7 @@ you only merge drives with striping and instead we recommend mirroring. However 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/hardware/diy-serious copy.html b/docs/nodes/providers/hardware/diy-serious copy.html index e211fca..a41a206 100644 --- a/docs/nodes/providers/hardware/diy-serious copy.html +++ b/docs/nodes/providers/hardware/diy-serious copy.html @@ -5,14 +5,14 @@ DIY Build | Jackal Chain Docs - +

DIY 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
Memory128 GB (2 x 64 GB) 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$2014.08 USD
- + \ No newline at end of file diff --git a/docs/nodes/providers/hardware/enterprise.html b/docs/nodes/providers/hardware/enterprise.html index 0a366ed..cde8aae 100644 --- a/docs/nodes/providers/hardware/enterprise.html +++ b/docs/nodes/providers/hardware/enterprise.html @@ -5,14 +5,14 @@ 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/nodes/providers/setting_up.html b/docs/nodes/providers/setting_up.html index b943ca2..9d6b753 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 - + @@ -23,7 +23,7 @@ Jackal Storage.

Before completing step 5 below, your account will need tok 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 3ee9fad..b9c5d47 100644 --- a/docs/nodes/validators/joining.html +++ b/docs/nodes/validators/joining.html @@ -5,7 +5,7 @@ Creating Validator | Jackal Chain Docs - + @@ -17,7 +17,7 @@ them. Your commission-rate may be changed once per day.

There 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 a0b61a8..742f239 100644 --- a/docs/official-links/jackal-foundation.html +++ b/docs/official-links/jackal-foundation.html @@ -5,14 +5,14 @@ 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 684f17d..3bc84f3 100644 --- a/docs/official-links/jackal-labs.html +++ b/docs/official-links/jackal-labs.html @@ -5,14 +5,14 @@ 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

- + \ No newline at end of file diff --git a/docs/official-links/jackal-protocol.html b/docs/official-links/jackal-protocol.html index da29855..3b6de78 100644 --- a/docs/official-links/jackal-protocol.html +++ b/docs/official-links/jackal-protocol.html @@ -5,14 +5,14 @@ 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 2af54a9..867cdba 100644 --- a/docs/overview/jackal-tldr.html +++ b/docs/overview/jackal-tldr.html @@ -5,7 +5,7 @@ Discover the Jackal Protocol | Jackal Chain Docs - + @@ -27,7 +27,7 @@ infrastructure, and opportunities.

Maintained by the dedicated 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 c45d3d1..e387f02 100644 --- a/docs/overview/jkl.html +++ b/docs/overview/jkl.html @@ -5,7 +5,7 @@ What Is The JKL Token? | Jackal Chain Docs - + @@ -20,7 +20,7 @@ heard by voting on text, software, spending, and other critical governance propo 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 03a3c99..5166385 100644 --- a/docs/overview/why-jackal.html +++ b/docs/overview/why-jackal.html @@ -5,7 +5,7 @@ Why Choose Jackal Protocol | Jackal Chain Docs - + @@ -22,7 +22,7 @@ information remains protected and accessible only to authorized personnel.

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 2473bf2..7207f99 100644 --- a/docs/protocol/encryption.html +++ b/docs/protocol/encryption.html @@ -5,7 +5,7 @@ Encryption in Jackal Protocol | Jackal Chain Docs - + @@ -23,7 +23,7 @@ retrieved, it can be used to decrypt the file stored on the storage provider, re external user's public key from the chain, and encrypts the symmetric key with the external user's public key. By appending the newly encrypted symmetric key to the file entry, the external user gains access to the file.

By leveraging encryption techniques for both files and file entries, the Jackal Protocol ensures the privacy, security, and integrity of user data throughout the storage and sharing processes.

- + \ No newline at end of file diff --git a/docs/protocol/modules/filetree.html b/docs/protocol/modules/filetree.html index 1c886f0..9f551f4 100644 --- a/docs/protocol/modules/filetree.html +++ b/docs/protocol/modules/filetree.html @@ -5,7 +5,7 @@ Filetree Module | Jackal Chain Docs - + @@ -36,7 +36,7 @@ corresponding public key. The protocol can then store that map in the file entry 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 4c25d50..e8c0635 100644 --- a/docs/protocol/modules/jklmint.html +++ b/docs/protocol/modules/jklmint.html @@ -5,14 +5,14 @@ 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.
- + \ No newline at end of file diff --git a/docs/protocol/modules/module-overview.html b/docs/protocol/modules/module-overview.html index 939cc58..623f5c7 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 1056845..04d8201 100644 --- a/docs/protocol/modules/rns.html +++ b/docs/protocol/modules/rns.html @@ -5,7 +5,7 @@ Name Service Module | Jackal Chain Docs - + @@ -15,7 +15,7 @@ naming system for blockchain addresses. The RNS module simplifies the process of 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 f582e4f..219b8fe 100644 --- a/docs/protocol/modules/storage.html +++ b/docs/protocol/modules/storage.html @@ -5,7 +5,7 @@ Storage Module | Jackal Chain Docs - + @@ -32,7 +32,7 @@ Provider's hard storage, and the challenge windows start being created for 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 6bba114..74100e1 100644 --- a/docs/protocol/modules/wasm.html +++ b/docs/protocol/modules/wasm.html @@ -5,7 +5,7 @@ WASM Module | Jackal Chain Docs - + @@ -15,7 +15,7 @@ specifically for the Cosmos Ecosystem. This module provides a secure and efficie 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 52dbf55..2a947e6 100644 --- a/docs/protocol/p-o-p.html +++ b/docs/protocol/p-o-p.html @@ -5,7 +5,7 @@ Jackal Proof-of-Persistence Documentation | Jackal Chain Docs - + @@ -26,7 +26,7 @@ following diagram, we can see that only the blue nodes are required to build a s 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/tokens.html b/docs/protocol/tokens.html index f5c4a61..d735fe1 100644 --- a/docs/protocol/tokens.html +++ b/docs/protocol/tokens.html @@ -5,7 +5,7 @@ JKL Token | Jackal Chain Docs - + @@ -21,7 +21,7 @@ within the Jackal Protocol. By utilizing JKL tokens as a medium of exchange, use and censorship-resistant storage infrastructure.

Storage Providers​

Storage providers are incentivized to offer storage space and maintain a high level of service by earning JKL tokens. By receiving JKL tokens as payment for their services, storage providers can cover the costs of infrastructure, hardware, and bandwidth while potentially profiting from their participation in the ecosystem.

- + \ No newline at end of file diff --git a/docs/protocol/validators.html b/docs/protocol/validators.html index c3a3f1c..9007a78 100644 --- a/docs/protocol/validators.html +++ b/docs/protocol/validators.html @@ -5,7 +5,7 @@ Validators | Jackal Chain Docs - + @@ -15,7 +15,7 @@ broadcasting cryptographic signatures, or votes, to agree upon the next block. V 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/cli/cli.html b/docs/using-jackal/cli/cli.html index 27d2a4a..b6be6f9 100644 --- a/docs/using-jackal/cli/cli.html +++ b/docs/using-jackal/cli/cli.html @@ -5,13 +5,13 @@ Command Lind Interface (CLI) | Jackal Chain Docs - +

Command Lind Interface (CLI)

The CLI is a tool for both users and developers to interact with the Jackal Protocol without a traditional GUI.

Download and Install​

Head to the Releases page and download the binary for your system.

Setting up an Account​

You can create a new account like this:

canined keys add {account name}

Or you can recover an account with a seed phrase like this:

canined keys add {account name} --recover

Buying Storage​

Buying 1TB for a single month:

canined tx storage buy-storage $(canined keys show {account name} -a) 720h 1099511627776 ujkl --from {account name} --gas-prices=0.02ujkl

In this case, 720h is 720 hours, or one month, you can specify the hours you wish to buy storage for here. 1099511627776 is how many bytes you wish to purchase, this value is 1TiB, you can increase this or decrease this as you please.

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

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 1769e66..5ac2107 100644 --- a/docs/using-jackal/delegate.html +++ b/docs/using-jackal/delegate.html @@ -5,7 +5,7 @@ How to Delegate JKL Tokens to a Validator | Jackal Chain Docs - + @@ -20,7 +20,7 @@ Protocol’s future. These rewards come from newly generated JKL tokens and tran 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 94deff0..3ca8f6f 100644 --- a/docs/using-jackal/fund.html +++ b/docs/using-jackal/fund.html @@ -5,14 +5,14 @@ Accessing JKL Tokens on a Decentralized Exchange and Withdrawing to Jackal Protocol | Jackal Chain Docs - +

Accessing JKL Tokens on a Decentralized Exchange 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 the Inter-Blockchain Communication Protocol (IBC).

Step 1: Set up a Keplr Wallet​

  1. Install the Keplr Wallet or Leap Walletbrowser 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 765f251..e13bb3f 100644 --- a/docs/using-jackal/wallet/keplr.html +++ b/docs/using-jackal/wallet/keplr.html @@ -5,7 +5,7 @@ Keplr Wallet | Jackal Chain Docs - + @@ -27,7 +27,7 @@ Account, and select Import Ledger.
  • < A detailed tutorial can be found here.

  • 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 d87e42e..a13395a 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

    Featured Articles

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