@_koii/task-node 1.12.37 → 1.12.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,49 +1,37 @@
|
|
|
1
|
-
#
|
|
2
|
-
****
|
|
3
|
-
## TL;DR
|
|
4
|
-
# How to to run a node:
|
|
1
|
+
# KOII Task Node
|
|
5
2
|
|
|
6
|
-
|
|
7
|
-
2. do `npm install`
|
|
8
|
-
3. do `npm run build:watch`
|
|
9
|
-
4. on another terminal do `npm start ` this will start a **K2** node with attention game running.
|
|
10
|
-
****
|
|
11
|
-
## Full Guide
|
|
12
|
-
## How Attention game works
|
|
3
|
+
> Internal engine powering Koii Task Nodes – interacting with the K2 blockchain, coordinating task execution, and managing on-chain operations.
|
|
13
4
|
|
|
14
|
-
|
|
15
|
-
On the next Epoch the node will do voting by getting all the attention accounts and pings all the registered nodes and get all the posts the generates distribution list after verifying that teh list is correct or not.
|
|
5
|
+
## Overview
|
|
16
6
|
|
|
7
|
+
`@_koii/task-node` is a core package used in Koii Desktop Nodes to handle the internal logic related to running and maintaining tasks on the K2 blockchain. Although the source code is currently closed, this package is open-source and distributed via npm for use within the Koii node ecosystem.
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
## Deploy Uploader Program
|
|
20
|
-
First airdrop 1000 tokens to your default wallet.
|
|
21
|
-
after that clone https://github.com/koii-network/k2-contracts this repo and deployed the uploader program by running `init.sh` file after installing dependencies using `npm install`. This will deploy the uploader program used by attention game.
|
|
9
|
+
It provides:
|
|
22
10
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
11
|
+
- 🧠 Core logic for interacting with Koii's decentralized task economy
|
|
12
|
+
- 🔗 Communication utilities with the K2 blockchain
|
|
13
|
+
- 🔒 Cryptographic utilities and key management
|
|
14
|
+
- ⛓ Task life cycle handling (registration, staking, validation, and rewards)
|
|
15
|
+
- 🧰 A wide range of utility methods used across node operations
|
|
27
16
|
|
|
28
|
-
|
|
29
|
-
To run a node run `npm run build:watch` and ona different terminal run `npm start` to start the node.
|
|
17
|
+
> **Note**: This package is intended to be used as part of the official [Koii Desktop Node](https://koii.network/) and is not designed for general-purpose consumption.
|
|
30
18
|
|
|
31
|
-
|
|
19
|
+
---
|
|
32
20
|
|
|
33
|
-
|
|
21
|
+
## Installation
|
|
34
22
|
|
|
35
|
-
|
|
23
|
+
```bash
|
|
24
|
+
npm install @_koii/task-node
|
|
25
|
+
```
|
|
26
|
+
> Requires **Node.js v16+**
|
|
27
|
+
## Usage
|
|
28
|
+
-----
|
|
36
29
|
|
|
30
|
+
The module exports a compiled JavaScript library (`dist/taskNodeLib.js`) which is consumed by the Koii Desktop Node.
|
|
37
31
|
|
|
38
|
-
|
|
39
|
-
****
|
|
40
|
-
# Trouble Shooting:
|
|
41
|
-
## Insufficient Balance:
|
|
42
|
-
You might get this error if you have restated the network and you are trying to run deploy uploader program or running attention game. In this cases try `solana airdrop <AMOUNT> <ADDRESS> `.
|
|
32
|
+
While direct usage is not typically needed for most developers, here's an example import:
|
|
43
33
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
****
|
|
34
|
+
```ts
|
|
35
|
+
import { SomeInternalFunction } from '@_koii/task-node'
|
|
36
|
+
// Note: Actual exports and usage are internal to Koii's node runtime.
|
|
37
|
+
```
|