First copy import.

This commit is contained in:
Patrick Dunlop 2022-08-26 11:15:22 -04:00
parent bee9c5a0e6
commit fefaa17e48
27 changed files with 7868 additions and 62 deletions

View File

@ -0,0 +1,8 @@
{
"label": "Community and Contributors",
"position":5,
"link": {
"type": "generated-index",
"description": "The Jackal Community is open to all. To join the community, please check out our official links."
}
}

View File

@ -0,0 +1,20 @@
---
sidebar_position: 2
---
# Jackal Foundation
## What is the Jackal Foundation?
The Jackal Community is anchored by the Jackal Foundation. A non-profit organization that drives the direction of development by researching and testing software, supporting projects, and ensuring decentralization.
### What is the scope of the Jackal Foundation?
- Maintain the Jackal Protocol.
- Fund ecosystem development.
- Create and manage Jackal Collectives.
- Manage the core governance of the Jackal Protocol.
- Represent and enforce changes made through the governance process.

21
docs/contributors/join.md Normal file
View File

@ -0,0 +1,21 @@
---
sidebar_position: 1
---
# Join the Community!
## The Jackal Community is open to all.
The Jackal Protocol is an transparent, open source, and communnity driven project. We welcome all who want to help build a self-custodial and secure digital future.
### To contribute; please join below.
- [Twitter](https://twitter.com/home)
- [Discord](https://discord.com/invite/5GKym3p6rj)
- [Telegram](https://t.me/+kyaQs5qFMF8zZDcx)
- [GitHub](https://github.com/JackalLabs)
- __Jackal Forums:__ Coming Soon

14
docs/contributors/labs.md Normal file
View File

@ -0,0 +1,14 @@
---
sidebar_position: 3
---
# Jackal Labs
## Who is Jackal Labs?
Jackal Labs is a Canadian software development company that contributed to the early development of the Jackal Protocol. Jackal Labs does not own or operate the Jackal Protocol as it is decentralized and autonomous. Jackal Labs proposes changes to the Jackal Protocol through on-chain governance.
### What is the scope of Jackal Labs?
- Contribute to the early development of the Jackal Protocol.
- Perfom continuous research and development for the Protocol.
- Propose changes to the protocol through governance.

11
docs/explorer.md Normal file
View File

@ -0,0 +1,11 @@
---
sidebar_position: 8
---
# Jackal Explorer
The Jackal Explorer is a “Light Explorer” that fetch data from Cosmos full node via LCD/RPC endpoints. This allows our users to explore transactions on the Jackal Blockchain.
__TODO: Explorer How-To__
__Explorer Images__

View File

@ -4,20 +4,10 @@ sidebar_position: 1
# Getting Started
Jackal is a sovereign blockchain built with the CosmosSDK. Jackal uses the Tendermint Consensus engine to achieve high throughput and secure transactions.
Youve arrived at the Jackal Wiki! Thank you for taking the first steps towards a more secure, simple, and self-custodial digital experience.
## Installing
The Jackal Protocol is [open source](https://github.com/JackalLabs/canine-chain) and community-driven to facilitate a transparent and trustless system. This wiki is a one-stop shop with information on the protocol, usage, infrastructure, and opportunities.
To use Jackal you'll need a wallet! There are two ways to get a wallet and interact with the blockchain.
The Jackal Wiki is maintained by Jackal Labs and the Jackal Foundation teams. We work tirelessly to maintain our documentation, but if you happen to stumble upon something out-of-date, please reach out to our teams so we can keep our documentation accurate in perpetuity.
### Command Line Interface (CLI)
To interact with the Jackal chain from the command line, you'll need the CLI tool. You can download this [here](https://github.com/JackalLabs/canine-chain/releases).
### Web wallet
You can interact with Jackal through several web wallets. The most common is [Keplr](https://wallet.keplr.app/), this will give you access to the entirety of the Cosmos ecosystem.
## Using the Jackal Chain
Head over to https://beta.jackaldao.com to start your journey into using the Jackal Wallet.

View File

@ -1,5 +0,0 @@
---
sidebar_position: 3
---
# Official Links

View File

@ -0,0 +1,8 @@
{
"label": "Official Links",
"position":4,
"link": {
"type": "generated-index",
"description": "Check out the Official Links"
}
}

View File

@ -0,0 +1,16 @@
---
sidebar_position: 2
---
# Jackal Foundation Links
Here are the official website links for Jackal Foundation. Please use and bookmark these links to reduce the likelihood cyberphishing threats.
## Jackal Foundation
[Jackal Foundation Twitter](https://twitter.com/FoundationJKL)
__Website__: Coming Soon

View File

@ -0,0 +1,16 @@
---
sidebar_position: 2
---
# Jackal Labs Links
Here are the official website links for Jackal Labs. Please use and bookmark these links to reduce the likelihood cyberphishing threats.
## Jackal Labs
[Jackal Labs Twitter](https://twitter.com/Jackal_Labs)
__Website__: Coming Soon

View File

@ -0,0 +1,28 @@
---
sidebar_position: 1
---
# Jackal Protocol Links
Here are the official website links of the Jackal Protocol. Please use and bookmark these links to reduce the likelihood cyberphishing threats.
## Protocol
[Link Tree](https://linktr.ee/jackal_protocol)
[Github](https://github.com/JackalLabs)
[Website](https://jackaldao.com/)
[Testnet Dashboard](https://beta.jackaldao.com/)
## Social
[Discord](https://discord.com/invite/5GKym3p6rj)
[Telegram](https://t.me/+kyaQs5qFMF8zZDcx)
[Jackal Protocol Twitter](https://twitter.com/Jackal_Protocol)

View File

@ -3,6 +3,6 @@
"position": 2,
"link": {
"type": "generated-index",
"description": "The bare bones of what you need to start using the Jackal Chain!"
"description": "Welcome to the Pack!"
}
}

View File

@ -1,43 +0,0 @@
---
sidebar_position: 1
---
# Create a Page
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
- `src/pages/index.js``localhost:3000/`
- `src/pages/foo.md``localhost:3000/foo`
- `src/pages/foo/bar.js``localhost:3000/foo/bar`
## Create your first React Page
Create a file at `src/pages/my-react-page.js`:
```jsx title="src/pages/my-react-page.js"
import React from 'react';
import Layout from '@theme/Layout';
export default function MyReactPage() {
return (
<Layout>
<h1>My React page</h1>
<p>This is a React page</p>
</Layout>
);
}
```
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
## Create your first Markdown Page
Create a file at `src/pages/my-markdown-page.md`:
```mdx title="src/pages/my-markdown-page.md"
# My Markdown page
This is a Markdown page
```
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).

View File

@ -0,0 +1,11 @@
---
sidebar_position: 1
---
# What is the Jackal Protocol?
The Jackal Protocol is a fast, scalable, and secure blockchain that empowers individuals, developers, and enterprises to increase their data privacy and cybersecurity posture without sacrificing ease of use. This protocol strives to offer world-class applications to protect the planets most important datayour data.
Unlike other blockchains, the Jackal Protocol utilizes both validators and storage providers. The Jackal Protocol allows developers to build decentralized applications with the ability to interface with all Jackal Protocol Modulesincluding storage contracts and file structure. This allows developers to adjust the ownership of data, share data with other jackal users or smart contracts, and transfer small or large amounts of encrypted data without centralized storage providers or middleware. This data is always self-custodial meaning no one not even the team at Jackalcan access or view your data.
This blockchain currently consists of seven [modules](https://github.com/JackalLabs/canine-chain/blob/master/x/README.md): [jklMint](https://github.com/JackalLabs/canine-chain/blob/master/x/jklmint/README.md), [lp](https://github.com/JackalLabs/canine-chain/blob/master/x/lp/README.md), [rns](https://github.com/JackalLabs/canine-chain/blob/master/x/rns/README.md), [wasm](https://github.com/JackalLabs/canine-chain/blob/master/x/wasm/README.md), [storage](https://github.com/JackalLabs/canine-chain/blob/master/x/storage/README.md), __filetree__ and [dsig](https://github.com/JackalLabs/canine-chain/blob/master/x/dsig/README.md). These interoperable modules allow for the creation of secure, scalable, and truly decentralized applications.

29
docs/overview/jkl.md Normal file
View File

@ -0,0 +1,29 @@
---
sidebar_position: 2
---
# What is the JKL Token?
The JKL Token is the native token that powers the infrastructure of the Jackal Protocol and can be applied in a multitude of different ways.
## dApps
Applications built on the Jackal Protocol, such as Jackal Storage and the RNS Marketplace may choose to leverage the JKL token to expand its utility.
## Securing the Network
As the Jackal Protocol is a Proof-of-Stake (PoS) Cosmos L1 blockchain, JKL can be delegated to validators to secure the network and earn JKL rewards. Otherwise known as staking or staked tokens.
## Transaction Fees
Transactions on the Jackal Protocol must be paid for using JKL. As the protocol is PoS, cost of transactions are inexpensive.
## Governance
Staked tokens grant on-chain governance participation within the Jackal Protocol to vote on text, software, spend, and other governance proposals.
## Collateral
The JKL token can act as collateral for validators, storage providers, and other smart contract usecases.
## Liquidity Provision
JKL can be allocated into a liquidity pool to earn JKL rewards.

View File

@ -0,0 +1,35 @@
---
sidebar_position: 3
---
# Why would I use the Jackal Protocol?
Jackal users are empowered with a fast and scalable blockchain while having the ability to be self custodial of their data. It may be hard to comprehend why many strive for a high digital privacy and cyber security posture, so here is a community compiled list of reasons people use the Jackal Protocol.
- "I want a transparent, secure, and unified experience with web3."
- "The same reason we think our phones are listening to us!"
- "I want better cybersecurity but dont want to change your passwords every month."
- "Because I shouldnt have to give up ownership of all my personal information to access basic services on the Internet."
- "I cant trust third parties that sell your data when 15 million people in the US alone experience identity theft with over 50 billion in financial losses!"
- "Data breaches have exposed 14 billion of our records including passwords, usernames, emails, IP addresses, phone numbers, VINs, physical addresses, and more!"
- Check if you have been compromised below:
- https://www.dehashed.com/
- https://haveibeenpwned.com/
- "I believe in open-source, transparent, ethical and humane technology."
- "It's empowering to own your own data."
- "Digital privacy is a fundamental human right and cybersecurity should be accessible to all."
- "Third-party cookies or trackers are invasive and unnecicary."
- "The only person that can sell my data is me."

View File

@ -0,0 +1,10 @@
{
"label": "The Protocol",
"position":6,
"link": {
"type": "generated-index",
"description": "Also known as Canine, the Jackal Blockchain is a Cosmos L1 built using the Cosmos SDK and Tendermint, created with Ignite CLI. Canine is open source and uses the MIT License.
Canine has seven modules and two tokens."
}
}

46
docs/protocol/modules.md Normal file
View File

@ -0,0 +1,46 @@
---
sidebar_position: 2
---
# Blockchain Modules
As the Jackal Protocol is built using Tendermint and the Cosmos SDK, we are able to create an ecosystem of __modules__. The Protocol uses some of the basic modules needed for interacting with the Cosmos Ecosystem but have also created customized our own modules optimized for the needs of Jackal.
__JACKAL PROTOCOL IMAGE__
## jklmint
The Jackal Mint module is a replacement for the cosmos-sdk module: [Mint](https://github.com/cosmos/cosmos-sdk/blob/main/x/mint/spec/README.md). The key differences between this and the pre-existing minting module are that jklmint does not adjust inflation based on rate of bonded tokens. At genesis, the jklmint module prints 10 JKL per block and distribute it to both the storage module and the default distribution module.
__mint image__
## lp
The lp module allows for a native automated market maker (AMM) liquidity pools (LP) to be built directly into the Jackal Blockchain. This allows for local prices for payment mechanisms without the need for oracles, along with the ability to swap tokens directly from the Jackal dashboard or the Jackal Swap service.
__swap images__
## rns
The rns module is a name service that allows users to manage human-readable names when interacting with the Jackal Blockchain. Users can register names, list names for sale, buy names on the marketplace, and place/accept bids from other users on their names.
__rns images__
## wasm
Jackal incorporates the CosmWasm smart contracting platform built for the Cosmos Ecosystem. The primary programing language used in this module is Rust for building secure and multichain smart contracts, yet any language that can be compiled into WASM can be supported as they become available.
## storage
Jackal Storage functions by a Proof-of-Storage algorithm we call Proof-of-Persistence. The Jackal Proof-of-Persistence (JPOP) works through a series of contracts formed between the storage provider and the user. These contracts contain the Merkle Tree root hash of the file and the information required to prove ownership of the file. Miners, or as well call them, Storage Providers, are responsible for posting Merkle Proofs within a challenge window determined by the blockchain. These challenge windows require the miner to post the raw data chunk of data corresponding to the index of the challenge window alongside the required Merkle Hashes to prove the data belongs to the Merkle Root stored on the contract. These challenge indexes are chosen at random by the blockchain using a block-hash-based random number generator paired with a random data oracle.
If a Storage Provider successfully posts a Merkle Proof within the challenge window for the contract and the data is verified by the Validators to be valid Merkle Proofs for the challenge index, the Storage Provider is paid out. Storage Provider rewards are proportional to the file size the contract is associated with relative to every other active contract on the network. If a Storage Provider fails to provide a valid proof within the allotted timeframe, the contract is struck with a missed proof. After (X) missed proofs, the contract is burned, and the user is alerted the next time they query the contract. For every contract burned through missing proofs, the Storage Provider is struck with a penalty that remains on their record for a period of time adjustable through governance.
__Storage Images__
### Interaction Outline
A user first sends a file to an available Storage Provider. A list of Storage Providers can be found on the blockchain, and providers can deny any incoming request if they wish not to store new files. The Storage Provider, after receiving the entire file, keeps that file in memory and posts a contract to the blockchain. If the contract is not signed by the sender in X blocks (configurable by the Storage Provider), then the file is removed from memory, and the contract is burned. However, if the contract is signed by the user within the given blocks, the file is committed to the Storage Provider's hard storage, and the challenge windows start being created for the now active contract.
## dsig
The dsig module is a digital signature service that allows users to collect signatures from multiple users who are registered on the Jackal Blockchain. Users can create 'forms' associated with a unique file stored on Jackal and can add signees (users) to collect their signatures. The signees have the following options to respond: Approve, Deny, Abstain, and No Response (Default). The form can execute a custom function after all users have voted to Approve the form.
__dsig images__
## filetree
__TODO: Description__
__TODO: Visual Aid__

View File

@ -0,0 +1,11 @@
---
sidebar_position: 4
---
# Storage Providers
A Jackal Storage Provider is a dedicated web server optimized for data storage that accepts incoming files from users and creates contracts for the users to approve. These contracts last until the user either cancel them or the provider itself goes offline.
__Storage Provider Images__
__TODO: Storage Provider Setup__

26
docs/protocol/tokens.md Normal file
View File

@ -0,0 +1,26 @@
---
sidebar_position: 1
---
# Tokens
## JKL or Jackal
JKL is an inflationary token that powers the Jackal Protocol. The JKL Token has many usecases. Some of these use cases are below.
- __dApps__ - Applications built leveraging the Jackal Protocol, such as Jackal Storage and the RNS Marketplace, may choose to include the JKL token to expand its utility.
- __Securing the Network__ - As the Jackal Protocol is a Proof-of-Stake (PoS) Cosmos L1 blockchain, JKL can be delegated to validators to secure the network and earn JKL rewards. Otherwise known as staking or bonded tokens.
- __Transaction Fees__ - Transactions on the Jackal Protocol must be paid for using JKL. As the protocol is PoS, cost of transactions are inexpensive.
- __Governance__ - Staked tokens grant on-chain governance participation within the Jackal Protocol to vote on text, software, spend, and other governance proposals.
- __Collateral__ - The JKL token can act as collateral for validators, storage providers, and other smart contract usecases.
- __Liquidity Provision__ - JKL can be allocated into a liquidity pool to earn rewards.
## JWL or Jewel
JWL is an L1 store-of-value token native to the Canine Blockchain. JWL tokens are immutable, meaning they can never be created, changed or destroyed. There is a finite amount of JWL that will be minted at the chains genesis. Currently, there is no utility for the JWL token and it should be treated as such.

View File

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

View File

@ -0,0 +1,10 @@
{
"label": "Using Jackal",
"position":4,
"link": {
"type": "generated-index",
"description": "Jackal is a blockchain where users interact with the chain and eachother through public and private keys. This means there is no need for security vulnerabilities such as usernames, passwords, email addresses, phone numbers etc.
There are three approved wallets that can be used to interact with the Jackal Protocol. Keplr, Metamask, and the Jackal Wallet. For the most optimized user experience, we recommend using the Jackal Wallet. "
}
}

View File

@ -0,0 +1,20 @@
---
sidebar_position: 4
---
# Jackal Dashboard
## What is the Jackal Dashboard?
The Jackal Dashboard is your unified experience with the Jackal and Cosmos ecosystem. From the Jackal Dashboard, users can;
- Upload, download, and share files.
- Access the Jackal Swap interface to swap Cosmos native tokens.
- Register RNS names.
- Use the RNS marketplace.
- Host static websites.
- Participate in Governance.
- Delegate tokens to validators.
- More to come!
__TODO: JACKAL DASHBOARD IMAGES AND HOW-TO__

View File

@ -0,0 +1,8 @@
---
sidebar_position: 3
---
# Staking
## How to Delegate to a Validator
TODO: How to delegate

View File

@ -0,0 +1,8 @@
---
sidebar_position: 2
---
# Funding your Account
## How to Fund your Account.
TODO: Funding

View File

@ -0,0 +1,14 @@
---
sidebar_position: 1
---
# Wallets
## Create a Wallet
TODO: KEPLR
TODO: JKL WALLET
TODO: METAMASK

7485
yarn.lock Normal file

File diff suppressed because it is too large Load Diff