.creates property missing in TransactionResponse

[travisbotello]

Ethers Version

6.6.0

Search Terms

creates, getTransaction, contactcreation

Describe the Problem

The .creates property is missing in TransactionResponse for contract creating transactions.

Example transaction: 0x33174df580acaa50b08ba908a633ed7e3ac20e4440bf2a363be344b04c5f8474

V5:

{
  hash: '0x33174df580acaa50b08ba908a633ed7e3ac20e4440bf2a363be344b04c5f8474',
  type: 2,
  accessList: [],
  blockHash: '0x6ab00830a56915d9fa9df42709dc62902c91c5377c9fcd2abf18554ed90f5444',
  blockNumber: 17477709,
  transactionIndex: 87,
  confirmations: 1026,
  from: '0xAa978a361AA39aE5dA51354e27f44d78145621eE',
  gasPrice: BigNumber { _hex: '0x03424c0ea4', _isBigNumber: true },
  maxPriorityFeePerGas: BigNumber { _hex: '0x3b9aca00', _isBigNumber: true },
  maxFeePerGas: BigNumber { _hex: '0x03424c0ea4', _isBigNumber: true },
  gasLimit: BigNumber { _hex: '0x11fae8', _isBigNumber: true },
  to: null,
  value: BigNumber { _hex: '0x00', _isBigNumber: true },
  nonce: 5,
  data: '0x6080'... 3894 more characters,
  r: '0x494cab45204a001c8087ce569bb679feb929bccc390134b305a311943405a5cc',
  s: '0x43c69b58a73a52e67087c7a056da72d2197afddf721c1684f74286f665d107e9',
  v: 0,
  creates: '0x2c9eBca71C31eD35595A7bDD48Ec12C64969b6ce',
  chainId: 1,
  wait: [Function (anonymous)]
}

V6:

TransactionResponse {
  provider: PocketProvider {
    applicationId: '123456',
    applicationSecret: null
  },
  blockNumber: 17477709,
  blockHash: '0x6ab00830a56915d9fa9df42709dc62902c91c5377c9fcd2abf18554ed90f5444',
  index: undefined,
  hash: '0x33174df580acaa50b08ba908a633ed7e3ac20e4440bf2a363be344b04c5f8474',
  type: 2,
  to: null,
  from: '0xAa978a361AA39aE5dA51354e27f44d78145621eE',
  nonce: 5,
  gasLimit: 1178344n,
  gasPrice: 13997182628n,
  maxPriorityFeePerGas: 1000000000n,
  maxFeePerGas: 13997182628n,
  data: '0x6080'... 3894 more characters,
  value: 0n,
  chainId: 1n,
  signature: Signature { r: "0x494cab45204a001c8087ce569bb679feb929bccc390134b305a311943405a5cc", s: "0x43c69b58a73a52e67087c7a056da72d2197afddf721c1684f74286f665d107e9", yParity: 0, networkV: null },
  accessList: []
}

Code Snippet

provider.getTransaction('0x33174df580acaa50b08ba908a633ed7e3ac20e4440bf2a363be344b04c5f8474')

Contract ABI

No response

Errors

No response

Environment

No response

Environment (Other)

No response

[ricmoo]

Looking at the v5 code, I see that it computes the value if it is missing as the JSON-RPC API used to return it as some nodes returned it and some didn't.

It is no longer included at all in the JSON-RPC API, which may be due to the creation only occurring in the event the receipt.status is 1. I'm researching why it was removed to determine if v6 should also compute it regardless, or whether it makes more sense to punt to the application developer.

To compute this manually, you can use:

// Only transactions with no `to` can cause a CREATE.
const creates = (tx.to == null) ? ethers.getCreateAddress(tx): null;

I'll update this issue when I have more info.

[travisbotello]

Looking at the v5 code, I see that it computes the value if it is missing as the JSON-RPC API used to return it as some nodes returned it and some didn't.

It is no longer included at all in the JSON-RPC API, which may be due to the creation only occurring in the event the receipt.status is 1. I'm researching why it was removed to determine if v6 should also compute it regardless, or whether it makes more sense to punt to the application developer.

To compute this manually, you can use:

// Only transactions with no `to` can cause a CREATE.
const creates = (tx.to == null) ? ethers.getCreateAddress(tx): null;

I'll update this issue when I have more info.

Thanks for the comprehensive research! 👍

[ricmoo]

So, it doesn't appear to be included in the TransactionResponse, and I think it makes sense to not include it there, since if the transaction fails (reverts), there is no contract deployed to that address.

It is available on the receipt though, at receipt.contractAddress which is either null or an address.

I think I'd prefer keeping this logic, rather than mimic the old API (I think back to v0 ;)) of the .creates property.

Does that make sense?

[nfts2me]

It makes sense.
But this (as many missing things) would be nice to be added to https://docs.ethers.org/v6/migrating/
There are also many errors there.

[travisbotello]

So, it doesn't appear to be included in the TransactionResponse, and I think it makes sense to not include it there, since if the transaction fails (reverts), there is no contract deployed to that address.

It is available on the receipt though, at receipt.contractAddress which is either null or an address.

I think I'd prefer keeping this logic, rather than mimic the old API (I think back to v0 ;)) of the .creates property.

Does that make sense?

I guess it does make sense. I originally came over this issue because I updated my script that is constantly monitoring new contract deployments and it stopped working on V6. At first my solution was to run getTransactionReceipt on the prefetchedTransactions additionally which was a kinda expensive operation on my RPC credits. But your solution with manually computing via getCreateAddress did the trick and I can definitely live with it...