Class KIP17


  • public class KIP17
    extends Contract
    The KIP17 class that helps you easily handle a smart contract that implements KIP-17 as a Java instance on the Klaytn blockchain platform.

    This KIP-17 contract source code based on Klaytn-contracts. Static methods and constructor is accessed via `caver.kct.kip17`.

    See Also:
    KIP17Wrapper, KCTWrapper, Contract
    • Field Detail

      • FUNCTION_ADD_MINTER

        public static final java.lang.String FUNCTION_ADD_MINTER
        See Also:
        Constant Field Values
      • FUNCTION_ADD_PAUSER

        public static final java.lang.String FUNCTION_ADD_PAUSER
        See Also:
        Constant Field Values
      • FUNCTION_APPROVE

        public static final java.lang.String FUNCTION_APPROVE
        See Also:
        Constant Field Values
      • FUNCTION_BALANCE_OF

        public static final java.lang.String FUNCTION_BALANCE_OF
        See Also:
        Constant Field Values
      • FUNCTION_GET_APPROVED

        public static final java.lang.String FUNCTION_GET_APPROVED
        See Also:
        Constant Field Values
      • FUNCTION_IS_APPROVED_FOR_ALL

        public static final java.lang.String FUNCTION_IS_APPROVED_FOR_ALL
        See Also:
        Constant Field Values
      • FUNCTION_IS_MINTER

        public static final java.lang.String FUNCTION_IS_MINTER
        See Also:
        Constant Field Values
      • FUNCTION_IS_PAUSER

        public static final java.lang.String FUNCTION_IS_PAUSER
        See Also:
        Constant Field Values
      • FUNCTION_MINT_WITH_TOKEN_URI

        public static final java.lang.String FUNCTION_MINT_WITH_TOKEN_URI
        See Also:
        Constant Field Values
      • FUNCTION_OWNER_OF

        public static final java.lang.String FUNCTION_OWNER_OF
        See Also:
        Constant Field Values
      • FUNCTION_RENOUNCE_MINTER

        public static final java.lang.String FUNCTION_RENOUNCE_MINTER
        See Also:
        Constant Field Values
      • FUNCTION_RENOUNCE_PAUSER

        public static final java.lang.String FUNCTION_RENOUNCE_PAUSER
        See Also:
        Constant Field Values
      • FUNCTION_SAFE_TRANSFER_FROM

        public static final java.lang.String FUNCTION_SAFE_TRANSFER_FROM
        See Also:
        Constant Field Values
      • FUNCTION_SET_APPROVAL_FOR_ALL

        public static final java.lang.String FUNCTION_SET_APPROVAL_FOR_ALL
        See Also:
        Constant Field Values
      • FUNCTION_SUPPORTS_INTERFACE

        public static final java.lang.String FUNCTION_SUPPORTS_INTERFACE
        See Also:
        Constant Field Values
      • FUNCTION_TOKEN_BY_INDEX

        public static final java.lang.String FUNCTION_TOKEN_BY_INDEX
        See Also:
        Constant Field Values
      • FUNCTION_TOKEN_OF_OWNER_BY_INDEX

        public static final java.lang.String FUNCTION_TOKEN_OF_OWNER_BY_INDEX
        See Also:
        Constant Field Values
      • FUNCTION_TOKEN_URI

        public static final java.lang.String FUNCTION_TOKEN_URI
        See Also:
        Constant Field Values
      • FUNCTION_TOTAL_SUPPLY

        public static final java.lang.String FUNCTION_TOTAL_SUPPLY
        See Also:
        Constant Field Values
      • FUNCTION_TRANSFER_FROM

        public static final java.lang.String FUNCTION_TRANSFER_FROM
        See Also:
        Constant Field Values
      • FUNCTION_UNPAUSE

        public static final java.lang.String FUNCTION_UNPAUSE
        See Also:
        Constant Field Values
    • Constructor Detail

      • KIP17

        public KIP17​(Caver caver)
              throws java.io.IOException
        Creates a KIP17 instance.
        Parameters:
        caver - A Caver instance.
        Throws:
        java.io.IOException
      • KIP17

        public KIP17​(Caver caver,
                     java.lang.String contractAddress)
              throws java.io.IOException
        Creates a KIP17 instance
        Parameters:
        caver - A Caver instance.
        contractAddress - A contract address
        Throws:
        java.io.IOException
    • Method Detail

      • create

        public static KIP17 create​(Caver caver)
                            throws java.io.IOException
        Creates a KIP17 instance.

        Example :
         
         KIP17 kip17 = caver.kct.kip17.create();
         
         
        Parameters:
        caver - A Caver instance.
        Returns:
        KIP17
        Throws:
        java.io.IOException
      • create

        public static KIP17 create​(Caver caver,
                                   java.lang.String contractAddress)
                            throws java.io.IOException
        Creates a KIP17 instance.

        Example :
         
         String contractAddress = "0x{contractAddress}";
         KIP17 kip17 = caver.kct.kip17.create(contractAddress);
         
         
        Parameters:
        caver - A Caver instance.
        contractAddress - A contract address
        Returns:
        KIP17
        Throws:
        java.io.IOException
      • deploy

        public static KIP17 deploy​(Caver caver,
                                   java.lang.String deployer,
                                   java.lang.String name,
                                   java.lang.String symbol)
                            throws java.lang.NoSuchMethodException,
                                   java.io.IOException,
                                   java.lang.InstantiationException,
                                   java.lang.ClassNotFoundException,
                                   java.lang.IllegalAccessException,
                                   java.lang.reflect.InvocationTargetException,
                                   org.web3j.protocol.exceptions.TransactionException
        Deploy a KIP-17 contract.

        The deployer's keyring should be added in `caver.wallet`. See KeyringContainer and IWallet.

        Example :
         
         String deployerAddress = "0x{deployerAddress}";
         String name = "KIP17";
         String symbol = "KIP17Symbol";
        
         KIP17 kip17 = caver.kct.kip17.deploy(deployerAddress, name, symbol);
         
         
        Parameters:
        caver - A Caver instance.
        deployer - A deployer's address.
        name - A KIP-17 contract name.
        symbol - A KIP-17 contract symbol.
        Returns:
        KIP17
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • deploy

        public static KIP17 deploy​(Caver caver,
                                   SendOptions sendOptions,
                                   java.lang.String name,
                                   java.lang.String symbol)
                            throws java.lang.NoSuchMethodException,
                                   java.io.IOException,
                                   java.lang.InstantiationException,
                                   java.lang.ClassNotFoundException,
                                   java.lang.IllegalAccessException,
                                   java.lang.reflect.InvocationTargetException,
                                   org.web3j.protocol.exceptions.TransactionException
        Deploy a KIP-17 contract.

        The deployer's keyring should be added in `caver.wallet`. See KeyringContainer and IWallet.

        If you want to deploy a contract using fee delegation transaction, you can create and send a fee delegated transaction through setting a fee delegation field in `SendOptions` like below code example.

        Example :
         
         String name = "KIP17";
         String symbol = "KIP17Symbol";
        
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom("0x{deployerAddress}");
         sendOptions.setGas(BigInteger.valueOf(gas value));
         sendOptions.setFeeDelegation(true);
         sendOptions.setFeePayer("0x{feePayerAddress}");
        
         KIP17 kip17 = caver.kct.kip17.deploy(sendOptions, name, symbol);
         
         
        Parameters:
        caver - A Caver instance.
        sendOptions - The send options to deploy a contract.
        name - A KIP-17 contract name.
        symbol - A KIP-17 contract symbol.
        Returns:
        KIP17
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • deploy

        public static KIP17 deploy​(Caver caver,
                                   java.lang.String deployer,
                                   java.lang.String name,
                                   java.lang.String symbol,
                                   IWallet wallet)
                            throws java.lang.NoSuchMethodException,
                                   java.io.IOException,
                                   java.lang.InstantiationException,
                                   java.lang.ClassNotFoundException,
                                   java.lang.IllegalAccessException,
                                   java.lang.reflect.InvocationTargetException,
                                   org.web3j.protocol.exceptions.TransactionException
        Deploy a KIP-17 contract.

        The wallet used in the contract is set with the wallet that implements the IWallet interface passed as a parameter of the method.

        Example :
         
         String deployerAddress = "0x{deployerAddress}";
         String name = "KIP17";
         String symbol = "KIP17Symbol";
        
         KIP17 kip17 = caver.kct.kip17.deploy(deployer, name, symbol, caver.getWallet());
         
         
        Parameters:
        caver - A Caver instance.
        deployer - A deployer's address.
        name - A KIP-17 contract name.
        symbol - A KIP-17 contract symbol.
        wallet - The class instance implemented IWallet to sign transaction.
        Returns:
        KIP17
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • deploy

        public static KIP17 deploy​(Caver caver,
                                   SendOptions sendOptions,
                                   java.lang.String name,
                                   java.lang.String symbol,
                                   IWallet wallet)
                            throws java.lang.NoSuchMethodException,
                                   java.io.IOException,
                                   java.lang.InstantiationException,
                                   java.lang.ClassNotFoundException,
                                   java.lang.IllegalAccessException,
                                   java.lang.reflect.InvocationTargetException,
                                   org.web3j.protocol.exceptions.TransactionException
        Deploy KIP-17 contract.

        The wallet used in the contract is set with the wallet that implements the IWallet interface passed as a parameter of the method.

        If you want to deploy a contract using fee delegation transaction, you can create and send a fee delegated transaction through setting a fee delegation field in `SendOptions` like below code example.

        Example :
         
         String name = "KIP17";
         String symbol = "KIP17Symbol";
        
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom("0x{deployerAddress}");
         sendOptions.setGas(BigInteger.valueOf(gas value));
         sendOptions.setFeeDelegation(true);
         sendOptions.setFeePayer("0x{feePayerAddress}");
        
         KIP17 kip17 = caver.kct.kip17.deploy(sendOptions, name, symbol, caver.getWallet());
         
         
        Parameters:
        caver - A Caver instance.
        sendOptions - The send options to deploy a contract.
        name - A KIP-17 contract name.
        symbol - A KIP-17 contract symbol.
        wallet - The class instance implemented IWallet to sign transaction.
        Returns:
        KIP17
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • deploy

        public static KIP17 deploy​(Caver caver,
                                   KIP17DeployParams tokenInfo,
                                   java.lang.String deployer)
                            throws java.lang.NoSuchMethodException,
                                   java.io.IOException,
                                   java.lang.InstantiationException,
                                   java.lang.ClassNotFoundException,
                                   java.lang.IllegalAccessException,
                                   java.lang.reflect.InvocationTargetException,
                                   org.web3j.protocol.exceptions.TransactionException
        Deploy KIP17 contract.

        The deployer's keyring should be added in `caver.wallet`. See KeyringContainer and IWallet.

        Example :
         
         String deployerAddress = "0x{deployerAddress}";
         String name = "KIP17";
         String symbol = "KIP17Symbol";
         KIP17DeployParams tokenInfo = new KIP17DeployParams(name, symbol);
        
         KIP17 kip17 = caver.kct.kip17.deploy(tokenInfo, deployerAddress);
         
         
        Parameters:
        caver - A Caver instance.
        tokenInfo - The KIP-17 contract's deploy parameter values.
        deployer - A deployer's address.
        Returns:
        KIP17
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • deploy

        public static KIP17 deploy​(Caver caver,
                                   KIP17DeployParams tokenInfo,
                                   SendOptions sendOptions)
                            throws java.lang.NoSuchMethodException,
                                   java.io.IOException,
                                   java.lang.InstantiationException,
                                   java.lang.ClassNotFoundException,
                                   java.lang.IllegalAccessException,
                                   java.lang.reflect.InvocationTargetException,
                                   org.web3j.protocol.exceptions.TransactionException
        Deploy KIP-17 contract.

        The deployer's keyring should be added in `caver.wallet`. See KeyringContainer and IWallet.

        If you want to deploy a contract using fee delegation transaction, you can create and send a fee delegated transaction through setting a fee delegation field in `SendOptions` like below code example.

         
         String name = "KIP17";
         String symbol = "KIP17Symbol";
        
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom("0x{deployerAddress}");
         sendOptions.setGas(BigInteger.valueOf(gas value));
         sendOptions.setFeeDelegation(true);
         sendOptions.setFeePayer("0x{feePayerAddress}");
        
         KIP17DeployParams tokenInfo = new KIP17DeployParams(name, symbol);
         KIP17 kip17 = caver.kct.kip17.deploy(tokenInfo, sendOptions);
         
         
        Parameters:
        caver - A Caver instance.
        tokenInfo - The KIP-17 contract's deploy parameter values.
        sendOptions - The send options to deploy a contract.
        Returns:
        KIP17
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • deploy

        public static KIP17 deploy​(Caver caver,
                                   KIP17DeployParams tokenInfo,
                                   java.lang.String deployer,
                                   IWallet wallet)
                            throws java.lang.NoSuchMethodException,
                                   java.io.IOException,
                                   java.lang.InstantiationException,
                                   java.lang.ClassNotFoundException,
                                   java.lang.IllegalAccessException,
                                   java.lang.reflect.InvocationTargetException,
                                   org.web3j.protocol.exceptions.TransactionException
        Deploy KIP17 contract.

        The wallet used in the contract is set with the wallet that implements the IWallet interface passed as a parameter of the method.

        Example :
         
         String deployerAddress = "0x{deployerAddress}";
         String name = "KIP17";
         String symbol = "KIP17Symbol";
         KIP17DeployParams tokenInfo = new KIP17DeployParams(name, symbol);
        
         KIP17 kip17 = caver.kct.kip17.deploy(tokenInfo, deployerAddress, caver.getWallet());
         
         
        Parameters:
        caver - A Caver instance.
        tokenInfo - The KIP-17 contract's deploy parameter values.
        deployer - A deployer's address.
        wallet - The class instance implemented IWallet to sign transaction.
        Returns:
        KIP17
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • deploy

        public static KIP17 deploy​(Caver caver,
                                   KIP17DeployParams tokenInfo,
                                   SendOptions sendOptions,
                                   IWallet wallet)
                            throws java.lang.NoSuchMethodException,
                                   java.io.IOException,
                                   java.lang.InstantiationException,
                                   java.lang.ClassNotFoundException,
                                   java.lang.IllegalAccessException,
                                   java.lang.reflect.InvocationTargetException,
                                   org.web3j.protocol.exceptions.TransactionException
        Deploy KIP-17 contract.

        The wallet used in the contract is set with the wallet that implements the IWallet interface passed as a parameter of the method.

        If you want to deploy a contract using fee delegation transaction, you can create and send a fee delegated transaction through setting a fee delegation field in `SendOptions` like below code example.

        Example :
         
         String name = "KIP17";
         String symbol = "KIP17Symbol";
        
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom("0x{deployerAddress}");
         sendOptions.setGas(BigInteger.valueOf(gas value));
         sendOptions.setFeeDelegation(true);
         sendOptions.setFeePayer("0x{feePayerAddress}");
        
         KIP17DeployParams tokenInfo = new KIP17DeployParams(name, symbol);
         KIP17 kip17 = caver.kct.kip17.deploy(tokenInfo, sendOptions, caver.getWallet());
         
         
        Parameters:
        caver - A Caver instance.
        tokenInfo - The KIP-17 contract's deploy parameter values.
        sendOptions - The send options to deploy a contract.
        wallet - The class instance implemented IWallet to sign transaction.
        Returns:
        KIP17
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • detectInterface

        public static java.util.Map<java.lang.String,​java.lang.Boolean> detectInterface​(Caver caver,
                                                                                              java.lang.String contractAddress)
        Detects which interface the KIP-17 token contract supports.

        Example :

        
         Map<String, Boolean> result = KIP17.detectInterface();
         result.get(KIP17.INTERFACE_ID_IKIP17);
         result.get(KIP17.INTERFACE_ID_IKIP17_METADATA);
         result.get(KIP17.INTERFACE_ID_IKIP17_ENUMERABLE);
         result.get(KIP17.INTERFACE_ID_IKIP17_MINTABLE);
         result.get(KIP17.INTERFACE_ID_IKIP17_METADATA_MINTABLE);
         result.get(KIP17.INTERFACE_ID_IKIP17_BURNABLE);
         result.get(KIP17.INTERFACE_ID_IKIP17_PAUSABLE);
         
        Parameters:
        caver - A Caver instance.
        contractAddress - A contract instance
        Returns:
        Map<String, Boolean>
      • clone

        public KIP17 clone()
        Copy instance.
        Example :
         
         KIP7 cloned = kip7.clone();
         
         
        Overrides:
        clone in class java.lang.Object
        Returns:
        KIP17
      • clone

        public KIP17 clone​(java.lang.String tokenAddress)
        Copy instance with token address.
        Example :
         
         String contractAddress = "0x{contractAddress}";
         KIP17 cloned = kip17.clone(contractAddress);
         
         
        Parameters:
        tokenAddress - A KIP-17 token address
        Returns:
        KIP17
      • detectInterface

        public java.util.Map<java.lang.String,​java.lang.Boolean> detectInterface()
        Detects which interface the KIP-17 token contract supports.

        Example :

        
         KIP17 kip17 = new KIP17("0x{contract_address}");
         Map<String, Boolean> result = kip17.detectInterface();
         result.get(KIP17.INTERFACE_ID_IKIP17);
         result.get(KIP17.INTERFACE_ID_IKIP17_METADATA);
         result.get(KIP17.INTERFACE_ID_IKIP17_ENUMERABLE);
         result.get(KIP17.INTERFACE_ID_IKIP17_MINTABLE);
         result.get(KIP17.INTERFACE_ID_IKIP17_METADATA_MINTABLE);
         result.get(KIP17.INTERFACE_ID_IKIP17_BURNABLE);
         result.get(KIP17.INTERFACE_ID_IKIP17_PAUSABLE);
         
        Returns:
        Map<String, Boolean>
      • supportInterface

        public boolean supportInterface​(java.lang.String interfaceId)
                                 throws java.lang.NoSuchMethodException,
                                        java.io.IOException,
                                        java.lang.InstantiationException,
                                        java.lang.IllegalAccessException,
                                        java.lang.reflect.InvocationTargetException,
                                        java.lang.ClassNotFoundException
        Call method "supportsInterface" in KIP-13 standard contract.
        Example :
         
         boolean isSupported = kip17.supportInterface(KIP17.INTERFACE.IKIP17.getId());
         
         
        Parameters:
        interfaceId - interface identifier. see KIP17.INTERFACE
        Returns:
        boolean
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • name

        public java.lang.String name()
                              throws java.lang.NoSuchMethodException,
                                     java.io.IOException,
                                     java.lang.InstantiationException,
                                     java.lang.IllegalAccessException,
                                     java.lang.reflect.InvocationTargetException,
                                     java.lang.ClassNotFoundException
        Call method "name" in KIP-17 standard contract.
        Example :
         
         String name = kip17.name();
         
         
        Returns:
        String
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • symbol

        public java.lang.String symbol()
                                throws java.lang.NoSuchMethodException,
                                       java.io.IOException,
                                       java.lang.InstantiationException,
                                       java.lang.IllegalAccessException,
                                       java.lang.reflect.InvocationTargetException,
                                       java.lang.ClassNotFoundException
        Call method "symbol" in KIP-17 standard contract.
        Example :
         
         String symbol = kip17.symbol();
         
         
        Returns:
        String
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • tokenURI

        public java.lang.String tokenURI​(java.math.BigInteger tokenId)
                                  throws java.lang.NoSuchMethodException,
                                         java.io.IOException,
                                         java.lang.InstantiationException,
                                         java.lang.IllegalAccessException,
                                         java.lang.reflect.InvocationTargetException,
                                         java.lang.ClassNotFoundException
        Call method "tokenURI" in KIP-17 standard contract.
        Example :
         
         BigInteger tokenId = BigInteger.ONE;
         String uri = kip17.tokenURI(tokenId);
         
         
        Parameters:
        tokenId -
        Returns:
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • totalSupply

        public java.math.BigInteger totalSupply()
                                         throws java.lang.NoSuchMethodException,
                                                java.io.IOException,
                                                java.lang.InstantiationException,
                                                java.lang.IllegalAccessException,
                                                java.lang.reflect.InvocationTargetException,
                                                java.lang.ClassNotFoundException
        Call method "totalSupply" in KIP-17 standard contract.
        Example :
         
         BigInteger totalSupply = kip17.totalSupply();
         
         
        Returns:
        String
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • tokenOwnerByIndex

        public java.math.BigInteger tokenOwnerByIndex​(java.lang.String owner,
                                                      java.math.BigInteger index)
                                               throws java.lang.NoSuchMethodException,
                                                      java.io.IOException,
                                                      java.lang.InstantiationException,
                                                      java.lang.IllegalAccessException,
                                                      java.lang.reflect.InvocationTargetException,
                                                      java.lang.ClassNotFoundException
        Call method "tokenOwnerByIndex" in KIP-17 standard contract.
        Example :
         
         String owner = "0x{ownerAddress}";
         BigInteger index = BigInteger.ZERO;
        
         BigInteger token = kip17.tokenOwnerByIndex(owner, index);
         
         
        Parameters:
        owner - An account where we are interested in NFTs owned by them
        index - A counter less than "balanceOf(owner)"
        Returns:
        BigInteger
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • tokenByIndex

        public java.math.BigInteger tokenByIndex​(java.math.BigInteger index)
                                          throws java.lang.NoSuchMethodException,
                                                 java.io.IOException,
                                                 java.lang.InstantiationException,
                                                 java.lang.IllegalAccessException,
                                                 java.lang.reflect.InvocationTargetException,
                                                 java.lang.ClassNotFoundException
        Call method "tokenByIndex" in KIP-17 standard contract.
        Example :
         
         BigInteger tokenIndex = BigInteger.ONE;
         BigInteger token = kip17.tokenByIndex(tokenIndex);
         
         
        Parameters:
        index - A counter less than "totalSupply"
        Returns:
        BigInteger
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • balanceOf

        public java.math.BigInteger balanceOf​(java.lang.String account)
                                       throws java.lang.NoSuchMethodException,
                                              java.io.IOException,
                                              java.lang.InstantiationException,
                                              java.lang.IllegalAccessException,
                                              java.lang.reflect.InvocationTargetException,
                                              java.lang.ClassNotFoundException
        Call method "balanceOf" in KIP-17 standard contract.
        Example :
         
         String account = "0x{accountAddress}";
         BigInteger balance = kip17.balanceOf(account);
         
         
        Parameters:
        account - An account for whom to query the balance
        Returns:
        BigInteger
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • ownerOf

        public java.lang.String ownerOf​(java.math.BigInteger tokenId)
                                 throws java.lang.NoSuchMethodException,
                                        java.io.IOException,
                                        java.lang.InstantiationException,
                                        java.lang.IllegalAccessException,
                                        java.lang.reflect.InvocationTargetException,
                                        java.lang.ClassNotFoundException
        Call method "ownerOf" in KIP-17 standard contract.
        Example :
         
         BigInteger tokenId = BigInteger.ONE;
         String owner = kip17.ownerOf(tokenId);
         
         
        Parameters:
        tokenId - The identifier of NFT
        Returns:
        String
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • getApproved

        public java.lang.String getApproved​(java.math.BigInteger tokenId)
                                     throws java.lang.NoSuchMethodException,
                                            java.io.IOException,
                                            java.lang.InstantiationException,
                                            java.lang.IllegalAccessException,
                                            java.lang.reflect.InvocationTargetException,
                                            java.lang.ClassNotFoundException
        Call method "getApproved" in KIP-17 standard contract.
        Example :
         
         BigInteger tokenId = BigInteger.ONE;
         String operator = kip17.getApproved(tokenId);
         
         
        Parameters:
        tokenId - The identifier of NFT
        Returns:
        String
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • isApprovedForAll

        public boolean isApprovedForAll​(java.lang.String owner,
                                        java.lang.String operator)
                                 throws java.lang.NoSuchMethodException,
                                        java.io.IOException,
                                        java.lang.InstantiationException,
                                        java.lang.IllegalAccessException,
                                        java.lang.reflect.InvocationTargetException,
                                        java.lang.ClassNotFoundException
        Call method "isApprovedForAll" in KIP-17 standard contract.
        Example :
         
         String owner = "0x{ownerAddress}";
         String operator = "0x{operatorAddress}";
        
         boolean approved = kip17.isApprovedForAll(owner, operator);
         
         
        Parameters:
        owner - The account that owns the NFTs
        operator - The account that act on behalf of the owner
        Returns:
        boolean
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • isMinter

        public boolean isMinter​(java.lang.String account)
                         throws java.lang.NoSuchMethodException,
                                java.io.IOException,
                                java.lang.InstantiationException,
                                java.lang.IllegalAccessException,
                                java.lang.reflect.InvocationTargetException,
                                java.lang.ClassNotFoundException
        Call method "isMinter" in KIP-17 standard contract.
        Example :
         
         String account = "0x{accountAddress}";
        
         boolean hasMinter = kip17.isMinter(account);
         
         
        Parameters:
        account - The account to check the minting permission
        Returns:
        boolean
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • paused

        public boolean paused()
                       throws java.lang.NoSuchMethodException,
                              java.io.IOException,
                              java.lang.InstantiationException,
                              java.lang.IllegalAccessException,
                              java.lang.reflect.InvocationTargetException,
                              java.lang.ClassNotFoundException
        Call method "paused" in KIP-17 standard contract.
        Example :
         
         boolean isPausedContract = kip17.paused();
         
         
        Returns:
        boolean
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • isPauser

        public boolean isPauser​(java.lang.String account)
                         throws java.lang.NoSuchMethodException,
                                java.io.IOException,
                                java.lang.InstantiationException,
                                java.lang.IllegalAccessException,
                                java.lang.reflect.InvocationTargetException,
                                java.lang.ClassNotFoundException
        Call method "isPauser" in KIP-17 standard contract.
        Example :
         
         String account = "0x{accountAddress}";
         boolean isPauser = kip17.isPauser(account);
         
         
        Parameters:
        account - The account to check the pausing permission
        Returns:
        boolean
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.ClassNotFoundException
      • approve

        public TransactionReceipt.TransactionReceiptData approve​(java.lang.String to,
                                                                 java.math.BigInteger tokenId)
                                                          throws java.lang.NoSuchMethodException,
                                                                 java.io.IOException,
                                                                 java.lang.InstantiationException,
                                                                 java.lang.ClassNotFoundException,
                                                                 java.lang.IllegalAccessException,
                                                                 java.lang.reflect.InvocationTargetException,
                                                                 org.web3j.protocol.exceptions.TransactionException
        Execute method "approve" in KIP-17 standard contract.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         String to = "0x{toAddress}";
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.approve(to, tokenId);
         
         
        Parameters:
        to - The new account approved NFT controller
        tokenId - The NFT ID to approve
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • approve

        public TransactionReceipt.TransactionReceiptData approve​(java.lang.String to,
                                                                 java.math.BigInteger tokenId,
                                                                 SendOptions sendParam)
                                                          throws java.lang.NoSuchMethodException,
                                                                 java.io.IOException,
                                                                 java.lang.InstantiationException,
                                                                 java.lang.ClassNotFoundException,
                                                                 java.lang.IllegalAccessException,
                                                                 java.lang.reflect.InvocationTargetException,
                                                                 org.web3j.protocol.exceptions.TransactionException
        Execute method "approve" in KIP-17 standard contract.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         String to = "0x{toAddress}";
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.approve(to, tokenId, sendOptions);
         
         
        Parameters:
        to - The new account approved NFT controller
        tokenId - The NFT ID to approve
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • setApproveForAll

        public TransactionReceipt.TransactionReceiptData setApproveForAll​(java.lang.String to,
                                                                          boolean approved)
                                                                   throws java.lang.NoSuchMethodException,
                                                                          java.io.IOException,
                                                                          java.lang.InstantiationException,
                                                                          java.lang.ClassNotFoundException,
                                                                          java.lang.IllegalAccessException,
                                                                          java.lang.reflect.InvocationTargetException,
                                                                          org.web3j.protocol.exceptions.TransactionException
        Execute method "setApprovedForAll" in KIP-17 standard contract.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         String to = "0x{operatorAddress}";
         boolean approved = true;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.setApproveForAll(to, approved);
         
         
        Parameters:
        to - Account to add the set of authorized operators.
        approved - True if the operator is approved, false to revoke approval
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • setApproveForAll

        public TransactionReceipt.TransactionReceiptData setApproveForAll​(java.lang.String to,
                                                                          boolean approved,
                                                                          SendOptions sendParam)
                                                                   throws java.lang.NoSuchMethodException,
                                                                          java.io.IOException,
                                                                          java.lang.InstantiationException,
                                                                          java.lang.ClassNotFoundException,
                                                                          java.lang.IllegalAccessException,
                                                                          java.lang.reflect.InvocationTargetException,
                                                                          org.web3j.protocol.exceptions.TransactionException
        Execute method "setApprovedForAll" in KIP-17 standard contract.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         String to = "0x{operatorAddress}";
         boolean approved = true;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.setApproveForAll(to, approved, sendOptions);
         
         
        Parameters:
        to - Account to add the set of authorized operators.
        approved - True if the operator is approved, false to revoke approval
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • transferFrom

        public TransactionReceipt.TransactionReceiptData transferFrom​(java.lang.String from,
                                                                      java.lang.String to,
                                                                      java.math.BigInteger tokenId)
                                                               throws java.lang.NoSuchMethodException,
                                                                      java.io.IOException,
                                                                      java.lang.InstantiationException,
                                                                      java.lang.ClassNotFoundException,
                                                                      java.lang.IllegalAccessException,
                                                                      java.lang.reflect.InvocationTargetException,
                                                                      org.web3j.protocol.exceptions.TransactionException
        Execute method "transferFrom" in KIP-17 standard contract.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         String from = "0x{fromAddress}";
         String to = "0x{toAddress}";
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.transferFrom(from, to, tokenId);
         
         
        Parameters:
        from - The current owner of the NFT
        to - The new owner
        tokenId - The NFT identifier to transfer
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • transferFrom

        public TransactionReceipt.TransactionReceiptData transferFrom​(java.lang.String from,
                                                                      java.lang.String to,
                                                                      java.math.BigInteger tokenId,
                                                                      SendOptions sendParam)
                                                               throws java.lang.NoSuchMethodException,
                                                                      java.io.IOException,
                                                                      java.lang.InstantiationException,
                                                                      java.lang.ClassNotFoundException,
                                                                      java.lang.IllegalAccessException,
                                                                      java.lang.reflect.InvocationTargetException,
                                                                      org.web3j.protocol.exceptions.TransactionException
        Execute method "transferFrom" in KIP-17 standard contract.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         String from = "0x{fromAddress}";
         String to = "0x{toAddress}";
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.transferFrom(from, to, tokenId, sendOptions);
         
         
        Parameters:
        from - The current owner of the NFT
        to - The new owner
        tokenId - The NFT identifier to transfer
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • safeTransferFrom

        public TransactionReceipt.TransactionReceiptData safeTransferFrom​(java.lang.String from,
                                                                          java.lang.String to,
                                                                          java.math.BigInteger tokenId)
                                                                   throws java.lang.NoSuchMethodException,
                                                                          java.io.IOException,
                                                                          java.lang.InstantiationException,
                                                                          java.lang.ClassNotFoundException,
                                                                          java.lang.IllegalAccessException,
                                                                          java.lang.reflect.InvocationTargetException,
                                                                          org.web3j.protocol.exceptions.TransactionException
        Execute method "safeTransferFrom" in KIP-17 standard contract.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         String from = "0x{fromAddress}";
         String to = "0x{toAddress}";
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.safeTransferFrom(from, to, tokenId);
         
         
        Parameters:
        from - The current owner of the NFT
        to - The new owner
        tokenId - The NFT identifier to transfer
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • safeTransferFrom

        public TransactionReceipt.TransactionReceiptData safeTransferFrom​(java.lang.String from,
                                                                          java.lang.String to,
                                                                          java.math.BigInteger tokenId,
                                                                          SendOptions sendParam)
                                                                   throws java.lang.NoSuchMethodException,
                                                                          java.io.IOException,
                                                                          java.lang.InstantiationException,
                                                                          java.lang.ClassNotFoundException,
                                                                          java.lang.IllegalAccessException,
                                                                          java.lang.reflect.InvocationTargetException,
                                                                          org.web3j.protocol.exceptions.TransactionException
        Execute method "safeTransferFrom" in KIP-17 standard contract.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         String from = "0x{fromAddress}";
         String to = "0x{toAddress}";
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.safeTransferFrom(from, to, tokenId, sendOptions);
         
         
        Parameters:
        from - The current owner of the NFT
        to - The new owner
        tokenId - The NFT identifier to transfer
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • safeTransferFrom

        public TransactionReceipt.TransactionReceiptData safeTransferFrom​(java.lang.String from,
                                                                          java.lang.String to,
                                                                          java.math.BigInteger tokenId,
                                                                          java.lang.String data)
                                                                   throws java.lang.NoSuchMethodException,
                                                                          java.io.IOException,
                                                                          java.lang.InstantiationException,
                                                                          java.lang.ClassNotFoundException,
                                                                          java.lang.IllegalAccessException,
                                                                          java.lang.reflect.InvocationTargetException,
                                                                          org.web3j.protocol.exceptions.TransactionException
        Execute method "safeTransferFrom" in KIP-17 standard contract.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         String from = "0x{fromAddress}";
         String to = "0x{toAddress}";
         BigInteger tokenId = BigInteger.ONE;
         String data = "data";
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.safeTransferFrom(from, to, tokenId, data);
         
         
        Parameters:
        from - The current owner of the NFT
        to - The new owner
        tokenId - The NFT identifier to transfer
        data - Additional data with no specified format, sent in call to "to"
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • safeTransferFrom

        public TransactionReceipt.TransactionReceiptData safeTransferFrom​(java.lang.String from,
                                                                          java.lang.String to,
                                                                          java.math.BigInteger tokenId,
                                                                          java.lang.String data,
                                                                          SendOptions sendParam)
                                                                   throws java.lang.NoSuchMethodException,
                                                                          java.io.IOException,
                                                                          java.lang.InstantiationException,
                                                                          java.lang.ClassNotFoundException,
                                                                          java.lang.IllegalAccessException,
                                                                          java.lang.reflect.InvocationTargetException,
                                                                          org.web3j.protocol.exceptions.TransactionException
        Execute method "safeTransferFrom" in KIP-17 standard contract.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         String from = "0x{fromAddress}";
         String to = "0x{toAddress}";
         BigInteger tokenId = BigInteger.ONE;
         String data = "data";
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.safeTransferFrom(from, to, tokenId, data, sendOptions);
         
         
        Parameters:
        from - The current owner of the NFT
        to - The new owner
        tokenId - The NFT identifier to transfer
        data - Additional data with no specified format, sent in call to "to"
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • addMinter

        public TransactionReceipt.TransactionReceiptData addMinter​(java.lang.String account)
                                                            throws java.lang.NoSuchMethodException,
                                                                   java.io.IOException,
                                                                   java.lang.InstantiationException,
                                                                   java.lang.ClassNotFoundException,
                                                                   java.lang.IllegalAccessException,
                                                                   java.lang.reflect.InvocationTargetException,
                                                                   org.web3j.protocol.exceptions.TransactionException
        Execute method "addMinter" in KIP-17 standard contract.

        Caller must have "Minter" permission.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         String account = "0x{accountAddress}";
         TransactionReceipt.TransactionReceiptData receipt = kip17.addMinter(account);
         
         
        Parameters:
        account - The account to be given the minting permission
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • addMinter

        public TransactionReceipt.TransactionReceiptData addMinter​(java.lang.String account,
                                                                   SendOptions sendParam)
                                                            throws java.lang.NoSuchMethodException,
                                                                   java.io.IOException,
                                                                   java.lang.InstantiationException,
                                                                   java.lang.ClassNotFoundException,
                                                                   java.lang.IllegalAccessException,
                                                                   java.lang.reflect.InvocationTargetException,
                                                                   org.web3j.protocol.exceptions.TransactionException
        Execute method "addMinter" in KIP-17 standard contract.

        Caller must have "Minter" permission.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         String account = "0x{address}";
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.addMinter(account, sendOptions);
         
         
        Parameters:
        account - The account to be given the minting permission
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • renounceMinter

        public TransactionReceipt.TransactionReceiptData renounceMinter()
                                                                 throws java.lang.NoSuchMethodException,
                                                                        java.io.IOException,
                                                                        java.lang.InstantiationException,
                                                                        java.lang.ClassNotFoundException,
                                                                        java.lang.IllegalAccessException,
                                                                        java.lang.reflect.InvocationTargetException,
                                                                        org.web3j.protocol.exceptions.TransactionException
        Execute method "renounceMinter" in KIP-17 standard contract.

        Caller must have "Minter" permission.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.renounceMinter();
         
         
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • renounceMinter

        public TransactionReceipt.TransactionReceiptData renounceMinter​(SendOptions sendParam)
                                                                 throws java.lang.NoSuchMethodException,
                                                                        java.io.IOException,
                                                                        java.lang.InstantiationException,
                                                                        java.lang.ClassNotFoundException,
                                                                        java.lang.IllegalAccessException,
                                                                        java.lang.reflect.InvocationTargetException,
                                                                        org.web3j.protocol.exceptions.TransactionException
        Execute method "renounceMinter" in KIP-17 standard contract.

        Caller must have "Minter" permission.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.renounceMinter(amount);
         
         
        Parameters:
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • mint

        public TransactionReceipt.TransactionReceiptData mint​(java.lang.String to,
                                                              java.math.BigInteger tokenId)
                                                       throws java.lang.NoSuchMethodException,
                                                              java.io.IOException,
                                                              java.lang.InstantiationException,
                                                              java.lang.ClassNotFoundException,
                                                              java.lang.IllegalAccessException,
                                                              java.lang.reflect.InvocationTargetException,
                                                              org.web3j.protocol.exceptions.TransactionException
        Execute method "mint" in KIP-17 standard contract.

        Caller must have "Minter" permission.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         String to = "0x{address}";
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.mint(to, tokenId);
         
         
        Parameters:
        to - The account that will receive the minted token
        tokenId - The NFT identifier to be minted
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • mint

        public TransactionReceipt.TransactionReceiptData mint​(java.lang.String to,
                                                              java.math.BigInteger tokenId,
                                                              SendOptions sendParam)
                                                       throws java.lang.NoSuchMethodException,
                                                              java.io.IOException,
                                                              java.lang.InstantiationException,
                                                              java.lang.ClassNotFoundException,
                                                              java.lang.IllegalAccessException,
                                                              java.lang.reflect.InvocationTargetException,
                                                              org.web3j.protocol.exceptions.TransactionException
        Execute method "mint" in KIP-17 standard contract.

        Caller must have "Minter" permission.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         String to = "0x{address}";
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.mint(to, tokenId, sendOptions);
         
         
        Parameters:
        to - The account that will receive the minted token
        tokenId - The NFT identifier to be minted
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • mintWithTokenURI

        public TransactionReceipt.TransactionReceiptData mintWithTokenURI​(java.lang.String to,
                                                                          java.math.BigInteger tokenId,
                                                                          java.lang.String tokenURI)
                                                                   throws java.lang.NoSuchMethodException,
                                                                          java.io.IOException,
                                                                          java.lang.InstantiationException,
                                                                          java.lang.ClassNotFoundException,
                                                                          java.lang.IllegalAccessException,
                                                                          java.lang.reflect.InvocationTargetException,
                                                                          org.web3j.protocol.exceptions.TransactionException
        Execute method "mintWithTokenURI" in KIP-17 standard contract.

        Caller must have Minter permission.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         String to = "0x{address}";
         BigInteger tokenId = BigInteger.ONE;
         String tokenURI = "tokenURI";
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.mintWithTokenURI(to, tokenId, tokenURI);
         
         
        Parameters:
        to - The account that will receive the minted token
        tokenId - The NFT identifier to be minted
        tokenURI - The NFT URI(Uniform Resource Identifier) to be minted
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • mintWithTokenURI

        public TransactionReceipt.TransactionReceiptData mintWithTokenURI​(java.lang.String to,
                                                                          java.math.BigInteger tokenId,
                                                                          java.lang.String tokenURI,
                                                                          SendOptions sendParam)
                                                                   throws java.lang.NoSuchMethodException,
                                                                          java.io.IOException,
                                                                          java.lang.InstantiationException,
                                                                          java.lang.ClassNotFoundException,
                                                                          java.lang.IllegalAccessException,
                                                                          java.lang.reflect.InvocationTargetException,
                                                                          org.web3j.protocol.exceptions.TransactionException
        Execute method "mintWithTokenURI" in KIP-17 standard contract.

        Caller must have Minter permission.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         String to = "0x{address}";
         BigInteger tokenId = BigInteger.ONE;
         String tokenURI = "tokenURI";
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.mintWithTokenURI(to, tokenId, tokenURI, sendOptions);
         
         
        Parameters:
        to - The account that will receive the minted token
        tokenId - The NFT identifier to be minted
        tokenURI - The NFT URI(Uniform Resource Identifier) to be minted
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • burn

        public TransactionReceipt.TransactionReceiptData burn​(java.math.BigInteger tokenId)
                                                       throws java.lang.NoSuchMethodException,
                                                              java.io.IOException,
                                                              java.lang.InstantiationException,
                                                              java.lang.ClassNotFoundException,
                                                              java.lang.IllegalAccessException,
                                                              java.lang.reflect.InvocationTargetException,
                                                              org.web3j.protocol.exceptions.TransactionException
        Execute method "burn" in KIP-17 standard contract.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.burn(tokenId);
         
         
        Parameters:
        tokenId - The NFT identifier to be minted
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • burn

        public TransactionReceipt.TransactionReceiptData burn​(java.math.BigInteger tokenId,
                                                              SendOptions sendParam)
                                                       throws java.lang.NoSuchMethodException,
                                                              java.io.IOException,
                                                              java.lang.InstantiationException,
                                                              java.lang.ClassNotFoundException,
                                                              java.lang.IllegalAccessException,
                                                              java.lang.reflect.InvocationTargetException,
                                                              org.web3j.protocol.exceptions.TransactionException
        Execute method "burn" in KIP-17 standard contract.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         BigInteger tokenId = BigInteger.ONE;
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.burn(tokenId);
         
         
        Parameters:
        tokenId - The NFT identifier to be minted
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • pause

        public TransactionReceipt.TransactionReceiptData pause()
                                                        throws java.lang.NoSuchMethodException,
                                                               java.io.IOException,
                                                               java.lang.InstantiationException,
                                                               java.lang.ClassNotFoundException,
                                                               java.lang.IllegalAccessException,
                                                               java.lang.reflect.InvocationTargetException,
                                                               org.web3j.protocol.exceptions.TransactionException
        Execute method "pause" in KIP-17 standard contract.

        Caller must have Pauser permission.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.pause();
         
         
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • pause

        public TransactionReceipt.TransactionReceiptData pause​(SendOptions sendParam)
                                                        throws java.lang.NoSuchMethodException,
                                                               java.io.IOException,
                                                               java.lang.InstantiationException,
                                                               java.lang.ClassNotFoundException,
                                                               java.lang.IllegalAccessException,
                                                               java.lang.reflect.InvocationTargetException,
                                                               org.web3j.protocol.exceptions.TransactionException
        Execute method "pause" in KIP-17 standard contract.

        Caller must have Pauser permission.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.pause(sendOptions);
         
         
        Parameters:
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • unpause

        public TransactionReceipt.TransactionReceiptData unpause()
                                                          throws java.lang.NoSuchMethodException,
                                                                 java.io.IOException,
                                                                 java.lang.InstantiationException,
                                                                 java.lang.ClassNotFoundException,
                                                                 java.lang.IllegalAccessException,
                                                                 java.lang.reflect.InvocationTargetException,
                                                                 org.web3j.protocol.exceptions.TransactionException
        Execute method "unpause" in KIP-17 standard contract.

        Caller must have Pauser permission.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.unpause();
         
         
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • unpause

        public TransactionReceipt.TransactionReceiptData unpause​(SendOptions sendParam)
                                                          throws java.lang.NoSuchMethodException,
                                                                 java.io.IOException,
                                                                 java.lang.InstantiationException,
                                                                 java.lang.ClassNotFoundException,
                                                                 java.lang.IllegalAccessException,
                                                                 java.lang.reflect.InvocationTargetException,
                                                                 org.web3j.protocol.exceptions.TransactionException
        Execute method "unpause" in KIP-17 standard contract.

        Caller must have Pauser permission.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.unpause(sendOptions);
         
         
        Parameters:
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • addPauser

        public TransactionReceipt.TransactionReceiptData addPauser​(java.lang.String account)
                                                            throws java.lang.NoSuchMethodException,
                                                                   java.io.IOException,
                                                                   java.lang.InstantiationException,
                                                                   java.lang.ClassNotFoundException,
                                                                   java.lang.IllegalAccessException,
                                                                   java.lang.reflect.InvocationTargetException,
                                                                   org.web3j.protocol.exceptions.TransactionException
        Execute method "addPauser" in KIP-17 standard contract.

        Caller must have Pauser permission.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         String account = "0x{accountAddress}";
         TransactionReceipt.TransactionReceiptData receipt = kip17.addPauser(account);
         
         
        Parameters:
        account - The account to be given the pausing permission
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • addPauser

        public TransactionReceipt.TransactionReceiptData addPauser​(java.lang.String account,
                                                                   SendOptions sendParam)
                                                            throws java.lang.NoSuchMethodException,
                                                                   java.io.IOException,
                                                                   java.lang.InstantiationException,
                                                                   java.lang.ClassNotFoundException,
                                                                   java.lang.IllegalAccessException,
                                                                   java.lang.reflect.InvocationTargetException,
                                                                   org.web3j.protocol.exceptions.TransactionException
        Execute method "addPauser" in KIP-17 standard contract.

        Caller must have Pauser permission.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         String account = "0x{accountAddress}";
         TransactionReceipt.TransactionReceiptData receipt = kip17.addPauser(account, sendOptions);
         
         
        Parameters:
        account - The account to be given the pausing permission
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • renouncePauser

        public TransactionReceipt.TransactionReceiptData renouncePauser()
                                                                 throws java.lang.NoSuchMethodException,
                                                                        java.io.IOException,
                                                                        java.lang.InstantiationException,
                                                                        java.lang.ClassNotFoundException,
                                                                        java.lang.IllegalAccessException,
                                                                        java.lang.reflect.InvocationTargetException,
                                                                        org.web3j.protocol.exceptions.TransactionException
        Execute method "renouncePauser" in KIP-17 standard contract.

        Caller must have Pauser permission.

        It will use default sendOptions in contract instance to passed sendOptions.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
         kip17.setDefaultSendOptions(sendOptions);
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.renouncePauser();
         
         
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException
      • renouncePauser

        public TransactionReceipt.TransactionReceiptData renouncePauser​(SendOptions sendParam)
                                                                 throws java.lang.NoSuchMethodException,
                                                                        java.io.IOException,
                                                                        java.lang.InstantiationException,
                                                                        java.lang.ClassNotFoundException,
                                                                        java.lang.IllegalAccessException,
                                                                        java.lang.reflect.InvocationTargetException,
                                                                        org.web3j.protocol.exceptions.TransactionException
        Execute method "renouncePauser" in KIP-17 standard contract.

        Caller must have Pauser permission.

        If a gas value in sendOptions has null, it will automatically set gas value through estimateGas().

        Example :
         
         String sender = "0x{senderAddress}";
         SendOptions sendOptions = new SendOptions();
         sendOptions.setFrom(sender);
        
         TransactionReceipt.TransactionReceiptData receipt = kip17.renouncePauser(sendOptions);
         
         
        Parameters:
        sendParam - A SendOptions need to execute contract's method.
        Returns:
        TransactionReceipt.TransactionReceiptData
        Throws:
        java.lang.NoSuchMethodException
        java.io.IOException
        java.lang.InstantiationException
        java.lang.ClassNotFoundException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        org.web3j.protocol.exceptions.TransactionException