@requestnetwork/request-network.js
Advanced tools
A JavaScript library for interacting with the Request Network protocol
Welcome to the requestNetwork.js documentation! requestNetwork.js is a Javascript library for interacting with the Request Network protocol. Using the library you can create new requests from your applications, pay them, consult them or update them from your own off-chain applications.
If your application is decentralized and onchain on Ethereum, you can directly interact with our smart contracts. Smart contract documentation
This is still an alpha version which will evolve significantly before the main net release.
Everything that is specified in the wiki.
Among other things, this documentation specifies the smart contract architecture, the different actions that can be done at specific times, the statuses, how to use the extensions, the fee management system, the cross currency feature, how to manage identity and what to expect from the reputation system.
No tutorials available yet. Feel free to suggest yours and we will refer to it. If you’re looking for an example, you can browse the app.request.network website and github
requestNetwork.js ships as a CommonJS package. CommonJS (recommended):
npm install @requestnetwork/request-network.js --save
yarn add @requestnetwork/request-network.js
(We are currently working on retrieving the name of requestnetwork.js)
import RequestNetwork from '@requestnetwork/request-network.js';
Default configuration (Infura and Rinkeby)
let requestNetwork = new RequestNetwork();
Custom configuration
let requestNetwork = new RequestNetwork(provider, networkId, useIpfsPublic);
Instantiates a new RequestNetwork instance that provides the public interface to the requestNetwork.js library.
@param provider The Web3.js Provider instance you would like the requestNetwork.js library to use for interacting with the Ethereum network.
@param networkId the Ethereum network ID.
@param useIpfsPublic use public ipfs node if true, private one specified in “src/config.json ipfs.nodeUrlDefault.private” otherwise
@return An instance of the requestNetwork.js RequestNetwork class.
requestNetwork.js is a promise-based library. This means that whenever an asynchronous call is required, the library method will return a native Javascript promise. You can therefore choose between using promise or async/await syntax when calling our async methods.
Every function that modify data on the blockchain will trigger first an event “broadcasted” when the transaction is submitted to the nodes, before returning the request data when the transaction is confirmed. You can specify a number of confirmations to wait before returning the promise in options.numberOfConfirmation - default to 0.
Async/await syntax (recommended):
try {
var data = await requestNetwork.requestEthereumService.accept(requestId).on('broadcasted', txHash => {
//Transaction broadcasted
console.log('transaction hash: ', txHash);
});
//Transaction mined
console.log(data.request)
} catch (error) {
console.log('Caught error: ', error);
}
Promise syntax:
requestNetwork.requestEthereumService.accept(requestId).on('broadcasted', txHash => {
//Transaction broadcasted
console.log('Transaction hash: ', txHash);
}).then(data => {
//Transaction mined
console.log(data.request);
})
.catch(error => {
console.log('Caught error: ', error);
});
As is the convention with promise-based libraries, if an error occurs, it is thrown. It is the callers responsibility to catch thrown errors and to handle them appropriately.
The library adheres to the Semantic Versioning 2.0.0 specification. Note that major version zero (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable since the library is still an alpha and we will introduce backward incompatible changes to the interface without incrementing the major version until the 1.0.0 release. Our convention until then will be to increment the minor version whenever we introduce backward incompatible changes to the public interface, and to increment the patch version otherwise.
public createRequestAsPayee(_payeesIdAddress: string[], _expectedAmounts: any[], _payer: string, _payeesPaymentAddress ?: Array<string|undefined>, _payerRefundAddress ?: string, _data ?: string, _extension ?: string, _extensionParams ?: any[], _options ?: any)
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_payeesIdAddress ID addresses of the payees (the position 0 will be the main payee, must be the broadcaster address)_expectedAmounts amount initial expected per payees for the request_payer address of the payer_payeesPaymentAddress payment addresses of the payees (the position 0 will be the main payee) (optional)_payerRefundAddress refund address of the payer (optional)_data Json of the request's details (optional)_extension address of the extension contract of the request (optional) NOT USED YET_extensionParams array of parameters for the extension (optional) NOT USED YET_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transactionHash})public createRequestAsPayer(_payeesIdAddress: string[], _expectedAmounts: any[], _payerRefundAddress ?: string, _amountsToPay ?: any[], _additionals ?: any[], _data ?: string, _extension ?: string, _extensionParams ?: any[], _options ?: any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_payeesIdAddress ID addresses of the payees (the position 0 will be the main payee)_expectedAmounts amount initial expected per payees for the request_payerRefundAddress refund address of the payer (optional)_amountsToPay amounts to pay in wei for each payee (optional)_additionals amounts of additional in wei for each payee (optional)_data Json of the request's details (optional)_extension address of the extension contract of the request (optional) NOT USED YET_extensionParams array of parameters for the extension (optional) NOT USED YET_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public signRequestAsPayee( _payeesIdAddress: string[], _expectedAmounts: any[], _expirationDate: number, _payeesPaymentAddress ?: Array<string|undefined>, _data ?: string, _extension ?: string, _extensionParams ?: any[], _from ?: string)
_payeesIdAddress ID addresses of the payees (the position 0 will be the main payee, must be the signer address)_expectedAmounts amount initial expected per payees for the request_expirationDate timestamp in second of the date after which the signed request is not broadcastable_payeesPaymentAddress payment addresses of the payees (the position 0 will be the main payee) (optional)_data Json of the request's details (optional)_extension address of the extension contract of the request (optional) NOT USED YET_extensionParams array of parameters for the extension (optional) NOT USED YET_from address of the payee, default account will be used otherwise (optional)public broadcastSignedRequestAsPayer( _signedRequest: any, _amountsToPay ?: any[], _additionals ?: any[], _options ?: any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_signedRequest object signed request (see Signed Request)_amountsToPay amounts to pay in wei for each payee (optional)_additionals amounts of additional in wei for each payee (optional)_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){
"currencyContract": "Address of the currency contract",
"data": "hash of the ipfs file(optional)",
"expectedAmounts": "amount initial expected per payees for the request",
"expirationDate": "unix timestamp of expiration date( in second)",
"hash": "solidity hash of the request data",
"payeesIdAddress": "ID addresses of the payees(the position 0 will be the main payee)",
"payeesPaymentAddress": "payment addresses of the payees(the position 0 will be the main payee)(optional)",
"signature": "signature by payee of the hash"
}
Example:
{
"currencyContract":"0xf12b5dd4ead5f743c6baa640b0216200e89b60da",
"data":"QmbFpULNpMJEj9LfvhH4hSTfTse5YrS2JvhbHW6bDCNpwS",
"expectedAmounts":[
"100000000",
"20000000",
"3000000"
],
"expirationDate":7952342400000,
"hash":"0x914512e0cc7597bea264a4741835257387b1fd66f81ea3947f113e4c20b4a679",
"payeesIdAddress":[
"0x821aea9a577a9b44299b9c15c88cf3087f3b5544",
"0x0d1d4e623d10f9fba5db95830f7d3839406c6af2",
"0x2932b7a2355d6fecc4b5c0b6bd44cc31df247a2e"
],
"payeesPaymentAddress":[
"0x6330a553fc93768f612722bb8c2ec78ac90b3bbc",
null,
"0x5aeda56215b167893e80b4fe645ba6d5bab767de"
],
"signature":"0xbe2cc3516f1805ab619f550a16e39cb435a9873dd3c1a6dff430a345c30b206515217da7430306207c7cf06e092c84ef0fb3def78c87e4488a5babc8c6f9761a01"
}
public isSignedRequestHasError(_signedRequest: any, _payer: string): string;
Check if a signed request is valid
_signedRequest Signed request_payer Payer of the requestpublic accept(_requestId: string, _options ? : any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public cancel(_requestId: string, _options ? : any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public paymentAction(_requestId: string, _amountsToPay: any[], _additionals ?: any[], _options ? : any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_amountsToPay amounts to pay in wei for each payee_additionals amounts of additional in wei for each payee (optional)_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public refundAction(_requestId: string, _amountToRefund: any, _options ? : any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
only addresses from payeesIdAddress and payeesPaymentAddress can refund a request
_requestId requestId of the payer_amount amount to refund in wei_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public subtractAction(_requestId: string, _subtracts: any[], _options ? : any)
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_subtracts amounts of subtracts in wei for each payee_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public additionalAction(_requestId: string, _additionals: any[], _options ? : any)
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_additionals amounts of additionals in wei for each payee_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public getRequestCurrencyContractInfo(_requestId: string)
return {} always
_requestId requestId of the request{} here)requestCoreServices.getRequest())public getRequest(_requestId: string)
_requestId requestId of the requestpublic getRequestByTransactionHash(_hash: string)
Get a request and method called by the hash of a transaction
requestCoreServices.getRequestEvents())public getRequestEvents(_requestId: string, _fromBlock ?: number, _toBlock ?: number)
_requestId requestId of the request_fromBlock search events from this block (optional)_toBlock search events until this block (optional)public getRequestEventsCurrencyContractInfo(_requestId: string, _fromBlock ?: number, _toBlock ?: number)
_requestId requestId of the request_fromBlock search events from this block (optional)_toBlock search events until this block (optional){} here)createRequestAsPayee(_tokenAddress: string, _payeesIdAddress: string[], _expectedAmounts: any[], _payer: string, _payeesPaymentAddress ?: Array<string|undefined>, _payerRefundAddress ?: string, _data ?: string, _extension ?: string, _extensionParams ?: any[] , _options ?: any);
emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted
_tokenAddress Address token used for payment_payeesIdAddress ID addresses of the payees (the position 0 will be the main payee, must be the broadcaster address)_expectedAmounts amount initial expected per payees for the request_payer address of the payer_payeesPaymentAddress payment addresses of the payees (the position 0 will be the main payee) (optional)_payerRefundAddress refund address of the payer (optional)_data Json of the request's details (optional)_extension address of the extension contract of the request (optional) NOT USED YET_extensionParams array of parameters for the extension (optional) NOT USED YET_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transactionHash})createRequestAsPayer(_tokenAddress: string,_payeesIdAddress: string[],_expectedAmounts: any[],_payerRefundAddress ?: string,_amountsToPay ?: any[],_additionals ?: any[],_data ?: string,_extension ?: string,_extensionParams ?: any[], _options ?: any)
emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted
_payeesIdAddress ID addresses of the payees (the position 0 will be the main payee)_expectedAmounts amount initial expected per payees for the request_payerRefundAddress refund address of the payer (optional)_amountsToPay amounts to pay for each payee (optional)_additionals amounts of additional for each payee (optional)_data Json of the request's details (optional)_extension address of the extension contract of the request (optional) NOT USED YET_extensionParams array of parameters for the extension (optional) NOT USED YET_options options for the method (gasPrice, gas, value, from, numberOfConfirmation)public signRequestAsPayee(_tokenAddress: string, _payeesIdAddress: string[], _expectedAmounts: any[], _expirationDate: number, _payeesPaymentAddress ?: Array<string|undefined>, _data ?: string, _extension ?: string, _extensionParams ?: any[], _from ?: string);
_tokenAddress Address token used for payment_payeesIdAddress ID addresses of the payees (the position 0 will be the main payee, must be the broadcaster address)_expectedAmounts amount initial expected per payees for the request_expirationDate timestamp in second of the date after which the signed request is not broadcastable_payeesPaymentAddress payment addresses of the payees (the position 0 will be the main payee) (optional)_data Json of the request's details (optional)_extension address of the extension contract of the request (optional) NOT USED YET_extensionParams array of parameters for the extension (optional) NOT USED YET_from address of the payee, default account will be used otherwise (optional)broadcastSignedRequestAsPayer(_signedRequest: any, _amountsToPay ?: any[], _additionals ?: any[], _options ?: any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_signedRequest object signed request (see Signed Request)_amountsToPay amounts to pay in wei for each payee (optional)_additionals amounts of additional in wei for each payee (optional)_options options for the method (gasPrice, gas, value, from, numberOfConfirmation, skipERC20checkAllowance){
"tokenAddress": "Address of the ERC20 token to pay the request",
"currencyContract": "Address of the currency contract",
"data": "hash of the ipfs file(optional)",
"expectedAmounts": "amount initial expected per payees for the request",
"expirationDate": "unix timestamp of expiration date( in second)",
"hash": "solidity hash of the request data",
"payeesIdAddress": "ID addresses of the payees(the position 0 will be the main payee)",
"payeesPaymentAddress": "payment addresses of the payees(the position 0 will be the main payee)(optional)",
"signature": "signature by payee of the hash"
}
Example:
{
"tokenAddress": "0xf25186B5081Ff5cE73482AD761DB0eB0d25abfBF",
"currencyContract":"0xf12b5dd4ead5f743c6baa640b0216200e89b60da",
"data":"QmbFpULNpMJEj9LfvhH4hSTfTse5YrS2JvhbHW6bDCNpwS",
"expectedAmounts":[
"100000000",
"20000000",
"3000000"
],
"expirationDate":7952342400000,
"hash":"0x914512e0cc7597bea264a4741835257387b1fd66f81ea3947f113e4c20b4a679",
"payeesIdAddress":[
"0x821aea9a577a9b44299b9c15c88cf3087f3b5544",
"0x0d1d4e623d10f9fba5db95830f7d3839406c6af2",
"0x2932b7a2355d6fecc4b5c0b6bd44cc31df247a2e"
],
"payeesPaymentAddress":[
"0x6330a553fc93768f612722bb8c2ec78ac90b3bbc",
null,
"0x5aeda56215b167893e80b4fe645ba6d5bab767de"
],
"signature":"0xbe2cc3516f1805ab619f550a16e39cb435a9873dd3c1a6dff430a345c30b206515217da7430306207c7cf06e092c84ef0fb3def78c87e4488a5babc8c6f9761a01"
}
public isSignedRequestHasError(_signedRequest: any, _payer: string): string;
Check if a signed request is valid
_signedRequest Signed request_payer Payer of the requestpublic accept(_requestId: string, _options ? : any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public cancel(_requestId: string, _options ? : any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public paymentAction(_requestId: string, _amountsToPay: any[], _additionals ?: any[], _options ? : any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_amountsToPay amounts to pay in wei for each payee_additionals amounts of additional in wei for each payee (optional)_options options for the method (gasPrice, gas, value, from, numberOfConfirmation, skipERC20checkAllowance){request, transaction})public refundAction(_requestId: string, _amountToRefund: any, _options ? : any);
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
only addresses from payeesIdAddress and payeesPaymentAddress can refund a request
_requestId requestId of the payer_amountToRefund amount to refund in wei_options options for the method (gasPrice, gas, value, from, numberOfConfirmation, skipERC20checkAllowance){request, transaction})public subtractAction(_requestId: string, _subtracts: any[], _options ? : any)
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_subtracts amounts of subtracts in wei for each payee_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public additionalAction(_requestId: string, _additionals: any[], _options ? : any)
Emit the event 'broadcasted' with {transaction: {hash}} when the transaction is submitted.
_requestId requestId of the payer_additionals amounts of additionals in wei for each payee_options options for the method (gasPrice, gas, value, from, numberOfConfirmation){request, transaction})public getRequestCurrencyContractInfo(_requestId: string)
_requestId requestId of the requestrequestCoreServices.getRequest())public getRequest(_requestId: string)
_requestId requestId of the requestpublic getRequestByTransactionHash(_hash: string)
Get a request and method called by the hash of a transaction
requestCoreServices.getRequestEvents())public getRequestEvents(_requestId: string, _fromBlock ?: number, _toBlock ?: number)
_requestId requestId of the request_fromBlock search events from this block (optional)_toBlock search events until this block (optional)public approveTokenForRequest(_requestId: string, _amount: any, _options ?: any)
_requestId requestId of the request_amount amount to allowed_options options for the method (gasPrice, gas, value, from, numberOfConfirmation)public approveTokenForSignedRequest(_signedRequest: any, _amount: any, _options ?: any)
_signedRequest object signed request_amount amount to allowed_options options for the method (gasPrice, gas, value, from, numberOfConfirmation)public getTokenAllowance(_tokenAddress: string, _currencyContractAddress: string, _options: any)
_tokenAddress token address_currencyContractAddress currency contract address_options options for the method (here only from)Here is the list of events produced by the Request Network smarts contracts. Note that the solidity types will be converted in strings when you receive them.
Created(bytes32 indexed requestId, address indexed payee, address indexed payer)Accepted(bytes32 indexed requestId)Canceled(bytes32 indexed requestId)UpdateBalance(bytes32 indexed requestId, uint8 payeeIndex, int256 deltaAmount)UpdateExpectedAmount(bytes32 indexed requestId, uint8 payeeIndex, int256 deltaAmount)NewSubPayee(bytes32 indexed requestId, address indexed payee)Install ganache globally if it isn't already installed
npm install -g ganache-cli
Install lerna and bootstrap it, to install the dependencies and link the packages together
npm install --global lerna
lerna bootstrap
Launch a ganache-cli instance on a terminal:
npm run ganache
In a second terminal, Launch an ipfs node:
ipfs daemon
In a third terminal, deploy the contracts:
npm run testdeploy
You can now launch the unit tests:
npm run test
FAQs
A JavaScript library for interacting with the Request Network protocol
The npm package @requestnetwork/request-network.js receives a total of 1 weekly downloads. As such, @requestnetwork/request-network.js popularity was classified as not popular.
We found that @requestnetwork/request-network.js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
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.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.