koilib 5.6.1 → 6.0.0

package/src/Signer.ts

@@ -30,12 +30,10 @@ import { koinos } from "./protoModules/protocol-proto.js";
 export interface SignerInterface {
   provider?: Provider;
   getAddress: (compressed?: boolean) => string;
-  getPrivateKey: (format: "wif" | "hex", compressed?: boolean) => string;
   signHash: (hash: Uint8Array) => Promise<Uint8Array>;
   signMessage: (message: string | Uint8Array) => Promise<Uint8Array>;
 
   // Transaction
-  prepareTransaction: (tx: TransactionJson) => Promise<TransactionJson>;
   signTransaction: (
     transaction: TransactionJson | TransactionJsonWait,
     abis?: Record<string, Abi>
@@ -71,54 +69,6 @@ const btypeTransactionHeader: TypeField["subtypes"] = {
   payee: { type: "bytes", btype: "ADDRESS" },
 };
 
-const btypesOperation: TypeField["subtypes"] = {
-  upload_contract: {
-    type: "object",
-    subtypes: {
-      contract_id: { type: "bytes", btype: "CONTRACT_ID" },
-      bytecode: { type: "bytes" },
-      abi: { type: "string" },
-      authorizes_call_contract: { type: "bool" },
-      authorizes_transaction_application: { type: "bool" },
-      authorizes_upload_contract: { type: "bool" },
-    },
-  },
-  call_contract: {
-    type: "object",
-    subtypes: {
-      contract_id: { type: "bytes", btype: "CONTRACT_ID" },
-      entry_point: { type: "uint32" },
-      args: { type: "bytes" },
-    },
-  },
-  set_system_call: {
-    type: "object",
-    subtypes: {
-      call_id: { type: "uint32" },
-      target: {
-        type: "object",
-        subtypes: {
-          thunk_id: { type: "uint32" },
-          system_call_bundle: {
-            type: "object",
-            subtypes: {
-              contract_id: { type: "bytes", btype: "CONTRACT_ID" },
-              entry_point: { type: "uint32" },
-            },
-          },
-        },
-      },
-    },
-  },
-  set_system_contract: {
-    type: "object",
-    subtypes: {
-      contract_id: { type: "bytes", btype: "CONTRACT_ID" },
-      system_contract: { type: "bool" },
-    },
-  },
-};
-
 /**
  * The Signer Class contains the private key needed to sign transactions.
  * It can be created using the seed, wif, or private key
@@ -315,7 +265,7 @@ export class Signer implements SignerInterface {
    * // 5KEX4TMHG66fT7cM9HMZLmdp4hVq4LC4X2Fkg6zeypM5UteWmtd
    * ```
    */
-  getPrivateKey(format: "wif" | "hex" = "hex", compressed = false): string {
+  getPrivateKey(format: "wif" | "hex" = "hex", compressed = true): string {
     let stringPrivateKey: string;
     if (this.privateKey instanceof Uint8Array) {
       stringPrivateKey = toHexString(this.privateKey);
@@ -637,105 +587,6 @@ export class Signer implements SignerInterface {
     );
   }
 
-  /**
-   * Function to prepare a transaction
-   * @deprecated - Use [[Transaction.prepareTransaction]] instead.
-   * @param tx - Do not set the nonce to get it from the blockchain
-   * using the provider. The rc_limit is 1e8 by default.
-   * @returns A prepared transaction.
-   */
-  async prepareTransaction(tx: TransactionJson): Promise<TransactionJson> {
-    if (!tx.header) {
-      tx.header = {};
-    }
-
-    const payer = tx.header.payer ?? this.address;
-    const { payee } = tx.header;
-
-    let nonce;
-    if (tx.header.nonce === undefined) {
-      if (!this.provider)
-        throw new Error(
-          "Cannot get the nonce because provider is undefined. To skip this call set a nonce in the transaction header"
-        );
-      nonce = await this.provider.getNextNonce(payee || payer);
-    } else {
-      nonce = tx.header.nonce;
-    }
-
-    let rcLimit;
-    if (tx.header.rc_limit === undefined) {
-      if (!this.provider)
-        throw new Error(
-          "Cannot get the rc_limit because provider is undefined. To skip this call set a rc_limit in the transaction header"
-        );
-      rcLimit = await this.provider.getAccountRc(payer);
-    } else {
-      rcLimit = tx.header.rc_limit;
-    }
-
-    let chainId = tx.header.chain_id || this.chainId;
-    if (!chainId) {
-      if (!this.provider)
-        throw new Error(
-          "Cannot get the chain_id because provider is undefined. To skip this call set a chain_id in the Signer"
-        );
-      chainId = await this.provider.getChainId();
-      this.chainId = chainId;
-    }
-
-    const operationsHashes: Uint8Array[] = [];
-
-    if (tx.operations) {
-      for (let index = 0; index < tx.operations?.length; index += 1) {
-        const operationDecoded = btypeDecode(
-          tx.operations[index],
-          btypesOperation!,
-          false
-        );
-        const message = koinos.protocol.operation.create(operationDecoded);
-        const operationEncoded = koinos.protocol.operation
-          .encode(message)
-          .finish() as Uint8Array;
-        operationsHashes.push(sha256(operationEncoded));
-      }
-    }
-    const operationMerkleRoot = encodeBase64url(
-      new Uint8Array([
-        // multihash sha256: 18, 32
-        18,
-        32,
-        ...calculateMerkleRoot(operationsHashes),
-      ])
-    );
-
-    tx.header = {
-      chain_id: chainId,
-      rc_limit: rcLimit,
-      nonce,
-      operation_merkle_root: operationMerkleRoot,
-      payer,
-      ...(payee && { payee }),
-      // TODO: Option to resolve names (payer, payee)
-    };
-
-    const headerDecoded = btypeDecode(
-      tx.header,
-      btypeTransactionHeader!,
-      false
-    );
-    const message = koinos.protocol.transaction_header.create(headerDecoded);
-    const headerBytes = koinos.protocol.transaction_header
-      .encode(message)
-      .finish() as Uint8Array;
-
-    const hash = sha256(headerBytes);
-
-    // multihash 0x1220. 12: code sha2-256. 20: length (32 bytes)
-    tx.id = `0x1220${toHexString(hash)}`;
-    return tx;
-  }
-
   /**
    * Function to prepare a block
    * @param block -

package/src/Transaction.ts

@@ -2,7 +2,7 @@
 import { sha256 } from "@noble/hashes/sha256";
 import { Contract } from "./Contract";
 import { Provider } from "./Provider";
-import { Signer } from "./Signer";
+import { SignerInterface } from "./Signer";
 import {
   Abi,
   OperationJson,
@@ -84,7 +84,7 @@ export class Transaction {
   /**
    * Signer interacting with the smart contracts
    */
-  signer?: Signer;
+  signer?: SignerInterface;
 
   /**
    * Provider to connect with the blockchain
@@ -107,7 +107,7 @@ export class Transaction {
   options: TransactionOptions;
 
   constructor(c?: {
-    signer?: Signer;
+    signer?: SignerInterface;
     provider?: Provider;
     options?: TransactionOptions;
   }) {
@@ -249,7 +249,7 @@ export class Transaction {
       nonce = tx.header.nonce;
     }
 
-    let rcLimit: string;
+    let rcLimit: string | number;
     if (tx.header.rc_limit === undefined) {
       if (!provider)
         throw new Error(
@@ -368,7 +368,10 @@ export class Transaction {
     };
     if (!this.transaction.id) await this.prepare();
 
-    if (this.signer && this.signer.provider) {
+    if (!this.transaction.signatures || !this.transaction.signatures.length) {
+      if (!this.signer) {
+        throw new Error("transaction without signatures and no signer defined");
+      }
       const { transaction: tx, receipt } = await this.signer.sendTransaction(
         this.transaction,
         opts
@@ -379,9 +382,6 @@ export class Transaction {
     }
 
     if (!this.provider) throw new Error("provider not defined");
-    if (!this.transaction.signatures || !this.transaction.signatures.length) {
-      throw new Error("transaction without signatures and no signer defined");
-    }
 
     if (opts.beforeSend) {
       await opts.beforeSend(this.transaction, opts);

package/src/index.ts

@@ -1,7 +1,7 @@
 /*! koilib - MIT License (c) Julian Gonzalez (joticajulian@gmail.com) */
 // eslint-disable import/no-cycle
 export * as utils from "./indexUtils";
-export * as interfaces from "./interface";
+export * from "./interface";
 export * from "./Contract";
 export * from "./Signer";
 export * from "./Provider";

package/src/interface.ts

@@ -308,7 +308,7 @@ export interface TransactionOptions extends SendTransactionOptions {
    * is not set it will be taken by querying the
    * actual mana of the payer
    */
-  rcLimit?: string;
+  rcLimit?: string | number;
 
   /**
    * Transaction nonce
@@ -662,7 +662,7 @@ export interface TransactionHeaderJson {
   /**
    * Resource credits limit
    */
-  rc_limit?: string;
+  rc_limit?: string | number;
 
   /**
    * Account nonce
@@ -735,6 +735,12 @@ export interface BlockJson {
   [x: string]: unknown;
 }
 
+export interface BlockTopology {
+  id: string;
+  height: string;
+  previous: string;
+}
+
 export interface ValueType {
   uint64_value?: string;
   [x: string]: unknown;
@@ -752,6 +758,16 @@ export interface DecodedEventData extends EventData {
   args: Record<string, unknown>;
 }
 
+export interface StateDeltaEntry {
+  object_space: {
+    system: boolean;
+    zone: string;
+    id: number;
+  };
+  key: string;
+  value: string;
+}
+
 export interface TransactionReceipt {
   id: string;
   payer: string;
@@ -763,5 +779,6 @@ export interface TransactionReceipt {
   compute_bandwidth_used: string;
   reverted: boolean;
   events: EventData[];
+  state_delta_entries: StateDeltaEntry[];
   logs: string[];
 }

package/src/jsonDescriptors/chain-proto.json

@@ -2,7 +2,7 @@
   "nested": {
     "koinos": {
       "options": {
-        "go_package": "github.com/koinos/koinos-proto-golang/koinos"
+        "go_package": "github.com/koinos/koinos-proto-golang/v2/koinos"
       },
       "nested": {
         "block_topology": {
@@ -32,9 +32,25 @@
         },
         "protocol": {
           "options": {
-            "go_package": "github.com/koinos/koinos-proto-golang/koinos/protocol"
+            "go_package": "github.com/koinos/koinos-proto-golang/v2/koinos/protocol"
           },
           "nested": {
+            "object_space": {
+              "fields": {
+                "system": {
+                  "type": "bool",
+                  "id": 1
+                },
+                "zone": {
+                  "type": "bytes",
+                  "id": 2
+                },
+                "id": {
+                  "type": "uint32",
+                  "id": 3
+                }
+              }
+            },
             "event_data": {
               "fields": {
                 "sequence": {
@@ -338,6 +354,11 @@
                   "rule": "repeated",
                   "type": "string",
                   "id": 11
+                },
+                "state_delta_entries": {
+                  "rule": "repeated",
+                  "type": "state_delta_entry",
+                  "id": 12
                 }
               }
             },
@@ -468,6 +489,56 @@
                   "rule": "repeated",
                   "type": "string",
                   "id": 9
+                },
+                "disk_storage_charged": {
+                  "type": "uint64",
+                  "id": 10,
+                  "options": {
+                    "jstype": "JS_STRING"
+                  }
+                },
+                "network_bandwidth_charged": {
+                  "type": "uint64",
+                  "id": 11,
+                  "options": {
+                    "jstype": "JS_STRING"
+                  }
+                },
+                "compute_bandwidth_charged": {
+                  "type": "uint64",
+                  "id": 12,
+                  "options": {
+                    "jstype": "JS_STRING"
+                  }
+                },
+                "state_delta_entries": {
+                  "rule": "repeated",
+                  "type": "state_delta_entry",
+                  "id": 13
+                }
+              }
+            },
+            "state_delta_entry": {
+              "oneofs": {
+                "_value": {
+                  "oneof": ["value"]
+                }
+              },
+              "fields": {
+                "object_space": {
+                  "type": "object_space",
+                  "id": 1
+                },
+                "key": {
+                  "type": "bytes",
+                  "id": 2
+                },
+                "value": {
+                  "type": "bytes",
+                  "id": 3,
+                  "options": {
+                    "proto3_optional": true
+                  }
                 }
               }
             }
@@ -475,7 +546,7 @@
         },
         "chain": {
           "options": {
-            "go_package": "github.com/koinos/koinos-proto-golang/koinos/chain"
+            "go_package": "github.com/koinos/koinos-proto-golang/v2/koinos/chain"
           },
           "nested": {
             "error_data": {

package/src/jsonDescriptors/pow-proto.json

@@ -6,7 +6,7 @@
           "nested": {
             "pow": {
               "options": {
-                "go_package": "github.com/koinos/koinos-proto-golang/koinos/contracts/pow"
+                "go_package": "github.com/koinos/koinos-proto-golang/v2/koinos/contracts/pow"
               },
               "nested": {
                 "difficulty_metadata": {

package/src/jsonDescriptors/token-proto.json

@@ -6,7 +6,7 @@
           "nested": {
             "token": {
               "options": {
-                "go_package": "github.com/koinos/koinos-proto-golang/koinos/contracts/token"
+                "go_package": "github.com/koinos/koinos-proto-golang/v2/koinos/contracts/token"
               },
               "nested": {
                 "name_arguments": {
@@ -100,6 +100,10 @@
                       "options": {
                         "jstype": "JS_STRING"
                       }
+                    },
+                    "memo": {
+                      "type": "string",
+                      "id": 4
                     }
                   }
                 },
@@ -159,31 +163,6 @@
                     }
                   }
                 },
-                "mana_balance_object": {
-                  "fields": {
-                    "balance": {
-                      "type": "uint64",
-                      "id": 1,
-                      "options": {
-                        "jstype": "JS_STRING"
-                      }
-                    },
-                    "mana": {
-                      "type": "uint64",
-                      "id": 2,
-                      "options": {
-                        "jstype": "JS_STRING"
-                      }
-                    },
-                    "last_mana_update": {
-                      "type": "uint64",
-                      "id": 3,
-                      "options": {
-                        "jstype": "JS_STRING"
-                      }
-                    }
-                  }
-                },
                 "burn_event": {
                   "fields": {
                     "from": {

package/src/jsonDescriptors/value-proto.json

@@ -12,8 +12,6 @@
                 "kind": {
                   "oneof": [
                     "message_value",
-                    "double_value",
-                    "float_value",
                     "int32_value",
                     "int64_value",
                     "uint32_value",
@@ -35,80 +33,72 @@
                   "type": "google.protobuf.Any",
                   "id": 1
                 },
-                "double_value": {
-                  "type": "double",
-                  "id": 2
-                },
-                "float_value": {
-                  "type": "float",
-                  "id": 3
-                },
                 "int32_value": {
                   "type": "int32",
-                  "id": 4
+                  "id": 2
                 },
                 "int64_value": {
                   "type": "int64",
-                  "id": 5,
+                  "id": 3,
                   "options": {
                     "jstype": "JS_STRING"
                   }
                 },
                 "uint32_value": {
                   "type": "uint32",
-                  "id": 6
+                  "id": 4
                 },
                 "uint64_value": {
                   "type": "uint64",
-                  "id": 7,
+                  "id": 5,
                   "options": {
                     "jstype": "JS_STRING"
                   }
                 },
                 "sint32_value": {
                   "type": "sint32",
-                  "id": 8
+                  "id": 6
                 },
                 "sint64_value": {
                   "type": "sint64",
-                  "id": 9,
+                  "id": 7,
                   "options": {
                     "jstype": "JS_STRING"
                   }
                 },
                 "fixed32_value": {
                   "type": "fixed32",
-                  "id": 10
+                  "id": 8
                 },
                 "fixed64_value": {
                   "type": "fixed64",
-                  "id": 11,
+                  "id": 9,
                   "options": {
                     "jstype": "JS_STRING"
                   }
                 },
                 "sfixed32_value": {
                   "type": "sfixed32",
-                  "id": 12
+                  "id": 10
                 },
                 "sfixed64_value": {
                   "type": "sfixed64",
-                  "id": 13,
+                  "id": 11,
                   "options": {
                     "jstype": "JS_STRING"
                   }
                 },
                 "bool_value": {
                   "type": "bool",
-                  "id": 14
+                  "id": 12
                 },
                 "string_value": {
                   "type": "string",
-                  "id": 15
+                  "id": 13
                 },
                 "bytes_value": {
                   "type": "bytes",
-                  "id": 16
+                  "id": 14
                 }
               }
             },