Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added content for new numscript interpreter #122

Merged
merged 3 commits into from
Mar 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/numscript/embedding.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: Embedding
title: Selecting an interpreter
---

Historically, Numscript was being built in a tightly knit way to our Ledger service, an extensible system-of-record and querying layer for financial transactions.
Since Ledger v2.2, two versions of the Numscript interpreter are available: the original, built directly into our Ledger service, and a new portable and embeddable interpreter that can run independently or enhance other ledgering systems.

The new revision of Numscript is this time designed with portability and embeddability in mind. While Numscript is natively embedded in our Ledger service, you can also now run Numscript separately or bolt it on top of your existing ledgering system as a way to improve its programmability.
The original interpreter is enabled by default but is no longer evolving, while the new version will receive ongoing updates and must be manually enabled.

The standalone Numscript codebase can be found [here](https://github.com/formancehq/numscript).
To enable the new interpreter, enable the `ledger.experimental-features` and `ledger.experimental-numscript` [settings](../operator/Configuration%20reference/Settings).

Note that the [Numscript playground](https://playground.numscript.org/?template=simple-send) uses the new interpreter, so results there may differ from those in production.
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@ const sidebars = {
{
type: 'doc',
id: 'numscript/embedding',
label: "Selecting an interpreter",
},
{
type: 'category',
Expand Down
10 changes: 6 additions & 4 deletions versioned_docs/version-v2.x/numscript/embedding.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: Embedding
title: Selecting an interpreter
---

Historically, Numscript was being built in a tightly knit way to our Ledger service, an extensible system-of-record and querying layer for financial transactions.
Since Ledger v2.2, two versions of the Numscript interpreter are available: the original, built directly into our Ledger service, and a new portable and embeddable interpreter that can run independently or enhance other ledgering systems.

The new revision of Numscript is this time designed with portability and embeddability in mind. While Numscript is natively embedded in our Ledger service, you can also now run Numscript separately or bolt it on top of your existing ledgering system as a way to improve its programmability.
The original interpreter is enabled by default but is no longer evolving, while the new version will receive ongoing updates and must be manually enabled.

The standalone Numscript codebase can be found [here](https://github.com/formancehq/numscript).
To enable the new interpreter, enable the `ledger.experimental-features` and `ledger.experimental-numscript` [settings](../operator/Configuration%20reference/Settings).

Note that the [Numscript playground](https://playground.numscript.org/?template=simple-send) uses the new interpreter, so results there may differ from those in production.