Merge pull request #1096 from kaleido-io/idempotent-apis

Idempotent apis

Author: nguyer

.vscode/settings.json

@@ -9,6 +9,7 @@
     "autometa",
     "bifactory",
     "blobstore",
+    "blockchainids",
     "breq",
     "ccache",
     "contractlisteners",
@@ -41,6 +42,8 @@
     "fftypes",
     "finalizers",
     "Hyperledger",
+    "Idempotency",
+    "idempotencykey",
     "IDUUID",
     "Infof",
     "IPFS",

db/migrations/postgres/000101_add_idempotency_keys.down.sql

@@ -0,0 +1,9 @@
+BEGIN;
+
+DROP INDEX transactions_idempotency_keys;
+DROP INDEX messages_idempotency_keys;
+
+ALTER TABLE transactions DROP COLUMN idempotency_key;
+ALTER TABLE messages DROP COLUMN idempotency_key;
+
+COMMIT;

db/migrations/postgres/000101_add_idempotency_keys.up.sql

@@ -0,0 +1,9 @@
+BEGIN;
+
+ALTER TABLE transactions ADD COLUMN idempotency_key VARCHAR(256);
+ALTER TABLE messages ADD COLUMN idempotency_key VARCHAR(256);
+
+CREATE UNIQUE INDEX transactions_idempotency_keys ON transactions (namespace, idempotency_key);
+CREATE UNIQUE INDEX messages_idempotency_keys ON messages (namespace, idempotency_key);
+
+COMMIT;

db/migrations/sqlite/000101_add_idempotency_keys.down.sql

@@ -0,0 +1,5 @@
+DROP INDEX transactions_idempotency_keys;
+DROP INDEX messages_idempotency_keys;
+
+ALTER TABLE transactions DROP COLUMN idempotency_key;
+ALTER TABLE messages DROP COLUMN idempotency_key;

db/migrations/sqlite/000101_add_idempotency_keys.up.sql

@@ -0,0 +1,5 @@
+ALTER TABLE transactions ADD COLUMN idempotency_key VARCHAR(256);
+ALTER TABLE messages ADD COLUMN idempotency_key VARCHAR(256);
+
+CREATE UNIQUE INDEX transactions_idempotency_keys ON transactions (namespace, idempotency_key);
+CREATE UNIQUE INDEX messages_idempotency_keys ON messages (namespace, idempotency_key);

docs/reference/types/message.md

@@ -64,6 +64,7 @@ nav_order: 15
 | `confirmed` | The timestamp of when the message was confirmed/rejected | [`FFTime`](simpletypes#fftime) |
 | `data` | The list of data elements attached to the message | [`DataRef[]`](#dataref) |
 | `pins` | For private messages, a unique pin hash:nonce is assigned for each topic | `string[]` |
+| `idempotencyKey` | An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network | `IdempotencyKey` |
 
 ## MessageHeader
 

docs/reference/types/transaction.md

@@ -42,5 +42,6 @@ nav_order: 6
 | `namespace` | The namespace of the FireFly transaction | `string` |
 | `type` | The type of the FireFly transaction | `FFEnum`:<br/>`"none"`<br/>`"unpinned"`<br/>`"batch_pin"`<br/>`"network_action"`<br/>`"token_pool"`<br/>`"token_transfer"`<br/>`"contract_deploy"`<br/>`"contract_invoke"`<br/>`"token_approval"`<br/>`"data_publish"` |
 | `created` | The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction | [`FFTime`](simpletypes#fftime) |
+| `idempotencyKey` | An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API | `IdempotencyKey` |
 | `blockchainIds` | The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions | `string[]` |