genlayer 0.18.2-beta.0 → 0.18.3

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.18.3 (2025-05-29)
+
+## 0.18.2 (2025-05-29)
+
 ## 0.18.2-beta.0 (2025-05-29)
 
 ## 0.18.0-beta.0 (2025-05-09)

package/CONTRIBUTING.md

@@ -0,0 +1,117 @@
+# Contributing to GenLayer CLI
+
+We're thrilled that you're interested in contributing to the GenLayer CLI! This document will guide you through the contribution process.
+
+## What is the GenLayer CLI?
+
+The GenLayer CLI is a command-line tool designed to:
+1. Streamline the setup and local execution of the GenLayer simulator. It automates the process of downloading and launching the GenLayer simulator, making it easy to start simulating and testing locally with minimal setup.
+2. Deploy Intelligent Contracts on any network, read their state and send transactions to them.
+3. Perform Validators operations
+
+## How You Can Contribute?
+
+Contributions to the GenLayer CLI are welcome in several forms:
+
+### Testing the CLI and Providing Feedback
+
+Help us make the CLI better by testing and giving feedback:
+
+- Start by installing the CLI globally using the command:
+  ```sh
+  $ npm install -g genlayer
+  ```
+- Try out the CLI features and tell us what you think through our [feedback form](https://forms.gle/ZbbxHsZrJxKucurB7) or on our [Discord Channel](https://discord.gg/8Jm4v89VAu).
+- If you find any issues, please report them on our [GitHub issues page](https://github.com/yeagerai/genlayer-cli/issues).
+
+### Sharing New Ideas and Use Cases
+
+Have ideas for new features or use cases? We're eager to hear them! But first:
+
+- Ensure you have the CLI installed to explore existing functionality.
+- After familiarizing yourself with the CLI, contribute your unique use case and share your ideas in our [Discord channel](https://discord.gg/8Jm4v89VAu).
+
+### Bug fixing and Feature development
+
+#### 1. Set yourself up to start coding
+
+- **1.1. Pick an issue**: Select one from the project GitHub repository [issue list](https://github.com/yeagerai/genlayer-cli/issues) and assign it to yourself.
+
+- **1.2. Create a branch**: create the branch that you will work on by using the link provided in the issue details page (right panel at the bottom - section "Development")
+
+- **1.3. Setup the CLI locally**: clone the repository and install dependencies
+
+   ```sh
+   $ git clone https://github.com/yeagerai/genlayer-cli.git
+   $ cd genlayer-cli
+   $ npm install
+   ```
+
+- **1.4. Run the CLI in dev mode**: to run the CLI in development mode with hot reload enabled:
+
+   ```sh
+   $ npm run dev
+   ```
+
+- **1.5. Test the CLI locally**: to test the CLI commands locally during development:
+
+   ```sh
+   $ node dist/index.js <command>
+   ```
+
+   For example:
+   ```sh
+   $ node dist/index.js init
+   $ node dist/index.js up
+   $ node dist/index.js validators get
+   ```
+
+- **1.6. Run unit tests**:
+The GenLayer CLI uses Jest in combination with ts-jest to handle testing of TypeScript files. The configuration is tailored to support ES Modules (ESM), aligning with the latest JavaScript standards and ensuring compatibility with modern tooling and Node.js features.
+
+##### Running Tests
+
+To run the tests, use the following command:
+
+```bash
+npm run test
+```
+
+This command sets the appropriate Node.js options to handle ES Modules and watches for changes in the test files, making it suitable for development.
+
+##### Test Configuration
+
+Our `jest.config.js` is set up as follows:
+
+- ES Module Support: Configured to treat .ts files as ES Modules.
+- Test Environment: Uses Node.js as the testing environment.
+- Transformation: Utilizes ts-jest with an ESM preset to process TypeScript files.
+
+Tests are located in the tests/ directory and should be named using the following pattern: [filename].test.ts. When writing tests, you can use all Jest functionalities such as describe, test, expect, and Jest mocks for testing asynchronous functions, component interactions, or API calls.
+
+#### 2. Submit your solution
+
+- **2.1. Prettier Formatter on Save File**: Configure IDE extensions to format your code with [Prettier](https://prettier.io/) before submitting it.
+- **2.2. Code solution**: implement the solution in the code.
+- **2.3. Run tests**: Ensure all tests pass before submitting:
+   ```sh
+   $ npm run test
+   ```
+- **2.4. Pull Request**: Submit your changes through a pull request (PR). Fill the entire PR template and set the PR title as a valid conventional commit.
+- **2.5. Check PR and issue linking**: if the issue and the PR are not linked, you can do it manually in the right panel of the Pull Request details page.  
+- **2.6. Peer Review**: One or more core contributors will review your PR. They may suggest changes or improvements.
+- **2.7. Approval and Merge**: After approval from the reviewers, you can merge your PR with a squash and merge type of action.
+
+
+### Improving Documentation
+
+To contribute to our docs, visit our [Documentation Repository](https://github.com/yeagerai/genlayer-docs) to create new issues or contribute to existing issues.
+
+## Community
+
+Connect with the GenLayer community to discuss, collaborate, and share insights:
+
+- **[Discord Channel](https://discord.gg/8Jm4v89VAu)**: Our primary hub for discussions, support, and announcements.
+- **[Telegram Group](https://t.me/genlayer)**: For more informal chats and quick updates.
+
+Your continuous feedback drives better product development. Please engage with us regularly to test, discuss, and improve the GenLayer CLI.

package/README.md

@@ -14,77 +14,275 @@ npm install -g genlayer
 
 ## Usage
 
-To initialize and start the GenLayer simulator, run the following command:
+Each command includes syntax, usage information, and examples to help you effectively use the CLI for interacting with the GenLayer environment.
+
+### Command line syntax
+
+General syntax for using the GenLayer CLI:
 
 ```bash
-genlayer init
+genlayer command [command options] [arguments...]
 ```
 
-This command will download the necessary components and start the simulator. Once initialized, you will be ready to execute further commands (to be implemented) to interact with the simulator.
+### Commands and usage
 
-## Contributing
+#### Initialize
 
-Contributions to the GenLayer CLI are welcome! Please feel free to fork the repository, make your changes, and submit a pull request. We appreciate your efforts to improve the software.
+Prepares and verifies your environment to run the GenLayer Studio.
 
-### Running the CLI from the repository
+```bash
+USAGE:
+   genlayer init [options]
+
+OPTIONS:
+   --numValidators <numValidators>       Number of validators (default: "5")
+   --headless                            Headless mode (default: false)
+   --reset-db                            Reset Database (default: false)
+   --localnet-version <localnetVersion>  Select a specific localnet version
+   --ollama                              Enable Ollama container (default: false)
+
+EXAMPLES:
+   genlayer init
+   genlayer init --numValidators 10 --headless --reset-db --localnet-version v0.10.2
+   genlayer init --ollama
+```
 
-First, install the dependencies and start the build process
+##### Version Compatibility
+
+The GenLayer CLI always uses the latest compatible version of the environment, ensuring that you benefit from the most recent features, bug fixes, and optimizations without requiring manual updates. If a specific version is needed, you can specify it using the --localnet-version option when initializing the environment.
 
 ```bash
-npm install
-npm run dev
+genlayer init --localnet-version v0.10.2
 ```
 
-This will continuously rebuild the CLI from the source
+#### Start GenLayer environment
 
-Then in another window execute the CLI commands like so:
+Launches the GenLayer environment and the Studio, initializing a fresh set of database and accounts.
 
 ```bash
-node dist/index.js init
+USAGE:
+   genlayer up [options]
+
+OPTIONS:
+   --reset-validators               Remove all current validators and create new random ones (default: false)
+   --numValidators <numValidators>  Number of validators (default: "5")
+   --headless                       Headless mode (default: false)
+   --reset-db                       Reset Database (default: false)
+   --ollama                         Enable Ollama container (default: false)
+
+EXAMPLES:
+   genlayer up
+   genlayer up --reset-validators --numValidators 8 --headless --reset-db
+   genlayer up --ollama
+```
+
+#### Stop GenLayer environment
+
+Stops all running GenLayer Localnet services.
+
+```bash
+USAGE:
+   genlayer stop
 ```
 
-## Testing
+#### Create a New GenLayer Project
+
+Initialize a new GenLayer project using a local template.
 
-### Overview
+```bash
+USAGE:
+   genlayer new <projectName> [options]
 
-The GenLayer CLI uses Jest in combination with ts-jest to handle testing of TypeScript files. The configuration is tailored to support ES Modules (ESM), aligning with the latest JavaScript standards and ensuring compatibility with modern tooling and Node.js features.
+OPTIONS:
+   --path <directory>  Specify the directory for the new project (default: ".")
+   --overwrite         Overwrite existing directory if it exists (default: false)
+
+EXAMPLES:
+   genlayer new myProject
+   genlayer new myProject --path ./customDir
+   genlayer new myProject --overwrite
+```
 
-### Running Tests
+#### Manage CLI Configuration
 
-To run the tests, use the following command:
+Configure the GenLayer CLI settings.
 
 ```bash
-npm run test
+USAGE:
+   genlayer config <command> [options]
+
+COMMANDS:
+   set <key=value>  Set a configuration value
+   get [key]        Get the current configuration
+   reset <key>      Reset a configuration value to its default
+
+EXAMPLES:
+   genlayer config get
+   genlayer config get defaultOllamaModel
+   genlayer config set defaultOllamaModel=deepseek-r1
+   genlayer config reset keyPairPath
 ```
 
-This command sets the appropriate Node.js options to handle ES Modules and watches for changes in the test files, making it suitable for development.
+#### Network Management
 
-### Test Configuration
+Set the network to use for contract operations.
 
-Our `jest.config.js` is set up as follows:
+```bash
+USAGE:
+   genlayer network [network]
 
-- ES Module Support: Configured to treat .ts files as ES Modules.
-- Test Environment: Uses Node.js as the testing environment.
-- Transformation: Utilizes ts-jest with an ESM preset to process TypeScript files.
+EXAMPLES:
+   genlayer network
+   genlayer network testnet
+   genlayer network mainnet
+```
 
-Tests are located in the tests/ directory and should be named using the following pattern: [filename].test.ts. When writing tests, you can use all Jest functionalities such as describe, test, expect, and Jest mocks for testing asynchronous functions, component interactions, or API calls.
+#### Deploy and Call Intelligent Contracts
 
-## License
+Deploy and interact with intelligent contracts.
 
-This project is licensed under the ... License - see the [LICENSE](LICENSE) file for details.
+```bash
+USAGE:
+   genlayer deploy [options]
+   genlayer call <contractAddress> <method> [options]
+   genlayer write <contractAddress> <method> [options]
+
+OPTIONS (deploy):
+   --contract <contractPath>  (Optional) Path to the intelligent contract to deploy
+   --rpc <rpcUrl>             RPC URL for the network
+   --args <args...>           Positional arguments for the contract (space-separated, use quotes for multi-word arguments)
+
+OPTIONS (call):
+   --rpc <rpcUrl>             RPC URL for the network
+   --args <args...>           Positional arguments for the method (space-separated, use quotes for multi-word arguments)
+
+OPTIONS (write):
+   --rpc <rpcUrl>             RPC URL for the network
+   --args <args...>           Positional arguments for the method (space-separated, use quotes for multi-word arguments)
+
+EXAMPLES:
+   genlayer deploy
+   genlayer deploy --contract ./my_contract.gpy
+   genlayer deploy --contract ./my_contract.gpy --args "arg1" "arg2" 123
+   genlayer call 0x123456789abcdef greet --args "Hello World!"
+   genlayer write 0x123456789abcdef updateValue --args 42
+```
+
+##### Deploy Behavior
+- If `--contract` is specified, the command will **deploy the given contract**.
+- If `--contract` is omitted, the CLI will **search for scripts inside the `deploy` folder**, sort them, and execute them sequentially.
+
+##### Call vs Write
+- `call` - Calls a contract method without sending a transaction or changing the state (read-only)
+- `write` - Sends a transaction to a contract method that modifies the state
+
+#### Keypair Management
+
+Generate and manage keypairs.
+
+```bash
+USAGE:
+   genlayer keygen create [options]
 
-## Credits
+OPTIONS:
+   --output <path>    Path to save the keypair (default: "./keypair.json")
+   --overwrite        Overwrite the existing file if it already exists (default: false)
 
-- TBD
+EXAMPLES:
+   genlayer keygen create
+   genlayer keygen create --output ./my_key.json --overwrite
+```
+
+#### Update Resources
+
+Manage and update models or configurations.
+
+```bash
+USAGE:
+   genlayer update ollama [options]
+
+OPTIONS:
+   --model [model-name]  Specify the model to update or pull
+   --remove              Remove the specified model instead of updating
+
+EXAMPLES:
+   genlayer update ollama
+   genlayer update ollama --model deepseek-r1
+   genlayer update ollama --model deepseek-r1 --remove
+```
+
+#### Validator Management
+
+Manage validator operations.
+
+```bash
+USAGE:
+   genlayer validators <command> [options]
+
+COMMANDS:
+   get [--address <validatorAddress>]     Retrieve details of a specific validator or all validators
+   delete [--address <validatorAddress>]  Delete a specific validator or all validators
+   count                                  Count all validators
+   update <validatorAddress> [options]    Update a validator details
+   create-random [options]                Create random validators
+   create [options]                       Create a new validator
+
+OPTIONS (update):
+   --stake <stake>                        New stake for the validator
+   --provider <provider>                  New provider for the validator
+   --model <model>                        New model for the validator
+   --config <config>                      New JSON config for the validator
+
+OPTIONS (create-random):
+   --count <count>                        Number of validators to create (default: "1")
+   --providers <providers...>             Space-separated list of provider names (e.g., openai ollama)
+   --models <models...>                   Space-separated list of model names (e.g., gpt-4 gpt-4o)
+
+OPTIONS (create):
+   --stake <stake>                        Stake amount for the validator (default: "1")
+   --config <config>                      Optional JSON configuration for the validator
+   --provider <provider>                  Specify the provider for the validator
+   --model <model>                        Specify the model for the validator
+
+EXAMPLES:
+   genlayer validators get
+   genlayer validators get --address 0x123456789abcdef
+
+   genlayer validators count
+   genlayer validators delete --address 0x123456789abcdef
+   genlayer validators update 0x123456789abcdef --stake 100 --provider openai --model gpt-4
+
+   genlayer validators create
+   genlayer validators create --stake 50 --provider openai --model gpt-4
+   genlayer validators create-random --count 3 --providers openai --models gpt-4 gpt-4o
+```
+
+### Running the CLI from the repository
+
+First, install the dependencies and start the build process
 
-## Contact
+```bash
+npm install
+npm run dev
+```
 
-- TBD
+This will continuously rebuild the CLI from the source
 
-## Further Development
+Then in another window execute the CLI commands like so:
 
-Further commands are planned for implementation to enhance interaction with the GenLayer simulator. Stay tuned for updates.
+```bash
+node dist/index.js init
+```
 
-## Feedback
+## Documentation
+
+For detailed information on how to use GenLayer CLI, please refer to our [documentation](https://docs.genlayer.com/).
+
+## Contributing
+
+We welcome contributions to GenLayerJS SDK! Whether it's new features, improved infrastructure, or better documentation, your input is valuable. Please read our [CONTRIBUTING](https://github.com/yeagerai/genlayer-js/blob/main/CONTRIBUTING.md) guide for guidelines on how to submit your contributions.
+
+## License
+
+This project is licensed under the ... License - see the [LICENSE](LICENSE) file for details.
 
-If you have any feedback, please reach out to us at the contact provided above.

package/dist/index.js

@@ -17723,7 +17723,7 @@ var require_semver2 = __commonJS({
 import { program } from "commander";
 
 // package.json
-var version = "0.18.2-beta.0";
+var version = "0.18.3";
 var package_default = {
   name: "genlayer",
   version,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "genlayer",
-  "version": "0.18.2-beta.0",
+  "version": "0.18.3",
   "description": "GenLayer Command Line Tool",
   "main": "src/index.ts",
   "type": "module",