privacycash 1.0.6

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,67 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          registry-url: "https://registry.npmjs.org"
+          cache: "npm"
+
+      # Get previous version from the last commit in origin/main
+      - name: Get previous package.json version
+        run: |
+          PREV=$(git show origin/main~1:package.json | jq -r .version)
+          echo "Previous version: $PREV"
+          echo "PREV_VERSION=$PREV" >> $GITHUB_ENV
+
+      # Get current version from package.json
+      - name: Get current package.json version
+        run: |
+          CURR=$(jq -r .version package.json)
+          echo "CURR_VERSION=$CURR"
+          echo "CURR_VERSION=$CURR" >> $GITHUB_ENV
+
+      # Compare previous and current versions
+      - name: Compare versions
+        run: |
+          if [ "$PREV_VERSION" = "$CURR_VERSION" ]; then
+            echo "Version unchanged, skip publish"
+            echo "SHOULD_PUBLISH=false" >> $GITHUB_ENV
+          else
+            echo "Version changed, will publish"
+            echo "SHOULD_PUBLISH=true" >> $GITHUB_ENV
+          fi
+
+      # Install dependencies only if publish is needed
+      - name: Install dependencies
+        if: env.SHOULD_PUBLISH == 'true'
+        run: npm ci
+
+      # Run build script before publishing
+      - name: Build project
+        if: env.SHOULD_PUBLISH == 'true'
+        run: npm run build
+
+      # Publish to npm
+      - name: Publish to npm
+        if: env.SHOULD_PUBLISH == 'true'
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,22 @@
+## Privacy Cash SDK
+This is the SDK for Privacy Cash. It has been audited by Zigtur (https://x.com/zigtur).
+
+### Usage
+This SDK provides APIs for developers to interact with Privacy Cash relayers easily. Developers can easily deposit/withdraw/query balances in Privacy Cash solana program.
+
+Main APIs for this SDK are: deposit(), withdraw(), getPrivateBalance().
+
+Check the example project under /example folder. The code should be fairly self-explanatory.
+
+Use node version 24 or above.
+
+### Tests
+1. To run unit tests:
+```
+    npm test
+```
+2. To run e2e test (on Mainnet), you need to put your private key (PRIVATE_KEY) inside .env file under the project root directory, and then run:
+```
+    npm run teste2e
+```
+Running e2e tests will cost some transaction fees on your wallet, so don't put too much SOL into your wallet. Maybe put 0.1 SOL, and the tests might cost 0.02 SOL.

package/__tests__/e2e.test.ts

@@ -0,0 +1,52 @@
+import { describe, it, expect, vi, beforeAll, beforeEach, type Mock } from "vitest";
+import dotenv from 'dotenv';
+import { PrivacyCash } from "../src";
+import { LAMPORTS_PER_SOL } from "@solana/web3.js";
+dotenv.config();
+const TEST_AMOUNT = 0.01
+
+describe('e2e test', async () => {
+    if (!process.env.PRIVATE_KEY) {
+        throw new Error('missing PRIVATE_KEY in .env')
+    }
+    let client = new PrivacyCash({
+        RPC_url: 'https://rorie-6cdtt5-fast-mainnet.helius-rpc.com',
+        owner: process.env.PRIVATE_KEY
+    })
+    let balance_original = await client.getPrivateBalance()
+
+    // deposit
+    await client.deposit({
+        lamports: TEST_AMOUNT * LAMPORTS_PER_SOL
+    })
+    let balance_after_deposit = await client.getPrivateBalance()
+
+    // withdraw wrong amount
+    it(`show throw error if withdraw amount less than 0.01`, async () => {
+        await expect(client.withdraw({
+            lamports: 0.005 * LAMPORTS_PER_SOL
+        })).rejects.toThrow()
+    })
+
+    // withdraw
+    let withdrawRes = await client.withdraw({
+        lamports: TEST_AMOUNT * LAMPORTS_PER_SOL
+    })
+    let balance_after_withdraw = await client.getPrivateBalance()
+
+    it('balance is a number', () => {
+        expect(balance_original.lamports).to.be.a('number')
+    })
+
+    it(`balance should be increased ${TEST_AMOUNT} sol`, () => {
+        expect(balance_after_deposit.lamports).equal(balance_after_withdraw.lamports + TEST_AMOUNT * LAMPORTS_PER_SOL)
+    })
+
+    it('should keep balance unchanged after depositing and withdrawing the same amount', () => {
+        expect(balance_original.lamports).equal(balance_after_withdraw.lamports)
+    })
+
+    it(`withdraw real amount plus fee should  be ${TEST_AMOUNT * LAMPORTS_PER_SOL}`, () => {
+        expect(withdrawRes.amount_in_lamports + withdrawRes.fee_in_lamports).equal(TEST_AMOUNT * LAMPORTS_PER_SOL)
+    })
+})