HttpRequestNetwork
@requestnetwork/request-client.js › Globals › "http-request-network" › HttpRequestNetwork
Exposes RequestNetwork module configured to use http-data-access.
Hierarchy
↳ HttpRequestNetwork
Index
Constructors
Properties
Methods
- _createEncryptedRequest
- computeRequestId
- createRequest
- fromIdentity
- fromMultipleIdentities
- fromMultipleTopics
- fromRequestId
- fromTopic
Constructors
constructor
+ new HttpRequestNetwork(__namedParameters: object): HttpRequestNetwork
Overrides RequestNetwork.constructor
Defined in request-client.js/src/http-request-network.ts:18
Creates an instance of HttpRequestNetwork.
Parameters:
▪Default value __namedParameters: object= {
nodeConnectionConfig: {},
useLocalEthereumBroadcast: false,
useMockStorage: false,
}
| Name | Type |
|---|---|
decryptionProvider | undefined | IDecryptionProvider |
ethereumProviderUrl | undefined | string |
nodeConnectionConfig | undefined | AxiosRequestConfig |
signatureProvider | undefined | ISignatureProvider |
useLocalEthereumBroadcast | undefined | false | true |
useMockStorage | undefined | false | true |
web3 | any |
Returns: HttpRequestNetwork
Properties
_mockStorage
• _mockStorage: MockStorage | undefined
Defined in request-client.js/src/http-request-network.ts:18
Public for test purpose
Optional bitcoinDetectionProvider
• bitcoinDetectionProvider? : PaymentTypes.IBitcoinDetectionProvider
Inherited from RequestNetwork.bitcoinDetectionProvider
Defined in request-client.js/src/api/request-network.ts:28
Methods
_createEncryptedRequest
▸ _createEncryptedRequest(parameters: ICreateRequestParameters, encryptionParams: IEncryptionParameters[]): Promise‹Request›
Inherited from RequestNetwork._createEncryptedRequest
Defined in request-client.js/src/api/request-network.ts:93
Creates an encrypted request.
Parameters:
| Name | Type | Description |
|---|---|---|
parameters | ICreateRequestParameters | Parameters to create a request |
encryptionParams | IEncryptionParameters[] | Request encryption parameters |
Returns: Promise‹Request›
The created encrypted request
computeRequestId
▸ computeRequestId(parameters: ICreateRequestParameters): Promise‹RequestLogicTypes.RequestId›
Inherited from RequestNetwork.computeRequestId
Defined in request-client.js/src/api/request-network.ts:128
Gets the ID of a request without creating it.
Parameters:
| Name | Type |
|---|---|
parameters | ICreateRequestParameters |
Returns: Promise‹RequestLogicTypes.RequestId›
The requestId
createRequest
▸ createRequest(parameters: ICreateRequestParameters): Promise‹Request›
Inherited from RequestNetwork.createRequest
Defined in request-client.js/src/api/request-network.ts:61
Creates a request.
Parameters:
| Name | Type |
|---|---|
parameters | ICreateRequestParameters |
Returns: Promise‹Request›
The created request
fromIdentity
▸ fromIdentity(identity: IIdentity, updatedBetween?: Types.ITimestampBoundaries, options?: undefined | object): Promise‹Request[]›
Inherited from RequestNetwork.fromIdentity
Defined in request-client.js/src/api/request-network.ts:188
Create an array of request instances from an identity
Parameters:
| Name | Type | Description |
|---|---|---|
identity | IIdentity | - |
updatedBetween? | Types.ITimestampBoundaries | filter the requests with time boundaries |
options? | undefined | object | options |
Returns: Promise‹Request[]›
the Requests
fromMultipleIdentities
▸ fromMultipleIdentities(identities: IIdentity[], updatedBetween?: Types.ITimestampBoundaries, options?: undefined | object): Promise‹Request[]›
Inherited from RequestNetwork.fromMultipleIdentities
Defined in request-client.js/src/api/request-network.ts:207
Create an array of request instances from multiple identities
Parameters:
| Name | Type | Description |
|---|---|---|
identities | IIdentity[] | - |
updatedBetween? | Types.ITimestampBoundaries | filter the requests with time boundaries |
options? | undefined | object | - |
Returns: Promise‹Request[]›
the requests
fromMultipleTopics
▸ fromMultipleTopics(topics: any[], updatedBetween?: Types.ITimestampBoundaries, options?: undefined | object): Promise‹Request[]›
Inherited from RequestNetwork.fromMultipleTopics
Defined in request-client.js/src/api/request-network.ts:285
Create an array of request instances from a multiple topics
Parameters:
| Name | Type | Description |
|---|---|---|
topics | any[] | - |
updatedBetween? | Types.ITimestampBoundaries | filter the requests with time boundaries |
options? | undefined | object | options |
Returns: Promise‹Request[]›
the Requests
fromRequestId
▸ fromRequestId(requestId: RequestLogicTypes.RequestId, options?: undefined | object): Promise‹Request›
Inherited from RequestNetwork.fromRequestId
Defined in request-client.js/src/api/request-network.ts:142
Create a Request instance from an existing Request's ID
Parameters:
| Name | Type | Description |
|---|---|---|
requestId | RequestLogicTypes.RequestId | The ID of the Request |
options? | undefined | object | options |
Returns: Promise‹Request›
the Request
fromTopic
▸ fromTopic(topic: any, updatedBetween?: Types.ITimestampBoundaries, options?: undefined | object): Promise‹Request[]›
Inherited from RequestNetwork.fromTopic
Defined in request-client.js/src/api/request-network.ts:231
Create an array of request instances from a topic
Parameters:
| Name | Type | Description |
|---|---|---|
topic | any | - |
updatedBetween? | Types.ITimestampBoundaries | filter the requests with time boundaries |
options? | undefined | object | options |
Returns: Promise‹Request[]›
the Requests