starknet 4.0.1 → 4.3.0

package/src/provider/interface.ts

@@ -10,6 +10,7 @@ import type {
   DeployContractResponse,
   EstimateFeeResponse,
   GetBlockResponse,
+  GetCodeResponse,
   GetTransactionReceiptResponse,
   GetTransactionResponse,
   Invocation,
@@ -42,6 +43,11 @@ export abstract class ProviderInterface {
    */
   public abstract getBlock(blockIdentifier: BlockIdentifier): Promise<GetBlockResponse>;
 
+  public abstract getCode(
+    contractAddress: string,
+    blockIdentifier?: BlockIdentifier
+  ): Promise<GetCodeResponse>;
+
   /**
    * Gets the contract class of the deployed contract.
    *

package/src/provider/rpc.ts

@@ -213,6 +213,15 @@ export class RpcProvider implements ProviderInterface {
     return this.responseParser.parseCallContractResponse(result);
   }
 
+  public async getCode(
+    contractAddress: string,
+    _blockIdentifier?: BlockIdentifier
+  ): Promise<RPC.GetCodeResponse> {
+    const result = await this.fetchEndpoint('starknet_getCode', [contractAddress]);
+
+    return this.responseParser.parseGetCodeResponse(result);
+  }
+
   public async waitForTransaction(txHash: BigNumberish, retryInterval: number = 8000) {
     let onchain = false;
     let retries = 100;

package/src/provider/sequencer.ts

@@ -31,6 +31,7 @@ import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from
 import { parseContract, wait } from '../utils/provider';
 import { SequencerAPIResponseParser } from '../utils/responseParser/sequencer';
 import { randomAddress } from '../utils/stark';
+import { buildUrl } from '../utils/url';
 import { GatewayError, HttpError } from './errors';
 import { ProviderInterface } from './interface';
 import { BlockIdentifier, getFormattedBlockIdentifier } from './utils';
@@ -74,9 +75,13 @@ export class SequencerProvider implements ProviderInterface {
       this.gatewayUrl = urljoin(this.baseUrl, 'gateway');
     } else {
       this.baseUrl = optionsOrProvider.baseUrl;
-      this.feederGatewayUrl =
-        optionsOrProvider.feederGatewayUrl ?? urljoin(this.baseUrl, 'feeder_gateway');
-      this.gatewayUrl = optionsOrProvider.gatewayUrl ?? urljoin(this.baseUrl, 'gateway');
+      this.feederGatewayUrl = buildUrl(
+        this.baseUrl,
+        'feeder_gateway',
+        optionsOrProvider.feederGatewayUrl
+      );
+      this.gatewayUrl = buildUrl(this.baseUrl, 'gateway', optionsOrProvider.gatewayUrl);
+
       this.chainId =
         optionsOrProvider.chainId ??
         SequencerProvider.getChainIdFromBaseUrl(optionsOrProvider.baseUrl);
@@ -323,6 +328,15 @@ export class SequencerProvider implements ProviderInterface {
     ).then(this.responseParser.parseFeeEstimateResponse);
   }
 
+  public async getCode(
+    contractAddress: string,
+    blockIdentifier: BlockIdentifier = 'pending'
+  ): Promise<Sequencer.GetCodeResponse> {
+    return this.fetchEndpoint('get_code', { contractAddress, blockIdentifier }).then(
+      this.responseParser.parseGetCodeResponse
+    );
+  }
+
   public async waitForTransaction(txHash: BigNumberish, retryInterval: number = 8000) {
     let onchain = false;
 

package/src/types/api/sequencer.ts

@@ -53,11 +53,6 @@ export type ExecutionResources = {
   n_memory_holes: number;
 };
 
-export type GetCodeResponse = {
-  bytecode: string[];
-  abi: Abi;
-};
-
 export type GetTransactionTraceResponse = {
   function_invocation: {
     caller_address: string;
@@ -116,6 +111,11 @@ export namespace Sequencer {
     class_hash?: string;
   };
 
+  export type GetCodeResponse = {
+    bytecode: string[];
+    abi: Abi;
+  };
+
   export interface InvokeFunctionTransactionResponse extends InvokeFunctionTransaction {
     transaction_hash: string;
   }

package/src/types/provider.ts

@@ -16,6 +16,11 @@ export interface GetBlockResponse {
   starknet_version?: string;
 }
 
+export interface GetCodeResponse {
+  bytecode: string[];
+  // abi: string; // is not consistent between rpc and sequencer (is it?), therefore not included in the provider interface
+}
+
 export type GetTransactionResponse = InvokeTransactionResponse & DeclareTransactionResponse;
 
 export interface CommonTransactionResponse {

package/src/utils/address.ts

@@ -3,7 +3,7 @@ import { arrayify } from '@ethersproject/bytes';
 
 import { MASK_251, ZERO } from '../constants';
 import { addHexPrefix, removeHexPrefix } from './encode';
-import { pedersen } from './hash';
+import { keccakBn } from './hash';
 import { BigNumberish, assertInRange, toBN, toHex } from './number';
 
 export function addAddressPadding(address: BigNumberish): string {
@@ -25,7 +25,7 @@ export function validateAndParseAddress(address: BigNumberish): string {
 // from https://github.com/ethers-io/ethers.js/blob/fc1e006575d59792fa97b4efb9ea2f8cca1944cf/packages/address/src.ts/index.ts#L12
 export function getChecksumAddress(address: BigNumberish): string {
   const chars = removeHexPrefix(validateAndParseAddress(address)).toLowerCase().split('');
-  const hashed = arrayify(pedersen([0, address]), { hexPad: 'left' }); // as the hash will be 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
+  const hashed = arrayify(keccakBn(address), { hexPad: 'left' }); // in case the hash is 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
 
   for (let i = 0; i < chars.length; i += 2) {
     if (hashed[i >> 1] >> 4 >= 8) {

package/src/utils/hash.ts

@@ -1,5 +1,6 @@
 import BN from 'bn.js';
 import { keccak256 } from 'ethereum-cryptography/keccak';
+import { hexToBytes } from 'ethereum-cryptography/utils';
 import assert from 'minimalistic-assert';
 
 import {
@@ -13,12 +14,18 @@ import {
 } from '../constants';
 import { RawCalldata } from '../types/lib';
 import { ec } from './ellipticCurve';
-import { addHexPrefix, buf2hex, utf8ToArray } from './encode';
+import { addHexPrefix, buf2hex, removeHexPrefix, utf8ToArray } from './encode';
 import { BigNumberish, toBN, toFelt, toHex } from './number';
 
 export const transactionVersion = 0;
 export const feeTransactionVersion = toBN(2).pow(toBN(128)).add(toBN(transactionVersion));
 
+export function keccakBn(value: BigNumberish): string {
+  const hexWithoutPrefix = removeHexPrefix(toHex(toBN(value)));
+  const evenHex = hexWithoutPrefix.length % 2 === 0 ? hexWithoutPrefix : `0${hexWithoutPrefix}`;
+  return addHexPrefix(buf2hex(keccak256(hexToBytes(evenHex))));
+}
+
 function keccakHex(value: string): string {
   return addHexPrefix(buf2hex(keccak256(utf8ToArray(value))));
 }

package/src/utils/responseParser/rpc.ts

@@ -57,6 +57,10 @@ export class RPCResponseParser extends ResponseParser {
     };
   }
 
+  public parseGetCodeResponse(res: RPC.GetCodeResponse): RPC.GetCodeResponse {
+    return res;
+  }
+
   public parseFeeEstimateResponse(res: RPC.EstimateFeeResponse): EstimateFeeResponse {
     return {
       overall_fee: toBN(res.overall_fee),

package/src/utils/responseParser/sequencer.ts

@@ -70,6 +70,10 @@ export class SequencerAPIResponseParser extends ResponseParser {
     };
   }
 
+  public parseGetCodeResponse(res: Sequencer.GetCodeResponse): Sequencer.GetCodeResponse {
+    return res;
+  }
+
   public parseFeeEstimateResponse(res: Sequencer.EstimateFeeResponse): EstimateFeeResponse {
     if ('overall_fee' in res) {
       let gasInfo = {};

package/src/utils/url.ts

@@ -0,0 +1,53 @@
+import urljoin from 'url-join';
+
+/**
+ * Inspired from https://github.com/segmentio/is-url
+ */
+
+/**
+ * RegExps.
+ * A URL must match #1 and then at least one of #2/#3.
+ * Use two levels of REs to avoid REDOS.
+ */
+const protocolAndDomainRE = /^(?:\w+:)?\/\/(\S+)$/;
+
+const localhostDomainRE = /^localhost[:?\d]*(?:[^:?\d]\S*)?$/;
+const nonLocalhostDomainRE = /^[^\s.]+\.\S{2,}$/;
+
+/**
+ * Loosely validate a URL `string`.
+ * @param {String} s
+ * @return {Boolean}
+ */
+export function isUrl(s?: string): boolean {
+  if (!s) {
+    return false;
+  }
+
+  if (typeof s !== 'string') {
+    return false;
+  }
+
+  const match = s.match(protocolAndDomainRE);
+  if (!match) {
+    return false;
+  }
+
+  const everythingAfterProtocol = match[1];
+  if (!everythingAfterProtocol) {
+    return false;
+  }
+
+  if (
+    localhostDomainRE.test(everythingAfterProtocol) ||
+    nonLocalhostDomainRE.test(everythingAfterProtocol)
+  ) {
+    return true;
+  }
+
+  return false;
+}
+
+export function buildUrl(baseUrl: string, defaultPath: string, urlOrPath?: string) {
+  return isUrl(urlOrPath) ? urlOrPath! : urljoin(baseUrl, urlOrPath ?? defaultPath);
+}

package/types/api/sequencer.d.ts

@@ -39,10 +39,6 @@ export declare type ExecutionResources = {
     };
     n_memory_holes: number;
 };
-export declare type GetCodeResponse = {
-    bytecode: string[];
-    abi: Abi;
-};
 export declare type GetTransactionTraceResponse = {
     function_invocation: {
         caller_address: string;
@@ -97,6 +93,10 @@ export declare namespace Sequencer {
         address?: string;
         class_hash?: string;
     };
+    type GetCodeResponse = {
+        bytecode: string[];
+        abi: Abi;
+    };
     interface InvokeFunctionTransactionResponse extends InvokeFunctionTransaction {
         transaction_hash: string;
     }

package/types/provider.d.ts

@@ -13,6 +13,9 @@ export interface GetBlockResponse {
     transactions: Array<string>;
     starknet_version?: string;
 }
+export interface GetCodeResponse {
+    bytecode: string[];
+}
 export declare type GetTransactionResponse = InvokeTransactionResponse & DeclareTransactionResponse;
 export interface CommonTransactionResponse {
     transaction_hash?: string;

package/utils/address.js

@@ -23,7 +23,7 @@ exports.validateAndParseAddress = validateAndParseAddress;
 // from https://github.com/ethers-io/ethers.js/blob/fc1e006575d59792fa97b4efb9ea2f8cca1944cf/packages/address/src.ts/index.ts#L12
 function getChecksumAddress(address) {
     var chars = (0, encode_1.removeHexPrefix)(validateAndParseAddress(address)).toLowerCase().split('');
-    var hashed = (0, bytes_1.arrayify)((0, hash_1.pedersen)([0, address]), { hexPad: 'left' }); // as the hash will be 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
+    var hashed = (0, bytes_1.arrayify)((0, hash_1.keccakBn)(address), { hexPad: 'left' }); // in case the hash is 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
     for (var i = 0; i < chars.length; i += 2) {
         if (hashed[i >> 1] >> 4 >= 8) {
             chars[i] = chars[i].toUpperCase();

package/utils/hash.d.ts

@@ -4,6 +4,7 @@ import { RawCalldata } from '../types/lib';
 import { BigNumberish } from './number';
 export declare const transactionVersion = 0;
 export declare const feeTransactionVersion: BN;
+export declare function keccakBn(value: BigNumberish): string;
 /**
  * Function to get the starknet keccak hash from a string
  *

package/utils/hash.js

@@ -28,8 +28,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateContractAddressFromHash = exports.calculcateTransactionHash = exports.calculateDeployTransactionHash = exports.calculateTransactionHashCommon = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = exports.feeTransactionVersion = exports.transactionVersion = void 0;
+exports.calculateContractAddressFromHash = exports.calculcateTransactionHash = exports.calculateDeployTransactionHash = exports.calculateTransactionHashCommon = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = exports.keccakBn = exports.feeTransactionVersion = exports.transactionVersion = void 0;
 var keccak_1 = require("ethereum-cryptography/keccak");
+var utils_1 = require("ethereum-cryptography/utils");
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
 var constants_1 = require("../constants");
 var ellipticCurve_1 = require("./ellipticCurve");
@@ -37,6 +38,12 @@ var encode_1 = require("./encode");
 var number_1 = require("./number");
 exports.transactionVersion = 0;
 exports.feeTransactionVersion = (0, number_1.toBN)(2).pow((0, number_1.toBN)(128)).add((0, number_1.toBN)(exports.transactionVersion));
+function keccakBn(value) {
+    var hexWithoutPrefix = (0, encode_1.removeHexPrefix)((0, number_1.toHex)((0, number_1.toBN)(value)));
+    var evenHex = hexWithoutPrefix.length % 2 === 0 ? hexWithoutPrefix : "0".concat(hexWithoutPrefix);
+    return (0, encode_1.addHexPrefix)((0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, utils_1.hexToBytes)(evenHex))));
+}
+exports.keccakBn = keccakBn;
 function keccakHex(value) {
     return (0, encode_1.addHexPrefix)((0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, encode_1.utf8ToArray)(value))));
 }

package/utils/responseParser/rpc.d.ts

@@ -5,6 +5,7 @@ export declare class RPCResponseParser extends ResponseParser {
     parseGetBlockResponse(res: RPC.GetBlockResponse): GetBlockResponse;
     parseGetTransactionResponse(res: RPC.GetTransactionResponse): GetTransactionResponse;
     parseGetTransactionReceiptResponse(res: RPC.GetTransactionReceiptResponse): GetTransactionReceiptResponse;
+    parseGetCodeResponse(res: RPC.GetCodeResponse): RPC.GetCodeResponse;
     parseFeeEstimateResponse(res: RPC.EstimateFeeResponse): EstimateFeeResponse;
     parseCallContractResponse(res: Array<string>): CallContractResponse;
     parseInvokeFunctionResponse(res: RPC.AddTransactionResponse): InvokeFunctionResponse;

package/utils/responseParser/rpc.js

@@ -62,6 +62,9 @@ var RPCResponseParser = /** @class */ (function (_super) {
             events: res.events,
         };
     };
+    RPCResponseParser.prototype.parseGetCodeResponse = function (res) {
+        return res;
+    };
     RPCResponseParser.prototype.parseFeeEstimateResponse = function (res) {
         return {
             overall_fee: (0, number_1.toBN)(res.overall_fee),

package/utils/responseParser/sequencer.d.ts

@@ -5,6 +5,7 @@ export declare class SequencerAPIResponseParser extends ResponseParser {
     parseGetBlockResponse(res: Sequencer.GetBlockResponse): GetBlockResponse;
     parseGetTransactionResponse(res: Sequencer.GetTransactionResponse): GetTransactionResponse;
     parseGetTransactionReceiptResponse(res: Sequencer.TransactionReceiptResponse): GetTransactionReceiptResponse;
+    parseGetCodeResponse(res: Sequencer.GetCodeResponse): Sequencer.GetCodeResponse;
     parseFeeEstimateResponse(res: Sequencer.EstimateFeeResponse): EstimateFeeResponse;
     parseCallContractResponse(res: Sequencer.CallContractResponse): CallContractResponse;
     parseInvokeFunctionResponse(res: Sequencer.AddTransactionResponse): InvokeFunctionResponse;

package/utils/responseParser/sequencer.js

@@ -79,6 +79,9 @@ var SequencerAPIResponseParser = /** @class */ (function (_super) {
             l1_origin_message: undefined,
         };
     };
+    SequencerAPIResponseParser.prototype.parseGetCodeResponse = function (res) {
+        return res;
+    };
     SequencerAPIResponseParser.prototype.parseFeeEstimateResponse = function (res) {
         if ('overall_fee' in res) {
             var gasInfo = {};

package/utils/url.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Loosely validate a URL `string`.
+ * @param {String} s
+ * @return {Boolean}
+ */
+export declare function isUrl(s?: string): boolean;
+export declare function buildUrl(baseUrl: string, defaultPath: string, urlOrPath?: string): string;

package/utils/url.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildUrl = exports.isUrl = void 0;
+var url_join_1 = __importDefault(require("url-join"));
+/**
+ * Inspired from https://github.com/segmentio/is-url
+ */
+/**
+ * RegExps.
+ * A URL must match #1 and then at least one of #2/#3.
+ * Use two levels of REs to avoid REDOS.
+ */
+var protocolAndDomainRE = /^(?:\w+:)?\/\/(\S+)$/;
+var localhostDomainRE = /^localhost[:?\d]*(?:[^:?\d]\S*)?$/;
+var nonLocalhostDomainRE = /^[^\s.]+\.\S{2,}$/;
+/**
+ * Loosely validate a URL `string`.
+ * @param {String} s
+ * @return {Boolean}
+ */
+function isUrl(s) {
+    if (!s) {
+        return false;
+    }
+    if (typeof s !== 'string') {
+        return false;
+    }
+    var match = s.match(protocolAndDomainRE);
+    if (!match) {
+        return false;
+    }
+    var everythingAfterProtocol = match[1];
+    if (!everythingAfterProtocol) {
+        return false;
+    }
+    if (localhostDomainRE.test(everythingAfterProtocol) ||
+        nonLocalhostDomainRE.test(everythingAfterProtocol)) {
+        return true;
+    }
+    return false;
+}
+exports.isUrl = isUrl;
+function buildUrl(baseUrl, defaultPath, urlOrPath) {
+    return isUrl(urlOrPath) ? urlOrPath : (0, url_join_1.default)(baseUrl, urlOrPath !== null && urlOrPath !== void 0 ? urlOrPath : defaultPath);
+}
+exports.buildUrl = buildUrl;