@atomiqlabs/chain-solana 13.5.13 → 13.5.14

package/src/solana/wallet/SolanaKeypairWallet.ts

@@ -1,56 +1,56 @@
-import {Wallet} from "@coral-xyz/anchor/dist/cjs/provider";
-import {Keypair, PublicKey, Transaction, VersionedTransaction} from "@solana/web3.js";
-
-/**
- * Keypair-based wallet implementation for Solana
- * @category Wallets
- */
-export class SolanaKeypairWallet implements Wallet {
-
-    /**
-     * Underlying signer keypair.
-     */
-    readonly payer: Keypair;
-
-    constructor(payer: Keypair) {
-        this.payer = payer;
-    }
-
-    /**
-     * Public key of the wrapped payer keypair.
-     */
-    get publicKey(): PublicKey {
-        return this.payer.publicKey;
-    }
-
-    /**
-     * Signs all provided transactions with the wrapped keypair.
-     *
-     * @param txs Transactions to sign
-     */
-    signAllTransactions<T extends Transaction | VersionedTransaction>(txs: T[]): Promise<T[]> {
-        txs.forEach((tx) => {
-            if(tx instanceof Transaction) {
-                tx.partialSign(this.payer);
-            } else if(tx instanceof VersionedTransaction) {
-                tx.sign([this.payer]);
-            }
-        });
-        return Promise.resolve(txs);
-    }
-
-    /**
-     * Signs a single transaction with the wrapped keypair.
-     *
-     * @param tx Transaction to sign
-     */
-    signTransaction<T extends Transaction | VersionedTransaction>(tx: T): Promise<T> {
-        if(tx instanceof Transaction) {
-            tx.partialSign(this.payer);
-        } else if(tx instanceof VersionedTransaction) {
-            tx.sign([this.payer]);
-        }
-        return Promise.resolve(tx);
-    }
-
-}
+import {Wallet} from "@coral-xyz/anchor/dist/cjs/provider";
+import {Keypair, PublicKey, Transaction, VersionedTransaction} from "@solana/web3.js";
+
+/**
+ * Keypair-based wallet implementation for Solana
+ * @category Wallets
+ */
+export class SolanaKeypairWallet implements Wallet {
+
+    /**
+     * Underlying signer keypair.
+     */
+    readonly payer: Keypair;
+
+    constructor(payer: Keypair) {
+        this.payer = payer;
+    }
+
+    /**
+     * Public key of the wrapped payer keypair.
+     */
+    get publicKey(): PublicKey {
+        return this.payer.publicKey;
+    }
+
+    /**
+     * Signs all provided transactions with the wrapped keypair.
+     *
+     * @param txs Transactions to sign
+     */
+    signAllTransactions<T extends Transaction | VersionedTransaction>(txs: T[]): Promise<T[]> {
+        txs.forEach((tx) => {
+            if(tx instanceof Transaction) {
+                tx.partialSign(this.payer);
+            } else if(tx instanceof VersionedTransaction) {
+                tx.sign([this.payer]);
+            }
+        });
+        return Promise.resolve(txs);
+    }
+
+    /**
+     * Signs a single transaction with the wrapped keypair.
+     *
+     * @param tx Transaction to sign
+     */
+    signTransaction<T extends Transaction | VersionedTransaction>(tx: T): Promise<T> {
+        if(tx instanceof Transaction) {
+            tx.partialSign(this.payer);
+        } else if(tx instanceof VersionedTransaction) {
+            tx.sign([this.payer]);
+        }
+        return Promise.resolve(tx);
+    }
+
+}

package/src/solana/wallet/SolanaSigner.ts

@@ -1,43 +1,43 @@
-import { Wallet } from "@coral-xyz/anchor/dist/cjs/provider";
-import {AbstractSigner} from "@atomiqlabs/base";
-import {PublicKey, Signer} from "@solana/web3.js";
-
-/**
- * Solana signer implementation wrapping an Anchor Wallet
- * @category Wallets
- */
-export class SolanaSigner implements AbstractSigner {
-    /**
-     * @inheritDoc
-     */
-    type = "AtomiqAbstractSigner" as const;
-
-    /**
-     * Wrapped wallet implementation used for signing.
-     */
-    wallet: Wallet;
-    /**
-     * Optional raw keypair signer when available.
-     */
-    keypair?: Signer;
-
-    constructor(wallet: Wallet, keypair?: Signer) {
-        this.wallet = wallet;
-        this.keypair = keypair;
-    }
-
-    /**
-     * Returns public key of the wrapped wallet.
-     */
-    getPublicKey(): PublicKey {
-        return this.wallet.publicKey;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    getAddress(): string {
-        return this.wallet.publicKey.toString();
-    }
-
-}
+import { Wallet } from "@coral-xyz/anchor/dist/cjs/provider";
+import {AbstractSigner} from "@atomiqlabs/base";
+import {PublicKey, Signer} from "@solana/web3.js";
+
+/**
+ * Solana signer implementation wrapping an Anchor Wallet
+ * @category Wallets
+ */
+export class SolanaSigner implements AbstractSigner {
+    /**
+     * @inheritDoc
+     */
+    type = "AtomiqAbstractSigner" as const;
+
+    /**
+     * Wrapped wallet implementation used for signing.
+     */
+    wallet: Wallet;
+    /**
+     * Optional raw keypair signer when available.
+     */
+    keypair?: Signer;
+
+    constructor(wallet: Wallet, keypair?: Signer) {
+        this.wallet = wallet;
+        this.keypair = keypair;
+    }
+
+    /**
+     * Returns public key of the wrapped wallet.
+     */
+    getPublicKey(): PublicKey {
+        return this.wallet.publicKey;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    getAddress(): string {
+        return this.wallet.publicKey.toString();
+    }
+
+}

package/src/utils/Utils.ts

@@ -1,194 +1,194 @@
-import {ComputeBudgetProgram, PublicKey, Transaction} from "@solana/web3.js";
-import * as BN from "bn.js";
-import {Buffer} from "buffer";
-import {sha256} from "@noble/hashes/sha2";
-
-export type Serialized<T> = {
-    [K in keyof T as T[K] extends Function ? never : K]:
-    T[K] extends infer U
-        ? U extends PublicKey | BN
-            ? string
-            : U extends object
-                ? Serialized<U>
-                : U
-        : never;
-};
-
-export function timeoutPromise(timeoutMillis: number, abortSignal?: AbortSignal): Promise<void> {
-    return new Promise((resolve, reject) => {
-        const timeout = setTimeout(resolve, timeoutMillis)
-        if(abortSignal!=null) abortSignal.addEventListener("abort", () => {
-            clearTimeout(timeout);
-            reject(new Error("Aborted"));
-        })
-    });
-}
-
-export function onceAsync<T>(executor: () => Promise<T>): () => Promise<T> {
-    let promise: Promise<T>;
-
-    return () => {
-        if(promise==null) {
-            promise = executor();
-            return promise;
-        } else {
-            return promise.catch(() => promise = executor());
-        }
-    }
-}
-
-export function getLogger(prefix: string) {
-    return {
-        debug: (msg: string, ...args: any[]) => (global as any).atomiqLogLevel >= 3 && console.debug(prefix+msg, ...args),
-        info: (msg: string, ...args: any[]) => (global as any).atomiqLogLevel >= 2 && console.info(prefix+msg, ...args),
-        warn: (msg: string, ...args: any[]) => ((global as any).atomiqLogLevel==null || (global as any).atomiqLogLevel >= 1) && console.warn(prefix+msg, ...args),
-        error: (msg: string, ...args: any[]) => ((global as any).atomiqLogLevel==null || (global as any).atomiqLogLevel >= 0) && console.error(prefix+msg, ...args)
-    };
-}
-const logger = getLogger("Utils: ");
-
-export async function tryWithRetries<T>(func: () => Promise<T>, retryPolicy?: {
-    maxRetries?: number, delay?: number, exponential?: boolean
-}, errorAllowed?: (e: any) => boolean, abortSignal?: AbortSignal): Promise<T> {
-    retryPolicy = retryPolicy || {};
-    retryPolicy.maxRetries = retryPolicy.maxRetries || 5;
-    retryPolicy.delay = retryPolicy.delay || 500;
-    retryPolicy.exponential =  retryPolicy.exponential==null ? true : retryPolicy.exponential;
-
-    let err = null;
-
-    for(let i=0;i<retryPolicy.maxRetries;i++) {
-        try {
-            const resp: T = await func();
-            return resp;
-        } catch (e) {
-            if(errorAllowed!=null && errorAllowed(e)) throw e;
-            err = e;
-            logger.error("tryWithRetries(): error on try number: "+i, e);
-        }
-        if(abortSignal!=null && abortSignal.aborted) throw new Error("Aborted");
-        if(i!==retryPolicy.maxRetries-1) {
-            await timeoutPromise(
-                retryPolicy.exponential ? retryPolicy.delay*Math.pow(2, i) : retryPolicy.delay,
-                abortSignal
-            );
-        }
-    }
-
-    throw err;
-}
-
-export class SolanaTxUtils {
-    // COMPACT ARRAY
-    private static LOW_VALUE = 127; // 0x7f
-    private static HIGH_VALUE = 16383; // 0x3fff
-
-    /**
-     * Compact u16 array header size
-     * @param n elements in the compact array
-     * @returns size in bytes of array header
-     */
-    private static compactHeader(n: number): number {
-        return (n <= SolanaTxUtils.LOW_VALUE ? 1 : n <= SolanaTxUtils.HIGH_VALUE ? 2 : 3);
-    }
-
-    /**
-     * Compact u16 array size
-     * @param n elements in the compact array
-     * @param size bytes per each element
-     * @returns size in bytes of array
-     */
-    private static compactArraySize(n: number, size: number): number {
-        return SolanaTxUtils.compactHeader(n) + n * size;
-    }
-
-    /**
-     * Returns # number of non-compute budget related instructions
-     *
-     * @param tx
-     */
-    public static getNonComputeBudgetIxs(tx: Transaction): number {
-        let counter = 0;
-        for(let ix of tx.instructions) {
-            if(!ix.programId.equals(ComputeBudgetProgram.programId)) counter++;
-        }
-        return counter;
-    }
-
-    /**
-     * @param tx a solana transaction
-     * @param feePayer the publicKey of the signer
-     * @returns size in bytes of the transaction
-     */
-    public static getTxSize(tx: Transaction, feePayer: PublicKey): number {
-        const feePayerPk = [feePayer.toBase58()];
-
-        const signers = new Set<string>(feePayerPk);
-        const accounts = new Set<string>(feePayerPk);
-
-        const ixsSize = tx.instructions.reduce((acc, ix) => {
-            ix.keys.forEach(({ pubkey, isSigner }) => {
-                const pk = pubkey.toBase58();
-                if (isSigner) signers.add(pk);
-                accounts.add(pk);
-            });
-
-            accounts.add(ix.programId.toBase58());
-
-            const nIndexes = ix.keys.length;
-            const opaqueData = ix.data.length;
-
-            return (
-                acc +
-                1 + // PID index
-                SolanaTxUtils.compactArraySize(nIndexes, 1) +
-                SolanaTxUtils.compactArraySize(opaqueData, 1)
-            );
-        }, 0);
-
-        return (
-            SolanaTxUtils.compactArraySize(signers.size, 64) + // signatures
-            3 + // header
-            SolanaTxUtils.compactArraySize(accounts.size, 32) + // accounts
-            32 + // blockhash
-            SolanaTxUtils.compactHeader(tx.instructions.length) + // instructions
-            ixsSize
-        );
-    };
-}
-
-export function toClaimHash(paymentHash: string, nonce: bigint, confirmations: number): string {
-    return paymentHash+
-        nonce.toString(16).padStart(16, "0")+
-        confirmations.toString(16).padStart(4, "0");
-}
-
-export function fromClaimHash(claimHash: string): {paymentHash: string, nonce: BN, confirmations: number} {
-    if(claimHash.length!==84) throw new Error("Claim hash invalid length: "+claimHash.length);
-    return {
-        paymentHash: claimHash.slice(0, 64),
-        nonce: new BN(claimHash.slice(64, 80), "hex"),
-        confirmations: parseInt(claimHash.slice(80, 84), 16)
-    }
-}
-
-export function toEscrowHash(paymentHash: string, sequence: BN): string {
-    return Buffer.from(sha256(Buffer.concat([
-        Buffer.from(paymentHash, "hex"),
-        sequence.toArrayLike(Buffer, "be", 8)
-    ]))).toString("hex");
-}
-
-export function toBN(value: bigint): BN;
-export function toBN(value: null): null;
-export function toBN(value: bigint | null): BN | null {
-    if(value==null) return null;
-    return new BN(value.toString(10));
-}
-
-export function toBigInt(value: BN): bigint;
-export function toBigInt(value: null): null;
-export function toBigInt(value: BN | null): bigint |  null {
-    if(value==null) return null;
-    return BigInt(value.toString(10));
-}
+import {ComputeBudgetProgram, PublicKey, Transaction} from "@solana/web3.js";
+import * as BN from "bn.js";
+import {Buffer} from "buffer";
+import {sha256} from "@noble/hashes/sha2";
+
+export type Serialized<T> = {
+    [K in keyof T as T[K] extends Function ? never : K]:
+    T[K] extends infer U
+        ? U extends PublicKey | BN
+            ? string
+            : U extends object
+                ? Serialized<U>
+                : U
+        : never;
+};
+
+export function timeoutPromise(timeoutMillis: number, abortSignal?: AbortSignal): Promise<void> {
+    return new Promise((resolve, reject) => {
+        const timeout = setTimeout(resolve, timeoutMillis)
+        if(abortSignal!=null) abortSignal.addEventListener("abort", () => {
+            clearTimeout(timeout);
+            reject(new Error("Aborted"));
+        })
+    });
+}
+
+export function onceAsync<T>(executor: () => Promise<T>): () => Promise<T> {
+    let promise: Promise<T>;
+
+    return () => {
+        if(promise==null) {
+            promise = executor();
+            return promise;
+        } else {
+            return promise.catch(() => promise = executor());
+        }
+    }
+}
+
+export function getLogger(prefix: string) {
+    return {
+        debug: (msg: string, ...args: any[]) => (global as any).atomiqLogLevel >= 3 && console.debug(prefix+msg, ...args),
+        info: (msg: string, ...args: any[]) => (global as any).atomiqLogLevel >= 2 && console.info(prefix+msg, ...args),
+        warn: (msg: string, ...args: any[]) => ((global as any).atomiqLogLevel==null || (global as any).atomiqLogLevel >= 1) && console.warn(prefix+msg, ...args),
+        error: (msg: string, ...args: any[]) => ((global as any).atomiqLogLevel==null || (global as any).atomiqLogLevel >= 0) && console.error(prefix+msg, ...args)
+    };
+}
+const logger = getLogger("Utils: ");
+
+export async function tryWithRetries<T>(func: () => Promise<T>, retryPolicy?: {
+    maxRetries?: number, delay?: number, exponential?: boolean
+}, errorAllowed?: (e: any) => boolean, abortSignal?: AbortSignal): Promise<T> {
+    retryPolicy = retryPolicy || {};
+    retryPolicy.maxRetries = retryPolicy.maxRetries || 5;
+    retryPolicy.delay = retryPolicy.delay || 500;
+    retryPolicy.exponential =  retryPolicy.exponential==null ? true : retryPolicy.exponential;
+
+    let err = null;
+
+    for(let i=0;i<retryPolicy.maxRetries;i++) {
+        try {
+            const resp: T = await func();
+            return resp;
+        } catch (e) {
+            if(errorAllowed!=null && errorAllowed(e)) throw e;
+            err = e;
+            logger.error("tryWithRetries(): error on try number: "+i, e);
+        }
+        if(abortSignal!=null && abortSignal.aborted) throw new Error("Aborted");
+        if(i!==retryPolicy.maxRetries-1) {
+            await timeoutPromise(
+                retryPolicy.exponential ? retryPolicy.delay*Math.pow(2, i) : retryPolicy.delay,
+                abortSignal
+            );
+        }
+    }
+
+    throw err;
+}
+
+export class SolanaTxUtils {
+    // COMPACT ARRAY
+    private static LOW_VALUE = 127; // 0x7f
+    private static HIGH_VALUE = 16383; // 0x3fff
+
+    /**
+     * Compact u16 array header size
+     * @param n elements in the compact array
+     * @returns size in bytes of array header
+     */
+    private static compactHeader(n: number): number {
+        return (n <= SolanaTxUtils.LOW_VALUE ? 1 : n <= SolanaTxUtils.HIGH_VALUE ? 2 : 3);
+    }
+
+    /**
+     * Compact u16 array size
+     * @param n elements in the compact array
+     * @param size bytes per each element
+     * @returns size in bytes of array
+     */
+    private static compactArraySize(n: number, size: number): number {
+        return SolanaTxUtils.compactHeader(n) + n * size;
+    }
+
+    /**
+     * Returns # number of non-compute budget related instructions
+     *
+     * @param tx
+     */
+    public static getNonComputeBudgetIxs(tx: Transaction): number {
+        let counter = 0;
+        for(let ix of tx.instructions) {
+            if(!ix.programId.equals(ComputeBudgetProgram.programId)) counter++;
+        }
+        return counter;
+    }
+
+    /**
+     * @param tx a solana transaction
+     * @param feePayer the publicKey of the signer
+     * @returns size in bytes of the transaction
+     */
+    public static getTxSize(tx: Transaction, feePayer: PublicKey): number {
+        const feePayerPk = [feePayer.toBase58()];
+
+        const signers = new Set<string>(feePayerPk);
+        const accounts = new Set<string>(feePayerPk);
+
+        const ixsSize = tx.instructions.reduce((acc, ix) => {
+            ix.keys.forEach(({ pubkey, isSigner }) => {
+                const pk = pubkey.toBase58();
+                if (isSigner) signers.add(pk);
+                accounts.add(pk);
+            });
+
+            accounts.add(ix.programId.toBase58());
+
+            const nIndexes = ix.keys.length;
+            const opaqueData = ix.data.length;
+
+            return (
+                acc +
+                1 + // PID index
+                SolanaTxUtils.compactArraySize(nIndexes, 1) +
+                SolanaTxUtils.compactArraySize(opaqueData, 1)
+            );
+        }, 0);
+
+        return (
+            SolanaTxUtils.compactArraySize(signers.size, 64) + // signatures
+            3 + // header
+            SolanaTxUtils.compactArraySize(accounts.size, 32) + // accounts
+            32 + // blockhash
+            SolanaTxUtils.compactHeader(tx.instructions.length) + // instructions
+            ixsSize
+        );
+    };
+}
+
+export function toClaimHash(paymentHash: string, nonce: bigint, confirmations: number): string {
+    return paymentHash+
+        nonce.toString(16).padStart(16, "0")+
+        confirmations.toString(16).padStart(4, "0");
+}
+
+export function fromClaimHash(claimHash: string): {paymentHash: string, nonce: BN, confirmations: number} {
+    if(claimHash.length!==84) throw new Error("Claim hash invalid length: "+claimHash.length);
+    return {
+        paymentHash: claimHash.slice(0, 64),
+        nonce: new BN(claimHash.slice(64, 80), "hex"),
+        confirmations: parseInt(claimHash.slice(80, 84), 16)
+    }
+}
+
+export function toEscrowHash(paymentHash: string, sequence: BN): string {
+    return Buffer.from(sha256(Buffer.concat([
+        Buffer.from(paymentHash, "hex"),
+        sequence.toArrayLike(Buffer, "be", 8)
+    ]))).toString("hex");
+}
+
+export function toBN(value: bigint): BN;
+export function toBN(value: null): null;
+export function toBN(value: bigint | null): BN | null {
+    if(value==null) return null;
+    return new BN(value.toString(10));
+}
+
+export function toBigInt(value: BN): bigint;
+export function toBigInt(value: null): null;
+export function toBigInt(value: BN | null): bigint |  null {
+    if(value==null) return null;
+    return BigInt(value.toString(10));
+}