aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/clef/intapi_changelog.md
diff options
context:
space:
mode:
authorMartin Holst Swende <martin@swende.se>2018-04-16 20:04:32 +0800
committerPéter Szilágyi <peterke@gmail.com>2018-04-16 20:04:32 +0800
commitec3db0f56c779387132dcf2049ed32bf4ed34a4f (patch)
treed509c580e02053fd133b0402c0838940d4b871d2 /cmd/clef/intapi_changelog.md
parentde2a7bb764c82dbaa80d37939c5862358174bc6e (diff)
downloaddexon-ec3db0f56c779387132dcf2049ed32bf4ed34a4f.tar.gz
dexon-ec3db0f56c779387132dcf2049ed32bf4ed34a4f.tar.zst
dexon-ec3db0f56c779387132dcf2049ed32bf4ed34a4f.zip
cmd/clef, signer: initial poc of the standalone signer (#16154)
* signer: introduce external signer command * cmd/signer, rpc: Implement new signer. Add info about remote user to Context * signer: refactored request/response, made use of urfave.cli * cmd/signer: Use common flags * cmd/signer: methods to validate calldata against abi * cmd/signer: work on abi parser * signer: add mutex around UI * cmd/signer: add json 4byte directory, remove passwords from api * cmd/signer: minor changes * cmd/signer: Use ErrRequestDenied, enable lightkdf * cmd/signer: implement tests * cmd/signer: made possible for UI to modify tx parameters * cmd/signer: refactors, removed channels in ui comms, added UI-api via stdin/out * cmd/signer: Made lowercase json-definitions, added UI-signer test functionality * cmd/signer: update documentation * cmd/signer: fix bugs, improve abi detection, abi argument display * cmd/signer: minor change in json format * cmd/signer: rework json communication * cmd/signer: implement mixcase addresses in API, fix json id bug * cmd/signer: rename fromaccount, update pythonpoc with new json encoding format * cmd/signer: make use of new abi interface * signer: documentation * signer/main: remove redundant option * signer: implement audit logging * signer: create package 'signer', minor changes * common: add 0x-prefix to mixcaseaddress in json marshalling + validation * signer, rules, storage: implement rules + ephemeral storage for signer rules * signer: implement OnApprovedTx, change signing response (API BREAKAGE) * signer: refactoring + documentation * signer/rules: implement dispatching to next handler * signer: docs * signer/rules: hide json-conversion from users, ensure context is cleaned * signer: docs * signer: implement validation rules, change signature of call_info * signer: fix log flaw with string pointer * signer: implement custom 4byte databsae that saves submitted signatures * signer/storage: implement aes-gcm-backed credential storage * accounts: implement json unmarshalling of url * signer: fix listresponse, fix gas->uint64 * node: make http/ipc start methods public * signer: add ipc capability+review concerns * accounts: correct docstring * signer: address review concerns * rpc: go fmt -s * signer: review concerns+ baptize Clef * signer,node: move Start-functions to separate file * signer: formatting
Diffstat (limited to 'cmd/clef/intapi_changelog.md')
-rw-r--r--cmd/clef/intapi_changelog.md86
1 files changed, 86 insertions, 0 deletions
diff --git a/cmd/clef/intapi_changelog.md b/cmd/clef/intapi_changelog.md
new file mode 100644
index 000000000..7d2a897ea
--- /dev/null
+++ b/cmd/clef/intapi_changelog.md
@@ -0,0 +1,86 @@
+### Changelog for internal API (ui-api)
+
+### 2.0.0
+
+* Modify how `call_info` on a transaction is conveyed. New format:
+
+```
+{
+ "jsonrpc": "2.0",
+ "id": 2,
+ "method": "ApproveTx",
+ "params": [
+ {
+ "transaction": {
+ "from": "0x82A2A876D39022B3019932D30Cd9c97ad5616813",
+ "to": "0x07a565b7ed7d7a678680a4c162885bedbb695fe0",
+ "gas": "0x333",
+ "gasPrice": "0x123",
+ "value": "0x10",
+ "nonce": "0x0",
+ "data": "0x4401a6e40000000000000000000000000000000000000000000000000000000000000012",
+ "input": null
+ },
+ "call_info": [
+ {
+ "type": "WARNING",
+ "message": "Invalid checksum on to-address"
+ },
+ {
+ "type": "WARNING",
+ "message": "Tx contains data, but provided ABI signature could not be matched: Did not match: test (0 matches)"
+ }
+ ],
+ "meta": {
+ "remote": "127.0.0.1:54286",
+ "local": "localhost:8550",
+ "scheme": "HTTP/1.1"
+ }
+ }
+ ]
+}
+```
+
+#### 1.2.0
+
+* Add `OnStartup` method, to provide the UI with information about what API version
+the signer uses (both internal and external) aswell as build-info and external api.
+
+Example call:
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 1,
+ "method": "OnSignerStartup",
+ "params": [
+ {
+ "info": {
+ "extapi_http": "http://localhost:8550",
+ "extapi_ipc": null,
+ "extapi_version": "2.0.0",
+ "intapi_version": "1.2.0"
+ }
+ }
+ ]
+}
+```
+
+#### 1.1.0
+
+* Add `OnApproved` method
+
+#### 1.0.0
+
+Initial release.
+
+### Versioning
+
+The API uses [semantic versioning](https://semver.org/).
+
+TLDR; Given a version number MAJOR.MINOR.PATCH, increment the:
+
+* MAJOR version when you make incompatible API changes,
+* MINOR version when you add functionality in a backwards-compatible manner, and
+* PATCH version when you make backwards-compatible bug fixes.
+
+Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.