@cometh/connect-sdk-viem
v2.0.8
Published
Viem SDK Cometh Connect
Downloads
214
Readme
Connect Viem SDK
Cometh Connect Viem SDK allows developers to onboard their users with a seedless, gasless experience familiar to Web2 using Biometrics and web2 logins.
Account Abstraction (AA) improves transaction user experience by using smart contract wallets as primary accounts.
If you need more information on how to use the SDK check our documentation
Before interacting with viem
Before being able to use the connect custom viem client, we'll need to create a connect instance and call the connect function:
To get an API key please Contact us
Create a Wallet
import {
ComethWallet,
ConnectAdaptor,
SupportedNetworks
} from '@cometh/connect-sdk'
const walletAdaptor = new ConnectAdaptor({
chainId: SupportedNetworks.POLYGON,
apiKey: API_KEY
})
const wallet = new ComethWallet({
authAdapter: walletAdaptor,
apiKey: API_KEY,
rpcUrl: RPC_URL
})
await wallet.connect()
This function create a new wallet and connect to the API.
Connect an existing Wallet
You can also connect to a previously created wallet. You'll have to provide the wallet address of the previously created wallet.
await wallet.connect(walletAddress)
Instanciate a Connect viem Client
After creating (or reconnecting) to a connect wallet, you can now create a connectViemClient:
import {
ComethWallet,
ConnectAdaptor,
SupportedNetworks
} from '@cometh/connect-sdk'
import { getConnectViemClient } from '@cometh/connect-sdk-viem'
const walletAdaptor = new ConnectAdaptor({
chainId: SupportedNetworks.POLYGON,
apiKey: API_KEY
})
const wallet = new ComethWallet({
authAdapter: walletAdaptor,
apiKey: API_KEY,
rpcUrl: RPC_URL
})
await wallet.connect()
const connectViemClient = getConnectViemClient({ wallet })
Available Client methods
All Public actions available through a Public Viem Client are available. (see viem docs)
On top of that, we added 2 custom functions that you can call throught the connectViemClient:
- sendTransaction
- getTransaction
Send transaction
import { encodeFunctionData } from 'viem'
const txCallData = encodeFunctionData({
abi: CONTRACT_ABI,
functionName: CONTRACT_METHOD
})
const tx = { to: DESTINATION, value: VALUE, data: txCallData }
const txHash = await connectViemClient.sendTransaction(tx)
This function relays the transaction data to the target address. The transaction fees can be sponsored.
Send Batch transactions
const txBatch = [
{ to: DESTINATION, value: VALUE, data: txCallData },
{ to: DESTINATION, value: VALUE, data: txCallData }
]
const txHash = await connectViemClient.sendBatchTransactions(tx)
This function relays a batch of transaction data to the targeted addresses. The transaction fees can be sponsored as well.
Instanciate a Connect Viem Account
import {
ComethWallet,
ConnectAdaptor,
SupportedNetworks
} from '@cometh/connect-sdk'
import { getConnectViemAccount } from '@cometh/connect-sdk-viem'
const walletAdaptor = new ConnectAdaptor({
chainId: SupportedNetworks.POLYGON,
apiKey: API_KEY
})
const wallet = new ComethWallet({
authAdapter: walletAdaptor,
apiKey: API_KEY,
rpcUrl: RPC_URL
})
await wallet.connect()
const connectViemAccount = getConnectViemAccount(wallet)
Available Account methods
Sign Message
const signature = await connectViemAccount.signMessage({ message: 'hello' })
Sign the given message using the EOA, owner of the smart wallet.
Sign Transaction
const tx = { to: DESTINATION, value: VALUE, data: txCallData }
const signature = await connectViemAccount.signTransaction(tx)
Sign the given message using the EOA, owner of the smart wallet.