Interface LocalStorageData

Interface for local storage data. Represents the result of querying local state from an application for a specific account.

interface LocalStorageData {
    address: string;
    decodedKey: string;
    decodedValue?: string;
    error?: string;
    exists: boolean;
    isOptedIn: boolean;
    key: string;
    value: null | bigint | Uint8Array<ArrayBufferLike>;
    valueType: null | "bytes" | "uint";
}

Properties

address decodedKey decodedValue? error? exists isOptedIn key value valueType

Properties

address

address: string

Account address

decodedKey

decodedKey: string

Decoded key as UTF-8 string

Optional decodedValue

decodedValue?: string

Decoded value as UTF-8 string (if bytes and valid UTF-8)

Optional error

error?: string

Error message if query failed

exists

exists: boolean

Whether the key exists for this account

isOptedIn

isOptedIn: boolean

Whether the account is opted into the app

key

key: string

Base64url-encoded key

value

value: null | bigint | Uint8Array<ArrayBufferLike>

Raw value (bytes or uint)

valueType

valueType: null | "bytes" | "uint"

Value type (bytes or uint)

Settings

Member Visibility

Theme

On This Page

addressdecodedKeydecodedValueerrorexistsisOptedInkeyvaluevalueType