From 52db64bd3469a4cae5b0dc5d969628ff0921e9c8 Mon Sep 17 00:00:00 2001 From: MarkoAT Date: Mon, 1 Apr 2024 22:57:25 +0200 Subject: [PATCH] improved API grouping --- _api_docs/deprecated/core_add_multisig_key.md | 57 ------------------ .../core_add_multisig_transaction.md | 60 ------------------- .../core_add_multisig_tx_signature.md | 59 ------------------ ...ore_change_multisig_required_signatures.md | 58 ------------------ .../deprecated/core_delete_multisig_key.md | 56 ----------------- _api_docs/{ => names}/core_extend_name.md | 0 _api_docs/{ => names}/core_recover_name.md | 0 _api_docs/{ => names}/core_register_name.md | 0 .../{ => names}/core_update_name_capacity.md | 0 .../{ => names}/core_update_name_record.md | 0 _api_docs/{ => names}/dlt_regname_list.md | 0 11 files changed, 290 deletions(-) delete mode 100644 _api_docs/deprecated/core_add_multisig_key.md delete mode 100644 _api_docs/deprecated/core_add_multisig_transaction.md delete mode 100644 _api_docs/deprecated/core_add_multisig_tx_signature.md delete mode 100644 _api_docs/deprecated/core_change_multisig_required_signatures.md delete mode 100644 _api_docs/deprecated/core_delete_multisig_key.md rename _api_docs/{ => names}/core_extend_name.md (100%) rename _api_docs/{ => names}/core_recover_name.md (100%) rename _api_docs/{ => names}/core_register_name.md (100%) rename _api_docs/{ => names}/core_update_name_capacity.md (100%) rename _api_docs/{ => names}/core_update_name_record.md (100%) rename _api_docs/{ => names}/dlt_regname_list.md (100%) diff --git a/_api_docs/deprecated/core_add_multisig_key.md b/_api_docs/deprecated/core_add_multisig_key.md deleted file mode 100644 index 65944ab..0000000 --- a/_api_docs/deprecated/core_add_multisig_key.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Add MultiSig Key -type: core ---- -## Add MultiSig Key -Adds the specified address to the 'allowed signers' list of the target multisig wallet. If the wallet is not a multisig wallet, this command will change it into one. -Note: After this transaction is processed, the required signatures does not change. You must also issue a transaction `changemultisigs` to adjust the number of required signatures. -In the event where the wallet is newly converted into a multisig wallet, the required signers value will be 1, meaning that *either* of the addresses may use the wallet. - -### Method: `addmultisigkey` -### Input parameters: - -| Parameter | Type | Required | Description | -| --- | --- | --- | --- | -| wallet | String | Yes | The wallet where the specified signer will be added as an allowed signer. | -| signer | String | Yes | The signing address which will be permitted to use the target wallet. | - -### Errors: - -| Error | Description | -| --- | --- | -| RPC_INVALID_PARAMS | One or more of the required parameters are missing or invalid. | -| RPC_INTERNAL_ERROR | An unknown error occurred while creating the transaction - please check the node's log file. | - -### Output: -- success: the transaction is added to the Transaction Pool and broadcast to the network and the Transaction object is returned. -- fail: JSON encoded details with a non-null error and a null result - -### Example: -``` -{ - "result": { - "id": "16-4aLyz5LksuySmtqHvs5YfE36uym8pqK9gh7E2bUtiqiiwjFNmvapaS55CyJ7", - "version": 3, - "blockHeight": "16", - "nonce": "22160", - "signature": "4bd9a2560d6be7..6350c4662b1edb43", - "pubKey": "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv", - "data": "4d73012400..d9ee46c99b5b06baad", - "timestamp": "1549980713", - "type": "5", - "amount": "0.00000000", - "applied": "0", - "checksum": "ff0717335924a41fb2eed9decd4786d6c8d9596e98afb3897185bdb44701806555da8ca9b3724758b2edcfdd", - "from": { - "1": "0.00010000" - }, - "to": { - "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv": "0.00000000" - }, - "fee": "0.00010000", - "totalAmount": "0.00010000" - }, - "error": null, - "id": null -} -``` \ No newline at end of file diff --git a/_api_docs/deprecated/core_add_multisig_transaction.md b/_api_docs/deprecated/core_add_multisig_transaction.md deleted file mode 100644 index e3faf65..0000000 --- a/_api_docs/deprecated/core_add_multisig_transaction.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Add MultiSig Transaction -type: core ---- -## Add MultiSig Transaction -Creates an initial transaction for a Multi-Signature wallet. The transaction is broadcast to the network, but not executed until the minimum number of required signatures are added. - -### Method: `addmultisigtransaction` -### Input parameters: - -| Parameter | Type | Required | Description | -| --- | --- | --- | --- | -| to | String | Yes | A list of destination addresses and amounts for each in the same format as for `addtransaction` | -| fee | Number | No | Desired transaction fee per KB, if you would like to increase it from the default value (lower values will be rejected. | -| from | String | No | An address of the originating Multisig wallet which will be deducted. | - -### Errors: - -| Error | Description | -| --- | --- | -| RPC_WALLET_ERROR | The specified wallet is not a multisig wallet. | -| RPC_WALLET_INSUFFICIENT_FUNDS | The balance on the `from` wallet is too low for this transaction. | -| RPC_WALLET_INSUFFICIENT_FUNDS | An unknown error occurred while creating the transaction - please check the node's log file. | -| RPC_INTERNAL_ERROR | An unknown error occurred in the node. Please check the node log for details. | - -### Output: -- success: the transaction is added to the Transaction Pool and broadcast to the network and the Transaction object is returned. -- fail: JSON encoded details with a non-null error and a null result - -### Example: -GET http://localhost:8081/addmultisigtransaction?from=1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv&to=153xXfVi1sznPcRqJur8tutgrZecNVYGSzetp47bQvRfNuDix_15000 - -``` -{ - "result": { - "id": "15-CoxywacZbqiK1sf84R6nuYyW32u5sDbTqD4VZgpeGChw", - "version": 2, - "blockHeight": "15", - "nonce": "47961", - "signature": "537b159c193..c2ce2d7c2", - "data": "7dc3adb039..997aa3a8452a6844cc4e6c6", - "pubKey": "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv", - "timeStamp": "1547587273", - "type": "4", - "amount": "15000.00000000", - "applied": "0", - "checksum": "0765a87d5393ad8742de1f8a9ce39f2ae1f1a5a6e7bafc066e454c1856661326", - "from": { - "0":"15000.00015000", - }, - "to": { - "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv": "15000.00000000" - }, - "fee": "0.00015000", - "totalAmount": "15000.00015000" - }, - "error": null, - "id": null -} -``` diff --git a/_api_docs/deprecated/core_add_multisig_tx_signature.md b/_api_docs/deprecated/core_add_multisig_tx_signature.md deleted file mode 100644 index 29093d5..0000000 --- a/_api_docs/deprecated/core_add_multisig_tx_signature.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Add MultiSig TX Signature -type: core ---- -## Add MultiSig TX Signature -Signs an already existing Multi-Signature wallet transaction, thereby permitting the change on the wallet or the withdrawal of funds. -Note: If there are more allowed signers than the required signatures value, any combination of allowed signatures will work, as long as they reach the required minimum number of signatures that the wallet defines. - -### Method: `addmultisigtxsignature` -### Input parameters: - -| Parameter | Type | Required | Description | -| --- | --- | --- | --- | -| wallet | String | Yes | The destination wallet - wallet, which will be changed by the transaction `origtx`. | -| origtx | String | Yes | The multisig transaction you are validating with additional signature. | - -### Errors: - -| Error | Description | -| --- | --- | -| RPC_INVALID_PARAMETER | One or more of the required parameters are missing or invalid. | -| RPC_TRANSACTION_ERROR | The transaction specified by `origtx` does not exist. | -| RPC_INTERNAL_ERROR | An unknown error occurred while creating the transaction - please check the node's log file. | - -### Output: -- success: the transaction is added to the Transaction Pool and broadcast to the network and the Transaction object is returned. -- fail: JSON encoded details with a non-null error and a null result - -### Example: -GET http://localhost:8081/addmultisigtransaction?wallet=1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv&origtx=15-CoxywacZbqiK1sf84R6nuYyW32u5sDbTqD4VZgpeGChw - -``` -{ - "result": { - "id": "50-kyfpUJEqKjJwcFv2MzdazCJcpwhqeYW3GwQM6W3tDE4DWDCL6gkwHHWKSiNy", - "version": 3, - "blockHeight": "50", - "nonce": "17678", - "signature": "8ce677e9488d89a32..5f5195399b343", - "pubKey": "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv", - "data": "4d734000000032..0010100000000", - "timestamp": "1549981848", - "type": "6", - "amount": "0.00000000", - "applied": "0", - "checksum": "082cfa49212251a10be37bcc23f78e18b1faef6e64c822c2288294675c8120a13814ebd2ec5326e00a777733", - "from": { - "1": "0.00010000" - }, - "to": { - "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv": "0.00000000" - }, - "fee": "0.00010000", - "totalAmount": "0.00010000" - }, - "error": null, - "id": null -} -``` \ No newline at end of file diff --git a/_api_docs/deprecated/core_change_multisig_required_signatures.md b/_api_docs/deprecated/core_change_multisig_required_signatures.md deleted file mode 100644 index 4833a41..0000000 --- a/_api_docs/deprecated/core_change_multisig_required_signatures.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Change MultiSig Required Signatures -type: core ---- -## Change MultiSig Required Signatures -Changes the required number of signatures on a multisig wallet. The required number of signatures is the minimum number of additional signatures for any transaction performed on a multisig wallet before the transaction is executed. -Note: The required number of signatures cannot be increased to such a value that would make the wallet unusuable. (More required signatures than allowed signers. -Note: Any combination of allowed signatures will enable the transaction, as long as the number of required signatures is reached. - -### Method: `changemultisigs` -### Input parameters: - -| Parameter | Type | Required | Description | -| --- | --- | --- | --- | -| wallet | String | Yes | The multisig wallet which will have its required signatures alterred. | -| sigs | String | Yes | New number of signatures. | - -### Errors: - -| Error | Description | -| --- | --- | -| RPC_INVALID_PARAMS | One or more of the required parameters are missing or invalid. | -| RPC_INVALID_PARAMETER | The `sigs` parameter was not a number or was out of range. | -| RPC_INTERNAL_ERROR | An unknown error occurred while creating the transaction - please check the node's log file. | - -### Output: -- success: the transaction is added to the Transaction Pool and broadcast to the network and the Transaction object is returned. -- fail: JSON encoded details with a non-null error and a null result - -### Example: -``` -{ - "result": { - "id": "22-kqKnZqEUnXuHwKVU1hNU1sFtbeY49ymr9S6BPHr3n9CVbN6jadWaJ9MXhw12", - "version": 3, - "blockHeight": "22", - "nonce": "55626", - "signature": "63f03ab39d93267..2559fad1763510c9851", - "pubKey": "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv", - "data": "4d730302..9ee46c99b5b06baad", - "timestamp": "1549980883", - "type": "5", - "amount": "0.00000000", - "applied": "0", - "checksum": "f22dda59a601ff28451136c0f8f84bfa9eef59d4b56c3218c635ddd11badc7c963c5f55041de9b7b347630b9", - "from": { - "1": "0.00010000" - }, - "to": { - "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv": "0.00000000" - }, - "fee": "0.00010000", - "totalAmount": "0.00010000" - }, - "error": null, - "id": null -} -``` diff --git a/_api_docs/deprecated/core_delete_multisig_key.md b/_api_docs/deprecated/core_delete_multisig_key.md deleted file mode 100644 index 88e75b2..0000000 --- a/_api_docs/deprecated/core_delete_multisig_key.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Delete MultiSig Key -type: core ---- -## Delete MultiSig Key -Deletes the specified address from the 'allowed signers' list of the target multisig wallet. If all other signers, except the original wallet owner, are removed, the wallet will be converted into a normal wallet. -Note: You cannot use this to remove the original owner of the wallet. You cannot remove a signer if doing so will leave the wallet unusuable (if the change would bring the number of allowed signers below the required signatures). - -### Method: `delmultisigkey` -### Input parameters: - -| Parameter | Type | Required | Description | -| --- | --- | --- | --- | -| wallet | String | Yes | The wallet where the specified signer will be removed from allowed signers. | -| signer | String | Yes | The signing address which will be removed from the target wallet. | - -### Errors: - -| Error | Description | -| --- | --- | -| RPC_INVALID_PARAMS | One or more of the required parameters are missing or invalid. | -| RPC_INTERNAL_ERROR | An unknown error occurred while creating the transaction - please check the node's log file. | - -### Output: -- success: the transaction is added to the Transaction Pool and broadcast to the network and the Transaction object is returned. -- fail: JSON encoded details with a non-null error and a null result - -### Example: -``` -{ - "result": { - "id": "25-27QZ5kmBCWp8e7ufkbJrxX2HqaFCQakHk7SsDvfea4HeBXMqV28yCw6HXXihb", - "version": 3, - "blockHeight": "25", - "nonce": "84286", - "signature": "6789fc53819b..5783981f06947c7b21", - "pubKey": "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv", - "data": "4d730224..dc101d9ee46c99b5b06baad", - "timestamp": "1549981011", - "type": "5", - "amount": "0.00000000", - "applied": "0", - "checksum": "7fe9182d6de44916ab9d074c46c214adfcdf1fe2e80f3a42e2074f04be8f0a38e66caeacab69e0fc8e1d48f1", - "from": { - "1": "0.00010000" - }, - "to": { - "1CQy94c7iNv1QGv9P4UQmgLEPMNzrkq89gdVWiq87CundLWKv": "0.00000000" - }, - "fee": "0.00010000", - "totalAmount": "0.00010000" - }, - "error": null, - "id": null -} -``` diff --git a/_api_docs/core_extend_name.md b/_api_docs/names/core_extend_name.md similarity index 100% rename from _api_docs/core_extend_name.md rename to _api_docs/names/core_extend_name.md diff --git a/_api_docs/core_recover_name.md b/_api_docs/names/core_recover_name.md similarity index 100% rename from _api_docs/core_recover_name.md rename to _api_docs/names/core_recover_name.md diff --git a/_api_docs/core_register_name.md b/_api_docs/names/core_register_name.md similarity index 100% rename from _api_docs/core_register_name.md rename to _api_docs/names/core_register_name.md diff --git a/_api_docs/core_update_name_capacity.md b/_api_docs/names/core_update_name_capacity.md similarity index 100% rename from _api_docs/core_update_name_capacity.md rename to _api_docs/names/core_update_name_capacity.md diff --git a/_api_docs/core_update_name_record.md b/_api_docs/names/core_update_name_record.md similarity index 100% rename from _api_docs/core_update_name_record.md rename to _api_docs/names/core_update_name_record.md diff --git a/_api_docs/dlt_regname_list.md b/_api_docs/names/dlt_regname_list.md similarity index 100% rename from _api_docs/dlt_regname_list.md rename to _api_docs/names/dlt_regname_list.md