Umi — API References - v1.3.0
    Preparing search index...

    Module umi - v1.4.0

    umi

    A Solana Framework for JavaScript clients.

    Umi is a modular framework for building and using JavaScript clients for Solana programs. It provides a zero-dependency library that defines a set of core interfaces that libraries can rely on without being tied to a specific implementation. It is then up to the end-user to choose the implementation that best suits their needs. Umi also provides a set of default implementations and bundles that can be used out of the box allowing developers to get started quickly.

    Tip

    Just want to mint NFTs? Go straight to the MPL Core JS docs. Looking for fungible tokens? Straight to the Token Metadata SPL Token Guide!

    Context and Interfaces

    Context
    DownloaderInterface
    EddsaInterface
    HttpInterface
    ProgramRepositoryInterface
    RpcInterface
    SerializerInterface
    Signer
    TransactionFactoryInterface
    Umi
    UploaderInterface
    UmiPlugin
    createBaseUmi
    createNullContext

    Signers and PublicKeys

    HasPublicKey
    Keypair
    KeypairSigner
    LegacyWeb3JsPublicKey
    Pda
    PublicKey
    PublicKeyBytes
    PublicKeyInput
    SafePublicKeyInput
    base58PublicKey
    defaultPublicKey
    isPda
    isPublicKey
    PUBLIC_KEY_LENGTH
    publicKeyBytes
    samePublicKey
    uniquePublicKeys
    assertPublicKey
    createNoopSigner
    createNullEddsa
    createNullSigner
    createSignerFromKeypair
    generatedSignerIdentity
    generatedSignerPayer
    generateSigner
    isKeypairSigner
    isSigner
    keypairIdentity
    keypairPayer
    publicKey
    signAllTransactions
    signerIdentity
    signerPayer
    signTransaction
    uniqueSigners

    Serializers

    baseX
    bitArray
    fixSerializer
    mapSerializer
    reverseSerializer
    createNullSerializer

    Transactions

    TransactionBuilder
    Transaction
    TransactionMessage
    AccountMeta
    AddressLookupTableInput
    Blockhash
    BlockhashWithExpiryBlockHeight
    CompiledAddressLookupTable
    CompiledInstruction
    HasWrappedInstructions
    Instruction
    SerializedTransaction
    SerializedTransactionMessage
    SignerMeta
    TransactionBuilderItemsInput
    TransactionBuilderOptions
    TransactionBuilderSendAndConfirmOptions
    TransactionError
    TransactionInput
    TransactionInputBase
    TransactionInputLegacy
    TransactionInputV0
    TransactionMessageHeader
    TransactionMeta
    TransactionMetaInnerInstruction
    TransactionMetaLoadedAddresses
    TransactionMetaTokenBalance
    TransactionSignature
    TransactionStatus
    TransactionVersion
    TransactionWithMeta
    WrappedInstruction
    TRANSACTION_SIZE_LIMIT
    addTransactionSignature
    createNullTransactionFactory
    transactionBuilder

    Rpc

    Commitment
    RpcAccountExistsOptions
    RpcAirdropOptions
    RpcBaseOptions
    RpcCallOptions
    RpcConfirmTransactionOptions
    RpcConfirmTransactionResult
    RpcConfirmTransactionStrategy
    RpcDataFilter
    RpcDataFilterMemcmp
    RpcDataFilterSize
    RpcDataSlice
    RpcGetAccountOptions
    RpcGetAccountsOptions
    RpcGetBalanceOptions
    RpcGetBlockTimeOptions
    RpcGetLatestBlockhashOptions
    RpcGetProgramAccountsOptions
    RpcGetRentOptions
    RpcGetSignatureStatusesOptions
    RpcGetSlotOptions
    RpcGetTransactionOptions
    RpcGetTransactionResponseOther
    RpcGetVersionedBlockOptions
    RpcResultWithContext
    RpcSendTransactionOptions
    RpcSimulateTransactionAccountInfo
    RpcSimulateTransactionOptions
    RpcSimulateTransactionReplacementBlockhash
    RpcSimulateTransactionResult
    RpcSimulateTransactionTransactionReturnData
    createNullRpc

    Http

    HttpRequestBuilder
    HttpHeaderContentTypeValue
    HttpHeaders
    HttpHeaderValue
    HttpMethod
    HttpRequest
    HttpRequestHeaders
    HttpResponse
    HttpResponseHeaders
    createNullHttp
    request

    Storage

    BrowserFile
    DownloaderOptions
    GenericFile
    GenericFileOptions
    GenericFileTag
    UploaderGetUploadPriceOptions
    UploaderUploadOptions
    createBrowserFileFromGenericFile
    createGenericFile
    createGenericFileFromBrowserFile
    createGenericFileFromJson
    createNullDownloader
    createNullUploader
    getBytesFromGenericFiles
    isGenericFile
    parseJsonFromGenericFile

    Programs

    ErrorWithCode
    ErrorWithLogs
    Program
    createNullProgramRepository
    isErrorWithLogs

    Accounts

    Account
    AccountHeader
    MaybeRpcAccount
    RpcAccount
    ACCOUNT_HEADER_SIZE
    assertAccountExists
    deserializeAccount

    Errors

    AccountNotFoundError
    AmountMismatchError
    InterfaceImplementationMissingError
    InvalidBaseStringError
    InvalidPublicKeyError
    ProgramError
    SdkError
    UmiError
    UnexpectedAccountError
    UnexpectedAmountError
    UmiErrorSource
    UnderlyingProgramError

    Other

    TransactionBuilderGroup
    ArrayLikeSerializerSize
    ArraySerializerOptions
    BaseSerializerOptions
    BoolSerializerOptions
    BytesSerializerOptions
    DataEnum
    DataEnumSerializerOptions
    DataEnumToSerializerTuple
    EnumSerializerOptions
    GetDataEnumKind
    GetDataEnumKindContent
    MapSerializerOptions
    NullableSerializerOptions
    NumberSerializer
    NumberSerializerOptions
    OptionSerializerOptions
    PublicKeySerializerOptions
    ScalarEnum
    Serializer
    SetSerializerOptions
    SingleByteNumberSerializerOptions
    StringSerializerOptions
    StructSerializerOptions
    StructToSerializerTuple
    TransactionBuilderGroupOptions
    TupleSerializerOptions
    UnitSerializerOptions
    WrapInSerializer
    base10
    base16
    base58
    base64
    Endian
    utf8
    createUmi
    transactionBuilderGroup

    Utils

    GenericAbortSignal
    fixBytes
    mergeBytes
    padBytes
    padNullCharacters
    removeNullCharacters
    chunk
    generateRandomString
    uniqueBy
    zipMap

    Utils — Amounts

    Amount
    AmountDecimals
    AmountIdentifier
    BigIntInput
    MicroSolAmount
    PercentAmount
    SolAmount
    UsdAmount
    absoluteAmount
    addAmounts
    amountToNumber
    amountToString
    assertAmount
    assertSameAmounts
    assertSolAmount
    compareAmounts
    createAmount
    createAmountFromDecimals
    createBigInt
    displayAmount
    divideAmount
    isAmount
    isEqualToAmount
    isGreaterThanAmount
    isGreaterThanOrEqualToAmount
    isLessThanAmount
    isLessThanOrEqualToAmount
    isNegativeAmount
    isPositiveAmount
    isSolAmount
    isZeroAmount
    lamports
    mapAmountSerializer
    microLamports
    microSol
    multiplyAmount
    percentAmount
    sameAmounts
    sol
    subtractAmounts
    tokenAmount
    usd

    Utils — Cluster

    Cluster
    ClusterFilter
    resolveClusterFromEndpoint

    Utils — DateTime

    DateTime
    DateTimeInput
    DateTimeString
    dateTime
    formatDateTime
    mapDateTimeSerializer
    now

    Utils — GpaBuilder

    GpaBuilder
    GpaBuilderFieldSerializers
    GpaBuilderMapCallback
    GpaBuilderSortCallback
    gpaBuilder

    Utils — Options

    None
    Nullable
    Nullish
    Option
    OptionOrNullable
    Some
    UnwrappedOption
    isNone
    isOption
    isSome
    none
    some
    unwrapSome
    unwrapSomeOrElse
    wrapNullable
    wrapNullish
    unwrapOption
    unwrapOptionRecursively