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

Add EIP-1884 support for Istanbul #581

Merged
merged 1 commit into from
Aug 29, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Add EIP-1884 support for Istanbul
  • Loading branch information
s1na committed Aug 29, 2019
commit 56350e1f22536207e3de7da3a14f83871afd4005
7 changes: 7 additions & 0 deletions lib/evm/eei.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,13 @@ export default class EEI {
return new BN(account.balance)
}

/**
* Returns balance of self.
*/
getSelfBalance(): BN {
return new BN(this._env.contract.balance)
}

/**
* Returns caller address. This is the address of the account
* that is directly responsible for this execution.
Expand Down
7 changes: 7 additions & 0 deletions lib/evm/opFns.ts
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,13 @@ export const handlers: { [k: string]: OpHandler } = {

runState.stack.push(runState.eei.getChainId())
},
SELFBALANCE: function(runState: RunState) {
if (!runState._common.gteHardfork('istanbul')) {
trap(ERROR.INVALID_OPCODE)
}

runState.stack.push(runState.eei.getSelfBalance())
},
// 0x50 range - 'storage' and execution
POP: function(runState: RunState) {
runState.stack.pop()
Expand Down
4 changes: 4 additions & 0 deletions lib/evm/opcodes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,11 @@ let codes: any = {
}

const istanbulOpcodes: any = {
0x31: ['BALANCE', 700, true],
0x3f: ['EXTCODEHASH', 700, true],
0x46: ['CHAINID', 2, false],
0x47: ['SELFBALANCE', 5, false],
0x54: ['SLOAD', 800, true],
Copy link
Member

Choose a reason for hiding this comment

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

Hmm, this breaks with the concept of having gas price changes collected in the Common library (e.g. for SLOAD), I only expected the Istanbul opcode list to include the newly introduced opcodes (SELFBALANCE).

For the moment this would introduce a lot of inconsistency - we also have added other gas price changes for Istanbul in the istanbul.json file.

Do you have a bigger plan for a complete transition here respectively a strong reasoning for this break apart? Otherwise I would very much suggest we add the price changes to the Common library.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, I didn't know the base cost of opcodes are also updated in Common (in addition to extra gas parameters like ecAdd). If that has been the intention, there's no corresponding code in the VM to read those base gas costs from Common:

https://github.com/ethereumjs/ethereumjs-vm/blob/edffcde9696283799efc4ab17d0c3e481618c727/lib/evm/interpreter.ts#L105-L112

If we want to keep base gas costs in Common we'd have to:

  • Make sure costs for all opcodes are in Common (not the case now, searching swap in ethereumjs-common returned empty)
  • Remove them from opcodes.ts to only have one source of truth
  • Modify Interpreter to read costs from Common

Copy link
Member

Choose a reason for hiding this comment

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

Hmm, maybe we are talking side by side a bit? What is with SLOAD e.g. - the EIP is stating that this is changing gas costs from 200 to 800 - and the 200 price is just "normally" defined in the tangerine whistle json file in the Common library (see link above).

This is just a "normal" gas price change, isn't it?

Copy link
Member

Choose a reason for hiding this comment

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

Ah, just had another look. See the point, these gas costs are not taken by Common at all atm. Maybe this is just more of some inconsistency/incompleteness in the Common library.

Anyhow, you are right. Will approve here.

}

export function setOpcodes(hf: string) {
Expand Down
44 changes: 44 additions & 0 deletions tests/api/istanbul/eip-1884.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
const tape = require('tape')
const BN = require('bn.js')
const Common = require('ethereumjs-common').default
const VM = require('../../../dist/index').default
const PStateManager = require('../../../dist/state/promisified').default
const { ERROR } = require('../../../dist/exceptions')
const { createAccount } = require('../utils')

const testCases = [
{ chain: 'mainnet', hardfork: 'istanbul', selfbalance: '0xf1' },
{ chain: 'mainnet', hardfork: 'constantinople', err: ERROR.INVALID_OPCODE }
]

// SELFBALANCE PUSH8 0x00 MSTORE8 PUSH8 0x01 PUSH8 0x00 RETURN
const code = ['47', '60', '00', '53', '60', '01', '60', '00', 'f3']
tape('Istanbul: EIP-1884: SELFBALANCE', async (t) => {
const addr = Buffer.from('00000000000000000000000000000000000000ff', 'hex')
const runCodeArgs = {
code: Buffer.from(code.join(''), 'hex'),
gasLimit: new BN(0xffff),
address: addr
}

for (const testCase of testCases) {
const common = new Common(testCase.chain, testCase.hardfork)
const vm = new VM({ common })
const state = new PStateManager(vm.stateManager)
const account = createAccount('00', testCase.selfbalance)
await state.putAccount(addr, account)
try {
const res = await vm.runCode(runCodeArgs)
if (testCase.err) {
t.equal(res.exceptionError.error, testCase.err)
} else {
t.assert(res.exceptionError === undefined)
t.assert(new BN(Buffer.from(testCase.selfbalance.slice(2), 'hex')).eq(new BN(res.returnValue)))
}
} catch (e) {
t.fail(e.message)
}
}

t.end()
})