GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

stub

Browse Source
This commit is contained in:
mfahampshire
2024-10-05 12:52:02 +02:00
parent b577fd7a29
commit 6a67275b44
3 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/docs/components/my-tab.tsx
+6
View File
@@ -0,0 +1,6 @@
import { Tabs } from "nextra/components";
export const MyTab = ({ name, children }) => (
<Tabs.Tab>
{name} {children}
</Tabs.Tab>
);
documentation/docs/pages/developers/integrations.mdx
+2 -3
View File
@@ -4,7 +4,6 @@ import { Tabs } from 'nextra/components'
import { GitHubRepoSearch } from '../../code-snippets/mixfetchurl';
# Integration Options
Developers might want to either integrate a Mixnet client or just to interact with the blockchain. See the relevant section below.
### Integrating Mixnet Functionality
@@ -14,7 +13,7 @@ There are several options available to developers wanting to embed a Nym client
<Tabs.Tab >
<>
Typescript and Javascript developers have several options avaliable to them:
- [`mixfetch`]() is an almost-dropin replacement for the `fetch` library. The best way to integrate Nym's `mixFetch` into your application will be where external network calls and RPC happens, for example, something in the lines of `sendRawTransaction` if you have an ETH-compatible wallet or `JsonRpcClient` if you use CosmJS. Although you can simply search for any JS `fetch` calls in your code (using our tool below) that are easily replaceable with `mixFetch`, keep in mind that `fetch` is not the only way to make `JSONRPC` or `XHR` calls. We advise to approach the integration process in a semantic way, searching for a module that is the common denominator for external communication in the codebase. Usually these are API controllers, middlewares or repositories.
- [`mixfetch`]() TODO LINK is an almost-dropin replacement for the `fetch` library. The best way to integrate Nym's `mixFetch` into your application will be where external network calls and RPC happens, for example, something in the lines of `sendRawTransaction` if you have an ETH-compatible wallet or `JsonRpcClient` if you use CosmJS. Although you can simply search for any JS `fetch` calls in your code (using our tool below) that are easily replaceable with `mixFetch`, keep in mind that `fetch` is not the only way to make `JSONRPC` or `XHR` calls. We advise to approach the integration process in a semantic way, searching for a module that is the common denominator for external communication in the codebase. Usually these are API controllers, middlewares or repositories.
<GitHubRepoSearch />
@@ -30,7 +29,7 @@ There are several options available to developers wanting to embed a Nym client
</ >
</Tabs.Tab>
<Tabs.Tab> If your app is not written in any of the supported languages, you might still be able to send traffic through a standalone socks5 client TODO LINK but will have to think about packaging and bundling the client binary with e.g. a `systemd` file for autostart to run the client as a daemon. If you want to discuss FFI options reach out to us via our public dev channel. </Tabs.Tab>
<Tabs.Tab> If your app is not written in any of the supported languages, you might still be able to send traffic through a standalone socks5 client TODO LINK but will have to think about packaging and bundling the client binary with e.g. a `systemd` file for autostart to run the client as a daemon. If you want to discuss FFI options reach out to us via our public dev channel. TODO LINK </Tabs.Tab>
</Tabs>
### Interacting with Nyx
documentation/rework_todo.md
+4 -1
View File
@@ -38,6 +38,8 @@ Initial overhaul
- [ ] pull in all docs updates after 37d9f919227cec148e0355404b4029c0949e4dea from develop !!
- [ ] operators docs (various)
- [x] ecash
- [ ] wait on ania's updates
- [ ] wait on whether we change the language now that we have 4 ticketbooks.. talk to jaya
- [ ] developers
- [ ] overhaul the FAQs and split out into integrations section
@@ -62,11 +64,12 @@ Initial overhaul
- [ ] make common links (e.g. github) variables if we require several
- [x] remove dangling index
- [ ] bring in notes from Claudia's presentation
Autodocs
--------
- [x] autodocs branch - merge in
- [ ] work out where `autodocs` sits in CI
- [ ] work out where `autodocs` sits in CI - call in package.json instead
- [ ] `autodocs` pages - incorporate
CI / deployment