ryt-sdk 1.0.0 โ†’ 1.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 (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +73 -3
  3. package/package.json +9 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 RYT Core Team
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,8 +1,78 @@
1
- # ryt-sdk
1
+ #### ๐Ÿš€ RYT SDK
2
2
 
3
3
  RYT blockchain SDK for provider, wallet, and smart contract interactions.
4
4
 
5
- ## Install
5
+ #### โš™๏ธ Install
6
6
 
7
7
  ```bash
8
- npm install ryt-sdk
8
+ npm install ryt-sdk
9
+ ```
10
+ or
11
+
12
+ ```bash
13
+ yarn add ryt-sdk
14
+ ```
15
+
16
+ #### ๐Ÿ” Environment Setup
17
+
18
+ Create a .env file:
19
+
20
+ ```bash
21
+ PRIVATE_KEY=your_private_key
22
+ RPC_URL=https://your-rpc-url
23
+ CHAIN_ID=1234
24
+
25
+ TOKEN_URI=https://metadata.example.com
26
+ CREATE2_FACTORY=0xFactoryAddress
27
+ SALT=random_salt
28
+ MATH_LIB_ADDRESS=0xLibraryAddress
29
+ ```
30
+
31
+ #### โšก 30-Second Quickstart
32
+
33
+ ```bash
34
+ import RYTProvider from "ryt-sdk/provider";
35
+ import RYTWallet from "ryt-sdk/wallet";
36
+ import RYTContract from "ryt-sdk/contract";
37
+
38
+ const provider = new RYTProvider({
39
+ chainId: process.env.CHAIN_ID,
40
+ rpcUrls: [process.env.RPC_URL]
41
+ });
42
+
43
+ const wallet = new RYTWallet(process.env.PRIVATE_KEY, provider);
44
+
45
+ const contract = new RYTContract(address, abi, wallet);
46
+
47
+ const tx = await contract.write("transfer", to, 100n);
48
+ await tx.wait();
49
+ ```
50
+
51
+
52
+ #### ๐Ÿ“Œ Overview
53
+
54
+ RYT SDK is a modular blockchain development toolkit designed to simplify:
55
+
56
+ - Smart contract interaction
57
+ - Wallet management
58
+ - Contract deployment (CREATE / CREATE2)
59
+ - ERC20 / ERC721 / ERC1155 support
60
+ - Proxy patterns (UUPS)
61
+ - Cloning (EIP-1167)
62
+ - Library-linked contracts
63
+
64
+
65
+ #### ๐Ÿงช Testing
66
+
67
+ To run tests, run the following commands:
68
+
69
+ ```bash
70
+ npm test
71
+ npm run contractsTest
72
+ ```
73
+
74
+ #### ๐Ÿ“œ License
75
+
76
+ [MIT](https://choosealicense.com/licenses/mit/)ยฉ 2026 RYT Core Team
77
+
78
+
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "ryt-sdk",
3
3
  "type": "module",
4
- "version": "1.0.0",
4
+ "version": "1.0.2",
5
5
  "description": "RYT blockchain SDK for provider, wallet, and smart contract interactions",
6
6
  "author": "Muhammad Hammad Mubeen",
7
7
  "license": "MIT",
@@ -57,5 +57,13 @@
57
57
  },
58
58
  "publishConfig": {
59
59
  "access": "public"
60
+ },
61
+ "repository": {
62
+ "type": "git",
63
+ "url": "https://github.com/Hammad-Mubeen/ryt-sdk.git"
64
+ },
65
+ "homepage": "https://ryt-docs.vercel.app",
66
+ "bugs": {
67
+ "url": "https://github.com/Hammad-Mubeen/ryt-sdk/issues"
60
68
  }
61
69
  }