@imtbl/sdk 0.0.1-alpha

package/dist/passport.d.ts

@@ -0,0 +1,736 @@
+declare enum PassportErrorType {
+    AUTHENTICATION_ERROR = "AUTHENTICATION_ERROR",
+    INVALID_CONFIGURATION = "INVALID_CONFIGURATION",
+    WALLET_CONNECTION_ERROR = "WALLET_CONNECTION_ERROR",
+    NOT_LOGGED_IN_ERROR = "NOT_LOGGED_IN_ERROR",
+    REFRESH_TOKEN_ERROR = "REFRESH_TOKEN_ERROR",
+    USER_REGISTRATION_ERROR = "USER_REGISTRATION_ERROR",
+    LOGOUT_ERROR = "LOGOUT_ERROR",
+    TRANSFER_ERROR = "TRANSFER_ERROR",
+    CREATE_ORDER_ERROR = "CREATE_ORDER_ERROR",
+    CANCEL_ORDER_ERROR = "CANCEL_ORDER_ERROR",
+    EXCHANGE_TRANSFER_ERROR = "EXCHANGE_TRANSFER_ERROR",
+    CREATE_TRADE_ERROR = "CREATE_TRADE_ERROR",
+    OPERATION_NOT_SUPPORTED_ERROR = "OPERATION_NOT_SUPPORTED_ERROR"
+}
+declare class PassportError extends Error {
+    type: PassportErrorType;
+    constructor(message: string, type: PassportErrorType);
+}
+
+declare type Bytes = ArrayLike<number>;
+interface Hexable {
+    toHexString(): string;
+}
+
+declare type BigNumberish = BigNumber | Bytes | bigint | string | number;
+declare class BigNumber implements Hexable {
+    readonly _hex: string;
+    readonly _isBigNumber: boolean;
+    constructor(constructorGuard: any, hex: string);
+    fromTwos(value: number): BigNumber;
+    toTwos(value: number): BigNumber;
+    abs(): BigNumber;
+    add(other: BigNumberish): BigNumber;
+    sub(other: BigNumberish): BigNumber;
+    div(other: BigNumberish): BigNumber;
+    mul(other: BigNumberish): BigNumber;
+    mod(other: BigNumberish): BigNumber;
+    pow(other: BigNumberish): BigNumber;
+    and(other: BigNumberish): BigNumber;
+    or(other: BigNumberish): BigNumber;
+    xor(other: BigNumberish): BigNumber;
+    mask(value: number): BigNumber;
+    shl(value: number): BigNumber;
+    shr(value: number): BigNumber;
+    eq(other: BigNumberish): boolean;
+    lt(other: BigNumberish): boolean;
+    lte(other: BigNumberish): boolean;
+    gt(other: BigNumberish): boolean;
+    gte(other: BigNumberish): boolean;
+    isNegative(): boolean;
+    isZero(): boolean;
+    toNumber(): number;
+    toBigInt(): bigint;
+    toString(): string;
+    toHexString(): string;
+    toJSON(key?: string): any;
+    static from(value: any): BigNumber;
+    static isBigNumber(value: any): value is BigNumber;
+}
+
+declare type AccessList = Array<{
+    address: string;
+    storageKeys: Array<string>;
+}>;
+interface Transaction {
+    hash?: string;
+    to?: string;
+    from?: string;
+    nonce: number;
+    gasLimit: BigNumber;
+    gasPrice?: BigNumber;
+    data: string;
+    value: BigNumber;
+    chainId: number;
+    r?: string;
+    s?: string;
+    v?: number;
+    type?: number | null;
+    accessList?: AccessList;
+    maxPriorityFeePerGas?: BigNumber;
+    maxFeePerGas?: BigNumber;
+}
+
+interface TransactionResponse extends Transaction {
+    hash: string;
+    blockNumber?: number;
+    blockHash?: string;
+    timestamp?: number;
+    confirmations: number;
+    from: string;
+    raw?: string;
+    wait: (confirmations?: number) => Promise<TransactionReceipt>;
+}
+interface Log {
+    blockNumber: number;
+    blockHash: string;
+    transactionIndex: number;
+    removed: boolean;
+    address: string;
+    data: string;
+    topics: Array<string>;
+    transactionHash: string;
+    logIndex: number;
+}
+interface TransactionReceipt {
+    to: string;
+    from: string;
+    contractAddress: string;
+    transactionIndex: number;
+    root?: string;
+    gasUsed: BigNumber;
+    logsBloom: string;
+    blockHash: string;
+    transactionHash: string;
+    logs: Array<Log>;
+    blockNumber: number;
+    confirmations: number;
+    cumulativeGasUsed: BigNumber;
+    effectiveGasPrice: BigNumber;
+    byzantium: boolean;
+    type: number;
+    status?: number;
+}
+
+/**
+ * An ERC20 token
+ */
+interface ERC20Token {
+    type: 'ERC20';
+    tokenAddress: string;
+}
+/**
+ * An ERC721 token
+ */
+interface ERC721Token {
+    type: 'ERC721';
+    tokenId: string;
+    tokenAddress: string;
+}
+/**
+ * An ETH token
+ */
+interface ETHToken {
+    type: 'ETH';
+}
+/**
+ * An amount of ETH token of unit Wei
+ */
+interface ETHAmount extends ETHToken {
+    /**
+     * An amount in unit Wei
+     */
+    amount: string;
+}
+/**
+ * The token details and amount of ERC20 token units
+ */
+interface ERC20Amount extends ERC20Token {
+    /**
+     * An amount in units for the given ERC20 token
+     */
+    amount: string;
+}
+/**
+ * Union type that represents all token types
+ */
+declare type AnyToken = ETHToken | ERC721Token | ERC20Token;
+/**
+ * Union type that represents all token type amounts
+ */
+declare type TokenAmount = ETHAmount | ERC20Amount | ERC721Token;
+/**
+ * Union type that represents exchange token type amounts
+ */
+declare type ExchangeTokenAmount = ETHAmount | ERC20Amount;
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CancelOrderResponse
+ */
+interface CancelOrderResponse {
+    /**
+     * ID of the cancelled order
+     * @type {number}
+     * @memberof CancelOrderResponse
+     */
+    'order_id': number;
+    /**
+     * New status of the order
+     * @type {string}
+     * @memberof CancelOrderResponse
+     */
+    'status': string;
+}
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface FeeEntry
+ */
+interface FeeEntry {
+    /**
+     *
+     * @type {string}
+     * @memberof FeeEntry
+     */
+    'address'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof FeeEntry
+     */
+    'fee_percentage'?: number;
+}
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateOrderResponse
+ */
+interface CreateOrderResponse {
+    /**
+     * ID of the created order
+     * @type {number}
+     * @memberof CreateOrderResponse
+     */
+    'order_id': number;
+    /**
+     * Request ID as a reference for an asynchronous order creation request
+     * @type {string}
+     * @memberof CreateOrderResponse
+     */
+    'request_id'?: string;
+    /**
+     * Status of the created order
+     * @type {string}
+     * @memberof CreateOrderResponse
+     */
+    'status': string;
+    /**
+     * Timestamp of the created order
+     * @type {number}
+     * @memberof CreateOrderResponse
+     */
+    'time': number;
+}
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateTradeResponse
+ */
+interface CreateTradeResponse {
+    /**
+     * Request ID as a reference for an asynchronous trade creation request
+     * @type {string}
+     * @memberof CreateTradeResponse
+     */
+    'request_id'?: string;
+    /**
+     * Current status of trade
+     * @type {string}
+     * @memberof CreateTradeResponse
+     */
+    'status': string;
+    /**
+     * ID of trade within Immutable X
+     * @type {number}
+     * @memberof CreateTradeResponse
+     */
+    'trade_id': number;
+}
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateTransferResponse
+ */
+interface CreateTransferResponse {
+    /**
+     * List of transfer IDs
+     * @type {Array<number>}
+     * @memberof CreateTransferResponse
+     */
+    'transfer_ids': Array<number>;
+}
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateTransferResponseV1
+ */
+interface CreateTransferResponseV1 {
+    /**
+     * [deprecated] Sent signature
+     * @type {string}
+     * @memberof CreateTransferResponseV1
+     */
+    'sent_signature': string;
+    /**
+     * [deprecated] The status of transfer
+     * @type {string}
+     * @memberof CreateTransferResponseV1
+     */
+    'status': string;
+    /**
+     * [deprecated] Time of the transfer
+     * @type {number}
+     * @memberof CreateTransferResponseV1
+     */
+    'time': number;
+    /**
+     * ID of the transfer
+     * @type {number}
+     * @memberof CreateTransferResponseV1
+     */
+    'transfer_id': number;
+}
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateWithdrawalResponse
+ */
+interface CreateWithdrawalResponse {
+    /**
+     * Status of the withdrawal
+     * @type {string}
+     * @memberof CreateWithdrawalResponse
+     */
+    'status': string;
+    /**
+     * Time of the withdrawal
+     * @type {number}
+     * @memberof CreateWithdrawalResponse
+     */
+    'time': number;
+    /**
+     * ID of the withdrawal
+     * @type {number}
+     * @memberof CreateWithdrawalResponse
+     */
+    'withdrawal_id': number;
+}
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetSignableCancelOrderRequest
+ */
+interface GetSignableCancelOrderRequest {
+    /**
+     * ID of the order to be cancelled
+     * @type {number}
+     * @memberof GetSignableCancelOrderRequest
+     */
+    'order_id': number;
+}
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface GetSignableTradeRequest
+ */
+interface GetSignableTradeRequest {
+    /**
+     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     * @type {number}
+     * @memberof GetSignableTradeRequest
+     */
+    'expiration_timestamp'?: number;
+    /**
+     * Inclusion of either maker or taker fees
+     * @type {Array<FeeEntry>}
+     * @memberof GetSignableTradeRequest
+     */
+    'fees'?: Array<FeeEntry>;
+    /**
+     * The ID of the maker order involved
+     * @type {number}
+     * @memberof GetSignableTradeRequest
+     */
+    'order_id': number;
+    /**
+     * Ethereum address of the submitting user
+     * @type {string}
+     * @memberof GetSignableTradeRequest
+     */
+    'user': string;
+}
+
+/**
+ * Immutable X API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 3.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface RegisterUserResponse
+ */
+interface RegisterUserResponse {
+    /**
+     * Immutable signature authorising registration
+     * @type {string}
+     * @memberof RegisterUserResponse
+     */
+    'tx_hash': string;
+}
+
+/**
+ * Parameter required to create an Order
+ */
+interface UnsignedOrderRequest {
+    /**
+     * The amount of tokens that will be bought for this order
+     */
+    buy: TokenAmount;
+    /**
+     * The amount of tokens that will be sold for this order
+     */
+    sell: TokenAmount;
+    /**
+     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     */
+    expiration_timestamp?: number;
+    /**
+     * Inclusion of either maker or taker fees
+     */
+    fees?: Array<FeeEntry>;
+}
+/**
+ * Parameter required to create a Transfer
+ */
+declare type UnsignedTransferRequest = TokenAmount & {
+    /**
+     * Ethereum address of the receiving user
+     */
+    receiver: string;
+};
+/**
+ * Parameter required to create a Transfer
+ */
+declare type UnsignedExchangeTransferRequest = ExchangeTokenAmount & {
+    /**
+     * Ethereum address of the receiving user
+     */
+    receiver: string;
+    /**
+     * Exchange transaction ID
+     */
+    transactionID: string;
+};
+
+/**
+ * Parameter required to create a batchNftTransfer
+ */
+interface NftTransferDetails {
+    /**
+     * Ethereum address of the receiving user
+     */
+    receiver: string;
+    /**
+     * The token ID
+     */
+    tokenId: string;
+    /**
+     * The token contract address
+     */
+    tokenAddress: string;
+}
+
+interface IMXProvider {
+    /**
+     * Get the Signer address
+     *
+     * @return {Promise<string>} Returns a promise that resolves with the signer's address
+     */
+    getAddress(): Promise<string>;
+    /**
+     * Register a User to Immutable X if they are not already registered
+     *
+     * @return {Promise<RegisterUserResponse>} Returns a promise that resolves with the user registration response
+     */
+    registerOffchain(): Promise<RegisterUserResponse>;
+    /**
+     * Checks if a User is registered on-chain
+     *
+     * @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered, false otherwise
+     */
+    isRegisteredOnchain(): Promise<boolean>;
+    /**
+     * Create an Order
+     *
+     * @param {UnsignedOrderRequest} request The unsigned order request to create an order
+     * @return {Promise<CreateOrderResponse>} Returns a promise that resolves with the created Order
+     */
+    createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse>;
+    /**
+     * Cancel an Order
+     *
+     * @param {GetSignableCancelOrderRequest} request The signable cancel order request
+     * @return {Promise<CancelOrderResponse>} Returns a promise that resolves with the cancelled Order
+     */
+    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
+    /**
+     * Create a Trade
+     *
+     * @param {GetSignableTradeRequest} request The signable trade request
+     * @return {Promise<CreateTradeResponse>} Returns a promise that resolves with the created Trade
+     */
+    createTrade(request: GetSignableTradeRequest): Promise<CreateTradeResponse>;
+    /**
+     * Create a new Transfer request
+     *
+     * @param {UnsignedTransferRequest} request The unsigned transfer request
+     * @return {Promise<CreateTransferResponseV1>} Returns a promise that resolves with the created Transfer
+     */
+    transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1>;
+    /**
+     * Create a batch of NFT transfer requests
+     *
+     * @param {Array<NftTransferDetails>} request An array of NFT transfer details
+     * @return {Promise<CreateTransferResponse>} Resolves a promise that resolves with the list of Transfer IDs
+     */
+    batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
+    /**
+     * Create a new Exchange transaction
+     *
+     * @param {UnsignedExchangeTransferRequest} request The unsigned exchange transfer request
+     * @return {Promise<CreateTransferResponseV1>} Returns a promise that resolves with the created Exchange Transaction
+     */
+    exchangeTransfer(request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1>;
+    /**
+     * Deposit either ETH, ERC20 or ERC721 tokens
+     *
+     * @param {TokenAmount} request The token type amount in its corresponding unit
+     * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
+     */
+    deposit(deposit: TokenAmount): Promise<TransactionResponse>;
+    /**
+     * Create a Withdrawal
+     *
+     * @param {TokenAmount} request The token type amount in its corresponding unit
+     * @return {Promise<CreateWithdrawalResponse>} Returns a promise that resolves with the created Withdrawal
+     */
+    prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse>;
+    /**
+     * Completes a Withdrawal
+     *
+     * @param {string} starkPublicKey The stark public key
+     * @param {AnyToken} token The token to withdraw
+     * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
+     */
+    completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
+}
+
+declare enum Environment {
+    PRODUCTION = "production",
+    SANDBOX = "sandbox"
+}
+declare class ImmutableConfiguration {
+    readonly environment: Environment;
+    readonly apiKey?: string;
+    constructor(options: {
+        environment: Environment;
+        apiKey?: string;
+    });
+}
+interface ModuleConfiguration<T> {
+    baseConfig: ImmutableConfiguration;
+    overrides?: T;
+}
+
+type UserProfile = {
+    email?: string;
+    nickname?: string;
+    sub: string;
+};
+declare enum Networks {
+    PRODUCTION = "mainnet",
+    SANDBOX = "goerli"
+}
+interface OidcConfiguration {
+    clientId: string;
+    logoutRedirectUri: string;
+    redirectUri: string;
+    scope?: string;
+    audience?: string;
+}
+interface PassportOverrides {
+    network: Networks;
+    authenticationDomain: string;
+    magicPublishableApiKey: string;
+    magicProviderId: string;
+    passportDomain: string;
+    imxApiBasePath: string;
+}
+interface PassportModuleConfiguration extends ModuleConfiguration<PassportOverrides>, OidcConfiguration {
+}
+
+declare class Passport {
+    private authManager;
+    private magicAdapter;
+    private readonly config;
+    constructor(passportModuleConfiguration: PassportModuleConfiguration);
+    connectImx(): Promise<IMXProvider>;
+    loginCallback(): Promise<void>;
+    logout(): Promise<void>;
+    getUserInfo(): Promise<UserProfile>;
+    getIdToken(): Promise<string | undefined>;
+    getAccessToken(): Promise<string>;
+    private registerUser;
+}
+
+declare class PassportConfiguration {
+    readonly network: Networks;
+    readonly authenticationDomain: string;
+    readonly passportDomain: string;
+    readonly magicPublishableApiKey: string;
+    readonly magicProviderId: string;
+    readonly imxApiBasePath: string;
+    readonly oidcConfiguration: OidcConfiguration;
+    readonly baseConfig: ImmutableConfiguration;
+    constructor({ baseConfig, overrides, ...oidcConfiguration }: PassportModuleConfiguration);
+}
+
+export { Passport, PassportConfiguration, PassportError };