Allow passing network options from Entrypoint to Network Provider

[BubuMVX]

Hello,

Summary

This PR adds support for passing custom network options from the Entrypoint to the Network Provider. This allows developers to configure headers and other request-related parameters when initializing the entrypoint.

Changes

• Added a new networkProviderOptions field in the Entrypoint options.
• Ensured clientName can be set via either options.clientName or fallback to User-Agent header.

Motivation

Provides more flexibility for advanced developers needing to customize the network layer (e.g. for authentication, logging, or custom headers).

[andreibancioiu]

👍

[andreibancioiu]

In the constructors of ProxyNetworkProvider and ApiNetworkProvider, this is named "config". Maybe, for consistency, rename the parameter to networkProviderConfig?

[BubuMVX]

Hey @andreibancioiu, thanks a lot for all the feedback.
I agree with you, I rename it.

[andreibancioiu]

Such a line:

options.networkProviderOptions.[...] = ...

Will mutate the input argument networkProviderOptions, which might cause downstream issues (if that input argument is re-used by the caller). Maybe clone the options (below is just an example, not an actual suggestion)?

networkProviderOptions = { ...options.networkProviderOptions, ...{ clientName: options.clientName } };

Maybe a cleaner way would be to simply drop the input argument clientName, and only have networkProviderConfig? However, that would be a breaking change, and we shouldn't apply it (yet!).

[BubuMVX]

I'm not a fan of this line either.
I went down this route by mimicking what I saw in the extended Entrypoints, such as

mx-sdk-js-core/src/entrypoints/entrypoints.ts

Line 272 in eec19ba

options = options || {};

I'll try to suggest a better approach.

[andreibancioiu]

This is an opaque trick (a hack), and assumes that "client name" and "header user agent" are synonyms for network providers (somehow, it breaks a bit their encapsulation).

Maybe drop this logic, and, if desired, a separate PR can be made, but not for the entrypoints. See the file below for a possible place of adjustment:

• https://github.com/multiversx/mx-sdk-js-core/blob/main/src/networkProviders/userAgent.ts

[BubuMVX]

As you understood, I wanted to avoid doing a breaking change in the active major version.
After looking more closely at the code you suggested, I also think it's good to move it in this dedicated function.

[BubuMVX]

About the clientName and User-Agent header, my opinion is:

• clientName is good for general usage, as you want to collect stats. It's easy to set and abstracts the technical implications. And you already build a custom User-Agent from that, that looks like a good approach.
• More advanced users may want to force a very specific User-Agent. This shouldn't be altered later in the Network Provider.
• One of them must be specified for sure, otherwise you get the console error message and the "unknown" fallback. With a priority to be discussed (probably User-Agent > clientName).

So yes, it's probably a topic for the next major release.