Skip to content
SIP Protocol
Search
Ctrl
K
Cancel
GitHub
Twitter
Select theme
Dark
Light
Auto
Getting Started
Introduction
Quick Start
Architecture
Guides
Solver Integration
API Migration
SDK Cookbook
Basic Swap with Privacy
Custom Privacy Levels
Viewing Key Management
Multi-Party Disclosure
Stealth Address Scanning
Compliance Reporting
Batch Transactions
Error Handling Patterns
Wallet Integration
Testing with Mocks
Concepts
Privacy Levels
Stealth Addresses
Viewing Keys
Specifications
SIP Specification
ZK Architecture
Funding Proof
Validity Proof
Fulfillment Proof
Wallet Adapter
Integrations
NEAR Intents
Zcash Integration
Zcash Evaluation
Security
Threat Model
Security Properties
Known Limitations
Audit Preparation
Resources
Roadmap
Whitepaper
FAQ
Glossary
Comparison
Changelog
API Reference
API Reference
classes
AptosStealthService
AuditorKeyDerivation
Abstract Class: BaseWalletAdapter
ComplianceManager
ComplianceReporter
ConditionalDisclosure
CosmosStealthService
CryptoError
~~Class: EncryptionNotImplementedError~~
EthereumWalletAdapter
HardwareWalletError
IntentBuilder
IntentError
LedgerWalletAdapter
MockEthereumAdapter
MockLedgerAdapter
MockProofProvider
MockSolanaAdapter
MockSolver
MockTrezorAdapter
MockWalletAdapter
NEARIntentsAdapter
NEARIntentsBackend
NetworkError
OneClickClient
PaymentBuilder
PrivateNFT
PrivateVoting
ProofError
ProofGenerationError
ProofNotImplementedError
SealedBidAuction
SettlementRegistry
SettlementRegistryError
SIP
SIPError
SmartRouter
SolanaSameChainExecutor
SolanaWalletAdapter
SuiStealthService
ThresholdViewingKey
Treasury
TrezorWalletAdapter
ValidationError
WalletError
ZcashNativeBackend
ZcashRPCClient
ZcashRPCError
ZcashShieldedService
ZcashSwapService
enumerations
AuditorType
ErrorCode
IntentStatus
OneClickDepositMode
OneClickErrorCode
OneClickSwapStatus
OneClickSwapType
PrivacyLevel
SwapStatus
functions
addBlindings()
addCommitments()
addOracle()
aptosAddressToAuthKey()
attachProofs()
base58ToHex()
browserBytesToHex()
browserHexToBytes()
checkAptosStealthAddress()
checkEd25519StealthAddress()
checkStealthAddress()
checkSuiStealthAddress()
claimStealthPayment()
commit()
commitZero()
computeAttestationHash()
computeTweakedKey()
createAnnouncementMemo()
~~Function: createCommitment()~~
createEthereumAdapter()
createKeySpendOnlyOutput()
createLedgerAdapter()
createMockEthereumAdapter()
createMockEthereumProvider()
createMockLedgerAdapter()
createMockSolanaAdapter()
createMockSolanaConnection()
createMockSolanaProvider()
createMockSolver()
createMockTrezorAdapter()
createNEARIntentsAdapter()
createNEARIntentsBackend()
createOracleRegistry()
createPrivateOwnership()
createPrivateVoting()
createProductionSIP()
createSameChainExecutor()
createSealedBidAuction()
createShieldedIntent()
createShieldedPayment()
createSIP()
createSmartRouter()
createSolanaAdapter()
createTaprootOutput()
createTrezorAdapter()
createWalletFactory()
createZcashClient()
createZcashNativeBackend()
createZcashShieldedService()
createZcashSwapService()
decodeStealthMetaAddress()
decodeTaprootAddress()
decryptMemo()
decryptWithViewing()
deriveAptosStealthPrivateKey()
deriveEd25519StealthPrivateKey()
deriveOracleId()
deriveStealthPrivateKey()
deriveSuiStealthPrivateKey()
deriveViewingKey()
deserializeAttestationMessage()
deserializeIntent()
deserializePayment()
detectEthereumWallets()
detectSolanaWallets()
ed25519PublicKeyToAptosAddress()
ed25519PublicKeyToNearAddress()
ed25519PublicKeyToSolanaAddress()
ed25519PublicKeyToSuiAddress()
encodeStealthMetaAddress()
encryptForViewing()
estimatePrivateTransferFee()
featureNotSupportedError()
formatStablecoinAmount()
fromHex()
fromStablecoinUnits()
generateAptosStealthAddress()
generateBlinding()
generateCosmosStealthAddress()
generateCosmosStealthMetaAddress()
generateEd25519StealthAddress()
generateEd25519StealthMetaAddress()
generateIntentId()
generatePdfReport()
generateRandomBytes()
generateStealthAddress()
generateStealthMetaAddress()
generateSuiStealthAddress()
generateViewingKey()
getActiveOracles()
getAvailableTransports()
getBrowserInfo()
getChainNumericId()
getChainsForStablecoin()
getCurveForChain()
getDefaultRpcEndpoint()
getDerivationPath()
getErrorMessage()
getEthereumProvider()
getGenerators()
getIntentSummary()
getPaymentSummary()
getPaymentTimeRemaining()
getPrivacyConfig()
getPrivacyDescription()
getSolanaExplorerUrl()
getSolanaProvider()
getStablecoin()
getStablecoinInfo()
getStablecoinsForChain()
getStealthBalance()
getSupportedSameChainChains()
getSupportedStablecoins()
getTimeRemaining()
getTokenDecimals()
getTokenMint()
getXOnlyPublicKey()
hasEnoughOracles()
hasErrorCode()
hash()
hasRequiredProofs()
hasTokenAccount()
hexToNumber()
isBrowser()
isEd25519Chain()
isExpired()
isNonNegativeAmount()
isPaymentExpired()
isPrivate()
isPrivateWalletAdapter()
isSameChainSupported()
isSIPError()
isStablecoin()
isStablecoinOnChain()
isValidAmount()
isValidAptosAddress()
isValidChainId()
isValidCompressedPublicKey()
isValidCosmosAddress()
isValidEd25519PublicKey()
isValidHex()
isValidHexLength()
isValidNearAccountId()
isValidNearImplicitAddress()
isValidPrivacyLevel()
isValidPrivateKey()
isValidScalar()
isValidSlippage()
isValidSolanaAddress()
isValidStealthMetaAddress()
isValidSuiAddress()
isValidTaprootAddress()
nearAddressToEd25519PublicKey()
normalizeAddress()
normalizeSuiAddress()
notConnectedError()
parseAnnouncement()
proveOwnership()
publicKeyToEthAddress()
registerWallet()
removeOracle()
scanForPayments()
schnorrSign()
schnorrSignHex()
schnorrVerify()
schnorrVerifyHex()
secureWipe()
secureWipeAll()
sendPrivateSPLTransfer()
serializeAttestationMessage()
serializeIntent()
serializePayment()
signAttestationMessage()
solanaAddressToEd25519PublicKey()
solanaPublicKeyToHex()
stealthKeyToCosmosAddress()
subtractBlindings()
subtractCommitments()
supportsSharedArrayBuffer()
supportsViewingKey()
supportsWebBluetooth()
supportsWebHID()
supportsWebUSB()
supportsWebWorkers()
taprootAddress()
toHex()
toStablecoinUnits()
trackIntent()
trackPayment()
updateOracleStatus()
validateAsset()
validateCreateIntentParams()
validateIntentInput()
validateIntentOutput()
validateScalar()
validateViewingKey()
verifyAttestation()
~~Function: verifyCommitment()~~
verifyOpening()
verifyOracleSignature()
verifyOwnership()
withSecureBuffer()
withSecureBufferSync()
wrapError()
interfaces
AptosStealthResult
Asset
AttestationRequest
AttestationResult
AuditLogEntry
AuditorRegistration
AuditorViewingKey
AuditReport
AuditScope
BackendCapabilities
BatchPaymentRecipient
BatchPaymentRequest
BidReceipt
BridgeProvider
BrowserNoirProviderConfig
CastVoteParams
Commitment
CommitmentPoint
ComplianceConfig
ComplianceReport
CosmosStealthResult
CreateBatchProposalParams
CreateBidParams
CreateComplianceConfigParams
CreateIntentOptions
CreateIntentParams
CreatePaymentOptions
CreatePaymentParams
CreatePaymentProposalParams
CreatePrivateOwnershipParams
CreateTreasuryParams
CSVExport
DecryptedTransaction
DerivedViewingKey
DeriveMultipleParams
DeriveViewingKeyParams
DisclosedTransaction
DisclosureRequest
EIP1193ConnectInfo
EIP1193Provider
EIP1193ProviderRpcError
EIP1193RequestArguments
EIP712Domain
EIP712TypedData
EIP712TypeDefinition
EIP712Types
EncryptedVote
EthereumAdapterConfig
EthereumChainMetadata
EthereumTokenMetadata
EthereumTransactionReceipt
EthereumTransactionRequest
ExportedViewingKey
ExportForRegulatorParams
FATFExport
FATFTransaction
FINCENExport
FINCENTransaction
FindBestRouteParams
FulfillmentCommitment
FulfillmentProof
FulfillmentProofParams
FulfillmentRequest
FulfillmentResult
FulfillmentStatus
FundingProofParams
GenerateAuditReportParams
GenerateReportParams
HardwareAccount
HardwareDeviceInfo
HardwareEthereumTx
HardwareSignature
HardwareSignRequest
HardwareTransport
HardwareWalletConfig
IWalletAdapter
LedgerConfig
MockEthereumAdapterConfig
MockHardwareConfig
MockSolanaAdapterConfig
MockSolverConfig
NEARIntentsAdapterConfig
NoirProviderConfig
OneClickConfig
OneClickQuoteRequest
OneClickQuoteResponse
OneClickStatusResponse
OracleAttestation
OracleAttestationMessage
OracleInfo
OracleRegistry
OracleRegistryConfig
OracleSignature
OwnershipProof
OwnershipVerification
PaymentReceipt
PdfExportOptions
PedersenCommitment
PreparedSwap
PriceFeed
PrivacyConfig
PrivateNFTOwnership
PrivateWalletAdapter
ProductionQuote
ProofProvider
ProofResult
ProposalSignature
ProveOwnershipParams
Quote
QuoteComparison
ReceivedNote
RegisterAuditorParams
ReportData
RevealedVote
Route
RouteWithQuote
SameChainExecuteParams
SameChainExecuteResult
SameChainExecutor
SameChainTransferParams
SameChainTransferResult
SealedBid
SerializedError
SettlementBackend
SettlementBackendRegistry
SettlementQuote
SettlementQuoteParams
SettlementSwapParams
SettlementSwapResult
SettlementSwapRoute
SettlementSwapRouteStep
ShieldedBalance
ShieldedIntent
ShieldedPayment
ShieldedSendParams
ShieldedSendResult
Signature
SignedOracleAttestation
SignedTransaction
SIPConfig
SIPSolver
SolanaAdapterConfig
SolanaAnnouncement
SolanaClaimParams
SolanaClaimResult
SolanaConnection
SolanaPrivateTransferParams
SolanaPrivateTransferResult
SolanaPublicKey
SolanaSameChainConfig
SolanaScanParams
SolanaScanResult
SolanaSendOptions
SolanaSignature
SolanaTransaction
SolanaUnsignedTransaction
SolanaVersionedTransaction
SolanaWalletProvider
Solver
SolverCapabilities
SolverQuote
SolverVisibleIntent
StablecoinInfo
StealthAddress
StealthAddressRecovery
StealthMetaAddress
SuiStealthResult
SwapRequest
SwapResult
SwapRoute
SwapRouteStep
SwapStatusResponse
TaprootOutput
TapScript
ThresholdShares
TimeLockParams
TimeLockResult
TrackedIntent
TrackedPayment
TransactionData
TransactionReceipt
TreasuryBalance
TreasuryConfig
TreasuryMember
TreasuryProposal
TreasuryTransaction
TrezorConfig
UnlockResult
UnsignedTransaction
ValidityProofParams
VerificationResult
VerifyBidParams
ViewingKey
WalletAccountChangedEvent
WalletAdapter
WalletChainChangedEvent
WalletConnectEvent
WalletDisconnectEvent
WalletErrorEvent
WalletInfo
WalletRegistryEntry
WalletShieldedSendParams
WalletShieldedSendResult
ZcashAccountAddress
ZcashAccountBalance
ZcashAddressInfo
ZcashBlock
ZcashBlockchainInfo
ZcashBlockHeader
ZcashConfig
ZcashNativeBackendConfig
ZcashNetworkInfo
ZcashNewAccount
ZcashOperation
ZcashOperationError
ZcashOperationTxResult
ZcashPoolBalance
ZcashQuote
ZcashQuoteParams
ZcashSendRecipient
ZcashShieldedSendParams
ZcashShieldedServiceConfig
ZcashSwapParams
ZcashSwapResult
ZcashSwapServiceConfig
ZcashUnspentNote
ZKProof
type-aliases
BitcoinNetwork
ChainId
ComplianceRole
CosmosChainId
DefuseAssetId
EIP1193Event
EthereumChainIdType
EthereumWalletName
HardwareConnectionStatus
HardwareErrorCodeType
HardwareWalletType
Hash
HexString
Jurisdiction
LedgerModel
OracleId
OracleStatus
PaymentPurpose
PaymentStatusType
ProofFramework
ProofProgressCallback()
ProposalStatusType
ProposalType
RegulatoryExport
RegulatoryFormat
ReportFormat
ReportStatusType
ReportType
SettlementBackendFactory()<TConfig>
SettlementBackendName
SolanaCluster
SolanaSameChainCluster
SolanaWalletName
SolverEvent
SolverEventListener()
StablecoinSymbol
StealthCurve
TransportType
TreasuryRole
TrezorModel
WalletAdapterFactory()
WalletConnectionState
WalletEvent
WalletEventHandler()<T>
WalletEventType
ZcashAddressType
ZcashNetwork
ZcashOperationStatus
ZcashPool
ZcashPrivacyPolicy
ZcashReceiverType
ZcashSwapSourceChain
ZcashSwapSourceToken
ZcashSwapStatus
variables
ATTESTATION VERSION
CHAIN NUMERIC IDS
COSMOS CHAIN PREFIXES
DEFAULT THRESHOLD
DEFAULT TOTAL ORACLES
DerivationPath
EthereumChainId
HardwareErrorCode
MEMO PROGRAM ID
NATIVE TOKENS
ORACLE DOMAIN
PaymentStatus
ProposalStatus
ReportStatus
SIP MEMO PREFIX
SIP VERSION
SOLANA EXPLORER URLS
SOLANA RPC ENDPOINTS
SOLANA TOKEN DECIMALS
SOLANA TOKEN MINTS
STABLECOIN ADDRESSES
STABLECOIN DECIMALS
STABLECOIN INFO
WalletErrorCode
walletRegistry
ZcashErrorCode
GitHub
Twitter
Select theme
Dark
Light
Auto
Validity Proof