Module umi - v0.9.2

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.

Documentation

[!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!

Index

Context and Interfaces

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

Signers and PublicKeys

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

Serializers

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 RpcResultWithContext RpcSendTransactionOptions createNullRpc

Http

HttpRequestBuilder HttpHeaderContentTypeValue HttpHeaderValue HttpHeaders 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 Endian base10 base16 base58 base64 utf8 baseX bitArray fixBytes fixSerializer mapSerializer mergeBytes padBytes padNullCharacters removeNullCharacters reverseSerializer transactionBuilderGroup

Utils

GenericAbortSignal chunk generateRandomString uniqueBy zipMap

Utils — Amounts

Amount AmountDecimals AmountIdentifier BigIntInput 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 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 unwrapOption unwrapOptionRecursively unwrapSome unwrapSomeOrElse wrapNullable wrapNullish

Settings

Member Visibility

Theme

Generated using TypeDoc