Overview

Rayls offers various interaction methods, each tailored to different user needs for managing tokens, wallets, and transactions in a private, secure environment. This page provides an overview of each method, highlighting prerequisites for setting up and using the Rayls environment effectively.

Pre-requisites

There are system components required to set up and interact with the Rayls Private Subnet environment:

Access to Parfin Nexus Registry: Authentication for registry.parfin.io. For more information about accessing the registry reach out to us.
System Compatibility: Linux/WSL for Windows users.

Tools:

Git for version control.
Make for task automation.
Docker and Docker Compose for containerized services.
Clustered MongoDB with ReplicaSet enabled for data handling.

Interaction Methods

Rayls SDK

The SDK enables integration with Rayls services through JavaScript or Python, ideal for full flexibility in embedding Rayls functionalities (e.g., token and transaction management) into applications.

Prerequisites:

Access to the SDK from the Parfin Nexus registry.
An API key for secure connection.
Development environment with appropriate dependencies for JavaScript or Python.

Rayls Custody APIs

The Rayls Custody APIs provide RESTful access for managing tokens, transactions, and wallets within the Rayls Privacy Ledger.

Prerequisites:

Access to API documentation and API credentials (API key, user authentication).
Internet connection to securely interact with Rayls Custody API endpoints.

Rayls CLI

The Rayls CLI is integrated with Hardhat, specifically designed to streamline deploying, executing, managing, and testing smart contracts within the Rayls Private Subnet. It provides developers with a powerful toolkit for complete contract lifecycle operations, enabling efficient interactions with the privacy ledger and private subnet capabilities.

Prerequisites:

Node.js and npm: Required for installing Hardhat and the Rayls CLI dependencies.
Hardhat: Installed through npm, serving as the core development framework.
Make: Utilized for automation tasks, simplifying setup and configuration commands within the CLI.
Access to the Rayls CLI: Available from the Parfin registry, with necessary authentication credentials for secure access.

Each method provides comprehensive access to Rayls resources, allowing flexibility for various operational needs within the Rayls ecosystem. Ensure the general and specific prerequisites are met to ensure a smooth setup and interaction experience.