starknet 3.10.3 → 3.11.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.11.0](https://github.com/seanjameshan/starknet.js/compare/v3.10.3...v3.11.0) (2022-05-11)
+
+### Bug Fixes
+
+- review ([9ee4987](https://github.com/seanjameshan/starknet.js/commit/9ee498788185a35a75f2b429b3f1ec55dc4ee2a3))
+- tests ([f535edb](https://github.com/seanjameshan/starknet.js/commit/f535edbef8da6050e54575792926488774e3ed0f))
+- transaction receipt ([806eb7d](https://github.com/seanjameshan/starknet.js/commit/806eb7d63a01e158231f7b63cc4fc1fb0c30717e))
+- use npm again ([3b9e176](https://github.com/seanjameshan/starknet.js/commit/3b9e176812f6401e167a207db2d9ff3686260e13))
+
+### Features
+
+- add checksum addresses ([2d32ed8](https://github.com/seanjameshan/starknet.js/commit/2d32ed828f908090642a42d9f6620f050a75b43a))
+- use BigNumber for estimate fee amount ([751c2ed](https://github.com/seanjameshan/starknet.js/commit/751c2edf89d019f365f5fba8123a9df0320ff543))
+
 ## [3.10.3](https://github.com/seanjameshan/starknet.js/compare/v3.10.2...v3.10.3) (2022-05-04)
 
 ### Bug Fixes

package/__tests__/account.test.ts

@@ -1,3 +1,5 @@
+import { isBN } from 'bn.js';
+
 import typedDataExample from '../__mocks__/typedDataExample.json';
 import { Account, Contract, defaultProvider, ec, number, stark } from '../src';
 import { toBN } from '../src/utils/number';
@@ -50,7 +52,7 @@ describe('deploy and test Wallet', () => {
       entrypoint: 'transfer',
       calldata: [erc20.address, '10'],
     });
-    expect(typeof amount).toBe('number');
+    expect(isBN(amount)).toBe(true);
     expect(typeof unit).toBe('string');
   });
 

package/__tests__/provider.test.ts

@@ -76,9 +76,9 @@ describe('defaultProvider', () => {
 
     test('getTransactionReceipt', async () => {
       return expect(
-        defaultProvider.getTransactionReceipt({
-          txHash: '0x37013e1cb9c133e6fe51b4b371b76b317a480f56d80576730754c1662582348',
-        })
+        defaultProvider.getTransactionReceipt(
+          '0x37013e1cb9c133e6fe51b4b371b76b317a480f56d80576730754c1662582348'
+        )
       ).resolves.not.toThrow();
     });
 

package/__tests__/utils/address.test.ts

@@ -1,4 +1,9 @@
-import { addAddressPadding, validateAndParseAddress } from '../../src/utils/address';
+import {
+  addAddressPadding,
+  getChecksumAddress,
+  validateAndParseAddress,
+  validateChecksumAddress,
+} from '../../src/utils/address';
 // import { addHexPrefix, removeHexPrefix } from '../../src/utils/encode';
 
 describe('validateAndParseAddress', () => {
@@ -14,3 +19,27 @@ describe('validateAndParseAddress', () => {
     return expect(validateAndParseAddress(addr)).toEqual(`${addAddressPadding(addr)}`);
   });
 });
+
+describe('address checksums', () => {
+  test('should be able to calculate checksum address', () => {
+    const checksumAddress = getChecksumAddress(
+      '0x2fd23d9182193775423497fc0c472e156c57c69e4089a1967fb288a2d84e914'
+    );
+    expect(checksumAddress).toEqual(
+      '0x02FD23D9182193775423497Fc0c472E156C57C69E4089a1967fb288a2D84e914'
+    );
+  });
+  test('should be able to verify checksum address', () => {
+    const isValid = validateChecksumAddress(
+      '0x02FD23D9182193775423497Fc0c472E156C57C69E4089a1967fb288a2D84e914'
+    );
+    expect(isValid).toEqual(true);
+  });
+  test('calculated checksum address should validate', () => {
+    const checksumAddress = getChecksumAddress(
+      '0x26cb0b500d175111341fabb53bf7fa4f5a0b8c5cbb31896cec1e8383a5edda8'
+    );
+    const isValid = validateChecksumAddress(checksumAddress);
+    expect(isValid).toEqual(true);
+  });
+});

package/dist/provider/default.d.ts

@@ -1,5 +1,5 @@
 import { StarknetChainId } from '../constants';
-import { Abi, AddTransactionResponse, Call, CallContractResponse, DeployContractPayload, Endpoints, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, Invocation, TransactionReceipt } from '../types';
+import { Abi, AddTransactionResponse, Call, CallContractResponse, DeployContractPayload, Endpoints, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, Invocation, TransactionReceiptResponse } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
 import { BlockIdentifier } from './utils';
@@ -90,13 +90,9 @@ export declare class Provider implements ProviderInterface {
      * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
      *
      * @param txHash
-     * @param txId
      * @returns the transaction receipt object
      */
-    getTransactionReceipt({ txHash, txId, }: {
-        txHash?: BigNumberish;
-        txId?: BigNumberish;
-    }): Promise<TransactionReceipt>;
+    getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
     /**
      * Gets the transaction information from a tx id.
      *

package/dist/provider/default.js

@@ -196,6 +196,16 @@ var Provider = /** @class */ (function () {
                         _d.trys.push([1, 3, , 4]);
                         return [4 /*yield*/, axios_1.default.request({
                                 method: method,
+                                transformResponse: endpoint === 'estimate_fee'
+                                    ? function (res) {
+                                        return (0, json_1.parse)(res, function (_, v) {
+                                            if (v && typeof v === 'bigint') {
+                                                return (0, number_1.toBN)(v.toString());
+                                            }
+                                            return v;
+                                        });
+                                    }
+                                    : axios_1.default.defaults.transformResponse,
                                 url: (0, url_join_1.default)(baseUrl, endpoint, queryString),
                                 data: (0, json_1.stringify)(request),
                                 headers: headers,
@@ -330,20 +340,14 @@ var Provider = /** @class */ (function () {
      * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
      *
      * @param txHash
-     * @param txId
      * @returns the transaction receipt object
      */
-    Provider.prototype.getTransactionReceipt = function (_a) {
-        var txHash = _a.txHash, txId = _a.txId;
+    Provider.prototype.getTransactionReceipt = function (txHash) {
         return __awaiter(this, void 0, void 0, function () {
-            var data;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0: return [4 /*yield*/, axios_1.default.get((0, url_join_1.default)(this.feederGatewayUrl, 'get_transaction_receipt', "?" + (0, utils_1.txIdentifier)(txHash, txId)))];
-                    case 1:
-                        data = (_b.sent()).data;
-                        return [2 /*return*/, data];
-                }
+            var txHashHex;
+            return __generator(this, function (_a) {
+                txHashHex = (0, number_1.toHex)((0, number_1.toBN)(txHash));
+                return [2 /*return*/, this.fetchEndpoint('get_transaction_receipt', { transactionHash: txHashHex })];
             });
         });
     };

package/dist/provider/interface.d.ts

@@ -1,5 +1,5 @@
 import { StarknetChainId } from '../constants';
-import type { AddTransactionResponse, Call, CallContractResponse, DeployContractPayload, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Invocation, TransactionReceipt } from '../types';
+import type { AddTransactionResponse, Call, CallContractResponse, DeployContractPayload, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Invocation, TransactionReceiptResponse } from '../types';
 import type { BigNumberish } from '../utils/number';
 import { BlockIdentifier } from './utils';
 export declare abstract class ProviderInterface {
@@ -74,10 +74,7 @@ export declare abstract class ProviderInterface {
      * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
      */
     abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
-    abstract getTransactionReceipt({ txHash, txId, }: {
-        txHash?: BigNumberish;
-        txId?: BigNumberish;
-    }): Promise<TransactionReceipt>;
+    abstract getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
     /**
      * Deploys a given compiled contract (json) to starknet
      *

package/dist/types/api.d.ts

@@ -1,3 +1,4 @@
+import BN from 'bn.js';
 import { BlockIdentifier } from '../provider/utils';
 import { BigNumberish } from '../utils/number';
 import { Abi, BlockNumber, CompressedCompiledContract, EntryPointType, RawCalldata, Signature, Status, TransactionStatus } from './lib';
@@ -33,6 +34,13 @@ export declare type Endpoints = {
         REQUEST: never;
         RESPONSE: GetTransactionTraceResponse;
     };
+    get_transaction_receipt: {
+        QUERY: {
+            transactionHash: string;
+        };
+        REQUEST: never;
+        RESPONSE: TransactionReceiptResponse;
+    };
     get_storage_at: {
         QUERY: {
             contractAddress: string;
@@ -189,7 +197,7 @@ export declare type AddTransactionResponse = {
     transaction_hash: string;
     address?: string;
 };
-export declare type TransactionReceipt = {
+export declare type TransactionReceiptResponse = {
     status: Status;
     transaction_hash: string;
     transaction_index: number;
@@ -199,7 +207,7 @@ export declare type TransactionReceipt = {
     events: string[];
 };
 export declare type EstimateFeeResponse = {
-    amount: number;
+    amount: BN;
     unit: string;
 };
 export declare type RawArgs = {

package/dist/utils/address.d.ts

@@ -1,2 +1,5 @@
-export declare function addAddressPadding(address: string): string;
-export declare function validateAndParseAddress(address: string): string;
+import { BigNumberish } from './number';
+export declare function addAddressPadding(address: BigNumberish): string;
+export declare function validateAndParseAddress(address: BigNumberish): string;
+export declare function getChecksumAddress(address: BigNumberish): string;
+export declare function validateChecksumAddress(address: string): boolean;

package/dist/utils/address.js

@@ -1,17 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateAndParseAddress = exports.addAddressPadding = void 0;
+exports.validateChecksumAddress = exports.getChecksumAddress = exports.validateAndParseAddress = exports.addAddressPadding = void 0;
+/* eslint-disable no-bitwise */
+var bytes_1 = require("@ethersproject/bytes");
 var constants_1 = require("../constants");
 var encode_1 = require("./encode");
+var hash_1 = require("./hash");
 var number_1 = require("./number");
 function addAddressPadding(address) {
-    return (0, encode_1.addHexPrefix)((0, encode_1.removeHexPrefix)(address).padStart(64, '0'));
+    return (0, encode_1.addHexPrefix)((0, encode_1.removeHexPrefix)((0, number_1.toHex)((0, number_1.toBN)(address))).padStart(64, '0'));
 }
 exports.addAddressPadding = addAddressPadding;
 function validateAndParseAddress(address) {
-    if (typeof address !== 'string') {
-        throw new Error('Invalid Address Type');
-    }
     (0, number_1.assertInRange)(address, constants_1.ZERO, constants_1.MASK_251, 'Starknet Address');
     var result = addAddressPadding(address);
     if (!result.match(/^(0x)?[0-9a-fA-F]{64}$/)) {
@@ -20,3 +20,22 @@ function validateAndParseAddress(address) {
     return result;
 }
 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")
+    for (var i = 0; i < chars.length; i += 2) {
+        if (hashed[i >> 1] >> 4 >= 8) {
+            chars[i] = chars[i].toUpperCase();
+        }
+        if ((hashed[i >> 1] & 0x0f) >= 8) {
+            chars[i + 1] = chars[i + 1].toUpperCase();
+        }
+    }
+    return (0, encode_1.addHexPrefix)(chars.join(''));
+}
+exports.getChecksumAddress = getChecksumAddress;
+function validateChecksumAddress(address) {
+    return getChecksumAddress(address) === address;
+}
+exports.validateChecksumAddress = validateChecksumAddress;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.10.3",
+  "version": "3.11.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -61,6 +61,7 @@
     "typescript": "^4.4.4"
   },
   "dependencies": {
+    "@ethersproject/bytes": "^5.6.1",
     "axios": "^0.23.0",
     "bn.js": "^5.2.0",
     "elliptic": "^6.5.4",

package/provider/default.d.ts

@@ -13,7 +13,7 @@ import {
   GetTransactionStatusResponse,
   GetTransactionTraceResponse,
   Invocation,
-  TransactionReceipt,
+  TransactionReceiptResponse,
 } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
@@ -127,16 +127,9 @@ export declare class Provider implements ProviderInterface {
    * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
    *
    * @param txHash
-   * @param txId
    * @returns the transaction receipt object
    */
-  getTransactionReceipt({
-    txHash,
-    txId,
-  }: {
-    txHash?: BigNumberish;
-    txId?: BigNumberish;
-  }): Promise<TransactionReceipt>;
+  getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
   /**
    * Gets the transaction information from a tx id.
    *

package/provider/default.js

@@ -315,6 +315,17 @@ var Provider = /** @class */ (function () {
               4 /*yield*/,
               axios_1.default.request({
                 method: method,
+                transformResponse:
+                  endpoint === 'estimate_fee'
+                    ? function (res) {
+                        return (0, json_1.parse)(res, function (_, v) {
+                          if (v && typeof v === 'bigint') {
+                            return (0, number_1.toBN)(v.toString());
+                          }
+                          return v;
+                        });
+                      }
+                    : axios_1.default.defaults.transformResponse,
                 url: (0, url_join_1.default)(baseUrl, endpoint, queryString),
                 data: (0, json_1.stringify)(request),
                 headers: headers,
@@ -492,31 +503,17 @@ var Provider = /** @class */ (function () {
    * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
    *
    * @param txHash
-   * @param txId
    * @returns the transaction receipt object
    */
-  Provider.prototype.getTransactionReceipt = function (_a) {
-    var txHash = _a.txHash,
-      txId = _a.txId;
+  Provider.prototype.getTransactionReceipt = function (txHash) {
     return __awaiter(this, void 0, void 0, function () {
-      var data;
-      return __generator(this, function (_b) {
-        switch (_b.label) {
-          case 0:
-            return [
-              4 /*yield*/,
-              axios_1.default.get(
-                (0, url_join_1.default)(
-                  this.feederGatewayUrl,
-                  'get_transaction_receipt',
-                  '?' + (0, utils_1.txIdentifier)(txHash, txId)
-                )
-              ),
-            ];
-          case 1:
-            data = _b.sent().data;
-            return [2 /*return*/, data];
-        }
+      var txHashHex;
+      return __generator(this, function (_a) {
+        txHashHex = (0, number_1.toHex)((0, number_1.toBN)(txHash));
+        return [
+          2 /*return*/,
+          this.fetchEndpoint('get_transaction_receipt', { transactionHash: txHashHex }),
+        ];
       });
     });
   };

package/provider/interface.d.ts

@@ -10,7 +10,7 @@ import type {
   GetTransactionResponse,
   GetTransactionStatusResponse,
   Invocation,
-  TransactionReceipt,
+  TransactionReceiptResponse,
 } from '../types';
 import type { BigNumberish } from '../utils/number';
 import { BlockIdentifier } from './utils';
@@ -96,13 +96,7 @@ export declare abstract class ProviderInterface {
    * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
    */
   abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
-  abstract getTransactionReceipt({
-    txHash,
-    txId,
-  }: {
-    txHash?: BigNumberish;
-    txId?: BigNumberish;
-  }): Promise<TransactionReceipt>;
+  abstract getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/src/provider/default.ts

@@ -10,6 +10,7 @@ import {
   CompiledContract,
   DeployContractPayload,
   Endpoints,
+  EstimateFeeResponse,
   GetBlockResponse,
   GetCodeResponse,
   GetContractAddressesResponse,
@@ -17,14 +18,14 @@ import {
   GetTransactionStatusResponse,
   GetTransactionTraceResponse,
   Invocation,
-  TransactionReceipt,
+  TransactionReceiptResponse,
 } from '../types';
 import { getSelectorFromName } from '../utils/hash';
 import { parse, stringify } from '../utils/json';
 import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from '../utils/number';
 import { compressProgram, randomAddress } from '../utils/stark';
 import { ProviderInterface } from './interface';
-import { BlockIdentifier, getFormattedBlockIdentifier, txIdentifier } from './utils';
+import { BlockIdentifier, getFormattedBlockIdentifier } from './utils';
 
 type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
 
@@ -153,6 +154,17 @@ export class Provider implements ProviderInterface {
     try {
       const { data } = await axios.request<Endpoints[T]['RESPONSE']>({
         method,
+        transformResponse:
+          endpoint === 'estimate_fee'
+            ? (res): EstimateFeeResponse => {
+                return parse(res, (_, v) => {
+                  if (v && typeof v === 'bigint') {
+                    return toBN(v.toString());
+                  }
+                  return v;
+                });
+              }
+            : axios.defaults.transformResponse,
         url: urljoin(baseUrl, endpoint, queryString),
         data: stringify(request),
         headers,
@@ -272,22 +284,12 @@ export class Provider implements ProviderInterface {
    * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
    *
    * @param txHash
-   * @param txId
    * @returns the transaction receipt object
    */
 
-  public async getTransactionReceipt({
-    txHash,
-    txId,
-  }: {
-    txHash?: BigNumberish;
-    txId?: BigNumberish;
-  }): Promise<TransactionReceipt> {
-    const { data } = await axios.get<TransactionReceipt>(
-      urljoin(this.feederGatewayUrl, 'get_transaction_receipt', `?${txIdentifier(txHash, txId)}`)
-    );
-
-    return data;
+  public async getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse> {
+    const txHashHex = toHex(toBN(txHash));
+    return this.fetchEndpoint('get_transaction_receipt', { transactionHash: txHashHex });
   }
 
   /**

package/src/provider/interface.ts

@@ -10,7 +10,7 @@ import type {
   GetTransactionResponse,
   GetTransactionStatusResponse,
   Invocation,
-  TransactionReceipt,
+  TransactionReceiptResponse,
 } from '../types';
 import type { BigNumberish } from '../utils/number';
 import { BlockIdentifier } from './utils';
@@ -109,13 +109,7 @@ export abstract class ProviderInterface {
    */
   public abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
 
-  public abstract getTransactionReceipt({
-    txHash,
-    txId,
-  }: {
-    txHash?: BigNumberish;
-    txId?: BigNumberish;
-  }): Promise<TransactionReceipt>;
+  public abstract getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
 
   /**
    * Deploys a given compiled contract (json) to starknet

package/src/types/api.ts

@@ -1,3 +1,5 @@
+import BN from 'bn.js';
+
 import { BlockIdentifier } from '../provider/utils';
 import { BigNumberish } from '../utils/number';
 import {
@@ -43,6 +45,13 @@ export type Endpoints = {
     REQUEST: never;
     RESPONSE: GetTransactionTraceResponse;
   };
+  get_transaction_receipt: {
+    QUERY: {
+      transactionHash: string;
+    };
+    REQUEST: never;
+    RESPONSE: TransactionReceiptResponse;
+  };
   get_storage_at: {
     QUERY: {
       contractAddress: string;
@@ -217,7 +226,7 @@ export type AddTransactionResponse = {
   address?: string;
 };
 
-export type TransactionReceipt = {
+export type TransactionReceiptResponse = {
   status: Status;
   transaction_hash: string;
   transaction_index: number;
@@ -228,7 +237,7 @@ export type TransactionReceipt = {
 };
 
 export type EstimateFeeResponse = {
-  amount: number;
+  amount: BN;
   unit: string;
 };
 

package/src/utils/address.ts

@@ -1,16 +1,16 @@
+/* eslint-disable no-bitwise */
+import { arrayify } from '@ethersproject/bytes';
+
 import { MASK_251, ZERO } from '../constants';
 import { addHexPrefix, removeHexPrefix } from './encode';
-import { assertInRange } from './number';
+import { pedersen } from './hash';
+import { BigNumberish, assertInRange, toBN, toHex } from './number';
 
-export function addAddressPadding(address: string): string {
-  return addHexPrefix(removeHexPrefix(address).padStart(64, '0'));
+export function addAddressPadding(address: BigNumberish): string {
+  return addHexPrefix(removeHexPrefix(toHex(toBN(address))).padStart(64, '0'));
 }
 
-export function validateAndParseAddress(address: string): string {
-  if (typeof address !== 'string') {
-    throw new Error('Invalid Address Type');
-  }
-
+export function validateAndParseAddress(address: BigNumberish): string {
   assertInRange(address, ZERO, MASK_251, 'Starknet Address');
 
   const result = addAddressPadding(address);
@@ -21,3 +21,24 @@ export function validateAndParseAddress(address: string): string {
 
   return result;
 }
+
+// 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")
+
+  for (let i = 0; i < chars.length; i += 2) {
+    if (hashed[i >> 1] >> 4 >= 8) {
+      chars[i] = chars[i].toUpperCase();
+    }
+    if ((hashed[i >> 1] & 0x0f) >= 8) {
+      chars[i + 1] = chars[i + 1].toUpperCase();
+    }
+  }
+
+  return addHexPrefix(chars.join(''));
+}
+
+export function validateChecksumAddress(address: string): boolean {
+  return getChecksumAddress(address) === address;
+}

package/types/api.d.ts

@@ -1,3 +1,5 @@
+import BN from 'bn.js';
+
 import { BlockIdentifier } from '../provider/utils';
 import { BigNumberish } from '../utils/number';
 import {
@@ -42,6 +44,13 @@ export declare type Endpoints = {
     REQUEST: never;
     RESPONSE: GetTransactionTraceResponse;
   };
+  get_transaction_receipt: {
+    QUERY: {
+      transactionHash: string;
+    };
+    REQUEST: never;
+    RESPONSE: TransactionReceiptResponse;
+  };
   get_storage_at: {
     QUERY: {
       contractAddress: string;
@@ -201,7 +210,7 @@ export declare type AddTransactionResponse = {
   transaction_hash: string;
   address?: string;
 };
-export declare type TransactionReceipt = {
+export declare type TransactionReceiptResponse = {
   status: Status;
   transaction_hash: string;
   transaction_index: number;
@@ -211,7 +220,7 @@ export declare type TransactionReceipt = {
   events: string[];
 };
 export declare type EstimateFeeResponse = {
-  amount: number;
+  amount: BN;
   unit: string;
 };
 export declare type RawArgs = {

package/utils/address.d.ts

@@ -1,2 +1,5 @@
-export declare function addAddressPadding(address: string): string;
-export declare function validateAndParseAddress(address: string): string;
+import { BigNumberish } from './number';
+export declare function addAddressPadding(address: BigNumberish): string;
+export declare function validateAndParseAddress(address: BigNumberish): string;
+export declare function getChecksumAddress(address: BigNumberish): string;
+export declare function validateChecksumAddress(address: string): boolean;

package/utils/address.js

@@ -1,17 +1,26 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.validateAndParseAddress = exports.addAddressPadding = void 0;
+exports.validateChecksumAddress =
+  exports.getChecksumAddress =
+  exports.validateAndParseAddress =
+  exports.addAddressPadding =
+    void 0;
+/* eslint-disable no-bitwise */
+var bytes_1 = require('@ethersproject/bytes');
 var constants_1 = require('../constants');
 var encode_1 = require('./encode');
+var hash_1 = require('./hash');
 var number_1 = require('./number');
 function addAddressPadding(address) {
-  return (0, encode_1.addHexPrefix)((0, encode_1.removeHexPrefix)(address).padStart(64, '0'));
+  return (0, encode_1.addHexPrefix)(
+    (0, encode_1.removeHexPrefix)((0, number_1.toHex)((0, number_1.toBN)(address))).padStart(
+      64,
+      '0'
+    )
+  );
 }
 exports.addAddressPadding = addAddressPadding;
 function validateAndParseAddress(address) {
-  if (typeof address !== 'string') {
-    throw new Error('Invalid Address Type');
-  }
   (0, number_1.assertInRange)(address, constants_1.ZERO, constants_1.MASK_251, 'Starknet Address');
   var result = addAddressPadding(address);
   if (!result.match(/^(0x)?[0-9a-fA-F]{64}$/)) {
@@ -20,3 +29,24 @@ function validateAndParseAddress(address) {
   return result;
 }
 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")
+  for (var i = 0; i < chars.length; i += 2) {
+    if (hashed[i >> 1] >> 4 >= 8) {
+      chars[i] = chars[i].toUpperCase();
+    }
+    if ((hashed[i >> 1] & 0x0f) >= 8) {
+      chars[i + 1] = chars[i + 1].toUpperCase();
+    }
+  }
+  return (0, encode_1.addHexPrefix)(chars.join(''));
+}
+exports.getChecksumAddress = getChecksumAddress;
+function validateChecksumAddress(address) {
+  return getChecksumAddress(address) === address;
+}
+exports.validateChecksumAddress = validateChecksumAddress;

package/www/docs/API/changelog.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 7
 ---
 
 # CHANGELOG

package/www/docs/API/contract.md

@@ -14,7 +14,7 @@ Contracts allow you to transform Cairo values, like `Uint256` to `BigNumber`. It
 
 `contract.attach(providerOrAccount)` _for changing the provider or account_
 
-`contract.connect(providerOrAccount)` _for changing the address of the connected contract_
+`contract.connect(address)` _for changing the address of the connected contract_
 
 ## Contract properties
 

package/www/docs/API/contractFacotry.md

@@ -12,9 +12,9 @@ Contract Factory allow you to deploy contracts onto StarkNet. To deploy a Contra
 
 Creates a new instance of a ContractFactory for the contract described by the _compiledContract_.
 
-`contractFacotry.connect(providerOrAccount)` _for changing the provider or account_
+`contractFactory.connect(providerOrAccount)` _for changing the provider or account_
 
-`contractFacotry.attach(address)` _for changing the address of the connected contract factory_
+`contractFactory.attach(address)` _for changing the address of the connected contract factory_
 
 ## Properties
 

package/www/docs/API/utils.md

@@ -0,0 +1,34 @@
+---
+sidebar_position: 6
+---
+
+# Utils
+
+Util functions are provided so you can use low level functions in your application.
+
+## `address`
+
+the address helpers can be imported using:
+
+```js
+import { address } from 'starknet.js';
+```
+
+### `getChecksumAddress(address: BigNumberish): string`
+
+This function accepts an address as a `BigNumberish` and returns the checksummed address as a string.
+An example:
+
+```js
+import { address } from 'starknet.js';
+
+const addressToCheck = '0x2fd23d9182193775423497fc0c472e156c57c69e4089a1967fb288a2d84e914';
+
+const checksummedAddress = address.getChecksumAddress(addressToCheck);
+
+console.log(checksummedAddress); // 0x02FD23D9182193775423497Fc0c472E156C57C69E4089a1967fb288a2D84e914
+```
+
+### `validateChecksumAddress(address: string): boolean`
+
+This function validates the checksum address. It returns true if the address is valid, false otherwise.