update scripts to use config.json + update yarn version

Author: SalmaElsoly

.yarn/install-state.gz

@@ -0,0 +1 @@
+nodeLinker: node-modules

.yarnrc.yml

@@ -10,6 +10,7 @@ This repo contains the typescript clients and projects for Threefold gridV4.
 
 - [Node.js](https://nodejs.org/) (version 20 or higher)
 - [lerna](https://lerna.js.org/) (version 8.1.9 or higher)
+- [yarn](https://yarnpkg.com/)    (version 4.7.0)
 
 ## Install
 

README.MD

@@ -1,5 +1,5 @@
 {
-  "name": "root",
+  "name": "@threefold/root",
   "private": true,
   "workspaces": [
     "packages/*"
@@ -21,5 +21,6 @@
     "prettier": "^3.5.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.7.3"
-  }
+  },
+  "packageManager": "yarn@4.7.0"
 }

package.json

@@ -5,7 +5,6 @@ This package provides a client for interacting with the TFGrid v4 Node Registrar
 ## Prerequisites
 
 - node 20.10.0 or higher
-- npm 10.2.3 or higher
 
 ## Installation
 
@@ -36,7 +35,21 @@ This package provides a client for interacting with the TFGrid v4 Node Registrar
 
 ## Getting Started
 
-To initialize the Registrar Client, you need to provide the base url of registrar and your private key. Here is an example:
+To initialize the Registrar Client, you need to provide the base url of registrar and Base64-encoded, 64-byte raw Ed25519 private key (nacl format).
+
+To generate a 64-byte ed25519 private key, you can use tweetnacl library to generate key:
+
+```typescript
+import nacl from "tweetnacl";
+import base64 from "base64-js";
+
+const keyPair = nacl.sign.keyPair();
+const privateKey = base64.fromByteArray(keyPair.secretKey);
+
+console.log("Your 64-byte ed25519 private key:", privateKey);
+```
+
+Here is an example:
 
 ```typescript
 const client = new RegistrarClient({ baseURl: "https://registrar.dev4.grid.tf/v1", privateKey: your_private_key });

packages/registrar_client/README.md

@@ -1,5 +1,5 @@
 {
-  "name": "registrar_client",
+  "name": "@threefold/registrar_client",
   "version": "0.1.0",
   "description": "Registrar client for the ThreeFold Grid V4",
   "keywords": [],
@@ -35,6 +35,7 @@
     "@types/node": "^22.13.4",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
     "typescript": "^5.7.3"
   },
   "dependencies": {

packages/registrar_client/package.json

@@ -0,0 +1,27 @@
+# Registrar Client Scripts
+
+This directory contains scripts for the Registrar Client package.
+
+## Prerequisites
+
+- Node.js 20 or higher
+
+## Installation
+
+To install the necessary dependencies, run:
+
+```bash
+yarn install
+```
+
+## Getting Started
+
+- Set your base url and private key in `scripts/config.json`
+
+## Usage
+
+To run any of the scripts, use the following command format:
+
+```bash
+yarn ts-node <script_name>.ts
+```

packages/registrar_client/scripts/README.md

@@ -0,0 +1 @@
+{"baseUrl": "http://localhost:8080/v1", "privateKey": ""}

packages/registrar_client/scripts/config.json

@@ -1,7 +1,6 @@
 import { log } from "console";
 import { RegistrarClient } from "../src/";
-import tweetnacl from "tweetnacl";
-import base64 from "base64-js";
+import config from "./config.json";
 
 async function createAccount(client: RegistrarClient) {
   const account = await client.accounts.createAccount({});
@@ -11,9 +10,7 @@ async function createAccount(client: RegistrarClient) {
 }
 
 async function main() {
-  const keyPair = tweetnacl.sign.keyPair();
-  const privateKey = base64.fromByteArray(keyPair.secretKey);
-  const client = new RegistrarClient({ baseURL: "https://registrar.grid.tf/v1/", privateKey: privateKey });
+  const client = new RegistrarClient({ baseURL: config.baseUrl, privateKey: config.privateKey });
   await createAccount(client);
 }
 

packages/registrar_client/scripts/create_account.ts

@@ -1,7 +1,6 @@
 import { log } from "console";
 import { Account, RegistrarClient } from "../src/";
-import tweetnacl from "tweetnacl";
-import base64 from "base64-js";
+import config from "./config.json";
 
 async function createAccount(client: RegistrarClient): Promise<Account> {
   const account = await client.accounts.createAccount({});
@@ -27,9 +26,7 @@ async function getFarm(client: RegistrarClient, farmID: number) {
 }
 
 async function main() {
-  const keyPair = tweetnacl.sign.keyPair();
-  const privateKey = base64.fromByteArray(keyPair.secretKey);
-  const client = new RegistrarClient({ baseURL: "https://registrar.grid.tf/v1/", privateKey: privateKey });
+  const client = new RegistrarClient({ baseURL: config.baseUrl, privateKey: config.privateKey });
   const account = await createAccount(client);
   const twinID = account.twin_id;
   const farmID = await createFarm(client, twinID);

packages/registrar_client/scripts/create_farm.ts

@@ -1,7 +1,7 @@
 import { log } from "console";
 import { Account, RegistrarClient, NodeRegistrationRequest } from "../src/";
-import tweetnacl from "tweetnacl";
-import base64 from "base64-js";
+import config from "./config.json";
+
 
 async function createAccount(client: RegistrarClient): Promise<Account> {
   const account = await client.accounts.createAccount({});
@@ -35,10 +35,7 @@ async function getNode(client: RegistrarClient, nodeID: number) {
 }
 
 async function main() {
-  const keyPair = tweetnacl.sign.keyPair();
-  const privateKey = base64.fromByteArray(keyPair.secretKey);
-  log(privateKey);
-  const client = new RegistrarClient({ baseURL: "https://registrar.grid.tf/v1/", privateKey: privateKey });
+  const client = new RegistrarClient({ baseURL: config.baseUrl, privateKey: config.privateKey });
   const account = await createAccount(client);
   const twinID = account.twin_id;
   const farmID = await createFarm(client, twinID);

packages/registrar_client/scripts/create_node.ts

@@ -1,4 +1,5 @@
 import { RegistrarClient, NodesFilter } from "../src/";
+import config from "./config.json";
 
 async function listFarms(client: RegistrarClient, filter: NodesFilter) {
   const nodes = await client.nodes.listNodes(filter);
@@ -8,8 +9,7 @@ async function listFarms(client: RegistrarClient, filter: NodesFilter) {
 }
 
 async function main() {
-  const privateKey = "private_key";
-  const client = new RegistrarClient({ baseURL: "https://registrar.grid.tf/v1/", privateKey: privateKey });
+  const client = new RegistrarClient({ baseURL: config.baseUrl, privateKey: config.privateKey });
   await listFarms(client, {});
 }
 

packages/registrar_client/scripts/list_farms.ts

@@ -1,4 +1,5 @@
 import { RegistrarClient, NodesFilter } from "../src/";
+import config from "./config.json";
 
 async function listNodes(client: RegistrarClient, filter: NodesFilter) {
   const nodes = await client.nodes.listNodes(filter);
@@ -8,8 +9,7 @@ async function listNodes(client: RegistrarClient, filter: NodesFilter) {
 }
 
 async function main() {
-  const privateKey = "private_key";
-  const client = new RegistrarClient({ baseURL: "https://registrar.grid.tf/v1/", privateKey: privateKey });
+  const client = new RegistrarClient({ baseURL: config.baseUrl, privateKey: config.privateKey });
   const filter: NodesFilter = {
     farm_id: 70,
   };

packages/registrar_client/scripts/list_nodes.ts

@@ -1,5 +1,6 @@
 import { log } from "console";
 import { RegistrarClient, UpdateAccountRequest } from "../src/";
+import config from "./config.json";
 
 async function updateAccount(client: RegistrarClient, twinID: number, update: UpdateAccountRequest) {
   const account = await client.accounts.updateAccount(twinID, update);
@@ -16,8 +17,7 @@ async function getAccount(client: RegistrarClient, twinID: number) {
 }
 
 async function main() {
-  const privateKey = "6KY+Ih5LLTivq4cGNrFxkNVtx0lSGbK7wfp2IP/6Wa3plMiff05OWILxBgdPDPrIvPaeBgwTe9bwt4X61Sm2fQ==";
-  const client = new RegistrarClient({ baseURL: "https://registrar.grid.tf/v1/", privateKey: privateKey });
+  const client = new RegistrarClient({ baseURL: config.baseUrl, privateKey: config.privateKey });
   const update: UpdateAccountRequest = {
     relays: ["relay1", "relay2"],
     rmb_enc_key: "rmb_enc_key",

packages/registrar_client/scripts/update_account.ts

@@ -1,5 +1,6 @@
 import { log } from "console";
 import { RegistrarClient } from "../src/";
+import config from "./config.json";
 
 async function updateFarm(client: RegistrarClient, twinID: number, farmID: number, farmName: string) {
   const farm = await client.farms.updateFarm(farmID, twinID, farmName);
@@ -16,8 +17,7 @@ async function getFarm(client: RegistrarClient, farmID: number) {
 }
 
 async function main() {
-  const privateKey = "private_key";
-  const client = new RegistrarClient({ baseURL: "https://registrar.grid.tf/v1/", privateKey: privateKey });
+  const client = new RegistrarClient({ baseURL: config.baseUrl, privateKey: config.privateKey });
   const twinID = 64;
   const farmID = 94;
   const farmName = "test-farm";

packages/registrar_client/scripts/update_farm.ts

@@ -1,5 +1,6 @@
 import { log } from "console";
 import { UpdateNodeRequest, RegistrarClient } from "../src/";
+import config from "./config.json";
 
 async function updateNode(client: RegistrarClient, twinID: number, nodeID: number, update: UpdateNodeRequest) {
   const account = await client.nodes.updateNode(nodeID, twinID, update);
@@ -16,8 +17,7 @@ async function getNode(client: RegistrarClient, nodeID: number) {
 }
 
 async function main() {
-  const privateKey = "QjWTJjjuOJ/KHRo43lKobC9q7ly+3gESVuEXm/t2PFG/d3lrmo/c/C7eRob5qIri2SqqV/tLZRhebLS3hSHRbQ==";
-  const client = new RegistrarClient({ baseURL: "https://registrar.grid.tf/v1/", privateKey: privateKey });
+  const client = new RegistrarClient({ baseURL: config.baseUrl, privateKey: config.privateKey });
   const update: UpdateNodeRequest = {
     farm_id: 94,
     interfaces: [

packages/registrar_client/scripts/update_node.ts

@@ -1,9 +1,11 @@
+import { Node } from "./node";
+
 export interface Farm {
   created_at: string;
   dedicated: boolean;
   farm_id: number;
   farm_name: string;
-  nodes: any[];
+  nodes: Node[];
   twin_id: number;
   updated_at: string;
 }

packages/registrar_client/src/types/farm.ts

@@ -42,7 +42,7 @@ describe("test farm module", () => {
   });
 
   test("create farm with non-existing twin id", async () => {
-    await expect(client.farms.createFarm("test",false, twinID+1)).rejects.toThrowError(
+    await expect(client.farms.createFarm("test",false, twinID+20)).rejects.toThrowError(
       "Failed to create farm: 404 Not Found",
     );
   });

packages/registrar_client/tests/integration_tests/farm.spec.ts

@@ -2,7 +2,7 @@ import { describe, test, expect } from "@jest/globals";
 import { RegistrarClient } from "../../src/client/client";
 
 describe("test zos module", () => {
-  const client = new RegistrarClient({ baseURL: "http://localhost:8080/v1", privateKey: "private_key" });
+  const client = new RegistrarClient({ baseURL: "https://registrar.dev4.grid.tf/v1", privateKey: "private_key" });
 
   test("get zos version", async () => {
     const zos = await client.zos.getZosVersion();

packages/registrar_client/tests/integration_tests/zos.spec.ts

@@ -2,6 +2,7 @@
   "compilerOptions": {
     /* Language and Environment */
     "target": "ESNext",
+    "resolveJsonModule": true,
 
     /* Modules */
     "module": "commonjs",
@@ -15,5 +16,6 @@
     "strict": true,
     "skipLibCheck": true
   },
-  "include": ["./src", "./tests"]
+  "include": ["./src", "scripts"],
+  "exclude": ["./tests"]
 }