Skip to content
ICP JS SDK Docs
Core
Search Core
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Core
Version
Latest (v4.2.3)
v4.2
v4.1
v4.0
v3.2
Getting Started
Overview
Installation
Quick Start
Guides
Canister Environment
Experimental
Typescript
Library Development
Modules
Agent
Overview
API Reference
Overview
classes
Actor
AgentError
AnonymousIdentity
CborDecodeErrorCode
CborEncodeErrorCode
Certificate
CertificateHasTooManyDelegationsErrorCode
CertificateNotAuthorizedErrorCode
CertificateOutdatedErrorCode
CertificateTimeErrorCode
CertificateVerificationErrorCode
CertifiedRejectErrorCode
CreateHttpAgentErrorCode
DerDecodeErrorCode
DerDecodeLengthMismatchErrorCode
DerEncodeErrorCode
DerKeyLengthMismatchErrorCode
DerPrefixMismatchErrorCode
Ed25519PublicKey
EmptyCookieErrorCode
Expiry
ExpiryJsonDeserializeErrorCode
ExternalError
HashTreeDecodeErrorCode
HashValueErrorCode
HexDecodeErrorCode
HttpAgent
HttpDefaultFetchErrorCode
HttpErrorCode
HttpFetchErrorCode
HttpV3ApiNotSupportedErrorCode
IdentityInvalidErrorCode
IngressExpiryInvalidErrorCode
InputError
InvalidReadStateRequestErrorCode
InvalidRootKeyErrorCode
LimitError
LookupErrorCode
MalformedLookupFoundValueErrorCode
MalformedPublicKeyErrorCode
MalformedSignatureErrorCode
MissingCanisterIdErrorCode
MissingCookieErrorCode
MissingLookupValueErrorCode
MissingRootKeyErrorCode
MissingSignatureErrorCode
Observable
ObservableLog
ProtocolError
QuerySignatureVerificationFailedErrorCode
RejectError
RequestStatusDoneNoReplyErrorCode
SignIdentity
TimeoutWaitingForResponseErrorCode
ToCborValue
TransportError
TrustError
UncertifiedRejectErrorCode
UncertifiedRejectUpdateErrorCode
UnexpectedErrorCode
UnknownError
enumerations
Endpoint
ErrorKindEnum
LookupLabelStatus
LookupPathStatus
LookupSubtreeStatus
NodeType
QueryResponseStatus
ReadRequestType
ReplicaRejectCode
RequestStatusResponseStatus
SubmitRequestType
functions
blsVerify
calculateIngressExpiry
check_canister_ranges
constructRequest
createIdentityDescriptor
decodeLen
decodeLenBytes
domain_sep
encodeLen
encodeLenBytes
fetchCandid
find_label
flatten_forks
hashOfMap
hashTreeToString
hashValue
httpHeadersTransform
isV2ResponseBody
isV3ResponseBody
lookup_path
lookup_subtree
lookupResultToBuffer
makeExpiryTransform
makeNonce
makeNonceTransform
pollForResponse
randomNumber
reconstruct
requestIdOf
uint8Equals
uint8FromBufLike
uint8ToBuf
unwrapDER
wrapDER
interfaces
ActorConfig
ActorMethod
ActorMethodExtended
ActorMethodWithHttpDetails
Agent
AnonymousIdentityDescriptor
CallConfig
CallOptions
CallRequest
Cert
CreateActorClassOpts
CreateCertificateOptions
HttpAgentBaseRequest
HttpAgentOptions
HttpAgentQueryRequest
HttpAgentReadStateRequest
HttpAgentRequestTransformFn
HttpAgentSubmitRequest
HttpDetailsResponse
Identity
KeyPair
LookupLabelResultAbsent
LookupLabelResultFound
LookupLabelResultGreater
LookupLabelResultLess
LookupLabelResultUnknown
LookupPathResultAbsent
LookupPathResultError
LookupPathResultFound
LookupPathResultUnknown
LookupSubtreeResultAbsent
LookupSubtreeResultFound
LookupSubtreeResultUnknown
PollingOptions
PublicKey
PublicKeyIdentityDescriptor
QueryFields
QueryRequest
QueryResponseBase
QueryResponseRejected
QueryResponseReplied
ReadStateOptions
ReadStateRequest
ReadStateResponse
Signed
SubmitResponse
UnSigned
v2ResponseBody
v3ResponseBody
namespaces
CanisterStatus
CanisterStatus
classes
CustomPath
functions
encodePath
fetchNodeKeys
request
interfaces
MetaData
type-aliases
CanisterStatusOptions
Path
Status
StatusMap
SubnetStatus
polling
polling
strategy
strategy
functions
backoff
chain
conditionalDelay
defaultStrategy
maxAttempts
once
throttle
timeout
type-aliases
Predicate
type-aliases
ActorConstructor
ActorMethodMappedExtended
ActorMethodMappedWithHttpDetails
ActorSubclass
AgentLog
ApiQueryResponse
CallContext
DerEncodedPublicKey
EmptyHashTree
Envelope
ForkHashTree
FunctionWithArgsAndReturn
HashTree
HttpAgentRequest
HttpHeaderField
IdentityDescriptor
JsonnableExpiry
LabeledHashTree
LabelLookupResult
LeafHashTree
LookupResult
NodeHash
NodeLabel
NodePath
NodeSignature
NodeValue
Nonce
ObserveFunction
PollStrategy
PrunedHashTree
QueryResponse
ReadRequest
RequestContext
RequestId
Signature
SubtreeLookupResult
variables
ACTOR_METHOD_WITH_CERTIFICATE
ACTOR_METHOD_WITH_HTTP_DETAILS
BLS12_381_G2_OID
Cbor
DEFAULT_POLLING_OPTIONS
DER_COSE_OID
ED25519_OID
IC_REQUEST_AUTH_DELEGATION_DOMAIN_SEPARATOR
IC_REQUEST_DOMAIN_SEPARATOR
IC_RESPONSE_DOMAIN_SEPARATOR
IC_ROOT_KEY
JSON_KEY_EXPIRY
MANAGEMENT_CANISTER_ID
SECP256K1_OID
UNREACHABLE_ERROR
verify
Canister Environment API
Experimental
Overview
functions
getCanisterEnv
safeGetCanisterEnv
interfaces
CanisterEnv
type-aliases
GetCanisterEnvOptions
Candid
Overview
API Reference
Overview
classes
InputBox
InputForm
OptionForm
PipeArrayBuffer
RecordForm
Render
TupleForm
VariantForm
VecForm
functions
compare
concat
idlLabelToId
inputBox
lebDecode
lebEncode
optForm
readIntLE
readUIntLE
recordForm
renderInput
renderValue
safeRead
safeReadUint8
slebDecode
slebEncode
tupleForm
uint8Equals
uint8FromBufLike
uint8ToDataView
variantForm
vecForm
writeIntLE
writeUIntLE
interfaces
FormConfig
JsonArray
JsonObject
ParseConfig
UIConfig
namespaces
IDL
IDL
classes
BoolClass
ConstructType
EmptyClass
FixedIntClass
FixedNatClass
FloatClass
FuncClass
IntClass
NatClass
NullClass
OptClass
PrimitiveType
PrincipalClass
RecClass
RecordClass
ReservedClass
ServiceClass
TextClass
TupleClass
Type
UnknownClass
VariantClass
VecClass
Visitor
functions
decode
encode
Func
Opt
Rec
Record
resetSubtypeCache
Service
subtype
Tuple
Variant
Vec
type-aliases
GenericIdlFuncArgs
GenericIdlFuncRets
GenericIdlServiceFields
InterfaceFactory
variables
Bool
Empty
Float32
Float64
Int
Int16
Int32
Int64
Int8
Nat
Nat16
Nat32
Nat64
Nat8
Null
Principal
Reserved
Text
Unknown
type-aliases
JsonValue
Identity
Overview
API Reference
Overview
classes
CryptoError
Delegation
DelegationChain
DelegationIdentity
ECDSAKeyIdentity
Ed25519KeyIdentity
Ed25519PublicKey
PartialDelegationIdentity
PartialIdentity
Secp256k1KeyIdentity
WebAuthnIdentity
functions
isDelegationValid
wrapDER
interfaces
DelegationValidChecks
DerCryptoKey
JsonnableDelegationChain
SignedDelegation
type-aliases
CryptoKeyOptions
JsonnableEd25519KeyIdentity
variables
DER_COSE_OID
ED25519_OID
unwrapDER
Identity Secp256k1
Overview
API Reference
Overview
classes
Secp256k1KeyIdentity
Secp256k1PublicKey
type-aliases
JsonableSecp256k1Identity
Principal
Overview
API Reference
Overview
classes
Principal
functions
base32Decode
base32Encode
getCrc32
type-aliases
JsonnablePrincipal
variables
JSON_KEY_PRINCIPAL
Upgrading
v4
v3
Changelog
GitHub
Select theme
Dark
Light
Auto
Float64
Copy Page
const
Float64
:
FloatClass
Defined in:
packages/candid/src/idl.ts:2298
