github.com/niluplatform/go-nilu@v1.7.4-0.20200912082737-a0cb0776d52c/cmd/clef/intapi_changelog.md (about)

     1  ### Changelog for internal API (ui-api)
     2  
     3  ### 2.0.0
     4  
     5  * Modify how `call_info` on a transaction is conveyed. New format:
     6  
     7  ```
     8  {
     9    "jsonrpc": "2.0",
    10    "id": 2,
    11    "method": "ApproveTx",
    12    "params": [
    13      {
    14        "transaction": {
    15          "from": "0x82A2A876D39022B3019932D30Cd9c97ad5616813",
    16          "to": "0x07a565b7ed7d7a678680a4c162885bedbb695fe0",
    17          "gas": "0x333",
    18          "gasPrice": "0x123",
    19          "value": "0x10",
    20          "nonce": "0x0",
    21          "data": "0x4401a6e40000000000000000000000000000000000000000000000000000000000000012",
    22          "input": null
    23        },
    24        "call_info": [
    25          {
    26            "type": "WARNING",
    27            "message": "Invalid checksum on to-address"
    28          },
    29          {
    30            "type": "WARNING",
    31            "message": "Tx contains data, but provided ABI signature could not be matched: Did not match: test (0 matches)"
    32          }
    33        ],
    34        "meta": {
    35          "remote": "127.0.0.1:54286",
    36          "local": "localhost:8550",
    37          "scheme": "HTTP/1.1"
    38        }
    39      }
    40    ]
    41  }
    42  ```
    43  
    44  #### 1.2.0
    45  
    46  * Add `OnStartup` method, to provide the UI with information about what API version
    47  the signer uses (both internal and external) aswell as build-info and external api.
    48  
    49  Example call:
    50  ```json
    51  {
    52    "jsonrpc": "2.0",
    53    "id": 1,
    54    "method": "OnSignerStartup",
    55    "params": [
    56      {
    57        "info": {
    58          "extapi_http": "http://localhost:8550",
    59          "extapi_ipc": null,
    60          "extapi_version": "2.0.0",
    61          "intapi_version": "1.2.0"
    62        }
    63      }
    64    ]
    65  }
    66  ```
    67  
    68  #### 1.1.0
    69  
    70  * Add `OnApproved` method
    71  
    72  #### 1.0.0
    73  
    74  Initial release.
    75  
    76  ### Versioning
    77  
    78  The API uses [semantic versioning](https://semver.org/).
    79  
    80  TLDR; Given a version number MAJOR.MINOR.PATCH, increment the:
    81  
    82  * MAJOR version when you make incompatible API changes,
    83  * MINOR version when you add functionality in a backwards-compatible manner, and
    84  * PATCH version when you make backwards-compatible bug fixes.
    85  
    86  Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.