Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/client_sdk_ci.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
name: Client SDK CI
permissions:
contents: read

on:
push:
Expand Down Expand Up @@ -35,3 +37,35 @@ jobs:
- name: Run tests
working-directory: client
run: npm run test

test-coverage:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Use Node.js 20.x
uses: actions/setup-node@v4
with:
node-version: "20.x"
cache: "npm"
cache-dependency-path: "client/package-lock.json"

- name: Install dependencies
working-directory: client
run: npm ci

- name: Build
working-directory: client
run: npm run build:all

- name: Run coverage tests
working-directory: client
run: npm run test:coverage

- name: Upload coverage reports
uses: actions/upload-artifact@v4
with:
name: coverage-report
path: client/coverage
retention-days: 7
4 changes: 4 additions & 0 deletions client/src/accounts/hdKeyToAvalancheAccount.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,12 @@ test("getEVMAddress", () => {
test("getXPAddress", () => {
const account = hdKeyToAvalancheAccount(hdKey);
const address = account.getXPAddress();
const cAddress = account.getXPAddress("C");
expect(address).toBeDefined();
expect(typeof address).toBe("string");
expect(cAddress).toBeDefined();
expect(typeof cAddress).toBe("string");
expect(cAddress.startsWith("C-")).toBe(true);
});

test("xpAccount has getHdKey", () => {
Expand Down
104 changes: 104 additions & 0 deletions client/src/accounts/utils/parseAvalancheAccount.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
import { Address } from "viem";
import { describe, expect, expectTypeOf, test } from "vitest";
import { privateKey1ForTest } from "../../methods/wallet/fixtures/transactions/common.js";
import type { AvalancheAccount } from "../avalancheAccount.js";
import { privateKeyToAvalancheAccount } from "../privateKeyToAvalancheAccount.js";
import { parseAvalancheAccount } from "./parseAvalancheAccount.js";

describe("parseAvalancheAccount", () => {
test("parses string address to AvalancheAccount", () => {
const address = "0x76Dd3d7b2f635c2547B861e55aE8A374E587742D" as Address;

const result = parseAvalancheAccount(address);

expectTypeOf(result).toEqualTypeOf<AvalancheAccount>();
expect(result).toBeDefined();
expect(result).toHaveProperty("evmAccount");
expect(result.evmAccount).toBeDefined();
expect(result.evmAccount.address.toLowerCase()).toBe(address.toLowerCase());
expect(result.evmAccount.type).toBe("json-rpc");
});

test("returns AvalancheAccount when passed AvalancheAccount", () => {
const account = privateKeyToAvalancheAccount(privateKey1ForTest);

const result = parseAvalancheAccount(account);

expectTypeOf(result).toEqualTypeOf<AvalancheAccount>();
expect(result).toBe(account);
expect(result).toHaveProperty("evmAccount");
expect(result).toHaveProperty("xpAccount");
expect(result).toHaveProperty("getEVMAddress");
expect(result).toHaveProperty("getXPAddress");
});

test("returns undefined when passed undefined", () => {
const result = parseAvalancheAccount(undefined);

expectTypeOf(result).toEqualTypeOf<undefined>();
expect(result).toBeUndefined();
});

test("handles different address formats", () => {
const addresses = [
"0x76Dd3d7b2f635c2547B861e55aE8A374E587742D",
"0x0000000000000000000000000000000000000000",
"0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"0x1234567890abcdef1234567890abcdef12345678",
] as Address[];

for (const address of addresses) {
const result = parseAvalancheAccount(address);

expect(result).toBeDefined();
expect(result).toHaveProperty("evmAccount");
expect(result.evmAccount.address.toLowerCase()).toBe(
address.toLowerCase()
);
}
});

test("parsed account has correct evmAccount structure", () => {
const address = "0x76Dd3d7b2f635c2547B861e55aE8A374E587742D" as Address;

const result = parseAvalancheAccount(address);

expect(result.evmAccount).toHaveProperty("address");
expect(result.evmAccount).toHaveProperty("type");
expect(result.evmAccount.address.toLowerCase()).toBe(address.toLowerCase());
expect(result.evmAccount.type).toBe("json-rpc");
});

test("parsed account from address does not have xpAccount", () => {
const address = "0x76Dd3d7b2f635c2547B861e55aE8A374E587742D" as Address;

const result = parseAvalancheAccount(address);

expect(result).not.toHaveProperty("xpAccount");
// Or if it exists, it should be undefined
if ("xpAccount" in result) {
expect(result.xpAccount).toBeUndefined();
}
});

test("preserves xpAccount when passing AvalancheAccount", () => {
const account = privateKeyToAvalancheAccount(privateKey1ForTest);

const result = parseAvalancheAccount(account);

expect(result.xpAccount).toBeDefined();
expect(result.xpAccount).toBe(account.xpAccount);
expect(result.xpAccount?.publicKey).toBe(account.xpAccount?.publicKey);
});

test("preserves getEVMAddress and getXPAddress methods", () => {
const account = privateKeyToAvalancheAccount(privateKey1ForTest);

const result = parseAvalancheAccount(account);

expect(result.getEVMAddress).toBe(account.getEVMAddress);
expect(result.getXPAddress).toBe(account.getXPAddress);
expect(typeof result.getEVMAddress).toBe("function");
expect(typeof result.getXPAddress).toBe("function");
});
});
2 changes: 1 addition & 1 deletion client/src/clients/common.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export const SDK_METADATA = {
version: "0.0.4-alpha.0",
version: "0.1.0-alpha.3",
name: "@avalanche-sdk/client",
};

Expand Down
Loading
Loading