@apibara/starknet 0.3.0 → 0.4.0

package/dist/proto/index.d.ts

@@ -1,2 +1,2 @@
-import { apibara } from './generated';
+import { apibara } from "./generated";
 export import v1alpha2 = apibara.starknet.v1alpha2;

package/dist/proto/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/proto/index.ts"],"names":[],"mappings":";;;AAAA,2CAAqC;AAErC,6DAA6D;AAC/C,QAAA,QAAQ,GAAG,mBAAO,CAAC,QAAQ,CAAC,QAAQ,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/proto/index.ts"],"names":[],"mappings":";;;AAAA,2CAAsC;AAEtC,6DAA6D;AAC/C,QAAA,QAAQ,GAAG,mBAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC"}

package/dist/proto/starknet.proto

@@ -20,6 +20,8 @@ message Block {
   repeated EventWithTransaction events = 5;
   // Messages to L1 sent in the block.
   repeated L2ToL1MessageWithTransaction l2_to_l1_messages = 6;
+  // Whether the block contains data.
+  bool empty = 7;
 }
 
 // Block header.
@@ -36,6 +38,10 @@ message BlockHeader {
   FieldElement new_root = 5;
   // Timestamp when block  was produced.
   google.protobuf.Timestamp timestamp = 6;
+  // Starknet version.
+  string starknet_version = 7;
+  // Price of L1 gas in the block.
+  ResourcePrice l1_gas_price = 8;
 }
 
 // Status of a block.
@@ -69,7 +75,7 @@ message Transaction {
     InvokeTransactionV0 invoke_v0 = 2;
     // Transaction invoking a smart contract, V1.
     InvokeTransactionV1 invoke_v1 = 3;
-    // Transaction deploying a new smart contract.
+    // Transaction deploying a new smart contract, V1.
     DeployTransaction deploy = 4;
     // Transaction declaring a smart contract.
     DeclareTransaction declare = 5;
@@ -77,6 +83,12 @@ message Transaction {
     L1HandlerTransaction l1_handler = 6;
     // Transaction deploying a new account.
     DeployAccountTransaction deploy_account = 7;
+    // Transaction deploying a new smart contract, V3.
+    DeployAccountTransactionV3 deploy_account_v3 = 8;
+    // Transaction invoking a smart contract, V3.
+    InvokeTransactionV3 invoke_v3 = 9;
+    // Transaction declaring a smart contract, V3.
+    DeclareTransactionV3 declare_v3 = 10;
   }
 }
 
@@ -92,6 +104,18 @@ message TransactionMeta {
   FieldElement nonce = 4;
   // Version.
   uint64 version = 5;
+  // Transaction resources.
+  ResourceBoundsMapping resource_bounds = 6;
+  // Tip to the sequencer.
+  uint64 tip = 7;
+  // Data passed to the paymaster.
+  repeated FieldElement paymaster_data = 8;
+  // The storage domain of the account's nonce.
+  DataAvailabilityMode nonce_data_availability_mode = 9;
+  // The storage domain of the account's balance from which fee will be charged.
+  DataAvailabilityMode fee_data_availability_mode = 10;
+  // Index of the transaction in the block.
+  uint64 transaction_index = 11;
 }
 
 // Transaction invoking a smart contract, V0.
@@ -112,7 +136,17 @@ message InvokeTransactionV1 {
   repeated FieldElement calldata = 2;
 }
 
-// Transaction deploying a new smart contract.
+// Transaction invoking a smart contract, V3.
+message InvokeTransactionV3 {
+  // Address sending the transaction.
+  FieldElement sender_address = 1;
+  // Raw calldata.
+  repeated FieldElement calldata = 2;
+  // Data passed to the account deployment.
+  repeated FieldElement account_deployment_data = 3;
+}
+
+// Transaction deploying a new smart contract, V1.
 message DeployTransaction {
   // Raw calldata passed to the constructor.
   repeated FieldElement constructor_calldata = 2;
@@ -132,6 +166,18 @@ message DeclareTransaction {
   FieldElement compiled_class_hash = 3;
 }
 
+// Transaction declaring a smart contract.
+message DeclareTransactionV3 {
+  // Class hash.
+  FieldElement class_hash = 1;
+  // Address of the account declaring the class.
+  FieldElement sender_address = 2;
+  // The hash of the cairo assembly resulting from the sierra compilation.
+  FieldElement compiled_class_hash = 3;
+  // Data passed to the account deployment.
+  repeated FieldElement account_deployment_data = 4;
+}
+
 // Transaction handling a message from L1.
 message L1HandlerTransaction {
   // Target contract address.
@@ -152,6 +198,26 @@ message DeployAccountTransaction {
   FieldElement class_hash = 4;
 }
 
+// Transaction deploying a new smart contract, V3.
+message DeployAccountTransactionV3 {
+  // Raw calldata passed to the constructor.
+  repeated FieldElement constructor_calldata = 1;
+  // Salt used when computing the contract's address.
+  FieldElement contract_address_salt = 2;
+  // Hash of the class being deployed.
+  FieldElement class_hash = 3;
+}
+
+// Transaction execution status.
+enum ExecutionStatus {
+  // Unknown execution status.
+  EXECUTION_STATUS_UNSPECIFIED = 0;
+  // Transaction succeeded.
+  EXECUTION_STATUS_SUCCEEDED = 1;
+  // Transaction reverted.
+  EXECUTION_STATUS_REVERTED = 2;
+}
+
 // Result of the execution of a transaction.
 //
 // This message only contains the receipt data, if you also need the
@@ -162,13 +228,19 @@ message TransactionReceipt {
   // Transaction's indexe in the list of transactions in a block.
   uint64 transaction_index = 2;
   // Feed paid.
-  FieldElement actual_fee = 3;
+  FieldElement actual_fee = 3 [ deprecated = true ];
   // Messages sent to L1 in the transactions.
   repeated L2ToL1Message l2_to_l1_messages = 4;
   // Events emitted in the transaction.
   repeated Event events = 5;
   // Address of the contract that was created by the transaction.
   FieldElement contract_address = 6;
+  // Transaction execution status.
+  ExecutionStatus execution_status = 7;
+  // The reason why the transaction reverted.
+  string revert_reason = 8;
+  // Feed paid.
+  FeePayment actual_fee_paid = 9;
 }
 
 // Message sent from L2 to L1 together with its transaction and receipt.
@@ -294,3 +366,60 @@ message NonceUpdate {
   // New nonce value.
   FieldElement nonce = 2;
 }
+
+// Price of a unit of a resource.
+message ResourcePrice {
+  // Price in fri (10^-18 strk).
+  FieldElement price_in_fri = 1;
+  // Price in wei (10^-18 eth).
+  FieldElement price_in_wei = 2;
+}
+
+// A Starknet fee payment.
+message FeePayment {
+  // Amount paid.
+  FieldElement amount = 1;
+  // Unit of the amount.
+  PriceUnit unit = 2;
+}
+
+// Price unit.
+enum PriceUnit {
+  // Unknown price unit.
+  PRICE_UNIT_UNSPECIFIED = 0;
+  // WEI.
+  PRICE_UNIT_WEI = 1;
+  // FRI.
+  PRICE_UNIT_FRI = 2;
+}
+
+message ResourceBoundsMapping {
+  // Maximum amount and price of L1 gas.
+  ResourceBounds l1_gas = 1;
+  // Maximum amount and price of L2 gas.
+  ResourceBounds l2_gas = 2;
+}
+
+message ResourceBounds {
+  // The maximum amount of resources that can be consumed by a transaction.
+  uint64 max_amount = 1;
+  /// The max price per unit of resource.
+  Uint128 max_price_per_unit = 2;
+}
+
+message Uint128 {
+  // The low 64 bits of the number.
+  uint64 low = 1;
+  // The high 64 bits of the number.
+  uint64 high = 2;
+}
+
+// DA mode.
+enum DataAvailabilityMode {
+  // Unknown DA.
+  DATA_AVAILABILITY_MODE_UNSPECIFIED = 0;
+  // L1.
+  DATA_AVAILABILITY_MODE_L1 = 1;
+  // L2.
+  DATA_AVAILABILITY_MODE_L2 = 2;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apibara/starknet",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "source": "src/index.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,17 +19,13 @@
     "@types/node": "^18.11.9",
     "protobufjs-cli": "^1.0.2"
   },
-  "eslintConfig": {
-    "ignorePatterns": [
-      "src/proto/generated.d.ts"
-    ]
-  },
   "scripts": {
     "prebuild": "pnpm run protobuf && pnpm run gen-proto",
     "build": "tsc && cp src/proto/generated.d.ts dist/proto/generated.d.ts",
     "test": "jest src",
-    "lint": "eslint src --ext .ts",
-    "lint:fix": "eslint --fix src --ext .ts",
+    "lint": "biome check .",
+    "lint:fix": "pnpm lint --apply",
+    "format": "biome format . --write",
     "protobuf": "mkdir -p dist/proto && cp src/proto/*.proto dist/proto",
     "gen-module": "pbjs -t static-module -w commonjs -o src/proto/generated.js src/proto/*.proto",
     "gen-types": "pbts -o src/proto/generated.d.ts src/proto/generated.js",

package/src/cursor.ts

@@ -1,6 +1,6 @@
-import Long from 'long'
-import { FieldElement } from './felt'
-import { v1alpha2 } from './proto'
+import Long from "long";
+import { FieldElement } from "./felt";
+import { v1alpha2 } from "./proto";
 
 export const StarkNetCursor = {
   /**
@@ -10,17 +10,23 @@ export const StarkNetCursor = {
     return {
       orderKey: Long.fromValue(number),
       uniqueKey: new Uint8Array(),
-    }
+    };
   },
 
   /**
    * Creates a cursor pointing at the block with the given height and hash.
    */
-  createWithBlockNumberAndHash: (number: string | number | Long, hash: v1alpha2.IFieldElement) => {
-    const uniqueKey = Buffer.from(FieldElement.toHex(hash).replace('0x', ''), 'hex')
+  createWithBlockNumberAndHash: (
+    number: string | number | Long,
+    hash: v1alpha2.IFieldElement,
+  ) => {
+    const uniqueKey = Buffer.from(
+      FieldElement.toHex(hash).replace("0x", ""),
+      "hex",
+    );
     return {
       orderKey: Long.fromValue(number),
       uniqueKey,
-    }
+    };
   },
-}
+};

package/src/felt.test.ts

@@ -1,24 +1,26 @@
-import { FieldElement } from './felt'
+import { FieldElement } from "./felt";
 
-describe('FieldElement', () => {
-  describe('encoding', () => {
-    it('can be encoded to and from the wire format', () => {
-      const original = BigInt('0x00da114221cb83fa859dbdb4c44beeaa0bb37c7537ad5ae66fe5e0efd20e6eb3')
+describe("FieldElement", () => {
+  describe("encoding", () => {
+    it("can be encoded to and from the wire format", () => {
+      const original = BigInt(
+        "0x00da114221cb83fa859dbdb4c44beeaa0bb37c7537ad5ae66fe5e0efd20e6eb3",
+      );
 
-      const encoded = FieldElement.fromBigInt(original)
+      const encoded = FieldElement.fromBigInt(original);
 
-      const back = FieldElement.toBigInt(encoded)
+      const back = FieldElement.toBigInt(encoded);
 
-      expect(back).toBe(original)
-    })
+      expect(back).toBe(original);
+    });
 
-    it('encodes the value as big endian', () => {
-      const prime = 2n ** 251n + 17n * 2n ** 192n
-      const encoded = FieldElement.fromBigInt(prime)
-      expect(encoded.hiHi?.toString()).toEqual('0')
-      expect(encoded.hiLo?.toString()).toEqual('0')
-      expect(encoded.loHi?.toString()).toEqual('0')
-      expect(encoded.loLo?.toString()).toEqual('576460752303423505')
-    })
-  })
-})
+    it("encodes the value as big endian", () => {
+      const prime = 2n ** 251n + 17n * 2n ** 192n;
+      const encoded = FieldElement.fromBigInt(prime);
+      expect(encoded.hiHi?.toString()).toEqual("0");
+      expect(encoded.hiLo?.toString()).toEqual("0");
+      expect(encoded.loHi?.toString()).toEqual("0");
+      expect(encoded.loLo?.toString()).toEqual("576460752303423505");
+    });
+  });
+});

package/src/felt.ts

@@ -1,7 +1,7 @@
-import Long from 'long'
-import { v1alpha2 } from './proto'
+import Long from "long";
+import { v1alpha2 } from "./proto";
 
-const MAX_FELT = 2n ** 251n + 17n * 2n ** 192n
+const MAX_FELT = 2n ** 251n + 17n * 2n ** 192n;
 
 export const FieldElement = {
   encode: v1alpha2.FieldElement.encode,
@@ -13,11 +13,11 @@ export const FieldElement = {
    * Converts from the wire representation to a bigint.
    */
   toBigInt(message: v1alpha2.IFieldElement): bigint {
-    const hiHi = hexEncodedU64(message.hiHi)
-    const hiLo = hexEncodedU64(message.hiLo)
-    const loHi = hexEncodedU64(message.loHi)
-    const loLo = hexEncodedU64(message.loLo)
-    return BigInt(`0x${loLo}${loHi}${hiLo}${hiHi}`)
+    const hiHi = hexEncodedU64(message.hiHi);
+    const hiLo = hexEncodedU64(message.hiLo);
+    const loHi = hexEncodedU64(message.loHi);
+    const loLo = hexEncodedU64(message.loLo);
+    return BigInt(`0x${loLo}${loHi}${hiLo}${hiHi}`);
   },
 
   /**
@@ -25,37 +25,37 @@ export const FieldElement = {
    */
   fromBigInt(number: string | number | bigint): v1alpha2.IFieldElement {
     if (number < 0 || number > MAX_FELT) {
-      throw new Error('FieldElement outside of range')
+      throw new Error("FieldElement outside of range");
     }
 
-    const bn = BigInt(number)
+    const bn = BigInt(number);
     // bit-shifting of a big int doesn't make much sense.
     // convert to hex and from there breakup in pieces
-    const hex = bn.toString(16).padStart(64, '0')
-    const s = hex.length
-    const hiHi = Long.fromString(hex.slice(s - 16, s), true, 16)
-    const hiLo = Long.fromString(hex.slice(s - 32, s - 16), true, 16)
-    const loHi = Long.fromString(hex.slice(s - 48, s - 32), true, 16)
-    const loLo = Long.fromString(hex.slice(s - 64, s - 48), true, 16)
+    const hex = bn.toString(16).padStart(64, "0");
+    const s = hex.length;
+    const hiHi = Long.fromString(hex.slice(s - 16, s), true, 16);
+    const hiLo = Long.fromString(hex.slice(s - 32, s - 16), true, 16);
+    const loHi = Long.fromString(hex.slice(s - 48, s - 32), true, 16);
+    const loLo = Long.fromString(hex.slice(s - 64, s - 48), true, 16);
 
     return {
       hiHi,
       hiLo,
       loHi,
       loLo,
-    }
+    };
   },
 
   /**
    * Returns the hex value of the field element.
    */
   toHex(message: v1alpha2.IFieldElement): string {
-    const num = this.toBigInt(message)
-    return `0x${num.toString(16).padStart(64, '0')}`
+    const num = this.toBigInt(message);
+    return `0x${num.toString(16).padStart(64, "0")}`;
   },
-}
+};
 
 function hexEncodedU64(n: Long | number | null | undefined): string {
-  const s = n?.toString(16) ?? ''
-  return s.padStart(16, '0')
+  const s = n?.toString(16) ?? "";
+  return s.padStart(16, "0");
 }

package/src/filter.test.ts

@@ -1,117 +1,139 @@
-import { Filter } from './filter'
-import { FieldElement } from './felt'
-
-describe('Filter', () => {
-  describe('addHeader', () => {
-    it('sets the header field', () => {
-      let filter = Filter.create().withHeader().toObject()
-
-      expect(filter.header).toEqual({})
-    })
-  })
-
-  describe('addTransaction', () => {
-    it('accepts a builder or callback function', () => {
-      let filter = Filter.create()
-        .addTransaction(Filter.transaction().declare().withClassHash(FieldElement.fromBigInt(123)))
+import { FieldElement } from "./felt";
+import { Filter } from "./filter";
+
+describe("Filter", () => {
+  describe("addHeader", () => {
+    it("sets the header field", () => {
+      const filter = Filter.create().withHeader().toObject();
+
+      expect(filter.header).toEqual({});
+    });
+  });
+
+  describe("addTransaction", () => {
+    it("accepts a builder or callback function", () => {
+      const filter = Filter.create()
+        .addTransaction(
+          Filter.transaction()
+            .declare()
+            .withClassHash(FieldElement.fromBigInt(123)),
+        )
         .addTransaction((tx) =>
-          tx.deployAccount().withConstructorCalldata([FieldElement.fromBigInt(0)])
+          tx
+            .deployAccount()
+            .withConstructorCalldata([FieldElement.fromBigInt(0)]),
+        )
+        .toObject();
+
+      expect(filter.transactions).toHaveLength(2);
+      expect(filter.transactions?.[0].declare).toBeDefined();
+      expect(filter.transactions?.[1].deployAccount).toBeDefined();
+    });
+  });
+
+  describe("addEvent", () => {
+    it("accepts a builder or callback function", () => {
+      const filter = Filter.create()
+        .addEvent(
+          Filter.event().withFromAddress(FieldElement.fromBigInt("0x0")),
         )
-        .toObject()
-
-      expect(filter.transactions).toHaveLength(2)
-      expect(filter.transactions?.[0].declare).toBeDefined()
-      expect(filter.transactions?.[1].deployAccount).toBeDefined()
-    })
-  })
-
-  describe('addEvent', () => {
-    it('accepts a builder or callback function', () => {
-      let filter = Filter.create()
-        .addEvent(Filter.event().withFromAddress(FieldElement.fromBigInt('0x0')))
         .addEvent((ev) => ev.withData([FieldElement.fromBigInt(0)]))
-        .toObject()
+        .toObject();
 
-      expect(filter.events).toHaveLength(2)
-    })
-  })
+      expect(filter.events).toHaveLength(2);
+    });
+  });
 
-  describe('addMessage', () => {
-    it('accepts a builder or callback function', () => {
-      let filter = Filter.create()
+  describe("addMessage", () => {
+    it("accepts a builder or callback function", () => {
+      const filter = Filter.create()
         .addMessage(Filter.message().withToAddress(FieldElement.fromBigInt(0)))
         .addMessage((msg) => msg.withPayload([FieldElement.fromBigInt(0)]))
-        .toObject()
+        .toObject();
 
-      expect(filter.messages).toHaveLength(2)
-    })
-  })
+      expect(filter.messages).toHaveLength(2);
+    });
+  });
 
-  describe('withStateUpdate', () => {
-    it('accepts a callback function', () => {
-      let filter = Filter.create()
+  describe("withStateUpdate", () => {
+    it("accepts a callback function", () => {
+      const filter = Filter.create()
         .withStateUpdate((s) => s)
-        .toObject()
-      expect(filter.stateUpdate).toBeDefined()
-    })
-
-    it('accepts a builder', () => {
-      let filter = Filter.create().withStateUpdate(Filter.stateUpdate()).toObject()
-      expect(filter.stateUpdate).toBeDefined()
-    })
-
-    describe('addStorageDiff', () => {
-      it('accepts a callback function', () => {
-        let filter = Filter.create()
-          .withStateUpdate((s) => s.addStorageDiff((d) => d).addStorageDiff((d) => d))
-          .toObject()
-        expect(filter.stateUpdate?.storageDiffs).toHaveLength(2)
-      })
-    })
-
-    describe('addDeclaredContract', () => {
-      it('accepts a callback function', () => {
-        let filter = Filter.create()
-          .withStateUpdate((s) => s.addDeclaredContract((d) => d).addDeclaredContract((d) => d))
-          .toObject()
-        expect(filter.stateUpdate?.declaredContracts).toHaveLength(2)
-      })
-    })
-
-    describe('addDeployedContract', () => {
-      it('accepts a callback function', () => {
-        let filter = Filter.create()
-          .withStateUpdate((s) => s.addDeployedContract((d) => d).addDeployedContract((d) => d))
-          .toObject()
-        expect(filter.stateUpdate?.deployedContracts).toHaveLength(2)
-      })
-    })
-
-    describe('addDeclaredClass', () => {
-      it('accepts a callback function', () => {
-        let filter = Filter.create()
-          .withStateUpdate((s) => s.addDeclaredClass((d) => d).addDeclaredClass((d) => d))
-          .toObject()
-        expect(filter.stateUpdate?.declaredClasses).toHaveLength(2)
-      })
-    })
-
-    describe('addReplacedClass', () => {
-      it('accepts a callback function', () => {
-        let filter = Filter.create()
-          .withStateUpdate((s) => s.addReplacedClass((d) => d).addReplacedClass((d) => d))
-          .toObject()
-        expect(filter.stateUpdate?.replacedClasses).toHaveLength(2)
-      })
-    })
-
-    describe('addNonceUpdated', () => {
-      it('accepts a callback function', () => {
-        let filter = Filter.create()
-          .withStateUpdate((s) => s.addNonceUpdate((d) => d).addNonceUpdate((d) => d))
-          .toObject()
-        expect(filter.stateUpdate?.nonces).toHaveLength(2)
-      })
-    })
-  })
-})
+        .toObject();
+      expect(filter.stateUpdate).toBeDefined();
+    });
+
+    it("accepts a builder", () => {
+      const filter = Filter.create()
+        .withStateUpdate(Filter.stateUpdate())
+        .toObject();
+      expect(filter.stateUpdate).toBeDefined();
+    });
+
+    describe("addStorageDiff", () => {
+      it("accepts a callback function", () => {
+        const filter = Filter.create()
+          .withStateUpdate((s) =>
+            s.addStorageDiff((d) => d).addStorageDiff((d) => d),
+          )
+          .toObject();
+        expect(filter.stateUpdate?.storageDiffs).toHaveLength(2);
+      });
+    });
+
+    describe("addDeclaredContract", () => {
+      it("accepts a callback function", () => {
+        const filter = Filter.create()
+          .withStateUpdate((s) =>
+            s.addDeclaredContract((d) => d).addDeclaredContract((d) => d),
+          )
+          .toObject();
+        expect(filter.stateUpdate?.declaredContracts).toHaveLength(2);
+      });
+    });
+
+    describe("addDeployedContract", () => {
+      it("accepts a callback function", () => {
+        const filter = Filter.create()
+          .withStateUpdate((s) =>
+            s.addDeployedContract((d) => d).addDeployedContract((d) => d),
+          )
+          .toObject();
+        expect(filter.stateUpdate?.deployedContracts).toHaveLength(2);
+      });
+    });
+
+    describe("addDeclaredClass", () => {
+      it("accepts a callback function", () => {
+        const filter = Filter.create()
+          .withStateUpdate((s) =>
+            s.addDeclaredClass((d) => d).addDeclaredClass((d) => d),
+          )
+          .toObject();
+        expect(filter.stateUpdate?.declaredClasses).toHaveLength(2);
+      });
+    });
+
+    describe("addReplacedClass", () => {
+      it("accepts a callback function", () => {
+        const filter = Filter.create()
+          .withStateUpdate((s) =>
+            s.addReplacedClass((d) => d).addReplacedClass((d) => d),
+          )
+          .toObject();
+        expect(filter.stateUpdate?.replacedClasses).toHaveLength(2);
+      });
+    });
+
+    describe("addNonceUpdated", () => {
+      it("accepts a callback function", () => {
+        const filter = Filter.create()
+          .withStateUpdate((s) =>
+            s.addNonceUpdate((d) => d).addNonceUpdate((d) => d),
+          )
+          .toObject();
+        expect(filter.stateUpdate?.nonces).toHaveLength(2);
+      });
+    });
+  });
+});