@imtbl/x-client 2.0.0-alpha.0

package/dist/types/utils/formatError.d.ts

@@ -0,0 +1,7 @@
+import { IMXError } from '../types/errors';
+/**
+ * [Formats an error in the IMXError shape](https://axios-http.com/docs/handling_errors)
+ * @param error - The Error object thrown by the request
+ * @returns {@link IMXError} - The formatted error
+ */
+export declare function formatError(error: unknown): IMXError;

package/dist/types/utils/formatError.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './convertToSignableToken';
+export * from './formatError';
+export * from './crypto';
+export * from './stark/starkCurve';
+export * from './stark/starkSigner';

package/dist/types/utils/stark/errors.d.ts

@@ -0,0 +1,3 @@
+export declare enum Errors {
+    StarkCurveInvalidMessageLength = "invalid message length"
+}

package/dist/types/utils/stark/getStarkPublicKeyFromImx.d.ts

@@ -0,0 +1,12 @@
+interface StarkUserResponse {
+    starkPublicKey: string;
+    accountNotFound: boolean;
+}
+/**
+ * @description Gets the account (stark public key) value of the requested user
+ * (ethAddress) for Production environment only.
+ * @param ethAddress {string}
+ * @returns {Promise<StarkUserResponse | undefined>}
+ */
+export declare function getStarkPublicKeyFromImx(ethAddress: string): Promise<StarkUserResponse | undefined>;
+export {};

package/dist/types/utils/stark/legacy/crypto/constants.d.ts

@@ -0,0 +1,27 @@
+import BN from 'bn.js';
+import { Instruction, InstructionWithFee } from './types';
+declare const DEFAULT_ACCOUNT_MAPPING_KEY = "STARKWARE_ACCOUNT_MAPPING";
+declare const DEFAULT_SIGNATURE_MESSAGE = "Only sign this request if you\u2019ve initiated an action with Immutable X.";
+declare const DEFAULT_ACCOUNT_LAYER = "starkex";
+declare const DEFAULT_ACCOUNT_APPLICATION = "immutablex";
+declare const DEFAULT_ACCOUNT_INDEX = "1";
+declare const NFT_ASSET_ID_PREFIX = "NFT:";
+declare const MINTABLE_ASSET_ID_PREFIX = "MINTABLE:";
+declare const prime: BN;
+declare const starkEc: any;
+declare const constantPoints: any[];
+declare const shiftPoint: any;
+declare const instructionEncodingMap: {
+    [instruction in Instruction | InstructionWithFee]: BN;
+};
+declare const ZERO_BN: BN;
+declare const ONE_BN: BN;
+declare const TWO_POW_22_BN: BN;
+declare const TWO_POW_31_BN: BN;
+declare const TWO_POW_63_BN: BN;
+declare const PRIME_BN: BN;
+declare const MAX_ECDSA_BN: BN;
+declare const MISSING_HEX_PREFIX = "Hex strings expected to be prefixed with 0x.";
+declare const ORDER: BN;
+declare const SECP_ORDER: BN;
+export { constantPoints, DEFAULT_ACCOUNT_APPLICATION, DEFAULT_ACCOUNT_INDEX, DEFAULT_ACCOUNT_LAYER, DEFAULT_ACCOUNT_MAPPING_KEY, DEFAULT_SIGNATURE_MESSAGE, instructionEncodingMap, MAX_ECDSA_BN, MINTABLE_ASSET_ID_PREFIX, MISSING_HEX_PREFIX, NFT_ASSET_ID_PREFIX, ONE_BN, ORDER, prime, PRIME_BN, SECP_ORDER, shiftPoint, starkEc, TWO_POW_22_BN, TWO_POW_31_BN, TWO_POW_63_BN, ZERO_BN, };

package/dist/types/utils/stark/legacy/crypto/crypto.d.ts

@@ -0,0 +1,14 @@
+import BN from 'bn.js';
+import elliptic from 'elliptic';
+export declare function isHexPrefixed(str: string): boolean;
+export declare function getIntFromBits(hex: string, start: number, end?: number | undefined): number;
+export declare function getAccountPath(layer: string, application: string, ethereumAddress: string, index: string): string;
+export declare function hashKeyWithIndex(key: string, index: number): BN;
+export declare function grindKey(privateKey: string): string;
+export declare function getKeyPair(privateKey: string): elliptic.ec.KeyPair;
+export declare function getPrivateKeyFromPath(seed: string, path: string): string;
+export declare function getPublic(keyPair: elliptic.ec.KeyPair, compressed?: boolean): string;
+export declare function getStarkPublicKey(keyPair: elliptic.ec.KeyPair): string;
+export declare function getKeyPairFromPublicKey(publicKey: string): elliptic.ec.KeyPair;
+export declare function getKeyPairFromPrivateKey(privateKey: string): elliptic.ec.KeyPair;
+export declare function getXCoordinate(publicKey: string): string;

package/dist/types/utils/stark/legacy/crypto/index.d.ts

@@ -0,0 +1,2 @@
+export * from './constants';
+export * from './crypto';

package/dist/types/utils/stark/legacy/crypto/points.d.ts

@@ -0,0 +1 @@
+export declare const constantPointsHex: string[][];

package/dist/types/utils/stark/legacy/crypto/types.d.ts

@@ -0,0 +1,18 @@
+export type Instruction = 'order' | 'transfer' | 'registerUser' | 'deposit' | 'withdraw' | 'cancelOrder';
+export type InstructionWithFee = 'orderWithFee' | 'transferWithFee';
+export type FeeParams = {
+    feeToken: string;
+    feeVault: string;
+    feeLimit: string;
+};
+export type LimitOrderParams = {
+    vaultSell: string;
+    vaultBuy: string;
+    amountSell: string;
+    amountBuy: string;
+    nonce: string;
+    expirationTimestamp: string;
+    tokenSell: string;
+    tokenBuy: string;
+};
+export type LimitOrderWithFeeParams = LimitOrderParams & FeeParams;

package/dist/types/utils/stark/starkCurve.d.ts

@@ -0,0 +1,18 @@
+import BN from 'bn.js';
+import { Signer } from 'ethers';
+export declare const starkEcOrder: BN;
+export declare const starkEc: any;
+export declare function grindKeyV201(keySeed: BN): string;
+export declare function grindKey(keySeed: BN): string;
+export declare function checkIfHashedKeyIsAboveLimit(keySeed: BN): boolean;
+export declare function getPrivateKeyFromPath(seed: string, path: string): BN;
+/**
+ * Generates a new Stark private key
+ * @returns the private key as a hex string
+ */
+export declare function generateStarkPrivateKey(): string;
+/**
+ * Generates a deterministic Stark private key from the provided signer.
+ * @returns the private key as a hex string
+ */
+export declare function generateLegacyStarkPrivateKey(signer: Signer): Promise<string>;

package/dist/types/utils/stark/starkCurve.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/stark/starkSigner.d.ts

@@ -0,0 +1,17 @@
+import { StarkSigner } from '../../types';
+export declare class StandardStarkSigner implements StarkSigner {
+    private privateKey;
+    private keyPair;
+    constructor(privateKey: string);
+    getAddress(): string;
+    signMessage(msg: string): Promise<string>;
+    private serialize;
+    getYCoordinate(): Promise<string>;
+    private fixMsgHashLen;
+}
+/**
+ * Creates a new Stark Signer
+ * @params starkPrivateKey - the private key as a hex string
+ * @returns a StarkSigner
+ */
+export declare function createStarkSigner(starkPrivateKey: string): StarkSigner;

package/dist/types/utils/stark/starkSigner.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/workflows/errors.d.ts

@@ -0,0 +1,3 @@
+export declare enum Errors {
+    StarkCurveInvalidMessageLength = "invalid message length"
+}

package/dist/types/workflows/exchangeTransfers.d.ts

@@ -0,0 +1,8 @@
+import { CreateTransferResponseV1, ExchangesApi } from '../types/api';
+import { UnsignedExchangeTransferRequest, WalletConnection } from '../types';
+type TransfersWorkflowParams = WalletConnection & {
+    request: UnsignedExchangeTransferRequest;
+    exchangesApi: ExchangesApi;
+};
+export declare function exchangeTransfersWorkflow({ ethSigner, starkSigner, request, exchangesApi, }: TransfersWorkflowParams): Promise<CreateTransferResponseV1>;
+export {};

package/dist/types/workflows/index.d.ts

@@ -0,0 +1 @@
+export * from './workflows';

package/dist/types/workflows/minting.d.ts

@@ -0,0 +1,4 @@
+import { Signer } from 'ethers';
+import { MintsApi, MintTokensResponse } from '../types/api';
+import { UnsignedMintRequest } from '../types';
+export declare function mintingWorkflow(signer: Signer, request: UnsignedMintRequest, mintsApi: MintsApi): Promise<MintTokensResponse>;

package/dist/types/workflows/orders.d.ts

@@ -0,0 +1,13 @@
+import { CancelOrderResponse, CreateOrderResponse, GetSignableCancelOrderRequest, OrdersApi } from '../types/api';
+import { UnsignedOrderRequest, WalletConnection } from '../types';
+type CreateOrderWorkflowParams = WalletConnection & {
+    request: UnsignedOrderRequest;
+    ordersApi: OrdersApi;
+};
+type CancelOrderWorkflowParams = WalletConnection & {
+    request: GetSignableCancelOrderRequest;
+    ordersApi: OrdersApi;
+};
+export declare function createOrderWorkflow({ ethSigner, starkSigner, request, ordersApi, }: CreateOrderWorkflowParams): Promise<CreateOrderResponse>;
+export declare function cancelOrderWorkflow({ ethSigner, starkSigner, request, ordersApi, }: CancelOrderWorkflowParams): Promise<CancelOrderResponse>;
+export {};

package/dist/types/workflows/trades.d.ts

@@ -0,0 +1,8 @@
+import { CreateTradeResponse, GetSignableTradeRequest, TradesApi } from '../types/api';
+import { WalletConnection } from '../types';
+type createTradeWorkflowParams = WalletConnection & {
+    request: GetSignableTradeRequest;
+    tradesApi: TradesApi;
+};
+export declare function createTradeWorkflow({ ethSigner, starkSigner, request, tradesApi, }: createTradeWorkflowParams): Promise<CreateTradeResponse>;
+export {};

package/dist/types/workflows/workflows.d.ts

@@ -0,0 +1,29 @@
+import { AxiosResponse } from 'axios';
+import { Signer } from 'ethers';
+import { CollectionsApi, ExchangesApi, ProjectsApi, MetadataApi, MetadataRefreshesApi, MintsApi, CreateCollectionRequest, UpdateCollectionRequest, AddMetadataSchemaToCollectionRequest, CreateMetadataRefreshRequest, MetadataSchemaRequest, Project, Collection, SuccessResponse, GetMetadataRefreshes, GetMetadataRefreshErrorsResponse, GetMetadataRefreshResponse, CreateMetadataRefreshResponse } from '../types/api';
+import { UnsignedMintRequest, WalletConnection, EthSigner, UnsignedExchangeTransferRequest } from '../types';
+import { ImmutableXConfiguration } from '../config';
+export declare class Workflows {
+    protected config: ImmutableXConfiguration;
+    private readonly mintsApi;
+    private readonly projectsApi;
+    private readonly collectionsApi;
+    private readonly metadataApi;
+    private readonly metadataRefreshesApi;
+    private readonly exchangesApi;
+    private isChainValid;
+    constructor(config: ImmutableXConfiguration, collectionsApi: CollectionsApi, exchangesApi: ExchangesApi, metadataApi: MetadataApi, metadataRefreshesApi: MetadataRefreshesApi, mintsApi: MintsApi, projectsApi: ProjectsApi);
+    private validateChain;
+    private getStarkExContractVersion;
+    mint(signer: Signer, request: UnsignedMintRequest): Promise<import("..").MintTokensResponse>;
+    exchangeTransfer(walletConnection: WalletConnection, request: UnsignedExchangeTransferRequest): Promise<import("..").CreateTransferResponseV1>;
+    getProject(ethSigner: EthSigner, id: string): Promise<AxiosResponse<Project, any>>;
+    createCollection(ethSigner: EthSigner, createCollectionRequest: CreateCollectionRequest): Promise<AxiosResponse<Collection, any>>;
+    updateCollection(ethSigner: EthSigner, address: string, updateCollectionRequest: UpdateCollectionRequest): Promise<AxiosResponse<Collection, any>>;
+    addMetadataSchemaToCollection(ethSigner: EthSigner, address: string, addMetadataSchemaToCollectionRequest: AddMetadataSchemaToCollectionRequest): Promise<AxiosResponse<SuccessResponse, any>>;
+    updateMetadataSchemaByName(ethSigner: EthSigner, address: string, name: string, metadataSchemaRequest: MetadataSchemaRequest): Promise<AxiosResponse<SuccessResponse, any>>;
+    listMetadataRefreshes(ethSigner: EthSigner, collectionAddress?: string, pageSize?: number, cursor?: string): Promise<AxiosResponse<GetMetadataRefreshes, any>>;
+    getMetadataRefreshErrors(ethSigner: EthSigner, refreshId: string, pageSize?: number, cursor?: string): Promise<AxiosResponse<GetMetadataRefreshErrorsResponse, any>>;
+    getMetadataRefreshResults(ethSigner: EthSigner, refreshId: string): Promise<AxiosResponse<GetMetadataRefreshResponse, any>>;
+    createMetadataRefresh(ethSigner: EthSigner, request: CreateMetadataRefreshRequest): Promise<AxiosResponse<CreateMetadataRefreshResponse, any>>;
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@imtbl/x-client",
+  "description": "Immutable X Client for Immutable SDK",
+  "version": "2.0.0-alpha.0",
+  "author": "Immutable",
+  "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
+  "dependencies": {
+    "@ethereumjs/wallet": "^2.0.4",
+    "@imtbl/config": "2.0.0-alpha.0",
+    "@imtbl/generated-clients": "2.0.0-alpha.0",
+    "axios": "^1.6.5",
+    "bn.js": "^5.2.1",
+    "elliptic": "^6.5.7",
+    "enc-utils": "^3.0.0",
+    "ethers": "^6.13.4",
+    "hash.js": "^1.1.7"
+  },
+  "devDependencies": {
+    "@swc/core": "^1.3.36",
+    "@swc/jest": "^0.2.24",
+    "@types/bn.js": "^5.1.6",
+    "@types/jest": "^29.4.3",
+    "crypto": "^1.0.1",
+    "eslint": "^8.40.0",
+    "jest": "^29.4.3",
+    "jest-environment-jsdom": "^29.4.3",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.2"
+  },
+  "engines": {
+    "node": ">=20.11.0"
+  },
+  "exports": {
+    "development": {
+      "types": "./src/index.ts",
+      "browser": "./dist/browser/index.js",
+      "require": "./dist/node/index.cjs",
+      "default": "./dist/node/index.js"
+    },
+    "default": {
+      "types": "./dist/types/index.d.ts",
+      "browser": "./dist/browser/index.js",
+      "require": "./dist/node/index.cjs",
+      "default": "./dist/node/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/immutable/ts-immutable-sdk#readme",
+  "license": "Apache-2.0",
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "browser": "dist/browser/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "immutable/ts-immutable-sdk.git",
+  "type": "module",
+  "types": "./dist/types/index.d.ts",
+  "scripts": {
+    "build": "pnpm transpile && pnpm typegen",
+    "transpile": "tsup src/index.ts --config ../../tsup.config.js",
+    "typegen": "tsc --customConditions default --emitDeclarationOnly --outDir dist/types",
+    "lint": "eslint ./src --ext .ts,.jsx,.tsx --max-warnings=0",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "typecheck": "tsc --customConditions default --noEmit --jsx preserve"
+  }
+}