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
  • help command
  • create command
  • run command
  • list command
  • describe command
  • test command
  • version command
  • Interactive Model Console
    • Using the Console
      • Get current context block number
      • Get a block number for a timestamp
      • Query the ledger
      • Get info on a model
      • Run a model
        • Run a model with parameters
        • Run a model and get a DTO result
      • Switch context to an earlier block number
    • Console Configuration
• Model Framework Core Components
  • Model Class
  • Data Transfer Object (DTO)
    • Model Error Detail DTO [Advanced Topic]
  • Data Classes
  • Model Context
    • Calling Other Models
      • context.models
      • context.run_model()
    • Web3
    • Contract
    • Ledger
    • Block number
    • Historical Utility
• Error handling
  • ModelBaseError
  • ModelDataError
    • Raising ModelDataError Errors
  • ModelInputError
  • Logging
• Testing Models
  • Unit Testing
    • Creating Tests
      • ModelTestCase
        • ModelTestCase.context
        • ModelTestCase.create_model_context()
      • model_context()
    • Running Tests
  • Mocks
    • Mock Configuration
      • ModelMockConfig
      • ModelMock
    • Generating Mocks
      • Removing Top-Level Generated Mocks
    • Testing with Mocks
    • Running with Mocks
    • Example Using Mocks
      • Example Unit Test
• Framework Reference
  • credmark
    • credmark.cmf
      • credmark.cmf.ipython
        • credmark.cmf.ipython.create_cmf
          • create_cmf()
        • credmark.cmf.ipython.create_cmf_context
          • create_cmf_context()
        • credmark.cmf.ipython.load_ipython_extension
          • load_ipython_extension()
        • credmark.cmf.ipython.load_module_items
          • load_module_items()
        • credmark.cmf.ipython.CmfInit
          • CmfInit
            • CmfInit.__add__()
            • CmfInit.__mul__()
            • CmfInit.api_url
            • CmfInit.block_number
            • CmfInit.chain_id
            • CmfInit.chain_to_provider_url
            • CmfInit.count()
            • CmfInit.index()
            • CmfInit.model_loader_path
            • CmfInit.register_utility_global
            • CmfInit.use_local_models
        • credmark.cmf.ipython.CredmarkMagic
          • CredmarkMagic
            • CredmarkMagic.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_lock
            • CredmarkMagic.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
          • create_error_schema_for_error_descs()
        • credmark.cmf.model.validate_model_slug
          • validate_model_slug()
        • credmark.cmf.model.BaseModel
          • BaseModel
            • BaseModel.convert_dict_to_dto()
            • BaseModel.init()
        • credmark.cmf.model.ImmutableModel
          • ImmutableModel
            • ImmutableModel.convert_dict_to_dto()
            • ImmutableModel.describe()
            • ImmutableModel.init()
        • credmark.cmf.model.IncrementalModel
          • IncrementalModel
            • IncrementalModel.convert_dict_to_dto()
            • IncrementalModel.describe()
            • IncrementalModel.init()
        • credmark.cmf.model.Model
          • Model
            • Model.convert_dict_to_dto()
            • Model.describe()
            • Model.init()
            • Model.run()
        • credmark.cmf.model.ModelDataErrorDesc
          • ModelDataErrorDesc
            • ModelDataErrorDesc.schema()
        • credmark.cmf.model.ModelErrorDesc
          • ModelErrorDesc
        • credmark.cmf.model.InvalidModelCacheKey
          • InvalidModelCacheKey
        • credmark.cmf.model.InvalidModelSlug
          • InvalidModelSlug
        • credmark.cmf.model.MissingModelBaseClass
          • MissingModelBaseClass
        • credmark.cmf.model.WrongModelMethodSignature
          • WrongModelMethodSignature
        • credmark.cmf.model.context
          • credmark.cmf.model.context.ModelContext
            • ModelContext
              • ModelContext.block_number
              • ModelContext.chain_id
              • ModelContext.current_context()
              • ModelContext.fork()
              • ModelContext.get_current_context()
              • ModelContext.historical
              • ModelContext.ledger
              • ModelContext.models
              • ModelContext.network
              • ModelContext.reset_current_context()
              • ModelContext.run_model()
              • ModelContext.set_current_context()
              • ModelContext.web3
              • ModelContext.web3_async
              • ModelContext.web3_batch
        • credmark.cmf.model.errors
          • credmark.cmf.model.errors.create_instance_from_error_dict
            • create_instance_from_error_dict()
          • credmark.cmf.model.errors.MaxModelRunDepthError
            • MaxModelRunDepthError
          • credmark.cmf.model.errors.ModelBaseError
            • ModelBaseError
          • credmark.cmf.model.errors.ModelDataError
            • ModelDataError
          • credmark.cmf.model.errors.ModelDefinitionError
            • ModelDefinitionError
          • credmark.cmf.model.errors.ModelEngineError
            • ModelEngineError
          • credmark.cmf.model.errors.ModelInputError
            • ModelInputError
          • credmark.cmf.model.errors.ModelInvalidStateError
            • ModelInvalidStateError
          • credmark.cmf.model.errors.ModelNoContextError
            • ModelNoContextError
          • credmark.cmf.model.errors.ModelNotFoundError
            • ModelNotFoundError
          • credmark.cmf.model.errors.ModelOutputError
            • ModelOutputError
          • credmark.cmf.model.errors.ModelRunError
            • ModelRunError
          • credmark.cmf.model.errors.ModelTypeError
            • ModelTypeError
          • credmark.cmf.model.errors.ModelCallStackEntry
            • ModelCallStackEntry
              • ModelCallStackEntry.blockNumber
              • ModelCallStackEntry.chainId
              • ModelCallStackEntry.input
              • ModelCallStackEntry.slug
              • ModelCallStackEntry.trace
              • ModelCallStackEntry.version
          • credmark.cmf.model.errors.ModelDataErrorDTO
            • ModelDataErrorDTO
              • ModelDataErrorDTO.code
              • ModelDataErrorDTO.detail
              • ModelDataErrorDTO.message
              • ModelDataErrorDTO.permanent
              • ModelDataErrorDTO.stack
              • ModelDataErrorDTO.type
              • ModelDataErrorDTO.schema()
          • credmark.cmf.model.errors.ModelErrorDTO
            • ModelErrorDTO
              • ModelErrorDTO.code
              • ModelErrorDTO.detail
              • ModelErrorDTO.message
              • ModelErrorDTO.permanent
              • ModelErrorDTO.stack
              • ModelErrorDTO.type
              • ModelErrorDTO.schema()
          • credmark.cmf.model.errors.ModelNotFoundErrorDTO
            • ModelNotFoundErrorDTO
              • ModelNotFoundErrorDTO.code
              • ModelNotFoundErrorDTO.detail
              • ModelNotFoundErrorDTO.message
              • ModelNotFoundErrorDTO.permanent
              • ModelNotFoundErrorDTO.stack
              • ModelNotFoundErrorDTO.type
              • ModelNotFoundErrorDTO.schema()
          • credmark.cmf.model.errors.SlugAndVersionDTO
            • SlugAndVersionDTO
              • SlugAndVersionDTO.slug
              • SlugAndVersionDTO.version
        • credmark.cmf.model.ledger
          • credmark.cmf.model.ledger.ledger_table_doc
            • ledger_table_doc()
          • credmark.cmf.model.ledger.Ledger
            • Ledger
              • Ledger.table()
              • Ledger.tables()
          • credmark.cmf.model.ledger.LedgerQueryBlock
            • LedgerQueryBlock
              • LedgerQueryBlock.colnames
              • LedgerQueryBlock.columns
              • LedgerQueryBlock.select()
          • credmark.cmf.model.ledger.LedgerQueryContract
            • LedgerQueryContract
              • LedgerQueryContract.colnames
              • LedgerQueryContract.columns
              • LedgerQueryContract.select()
          • credmark.cmf.model.ledger.LedgerQueryLog
            • LedgerQueryLog
              • LedgerQueryLog.colnames
              • LedgerQueryLog.columns
              • LedgerQueryLog.select()
          • credmark.cmf.model.ledger.LedgerQueryReceipt
            • LedgerQueryReceipt
              • LedgerQueryReceipt.colnames
              • LedgerQueryReceipt.columns
              • LedgerQueryReceipt.select()
          • credmark.cmf.model.ledger.LedgerQueryTable
            • LedgerQueryTable
              • LedgerQueryTable.colnames
              • LedgerQueryTable.columns
              • LedgerQueryTable.select()
          • credmark.cmf.model.ledger.LedgerQueryToken
            • LedgerQueryToken
              • LedgerQueryToken.colnames
              • LedgerQueryToken.columns
              • LedgerQueryToken.select()
          • credmark.cmf.model.ledger.LedgerQueryTokenBalance
            • LedgerQueryTokenBalance
              • LedgerQueryTokenBalance.colnames
              • LedgerQueryTokenBalance.columns
              • LedgerQueryTokenBalance.select()
          • credmark.cmf.model.ledger.LedgerQueryTokenTransfer
            • LedgerQueryTokenTransfer
              • LedgerQueryTokenTransfer.colnames
              • LedgerQueryTokenTransfer.columns
              • LedgerQueryTokenTransfer.select()
          • credmark.cmf.model.ledger.LedgerQueryTrace
            • LedgerQueryTrace
              • LedgerQueryTrace.colnames
              • LedgerQueryTrace.columns
              • LedgerQueryTrace.select()
          • credmark.cmf.model.ledger.LedgerQueryTransaction
            • LedgerQueryTransaction
              • LedgerQueryTransaction.colnames
              • LedgerQueryTransaction.columns
              • LedgerQueryTransaction.select()
        • credmark.cmf.model.models
          • credmark.cmf.model.models.Models
            • Models
          • credmark.cmf.model.models.RunModelMethod
            • RunModelMethod
        • credmark.cmf.model.print
          • credmark.cmf.model.print.print_manifest
            • print_manifest()
          • credmark.cmf.model.print.print_manifest_description
            • print_manifest_description()
        • credmark.cmf.model.template
          • credmark.cmf.model.template.ContribModel
            • ContribModel
              • ContribModel.convert_dict_to_dto()
              • ContribModel.describe()
              • ContribModel.init()
              • ContribModel.inputDTO
              • ContribModel.outputDTO
        • credmark.cmf.model.utils
          • credmark.cmf.model.utils.historical_util
            • credmark.cmf.model.utils.historical_util.HistoricalUtil
              • HistoricalUtil
                • HistoricalUtil.run_model_historical()
                • HistoricalUtil.run_model_historical_blocks()
      • credmark.cmf.types
        • credmark.cmf.types.abi
          • credmark.cmf.types.abi.ABI
            • ABI
              • ABI.__add__()
              • ABI.__mul__()
              • ABI.append()
              • ABI.clear()
              • ABI.copy()
              • ABI.count()
              • ABI.extend()
              • ABI.index()
              • ABI.insert()
              • ABI.pop()
              • ABI.remove()
              • ABI.reverse()
              • ABI.sort()
          • credmark.cmf.types.abi.EventDetails
            • EventDetails
          • credmark.cmf.types.abi.Events
            • Events
          • credmark.cmf.types.abi.FuncDetails
            • FuncDetails
          • credmark.cmf.types.abi.Funcs
            • Funcs
        • credmark.cmf.types.account
          • credmark.cmf.types.account.Account
            • Account
              • Account.address
              • Account.to_accounts()
              • Account.validate()
              • Account.models
          • credmark.cmf.types.account.Accounts
            • Accounts
              • Accounts.accounts
              • Accounts.append()
              • Accounts.extend()
              • Accounts.to_address()
        • credmark.cmf.types.address
          • credmark.cmf.types.address.validate_address
            • validate_address()
          • credmark.cmf.types.address.Address
            • Address
        • credmark.cmf.types.adt
          • credmark.cmf.types.adt.Maybe
            • Maybe
              • Maybe.just
              • Maybe.get_just()
              • Maybe.none()
          • credmark.cmf.types.adt.Records
            • Records
              • Records.fields
              • Records.fix_int_columns
              • Records.n_rows
              • Records.records
              • Records.append()
              • Records.empty()
              • Records.extend()
              • Records.from_dataframe()
              • Records.is_empty()
              • Records.to_dataframe()
          • credmark.cmf.types.adt.Some
            • Some
              • Some.some
              • Some.append()
              • Some.empty()
              • Some.extend()
              • Some.is_empty()
              • Some.sorted()
              • Some.to_dataframe()
        • credmark.cmf.types.block_number
          • credmark.cmf.types.block_number.BlockNumber
            • BlockNumber
              • BlockNumber.dict()
              • BlockNumber.from_date()
              • BlockNumber.from_datetime()
              • BlockNumber.from_timestamp()
              • BlockNumber.from_ymd()
              • BlockNumber.get_dt()
              • BlockNumber.list_with_interval()
          • credmark.cmf.types.block_number.BlockNumberOutOfRangeError
            • BlockNumberOutOfRangeError
          • credmark.cmf.types.block_number.BlockNumberOutOfRangeDetailDTO
            • BlockNumberOutOfRangeDetailDTO
              • BlockNumberOutOfRangeDetailDTO.blockNumber
              • BlockNumberOutOfRangeDetailDTO.maxBlockNumber
          • credmark.cmf.types.block_number.BlockNumberOutOfRangeErrorDTO
            • BlockNumberOutOfRangeErrorDTO
              • BlockNumberOutOfRangeErrorDTO.code
              • BlockNumberOutOfRangeErrorDTO.detail
              • BlockNumberOutOfRangeErrorDTO.message
              • BlockNumberOutOfRangeErrorDTO.permanent
              • BlockNumberOutOfRangeErrorDTO.stack
              • BlockNumberOutOfRangeErrorDTO.type
              • BlockNumberOutOfRangeErrorDTO.schema()
        • credmark.cmf.types.compose
          • credmark.cmf.types.compose.MapBlockResult
            • MapBlockResult
              • MapBlockResult.blockNumber
              • MapBlockResult.error
              • MapBlockResult.output
          • credmark.cmf.types.compose.MapBlockTimeSeriesInput
            • MapBlockTimeSeriesInput
              • MapBlockTimeSeriesInput.count
              • MapBlockTimeSeriesInput.endTimestamp
              • MapBlockTimeSeriesInput.exclusive
              • MapBlockTimeSeriesInput.interval
              • MapBlockTimeSeriesInput.modelInput
              • MapBlockTimeSeriesInput.modelSlug
              • MapBlockTimeSeriesInput.modelVersion
          • credmark.cmf.types.compose.MapBlockTimeSeriesOutput
            • MapBlockTimeSeriesOutput
              • MapBlockTimeSeriesOutput.endTimestamp
              • MapBlockTimeSeriesOutput.exclusive
              • MapBlockTimeSeriesOutput.interval
              • MapBlockTimeSeriesOutput.results
              • MapBlockTimeSeriesOutput.append()
              • MapBlockTimeSeriesOutput.extend()
              • MapBlockTimeSeriesOutput.get()
              • MapBlockTimeSeriesOutput.to_dataframe()
              • MapBlockTimeSeriesOutput.to_list()
          • credmark.cmf.types.compose.MapBlocksInput
            • MapBlocksInput
              • MapBlocksInput.blockNumbers
              • MapBlocksInput.modelInput
              • MapBlocksInput.modelSlug
              • MapBlocksInput.modelVersion
          • credmark.cmf.types.compose.MapBlocksOutput
            • MapBlocksOutput
              • MapBlocksOutput.results
              • MapBlocksOutput.append()
              • MapBlocksOutput.extend()
              • MapBlocksOutput.get()
              • MapBlocksOutput.to_dataframe()
              • MapBlocksOutput.to_list()
          • credmark.cmf.types.compose.MapInputsInput
            • MapInputsInput
              • MapInputsInput.modelInputs
              • MapInputsInput.modelSlug
              • MapInputsInput.modelVersion
          • credmark.cmf.types.compose.MapInputsOutput
            • MapInputsOutput
              • MapInputsOutput.results
              • MapInputsOutput.append()
              • MapInputsOutput.extend()
              • MapInputsOutput.to_dataframe()
              • MapInputsOutput.to_list()
          • credmark.cmf.types.compose.MapInputsResult
            • MapInputsResult
              • MapInputsResult.error
              • MapInputsResult.input
              • MapInputsResult.output
        • credmark.cmf.types.contract
          • credmark.cmf.types.contract.get_slot_proxy_address
            • get_slot_proxy_address()
          • credmark.cmf.types.contract.Contract
            • Contract
              • Contract.address
              • Contract.ContractMetaData
                • Contract.ContractMetaData.abi
                • Contract.ContractMetaData.abi_hash
                • Contract.ContractMetaData.constructor_args
                • Contract.ContractMetaData.contract_name
                • Contract.ContractMetaData.deploy_tx_hash
                • Contract.ContractMetaData.deployed_block_number
                • Contract.ContractMetaData.is_transparent_proxy
                • Contract.ContractMetaData.proxy_implementation
              • Contract.fetch_events()
              • Contract.set_abi()
              • Contract.to_accounts()
              • Contract.validate()
              • Contract.abi
              • Contract.constructor_args
              • Contract.contract_name
              • Contract.deploy_tx_hash
              • Contract.deployed_block_number
              • Contract.events
              • Contract.functions
              • Contract.info
              • Contract.instance
              • Contract.is_transparent_proxy
              • Contract.ledger
              • Contract.models
              • Contract.proxy_for
          • credmark.cmf.types.contract.ContractInfo
            • ContractInfo
              • ContractInfo.address
              • ContractInfo.meta
              • ContractInfo.ContractMetaData
                • ContractInfo.ContractMetaData.abi
                • ContractInfo.ContractMetaData.abi_hash
                • ContractInfo.ContractMetaData.constructor_args
                • ContractInfo.ContractMetaData.contract_name
                • ContractInfo.ContractMetaData.deploy_tx_hash
                • ContractInfo.ContractMetaData.deployed_block_number
                • ContractInfo.ContractMetaData.is_transparent_proxy
                • ContractInfo.ContractMetaData.proxy_implementation
              • ContractInfo.fetch_events()
              • ContractInfo.set_abi()
              • ContractInfo.to_accounts()
              • ContractInfo.validate()
              • ContractInfo.abi
              • ContractInfo.constructor_args
              • ContractInfo.contract_name
              • ContractInfo.deploy_tx_hash
              • ContractInfo.deployed_block_number
              • ContractInfo.events
              • ContractInfo.functions
              • ContractInfo.info
              • ContractInfo.instance
              • ContractInfo.is_transparent_proxy
              • ContractInfo.ledger
              • ContractInfo.models
              • ContractInfo.proxy_for
          • credmark.cmf.types.contract.Contracts
            • Contracts
              • Contracts.contracts
              • Contracts.append()
              • Contracts.empty()
              • Contracts.extend()
              • Contracts.from_addresses()
        • credmark.cmf.types.contract_web3
          • credmark.cmf.types.contract_web3.fetch_events
            • fetch_events()
          • credmark.cmf.types.contract_web3.fetch_events_async
            • fetch_events_async()
        • credmark.cmf.types.fiat_currency
          • credmark.cmf.types.fiat_currency.Currency
            • Currency
              • Currency.address
              • Currency.fiat
              • Currency.name
              • Currency.symbol
              • Currency.to_accounts()
              • Currency.validate()
              • Currency.models
          • credmark.cmf.types.fiat_currency.FiatCurrency
            • FiatCurrency
              • FiatCurrency.address
              • FiatCurrency.FiatCurrencyMeta
              • FiatCurrency.to_accounts()
              • FiatCurrency.validate()
              • FiatCurrency.fiat
              • FiatCurrency.models
              • FiatCurrency.name
              • FiatCurrency.symbol
        • credmark.cmf.types.ledger
          • credmark.cmf.types.ledger.BlockTable
            • BlockTable
              • BlockTable.BASE_FEE_PER_GAS
              • BlockTable.DIFFICULTY
              • BlockTable.EXTRA_DATA
              • BlockTable.GAS_LIMIT
              • BlockTable.GAS_USED
              • BlockTable.HASH
              • BlockTable.LOGS_BLOOM
              • BlockTable.MINER
              • BlockTable.NONCE
              • BlockTable.NUMBER
              • BlockTable.PARENT_HASH
              • BlockTable.RECEIPTS_ROOT
              • BlockTable.SHA3_UNCLES
              • BlockTable.SIZE
              • BlockTable.STATE_ROOT
              • BlockTable.TIMESTAMP
              • BlockTable.TOTAL_DIFFICULTY
              • BlockTable.TRANSACTIONS_ROOT
              • BlockTable.TRANSACTION_COUNT
              • BlockTable.colnames
              • BlockTable.columns
          • credmark.cmf.types.ledger.ColumnField
            • ColumnField
          • credmark.cmf.types.ledger.ContractTable
            • ContractTable
              • ContractTable.ADDRESS
              • ContractTable.BLOCK_HASH
              • ContractTable.BLOCK_NUMBER
              • ContractTable.BLOCK_TIMESTAMP
              • ContractTable.BYTECODE
              • ContractTable.IS_ERC20
              • ContractTable.IS_ERC721
              • ContractTable.colnames
              • ContractTable.columns
          • credmark.cmf.types.ledger.JoinType
            • JoinType
          • credmark.cmf.types.ledger.LedgerTable
            • LedgerTable
              • LedgerTable.colnames
              • LedgerTable.columns
          • credmark.cmf.types.ledger.LogTable
            • LogTable
              • LogTable.ADDRESS
              • LogTable.BLOCK_HASH
              • LogTable.BLOCK_NUMBER
              • LogTable.BLOCK_TIMESTAMP
              • LogTable.DATA
              • LogTable.LOG_INDEX
              • LogTable.TOPIC0
              • LogTable.TOPIC1
              • LogTable.TOPIC2
              • LogTable.TOPIC3
              • LogTable.TRANSACTION_HASH
              • LogTable.TRANSACTION_INDEX
              • LogTable.colnames
              • LogTable.columns
          • credmark.cmf.types.ledger.ReceiptTable
            • ReceiptTable
              • ReceiptTable.BLOCK_HASH
              • ReceiptTable.BLOCK_NUMBER
              • ReceiptTable.BLOCK_TIMESTAMP
              • ReceiptTable.CONTRACT_ADDRESS
              • ReceiptTable.CUMULATIVE_GAS_USED
              • ReceiptTable.EFFECTIVE_GAS_PRICE
              • ReceiptTable.GAS_USED
              • ReceiptTable.ROOT
              • ReceiptTable.STATUS
              • ReceiptTable.TRANSACTION_HASH
              • ReceiptTable.TRANSACTION_INDEX
              • ReceiptTable.colnames
              • ReceiptTable.columns
          • credmark.cmf.types.ledger.TokenBalanceTable
            • TokenBalanceTable
              • TokenBalanceTable.ADDRESS
              • TokenBalanceTable.AMOUNT
              • TokenBalanceTable.BLOCK_HASH
              • TokenBalanceTable.BLOCK_NUMBER
              • TokenBalanceTable.BLOCK_TIMESTAMP
              • TokenBalanceTable.COUNTERPARTY_ADDRESS
              • TokenBalanceTable.LOG_INDEX
              • TokenBalanceTable.RAW_AMOUNT
              • TokenBalanceTable.TOKEN_ADDRESS
              • TokenBalanceTable.TRANSACTION_HASH
              • TokenBalanceTable.colnames
              • TokenBalanceTable.columns
          • credmark.cmf.types.ledger.TokenTable
            • TokenTable
              • TokenTable.ADDRESS
              • TokenTable.BLOCK_HASH
              • TokenTable.BLOCK_NUMBER
              • TokenTable.BLOCK_TIMESTAMP
              • TokenTable.DECIMALS
              • TokenTable.NAME
              • TokenTable.SYMBOL
              • TokenTable.colnames
              • TokenTable.columns
          • credmark.cmf.types.ledger.TokenTransferTable
            • TokenTransferTable
              • TokenTransferTable.BLOCK_HASH
              • TokenTransferTable.BLOCK_NUMBER
              • TokenTransferTable.BLOCK_TIMESTAMP
              • TokenTransferTable.FROM_ADDRESS
              • TokenTransferTable.LOG_INDEX
              • TokenTransferTable.RAW_AMOUNT
              • TokenTransferTable.TOKEN_ADDRESS
              • TokenTransferTable.TO_ADDRESS
              • TokenTransferTable.TRANSACTION_HASH
              • TokenTransferTable.USD_AMOUNT
              • TokenTransferTable.colnames
              • TokenTransferTable.columns
          • credmark.cmf.types.ledger.TraceTable
            • TraceTable
              • TraceTable.BLOCK_HASH
              • TraceTable.BLOCK_NUMBER
              • TraceTable.BLOCK_TIMESTAMP
              • TraceTable.CALL_TYPE
              • TraceTable.ERROR
              • TraceTable.FROM_ADDRESS
              • TraceTable.GAS
              • TraceTable.INPUT
              • TraceTable.OUTPUT
              • TraceTable.REWARD_TYPE
              • TraceTable.STATUS
              • TraceTable.TO_ADDRESS
              • TraceTable.TRACE_ADDRESS
              • TraceTable.TRACE_ID
              • TraceTable.TRACE_TYPE
              • TraceTable.TRANSACTION_HASH
              • TraceTable.TRANSACTION_INDEX
              • TraceTable.VALUE
              • TraceTable.colnames
              • TraceTable.columns
          • credmark.cmf.types.ledger.TransactionTable
            • TransactionTable
              • TransactionTable.BLOCK_HASH
              • TransactionTable.BLOCK_NUMBER
              • TransactionTable.BLOCK_TIMESTAMP
              • TransactionTable.FROM_ADDRESS
              • TransactionTable.GAS
              • TransactionTable.GAS_PRICE
              • TransactionTable.HASH
              • TransactionTable.INPUT
              • TransactionTable.MAX_FEE_PER_GAS
              • TransactionTable.MAX_PRIORITY_FEE_PER_GAS
              • TransactionTable.NONCE
              • TransactionTable.TO_ADDRESS
              • TransactionTable.TRANSACTION_INDEX
              • TransactionTable.TRANSACTION_TYPE
              • TransactionTable.VALUE
              • TransactionTable.colnames
              • TransactionTable.columns
          • credmark.cmf.types.ledger.LedgerAggregate
            • LedgerAggregate
              • LedgerAggregate.asName
              • LedgerAggregate.expression
          • credmark.cmf.types.ledger.LedgerJoin
            • LedgerJoin
              • LedgerJoin.alias
              • LedgerJoin.on
              • LedgerJoin.tableKey
              • LedgerJoin.type
          • credmark.cmf.types.ledger.LedgerModelOutput
            • LedgerModelOutput
              • LedgerModelOutput.data
              • LedgerModelOutput.append()
              • LedgerModelOutput.bigint_cols()
              • LedgerModelOutput.extend()
              • LedgerModelOutput.set_bigint_cols()
              • LedgerModelOutput.to_dataframe()
        • credmark.cmf.types.ledger_contract
          • credmark.cmf.types.ledger_contract.ContractEntityFactory
            • ContractEntityFactory
          • credmark.cmf.types.ledger_contract.ContractEntityQuery
            • ContractEntityQuery
              • ContractEntityQuery.select()
          • credmark.cmf.types.ledger_contract.ContractEntityType
            • ContractEntityType
              • ContractEntityType.EVENTS
              • ContractEntityType.FUNCTIONS
          • credmark.cmf.types.ledger_contract.ContractEventsTable
            • ContractEventsTable
              • ContractEventsTable.BLOCK_NUMBER
              • ContractEventsTable.BLOCK_TIMESTAMP
              • ContractEventsTable.CONTRACT_ADDRESS
              • ContractEventsTable.LOG_INDEX
              • ContractEventsTable.TXN_HASH
              • ContractEventsTable.colnames
              • ContractEventsTable.columns
          • credmark.cmf.types.ledger_contract.ContractFunctionsTable
            • ContractFunctionsTable
              • ContractFunctionsTable.BLOCK_NUMBER
              • ContractFunctionsTable.BLOCK_TIMESTAMP
              • ContractFunctionsTable.FROM_ADDRESS
              • ContractFunctionsTable.TO_ADDRESS
              • ContractFunctionsTable.TRACE_ADDRESS
              • ContractFunctionsTable.TXN_HASH
              • ContractFunctionsTable.colnames
              • ContractFunctionsTable.columns
          • credmark.cmf.types.ledger_contract.ContractLedger
            • ContractLedger
          • credmark.cmf.types.ledger_contract.LedgerQueryContractEvents
            • LedgerQueryContractEvents
              • LedgerQueryContractEvents.colnames
              • LedgerQueryContractEvents.columns
              • LedgerQueryContractEvents.select()
          • credmark.cmf.types.ledger_contract.LedgerQueryContractFunctions
            • LedgerQueryContractFunctions
              • LedgerQueryContractFunctions.colnames
              • LedgerQueryContractFunctions.columns
              • LedgerQueryContractFunctions.select()
        • credmark.cmf.types.ledger_errors
          • credmark.cmf.types.ledger_errors.InvalidColumnException
            • InvalidColumnException
          • credmark.cmf.types.ledger_errors.InvalidQueryException
            • InvalidQueryException
        • credmark.cmf.types.ledger_query
          • credmark.cmf.types.ledger_query.LedgerQuery
            • LedgerQuery
              • LedgerQuery.select()
          • credmark.cmf.types.ledger_query.LedgerQueryBase
            • LedgerQueryBase
        • credmark.cmf.types.ledger_series
          • credmark.cmf.types.ledger_series.LedgerBlockNumberTimeSeries
            • LedgerBlockNumberTimeSeries
              • LedgerBlockNumberTimeSeries.blockNumbers
              • LedgerBlockNumberTimeSeries.endTimestamp
              • LedgerBlockNumberTimeSeries.exclusive
              • LedgerBlockNumberTimeSeries.interval
          • credmark.cmf.types.ledger_series.LedgerBlockTimeSeriesInput
            • LedgerBlockTimeSeriesInput
              • LedgerBlockTimeSeriesInput.count
              • LedgerBlockTimeSeriesInput.endTimestamp
              • LedgerBlockTimeSeriesInput.exclusive
              • LedgerBlockTimeSeriesInput.interval
        • credmark.cmf.types.network
          • credmark.cmf.types.network.Network
            • Network
          • credmark.cmf.types.network.NetworkDict
            • NetworkDict
              • NetworkDict.clear()
              • NetworkDict.copy()
              • NetworkDict.default_factory
              • NetworkDict.items()
              • NetworkDict.keys()
              • NetworkDict.popitem()
              • NetworkDict.values()
        • credmark.cmf.types.portfolio
          • credmark.cmf.types.portfolio.PortfolioBuilder
            • PortfolioBuilder
          • credmark.cmf.types.portfolio.Portfolio
            • Portfolio
              • Portfolio.positions
              • Portfolio.append()
              • Portfolio.extend()
              • Portfolio.get_value()
              • Portfolio.merge()
        • credmark.cmf.types.position
          • credmark.cmf.types.position.Position
            • Position
              • Position.amount
              • Position.asset
              • Position.price_quote
              • Position.value
              • Position.compute_value
              • Position.get_value()
        • credmark.cmf.types.price
          • credmark.cmf.types.price.Price
            • Price
              • Price.price
              • Price.src
          • credmark.cmf.types.price.PriceList
            • PriceList
              • PriceList.prices
              • PriceList.src
              • PriceList.tokenAddress
              • PriceList.append()
              • PriceList.extend()
          • credmark.cmf.types.price.PriceWithQuote
            • PriceWithQuote
              • PriceWithQuote.price
              • PriceWithQuote.quoteAddress
              • PriceWithQuote.src
              • PriceWithQuote.cross()
              • PriceWithQuote.eth()
              • PriceWithQuote.inverse()
              • PriceWithQuote.to_price()
              • PriceWithQuote.usd()
        • credmark.cmf.types.rpc
          • credmark.cmf.types.rpc.RpcBlockNumber
            • RpcBlockNumber
              • RpcBlockNumber.blockNumber
              • RpcBlockNumber.blockTimestamp
              • RpcBlockNumber.sampleTimestamp
          • credmark.cmf.types.rpc.RpcBlockRangeOutput
            • RpcBlockRangeOutput
              • RpcBlockRangeOutput.blockNumbers
              • RpcBlockRangeOutput.append()
              • RpcBlockRangeOutput.extend()
          • credmark.cmf.types.rpc.RpcBlockStartEndIntervalInput
            • RpcBlockStartEndIntervalInput
              • RpcBlockStartEndIntervalInput.end
              • RpcBlockStartEndIntervalInput.interval
              • RpcBlockStartEndIntervalInput.start
          • credmark.cmf.types.rpc.RpcBlockWindowIntervalInput
            • RpcBlockWindowIntervalInput
              • RpcBlockWindowIntervalInput.interval
              • RpcBlockWindowIntervalInput.window
        • credmark.cmf.types.series
          • credmark.cmf.types.series.BlockSeries
            • BlockSeries
              • BlockSeries.errors
              • BlockSeries.series
              • BlockSeries.append()
              • BlockSeries.append_error()
              • BlockSeries.extend()
              • BlockSeries.get()
              • BlockSeries.invalid_range()
              • BlockSeries.to_dataframe()
              • BlockSeries.to_list()
              • BlockSeries.to_range()
          • credmark.cmf.types.series.BlockSeriesErrorRow
            • BlockSeriesErrorRow
              • BlockSeriesErrorRow.blockNumber
              • BlockSeriesErrorRow.blockTimestamp
              • BlockSeriesErrorRow.error
              • BlockSeriesErrorRow.sampleTimestamp
          • credmark.cmf.types.series.BlockSeriesRow
            • BlockSeriesRow
              • BlockSeriesRow.blockNumber
              • BlockSeriesRow.blockTimestamp
              • BlockSeriesRow.output
              • BlockSeriesRow.sampleTimestamp
          • credmark.cmf.types.series.ImmutableOutput
            • ImmutableOutput
              • ImmutableOutput.firstResultBlockNumber
          • credmark.cmf.types.series.SeriesModelStartEndIntervalInput
            • SeriesModelStartEndIntervalInput
              • SeriesModelStartEndIntervalInput.end
              • SeriesModelStartEndIntervalInput.interval
              • SeriesModelStartEndIntervalInput.modelInput
              • SeriesModelStartEndIntervalInput.modelSlug
              • SeriesModelStartEndIntervalInput.modelVersion
              • SeriesModelStartEndIntervalInput.start
          • credmark.cmf.types.series.SeriesModelWindowIntervalInput
            • SeriesModelWindowIntervalInput
              • SeriesModelWindowIntervalInput.interval
              • SeriesModelWindowIntervalInput.modelInput
              • SeriesModelWindowIntervalInput.modelSlug
              • SeriesModelWindowIntervalInput.modelVersion
              • SeriesModelWindowIntervalInput.window
        • credmark.cmf.types.token_erc20
          • credmark.cmf.types.token_erc20.get_token_from_configuration
            • get_token_from_configuration()
          • credmark.cmf.types.token_erc20.NativeToken
            • NativeToken
              • NativeToken.address
              • NativeToken.ContractMetaData
                • NativeToken.ContractMetaData.abi
                • NativeToken.ContractMetaData.abi_hash
                • NativeToken.ContractMetaData.constructor_args
                • NativeToken.ContractMetaData.contract_name
                • NativeToken.ContractMetaData.deploy_tx_hash
                • NativeToken.ContractMetaData.deployed_block_number
                • NativeToken.ContractMetaData.is_transparent_proxy
                • NativeToken.ContractMetaData.proxy_implementation
              • NativeToken.TokenMetadata
                • NativeToken.TokenMetadata.abi
                • NativeToken.TokenMetadata.abi_hash
                • NativeToken.TokenMetadata.constructor_args
                • NativeToken.TokenMetadata.contract_name
                • NativeToken.TokenMetadata.decimals
                • NativeToken.TokenMetadata.deploy_tx_hash
                • NativeToken.TokenMetadata.deployed_block_number
                • NativeToken.TokenMetadata.is_transparent_proxy
                • NativeToken.TokenMetadata.name
                • NativeToken.TokenMetadata.proxy_implementation
                • NativeToken.TokenMetadata.set_loaded
                • NativeToken.TokenMetadata.symbol
                • NativeToken.TokenMetadata.total_supply
                • NativeToken.TokenMetadata.wrapped
                • NativeToken.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.abi
              • NativeToken.constructor_args
              • NativeToken.contract_name
              • NativeToken.decimals
              • NativeToken.deploy_tx_hash
              • NativeToken.deployed_block_number
              • NativeToken.events
              • NativeToken.fiat
              • NativeToken.functions
              • NativeToken.info
              • NativeToken.instance
              • NativeToken.is_transparent_proxy
              • NativeToken.ledger
              • NativeToken.models
              • NativeToken.name
              • NativeToken.proxy_for
              • NativeToken.symbol
              • NativeToken.total_supply
              • NativeToken.total_supply_scaled
          • credmark.cmf.types.token_erc20.Token
            • Token
              • Token.address
              • Token.ContractMetaData
                • Token.ContractMetaData.abi
                • Token.ContractMetaData.abi_hash
                • Token.ContractMetaData.constructor_args
                • Token.ContractMetaData.contract_name
                • Token.ContractMetaData.deploy_tx_hash
                • Token.ContractMetaData.deployed_block_number
                • Token.ContractMetaData.is_transparent_proxy
                • Token.ContractMetaData.proxy_implementation
              • Token.TokenMetadata
                • Token.TokenMetadata.abi
                • Token.TokenMetadata.abi_hash
                • Token.TokenMetadata.constructor_args
                • Token.TokenMetadata.contract_name
                • Token.TokenMetadata.decimals
                • Token.TokenMetadata.deploy_tx_hash
                • Token.TokenMetadata.deployed_block_number
                • Token.TokenMetadata.is_transparent_proxy
                • Token.TokenMetadata.name
                • Token.TokenMetadata.proxy_implementation
                • Token.TokenMetadata.set_loaded
                • Token.TokenMetadata.symbol
                • Token.TokenMetadata.total_supply
                • Token.TokenMetadata.wrapped
                • Token.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.abi
              • Token.constructor_args
              • Token.contract_name
              • Token.decimals
              • Token.deploy_tx_hash
              • Token.deployed_block_number
              • Token.events
              • Token.fiat
              • Token.functions
              • Token.info
              • Token.instance
              • Token.is_transparent_proxy
              • Token.ledger
              • Token.models
              • Token.name
              • Token.proxy_for
              • Token.symbol
              • Token.total_supply
              • Token.total_supply_scaled
          • credmark.cmf.types.token_erc20.TokenInfo
            • TokenInfo
              • TokenInfo.address
              • TokenInfo.meta
              • TokenInfo.ContractMetaData
                • TokenInfo.ContractMetaData.abi
                • TokenInfo.ContractMetaData.abi_hash
                • TokenInfo.ContractMetaData.constructor_args
                • TokenInfo.ContractMetaData.contract_name
                • TokenInfo.ContractMetaData.deploy_tx_hash
                • TokenInfo.ContractMetaData.deployed_block_number
                • TokenInfo.ContractMetaData.is_transparent_proxy
                • TokenInfo.ContractMetaData.proxy_implementation
              • TokenInfo.TokenMetadata
                • TokenInfo.TokenMetadata.abi
                • TokenInfo.TokenMetadata.abi_hash
                • TokenInfo.TokenMetadata.constructor_args
                • TokenInfo.TokenMetadata.contract_name
                • TokenInfo.TokenMetadata.decimals
                • TokenInfo.TokenMetadata.deploy_tx_hash
                • TokenInfo.TokenMetadata.deployed_block_number
                • TokenInfo.TokenMetadata.is_transparent_proxy
                • TokenInfo.TokenMetadata.name
                • TokenInfo.TokenMetadata.proxy_implementation
                • TokenInfo.TokenMetadata.set_loaded
                • TokenInfo.TokenMetadata.symbol
                • TokenInfo.TokenMetadata.total_supply
                • TokenInfo.TokenMetadata.wrapped
                • TokenInfo.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.abi
              • TokenInfo.constructor_args
              • TokenInfo.contract_name
              • TokenInfo.decimals
              • TokenInfo.deploy_tx_hash
              • TokenInfo.deployed_block_number
              • TokenInfo.events
              • TokenInfo.fiat
              • TokenInfo.functions
              • TokenInfo.info
              • TokenInfo.instance
              • TokenInfo.is_transparent_proxy
              • TokenInfo.ledger
              • TokenInfo.models
              • TokenInfo.name
              • TokenInfo.proxy_for
              • TokenInfo.symbol
              • TokenInfo.total_supply
              • TokenInfo.total_supply_scaled
          • credmark.cmf.types.token_erc20.Tokens
            • Tokens
              • Tokens.tokens
              • Tokens.append()
              • Tokens.empty()
              • Tokens.extend()
              • Tokens.from_addresses()
        • credmark.cmf.types.token_erc721
          • credmark.cmf.types.token_erc721.NonFungibleToken
            • NonFungibleToken
              • NonFungibleToken.address
              • NonFungibleToken.ContractMetaData
                • NonFungibleToken.ContractMetaData.abi
                • NonFungibleToken.ContractMetaData.abi_hash
                • NonFungibleToken.ContractMetaData.constructor_args
                • NonFungibleToken.ContractMetaData.contract_name
                • NonFungibleToken.ContractMetaData.deploy_tx_hash
                • NonFungibleToken.ContractMetaData.deployed_block_number
                • NonFungibleToken.ContractMetaData.is_transparent_proxy
                • NonFungibleToken.ContractMetaData.proxy_implementation
              • NonFungibleToken.fetch_events()
              • NonFungibleToken.set_abi()
              • NonFungibleToken.to_accounts()
              • NonFungibleToken.validate()
              • NonFungibleToken.abi
              • NonFungibleToken.constructor_args
              • NonFungibleToken.contract_name
              • NonFungibleToken.deploy_tx_hash
              • NonFungibleToken.deployed_block_number
              • NonFungibleToken.events
              • NonFungibleToken.functions
              • NonFungibleToken.info
              • NonFungibleToken.instance
              • NonFungibleToken.is_transparent_proxy
              • NonFungibleToken.ledger
              • NonFungibleToken.models
              • NonFungibleToken.proxy_for
        • credmark.cmf.types.token_wei
          • credmark.cmf.types.token_wei.TokenWei
            • TokenWei
    • credmark.dto
      • credmark.dto.DTOTypesTuple
        • DTOTypesTuple
      • credmark.dto.fixstr
        • fixstr()
      • credmark.dto.DTOPretty
        • DTOPretty
      • credmark.dto.FloatDTO
        • FloatDTO
          • FloatDTO.__add__()
          • FloatDTO.__mul__()
          • FloatDTO.as_integer_ratio()
          • FloatDTO.conjugate()
          • FloatDTO.fromhex()
          • FloatDTO.hex()
          • FloatDTO.imag
          • FloatDTO.is_integer()
          • FloatDTO.real
      • credmark.dto.HexStr
        • HexStr
      • credmark.dto.IntDTO
        • IntDTO
      • credmark.dto.StrDTO
        • StrDTO
      • credmark.dto.EmptyInput
        • EmptyInput
      • credmark.dto.EmptyInputSkipTest
        • EmptyInputSkipTest
      • credmark.dto.IterableListGenericDTO
        • IterableListGenericDTO
          • IterableListGenericDTO.append()
          • IterableListGenericDTO.extend()
      • credmark.dto.dto_error_schema
        • credmark.dto.dto_error_schema.extract_error_codes_and_descriptions
          • extract_error_codes_and_descriptions()
      • credmark.dto.dto_schema
        • credmark.dto.dto_schema.combine_dict
          • combine_dict()
        • credmark.dto.dto_schema.cross_examples
          • cross_examples()
        • credmark.dto.dto_schema.dto_schema_viz
          • dto_schema_viz()
        • credmark.dto.dto_schema.print_example
          • print_example()
        • credmark.dto.dto_schema.print_tree
          • print_tree()
      • credmark.dto.encoder
        • credmark.dto.encoder.json_dump
          • json_dump()
        • credmark.dto.encoder.json_dumps
          • json_dumps()
        • credmark.dto.encoder.PydanticJSONEncoder
          • PydanticJSONEncoder
            • PydanticJSONEncoder.iterencode()
      • credmark.dto.transform
        • credmark.dto.transform.transform_data_for_dto
          • transform_data_for_dto()
        • credmark.dto.transform.transform_dto_to_dict
          • transform_dto_to_dict()
        • credmark.dto.transform.DataTransformError
          • DataTransformError
• Credmark SDK (Python)
  • Installation
  • Usage
  • Examples
    • 1. DeFi API - Run models
    • 2. Portfolio API
    • 3. Token API
  • Handling Errors
  • Available APIs
  • Things to know
  • Advanced Usage