@peeramid-labs/sdk 2.0.1 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/docs/classes/ApiError.md +44 -0
  2. package/docs/classes/InstanceBase.md +341 -0
  3. package/docs/classes/InstancePlayer.md +568 -0
  4. package/docs/classes/MAODistributorClient.md +307 -0
  5. package/docs/classes/Multipass.md +276 -0
  6. package/docs/classes/MultipassBase.md +217 -0
  7. package/docs/docs/.nojekyll +1 -0
  8. package/docs/docs/classes/ApiError.md +44 -0
  9. package/docs/docs/classes/InstanceBase.md +341 -0
  10. package/docs/docs/classes/InstancePlayer.md +568 -0
  11. package/docs/docs/classes/MAODistributorClient.md +307 -0
  12. package/docs/docs/classes/Multipass.md +276 -0
  13. package/docs/docs/classes/MultipassBase.md +217 -0
  14. package/docs/docs/enums/SearchCriteria.md +29 -0
  15. package/docs/docs/enums/gameStatusEnum.md +71 -0
  16. package/docs/docs/index.md +367 -0
  17. package/docs/docs/interfaces/ApiErrorOptions.md +30 -0
  18. package/docs/docs/interfaces/MAOInstanceContracts.md +53 -0
  19. package/docs/docs/interfaces/MAOInstances.md +53 -0
  20. package/docs/docs/interfaces/RegisterMessage.md +53 -0
  21. package/docs/docs/interfaces/SignerIdentity.md +35 -0
  22. package/docs/enums/SearchCriteria.md +29 -0
  23. package/docs/enums/gameStatusEnum.md +71 -0
  24. package/docs/index.md +367 -0
  25. package/docs/interfaces/ApiErrorOptions.md +30 -0
  26. package/docs/interfaces/MAOInstanceContracts.md +53 -0
  27. package/docs/interfaces/MAOInstances.md +53 -0
  28. package/docs/interfaces/RegisterMessage.md +53 -0
  29. package/docs/interfaces/SignerIdentity.md +35 -0
  30. package/package.json +3 -3
  31. package/docs/assets/highlight.css +0 -64
  32. package/docs/assets/icons.js +0 -15
  33. package/docs/assets/icons.svg +0 -1
  34. package/docs/assets/main.js +0 -59
  35. package/docs/assets/navigation.js +0 -1
  36. package/docs/assets/search.js +0 -1
  37. package/docs/assets/style.css +0 -1412
  38. package/docs/index.html +0 -62
  39. package/docs/modules.html +0 -1
package/docs/index.html DELETED
@@ -1,62 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@peeramid-labs/sdk</title><meta name="description" content="Documentation for @peeramid-labs/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@peeramid-labs/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@peeramid-labs/sdk</h2></div><div class="tsd-panel tsd-typography"><a id="md:sdk" class="tsd-anchor"></a><h1><a href="#md:sdk">SDK</a></h1><p>This is SDK for use with Rankify game. You can ease interaction with smart contracts.</p>
2
- <a id="md:prerequisites" class="tsd-anchor"></a><h2><a href="#md:prerequisites">Prerequisites</a></h2><p>Before setting up the local development environment, ensure you have the following installed:</p>
3
- <ol>
4
- <li><p><strong>Node.js and pnpm</strong></p>
5
- <pre><code class="language-bash"><span class="hl-0"># Using homebrew</span><br/><span class="hl-1">brew</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">node</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-4">-g</span><span class="hl-2"> </span><span class="hl-3">pnpm</span>
6
- </code><button>Copy</button></pre>
7
- </li>
8
- <li><p><strong>Foundry (for Anvil)</strong></p>
9
- <pre><code class="language-bash"><span class="hl-1">curl</span><span class="hl-2"> </span><span class="hl-4">-L</span><span class="hl-2"> </span><span class="hl-3">https://foundry.paradigm.xyz</span><span class="hl-2"> | </span><span class="hl-1">bash</span><br/><span class="hl-1">foundryup</span>
10
- </code><button>Copy</button></pre>
11
- </li>
12
- <li><p><strong>tmux</strong></p>
13
- <pre><code class="language-bash"><span class="hl-0"># Using homebrew</span><br/><span class="hl-1">brew</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">tmux</span>
14
- </code><button>Copy</button></pre>
15
- </li>
16
- </ol>
17
- <a id="md:local-development-setup" class="tsd-anchor"></a><h2><a href="#md:local-development-setup">Local Development Setup</a></h2><p>To set up your local development environment:</p>
18
- <ol>
19
- <li><p>Create your environment file:</p>
20
- <pre><code class="language-bash"><span class="hl-1">cp</span><span class="hl-2"> </span><span class="hl-3">.env.example</span><span class="hl-2"> </span><span class="hl-3">.env</span>
21
- </code><button>Copy</button></pre>
22
- <p>Then edit <code>.env</code> to set your local repository paths.</p>
23
- </li>
24
- <li><p>Set the required environment variables:</p>
25
- <pre><code class="language-bash"><span class="hl-4">export</span><span class="hl-2"> </span><span class="hl-5">RANKIFY_CONTRACTS_PATH</span><span class="hl-2">=</span><span class="hl-3">&quot;/path/to/rankify/contracts&quot;</span><br/><span class="hl-4">export</span><span class="hl-2"> </span><span class="hl-5">EDS_PATH</span><span class="hl-2">=</span><span class="hl-3">&quot;/path/to/eds&quot;</span><br/><span class="hl-4">export</span><span class="hl-2"> </span><span class="hl-5">MULTIPASS_PATH</span><span class="hl-2">=</span><span class="hl-3">&quot;/path/to/multipass&quot;</span>
26
- </code><button>Copy</button></pre>
27
- </li>
28
- <li><p>Make the setup script executable:</p>
29
- <pre><code class="language-bash"><span class="hl-1">chmod</span><span class="hl-2"> </span><span class="hl-3">+x</span><span class="hl-2"> </span><span class="hl-3">scripts/setup-local-dev.sh</span>
30
- </code><button>Copy</button></pre>
31
- </li>
32
- <li><p>Run the setup script:</p>
33
- <pre><code class="language-bash"><span class="hl-1">source</span><span class="hl-2"> </span><span class="hl-3">.env</span><span class="hl-2"> &amp;&amp; </span><span class="hl-1">./scripts/setup-local-dev.sh</span>
34
- </code><button>Copy</button></pre>
35
- </li>
36
- </ol>
37
- <p>This will:</p>
38
- <ul>
39
- <li>Start a local Anvil development network in a tmux session (or use existing one if running)</li>
40
- <li>Install dependencies for all repositories</li>
41
- <li>Run local deployment scripts (<code>playbook/utils/deploy-to-local-anvil.sh</code>) in each repository</li>
42
- <li>Set up local pnpm links between packages</li>
43
- </ul>
44
- <p>The script uses a fixed mnemonic for consistent addresses across runs.</p>
45
- <a id="md:managing-anvil" class="tsd-anchor"></a><h3><a href="#md:managing-anvil">Managing Anvil</a></h3><ul>
46
- <li>View Anvil logs: <code>tmux attach -t anvil</code></li>
47
- <li>Detach from logs: Press <code>Ctrl+B</code> then <code>D</code></li>
48
- <li>Stop Anvil: <code>tmux kill-session -t anvil</code></li>
49
- </ul>
50
- <a id="md:documentation" class="tsd-anchor"></a><h2><a href="#md:documentation">Documentation</a></h2><p>The SDK comes with comprehensive API documentation generated using TypeDoc. The documentation is automatically generated during the package build process and is included in the npm package.</p>
51
- <a id="md:generating-documentation" class="tsd-anchor"></a><h3><a href="#md:generating-documentation">Generating Documentation</a></h3><p>To generate the documentation locally:</p>
52
- <pre><code class="language-bash"><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-3">run</span><span class="hl-2"> </span><span class="hl-3">docs</span>
53
- </code><button>Copy</button></pre>
54
- <p>This will create a <code>docs</code> directory with the generated documentation.</p>
55
- <p>For development, you can use the watch mode:</p>
56
- <pre><code class="language-bash"><span class="hl-1">pnpm</span><span class="hl-2"> </span><span class="hl-3">run</span><span class="hl-2"> </span><span class="hl-3">docs:watch</span>
57
- </code><button>Copy</button></pre>
58
- <a id="md:accessing-documentation" class="tsd-anchor"></a><h3><a href="#md:accessing-documentation">Accessing Documentation</a></h3><ul>
59
- <li><strong>Local Development</strong>: Open <code>docs/index.html</code> in your browser after generating the documentation</li>
60
- <li><strong>Published Package</strong>: Documentation is available through the npm package page</li>
61
- </ul>
62
- </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:sdk"><span>SDK</span></a><ul><li><a href="#md:prerequisites"><span>Prerequisites</span></a></li><li><a href="#md:local-development-setup"><span>Local <wbr/>Development <wbr/>Setup</span></a></li><li><ul><li><a href="#md:managing-anvil"><span>Managing <wbr/>Anvil</span></a></li></ul></li><li><a href="#md:documentation"><span>Documentation</span></a></li><li><ul><li><a href="#md:generating-documentation"><span>Generating <wbr/>Documentation</span></a></li><li><a href="#md:accessing-documentation"><span>Accessing <wbr/>Documentation</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@peeramid-labs/sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/modules.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@peeramid-labs/sdk</title><meta name="description" content="Documentation for @peeramid-labs/sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@peeramid-labs/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@peeramid-labs/sdk</h2></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@peeramid-labs/sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>