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.

Sign up for GitHub

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

Jump to bottom

Fix Sign Transaction Signature #125

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
+998 −169
Open

Fix Sign Transaction Signature #125

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
24c3020
fix: change body bytes to sign
MiguelLZPF May 6, 2024
7725c6e
fix: test sign transaction
MiguelLZPF May 6, 2024
35b0d58
fix: removed unused AccountId
MiguelLZPF May 6, 2024
a47c21d
Merge branch 'main' into fix/sign-transaction-signature
tmctl May 20, 2024
a20ba76
fix: remove irrelevant comment
MiguelLZPF May 28, 2024
9a3a23d
Merge branch 'main' into fix/sign-transaction-signature
MiguelLZPF May 28, 2024
6382906
fix: main branch change test
MiguelLZPF May 28, 2024
f46d34f
Merge branch 'main' into fix/sign-transaction-signature
MiguelLZPF Jul 29, 2024
b9e1e0d
feat: get latest changes from main & minor changes
MiguelLZPF Jul 29, 2024
5259eb5
Merge remote-tracking branch 'upstream/main' into fix/sign-transactio…
MiguelLZPF Sep 19, 2024
85cd2b4
feat: add separate function to get the SIGNED transaction body
MiguelLZPF Sep 19, 2024
fbc74d5
fix: revert last commit 85cd2b435fb4a9a3bd2595491a9f2c24ae175242
MiguelLZPF Sep 24, 2024
9a5dd89
Merge remote-tracking branch 'upstream/main' into fix/sign-transactio…
MiguelLZPF Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions src/lib/shared/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,17 +98,14 @@ export function base64StringToTransaction<T extends Transaction>(transactionByte
* @param transaction - a base64 encoded string of proto.TransactionBody.encode().finish()
* @returns `string`
* */
export function transactionToTransactionBody<T extends Transaction>(
transaction: T,
nodeAccountId: AccountId,
) {
export function transactionToTransactionBody<T extends Transaction>(transaction: T) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm uncomfortable changing the signature of a public method, this could result in a breaking change to existing implementations.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this implementation should remain and Signer.ts changed from

    const transactionBody: proto.TransactionBody = transactionToTransactionBody(
      transaction,
      this._getRandomNodes(1)[0],
    )

to re-using the nodeAccountId from transaction (if that's possible) ?

This would no longer be a breaking change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback! 🙂

From our testing and research, the method used in this PR is the only way to get the signed transaction validated by the Hedera network. The previous approach signed the transaction in a way that the Hedera Network couldn't verify.

That said, we can leave the nodeAccountId parameter for compatibility, although it's currently unused and likely not functional in its previous form. @gregscullard, should I include the nodeAccountId as you suggested?

If there is a better method to obtain the signed transaction bytes than the one used in this PR, please let me know. Based on our testing a few weeks ago, this was the only approach that worked.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll leave it to the community of builders/users to determine whether a breaking change in the signature of the transaction is acceptable or not. The change is minor and would likely be implemented as a result of changes to the application, so tested and working before deployed. Breaking but not critically so I guess.

// This is a private function, though provides the capabilities to construct a proto.TransactionBody
//@ts-ignore
return transaction._makeTransactionBody(nodeAccountId)
return transaction._signedTransactions.get(0)!.bodyBytes!
}

export function transactionBodyToBase64String(transactionBody: proto.TransactionBody) {
return Uint8ArrayToBase64String(proto.TransactionBody.encode(transactionBody).finish())
export function transactionBodyToBase64String(transactionBody: Uint8Array) {
return Uint8ArrayToBase64String(transactionBody)
}

/**
Expand Down
4 changes: 2 additions & 2 deletions test/dapp/DAppConnector.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
*
*/

import { AccountId, AccountInfoQuery, LedgerId, TopicCreateTransaction } from '@hashgraph/sdk'
import { AccountInfoQuery, LedgerId, TopicCreateTransaction } from '@hashgraph/sdk'
import {
DAppConnector,
ExecuteTransactionParams,
Expand Down Expand Up @@ -295,7 +295,7 @@ describe('DAppConnector', () => {
signerAccountId: testUserAccountId.toString(),
transactionBody: transactionBodyToBase64String(
// must specify a node account id for the transaction body
transactionToTransactionBody(transaction, AccountId.fromString('0.0.3')),
transactionToTransactionBody(transaction),
MiguelLZPF marked this conversation as resolved.
Show resolved Hide resolved
),
}

Expand Down
7 changes: 2 additions & 5 deletions test/wallet/methods/wallet-signTransaction.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
*
*/

import { TransferTransaction, AccountId, Hbar } from '@hashgraph/sdk'
import { TransferTransaction, Hbar } from '@hashgraph/sdk'
import {
HederaChainId,
SignTransactionResponse,
Expand Down Expand Up @@ -49,10 +49,7 @@ describe(Wallet.name, () => {
.setMaxTransactionFee(new Hbar(1))
.addHbarTransfer('0.0.123', new Hbar(10))
.addHbarTransfer('0.0.321', new Hbar(-10))
const transactionBody = transactionToTransactionBody(
transaction,
AccountId.fromString('0.0.3'),
)
const transactionBody = transactionToTransactionBody(transaction)
const respondSessionRequestSpy = jest.spyOn(wallet, 'respondSessionRequest')

const response = await wallet.hedera_signTransaction(
Expand Down
Loading