starknet 4.9.0 → 4.10.0

package/src/contract/interface.ts

@@ -57,6 +57,7 @@ export abstract class ContractInterface {
    *
    * @param method name of the method
    * @param args Array of the arguments for the call
+   * @param options optional blockIdentifier
    * @returns Result of the call as an array with key value pars
    */
   public abstract call(
@@ -72,6 +73,7 @@ export abstract class ContractInterface {
    *
    * @param method name of the method
    * @param args Array of the arguments for the invoke
+   * @param options
    * @returns Add Transaction Response
    */
   public abstract invoke(
@@ -81,10 +83,11 @@ export abstract class ContractInterface {
   ): Promise<InvokeFunctionResponse>;
 
   /**
-   * Calls a method on a contract
+   * Estimates a method on a contract
    *
    * @param method name of the method
    * @param args Array of the arguments for the call
+   * @param options optional blockIdentifier
    */
   public abstract estimate(
     method: string,
@@ -99,7 +102,7 @@ export abstract class ContractInterface {
    *
    * @param method name of the method
    * @param args Array of the arguments for the call
-   * @returns Invocation objet
+   * @returns Invocation object
    */
   public abstract populate(method: string, args?: Array<any>): Invocation;
 }

package/src/provider/rpc.ts

@@ -38,6 +38,7 @@ import { Block, BlockIdentifier } from './utils';
 export type RpcProviderOptions = {
   nodeUrl: string;
   retries?: number;
+  headers?: object;
 };
 
 export class RpcProvider implements ProviderInterface {
@@ -46,14 +47,17 @@ export class RpcProvider implements ProviderInterface {
   // from interface
   public chainId!: StarknetChainId;
 
+  public headers: object;
+
   private responseParser = new RPCResponseParser();
 
   private retries: number;
 
   constructor(optionsOrProvider: RpcProviderOptions) {
-    const { nodeUrl, retries } = optionsOrProvider;
+    const { nodeUrl, retries, headers } = optionsOrProvider;
     this.nodeUrl = nodeUrl;
     this.retries = retries || 200;
+    this.headers = { 'Content-Type': 'application/json', ...headers };
 
     this.getChainId().then((chainId) => {
       this.chainId = chainId;
@@ -64,7 +68,7 @@ export class RpcProvider implements ProviderInterface {
     return fetch(this.nodeUrl, {
       method: 'POST',
       body: stringify({ method, jsonrpc: '2.0', params, id: 0 }),
-      headers: { 'Content-Type': 'application/json' },
+      headers: this.headers,
     });
   }
 
@@ -196,7 +200,7 @@ export class RpcProvider implements ProviderInterface {
 
   public async getClassAt(
     contractAddress: string,
-    blockIdentifier: BlockIdentifier
+    blockIdentifier: BlockIdentifier = 'pending'
   ): Promise<RPC.ContractClass> {
     const block_id = new Block(blockIdentifier).identifier;
     return this.fetchEndpoint('starknet_getClassAt', {

package/src/provider/sequencer.ts

@@ -44,7 +44,7 @@ import { GatewayError, HttpError } from './errors';
 import { ProviderInterface } from './interface';
 import { Block, BlockIdentifier } from './utils';
 
-type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
+type NetworkName = 'mainnet-alpha' | 'goerli-alpha' | 'goerli-alpha-2';
 
 function isEmptyQueryObject(obj?: Record<any, any>): obj is undefined {
   return (
@@ -62,6 +62,7 @@ export type SequencerProviderOptions =
       feederGatewayUrl?: string;
       gatewayUrl?: string;
       chainId?: StarknetChainId;
+      headers?: object;
     };
 
 export class SequencerProvider implements ProviderInterface {
@@ -73,9 +74,11 @@ export class SequencerProvider implements ProviderInterface {
 
   public chainId: StarknetChainId;
 
+  public headers: object | undefined;
+
   private responseParser = new SequencerAPIResponseParser();
 
-  constructor(optionsOrProvider: SequencerProviderOptions = { network: 'goerli-alpha' }) {
+  constructor(optionsOrProvider: SequencerProviderOptions = { network: 'goerli-alpha-2' }) {
     if ('network' in optionsOrProvider) {
       this.baseUrl = SequencerProvider.getNetworkFromName(optionsOrProvider.network);
       this.chainId = SequencerProvider.getChainIdFromBaseUrl(this.baseUrl);
@@ -93,6 +96,8 @@ export class SequencerProvider implements ProviderInterface {
       this.chainId =
         optionsOrProvider.chainId ??
         SequencerProvider.getChainIdFromBaseUrl(optionsOrProvider.baseUrl);
+
+      this.headers = optionsOrProvider?.headers;
     }
   }
 
@@ -101,6 +106,9 @@ export class SequencerProvider implements ProviderInterface {
       case 'mainnet-alpha':
         return 'https://alpha-mainnet.starknet.io';
       case 'goerli-alpha':
+        return 'https://alpha4.starknet.io';
+      case 'goerli-alpha-2':
+        return 'https://alpha4-2.starknet.io';
       default:
         return 'https://alpha4.starknet.io';
     }
@@ -153,13 +161,14 @@ export class SequencerProvider implements ProviderInterface {
     return `?${queryString}`;
   }
 
-  private getHeaders(method: 'POST' | 'GET'): Record<string, string> | undefined {
+  private getHeaders(method: 'POST' | 'GET'): object | undefined {
     if (method === 'POST') {
       return {
         'Content-Type': 'application/json',
+        ...this.headers,
       };
     }
-    return undefined;
+    return this.headers;
   }
 
   // typesafe fetch

package/src/signer/default.ts

@@ -28,6 +28,11 @@ export class Signer implements SignerInterface {
     return getStarkKey(this.keyPair);
   }
 
+  public async signMessage(typedData: TypedData, accountAddress: string): Promise<Signature> {
+    const msgHash = getMessageHash(typedData, accountAddress);
+    return sign(this.keyPair, msgHash);
+  }
+
   public async signTransaction(
     transactions: Call[],
     transactionsDetail: InvocationsSignerDetails,
@@ -52,22 +57,6 @@ export class Signer implements SignerInterface {
     return sign(this.keyPair, msgHash);
   }
 
-  public async signDeclareTransaction(
-    // contractClass: ContractClass,  // Should be used once class hash is present in ContractClass
-    { classHash, senderAddress, chainId, maxFee, version, nonce }: DeclareSignerDetails
-  ) {
-    const msgHash = calculateDeclareTransactionHash(
-      classHash,
-      senderAddress,
-      version,
-      maxFee,
-      chainId,
-      nonce
-    );
-
-    return sign(this.keyPair, msgHash);
-  }
-
   public async signDeployAccountTransaction({
     classHash,
     contractAddress,
@@ -92,8 +81,19 @@ export class Signer implements SignerInterface {
     return sign(this.keyPair, msgHash);
   }
 
-  public async signMessage(typedData: TypedData, accountAddress: string): Promise<Signature> {
-    const msgHash = getMessageHash(typedData, accountAddress);
+  public async signDeclareTransaction(
+    // contractClass: ContractClass,  // Should be used once class hash is present in ContractClass
+    { classHash, senderAddress, chainId, maxFee, version, nonce }: DeclareSignerDetails
+  ) {
+    const msgHash = calculateDeclareTransactionHash(
+      classHash,
+      senderAddress,
+      version,
+      maxFee,
+      chainId,
+      nonce
+    );
+
     return sign(this.keyPair, msgHash);
   }
 }

package/src/signer/interface.ts

@@ -40,6 +40,7 @@ export abstract class SignerInterface {
 
   /**
    * Signs a DEPLOY_ACCOUNT transaction with the starknet private key and returns the signature
+   *
    * @param transaction
    * - contractAddress - the computed address of the contract
    * - constructorCalldata - calldata to be passed in deploy constructor
@@ -56,6 +57,7 @@ export abstract class SignerInterface {
 
   /**
    * Signs a DECLARE transaction with the starknet private key and returns the signature
+   *
    * @param transaction
    * - classHash - computed class hash. Will be replaced by ContractClass in future once class hash is present in CompiledContract
    * - senderAddress - the address of the sender

package/src/types/api/index.ts

@@ -1,10 +1,6 @@
 import { BigNumberish } from '../../utils/number';
 import { Signature } from '../lib';
 
-export type RawArgs = {
-  [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
-};
-
 export type Calldata = string[];
 
 export type Overrides = {

package/src/types/index.ts

@@ -1,6 +1,6 @@
 export * from './lib';
 export * as api from './api';
-export { Calldata, Overrides, RawArgs } from './api';
+export { Calldata, Overrides } from './api';
 export * from './signer';
 export * from './contract';
 export * from './account';

package/src/types/lib.ts

@@ -7,6 +7,11 @@ export type KeyPair = EC.KeyPair;
 export type Signature = string[];
 export type RawCalldata = BigNumberish[];
 export type AllowArray<T> = T | T[];
+export type RawArgs =
+  | {
+      [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
+    }
+  | string[];
 
 export interface ContractClass {
   program: CompressedProgram;
@@ -14,6 +19,14 @@ export interface ContractClass {
   abi?: Abi;
 }
 
+export type UniversalDeployerContractPayload = {
+  classHash: BigNumberish;
+  salt: string;
+  unique: boolean;
+  constructorCalldata?: RawArgs;
+  isDevnet?: boolean;
+};
+
 export type DeployContractPayload = {
   contract: CompiledContract | string;
   constructorCalldata?: RawCalldata;

package/src/utils/number.ts

@@ -88,3 +88,5 @@ export function getHexString(value: string) {
 export function getHexStringArray(value: Array<string>) {
   return value.map((el) => getHexString(el));
 }
+
+export const toCairoBool = (value: boolean): string => (+value).toString();

package/types/api/index.d.ts

@@ -1,11 +1,5 @@
 import { BigNumberish } from '../../utils/number';
 import { Signature } from '../lib';
-export declare type RawArgs = {
-    [inputName: string]: string | string[] | {
-        type: 'struct';
-        [k: string]: BigNumberish;
-    };
-};
 export declare type Calldata = string[];
 export declare type Overrides = {
     maxFee?: BigNumberish;

package/types/index.d.ts

@@ -1,6 +1,6 @@
 export * from './lib';
 export * as api from './api';
-export { Calldata, Overrides, RawArgs } from './api';
+export { Calldata, Overrides } from './api';
 export * from './signer';
 export * from './contract';
 export * from './account';

package/types/lib.d.ts

@@ -5,11 +5,24 @@ export declare type KeyPair = EC.KeyPair;
 export declare type Signature = string[];
 export declare type RawCalldata = BigNumberish[];
 export declare type AllowArray<T> = T | T[];
+export declare type RawArgs = {
+    [inputName: string]: string | string[] | {
+        type: 'struct';
+        [k: string]: BigNumberish;
+    };
+} | string[];
 export interface ContractClass {
     program: CompressedProgram;
     entry_points_by_type: RPC.ContractClass['entry_points_by_type'];
     abi?: Abi;
 }
+export declare type UniversalDeployerContractPayload = {
+    classHash: BigNumberish;
+    salt: string;
+    unique: boolean;
+    constructorCalldata?: RawArgs;
+    isDevnet?: boolean;
+};
 export declare type DeployContractPayload = {
     contract: CompiledContract | string;
     constructorCalldata?: RawCalldata;

package/utils/number.d.ts

@@ -13,3 +13,4 @@ export declare const toHexString: (value: string) => string;
 export declare function getDecimalString(value: string): string;
 export declare function getHexString(value: string): string;
 export declare function getHexStringArray(value: Array<string>): string[];
+export declare const toCairoBool: (value: boolean) => string;

package/utils/number.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHexStringArray = exports.getHexString = exports.getDecimalString = exports.toHexString = exports.isStringWholeNumber = exports.bigNumberishArrayToHexadecimalStringArray = exports.bigNumberishArrayToDecimalStringArray = exports.assertInRange = exports.toFelt = exports.hexToDecimalString = exports.toHex = exports.toBN = exports.isHex = void 0;
+exports.toCairoBool = exports.getHexStringArray = exports.getHexString = exports.getDecimalString = exports.toHexString = exports.isStringWholeNumber = exports.bigNumberishArrayToHexadecimalStringArray = exports.bigNumberishArrayToDecimalStringArray = exports.assertInRange = exports.toFelt = exports.hexToDecimalString = exports.toHex = exports.toBN = exports.isHex = void 0;
 var bn_js_1 = __importStar(require("bn.js"));
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
 var encode_1 = require("./encode");
@@ -108,3 +108,5 @@ function getHexStringArray(value) {
     return value.map(function (el) { return getHexString(el); });
 }
 exports.getHexStringArray = getHexStringArray;
+var toCairoBool = function (value) { return (+value).toString(); };
+exports.toCairoBool = toCairoBool;

package/www/docs/API/account.md

@@ -24,20 +24,56 @@ The address of the account contract.
 
 ## Methods
 
-account.**getNonce()** => _Promise < BigNumberish >_
+account.**getNonce(blockIdentifier)** => _Promise < BigNumberish >_
 
-Gets the new Nonce of the connected account for the next transaction.
+Gets the nonce of the account with respect to a specific block.
+
+_blockIdentifier_ - optional blockIdentifier. Defaults to 'pending'.
+
+Returns the nonce of the account.
+
+<hr />
+
+account.**estimateInvokeFee**(calls [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
+
+Estimate Fee for executing an INVOKE transaction on starknet.
+
+The _calls_ object structure:
+
+- calls.**contractAddress** - Address of the contract
+- calls.**entrypoint** - Entrypoint of the call (method name)
+- calls.**calldata** - Payload for the invoking method
+
+The _estimateFeeDetails_ object may include any of:
+
+- estimateFeeDetails.**blockIdentifier** - Block Identifier for the transaction
+- estimateFeeDetails.**nonce** - Nonce for the transaction
+
+###### _EstimateFeeResponse_
+
+```typescript
+{
+  overall_fee: BN;
+  gas_consumed?: BN;
+  gas_price?: BN;
+}
+```
 
 <hr />
 
-account.**estimateInvokeFee**(calls [ , options ]) => _Promise < EstimateFeeResponse >_
+account.**estimateDeclareFee**(contractPayload [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
+
+Estimate Fee for executing a DECLARE transaction on starknet.
 
-Gets the estimated fee for the call(s).
+The _contractPayload_ object structure:
 
-The _options_ object may include any of:
+- contractPayload.**contract** - The compiled contract
+- contractPayload.**classHash** - This can be obtained by using starknet-cli. Once the classHash is included in CompiledContract, this can be removed
 
-- options.**blockIdentifier** - Block Identifier for the transaction
-- options.**nonce** - Nonce for the transaction
+The _estimateFeeDetails_ object may include any of:
+
+- estimateFeeDetails.**blockIdentifier** - Block Identifier for the transaction
+- estimateFeeDetails.**nonce** - Nonce for the transaction
 
 ###### _EstimateFeeResponse_
 
@@ -51,14 +87,19 @@ The _options_ object may include any of:
 
 <hr />
 
-account.**estimateDeclareFee**(contractPayload [ , options ]) => _Promise < EstimateFeeResponse >_
+account.**estimateAccountDeployFee**(contractPayload [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
+
+Estimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet
 
-Gets the estimated fee for the declare transaction.
+The _contractPayload_ object structure:
 
-The _options_ object may include any of:
+- contractPayload.**contract** - The compiled contract to be declared
+- contractPayload.**classHash** - This can be obtained by using starknet-cli. Once the classHash is included in CompiledContract, this can be removed
 
-- options.**blockIdentifier** - Block Identifier for the transaction
-- options.**nonce** - Nonce for the transaction
+The _estimateFeeDetails_ object may include any of:
+
+- estimateFeeDetails.**blockIdentifier** - Block Identifier for the transaction
+- estimateFeeDetails.**nonce** - Nonce for the transaction
 
 ###### _EstimateFeeResponse_
 
@@ -72,17 +113,26 @@ The _options_ object may include any of:
 
 <hr />
 
-account.**execute**(calls [ , abi , transactionsDetail ]) => _Promise < AddTransactionResponse >_
+account.**execute**(transactions [ , abi , transactionsDetail ]) => _Promise < InvokeFunctionResponse >_
 
 Executes one or multiple calls using the account contract.
 
+The _transactions_ object structure:
+
+- contractPayload.**contractAddress** - the address of the contract
+- contractPayload.**entrypoint** - the entrypoint of the contract
+- contractPayload.**calldata** - (defaults to []) the calldata
+- contractPayload.**signature** - (defaults to []) the signature
+
+_abi_ - (optional) the abi of the contract for better displaying
+
 The _transactionsDetail_ object may include any of:
 
 - transactionsDetail.**maxFee** - Max Fee that that will be used to execute the call(s)
 - transactionsDetail.**nonce** - Nonce for the transaction
 - transactionsDetail.**version** - Version for the transaction (default is 1)
 
-###### _AddTransactionResponse_
+###### _InvokeFunctionResponse_
 
 ```typescript
 {
@@ -92,12 +142,14 @@ The _transactionsDetail_ object may include any of:
 
 <hr />
 
-account.**declare**(payload [ , transactionsDetail ]) => _Promise < DeclareContractResponse >_
+account.**declare**(contractPayload [ , transactionsDetail ]) => _Promise < DeclareContractResponse >_
 
-The _payload_ object consists of:
+Declares a given compiled contract (json) to starknet.
 
-- payload.**contract** - The compiled contract
-- payload.**classHash** - Hash of the compiled contract
+The _contractPayload_ object consists of:
+
+- contractPayload.**contract** - The compiled contract
+- contractPayload.**classHash** - Hash of the compiled contract
 
 The _transactionsDetail_ object may include any of:
 
@@ -105,8 +157,6 @@ The _transactionsDetail_ object may include any of:
 - transactionsDetail.**nonce** - Nonce for the transaction
 - transactionsDetail.**version** - Version for the transaction (default is 1)
 
-Declares a contract on Starknet.
-
 > _Note:_ Once the classHash is included in CompiledContract, this parameter can be removed. Currently it can be pre-computed from starknet-cli.
 
 Example:
@@ -128,11 +178,43 @@ const declareTx = await account.declare({
 };
 ```
 
+<hr />
+
+account.**deployAccount**(contractPayload [ , transactionsDetail ]) => _Promise < DeployContractResponse >_
+
+Declares a given compiled contract (json) to starknet.
+
+The _contractPayload_ object consists of:
+
+- contractPayload.**classHash** - Hash of the compiled contract
+- contractPayload.**constructorCalldata** - optional
+- contractPayload.**addressSalt** - optional
+- contractPayload.**contractAddress** - optional
+
+The _transactionsDetail_ object may include any of:
+
+- transactionsDetail.**maxFee** - Max Fee that that will be used to execute the call(s)
+- transactionsDetail.**nonce** - Nonce for the transaction
+- transactionsDetail.**version** - Version for the transaction (default is 1)
+
+> _Note:_ Once the classHash is included in CompiledContract, this parameter can be removed. Currently it can be pre-computed from starknet-cli.
+
+###### _DeployContractResponse_
+
+```typescript
+{
+  contract_address: string;
+  transaction_hash: string;
+};
+```
+
 <hr/>
 
 account.**signMessage**(typedData) => _Promise < Signature >_
 
-Creates a signature from the passed data.
+Sign an JSON object for off-chain usage with the starknet private key and return the signature. This adds a message prefix so it cant be interchanged with transactions.
+
+_typedData_ - JSON object to be signed
 
 ###### _Signature_
 
@@ -144,7 +226,11 @@ string[];
 
 account.**hashMessage**(typedData) => _Promise < string >_
 
-Creates a hash from the passed data.
+Hash a JSON object with pederson hash and return the hash. This adds a message prefix so it cant be interchanged with transactions.
+
+_typedData_ - JSON object to be signed
+
+Returns the hash of the JSON object.
 
 <hr />
 
@@ -162,4 +248,18 @@ account.**verifyMessage**(typedData, signature) => _Promise < boolean >_
 
 Verify a signature of a JSON object.
 
+_typedData_ - JSON object to be verified
+_signature_ - signature of the JSON object
+
+Returns true if the signature is valid, false otherwise
+
 <hr />
+
+account.**getSuggestedMaxFee**(estimateFeeAction, details) => _Promise < BigNumberish >_
+
+Gets Suggested Max Fee based on the transaction type.
+
+The _details_ object may include any of:
+
+- details.**blockIdentifier**
+- details.**nonce**

package/www/docs/API/contract.md

@@ -18,6 +18,10 @@ Contracts allow you to transform Cairo values, like `Uint256` to `BigNumber`. It
 
 ## Properties
 
+contract.**abi** => _Abi_
+
+The ABI the contract was constructed with.
+
 contract.**address** => _string_
 
 The address the contract was constructed/connected with.
@@ -30,16 +34,48 @@ contract.**deployTransactionHash** => _string | null_
 
 If the Contract object is the result of a ContractFactory deployment, this is the transaction which was used to deploy the contract.
 
-contract.**abi** => _Abi_
+## Methods
 
-The ABI the contract was constructed with.
+contract.**attach**(address) => void
 
-## Methods
+Saves the address of the contract deployed on network that will be used for interaction.
+
+_address_ - address of the contract.
+
+<br></br>
+
+contract.**connect**(providerOrAccount) => void
+
+Attaches to new Provider or Account
+
+<br></br>
 
 contract.**deployed**() => _Promise < Contract >_
 
 If the Contract object is the result of a ContractFactory deployment, this method will wait for the transaction to be resolved.
 
+<br></br>
+
+contract.**call**(method, args, options) => _Promise < Result >_
+
+Calls a method on a contract.
+
+<br></br>
+
+contract.**invoke**(method, args, options) => _Promise < InvokeFunctionResponse >_
+
+Invokes a method on a contract.
+
+<br></br>
+
+contract.**estimate**(method, args, options) => _Promise < any >_
+
+Estimates a method on a contract.
+
+<br></br>
+
+contract.**populate**(method, args, options) => _Invocation_
+
 ## Meta-Class
 
 A Meta-Class is a Class which has any of its properties determined at run-time. The Contract object uses a Contract's ABI to determine what methods are available, so the following sections describe the generic ways to interact with the properties added at run-time during the Contract constructor.

package/www/docs/API/provider.md

@@ -259,10 +259,12 @@ The options for the provider depend on the network. The structure of the options
 - options.**baseUrl** - Base URL of the network
 - options.**feederGatewayUrl** - Feeder Gateway Endpoint of the network
 - options.**gatewayUrl** - Gateway Endpoint
+- options.**headers** - [Optional] custom fetch headers
 
 or
 
 - options.**network** - Either 'mainnet-alpha' or 'goerli-alpha'
+- options.**headers** - [Optional] custom fetch headers
 
 Example:
 
@@ -396,6 +398,8 @@ Gets the transaction trace from a tx hash.
 `new starknet.RpcProvider(options)`
 
 - options.**nodeUrl** - Starknet RPC node url
+- options.**headers** - [Optional] custom fetch headers
+- options.**retries** - [Optional] wait for transaction max retries
 
 Example: