postchain-client 1.5.9 → 1.6.0

package/README.md

@@ -28,7 +28,7 @@ const signerPubKeyB = secp256k1.publicKeyCreate(signerPrivKeyB);
 Each blockchain has a Blockchain RID (`blockchainRID`) that identifies the specific blockchain we wish to interact with. This blockchainRID should match the Blockchain RID encoded into the first block of the blockchain. How the blockchainRID is structured depends on the blockchain's creator. In this example, we use the Linux command: `echo "A blockchain example"| sha256sum`.
 
 ```typescript
-const blockchainRID =
+const blockchainRid =
   "7d565d92fd15bd1cdac2dc276cbcbc5581349d05a9e94ba919e1155ef4daf8f9";
 ```
 
@@ -37,7 +37,7 @@ Next, create a Chromia client instance and configure it with a specific set of b
 ```typescript
 const chromiaClient = await createClient({
   nodeURLPool: "http://localhost:7740",
-  blockchainRID,
+  blockchainRid,
 });
 ```
 
@@ -45,10 +45,29 @@ Connecting to a network is achieved through the Directory System Chain. The `dir
 
 ```typescript
 const chromiaClient = await createClient({
-  directoryNodeURLPool: ["url1", "url2", "url3", "etc."],
-  blockchainRID,
+  directoryNodeUrlPool: ["url1", "url2", "url3", "etc."],
+  blockchainRid,
 });
 ```
+### Failover strategies
+When initializing a client, you have the option to configure the failover strategy for the client. Additionally, you can modify certain parameters within the failover configuration, such as the number of attempts per endpoint and the interval between attempts.
+
+The Postchain client offers three failover strategies:
+#### Abort On Error
+The request strategy will abort on client error and retry
+on server error. This means that if a client error occurs, such as an
+invalid query parameter, the request strategy will not retry the query.
+However, if a server error occurs, such as a timeout or internal server
+error, the request strategy will retry the query on another node.
+
+#### Try Next On Error
+The Try Next On Error request strategy is similar to Abort On Error, but
+will also retry on client error. This means that if a client error
+occurs, the request strategy will retry the query on another node, as
+well as retrying on server error.
+
+#### Single Endpoint
+The Single Endpoint request strategy will not retry on another node.
 
 ## Queries
 
@@ -248,7 +267,37 @@ const signatureProviderB = {
   sign: askUserBToSign,
 };
 ```
+## ICCF
+Creates an [ICCF](https://docs.chromia.com/overview/cross-chain-communication) (Inter-Chain Communication Framework) proof transaction. This function generates a proof that a specific transaction has occurred on the source blockchain. The function returns a transaction object with an operation called iccf_proof and the operation that should be accompanied by the proof should be added to this transaction object. The transaction can then be signed and posted to the target blockchain.
 
+```typescript
+const managementBlockchainRid = "7d565d92fd15bd1cdac2dc276cbcbc5581349d05a9e94ba919e1155ef4daf8f9";
+
+const chromiaClient = await createClient({
+  nodeUrlPool: "<url-node-running-managementchain>",
+  managementBlockchainRid,
+});
+
+const txToProveRid: Buffer = <txRid>;
+const txToProveHash: Buffer = <txHash>;
+const txToProveSigners: Pubkey[] = [<signer1>, <signer2>];
+const sourceBlockchainRid: string = "<sourceBlockchainRid>";
+const targetBlockchainRid: string = "<targetBlockchainRid>";
+
+const { iccfTx, verifiedTx } = createIccfProofTx(chromiaClient, txToProveRID,txToProveHash,txToProveSigners, sourceBlockchainRid, targetBlockchainRid);
+```
+
+`iccfTx` is a transaction object with an operation called `iccf_proof` with argument containing the composed proof. To this transaction object you can now add the operation that will need the proof. Finally, the transaction object is ready to be signed and sent.
+
+If necessary, it is possible to solely verify whether a specific transaction has been included in the anchoring blockchain:
+```typescript
+isBlockAnchored(sourceClient, anchoringClient, txRid);
+```
+
+To create an anchoring client there is an utility function:
+```typescript
+const anchoringClient = getAnchoringClient()
+```
 ## Architecture
 
 In the Postchain client, Generic Transactions (GTX) are used to simplify user implementations of Postchain. Users do not need to invent a binary format for their transactions. The client will serialize the function calls, sign them, and send them to Postchain. Read more about GTX in the [docs](https://docs.chromia.com/category/gtx).