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

Update dependency @polkadot/api to v12 #233

Merged
merged 1 commit into from
Jun 28, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jun 25, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@polkadot/api (source) ^11.3.1 -> ^12.0.2 age adoption passing confidence

Release Notes

polkadot-js/api (@​polkadot/api)

v12.0.2

Compare Source

Important Changes:

  • withSignedTransaction: This option has been added to SignerOptions. When using signAndSend, signAsync, and dryRun you may now enable or disable the use of the signedTransaction field by adding the withSignedTransaction option. When withSignedTransaction is not enabled but the signer adds a signedTransaction the api will error.
    • Always disabled by default.
    • This ensures no big breaking changes happen to the interface of signPayload.
    • withSignedTransaction has also been added to the SignerPayload type which allows for payload.toPayload() to include the option.
  • signAsync: now accepts the signedTransaction field as well. This means that if withSignedTransaction is enabled, and signedTransaction is present the api will adjust the current payload attached to the SubmittableExtrinsic, and add the signature. Then the user can call .send() as they please.
  • dryRun: All steps will be the same as signAsync with the exception that .send() has never needed to be called.

Contributed:

v12.0.1

Compare Source

Important Changes:

  • Addition of an optional signedTransaction field to the SignerResult response for injected signers. This only applies to the signPayload method exposed in the Signer interface for polkadot-js. As the name suggests the field expects a signed transaction (extrinsic) when inputted. When its present, the api will not add the signature to the payload, but instead broadcast the inputted signed transaction. This means the signer may modify the payload it's given. The only part of the payload that may not be modified is the call data. This is verified on the api, and will throw an error if it does not match the initial payloads call data.
    • This is very useful for signers that want to adjust the mode and metadataHash field for the CheckMetadataHash signed extension.
    • Note that this is not your traditional breaking change since it more-so acts as an addition, but since this is a high magnitude change it is going to be considered a MAJOR bump.
    • For more info please review the following PR (#​5914)

Changes:

  • Replace system_accountNextIndex with runtime api call accountNonceApi for api.derive.tx.signingInfo
  • Sanitize eras for api.derive.staking._stakerRewards

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from a team as a code owner June 25, 2024 03:06
@renovate renovate bot force-pushed the renovate/polkadot-api-12.x branch from c2e292e to a9b6547 Compare June 27, 2024 22:35
@mattdean-digicatapult mattdean-digicatapult merged commit a1d7000 into main Jun 28, 2024
6 checks passed
@mattdean-digicatapult mattdean-digicatapult deleted the renovate/polkadot-api-12.x branch June 28, 2024 07:38
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.

1 participant