veilioexchange 0.1.0 → 0.2.0

package/README.md

@@ -2,7 +2,7 @@
 
 TypeScript SDK for **VEILIO**: sealed-bid auctions for digital assets and milestone service escrow, built on [viem](https://viem.sh).
 
-- **Networks:** BNB Smart Chain Testnet (97) and Base Sepolia (84532). Testnet only.
+- **Networks:** BNB Smart Chain Testnet (97), Base Sepolia (84532) and Solana Devnet. Testnet only.
 - **Formats:** ESM and CommonJS, with TypeScript types.
 - **Runtime:** Node.js 18+ or any modern browser.
 
@@ -90,6 +90,53 @@ await fetch(`https://your-veilio-host/api/orders/${orderId}/verify-deposit`, {
 });
 ```
 
+## Solana Devnet
+
+Solana lives in its own entry point so EVM-only users never load `@solana/web3.js`:
+
+```sh
+npm install veilioexchange @solana/web3.js
+```
+
+```ts
+import { Connection, Keypair, clusterApiUrl } from '@solana/web3.js';
+import { createVeilioSolanaClient, keypairSigner } from 'veilioexchange/solana';
+
+const connection = new Connection(clusterApiUrl('devnet'), 'confirmed');
+const agentKey = Keypair.fromSecretKey(/* load your devnet key from a secret store */);
+
+const solana = createVeilioSolanaClient({
+  connection,
+  signer: keypairSigner(agentKey), // or a Phantom provider: window.phantom.solana
+});
+
+// Sealed-bid auction
+const auctions = await solana.listAuctions();
+const bid = solana.prepareBid(auctions[0].auctionId, '0.25'); // max bid in SOL
+// Store `bid` (salt included) in encrypted storage before committing.
+await solana.commitBid(bid, '0.3');
+await solana.revealBid(bid);
+
+// Service escrow
+await solana.deposit({
+  orderId: 'ord-1739-abc12',     // up to 32 bytes, or 32-byte hex
+  seller: 'SellerBase58...',
+  reviewer: 'ReviewerWallet...',  // a wallet that can sign, never a program ID
+  feeRecipient: 'FeeWallet...',
+  amountSol: '1.5',
+  deadline: Math.floor(Date.now() / 1000) + 3 * 86400,
+});
+await solana.submitDelivery('ord-1739-abc12', 'ipfs://QmProof'); // seller
+await solana.releaseFunds('ord-1739-abc12');                     // buyer
+```
+
+Solana support needs Node.js 18+ (it uses `node:crypto`). Base58 addresses are case-sensitive; never lowercase them.
+
+| Program (Devnet) | ID |
+|---|---|
+| Auction | `5Tw1iJGN1hhyRzepbD5eLoaRoZTEiKcqrh2HoZYhYEta` |
+| Service escrow | `5Vj4y8BT74PDe5VwLuDp9agTR5ak4vtZdwxnBfRW3R8s` |
+
 ## Contract addresses
 
 Defaults live in `VEILIO_DEPLOYMENTS`. Every client takes a `contractAddress` option to point at your own deployment.

package/dist/cjs/solana/auction.d.ts

@@ -0,0 +1,180 @@
+/**
+ * VEILIO Solana Auction Client & Instruction Interface
+ *
+ * Implements client-side PDA derivation, Anchor instruction encoding,
+ * domain-separated sealed commitment calculation, and account deserialization
+ * for the on-chain Solana Devnet Veilio Auction program.
+ */
+import { type SolanaCompiledInstruction } from './registry.js';
+export declare const AUCTION_SEED: Buffer<ArrayBuffer>;
+export declare const BID_COMMITMENT_SEED: Buffer<ArrayBuffer>;
+export declare const COMMITMENT_DOMAIN_TAG: Buffer<ArrayBuffer>;
+export declare const DEFAULT_SOLANA_AUCTION_PROGRAM_ID = "5Tw1iJGN1hhyRzepbD5eLoaRoZTEiKcqrh2HoZYhYEta";
+export declare const MAX_ITEM_NAME_LEN = 64;
+export declare const MAX_DESC_LEN = 128;
+export declare const MAX_IMAGE_URI_LEN = 200;
+export declare const MAX_REVIEW_REASON_LEN = 100;
+export declare enum SolanaAuctionState {
+    Created = 0,
+    Bidding = 1,
+    Revealing = 2,
+    Inspection = 3,
+    RefundRequested = 4,
+    UnderReview = 5,
+    Completed = 6,
+    Refunded = 7,
+    Cancelled = 8
+}
+export declare function getSolanaAuctionProgramId(): string;
+/**
+ * Derives the deterministic PDA for an Auction on Solana.
+ * Seeds: [b"auction", auction_id: u64 LE]
+ */
+export declare function findAuctionPda(auctionId: bigint | number, programId?: string): {
+    pda: string;
+    bump: number;
+};
+/**
+ * Derives the deterministic PDA for a Bidder's Commitment on Solana.
+ * Seeds: [b"bid_commitment", auction_pubkey, bidder_pubkey]
+ */
+export declare function findBidCommitmentPda(auctionPubkey: string, bidderPubkey: string, programId?: string): {
+    pda: string;
+    bump: number;
+};
+/**
+ * Computes domain-separated sealed bid commitment:
+ * SHA-256(b"VEILIO_AUCTION_COMMITMENT_V1" || auction_key || bidder_key || max_bid_le || salt)
+ */
+export declare function computeSealedBidCommitment(params: {
+    auctionPubkey: string;
+    bidderPubkey: string;
+    maxBidLamports: bigint | number;
+    salt: Uint8Array | Buffer;
+}): Buffer;
+export interface DecodedAuctionState {
+    seller: string;
+    reviewer: string;
+    auctionId: bigint;
+    itemName: string;
+    description: string;
+    imageUri: string;
+    startingPrice: bigint;
+    commitEndTime: number;
+    revealEndTime: number;
+    inspectionDuration: number;
+    inspectionEndTime: number;
+    refundRequestedAt: number;
+    state: SolanaAuctionState;
+    highestBidder: string;
+    highestBid: bigint;
+    bidderCount: number;
+    revealedCount: number;
+    evidenceHash: string;
+    reviewReason: string;
+    bump: number;
+}
+export interface DecodedBidCommitment {
+    auction: string;
+    bidder: string;
+    commitment: string;
+    deposit: bigint;
+    maxBid: bigint;
+    revealed: boolean;
+    bump: number;
+}
+/**
+ * Builds `create_auction` instruction.
+ */
+export declare function createCreateAuctionInstruction(params: {
+    programId?: string;
+    seller: string;
+    reviewer: string;
+    auctionId: bigint | number;
+    itemName: string;
+    description: string;
+    imageUri: string;
+    startingPriceLamports: bigint | number;
+    commitDurationSeconds: number;
+    revealDurationSeconds: number;
+    inspectionDurationSeconds: number;
+}): SolanaCompiledInstruction;
+/**
+ * Builds `commit_bid` instruction.
+ */
+export declare function createCommitBidInstruction(params: {
+    programId?: string;
+    auctionId: bigint | number;
+    bidder: string;
+    commitment: Buffer | Uint8Array;
+    depositLamports: bigint | number;
+}): SolanaCompiledInstruction;
+/**
+ * Builds `reveal_bid` instruction.
+ */
+export declare function createRevealBidInstruction(params: {
+    programId?: string;
+    auctionId: bigint | number;
+    bidder: string;
+    maxBidLamports: bigint | number;
+    salt: Buffer | Uint8Array;
+}): SolanaCompiledInstruction;
+/**
+ * Builds `settle_auction` instruction.
+ */
+export declare function createSettleAuctionInstruction(params: {
+    programId?: string;
+    auctionId: bigint | number;
+}): SolanaCompiledInstruction;
+/**
+ * Builds `accept_dataset` instruction.
+ */
+export declare function createAcceptDatasetInstruction(params: {
+    programId?: string;
+    auctionId: bigint | number;
+    seller: string;
+    winner: string;
+}): SolanaCompiledInstruction;
+export declare function createReviewRefundInstruction(params: {
+    programId?: string;
+    auctionId: bigint | number;
+    seller: string;
+    reviewer: string;
+    winner: string;
+    approve: boolean;
+}): SolanaCompiledInstruction;
+export declare function createFinalizeInspectionTimeoutInstruction(params: {
+    programId?: string;
+    auctionId: bigint | number;
+    seller: string;
+    winner: string;
+    caller: string;
+}): SolanaCompiledInstruction;
+export declare function createFinalizeRefundTimeoutInstruction(params: {
+    programId?: string;
+    auctionId: bigint | number;
+    winner: string;
+}): SolanaCompiledInstruction;
+export declare function createClaimRefundInstruction(params: {
+    programId?: string;
+    auctionId: bigint | number;
+    bidder: string;
+}): SolanaCompiledInstruction;
+/**
+ * Builds `request_refund` instruction.
+ */
+export declare function createRequestRefundInstruction(params: {
+    programId?: string;
+    auctionId: bigint | number;
+    winner: string;
+    evidenceHash: Buffer | Uint8Array;
+}): SolanaCompiledInstruction;
+/**
+ * Decodes an Anchor `AuctionStateAccount` buffer.
+ */
+export declare function decodeAuctionStateAccount(data: Buffer | Uint8Array): DecodedAuctionState;
+/**
+ * Decodes an Anchor `BidCommitmentAccount` buffer.
+ */
+export declare function decodeBidCommitmentAccount(data: Buffer | Uint8Array): DecodedBidCommitment;
+//# sourceMappingURL=auction.d.ts.map

package/dist/cjs/solana/auction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auction.d.ts","sourceRoot":"","sources":["../../../src/solana/auction.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAOL,KAAK,yBAAyB,EAC/B,MAAM,eAAe,CAAC;AAEvB,eAAO,MAAM,YAAY,qBAAyB,CAAC;AACnD,eAAO,MAAM,mBAAmB,qBAAgC,CAAC;AACjE,eAAO,MAAM,qBAAqB,qBAA8C,CAAC;AAEjF,eAAO,MAAM,iCAAiC,iDACE,CAAC;AAEjD,eAAO,MAAM,iBAAiB,KAAK,CAAC;AACpC,eAAO,MAAM,YAAY,MAAM,CAAC;AAChC,eAAO,MAAM,iBAAiB,MAAM,CAAC;AACrC,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC,oBAAY,kBAAkB;IAC5B,OAAO,IAAI;IACX,OAAO,IAAI;IACX,SAAS,IAAI;IACb,UAAU,IAAI;IACd,eAAe,IAAI;IACnB,WAAW,IAAI;IACf,SAAS,IAAI;IACb,QAAQ,IAAI;IACZ,SAAS,IAAI;CACd;AAED,wBAAgB,yBAAyB,IAAI,MAAM,CAElD;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,SAAS,GAAE,MAAoC,GAC9C;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAI/B;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,SAAS,GAAE,MAAoC,GAC9C;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAI/B;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE;IACjD,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,GAAG,MAAM,CAAC;IAChC,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;CAC3B,GAAG,MAAM,CAmBT;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,yBAAyB,EAAE,MAAM,CAAC;CACnC,GAAG,yBAAyB,CAmF5B;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,GAAG,UAAU,CAAC;IAChC,eAAe,EAAE,MAAM,GAAG,MAAM,CAAC;CAClC,GAAG,yBAAyB,CA8B5B;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,GAAG,MAAM,CAAC;IAChC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;CAC3B,GAAG,yBAAyB,CA0B5B;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B,GAAG,yBAAyB,CAW5B;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,yBAAyB,CAiB5B;AAED,wBAAgB,6BAA6B,CAAC,MAAM,EAAE;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CAClB,GAAG,yBAAyB,CAkB5B;AAED,wBAAgB,0CAA0C,CAAC,MAAM,EAAE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,yBAAyB,CAe5B;AAED,wBAAgB,sCAAsC,CAAC,MAAM,EAAE;IAC7D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,yBAAyB,CAa5B;AAED,wBAAgB,4BAA4B,CAAC,MAAM,EAAE;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,yBAAyB,CAa5B;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,GAAG,UAAU,CAAC;CACnC,GAAG,yBAAyB,CAwB5B;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,mBAAmB,CAqGxF;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,oBAAoB,CAyC1F"}