ccxt-ir 4.9.32 → 4.11.0

package/js/src/src/static_dependencies/starknet/utils/cairoDataTypes/uint256.js

@@ -0,0 +1,117 @@
+// ----------------------------------------------------------------------------
+
+// PLEASE DO NOT EDIT THIS FILE, IT IS GENERATED AND WILL BE OVERWRITTEN:
+// https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md#how-to-contribute-code
+// EDIT THE CORRESPONDENT .ts FILE INSTEAD
+
+/* eslint-disable no-bitwise */
+/**
+ * Singular class handling cairo u256 data type
+ */
+import { addHexPrefix } from '../encode.js';
+import { CairoFelt } from './felt.js';
+export const UINT_128_MAX = (1n << 128n) - 1n;
+export const UINT_256_MAX = (1n << 256n) - 1n;
+export const UINT_256_MIN = 0n;
+export const UINT_256_LOW_MAX = 340282366920938463463374607431768211455n;
+export const UINT_256_HIGH_MAX = 340282366920938463463374607431768211455n;
+export const UINT_256_LOW_MIN = 0n;
+export const UINT_256_HIGH_MIN = 0n;
+export class CairoUint256 {
+    constructor(...arr) {
+        if (typeof arr[0] === 'object' && arr.length === 1 && 'low' in arr[0] && 'high' in arr[0]) {
+            const props = CairoUint256.validateProps(arr[0].low, arr[0].high);
+            this.low = props.low;
+            this.high = props.high;
+        }
+        else if (arr.length === 1) {
+            const bigInt = CairoUint256.validate(arr[0]);
+            this.low = bigInt & UINT_128_MAX;
+            this.high = bigInt >> 128n;
+        }
+        else if (arr.length === 2) {
+            const props = CairoUint256.validateProps(arr[0], arr[1]);
+            this.low = props.low;
+            this.high = props.high;
+        }
+        else {
+            throw Error('Incorrect constructor parameters');
+        }
+    }
+    /**
+     * Validate if BigNumberish can be represented as Unit256
+     */
+    static validate(bigNumberish) {
+        const bigInt = BigInt(bigNumberish);
+        if (bigInt < UINT_256_MIN)
+            throw Error('bigNumberish is smaller than UINT_256_MIN');
+        if (bigInt > UINT_256_MAX)
+            throw new Error('bigNumberish is bigger than UINT_256_MAX');
+        return bigInt;
+    }
+    /**
+     * Validate if low and high can be represented as Unit256
+     */
+    static validateProps(low, high) {
+        const bigIntLow = BigInt(low);
+        const bigIntHigh = BigInt(high);
+        if (bigIntLow < UINT_256_LOW_MIN || bigIntLow > UINT_256_LOW_MAX) {
+            throw new Error('low is out of range UINT_256_LOW_MIN - UINT_256_LOW_MAX');
+        }
+        if (bigIntHigh < UINT_256_HIGH_MIN || bigIntHigh > UINT_256_HIGH_MAX) {
+            throw new Error('high is out of range UINT_256_HIGH_MIN - UINT_256_HIGH_MAX');
+        }
+        return { low: bigIntLow, high: bigIntHigh };
+    }
+    /**
+     * Check if BigNumberish can be represented as Unit256
+     */
+    static is(bigNumberish) {
+        try {
+            CairoUint256.validate(bigNumberish);
+        }
+        catch (error) {
+            return false;
+        }
+        return true;
+    }
+    /**
+     * Check if provided abi type is this data type
+     */
+    static isAbiType(abiType) {
+        return abiType === CairoUint256.abiSelector;
+    }
+    /**
+     * Return bigint representation
+     */
+    toBigInt() {
+        return (this.high << 128n) + this.low;
+    }
+    /**
+     * Return Uint256 structure with HexString props
+     * {low: HexString, high: HexString}
+     */
+    toUint256HexString() {
+        return {
+            low: addHexPrefix(this.low.toString(16)),
+            high: addHexPrefix(this.high.toString(16)),
+        };
+    }
+    /**
+     * Return Uint256 structure with DecimalString props
+     * {low: DecString, high: DecString}
+     */
+    toUint256DecimalString() {
+        return {
+            low: this.low.toString(10),
+            high: this.high.toString(10),
+        };
+    }
+    /**
+     * Return api requests representation witch is felt array
+     */
+    toApiRequest() {
+        return [CairoFelt(this.low), CairoFelt(this.high)];
+    }
+}
+CairoUint256.abiSelector = 'core::integer::u256';

package/js/src/src/static_dependencies/starknet/utils/cairoDataTypes/uint512.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Singular class handling cairo u512 data type
+ */
+import { BigNumberish, type Uint512 } from '../../types/index.js';
+export declare const UINT_512_MAX: bigint;
+export declare const UINT_512_MIN = 0n;
+export declare const UINT_128_MIN = 0n;
+export declare class CairoUint512 {
+    limb0: bigint;
+    limb1: bigint;
+    limb2: bigint;
+    limb3: bigint;
+    static abiSelector: string;
+    /**
+     * Default constructor (Lib usage)
+     * @param bigNumberish BigNumberish value representing u512
+     */
+    constructor(bigNumberish: BigNumberish);
+    /**
+     * Direct props initialization (Api response)
+     */
+    constructor(limb0: BigNumberish, limb1: BigNumberish, limb2: BigNumberish, limb3: BigNumberish);
+    /**
+     * Initialization from Uint512 object
+     */
+    constructor(uint512: Uint512);
+    /**
+     * Validate if BigNumberish can be represented as Uint512
+     */
+    static validate(bigNumberish: BigNumberish): bigint;
+    /**
+     * Validate if limbs can be represented as Uint512
+     */
+    static validateProps(limb0: BigNumberish, limb1: BigNumberish, limb2: BigNumberish, limb3: BigNumberish): {
+        limb0: bigint;
+        limb1: bigint;
+        limb2: bigint;
+        limb3: bigint;
+    };
+    /**
+     * Check if BigNumberish can be represented as Uint512
+     */
+    static is(bigNumberish: BigNumberish): boolean;
+    /**
+     * Check if provided abi type is this data type
+     */
+    static isAbiType(abiType: string): boolean;
+    /**
+     * Return bigint representation
+     */
+    toBigInt(): bigint;
+    /**
+     * Return Uint512 structure with HexString props
+     * limbx: HexString
+     */
+    toUint512HexString(): {
+        limb0: string;
+        limb1: string;
+        limb2: string;
+        limb3: string;
+    };
+    /**
+     * Return Uint512 structure with DecimalString props
+     * limbx DecString
+     */
+    toUint512DecimalString(): {
+        limb0: string;
+        limb1: string;
+        limb2: string;
+        limb3: string;
+    };
+    /**
+     * Return api requests representation witch is felt array
+     */
+    toApiRequest(): string[];
+}

package/js/src/src/static_dependencies/starknet/utils/cairoDataTypes/uint512.js

@@ -0,0 +1,136 @@
+// ----------------------------------------------------------------------------
+
+// PLEASE DO NOT EDIT THIS FILE, IT IS GENERATED AND WILL BE OVERWRITTEN:
+// https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md#how-to-contribute-code
+// EDIT THE CORRESPONDENT .ts FILE INSTEAD
+
+/* eslint-disable no-bitwise */
+/**
+ * Singular class handling cairo u512 data type
+ */
+import { addHexPrefix } from '../encode.js';
+import { CairoFelt } from './felt.js';
+import { UINT_128_MAX } from './uint256.js';
+export const UINT_512_MAX = (1n << 512n) - 1n;
+export const UINT_512_MIN = 0n;
+export const UINT_128_MIN = 0n;
+export class CairoUint512 {
+    constructor(...arr) {
+        if (typeof arr[0] === 'object' &&
+            arr.length === 1 &&
+            'limb0' in arr[0] &&
+            'limb1' in arr[0] &&
+            'limb2' in arr[0] &&
+            'limb3' in arr[0]) {
+            const props = CairoUint512.validateProps(arr[0].limb0, arr[0].limb1, arr[0].limb2, arr[0].limb3);
+            this.limb0 = props.limb0;
+            this.limb1 = props.limb1;
+            this.limb2 = props.limb2;
+            this.limb3 = props.limb3;
+        }
+        else if (arr.length === 1) {
+            const bigInt = CairoUint512.validate(arr[0]);
+            this.limb0 = bigInt & UINT_128_MAX;
+            this.limb1 = (bigInt & (UINT_128_MAX << 128n)) >> 128n;
+            this.limb2 = (bigInt & (UINT_128_MAX << 256n)) >> 256n;
+            this.limb3 = bigInt >> 384n;
+        }
+        else if (arr.length === 4) {
+            const props = CairoUint512.validateProps(arr[0], arr[1], arr[2], arr[3]);
+            this.limb0 = props.limb0;
+            this.limb1 = props.limb1;
+            this.limb2 = props.limb2;
+            this.limb3 = props.limb3;
+        }
+        else {
+            throw Error('Incorrect Uint512 constructor parameters');
+        }
+    }
+    /**
+     * Validate if BigNumberish can be represented as Uint512
+     */
+    static validate(bigNumberish) {
+        const bigInt = BigInt(bigNumberish);
+        if (bigInt < UINT_512_MIN)
+            throw Error('bigNumberish is smaller than UINT_512_MIN.');
+        if (bigInt > UINT_512_MAX)
+            throw Error('bigNumberish is bigger than UINT_512_MAX.');
+        return bigInt;
+    }
+    /**
+     * Validate if limbs can be represented as Uint512
+     */
+    static validateProps(limb0, limb1, limb2, limb3) {
+        const l0 = BigInt(limb0);
+        const l1 = BigInt(limb1);
+        const l2 = BigInt(limb2);
+        const l3 = BigInt(limb3);
+        [l0, l1, l2, l3].forEach((value, index) => {
+            if (value < UINT_128_MIN || value > UINT_128_MAX) {
+                throw Error(`limb${index} is not in the range of a u128 number`);
+            }
+        });
+        return { limb0: l0, limb1: l1, limb2: l2, limb3: l3 };
+    }
+    /**
+     * Check if BigNumberish can be represented as Uint512
+     */
+    static is(bigNumberish) {
+        try {
+            CairoUint512.validate(bigNumberish);
+        }
+        catch (error) {
+            return false;
+        }
+        return true;
+    }
+    /**
+     * Check if provided abi type is this data type
+     */
+    static isAbiType(abiType) {
+        return abiType === CairoUint512.abiSelector;
+    }
+    /**
+     * Return bigint representation
+     */
+    toBigInt() {
+        return (this.limb3 << 384n) + (this.limb2 << 256n) + (this.limb1 << 128n) + this.limb0;
+    }
+    /**
+     * Return Uint512 structure with HexString props
+     * limbx: HexString
+     */
+    toUint512HexString() {
+        return {
+            limb0: addHexPrefix(this.limb0.toString(16)),
+            limb1: addHexPrefix(this.limb1.toString(16)),
+            limb2: addHexPrefix(this.limb2.toString(16)),
+            limb3: addHexPrefix(this.limb3.toString(16)),
+        };
+    }
+    /**
+     * Return Uint512 structure with DecimalString props
+     * limbx DecString
+     */
+    toUint512DecimalString() {
+        return {
+            limb0: this.limb0.toString(10),
+            limb1: this.limb1.toString(10),
+            limb2: this.limb2.toString(10),
+            limb3: this.limb3.toString(10),
+        };
+    }
+    /**
+     * Return api requests representation witch is felt array
+     */
+    toApiRequest() {
+        // lower limb first : https://github.com/starkware-libs/cairo/blob/07484c52791b76abcc18fd86265756904557d0d2/corelib/src/test/integer_test.cairo#L767
+        return [
+            CairoFelt(this.limb0),
+            CairoFelt(this.limb1),
+            CairoFelt(this.limb2),
+            CairoFelt(this.limb3),
+        ];
+    }
+}
+CairoUint512.abiSelector = 'core::integer::u512';

package/js/src/src/static_dependencies/starknet/utils/calldata/byteArray.d.ts

@@ -0,0 +1,32 @@
+import { ByteArray } from '../../types/lib/index.js';
+/**
+ * convert a Cairo ByteArray to a JS string
+ * @param myByteArray Cairo representation of a LongString
+ * @returns a JS string
+ * @example
+ * ```typescript
+ * const myByteArray = {
+ *    data: [],
+ *    pending_word: '0x414243444546474849',
+ *    pending_word_len: 9
+ * }
+ * const result: String = stringFromByteArray(myByteArray); // ABCDEFGHI
+ * ```
+ */
+export declare function stringFromByteArray(myByteArray: ByteArray): string;
+/**
+ * convert a JS string to a Cairo ByteArray
+ * @param targetString a JS string
+ * @returns Cairo representation of a LongString
+ * @example
+ * ```typescript
+ * const myByteArray: ByteArray = byteArrayFromString("ABCDEFGHI");
+ * ```
+ * Result is :
+ * {
+ *    data: [],
+ *    pending_word: '0x414243444546474849',
+ *    pending_word_len: 9
+ * }
+ */
+export declare function byteArrayFromString(targetString: string): ByteArray;

package/js/src/src/static_dependencies/starknet/utils/calldata/byteArray.js

@@ -0,0 +1,59 @@
+// ----------------------------------------------------------------------------
+
+// PLEASE DO NOT EDIT THIS FILE, IT IS GENERATED AND WILL BE OVERWRITTEN:
+// https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md#how-to-contribute-code
+// EDIT THE CORRESPONDENT .ts FILE INSTEAD
+
+import { toHex } from '../num.js';
+import { decodeShortString, encodeShortString, splitLongString } from '../shortString.js';
+/**
+ * convert a Cairo ByteArray to a JS string
+ * @param myByteArray Cairo representation of a LongString
+ * @returns a JS string
+ * @example
+ * ```typescript
+ * const myByteArray = {
+ *    data: [],
+ *    pending_word: '0x414243444546474849',
+ *    pending_word_len: 9
+ * }
+ * const result: String = stringFromByteArray(myByteArray); // ABCDEFGHI
+ * ```
+ */
+export function stringFromByteArray(myByteArray) {
+    const pending_word = BigInt(myByteArray.pending_word) === 0n
+        ? ''
+        : decodeShortString(toHex(myByteArray.pending_word));
+    return (myByteArray.data.reduce((cumuledString, encodedString) => {
+        const add = BigInt(encodedString) === 0n ? '' : decodeShortString(toHex(encodedString));
+        return cumuledString + add;
+    }, '') + pending_word);
+}
+/**
+ * convert a JS string to a Cairo ByteArray
+ * @param targetString a JS string
+ * @returns Cairo representation of a LongString
+ * @example
+ * ```typescript
+ * const myByteArray: ByteArray = byteArrayFromString("ABCDEFGHI");
+ * ```
+ * Result is :
+ * {
+ *    data: [],
+ *    pending_word: '0x414243444546474849',
+ *    pending_word_len: 9
+ * }
+ */
+export function byteArrayFromString(targetString) {
+    const shortStrings = splitLongString(targetString);
+    const remainder = shortStrings[shortStrings.length - 1];
+    const shortStringsEncoded = shortStrings.map(encodeShortString);
+    const [pendingWord, pendingWordLength] = remainder === undefined || remainder.length === 31
+        ? ['0x00', 0]
+        : [shortStringsEncoded.pop(), remainder.length];
+    return {
+        data: shortStringsEncoded.length === 0 ? [] : shortStringsEncoded,
+        pending_word: pendingWord,
+        pending_word_len: pendingWordLength,
+    };
+}

package/js/src/src/static_dependencies/starknet/utils/calldata/cairo.d.ts

@@ -0,0 +1,183 @@
+import { Abi, AbiEnums, AbiStructs, BigNumberish, ContractVersion, Uint256, Uint512 } from '../../types/index.js';
+/**
+ * Checks if the given name ends with "_len".
+ *
+ * @param {string} name - The name to be checked.
+ * @returns - True if the name ends with "_len", false otherwise.
+ */
+export declare const isLen: (name: string) => boolean;
+/**
+ * Checks if a given type is felt.
+ *
+ * @param {string} type - The type to check.
+ * @returns - True if the type is felt, false otherwise.
+ */
+export declare const isTypeFelt: (type: string) => boolean;
+/**
+ * Checks if the given type is an array type.
+ *
+ * @param {string} type - The type to check.
+ * @returns - `true` if the type is an array type, `false` otherwise.
+ */
+export declare const isTypeArray: (type: string) => boolean;
+/**
+ * Checks if the given type is a tuple type.
+ *
+ * @param {string} type - The type to be checked.
+ * @returns - `true` if the type is a tuple type, otherwise `false`.
+ */
+export declare const isTypeTuple: (type: string) => boolean;
+/**
+ * Checks whether a given type is a named tuple.
+ *
+ * @param {string} type - The type to be checked.
+ * @returns - True if the type is a named tuple, false otherwise.
+ */
+export declare const isTypeNamedTuple: (type: string) => boolean;
+/**
+ * Checks if a given type is a struct.
+ *
+ * @param {string} type - The type to check for existence.
+ * @param {AbiStructs} structs - The collection of structs to search in.
+ * @returns - True if the type exists in the structs, false otherwise.
+ */
+export declare const isTypeStruct: (type: string, structs: AbiStructs) => boolean;
+/**
+ * Checks if a given type is an enum.
+ *
+ * @param {string} type - The type to check.
+ * @param {AbiEnums} enums - The enumeration to search in.
+ * @returns - True if the type exists in the enumeration, otherwise false.
+ */
+export declare const isTypeEnum: (type: string, enums: AbiEnums) => boolean;
+/**
+ * Determines if the given type is an Option type.
+ *
+ * @param {string} type - The type to check.
+ * @returns - True if the type is an Option type, false otherwise.
+ */
+export declare const isTypeOption: (type: string) => boolean;
+/**
+ * Checks whether a given type starts with 'core::result::Result::'.
+ *
+ * @param {string} type - The type to check.
+ * @returns - True if the type starts with 'core::result::Result::', false otherwise.
+ */
+export declare const isTypeResult: (type: string) => boolean;
+/**
+ * Checks if the given value is a valid Uint type.
+ *
+ * @param {string} type - The value to check.
+ * @returns - Returns true if the value is a valid Uint type, otherwise false.
+ */
+export declare const isTypeUint: (type: string) => boolean;
+/**
+ * Checks if the given type is `uint256`.
+ *
+ * @param {string} type - The type to be checked.
+ * @returns - Returns true if the type is `uint256`, otherwise false.
+ */
+export declare const isTypeUint256: (type: string) => boolean;
+/**
+ * Checks if the given type is a literal type.
+ *
+ * @param {string} type - The type to check.
+ * @returns - True if the type is a literal type, false otherwise.
+ */
+export declare const isTypeLiteral: (type: string) => boolean;
+/**
+ * Checks if the given type is a boolean type.
+ *
+ * @param {string} type - The type to be checked.
+ * @returns - Returns true if the type is a boolean type, otherwise false.
+ */
+export declare const isTypeBool: (type: string) => boolean;
+/**
+ * Checks if the provided type is equal to 'core::starknet::contract_address::ContractAddress'.
+ * @param {string} type - The type to be checked.
+ * @returns - true if the type matches 'core::starknet::contract_address::ContractAddress', false otherwise.
+ */
+export declare const isTypeContractAddress: (type: string) => boolean;
+/**
+ * Determines if the given type is an Ethereum address type.
+ *
+ * @param {string} type - The type to check.
+ * @returns - Returns true if the given type is 'core::starknet::eth_address::EthAddress', otherwise false.
+ */
+export declare const isTypeEthAddress: (type: string) => boolean;
+/**
+ * Checks if the given type is 'core::bytes_31::bytes31'.
+ *
+ * @param {string} type - The type to check.
+ * @returns - True if the type is 'core::bytes_31::bytes31', false otherwise.
+ */
+export declare const isTypeBytes31: (type: string) => boolean;
+/**
+ * Checks if the given type is equal to the 'core::byte_array::ByteArray'.
+ *
+ * @param {string} type - The type to check.
+ * @returns - True if the given type is equal to 'core::byte_array::ByteArray', false otherwise.
+ */
+export declare const isTypeByteArray: (type: string) => boolean;
+export declare const isTypeSecp256k1Point: (type: string) => boolean;
+export declare const isCairo1Type: (type: string) => boolean;
+/**
+ * Retrieves the array type from the given type string.
+ *
+ * @param {string} type - The type string.
+ * @returns - The array type.
+ */
+export declare const getArrayType: (type: string) => string;
+/**
+ * Test if an ABI comes from a Cairo 1 contract
+ * @param abi representing the interface of a Cairo contract
+ * @returns TRUE if it is an ABI from a Cairo1 contract
+ * @example
+ * ```typescript
+ * const isCairo1: boolean = isCairo1Abi(myAbi: Abi);
+ * ```
+ */
+export declare function isCairo1Abi(abi: Abi): boolean;
+/**
+ * Return ContractVersion (Abi version) based on Abi
+ * or undefined for unknown version
+ * @param abi
+ * @returns string
+ */
+export declare function getAbiContractVersion(abi: Abi): ContractVersion;
+/**
+ * named tuple cairo type is described as js object {}
+ * struct cairo type are described as js object {}
+ * array cairo type are described as js array []
+ */
+/**
+ * Create Uint256 Cairo type (helper for common struct type)
+ * @example
+ * ```typescript
+ * uint256('892349863487563453485768723498');
+ * ```
+ */
+export declare const uint256: (it: BigNumberish) => Uint256;
+/**
+ * Create Uint512 Cairo type (helper for common struct type)
+ * @param it BigNumberish representation of a 512 bits unsigned number
+ * @returns Uint512 struct
+ * @example
+ * ```typescript
+ * uint512('345745685892349863487563453485768723498');
+ * ```
+ */
+export declare const uint512: (it: BigNumberish) => Uint512;
+/**
+ * Create unnamed tuple Cairo type (helper same as common struct type)
+ * @example
+ * ```typescript
+ * tuple(1, '0x101', 16);
+ * ```
+ */
+export declare const tuple: (...args: (BigNumberish | object | boolean)[]) => Record<number, BigNumberish | object | boolean>;
+/**
+ * Create felt Cairo type (cairo type helper)
+ * @returns format: felt-string
+ */
+export declare function felt(it: BigNumberish): string;