Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 1105 class Address.ts documented in examples and diagrams #1172

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

lucanicoladebiasi
Copy link
Contributor

@lucanicoladebiasi lucanicoladebiasi commented Aug 15, 2024

Description

Class packages/core/src/vcdm/Address.ts documented with security audit remarks.
UML diagram at docs/diagrams/architecture/vcdm.md includes full Address functionalities.
Documentation's examples reworked to use the Address and VeChain Data Model types when possible.

Type of change

Please delete options that are not relevant.

  • This change required a documentation update.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • yarn test:examples
  • yarn test:unit
  • yarn test:solo

Test Configuration:

  • Node.js Version: v20.14.0
  • Yarn Version: 1.22.22

Checklist:

  • My code follows the coding standards of this project
  • I have performed a self-review of my code
  • I have commented on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • New and existing integration tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have not added any vulnerable dependencies to my code

Copy link

Test Coverage

Summary

Lines Statements Branches Functions
Coverage: 99%
99.3% (3560/3585) 97.58% (931/954) 99.29% (701/706)
Title Tests Skipped Failures Errors Time
core 501 0 💤 0 ❌ 0 🔥 1m 5s ⏱️
network 684 0 💤 0 ❌ 0 🔥 3m 42s ⏱️
errors 40 0 💤 0 ❌ 0 🔥 12.952s ⏱️

@lucanicoladebiasi lucanicoladebiasi merged commit c13361d into main Aug 15, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants