Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
core
command
Command core is OpenFief's core service (docs/DESIGN.md D-2): the system of record.
|
Command core is OpenFief's core service (docs/DESIGN.md D-2): the system of record. |
|
demo-seed
command
Command demo-seed loads the demo dataset (internal/demo) into an OpenFief database, through the same paths real data takes: the IBKR history through the ibkrflex connector and the ingest service, the other accounts through the ledger's API, prices, FX rates, CPI and bond terms through valuation's input recorder, and the stored valuations through the River revaluation queue (D-36).
|
Command demo-seed loads the demo dataset (internal/demo) into an OpenFief database, through the same paths real data takes: the IBKR history through the ibkrflex connector and the ingest service, the other accounts through the ledger's API, prices, FX rates, CPI and bond terms through valuation's input recorder, and the stored valuations through the River revaluation queue (D-36). |
|
egress-proxy
command
Command egress-proxy is OpenFief's egress proxy (D-32, D-63): Smokescreen, embedded in OpenFief's own HTTP server, with plugin identity from projected ServiceAccount tokens (audience openfief-egress) checked by TokenReview and cached, and per-plugin egress allow-lists from the operator's ConfigMap.
|
Command egress-proxy is OpenFief's egress proxy (D-32, D-63): Smokescreen, embedded in OpenFief's own HTTP server, with plugin identity from projected ServiceAccount tokens (audience openfief-egress) checked by TokenReview and cached, and per-plugin egress allow-lists from the operator's ConfigMap. |
|
openfief
command
Command openfief is the owner's command line (D-46): it installs, upgrades, uninstalls and lists plugin instances with the owner's own kubeconfig, and gives the owner the link for the first passkey (D-80).
|
Command openfief is the owner's command line (D-46): it installs, upgrades, uninstalls and lists plugin instances with the owner's own kubeconfig, and gives the owner the link for the first passkey (D-80). |
|
operator
command
Command operator runs OpenFief's plugin operator (D-13): it reconciles the Plugin and PluginGrant resources of the openfief namespace, and only that namespace (D-15), into running, isolated plugins.
|
Command operator runs OpenFief's plugin operator (D-13): it reconciles the Plugin and PluginGrant resources of the openfief namespace, and only that namespace (D-15), into running, isolated plugins. |
|
sigstore-trusted-root
command
Command sigstore-trusted-root fetches the Sigstore public-good trusted root (trusted_root.json) through TUF and writes it where the operator embeds it (D-56).
|
Command sigstore-trusted-root fetches the Sigstore public-good trusted root (trusted_root.json) through TUF and writes it where the operator embeds it (D-56). |
|
Package design embeds OpenFief's design system (docs/dev/design-system.md) for Go programs that serve it: the built-in UI serves these files as they are, so design/ stays the single source and nothing is copied out of it.
|
Package design embeds OpenFief's design system (docs/dev/design-system.md) for Go programs that serve it: the built-in UI serves these files as they are, so design/ stays the single source and nothing is copied out of it. |
|
internal
|
|
|
attention
Package attention is the attention context: the attention items that ask the owner to look at something, in one append-only store (docs/DESIGN.md D-130, D-131).
|
Package attention is the attention context: the attention items that ask the owner to look at something, in one append-only store (docs/DESIGN.md D-130, D-131). |
|
attention/app
Package app holds the attention context's use cases (docs/DESIGN.md D-130, D-131): checks raising and clearing attention items in the store, the owner acknowledging and resolving them, and the outbox's events handed to a publisher.
|
Package app holds the attention context's use cases (docs/DESIGN.md D-130, D-131): checks raising and clearing attention items in the store, the owner acknowledging and resolving them, and the outbox's events handed to a publisher. |
|
attention/connectapi
Package connectapi serves the attention context's AttentionService (proto/openfief/attention/v1/attention.proto) to view plugins over Connect: the built-in UI hands the owner's acknowledgement or resolution of an attention item to the core through it (D-130, D-79).
|
Package connectapi serves the attention context's AttentionService (proto/openfief/attention/v1/attention.proto) to view plugins over Connect: the built-in UI hands the owner's acknowledgement or resolution of an attention item to the core through it (D-130, D-79). |
|
attention/postgres
Package postgres stores attention items in PostgreSQL, in the attention schema that Migrate creates (docs/DESIGN.md D-130): the items, their append-only history, and the core's transactional outbox, whose event for a change is written in the same database transaction as the change.
|
Package postgres stores attention items in PostgreSQL, in the attention schema that Migrate creates (docs/DESIGN.md D-130): the items, their append-only history, and the core's transactional outbox, whose event for a change is written in the same database transaction as the change. |
|
demo
Package demo generates the demo dataset: a synthetic portfolio, about a year of its history and its valuation inputs, for showing OpenFief's real pipelines working on fake data (GR-12).
|
Package demo generates the demo dataset: a synthetic portfolio, about a year of its history and its valuation inputs, for showing OpenFief's real pipelines working on fake data (GR-12). |
|
identity
Package identity is the identity bounded context: who may use OpenFief.
|
Package identity is the identity bounded context: who may use OpenFief. |
|
identity/app
Package app holds the identity context's use cases: issuing, verifying, revoking and listing script tokens (docs/DESIGN.md D-27).
|
Package app holds the identity context's use cases: issuing, verifying, revoking and listing script tokens (docs/DESIGN.md D-27). |
|
identity/cli
Package cli is the identity context's part of the owner's openfief command line: `openfief enroll`, the first passkey (D-80).
|
Package cli is the identity context's part of the owner's openfief command line: `openfief enroll`, the first passkey (D-80). |
|
identity/connectapi
Package connectapi serves the identity context's AuthService (proto/openfief/identity/v1/auth.proto) to view plugins over Connect: the built-in UI calls it as the backend of the owner's browser (author decision, auth split).
|
Package connectapi serves the identity context's AuthService (proto/openfief/identity/v1/auth.proto) to view plugins over Connect: the built-in UI calls it as the backend of the owner's browser (author decision, auth split). |
|
identity/kube
Package kube is the identity context's Kubernetes adapter.
|
Package kube is the identity context's Kubernetes adapter. |
|
identity/postgres
Package postgres is the identity context's store in PostgreSQL (docs/DESIGN.md D-14): an app.Store for script tokens (D-27) over a pgx pool, and Migrate, which creates and upgrades the identity schema from the SQL files embedded in migrations/.
|
Package postgres is the identity context's store in PostgreSQL (docs/DESIGN.md D-14): an app.Store for script tokens (D-27) over a pgx pool, and Migrate, which creates and upgrades the identity schema from the SQL files embedded in migrations/. |
|
identity/webauthn
Package webauthn runs the WebAuthn side of passkey ceremonies for the identity context (docs/DESIGN.md D-26) on github.com/go-webauthn/webauthn, so no WebAuthn verification is written here (D-29).
|
Package webauthn runs the WebAuthn side of passkey ceremonies for the identity context (docs/DESIGN.md D-26) on github.com/go-webauthn/webauthn, so no WebAuthn verification is written here (D-29). |
|
identity/webauthn/virtual
Package virtual is a software WebAuthn authenticator for tests: it holds one ES256 passkey and answers creation and request options the way a browser and a platform authenticator would, with attestation "none", user presence and user verification.
|
Package virtual is a software WebAuthn authenticator for tests: it holds one ES256 passkey and answers creation and request options the way a browser and a platform authenticator would, with attestation "none", user presence and user verification. |
|
ingest
Package ingest is the ingest bounded context: institutions, import batches, and the mapping of what a connector reads from an institution into ledger transactions, balance assertions and ingest problems (docs/DESIGN.md D-7, D-18, D-23).
|
Package ingest is the ingest bounded context: institutions, import batches, and the mapping of what a connector reads from an institution into ledger transactions, balance assertions and ingest problems (docs/DESIGN.md D-7, D-18, D-23). |
|
ingest/app
Package app holds the ingest context's use cases: running a connector's ingest path, from a file or a pull, through its mapper into the ledger (D-7, D-18, D-23).
|
Package app holds the ingest context's use cases: running a connector's ingest path, from a file or a pull, through its mapper into the ledger (D-7, D-18, D-23). |
|
ingest/connectapi
Package connectapi serves the ingest context's BondLotService (proto/openfief/ingest/v1/bond_lots.proto) and StatementService (statements.proto) to view plugins over Connect: the built-in UI hands each treasury bond lot the owner enters, and streams each statement file the owner uploads, to the core through them (D-7, D-9, D-49).
|
Package connectapi serves the ingest context's BondLotService (proto/openfief/ingest/v1/bond_lots.proto) and StatementService (statements.proto) to view plugins over Connect: the built-in UI hands each treasury bond lot the owner enters, and streams each statement file the owner uploads, to the core through them (D-7, D-9, D-49). |
|
ingest/connectrpc
Package connectrpc calls connector plugins' connector contract, openfief.connector.v1.ConnectorService, over Connect RPC (D-11, D-49): the core's side of a plugin connector's ingest path (D-7).
|
Package connectrpc calls connector plugins' connector contract, openfief.connector.v1.ConnectorService, over Connect RPC (D-11, D-49): the core's side of a plugin connector's ingest path (D-7). |
|
ingest/delivery
Package delivery is the connector side of the connector contract (D-49): it writes a connector's mapping, prices, FX rates, index readings, index levels and ingest mode as openfief.connector.v1 messages, the reverse of what the core's internal/ingest/connectrpc reads.
|
Package delivery is the connector side of the connector contract (D-49): it writes a connector's mapping, prices, FX rates, index readings, index levels and ingest mode as openfief.connector.v1 messages, the reverse of what the core's internal/ingest/connectrpc reads. |
|
ingest/ibkrflex
Package ibkrflex is the Interactive Brokers Flex Query connector's adapter and anti-corruption layer: it parses a Flex Query XML statement (FlexQueryResponse > FlexStatements > FlexStatement) and translates IBKR's sections into ledger transactions, balance assertions and ingest problems.
|
Package ibkrflex is the Interactive Brokers Flex Query connector's adapter and anti-corruption layer: it parses a Flex Query XML statement (FlexQueryResponse > FlexStatements > FlexStatement) and translates IBKR's sections into ledger transactions, balance assertions and ingest problems. |
|
ingest/kube
Package kube is the ingest context's Kubernetes adapter: Discovery finds the connector instances that run in the cluster (docs/DESIGN.md D-48, D-49) and the address of each one's Service, by watching the operator's Plugin resources and the Services it creates for them.
|
Package kube is the ingest context's Kubernetes adapter: Discovery finds the connector instances that run in the cluster (docs/DESIGN.md D-48, D-49) and the address of each one's Service, by watching the operator's Plugin resources and the Services it creates for them. |
|
ingest/postgres
Package postgres is the ingest context's store in PostgreSQL (docs/DESIGN.md D-14): the app.SyncStore that keeps each connector instance's watermark, sync state and import batch history (D-49), and the app.BindingStore of connector bindings, over a pgx pool.
|
Package postgres is the ingest context's store in PostgreSQL (docs/DESIGN.md D-14): the app.SyncStore that keeps each connector instance's watermark, sync state and import batch history (D-49), and the app.BindingStore of connector bindings, over a pgx pool. |
|
ingest/treasurybonds
Package treasurybonds is the Polish retail treasury bond connector's logic (D-9, D-49): it maps the bond lots the owner enters by hand in the built-in UI, which the core hands to the connector, into ledger transactions and the series terms valuation needs.
|
Package treasurybonds is the Polish retail treasury bond connector's logic (D-9, D-49): it maps the bond lots the owner enters by hand in the built-in UI, which the core hands to the connector, into ledger transactions and the series terms valuation needs. |
|
ingest/xtb
Package xtb maps XTB's xStation "Historia operacji" export, an .xlsx file of one account (R-24), into the connector contract's mapping (D-9).
|
Package xtb maps XTB's xStation "Historia operacji" export, an .xlsx file of one account (R-24), into the connector contract's mapping (D-9). |
|
ingest/xtb/xtbtest
Package xtbtest writes synthetic xStation "Historia operacji" exports laid out as R-24 describes, for tests only.
|
Package xtbtest writes synthetic xStation "Historia operacji" exports laid out as R-24 describes, for tests only. |
|
jurisdiction
Package jurisdiction is the contract of a jurisdiction pack (GR-13, D-70): the pure rules of one country behind one interface, Pack, so another country is another implementation of it.
|
Package jurisdiction is the contract of a jurisdiction pack (GR-13, D-70): the pure rules of one country behind one interface, Pack, so another country is another implementation of it. |
|
jurisdiction/pl
Package pl holds Polish jurisdiction rules as pure functions: retail treasury bond series and their statutory valuation, tax wrappers (IKE, IKZE), Belka tax on bond interest, which NBP rate tax uses, and the business days that pick the NBP reference rate for ROR and DOR.
|
Package pl holds Polish jurisdiction rules as pure functions: retail treasury bond series and their statutory valuation, tax wrappers (IKE, IKZE), Belka tax on bond interest, which NBP rate tax uses, and the business days that pick the NBP reference rate for ROR and DOR. |
|
kernel
Package kernel is the shared kernel of the bounded contexts: exact decimal numbers, currencies, money, quantities and calendar dates.
|
Package kernel is the shared kernel of the bounded contexts: exact decimal numbers, currencies, money, quantities and calendar dates. |
|
ledger
Package ledger is the ledger bounded context: accounts, ledger accounts, transactions and their postings, instruments, holdings, lots and balance assertions (docs/DESIGN.md D-18, D-19, D-20, D-23).
|
Package ledger is the ledger bounded context: accounts, ledger accounts, transactions and their postings, instruments, holdings, lots and balance assertions (docs/DESIGN.md D-18, D-19, D-20, D-23). |
|
ledger/app
Package app holds the ledger context's use cases: registering sleeves and accounts, importing transactions and balance assertions into the append-only, versioned transaction log (docs/DESIGN.md D-18), and the queries the read API answers from it.
|
Package app holds the ledger context's use cases: registering sleeves and accounts, importing transactions and balance assertions into the append-only, versioned transaction log (docs/DESIGN.md D-18), and the queries the read API answers from it. |
|
ledger/connectapi
Package connectapi serves the ledger context's TransferService (proto/openfief/ledger/v1/transfers.proto) and CashCheckpointService (cash_checkpoints.proto) to view plugins over Connect: the built-in UI hands the owner's decision on a suggested transfer (D-105), and the cash an institution showed with the differences the owner books (D-158), to the core through them (D-79).
|
Package connectapi serves the ledger context's TransferService (proto/openfief/ledger/v1/transfers.proto) and CashCheckpointService (cash_checkpoints.proto) to view plugins over Connect: the built-in UI hands the owner's decision on a suggested transfer (D-105), and the cash an institution showed with the differences the owner books (D-158), to the core through them (D-79). |
|
ledger/postgres
Package postgres is the ledger's store in PostgreSQL (docs/DESIGN.md D-14): an app.Store over a pgx pool, and Migrate, which creates and upgrades the ledger schema from the SQL files embedded in migrations/.
|
Package postgres is the ledger's store in PostgreSQL (docs/DESIGN.md D-14): an app.Store over a pgx pool, and Migrate, which creates and upgrades the ledger schema from the SQL files embedded in migrations/. |
|
plugins
Package plugins is the plugins bounded context: what a plugin requests (Plugin, Manifest), what the owner approved (Grant), what is enforced (EffectivePermissions, D-16), and how that compiles into a Workload: the domain description of a plugin's NetworkPolicy, Secret mounts, RBAC, projected token and egress allow-list (D-11, D-27, D-32).
|
Package plugins is the plugins bounded context: what a plugin requests (Plugin, Manifest), what the owner approved (Grant), what is enforced (EffectivePermissions, D-16), and how that compiles into a Workload: the domain description of a plugin's NetworkPolicy, Secret mounts, RBAC, projected token and egress allow-list (D-11, D-27, D-32). |
|
plugins/app
Package app holds the plugins context's use cases and the ports they consume.
|
Package app holds the plugins context's use cases and the ports they consume. |
|
plugins/catalog
Package catalog is OpenFief's plugin catalog (D-43): plugins.json, a file in this repository released with the product and embedded in the operator.
|
Package catalog is OpenFief's plugin catalog (D-43): plugins.json, a file in this repository released with the product and embedded in the operator. |
|
plugins/cli
Package cli is the openfief command line (D-46): it installs, uninstalls and lists plugin instances with the owner's own kubeconfig.
|
Package cli is the openfief command line (D-46): it installs, uninstalls and lists plugin instances with the owner's own kubeconfig. |
|
plugins/cosign
Package cosign checks plugin images in their registry (D-17, D-42, D-56): it finds an image's cosign signatures, verifies them with sigstore-go against the bundled Sigstore trust root and the trust policy's signers, and reads the image's manifest label.
|
Package cosign checks plugin images in their registry (D-17, D-42, D-56): it finds an image's cosign signatures, verifies them with sigstore-go against the bundled Sigstore trust root and the trust policy's signers, and reads the image's manifest label. |
|
plugins/cosign/cosigntest
Package cosigntest builds signed plugin images for tests of code that checks them with package cosign: an in-memory OCI registry served over HTTP, images carrying a manifest label, and cosign bundles signed with a fresh key and attached as OCI referrers, the way `cosign sign --key` stores them.
|
Package cosigntest builds signed plugin images for tests of code that checks them with package cosign: an in-memory OCI registry served over HTTP, images carrying a manifest label, and cosign bundles signed with a fresh key and attached as OCI referrers, the way `cosign sign --key` stores them. |
|
plugins/egress
Package egress holds the egress proxy's destination checks that need net/netip, which the domain packages may not import.
|
Package egress holds the egress proxy's destination checks that need net/netip, which the domain packages may not import. |
|
plugins/kube
Package kube is the egress proxy's Kubernetes adapter: it verifies plugin tokens with the TokenReview API (D-63) and follows the egress allow-list ConfigMap the operator writes (D-32).
|
Package kube is the egress proxy's Kubernetes adapter: it verifies plugin tokens with the TokenReview API (D-63) and follows the egress allow-list ConfigMap the operator writes (D-32). |
|
plugins/operator
Package operator is the plugin operator's Kubernetes adapter (D-13): it reconciles Plugin and PluginGrant resources in the openfief namespace (D-15) into each plugin's ServiceAccount, config ConfigMap, Service, NetworkPolicy and Deployment, and publishes every running plugin's egress allow-list in the plugins.EgressAllowListConfigMap ConfigMap for the egress proxy (D-32).
|
Package operator is the plugin operator's Kubernetes adapter (D-13): it reconciles Plugin and PluginGrant resources in the openfief namespace (D-15) into each plugin's ServiceAccount, config ConfigMap, Service, NetworkPolicy and Deployment, and publishes every running plugin's egress allow-list in the plugins.EgressAllowListConfigMap ConfigMap for the egress proxy (D-32). |
|
plugins/operator/v1alpha1
Package v1alpha1 is the openfief.io/v1alpha1 API of the plugin operator: the Plugin and PluginGrant custom resources (D-13, D-16).
|
Package v1alpha1 is the openfief.io/v1alpha1 API of the plugin operator: the Plugin and PluginGrant custom resources (D-13, D-16). |
|
plugins/smokescreen
Package smokescreen is the egress proxy adapter: Stripe's Smokescreen, embedded as a library through BuildProxy inside OpenFief's own HTTP server (D-32, D-63).
|
Package smokescreen is the egress proxy adapter: Stripe's Smokescreen, embedded as a library through BuildProxy inside OpenFief's own HTTP server (D-32, D-63). |
|
portfolio
Package portfolio is the portfolio bounded context: the sleeves that accounts belong to, each with one role and one sleeve kind, and the optional model portfolio the real portfolio is compared with (D-52 to D-54): its targets and weights, its backtest from end-of-day history, rebalanced yearly, and the max drawdown of a series.
|
Package portfolio is the portfolio bounded context: the sleeves that accounts belong to, each with one role and one sleeve kind, and the optional model portfolio the real portfolio is compared with (D-52 to D-54): its targets and weights, its backtest from end-of-day history, rebalanced yearly, and the max drawdown of a series. |
|
portfolio/app
Package app holds the portfolio context's use cases for the model portfolio: the owner reads and replaces it (D-52), and the read API gets its backtest and max drawdowns while it is on (D-53, D-54).
|
Package app holds the portfolio context's use cases for the model portfolio: the owner reads and replaces it (D-52), and the read API gets its backtest and max drawdowns while it is on (D-53, D-54). |
|
portfolio/connectapi
Package connectapi serves the portfolio context's ModelPortfolioService (proto/openfief/portfolio/v1/model.proto) to view plugins over Connect: the built-in UI hands the owner's model portfolio to the core through it (D-52, D-49).
|
Package connectapi serves the portfolio context's ModelPortfolioService (proto/openfief/portfolio/v1/model.proto) to view plugins over Connect: the built-in UI hands the owner's model portfolio to the core through it (D-52, D-49). |
|
portfolio/postgres
Package postgres is the portfolio context's store in PostgreSQL (docs/DESIGN.md D-14): the optional model portfolio (D-52), whether it is on and its targets, over a pgx pool, and Migrate, which creates and upgrades the portfolio schema from the SQL files embedded in migrations/.
|
Package postgres is the portfolio context's store in PostgreSQL (docs/DESIGN.md D-14): the optional model portfolio (D-52), whether it is on and its targets, over a pgx pool, and Migrate, which creates and upgrades the portfolio schema from the SQL files embedded in migrations/. |
|
valuation
Package valuation holds prices, FX rates, each naming its base, and valuations of holdings, as pure values and functions.
|
Package valuation holds prices, FX rates, each naming its base, and valuations of holdings, as pure values and functions. |
|
valuation/app
Package app holds valuation's use cases and the ports they consume.
|
Package app holds valuation's use cases and the ports they consume. |
|
valuation/connectapi
Package connectapi serves the valuation context's MarketDataService (proto/openfief/valuation/v1/market_data.proto) to view plugins over Connect: the built-in UI hands the owner's ranking of market-data sources, each series' source and the gap thresholds to the core through it (D-94, D-79).
|
Package connectapi serves the valuation context's MarketDataService (proto/openfief/valuation/v1/market_data.proto) to view plugins over Connect: the built-in UI hands the owner's ranking of market-data sources, each series' source and the gap thresholds to the core through it (D-94, D-79). |
|
valuation/eodhd
Package eodhd is the market-data adapter for EODHD (D-22, D-51): an HTTP client for EODHD's search and end-of-day APIs.
|
Package eodhd is the market-data adapter for EODHD (D-22, D-51): an HTTP client for EODHD's search and end-of-day APIs. |
|
valuation/gus
Package gus is an HTTP adapter for the public API of Statistics Poland (GUS), the SDP API at https://api-sdp.stat.gov.pl: it fetches consumer prices year on year (CPI), which set the rates of inflation-indexed treasury bonds after their first interest period (D-9), and maps them to valuation.IndexReading.
|
Package gus is an HTTP adapter for the public API of Statistics Poland (GUS), the SDP API at https://api-sdp.stat.gov.pl: it fetches consumer prices year on year (CPI), which set the rates of inflation-indexed treasury bonds after their first interest period (D-9), and maps them to valuation.IndexReading. |
|
valuation/nbp
Package nbp is the default FX rate provider (D-20): an HTTP adapter for the National Bank of Poland's public Web API that fetches table A, the daily average exchange rates, and maps it to valuation.FXRate.
|
Package nbp is the default FX rate provider (D-20): an HTTP adapter for the National Bank of Poland's public Web API that fetches table A, the daily average exchange rates, and maps it to valuation.FXRate. |
|
valuation/postgres
Package postgres is the valuation context's store and job queue in PostgreSQL (docs/DESIGN.md D-14, D-36): prices, FX rates, period index readings, bond series terms and tax wrappers; the stored valuations and each account's valued-through date; and the River queue that revalues accounts.
|
Package postgres is the valuation context's store and job queue in PostgreSQL (docs/DESIGN.md D-14, D-36): prices, FX rates, period index readings, bond series terms and tax wrappers; the stored valuations and each account's valued-through date; and the River queue that revalues accounts. |
|
views
Package views holds the pure rules behind the read API (docs/DESIGN.md D-6): paging transactions, totalling valuations per date, the allocation the built-in UI charts (D-30), grouped by asset class, currency, institution or sleeve, and the portfolio's time-weighted return (D-61), chained across external cash flows with transfers between the owner's accounts left out.
|
Package views holds the pure rules behind the read API (docs/DESIGN.md D-6): paging transactions, totalling valuations per date, the allocation the built-in UI charts (D-30), grouped by asset class, currency, institution or sleeve, and the portfolio's time-weighted return (D-61), chained across external cash flows with transfers between the owner's accounts left out. |
|
views/app
Package app holds the views context's use cases: the queries the read-only /v1 API answers (docs/DESIGN.md D-6), composed from the ledger's queries, the stored valuations and their status (D-36), and FX rates (D-20).
|
Package app holds the views context's use cases: the queries the read-only /v1 API answers (docs/DESIGN.md D-6), composed from the ledger's queries, the stored valuations and their status (D-36), and FX rates (D-20). |
|
views/browserproxy
Package browserproxy is the views context's HTTP adapter for D-81: the core is the only entry point for browsers, and it reverse-proxies each browser request to the one view plugin that holds a browser path (D-114), such as the built-in UI, with the core's own token for that instance (D-59).
|
Package browserproxy is the views context's HTTP adapter for D-81: the core is the only entry point for browsers, and it reverse-proxies each browser request to the one view plugin that holds a browser path (D-114), such as the built-in UI, with the core's own token for that instance (D-59). |
|
views/cli
Package cli is the views context's part of the owner's command line: `openfief check balances`, the owner's balance check (D-200, criterion 1).
|
Package cli is the views context's part of the owner's command line: `openfief check balances`, the owner's balance check (D-200, criterion 1). |
|
views/connectapi
Package connectapi serves the read API (docs/DESIGN.md D-6, D-50): the openfief.views.v1.ReadService defined in proto/openfief/views/v1, as Connect (and gRPC, gRPC-Web) for generated clients and, transcoded by Vanguard from the same handlers, as REST under /v1.
|
Package connectapi serves the read API (docs/DESIGN.md D-6, D-50): the openfief.views.v1.ReadService defined in proto/openfief/views/v1, as Connect (and gRPC, gRPC-Web) for generated clients and, transcoded by Vanguard from the same handlers, as REST under /v1. |
|
views/ghostfolio
Package ghostfolio is the Ghostfolio view (D-3, D-4, D-64): it reads the record through the read API and keeps the Ghostfolio accounts it owns equal to it, with a reconcile loop.
|
Package ghostfolio is the Ghostfolio view (D-3, D-4, D-64): it reads the record through the read API and keeps the Ghostfolio accounts it owns equal to it, with a reconcile loop. |
|
views/kube
Package kube is the views context's Kubernetes adapter: Plugins reads the installed plugin instances (docs/DESIGN.md D-46, D-48) and how far each image is trusted (D-56) from the operator's Plugin resources, for the read API to list them and to mark transactions of removed instances (D-58).
|
Package kube is the views context's Kubernetes adapter: Plugins reads the installed plugin instances (docs/DESIGN.md D-46, D-48) and how far each image is trusted (D-56) from the operator's Plugin resources, for the read API to list them and to mark transactions of removed instances (D-58). |
|
views/ui
Package ui is the built-in UI (D-3): a view plugin that serves the owner's browser as its backend (backend for frontend).
|
Package ui is the built-in UI (D-3): a view plugin that serves the owner's browser as its backend (backend for frontend). |
|
plugins
|
|
|
eodhd
command
Command eodhd is OpenFief's first-party market-data connector plugin (D-22, D-51, D-49): the core calls its Sync for the end-of-day closes of the instruments the owner holds and the model portfolio targets, which each sync request names (D-93), and the levels of the model portfolio's market indices, from EODHD on the owner's own API key.
|
Command eodhd is OpenFief's first-party market-data connector plugin (D-22, D-51, D-49): the core calls its Sync for the end-of-day closes of the instruments the owner holds and the model portfolio targets, which each sync request names (D-93), and the levels of the model portfolio's market indices, from EODHD on the owner's own API key. |
|
ghostfolio
command
Command ghostfolio is OpenFief's Ghostfolio view plugin (D-3, D-4, D-64): every interval it reads the record through the core's read API, with its own projected ServiceAccount token (D-27), and makes the Ghostfolio accounts it owns hold exactly the record's projection.
|
Command ghostfolio is OpenFief's Ghostfolio view plugin (D-3, D-4, D-64): every interval it reads the record through the core's read API, with its own projected ServiceAccount token (D-27), and makes the Ghostfolio accounts it owns hold exactly the record's projection. |
|
ibkr-flex
command
Command ibkr-flex is OpenFief's first-party Interactive Brokers Flex Query connector plugin (D-49): the core calls its Sync to pull the statement of the owner's Flex Query from IBKR's Flex Web Service, and its ImportFile to map an uploaded Flex statement, in the opening or transactions mode the call names (D-23).
|
Command ibkr-flex is OpenFief's first-party Interactive Brokers Flex Query connector plugin (D-49): the core calls its Sync to pull the statement of the owner's Flex Query from IBKR's Flex Web Service, and its ImportFile to map an uploaded Flex statement, in the opening or transactions mode the call names (D-23). |
|
nbp-fx
command
Command nbp-fx is OpenFief's first-party NBP FX connector plugin (D-20, D-49): the core calls its Sync for the National Bank of Poland's table A exchange rates to PLN since the previous sync.
|
Command nbp-fx is OpenFief's first-party NBP FX connector plugin (D-20, D-49): the core calls its Sync for the National Bank of Poland's table A exchange rates to PLN since the previous sync. |
|
treasury-bonds
command
Command treasury-bonds is OpenFief's first-party Polish retail treasury bond connector plugin (D-9, D-49).
|
Command treasury-bonds is OpenFief's first-party Polish retail treasury bond connector plugin (D-9, D-49). |
|
ui
command
Command ui is OpenFief's built-in UI (D-3), a view plugin: it serves the owner's browser on the plugin port, through the core, which proxies the UI's browser path "/" to it (D-81), and talks to the core only.
|
Command ui is OpenFief's built-in UI (D-3), a view plugin: it serves the owner's browser on the plugin port, through the core, which proxies the UI's browser path "/" to it (D-81), and talks to the core only. |
|
xtb
command
Command xtb is OpenFief's first-party XTB connector plugin (D-9, D-49): the core calls its ImportFile with an xStation "Historia operacji" export the owner uploaded (R-24), one account per file, and it maps the file in the transactions mode the call names.
|
Command xtb is OpenFief's first-party XTB connector plugin (D-9, D-49): the core calls its ImportFile with an xStation "Historia operacji" export the owner uploaded (R-24), one account per file, and it maps the file in the transactions mode the call names. |
|
sdk
|
|
|
go
module
|
|
|
test
|
|
|
e2e/apicontract
Package apicontract walks the read API's contract for the end-to-end suite's check of D-200's criterion 7: the operations its OpenAPI document lists, the HTTP routes the protobuf service's google.api.http annotations declare (D-50), the REST target and the Connect request of one call built from the same request fields, and the Connect error code of a refused call.
|
Package apicontract walks the read API's contract for the end-to-end suite's check of D-200's criterion 7: the operations its OpenAPI document lists, the HTTP routes the protobuf service's google.api.http annotations declare (D-50), the REST target and the Connect request of one call built from the same request fields, and the Connect error code of a refused call. |
|
e2e/chartcheck
Package chartcheck works out, for the end-to-end suite's check of D-200's criterion 8, what the built-in UI's charts must draw when it draws them from the read API alone, and which calls the UI made to the core while it drew them.
|
Package chartcheck works out, for the end-to-end suite's check of D-200's criterion 8, what the built-in UI's charts must draw when it draws them from the read API alone, and which calls the UI made to the core while it drew them. |
|
e2e/fixture
command
Command fixture is the end-to-end suite's institution fixture server, built only for the suite (scripts/e2e-images.sh) and never released.
|
Command fixture is the end-to-end suite's institution fixture server, built only for the suite (scripts/e2e-images.sh) and never released. |
|
e2e/ghostfoliocheck
Package ghostfoliocheck reads, for the end-to-end suite's check of D-200's criterion 9, what the Ghostfolio view plugin reports and what a real Ghostfolio holds after it synced: each pass of the reconcile loop the plugin logged, with its counts or its error; the transaction key an activity's comment names (D-4); the units of a bond series an owned account holds in Ghostfolio, to compare with the read API's holding; an owned account's cash balance on a date (D-108), to compare with the read API's cash; a line per activity and balance, IDs included, to tell that a sync changed nothing; and the body of the hand edit an owner makes in Ghostfolio's UI, which the next sync must revert.
|
Package ghostfoliocheck reads, for the end-to-end suite's check of D-200's criterion 9, what the Ghostfolio view plugin reports and what a real Ghostfolio holds after it synced: each pass of the reconcile loop the plugin logged, with its counts or its error; the transaction key an activity's comment names (D-4); the units of a bond series an owned account holds in Ghostfolio, to compare with the read API's holding; an owned account's cash balance on a date (D-108), to compare with the read API's cash; a line per activity and balance, IDs included, to tell that a sync changed nothing; and the body of the hand edit an owner makes in Ghostfolio's UI, which the next sync must revert. |
|
e2e/modelcheck
Package modelcheck works out, for the end-to-end suite's check of D-200's criterion 19, what the read API's model portfolio and the built-in UI must answer for the two synthetic index series of modelseries, by hand: the basket's value on each stretch of days is written down as a table worked out from the levels (one yearly rebalance on December 31, D-53), not computed by the backtest the core runs, and the max drawdowns (D-54) are the series' known peak and trough days.
|
Package modelcheck works out, for the end-to-end suite's check of D-200's criterion 19, what the read API's model portfolio and the built-in UI must answer for the two synthetic index series of modelseries, by hand: the basket's value on each stretch of days is written down as a table worked out from the levels (one yearly rebalance on December 31, D-53), not computed by the backtest the core runs, and the max drawdowns (D-54) are the series' known peak and trough days. |
|
e2e/modelseries
Package modelseries holds the two synthetic index series the end-to-end suite's model portfolio runs on (D-200's criterion 19): MODA and MODB, each a closing level in PLN per weekday, as EODHD's end-of-day API would serve them for MODA.INDX and MODB.INDX.
|
Package modelseries holds the two synthetic index series the end-to-end suite's model portfolio runs on (D-200's criterion 19): MODA and MODB, each a closing level in PLN per weekday, as EODHD's end-of-day API would serve them for MODA.INDX and MODB.INDX. |
|
tools
|
|
|
affected
command
Command affected decides which checks a change needs, so the pre-commit hook and CI run only what the change can affect (docs/dev/pipeline.md#affected-checks).
|
Command affected decides which checks a change needs, so the pre-commit hook and CI run only what the change can affect (docs/dev/pipeline.md#affected-checks). |
|
archtest
Package archtest holds OpenFief's architecture tests (docs/dev/code-organization.md#architecture-tests): rules over the whole repository's packages, imports, types, SQL, contracts and tests, which a linter that sees one file at a time cannot check.
|
Package archtest holds OpenFief's architecture tests (docs/dev/code-organization.md#architecture-tests): rules over the whole repository's packages, imports, types, SQL, contracts and tests, which a linter that sees one file at a time cannot check. |
|
docgen
command
Command docgen generates the docs site's reference pages and checks that hand-written pages keep up with the code they cover (docs/dev/docs.md).
|
Command docgen generates the docs site's reference pages and checks that hand-written pages keep up with the code they cover (docs/dev/docs.md). |
|
openapierrors
command
Command openapierrors adds the read API's error responses to its generated OpenAPI document (docs/dev/pipeline.md#contracts).
|
Command openapierrors adds the read API's error responses to its generated OpenAPI document (docs/dev/pipeline.md#contracts). |
|
protobreak
command
Command protobreak decides which breaking contract changes proto:breaking lets through (docs/dev/pipeline.md#breaking-contract-changes).
|
Command protobreak decides which breaking contract changes proto:breaking lets through (docs/dev/pipeline.md#breaking-contract-changes). |
Click to show internal directories.
Click to hide internal directories.