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

getPublicClient()

getPublicClient(options): object

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

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

Parameters

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

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

Parameters

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

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

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

Interfaces

ClientOptions

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

The options for the viem client.

Properties

CreateWalletParameters

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

Parameters for creating a wallet.

Properties

CreateWalletResponse

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

Response from creating a wallet.

Properties

CreateWalletVerificationChallengesParameters

Defined in: sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:8

Parameters for creating wallet verification challenges.

Properties

CreateWalletVerificationParameters

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

Parameters for creating a wallet verification.

Properties

CreateWalletVerificationResponse

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

Response from creating a wallet verification.

Properties

DeleteWalletVerificationParameters

Defined in: sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:6

Parameters for deleting a wallet verification.

Properties

DeleteWalletVerificationResponse

Defined in: sdk/viem/src/custom-actions/delete-wallet-verification.action.ts:16

Response from deleting a wallet verification.

Properties

GetWalletVerificationsParameters

Defined in: sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:7

Parameters for getting wallet verifications.

Properties

VerificationResult

Defined in: sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:26

Result of a wallet verification challenge.

Properties

VerifyWalletVerificationChallengeParameters

Defined in: sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:16

Parameters for verifying a wallet verification challenge.

Properties

WalletInfo

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

Information about the wallet to be created.

Properties

WalletOTPVerificationInfo

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

Information for One-Time Password (OTP) verification.

Extends

• BaseWalletVerificationInfo

Properties

WalletPincodeVerificationInfo

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

Information for PIN code verification.

Extends

• BaseWalletVerificationInfo

Properties

WalletSecretCodesVerificationInfo

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

Information for secret recovery codes verification.

Extends

• BaseWalletVerificationInfo

Properties

WalletVerification

Defined in: sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:15

Represents a wallet verification.

Properties

WalletVerificationChallenge

Defined in: sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:16

Represents a wallet verification challenge.

Properties

WalletVerificationOptions

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

The options for the wallet client.

Properties

Type Aliases

AddressOrObject

AddressOrObject = string | { userWalletAddress: string; verificationId?: string; }

Defined in: sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:6

Represents either a wallet address string or an object containing wallet address and optional verification ID.

CreateWalletVerificationChallengesResponse

CreateWalletVerificationChallengesResponse = WalletVerificationChallenge[]

Defined in: sdk/viem/src/custom-actions/create-wallet-verification-challenges.action.ts:30

Response from creating wallet verification challenges.

GetWalletVerificationsResponse

GetWalletVerificationsResponse = WalletVerification[]

Defined in: sdk/viem/src/custom-actions/get-wallet-verifications.action.ts:27

Response from getting wallet verifications.

VerifyWalletVerificationChallengeResponse

VerifyWalletVerificationChallengeResponse = VerificationResult[]

Defined in: sdk/viem/src/custom-actions/verify-wallet-verification-challenge.action.ts:34

Response from verifying a wallet verification challenge.

WalletVerificationInfo

WalletVerificationInfo = WalletPincodeVerificationInfo | WalletOTPVerificationInfo | WalletSecretCodesVerificationInfo

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

Union type of all possible wallet verification information types.

Contributing

We welcome contributions from the community! Please check out our Contributing guide to learn how you can help improve the SettleMint SDK through bug reports, feature requests, documentation updates, or code contributions.

License

The SettleMint SDK is released under the FSL Software License. See the LICENSE file for more details.