flashbots/suave-viem

Typescript client library to interact with SUAVE.

⚠️ ALPHA SOFTWARE: This code relies on the SUAVE protocol, and both are subject to change. Please use it with caution. The SUAVE spec has not yet stabilized, so we are currently refraining from merging this work upstream. Confidential Compute Requests rely on a custom signature scheme, with the option to use EIP-712 to sign the payload. EIP-1193 wallets use either eth_signTypedData_v4 (EIP-712) or eth_sign (generally regarded as unsafe) to sign confidential requests. We recommend always using EIP-712, which is the default. This default can be overridden by setting isEIP712 in the request being signed.

TypeScript Interface for Ethereum

Features

• Abstractions over the JSON-RPC API to make your life easier
• First-class APIs for interacting with Smart Contracts
• Language closely aligned to official Ethereum terminology
• Import your Browser Extension, WalletConnect or Private Key Wallet
• Browser native BigInt, instead of large BigNumber libraries
• Utilities for working with ABIs (encoding/decoding/inspection)
• TypeScript ready (infer types from ABIs and EIP-712 Typed Data)
• First-class support for Anvil, Hardhat & Ganache
• Test suite running against forked Ethereum network

... and a lot lot more.

Overview

First, see these instructions for spinning up a local devnet. Then install @flashbots/suave-viem into your project and run this code:

import { http, type Hex } from '@flashbots/suave-viem';
import { suaveToliman as suaveChain } from '@flashbots/suave-viem/chains';
import {
  getSuaveProvider,
  getSuaveWallet,
  type TransactionRequestSuave,
  SuaveTxRequestTypes
} from '@flashbots/suave-viem/chains/utils';

// connect to a local SUAVE devnet
const SUAVE_RPC_URL = 'http://localhost:8545';
const suaveProvider = getSuaveProvider(http(SUAVE_RPC_URL));

// instantiate a wallet
const DEFAULT_PRIVATE_KEY: Hex =
  '0x91ab9a7e53c220e6210460b65a7a3bb2ca181412a8a7b43ff336b3df1737ce12';
const wallet = getSuaveWallet({
  transport: http(SUAVE_RPC_URL),
  privateKey: DEFAULT_PRIVATE_KEY,
});

// Watch for pending transactions
suaveProvider.watchPendingTransactions({
  async onTransactions(transactions) {
    for (const hash of transactions) {
      try {
        console.log(
          'Transaction Receipt:',
          await suaveProvider.getTransactionReceipt({hash})
        );
      } catch (error) {
        console.error('Error fetching receipt:', error);
      }
    }
  },
});

// send a confidential compute request
const ccr: TransactionRequestSuave = {
  confidentialInputs:
    '0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000fd7b22626c6f636b4e756d626572223a22307830222c22747873223a5b2230786638363538303064383235323038393461646263653931303332643333396338336463653834316336346566643261393232383165653664383230336538383038343032303131386164613038376337386234353663653762343234386237313565353164326465656236343031363032343832333735663130663037396663666637373934383830653731613035373366336364343133396437323037643165316235623263323365353438623061316361636533373034343739656334653939316362356130623661323930225d2c2270657263656e74223a31307d000000',
  kettleAddress: '0xB5fEAfbDD752ad52Afb7e1bD2E40432A485bBB7F', // Address of your local Kettle. Use 0x03493869959C866713C33669cA118E774A30A0E5 if on Rigil.
  to: '0x8f21Fdd6B4f4CacD33151777A46c122797c8BF17',
  gasPrice: 10000000000n, // Gas price for the transaction
  gas: 420000n, // Gas limit for the transaction
  type: SuaveTxRequestTypes.ConfidentialRequest, // (0x43)
  data: '0x236eb5a70000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000010000000000000000000000008f21fdd6b4f4cacd33151777a46c122797c8bf170000000000000000000000000000000000000000000000000000000000000000',
};

const res = await wallet.sendTransaction(ccr);
console.log(`sent ccr! tx hash: ${res}`);

See the docs and examples in this repo (suave, suave-web-demo) for more detailed examples.

Community

Check out the following places for more viem-related content:

• Follow @wagmi_sh, @jakemoxey, and @awkweb on Twitter for project updates
• Join the discussions on GitHub
• Share your project/organization that uses viem

Support

• GitHub Sponsors
• Gitcoin Grant
• wagmi-dev.eth

Sponsors

Contributing

If you're interested in contributing, please read the contributing docs before submitting a pull request.

Authors

• @jxom (jxom.eth, Twitter)
• @tmm (awkweb.eth, Twitter)

License

MIT License

suave-viem's Issues

DX issue: too many params required for tx requests

Is there an existing issue for this?

• I have searched the existing issues

Package Version

#5d4c777

Current Behavior

need to include potentially-optional params (type, gas, gasPrice), especially in provider.call

Expected Behavior

• infer type from presence of confidentialInputs & kettleAddress
• make assertions on presence of gas params as needed
• make these optional in TransactionRequestSuave

Steps To Reproduce

const balance = await suaveProvider.call({
    to: wethAddress,
    data: encodeFunctionData({
        abi: weth.abi,
        functionName: 'balanceOf',
        args: [this.wallet.account.address]
    }),
})

renders error:

Type '{ to: `0x${string}`; data: `0x${string}`; }' is missing the following properties from type 'Omit<Assign_<Partial<TransactionRequestEIP1559<bigint, number, "eip1559">>, TransactionRequestSuave<bigint, number, "0x0" | "0x43">> & ... 5 more ... & { ...; }, "from">': type, gasPrice
ts(2345)

workaround: add some generic values for missing params, and inject your account into the request

const balance = await suaveProvider.call({
    account: this.wallet.account,
    to: wethAddress,
    data: encodeFunctionData({
        abi: weth.abi,
        functionName: 'balanceOf',
        args: [this.wallet.account.address]
    }),
    gasPrice: 1000000000n,
    gas: 42000n,
    type: '0x0',
})

Link to Minimal Reproducible Example (StackBlitz, CodeSandbox, GitHub repo etc.)

No response

Anything else?

No response

Metamask integration docs

Is there an existing issue for this?

• I have searched the existing issues

Package Version

1.14.0

Current Behavior

Integrating with Metamask seems like a common use case, but I couldn't get it to work. If it should work, I think sample code for how to integrate with Metamask would be of great value.

Expected Behavior

No response

Steps To Reproduce

No response

Link to Minimal Reproducible Example (StackBlitz, CodeSandbox, GitHub repo etc.)

No response

Anything else?

No response

bug: suave-viem is not updated for Toliman

Is there an existing issue for this?

• I have searched the existing issues

Package Version

0.0.0-main.20240703T192338

Current Behavior

This package does not have specs for Toliman, for example the chain id changed. RPC requests throw this errror

shortMessage: 'RPC Request failed.',
    version: '[email protected]',
    cause: {
      code: -32000,
      message: 'invalid chain id for signer: have 33626250 want 16813125'
    },

because the SuaveProvider type is hardcoded to be typeof `suaveRigil

Expected Behavior

There should be a config which testnet you are using. Also should be configurable to work with local suave-geth testnet running both Rigil and Toliman specs.

Steps To Reproduce

No response

Link to Minimal Reproducible Example (StackBlitz, CodeSandbox, GitHub repo etc.)

No response

Anything else?

No response

request: Make Types WAGMI compatible

Is there an existing issue for this?

• I have searched the existing issues

Package Version

0.1.0

Current Behavior

not wagmi compatible

Expected Behavior

wagmi compatible

Steps To Reproduce

123

Link to Minimal Reproducible Example (StackBlitz, CodeSandbox, GitHub repo etc.)

https://www.google.com/

Anything else?

No response