1.6.0 • Published 10 months ago

@open-oracle-origami/origami-js-sdk v1.6.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

origami-js-sdk

npm package Build Status Downloads Issues Code Coverage Commitizen Friendly Semantic Release

Open Oracle Origami Node JS SDK

Open Oracle Origami

Any form, any shape. Web3’s modular open oracle.

Open Oracle Origami (OOO) believes that building and deploying an oracle for blockchain shouldn’t be rocket science. Our end goal is to allow expedient development of blockchain oracles while providing a myriad of oracle solutions to the world. The ideology is simple, based around composability and themed around the world of origami, its creation and viewership.

Our open-source, community-driven oracle focuses on providing reliable and decentralized data feeds as a public good. By eliminating the financial burden for users and developers, we lower barriers to entry and foster wider participation, benefiting all networks. We address the challenge of on-chain data publication by offsetting gas fees with validator rewards and utilizing them as vital infrastructure. This approach facilitates extensive historical data availability and unlocks new potential use cases.

OOO offers native pricing feeds as a public good and allows Curators to set subscriptions for their oracle's data feeds. DApps gain complimentary access to our curated Museums, while independent data providers can establish their own tailored feeds known as Collections. Curators determine subscription fees in native tokens, streamlining the user experience and enabling seamless integration of decentralized applications. With the elimination of fees, more users engage with the network, driving accelerated growth, heightened transactional activity, and increased value locked.

Main OOO components:

  • Origami: The data created by the data provider that is certified by the application. One of the main goals of the application is to transform raw data into trusted on-chain data.
  • Collab : A process that converts raw data into trusted data (data certifier).
  • Museum: The on-chain process that gives end users access to the data.
  • Curator: The process that updates the BC with the trusted data (data updater).

SDKs

We support follwoing SDKs

  • Origami JS SDK
  • Origami Rust SDK
  • Origami Solidity SDK
  • Origami Cosmos SDK
  • Origami MOVE SDK

Community data validation process:

In this scenario, data is certified through a community process. Users pay to access the results of this community process. For example, it could be an application to validate fake or real news. The producer adds news to the trusted process, and community users attempt to add fact-check elements. When there are enough checks, the news is considered true, and a link or summary is written on-chain. Users who want access to certified news pay to access the on-chain information.

Install the JS SDK

Clone the project

yarn add @open-oracle-origami/origami-js-sdk

Usage

import { Curator, Origami } from '@open-oracle-origami/origami-js-sdk'

const origami = new Origami()

Curator.curate(origami)
//=> 'curator node running'

Features

  • Reliable Data Feeds: Obtain real-time data from trusted sources and securely deliver it to smart contracts.
  • Decentralized Consensus: Utilize consensus algorithms to verify and validate the accuracy of data.
  • Data Integrity and Security: Protect data against tampering and ensure the reliability of the oracle network.
  • Flexible Integration: Seamlessly integrate Open Oracle Origami with various blockchain platforms and protocols.
  • Developer-Friendly SDKs: Provide easy-to-use SDKs for developers to interact with the oracle network.

Contributing

Contributions are always welcome! Our source code is licensed under the MIT License, and contributions are welcome.

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

License

MIT

More Documentation coming soon...