starknet 4.17.0 → 4.18.0

package/src/provider/default.ts

@@ -1,187 +0,0 @@
-import { StarknetChainId } from '../constants';
-import {
-  Call,
-  CallContractResponse,
-  ContractClass,
-  DeclareContractResponse,
-  DeclareContractTransaction,
-  DeployAccountContractTransaction,
-  DeployContractResponse,
-  EstimateFeeResponse,
-  GetBlockResponse,
-  GetCodeResponse,
-  GetTransactionReceiptResponse,
-  GetTransactionResponse,
-  Invocation,
-  InvocationsDetailsWithNonce,
-  InvokeFunctionResponse,
-  Status,
-} from '../types';
-import { BigNumberish } from '../utils/number';
-import { ProviderInterface } from './interface';
-import { RpcProvider, RpcProviderOptions } from './rpc';
-import { SequencerProvider, SequencerProviderOptions } from './sequencer';
-import { BlockIdentifier } from './utils';
-
-export interface ProviderOptions {
-  sequencer?: SequencerProviderOptions;
-  rpc?: RpcProviderOptions;
-}
-
-export class Provider implements ProviderInterface {
-  private provider!: ProviderInterface;
-
-  constructor(providerOrOptions?: ProviderOptions | ProviderInterface) {
-    if (providerOrOptions instanceof Provider) {
-      // providerOrOptions is Provider
-      this.provider = providerOrOptions.provider;
-    } else if (
-      providerOrOptions instanceof RpcProvider ||
-      providerOrOptions instanceof SequencerProvider
-    ) {
-      // providerOrOptions is SequencerProvider or RpcProvider
-      this.provider = <ProviderInterface>providerOrOptions;
-    } else if (providerOrOptions && 'rpc' in providerOrOptions) {
-      // providerOrOptions is rpc option
-      this.provider = new RpcProvider(<RpcProviderOptions>providerOrOptions.rpc);
-    } else if (providerOrOptions && 'sequencer' in providerOrOptions) {
-      // providerOrOptions is sequencer option
-      this.provider = new SequencerProvider(<SequencerProviderOptions>providerOrOptions.sequencer);
-    } else {
-      // providerOrOptions is none, create SequencerProvider as default
-      this.provider = new SequencerProvider();
-    }
-  }
-
-  public get chainId(): StarknetChainId {
-    return this.provider.chainId;
-  }
-
-  public async getChainId(): Promise<StarknetChainId> {
-    return this.provider.getChainId();
-  }
-
-  public async getBlock(blockIdentifier: BlockIdentifier): Promise<GetBlockResponse> {
-    return this.provider.getBlock(blockIdentifier);
-  }
-
-  public async getClassAt(
-    contractAddress: string,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<ContractClass> {
-    return this.provider.getClassAt(contractAddress, blockIdentifier);
-  }
-
-  public async getClassHashAt(
-    contractAddress: string,
-    blockIdentifier: BlockIdentifier
-  ): Promise<string> {
-    return this.provider.getClassHashAt(contractAddress, blockIdentifier);
-  }
-
-  public getClassByHash(classHash: string): Promise<ContractClass> {
-    return this.provider.getClassByHash(classHash);
-  }
-
-  public async getEstimateFee(
-    invocationWithTxType: Invocation,
-    invocationDetails: InvocationsDetailsWithNonce,
-    blockIdentifier: BlockIdentifier
-  ): Promise<EstimateFeeResponse> {
-    return this.provider.getEstimateFee(invocationWithTxType, invocationDetails, blockIdentifier);
-  }
-
-  public async getInvokeEstimateFee(
-    invocationWithTxType: Invocation,
-    invocationDetails: InvocationsDetailsWithNonce,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<EstimateFeeResponse> {
-    return this.provider.getInvokeEstimateFee(
-      invocationWithTxType,
-      invocationDetails,
-      blockIdentifier
-    );
-  }
-
-  public async getNonceForAddress(
-    contractAddress: string,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<BigNumberish> {
-    return this.provider.getNonceForAddress(contractAddress, blockIdentifier);
-  }
-
-  public async getStorageAt(
-    contractAddress: string,
-    key: BigNumberish,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<BigNumberish> {
-    return this.provider.getStorageAt(contractAddress, key, blockIdentifier);
-  }
-
-  public async getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse> {
-    return this.provider.getTransaction(txHash);
-  }
-
-  public async getTransactionReceipt(txHash: BigNumberish): Promise<GetTransactionReceiptResponse> {
-    return this.provider.getTransactionReceipt(txHash);
-  }
-
-  public async callContract(
-    request: Call,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<CallContractResponse> {
-    return this.provider.callContract(request, blockIdentifier);
-  }
-
-  public async invokeFunction(
-    functionInvocation: Invocation,
-    details: InvocationsDetailsWithNonce
-  ): Promise<InvokeFunctionResponse> {
-    return this.provider.invokeFunction(functionInvocation, details);
-  }
-
-  public async deployAccountContract(
-    payload: DeployAccountContractTransaction,
-    details: InvocationsDetailsWithNonce
-  ): Promise<DeployContractResponse> {
-    return this.provider.deployAccountContract(payload, details);
-  }
-
-  public async declareContract(
-    transaction: DeclareContractTransaction,
-    details: InvocationsDetailsWithNonce
-  ): Promise<DeclareContractResponse> {
-    return this.provider.declareContract(transaction, details);
-  }
-
-  public async getDeclareEstimateFee(
-    transaction: DeclareContractTransaction,
-    details: InvocationsDetailsWithNonce,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<EstimateFeeResponse> {
-    return this.provider.getDeclareEstimateFee(transaction, details, blockIdentifier);
-  }
-
-  public getDeployAccountEstimateFee(
-    transaction: DeployAccountContractTransaction,
-    details: InvocationsDetailsWithNonce,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<EstimateFeeResponse> {
-    return this.provider.getDeployAccountEstimateFee(transaction, details, blockIdentifier);
-  }
-
-  public async getCode(
-    contractAddress: string,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<GetCodeResponse> {
-    return this.provider.getCode(contractAddress, blockIdentifier);
-  }
-
-  public async waitForTransaction(
-    txHash: BigNumberish,
-    retryInterval?: number,
-    successStates?: Array<Status>
-  ): Promise<GetTransactionReceiptResponse> {
-    return this.provider.waitForTransaction(txHash, retryInterval, successStates);
-  }
-}

package/src/provider/errors.ts

@@ -1,14 +0,0 @@
-/* eslint-disable max-classes-per-file */
-import { CustomError } from 'ts-custom-error';
-
-export class GatewayError extends CustomError {
-  constructor(message: string, public errorCode: string) {
-    super(message);
-  }
-}
-
-export class HttpError extends CustomError {
-  constructor(message: string, public errorCode: number) {
-    super(message);
-  }
-}

package/src/provider/index.ts

@@ -1,9 +0,0 @@
-import { Provider } from './default';
-
-export * from './default';
-export * from './errors';
-export * from './sequencer';
-export * from './interface';
-export * from './rpc';
-
-export const defaultProvider = new Provider();

package/src/provider/interface.ts

@@ -1,281 +0,0 @@
-import { StarknetChainId } from '../constants';
-import type {
-  Call,
-  CallContractResponse,
-  ContractClass,
-  DeclareContractResponse,
-  DeclareContractTransaction,
-  DeployAccountContractPayload,
-  DeployAccountContractTransaction,
-  DeployContractResponse,
-  EstimateFeeResponse,
-  GetBlockResponse,
-  GetCodeResponse,
-  GetTransactionReceiptResponse,
-  GetTransactionResponse,
-  Invocation,
-  InvocationsDetailsWithNonce,
-  InvokeFunctionResponse,
-  Status,
-} from '../types';
-import type { BigNumberish } from '../utils/number';
-import { BlockIdentifier } from './utils';
-
-export abstract class ProviderInterface {
-  public abstract chainId: StarknetChainId;
-
-  /**
-   * Gets the Starknet chain Id
-   *
-   * @returns the chain Id
-   */
-  public abstract getChainId(): Promise<StarknetChainId>;
-
-  /**
-   * Calls a function on the StarkNet contract.
-   *
-   * @param call transaction to be called
-   * @param blockIdentifier block identifier
-   * @returns the result of the function on the smart contract.
-   */
-  public abstract callContract(
-    call: Call,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<CallContractResponse>;
-
-  /**
-   * Gets the block information
-   *
-   * @param blockIdentifier block identifier
-   * @returns the block object
-   */
-  public abstract getBlock(blockIdentifier: BlockIdentifier): Promise<GetBlockResponse>;
-
-  /**
-   * @deprecated The method should not be used
-   */
-  public abstract getCode(
-    contractAddress: string,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<GetCodeResponse>;
-
-  /**
-   * Gets the contract class of the deployed contract.
-   *
-   * @param contractAddress - contract address
-   * @param blockIdentifier - block identifier
-   * @returns Contract class of compiled contract
-   */
-  public abstract getClassAt(
-    contractAddress: string,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<ContractClass>;
-
-  /**
-   * Returns the class hash deployed under the given address.
-   *
-   * @param contractAddress - contract address
-   * @param blockIdentifier - block identifier
-   * @returns Class hash
-   */
-  public abstract getClassHashAt(
-    contractAddress: string,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<string>;
-
-  /**
-   * Returns the contract class deployed under the given class hash.
-   *
-   * @param classHash - class hash
-   * @returns Contract class of compiled contract
-   */
-  public abstract getClassByHash(classHash: string): Promise<ContractClass>;
-
-  /**
-   * Gets the nonce of a contract with respect to a specific block
-   *
-   * @param contractAddress - contract address
-   * @returns the hex nonce
-   */
-  public abstract getNonceForAddress(
-    contractAddress: string,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<BigNumberish>;
-
-  /**
-   * Gets the contract's storage variable at a specific key.
-   *
-   * @param contractAddress
-   * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-   * @param blockIdentifier - block identifier
-   * @returns the value of the storage variable
-   */
-  public abstract getStorageAt(
-    contractAddress: string,
-    key: BigNumberish,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<BigNumberish>;
-
-  /**
-   * Gets the transaction information from a tx id.
-   *
-   * @param txHash
-   * @returns the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
-   */
-  public abstract getTransaction(transactionHash: BigNumberish): Promise<GetTransactionResponse>;
-
-  /**
-   * Gets the transaction receipt from a tx hash.
-   *
-   * @param txHash
-   * @returns the transaction receipt object
-   */
-  public abstract getTransactionReceipt(
-    transactionHash: BigNumberish
-  ): Promise<GetTransactionReceiptResponse>;
-
-  /**
-   * Deploys a given compiled Account contract (json) to starknet
-   *
-   * @param payload payload to be deployed containing:
-   * - compiled contract code
-   * - constructor calldata
-   * - address salt
-   * @returns a confirmation of sending a transaction on the starknet contract
-   */
-  public abstract deployAccountContract(
-    payload: DeployAccountContractPayload,
-    details: InvocationsDetailsWithNonce
-  ): Promise<DeployContractResponse>;
-
-  /**
-   * Invokes a function on starknet
-   * @deprecated This method wont be supported as soon as fees are mandatory. Should not be used outside of Account class
-   *
-   * @param invocation the invocation object containing:
-   * - contractAddress - the address of the contract
-   * - entrypoint - the entrypoint of the contract
-   * - calldata - (defaults to []) the calldata
-   * - signature - (defaults to []) the signature
-   * @param details - optional details containing:
-   * - nonce - optional nonce
-   * - version - optional version
-   * - maxFee - optional maxFee
-   * @returns response from addTransaction
-   */
-  public abstract invokeFunction(
-    invocation: Invocation,
-    details: InvocationsDetailsWithNonce
-  ): Promise<InvokeFunctionResponse>;
-
-  /**
-   * Declares a given compiled contract (json) to starknet
-   * @param transaction transaction payload to be deployed containing:
-   * - compiled contract code
-   * - sender address
-   * - signature
-   * @param details Invocation Details containing:
-   * - nonce
-   * - optional version
-   * - optional maxFee
-   * @returns a confirmation of sending a transaction on the starknet contract
-   */
-  public abstract declareContract(
-    transaction: DeclareContractTransaction,
-    details: InvocationsDetailsWithNonce
-  ): Promise<DeclareContractResponse>;
-
-  /**
-   * Estimates the fee for a given INVOKE transaction
-   * @deprecated Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class
-   *
-   * @param invocation the invocation object containing:
-   * - contractAddress - the address of the contract
-   * - entrypoint - the entrypoint of the contract
-   * - calldata - (defaults to []) the calldata
-   * - signature - (defaults to []) the signature
-   * @param blockIdentifier - block identifier
-   * @param details - optional details containing:
-   * - nonce - optional nonce
-   * - version - optional version
-   * @returns the estimated fee
-   */
-  public abstract getEstimateFee(
-    invocation: Invocation,
-    details: InvocationsDetailsWithNonce,
-    blockIdentifier: BlockIdentifier
-  ): Promise<EstimateFeeResponse>;
-
-  /**
-   * Estimates the fee for a given INVOKE transaction
-   *
-   * @param invocation the invocation object containing:
-   * - contractAddress - the address of the contract
-   * - entrypoint - the entrypoint of the contract
-   * - calldata - (defaults to []) the calldata
-   * - signature - (defaults to []) the signature
-   * @param blockIdentifier - block identifier
-   * @param details - optional details containing:
-   * - nonce - optional nonce
-   * - version - optional version
-   * @returns the estimated fee
-   */
-  public abstract getInvokeEstimateFee(
-    invocation: Invocation,
-    details: InvocationsDetailsWithNonce,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<EstimateFeeResponse>;
-
-  /**
-   * Estimates the fee for a given DECLARE transaction
-   *
-   * @param transaction transaction payload to be declared containing:
-   * - compiled contract code
-   * - sender address
-   * - signature - (defaults to []) the signature
-   * @param details - optional details containing:
-   * - nonce
-   * - version - optional version
-   * - optional maxFee
-   * @param blockIdentifier - block identifier
-   * @returns the estimated fee
-   */
-  public abstract getDeclareEstimateFee(
-    transaction: DeclareContractTransaction,
-    details: InvocationsDetailsWithNonce,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<EstimateFeeResponse>;
-
-  /**
-   * Estimates the fee for a given DEPLOY_ACCOUNT transaction
-   *
-   * @param transaction transaction payload to be deployed containing:
-   * - classHash
-   * - constructorCalldata
-   * - addressSalt
-   * - signature - (defaults to []) the signature
-   * @param details - optional details containing:
-   * - nonce
-   * - version - optional version
-   * - optional maxFee
-   * @param blockIdentifier - block identifier
-   * @returns the estimated fee
-   */
-  public abstract getDeployAccountEstimateFee(
-    transaction: DeployAccountContractTransaction,
-    details: InvocationsDetailsWithNonce,
-    blockIdentifier?: BlockIdentifier
-  ): Promise<EstimateFeeResponse>;
-
-  /**
-   * Wait for the transaction to be accepted
-   * @param txHash - transaction hash
-   * @param retryInterval - retry interval
-   * @return GetTransactionReceiptResponse
-   */
-  public abstract waitForTransaction(
-    txHash: BigNumberish,
-    retryInterval?: number,
-    successStates?: Array<Status>
-  ): Promise<GetTransactionReceiptResponse>;
-}