@imtbl/sdk 0.21.0 → 0.22.0

package/dist/erc721_mint_by_id.d.ts

@@ -1,521 +0,0 @@
-declare type Bytes = ArrayLike<number>;
-declare type BytesLike = Bytes | string;
-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 Deferrable<T> = {
-    [K in keyof T]: T[K] | Promise<T[K]>;
-};
-declare class Description<T = any> {
-    constructor(info: {
-        [K in keyof T]: T[K];
-    });
-}
-
-declare type Network = {
-    name: string;
-    chainId: number;
-    ensAddress?: string;
-    _defaultProvider?: (providers: any, options?: any) => any;
-};
-
-declare type AccessList = Array<{
-    address: string;
-    storageKeys: Array<string>;
-}>;
-declare type AccessListish = AccessList | Array<[string, Array<string>]> | Record<string, 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 OnceBlockable {
-    once(eventName: "block", handler: () => void): void;
-}
-
-declare type TransactionRequest = {
-    to?: string;
-    from?: string;
-    nonce?: BigNumberish;
-    gasLimit?: BigNumberish;
-    gasPrice?: BigNumberish;
-    data?: BytesLike;
-    value?: BigNumberish;
-    chainId?: number;
-    type?: number;
-    accessList?: AccessListish;
-    maxPriorityFeePerGas?: BigNumberish;
-    maxFeePerGas?: BigNumberish;
-    customData?: Record<string, any>;
-    ccipReadEnabled?: boolean;
-};
-interface TransactionResponse extends Transaction {
-    hash: string;
-    blockNumber?: number;
-    blockHash?: string;
-    timestamp?: number;
-    confirmations: number;
-    from: string;
-    raw?: string;
-    wait: (confirmations?: number) => Promise<TransactionReceipt>;
-}
-declare type BlockTag = string | number;
-interface _Block {
-    hash: string;
-    parentHash: string;
-    number: number;
-    timestamp: number;
-    nonce: string;
-    difficulty: number;
-    _difficulty: BigNumber;
-    gasLimit: BigNumber;
-    gasUsed: BigNumber;
-    miner: string;
-    extraData: string;
-    baseFeePerGas?: null | BigNumber;
-}
-interface Block extends _Block {
-    transactions: Array<string>;
-}
-interface BlockWithTransactions extends _Block {
-    transactions: Array<TransactionResponse>;
-}
-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;
-}
-interface FeeData {
-    lastBaseFeePerGas: null | BigNumber;
-    maxFeePerGas: null | BigNumber;
-    maxPriorityFeePerGas: null | BigNumber;
-    gasPrice: null | BigNumber;
-}
-interface EventFilter {
-    address?: string;
-    topics?: Array<string | Array<string> | null>;
-}
-interface Filter extends EventFilter {
-    fromBlock?: BlockTag;
-    toBlock?: BlockTag;
-}
-declare abstract class ForkEvent extends Description {
-    readonly expiry: number;
-    readonly _isForkEvent?: boolean;
-    static isForkEvent(value: any): value is ForkEvent;
-}
-declare type EventType = string | Array<string | Array<string>> | EventFilter | ForkEvent;
-declare type Listener = (...args: Array<any>) => void;
-declare abstract class Provider implements OnceBlockable {
-    abstract getNetwork(): Promise<Network>;
-    abstract getBlockNumber(): Promise<number>;
-    abstract getGasPrice(): Promise<BigNumber>;
-    getFeeData(): Promise<FeeData>;
-    abstract getBalance(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<BigNumber>;
-    abstract getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
-    abstract getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
-    abstract getStorageAt(addressOrName: string | Promise<string>, position: BigNumberish | Promise<BigNumberish>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
-    abstract sendTransaction(signedTransaction: string | Promise<string>): Promise<TransactionResponse>;
-    abstract call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>;
-    abstract estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
-    abstract getBlock(blockHashOrBlockTag: BlockTag | string | Promise<BlockTag | string>): Promise<Block>;
-    abstract getBlockWithTransactions(blockHashOrBlockTag: BlockTag | string | Promise<BlockTag | string>): Promise<BlockWithTransactions>;
-    abstract getTransaction(transactionHash: string): Promise<TransactionResponse>;
-    abstract getTransactionReceipt(transactionHash: string): Promise<TransactionReceipt>;
-    abstract getLogs(filter: Filter): Promise<Array<Log>>;
-    abstract resolveName(name: string | Promise<string>): Promise<null | string>;
-    abstract lookupAddress(address: string | Promise<string>): Promise<null | string>;
-    abstract on(eventName: EventType, listener: Listener): Provider;
-    abstract once(eventName: EventType, listener: Listener): Provider;
-    abstract emit(eventName: EventType, ...args: Array<any>): boolean;
-    abstract listenerCount(eventName?: EventType): number;
-    abstract listeners(eventName?: EventType): Array<Listener>;
-    abstract off(eventName: EventType, listener?: Listener): Provider;
-    abstract removeAllListeners(eventName?: EventType): Provider;
-    addListener(eventName: EventType, listener: Listener): Provider;
-    removeListener(eventName: EventType, listener: Listener): Provider;
-    abstract waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<TransactionReceipt>;
-    readonly _isProvider: boolean;
-    constructor();
-    static isProvider(value: any): value is Provider;
-}
-
-interface Overrides {
-    gasLimit?: BigNumberish | Promise<BigNumberish>;
-    gasPrice?: BigNumberish | Promise<BigNumberish>;
-    maxFeePerGas?: BigNumberish | Promise<BigNumberish>;
-    maxPriorityFeePerGas?: BigNumberish | Promise<BigNumberish>;
-    nonce?: BigNumberish | Promise<BigNumberish>;
-    type?: number;
-    accessList?: AccessListish;
-    customData?: Record<string, any>;
-    ccipReadEnabled?: boolean;
-}
-interface PayableOverrides extends Overrides {
-    value?: BigNumberish | Promise<BigNumberish>;
-}
-interface CallOverrides extends PayableOverrides {
-    blockTag?: BlockTag | Promise<BlockTag>;
-    from?: string | Promise<string>;
-}
-interface PopulatedTransaction {
-    to?: string;
-    from?: string;
-    nonce?: number;
-    gasLimit?: BigNumber;
-    gasPrice?: BigNumber;
-    data?: string;
-    value?: BigNumber;
-    chainId?: number;
-    type?: number;
-    accessList?: AccessList;
-    maxFeePerGas?: BigNumber;
-    maxPriorityFeePerGas?: BigNumber;
-    customData?: Record<string, any>;
-    ccipReadEnabled?: boolean;
-}
-
-type PromiseOrValue<T> = T | Promise<T>;
-
-declare namespace ImmutableERC721Base {
-    type IDBurnStruct = {
-        owner: PromiseOrValue<string>;
-        tokenIds: PromiseOrValue<BigNumberish>[];
-    };
-    type IDBurnStructOutput = [string, BigNumber[]] & {
-        owner: string;
-        tokenIds: BigNumber[];
-    };
-    type IDMintStruct = {
-        to: PromiseOrValue<string>;
-        tokenIds: PromiseOrValue<BigNumberish>[];
-    };
-    type IDMintStructOutput = [string, BigNumber[]] & {
-        to: string;
-        tokenIds: BigNumber[];
-    };
-    type TransferRequestStruct = {
-        from: PromiseOrValue<string>;
-        tos: PromiseOrValue<string>[];
-        tokenIds: PromiseOrValue<BigNumberish>[];
-    };
-    type TransferRequestStructOutput = [string, string[], BigNumber[]] & {
-        from: string;
-        tos: string[];
-        tokenIds: BigNumber[];
-    };
-}
-
-type IDMint = ImmutableERC721Base.IDMintStruct;
-type TransferRequest = ImmutableERC721Base.TransferRequestStruct;
-type IDBurn = ImmutableERC721Base.IDBurnStruct;
-declare class ERC721MintByID {
-    private readonly contract;
-    constructor(contractAddress: string);
-    /**
-     * Read functions
-     */
-    /**
-     * @returns the DEFAULT_ADMIN_ROLE as a string.
-     */
-    DEFAULT_ADMIN_ROLE(provider: Provider, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns the MINTER_ROLE as a string.
-     */
-    MINTER_ROLE(provider: Provider, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns the balance of an address as a BigNumber.
-     */
-    balanceOf(provider: Provider, owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
-    /**
-     * @returns the baseURI as a string.
-     */
-    baseURI(provider: Provider, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns the contractURI as a string.
-     */
-    contractURI(provider: Provider, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns admin addresses as an array of strings.
-     */
-    getAdmins(provider: Provider, overrides?: CallOverrides): Promise<string[]>;
-    /**
-     * @returns the approved address for a token ID, or zero if no address set.
-     */
-    getApproved(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns the role admin address.
-     */
-    getRoleAdmin(provider: Provider, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns the role member address at a particular index.
-     */
-    getRoleMember(provider: Provider, role: PromiseOrValue<BytesLike>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns the role member count as a BigNumber.
-     */
-    getRoleMemberCount(provider: Provider, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<BigNumber>;
-    /**
-     * @returns a boolean for whether an account has a particular role.
-     */
-    hasRole(provider: Provider, role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
-    /**
-     * @returns a booolean that tells whether an operator is approved by a given owner.
-     */
-    isApprovedForAll(provider: Provider, owner: PromiseOrValue<string>, operator: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
-    /**
-     * @returns the name of the contract as a string.
-     */
-    name(provider: Provider, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns the owner address of a particular tokenId.
-     */
-    ownerOf(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
-    /**
-     * Returns the current nonce of a given token ID.
-     * @param tokenId The ID of the token for which to retrieve the nonce.
-     * @return Current nonce of the given token.
-     */
-    nonces(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
-    /**
-     * @returns the operator allowlist as a string.
-     */
-    operatorAllowlist(provider: Provider, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns the royalty information for a particular tokenId.
-     */
-    royaltyInfo(provider: Provider, _tokenId: PromiseOrValue<BigNumberish>, _salePrice: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[string, BigNumber]>;
-    /**
-     * @returns the symbol of the contract as a string.
-     */
-    symbol(provider: Provider, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns the Uniform Resource Identifier (URI) for tokenId token.
-     */
-    tokenURI(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
-    /**
-     * @returns returns the total amount of tokens stored by the contract.
-     */
-    totalSupply(provider: Provider, overrides?: CallOverrides): Promise<BigNumber>;
-    /**
-     * Write functions
-     */
-    /**
-     * @returns a populated transaction for the approve contract function
-     */
-    populateApprove(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * Function to approve by way of owner signature
-     * @param spender the address to approve
-     * @param tokenId the index of the NFT to approve the spender on
-     * @param deadline a timestamp expiry for the permit
-     * @param sig a traditional or EIP-2098 signature
-     */
-    populatePermit(spender: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, deadline: PromiseOrValue<BigNumberish>, sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the burn contract function
-     */
-    populateBurn(tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the batch burn contract function
-     */
-    populateBurnBatch(tokenIds: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the grantMinterRole contract function
-     */
-    populateGrantMinterRole(user: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the grantRole contract function
-     */
-    populateGrantRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the mint contract function
-     */
-    populateMint(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the batch mint contract function
-     */
-    populateSafeMintBatch(mints: IDMint[], overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the safe burn contract function
-     */
-    populateSafeBurn(owner: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the safe burn batch contract function
-     */
-    populateSafeBurnBatch(burns: IDBurn[], overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the renounceRole contract function
-     */
-    populateRenounceRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the revokeMinterRole contract function
-     */
-    populateRevokeMinterRole(user: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the revokeRole contract function
-     */
-    populateRevokeRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the batch save transfer from function
-     */
-    populateSafeTransferFromBatch(transfers: TransferRequest, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the safeTransferFrom(address,address,uint256) contract function
-     */
-    'populateSafeTransferFrom(address,address,uint256)'(from: PromiseOrValue<string>, to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the safeTransferFrom(address,address,uint256,bytes) contract function
-     */
-    'populateSafeTransferFrom(address,address,uint256,bytes)'(from: PromiseOrValue<string>, to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, data: PromiseOrValue<BytesLike>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the setApprovalForAll contract function
-     */
-    populateSetApprovalForAll(operator: PromiseOrValue<string>, approved: PromiseOrValue<boolean>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the setBaseURI contract function
-     */
-    populateSetBaseURI(baseURI_: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the setContractURI contract function
-     */
-    populateSetContractURI(_contractURI: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the setDefaultRoyaltyReceiver contract function
-     */
-    populateSetDefaultRoyaltyReceiver(receiver: PromiseOrValue<string>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the setNFTRoyaltyReceiver contract function
-     */
-    populateSetNFTRoyaltyReceiver(tokenId: PromiseOrValue<BigNumberish>, receiver: PromiseOrValue<string>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the setNFTRoyaltyReceiverBatch contract function
-     */
-    populateSetNFTRoyaltyReceiverBatch(tokenIds: PromiseOrValue<BigNumberish>[], receiver: PromiseOrValue<string>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-    /**
-     * @returns a populated transaction for the setOperatorAllowlistRegistry contract function
-     */
-    populateSetOperatorAllowlistRegistry(_operatorAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
-}
-
-export { ERC721MintByID };