Skip to content

A JavaScript library for interacting with the Request Network protocol

License

Notifications You must be signed in to change notification settings

PijiDev/requestNetwork

 
 

Repository files navigation


CircleCI Coverage Status Commit Activity

Request is a decentralized network built on top of Ethereum, which allows anyone, anywhere to request a payment. A full description of the protocol may be found in our whitepaper.

This repository contains all the Request Network developer tools written in TypeScript.

Join the Request Discord to get in touch with us.

Published Packages

Package Version Description
@requestnetwork/advanced-logic npm Extensions to the protocol
@requestnetwork/request-client.js npm Library to use Request nodes as servers
@requestnetwork/data-access npm Indexing an batching of transactions
@requestnetwork/data-format npm Standards for data stored on Request, like invoices format
@requestnetwork/epk-signature npm Sign requests using Ethereum private keys
@requestnetwork/ethereum-storage npm Storage of Request data on Ethereum and IPFS, with custom indexing
@requestnetwork/epk-decryption npm Decrypt encrypted requests using Ethereum private keys
@requestnetwork/payment-detection npm Client-side payment detection, to compute the balance.
@requestnetwork/payment-processor npm Pay a request using a web3 wallet
@requestnetwork/request-logic npm The Request business logic: properties and actions of requests
@requestnetwork/request-node npm Web server that allows easy access to Request system
@requestnetwork/transaction-manager npm Creates transactions to be sent to Data Access, managing encryption
@requestnetwork/types npm Typescript types shared across @requestnetwork packages
@requestnetwork/utils npm Collection of tools shared between the @requestnetwork packages
@requestnetwork/web3-signature npm Sign requests using web3 tools (like Metamask)
@requestnetwork/multi-format npm Serialize and deserialize object in the Request Network protocol
@requestnetwork/thegraph-data-access npm Storage of Request data on Ethereum and IPFS, indexed by TheGraph
@requestnetwork/smart-contracts npm Sources and artifacts of the smart contracts

Private Packages

Package Description
@requestnetwork/integration-test Integration test for the Request system
@requestnetwork/prototype-estimator Give estimates of size and throughput of the Request system
@requestnetwork/toolbox Toolbox for Request Network
@requestnetwork/usage-example Usage examples of Request Network

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Read the contributing guide

Install

Install all the packages in the monorepo.

yarn install

Build

Build all the packages in the monorepo.

yarn run build

Lint

Lint all the packages in the monorepo.

yarn run lint

Test

Disable API tests OR define all required explorer API keys.

export DISABLE_API_TESTS=1
# OR
export EXPLORER_API_KEY_MAINNET=
export EXPLORER_API_KEY_RINKEBY=
export EXPLORER_API_KEY_FUSE=
export EXPLORER_API_KEY_MATIC=
export EXPLORER_API_KEY_FANTOM=

Test all the packages in the monorepo.

yarn run test

License

MIT

V1 packages

This repository hosts the packages for the second version of Request. The v1 packages are deprecated and can be found on requestNetwork-v1-archive.

About

A JavaScript library for interacting with the Request Network protocol

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.6%
  • Solidity 4.0%
  • JavaScript 0.8%
  • HTML 0.5%
  • CSS 0.1%
  • Shell 0.0%