koilib 3.0.0 → 4.0.0

package/README.md

@@ -37,7 +37,7 @@ You can also load it directly to the browser by downloading the bunble file loca
         signer.provider = provider;
         const koinContract = new Contract({
           id: "19JntSm8pSNETT9aHTwAUHC5RMoaSmgZPJ",
-          abi: utils.Krc20Abi,
+          abi: utils.tokenAbi,
           provider,
           signer,
         });
@@ -92,28 +92,35 @@ a transaction, and read contracts.
   signer.provider = provider;
   const koinContract = new Contract({
     id: "19JntSm8pSNETT9aHTwAUHC5RMoaSmgZPJ",
-    abi: utils.Krc20Abi,
+    abi: utils.tokenAbi,
     provider,
     signer,
   });
   const koin = koinContract.functions;
 
   // optional: preformat input/output
-  koinContract.abi.methods.balanceOf.preformatInput = (owner) => ({ owner });
-  koinContract.abi.methods.balanceOf.preformatOutput = (res) =>
+  koinContract.abi.methods.balanceOf.preformat_argument = (owner) => ({
+    owner,
+  });
+  koinContract.abi.methods.balanceOf.preformat_return = (res) =>
     utils.formatUnits(res.value, 8);
-  koinContract.abi.methods.transfer.preformatInput = (input) => ({
+  koinContract.abi.methods.transfer.preformat_argument = (input) => ({
     from: signer.getAddress(),
     to: input.to,
     value: utils.parseUnits(input.value, 8),
   });
 
   // Transfer
-  const { transaction } = await koin.transfer({
+  const { transaction, receipt } = await koin.transfer({
     to: "172AB1FgCsYrRAW5cwQ8KjadgxofvgPFd6",
     value: "10.0001",
   });
-  console.log(`Transaction id ${transaction.id} submitted`);
+  console.log(`Transaction id ${transaction.id} submitted. Receipt:`);
+  console.log(receipt);
+
+  if (receipt.logs) {
+    console.log(`Transfer failed. Logs: ${receipt.logs.join(",")}`);
+  }
 
   // wait to be mined
   const blockNumber = await transaction.wait();
@@ -139,7 +146,9 @@ It's also possible to upload contracts. First, follow the instructions in [koino
 
   // create contract and deploy
   const contract = new Contract({ signer, provider, bytecode });
-  const { transaction } = await contract.deploy();
+  const { transaction, receipt } = await contract.deploy();
+  console.log("Transaction submitted. Receipt:");
+  console.log(receipt);
   // wait to be mined
   const blockNumber = await transaction.wait();
   console.log(`Contract uploaded in block number ${blockNumber}`);
@@ -161,7 +170,7 @@ You can also upload a contract in a new address. It is not required that this ne
 
   // create contract. Set newAccount as signer
   const contract = new Contract({
-    signer: newAccount.address,
+    signer: newAccount,
     provider,
     bytecode,
   });
@@ -181,7 +190,9 @@ You can also upload a contract in a new address. It is not required that this ne
   // - signature of accountWithFunds
 
   // now broadcast the transaction to deploy
-  transaction = await newAccount.sendTransaction(transaction);
+  const { receipt } = await newAccount.sendTransaction(transaction);
+  console.log("Transaction submitted. Receipt: ");
+  console.log(receipt);
   const blockNumber = await transaction.wait();
   console.log(`Contract uploaded in block number ${blockNumber}`);
 })();
@@ -213,28 +224,28 @@ const tokenJson = require("./token-proto.json");
 const abiToken = {
   methods: {
     balanceOf: {
-      entryPoint: 0x5c721497,
-      inputs: "balance_of_arguments",
-      outputs: "balance_of_result",
-      readOnly: true,
-      defaultOutput: { value: "0" },
+      entry_point: 0x5c721497,
+      argument: "balance_of_arguments",
+      return: "balance_of_result",
+      read_only: true,
+      default_output: { value: "0" },
     },
     transfer: {
-      entryPoint: 0x27f576ca,
-      inputs: "transfer_arguments",
-      outputs: "transfer_result",
+      entry_point: 0x27f576ca,
+      argument: "transfer_arguments",
+      return: "transfer_result",
     },
     mint: {
-      entryPoint: 0xdc6f17bb,
-      inputs: "mint_argumnets",
-      outputs: "mint_result",
+      entry_point: 0xdc6f17bb,
+      argument: "mint_argumnets",
+      return: "mint_result",
     },
   },
-  types: tokenJson,
+  koilib_types: tokenJson,
 };
 ```
 
-Note that this example uses "defaultOutput" for the method
+Note that this example uses "default_output" for the method
 "balanceOf". This is used when the smart contract returns an
 empty response (for instance when there are no balance records
 for a specific address) and you require a default output in
@@ -258,13 +269,14 @@ such cases.
    For the ABI you need the .proto file and the library
    [protobufjs](https://www.npmjs.com/package/protobufjs). Then follow the format
    for the ABI as described in the previous section. It's important to note that
-   this ABI is not the same ABI used in [koinos-cli](https://docs.koinos.io/architecture/contract-abi.html).
-   In particular, descriptors use different format (koilib using json format, cli
-   using binary format).
+   this ABI has a diffence with respect to the ABI used in [koinos-cli](https://docs.koinos.io/architecture/contract-abi.html).
+   In particular, koilib takes the descriptor from `koilib_types`, which is a
+   descriptor in json format, while the ABI in koinos-cli takes the descriptor from
+   `types`, which is a descriptor in binary format.
 
 4. Can this library be used to interact with smart contracts?
 
-   Yes. You can use it to call readOnly functions, or send transactions
+   Yes. You can use it to call read_only functions, or send transactions
    to the contract by calling write functions.
 
 ## Documentation