Merge pull request #684 from jimni1222/publicKlayAPIs

Added newly added klay APIs for upper/lower bound gas price
klaytn · Jul 15, 2022 · 380dadf · 380dadf
2 parents b5a88f8 + 8d053e2
commit 380dadf
Show file tree

Hide file tree

Showing 5 changed files with 262 additions and 0 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/caver-rpc/src/klay.js b/packages/caver-rpc/src/klay.js
@@ -2006,6 +2006,42 @@ class Klay {
                 call: 'klay_maxPriorityFeePerGas',
                 params: 0,
             }),
+            /**
+             * Returns an upper bound gas price.
+             *
+             * @memberof Klay
+             * @method getUpperBoundGasPrice
+             * @instance
+             *
+             * @example
+             * const result = await caver.rpc.klay.getUpperBoundGasPrice()
+             *
+             * @param {function} [callback] Optional callback, returns an error object as the first parameter and the result as the second.
+             * @return {Promise<string>} An upper bound gas price
+             */
+            new Method({
+                name: 'getUpperBoundGasPrice',
+                call: 'klay_upperBoundGasPrice',
+                params: 0,
+            }),
+            /**
+             * Returns a lower bound gas price.
+             *
+             * @memberof Klay
+             * @method getLowerBoundGasPrice
+             * @instance
+             *
+             * @example
+             * const result = await caver.rpc.klay.getLowerBoundGasPrice()
+             *
+             * @param {function} [callback] Optional callback, returns an error object as the first parameter and the result as the second.
+             * @return {Promise<string>} A lower bound gas price
+             */
+            new Method({
+                name: 'getLowerBoundGasPrice',
+                call: 'klay_lowerBoundGasPrice',
+                params: 0,
+            }),
             /**
              * An object defines an access list result that includes accessList and gasUsed.
              *

diff --git a/test/packages/caver.rpc.js b/test/packages/caver.rpc.js
@@ -576,6 +576,42 @@ describe('caver.rpc.klay', () => {
         }).timeout(100000)
     })
 
+    context('caver.rpc.klay.getUpperBoundGasPrice', () => {
+        it('CAVERJS-UNIT-RPC-035: should call klay_upperBoundGasPrice', async () => {
+            sandbox.stub(caver.rpc.klay._requestManager, 'send').callsFake((data, callback) => {
+                expect(data.method).to.equal('klay_upperBoundGasPrice')
+                callback(undefined, {})
+            })
+
+            await caver.rpc.klay.getUpperBoundGasPrice()
+        }).timeout(100000)
+
+        it('CAVERJS-UNIT-RPC-036: should return an upper bound gas price', async () => {
+            const ret = await caver.rpc.klay.getUpperBoundGasPrice()
+            const gasPrice = await caver.rpc.klay.getGasPrice()
+            expect(_.isString(ret)).to.be.true
+            expect(caver.utils.hexToNumber(ret) >= caver.utils.hexToNumber(gasPrice)).to.be.true
+        }).timeout(100000)
+    })
+
+    context('caver.rpc.klay.getLowerBoundGasPrice', () => {
+        it('CAVERJS-UNIT-RPC-037: should call klay_lowerBoundGasPrice', async () => {
+            sandbox.stub(caver.rpc.klay._requestManager, 'send').callsFake((data, callback) => {
+                expect(data.method).to.equal('klay_lowerBoundGasPrice')
+                callback(undefined, {})
+            })
+
+            await caver.rpc.klay.getLowerBoundGasPrice()
+        }).timeout(100000)
+
+        it('CAVERJS-UNIT-RPC-038: should return an lower bound gas price', async () => {
+            const ret = await caver.rpc.klay.getLowerBoundGasPrice()
+            const gasPrice = await caver.rpc.klay.getGasPrice()
+            expect(_.isString(ret)).to.be.true
+            expect(caver.utils.hexToNumber(ret) <= caver.utils.hexToNumber(gasPrice)).to.be.true
+        }).timeout(100000)
+    })
+
     context('caver.rpc.klay.createAccessList', () => {
         const txArgs = {
             from: '0x3bc5885c2941c5cda454bdb4a8c88aa7f248e312',

diff --git a/types/packages/caver-rpc/src/klay.d.ts b/types/packages/caver-rpc/src/klay.d.ts
@@ -251,6 +251,12 @@ export class Klay {
     getMaxPriorityFeePerGas(
         callback?: (error: Error, result: string) => void
     ): Promise<string>
+    getUpperBoundGasPrice(
+        callback?: (error: Error, result: string) => void
+    ): Promise<string>
+    getLowerBoundGasPrice(
+        callback?: (error: Error, result: string) => void
+    ): Promise<string>
     createAccessList(
         callObject: CallObject,
         blockNumber: BlockNumber,

diff --git a/types/test/rpc-test.ts b/types/test/rpc-test.ts
@@ -1133,6 +1133,19 @@ rpc.klay.getGasPrice()
 // $ExpectType Promise<string>
 rpc.klay.getGasPrice((err: Error, ret: string) => {})
 
+// $ExpectType Promise<string>
+rpc.klay.getMaxPriorityFeePerGas()
+// $ExpectType Promise<string>
+rpc.klay.getMaxPriorityFeePerGas((err: Error, ret: string) => {})
+// $ExpectType Promise<string>
+rpc.klay.getUpperBoundGasPrice()
+// $ExpectType Promise<string>
+rpc.klay.getUpperBoundGasPrice((err: Error, ret: string) => {})
+// $ExpectType Promise<string>
+rpc.klay.getLowerBoundGasPrice()
+// $ExpectType Promise<string>
+rpc.klay.getLowerBoundGasPrice((err: Error, ret: string) => {})
+
 // $ExpectType Promise<string>
 rpc.klay.getGasPriceAt(0)
 // $ExpectType Promise<string>