@carbonx3/cx3.js 0.1.0 → 0.1.1

package/README.md

@@ -1,27 +1,22 @@
-# @carbonx3/cx3.js — CarbonX3 Green Chain SDK
+# @carbonx3/cx3.js
 
-Official JavaScript client (**CX3js**) for **CarbonX3 Green Chain**.
+Official **Node.js** client (**CX3js**) for [CarbonX3 Green Chain](https://carbonx3.com/).
 
 Talks to the node over **REST + JSON** (`/api/v1/...`) with named method params.
 
-| `@carbonx3/cx3.js` | Role | Green Chain API |
-|----------|------|-----------------|
-| `Cx3Provider` | HTTP client | `CX3_NODE_URL` + `/api/v1` |
-| `Cx3Wallet` | secp256k1 signing | Deploy / send digests |
-| `Contract` / `provider.getContract` | ABI-bound calls | `/contract/call` + `/contract/send` |
-| `Cx3TokenFactory` | Standard deploys | `POST /deployContract` (CX30–CX3192, CX337–CX341) |
+The **browser** client is the **CX3 IIFE**: `<script src="cx3.min.js"></script>` (`window.cx3`). Do not `require` this package in a page.
+
+| Export | Role |
+|--------|------|
+| `Cx3Provider` | HTTP client (`{node}/api/v1`) |
+| `Cx3Wallet` | secp256k1 signing (deploy / send / native CX3) |
+| `Contract` / `provider.getContract` | ABI-bound calls |
+| `Cx3TokenFactory` | Standard deploys (CX30–CX3192, CX337–CX341) |
 
 ## Install
 
 ```bash
-# when published
 npm install @carbonx3/cx3.js
-
-# from monorepo root
-npm install ./CX3Web3JS
-
-# or inside another package
-npm install file:../CX3Web3JS
 ```
 
 Node.js **18+** (native `fetch`).
@@ -29,39 +24,17 @@ Node.js **18+** (native `fetch`).
 ## Quick start
 
 ```javascript
-const {
-  Cx3Provider,
-  Cx3Wallet,
-  Cx3TokenFactory,
-  readCallValue
-} = require("@carbonx3/cx3.js");
-
-const provider = new Cx3Provider(process.env.CX3_NODE_URL, {
-  auth: {
-    user: process.env.CX3_INTERNAL_AUTH_USER,
-    pass: process.env.CX3_INTERNAL_AUTH_PASS
-  }
-  // or: apiKey: process.env.CX3_API_KEY   // empty = public (any wallet); cx3wk_ = that wallet only
-});
+const { Cx3Provider, Cx3Wallet, Cx3TokenFactory } = require("@carbonx3/cx3.js");
 
+const provider = new Cx3Provider("https://your-green-chain-node");
 const wallet = new Cx3Wallet(process.env.CX3_PRIVATE_KEY, provider);
-await wallet.bindApiKey();
 
-// Read
 const token = await provider.getContract(process.env.CONTRACT_ADDRESS, null, wallet);
 const balance = await token.balanceOf(wallet.address);
-console.log("balance", balance);
 
-const cx3Balance = await provider.getBalance(wallet.address);
-
-// Write
 const tx = await token.transfer("0xRecipient…", "1000000000000000000");
 await tx.wait();
 
-await wallet.pauseContract(process.env.CONTRACT_ADDRESS);
-await wallet.transferNative("0xRecipient…", 1);
-
-// Deploy CX30
 const factory = new Cx3TokenFactory(wallet);
 const deployed = await factory.deployCX30({
   name: "My Token",
@@ -72,67 +45,56 @@ const deployed = await factory.deployCX30({
 console.log(deployed.contractAddress);
 ```
 
-## Signing (important)
+## Connect
 
-Digests are **UTF-8 strings**, then `sha256` + **secp256k1** (same as CX3Wallet):
+**1. Green Chain node (usual case)** — pass the node URL only. No username, password, or API key.
+
+```javascript
+const provider = new Cx3Provider("https://your-green-chain-node");
+```
+
+**2. Your own node** — add HTTP Basic **only if that node requires it**. If it does not, skip this and keep option 1.
+
+```javascript
+const provider = new Cx3Provider("https://your-node", {
+  auth: {
+    user: process.env.CX3_INTERNAL_AUTH_USER,
+    pass: process.env.CX3_INTERNAL_AUTH_PASS
+  }
+});
+```
+
+### Optional wallet API key
+
+Leave unset for **public** access (any wallet). Set a `cx3wk_…` key only to lock this client to that wallet. Never put an API key in browser JavaScript.
+
+## Signing
+
+Digests are **UTF-8 strings**, then `sha256` + **secp256k1**:
 
 - Deploy: `deploy|{owner}|{standard}|{name}|{symbol}|{decimals}|{initialSupply}|{timestamp}`
 - Send: `{contractAddress}|{method}|{JSON.stringify(params)}|{fromAddress}`
 - Owner: `{action}|{address}|{owner}|{timestamp}`
-- Native CX3: canonical JSON payload (`buildTransferPayload`) then `wallet.transferNative(to, amount)`
+- Native CX3: `wallet.transferNative(to, amount)`
 
 Address = `0x` + last 20 bytes of `sha256(uncompressedPublicKey)`.
 
 ## ABI-bound methods
 
-Supports:
-
 1. Standard interface JSON (`methods.balanceOf.type = "view"`)
 2. Compiler flat ABI (`[{ type: "function", name, inputs, stateMutability }]`)
 
-Positional args map to ABI input names:
-
 ```javascript
-await token.balanceOf(owner);           // → { address: owner } or { account: owner }
-await token.transfer(to, amount);       // → { to, amount }
+await token.balanceOf(owner);
+await token.transfer(to, amount);
 await token.call("balanceOf", { account: owner });
 ```
 
-## Environment
-
-```bash
-CX3_NODE_URL=https://your-node
-CX3_INTERNAL_AUTH_USER=cx3-internal
-CX3_INTERNAL_AUTH_PASS=…
-CX3_API_KEY=cx3wk_…          # optional; empty = public (any wallet); set = that wallet only (X-Api-Key)
-CX3_PRIVATE_KEY=…   # 64-hex or 0x-prefixed
-CX3_CHAIN_ID=cx3-dev         # native transfer payload (default)
-```
-
-## Package layout
+## Docs
 
-```
-CX3Web3JS/
-  index.js          # public API
-  index.d.ts
-  src/
-    provider.js
-    wallet.js
-    contract.js
-    factory.js
-    crypto.js
-    digest.js
-    …
-  test/
-```
+- [CX3js SDK](https://cx3script.com/docs?doc=cx3js-sdk)
+- [CarbonX3 Green Chain](https://carbonx3.com/)
 
 ## License
 
 UNLICENSED — Mersolution Technology Ltd.
-
-## Docs
-
-CX3Script documentation site (sidebar **cx3.js SDK**):
-
-- Monorepo: `CX3VM-WebSites/cx3docs/docs/cx3js-sdk.md`
-- Local: `/CX3VM-WebSites/docs?doc=cx3js-sdk`

package/index.js

@@ -26,7 +26,7 @@ const {
 } = require("./src/crypto");
 const { normalizeAbi, argsToParams } = require("./src/abi");
 
-const VERSION = "0.1.0";
+const VERSION = "0.1.1";
 
 /**
  * Convenience: provider from env `CX3_NODE_URL` (+ optional Basic auth env).

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@carbonx3/cx3.js",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "CarbonX3 Green Chain JavaScript SDK (CX3js) - Provider / Wallet / Contract over REST + JSON",
+  "homepage": "https://cx3script.com/docs?doc=cx3js-sdk",
   "publishConfig": {
     "access": "public"
   },