Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.faremeter.xyz/llms.txt

Use this file to discover all available pages before exploring further.

solana

Type Aliases

Base58Address

Base58Address = typeof Base58Address.infer
Defined in: packages/types/src/solana.ts:7

SolanaCAIP2Network

SolanaCAIP2Network = object
Defined in: packages/types/src/solana.ts:56 Solana network identifier with associated metadata.

Properties

caip2
readonly caip2: string
Defined in: packages/types/src/solana.ts:59
hash
readonly hash: string
Defined in: packages/types/src/solana.ts:57
name?
readonly optional name: string
Defined in: packages/types/src/solana.ts:58

SolanaCluster

SolanaCluster = typeof SolanaCluster.infer
Defined in: packages/types/src/solana.ts:23

Variables

Base58Address

const Base58Address: Type<string, { }>
Defined in: packages/types/src/solana.ts:7 Validator for Solana base58-encoded addresses.

SolanaCAIP2NetworkString

const SolanaCAIP2NetworkString: Type<string, { }>
Defined in: packages/types/src/solana.ts:41 Validator for Solana CAIP-2 network identifier strings. Format: solana:<genesis-hash> where genesis-hash is base58-encoded.

SolanaCluster

const SolanaCluster: Type<"mainnet-beta" | "devnet" | "testnet", { }>
Defined in: packages/types/src/solana.ts:23 Validator for Solana cluster names.

Functions

createSolanaNetwork()

createSolanaNetwork(caip2, name?): SolanaCAIP2Network
Defined in: packages/types/src/solana.ts:87 Creates a SolanaCAIP2Network object from a CAIP-2 string.

Parameters

caip2
string The CAIP-2 network identifier string (e.g., “solana:5eykt…“)
name?
string Optional display name for the network

Returns

SolanaCAIP2Network A SolanaCAIP2Network object

Throws

Error if the CAIP-2 string is invalid

isBaseAddress()

isBaseAddress(maybe): maybe is string
Defined in: packages/types/src/solana.ts:16 Type guard that checks if a value is a valid Solana base58 address.

Parameters

maybe
unknown The value to check

Returns

maybe is string True if the value matches the base58 address format

isSolanaCAIP2Network()

isSolanaCAIP2Network(maybe): maybe is SolanaCAIP2Network
Defined in: packages/types/src/solana.ts:68 Type guard that checks if a value is a SolanaCAIP2Network object.

Parameters

maybe
unknown The value to check

Returns

maybe is SolanaCAIP2Network True if the value is a SolanaCAIP2Network object

isSolanaCAIP2NetworkString()

isSolanaCAIP2NetworkString(maybe): maybe is string
Defined in: packages/types/src/solana.ts:49 Type guard that checks if a value is a valid Solana CAIP-2 network string.

Parameters

maybe
unknown The value to check

Returns

maybe is string True if the value matches the Solana CAIP-2 format

isSolanaCluster()

isSolanaCluster(maybe): maybe is “mainnet-beta” | “devnet” | “testnet”
Defined in: packages/types/src/solana.ts:32 Type guard that checks if a value is a valid Solana cluster name.

Parameters

maybe
unknown The value to check

Returns

maybe is “mainnet-beta” | “devnet” | “testnet” True if the value is a known cluster name