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:456

Discovers the chain ID from an RPC endpoint without requiring prior knowledge.

Parameters

Parameter	Type	Description
`options`	`GetChainIdOptions`	Minimal options with RPC URL and optional authentication

Returns

Promise<number>

Promise resolving to the network's chain ID as a number

Remarks

UTILITY: Enables chain discovery for dynamic network configuration scenarios. Unlike other client functions, this creates a minimal, non-cached client for one-time queries.

USE CASE: Chain ID discovery during initial network setup or validation. Alternative to requiring users to know chain IDs in advance.

PERFORMANCE: No caching because chain IDs are typically discovered once during setup rather than repeatedly during runtime operations.

Throws

NetworkError when RPC endpoint is unreachable

Throws

AuthenticationError when access token is invalid

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): Client<HttpTransport<undefined | RpcSchema, boolean>, Chain, undefined, PublicRpcSchema, object & PublicActions<HttpTransport<undefined | RpcSchema, boolean>, Chain>>

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

Creates an optimized public client for blockchain read operations.

Parameters

Parameter	Type	Description
`options`	`ClientOptions`	Client configuration including chain details and authentication

Returns

Client<HttpTransport<undefined | RpcSchema, boolean>, Chain, undefined, PublicRpcSchema, object & PublicActions<HttpTransport<undefined | RpcSchema, boolean>, Chain>>

Cached or newly created public client with read-only blockchain access

Remarks

PERFORMANCE: Implements intelligent caching to minimize client creation overhead. Cache hit rates of 80%+ typical in production workloads with repeated chain access.

SECURITY: Each access token gets isolated cache entries to prevent cross-tenant data exposure. Client instances are immutable once cached to prevent credential pollution.

RESOURCE MANAGEMENT: 500ms polling interval balances responsiveness with server load. 60-second timeout prevents hanging connections in unstable network conditions.

Throws

ValidationError when options don't match required schema

Throws

NetworkError when RPC endpoint is unreachable during client creation

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>>

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

Creates a factory function for wallet clients with runtime verification support.

Parameters

Parameter	Type	Description
`options`	`ClientOptions`	Base client configuration (chain, RPC, auth)

Returns

Factory function that accepts runtime verification options

(verificationOptions?): Client<HttpTransport<undefined | RpcSchema, boolean>>

Parameters

Parameter	Type
`verificationOptions?`	`WalletVerificationOptions`

Returns

Client<HttpTransport<undefined | RpcSchema, boolean>>

Remarks

DESIGN PATTERN: Returns a factory function rather than a client instance because wallet operations require runtime verification parameters (challenge responses, etc.) that cannot be known at factory creation time.

SECURITY: Verification headers are injected per-operation to support:

HD wallet challenge/response flows
Multi-signature verification workflows
Time-sensitive authentication tokens

PERFORMANCE: Factory caching amortizes expensive setup (chain resolution, transport config) while allowing runtime parameter injection for each wallet operation.

FEATURE EXTENSIONS: Automatically extends client with SettleMint-specific wallet actions:

Wallet creation and management
Verification challenge handling
Multi-factor authentication flows

Throws

ValidationError when options don't match required schema

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:16

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:18
`walletInfo`	`WalletInfo`	Information about the wallet to be created.	sdk/viem/src/custom-actions/create-wallet.action.ts:20

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

Property	Type	Description	Defined in
`userWalletAddress`	`string`	The wallet address.	sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:9
`verificationId`	`string`	The verification ID.	sdk/viem/src/custom-actions/create-wallet-verification-challenge.action.ts:11

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

Viem

On this page