Celo SDK Docs
Celo SDK Reference Documentation
Base
Index
Classes
future .future
lock .lock
result .jsonparseerror
result .rooterror
Enums
account .mnemoniclanguages
account .mnemonicstrength
attestations .identifiertype
currencies .currency enum
currencies .short currencies
inputvalidation .validatorkind
Interfaces
account .bip39
attestations .attestationsstatus
collections .addresslistitem
contacts .contactphonenumber
contacts .minimalcontact
inputvalidation .baseprops
phonenumbers .parsedphonenumber
result .baseerror
result .errorresult
result .okresult
signatureutils .signature
signatureutils .signer
task .repeattaskcontext
task .retrytaskoptions
task .runningtask
task .runningtaskwithvalue
task .taskoptions
Modules
account
address
async
attestations
collections
contacts
currencies
displayformatting
future
inputvalidation
io
lock
logger
parsing
phonenumbers
result
signatureutils
string
task
Connect
Index
Classes
celo provider .celoprovider
connection .connection
utils celo transaction object .celotransactionobject
utils rpc caller .defaultrpccaller
utils tx params normalizer .txparamsnormalizer
utils tx result .transactionresult
Interfaces
abi types .abicoder
abi types .abidefinition
abi types .decodedparamsarray
abi types .decodedparamsobject
connection .connectionoptions
types .celoparams
types .celotxobject
types .encodedtransaction
types .jsonrpcpayload
types .jsonrpcresponse
types .provider
types .rlpencodedtx
utils rpc caller .rpccaller
wallet .readonlywallet
wallet .signer
Modules
abi types
celo provider
connection
types
utils abi utils
utils celo transaction object
utils formatter
utils provider utils
utils rpc caller
utils tx params normalizer
utils tx result
wallet
Contractkit
Index
Classes
address registry .addressregistry
address registry .unregisterederror
celo tokens .celotokens
contract cache .wrappercache
identity metadata .identitymetadatawrapper
kit .contractkit
versions .contractversion
web3 contract cache .web3contractcache
wrappers accounts .accountswrapper
wrappers attestations .attestationswrapper
wrappers baseslasher .baseslasher
wrappers basewrapper .basewrapper
wrappers blockchainparameters .blockchainparameterswrapper
wrappers celotokenwrapper .celotokenwrapper
wrappers doublesigningslasher .doublesigningslasherwrapper
wrappers downtimeslasher .downtimeslasherwrapper
wrappers election .electionwrapper
wrappers epochrewards .epochrewardswrapper
wrappers erc20wrapper .erc20wrapper
wrappers escrow .escrowwrapper
wrappers exchange .exchangewrapper
wrappers freezer .freezerwrapper
wrappers gaspriceminimum .gaspriceminimumwrapper
wrappers goldtokenwrapper .goldtokenwrapper
wrappers governance .governancewrapper
wrappers grandamento .grandamentowrapper
wrappers lockedgold .lockedgoldwrapper
wrappers metatransactionwallet .metatransactionwalletwrapper
wrappers metatransactionwalletdeployer .metatransactionwalletdeployerwrapper
wrappers multisig .multisigwrapper
wrappers releasegold .releasegoldwrapper
wrappers reserve .reservewrapper
wrappers sortedoracles .sortedoracleswrapper
wrappers stabletokenwrapper .stabletokenwrapper
wrappers validators .validatorswrapper
Enums
base .celocontract
celo tokens .stabletoken
celo tokens .token
identity claims types .claimtypes
wrappers attestations .attestationservicestatusstate
wrappers attestations .attestationstate
wrappers governance .proposalstage
wrappers governance .votevalue
wrappers grandamento .exchangeproposalstate
wrappers sortedoracles .medianrelation
Interfaces
celo tokens .celotokeninfo
celo tokens .stabletokeninfo
kit .networkconfig
wrappers attestations .actionableattestation
wrappers attestations .attestationsconfig
wrappers attestations .attestationservicestatusresponse
wrappers attestations .attestationstat
wrappers attestations .attestationstateforissuer
wrappers attestations .attestationstoken
wrappers attestations .unselectedrequest
wrappers blockchainparameters .blockchainparametersconfig
wrappers blockchainparameters .clientversion
wrappers downtimeslasher .downtimeslasherconfig
wrappers downtimeslasher .interval
wrappers election .electablevalidators
wrappers election .electionconfig
wrappers election .groupvote
wrappers election .groupvoterreward
wrappers election .validatorgroupvote
wrappers election .voter
wrappers election .voterreward
wrappers exchange .exchangeconfig
wrappers gaspriceminimum .gaspriceminimumconfig
wrappers governance .governanceconfig
wrappers governance .hotfixrecord
wrappers governance .participationparameters
wrappers governance .proposalmetadata
wrappers governance .proposalrecord
wrappers governance .upvoterecord
wrappers governance .voter
wrappers governance .voterecord
wrappers governance .votes
wrappers grandamento .exchangeproposal
wrappers grandamento .exchangeproposalreadable
wrappers grandamento .grandamentoconfig
wrappers grandamento .stabletokenexchangelimits
wrappers lockedgold .accountslashed
wrappers lockedgold .lockedgoldconfig
wrappers lockedgold .pendingwithdrawal
wrappers lockedgold .votingdetails
wrappers metatransactionwallet .rawtransaction
wrappers metatransactionwallet .transactionobjectwithvalue
wrappers multisig .transactiondata
wrappers releasegold .balancestate
wrappers releasegold .releasegoldinfo
wrappers reserve .reserveconfig
wrappers sortedoracles .medianrate
wrappers sortedoracles .oraclerate
wrappers sortedoracles .oraclereport
wrappers sortedoracles .oracletimestamp
wrappers sortedoracles .sortedoraclesconfig
wrappers stabletokenwrapper .inflationparameters
wrappers stabletokenwrapper .stabletokenconfig
wrappers validators .groupmembership
wrappers validators .lockedgoldrequirements
wrappers validators .membershiphistoryextradata
wrappers validators .validator
wrappers validators .validatorgroup
wrappers validators .validatorreward
wrappers validators .validatorsconfig
Modules
address registry
base
celo tokens
contract cache
identity claims account
identity claims attestation service url
identity claims claim
identity claims keybase
identity claims types
identity claims verify
identity metadata
kit
proxy
test utils grandamento
test utils promieventstub
test utils setup global
test utils teardown global
test utils transferownership
versions
web3 contract cache
wrappers accounts
wrappers attestations
wrappers baseslasher
wrappers basewrapper
wrappers blockchainparameters
wrappers celotokenwrapper
wrappers doublesigningslasher
wrappers downtimeslasher
wrappers election
wrappers epochrewards
wrappers erc20wrapper
wrappers escrow
wrappers exchange
wrappers freezer
wrappers gaspriceminimum
wrappers goldtokenwrapper
wrappers governance
wrappers grandamento
wrappers lockedgold
wrappers metatransactionwallet
wrappers metatransactionwalletdeployer
wrappers multisig
wrappers releasegold
wrappers reserve
wrappers sortedoracles
wrappers stabletokenwrapper
wrappers validators
Encrypted backup
Index
Classes
errors .authorizationerror
errors .decodeerror
errors .decryptionerror
errors .encryptionerror
errors .fetcherror
errors .invalidbackuperror
errors .odisratelimitingerror
errors .odisserviceerror
errors .odisverificationerror
errors .pbkdferror
errors .scrypterror
errors .usageerror
odis mock .mockodis
Enums
config .computationalhardeningfunction
config .environmentidentifier
errors .backuperrortypes
utils .kdfinfo
Interfaces
backup .backup
backup .createbackupargs
backup .createpasswordencryptedbackupargs
backup .createpinencryptedbackupargs
backup .openbackupargs
config .circuitbreakerconfig
config .hardeningconfig
config .odishardeningconfig
config .pbkdfconfig
config .scryptconfig
utils .scryptoptions
Modules
backup
config
errors
odis
odis mock
schema
utils
Explorer
Index
Classes
block explorer .blockexplorer
log explorer .logexplorer
Interfaces
base .contractdetails
block explorer .calldetails
block explorer .parsedblock
block explorer .parsedtx
Modules
base
block explorer
log explorer
Governance
Index
Classes
proposals .interactiveproposalbuilder
proposals .proposalbuilder
Interfaces
proposals .proposaltransactionjson
Modules
proposals
Identity
Index
Classes
odis bls blinding client .wasmblsblindingclient
odis circuit breaker .circuitbreakerclient
odis circuit breaker .circuitbreakerserviceerror
odis circuit breaker .circuitbreakerunavailableerror
odis circuit breaker .encryptionerror
odis circuit breaker .fetcherror
odis circuit breaker mock .mockcircuitbreaker
offchain accessors authorized signer .authorizedsigneraccessor
offchain accessors binary .privatebinaryaccessor
offchain accessors binary .publicbinaryaccessor
offchain accessors errors .invaliddataerror
offchain accessors errors .invalidkey
offchain accessors errors .offchainerror
offchain accessors errors .unavailablekey
offchain accessors errors .unknownciphertext
offchain accessors name .privatenameaccessor
offchain accessors name .publicnameaccessor
offchain accessors pictures .privatepictureaccessor
offchain accessors pictures .publicpictureaccessor
offchain accessors simple .privatesimpleaccessor
offchain accessors simple .publicsimpleaccessor
offchain data wrapper .basicdatawrapper
offchain data wrapper .fetcherror
offchain data wrapper .invalidsignature
offchain data wrapper .nostorageprovider
offchain data wrapper .nostoragerootprovideddata
offchain storage writers .awsstoragewriter
offchain storage writers .gitstoragewriter
offchain storage writers .googlestoragewriter
offchain storage writers .localstoragewriter
offchain storage writers .mockstoragewriter
offchain storage writers .storagewriter
Enums
odis circuit breaker .circuitbreakerendpoints
odis circuit breaker .circuitbreakererrortypes
odis circuit breaker .circuitbreakerkeystatus
odis query .errormessages
offchain accessors errors .schemaerrortypes
offchain data wrapper .offchainerrortypes
Interfaces
odis bls blinding client .blsblindingclient
odis circuit breaker .circuitbreakerservicecontext
odis circuit breaker .circuitbreakerstatusresponse
odis circuit breaker .circuitbreakerunwrapkeyrequest
odis circuit breaker .circuitbreakerunwrapkeyresponse
odis phone number identifier .phonenumberhashdetails
odis query .combinersignmessageresponse
odis query .encryptionkeysigner
odis query .servicecontext
odis query .walletkeysigner
offchain accessors interfaces .privateaccessor
offchain accessors interfaces .publicaccessor
offchain data wrapper .offchaindatawrapper
Modules
odis bls blinding client
odis circuit breaker
odis circuit breaker mock
odis matchmaking
odis phone number identifier
odis query
offchain accessors authorized signer
offchain accessors binary
offchain accessors errors
offchain accessors interfaces
Module: "offchain/accessors/interfaces"
Index
offchain accessors name
offchain accessors pictures
offchain accessors simple
offchain data wrapper
offchain storage writers
offchain utils
test utils setup global
test utils teardown global
Keystores
Index
Classes
file keystore .filekeystore
inmemory keystore .inmemorykeystore
keystore base .keystorebase
keystore wallet wrapper .keystorewalletwrapper
Enums
keystore base .errormessages
Modules
file keystore
inmemory keystore
keystore base
keystore wallet wrapper
test constants
Network utils
Index
Classes
genesis block utils .genesisblockutils
google storage utils .googlestorageutils
static node utils .staticnodeutils
Interfaces
utils timezone .coordinates
utils timezone .timezone
Modules
genesis block utils
google storage utils
static node utils
utils timezone
Phone utils
Index
Classes
countries .countries
Interfaces
countries .localizedcountry
Modules
countries
data countries es country
getcountryemoji
getphonehash
inputvalidation
io
phonenumbers
Transactions uri
Index
Modules
test utils setup global
test utils teardown global
tx uri
Utils
Index
Classes
node modules bls12377js src f2 .f2
node modules bls12377js src f .f
node modules bls12377js src g1 .g1
node modules bls12377js src g2 .g2
node modules bls12377js src group .group
packages sdk utils src countries .countries
Enums
packages sdk utils src dappkit .dappkitrequesttypes
packages sdk utils src dappkit .dappkitresponsestatus
Interfaces
node modules bls12377js src defs .fieldspec
node modules bls12377js src defs .groupspec
packages sdk utils src commentencryption .encryptionstatus
packages sdk utils src countries .localizedcountry
packages sdk utils src dappkit .accountauthrequest
packages sdk utils src dappkit .accountauthresponsefailure
packages sdk utils src dappkit .accountauthresponsesuccess
packages sdk utils src dappkit .dappkitrequestbase
packages sdk utils src dappkit .dappkitrequestmeta
packages sdk utils src dappkit .signtxrequest
packages sdk utils src dappkit .signtxresponsefailure
packages sdk utils src dappkit .signtxresponsesuccess
packages sdk utils src dappkit .txtosignparam
packages sdk utils src istanbul .istanbulextra
packages sdk utils src istanbul .seal
packages sdk utils src sign typed data utils .eip712object
packages sdk utils src sign typed data utils .eip712parameter
packages sdk utils src sign typed data utils .eip712typeddata
packages sdk utils src sign typed data utils .eip712types
packages sdk utils src sign typed data utils .eip712typeswithprimary
Modules
node modules bls12377js src bls
node modules bls12377js src defs
node modules bls12377js src f2
node modules bls12377js src f
node modules bls12377js src g1
node modules bls12377js src g2
node modules bls12377js src group
packages sdk utils src account
packages sdk utils src address
packages sdk utils src async
packages sdk utils src attestations
packages sdk utils src bls
packages sdk utils src bn
packages sdk utils src celohistory
packages sdk utils src collections
packages sdk utils src commentencryption
packages sdk utils src contacts
packages sdk utils src countries
packages sdk utils src currencies
packages sdk utils src dappkit
packages sdk utils src data countries es country
packages sdk utils src dataencryptionkey
packages sdk utils src displayformatting
packages sdk utils src ecdh
packages sdk utils src ecies
packages sdk utils src fixidity
packages sdk utils src future
packages sdk utils src inputvalidation
packages sdk utils src io
packages sdk utils src istanbul
packages sdk utils src levenshtein
packages sdk utils src logger
packages sdk utils src parsing
packages sdk utils src phonenumbers
packages sdk utils src sign typed data utils
packages sdk utils src signatureutils
packages sdk utils src solidity
packages sdk utils src string
packages sdk utils src task
packages sdk utils src typed data constructors
Wallet base
Index
Classes
wallet base .walletbase
Interfaces
wallet base .unlockablewallet
wallet base .wallet
Modules
signing utils
wallet base
Wallet hsm
Index
Classes
signature utils .signature
Modules
ber utils
signature utils
Wallet hsm aws
Index
Classes
aws hsm signer .awshsmsigner
aws hsm wallet .awshsmwallet
Modules
aws hsm signer
aws hsm wallet
Wallet hsm azure
Index
Classes
azure hsm signer .azurehsmsigner
azure hsm wallet .azurehsmwallet
azure key vault client .azurekeyvaultclient
Modules
azure hsm signer
azure hsm wallet
azure key vault client
Wallet ledger
Index
Classes
ledger signer .ledgersigner
ledger wallet .ledgerwallet
Enums
ledger wallet .addressvalidation
Interfaces
tokens .api
tokens .tokeninfo
Modules
data
ledger signer
ledger utils
ledger wallet
tokens
Wallet local
Index
Classes
local signer .localsigner
local wallet .localwallet
Modules
local signer
local wallet
Wallet remote
Index
Classes
remote wallet .remotewallet
Modules
remote wallet
Wallet rpc
Index
Classes
rpc signer .rpcsigner
rpc wallet .rpcwallet
Enums
rpc wallet .rpcwalleterrors
Modules
rpc signer
rpc wallet
test utils ganache setup
test utils ganache teardown
Celo SDK Docs
Docs
»
Modules »
Identity »
offchain accessors interfaces
@celo/identity
›
"offchain/accessors/interfaces"
Module: "offchain/accessors/interfaces"
Index
Interfaces
PrivateAccessor
PublicAccessor