ryt-sdk 1.0.1 → 1.0.3

package/README.md

@@ -1,8 +1,14 @@
-# 🚀 RYT SDK
 
-RYT blockchain SDK for provider, wallet, and smart contract interactions.
 
-## ⚙️ Install
+[RYT](https://ryt.io/) is a modern blockchain infrastructure platform designed to make decentralized development faster, simpler, and more accessible. It provides developers with a powerful yet streamlined ecosystem for building, deploying, and interacting with smart contracts, wallets, and scalable applications. By combining intuitive tooling with advanced features like deterministic deployments, proxy patterns, and modular contract architecture, RYT.io removes much of the complexity traditionally associated with Web3 development. Whether you're launching tokens, building dApps, or optimizing on-chain performance, RYT.io empowers you to focus on innovation while handling the heavy lifting behind the scenes.
+
+This is our RYT blockchain sdk for provider, wallet, and smart contract interactions. 
+
+- ⚡ This is only a quick start guide.
+- 📚 For detail developer documentation and guide that how to interact with ryt chain visit 👉 [Homepage](https://ryt-docs.vercel.app/)
+
+
+### ⚙️ Install
 
 ```bash
   npm install ryt-sdk
@@ -13,7 +19,7 @@ or
   yarn add ryt-sdk
 ```
 
-## 🔐 Environment Setup
+### 🔐 Environment Setup
 
 Create a .env file:
 
@@ -28,7 +34,7 @@ SALT=random_salt
 MATH_LIB_ADDRESS=0xLibraryAddress
 ```
 
-## ⚡ 30-Second Quickstart
+### ⚡ 30-Second Quickstart
 
 ```bash
 import RYTProvider from "ryt-sdk/provider";
@@ -49,7 +55,7 @@ await tx.wait();
 ```
 
 
-## 📌 Overview
+### 📌 Overview
 
 RYT SDK is a modular blockchain development toolkit designed to simplify:
 
@@ -61,246 +67,18 @@ RYT SDK is a modular blockchain development toolkit designed to simplify:
 - Cloning (EIP-1167)
 - Library-linked contracts
 
-## 🧠 Architecture
-
-```bash
-  Your App
-     │
-     ▼
-  RYT SDK Core
-     ├── Provider
-     ├── Wallet
-     ├── Contract
-     ├── Deployment Engine
-     │
-     ▼
-  RYT/ Ethereum / EVM Chain
-```
-
-## 🧩 Core Modules
-
-#### Provider
-
-```bash
-import RYTProvider from "ryt-sdk/provider";
-
-const provider = new RYTProvider({
-  chainId: 1234,
-  rpcUrls: ["https://rpc-url"]
-});
-```
-
-#### Wallet
-
-```bash
-import RYTWallet from "ryt-sdk/wallet";
-
-const wallet = new RYTWallet(PRIVATE_KEY, provider);
-
-console.log(wallet.getAddress());
-```
-
-#### Contract
-
-```bash
-import RYTContract from "ryt-sdk/contract";
-
-const contract = new RYTContract(address, abi, wallet);
-```
-
-### 📖 Read Contract Data
-
-```bash
-const name = await contract.read("name");
-const symbol = await contract.read("symbol");
-const decimals = await contract.read("decimals");
-```
-
-### ✍️ Write Transactions
-
-```bash
-const tx = await contract.write("transfer", to, 100n);
-await tx.wait();
-```
-
-
-### 🪙 ERC20 Example
-
-```bash
-const token = new RYTContract(address, ERC20.abi, wallet);
-
-await token.write("transfer", recipient, 100n);
-await token.write("approve", spender, 100n);
-```
-
-
-### 🎨 ERC721 Mint
-
-```bash
-const nft = new RYTContract(address, ERC721.abi, wallet);
-
-await nft.write("safeMint", wallet.getAddress(), TOKEN_URI);
-```
-
-
-### 🧩 ERC1155 Mint
-
-```bash
-const multi = new RYTContract(address, ERC1155.abi, wallet);
-
-await multi.write("mint", wallet.getAddress(), 1, 20);
-```
-
 
-### 🏗️ Deploy Contracts
+### 🧪 Testing
 
-```bash
-const contract = await deployer.deploy({
-  abi: ERC20.abi,
-  bytecode: ERC20.bytecode,
-  args: ["My Token", "MTK", 18, 1000000]
-});
-```
-
-### 🏭 Factory Deployments
-
-#### Master Factory
-
-```bash
-const factory = await deployer.deploy({
-    abi: MasterFactory.abi,
-    bytecode: MasterFactory.bytecode,
-    args: [100]
-});
-```
-
-#### Create
-
-```bash
-const tx = await factory.write("deploySimple", 777);
-await tx.wait();
-```
-
-#### Create2
-
-```bash
-const tx = await factory.write("deployCreate2", 999, salt);
-await tx.wait();
-```
-
-#### Cloning (EIP-1167) 
-
-```bash
-const tx = await factory.write("deployClone", childAddr);
-await tx.wait();
-```
-
-### 🧬 Cloning (EIP-1167) without factory
-
-```bash
-const clone = await deployer.deployClone(address);
-```
-
-### 🔁 UUPS Proxy
-
-```bash
-const proxy = await deployer.deployUUPS({
-  implementationAbi,
-  implementationBytecode,
-  initData
-});
-
-await proxy.write("setValue", 100);
-```
-
-### CREATE2
-
-```bash
-const result = await deployer.deployCreate2({
-  factoryAddress: CREATE2_FACTORY,
-  abi: ERC20.abi,
-  bytecode: ERC20.bytecode,
-  salt,
-  args: ["My Token", "MTK", 18, 1000000]
-});
-```
-
-### 📦 Library Linking
-
-```bash
-const lib = await deployer.deployWithLibraries({
-    abi: Calculator.abi,
-    bytecode: Calculator.bytecode,
-    linkReferences: {
-        "contracts/ryt/MathLib.sol": {
-            MathLib: [{ length: 20, start: 283 }]
-        }
-    },
-    libraries: {
-        MathLib: MATH_LIB_ADDRESS
-    }
-});
-```
-
-## 🚨 Error Handling
-
-```bash
-try {
-  await contract.write("transfer", to, amount);
-} catch (err) {
-  console.error(err);
-}
-```
-
-## 📊 Feature Support
-
-| Category              | Feature                | Status | Description |
-|----------------------|------------------------|--------|-------------|
-| Core                 | Provider               | ✅     | RPC connection & chain interaction layer |
-| Core                 | Wallet                 | ✅     | Private key management & signing |
-| Core                 | Contract Read/Write    | ✅     | Unified smart contract interaction API |
-| Tokens               | ERC20                  | ✅     | Fungible token standard support |
-| Tokens               | ERC721                 | ✅     | NFT (non-fungible token) support |
-| Tokens               | ERC1155                | ✅     | Multi-token standard support |
-| Deployment           | CREATE                 | ✅     | Standard contract deployment |
-| Deployment           | CREATE2                | ✅     | Deterministic contract deployment |
-| Proxy Systems        | UUPS Proxy             | ✅     | Upgradeable contract architecture |
-| Proxy Systems        | Cloning (EIP-1167)     | ✅     | Minimal proxy factory cloning |
-| Advanced             | Library Linking        | ✅     | Solidity library linking support |
-| Advanced             | Internal Transactions  | ✅     | Internal execution tracing support |
-| Advanced             | Payable Functions      | ✅     | ETH value transfer support |
-
-
-## 🧪 Full Test Suite
-
-To run tests, run the following command
+To run tests, run the following commands:
 
 ```bash
   npm test 
   npm run contractsTest
 ```
 
-Includes:
-
-- ERC20 / ERC721 / ERC1155
-- CREATE / CREATE2 deployments
-- Proxy patterns (UUPS)
-- Cloning (EIP-1167)
-- Payable functions
-- Library linking
-- Internal transaction validation
-
-
-## 🌟 Why RYT SDK?
-  
-- 🧩 Modular blockchain architecture
-- 🏗️ Supports advanced EVM patterns
-- 🧠 Designed for real-world production systems
-- 🔌 Works with any EVM chain
-
-## 📜 License
+### 📜 License
 
-[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)© 2026 RYT Core Team
+[MIT](https://choosealicense.com/licenses/mit/)© 2026 RYT Core Team
  
 
-![Logo](https://kresus.mypinata.cloud/ipfs/bafkreiexrumjdyahbtlxomgy5fnuue4vhlfnytzxvkonvianmsrzmug6wy)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ryt-sdk",
   "type": "module",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "RYT blockchain SDK for provider, wallet, and smart contract interactions",
   "author": "Muhammad Hammad Mubeen",
   "license": "MIT",
@@ -57,5 +57,13 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Hammad-Mubeen/ryt-sdk.git"
+  },
+  "homepage": "https://ryt-docs.vercel.app",
+  "bugs": {
+    "url": "https://github.com/Hammad-Mubeen/ryt-sdk/issues"
   }
 }