@monolythium/core-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 Monolythium
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,200 @@
+# @monolythium/core-sdk
+
+Official TypeScript SDK for [Monolythium v4.0](https://monolythium.com) (LythiumDAG-BFT).
+
+## Install
+
+```bash
+pnpm add @monolythium/core-sdk
+```
+
+## Usage
+
+```ts
+import { RpcClient } from "@monolythium/core-sdk";
+
+const client = await RpcClient.forNetwork("testnet-69420", { probe: true });
+
+const chainId = await client.ethChainId();
+const head = await client.ethBlockNumber();
+console.log(`chain ${chainId} at height ${head}`);
+
+const clusters = await client.lythClusterDirectory(0, 100);
+console.log(`${clusters.totalClusters} cluster descriptors`);
+
+const decoded = await client.lythDecodeTx("0x...");
+const holders = await client.lythRichList("0x...", 25);
+const txs = await client.lythTxFeed(25);
+const markets = await client.lythClobMarkets(25);
+console.log(decoded.status, holders.holders.length, txs.transactions.length, markets.markets.length);
+```
+
+The client wraps every JSON-RPC method served by a Monolythium node — the
+EVM-compatible `eth_*` / `net_*` / `web3_*` surface and the chain-native
+`lyth_*` and `debug_*` namespaces, including live explorer helpers such as
+`lyth_decodeTx`, `lyth_gapRecords`, `lyth_dagParents`, `lyth_richList`,
+`lyth_txFeed`, `lyth_addressProfile`, `lyth_addressFlow`, `lyth_search`,
+`lyth_chainStats`, `lyth_clobMarkets`, `lyth_clobTrades`, `lyth_clobOhlc`,
+`lyth_clobOrderBook`, and `lyth_addressActivityKind`. Wire types are generated
+from the Rust SDK via `ts-rs` where possible, with SDK-local convenience types
+for newer explorer envelopes.
+
+Quantities surface as `bigint` to preserve full precision. Use
+`parseQuantity` only when you know the value fits in `Number.MAX_SAFE_INTEGER`.
+
+### Node API client
+
+The SDK also exports `ApiClient` for the node's REST-shaped `/api/v1` surface.
+Pass the JSON-RPC endpoint; the client derives `/api/v1` automatically.
+
+```ts
+import { ApiClient } from "@monolythium/core-sdk";
+
+const api = new ApiClient("https://rpc.testnet.monolythium.com");
+
+const latest = await api.block("latest");
+const txs = await api.blockTransactions("latest", 0, 25);
+const activity = await api.addressActivity("0x123456789abcdef0112233445566778899aabbcc");
+
+console.log(latest.data.block.blockHash, txs.data.totalTransactions, activity.data.entries.length);
+```
+
+### Chain registry
+
+The SDK vendors the official testnet bootstrap IPs from
+`monolythium/chain-registry` and can optionally fetch the latest raw
+registry TOML at runtime.
+
+```ts
+import {
+  RpcClient,
+  fetchChainInfoLatest,
+  getP2pSeeds,
+  getRpcEndpoints,
+} from "@monolythium/core-sdk";
+
+console.log(getRpcEndpoints("testnet-69420").map((r) => r.url));
+console.log(getP2pSeeds("testnet-69420").map((p) => p.multiaddr));
+
+const latest = await fetchChainInfoLatest("testnet-69420");
+const client = await RpcClient.fromFirstReachable(latest);
+```
+
+`RpcClient.forNetwork("testnet-69420")` picks the first official endpoint in
+the bundled snapshot. Pass `{ probe: true }` to walk the endpoints and choose
+the first one that answers with the expected chain id.
+
+### Address helpers
+
+User-facing surfaces should display Monolythium addresses as `mono1...`
+bech32m, while JSON-RPC still uses 20-byte `0x...` hex.
+
+```ts
+import { addressToBech32, bech32ToAddress } from "@monolythium/core-sdk";
+
+const display = addressToBech32("0x123456789abcdef0112233445566778899aabbcc");
+const wire = bech32ToAddress(display);
+```
+
+### Spending-policy helpers
+
+Fresh sub-account policy claims must use `claimPolicyByAddress` or
+`setPolicyClaim`, both of which bind the policy to a sub-account ML-DSA-65
+signature. Prefer `claimPolicyByAddress` after the pubkey is registered in
+pubkey-registry; it avoids carrying the 1952-byte pubkey in calldata.
+
+```ts
+import {
+  composeClaimBoundMessage,
+  encodeClaimPolicyByAddressCalldata,
+  encodeSetPolicyClaimCalldata,
+} from "@monolythium/core-sdk";
+
+const message = composeClaimBoundMessage(69420n, policyArgs);
+// Sign `message` with the sub-account ML-DSA-65 key, then:
+const calldata = encodeClaimPolicyByAddressCalldata(policyArgs, subAccountSig);
+```
+
+### Pubkey-registry helpers
+
+The pubkey-registry precompile at `0x110D` publishes an account's
+primary ML-DSA-65 pubkey once, so contracts can look it up by address.
+
+```ts
+import {
+  encodeRegisterPubkeyCalldata,
+  encodeLookupPubkeyCalldata,
+  decodeLookupPubkeyReturn,
+} from "@monolythium/core-sdk";
+
+const calldata = encodeRegisterPubkeyCalldata(mlDsa65Pubkey);
+const lookup = encodeLookupPubkeyCalldata("0x123456789abcdef0112233445566778899aabbcc");
+const decoded = decodeLookupPubkeyReturn(returnData);
+```
+
+### PQM-1 + ML-DSA-65 helpers
+
+Wallets and faucets can derive deterministic ML-DSA-65 backends directly in
+TypeScript from PQM-1 mnemonics.
+
+```ts
+import {
+  generatePqm1Mnemonic,
+  pqm1MnemonicToAddress,
+  pqm1MnemonicToMlDsa65Backend,
+} from "@monolythium/core-sdk/crypto";
+
+const mnemonic = generatePqm1Mnemonic();
+const address = pqm1MnemonicToAddress(mnemonic);
+const backend = pqm1MnemonicToMlDsa65Backend(mnemonic);
+const signature = backend.sign(new Uint8Array([1, 2, 3]));
+```
+
+### ethers.js v6 compat
+
+The package also ships an ethers v6 compat shim — a `MonolythiumProvider`
+and `MonolythiumSigner` that drop in wherever ethers' `Provider` and
+`Signer` are expected. `ethers` is a peer dependency.
+
+```ts
+import { Wallet, ContractFactory } from "ethers";
+import {
+  MonolythiumProvider,
+  MonolythiumSigner,
+} from "@monolythium/core-sdk";
+
+const provider = new MonolythiumProvider("https://rpc.testnet.monolythium.com");
+const wallet = new Wallet(process.env.PRIVATE_KEY!);
+const signer = MonolythiumSigner.fromEthersWallet(wallet, provider);
+
+const factory = new ContractFactory(abi, bytecode, signer);
+const contract = await factory.deploy();
+await contract.waitForDeployment();
+```
+
+For non-secp256k1 signing sources (OS keychain, hardware wallet, future
+ML-DSA-65 backends), implement `MonolythiumSignerBackend` and pass it to
+`new MonolythiumSigner(backend, provider)`.
+
+## Development
+
+```bash
+pnpm install
+pnpm run typecheck
+pnpm run build
+pnpm test                  # unit tests against a stub fetch
+MONO_CORE_RPC_URL=... pnpm test   # plus live round-trip tests
+pnpm run pack:smoke        # verify the published tarball layout
+```
+
+When the Rust types change, regenerate the bindings:
+
+```bash
+cd ../..
+cargo test --features ts-bindings export_bindings
+bash packages/ts/scripts/sync-bindings.sh
+```
+
+## License
+
+Apache-2.0.