starknet 3.10.3 → 3.12.1

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/provider/utils.js

@@ -39,8 +39,8 @@ exports.txIdentifier = txIdentifier;
  * @returns block identifier object
  */
 function getBlockIdentifier(blockIdentifier) {
-  if (blockIdentifier === null) {
-    return { type: 'BLOCK_NUMBER', data: null };
+  if (blockIdentifier === null || blockIdentifier === 'latest') {
+    return { type: 'BLOCK_NUMBER', data: 'latest' }; // default to latest block
   }
   if (blockIdentifier === 'pending') {
     return { type: 'BLOCK_NUMBER', data: 'pending' };

package/src/account/default.ts

@@ -8,7 +8,6 @@ import {
   Abi,
   AddTransactionResponse,
   Call,
-  EstimateFeeResponse,
   InvocationsDetails,
   InvocationsSignerDetails,
   InvokeFunctionTransaction,
@@ -16,6 +15,7 @@ import {
   Signature,
   Transaction,
 } from '../types';
+import { EstimateFee } from '../types/account';
 import { sign } from '../utils/ellipticCurve';
 import {
   computeHashOnElements,
@@ -60,7 +60,7 @@ export class Account extends Provider implements AccountInterface {
       nonce: providedNonce,
       blockIdentifier = 'pending',
     }: { nonce?: BigNumberish; blockIdentifier?: BlockIdentifier } = {}
-  ): Promise<EstimateFeeResponse> {
+  ): Promise<EstimateFee> {
     const transactions = Array.isArray(calls) ? calls : [calls];
     const nonce = providedNonce ?? (await this.getNonce());
     const version = toBN(feeTransactionVersion);
@@ -76,7 +76,7 @@ export class Account extends Provider implements AccountInterface {
     const signature = await this.signer.signTransaction(transactions, signerDetails);
 
     const calldata = fromCallsToExecuteCalldataWithNonce(transactions, nonce);
-    return this.fetchEndpoint(
+    const fetchedEstimate = await this.fetchEndpoint(
       'estimate_fee',
       { blockIdentifier },
       {
@@ -87,6 +87,12 @@ export class Account extends Provider implements AccountInterface {
         signature: bigNumberishArrayToDecimalStringArray(signature),
       }
     );
+    const suggestedMaxFee = estimatedFeeToMaxFee(fetchedEstimate.amount);
+
+    return {
+      ...fetchedEstimate,
+      suggestedMaxFee,
+    };
   }
 
   /**
@@ -94,7 +100,9 @@ export class Account extends Provider implements AccountInterface {
    *
    * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/gateway/gateway_client.py#L13-L17)
    *
-   * @param transaction - transaction to be invoked
+   * @param calls - one or more calls to be executed
+   * @param abis - one or more abis which can be used to display the calls
+   * @param transactionsDetail - optional transaction details
    * @returns a confirmation of invoking a function on the starknet contract
    */
   public async execute(
@@ -108,8 +116,8 @@ export class Account extends Provider implements AccountInterface {
     if (transactionsDetail.maxFee || transactionsDetail.maxFee === 0) {
       maxFee = transactionsDetail.maxFee;
     } else {
-      const estimatedFee = (await this.estimateFee(transactions, { nonce })).amount;
-      maxFee = estimatedFeeToMaxFee(estimatedFee).toString();
+      const { suggestedMaxFee } = await this.estimateFee(transactions, { nonce });
+      maxFee = suggestedMaxFee.toString();
     }
 
     const signerDetails: InvocationsSignerDetails = {

package/src/account/interface.ts

@@ -5,11 +5,11 @@ import {
   AddTransactionResponse,
   Call,
   DeployContractPayload,
-  EstimateFeeResponse,
   Invocation,
   InvocationsDetails,
   Signature,
 } from '../types';
+import { EstimateFee } from '../types/account';
 import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData/types';
 
@@ -44,7 +44,7 @@ export abstract class AccountInterface extends ProviderInterface {
    *
    * @returns response from addTransaction
    */
-  public abstract estimateFee(invocation: Invocation): Promise<EstimateFeeResponse>;
+  public abstract estimateFee(invocation: Invocation): Promise<EstimateFee>;
 
   /**
    * Invoke execute function in account contract

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/provider/utils.ts

@@ -43,8 +43,8 @@ type BlockIdentifierObject =
  * @returns block identifier object
  */
 export function getBlockIdentifier(blockIdentifier: BlockIdentifier): BlockIdentifierObject {
-  if (blockIdentifier === null) {
-    return { type: 'BLOCK_NUMBER', data: null };
+  if (blockIdentifier === null || blockIdentifier === 'latest') {
+    return { type: 'BLOCK_NUMBER', data: 'latest' }; // default to latest block
   }
   if (blockIdentifier === 'pending') {
     return { type: 'BLOCK_NUMBER', data: 'pending' };

package/src/types/account.ts

@@ -0,0 +1,7 @@
+import BN from 'bn.js';
+
+import { EstimateFeeResponse } from './api';
+
+export interface EstimateFee extends EstimateFeeResponse {
+  suggestedMaxFee: BN;
+}

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/types/lib.ts

@@ -60,7 +60,7 @@ export type Abi = Array<FunctionAbi | StructAbi>;
 
 export type EntryPointsByType = object;
 export type Program = Record<any, any>;
-export type BlockNumber = 'pending' | null | number;
+export type BlockNumber = 'pending' | 'latest' | null | number;
 
 export type CompiledContract = {
   abi: Abi;

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/src/utils/stark.ts

@@ -50,7 +50,7 @@ export function compileCalldata(args: RawArgs): Calldata {
   });
 }
 
-export function estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead: number = 0.15): BN {
+export function estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead: number = 0.5): BN {
   // BN can only handle Integers, so we need to do all calulations with integers
   const overHeadPercent = Math.round((1 + overhead) * 100);
   return toBN(estimatedFee).mul(toBN(overHeadPercent)).div(toBN(100));

package/types/account.d.ts

@@ -0,0 +1,6 @@
+import BN from 'bn.js';
+
+import { EstimateFeeResponse } from './api';
+export interface EstimateFee extends EstimateFeeResponse {
+  suggestedMaxFee: BN;
+}

package/types/account.js

@@ -0,0 +1,2 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });

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/types/lib.d.ts

@@ -54,7 +54,7 @@ export declare type StructAbi = {
 export declare type Abi = Array<FunctionAbi | StructAbi>;
 export declare type EntryPointsByType = object;
 export declare type Program = Record<any, any>;
-export declare type BlockNumber = 'pending' | null | number;
+export declare type BlockNumber = 'pending' | 'latest' | null | number;
 export declare type CompiledContract = {
   abi: Abi;
   entry_points_by_type: EntryPointsByType;

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/utils/stark.js

@@ -114,7 +114,7 @@ function compileCalldata(args) {
 exports.compileCalldata = compileCalldata;
 function estimatedFeeToMaxFee(estimatedFee, overhead) {
   if (overhead === void 0) {
-    overhead = 0.15;
+    overhead = 0.5;
   }
   // BN can only handle Integers, so we need to do all calulations with integers
   var overHeadPercent = Math.round((1 + overhead) * 100);

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.