@armada/sdk / index
index
Enumerations
Classes
- ArmadaError
- RootMismatchError
- NoteAlreadySpentError
- FeeQuoteExpiredError
- ArtifactIntegrityError
- StorageConflictError
- StorageUnavailableError
- NoSpendCapabilityError
- InsufficientBalanceError
- RpcError
- QuickSyncSchemaError
- IndexerHttpError
- PositionGapError
- ArtifactFetchError
- InvalidKeyMaterialError
- ProofVerificationError
- UnsupportedCircuitShapeError
- TooFragmentedError
- NothingToConsolidateError
- AbortedError
- InstanceClosedError
- ProverWorkerError
- ProofHandleInvalidatedError
- ProofExpiredError
- InvalidRequestError
- InvalidConfigError
- SignerContractViolationError
- InternalError
- IndexedDbArtifactCache
- HttpArtifactSource
- VerifiedArtifactSource
- IndexedDBStorageAdapter
- LevelStorageAdapter
- MemoryStorageAdapter
- ExternalSigner
- LocalSigner
Interfaces
- QuickSyncTelemetry
- ArmadaErrorByCode
- PoolConfig
- RpcConfig
- TelemetryEventMap
- TelemetrySink
- ArmadaSdkConfig
- ArmadaSdk
- ArtifactDigest
- WorkerChannel
- BrowserWorkerLike
- IndexedDBStorageAdapterOptions
- AbstractLevelLike
- TXO
- SpentNullifier
- TokenBalance
- DecodedShieldCommitment
- DecodedTransactCommitment
- DecodedNullifier
- DecodedUnshield
- DecodedPoolEvents
- SentRecipient
- HistoryEntry
- ReconstructHistoryInput
- CommitmentCiphertextV2
- SenderNoteKeys
- ReceiverNoteKeys
- WireTokenData
- WireShieldCommitment
- WireCommitmentCiphertext
- WireTransactCommitment
- WireNullifier
- WireUnshield
- QuickSyncResponse
- SentOutput
- ShieldData
- CrossChainShieldIntent
- CrossChainShieldIntentTypedData
- GaslessCrossChainShieldInput
- ShieldIntent
- ShieldIntentTypedData
- GaslessShieldInput
- PermitMessage
- PermitTypedData
- PreflightFinding
- PreflightResult
- TransactionBoundParams
- TransactionData
- ShieldFeeTiers
- ShieldRequestInput
- ShieldRequest
- SpendFee
- SpendIntentContext
- ShieldCiphertextArg
- GaslessShieldParams
- GaslessCrossChainShieldParams
- Keyset
- ShareableViewingKeyMaterial
- ViewOnlyIdentity
- TokenDataGetter
Type Aliases
- QuickSyncReason
- ErrorCode
- ReorgRecoveryReason
- TelemetryEvent
- HttpArtifactSourceOptions
- ArtifactManifest
- ProverWorkerRequest
- ProverWorkerReply
- NoteOrigin
- Unsubscribe
- HistoryCategory
- TokenAddressResolver
- PreflightCheck
- FeeOperation
- SignBackend
- PublicKeyBackend
- AddressData
- Chain
- Ciphertext
- TokenData
Variables
- ERROR_CODES
- VERSION
- DEFAULT_EVM_CHAIN
- QUICK_SYNC_SCHEMA_VERSION
- CCTP_UNSHIELD_DOMAIN_TAG
- TRANSACTION_STRUCT
- TRANSACT_ABI
- getTokenDataERC20
- getTokenDataHash
- initPoseidonPromise
Functions
- isArmadaError
- shapeKey
- artifactDigest
- verifyArtifactIntegrity
- createSnarkjsProver
- createProverWorkerHandler
- createWorkerProver
- webWorkerChannel
- createArmadaSdk
- erc20AddressFromHash
- reconstructReceiveHistory
- reconstructHistory
- createTransferNote
- encryptNoteToReceiver
- tryDecryptCommitment
- tryDecryptSentCommitment
- serializeQuickSync
- parseQuickSync
- encodeSelfMetadata
- decodeSelfMetadata
- encodeCctpBinding
- verifyCctpBinding
- encodeYieldDepositBinding
- verifyYieldDepositBinding
- encodeYieldRedeemBinding
- verifyYieldRedeemBinding
- decodeTransact
- extractFeeOutput
- hashShieldData
- shieldDataFromRequest
- buildCrossChainShieldIntentTypedData
- buildGaslessCrossChainShield
- hashCrossChainShieldIntent
- hashShieldRequests
- buildShieldIntentTypedData
- hashShieldIntent
- buildGaslessShield
- buildPermitTypedData
- hashPermit
- assertPreflight
- isCrossChainUnshield
- transactionToTuple
- buildTransactCalldata
- shieldFee
- shieldNet
- grossUpShieldFee
- reconstructShieldNpk
- verifyShieldFeeNote
- generateShieldPrivateKey
- buildShieldRequest
- feeForOperation
- computeSpendIntentDigest
- buildAtomicCrossChainUnshieldCalldata
- buildLendAndShieldCalldata
- buildRedeemAndShieldCalldata
- buildGaslessShieldCalldata
- buildGaslessCrossChainShieldCalldata
- decodeGaslessShieldCalldata
- decodeGaslessCrossChainShieldCalldata
- deriveKeysetFromMnemonic
- deriveKeyset
- encodeShareableViewingKey
- decodeShareableViewingKey
- deriveViewOnlyIdentity
- encodeAddress
- decodeAddress
References
SyncEventMap
Re-exports SyncEventMap
CircuitShape
Re-exports CircuitShape
ArtifactSet
Re-exports ArtifactSet
ArtifactSource
Re-exports ArtifactSource
ArtifactResolveOptions
Re-exports ArtifactResolveOptions
ProofProgress
Re-exports ProofProgress
Groth16Proof
Re-exports Groth16Proof
ProveOptions
Re-exports ProveOptions
ProverAdapter
Re-exports ProverAdapter
StorageNamespace
Re-exports StorageNamespace
StorageOp
Re-exports StorageOp
StorageWriteOptions
Re-exports StorageWriteOptions
StorageAdapter
Re-exports StorageAdapter
FeeQuote
Re-exports FeeQuote
CctpBinding
Re-exports CctpBinding
DecodedBoundParams
Re-exports DecodedBoundParams
PlanOutput
Re-exports PlanOutput
PlanSummary
Re-exports PlanSummary
PlanSelection
Re-exports PlanSelection
Plan
Re-exports Plan
TransactCalldata
Re-exports TransactCalldata
ProofHandle
Re-exports ProofHandle
AdaptParamsEncoders
Re-exports AdaptParamsEncoders
DecodedTransact
Re-exports DecodedTransact
BroadcasterIdentity
Re-exports BroadcasterIdentity
TransactDecoder
Re-exports TransactDecoder
EddsaSignature
Re-exports EddsaSignature
SpendSignRequest
Re-exports SpendSignRequest
SpendSignOptions
Re-exports SpendSignOptions
SpendSigner
Re-exports SpendSigner
Wallet
Re-exports Wallet
PlanTransferRequest
Re-exports PlanTransferRequest
MaxTransferRequest
Re-exports MaxTransferRequest
MaxUnshieldRequest
Re-exports MaxUnshieldRequest
ConsolidateRequest
Re-exports ConsolidateRequest
WalletFactory
Re-exports WalletFactory