offchainMessageApplicationDomain

function offchainMessageApplicationDomain(
    putativeApplicationDomain,
): OffchainMessageApplicationDomain;

Combines asserting that a string is an offchain message application domain with coercing it to the OffchainMessageApplicationDomain type. It's most useful with untrusted input.

Parameters

Returns

OffchainMessageApplicationDomain

Example

import { offchainMessageApplicationDomain, OffchainMessageV0 } from '@solana/offchain-messages';
 
const offchainMessage: OffchainMessageV0 = {
    applicationDomain:
        offchainMessageApplicationDomain('HgHLLXT3BVA5m7x66tEp3YNatXLth1hJwVeCva2T9RNx'),
    // ...
};

[!TIP] When starting from a known-good application domain as a string, it's more efficient to typecast it rather than to use the offchainMessageApplicationDomain helper, because the helper unconditionally performs validation on its input.

import { OffchainMessageApplicationDomain } from '@solana/offchain-messages';
 
const applicationDomain =
    'HgHLLXT3BVA5m7x66tEp3YNatXLth1hJwVeCva2T9RNx' as OffchainMessageApplicationDomain;