extended sdk-nestjs docs + cleanup #752
Merged
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
andreibancioiu
previously approved these changes
Jan 30, 2024
| @@ -88,7 +88,7 @@ Then it's serialized form (step 5 is omitted in this example) is as follows: | |||
|
|
|||
| ## **Ed25519 signature** | |||
|
|
|||
| MultiversX uses the [Ed25519](https://ed25519.cr.yp.to/) algorithm to sign transactions. In order to obtain the signature, one can use generic software libraries such as [PyNaCl](https://pynacl.readthedocs.io/en/stable/signing/), [tweetnacl-js](https://github.com/dchest/tweetnacl-js#signatures) or components of MultiversX SDK such as [mx-sdk-js-wallet](https://github.com/multiversx/mx-sdk-js-wallet), [mx-sdk-py-wallet](https://github.com/multiversx/mx-sdk-py-wallet), [erdgo](https://github.com/multiversx/mx-sdk-erdgo), [erdjava](https://github.com/multiversx/mx-sdk-erdjava), [mx-sdk-js-wallet-cli](https://github.com/multiversx/mx-sdk-js-wallet-cli) etc. | |||
| MultiversX uses the [Ed25519](https://ed25519.cr.yp.to/) algorithm to sign transactions. In order to obtain the signature, one can use generic software libraries such as [PyNaCl](https://pynacl.readthedocs.io/en/stable/signing/), [tweetnacl-js](https://github.com/dchest/tweetnacl-js#signatures) or components of MultiversX SDK such as [mx-sdk-js-wallet](https://github.com/multiversx/mx-sdk-js-wallet), [mx-sdk-py-wallet](https://github.com/multiversx/mx-sdk-py-wallet), [sdk-go](https://github.com/multiversx/mx-sdk-go), [mxjava](https://github.com/multiversx/mx-sdk-java), [mx-sdk-js-wallet-cli](https://github.com/multiversx/mx-sdk-js-wallet-cli) etc. | |||
| - programmatically, using the [erdgo - Golang SDK](/sdk-and-tools/erdgo) | ||
| - programmatically, using the [erdjava - Java SDK](/sdk-and-tools/erdjava) | ||
| - programmatically, using the [sdk-go - Golang SDK](/sdk-and-tools/sdk-go) | ||
| - programmatically, using the [mxjava - Java SDK](/sdk-and-tools/mxjava) |
There was a problem hiding this comment.
In this context, can be sdk-java (the label - the link is OK).
docs/sdk-and-tools/overview.md
Outdated
|
|
||
| [comment]: # (mx-context-auto) | ||
|
|
||
| ### erdjava - Java SDK | ||
| ### mxjava - Java SDK |
There was a problem hiding this comment.
So, not mx-sdk-java (for consistency)?
| [comment]: # (mx-context-auto) | ||
|
|
||
| ## Utility | ||
| The package exports **in memory cache service** and **remote cache service**. |
There was a problem hiding this comment.
... two services: an in-memory ... and a remote ...
| [comment]: # (mx-context-auto) | ||
|
|
||
| ## Table of contents | ||
| - [In Memory Cache](#in-memory-cache) - super fast in memory caching system based on [LRU cache](https://www.npmjs.com/package/lru-cache) |
| ## In memory cache | ||
| In memory cache, available through `InMemoryCacheService`, is used to read and write data from and into the memory storage of your Node.js instance. | ||
|
|
||
| *Note that if you have multiple instances of your application you must sync local cache across all your instances.* |
|
|
||
| *Note that if you have multiple instances of your application you must sync local cache across all your instances.* | ||
|
|
||
| Let's take as an example a ConfigService that loads some non-crucial configuration from the database and can be cached for 10 seconds. |
| [comment]: # (mx-context-auto) | ||
|
|
||
| ## Redis Cache | ||
| Redis cache, available through `RedisCacheService`, is a caching system build ontop of Redis. It is used to share cache related information among multiple microservices. |
There was a problem hiding this comment.
"to share cache related information" -> "used as a shared cache, shared among ..." (without "cache related information").
| [comment]: # (mx-context-auto) | ||
|
|
||
| ## Interceptors | ||
| The package provides a series of [Nestjs Interceptors](https://docs.nestjs.com/interceptors) which will automatically log and set the CPU and overall duration for each request in a prom histogram ready to be scrapped by Prometheus. |
There was a problem hiding this comment.
_prom_ or Prometheus histogram, plus a link to Prometheus?
|
|
||
| ## MetricsModule and MetricsService | ||
|
|
||
| `MetricsModule` is a [Nestjs Module](https://docs.nestjs.com/modules) responsible for aggregating metrics data through `MetricsService` and exposing them to be consumed by Prometheus. `MetricsService` is extensible, you can define and aggregate your own metrics and expose them. By default it exposes a set of metrics created by the interceptors specified [here](#interceptors). Most of the Multiversx packages expose metrics by default through this service. For example [@multiversx/sdk-nestjs-redis](https://www.npmjs.com/package/@multiversx/sdk-nestjs-redis) automatically tracks the execution time of each redis query, overall redis health and much more, by leveraging the `MetricsService`. |
There was a problem hiding this comment.
"Most of the Multiversx packages" -> typo X.
tanghel
previously approved these changes
Jan 31, 2024
bogdan-rosianu
dismissed stale reviews from tanghel and andreibancioiu
via
de4d91d
# Conflicts: # docs/developers/meta/sc-meta-cli.md
andreibancioiu
approved these changes
Feb 7, 2024
tanghel
approved these changes
Feb 7, 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.
Description of the pull request (what is new / what has changed)
Extended NestJS SDK docs + rebranding + code cleanup
Did you test the changes locally ?
Which category (categories) does this pull request belong to?