Welcome to the Credmark Model Framework documentation!
Credmark Model Framework is a Python library building models that run on the Credmark Data Platform.
This site gives you some deep technical details of the CMF and its components. For an introduction and simple how-to-guide, please head over to the Github Readme for the CMF.
Note
This project is under active development.
Contents
- CLI credmark-dev
- Model Framework Core Components
- Error handling
- Testing Models
- Framework Reference
- credmark
- credmark.cmf
- credmark.cmf.ipython
- credmark.cmf.ipython.create_cmf
- credmark.cmf.ipython.create_cmf_context
- credmark.cmf.ipython.load_ipython_extension
- credmark.cmf.ipython.load_module_items
- credmark.cmf.ipython.CmfInit
- credmark.cmf.ipython.CredmarkMagic
CredmarkMagicCredmarkMagic.add_traits()CredmarkMagic.arg_err()CredmarkMagic.class_config_rst_doc()CredmarkMagic.class_config_section()CredmarkMagic.class_get_help()CredmarkMagic.class_get_trait_help()CredmarkMagic.class_own_trait_events()CredmarkMagic.class_own_traits()CredmarkMagic.class_print_help()CredmarkMagic.class_trait_names()CredmarkMagic.class_traits()CredmarkMagic.cross_validation_lockCredmarkMagic.default_option()CredmarkMagic.format_latex()CredmarkMagic.has_trait()CredmarkMagic.hold_trait_notifications()CredmarkMagic.notify_change()CredmarkMagic.observe()CredmarkMagic.on_trait_change()CredmarkMagic.parse_options()CredmarkMagic.section_names()CredmarkMagic.set_trait()CredmarkMagic.trait_defaults()CredmarkMagic.trait_events()CredmarkMagic.trait_has_value()CredmarkMagic.trait_metadata()CredmarkMagic.trait_names()CredmarkMagic.trait_values()CredmarkMagic.traits()CredmarkMagic.unobserve()CredmarkMagic.unobserve_all()CredmarkMagic.update_config()
- credmark.cmf.model
- credmark.cmf.model.create_error_schema_for_error_descs
- credmark.cmf.model.validate_model_slug
- credmark.cmf.model.BaseModel
- credmark.cmf.model.ImmutableModel
- credmark.cmf.model.IncrementalModel
- credmark.cmf.model.Model
- credmark.cmf.model.ModelDataErrorDesc
- credmark.cmf.model.ModelErrorDesc
- credmark.cmf.model.InvalidModelCacheKey
- credmark.cmf.model.InvalidModelSlug
- credmark.cmf.model.MissingModelBaseClass
- credmark.cmf.model.WrongModelMethodSignature
- credmark.cmf.model.context
- credmark.cmf.model.context.ModelContext
ModelContextModelContext.block_numberModelContext.chain_idModelContext.current_context()ModelContext.fork()ModelContext.get_current_context()ModelContext.historicalModelContext.ledgerModelContext.modelsModelContext.networkModelContext.reset_current_context()ModelContext.run_model()ModelContext.set_current_context()ModelContext.web3ModelContext.web3_asyncModelContext.web3_batch
- credmark.cmf.model.context.ModelContext
- credmark.cmf.model.errors
- credmark.cmf.model.errors.create_instance_from_error_dict
- credmark.cmf.model.errors.MaxModelRunDepthError
- credmark.cmf.model.errors.ModelBaseError
- credmark.cmf.model.errors.ModelDataError
- credmark.cmf.model.errors.ModelDefinitionError
- credmark.cmf.model.errors.ModelEngineError
- credmark.cmf.model.errors.ModelInputError
- credmark.cmf.model.errors.ModelInvalidStateError
- credmark.cmf.model.errors.ModelNoContextError
- credmark.cmf.model.errors.ModelNotFoundError
- credmark.cmf.model.errors.ModelOutputError
- credmark.cmf.model.errors.ModelRunError
- credmark.cmf.model.errors.ModelTypeError
- credmark.cmf.model.errors.ModelCallStackEntry
- credmark.cmf.model.errors.ModelDataErrorDTO
- credmark.cmf.model.errors.ModelErrorDTO
- credmark.cmf.model.errors.ModelNotFoundErrorDTO
- credmark.cmf.model.errors.SlugAndVersionDTO
- credmark.cmf.model.ledger
- credmark.cmf.model.ledger.ledger_table_doc
- credmark.cmf.model.ledger.Ledger
- credmark.cmf.model.ledger.LedgerQueryBlock
- credmark.cmf.model.ledger.LedgerQueryContract
- credmark.cmf.model.ledger.LedgerQueryLog
- credmark.cmf.model.ledger.LedgerQueryNFTBalance
- credmark.cmf.model.ledger.LedgerQueryNFTTransfer
- credmark.cmf.model.ledger.LedgerQueryReceipt
- credmark.cmf.model.ledger.LedgerQueryTable
- credmark.cmf.model.ledger.LedgerQueryToken
- credmark.cmf.model.ledger.LedgerQueryTokenBalance
- credmark.cmf.model.ledger.LedgerQueryTokenTransfer
- credmark.cmf.model.ledger.LedgerQueryTrace
- credmark.cmf.model.ledger.LedgerQueryTransaction
- credmark.cmf.model.models
- credmark.cmf.model.print
- credmark.cmf.model.template
- credmark.cmf.model.utils
- credmark.cmf.types
- credmark.cmf.types.abi
- credmark.cmf.types.account
- credmark.cmf.types.address
- credmark.cmf.types.adt
- credmark.cmf.types.block_number
- credmark.cmf.types.compose
- credmark.cmf.types.compose.MapBlockResult
- credmark.cmf.types.compose.MapBlockTimeSeriesInput
- credmark.cmf.types.compose.MapBlockTimeSeriesOutput
MapBlockTimeSeriesOutputMapBlockTimeSeriesOutput.endTimestampMapBlockTimeSeriesOutput.exclusiveMapBlockTimeSeriesOutput.intervalMapBlockTimeSeriesOutput.resultsMapBlockTimeSeriesOutput.append()MapBlockTimeSeriesOutput.extend()MapBlockTimeSeriesOutput.get()MapBlockTimeSeriesOutput.to_dataframe()MapBlockTimeSeriesOutput.to_list()
- credmark.cmf.types.compose.MapBlocksInput
- credmark.cmf.types.compose.MapBlocksOutput
- credmark.cmf.types.compose.MapInputsInput
- credmark.cmf.types.compose.MapInputsOutput
- credmark.cmf.types.compose.MapInputsResult
- credmark.cmf.types.contract
- credmark.cmf.types.contract.get_slot_proxy_address
- credmark.cmf.types.contract.Contract
ContractContract.addressContract.ContractMetaDataContract.ContractMetaData.abiContract.ContractMetaData.abi_hashContract.ContractMetaData.constructor_argsContract.ContractMetaData.contract_nameContract.ContractMetaData.deploy_tx_hashContract.ContractMetaData.deployed_block_numberContract.ContractMetaData.is_transparent_proxyContract.ContractMetaData.proxy_implementation
Contract.fetch_events()Contract.set_abi()Contract.to_accounts()Contract.validate()Contract.abiContract.constructor_argsContract.contract_nameContract.deploy_tx_hashContract.deployed_block_numberContract.eventsContract.functionsContract.infoContract.instanceContract.is_transparent_proxyContract.ledgerContract.modelsContract.proxy_for
- credmark.cmf.types.contract.ContractInfo
ContractInfoContractInfo.addressContractInfo.metaContractInfo.ContractMetaDataContractInfo.ContractMetaData.abiContractInfo.ContractMetaData.abi_hashContractInfo.ContractMetaData.constructor_argsContractInfo.ContractMetaData.contract_nameContractInfo.ContractMetaData.deploy_tx_hashContractInfo.ContractMetaData.deployed_block_numberContractInfo.ContractMetaData.is_transparent_proxyContractInfo.ContractMetaData.proxy_implementation
ContractInfo.fetch_events()ContractInfo.set_abi()ContractInfo.to_accounts()ContractInfo.validate()ContractInfo.abiContractInfo.constructor_argsContractInfo.contract_nameContractInfo.deploy_tx_hashContractInfo.deployed_block_numberContractInfo.eventsContractInfo.functionsContractInfo.infoContractInfo.instanceContractInfo.is_transparent_proxyContractInfo.ledgerContractInfo.modelsContractInfo.proxy_for
- credmark.cmf.types.contract.Contracts
- credmark.cmf.types.contract_web3
- credmark.cmf.types.fiat_currency
- credmark.cmf.types.ledger
- credmark.cmf.types.ledger.BlockTable
BlockTableBlockTable.BASE_FEE_PER_GASBlockTable.DIFFICULTYBlockTable.EXTRA_DATABlockTable.GAS_LIMITBlockTable.GAS_USEDBlockTable.HASHBlockTable.LOGS_BLOOMBlockTable.MINERBlockTable.NONCEBlockTable.NUMBERBlockTable.PARENT_HASHBlockTable.RECEIPTS_ROOTBlockTable.SHA3_UNCLESBlockTable.SIZEBlockTable.STATE_ROOTBlockTable.TIMESTAMPBlockTable.TOTAL_DIFFICULTYBlockTable.TRANSACTIONS_ROOTBlockTable.TRANSACTION_COUNTBlockTable.colnamesBlockTable.columns
- credmark.cmf.types.ledger.ColumnField
- credmark.cmf.types.ledger.ContractTable
- credmark.cmf.types.ledger.JoinType
- credmark.cmf.types.ledger.LedgerTable
- credmark.cmf.types.ledger.LogTable
- credmark.cmf.types.ledger.NFTBalanceTable
NFTBalanceTableNFTBalanceTable.ADDRESSNFTBalanceTable.AMOUNTNFTBalanceTable.BLOCK_HASHNFTBalanceTable.BLOCK_NUMBERNFTBalanceTable.BLOCK_TIMESTAMPNFTBalanceTable.COUNTERPARTY_ADDRESSNFTBalanceTable.LOG_INDEXNFTBalanceTable.RAW_AMOUNTNFTBalanceTable.TOKEN_ADDRESSNFTBalanceTable.TOKEN_IDNFTBalanceTable.TRANSACTION_HASHNFTBalanceTable.colnamesNFTBalanceTable.columns
- credmark.cmf.types.ledger.NFTTransferTable
NFTTransferTableNFTTransferTable.BLOCK_HASHNFTTransferTable.BLOCK_NUMBERNFTTransferTable.BLOCK_TIMESTAMPNFTTransferTable.FROM_ADDRESSNFTTransferTable.LOG_INDEXNFTTransferTable.RAW_AMOUNTNFTTransferTable.TOKEN_ADDRESSNFTTransferTable.TOKEN_IDNFTTransferTable.TO_ADDRESSNFTTransferTable.TRANSACTION_HASHNFTTransferTable.colnamesNFTTransferTable.columns
- credmark.cmf.types.ledger.ReceiptTable
ReceiptTableReceiptTable.BLOCK_HASHReceiptTable.BLOCK_NUMBERReceiptTable.BLOCK_TIMESTAMPReceiptTable.CONTRACT_ADDRESSReceiptTable.CUMULATIVE_GAS_USEDReceiptTable.EFFECTIVE_GAS_PRICEReceiptTable.GAS_USEDReceiptTable.ROOTReceiptTable.STATUSReceiptTable.TRANSACTION_HASHReceiptTable.TRANSACTION_INDEXReceiptTable.colnamesReceiptTable.columns
- credmark.cmf.types.ledger.TokenBalanceTable
TokenBalanceTableTokenBalanceTable.ADDRESSTokenBalanceTable.AMOUNTTokenBalanceTable.BLOCK_HASHTokenBalanceTable.BLOCK_NUMBERTokenBalanceTable.BLOCK_TIMESTAMPTokenBalanceTable.COUNTERPARTY_ADDRESSTokenBalanceTable.LOG_INDEXTokenBalanceTable.RAW_AMOUNTTokenBalanceTable.TOKEN_ADDRESSTokenBalanceTable.TRANSACTION_HASHTokenBalanceTable.colnamesTokenBalanceTable.columns
- credmark.cmf.types.ledger.TokenTable
- credmark.cmf.types.ledger.TokenTransferTable
TokenTransferTableTokenTransferTable.BLOCK_HASHTokenTransferTable.BLOCK_NUMBERTokenTransferTable.BLOCK_TIMESTAMPTokenTransferTable.FROM_ADDRESSTokenTransferTable.LOG_INDEXTokenTransferTable.RAW_AMOUNTTokenTransferTable.TOKEN_ADDRESSTokenTransferTable.TO_ADDRESSTokenTransferTable.TRANSACTION_HASHTokenTransferTable.USD_AMOUNTTokenTransferTable.colnamesTokenTransferTable.columns
- credmark.cmf.types.ledger.TraceTable
TraceTableTraceTable.BLOCK_HASHTraceTable.BLOCK_NUMBERTraceTable.BLOCK_TIMESTAMPTraceTable.CALL_TYPETraceTable.ERRORTraceTable.FROM_ADDRESSTraceTable.GASTraceTable.INPUTTraceTable.OUTPUTTraceTable.REWARD_TYPETraceTable.STATUSTraceTable.TO_ADDRESSTraceTable.TRACE_ADDRESSTraceTable.TRACE_IDTraceTable.TRACE_TYPETraceTable.TRANSACTION_HASHTraceTable.TRANSACTION_INDEXTraceTable.VALUETraceTable.colnamesTraceTable.columns
- credmark.cmf.types.ledger.TransactionTable
TransactionTableTransactionTable.BLOCK_HASHTransactionTable.BLOCK_NUMBERTransactionTable.BLOCK_TIMESTAMPTransactionTable.FROM_ADDRESSTransactionTable.GASTransactionTable.GAS_PRICETransactionTable.HASHTransactionTable.INPUTTransactionTable.MAX_FEE_PER_GASTransactionTable.MAX_PRIORITY_FEE_PER_GASTransactionTable.NONCETransactionTable.TO_ADDRESSTransactionTable.TRANSACTION_INDEXTransactionTable.TRANSACTION_TYPETransactionTable.VALUETransactionTable.colnamesTransactionTable.columns
- credmark.cmf.types.ledger.LedgerAggregate
- credmark.cmf.types.ledger.LedgerJoin
- credmark.cmf.types.ledger.LedgerModelOutput
- credmark.cmf.types.ledger.BlockTable
- credmark.cmf.types.ledger_contract
- credmark.cmf.types.ledger_contract.ContractEntityFactory
- credmark.cmf.types.ledger_contract.ContractEntityQuery
- credmark.cmf.types.ledger_contract.ContractEntityType
- credmark.cmf.types.ledger_contract.ContractEventsTable
- credmark.cmf.types.ledger_contract.ContractFunctionsTable
- credmark.cmf.types.ledger_contract.ContractLedger
- credmark.cmf.types.ledger_contract.LedgerQueryContractEvents
- credmark.cmf.types.ledger_contract.LedgerQueryContractFunctions
- credmark.cmf.types.ledger_errors
- credmark.cmf.types.ledger_query
- credmark.cmf.types.ledger_series
- credmark.cmf.types.network
- credmark.cmf.types.portfolio
- credmark.cmf.types.position
- credmark.cmf.types.price
- credmark.cmf.types.rpc
- credmark.cmf.types.series
- credmark.cmf.types.token_erc20
- credmark.cmf.types.token_erc20.get_token_from_configuration
- credmark.cmf.types.token_erc20.NativeToken
NativeTokenNativeToken.addressNativeToken.ContractMetaDataNativeToken.ContractMetaData.abiNativeToken.ContractMetaData.abi_hashNativeToken.ContractMetaData.constructor_argsNativeToken.ContractMetaData.contract_nameNativeToken.ContractMetaData.deploy_tx_hashNativeToken.ContractMetaData.deployed_block_numberNativeToken.ContractMetaData.is_transparent_proxyNativeToken.ContractMetaData.proxy_implementation
NativeToken.TokenMetadataNativeToken.TokenMetadata.abiNativeToken.TokenMetadata.abi_hashNativeToken.TokenMetadata.constructor_argsNativeToken.TokenMetadata.contract_nameNativeToken.TokenMetadata.decimalsNativeToken.TokenMetadata.deploy_tx_hashNativeToken.TokenMetadata.deployed_block_numberNativeToken.TokenMetadata.is_transparent_proxyNativeToken.TokenMetadata.nameNativeToken.TokenMetadata.proxy_implementationNativeToken.TokenMetadata.set_loadedNativeToken.TokenMetadata.symbolNativeToken.TokenMetadata.total_supplyNativeToken.TokenMetadata.wrappedNativeToken.TokenMetadata.get_cache()NativeToken.TokenMetadata.update_cache()
NativeToken.as_erc20()NativeToken.balance_of()NativeToken.balance_of_scaled()NativeToken.fetch_events()NativeToken.scaled()NativeToken.set_abi()NativeToken.to_accounts()NativeToken.try_erc20_property()NativeToken.unscaled()NativeToken.validate()NativeToken.wrapped()NativeToken.abiNativeToken.constructor_argsNativeToken.contract_nameNativeToken.decimalsNativeToken.deploy_tx_hashNativeToken.deployed_block_numberNativeToken.eventsNativeToken.fiatNativeToken.functionsNativeToken.infoNativeToken.instanceNativeToken.is_transparent_proxyNativeToken.ledgerNativeToken.modelsNativeToken.nameNativeToken.proxy_forNativeToken.symbolNativeToken.total_supplyNativeToken.total_supply_scaled
- credmark.cmf.types.token_erc20.Token
TokenToken.addressToken.ContractMetaDataToken.ContractMetaData.abiToken.ContractMetaData.abi_hashToken.ContractMetaData.constructor_argsToken.ContractMetaData.contract_nameToken.ContractMetaData.deploy_tx_hashToken.ContractMetaData.deployed_block_numberToken.ContractMetaData.is_transparent_proxyToken.ContractMetaData.proxy_implementation
Token.TokenMetadataToken.TokenMetadata.abiToken.TokenMetadata.abi_hashToken.TokenMetadata.constructor_argsToken.TokenMetadata.contract_nameToken.TokenMetadata.decimalsToken.TokenMetadata.deploy_tx_hashToken.TokenMetadata.deployed_block_numberToken.TokenMetadata.is_transparent_proxyToken.TokenMetadata.nameToken.TokenMetadata.proxy_implementationToken.TokenMetadata.set_loadedToken.TokenMetadata.symbolToken.TokenMetadata.total_supplyToken.TokenMetadata.wrappedToken.TokenMetadata.get_cache()Token.TokenMetadata.update_cache()
Token.as_erc20()Token.balance_of()Token.balance_of_scaled()Token.fetch_events()Token.scaled()Token.set_abi()Token.to_accounts()Token.try_erc20_property()Token.unscaled()Token.validate()Token.abiToken.constructor_argsToken.contract_nameToken.decimalsToken.deploy_tx_hashToken.deployed_block_numberToken.eventsToken.fiatToken.functionsToken.infoToken.instanceToken.is_transparent_proxyToken.ledgerToken.modelsToken.nameToken.proxy_forToken.symbolToken.total_supplyToken.total_supply_scaled
- credmark.cmf.types.token_erc20.TokenInfo
TokenInfoTokenInfo.addressTokenInfo.metaTokenInfo.ContractMetaDataTokenInfo.ContractMetaData.abiTokenInfo.ContractMetaData.abi_hashTokenInfo.ContractMetaData.constructor_argsTokenInfo.ContractMetaData.contract_nameTokenInfo.ContractMetaData.deploy_tx_hashTokenInfo.ContractMetaData.deployed_block_numberTokenInfo.ContractMetaData.is_transparent_proxyTokenInfo.ContractMetaData.proxy_implementation
TokenInfo.TokenMetadataTokenInfo.TokenMetadata.abiTokenInfo.TokenMetadata.abi_hashTokenInfo.TokenMetadata.constructor_argsTokenInfo.TokenMetadata.contract_nameTokenInfo.TokenMetadata.decimalsTokenInfo.TokenMetadata.deploy_tx_hashTokenInfo.TokenMetadata.deployed_block_numberTokenInfo.TokenMetadata.is_transparent_proxyTokenInfo.TokenMetadata.nameTokenInfo.TokenMetadata.proxy_implementationTokenInfo.TokenMetadata.set_loadedTokenInfo.TokenMetadata.symbolTokenInfo.TokenMetadata.total_supplyTokenInfo.TokenMetadata.wrappedTokenInfo.TokenMetadata.get_cache()TokenInfo.TokenMetadata.update_cache()
TokenInfo.as_erc20()TokenInfo.balance_of()TokenInfo.balance_of_scaled()TokenInfo.fetch_events()TokenInfo.scaled()TokenInfo.set_abi()TokenInfo.to_accounts()TokenInfo.try_erc20_property()TokenInfo.unscaled()TokenInfo.validate()TokenInfo.abiTokenInfo.constructor_argsTokenInfo.contract_nameTokenInfo.decimalsTokenInfo.deploy_tx_hashTokenInfo.deployed_block_numberTokenInfo.eventsTokenInfo.fiatTokenInfo.functionsTokenInfo.infoTokenInfo.instanceTokenInfo.is_transparent_proxyTokenInfo.ledgerTokenInfo.modelsTokenInfo.nameTokenInfo.proxy_forTokenInfo.symbolTokenInfo.total_supplyTokenInfo.total_supply_scaled
- credmark.cmf.types.token_erc20.Tokens
- credmark.cmf.types.token_erc721
- credmark.cmf.types.token_erc721.NonFungibleToken
NonFungibleTokenNonFungibleToken.addressNonFungibleToken.ContractMetaDataNonFungibleToken.ContractMetaData.abiNonFungibleToken.ContractMetaData.abi_hashNonFungibleToken.ContractMetaData.constructor_argsNonFungibleToken.ContractMetaData.contract_nameNonFungibleToken.ContractMetaData.deploy_tx_hashNonFungibleToken.ContractMetaData.deployed_block_numberNonFungibleToken.ContractMetaData.is_transparent_proxyNonFungibleToken.ContractMetaData.proxy_implementation
NonFungibleToken.fetch_events()NonFungibleToken.set_abi()NonFungibleToken.to_accounts()NonFungibleToken.validate()NonFungibleToken.abiNonFungibleToken.constructor_argsNonFungibleToken.contract_nameNonFungibleToken.deploy_tx_hashNonFungibleToken.deployed_block_numberNonFungibleToken.eventsNonFungibleToken.functionsNonFungibleToken.infoNonFungibleToken.instanceNonFungibleToken.is_transparent_proxyNonFungibleToken.ledgerNonFungibleToken.modelsNonFungibleToken.proxy_for
- credmark.cmf.types.token_erc721.NonFungibleToken
- credmark.cmf.types.token_wei
- credmark.cmf.ipython
- credmark.dto
- credmark.dto.DTOTypesTuple
- credmark.dto.fixstr
- credmark.dto.DTOPretty
- credmark.dto.FloatDTO
- credmark.dto.HexStr
- credmark.dto.IntDTO
- credmark.dto.StrDTO
- credmark.dto.EmptyInput
- credmark.dto.EmptyInputSkipTest
- credmark.dto.IterableListGenericDTO
- credmark.dto.dto_error_schema
- credmark.dto.dto_schema
- credmark.dto.encoder
- credmark.dto.transform
- credmark.cmf
- credmark
- Credmark SDK (Python)