koilib 2.7.0 → 3.1.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,
         });
@@ -77,6 +77,10 @@ There are 4 principal classes:
 - **Serializer**: Class with the protocol buffers definitions to
   serialize/deserialize data types.
 
+### Examples
+
+#### Send tokens, get balance
+
 The following code shows how to sign a transaction, broadcast
 a transaction, and read contracts.
 
@@ -88,7 +92,7 @@ a transaction, and read contracts.
   signer.provider = provider;
   const koinContract = new Contract({
     id: "19JntSm8pSNETT9aHTwAUHC5RMoaSmgZPJ",
-    abi: utils.Krc20Abi,
+    abi: utils.tokenAbi,
     provider,
     signer,
   });
@@ -105,11 +109,16 @@ a transaction, and read contracts.
   });
 
   // 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();
@@ -117,11 +126,13 @@ a transaction, and read contracts.
 
   // read the balance
   const { result } = await koin.balanceOf(signer.getAddress());
-  console.log(balance.result);
+  console.log(result);
 })();
 ```
 
-It's also possible to upload contracts. First, follow the instructions in [koinos-cdt](https://github.com/koinos/koinos-cdt) to compile the contracts as wasm files. Then you can use koilib to deploy them.
+#### Upload contract
+
+It's also possible to upload contracts. First, follow the instructions in [koinos-sdk](https://github.com/koinos/koinos-sdk-cpp) (for C++ developers) or [koinos-as-sdk-examples](https://github.com/roaminroe/koinos-as-sdk-examples) (for TypeScript developers) to compile the contracts as wasm files. Then you can use koilib to deploy them.
 
 ```typescript
 (async () => {
@@ -133,13 +144,58 @@ 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}`);
 })();
 ```
 
+You can also upload a contract in a new address. It is not required that this new address has funds, you just have to set your principal wallet as payer.
+
+```typescript
+(async () => {
+  // define signer, provider and bytecode
+  const provider = new Provider(["http://api.koinos.io:8080"]);
+  const accountWithFunds = Signer.fromSeed("this account has funds");
+  const newAccount = Signer.fromSeed("new account without funds");
+  accountWithFunds.provider = provider;
+  newAccount.provider = provider;
+
+  const bytecode = fs.readFileSync("my_contract.wasm");
+
+  // create contract. Set newAccount as signer
+  const contract = new Contract({
+    signer: newAccount.address,
+    provider,
+    bytecode,
+  });
+
+  // call deploy but do not broadcast the transaction.
+  // Also set the payer
+  const { transaction } = await contract.deploy({
+    payer: accountWithFunds.address,
+    sendTransaction: false,
+  });
+
+  // sign the transaction with the payer
+  await accountWithFunds.signTransaction(transaction);
+
+  // at this point the transaction will have 2 signatures:
+  // - signature of newAccount
+  // - signature of accountWithFunds
+
+  // now broadcast the transaction to deploy
+  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}`);
+})();
+```
+
 ### Create ABIs
 
 ABIs are composed of 2 elements: methods and types.
@@ -166,19 +222,19 @@ const tokenJson = require("./token-proto.json");
 const abiToken = {
   methods: {
     balanceOf: {
-      entryPoint: 0x15619248,
+      entryPoint: 0x5c721497,
       inputs: "balance_of_arguments",
       outputs: "balance_of_result",
       readOnly: true,
       defaultOutput: { value: "0" },
     },
     transfer: {
-      entryPoint: 0x62efa292,
+      entryPoint: 0x27f576ca,
       inputs: "transfer_arguments",
       outputs: "transfer_result",
     },
     mint: {
-      entryPoint: 0xc2f82bdc,
+      entryPoint: 0xdc6f17bb,
       inputs: "mint_argumnets",
       outputs: "mint_result",
     },
@@ -197,8 +253,9 @@ such cases.
 
 1. Can this library be used to create smart contracts?
 
-   No. You need to install [koinos-cdt](https://github.com/koinos/koinos-cdt) for
-   this purpose.
+   No. You need to install [koinos-sdk](https://github.com/koinos/koinos-sdk-cpp)
+   (for C++ developers) or [koinos-as-sdk-examples](https://github.com/roaminroe/koinos-as-sdk-examples)
+   (for TypeScript developers) for this purpose.
 
 2. Can this library be used to deploy smart contracts?
 
@@ -223,6 +280,12 @@ such cases.
 
 The complete documentation can be found at https://joticajulian.github.io/koilib/
 
+## Acknowledgments
+
+Many thanks to the sponsors of this library: @levineam, @Amikob, @motoeng, @isaacdozier, @imjwalker, and the private sponsors.
+
+If you would like to contribute to the development of this library consider becoming a sponsor in https://github.com/sponsors/joticajulian.
+
 ## License
 
 MIT License