Skip to main content

Class: HttpRequestNetwork#

"http-request-network".HttpRequestNetwork

Exposes RequestNetwork module configured to use http-data-access.

Hierarchy#

Constructors#

constructor#

+ new HttpRequestNetwork(__namedParameters: { currencies: CurrencyInput[] ; currencyManager: ICurrencyManager<unknown> ; decryptionProvider: IDecryptionProvider ; httpConfig: Partial<IHttpDataAccessConfig> ; nodeConnectionConfig: AxiosRequestConfig<any> ; paymentOptions: Partial<PaymentNetworkOptions> ; signatureProvider: ISignatureProvider ; useMockStorage: boolean }): HttpRequestNetwork

Overrides RequestNetwork.constructor

Defined in request-client.js/src/http-request-network.ts:18

Creates an instance of HttpRequestNetwork.

Parameters:#

NameTypeDefault value
__namedParameters{ currencies: CurrencyInput[] ; currencyManager: ICurrencyManager<unknown> ; decryptionProvider: IDecryptionProvider ; httpConfig: Partial<IHttpDataAccessConfig> ; nodeConnectionConfig: AxiosRequestConfig<any> ; paymentOptions: Partial<PaymentNetworkOptions> ; signatureProvider: ISignatureProvider ; useMockStorage: boolean }{
httpConfig: {},
nodeConnectionConfig: {},
useMockStorage: false,
} |

Returns: HttpRequestNetwork

Properties#

paymentNetworkFactory#

paymentNetworkFactory: PaymentNetworkFactory

Inherited from RequestNetwork.paymentNetworkFactory

Defined in request-client.js/src/api/request-network.ts:32


supportedIdentities#

supportedIdentities: TYPE[] = Utils.identity.supportedIdentities

Inherited from RequestNetwork.supportedIdentities

Defined in request-client.js/src/api/request-network.ts:33

Methods#

_createEncryptedRequest#

_createEncryptedRequest(parameters: ICreateRequestParameters, encryptionParams: IEncryptionParameters[]): Promise<Request>

Inherited from RequestNetwork._createEncryptedRequest

Defined in request-client.js/src/api/request-network.ts:117

Creates an encrypted request.

Parameters:#

NameTypeDescription
parametersICreateRequestParametersParameters to create a request
encryptionParamsIEncryptionParameters[]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:158

Gets the ID of a request without creating it.

Parameters:#

NameType
parametersICreateRequestParameters

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:79

Creates a request.

Parameters:#

NameType
parametersICreateRequestParameters

Returns: Promise<Request>

The created request


fromIdentity#

fromIdentity(identity: IIdentity, updatedBetween?: ITimestampBoundaries, options?: { disableEvents?: boolean ; disablePaymentDetection?: boolean }): Promise<Request[]>

Inherited from RequestNetwork.fromIdentity

Defined in request-client.js/src/api/request-network.ts:214

Create an array of request instances from an identity

Parameters:#

NameTypeDescription
identityIIdentity-
updatedBetween?ITimestampBoundariesfilter the requests with time boundaries
options?{ disableEvents?: boolean ; disablePaymentDetection?: boolean }options

Returns: Promise<Request[]>

the Requests


fromMultipleIdentities#

fromMultipleIdentities(identities: IIdentity[], updatedBetween?: ITimestampBoundaries, options?: { disableEvents?: boolean ; disablePaymentDetection?: boolean }): Promise<Request[]>

Inherited from RequestNetwork.fromMultipleIdentities

Defined in request-client.js/src/api/request-network.ts:232

Create an array of request instances from multiple identities

Parameters:#

NameTypeDescription
identitiesIIdentity[]-
updatedBetween?ITimestampBoundariesfilter the requests with time boundaries
options?{ disableEvents?: boolean ; disablePaymentDetection?: boolean }-

Returns: Promise<Request[]>

the requests


fromMultipleTopics#

fromMultipleTopics(topics: any[], updatedBetween?: ITimestampBoundaries, options?: { disableEvents?: boolean ; disablePaymentDetection?: boolean }): Promise<Request[]>

Inherited from RequestNetwork.fromMultipleTopics

Defined in request-client.js/src/api/request-network.ts:307

Create an array of request instances from a multiple topics

Parameters:#

NameTypeDescription
topicsany[]-
updatedBetween?ITimestampBoundariesfilter the requests with time boundaries
options?{ disableEvents?: boolean ; disablePaymentDetection?: boolean }options

Returns: Promise<Request[]>

the Requests


fromRequestId#

fromRequestId(requestId: RequestLogicTypes.RequestId, options?: { disableEvents?: boolean ; disablePaymentDetection?: boolean }): Promise<Request>

Inherited from RequestNetwork.fromRequestId

Defined in request-client.js/src/api/request-network.ts:172

Create a Request instance from an existing Request's ID

Parameters:#

NameTypeDescription
requestIdRequestLogicTypes.RequestIdThe ID of the Request
options?{ disableEvents?: boolean ; disablePaymentDetection?: boolean }options

Returns: Promise<Request>

the Request


fromTopic#

fromTopic(topic: any, updatedBetween?: ITimestampBoundaries, options?: { disableEvents?: boolean ; disablePaymentDetection?: boolean }): Promise<Request[]>

Inherited from RequestNetwork.fromTopic

Defined in request-client.js/src/api/request-network.ts:255

Create an array of request instances from a topic

Parameters:#

NameTypeDescription
topicany-
updatedBetween?ITimestampBoundariesfilter the requests with time boundaries
options?{ disableEvents?: boolean ; disablePaymentDetection?: boolean }options

Returns: Promise<Request[]>

the Requests