Documentation

Chung Tran edited this page May 17, 2022 · 1 revision

Types

Protocols

APIClientRequest
APIClientRequestEncoder: Encoder used to encode request in able to use with the transport
APIClientResponse
SolanaAccountStorage
FeeCalculator
BorshDeserializable
BorshSerializable
BytesEncodable
BufferLayout
SolanaBasicProgram
WebSocketTaskProvider: The abstract websocket task provider, default is URLSession
SolanaSocketEventsDelegate: Delegate for listening socket's events

Global Typealiases

ResponseDecoder
RequestEncoder
Bignum: Bignum compatibility alias for BInt
BorshCodable
Int1X
Int128
Int256
Int512
Int1024
UInt1X
UInt128
UInt256
UInt512
UInt1024
TransactionID
Lamports
Decimals
TransactionError
Commitment
SPLTokenDestinationAddress
SocketLogsNotification
SocketNativeAccountNotification
SocketProgramAccountNotification
SocketSignatureNotification
SocketSubscriptionResponse
SocketTokenAccountNotification
SocketUnsubscriptionResponse

Global Functions

getMinimumBalanceForRentExemption(span:)
getRecentBlockhash()
observeSignatureStatus(signature:)
getMultipleMintDatas(mintAddresses:programId:)
checkIfAssociatedTokenAccountExists(owner:mint:)
checkAccountValidation(account:): Method checks account validation
findSPLTokenDestinationAddress(mintAddress:destinationAddress:)
getTokenWallets(account:tokensRepository:): Method retrieves token wallets
getAccountInfo(account:)
getBlockHeight()
getConfirmedBlocksWithLimit(startSlot:limit:)
getBalance(account:commitment:)
getBlockCommitment(block:)
getBlockTime(block:)
getClusterNodes()
getConfirmedBlock(slot:encoding:)
getConfirmedSignaturesForAddress(account:startSlot:endSlot:)
getTransaction(transactionSignature:)
getEpochInfo(commitment:)
getFees(commitment:)
getMinimumBalanceForRentExemption(dataLength:commitment:)
getRecentBlockhash(commitment:)
getSignatureStatuses(signatures:configs:)
getSignatureStatus(signature:configs:)
getTokenAccountBalance(pubkey:commitment:)
getTokenAccountsByDelegate(pubkey:mint:programId:configs:)
getTokenAccountsByOwner(pubkey:params:configs:)
getTokenLargestAccounts(pubkey:commitment:)
getTokenSupply(pubkey:commitment:)
getVersion()
getVoteAccounts(commitment:)
minimumLedgerSlot()
requestAirdrop(account:lamports:commitment:)
sendTransaction(transaction:configs:)
simulateTransaction(transaction:configs:)
observeSignatureStatus(signature:timeout:delay:)
setLogFilter(filter:)
validatorExit()
getMultipleAccounts(pubkeys:)
request(with:)
request(with:)
prepareCreatingWSOLAccountAndCloseWhenDone(from:amount:payer:minRentExemption:): Prepare instructions for creating WSOL account and close it after finishing transaction to return funds back to native SOL account
prepareForCreatingAssociatedTokenAccount(owner:mint:feePayer:closeAfterward:): Prepare instructions for creating associated token account and close if needed
prepareTransaction(instructions:signers:feePayer:feeCalculator:)
prepareSendingNativeSOL(from:to:amount:feePayer:): Create prepared transaction for sending SOL
prepareSendingSPLTokens(account:mintAddress:decimals:from:to:amount:feePayer:transferChecked:lamportsPerSignature:minRentExemption:)
abs(_:)
sha256(data:)
sendTransaction(preparedTransaction:)
simulateTransaction(preparedTransaction:)
requestData(request:)
connect(): Connect to socket
disconnect(): Disconnect from socket
subscribe(type:params:commitment:): Subscribe to an entity ('account', 'program', 'signature', for example)
unsubscribe(type:socketId:): Unsubscribe to an entity ('account', 'program', 'signature', for example)
parse(network:)
getTokensList(useCache:): Returns all tokens

Global Variables

endpoint
apiClient
phrase
publicKey
secretKey
isConnected: Connection status of the socket
delegate: Delegation

Operators

Extensions

Generated at 2022-05-17T08:44:22+0000 using swift-doc 1.0.0-rc.1.