Skip to content

Commit

Permalink
Release new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Yuliia committed Aug 21, 2024
1 parent 4d4ede7 commit 5c2fd8c
Show file tree
Hide file tree
Showing 139 changed files with 25,278 additions and 3,454 deletions.
Binary file modified .DS_Store
Binary file not shown.
Binary file modified docs/.DS_Store
Binary file not shown.
5 changes: 5 additions & 0 deletions docs/affiliate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Affiliates Rewards
PKT also has an affiliate program built into the protocol. Each connected wallet receives an affiliate code. If an individual (Affiliate-2) stakes using an affiliate code from someone (Affiliate-1), then Affiliate-2 receives a 1% yield bonus, in perpetuity. Affiliate-1, who provided the affiliate code, receives a 4% yield bonus on the stake of Affiliate-2, in perpetuity.

Affiliate-1 also receives a 1% yield bonus, in perpetuity, on the stake of anyone that Affiliate-2 provides their affiliate code to. These rewards incentivize organic growth within the ecosystem, while scaling the network worldwide.

26 changes: 26 additions & 0 deletions docs/airdrop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Migration Airdrop

## How to claim Airdrop
If you own PacketCrypt proof-of-work (“PoW”) coins you will need to swap into tokens of PKT on Base. All PacketCrypt.

* Install a Web3 wallet like [MetaMask](https://metamask.io/) or [Coinbase Wallet](https://www.coinbase.com/wallet)
* Buy enough Base Ethereum that you are able to pay a very small transaction fee
* Add the PKT contract address to your Web3 wallet
* Copy your wallet address
* Open your legacy PKT wallet (PKT World, Anode, CLI)
* Choose to copy the private key for one of the addresses in your legacy PKT wallet that has coins you want to swap
* Download the migration app [here](https://pkt.cash/1ea983ba3453631d914755e7ad96840d/overview)
* Paste the private key into the migration app
* Paste your new Web3 wallet address into the migration app
* The migration app will compute a digital signature
* Open the new PKT dashboard app on [pkt.cash](https://pkt.cash/)
* Navigate to the migration tab
* Paste the signature from the migration app
* Click __submit__ and this will claim your tokens of PKT on Base, which will be sent to the Web3 wallet address you provided
* You can repeat this process for each wallet address you want to swap (you can use the same Web3 wallet address, or a new Web3 wallet address of your choice.

!!! note "Note"
It will only be possible to swap PKT on Base for PoW coins via OTC.

!!! hint "FYI"
If you have tokens on WPKT, you will need to await for the Odapp custodian to inform the community how to redeem WPKT for PKT on Base.
10 changes: 10 additions & 0 deletions docs/buy-pkt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# How to Buy PKT
To buy PKT on Base:

* First you need Ethereum on Base in your web3 wallet. If you don’t have a web3 wallet, get a Coinbase Wallet or MetaMask wallet here.
* You can buy Ethereum on Base directly in your Coinbase Wallet. Or you can buy from another exchange or crypto on-ramp and transfer to your wallet.
* If you already have Ethereum, but need to convert it to Ethereum on Base, you can use a bridge [here](https://bridge.base.org/deposit).
* Once you have Ethereum on Base, you can swap PKT directly in your web3 wallet.

!!! note "NOTE"
If you already own PKT from the Packetcrypt proof-of-work coin, you are eligible to claim your 1:1 PKT airdrop on Base here. You will be eligible to claim ⅓ of your PKT airdrop now, ⅓ on February 21, 2025, and ⅓ on August 21, 2025.
24 changes: 24 additions & 0 deletions docs/community/avoid-examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Classifieds
PKT is composed of the community members and community member companies that operate within the ecosystem. This collective comes from around the world and are rallying around the vision and roadmap towards getting the next one billion people connected online.

Below is a mostly un-moderated list of classified advertisements and offerings. Beware that anyone can contribute and offer their services and there is no central authority at pkt.cash to verify them.

## Add yourself
Make a [Pull Request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to [This page](https://github.com/pkt-cash/pkt-docs/blob/main/docs/commercial.md) to add your offer.

* Keep it short and to the point
* NO PICTURES, no color text, no big fonts
* Use the appropriate category

## Hardware
### [Pktpal.com](https://pktpal.com/)
Buy a PKT Cube which will mine PKT with your unused internet and provides easy-to-use PkteerOS wallet.

## Hosting
### [Space-hosting.net](https://space-hosting.net/pktcash)
Mining servers for rent

## PKT Cloud Mining Service
### [AMAPOOL.com](https://amapool.com/)
Your best choice towards a fully automated PKT cloud mining solution.

24 changes: 24 additions & 0 deletions docs/community/better-examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Classifieds
PKT is composed of the community members and community member companies that operate within the ecosystem. This collective comes from around the world and are rallying around the vision and roadmap towards getting the next one billion people connected online.

Below is a mostly un-moderated list of classified advertisements and offerings. Beware that anyone can contribute and offer their services and there is no central authority at pkt.cash to verify them.

## Add yourself
Make a [Pull Request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to [This page](https://github.com/pkt-cash/pkt-docs/blob/main/docs/commercial.md) to add your offer.

* Keep it short and to the point
* NO PICTURES, no color text, no big fonts
* Use the appropriate category

## Hardware
### [Pktpal.com](https://pktpal.com/)
Buy a PKT Cube which will mine PKT with your unused internet and provides easy-to-use PkteerOS wallet.

## Hosting
### [Space-hosting.net](https://space-hosting.net/pktcash)
Mining servers for rent

## PKT Cloud Mining Service
### [AMAPOOL.com](https://amapool.com/)
Your best choice towards a fully automated PKT cloud mining solution.

52 changes: 18 additions & 34 deletions docs/community/code_of_conduct.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,21 @@
# PKT Code of Conduct:

1) We are here to talk about PKT. If it's not PKT related don't post it here.

2) Not reading the rules is not an excuse for breaking the rules.

3) No OTC trading allowed outside of designated areas.

4) This is a place to build the community and create a positive dialogue amongst Pkteers.
If the conversation turns negative, the moderators reserves the right to ban or block anyone. A person will not be banned for a single
offense, but only if the behavior continues after being warned by a moderator.

5) Hate speech is not permitted and can result in being banned. This mean no sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language. We ask that Pkteers keep the conversation civil and respectful.

6) No violence, threats of violence or violent language directed against another person.
No name calling, attacks, or bad mouthing others.

7) No posting or displaying sexually explicit or violent material.

8) No personal insults, particularly those related to gender, sexual orientation, race, religion, or disability

9) No unwelcome sexual attention. This includes, sexualized comments or jokes, and unwelcomed sexual advances.

10) No self-promotion whether direct or indirect unless with written admin approval. No shilling (promoting) of assets is permitted.

12) Moderators reserve the right to moderate, block or remove posts that are factually inaccurate, deemed inappopriate or lack substantiation.

13) Spamming will result in being banned.

14) No trolling - No antagonizing people or the any of the PKT chats by deliberately posting inflammatory, irrelevant, or offensive comments, images, memes, stickers or other disruptive content. If it doesn't relate to PKT don't post it or you will be banned.
# Code of Conduct

1. We are here to talk about PKT. If it's not PKT related, don't post it here.
2. Not reading the rules is not an excuse for breaking the rules.
3. No OTC trading allowed.
4. This is a place to build the community and create a positive dialogue amongst Pkteers. If the conversation turns negative, the moderators reserve the right to ban or block anyone.
5. Hate speech is not permitted and can result in being banned. This means no sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language. We ask that Pkteers keep the conversation civil and respectful.
6. No violence, threats of violence or violent language directed against another person. No name calling, attacks, or bad mouthing others.
7. No posting or displaying sexually explicit or violent material.
8. No personal insults, particularly those related to gender, sexual orientation, race, religion, or disability
9. No unwelcome sexual attention. This includes, sexualized comments or jokes, and unwelcomed sexual advances.
10. No self-promotion whether direct or indirect unless with written admin approval. No shilling (promoting) of assets is permitted.
11. Moderators reserve the right to moderate, block or remove posts that are factually inaccurate, deemed inappropriate or lack substantiation.
12. Spamming will result in being banned.
13. No trolling - No antagonizing people in any of the PKT chats by deliberately posting inflammatory, irrelevant, or offensive comments, images, memes, stickers or other disruptive content. If it doesn't relate to PKT don't post it or you will be banned.

## Contact people
If someone has made you feel unsafe or unwelcome, please contact one of the admins of the group.
We will do our best to address your matter quickly and with discretion.
If someone has made you feel unsafe or unwelcome, please contact one of the admins of the group. We will do our best to address your matter quickly and with discretion.

* Jeremy Berger: email: `[email protected]` / telegram: `@jeremy_berger` / pkt.chat: `@jeremyb`
* Caleb James DeLisle: email: `[email protected]` / pkt.chat: `@cjd`
* Jeremy Berger: telegram: `@jeremy_berger` / pkt.chat: `@jeremyb`
* Caleb James DeLisle: pkt.chat: `@cjd`
54 changes: 54 additions & 0 deletions docs/governance-nsc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Network Steward Charter
Anyone considering becoming Network Steward will need to publicly declare themselves to be a candidate. Upon declaring candidacy, a proposal should be publicly shared. The proposal should outline the basis and intentions of the Network Steward if elected. Please find suggestions for how to structure a proposal, as the criteria for evaluation is public.

## Short term impact
Short term impact constitutes the project's capability to help the achievement of the PKT project's immediate objectives. For example, a project to search for breakthroughs in wireless technology may be well aligned with PKT's objectives in the long term but will not bear fruit for a significant amount of time. Specific questions useful for evaluating short term impact:

Will this project facilitate PKT’s roadmap?
Will this project help PKT to distinguish itself from other blockchain projects?
Does this project provide a piece of infrastructure which is considered necessary?

## Long term impact
Long term impact constitutes a project's capability to pay dividends to the PKT ecosystem over the long term. Long term impact is important because it fosters a snowball effect of returns on the investment of Network Steward funds. Specific questions useful for evaluating long term impact:

Will this project help advance "infrastructure operator" roles?
Will this project provide key infrastructure/institutions necessary to the emergence of a healthy ecosystem?
Does this project bypass a tragedy-of-the-commons problem which blocks the natural emergence of a piece of key infrastructure?

## Scope and use of resources
Use of resources is the question of how "expensive" a project is and its ability to fit within the budget. Short and long term impact will be evaluated with attention to the impact/cost ratio. Note that volunteer time/effort spent by the Network Steward, or their team in order to oversee the project will be taken into account, so all other things being equal, a few large projects are preferable to a large number of smaller ones. Some questions which may be useful for evaluating scope and use of resources include:

Do the metrics for success justify the amount of effort placed on the project?
Does the cost for effort seem to be a good deal (attention shall be given to the skill sets of declared participants)?
Are there competitive aspects with the project to promote efficient use of resources?

## Risk control
Risk control is about the question of how likely a project is to fail at delivering the expected result. Projects which are inherently more risky will be evaluated more stringently on their proposed risk control. Specific questions useful to the evaluation of risk control include:

How evenly is the effort spaced over the milestones of the project?
How evenly is the payment spaced over the milestones of the project?
How well did the candidate specify success criteria for the project?
To what extent are the risks defined and planned for in the project proposal?
To what extent are the difficulties and potential blockers moved to the early parts of the project?
What evidence is there that the Network Steward is capable of delivering?

## Hazard control
The objective of the Network Steward is for the community to elect someone who will build or oversee projects that benefit the entire PKT ecosystem equally without unfairly benefitting any one participant over any other. Hazard control is about preventing any incentive or the perception of an incentive which would promote a corruption of the process from its objective. Public perceptions are almost as important as the real thing because the perception of hazard discourages new participants from joining the PKT ecosystem and encourages existing participants to submit projects which are at least as corrupt as they imagine the average project to be. Some questions which may be useful to the evaluation of hazard control include:

To what extent is the project safe from any real or perceived conflicts of interest?
To what extent are the results of this project equally advantageous to all participants in the PKT ecosystem?
To what extent does the proposal structure the project such that success will be more advantageous to the applicant than failure?
The use of milestones, deliverables and evenly spaced payments conditioned on deliveries is encouraged.
To what extent does the project control the risk of arbitrage profit opportunity for the applicant?
An example of arbitrage profit opportunity appears when there is a lack of market agreement on the cost of the deliverables which the project will produce. Logo design is a good example of a deliverable for which there lacks market agreement on the cost. While PepeiCo saw fit to spend one million dollars on their logo, the Nike logo was bought for a mere $35. In the case of such an expenditure, the overall community may be unable to verify whether a project constitutes a million dollars worth of diligent effort or a $35 drawing sold at a markup.
Did the applicant declare and control for any potential conflicts of interest?

## Potentially unacceptable projects
Some projects may be judged by the community to be unacceptable under any conditions. An intuitive example would be a proposal to build an assassination market which is blatantly illegal and contrary to the objectives of the project. These judgements will be made by individual voters. Some questions which are useful in the evaluation of acceptability:

Does the project seem more likely to benefit the PKT ecosystem than to harm it?
Does the project seem unlikely to cause significant damage to the perceived legitimacy of the PKT ecosystem?

## Delayed milestones

While it is not in the interest of the community to rush projects, it is important to guard against the possibility of candidates applying for projects and then not doing the work - planning to abandon the project unless there is a precipitous increase in the price at which they can sell PKT.
Loading

0 comments on commit 5c2fd8c

Please sign in to comment.