@imtbl/core-sdk - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1-alpha.1

dist/hardhat.config.d.ts

@@ -0,0 +0,0 @@ import { HardhatUserConfig } from 'hardhat/config';

dist/src/api/api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/base.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/common.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/configuration.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/assets-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/balances-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/collections-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/deposits-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/encoding-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/metadata-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/mints-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/orders-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/projects-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/tokens-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/trades-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/transfers-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/users-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/domain/withdrawals-api.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/index.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/add-metadata-schema-to-collection-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/asset-properties.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/asset.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/balance.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/cancel-order-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/cancel-order-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/collection-details.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/collection-filter.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/collection.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-collection-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-order-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-order-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-project-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-project-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-trade-request-v1.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-trade-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-transfer-request-v1.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-transfer-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-transfer-response-v1.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-transfer-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-withdrawal-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/create-withdrawal-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/deposit.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/encode-asset-request-token.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/encode-asset-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/encode-asset-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/encode-asset-token-data.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/fee-data.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/fee-entry.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/fee-info.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/fee-token.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/fee.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-projects-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-cancel-order-request.d.ts

@@ -23,3 +23,3 @@ /**
      */
-    'order_id'?: number;
+    'order_id': number;
 }

dist/src/api/models/get-signable-cancel-order-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-deposit-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-deposit-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-order-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-order-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-registration-offchain-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-registration-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-registration-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-trade-request.d.ts

@@ -36,3 +36,3 @@ /**
      */
-    'order_id'?: number;
+    'order_id': number;
     /**
@@ -39,0 +39,0 @@ * Ethereum address of the submitting user

dist/src/api/models/get-signable-trade-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-transfer-request-v1.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-transfer-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-transfer-response-v1.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-transfer-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-withdrawal-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-signable-withdrawal-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/get-users-api-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/index.d.ts

@@ -0,0 +0,0 @@ export * from './add-metadata-schema-to-collection-request';

dist/src/api/models/list-assets-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/list-balances-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/list-collections-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/list-deposits-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/list-mints-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/list-orders-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/list-tokens-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/list-trades-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/list-transfers-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/list-withdrawals-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/metadata-schema-property.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/metadata-schema-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/mint-fee.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/mint-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/mint-result-details.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/mint-token-data-v2.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/mint-tokens-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/mint-user.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/mint.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/mintable-token-details.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/order-details.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/order-fee-info.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/order.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/project.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/range.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/register-user-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/register-user-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/signable-token.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/signable-transfer-details.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/signable-transfer-response-details.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/success-response.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/token-data.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/token-details.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/token.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/trade-side.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/trade.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/transfer-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/transfer.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/update-collection-request.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/api/models/withdrawal.d.ts

@@ -0,0 +0,0 @@ /**

dist/src/contracts/@openzeppelin/contracts/index.d.ts

@@ -0,0 +0,0 @@ import type * as token from "./token";

dist/src/contracts/@openzeppelin/contracts/token/ERC20/IERC20.d.ts

@@ -0,0 +0,0 @@ import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PopulatedTransaction, Signer, utils } from "ethers";

dist/src/contracts/@openzeppelin/contracts/token/ERC20/index.d.ts

 export type { IERC20 } from "./IERC20";

dist/src/contracts/@openzeppelin/contracts/token/ERC721/IERC721.d.ts

@@ -0,0 +0,0 @@ import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PopulatedTransaction, Signer, utils } from "ethers";

dist/src/contracts/@openzeppelin/contracts/token/ERC721/index.d.ts

 export type { IERC721 } from "./IERC721";

dist/src/contracts/@openzeppelin/contracts/token/index.d.ts

@@ -0,0 +0,0 @@ import type * as erc20 from "./ERC20";

dist/src/contracts/@openzeppelin/contracts/utils/index.d.ts

 import type * as introspection from "./introspection";
 export type { introspection };

dist/src/contracts/@openzeppelin/contracts/utils/introspection/IERC165.d.ts

@@ -0,0 +0,0 @@ import type { BaseContract, BigNumber, BytesLike, CallOverrides, PopulatedTransaction, Signer, utils } from "ethers";

dist/src/contracts/@openzeppelin/contracts/utils/introspection/index.d.ts

 export type { IERC165 } from "./IERC165";

dist/src/contracts/@openzeppelin/index.d.ts

 import type * as contracts from "./contracts";
 export type { contracts };

dist/src/contracts/common.d.ts

@@ -0,0 +0,0 @@ import type { Listener } from "@ethersproject/providers";

dist/src/contracts/contracts/index.d.ts

 export type { Core } from "./Core";
 export type { Registration } from "./Registration";

dist/src/contracts/contracts/Registration.d.ts

@@ -0,0 +0,0 @@ import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PopulatedTransaction, Signer, utils } from "ethers";

dist/src/contracts/factories/@openzeppelin/contracts/index.d.ts

 export * as token from "./token";
 export * as utils from "./utils";

dist/src/contracts/factories/@openzeppelin/contracts/token/ERC20/IERC20__factory.d.ts

@@ -0,0 +0,0 @@ import { Signer } from "ethers";

dist/src/contracts/factories/@openzeppelin/contracts/token/ERC20/index.d.ts

 export { IERC20__factory } from "./IERC20__factory";

dist/src/contracts/factories/@openzeppelin/contracts/token/ERC721/IERC721__factory.d.ts

@@ -0,0 +0,0 @@ import { Signer } from "ethers";

dist/src/contracts/factories/@openzeppelin/contracts/token/ERC721/index.d.ts

 export { IERC721__factory } from "./IERC721__factory";

dist/src/contracts/factories/@openzeppelin/contracts/token/index.d.ts

 export * as erc20 from "./ERC20";
 export * as erc721 from "./ERC721";

dist/src/contracts/factories/@openzeppelin/contracts/utils/index.d.ts

 export * as introspection from "./introspection";

dist/src/contracts/factories/@openzeppelin/contracts/utils/introspection/IERC165__factory.d.ts

@@ -0,0 +0,0 @@ import { Signer } from "ethers";

dist/src/contracts/factories/@openzeppelin/contracts/utils/introspection/index.d.ts

 export { IERC165__factory } from "./IERC165__factory";

dist/src/contracts/factories/@openzeppelin/index.d.ts

 export * as contracts from "./contracts";

dist/src/contracts/factories/contracts/Core__factory.d.ts

@@ -0,0 +0,0 @@ import { Signer } from "ethers";

dist/src/contracts/factories/contracts/index.d.ts

 export { Core__factory } from "./Core__factory";
 export { Registration__factory } from "./Registration__factory";

dist/src/contracts/factories/contracts/Registration__factory.d.ts

@@ -0,0 +0,0 @@ import { Signer, ContractFactory, Overrides } from "ethers";

dist/src/contracts/factories/index.d.ts

 export * as openzeppelin from "./@openzeppelin";
 export * as contracts from "./contracts";

dist/src/contracts/index.d.ts

@@ -0,0 +0,0 @@ import type * as openzeppelin from "./@openzeppelin";

dist/src/index.d.ts

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

dist/src/types/deposit.d.ts

@@ -0,0 +0,0 @@ import { TokenType } from './token';

dist/src/types/index.d.ts

@@ -0,0 +0,0 @@ import { ec } from 'elliptic';

dist/src/types/signable-withdrawal.d.ts

@@ -0,0 +0,0 @@ import { TokenPrepareWithdrawal } from './withdrawal';

dist/src/types/token.d.ts

@@ -0,0 +0,0 @@ export declare enum TokenType {

dist/src/types/withdrawal.d.ts

@@ -0,0 +0,0 @@ import { TokenType } from './token';

dist/src/utils/config.d.ts

 import { ConfigurationParameters } from '../api';
 import { Config, EthNetwork } from '../types';
 export declare const getConfig: (network?: EthNetwork, apiConfigOptions?: ConfigurationParameters) => Config;

dist/src/utils/crypto/constants.d.ts

@@ -0,0 +0,0 @@ import BN from 'bn.js';

dist/src/utils/crypto/crypto.d.ts

@@ -0,0 +0,0 @@ import BN from 'bn.js';

dist/src/utils/crypto/crypto.test.d.ts

 export {};

dist/src/utils/index.d.ts

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

dist/src/utils/stark/points.d.ts

 export declare const constantPointsHex: string[][];

dist/src/utils/stark/stark-curve.d.ts

@@ -0,0 +0,0 @@ import { ec } from 'elliptic';

dist/src/utils/stark/stark-key.d.ts

@@ -0,0 +0,0 @@ import { ec } from 'elliptic';

dist/src/utils/stark/stark-key.test.d.ts

 export {};

dist/src/workflows/burn.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/constants.d.ts

 export declare enum BurnAddress {
     BurnEthAddress = "0x0000000000000000000000000000000000000000"
 }

dist/src/workflows/deposit/depositERC20.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/deposit/depositERC721.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/deposit/depositEth.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/deposit/index.d.ts

 export * from './depositEth';
 export * from './depositERC20';
 export * from './depositERC721';

dist/src/workflows/errors.d.ts

 export declare enum Errors {
     StarkCurveInvalidMessageLength = "invalid message length"
 }

dist/src/workflows/index.d.ts

 export * from './workflows';

dist/src/workflows/minting.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/orders.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/registration.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/trades.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/transfers.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/types.d.ts

@@ -0,0 +0,0 @@ import { SignableToken } from '../api';

dist/src/workflows/withdrawal/completeERC20Withdrawal.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/withdrawal/completeERC721Withdrawal.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/withdrawal/completeEthWithdrawal.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/withdrawal/getEncodeAssetInfo.d.ts

 import { EncodeAssetRequestTokenTypeEnum, EncodeAssetResponse, EncodingApi } from '../../api';
 export declare function getEncodeAssetInfo(assetType: string, tokenType: EncodeAssetRequestTokenTypeEnum, encodingApi: EncodingApi, tokenData?: any): Promise<EncodeAssetResponse>;

dist/src/workflows/withdrawal/index.d.ts

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

dist/src/workflows/withdrawal/prepareWithdrawal.d.ts

@@ -0,0 +0,0 @@ import { Signer } from '@ethersproject/abstract-signer';

dist/src/workflows/workflows.d.ts

@@ -0,0 +0,0 @@ import { TransfersApiGetTransferRequest, GetSignableOrderRequest, GetSignableCancelOrderRequest, GetSignableTradeRequest } from '../api';

package.json

 {
   "name": "@imtbl/core-sdk",
-  "version": "0.2.0",
+  "version": "0.2.1-alpha.1",
   "description": "Immutable Core SDK",
@@ -22,2 +22,3 @@ "main": "dist/index.cjs.js",
     "release": "release-it",
+    "typecheck": "tsc --noEmit",
     "lint": "eslint ./src/utils/** ./src/workflows/**",
@@ -41,2 +42,3 @@ "lint-fix": "eslint ./src/utils/** ./src/workflows/** --fix"
     "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-typescript": "^8.3.2",
     "@typechain/ethers-v5": "^10.0.0",
@@ -60,3 +62,2 @@ "@typechain/hardhat": "^6.0.0",
     "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-typescript2": "^0.31.2",
     "ts-jest": "^27.1.4",
@@ -63,0 +64,0 @@ "ts-node": "^10.7.0",

README.md

 <div align="center">
-  <br>
-  <br>
-  <a  href="https://docs.x.immutable.com/docs">
-    <img src="images/imx-logo.png">
-  </a>
-  <br>
-  <br>
+  <p align="center">
+    <a  href="https://docs.x.immutable.com/docs">
+      <img src="https://cdn.dribbble.com/users/1299339/screenshots/7133657/media/837237d447d36581ebd59ec36d30daea.gif" width="280"/>
+    </a>
+  </p>
 </div>
@@ -321,5 +319,5 @@
 ```json
-...
+
 "version": "0.3.0",
-...
+
 ```
@@ -357,1 +355,8 @@
 [Contact support](https://support.immutable.com/hc/en-us/requests/new)
+
+## Webpack 5
+
+Webpack 5 no longer uses NodeJS polyfills, such as `crypto`, which in turn breaks the Core SDK resulting in errors such as
+`Module not found: Error: Can't resolve 'crypto'`.
+
+To fix this, you can use a webpack polyfill plugin like [node-polyfill-webpack-plugin](https://www.npmjs.com/package/node-polyfill-webpack-plugin), or if you're using `create-react-app` in your project which hides the Webpack config, [this blog post](https://alchemy.com/blog/how-to-polyfill-node-core-modules-in-webpack-5) explains how to add polyfills to your CRA project.

No alert changes

Improved metrics

Number of lines in readme file

361

increased by1.4%

Worsened metrics

Total package byte prevSize

4432995

decreased by-0.22%

No dependency changes