Class KIP17Wrapper


  • public class KIP17Wrapper
    extends java.lang.Object
    Representing a KIP17Wrapper 1. This class wraps all static methods of KIP17 2. This class should be accessed via `caver.kct.kip17`
    • Constructor Detail

      • KIP17Wrapper

        public KIP17Wrapper​(Caver caver)
        Creates a KIP17Wrapper instance.
        Parameters:
        caver - A Caver instance.
    • Method Detail

      • create

        public KIP17 create()
                     throws java.io.IOException
        Creates a KIP17 instance.
        Example :
         
         KIP17 kip17 = caver.kct.kip17.create();
         
         
        Returns:
        KIP17
        Throws:
        java.io.IOException
      • create

        public KIP17 create​(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:
        contractAddress - A contract address.
        Returns:
        KIP17
        Throws:
        java.io.IOException
      • deploy

        public KIP17 deploy​(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:
        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 KIP17 deploy​(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:
        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 KIP17 deploy​(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:
        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 KIP17 deploy​(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:
        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 KIP17 deploy​(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:
        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 KIP17 deploy​(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:
        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 KIP17 deploy​(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:
        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 KIP17 deploy​(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:
        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:
        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 java.util.Map<java.lang.String,​java.lang.Boolean> detectInterface​(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:
        contractAddress - A contract instance
        Returns:
        Map<String, Boolean>