Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@kyve/core

Package Overview
Dependencies
Maintainers
3
Versions
80
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@kyve/core

🚀 The base KYVE node implementation.

  • 0.2.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
decreased by-83.33%
Maintainers
3
Weekly downloads
 
Created
Source

@kyve/core

🚀 The base KYVE node implementation.

Integrations

Existing integrations

Creating a custom integration

Installation
yarn add @kyve/core
Using KYVE in your application
Initiating a node

Next you need to set up the pool. You can create a new pool here.

import KYVE from "@kyve/core";
import { BigNumber } from "ethers";

const pool = "0x...";
const pk = process.env.PK;
const stake = BigNumber.from(100).mul(10).pow(18);
const jwk = ... // Arweave keyfile (optional).
const name = "my-node"; // optional.

const node = new KYVE(pool, pk, stake, jwk, name);
Node configuration

KYVE requires two custom functions. One which fetches the data from your data source and one which validates this data. You can then simply add these two functions into the KYVE run method.

Specifying an upload function

To pass data into KYVE, simply call subscriber.next():

const myUploader = (subscriber, config, logger) => {
  // use your custom logic here
  const data = ...
  subscriber.next({ data });
}

You can also, optionally, add custom tags to your transactions:

const myUploader = (subscriber, config, logger) => {
  // use your custom logic here
  const data = ...
  const tags = [...]
  subscriber.next({ data, tags });
}
Specifying a validation function
const myValidator = (listener, subscriber, config, logger) => {
  // use your custom logic here
  const valid = ...
  subscriber.next({ transaction: res.transaction, valid });
}
Running your node

To run your node, simply call the run function and pass your functions in:

node.run(myUploader, myValidator);

Querying data

Coming soon!

Contributing

To contribute to this repository please follow these steps:

  1. Clone the repository
    https://github.com/KYVENetwork/core.git
    
  2. Install dependencies
    yarn install
    

Keywords

FAQs

Package last updated on 28 Feb 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc