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

docs: update to Atlas version 0.12.0 #111

Merged
merged 1 commit into from
Mar 1, 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
27 changes: 24 additions & 3 deletions src/pages/getting-started/endpoints.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,30 @@ where `coreProvider` field can have one of following possible values:
</Tab>
<Tab>
```json
"coreProvider": { "socketPath": "path-to-node-socket", "kupoUrl": "http://localhost:1442" },
"coreProvider": {
"socketPath": "path-to-node-socket",
"kupoUrl": "http://localhost:1442",
"localTxSubmissionCache": {
"cacheInterval": 1
},
"mempoolCache": {
"cacheInterval": 1
}
},
```
</Tab>
<Tab>
```json
"coreProvider": { "ogmiosUrl": "http://localhost:1337", "kupoUrl": "http://localhost:1442" },
"coreProvider": {
"ogmiosUrl": "http://localhost:1337",
"kupoUrl": "http://localhost:1442"
"localTxSubmissionCache": {
"cacheInterval": 1
},
"mempoolCache": {
"cacheInterval": 1
}
},
```
</Tab>
<Tab>
Expand All @@ -91,7 +109,10 @@ Here is the explanation for each of the JSON keys above:

* **`coreProvider`**: This field is the differentiating factor between different providers.
* For Maestro, `maestroToken` holds the api key and `turboSubmit` field dictates whether the transactions are to be submitted via their [turbo submit](https://docs.gomaestro.org/Cardano/Transaction-Manager/tx-manager-turbo-submit) endpoint.
* For Local Node with Kupo provider, `socketPath` is the path towards node socket (usually named `node.socket`) file and `kupoUrl` is the url where endpoints are made available by Kupo, it is usually `http://localhost:1442`.
* For Local Node with Kupo provider, `socketPath` is the path towards node socket (usually named `node.socket`) file, `kupoUrl` is the url where endpoints are made available by Kupo, it is usually `http://localhost:1442`.
* `mempoolCache` denotes if one would like to use mempool to know for already spent inputs and to be made available outputs when utilising UTxO query functions such as `utxosAtAddresses`. `cacheInterval` here denotes how long (in seconds) will the mempool information would be cached as we would not want to query mempool frequently.
* Similarly `localTxSubmissionCache` denotes if one would like to consider locally submitted transactions to know for already spend inputs and to be made available outputs when utilising UTxO query functions. `cacheInterval` here denotes how long (in seconds) would one like to consider previously submitted transactions. We wouldn't want to carry huge amount of data in memory, so it's better to forget about old submitted transactions as their information would already be reflected in the tip.
* For Ogmios with Kupo provider, `ogmiosUrl` is the URL of Ogmios host and rest of the fields are same as in "Local node with Kupo provider".
* For Blockfrost, `blockfrostKey` holds the required api key.
* **`networkId`**: Specifies your network and must be one of `mainnet`, `preprod`, `preview`, `testnet` (for legacy testnet) & `privnet` (for local private network).
* **`logging`**: It's a list of [scribes](https://hackage.haskell.org/package/katip-0.8.7.3/docs/Katip.html#t:Scribe) to register. Its parameters (like `severity`, `verbosity`) and its general usage can be understood by going over their official haddock documentation [here](https://hackage.haskell.org/package/katip-0.8.7.2/docs/Katip.html). Katip is also explained in [this](https://link.springer.com/book/10.1007/978-1-4842-3739-7) book on web development in Haskell. Please have a look at haddock for `FromJSON` and `ToJSON` instances of [`GYLogScriptType`](https://haddock.atlas-app.io/GeniusYield-Types-Logging.html#t:GYLogScribeType) to see sample usage.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ Work through an end-to-end example here: [Getting Started](./getting-started).

<Callout>

This guide tracks the Atlas version [0.11.1](https://github.com/geniusyield/atlas/releases/tag/v0.11.1).
This guide tracks the Atlas version [0.12.0](https://github.com/geniusyield/atlas/releases/tag/v0.12.0).

</Callout>