CapSign
  • Home
  • Compliance Framework
  • Interactive Demos
    • Overview
  • Create an Account
  • Identity Verification
  • Investor Qualification
  • Guides for Individuals
    • Invest in an Offering
  • Guides for Corporations
    • Create a Share Class
    • Authorize Shares
    • Issue Shares
    • Upload a Document
    • Create a Document Template
    • Create an Offering
    • Manage Your Offering
    • Add a Trusted Attestor
    • Approve an Investment
  • API Reference
    • Overview
    • Compliance
      • Exemptions
        • FederalExemption.sol
          • FederalExemption
        • RegAExemption.sol
          • RegAExemption
        • RegCFExemption.sol
          • RegCFExemption
        • RegDExemption.sol
          • RegDExemption
        • Rule144Exemption.sol
          • Rule144Exemption
        • Rule701Exemption.sol
          • Rule701Exemption
      • IComplianceModule.sol
        • IComplianceModule
      • Vesting.sol
        • Vesting
    • Currencies
      • WETH.sol
        • WETH
      • CMX.sol
        • CMX
      • USD.sol
        • USD
    • Governance
      • BoardManagement.sol
        • BoardManagement
      • ProxyVoting.sol
        • ProxyVoting
    • Identity
      • AttestationRegistry.sol
        • AttestationRegistry
      • ERC20PaymentResolver.sol
        • ERC20PaymentResolver
      • Roles
        • BaseRoles.sol
          • BaseRoles
        • PrivateOfferingRoles.sol
          • PrivateOfferingRoles
        • PublicOfferingRoles.sol
          • PublicOfferingRoles
      • Whitelist.sol
        • Whitelist
    • Issuance
      • Compensation
        • CompensationFactory.sol
          • CompensationFactory
        • EmployeeStockOptionCompensation.sol
          • EmployeeStockOptionCompensation
        • RestrictedStockAwardCompensation.sol
          • RestrictedStockAwardCompensation
        • StockAppreciationRightsCompensation.sol
          • StockAppreciationRightCompensation
        • WarrantCompensation.sol
          • WarrantCompensation
      • Offering
        • ExemptOffering.sol
          • ExemptOffering
        • InitialPublicOffering.sol
          • InitialPublicOffering
        • Offering.sol
          • Offering
        • OfferingFactory.sol
          • OfferingFactory
        • Rule506bOffering.sol
          • Rule506bOffering
        • Rule506cOffering.sol
          • Rule506cOffering
        • TenderOffer.sol
          • TenderOffer
    • Investor Relations
      • DividendDistributor.sol
        • DividendDistributor
      • SubscriptionManager.sol
        • SubscriptionManager
        • IERC20
    • Ledgers
      • Ledger.sol
        • Ledger
      • LedgerManager.sol
        • LedgerManager
      • SettlementManager.sol
        • SettlementManager
    • Marketplace
      • AuctionMarket.sol
        • AuctionMarket
      • BaseMarket.sol
        • BaseMarket
      • BulletinBoardMarket.sol
        • BulletinBoardMarket
      • Contents
        • BaseCollateral.sol
          • BaseCollateral
        • ERC20Collateral.sol
          • ERC20Collateral
        • NativeCollateral.sol
          • NativeCollateral
      • LiquidityPoolMarket.sol
        • LiquidityPoolMarket
      • Contents
        • BaseMargin.sol
          • BaseMargin
        • MarginAccount.sol
          • MarginAccount
      • MarginOrderBookMarket.sol
        • MarginOrderBookMarket
      • OTCMarket.sol
        • OTCMarket
      • OrderBookMarket.sol
        • OrderBookMarket
      • Contents
        • BrokerNetSettlement.sol
          • BrokerNetSettlement
        • CustodyBridge.sol
          • CustodyBridge
        • DirectSettlement.sol
          • DirectSettlement
        • ListingRegistry.sol
          • ListingRegistry
    • Tokenization
      • Actions
        • CorporateActionManager.sol
          • CorporateActionManager
          • ICapitalAsset
        • ICorporateActionManager.sol
          • ICorporateActionManager
      • Assets
        • Asset.sol
          • Asset
          • Asset
        • ClosedEndFundClass.sol
          • ClosedEndFundClass
        • ClosedEndFundManager.sol
          • ClosedEndFundManager
        • EmployeeStockOption.sol
          • EmployeeStockOption
        • Contents
          • IAsset.sol
            • IAsset
          • IClosedEndFundClass.sol
            • IClosedEndFundClass
          • IIssuedAsset.sol
            • IIssuedAsset
          • IOpenEndFundClass.sol
            • IOpenEndFundClass
          • IShareClass.sol
            • IShareClass
        • IssuedAsset.sol
          • IssuedAsset
        • OpenEndFundClass.sol
          • OpenEndFundClass
        • OpenEndFundManager.sol
          • OpenEndFundManager
        • ShareClass.sol
          • ShareClass
        • StockAppreciationRight.sol
          • StockAppreciationRight
        • Warrant.sol
          • Warrant
      • TokenFactory.sol
        • TokenFactory
    • Utilities
      • PriceFeed.sol
        • SimplePriceFeed
        • IPriceFeed
    • Valuations
      • ValuationRegistry.sol
        • ValuationRegistry
    • Wallet
      • HookedSmartWallet.sol
        • HookedSmartWallet
      • Wallet.sol
        • Wallet
Powered by GitBook
On this page
  • State Variables
  • listingRegistry
  • brokerNetSettlement
  • directSettlement
  • BROKER_CHECK_CONTRACT
  • orderBookMapping
  • Functions
  • constructor
  • createListing
  • executeTrade
  • cancelListing
  • _settleBrokerNet
  • isBroker

Was this helpful?

  1. API Reference
  2. Marketplace
  3. OrderBookMarket.sol

OrderBookMarket

PreviousOrderBookMarket.solNextContents

Last updated 3 months ago

Was this helpful?

Inherits:

A more advanced market with multiple asks and bids, matching them on price-time priority or some other logic. Here we integrate with:

  • ListingRegistry for multi-lot listings

  • BrokerNetSettlement for broker-based settlement

  • DirectSettlement for on-chain direct settlement

State Variables

listingRegistry

ListingRegistry public listingRegistry;

brokerNetSettlement

BrokerNetSettlement public brokerNetSettlement;

directSettlement

DirectSettlement public directSettlement;

BROKER_CHECK_CONTRACT

address constant BROKER_CHECK_CONTRACT = 0x000000000000000000000000000000000000b0b0;

orderBookMapping

mapping(bytes32 => uint96) public orderBookMapping;

Functions

constructor

constructor(address _listingRegistry, address _brokerNetSettlement, address _directSettlement);

createListing

Creates a listing in the order book. For demonstration, we just create a single-lot array or a multi-lot array. Returns listingId.

function createListing(uint96 quantity, uint256 price) external override returns (bytes32);

executeTrade

Executes (fills) a trade against an existing listing. If there's more shares requested than available, it reverts. If fully filled, the listing is removed from the registry. Splits the logic between broker settlement or direct settlement.

function executeTrade(bytes32 listingId, uint96 tradeQuantity) external payable override;

cancelListing

Cancels a listing if the seller no longer wants to sell or if partially filled.

function cancelListing(bytes32 listingId) external override;

_settleBrokerNet

*Settlement logic for broker-based trades that uses BrokerNetSettlement.

  • If both buyer and seller are brokers, we simply update net balances.

  • If only one side is broker, you could optionally do partial direct settlement, but for simplicity, we'll treat either side as a broker => net settlement approach.*

function _settleBrokerNet(address buyer, address seller, uint96 quantity, uint256 totalPrice) internal;

isBroker

Stub function to call a "fake" broker-check contract. Returns true if address is recognized as a broker.

function isBroker(address account) internal view returns (bool);
Git Source
BaseMarket