Viem

About

The SettleMint Viem SDK provides a lightweight wrapper that automatically configures and sets up a Viem client based on your connected SettleMint application. It simplifies the process of establishing connections to SettleMint-managed blockchain networks by handling authentication, endpoint configuration, and chain selection. This allows developers to quickly start using Viem's powerful Ethereum interaction capabilities without manual setup, while ensuring proper integration with the SettleMint platform.

API Reference

Functions

getChainId()

getChainId(options): Promise<number>

Defined in: sdk/viem/src/viem.ts:217

Get the chain id of a blockchain network.

Parameters

Parameter	Type	Description
`options`	`GetChainIdOptions`	The options for the public client.

Returns

Promise<number>

The chain id.

Example

import { getChainId } from '@settlemint/sdk-viem';

const chainId = await getChainId({
  accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
  rpcUrl: process.env.SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT!,
});
console.log(chainId);

getPublicClient()

getPublicClient(options): object

Defined in: sdk/viem/src/viem.ts:75

Get a public client. Use this if you need to read from the blockchain.

Parameters

Parameter	Type	Description
`options`	`ClientOptions`	The options for the public client.

Returns

object

The public client. see https://viem.sh/docs/clients/public

Example

import { getPublicClient } from '@settlemint/sdk-viem';

const publicClient = getPublicClient({
  accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
  chainId: process.env.SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID!,
  chainName: process.env.SETTLEMINT_BLOCKCHAIN_NETWORK!,
  rpcUrl: process.env.SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT!,
});

// Get the block number
const block = await publicClient.getBlockNumber();
console.log(block);

getWalletClient()

getWalletClient(options): (verificationOptions?) => Client<HttpTransport<undefined | RpcSchema, boolean>, Chain, undefined, WalletRpcSchema, object & object & object & object & object & object & object & WalletActions<Chain, undefined>>

Defined in: sdk/viem/src/viem.ts:143

Get a wallet client. Use this if you need to write to the blockchain.

Parameters

Parameter	Type	Description
`options`	`ClientOptions`	The options for the wallet client.

Returns

A function that returns a wallet client. The function can be called with verification options for HD wallets. see https://viem.sh/docs/clients/wallet

(verificationOptions?): Client<HttpTransport<undefined | RpcSchema, boolean>, Chain, undefined, WalletRpcSchema, object & object & object & object & object & object & object & WalletActions<Chain, undefined>>

Parameters

Parameter	Type
`verificationOptions?`	`WalletVerificationOptions`

Returns

Client<HttpTransport<undefined | RpcSchema, boolean>, Chain, undefined, WalletRpcSchema, object & object & object & object & object & object & object & WalletActions<Chain, undefined>>

Example

import { getWalletClient } from '@settlemint/sdk-viem';
import { parseAbi } from "viem";

const walletClient = getWalletClient({
  accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
  chainId: process.env.SETTLEMINT_BLOCKCHAIN_NETWORK_CHAIN_ID!,
  chainName: process.env.SETTLEMINT_BLOCKCHAIN_NETWORK!,
  rpcUrl: process.env.SETTLEMINT_BLOCKCHAIN_NODE_OR_LOAD_BALANCER_JSON_RPC_ENDPOINT!,
});

// Get the chain id
const chainId = await walletClient().getChainId();
console.log(chainId);

// write to the blockchain
const transactionHash = await walletClient().writeContract({
  account: "0x0000000000000000000000000000000000000000",
  address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
  abi: parseAbi(["function mint(uint32 tokenId) nonpayable"]),
  functionName: "mint",
  args: [69420],
});
console.log(transactionHash);

Enumerations

OTPAlgorithm

Defined in: sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:18

Supported hash algorithms for One-Time Password (OTP) verification. These algorithms determine the cryptographic function used to generate OTP codes.

Enumeration Members

Enumeration Member	Value	Description	Defined in
`SHA1`	`"SHA1"`	SHA-1 hash algorithm	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:20
`SHA224`	`"SHA224"`	SHA-224 hash algorithm	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:22
`SHA256`	`"SHA256"`	SHA-256 hash algorithm	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:24
`SHA3_224`	`"SHA3-224"`	SHA3-224 hash algorithm	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:30
`SHA3_256`	`"SHA3-256"`	SHA3-256 hash algorithm	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:32
`SHA3_384`	`"SHA3-384"`	SHA3-384 hash algorithm	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:34
`SHA3_512`	`"SHA3-512"`	SHA3-512 hash algorithm	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:36
`SHA384`	`"SHA384"`	SHA-384 hash algorithm	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:26
`SHA512`	`"SHA512"`	SHA-512 hash algorithm	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:28

WalletVerificationType

Defined in: sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:5

Types of wallet verification methods supported by the system. Used to identify different verification mechanisms when creating or managing wallet verifications.

Enumeration Members

Enumeration Member	Value	Description	Defined in
`OTP`	`"OTP"`	One-Time Password verification method	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:9
`PINCODE`	`"PINCODE"`	PIN code verification method	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:7
`SECRET_CODES`	`"SECRET_CODES"`	Secret recovery codes verification method	sdk/viem/src/custom-actions/types/wallet-verification.enum.ts:11

Interfaces

CreateWalletParameters

Defined in: sdk/viem/src/custom-actions/create-wallet.action.ts:14

Parameters for creating a wallet.

Property	Type	Description	Defined in
`keyVaultId`	`string`	The unique name of the key vault where the wallet will be created.	sdk/viem/src/custom-actions/create-wallet.action.ts:16
`walletInfo`	`WalletInfo`	Information about the wallet to be created.	sdk/viem/src/custom-actions/create-wallet.action.ts:18

Property	Type	Description	Defined in
`address`	`string`	The blockchain address of the wallet.	sdk/viem/src/custom-actions/create-wallet.action.ts:30
`derivationPath`	`string`	The HD derivation path used to create the wallet.	sdk/viem/src/custom-actions/create-wallet.action.ts:32
`id`	`string`	The unique identifier of the wallet.	sdk/viem/src/custom-actions/create-wallet.action.ts:26
`name`	`string`	The name of the wallet.	sdk/viem/src/custom-actions/create-wallet.action.ts:28

Property	Type	Description	Defined in
`userWalletAddress`	`string`	The wallet address for which to create the verification.	sdk/viem/src/custom-actions/create-wallet-verification.action.ts:61
`walletVerificationInfo`	`WalletVerificationInfo`	The verification information to create.	sdk/viem/src/custom-actions/create-wallet-verification.action.ts:63

Property	Type	Description	Defined in
`id`	`string`	The unique identifier of the verification.	sdk/viem/src/custom-actions/create-wallet-verification.action.ts:71
`name`	`string`	The name of the verification method.	sdk/viem/src/custom-actions/create-wallet-verification.action.ts:73
`parameters`	`Record`<`string`, `string`>	Additional parameters specific to the verification type.	sdk/viem/src/custom-actions/create-wallet-verification.action.ts:77
`verificationType`	`WalletVerificationType`	The type of verification method.	sdk/viem/src/custom-actions/create-wallet-verification.action.ts:75

Viem

On this page