Utilize gas estimation in client libraries

[aefhm]

Why

Relates to #39

Development

Go

This appears fairly straight forward. I can test with a base Go script against our Vigil contract.

package main

import (
	"context"
	"crypto/ecdsa"
	"fmt"
	"log"
	"math/big"

	"github.com/aefhm/vigil" // or however you do local modules
	"github.com/ethereum/go-ethereum/accounts/abi/bind"
	"github.com/ethereum/go-ethereum/crypto"
	"github.com/ethereum/go-ethereum/ethclient"
	sapphire "github.com/oasisprotocol/sapphire-paratime/clients/go"
)

var SapphireChainID = big.NewInt(0x5aff)

func main() {
	c, err := ethclient.Dial("https://testnet.sapphire.oasis.dev")
	if err != nil {
		log.Fatal(err)
	}

	privateKey, err := crypto.HexToECDSA("")
	if err != nil {
		log.Fatal(err)
	}

	publicKey := privateKey.Public()
	publicKeyECDSA, ok := publicKey.(*ecdsa.PublicKey)
	if !ok {
		log.Fatal("error casting public key to ECDSA")
	}

	var client *sapphire.WrappedBackend
	client, err = sapphire.WrapClient(*c, func(digest [32]byte) ([]byte, error) { return crypto.Sign(digest[:], privateKey) })

	if err != nil {
		log.Fatal(err)
	}

	fromAddress := crypto.PubkeyToAddress(*publicKeyECDSA)
	nonce, err := client.PendingNonceAt(context.Background(), fromAddress)

	gasPrice, err := client.SuggestGasPrice(context.Background())
	if err != nil {
		log.Fatal(err)
	}

	auth, _ := bind.NewKeyedTransactorWithChainID(privateKey, SapphireChainID)
	auth.Nonce = big.NewInt(int64(nonce))
	auth.Value = big.NewInt(0) // in wei
	auth.GasLimit = uint64(0)  // in units
	auth.GasPrice = gasPrice

	if err != nil {
		log.Fatal(err)
	}

	address, tx, _, err := vigil.DeployVigil(auth, client)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(address.Hex())
	fmt.Println(tx.Hash().Hex())


        // create secret
        // reuse address or wait
	vigil, err := vigil.NewVigil(address, client)

	if err != nil {
		log.Fatalf("Failed to instantiate Vigil contract: %v", err)
	}

	val := []byte("123")
	transactOpts := client.Transactor(fromAddress)
	transaction, err := vigil.CreateSecret(transactOpts, "age", big.NewInt(5), val)

	if err != nil {
		log.Fatalf("Failed to create secret: %v", err)
	}

	fmt.Println(transaction.Data())
}

JS

I'm testing with Vigil.sol and run-vigil.ts

TODO

• Inform community
• Test locally again

[aefhm]

Hmm, looks like Truffle integration gas estimates are off.

estimate: 159564,
  error: Error: The transaction receipt didn't contain a contract address.
      at /Users/xi/oasis/sapphire-paratime/node_modules/.pnpm/[email protected]/node_modules/truffle/build/webpack:/packages/deployer/src/deployment.js:302:1
      at processTicksAndRejections (node:internal/process/task_queues:96:5) {
    receipt: {
      blockHash: '0xe02b3d5f3476d46ffb44ebc536f876f8996702fb5919efca4784e8ab295e7192',
      blockNumber: 99,
      contractAddress: null,
      cumulativeGasUsed: 199455,
      from: '0xa19875987799b8b52150E2a718F338FA36d8981d',
      gasUsed: 199455,
      logs: [],
      logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
      status: false,
      to: null,
      transactionHash: '0x040881a41eeba57a98466e7ff99611d056fb41df8f801515d695116efca722ba',
      transactionIndex: 0,
      type: '0x0'
    },

[CedarMist]

@aefhm Lets remove Truffle support, that will unblock this :D

https://consensys.io/blog/consensys-announces-the-sunset-of-truffle-and-ganache-and-new-hardhat

Starting on December 20, 2023, Truffle and Ganache codebases will remain available as public archives. This gives developers around 90 days to migrate to HardHat and other solutions.

[aefhm]

@aefhm Lets remove Truffle support, that will unblock this :D

https://consensys.io/blog/consensys-announces-the-sunset-of-truffle-and-ganache-and-new-hardhat

Starting on December 20, 2023, Truffle and Ganache codebases will remain available as public archives. This gives developers around 90 days to migrate to HardHat and other solutions.

I'm game. Will remove Truffle in a separate PR/issue and inform the community.

[aefhm]

Relates to oasisprotocol/docs#547

[matevz]

Is gas estimation possible, if we don't sign the gas estimation call? Most of estimates will be off, if the contract checks msg.sender credentials.

[kostko]

Task linked: CU-86785j9hu Utilize gateway gas estimation in Sapphire Client Library

[kostko]

Task linked: CU-86785j9hu Utilize gateway gas estimation in Sapphire Client Library

[aefhm]

Is gas estimation possible, if we don't sign the gas estimation call? Most of estimates will be off, if the contract checks msg.sender credentials.

I believe so. I tried testing with some

require(
    msg.sender == _metas[index].creator,
    "only for creator"
);

Most of estimates will be off, if the contract checks msg.sender credentials.

Could you elaborate? 🤔

[CedarMist]

Gas estimation is possible without signed queries, it's just msg.sender will be address(0).

So if the code relies on signed queries, gas estimation will be wrong.

If the code doesn't rely on signed queries, then gas estimation will be OK.

[aefhm]

Gas estimation is possible without signed queries, it's just msg.sender will be address(0).

👍

So if the code relies on signed queries, gas estimation will be wrong.

Wrong in the safe way though? #39 (comment)

If the code doesn't rely on signed queries, then gas estimation will be OK.

👌

I believe we are ~okay turning gas estimation on with this caveat?