pctestupgrade2 1.1.8

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

@@ -0,0 +1,55 @@
+name: Publish to npm when version changes
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - "package.json"
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          registry-url: https://registry.npmjs.org/
+
+      - name: Get current package version
+        id: pkg
+        run: echo "version=$(node -p 'require(\"./package.json\").version')" >> $GITHUB_OUTPUT
+
+      - name: Check if version already exists on npm
+        id: check
+        run: |
+          PKG_NAME=$(node -p 'require("./package.json").name')
+          PUBLISHED=$(npm view $PKG_NAME versions --json | grep -o "\"${{ steps.pkg.outputs.version }}\"" || true)
+          if [ -n "$PUBLISHED" ]; then
+            echo "exists=true" >> $GITHUB_OUTPUT
+            echo "Version ${{ steps.pkg.outputs.version }} already exists on npm. Skipping publish."
+          else
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build source
+        run: npm run build || echo "No build script defined."
+
+      - name: Publish to npm
+        if: steps.check.outputs.exists == 'false'
+        run: |
+          echo "Publishing version ${{ steps.pkg.outputs.version }}..."
+          npm publish --access public

package/README.md

@@ -0,0 +1,31 @@
+## Privacy Cash SDK
+This is the SDK for Privacy Cash. It has been audited by Zigtur (https://x.com/zigtur).
+
+### Disclaimer
+This SDK powers Privacy Cash's frontend, assuming the single wallet use case. If you use it or published npm library from this repo, please fully test and beware of the inherent software risks or potential bugs.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+### 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: 
+a. for SOL: 
+deposit(), withdraw(), getPrivateBalance() 
+b. for SPL (currently supporting USDC and USDT): 
+depositSPL(), withdrawSPL(), getPrivateBalanceSpl()
+
+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,56 @@
+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')
+    }
+    if (!process.env.RPC_URL) {
+        throw new Error('missing RPC_URL in .env')
+    }
+
+    let client = new PrivacyCash({
+        RPC_url: process.env.RPC_URL,
+        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)
+    })
+})

package/__tests__/e2espl.test.ts

@@ -0,0 +1,73 @@
+import { describe, it, expect, vi, beforeAll, beforeEach, type Mock } from "vitest";
+import dotenv from 'dotenv';
+import { PrivacyCash } from "../src";
+import { getAccount, getAssociatedTokenAddress } from "@solana/spl-token";
+import { FEE_RECIPIENT, USDC_MINT } from "../src/utils/constants";
+import { Connection } from "@solana/web3.js";
+dotenv.config();
+const TEST_AMOUNT = 2
+const units_per_token = 1_000_000
+describe('e2e test', async () => {
+    if (!process.env.PRIVATE_KEY) {
+        throw new Error('missing PRIVATE_KEY in .env')
+    }
+    if (!process.env.RPC_URL) {
+        throw new Error('missing RPC_URL in .env')
+    }
+
+    const connection = new Connection(process.env.RPC_URL)
+    let fee_recipient_ata = await getAssociatedTokenAddress(USDC_MINT, FEE_RECIPIENT, true)
+    let feeRecipientAccount = await getAccount(connection, fee_recipient_ata)
+    let feeRecipientBalance_before = feeRecipientAccount.amount
+
+    let client = new PrivacyCash({
+        RPC_url: process.env.RPC_URL,
+        owner: process.env.PRIVATE_KEY
+    })
+    let balance_original = await client.getPrivateBalanceUSDC()
+
+    // deposit
+    await client.depositUSDC({
+        base_units: TEST_AMOUNT * units_per_token
+    })
+    let balance_after_deposit = await client.getPrivateBalanceUSDC()
+
+    // withdraw wrong amount
+    it(`show throw error if withdraw amount less than 1`, async () => {
+        await expect(client.withdrawUSDC({
+            base_units: 0.9 * units_per_token
+        })).rejects.toThrow()
+    })
+
+    // withdraw
+    let withdrawRes = await client.withdrawUSDC({
+        base_units: TEST_AMOUNT * units_per_token
+    })
+
+    await new Promise(r => setTimeout(r, 10_000));
+
+    feeRecipientAccount = await getAccount(connection, fee_recipient_ata)
+    let feeRecipientBalance_after = feeRecipientAccount.amount
+
+    let balance_after_withdraw = await client.getPrivateBalanceUSDC()
+
+    it('balance is a number', () => {
+        expect(balance_original.base_units).to.be.a('number')
+    })
+
+    it(`balance should be increased ${TEST_AMOUNT} USDC`, () => {
+        expect(balance_after_deposit.base_units).equal(balance_after_withdraw.base_units + TEST_AMOUNT * units_per_token)
+    })
+
+    it('should keep balance unchanged after depositing and withdrawing the same amount', () => {
+        expect(balance_original.base_units).equal(balance_after_withdraw.base_units)
+    })
+
+    it(`withdraw real amount plus fee should  be ${TEST_AMOUNT * units_per_token}`, () => {
+        expect(withdrawRes.base_units + withdrawRes.fee_base_units).equal(TEST_AMOUNT * units_per_token)
+    })
+
+    it('fee recipient amount should be inceased by the withdraw fee', () => {
+        expect(withdrawRes.fee_base_units).equal(Number(feeRecipientBalance_after - feeRecipientBalance_before))
+    })
+})