Added library config #160
Merged
Added library config #160
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
andreibancioiu
previously approved these changes
Nov 29, 2024
examples/Cookbook.ipynb
Outdated
| "source": [ | ||
| "### Changing the default hrp\n", | ||
| "\n", | ||
| "We have a configuration class, called `LibraryConfig`, that only stores the **default hrp** of the addresses. The default value is `erd`. The hrp can be changed when instantiating an address, or it can be changed in the `LibraryConfig` class, and all the addresses created will have the newly set hrp. " |
There was a problem hiding this comment.
that only stores ... - "for now" / "for the moment".
Maybe, in the future, we'll move the most of the constants (that we use for default values in various parts). That way, the constants will be "promoted" to static variables.
| @@ -36,7 +37,7 @@ def __init__(self, pubkey: bytes, hrp: str) -> None: | |||
| raise ErrBadPubkeyLength(len(pubkey), PUBKEY_LENGTH) | |||
|
|
|||
| self.pubkey = bytes(pubkey) | |||
| self.hrp = hrp | |||
| self.hrp = hrp if hrp else LibraryConfig.default_address_hrp | |||
There was a problem hiding this comment.
All right, good change.
| Generally speaking, this configuration should only be altered on exotic use cases | ||
| it can be seen as a collection of constants (or , to be more precise, rarely changed variables) that are used throughout the library. | ||
|
|
||
| Never alter the configuration within a library! |
There was a problem hiding this comment.
Indeed. Only in an end application.
Altering within a library (several times) might lead to ambiguity and conflicts.
multiversx_sdk/core/config.py
Outdated
| it can be seen as a collection of constants (or , to be more precise, rarely changed variables) that are used throughout the library. | ||
|
|
||
| Never alter the configuration within a library! | ||
| Only alter the configuration(if needed) within an(end) application that uses this library. |
| DELEGATION_MANAGER_SC_ADDRESS = "erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqylllslmq6y6" | ||
|
|
||
| # left it for compatibility reasons, will be deleted in the future |
| config: Optional[NetworkProviderConfig] = None | ||
| ) -> None: | ||
| self.url = url | ||
| self.auth = auth | ||
| self.address_hrp = address_hrp | ||
| self.address_hrp = address_hrp or DEFAULT_ADDRESS_HRP | ||
| self.address_hrp = address_hrp or LibraryConfig.default_address_hrp |
|
|
||
|
|
||
| # this is duplicated code, added here to get rid of a circular dependency | ||
| # will be removed in V1 |
andreibancioiu
approved these changes
Nov 29, 2024
bogdan-rosianu
approved these changes
Nov 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a
LibraryConfigthat stores the defaulthrpvalue.