feat: Onchain Identifier via transaction `data` and `calldata` fields #1059

DaniSomoza · 2024-11-24T20:53:24Z

What it solves

Resolves #1056

How this PR fixes it

Append the on chain identifier to the transaction data field and in the calldata field

Examples

Chain: Sepolia

Safe deployment of a Safe Account (`v1.3.0`) in Sepolia using the `protocol-kit`

Safe Deployed: 0x096B2222AE1600D0074d35a8A6BC58FF04AB2384

Transaction Hash: 0xe0192eedd1fc2d06be0561d57380d610dd6d162af0f3cfbd6c08f9062d738761

On-chain Identifier: 5afe006363643438383836663461336661366162653539646561393238653366

Metadata included in the On-chain Identifier:

Identifier Prefix: 5afe
Identifier Version 00
Project: Test Dapp SDK hashed: 6363643438383836663461336661366162653539
Platform: Web: hashed: 646561
Tool: protocol-kit: hashed: 393238
Tool version: 5.0.4: hashed: 653366

Safe transaction of a Safe Account (`v1.3.0`) in Sepolia using the `protocol-kit`

Safe used: 0x096B2222AE1600D0074d35a8A6BC58FF04AB2384

the transaction is a rejection tx.

Transaction Hash: 0x0256ef4a2e21c5b529c2b60b3e48327261508d685a24e331788e2ee64275f9b0

On-chain Identifier: 5afe006363643438383836663461336661366162653539646561393238653366

Metadata included in the On-chain Identifier:

Identifier Prefix: 5afe
Identifier Version 00
Project: Test Dapp SDK hashed: 6363643438383836663461336661366162653539
Platform: Web: hashed: 646561
Tool: protocol-kit: hashed: 393238
Tool version: 5.0.4: hashed: 653366

Safe deployment + batch of transactions of a 4337 Safe Account (`v1.4.1`) in Sepolia using the `relay-kit`

Safe used: 0xf5E1c84b12763A70c79679ad00d34F0769Be57Cb

the transaction is a deployment of the Safe and a batch of 2 USDC transfers (amount: 0.01 USDC).

Transaction Hash: 0xd8a1a85c7b5ecffe62ba17d02d40f76043566beacb291279aef18242068e1a35

Transaction jiffyscan Link: https://jiffyscan.xyz/userOpHash/0xe1bd646760cf53f0332fec03ef4c094d8132462b1a4258069d7fa8ff08b96657?network=sepolia

On-chain Identifier: 5afe006363643438383836663461336661366162653539646561393063666133

Metadata included in the On-chain Identifier:

Identifier Prefix: 5afe
Identifier Version 00
Project: Test Dapp SDK hashed: 6363643438383836663461336661366162653539
Platform: Web: hashed: 646561
Tool: relay-kit: hashed: 393063
Tool version: 3.2.4: hashed: 666133

coveralls · 2024-11-24T20:57:17Z

Pull Request Test Coverage Report for Build 12254974241

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

7 of 12 (58.33%) changed or added relevant lines in 2 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.3%) to 75.199%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
packages/relay-kit/src/packs/safe-4337/utils/getRelayKitVersion.ts	2	3	66.67%
packages/relay-kit/src/packs/safe-4337/Safe4337Pack.ts	5	9	55.56%

Totals
Change from base Build 12008934309:	-0.3%
Covered Lines:	795
Relevant Lines:	985

💛 - Coveralls

yagopv · 2024-12-02T09:58:59Z

packages/protocol-kit/src/utils/on-chain-tracking/generateOnChainIdentifier.ts

+
+/**
+ * Generates an on-chain identifier for tracking transactions on the blockchain.
+ * This identifier includes hased metadata such as the project name, platform, tool, and tool version.


Suggested change

* This identifier includes hased metadata such as the project name, platform, tool, and tool version.

* This identifier includes hashed metadata such as the project name, platform, tool, and tool version.

yagopv · 2024-12-02T10:01:21Z

packages/protocol-kit/src/Safe.ts

-    const { provider, signer, isL1SafeSingleton, contractNetworks } = config
+    const { provider, signer, isL1SafeSingleton, contractNetworks, onchainAnalitics } = config
+
+    if (onchainAnalitics?.project) {


Protocol Kit Version is hardcoded here 🙃

done! I added a getProtocolKitVersion and a getRelayKitVersion to automatically get the version of the package from the package.json

yagopv · 2024-12-02T10:06:44Z

packages/protocol-kit/src/Safe.ts

+    const safeDeploymentBatch = await this.createTransactionBatch(
+      transactions,
+      transactionOptions,
+      true // include the on chain identifier


I don't understand this. Why including it explicetely? If the private variable exists then we can include it right?

It’s because we don’t always know where the batch created with the createTransactionBatch function will be used. Automatically appending the trackId could cause issues in transactions that aren’t meant to be executed directly.

yagopv · 2024-12-02T10:08:21Z

packages/relay-kit/src/packs/safe-4337/types.ts

@@ -50,6 +54,8 @@ export type Safe4337InitOptions = {
  }
  options: ExistingSafeOptions | PredictedSafeOptions
  paymasterOptions?: PaymasterOptions
+  // on-chain analitics


The variable name does the same as the comment right? and the other props has no comments

true, removed! 🙏

yagopv · 2024-12-02T10:08:36Z

packages/relay-kit/src/packs/safe-4337/types.ts

@@ -61,6 +67,8 @@ export type Safe4337Options = {
  entryPointAddress: string
  safe4337ModuleAddress: string
  safeWebAuthnSharedSignerAddress?: string
+  // on-chain analitics


Same as above

true, removed! 🙏

yagopv · 2024-12-02T10:12:11Z

playground/protocol-kit/deploy-safe.ts

@@ -22,7 +27,7 @@ interface Config {

 const config: Config = {
  RPC_URL: sepolia.rpcUrls.default.http[0],
-  DEPLOYER_ADDRESS_PRIVATE_KEY: '<DEPLOYER_ADDRESS_PRIVATE_KEY>',
+  DEPLOYER_ADDRESS_PRIVATE_KEY: SIGNER_ADDRESS_PRIVATE_KEY!,


Why this comming from the dotenv while the other playgrounds don't. I will address this in a separate PR if it's necessary and align all playgrounds

yagopv · 2024-12-02T10:12:46Z

packages/relay-kit/src/packs/safe-4337/Safe4337Pack.ts

+        onchainAnalitics.project,
+        onchainAnalitics.platform,
+        'relay-kit',
+        '3.2.4'


Hardcoded version ? Should be coming from package.json

done! I added a getProtocolKitVersion and a getRelayKitVersion to automatically get the package version from the package.json

yagopv · 2024-12-02T10:14:20Z

packages/relay-kit/src/packs/safe-4337/Safe4337Pack.ts

+  getOnchainIdentifier(): string {
+    return this.#onchainIdentifier
+  }


This can be probably this.protocolKit.getOnchainIdentifier right?

the onchainIdentifier set in the protocol-kit is different from the one in the relay-kit.

That’s why we need separate functions for each, like protocolKit.getOnchainIdentifier and relayKit.getOnchainIdentifier

the tool and toolVersion used to generate the identifier are different for each case.

germartinez · 2024-12-09T12:07:16Z

packages/protocol-kit/src/utils/on-chain-tracking/generateOnChainIdentifier.ts

+ * @param {string} toolVersion - The version of the tool used to generate the transaction.
+ * @returns {string} A string representing the on-chain identifier, composed of multiple hashed segments.
+ */
+function generateOnChainIdentifier(


Just a small suggestion. Could this function receive an object instead? It would allow to share more understandable code snippets in the docs.

generateOnChainIdentifier({ project: 'asdfasdf', // ... })

better than

generateOnChainIdentifier('asdfasdf', ...)

generateOnChainIdentifier function updated to accept an object as suggested sir 🫡

Thanks!

…R feedback.

append the on chain trackId to the transaction data field

c005852

DaniSomoza mentioned this pull request Nov 25, 2024

Onchain trackid via paymentReceiver & refundReceiver #1057

Closed

yagopv linked an issue Nov 25, 2024 that may be closed by this pull request

[Onchain tracking] PoC #1056

Closed

DaniSomoza changed the title ~~Onchain trackid via transaction data field~~ Onchain indentifier via transaction data and calldata fields Nov 28, 2024

DaniSomoza added 6 commits November 28, 2024 14:03

add new onchain identifier format to track transactions

c22aa95

fix On-chain analytics e2e tests

d96eca4

restored playground file

f0057b8

remove PIMLICO_API_KEY from playground

96704bb

restored playground files

7de2f15

Merge branch 'development' into onchain-trackid-data

642ccf5

DaniSomoza changed the title ~~Onchain indentifier via transaction data and calldata fields~~ feat: Onchain Identifier via transaction data and calldata fields Nov 28, 2024

DaniSomoza requested a review from yagopv November 28, 2024 14:01

use toHex instead of Buffer.from in generateHash

851e75e

This was referenced Dec 2, 2024

[Onchain tracking] Implementation #1062

Open

[Onchain tracking] PoC #1056

Closed

yagopv linked an issue Dec 2, 2024 that may be closed by this pull request

[Onchain tracking] Implementation #1062

Open

yagopv reviewed Dec 2, 2024

View reviewed changes

germartinez reviewed Dec 9, 2024

View reviewed changes

DaniSomoza mentioned this pull request Dec 9, 2024

[Onchain tracking] complete Onchain Tracking Solution Implementation #1071

Open

Updated generateOnChainIdentifier to accept an object and addressed P…

a80d468

…R feedback.

DaniSomoza requested review from germartinez and yagopv December 10, 2024 11:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Onchain Identifier via transaction `data` and `calldata` fields #1059

feat: Onchain Identifier via transaction `data` and `calldata` fields #1059

DaniSomoza commented Nov 24, 2024 •

edited

Loading

coveralls commented Nov 24, 2024 •

edited

Loading

yagopv Dec 2, 2024

DaniSomoza Dec 10, 2024

yagopv Dec 2, 2024

DaniSomoza Dec 10, 2024

yagopv Dec 2, 2024

DaniSomoza Dec 10, 2024

yagopv Dec 2, 2024

DaniSomoza Dec 10, 2024

yagopv Dec 2, 2024 •

edited

Loading

DaniSomoza Dec 10, 2024

yagopv Dec 2, 2024

DaniSomoza Dec 10, 2024

yagopv Dec 2, 2024

DaniSomoza Dec 10, 2024

yagopv Dec 2, 2024

DaniSomoza Dec 10, 2024 •

edited

Loading

germartinez Dec 9, 2024

DaniSomoza Dec 10, 2024

	* This identifier includes hased metadata such as the project name, platform, tool, and tool version.
	* This identifier includes hashed metadata such as the project name, platform, tool, and tool version.

feat: Onchain Identifier via transaction data and calldata fields #1059

Are you sure you want to change the base?

feat: Onchain Identifier via transaction data and calldata fields #1059

Conversation

DaniSomoza commented Nov 24, 2024 • edited Loading

What it solves

How this PR fixes it

Examples

Safe deployment of a Safe Account (v1.3.0) in Sepolia using the protocol-kit

Safe transaction of a Safe Account (v1.3.0) in Sepolia using the protocol-kit

Safe deployment + batch of transactions of a 4337 Safe Account (v1.4.1) in Sepolia using the relay-kit

coveralls commented Nov 24, 2024 • edited Loading

Pull Request Test Coverage Report for Build 12254974241

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yagopv Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaniSomoza Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat: Onchain Identifier via transaction `data` and `calldata` fields #1059

feat: Onchain Identifier via transaction `data` and `calldata` fields #1059

DaniSomoza commented Nov 24, 2024 •

edited

Loading

Safe deployment of a Safe Account (`v1.3.0`) in Sepolia using the `protocol-kit`

Safe transaction of a Safe Account (`v1.3.0`) in Sepolia using the `protocol-kit`

Safe deployment + batch of transactions of a 4337 Safe Account (`v1.4.1`) in Sepolia using the `relay-kit`

coveralls commented Nov 24, 2024 •

edited

Loading

yagopv Dec 2, 2024 •

edited

Loading

DaniSomoza Dec 10, 2024 •

edited

Loading