Preparing search index...
The search index is not available
Umi — API References
Umi — API References
umi
assertPublicKey
Function assertPublicKey
assert
Public
Key
<
TAddress
>
(
value
:
TAddress
)
:
asserts
value
is
PublicKey
<
TAddress
>
Ensures the given value is a valid public key.
Type Parameters
TAddress
extends
string
Parameters
value:
TAddress
Returns
asserts
value
is
PublicKey
<
TAddress
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
Umi — API
References
umi -
v1.0.0
umi-
bundle-
defaults -
v1.0.0
umi-
bundle-
tests -
v1.0.0
umi-
downloader-
http -
v1.0.0
umi-
eddsa-
web3js -
v1.0.1
umi-
http-
fetch -
v1.0.0
umi-
options -
v1.0.0
umi-
program-
repository -
v1.0.0
umi-
public-
keys -
v1.0.0
umi-
rpc-
chunk-
get-
accounts -
v1.0.0
umi-
rpc-
web3js -
v1.0.0
umi-
serializer-
beet -
v1.0.0
umi-
serializer-
data-
view -
v1.0.0
umi-
serializers -
v1.0.0
umi-
serializers-
core -
v1.0.0
umi-
serializers-
encodings -
v1.0.0
umi-
serializers-
numbers -
v1.0.0
umi-
signer-
derived -
v1.0.0
umi-
signer-
wallet-
adapters -
v1.0.0
umi-
storage-
mock -
v1.0.0
umi-
tasks -
v1.0.0
umi-
transaction-
factory-
web3js -
v1.0.0
umi-
uploader-
arweave-
via-
turbo -
v1.0.0
umi-
uploader-
aws -
v1.0.0
umi-
uploader-
cascade -
v1.0.0
umi-
uploader-
irys -
v1.0.0
umi-
uploader-
nft-
storage -
v1.0.0
umi-
web3js-
adapters -
v1.0.0
Account
Not
Found
Error
Amount
Mismatch
Error
Gpa
Builder
Http
Request
Builder
Interface
Implementation
Missing
Error
Invalid
Base
String
Error
Invalid
Public
Key
Error
Program
Error
Sdk
Error
Transaction
Builder
Transaction
Builder
Group
Umi
Error
Unexpected
Account
Error
Unexpected
Amount
Error
Context
Downloader
Interface
Eddsa
Interface
Generic
Abort
Signal
Http
Interface
Program
Repository
Interface
Rpc
Interface
Serializer
Interface
Signer
Transaction
Transaction
Factory
Interface
Transaction
Message
Umi
Uploader
Interface
Account
Account
Header
Account
Meta
Address
Lookup
Table
Input
Amount
Amount
Decimals
Amount
Identifier
Array
Like
Serializer
Size
Array
Serializer
Options
Base
Serializer
Options
Big
Int
Input
Blockhash
Blockhash
With
Expiry
Block
Height
Bool
Serializer
Options
Browser
File
Bytes
Serializer
Options
Cluster
Cluster
Filter
Commitment
Compiled
Address
Lookup
Table
Compiled
Instruction
Data
Enum
Data
Enum
Serializer
Options
Data
Enum
To
Serializer
Tuple
Date
Time
Date
Time
Input
Date
Time
String
Downloader
Options
Enum
Serializer
Options
Error
With
Code
Error
With
Logs
Generic
File
Generic
File
Options
Generic
File
Tag
Get
Data
Enum
Kind
Get
Data
Enum
Kind
Content
Gpa
Builder
Field
Serializers
Gpa
Builder
Map
Callback
Gpa
Builder
Sort
Callback
Has
Public
Key
Has
Wrapped
Instructions
Http
Header
Content
Type
Value
Http
Header
Value
Http
Headers
Http
Method
Http
Request
Http
Request
Headers
Http
Response
Http
Response
Headers
Instruction
Keypair
Keypair
Signer
Legacy
Web3
Js
Public
Key
Map
Serializer
Options
Maybe
Rpc
Account
None
Nullable
Nullable
Serializer
Options
Nullish
Number
Serializer
Number
Serializer
Options
Option
Option
Or
Nullable
Option
Serializer
Options
Pda
Percent
Amount
Program
Public
Key
Public
Key
Bytes
Public
Key
Input
Public
Key
Serializer
Options
Rpc
Account
Rpc
Account
Exists
Options
Rpc
Airdrop
Options
Rpc
Base
Options
Rpc
Call
Options
Rpc
Confirm
Transaction
Options
Rpc
Confirm
Transaction
Result
Rpc
Confirm
Transaction
Strategy
Rpc
Data
Filter
Rpc
Data
Filter
Memcmp
Rpc
Data
Filter
Size
Rpc
Data
Slice
Rpc
Get
Account
Options
Rpc
Get
Accounts
Options
Rpc
Get
Balance
Options
Rpc
Get
Block
Time
Options
Rpc
Get
Latest
Blockhash
Options
Rpc
Get
Program
Accounts
Options
Rpc
Get
Rent
Options
Rpc
Get
Signature
Statuses
Options
Rpc
Get
Slot
Options
Rpc
Get
Transaction
Options
Rpc
Get
Versioned
Block
Options
Rpc
Result
With
Context
Rpc
Send
Transaction
Options
Rpc
Simulate
Transaction
Account
Info
Rpc
Simulate
Transaction
Options
Rpc
Simulate
Transaction
Result
Rpc
Simulate
Transaction
Transaction
Return
Data
Safe
Public
Key
Input
Scalar
Enum
Serialized
Transaction
Serialized
Transaction
Message
Serializer
Set
Serializer
Options
Signer
Meta
Single
Byte
Number
Serializer
Options
Sol
Amount
Some
String
Serializer
Options
Struct
Serializer
Options
Struct
To
Serializer
Tuple
Transaction
Builder
Group
Options
Transaction
Builder
Items
Input
Transaction
Builder
Options
Transaction
Builder
Send
And
Confirm
Options
Transaction
Error
Transaction
Input
Transaction
Input
Base
Transaction
Input
Legacy
Transaction
Input
V0
Transaction
Message
Header
Transaction
Meta
Transaction
Meta
Inner
Instruction
Transaction
Meta
Loaded
Addresses
Transaction
Meta
Token
Balance
Transaction
Signature
Transaction
Status
Transaction
Version
Transaction
With
Meta
Tuple
Serializer
Options
Umi
Error
Source
Umi
Plugin
Underlying
Program
Error
Unit
Serializer
Options
Unwrapped
Option
Uploader
Get
Upload
Price
Options
Uploader
Upload
Options
Usd
Amount
Wrap
In
Serializer
Wrapped
Instruction
ACCOUNT_
HEADER_
SIZE
Endian
PUBLIC_
KEY_
LENGTH
TRANSACTION_
SIZE_
LIMIT
base10
base16
base58
base64
utf8
absolute
Amount
add
Amounts
add
Transaction
Signature
amount
To
Number
amount
To
String
assert
Account
Exists
assert
Amount
assert
Public
Key
assert
Same
Amounts
assert
Sol
Amount
base58
Public
Key
baseX
bit
Array
chunk
compare
Amounts
create
Amount
create
Amount
From
Decimals
create
Big
Int
create
Browser
File
From
Generic
File
create
Generic
File
create
Generic
File
From
Browser
File
create
Generic
File
From
Json
create
Noop
Signer
create
Null
Context
create
Null
Downloader
create
Null
Eddsa
create
Null
Http
create
Null
Program
Repository
create
Null
Rpc
create
Null
Serializer
create
Null
Signer
create
Null
Transaction
Factory
create
Null
Uploader
create
Signer
From
Keypair
create
Umi
date
Time
default
Public
Key
deserialize
Account
display
Amount
divide
Amount
fix
Bytes
fix
Serializer
format
Date
Time
generate
Random
String
generate
Signer
generated
Signer
Identity
generated
Signer
Payer
get
Bytes
From
Generic
Files
gpa
Builder
is
Amount
is
Equal
To
Amount
is
Error
With
Logs
is
Generic
File
is
Greater
Than
Amount
is
Greater
Than
Or
Equal
To
Amount
is
Keypair
Signer
is
Less
Than
Amount
is
Less
Than
Or
Equal
To
Amount
is
Negative
Amount
is
None
is
Option
is
Pda
is
Positive
Amount
is
Public
Key
is
Signer
is
Sol
Amount
is
Some
is
Zero
Amount
keypair
Identity
keypair
Payer
lamports
map
Amount
Serializer
map
Date
Time
Serializer
map
Serializer
merge
Bytes
multiply
Amount
none
now
pad
Bytes
pad
Null
Characters
parse
Json
From
Generic
File
percent
Amount
public
Key
public
Key
Bytes
remove
Null
Characters
request
resolve
Cluster
From
Endpoint
reverse
Serializer
same
Amounts
same
Public
Key
sign
All
Transactions
sign
Transaction
signer
Identity
signer
Payer
sol
some
subtract
Amounts
token
Amount
transaction
Builder
transaction
Builder
Group
unique
By
unique
Public
Keys
unique
Signers
unwrap
Option
unwrap
Option
Recursively
unwrap
Some
unwrap
Some
Or
Else
usd
wrap
Nullable
wrap
Nullish
zip
Map
Generated using
TypeDoc
Ensures the given value is a valid public key.