conflux-sponsor-faucet

A faucet for sponsoring contracts running on Conflux Chain. Before your apply, make sure you understand how the internal contracts works.

Conflux SponsorFaucet SDK

The SponsorFaucet returns a rawTx with suggested gas and input data.

1. Constructor for faucet

   /**
    * @param url The conflux provider url 
    * @param address The faucet contract address
    * @param lastAddress The last faucet contract address 
    */
   constructor(url, address, lastAddress)

2. apply gas / collateral sponsorship

   /**
    * @param dapp The address of dapp 
    */
   async apply(dapp) -> rawTx

3. check if appliable

   /**
    * @param dapp The address of dapp 
    */
   async checkAppliable(dapp) -> 
   {	
     	flag: bool,
     	message: string //error message and empty if success 
   }

4. withdraw from faucet

    /**
    * @param address address to accept fund 
    * @param amount amount to withdraw
    */
   async withdraw(address, amount) -> rawTx

5. set bounds for sponsorship

   /**
    * @param gasTotalLimit total sponsored gas limit
    * @param collateralTotalLimit total sponsored collateral limit
    * @param gasBound single sponsor gas bound
    * @param collateralBound single sponsor collateral bound
    * @param upperBound upperBound for single tx gas
    */
   async setBounds(gasTotalLimit, collateralTotalLimit, gasBound, collateralBound, upperBound) -> rawTx

6. pause/unpause the faucet

   async pause() -> rawTx
   async unpause() -> rawTx

7. get bounds and limits of faucet

   /**
    * @param dapp contract address
    */
   async getFaucetParams(dapp) -> 
   {
     	gas_total_limit: JSBI,
     	collateral_total_limit: JSBI,
     	gas_bound: JSBI,
     	collateral_bound: JSBI,
     	upper_bound: JSBI
   }

8. get accumulated sponsored amouts of a contract/dapp

   async getAmountAccumulated(dapp) -> 
   {
    	gas_amount_accumulated: JSBI,
    	collateral_amount_accumulated: JSBI
   }

9. get all info for a contract

   /**
    * @param dapp contract address
    */
   async search(dapp) ->
   {
      gas_amount_accumulated: BigNumber { s: 1, e: 0, c: [ 0 ] },
      collateral_amount_accumulated: BigNumber { s: 1, e: 0, c: [ 0 ] },
      gas_total_limit: BigNumber { s: 1, e: 20, c: [ 1000000 ] },
      collateral_total_limit: BigNumber { s: 1, e: 21, c: [ 60000000 ] },
      gas_bound: BigNumber { s: 1, e: 19, c: [ 100000 ] },
      collateral_bound: BigNumber { s: 1, e: 20, c: [ 6000000 ] },
      upper_bound: BigNumber { s: 1, e: 10, c: [ 10000000000 ] },
      sponsorInfo: {
          sponsorBalanceForCollateral: '0x167bcfff8f71430000',
          sponsorBalanceForGas: '0x1158e460910a76576',
          sponsorForCollateral: '0x8097e818c2c2c1524c41f0fcbda143520046d117',
          sponsorForGas: '0x8097e818c2c2c1524c41f0fcbda143520046d117',
          sponsorGasBound: '0x2540be400'
      },
      isAppliable: {
          flag: false,
          message: 'ERROR_COLLATERAL_CANNOT_REPLACE_OLD_FAUCET'
      }
   }

ERROR CODE

Address Check

1. ERROR_ADDRESS_IS_NOT_CONTRACT // Application address is not a contract

For Gas

1. ERROR_GAS_CANNOT_REPLACE_THIRD_PARTY_SPONSOR // Faucet cannot replace third-party sponsors
2. ERROR_GAS_FAUCET_OUT_OF_MONEY // Faucet insufficient balance
3. ERROR_GAS_SPONSORED_FUND_UNUSED // Sponsored but not used
4. ERROR_GAS_OVER_GAS_TOTAL_LIMIT // Exceeds the total gas sponsorship limit

For storage/collateral

1. ERROR_COLLATERAL_CANNOT_REPLACE_OLD_FAUCET // Contract upgraded, please contact the administrator
2. ERROR_COLLATERAL_CANNOT_REPLACE_THIRD_PARTY_SPONSOR // Faucet cannot replace third-party sponsors
3. ERROR_COLLATERAL_FAUCET_OUT_OF_MONEY // Faucet insufficient balance
4. ERROR_COLLATERAL_SPONSORED_FUND_UNUSED // Sponsored but not used
5. ERROR_COLLATERAL_OVER_COLLATERAL_TOTAL_LIMIT // Exceeds the maximum amount of collateral sponsorship