conflux-sponsor-faucet v1.0.0

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
    */
   constructor(url, address)

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

   async getFaucetParams() -> 
   {
     	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
   }

ERROR CODE

Address Check

1. ERROR_ADDRESS_IS_NOT_CONTRACT // 申请地址不是合约

For Gas

1. ERROR_GAS_CANNOT_REPLACE_THIRD_PARTY_SPONSOR // 无法替换第三方赞助者
2. ERROR_GAS_FAUCET_OUT_OF_MONEY // faucet 余额不足
3. ERROR_GAS_SPONSORED_FUND_UNUSED // 已申请赞助未使用
4. ERROR_GAS_OVER_GAS_TOTAL_LIMIT // 超过gas 赞助总额上限

For storage/collateral

1. ERROR_COLLATERAL_FAUCET_OUT_OF_MONEY // faucet 余额不足
2. ERROR_COLLATERAL_SPONSORED_FUND_UNUSED // 已申请赞助未使用
3. ERROR_COLLATERAL_OVER_COLLATERAL_TOTAL_LIMIT //超过collateral 赞助总额上限