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

[API] Show computation costs to StructLog transaction trace #2090

Merged
merged 6 commits into from
Jan 18, 2024

Conversation

hyunsooda
Copy link
Contributor

Proposed changes

Added two fields, computationCostTotal and computationCostUsed in debug.trace* APIs.

> debug.traceTransaction("0x58c1096e91560a0aae81332241168d1515729d29098e6899dcb22804ef1635a9")
{
  failed: false,
  gas: 21546,
  returnValue: "000000000000000000000000000000000000000000000000000000000000007b",
  structLogs: [{
      computationCostTotal: 150000000,
      computationCostUsed: 120,
      gas: 146,
      gasCost: 3,
      ...
  }, {
      computationCostTotal: 150000000,
      computationCostUsed: 310,
      gas: 143,
      gasCost: 3,
      memory: [],
      op: "DUP1",
      ...
  }, 
  ...

Types of changes

Please put an x in the boxes related to your change.

  • Bugfix
  • New feature or enhancement
  • Others

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING GUIDELINES doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes ($ make test)
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Related issues

  • Please leave the issue numbers or links related to this PR here.

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

@hyunsooda
Copy link
Contributor Author

@blukat29,

Consider removing the Computation field from the StructLog struct to reduce its size. This value can be derived within the loop as ComputationCostLimit - OpcodeCC. Let me know if this approach is acceptable.

@blukat29
Copy link
Contributor

@hyunsooda But the computation field is not Limit - opcodeCC, it's ComputationCostLimit - ComputationCostSum. It's inconvenient to sum up all opcodeCCs from the trace.

@hyunsooda
Copy link
Contributor Author

The calculation is equivalent to accumulating from the limit to each step's opcode CC, and this can be accomplished simply by

+ sum := cc
   for index, trace := range logs {
      if logTimeout {
          return nil, fmt.Errorf("trace logger timeout")
      }
+     sum -= trace.ComputationCost
      formatted[index] = StructLogRes{

Initially, I hesitated to implement this change, fearing it might compromise readability. However, I highlighted its value considering the memory-saving benefits, contingent on the number of StructLog instances instantiated.

@blukat29 blukat29 changed the title [API] Added new two fields, computationCostTotal and computationCostUsed [API] Show computation costs to StructLog transaction trace Jan 16, 2024
blockchain/vm/logger.go Outdated Show resolved Hide resolved
api/api_public_blockchain.go Outdated Show resolved Hide resolved
@hyunsooda hyunsooda merged commit 5786095 into klaytn:dev Jan 18, 2024
11 checks passed
@blukat29 blukat29 mentioned this pull request Jan 22, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants