Upgrade to 0.5.0

Author: earrietadev

CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file. See
 [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.5.0] (2025-05-01)
+
+### Change
+
+- Remove the `stellarSDK` and the `rpc` instance so we start using the Stellar SDK directly now that recent versions
+  don't fail like old ones with the "instance of" logic.
+- Make as many constructor params as optional as possible, if they are not provided just use default values
+- Avoid fetching the account in read only methods so calls are faster
+
 ### [0.3.0] (2025-05-01)
 
 ### Add

README.md

@@ -6,7 +6,9 @@ protocol
 ```shell
 npx jsr add @creit-tech/sorobandomains-sdk
 ```
-> If you are using another tool like Deno, Bun or PNPM; check the installation instructions [here](https://jsr.io/@creit-tech/sorobandomains-sdk). 
+
+> If you are using another tool like Deno, Bun or PNPM; check the installation instructions
+> [here](https://jsr.io/@creit-tech/sorobandomains-sdk).
 
 ## The SorobanDomainsSDK class
 
@@ -16,21 +18,11 @@ The first step will be creating a new instance from the main class.
 import * as SDK from "@stellar/stellar-sdk";
 import config from "./myconfigfile.ts";
 
-const sdk: SorobanDomainsSDK = new SorobanDomainsSDK({
-  stellarSDK: SDK,
-  rpc: new SDK.rpc.Server(config.RPC_URL),
-  network: config.NETWORK,
-  vaultsContractId: config.VAULTS_CONTRACT_ID,
-  valuesDatabaseContractId: config.VALUES_DATABASE_CONTRACT_ID,
-  reverseRegistrarContractId: config.REVERSE_REGISTRAR_CONTRACT_ID,
-  defaultFee: config.DEFAULT_FEE,
-  defaultTimeout: config.DEFAULT_TIMEOUT,
-  simulationAccount: config.SIMULATION_ACCOUNT,
-});
+const sdk: SorobanDomainsSDK = new SorobanDomainsSDK({ rpcUrl: config.RPC_URL });
 ```
 
-> If you want to know what each value represents, check the `SorobanDomainsSDKParams` interface in the `./src/types.ts`
-> file.
+> There are more parameters you can provide to the SDK, check the `SorobanDomainsSDKParams` interface in the
+> [src/types.ts](https://github.com/Creit-Tech/sorobandomains-sdk-js/blob/main/src/types.ts) file to know all of them.
 
 ## Fetch a registered domain
 

deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@creit-tech/sorobandomains-sdk",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "An SDK to easily fetch domains from the sorobandomains.org protocol",
   "license": "MIT",
   "author": {
@@ -12,7 +12,8 @@
     "url": "https://github.com/Creit-Tech/sorobandomains-sdk-js.git"
   },
   "tasks": {
-    "dev": "deno run --watch main.ts"
+    "dev": "deno run --watch main.ts",
+    "test": "deno test --allow-net"
   },
   "fmt": {
     "lineWidth": 120

src/sdk.test.ts

@@ -2,6 +2,7 @@ import { SorobanDomainsSDK } from "./sdk.ts";
 import { describe, test } from "@std/testing/bdd";
 import { assertEquals } from "@std/assert";
 import { decodeHex } from "@std/encoding";
+import { type Record, RecordType } from "./types.ts";
 
 describe("Basic logic", (): void => {
   test("The `hash` function", () => {
@@ -23,15 +24,27 @@ describe("Basic logic", (): void => {
   });
 
   test("It should validate domains correctly", (): void => {
-    assertEquals(true, SorobanDomainsSDK.isValidDomain('stellar.xlm'));
-    assertEquals(true, SorobanDomainsSDK.isValidDomain('dev.stellar.xlm'));
-    assertEquals(false, SorobanDomainsSDK.isValidDomain('another.dev.stellar.xlm'));
-    assertEquals(false, SorobanDomainsSDK.isValidDomain('stellar'));
-    assertEquals(false, SorobanDomainsSDK.isValidDomain('stellar..xlm'));
-    assertEquals(false, SorobanDomainsSDK.isValidDomain(' stellar.xlm'));
-    assertEquals(false, SorobanDomainsSDK.isValidDomain('qwertyuiopasdfghjklzxcvbnm.xlm'));
-    assertEquals(false, SorobanDomainsSDK.isValidDomain('hello-world.xlm'));
-    assertEquals(false, SorobanDomainsSDK.isValidDomain('steLLar.xlm'));
-    assertEquals(false, SorobanDomainsSDK.isValidDomain('ste11ar.xlm'));
+    assertEquals(true, SorobanDomainsSDK.isValidDomain("stellar.xlm"));
+    assertEquals(true, SorobanDomainsSDK.isValidDomain("dev.stellar.xlm"));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain("another.dev.stellar.xlm"));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain("stellar"));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain("stellar..xlm"));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain(" stellar.xlm"));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain("qwertyuiopasdfghjklzxcvbnm.xlm"));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain("hello-world.xlm"));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain("steLLar.xlm"));
+    assertEquals(false, SorobanDomainsSDK.isValidDomain("ste11ar.xlm"));
+  });
+});
+
+describe("Connection with public registry", () => {
+  test("Search an existing domain", async () => {
+    const now: number = performance.now();
+    const sdk: SorobanDomainsSDK = new SorobanDomainsSDK({ rpcUrl: "https://mainnet.sorobanrpc.com" });
+    const domain: Record = await sdk.searchDomain({ domain: "tomer" });
+    assertEquals(domain.type, RecordType.Domain);
+    const then: number = performance.now();
+
+    console.log(`${(then - now).toFixed(2)}ms`);
   });
 });