Comment on page
ICON Governance SCORE APIs

This page needs to be updated for ICON 2.0 new system SCORE architecture.
This document describes APIs that Governance SCORE provides.
Overview
Governance SCORE is a built-in SCORE that manages adjustable characteristics of ICON network.
Address: cx0000000000000000000000000000000000000001
Value Types
By default, Values in all JSON-RPC messages are in string form. The most commonly used Value types are as follows.
Value Type
Description
Example
T_ADDR_EOA
"hx" + 40 digits HEX string
hxbe258ceb872e08851f1f59694dac2558708ece11
T_ADDR_SCORE
"cx" + 40 digits HEX string
cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32
T_HASH
"0x" + 64 digits HEX string
0xc71303ef8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238
T_INT
"0x" + lowercase HEX string
0xa
T_STR
string
hello
T_IMPORT_STMT
Import statement string
"{'json': [], 'os': ['path'], 'base.exception': ['ExceptionCode']}"
T_BIN_DATA
"0x" + lowercase HEX string (the length of string should be even)
0x34b2
T_SIG
base64 encoded string
VAia7YZ2Ji6igKWzjR2YsGa2m53nKPrfK7uXYW78QLE+ATehAVZPC40szvAiA6NEU5gCYB4c4qaQzqDh2ugcHgA=
Import statement
Grammar
import_stmt: "{" import_element ("," import_element) "}" 
 import_element: (import_name | import_from) 
 import_name: dotted_name ": []" 
 Import_from: dotted_name ": [" dotted_names "]" 
 dotted_names: dotted_name ("," dotted_name)  
 dotted_name: "'"NAME ("." NAME)*"'" 
 NAME: Not an empty string
Examples
python import
import statement
import json
{ 'json' : [] }
from json import *
{ 'json' : [] }
from os import path
{ 'os' : ['path'] }
from base.exception import ExceptionCode
{ 'base.exception' : ['ExceptionCode'] }
import json 
 from os import path 
 from base.exception import ExceptionCode 

{ 'json' : [], 'os' : ['path'], 'base.exception' : ['ExceptionCode'] }
Methods List
Query methods
​getScoreStatus​
​getStepPrice​
​getStepCosts​
​getMaxStepLimit​
​isInScoreBlackList​
​getVersion​
​isInImportWhiteList​
​getServiceConfig​
​getRevision​
​getProposal​
​getProposals​
Invoke methods
​acceptScore​
​rejectScore​
​addAuditor​
​removeAuditor​
​registerProposal​
​cancelProposal​
​voteProposal​
Eventlog
​Accepted​
​Rejected​
​StepPriceChanged​
​RevisionChanged​
​MaliciousScore​
​PRepDisqualified​
​IRepChanged​
​NetworkProposalRegistered​
​NetworkProposalCanceled​
​NetworkProposalVoted​
​NetworkProposalApproved​
Query Methods
Query method does not change state. Read-only.
getScoreStatus
Queries the current status of the given SCORE.
current indicates the currently active SCORE instance, while next is the SCORE code that has been requested to install or update, but not activated yet.
[Fee 2.0] Checks the deposit information of the given SCORE.
Parameters
Key
Value Type
Description
address
T_ADDR_SCORE
SCORE address whose status be checked
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "to": "cx0000000000000000000000000000000000000001",
        "dataType": "call",
        "data": {
            "method": "getScoreStatus",
            "params": {
                "address": "cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32"
            }
        }
    }
}
Response: SCORE install case
// Response - install requested: under auditing
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "next": {
            "status": "pending",
            "deployTxHash": "0xe0f6dc6607aa9b5550cd1e6d57549f67fe9718654cde15258922d0f88ff58b27"
        }
    }
}
// Response - audit completed: accepted
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "current": {
            "status": "active",
            "deployTxHash": "0xe0f6dc6607aa9b5550cd1e6d57549f67fe9718654cde15258922d0f88ff58b27",
            "auditTxHash": "0x644dd57fbb65b49a49bcaf5e7685e01d53dc321f1cfb7dbbf8f4306265745292"
        }
    }
}
// Response - audit completed: rejected
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "next": {
            "status": "rejected",
            "deployTxHash": "0xe0f6dc6607aa9b5550cd1e6d57549f67fe9718654cde15258922d0f88ff58b27",
            "auditTxHash": "0x644dd57fbb65b49a49bcaf5e7685e01d53dc321f1cfb7dbbf8f4306265745292"
        }
    }
}
Response: SCORE update case
// Response - update requested: under auditing
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "current": {
            "status": "active",
            "deployTxHash": "0xe0f6dc6607aa9b5550cd1e6d57549f67fe9718654cde15258922d0f88ff58b207",
            "auditTxHash": "0x644dd57fbb65b49a49bcaf5e7685e01d53dc321f1cfb7dbbf8f4306265745292"
        },
        "next": {
            "status": "pending",
            "deployTxHash": "0xe0f6dc6607aa9b5550cd1e6d57549f67fe9718654cde15258922d0f88ff58b207"
        }
    }
}
// Response - update requested, audit completed: rejected
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "current": {
            "status": "active",
            "deployTxHash": "0xe0f6dc6607aa9b5550cd1e6d57549f67fe9718654cde15258922d0f88ff58b27",
            "auditTxHash": "0x644dd57fbb65b49a49bcaf5e7685e01d53dc321f1cfb7dbbf8f4306265745292"
        },
        "next": {
            "status": "rejected",
            "deployTxHash": "0xe0f6dc6607aa9b5550cd1e6d57549f67fe9718654cde15258922d0f88ff58b27",
            "auditTxHash": "0x644dd57fbb65b49a49bcaf5e7685e01d53dc321f1cfb7dbbf8f4306265745292"
        }
    }
}
Response: (Fee 2.0) SCORE deposit status
depositInfo field will be shown when there is a deposit in the SCORE.
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "current": {
            "status": "active",
            "deployTxHash": "0x19793f41b8e64fc31190c6a70a103103da1f4bc81bc829fa72c852a5e388fe8c"
        },
        "depositInfo": {
            "scoreAddress": "cx216e1468b780ac1b54c328d19ea23a35a6899e55",
            "deposits": [
                {
                    "id": "0x64b118d4a3c2b3b93362a0f3ea06e5519de42449523465265b85509041e69011",
                    "sender": "hxe7af5fcfd8dfc67530a01a0e403882687528dfcb",
                    "depositAmount": "0x10f0cf064dd59200000",
                    "depositUsed": "0x0",
                    "created": "0x16",
                    "expires": "0x13c696",
                    "virtualStepIssued": "0x9502f9000",
                    "virtualStepUsed": "0x329a6"
                }
            ],
            "availableVirtualStep": "0x9502c665a",
            "availableDeposit": "0xf3f20b8dfa69d00000"
        }
    }
}
Response: error case
{
    "jsonrpc": "2.0",
    "id": 100,
    "error": {
        "code": -32032,
        "message": "SCORE not found"
    }
}
getStepPrice
Returns the current step price in loop.
Parameters
None
Returns
T_INT - integer of the current step price in loop (1 ICX == 10^18 loop).
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "to": "cx0000000000000000000000000000000000000001",
        "dataType": "call",
        "data": {
            "method": "getStepPrice"
        }
    }
}
Response
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": "0x2540be400"
}
getStepCosts
Returns a table of the step costs for each actions.
Parameters
None
Returns
T_DICT - a dict: key - camel-cased action strings, value - step costs in integer
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "to": "cx0000000000000000000000000000000000000001",
        "dataType": "call",
        "data": {
            "method": "getStepCosts"
        }
    }
}
Response
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "default": "0x186a0",
        "contractCall": "0x61a8",
        "contractCreate": "0x3b9aca00",
        "contractUpdate": "0x5f5e1000",
        "contractDestruct": "-0x11170",
        "contractSet": "0x7530",
        "get": "0x0",
        "set": "0x140",
        "replace": "0x50",
        "delete": "-0xf0",
        "input": "0xc8",
        "eventLog": "0x64",
        "apiCall": "0x2710"
    }
}
getMaxStepLimit
Returns the maximum step limit value that any SCORE execution should be bounded by.
Parameters
Key
Value Type
Description
contextType
string
'invoke' for sendTransaction, 'query' for call
Returns
T_INT - integer of the maximum step limit
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "to": "cx0000000000000000000000000000000000000001",
        "dataType": "call",
        "data": {
            "method": "getMaxStepLimit",
            "params": {
                "contextType": "invoke"
            }
        }
    }
}
Response
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": "0x9502f900"
}
isInScoreBlackList
Returns "0x1" if the given address is in the deployer list.
Parameters
Key
Value Type
Description
address
T_ADDR_SCORE
SCORE address to query
Returns
T_INT - "0x1" if the SCORE address is in the black list, otherwise "0x0"
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "to": "cx0000000000000000000000000000000000000001",
        "dataType": "call",
        "data": {
            "method": "isInScoreBlackList",
            "params": {
                "address": "cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32"
            }
        }
    }
}
Response
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": "0x1"
}
getVersion
Returns the version of Governance SCORE
Returns
T_STR - version string
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "to": "cx0000000000000000000000000000000000000001",
        "dataType": "call",
        "data": {
            "method": "getVersion"
        }
    }
}
Response
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": "0.0.7"
}
isInImportWhiteList
Returns True if import statement is in the import white list.
Parameters
Key
Value Type
Description
importStmt
T_IMPORT_STMT
Import statement
Returns
T_INT - "0x1" if the import statement is in the import white list, otherwise "0x0"
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "to": "cx0000000000000000000000000000000000000001",
        "dataType": "call",
        "data": {
            "method": "isInImportWhiteList",
            "params": {
                "importStmt": "{'json': [], 'os': ['path'], 'base.exception': ['ExceptionCode']}"
            }
        }
    }
}
Response
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": "0x0"
}
getServiceConfig
Returns table about server config.
Parameters
None
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "to": "cx0000000000000000000000000000000000000001",
        "dataType": "call",
        "data": {
            "method": "getServiceConfig"
        }
    }
}
Response
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "FEE": "0x1",
        "AUDIT": "0x1",
        "DEPLOYER_WHITE_LIST": "0x0",
        "SCORE_PACKAGE_VALIDATOR": "0x1"
    }
}
getRevision
Returns info about revision.
Parameters
None
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "to": "cx0000000000000000000000000000000000000001",
        "dataType": "call",
        "data": {
            "method": "getRevision"
        }
    }
}
Response
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "code": "0x4",
        "name": "1.3.0"
    }
}
getProposal
Query information about the network proposal.
Parameters
Key
Value Type
Description
id
T_HASH
Transaction hash of the registered network proposal
Returns
T_DICT - Information of the network proposal in dict
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "version": "0x3",
        "from": "hx8f21e5c54f006b6a5d5fe65486908592151a7c57",
        "to": "cx0000000000000000000000000000000000000001",
        "timestamp": "0x563a6cf330136",
        "dataType": "call",
        "data": {
            "method": "getProposal",
            "params": {
                "id": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"
            }
        }
    }
}
Response
{
    "jsonrpc": "2.0",
    "id": 100,
    "result": {
        "id" : "0xb903239f8543d0..",
        "proposer" : "hxbe258ceb872e08851f1f59694dac2558708ece11",  
          "proposerName" : "P-Rep A",
          "status" : "0x0",
        "startBlockHeight" : "0x1",
        "endBlockHeight" : "0x65",
        "vote": {
            "agree": {
                "list":[{
                    "id": "0xb903239f854..",
                    "timestamp": "0x563a6cf330136",
                    "address": "hxe7af5fcfd8dfc67530a01a0e403882687528dfcb",
                    "name": "P-Rep B",
                    "amount": "0x1"
                }, .. ],
                "amount": "0x12345"
            },
            "disagree": {
                "list": [{
                    "id": "0xa803239f854..",
                    "timestamp": "0x563a6cf330136",
                    "address": "hxbe258ceb872e08851f1f59694dac2558708ece11",
                    "name": "P-Rep C",
                    "amount": "0x1"
                }, .. ],
                "amount": "0x123"
            },
            "noVote": {
                "list": ["hx31258ceb872e08851f1f59694dac2558708ece11", .. , "hx31258ceb872e08851f1f59694dac2558708eceff"],
                "amount": "0x12312341234a"
            },
        },
        "contents": {
            "title": "Disqualify P-Rep C",
            "description": "P-Rep C does not maintain node",
            "type": "0x3",
            "value": {
                "address": "hxbe258ceb872e08851f1f59694dac2558708ece11"
            }
        }
    }
}
getProposals
Query all of the network proposals.
Parameters
Key
Value Type
Description
type
T_INT
Type for querying (optional)
status
T_INT
Status for querying (optional)
Returns
T_LIST - List of summarized information of network proposals in dict.
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 100,
    "method": "icx_call",
    "params": {
        "version": "0x3",
        "from": "hx8f21e5c54f006b6a5d5fe65486908592151a7c57",
        "to": "cx0000000000000000000000000000000000000001",
        "timestamp": "0x563a6cf330136",
        "dataType": "call",
        "data": {
            "method": "getProposals",
            "params": {
                "type": "0x3",
                "status": "0x0"
            }
        }
    }
}
Response
{  
   "jsonrpc":"2.0",
   "id":1234,
   "result":{  
      "proposals":[  
         {  
            "id":"0xb903239f8543..",
            "proposer":"hxbe258ceb872e08851f1f59694dac2558708ece11",
            "proposerName":"P-Rep A",
            "status":"0x0",
            "startBlockHeight":"0x1",
            "endBlockHeight":"0x65",
            "vote":{  
               "agree":{  
                  "count":"0x1",
                  "amount":"0x12312341234a"
               },
               "disagree":{  
                  "count":"0x1",
                  "amount":"0x12312341234a"
               },
               "noVote":{  
                  "count":"0x1",
                  "amount":"0x12312341234a"
               }
            },
            "contents":{  
               "title":"Disqualify P-Rep C",
               "description":"P-Rep C does not maintain node",
               "type":"0x3",
               "value":{  
                  "address":"hxbe258ceb872e08851f1f59694dac2558708ece11"
               }
            }
         }, .. ]
   }
}
Invoke Methods
Invoke method can initiate state transition.
acceptScore
Accepts SCORE deployment request.
This method can be invoked only from the addresses that are in the auditor list.
The accepted SCORE will be executing from the next block.
Parameters
Key
Value Type
Description
txHash
T_HASH
Transaction hash of the SCORE deploy transaction.
Examples
Request
{
    "jsonrpc": "2.0",
    "id": 1234,
    "method": "icx_sendTransaction",
    "params": {
        "version": "0x3",
        "from": "hxbe258ceb872e08851f1f59694dac2558708ece11",
        "to": "cx0000000000000000000000000000000000000001",
        "stepLimit": "0x12345",
        "timestamp": "0x563a6cf330136",
        "nonce": "0x1",
        "signature": "VAia7YZ2Ji6igKWzjR2YsGa2m53nKPrfK7uXYW78QLE+ATehAVZPC40szvAiA6NEU5gCYB4c4qaQzqDh2ugcHgA=",
        "dataType": "call",
        "data": {
            "method": "acceptScore",
            "params": {
                "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"
            }
        }
    }
}
rejectScore
Value Type	Description	Example
T_ADDR_EOA	"hx" + 40 digits HEX string	hxbe258ceb872e08851f1f59694dac2558708ece11
T_ADDR_SCORE	"cx" + 40 digits HEX string	cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32
T_HASH	"0x" + 64 digits HEX string	0xc71303ef8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238
T_INT	"0x" + lowercase HEX string	0xa
T_STR	string	hello
T_IMPORT_STMT	Import statement string	"{'json': [], 'os': ['path'], 'base.exception': ['ExceptionCode']}"
T_BIN_DATA	"0x" + lowercase HEX string (the length of string should be even)	0x34b2
T_SIG	base64 encoded string	VAia7YZ2Ji6igKWzjR2YsGa2m53nKPrfK7uXYW78QLE+ATehAVZPC40szvAiA6NEU5gCYB4c4qaQzqDh2ugcHgA=
python import	import statement
import json	{ 'json' : [] }
from json import *	{ 'json' : [] }
from os import path	{ 'os' : ['path'] }
from base.exception import ExceptionCode	{ 'base.exception' : ['ExceptionCode'] }
import json from os import path from base.exception import ExceptionCode	{ 'json' : [], 'os' : ['path'], 'base.exception' : ['ExceptionCode'] }
Key	Value Type	Description
address	T_ADDR_SCORE	SCORE address whose status be checked
Key	Value Type	Description
contextType	string	'invoke' for sendTransaction, 'query' for call
Key	Value Type	Description
importStmt	T_IMPORT_STMT	Import statement
Key	Value Type	Description
type	T_INT	Type for querying (optional)
status	T_INT	Status for querying (optional)
Key	Value Type	Description
txHash	T_HASH	Transaction hash of the SCORE deploy transaction.