Merge pull request #741 from nohkwak/202303/newAPI

Update ChainConfig API
klaytn · Mar 16, 2023 · 5808132 · 5808132
2 parents caacaf4 + d166e40
commit 5808132
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 10 deletions.
diff --git a/packages/caver-rpc/src/governance.js b/packages/caver-rpc/src/governance.js
@@ -157,15 +157,18 @@ const Governance = function Governance(...args) {
          * @instance
          *
          * @example
+         * const result = await caver.rpc.governance.getChainConfig(0)
+         * // latest by default
          * const result = await caver.rpc.governance.getChainConfig()
          *
+         * @param {number|string} blockNumber A block number, or the hex number string to query chain configuration.
          * @param {function} [callback] Optional callback, returns an error object as the first parameter and the result as the second.
-         * @return {Promise<object>} The latest chain configuration
+         * @return {Promise<object>} The latest chain configuration, or chain configuration at the given block number.
          */
         new Method({
             name: 'getChainConfig',
-            call: 'governance_chainConfig',
-            params: 0,
+            call: 'governance_getChainConfig',
+            params: 1,
         }),
         /**
          * Returns the chain configuration at a specific block.

diff --git a/packages/caver-rpc/src/klay.js b/packages/caver-rpc/src/klay.js
@@ -2249,15 +2249,18 @@ class Klay {
              * @instance
              *
              * @example
+             * const result = await caver.rpc.klay.getChainConfig(0)
+             * // latest by default
              * const result = await caver.rpc.klay.getChainConfig()
              *
+             * @param {number|string} blockNumber A block number, or the hex number string to query chain configuration.
              * @param {function} [callback] Optional callback, returns an error object as the first parameter and the result as the second.
-             * @return {Promise<object>} The latest chain configuration
+             * @return {Promise<object>} The latest chain configuration, or chain configuration at the given block number.
              */
             new Method({
                 name: 'getChainConfig',
-                call: 'klay_chainConfig',
-                params: 0,
+                call: 'klay_getChainConfig',
+                params: 1,
             }),
             /**
              * Returns the chain configuration at a specific block.

diff --git a/test/packages/caver.rpc.js b/test/packages/caver.rpc.js
@@ -698,7 +698,7 @@ describe('caver.rpc.klay', () => {
             const klayRPCStub = sandbox
                 .stub(caver.rpc.klay.getChainConfig.method.requestManager, 'send')
                 .callsFake((payload, sendTxCallback) => {
-                    expect(payload.method).to.equal('klay_chainConfig')
+                    expect(payload.method).to.equal('klay_getChainConfig')
                     expect(payload.params.length).to.equal(caver.rpc.klay.getChainConfig.method.params)
                     const ret = {
                         chainId: 1001,
@@ -1098,7 +1098,7 @@ describe('caver.rpc.governance', () => {
             const govRPCStub = sandbox
                 .stub(caver.rpc.governance.getChainConfig.method.requestManager, 'send')
                 .callsFake((payload, sendTxCallback) => {
-                    expect(payload.method).to.equal('governance_chainConfig')
+                    expect(payload.method).to.equal('governance_getChainConfig')
                     expect(payload.params.length).to.equal(caver.rpc.governance.getChainConfig.method.params)
                     const ret = {
                         chainId: 1001,

diff --git a/types/packages/caver-klay/src/index.d.ts b/types/packages/caver-klay/src/index.d.ts
@@ -86,8 +86,6 @@ export class DeprecatedKlayRPC {
     getHeaderByHash: RpcCallToMethod['klay_getHeaderByHash']
     getBlockReceipts: RpcCallToMethod['klay_getBlockReceipts']
     getRewards: RpcCallToMethod['klay_getRewards']
-    getChainConfig: RpcCallToMethod['klay_chainConfig']
-    getChainConfigAt: RpcCallToMethod['klay_chainConfigAt']
     getNodeAddress: RpcCallToMethod['klay_nodeAddress']
     getGovParamsAt: RpcCallToMethod['klay_govParamsAt']
     getStakingInfo: RpcCallToMethod['klay_getStakingInfo']

diff --git a/types/packages/caver-rpc/src/governance.d.ts b/types/packages/caver-rpc/src/governance.d.ts
@@ -76,6 +76,7 @@ export class Governance {
     getMyVotingPower(callback?: (error: Error, result: number) => void): Promise<number>
     getMyVotes(callback?: (error: Error, result: MyVote[]) => void): Promise<MyVote[]>
     getChainConfig(callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
+    getChainConfig(blockNumber: BlockNumber, callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
     getChainConfigAt(callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
     getChainConfigAt(blockNumber: BlockNumber, callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
     getNodeAddress(callback?: (error: Error, result: string) => void): Promise<string>

diff --git a/types/packages/caver-rpc/src/klay.d.ts b/types/packages/caver-rpc/src/klay.d.ts
@@ -140,6 +140,7 @@ export class Klay {
 
     getRewards(blockNumber: BlockNumber, callback?: (error: Error, result: Header) => void): Promise<Rewards>
     getChainConfig(callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
+    getChainConfig(blockNumber: BlockNumber, callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
     getChainConfigAt(callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
     getChainConfigAt(blockNumber: BlockNumber, callback?: (error: Error, result: ChainConfig) => void): Promise<ChainConfig>
     getNodeAddress(callback?: (error: Error, result: string) => void): Promise<string>

diff --git a/types/packages/caver-rtm/src/index.d.ts b/types/packages/caver-rtm/src/index.d.ts
@@ -136,6 +136,10 @@ export default class RpcCallToMethod {
     klay_chainConfig(
         callback?: (error: Error, result: ChainConfig) => void
     ): Promise<ChainConfig>
+    klay_getChainConfig(
+        blockNumberOrHash?: BlockNumber | string,
+        callback?: (error: Error, result: ChainConfig) => void
+    ): Promise<ChainConfig>
     klay_chainConfigAt(
         blockNumberOrHash: BlockNumber | string,
         callback?: (error: Error, result: ChainConfig) => void

diff --git a/types/test/rpc-test.ts b/types/test/rpc-test.ts
@@ -1191,6 +1191,11 @@ rpc.klay.getRewardbase()
 // $ExpectType Promise<string>
 rpc.klay.getRewardbase((err: Error, ret: string) => {})
 
+// $ExpectType Promise<ChainConfig>
+rpc.klay.getChainConfig()
+// $ExpectType Promise<ChainConfig>
+rpc.klay.getChainConfig((err: Error, ret: ChainConfig) => {})
+
 // $ExpectType Promise<LogObject[]>
 rpc.klay.getFilterChanges('filterId')
 // $ExpectType Promise<LogObject[]>