@pbgtoken/rwa-contract 1.0.2 → 1.0.4

package/dist/validators/index.d.ts

@@ -2,10 +2,184 @@ import type { IntLike } from "@helios-lang/codec-utils";
 import type { Cast, CastConfig, UserFunc } from "@helios-lang/contract-utils";
 import type { Address, AssetClass, MintingPolicyHash, PubKeyHash, ScriptHash, TxInput, TxOutputId } from "@helios-lang/ledger";
 import type { UplcData, UplcProgram } from "@helios-lang/uplc";
+export declare const one_to_one_asset: {
+    $name: "one_to_one_asset";
+    $purpose: "mixed";
+    $currentScriptIndex: 0;
+    $sourceCode: string;
+    $dependencies: readonly [];
+    $hashDependencies: never[];
+    $dependsOnOwnHash: boolean;
+    $Redeemer: (config: CastConfig) => Cast<{
+        Other: {
+            redeemer: UplcData;
+        };
+    } | {
+        Spending: {
+            redeemer: UplcData;
+        };
+    }, {
+        Other: {
+            redeemer: UplcData;
+        };
+    } | {
+        Spending: {
+            redeemer: UplcData;
+        };
+    }>;
+    $Datum: (config: CastConfig) => Cast<UplcData, UplcData>;
+    $types: {
+        State: (config: CastConfig) => Cast<{
+            supply: bigint;
+            type: string;
+            account: number[];
+            name: string;
+            description: string;
+            decimals: bigint;
+            ticker: string;
+            url: string;
+            logo: string;
+        }, {
+            supply: IntLike;
+            type: string;
+            account: number[];
+            name: string;
+            description: string;
+            decimals: IntLike;
+            ticker: string;
+            url: string;
+            logo: string;
+        }>;
+        Cip68Extra: (config: CastConfig) => Cast<{
+            Unused: {};
+        }, {
+            Unused: {};
+        }>;
+        Metadata: (config: CastConfig) => Cast<{
+            Cip68: {
+                state: {
+                    supply: bigint;
+                    type: string;
+                    account: number[];
+                    name: string;
+                    description: string;
+                    decimals: bigint;
+                    ticker: string;
+                    url: string;
+                    logo: string;
+                };
+                version: bigint;
+                extra: {
+                    Unused: {};
+                };
+            };
+        }, {
+            Cip68: {
+                state: {
+                    supply: IntLike;
+                    type: string;
+                    account: number[];
+                    name: string;
+                    description: string;
+                    decimals: IntLike;
+                    ticker: string;
+                    url: string;
+                    logo: string;
+                };
+                version: IntLike;
+                extra: {
+                    Unused: {};
+                };
+            };
+        }>;
+        Redeemer: (config: CastConfig) => Cast<{
+            reserves: bigint;
+        }, {
+            reserves: IntLike;
+        }>;
+    };
+    $functions: {
+        "Metadata::state": (uplc: UplcProgram, config: CastConfig) => UserFunc<{
+            self: {
+                Cip68: {
+                    state: {
+                        supply: IntLike;
+                        type: string;
+                        account: number[];
+                        name: string;
+                        description: string;
+                        decimals: IntLike;
+                        ticker: string;
+                        url: string;
+                        logo: string;
+                    };
+                    version: IntLike;
+                    extra: {
+                        Unused: {};
+                    };
+                };
+            };
+        }, {
+            supply: bigint;
+            type: string;
+            account: number[];
+            name: string;
+            description: string;
+            decimals: bigint;
+            ticker: string;
+            url: string;
+            logo: string;
+        }>;
+        SEED_ID: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, TxOutputId>;
+        ORACLE_KEYS: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, PubKeyHash[]>;
+        TYPE: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, string>;
+        ACCOUNT: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, number[]>;
+        TICKER: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, string>;
+        NAME: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, string>;
+        DESCRIPTION: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, string>;
+        DECIMALS: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, bigint>;
+        URL: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, string>;
+        LOGO: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, string>;
+        ticker_bytes: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, number[]>;
+        user_token_name: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, number[]>;
+        ref_token_name: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, number[]>;
+        own_hash: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, ScriptHash>;
+        own_mph: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, MintingPolicyHash>;
+        own_address: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, Address>;
+        ref_token_asset_class: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, AssetClass>;
+        user_token_asset_class: (uplc: UplcProgram, config: CastConfig) => UserFunc<{}, AssetClass>;
+        validate_initialization: (uplc: UplcProgram, config: CastConfig) => UserFunc<{
+            $scriptContext: UplcData;
+        }, void>;
+        signed_by_quorum: (uplc: UplcProgram, config: CastConfig) => UserFunc<{
+            $scriptContext: UplcData;
+        }, boolean>;
+        validate_state_change: (uplc: UplcProgram, config: CastConfig) => UserFunc<{
+            $scriptContext: UplcData;
+            redeemer: {
+                reserves: IntLike;
+            };
+            input: TxInput;
+        }, void>;
+        main: (uplc: UplcProgram, config: CastConfig) => UserFunc<{
+            $scriptContext: UplcData;
+            $datum?: UplcData;
+            args: {
+                Other: {
+                    redeemer: UplcData;
+                };
+            } | {
+                Spending: {
+                    redeemer: UplcData;
+                };
+            };
+        }, void>;
+    };
+};
 export declare const tokenized_account: {
     $name: "tokenized_account";
     $purpose: "mixed";
-    $currentScriptIndex: 0;
+    $currentScriptIndex: 1;
     $sourceCode: string;
     $dependencies: readonly [];
     $hashDependencies: never[];

package/jest.config.js

@@ -0,0 +1,12 @@
+const { createDefaultPreset } = require("ts-jest");
+
+const tsJestTransformCfg = createDefaultPreset().transform;
+
+/** @type {import("jest").Config} **/
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    ...tsJestTransformCfg,
+  },
+  testMatch: ["**/tests/**/*.test.ts"],
+};

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pbgtoken/rwa-contract",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "",
   "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "type": "module",
+  "types": "./dist/index.d.ts",
   "license": "AGPL-version-3.0",
   "private": false,
   "engines": {
@@ -24,6 +24,7 @@
     "url": "https://github.com/christianschmitz"
   },
   "scripts": {
+    "test": "jest",
     "build": "npm run build:validators && npm run build:types && npm run build:bundle",
     "build:bundle": "node ./esbuild.js",
     "build:types": "npx tsc --declaration --emitDeclarationOnly",
@@ -37,6 +38,12 @@
     "@helios-lang/tx-utils": "^0.6.13",
     "@helios-lang/type-utils": "^0.3.0",
     "esbuild": "^0.25.4",
+    "ethers": "^6.14.1",
     "typescript": "^5.8.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.3.4"
   }
 }

package/tests/BSCAccountProvider.test.ts

@@ -0,0 +1,25 @@
+import { makeBSCAccountProvider } from "../src/BSCAccountProvider";
+import { makeCoinGeckoProvider } from "../src/CoinGeckoProvider";
+import { TEST_DATA } from "./const";
+
+const priceProvider = makeCoinGeckoProvider();
+
+describe("BSCAccountProvider", () => {
+  const provider = makeBSCAccountProvider(TEST_DATA.bnbAddress, priceProvider, TEST_DATA.alchemyApiKey);
+
+  test("should return balance as a number", async () => {
+    const balance = await provider.balance;
+    expect(typeof balance).toBe("number");
+  });
+
+  test("should return transfer history as array", async () => {
+    const transfers = await provider.transferHistory;
+    expect(Array.isArray(transfers)).toBe(true);
+  });
+
+  test("should calculate deposits in USD from transfer IDs", async () => {
+    const transfers = await provider.transferHistory;
+    const depositUsd = await provider.deposits(transfers);
+    expect(typeof depositUsd).toBe("number");
+  });
+});

package/tests/BinanceAccountProvider.test.ts

@@ -0,0 +1,26 @@
+import { makeBinanceAccountProvider } from "../src/BinanceAccountProvider";
+import { makeCoinGeckoProvider } from "../src/CoinGeckoProvider";
+import { TEST_DATA } from "./const";
+
+const priceProvider = makeCoinGeckoProvider();
+
+describe("BinanceAccountProvider", () => {
+  const provider = makeBinanceAccountProvider(TEST_DATA.binanceApiKey, priceProvider);
+
+  test("should return a USD balance", async () => {
+    const usdBalance = await provider.balance;
+    expect(typeof usdBalance).toBe("number");
+    expect(usdBalance).toBeGreaterThanOrEqual(0);
+  });
+
+  test("should return an array of transfer history", async () => {
+    const transfers = await provider.transferHistory;
+    expect(Array.isArray(transfers)).toBe(true);
+  });
+
+  test("should calculate deposits in USD from transfer IDs", async () => {
+    const transfers = await provider.transferHistory;
+    const depositUsd = await provider.deposits(transfers);
+    expect(typeof depositUsd).toBe("number");
+  });
+});

package/tests/BitcoinWalletProvider.test.ts

@@ -0,0 +1,28 @@
+import { makeBitcoinWalletProvider } from "../src/BitcoinWalletProvider";
+import { makeCoinGeckoProvider } from "../src/CoinGeckoProvider";
+import { TEST_DATA } from "./const";
+
+const priceProvider = makeCoinGeckoProvider();
+
+describe("BitcoinWalletProvider", () => {
+  const provider = makeBitcoinWalletProvider(TEST_DATA.btcAddress, priceProvider);
+
+  test("should return a valid Sats balance", async () => {
+    const sats = await provider.getSats();
+    expect(typeof sats).toBe("number");
+    console.log(sats)
+    expect(sats).toBeGreaterThanOrEqual(0);
+  });
+
+  test("should return an array for transfer history", async () => {
+    const transfers = await provider.transferHistory;
+    console.log(transfers)
+    expect(Array.isArray(transfers)).toBe(true);
+  });
+
+  test("should calculate USD deposits correctly", async () => {
+    const transfers = await provider.transferHistory;
+    const deposits = await provider.deposits(transfers);
+    expect(typeof deposits).toBe("number");
+  });
+});

package/tests/EthereumERC20AccountProvider.test.ts

@@ -0,0 +1,25 @@
+import { makeEthereumERC20AccountProvider } from "../src/EthereumERC20AccountProvider";
+import { makeCoinGeckoProvider } from "../src/CoinGeckoProvider";
+import { TEST_DATA } from "./const";
+
+const priceProvider = makeCoinGeckoProvider();
+
+describe("EthereumERC20AccountProvider", () => {
+  const provider = makeEthereumERC20AccountProvider(TEST_DATA.ethAddress, priceProvider, TEST_DATA.alchemyApiKey, TEST_DATA.usdtContract);
+
+  test("should return balance as a number", async () => {
+    const balance = await provider.balance;
+    expect(typeof balance).toBe("number");
+  });
+
+  test("should return transfer history as array", async () => {
+    const transfers = await provider.transferHistory;
+    expect(Array.isArray(transfers)).toBe(true);
+  });
+
+  test("should calculate deposits in USD from transfer IDs", async () => {
+    const transfers = await provider.transferHistory;
+    const depositUsd = await provider.deposits(transfers);
+    expect(typeof depositUsd).toBe("number");
+  });
+});

package/tests/const.ts

@@ -0,0 +1,16 @@
+export const TEST_DATA = {
+    // Ethereum ERC-20
+    ethAddress: "0xd31F13827c798d8f457313C2A7bA5f764e4842D8",
+    usdtContract: "0xdAC17F958D2ee523a2206206994597C13D831ec7" as `0x${string}`, // USDT contract on Ethereum
+    infuraRpc: process.env.INFURA_RPC_URL || "https://1rpc.io/eth",
+    alchemyApiKey: process.env.ALCHEMY_API_KEY || "",
+
+    // Binance Smart Chain
+    bnbAddress: "0xd31f13827c798d8f457313c2a7ba5f764e4842d8",
+
+    // Bitcoin
+    btcAddress: "bc1q23ztqjmh9a32z8j4rstg035y3c3vpfe0la3nck",
+
+    // Binance Account API
+    binanceApiKey: process.env.BINANCE_API_KEY || "",
+}