[VIP] V6 saitama

.gitignore

@@ -10,4 +10,5 @@ dist
 node_modules
 npm-debug.log
 package
-yarn.lock
+yarn.lock
+__tests__/scripts

__tests__/accountInstance.test.ts

@@ -0,0 +1,25 @@
+import { Account, AccountInstance, LibraryError, RpcProvider } from '../src';
+
+describe('Account instantiated from provider instance', () => {
+  const rpc = new RpcProvider();
+  const getNonceMock = jest.fn().mockResolvedValue('mock');
+  rpc.getNonceForAddress = getNonceMock;
+
+  test('Account to throw on extended custom methods for using re-instantiation on provider', () => {
+    const acc = new Account(rpc, '0x0', '0x1');
+
+    return expect(acc.getNonceForAddress('0x0')).rejects.toThrow(LibraryError);
+  });
+
+  test('AccountInstance to pass on extending', async () => {
+    const acc = new AccountInstance(rpc, '0x0', '0x1');
+    expect(await acc.getNonceForAddress('0x1')).toBe('mock');
+    expect(getNonceMock).toHaveBeenLastCalledWith('0x1');
+  });
+
+  test('Account to pass on extended custom methods for using instance on provider', async () => {
+    const acc = new Account(rpc, '0x0', '0x1', undefined, undefined, true);
+    expect(await acc.getNonceForAddress('0x2')).toBe('mock');
+    expect(getNonceMock).toHaveBeenLastCalledWith('0x2');
+  });
+});

__tests__/config/jestGlobalSetup.ts

@@ -6,6 +6,7 @@
  */
 
 import { BaseUrl } from '../../src/constants';
+import { getDefaultNodeUrl } from '../../src/utils/provider';
 import localDevnetDetector, { type DevnetStrategy } from './helpers/localDevnetDetector';
 import { GS_DEFAULT_TEST_PROVIDER_URL } from './constants';
 import { setIfNullish } from './helpers/env';
@@ -98,11 +99,10 @@ const verifySetup = (final?: boolean) => {
     if (final) throw new Error('TEST_ACCOUNT_PRIVATE_KEY env is not provided');
     else warnings.push('TEST_ACCOUNT_PRIVATE_KEY env is not provided!');
   }
-  // TODO: revise after Sequencer removal
-  // if (!process.env.TEST_RPC_URL) {
-  //   process.env.TEST_RPC_URL = getDefaultNodeUrl();
-  //   console.warn('TEST_RPC_URL env is not provided');
-  // }
+
+  if (!process.env.TEST_RPC_URL && final) {
+    process.env.TEST_RPC_URL = getDefaultNodeUrl();
+  }
 
   if (warnings.length > 0) {
     console.log('\x1b[33m', warnings.join('\n'), '\x1b[0m');

__tests__/rpcProvider.test.ts

@@ -5,11 +5,12 @@ import {
   Block,
   CallData,
   Contract,
+  ETransactionExecutionStatus,
+  ETransactionStatus,
   FeeEstimate,
   RPC,
   RPC06,
   RpcProvider,
-  TransactionExecutionStatus,
   stark,
   waitForTransactionOptions,
 } from '../src';
@@ -142,8 +143,8 @@ describeIfRpc('RPCProvider', () => {
 
     const generateOptions = (o: waitForTransactionOptions) => ({ retryInterval: 10, ...o });
     const generateTransactionStatus = (
-      finality_status: RPC.SPEC.TXN_STATUS,
-      execution_status?: RPC.SPEC.TXN_EXECUTION_STATUS
+      finality_status: `${ETransactionStatus}`,
+      execution_status?: `${ETransactionExecutionStatus}`
     ): RPC.TransactionStatus => ({
       finality_status,
       execution_status,
@@ -183,7 +184,7 @@ describeIfRpc('RPCProvider', () => {
 
     test('reverted - as error state', async () => {
       transactionStatusSpy.mockResolvedValueOnce(response.reverted);
-      const options = generateOptions({ errorStates: [TransactionExecutionStatus.REVERTED] });
+      const options = generateOptions({ errorStates: [ETransactionExecutionStatus.REVERTED] });
       await expect(rpcProvider.waitForTransaction(0, options)).rejects.toThrow(
         `${RPC.ETransactionExecutionStatus.REVERTED}: ${RPC.ETransactionStatus.ACCEPTED_ON_L2}`
       );

src/account/default.ts

@@ -1,4 +1,4 @@
-import { UDC, ZERO } from '../constants';
+import { DEFAULT_TRANSACTION_VERSION, UDC, ZERO } from '../constants';
 import { Provider, ProviderInterface } from '../provider';
 import { Signer, SignerInterface } from '../signer';
 import {
@@ -72,9 +72,12 @@ export class Account extends Provider implements AccountInterface {
     address: string,
     pkOrSigner: Uint8Array | string | SignerInterface,
     cairoVersion?: CairoVersion,
-    transactionVersion: ETransactionVersion.V2 | ETransactionVersion.V3 = ETransactionVersion.V2 // TODO: Discuss this, set to v2 for backward compatibility
+    transactionVersion:
+      | ETransactionVersion.V2
+      | ETransactionVersion.V3 = DEFAULT_TRANSACTION_VERSION,
+    instance?: boolean
   ) {
-    super(providerOrOptions);
+    super(providerOrOptions, instance);
     this.address = address.toLowerCase();
     this.signer =
       isString(pkOrSigner) || pkOrSigner instanceof Uint8Array

src/account/instance.ts

@@ -0,0 +1,19 @@
+import { DEFAULT_TRANSACTION_VERSION } from '../constants';
+import { ProviderInterface } from '../provider/interface';
+import { SignerInterface } from '../signer/interface';
+import { CairoVersion, ETransactionVersion, ProviderOptions } from '../types';
+import { Account } from '.';
+
+export class AccountInstance extends Account {
+  constructor(
+    providerOrOptions: ProviderOptions | ProviderInterface,
+    address: string,
+    pkOrSigner: Uint8Array | string | SignerInterface,
+    cairoVersion?: CairoVersion,
+    transactionVersion:
+      | ETransactionVersion.V2
+      | ETransactionVersion.V3 = DEFAULT_TRANSACTION_VERSION
+  ) {
+    super(providerOrOptions, address, pkOrSigner, cairoVersion, transactionVersion, true);
+  }
+}

src/channel/rpc_0_6.ts

@@ -5,19 +5,19 @@ import {
   AccountInvocations,
   BigNumberish,
   BlockIdentifier,
-  BlockTag,
   Call,
   DeclareContractTransaction,
   DeployAccountContractTransaction,
+  EBlockTag,
   Invocation,
   InvocationsDetailsWithNonce,
-  RpcProviderOptions,
+  RpcChannelOptions,
   TransactionType,
   getEstimateFeeBulkOptions,
   getSimulateTransactionOptions,
   waitForTransactionOptions,
 } from '../types';
-import { JRPC, RPCSPEC06 as RPC } from '../types/api';
+import { ERPCVersion, JRPC, RPCSPEC06 as RPC } from '../types/api';
 import { CallData } from '../utils/calldata';
 import { isSierra } from '../utils/contract';
 import fetch from '../utils/fetchPonyfill';
@@ -30,7 +30,7 @@ import { getVersionsByType } from '../utils/transaction';
 
 const defaultOptions = {
   headers: { 'Content-Type': 'application/json' },
-  blockIdentifier: BlockTag.pending,
+  blockIdentifier: EBlockTag.PENDING,
   retries: 200,
 };
 
@@ -51,23 +51,31 @@ export class RpcChannel {
 
   readonly waitMode: Boolean; // behave like web2 rpc and return when tx is processed
 
-  constructor(optionsOrProvider?: RpcProviderOptions) {
+  constructor(optionsOrProvider?: RpcChannelOptions) {
     const { nodeUrl, retries, headers, blockIdentifier, chainId, specVersion, waitMode } =
       optionsOrProvider || {};
     if (Object.values(NetworkName).includes(nodeUrl as NetworkName)) {
-      this.nodeUrl = getDefaultNodeUrl(nodeUrl as NetworkName, optionsOrProvider?.default);
+      this.nodeUrl = getDefaultNodeUrl(
+        nodeUrl as NetworkName,
+        optionsOrProvider?.rpcVersion,
+        optionsOrProvider?.default
+      );
     } else if (nodeUrl) {
       this.nodeUrl = nodeUrl;
     } else {
-      this.nodeUrl = getDefaultNodeUrl(undefined, optionsOrProvider?.default);
+      this.nodeUrl = getDefaultNodeUrl(
+        undefined,
+        optionsOrProvider?.rpcVersion,
+        optionsOrProvider?.default
+      );
     }
     this.retries = retries || defaultOptions.retries;
     this.headers = { ...defaultOptions.headers, ...headers };
     this.blockIdentifier = blockIdentifier || defaultOptions.blockIdentifier;
     this.chainId = chainId;
-    this.specVersion = specVersion;
     this.waitMode = waitMode || false;
     this.requestId = 0;
+    this.specVersion = specVersion;
   }
 
   public setChainId(chainId: StarknetChainId) {
@@ -378,7 +386,7 @@ export class RpcChannel {
   ) {
     const block_id = new Block(blockIdentifier).identifier;
     let flags = {};
-    if (!isVersion('0.5', await this.getSpecVersion())) {
+    if (!isVersion(ERPCVersion.V0_5, await this.getSpecVersion())) {
       flags = {
         simulation_flags: skipValidate ? [RPC.ESimulationFlag.SKIP_VALIDATE] : [],
       };

src/channel/rpc_0_7.ts

@@ -5,13 +5,13 @@ import {
   AccountInvocations,
   BigNumberish,
   BlockIdentifier,
-  BlockTag,
   Call,
   DeclareContractTransaction,
   DeployAccountContractTransaction,
+  EBlockTag,
   Invocation,
   InvocationsDetailsWithNonce,
-  RpcProviderOptions,
+  RpcChannelOptions,
   TransactionType,
   getEstimateFeeBulkOptions,
   getSimulateTransactionOptions,
@@ -30,7 +30,7 @@ import { getVersionsByType } from '../utils/transaction';
 
 const defaultOptions = {
   headers: { 'Content-Type': 'application/json' },
-  blockIdentifier: BlockTag.pending,
+  blockIdentifier: EBlockTag.PENDING,
   retries: 200,
 };
 
@@ -47,26 +47,35 @@ export class RpcChannel {
 
   private chainId?: StarknetChainId;
 
-  private speckVersion?: string;
+  private specVersion?: string;
 
   readonly waitMode: Boolean; // behave like web2 rpc and return when tx is processed
 
-  constructor(optionsOrProvider?: RpcProviderOptions) {
-    const { nodeUrl, retries, headers, blockIdentifier, chainId, waitMode } =
+  constructor(optionsOrProvider?: RpcChannelOptions) {
+    const { nodeUrl, retries, headers, blockIdentifier, chainId, specVersion, waitMode } =
       optionsOrProvider || {};
     if (Object.values(NetworkName).includes(nodeUrl as NetworkName)) {
-      this.nodeUrl = getDefaultNodeUrl(nodeUrl as NetworkName, optionsOrProvider?.default);
+      this.nodeUrl = getDefaultNodeUrl(
+        nodeUrl as NetworkName,
+        optionsOrProvider?.rpcVersion,
+        optionsOrProvider?.default
+      );
     } else if (nodeUrl) {
       this.nodeUrl = nodeUrl;
     } else {
-      this.nodeUrl = getDefaultNodeUrl(undefined, optionsOrProvider?.default);
+      this.nodeUrl = getDefaultNodeUrl(
+        undefined,
+        optionsOrProvider?.rpcVersion,
+        optionsOrProvider?.default
+      );
     }
     this.retries = retries || defaultOptions.retries;
     this.headers = { ...defaultOptions.headers, ...headers };
     this.blockIdentifier = blockIdentifier || defaultOptions.blockIdentifier;
     this.chainId = chainId;
     this.waitMode = waitMode || false;
     this.requestId = 0;
+    this.specVersion = specVersion;
   }
 
   public setChainId(chainId: StarknetChainId) {
@@ -124,8 +133,8 @@ export class RpcChannel {
   }
 
   public async getSpecVersion() {
-    this.speckVersion ??= (await this.fetchEndpoint('starknet_specVersion')) as StarknetChainId;
-    return this.speckVersion;
+    this.specVersion ??= (await this.fetchEndpoint('starknet_specVersion')) as StarknetChainId;
+    return this.specVersion;
   }
 
   public getNonceForAddress(

src/constants.ts

@@ -59,19 +59,28 @@ export const UDC = {
   ENTRYPOINT: 'deployContract',
 };
 
+export const DEFAULT_TRANSACTION_VERSION = ETransactionVersion.V2; // TODO: Discuss this, set to v2 for backward compatibility
 export const RPC_DEFAULT_VERSION = 'v0_7';
 
+export const DEFAULT_NETWORK_NAME = NetworkName.SN_GOERLI; // TODO: when goerli deprecated switch default to sepolia
+export const RPC_DEFAULT_VERSION_TAG = 'v0_6';
 export const RPC_NODES = {
   SN_GOERLI: [
-    `https://starknet-testnet.public.blastapi.io/rpc/${RPC_DEFAULT_VERSION}`,
-    `https://free-rpc.nethermind.io/goerli-juno/${RPC_DEFAULT_VERSION}`,
+    `https://starknet-testnet.public.blastapi.io/rpc/${RPC_DEFAULT_VERSION_TAG}`,
+    `https://free-rpc.nethermind.io/goerli-juno/${RPC_DEFAULT_VERSION_TAG}`,
   ],
   SN_MAIN: [
-    `https://starknet-mainnet.public.blastapi.io/rpc/${RPC_DEFAULT_VERSION}`,
-    `https://free-rpc.nethermind.io/mainnet-juno/${RPC_DEFAULT_VERSION}`,
+    `https://starknet-mainnet.public.blastapi.io/rpc/${RPC_DEFAULT_VERSION_TAG}`,
+    `https://free-rpc.nethermind.io/mainnet-juno/${RPC_DEFAULT_VERSION_TAG}`,
   ],
   SN_SEPOLIA: [
-    `https://starknet-sepolia.public.blastapi.io/rpc/${RPC_DEFAULT_VERSION}`,
-    `https://free-rpc.nethermind.io/sepolia-juno/${RPC_DEFAULT_VERSION}`,
+    `https://starknet-sepolia.public.blastapi.io/rpc/${RPC_DEFAULT_VERSION_TAG}`,
+    `https://free-rpc.nethermind.io/sepolia-juno/${RPC_DEFAULT_VERSION_TAG}`,
   ],
+  getNode(network: NetworkName, index: number, rpcVersion?: string) {
+    const defRpcUrl = this[network][index];
+    return rpcVersion
+      ? `${defRpcUrl.substring(0, defRpcUrl.lastIndexOf('/') + 1)}v${rpcVersion.replace('.', '_')}`
+      : defRpcUrl;
+  },
 };

src/index.ts

@@ -7,6 +7,7 @@ export * from './contract';
 export * from './provider';
 export * from './signer';
 export * from './channel';
+export * from './account/instance';
 
 // TODO: decide on final export style
 export * from './types';