v2.6.0 - Candy-Covered Cactus Pretzel Rods 🍬🌵🥨

 Highlights    How to Upgrade    Changelog    Related Releases 

---

We're moving to a beta › latest release pipeline, where all non-hotfix changes are first released in a beta before being promoted to a stable release.

We'd love it if you'd start using the latest betas and let us know early and often if you find any bugs or regressions!

Highlights

First of all, Candy-Covered Cactus Pretzel Rods is a real thing. Google it.

Secondly, this version of ganache-core introduces a new feature: eth_chainId (finally)! eth_chainId is currently hard-coded to return 1337; we'll be making this value configurable in a future release. We've also got some bug fixes related to forking in this release as well.

---

In case you missed it, we're holding TruffleCon 2019 August 2 - 4 at Microsoft's campus in Redmond, WA! And it'll be awesome. You should be there.

 Get Tickets (only $99!)  

---

How to Upgrade

Upgrade to the latest version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@latest

yarn

yarn remove ganache-core
yarn add ganache-core@latest

Changelog

Features

• Added eth_chainId (#419) – @tcichowicz

Bug Fixes

• Fix eth_getStorageAt in a forked chain (#438) – @niklasb

Maintenance

• Update README.md (#437) – @nicholasjpaterno
• docs: add example for accessing a server's provider (#403) – @lopezjurip

Related Releases

• ganache-cli v6.5.0
• Ganache UI v2.1.

---

💖 The Truffle Team

v2.5.8-beta.0 - Candy-Covered Cactus Pretzel Rods 🍬🌵🥨

 Highlights    How to Upgrade    Changelog    Related Releases 

---

We're moving to a beta › latest release pipeline, where all non-hotfix changes are first released in a beta before being promoted to a stable release.

We'd love it if you'd start using the latest betas and let us know early and often if you find any bugs or regressions!

Highlights

First of all, Candy-Covered Cactus Pretzel Rods are a real thing. Google it.

Secondly, this version of ganache-core beta introduces a new feature: eth_chainId (finally)! eth_chainId is currently hard-coded to return 1337; we'll be making this value configurable in a future release. We've also got some bug fixes related to forking in this release as well.

Note: this beta release should have been released as a new semver-minor update, but wasn't (sorry). So the stable version will be released as 2.6.0.

---

In case you missed it, we're holding TruffleCon 2019 August 2 - 4 at Microsoft's campus in Redmond, WA! And it'll be awesome. You should be there.

 Get Tickets (only $99!)  

---

How to Upgrade

Upgrade to the latest beta version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@beta

yarn

yarn remove ganache-core
yarn add ganache-core@beta

Changelog

Features

• Added eth_chainId (#419) – @tcichowicz

Bug Fixes

• Fix eth_getStorageAt in a forked chain (#438) – @niklasb

Maintenance

• Update README.md (#437) – @nicholasjpaterno
• docs: add example for accessing a server's provider (#403) – @lopezjurip

Related Releases

• ganache-cli v6.4.6-beta.0
• Ganache UI v2.0.4-beta.0

---

💖 The Truffle Team

v2.5.7 - Banana Pudding 🍌

 Highlights    How to Upgrade    Changelog    Related Releases 

---

We're moving to a beta › latest release pipeline, where all non-hotfix changes are first released in a beta before being promoted to a stable release.

We'd love it if you'd start using the latest betas and let us know early and often if you find any bugs or regressions!

Highlights

This version of ganache-core features the latest and greatest gas exactimation algorithm. While the previous algorithm works well in most cases and was heavily tested, it relied on several assumptions we later found to be incorrect. Gas exactimation 2.0 now makes ZERO assumptions, and returns an exactimation in O(1), compared with O(log n) in geth, parity, etc!

Some notable improvements you might like:

• Completely rewritten without recursion
• Approximately 20% faster and 33% less code
• Works with CREATE2

Stay tuned for a full featured blog post explaining the algorithm and a "Deep Dive" workshop at TruffleCon 2019!

---

In case you missed it, we're holding TruffleCon 2019 August 2 - 4 at Microsoft's campus in Redmond, WA! And it'll be awesome. You should be there.

 Get Tickets (only $99!)  

---

How to Upgrade

Upgrade to the latest version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@latest

yarn

yarn remove ganache-core
yarn add ganache-core@latest

Changelog

Bug Fixes

• Fix and optimize gas estimation algorithm (#435) – @nicholasjpaterno

Maintenance

• Update nyc (cc5b0ed) – @davidmurdoch
• Fix webpack replacement of 'scrypt' with 'js-scrypt'. (#426) – @markspanbroek
• bump ethereumjs-wallet (#424) – @andremedeiros

Related Releases

• ganache-cli v6.4.5
• Ganache UI v2.0.3

---

💖 The Truffle Team

v2.5.7-beta.0 - Banana Pudding 🍌

 Highlights    How to Upgrade    Changelog    Related Releases 

---

We're moving to a beta › latest release pipeline, where all non-hotfix changes are first released in a beta before being promoted to a stable release.

We'd love it if you'd start using the latest betas and let us know early and often if you find any bugs or regressions!

Highlights

This version of ganache-core features the latest and greatest gas exactimation algorithm. While the previous algorithm works well in most cases and was heavily tested, it relied on several assumptions we later found to be incorrect. Gas exactimation 2.0 now makes ZERO assumptions, and returns an exactimation in O(1), compared with O(log n) in geth, parity, etc!

Some notable improvements you might like:

• Completely rewritten without recursion
• Approximately 20% faster and 33% less code
• Works with CREATE2

Stay tuned for a full featured blog post explaining the algorithm and a "Deep Dive" workshop at TruffleCon 2019!

---

In case you missed it, we're holding TruffleCon 2019 August 2 - 4 at Microsoft's campus in Redmond, WA! And it'll be awesome. You should be there.

 Get Tickets (only $99!)  

---

How to Upgrade

Upgrade to the latest beta version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@beta

yarn

yarn remove ganache-core
yarn add ganache-core@beta

Changelog

Bug Fixes

• Fix and optimize gas estimation algorithm (#435) – @nicholasjpaterno

Maintenance

• Update nyc (cc5b0ed) – @davidmurdoch
• Fix webpack replacement of 'scrypt' with 'js-scrypt'. (#426) – @markspanbroek
• bump ethereumjs-wallet (#424) – @andremedeiros

Related Releases

• ganache-cli v6.4.5-beta.0
• Ganache UI v2.0.3-beta.0

---

💖 The Truffle Team

v2.5.6 - ✨ Mystery Flavor ✨

 Highlights    How to Upgrade    Changelog    Related Releases 

---

We're moving to a beta › latest release pipeline, where all non-hotfix changes are first released in a beta before being promoted to a stable release.

We'd love it if you'd start using the latest betas and let us know early and often if you find any bugs or regressions!

Highlights

Forked transactions have been fixed before, but the previous fix didn't get all the bugs, and the fix before that had to be reverted due to unwanted side effects. We've created a monster. The fix is back, back again, tell a friend!

We've also add support for binary data over websockets, updated eth-sig-util to fix a global variable leak, and fixed some other bugs, too!

---

In case you missed it, we're holding TruffleCon 2019 August 2 - 4 at Microsoft's campus in Redmond, WA! And it'll be awesome. You should be there.

 Get Tickets  

---

How to Upgrade

Upgrade to the latest version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@latest

yarn

yarn remove ganache-core
yarn add ganache-core@latest

Changelog

Bug Fixes

• Fix forked transaction trace storage (again) so it doesn't crash anymore (#420) – @davidmurdoch
• Handle binary websocket messages (#410) – @davidmurdoch
• Gas estimation: make sure we always return a lowestIndex for a range (#421) – @davidmurdoch & @nicholasjpaterno
• Fix getBlockTransactionCountByNumberFormat so it returns the right format (#414) – @davidmurdoch

Maintenance

• Update eth-sig-util to fix global variable leak (#415) – @davidmurdoch

Related Releases

• ganache-cli v6.4.4
• Ganache UI v2.0.2

---

💖 The Truffle Team

v2.5.6-beta.0 - ✨ Mystery Flavor ✨

 Highlights    How to Upgrade    Changelog    Related Releases 

---

We're moving to a beta › latest release pipeline, where all non-hotfix changes are first released in a beta before being promoted to a stable release.

We'd love it if you'd start using the latest betas and let us know early and often if you find any bugs or regressions!

Highlights

Forked transactions have been fixed before, but the previous fix didn't get all the bugs, and the fix before that had to be reverted due to unwanted side effects. We've created a monster. The fix is back, back again, tell a friend!

We've also add support for binary data over websockets, updated eth-sig-util to fix a global variable leak, and fixed some other bugs, too!

---

In case you missed it, we're holding TruffleCon 2019 August 2 - 4 at Microsoft's campus in Redmond, WA! And it'll be awesome. You should be there.

 Get Tickets    Speak at TruffleCon  

---

How to Upgrade

Upgrade to the beta version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@beta

yarn

yarn remove ganache-core
yarn add ganache-core@beta

Changelog

Bug Fixes

• Fix forked transaction trace storage (again) so it doesn't crash anymore (#420) – @davidmurdoch
• Handle binary websocket messages (#410) – @davidmurdoch
• Gas estimation: make sure we always return a lowestIndex for a range (#421) – @davidmurdoch & @nicholasjpaterno
• Fix getBlockTransactionCountByNumberFormat so it returns the right format (#414) – @davidmurdoch

Maintenance

• Update eth-sig-util to fix global variable leak (#415) – @davidmurdoch

Related Releases

• ganache-cli v6.4.4-beta.0
• Ganache UI v2.0.2-beta.0

---

💖 The Truffle Team

v2.5.5 - Forking Bugs ⋔🐞

 Highlights    How to Upgrade    Changelog    Related Releases 

---

We're moving to a beta › latest release pipeline, where all non-hotfix changes are first released in a beta before being promoted to a stable release.

We'd love it if you'd start using the latest betas and let us know early and often if you find any bugs or regressions!

Highlights

Forked transactions have been fixed before, but the previous fix had to be reverted due to unwanted side effects. The fix is back now, and is hopefully side-effect free this time!

We've also fixed some other bugs, improved documentation, and did a little maintenance, too.

---

Oh, we're also holding TruffleCon 2019 August 2 - 4 at Microsoft's campus in Redmond, WA! And it'll be awesome. You should be there.

 Get Tickets    Speak at TruffleCon  

---

How to Upgrade

Upgrade to the latest version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@latest

yarn

yarn remove ganache-core
yarn add ganache-core@latest

Changelog

Bug Fixes

• Fix forked transaction trace storage so it returns the correct data and doesn't modify the root trie (#398) – @davidmurdoch
• Add guard for undefined connection (#385) – @olaf89
• Fix crash and nonce mismatch when tracing a transaction on a forked chain (#396) – @davidmurdoch & @nicholasjpaterno
• Fix invalid snapshot revert hanging when the shapshot id doesn't exist (#387) – @davidmurdoch

Maintenance

• Improve findPath callback in keyExists (#378) – @nicholasjpaterno
• Update compileAndDeploy.js, use join for path's in compile (#379) – @nicholasjpaterno

Documentation

• Update allowUnlimitedContractSize documentation (#393) – @nicholasjpaterno
• Update evm_revert documentation (#389) – @nicholasjpaterno

Related Releases

• ganache-cli v6.4.3
• Ganache UI v2.0.1

---

💖 The Truffle Team

v2.5.5-beta.0 - Forking Bugs ⋔🐞

 Highlights    How to Upgrade    Changelog    Related Releases 

---

Quick bug-fix beta release here. We're moving to a beta › latest release pipeline, where all non-hotfix changes are first released in a beta before being promoted to a stable release.

We'd love it if you'd start using the latest betas and let us know early and often if you find any bugs or regressions!

Highlights

Forked transactions have been fixed before, but the previous fix had to be reverted due to unwanted side effects. The fix is back now, and is hopefully side-effect free this time!

We've also fixed some other bugs, improved documentation, and did a little maintenance, too.

How to Upgrade

Upgrade to the beta version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@beta

yarn

yarn remove ganache-core
yarn add ganache-core@beta

Changelog

Bug Fixes

• Fix forked transaction trace storage so it returns the correct data and doesn't modify the root trie (#398) – @davidmurdoch
• Add guard for undefined connection (#385) – @olaf89
• Fix crash and nonce mismatch when tracing a transaction on a forked chain (#396) – @davidmurdoch & @nicholasjpaterno
• Fix invalid snapshot revert hanging when the shapshot id doesn't exist (#387) – @davidmurdoch

Maintenance

• Improve findPath callback in keyExists (#378) – @nicholasjpaterno
• Update compileAndDeploy.js, use join for path's in compile (#379) – @nicholasjpaterno

Documentation

• Update allowUnlimitedContractSize documentation (#393) – @nicholasjpaterno
• Update evm_revert documentation (#389) – @nicholasjpaterno

Related Releases

• ganache-cli v6.4.3-beta.0
• Ganache UI v2.0.1-beta.0

---

💖 The Truffle Team

v2.5.4 - Gas Exactimation 📏

 Highlights    How to Upgrade    Changelog    Related Releases 

---

A long-standing issue with Ganache has been the fact that we haven't returned EIP-114 compliant gas estimations, AKA the "1/64ths rule". This caused our gas estimates to be too low in cases where a transaction executed opcodes that are subject to this EIP. This in turn was the cause of many frustrations, especially in situations where tools would use gas estimations in transactions without allowing the user to intercept or change the transaction's supplied gas.

Highlights

EIP-114 mandates that certain stackdepth-creating opcodes withhold 1/64th of remaining gas from the stack they create. This has two non-obvious effects:

1. The gas required for a successful transaction can be greater than the actual gas spent. This is similar to how gas refunds behave.
2. The extra gas required for a successful transaction varies depending on the transaction's initial gas amount!

Let's say we want to run the following example transaction (note: this transaction is nonsensical and is intended only to illustrate the 1/64ths rule):

DEPTH	OPCODE	OP FEE
0	PUSH1	3
0	CALL	700
1	ADD	3
1	EXPENSIVE	10000
1	RETURN	0
0	POP	2
0	STOP	0
	Total Gas:	10708

This transaction would cost exactly 10708 gas. However, if you attempted to run this transaction by supplying only 10708 gas it would fail with an "out of gas" exception when it gets to the EXPENSIVE opcode!

The reason for this failure is that the opcode CALL is subject to EIP-114. Here's a breakdown of how this gas is used:

DEPTH	OPCODE	GAS AVAILABLE	OP FEE	1⁄64 WITHHELD
0	PUSH1	10708	3
0	CALL	10705	700	156
1	ADD	9849	3
1	EXPENSIVE	9846	10000
	REVERT	OOG

Instead of 10005 gas available (10705 gas available − 700 op fee) at the ADD opcode,
only 9849 is actually available due to the "withheld" 1/64th: 10005 − FLOOR( 10005 ⁄ 64 ) = 9849; we are now 154 gas short!

All we need to do now is increase our supplied gas by 154, right? Let's see what happens now:

DEPTH	OPCODE	GAS AVAILABLE	OP FEE	1⁄64 WITHHELD
0	PUSH1	10862	3
0	CALL	10859	700	158
1	ADD	10001	3
1	EXPENSIVE	9998	10000
	REVERT	OOG

We still don't have enough gas! The amount withheld increased by 2 gas because the gas supplied to the transaction increased as well!

Because the 1/64ths rule gets applied to the gas remaining, which has increased since our first estimate, 2 more gas gets withheld, resulting in an OOG error!

Now, let's run the same transaction one more time, this time using the result of our new gas estimation algorithm:

DEPTH	OPCODE	GAS AVAILABLE	OP FEE	1⁄64 WITHHELD
0	PUSH1	10864	3
0	CALL	10861	700	158
1	ADD	10003	3
1	EXPENSIVE	10000	10000
1	RETURN	0	0	−158
0	POP	158	2
0	STOP	156	0
		156

It works! Notice that 156 gas was unspent at the end of the transaction, but had we provided even 1 less gas the transaction would have resulted in an "out of gas" exception at EXPENSIVE opcode.

---

This series of simplified examples attempts to provide a high-level overview of the 1/64th gas estimation calculation. To correctly estimate gas on any contract, we must consider how the gas withheld at any nested stack depth/frame affects the gas needed outside of its execution context.

It's a tricky problem to solve. Some implementations of gas estimation after EIP-114 use interval halving (binary search) by running the transaction through the EVM until the gas estimation converges. This seemed like an unnecessarily CPU-intensive approach to the problem, and we set out to find a (theoretically) more performant, and perfectly accurate, way of estimating gas (which we now refer to as "gas exactimation" here at Truffle).

If you find that any of your transactions are running in to unexpected OOG errors please let us know by filing an issue.

---

We are especially proud of this algorithm, and we are even more proud of the brilliant minds that went into its creation. Thank you Nick Paterno (@nicholasjpaterno), Amal Sudama (@cds-amal), Chris Cowell (@ccowell), Mike Seese (@seesemichaelj), Benjamin Burns (@benjamincburns), and David Murdoch (@davidmurdoch) for all the work you've put in to this release!

We'll follow up with a detailed blog post on the algorithm itself in the coming weeks.

How to Upgrade

Upgrade to the latest version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@latest

yarn

yarn remove ganache-core
yarn add ganache-core@latest

Changelog

Bug Fixes

• Gas Estimation (#292) – @nicholasjpaterno

Documentation

• Reformatted and rewrote our documentation (#348) – @nicholasjpaterno

Related Releases

• ganache-cli

---

💖 The Truffle Team

v2.5.4-beta.2 - Gas Exactimation 📏

 Highlights    How to Upgrade    Changelog    Related Releases 

---

A long-standing issue with Ganache has been the fact that we haven't returned EIP-114 compliant gas estimations, AKA the "1/64ths rule". This caused our gas estimates to be too low in cases where a transaction executed opcodes that are subject to this EIP. This in turn was the cause of many frustrations, especially in situations where tools would use gas estimations in transactions without allowing the user to intercept or change the transaction's supplied gas.

Highlights

EIP-114 mandates that certain stackdepth-creating opcodes withhold 1/64th of remaining gas from the stack they create. This has two non-obvious effects:

1. The gas required for a successful transaction can be greater than the actual gas spent. This is similar to how gas refunds behave.
2. The extra gas required for a successful transaction varies depending on the transaction's initial gas amount!

Let's say we want to run the following example transaction (note: this transaction is nonsensical and is intended only to illustrate the 1/64ths rule):

DEPTH	OPCODE	OP FEE
0	PUSH1	3
0	CALL	700
1	ADD	3
1	EXPENSIVE	10000
1	RETURN	0
0	POP	2
0	STOP	0
	Total Gas:	10708

This transaction would cost exactly 10708 gas. However, if you attempted to run this transaction by supplying only 10708 gas it would fail with an "out of gas" exception when it gets to the EXPENSIVE opcode!

The reason for this failure is that the opcode CALL is subject to EIP-114. Here's a breakdown of how this gas is used:

DEPTH	OPCODE	GAS AVAILABLE	OP FEE	1⁄64 WITHHELD
0	PUSH1	10708	3
0	CALL	10705	700	156
1	ADD	9849	3
1	EXPENSIVE	9846	10000
	REVERT	OOG

Instead of 10005 gas available (10705 gas available − 700 op fee) at the ADD opcode,
only 9849 is actually available due to the "withheld" 1/64th: 10005 − FLOOR( 10005 ⁄ 64 ) = 9849; we are now 154 gas short!

All we need to do now is increase our supplied gas by 154, right? Let's see what happens now:

DEPTH	OPCODE	GAS AVAILABLE	OP FEE	1⁄64 WITHHELD
0	PUSH1	10862	3
0	CALL	10859	700	158
1	ADD	10001	3
1	EXPENSIVE	9998	10000
	REVERT	OOG

We still don't have enough gas! The amount withheld increased by 2 gas because the gas supplied to the transaction increased as well!

Because the 1/64ths rule gets applied to the gas remaining, which has increased since our first estimate, 2 more gas gets withheld, resulting in an OOG error!

Now, let's run the same transaction one more time, this time using the result of our new gas estimation algorithm:

DEPTH	OPCODE	GAS AVAILABLE	OP FEE	1⁄64 WITHHELD
0	PUSH1	10864	3
0	CALL	10861	700	158
1	ADD	10003	3
1	EXPENSIVE	10000	10000
1	RETURN	0	0	−158
0	POP	158	2
0	STOP	156	0
		156

It works! Notice that 156 gas was unspent at the end of the transaction, but had we provided even 1 less gas the transaction would have resulted in an "out of gas" exception at EXPENSIVE opcode.

---

This series of simplified examples attempts to provide a high-level overview of the 1/64th gas estimation calculation. To correctly estimate gas on any contract, we must consider how the gas withheld at any nested stack depth/frame affects the gas needed outside of its execution context.

It's a tricky problem to solve. Some implementations of gas estimation after EIP-114 use interval halving (binary search) by running the transaction through the EVM until the gas estimation converges. This seemed like an unnecessarily CPU-intensive approach to the problem, and we set out to find a (theoretically) more performant, and perfectly accurate, way of estimating gas (which we now refer to as "gas exactimation" here at Truffle).

Our new gas estimation algorithm is being released as a beta in order to get real-world metrics on its accuracy as well as to prove some assumptions we've made about the EVM behavior. It's possible the algorithm still has crash-inducing bugs or could even return estimates that are too low.

If you find that any of your transactions are running in to unexpected OOG errors please let us know by filing an issue.

---

We are especially proud of this algorithm, and we are even more proud of the brilliant minds that went into its creation. Thank you Nick Paterno (@nicholasjpaterno), Amal Sudama (@cds-amal), Chris Cowell (@ccowell), Mike Seese (@seesemichaelj), Benjamin Burns (@benjamincburns), and David Murdoch (@davidmurdoch) for all the work you've put in to this release!

We'll follow up with a detailed blog post on the algorithm itself in the coming weeks.

How to Upgrade

Upgrade to the beta version of ganache-core by running:

npm

npm uninstall ganache-core
npm install ganache-core@beta

yarn

yarn remove ganache-core
yarn add ganache-core@beta

Changelog

Bug Fixes

• Gas Estimation (#292) – @nicholasjpaterno

Documentation

• Reformatted and rewrote our documentation (#348) – @nicholasjpaterno

Related Releases

• ganache-cli

---

💖 The Truffle Team