-
Notifications
You must be signed in to change notification settings - Fork 10
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
1658 bnc part 4 #1809
1658 bnc part 4 #1809
Conversation
* fix: fr9 recommendations * fix: en_1 recommendations * fix: en_1 recommendations * fix: en_2 recommendations... * fix: en_2 recommendations... * fix: en_7 recommendations... * fix: en_7 recommendations... * fix: n_7 recommandations * fix: n_7 recommandations * Merge branch 'main' into 1656-fr9 * Merge branch '1661-en_2' into 1662-en_7 * fix: EN_7 * fix: EN_7 * fix: EN_7 --------- Co-authored-by: Fabio Rigamonti <73019897+fabiorigam@users.noreply.github.com> (cherry picked from commit f52a556)
# Conflicts: # apps/sdk-hardhat-integration/hardhat.config.ts # packages/rpc-proxy/README.md # packages/rpc-proxy/src/utils/args-validator/args-validator-and-getter.ts # packages/rpc-proxy/src/utils/args-validator/args-validator.ts # packages/rpc-proxy/src/utils/config-validator/config-validator.ts # packages/rpc-proxy/tests/config-files-fixtures/correct-proxy-config-gas-payer-private-key.json # packages/rpc-proxy/tests/config-files-fixtures/correct-proxy-config-gas-payer-url.json
…dedBlockDetail` interface
…dedBlockDetail` interface
# Conflicts: # packages/hardhat-plugin/tests/helpers/fixture.ts
WalkthroughThis pull request standardizes terminology by replacing references to "delegator" with "gasPayer" throughout multiple modules. The changes cover documentation updates, configuration file adjustments, script modifications, and test suite renaming across the SDK Hardhat integration, AWS KMS adapter, Hardhat plugin, and network packages. One exception is in the network package where the interface now includes both a renamed field and additional documentation clarifying their roles. Changes
Sequence Diagram(s)sequenceDiagram
participant Config as Hardhat Config
participant Provider as Provider Helper
participant Wallet as Wallet Factory
participant Signer as KMSVeChainSigner
Config->>Provider: Supply network configuration with gasPayer data
Provider->>Wallet: Create wallet using gasPayer parameters
Wallet->>Signer: Instantiate signer with gasPayer provider settings
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
🧹 Nitpick comments (5)
packages/network/src/thor-client/blocks/types.d.ts (1)
215-229
: Enhance documentation clarity for the delegator property.While the documentation explains the relationship between
delegator
andgasPayer
, it could be more concise and clearer. Consider restructuring the note to emphasize the key points:- * The property name `delegator` is exposed by - * [Tx](https://mainnet.vechain.org/doc/stoplight-ui/#/schemas/Tx) - * response of the end-point - * [Retrieve a block](https://mainnet.vechain.org/doc/stoplight-ui/#/paths/blocks-revision/get) - * with query set as `?expanded=true`. - * * In the rest of the SDK the address of the sponsor of the transaction is exposed by properties named - * `gasPayer`. - * It's suggested to read as "delegated" the term written as "delegator". - * * This interface exposes the property {@link gasPayer} to express the address of the sponsor of the - * transaction, either {@link origin} or {@link delegator}. + * NOTE: This property represents the gas-payer address and is named `delegator` to match the + * [Tx schema](https://mainnet.vechain.org/doc/stoplight-ui/#/schemas/Tx) in the block retrieval API. + * Throughout the rest of the SDK, this concept is consistently referred to as `gasPayer`. + * + * @see {@link gasPayer} - The actual gas payer (either {@link origin} or {@link delegator}) + * @see [Block API](https://mainnet.vechain.org/doc/stoplight-ui/#/paths/blocks-revision/get)packages/aws-kms-adapter/src/KMSVeChainSigner.ts (2)
232-232
: Consider renaming method for terminology consistency.The method name
concatSignatureIfDelegation
still uses the old terminology. Consider renaming it to align with the new "gas payer" terminology.- private async concatSignatureIfDelegation( + private async concatSignatureIfGasPayer(
246-247
: Consider renaming variable for terminology consistency.The variable name
delegatedHash
uses the old terminology.- const delegatedHash = - transaction.getTransactionHash(originAddress).bytes; + const gasPayerHash = + transaction.getTransactionHash(originAddress).bytes;packages/aws-kms-adapter/README.md (2)
32-54
: Consider enhancing the JSON example with a gasPayer configuration.While the explanation mentions gasPayer key support, the JSON example could be more helpful by including a complete gasPayer configuration entry.
Consider expanding the example to show both entries:
[ { "keyId": "00000000-0000-0000-0000-000000000000", "region": "eu-west-1", "credentials": { "accessKeyId": "test", "secretAccessKey": "test", "sessionToken": "test" }, "endpoint": "http://localhost:4599" - } + }, + { + "keyId": "11111111-1111-1111-1111-111111111111", + "region": "eu-west-1", + "credentials": { + "accessKeyId": "gasPayer", + "secretAccessKey": "gasPayer", + "sessionToken": "test" + }, + "endpoint": "http://localhost:4599" + } ]🧰 Tools
🪛 LanguageTool
[style] ~32-~32: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... as follows (it is an array in case you want to include a gasPayer key, assumed to be t...(REP_WANT_TO_VB)
161-206
: LGTM! Clear and well-structured example.The example effectively demonstrates the usage of both origin and gasPayer keys with KMS. The comments and variable names are consistent with the new terminology.
Consider adding a brief comment to explain that
true
ingetAddress(true)
indicates retrieving the gasPayer's address:// Returns the address related to the gasPayer KMS key -const address = await signerWithGasPayer.getAddress(true); +const address = await signerWithGasPayer.getAddress(true); // Pass true to get gasPayer's address
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (20)
apps/sdk-hardhat-integration/README.md
(1 hunks)apps/sdk-hardhat-integration/hardhat.config.ts
(3 hunks)localstack/init/kms.sh
(1 hunks)packages/aws-kms-adapter/README.md
(2 hunks)packages/aws-kms-adapter/src/KMSVeChainSigner.ts
(5 hunks)packages/aws-kms-adapter/tests/KMSVeChainSigner.solo.test.ts
(6 hunks)packages/aws-kms-adapter/tests/KMSVeChainSigner.testnet.test.ts
(5 hunks)packages/aws-kms-adapter/tests/fixture.ts
(1 hunks)packages/hardhat-plugin/src/helpers/provider-helper.ts
(2 hunks)packages/hardhat-plugin/src/type-extensions.ts
(1 hunks)packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-default-value-project/hardhat.config.ts
(1 hunks)packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-no-value-project/hardhat.config.ts
(1 hunks)packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-random-value-project/hardhat.config.ts
(1 hunks)packages/hardhat-plugin/tests/hardhat-mock-projects/simple-vechain-hardhat-project/hardhat.config.ts
(2 hunks)packages/hardhat-plugin/tests/helpers/fixture.ts
(3 hunks)packages/hardhat-plugin/tests/helpers/provider-helpers.unit.test.ts
(1 hunks)packages/hardhat-plugin/tests/simple-vechain-hardhat-project.solo.test.ts
(1 hunks)packages/network/src/thor-client/blocks/types.d.ts
(1 hunks)packages/network/tests/provider/formatter/fixture.ts
(2 hunks)packages/network/tests/thor-client/blocks/fixture.ts
(4 hunks)
✅ Files skipped from review due to trivial changes (3)
- packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-default-value-project/hardhat.config.ts
- packages/aws-kms-adapter/tests/KMSVeChainSigner.testnet.test.ts
- packages/aws-kms-adapter/tests/fixture.ts
🧰 Additional context used
🧠 Learnings (7)
📓 Common learnings
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1777
File: packages/errors/src/available-errors/transaction/transaction.ts:33-33
Timestamp: 2025-01-30T17:15:49.377Z
Learning: PR #1777 is part of a phased approach to rename "delegator" terminology to "gas-payer" across the VeChain SDK. The changes are intentionally partial, with remaining occurrences to be addressed in subsequent PRs.
packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-no-value-project/hardhat.config.ts (3)
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-random-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:29:28.678Z
Learning: The renaming of 'delegator' to 'gasPayer' in configuration files is planned for the next refactoring phase of the project.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-default-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:28:09.555Z
Learning: The `delegator` property in hardhat configuration files is planned to be renamed to `gasPayer` in a future BNC refactoring phase. Until then, it contains the `gasPayerPrivateKey` property.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-no-value-project/hardhat.config.ts:32-35
Timestamp: 2025-02-07T16:04:18.593Z
Learning: The parent object `delegator` in hardhat configuration files is intentionally left unchanged during the current BNC refactoring phase, with only its inner properties being renamed (e.g., `delegatorPrivateKey` to `gasPayerPrivateKey`). The parent object will be renamed to `gasPayer` in a future phase.
packages/hardhat-plugin/tests/helpers/provider-helpers.unit.test.ts (3)
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-random-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:29:28.678Z
Learning: The renaming of 'delegator' to 'gasPayer' in configuration files is planned for the next refactoring phase of the project.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-default-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:28:09.555Z
Learning: The `delegator` property in hardhat configuration files is planned to be renamed to `gasPayer` in a future BNC refactoring phase. Until then, it contains the `gasPayerPrivateKey` property.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-no-value-project/hardhat.config.ts:32-35
Timestamp: 2025-02-07T16:04:18.593Z
Learning: The parent object `delegator` in hardhat configuration files is intentionally left unchanged during the current BNC refactoring phase, with only its inner properties being renamed (e.g., `delegatorPrivateKey` to `gasPayerPrivateKey`). The parent object will be renamed to `gasPayer` in a future phase.
packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-random-value-project/hardhat.config.ts (3)
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-random-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:29:28.678Z
Learning: The renaming of 'delegator' to 'gasPayer' in configuration files is planned for the next refactoring phase of the project.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-default-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:28:09.555Z
Learning: The `delegator` property in hardhat configuration files is planned to be renamed to `gasPayer` in a future BNC refactoring phase. Until then, it contains the `gasPayerPrivateKey` property.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-no-value-project/hardhat.config.ts:32-35
Timestamp: 2025-02-07T16:04:18.593Z
Learning: The parent object `delegator` in hardhat configuration files is intentionally left unchanged during the current BNC refactoring phase, with only its inner properties being renamed (e.g., `delegatorPrivateKey` to `gasPayerPrivateKey`). The parent object will be renamed to `gasPayer` in a future phase.
packages/hardhat-plugin/tests/helpers/fixture.ts (3)
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-default-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:28:09.555Z
Learning: The `delegator` property in hardhat configuration files is planned to be renamed to `gasPayer` in a future BNC refactoring phase. Until then, it contains the `gasPayerPrivateKey` property.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-random-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:29:28.678Z
Learning: The renaming of 'delegator' to 'gasPayer' in configuration files is planned for the next refactoring phase of the project.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-no-value-project/hardhat.config.ts:32-35
Timestamp: 2025-02-07T16:04:18.593Z
Learning: The parent object `delegator` in hardhat configuration files is intentionally left unchanged during the current BNC refactoring phase, with only its inner properties being renamed (e.g., `delegatorPrivateKey` to `gasPayerPrivateKey`). The parent object will be renamed to `gasPayer` in a future phase.
packages/hardhat-plugin/tests/hardhat-mock-projects/simple-vechain-hardhat-project/hardhat.config.ts (3)
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-random-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:29:28.678Z
Learning: The renaming of 'delegator' to 'gasPayer' in configuration files is planned for the next refactoring phase of the project.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-default-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:28:09.555Z
Learning: The `delegator` property in hardhat configuration files is planned to be renamed to `gasPayer` in a future BNC refactoring phase. Until then, it contains the `gasPayerPrivateKey` property.
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-no-value-project/hardhat.config.ts:32-35
Timestamp: 2025-02-07T16:04:18.593Z
Learning: The parent object `delegator` in hardhat configuration files is intentionally left unchanged during the current BNC refactoring phase, with only its inner properties being renamed (e.g., `delegatorPrivateKey` to `gasPayerPrivateKey`). The parent object will be renamed to `gasPayer` in a future phase.
packages/hardhat-plugin/src/type-extensions.ts (1)
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1788
File: packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-default-value-project/hardhat.config.ts:0-0
Timestamp: 2025-02-07T15:28:09.555Z
Learning: The `delegator` property in hardhat configuration files is planned to be renamed to `gasPayer` in a future BNC refactoring phase. Until then, it contains the `gasPayerPrivateKey` property.
🪛 markdownlint-cli2 (0.17.2)
apps/sdk-hardhat-integration/README.md
24-24: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms (10)
- GitHub Check: rpc-proxy / test / test
- GitHub Check: unit-integration-test-browser / Build & Lint (latest)
- GitHub Check: unit-integration-test-browser / Build & Lint (lts/*)
- GitHub Check: unit-integration-test-browser / Build & Lint (18)
- GitHub Check: unit-integration-test / Build & Lint (latest)
- GitHub Check: unit-integration-test / Build & Lint (lts/*)
- GitHub Check: unit-integration-test / Build & Lint (18)
- GitHub Check: test-apps / Install and test example apps
- GitHub Check: install-build / Build & Lint
- GitHub Check: Execute doc examples
🔇 Additional comments (16)
packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-no-value-project/hardhat.config.ts (1)
32-35
: LGTM! The configuration property has been correctly renamed.The change from
delegator
togasPayer
aligns with the PR objectives and maintains the same structure withgasPayerPrivateKey
.packages/hardhat-plugin/tests/hardhat-mock-projects/eth_getTransactionCount-random-value-project/hardhat.config.ts (1)
32-35
: LGTM! The configuration property has been correctly renamed.The change from
delegator
togasPayer
is consistent with the previous file and maintains the same structure.packages/hardhat-plugin/src/type-extensions.ts (2)
48-50
: LGTM! Documentation has been updated to reflect new terminology.The parameter descriptions have been correctly updated from
delegatorPrivateKey
anddelegatorUrl
togasPayerPrivateKey
andgasPayerServiceUrl
.
51-51
: LGTM! Interface property has been correctly renamed.The
gasPayer
property maintains the same typeSignTransactionOptions
as the previousdelegator
property, ensuring type compatibility.packages/hardhat-plugin/tests/helpers/provider-helpers.unit.test.ts (1)
30-34
: LGTM! Test cases have been updated to use new terminology.The changes correctly update:
- The method call from
getDelegator
togetGasPayer
- The property access from
networkConfig.delegator
tonetworkConfig.gasPayer
packages/hardhat-plugin/tests/hardhat-mock-projects/simple-vechain-hardhat-project/hardhat.config.ts (1)
32-35
: LGTM! Configuration updates align with the new terminology.The renaming from
delegator
togasPayer
is consistent with the broader SDK terminology changes.Also applies to: 50-50
packages/hardhat-plugin/src/helpers/provider-helper.ts (1)
65-66
: LGTM! Provider helper updates maintain functionality.The property access changes from
delegator
togasPayer
are consistent with the new terminology while preserving the existing functionality.Also applies to: 79-80
packages/hardhat-plugin/tests/simple-vechain-hardhat-project.solo.test.ts (1)
47-47
: LGTM! Test assertions updated correctly.The test assertion has been properly updated to verify the presence of the new
gasPayer
property.apps/sdk-hardhat-integration/hardhat.config.ts (1)
79-101
: LGTM! Network configurations updated comprehensively.The network configurations have been thoroughly updated to use the new
gasPayer
terminology, including:
- Network names
- Configuration properties
- Documentation comments
Also applies to: 106-128, 162-162
packages/hardhat-plugin/tests/helpers/fixture.ts (1)
40-40
: LGTM! Consistent terminology changes.The renaming from "delegator" to "gasPayer" in the test fixtures is consistent with the PR objectives and maintains test coverage for the gas payer functionality.
Also applies to: 76-76, 118-118
packages/aws-kms-adapter/tests/KMSVeChainSigner.solo.test.ts (1)
56-56
: LGTM! Consistent terminology changes in test cases.The renaming of variables and properties from "delegator" to "gasPayer" is consistent and maintains test coverage for the gas payer functionality.
Also applies to: 67-67, 93-102
packages/aws-kms-adapter/src/KMSVeChainSigner.ts (1)
19-20
: LGTM! Clean implementation of gas payer functionality.The constructor and property changes are well-structured and maintain clear separation between the provider and service URL options.
Also applies to: 24-27, 43-58
localstack/init/kms.sh (1)
5-5
: LGTM! Changes align with the new terminology.The renaming from "delegator" to "gas payer" is consistent with the PR objectives.
Also applies to: 13-14
apps/sdk-hardhat-integration/README.md (1)
24-24
: LGTM! Parameter names align with the new terminology.The renaming of parameters from
delegatorPrivateKey
anddelegatorUrl
togasPayerPrivateKey
andgasPayerServiceUrl
is consistent with the PR objectives.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
24-24: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
packages/aws-kms-adapter/README.md (2)
10-10
: LGTM! Clear feature description.The feature description accurately reflects the new "gasPayer" terminology, maintaining consistency with the SDK's updated naming conventions.
237-249
: LGTM! Clear URL-based gasPayer example.The example effectively demonstrates URL-based gasPayer configuration, and the comments clearly explain the limitations regarding address retrieval.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Luca Nicola Debiasi <63785793+lucanicoladebiasi@users.noreply.github.com>
Signed-off-by: Luca Nicola Debiasi <63785793+lucanicoladebiasi@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CodeRabbit objects not all delegator
references are renamed gasPayer
: the rabbit is missing the few documented exceptions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/sdk-hardhat-integration/README.md (1)
24-24
: Fix the bullet point indentation.The bullet point indentation is incorrect. According to markdownlint, it should be 2 spaces instead of 3.
Apply this diff to fix the indentation:
- - **Gas Payer**: The `gasPayer` field allows you to delegate the transaction to a gasPayer. It supports two optional parameters: `gasPayerPrivateKey` and `gasPayerServiceUrl`. + - **Gas Payer**: The `gasPayer` field allows you to delegate the transaction to a gasPayer. It supports two optional parameters: `gasPayerPrivateKey` and `gasPayerServiceUrl`.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
24-24: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
apps/sdk-hardhat-integration/README.md
(1 hunks)packages/aws-kms-adapter/README.md
(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/aws-kms-adapter/README.md
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: lucanicoladebiasi
PR: vechain/vechain-sdk-js#1777
File: packages/errors/src/available-errors/transaction/transaction.ts:33-33
Timestamp: 2025-01-30T17:15:49.377Z
Learning: PR #1777 is part of a phased approach to rename "delegator" terminology to "gas-payer" across the VeChain SDK. The changes are intentionally partial, with remaining occurrences to be addressed in subsequent PRs.
🪛 markdownlint-cli2 (0.17.2)
apps/sdk-hardhat-integration/README.md
24-24: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
🔇 Additional comments (1)
apps/sdk-hardhat-integration/README.md (1)
24-24
: LGTM! The terminology update looks good.The documentation has been successfully updated to use the new "gasPayer" terminology, which aligns with the PR objectives. The parameters
gasPayerPrivateKey
andgasPayerServiceUrl
are clearly documented.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
24-24: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
Description
The "delegator" is substituted with the "gas payer" terminology.
This is the last part of the four stages needed to rename coherently the SDK:
origin
;gasPayer
.The interface
TransactionsExpandedBlockDetail
atpackages/network/src/thor-client/blocks/types.d.ts
keeps the propertydelegator
to adhere to the structure of theExpandedBlockResponse
of the Thor end-point Retrieve a block with URI query set as?expanded=true
.The interface
TransactionsExpandedBlockDetail
represents the response of the named end-point exposing the propertygasPayer
to express the address of the sponsor of the transaction, either the propertyorigin
ordelegator
of the interface.Fixes # BNC
Type of change
Please delete options that are not relevant.
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:solo
Test Configuration:
Summary by CodeRabbit
Summary by CodeRabbit