Contracts SDK v1.2

.changeset/bumpy-games-chew.md

@@ -0,0 +1,5 @@
+---
+"@oaknetwork/contracts-sdk": minor
+---
+
+Add missing events, reads, errors, type-safe constants, simulation results, transaction preparation, and getReceipt; update event log fetching documentation and improve code consistency

packages/contracts/__tests__/integration/all-or-nothing.test.ts

@@ -15,14 +15,6 @@ describe("AllOrNothing — reads (may revert on uninitialized implementation)",
   it("getPlatformFeePercent", async () => { try { expect(typeof (await aon.getPlatformFeePercent())).toBe("bigint"); } catch { /* implementation revert */ } });
   it("paused", async () => { try { expect(typeof (await aon.paused())).toBe("boolean"); } catch { /* implementation revert */ } });
   it("cancelled", async () => { try { expect(typeof (await aon.cancelled())).toBe("boolean"); } catch { /* implementation revert */ } });
-  it("balanceOf", async () => { try { expect(typeof (await aon.balanceOf(ZERO_ADDR))).toBe("bigint"); } catch { /* implementation revert */ } });
-  it("ownerOf (may revert)", async () => { try { await aon.ownerOf(0n); } catch { /* expected */ } });
-  it("tokenURI (may revert)", async () => { try { await aon.tokenURI(0n); } catch { /* expected */ } });
-  it("name", async () => { try { expect(typeof (await aon.name())).toBe("string"); } catch { /* implementation revert */ } });
-  it("symbol", async () => { try { expect(typeof (await aon.symbol())).toBe("string"); } catch { /* implementation revert */ } });
-  it("getApproved (may revert)", async () => { try { await aon.getApproved(0n); } catch { /* expected */ } });
-  it("isApprovedForAll", async () => { try { expect(typeof (await aon.isApprovedForAll(ZERO_ADDR, ZERO_ADDR))).toBe("boolean"); } catch { /* implementation revert */ } });
-  it("supportsInterface", async () => { try { expect(typeof (await aon.supportsInterface("0x80ac58cd"))).toBe("boolean"); } catch { /* implementation revert */ } });
 });
 
 describe("AllOrNothing — writes (may revert)", () => {
@@ -40,11 +32,6 @@ describe("AllOrNothing — writes (may revert)", () => {
   it("claimRefund", async () => { try { await aon.claimRefund(0n); } catch { /* expected */ } });
   it("disburseFees", async () => { try { await aon.disburseFees(); } catch { /* expected */ } });
   it("withdraw", async () => { try { await aon.withdraw(); } catch { /* expected */ } });
-  it("burn", async () => { try { await aon.burn(0n); } catch { /* expected */ } });
-  it("approve", async () => { try { await aon.approve(ZERO_ADDR, 0n); } catch { /* expected */ } });
-  it("setApprovalForAll", async () => { try { await aon.setApprovalForAll(ZERO_ADDR, true); } catch { /* expected */ } });
-  it("safeTransferFrom", async () => { try { await aon.safeTransferFrom(ZERO_ADDR, ZERO_ADDR, 0n); } catch { /* expected */ } });
-  it("transferFrom", async () => { try { await aon.transferFrom(ZERO_ADDR, ZERO_ADDR, 0n); } catch { /* expected */ } });
 });
 
 describe("AllOrNothing — simulate (may throw)", () => {

packages/contracts/__tests__/integration/campaign-info.test.ts

@@ -97,6 +97,10 @@ describe("CampaignInfo — reads (may revert on uninitialized implementation)",
   it("paused", async () => {
     try { expect(typeof (await ci.paused())).toBe("boolean"); } catch { /* implementation revert */ }
   });
+  it("getApproved (may revert)", async () => { try { await ci.getApproved(0n); } catch { /* expected */ } });
+  it("isApprovedForAll", async () => {
+    try { expect(typeof (await ci.isApprovedForAll(ZERO_ADDR, ZERO_ADDR))).toBe("boolean"); } catch { /* implementation revert */ }
+  });
 });
 
 describe("CampaignInfo — writes (may revert)", () => {
@@ -112,6 +116,8 @@ describe("CampaignInfo — writes (may revert)", () => {
   it("unpauseCampaign", async () => { try { await ci.unpauseCampaign(BYTES32_ZERO); } catch { /* expected */ } });
   it("cancelCampaign", async () => { try { await ci.cancelCampaign(BYTES32_ZERO); } catch { /* expected */ } });
   it("setPlatformInfo", async () => { try { await ci.setPlatformInfo(BYTES32_ZERO, ZERO_ADDR); } catch { /* expected */ } });
+  it("approve", async () => { try { await ci.approve(ZERO_ADDR, 0n); } catch { /* expected */ } });
+  it("setApprovalForAll", async () => { try { await ci.setApprovalForAll(ZERO_ADDR, true); } catch { /* expected */ } });
   it("transferOwnership", async () => { try { await ci.transferOwnership(ZERO_ADDR); } catch { /* expected */ } });
   it("renounceOwnership", async () => { try { await ci.renounceOwnership(); } catch { /* expected */ } });
 });
@@ -124,6 +130,8 @@ describe("CampaignInfo — simulate (may throw)", () => {
   it("simulate.mintNFTForPledge", async () => { try { await ci.simulate.mintNFTForPledge(ZERO_ADDR, BYTES32_ZERO, ZERO_ADDR, 100n, 0n, 0n); } catch { /* expected */ } });
   it("simulate.pauseCampaign", async () => { try { await ci.simulate.pauseCampaign(BYTES32_ZERO); } catch { /* expected */ } });
   it("simulate.cancelCampaign", async () => { try { await ci.simulate.cancelCampaign(BYTES32_ZERO); } catch { /* expected */ } });
+  it("simulate.approve", async () => { try { await ci.simulate.approve(ZERO_ADDR, 0n); } catch { /* expected */ } });
+  it("simulate.setApprovalForAll", async () => { try { await ci.simulate.setApprovalForAll(ZERO_ADDR, true); } catch { /* expected */ } });
 });
 
 describe("CampaignInfo — events", () => {

packages/contracts/__tests__/integration/keep-whats-raised.test.ts

@@ -22,14 +22,6 @@ describe("KeepWhatsRaised — reads (may revert on uninitialized implementation)
   it("getFeeValue", async () => { try { expect(typeof (await kwr.getFeeValue(BYTES32_ZERO))).toBe("bigint"); } catch { /* implementation revert */ } });
   it("paused", async () => { try { expect(typeof (await kwr.paused())).toBe("boolean"); } catch { /* implementation revert */ } });
   it("cancelled", async () => { try { expect(typeof (await kwr.cancelled())).toBe("boolean"); } catch { /* implementation revert */ } });
-  it("balanceOf", async () => { try { expect(typeof (await kwr.balanceOf(ZERO_ADDR))).toBe("bigint"); } catch { /* implementation revert */ } });
-  it("ownerOf (may revert)", async () => { try { await kwr.ownerOf(0n); } catch { /* expected */ } });
-  it("tokenURI (may revert)", async () => { try { await kwr.tokenURI(0n); } catch { /* expected */ } });
-  it("name", async () => { try { expect(typeof (await kwr.name())).toBe("string"); } catch { /* implementation revert */ } });
-  it("symbol", async () => { try { expect(typeof (await kwr.symbol())).toBe("string"); } catch { /* implementation revert */ } });
-  it("getApproved (may revert)", async () => { try { await kwr.getApproved(0n); } catch { /* expected */ } });
-  it("isApprovedForAll", async () => { try { expect(typeof (await kwr.isApprovedForAll(ZERO_ADDR, ZERO_ADDR))).toBe("boolean"); } catch { /* implementation revert */ } });
-  it("supportsInterface", async () => { try { expect(typeof (await kwr.supportsInterface("0x80ac58cd"))).toBe("boolean"); } catch { /* implementation revert */ } });
 });
 
 describe("KeepWhatsRaised — writes (may revert)", () => {
@@ -62,10 +54,6 @@ describe("KeepWhatsRaised — writes (may revert)", () => {
   it("withdraw", async () => { try { await kwr.withdraw(ZERO_ADDR, 0n); } catch { /* expected */ } });
   it("updateDeadline", async () => { try { await kwr.updateDeadline(9999999999n); } catch { /* expected */ } });
   it("updateGoalAmount", async () => { try { await kwr.updateGoalAmount(1000n); } catch { /* expected */ } });
-  it("approve", async () => { try { await kwr.approve(ZERO_ADDR, 0n); } catch { /* expected */ } });
-  it("setApprovalForAll", async () => { try { await kwr.setApprovalForAll(ZERO_ADDR, true); } catch { /* expected */ } });
-  it("safeTransferFrom", async () => { try { await kwr.safeTransferFrom(ZERO_ADDR, ZERO_ADDR, 0n); } catch { /* expected */ } });
-  it("transferFrom", async () => { try { await kwr.transferFrom(ZERO_ADDR, ZERO_ADDR, 0n); } catch { /* expected */ } });
 });
 
 describe("KeepWhatsRaised — simulate (may throw)", () => {

packages/contracts/__tests__/unit/client.test.ts

@@ -137,6 +137,58 @@ describe("createOakContractsClient", () => {
     expect(results).toEqual([5n, 250n]);
   });
 
+  it("getReceipt returns receipt for mined transaction", async () => {
+    const client = createOakContractsClient({
+      chainId: CHAIN_IDS.CELO_TESTNET_SEPOLIA,
+      rpcUrl: RPC,
+      privateKey: PK,
+    });
+    const mockReceipt = {
+      blockNumber: 456n,
+      gasUsed: 42000n,
+      logs: [{ topics: ["0xabc"], data: "0xdef" }],
+    };
+    (
+      client.publicClient as unknown as { getTransactionReceipt: jest.Mock }
+    ).getTransactionReceipt = jest.fn().mockResolvedValue(mockReceipt);
+
+    const receipt = await client.getReceipt("0xdeadbeef");
+    expect(receipt).not.toBeNull();
+    expect(receipt!.blockNumber).toBe(456n);
+    expect(receipt!.gasUsed).toBe(42000n);
+    expect(receipt!.logs).toHaveLength(1);
+  });
+
+  it("getReceipt returns null when transaction is not found", async () => {
+    const client = createOakContractsClient({
+      chainId: CHAIN_IDS.CELO_TESTNET_SEPOLIA,
+      rpcUrl: RPC,
+      privateKey: PK,
+    });
+    const notFoundError = new Error("Transaction receipt not found");
+    notFoundError.name = "TransactionReceiptNotFoundError";
+    (
+      client.publicClient as unknown as { getTransactionReceipt: jest.Mock }
+    ).getTransactionReceipt = jest.fn().mockRejectedValue(notFoundError);
+
+    const receipt = await client.getReceipt("0xdeadbeef");
+    expect(receipt).toBeNull();
+  });
+
+  it("getReceipt re-throws non-receipt errors (e.g. network failures)", async () => {
+    const client = createOakContractsClient({
+      chainId: CHAIN_IDS.CELO_TESTNET_SEPOLIA,
+      rpcUrl: RPC,
+      privateKey: PK,
+    });
+    const networkError = new Error("RPC timeout");
+    (
+      client.publicClient as unknown as { getTransactionReceipt: jest.Mock }
+    ).getTransactionReceipt = jest.fn().mockRejectedValue(networkError);
+
+    await expect(client.getReceipt("0xdeadbeef")).rejects.toThrow("RPC timeout");
+  });
+
   it("waitForReceipt calls publicClient.waitForTransactionReceipt", async () => {
     const client = createOakContractsClient({
       chainId: CHAIN_IDS.CELO_TESTNET_SEPOLIA,
@@ -173,4 +225,15 @@ describe("contracts barrel export", () => {
     expect(contractsIndex.createKeepWhatsRaisedEntity).toBeDefined();
     expect(contractsIndex.createItemRegistryEntity).toBeDefined();
   });
+
+  it("re-exports all contract ABIs", () => {
+    expect(contractsIndex.GLOBAL_PARAMS_ABI).toBeDefined();
+    expect(contractsIndex.CAMPAIGN_INFO_FACTORY_ABI).toBeDefined();
+    expect(contractsIndex.CAMPAIGN_INFO_ABI).toBeDefined();
+    expect(contractsIndex.TREASURY_FACTORY_ABI).toBeDefined();
+    expect(contractsIndex.PAYMENT_TREASURY_ABI).toBeDefined();
+    expect(contractsIndex.ALL_OR_NOTHING_ABI).toBeDefined();
+    expect(contractsIndex.KEEP_WHATS_RAISED_ABI).toBeDefined();
+    expect(contractsIndex.ITEM_REGISTRY_ABI).toBeDefined();
+  });
 });