Main Navigation Guide API

Appearance

Sidebar Navigation

API reference

core

Enumerations

TokenType

OutputType

TXIDVersion

Classes

Babyjubjub

Mnemonic

WalletNode

ShieldNoteERC20

UnshieldNoteERC20

ShieldNote

TransactNote

Type Aliases

SpendingPublicKey

SpendingKeyPair

ViewingKeyPair

Variables

WalletInfo

deriveNodes

hashLeftRight

createDummyMerkleProof

verifyMerkleProof

TREE_DEPTH

MERKLE_ZERO_VALUE_BIGINT

MERKLE_ZERO_VALUE

hashBoundParamsV2

hashBoundParamsV3

poseidon

poseidonHex

initCurve25519Promise

Functions

encodeAddress

decodeAddress

getPublicSpendingKey

getPublicViewingKey

signEDDSA

verifyEDDSA

getNoteBlindingKeys

getSharedSymmetricKey

index

Enumerations

ChainType

Classes

ArmadaError

RootMismatchError

NoteAlreadySpentError

FeeQuoteExpiredError

ArtifactIntegrityError

StorageConflictError

NonDeterministicSignerError

ClaimSeedCounterError

NoSpendCapabilityError

InsufficientBalanceError

QuickSyncSchemaError

InvalidKeyMaterialError

ProofVerificationError

UnsupportedCircuitShapeError

AbortedError

ProofHandleInvalidatedError

ProofExpiredError

InvalidRequestError

SignerContractViolationError

IndexedDbArtifactCache

FilesystemArtifactSource

HttpArtifactSource

VerifiedArtifactSource

EncryptedStore

IndexedDBStorageAdapter

LevelStorageAdapter

MemoryStorageAdapter

SyncEmitter

RpcEventSource

IndexerEventSource

UTXOMerkletree

WalletScanState

ExternalSigner

LocalSigner

Interfaces

PoolConfig

RpcConfig

TelemetrySink

ArmadaSdkConfig

ArmadaSdk

ArtifactDigest

WorkerChannel

BrowserWorkerLike

AbstractLevelLike

TXO

SpentNullifier

TokenBalance

BalanceOptions

LogMeta

RawShieldArgs

RawTransactArgs

RawNullifiedArgs

DecodedShieldCommitment

DecodedTransactCommitment

DecodedNullifier

DecodedPoolEvents

ParsedPoolLog

IndexerEventSourceOptions

SentRecipient

HistoryEntry

ReconstructHistoryInput

MerkleProof

CommitmentCiphertextV2

SenderNoteKeys

ReceiverNoteKeys

WireTokenData

WireShieldCommitment

WireCommitmentCiphertext

WireTransactCommitment

WireNullifier

QuickSyncResponse

RangedFetchOptions

OwnedNote

SentOutput

WalletDecryptors

ApplyResult

ScanStateSnapshot

ShieldData

CrossChainShieldIntent

CrossChainShieldIntentTypedData

GaslessCrossChainShieldInput

ShieldIntent

ShieldIntentTypedData

GaslessShieldInput

PermitMessage

PermitTypedData

TransferOutputRequest

FeeRequest

PlanTransferParams

PreflightFinding

PreflightResult

PreflightQueries

PreflightParams

ProveParams

TransactionBoundParams

TransactionData

ShieldFeeTiers

ShieldRequestInput

ShieldRequest

SpendIntentContext

WitnessInput

WitnessOutputRequest

WitnessSenderContext

BuildWitnessParams

FormattedCircuitInputs

BuiltWitness

ShieldCiphertextArg

Keyset

ShareableViewingKeyMaterial

ViewOnlyIdentity

TokenDataGetter

Type Aliases

ArtifactManifest

ProverWorkerRequest

ProverWorkerReply

Unsubscribe

HistoryCategory

TokenAddressResolver

GetLogsFn

Decryptor

PreflightCheck

SignBackend

PublicKeyBackend

AddressData

Chain

Ciphertext

TokenData

Variables

VERSION

POOL_V2_EVENT_ABI

DEFAULT_EVM_CHAIN

QUICK_SYNC_SCHEMA_VERSION

CCTP_UNSHIELD_DOMAIN_TAG

TRANSACTION_STRUCT

TRANSACT_ABI

getTokenDataERC20

getTokenDataHash

initPoseidonPromise

Functions

shapeKey

artifactDigest

verifyArtifactIntegrity

createSnarkjsProver

createProverWorkerHandler

createWorkerProver

webWorkerChannel

createArmadaSdk

deriveStorageKey

deriveWalletStorageKey

computeBalances

tokenHashKey

withTokenAddresses

txoFromNote

formatCommitmentCiphertext

formatShieldEvent

formatTransactEvent

formatNullifiedEvent

decodePoolEvents

ownSpendTxids

newReceivedNotes

reconstructReceiveHistory

reconstructHistory

createTransferNote

encryptNoteToReceiver

tryDecryptCommitment

decryptedCommitmentMatches

tryDecryptSentCommitment

serializeQuickSync

parseQuickSync

fetchLogsRanged

ownedNoteFromTransactNote

scanStateKey

saveScanState

loadScanState

tryDecryptShield

encodeCctpBinding

verifyCctpBinding

encodeYieldDepositBinding

verifyYieldDepositBinding

encodeYieldRedeemBinding

verifyYieldRedeemBinding

decodeTransact

extractFeeOutput

hashShieldData

buildGaslessCrossChainShield

hashCrossChainShieldIntent

hashShieldRequests

buildShieldIntentTypedData

hashShieldIntent

buildGaslessShield

buildPermitTypedData

hashPermit

planTransfer

planWitnessInputs

readShieldsPaused

runPreflight

prove

transactionToTuple

buildTransactCalldata

shieldFee

shieldNet

grossUpShieldFee

reconstructShieldNpk

verifyShieldFeeNote

generateShieldPrivateKey

buildShieldRequest

hashSpendBoundParams

computeSpendIntentDigest

buildWitness

buildAtomicCrossChainUnshieldCalldata

buildLendAndShieldCalldata

buildRedeemAndShieldCalldata

deriveKeysetFromMnemonic

deriveKeyset

encodeShareableViewingKey

decodeShareableViewingKey

deriveViewOnlyIdentity

prover

Interfaces

CircuitShape

ArtifactSet

ArtifactSource

ProofProgress

Groth16Proof

ProveOptions

ProverAdapter

storage

Interfaces

StorageNamespace

StorageAdapter

sync

Interfaces

EventBatch

EventSource

SyncStatus

SyncEventMap

tx

Interfaces

FeeQuote

CctpBinding

DecodedBoundParams

PlanOutput

PlanSummary

PlanSelection

Plan

TransactCalldata

ProofHandle

AdaptParamsEncoders

DecodedTransact

TransactDecoder

Type Aliases

BroadcasterIdentity

wallet

Interfaces

SpendSignRequest

SpendSigner

Wallet

PlanTransferRequest

WalletFactory

Type Aliases

EddsaSignature

On this page

@armada/sdk

Modules

core
index
prover
storage
sync
tx
wallet

Edit this page on GitHub

Pager

Next pagecore

@armada/sdk ​

Modules ​

@armada/sdk

Modules