@imtbl/sdk 0.1.8-alpha.2 → 0.1.9-alpha

package/dist/erc721-permissioned-mintable.d.ts

@@ -40,13 +40,181 @@ declare class BigNumber implements Hexable {
     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>;
@@ -89,173 +257,179 @@ declare class ERC721PermissionedMintable {
     private readonly contract;
     constructor(contractAddress: string);
     /**
-     * @returns a promise that resolves with a populated transaction
+     * Read functions
      */
-    DEFAULT_ADMIN_ROLE(overrides?: CallOverrides): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the DEFAULT_ADMIN_ROLE as a string.
      */
-    MINTER_ROLE(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    DEFAULT_ADMIN_ROLE(provider: Provider, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the MINTER_ROLE as a string.
      */
-    approve(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
+    MINTER_ROLE(provider: Provider, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the balance of an address as a BigNumber.
      */
-    balanceOf(owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    balanceOf(provider: Provider, owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the baseURI as a string.
      */
-    baseURI(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    baseURI(provider: Provider, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the contractURI as a string.
      */
-    burn(tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
+    contractURI(provider: Provider, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns admin addresses as an array of strings.
      */
-    contractURI(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    getAdmins(provider: Provider, overrides?: CallOverrides): Promise<string[]>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the approved address for a token ID, or zero if no address set.
      */
-    getAdmins(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    getApproved(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the role admin address.
      */
-    getApproved(tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    getRoleAdmin(provider: Provider, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the role member address at a particular index.
      */
-    getRoleAdmin(role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    getRoleMember(provider: Provider, role: PromiseOrValue<BytesLike>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the role member count as a BigNumber.
      */
-    getRoleMember(role: PromiseOrValue<BytesLike>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    getRoleMemberCount(provider: Provider, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a boolean for whether an account has a particular role.
      */
-    getRoleMemberCount(role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    hasRole(provider: Provider, role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a booolean that tells whether an operator is approved by a given owner.
      */
-    grantMinterRole(user: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
+    isApprovedForAll(provider: Provider, owner: PromiseOrValue<string>, operator: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the name of the contract as a string.
      */
-    grantRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
+    name(provider: Provider, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the owner address of a particular tokenId.
      */
-    hasRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    ownerOf(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the royalty allowlist as a string.
      */
-    isApprovedForAll(owner: PromiseOrValue<string>, operator: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    royaltyAllowlist(provider: Provider, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the royalty information for a particular tokenId.
      */
-    mint(to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
+    royaltyInfo(provider: Provider, _tokenId: PromiseOrValue<BigNumberish>, _salePrice: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[string, BigNumber]>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the symbol of the contract as a string.
      */
-    name(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    symbol(provider: Provider, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a token ID at a given index of all the tokens stored by the contract.
      */
-    ownerOf(tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    tokenByIndex(provider: Provider, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a token ID owned by owner at a given index of its token list.
      */
-    renounceRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
+    tokenOfOwnerByIndex(provider: Provider, owner: PromiseOrValue<string>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns the Uniform Resource Identifier (URI) for tokenId token.
      */
-    revokeMinterRole(user: PromiseOrValue<string>, overrides?: Overrides & {
-        from?: PromiseOrValue<string>;
-    }): Promise<PopulatedTransaction>;
+    tokenURI(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns returns the total amount of tokens stored by the contract.
      */
-    revokeRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
+    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>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the burn contract function
      */
-    royaltyAllowlist(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    populateBurn(tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the grantMinterRole contract function
      */
-    royaltyInfo(_tokenId: PromiseOrValue<BigNumberish>, _salePrice: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    populateGrantMinterRole(user: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the grantRole contract function
      */
-    'safeTransferFrom(address,address,uint256)'(from: PromiseOrValue<string>, to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+    populateGrantRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the mint contract function
      */
-    'safeTransferFrom(address,address,uint256,bytes)'(from: PromiseOrValue<string>, to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, data: PromiseOrValue<BytesLike>, overrides?: Overrides & {
+    populateMint(to: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the renounceRole contract function
      */
-    setApprovalForAll(operator: PromiseOrValue<string>, approved: PromiseOrValue<boolean>, overrides?: Overrides & {
+    populateRenounceRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the revokeMinterRole contract function
      */
-    setBaseURI(baseURI_: PromiseOrValue<string>, overrides?: Overrides & {
+    populateRevokeMinterRole(user: PromiseOrValue<string>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the revokeRole contract function
      */
-    setContractURI(_contractURI: PromiseOrValue<string>, overrides?: Overrides & {
+    populateRevokeRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the safeTransferFrom(address,address,uint256) contract function
      */
-    setRoyaltyAllowlistRegistry(_royaltyAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
+    'populateSafeTransferFrom(address,address,uint256)'(from: PromiseOrValue<string>, to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the safeTransferFrom(address,address,uint256,bytes) contract function
      */
-    symbol(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    '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 promise that resolves with a populated transaction
+     * @returns a populated transaction for the setApprovalForAll contract function
      */
-    tokenByIndex(index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    setApprovalForAll(operator: PromiseOrValue<string>, approved: PromiseOrValue<boolean>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the setBaseURI contract function
      */
-    tokenOfOwnerByIndex(owner: PromiseOrValue<string>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    setBaseURI(baseURI_: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the setContractURI contract function
      */
-    tokenURI(tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    setContractURI(_contractURI: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
     /**
-     * @returns a promise that resolves with a populated transaction
+     * @returns a populated transaction for the setRoyaltyAllowlistRegistry contract function
      */
-    totalSupply(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    setRoyaltyAllowlistRegistry(_royaltyAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
 }
 
 export { ERC721PermissionedMintable };