The documentation from requestnetwork

documentation's Introduction

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

Private Packages

Package	Description
`@requestnetwork/integration-test`	Integration test for 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

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.

documentation's People

Contributors

Stargazers

Watchers

documentation's Issues

Error in using-the-javascript-library#example

I am running into an issue while trying out the following example in the request network JS library guide: https://docs.request.network/development/using-the-javascript-library#example

Unhandled rejection Error: Returned error: Attempting to run transaction which calls a contract function, but recipient address 0xf12b5dd4ead5f743c6baa640b0216200e89b60da is not a contract address

This occurs during the execution of

const { request } = await requestNetwork.createRequest(
    RequestNetwork.Types.Role.Payee,
    RequestNetwork.Types.Currency.ETH,
    payeesInfo,
    payerInfo,
  );

Details: I am running a private blockchain instance using ganache-cli.
I understand that:

As a step while the above is being executed, the req-net library instantiates the last-RequestEthereum contract here
which picks up the contract from here
and finally the address 0xf12b5dd4ead5f743c6baa640b0216200e89b60da comes from here.
Since my version of local blockchain doesn't have the request network smart contract published at that address (nor at any other), I get this error message.

My question is how do setup my environment so as to be able to develop on top the request network?

Add data as a parameter for transactions

:-D I assume its a big ask... but to donate on the Giveth DApp you have to call a function in our bridge contract... could that get added in so that this would be an option:

  var requestDonations = new requestNetworkDonations({
    address: '0x30f938fed5de6e06a9a7cd2ac3517131c317b1e7 ', 
 data:'0xbde60ac900000000000000000000000000000000000000000000000000000000000001eb0000000000000000000000000000000000000000000000000000000000000005',
    currencies: ['ETH', 'REQ', 'DAI', 'OMG', 'KNC', 'DGX', 'KIN', 'BNB', 'BAT', 'ZRX', 'LINK'],
    network: 1,
    max_amount: 1,000,000 /// TODO: insert Dr. Evil emoji
  });

This would allow us to use your app to accept donations! :-D

Recommend Projects

requestnetwork / documentation Goto Github PK