starknet 4.8.0 → 4.9.0

package/provider/rpc.js

@@ -231,7 +231,7 @@ var RpcProvider = /** @class */ (function () {
     RpcProvider.prototype.getTransactionReceipt = function (txHash) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.fetchEndpoint('starknet_getTransactionReceipt', { transaction_hash: txHash }).then(this.responseParser.parseGetTransactionReceiptResponse)];
+                return [2 /*return*/, this.fetchEndpoint('starknet_getTransactionReceipt', { transaction_hash: txHash })];
             });
         });
     };
@@ -262,6 +262,14 @@ var RpcProvider = /** @class */ (function () {
         });
     };
     RpcProvider.prototype.getEstimateFee = function (invocation, invocationDetails, blockIdentifier) {
+        if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.getInvokeEstimateFee(invocation, invocationDetails, blockIdentifier)];
+            });
+        });
+    };
+    RpcProvider.prototype.getInvokeEstimateFee = function (invocation, invocationDetails, blockIdentifier) {
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
         return __awaiter(this, void 0, void 0, function () {
             var block_id;
@@ -269,10 +277,12 @@ var RpcProvider = /** @class */ (function () {
                 block_id = new utils_1.Block(blockIdentifier).identifier;
                 return [2 /*return*/, this.fetchEndpoint('starknet_estimateFee', {
                         request: {
+                            type: 'INVOKE',
                             contract_address: invocation.contractAddress,
                             calldata: (0, provider_1.parseCalldata)(invocation.calldata),
                             signature: (0, number_1.bigNumberishArrayToHexadecimalStringArray)(invocation.signature || []),
                             version: (0, number_1.toHex)((0, number_1.toBN)((invocationDetails === null || invocationDetails === void 0 ? void 0 : invocationDetails.version) || 0)),
+                            nonce: (0, number_1.toHex)((0, number_1.toBN)(invocationDetails.nonce)),
                             max_fee: (0, number_1.toHex)((0, number_1.toBN)((invocationDetails === null || invocationDetails === void 0 ? void 0 : invocationDetails.maxFee) || 0)),
                         },
                         block_id: block_id,
@@ -280,19 +290,72 @@ var RpcProvider = /** @class */ (function () {
             });
         });
     };
-    RpcProvider.prototype.declareContract = function (_a) {
-        var contract = _a.contract, version = _a.version;
+    // TODO: Revisit after Pathfinder release with JSON-RPC v0.2.1 RPC Spec
+    RpcProvider.prototype.getDeclareEstimateFee = function (_a, details, blockIdentifier) {
+        var senderAddress = _a.senderAddress, contractDefinition = _a.contractDefinition, signature = _a.signature;
+        if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
+        return __awaiter(this, void 0, void 0, function () {
+            var block_id;
+            return __generator(this, function (_b) {
+                block_id = new utils_1.Block(blockIdentifier).identifier;
+                return [2 /*return*/, this.fetchEndpoint('starknet_estimateFee', {
+                        request: {
+                            type: 'DECLARE',
+                            contract_class: {
+                                program: contractDefinition.program,
+                                entry_points_by_type: contractDefinition.entry_points_by_type,
+                                abi: contractDefinition.abi, // rpc 2.0
+                            },
+                            sender_address: senderAddress,
+                            signature: (0, number_1.bigNumberishArrayToHexadecimalStringArray)(signature || []),
+                            version: (0, number_1.toHex)((0, number_1.toBN)((details === null || details === void 0 ? void 0 : details.version) || 0)),
+                            nonce: (0, number_1.toHex)((0, number_1.toBN)(details.nonce)),
+                            max_fee: (0, number_1.toHex)((0, number_1.toBN)((details === null || details === void 0 ? void 0 : details.maxFee) || 0)),
+                        },
+                        block_id: block_id,
+                    }).then(this.responseParser.parseFeeEstimateResponse)];
+            });
+        });
+    };
+    RpcProvider.prototype.getDeployAccountEstimateFee = function (_a, details, blockIdentifier) {
+        var classHash = _a.classHash, constructorCalldata = _a.constructorCalldata, addressSalt = _a.addressSalt, signature = _a.signature;
+        if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
+        return __awaiter(this, void 0, void 0, function () {
+            var block_id;
+            return __generator(this, function (_b) {
+                block_id = new utils_1.Block(blockIdentifier).identifier;
+                return [2 /*return*/, this.fetchEndpoint('starknet_estimateFee', {
+                        request: {
+                            type: 'DEPLOY_ACCOUNT',
+                            constructor_calldata: (0, number_1.bigNumberishArrayToHexadecimalStringArray)(constructorCalldata || []),
+                            class_hash: (0, number_1.toHex)((0, number_1.toBN)(classHash)),
+                            contract_address_salt: (0, number_1.toHex)((0, number_1.toBN)(addressSalt || 0)),
+                            signature: (0, number_1.bigNumberishArrayToHexadecimalStringArray)(signature || []),
+                            version: (0, number_1.toHex)((0, number_1.toBN)((details === null || details === void 0 ? void 0 : details.version) || 0)),
+                            nonce: (0, number_1.toHex)((0, number_1.toBN)(details.nonce)),
+                            max_fee: (0, number_1.toHex)((0, number_1.toBN)((details === null || details === void 0 ? void 0 : details.maxFee) || 0)),
+                        },
+                        block_id: block_id,
+                    }).then(this.responseParser.parseFeeEstimateResponse)];
+            });
+        });
+    };
+    // TODO: Revisit after Pathfinder release with JSON-RPC v0.2.1 RPC Spec
+    RpcProvider.prototype.declareContract = function (_a, details) {
+        var contractDefinition = _a.contractDefinition, signature = _a.signature, senderAddress = _a.senderAddress;
         return __awaiter(this, void 0, void 0, function () {
-            var contractDefinition;
             return __generator(this, function (_b) {
-                contractDefinition = (0, provider_1.parseContract)(contract);
                 return [2 /*return*/, this.fetchEndpoint('starknet_addDeclareTransaction', {
                         contract_class: {
                             program: contractDefinition.program,
                             entry_points_by_type: contractDefinition.entry_points_by_type,
                             abi: contractDefinition.abi, // rpc 2.0
                         },
-                        version: (0, number_1.toHex)((0, number_1.toBN)(version || 0)),
+                        version: (0, number_1.toHex)((0, number_1.toBN)(details.version || 0)),
+                        max_fee: (0, number_1.toHex)((0, number_1.toBN)(details.maxFee || 0)),
+                        signature: (0, number_1.bigNumberishArrayToHexadecimalStringArray)(signature || []),
+                        sender_address: senderAddress,
+                        nonce: (0, number_1.toHex)((0, number_1.toBN)(details.nonce)),
                     })];
             });
         });
@@ -315,6 +378,18 @@ var RpcProvider = /** @class */ (function () {
             });
         });
     };
+    RpcProvider.prototype.deployAccountContract = function (_a) {
+        var classHash = _a.classHash, constructorCalldata = _a.constructorCalldata, addressSalt = _a.addressSalt;
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_b) {
+                return [2 /*return*/, this.fetchEndpoint('starknet_addDeployAccountTransaction', {
+                        constructor_calldata: (0, number_1.bigNumberishArrayToHexadecimalStringArray)(constructorCalldata || []),
+                        class_hash: (0, number_1.toHex)((0, number_1.toBN)(classHash)),
+                        contract_address_salt: (0, number_1.toHex)((0, number_1.toBN)(addressSalt || 0)),
+                    })];
+            });
+        });
+    };
     RpcProvider.prototype.invokeFunction = function (functionInvocation, details) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -393,10 +468,10 @@ var RpcProvider = /** @class */ (function () {
                         return [4 /*yield*/, this.getTransactionReceipt(txHash)];
                     case 4:
                         res = _a.sent();
-                        if (successStates.includes(res.status)) {
+                        if (res.status && successStates.includes(res.status)) {
                             onchain = true;
                         }
-                        else if (errorStates.includes(res.status)) {
+                        else if (res.status && errorStates.includes(res.status)) {
                             message = res.status;
                             error = new Error(message);
                             error.response = res;

package/provider/sequencer.d.ts

@@ -1,6 +1,7 @@
 import { StarknetChainId } from '../constants';
-import { Call, CallContractResponse, ContractClass, DeclareContractPayload, DeclareContractResponse, DeployContractPayload, DeployContractResponse, EstimateFeeResponse, GetBlockResponse, GetTransactionReceiptResponse, GetTransactionResponse, Invocation, InvocationsDetailsWithNonce, InvokeFunctionResponse } from '../types';
+import { Call, CallContractResponse, ContractClass, DeclareContractResponse, DeployContractPayload, DeployContractResponse, EstimateFeeResponse, GetBlockResponse, GetTransactionReceiptResponse, GetTransactionResponse, Invocation, InvocationsDetailsWithNonce, InvokeFunctionResponse } from '../types';
 import { CallL1Handler, GetContractAddressesResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, Sequencer } from '../types/api';
+import { DeclareContractTransaction, DeployAccountContractTransaction } from '../types/lib';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
 import { BlockIdentifier } from './utils';
@@ -37,8 +38,12 @@ export declare class SequencerProvider implements ProviderInterface {
     getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<ContractClass>;
     invokeFunction(functionInvocation: Invocation, details: InvocationsDetailsWithNonce): Promise<InvokeFunctionResponse>;
     deployContract({ contract, constructorCalldata, addressSalt, }: DeployContractPayload): Promise<DeployContractResponse>;
-    declareContract({ contract, }: DeclareContractPayload): Promise<DeclareContractResponse>;
+    deployAccountContract({ classHash, constructorCalldata, addressSalt, signature }: DeployAccountContractTransaction, details: InvocationsDetailsWithNonce): Promise<DeployContractResponse>;
+    declareContract({ senderAddress, contractDefinition, signature }: DeclareContractTransaction, details: InvocationsDetailsWithNonce): Promise<DeclareContractResponse>;
     getEstimateFee(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
+    getInvokeEstimateFee(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
+    getDeclareEstimateFee({ senderAddress, contractDefinition, signature }: DeclareContractTransaction, details: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
+    getDeployAccountEstimateFee({ classHash, addressSalt, constructorCalldata, signature }: DeployAccountContractTransaction, details: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
     getCode(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<Sequencer.GetCodeResponse>;
     waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
     /**

package/provider/sequencer.js

@@ -157,22 +157,22 @@ var SequencerProvider = /** @class */ (function () {
     };
     // typesafe fetch
     SequencerProvider.prototype.fetchEndpoint = function (endpoint) {
-        // typescript type magiuc to create a nice fitting function interface
+        // typescript type magic to create a nice fitting function interface
         var _a = []; // when both query and request are needed, we cant omit anything
         for (
-        // typescript type magiuc to create a nice fitting function interface
+        // typescript type magic to create a nice fitting function interface
         var _i = 1 // when both query and request are needed, we cant omit anything
         ; 
-        // typescript type magiuc to create a nice fitting function interface
+        // typescript type magic to create a nice fitting function interface
         _i < arguments.length // when both query and request are needed, we cant omit anything
         ; 
-        // typescript type magiuc to create a nice fitting function interface
+        // typescript type magic to create a nice fitting function interface
         _i++ // when both query and request are needed, we cant omit anything
         ) {
-            // typescript type magiuc to create a nice fitting function interface
+            // typescript type magic to create a nice fitting function interface
             _a[_i - 1] = arguments[_i]; // when both query and request are needed, we cant omit anything
         }
-        // typescript type magiuc to create a nice fitting function interface
+        // typescript type magic to create a nice fitting function interface
         var _b = __read(_a, 2), query = _b[0], request = _b[1]; // when both query and request are needed, we cant omit anything
         return __awaiter(this, void 0, void 0, function () {
             var baseUrl, method, queryString, headers, url, res, textResponse, responseBody, errorCode, err_1;
@@ -344,23 +344,48 @@ var SequencerProvider = /** @class */ (function () {
             });
         });
     };
-    SequencerProvider.prototype.declareContract = function (_a) {
-        var contract = _a.contract;
+    SequencerProvider.prototype.deployAccountContract = function (_a, details) {
+        var classHash = _a.classHash, constructorCalldata = _a.constructorCalldata, addressSalt = _a.addressSalt, signature = _a.signature;
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_b) {
+                return [2 /*return*/, this.fetchEndpoint('add_transaction', undefined, {
+                        type: 'DEPLOY_ACCOUNT',
+                        contract_address_salt: addressSalt !== null && addressSalt !== void 0 ? addressSalt : (0, stark_1.randomAddress)(),
+                        constructor_calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(constructorCalldata !== null && constructorCalldata !== void 0 ? constructorCalldata : []),
+                        class_hash: (0, number_1.toHex)((0, number_1.toBN)(classHash)),
+                        max_fee: (0, number_1.toHex)((0, number_1.toBN)(details.maxFee || 0)),
+                        version: (0, number_1.toHex)((0, number_1.toBN)(details.version || 0)),
+                        nonce: (0, number_1.toHex)((0, number_1.toBN)(details.nonce)),
+                        signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(signature || []),
+                    }).then(this.responseParser.parseDeployContractResponse)];
+            });
+        });
+    };
+    SequencerProvider.prototype.declareContract = function (_a, details) {
+        var senderAddress = _a.senderAddress, contractDefinition = _a.contractDefinition, signature = _a.signature;
         return __awaiter(this, void 0, void 0, function () {
-            var contractDefinition;
             return __generator(this, function (_b) {
-                contractDefinition = (0, provider_1.parseContract)(contract);
                 return [2 /*return*/, this.fetchEndpoint('add_transaction', undefined, {
                         type: 'DECLARE',
                         contract_class: contractDefinition,
-                        nonce: (0, number_1.toHex)(constants_1.ZERO),
-                        signature: [],
-                        sender_address: (0, number_1.toHex)(constants_1.ONE),
+                        nonce: (0, number_1.toHex)((0, number_1.toBN)(details.nonce)),
+                        signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(signature || []),
+                        sender_address: senderAddress,
+                        max_fee: (0, number_1.toHex)((0, number_1.toBN)(details.maxFee || 0)),
+                        version: (0, number_1.toHex)((0, number_1.toBN)(details.version || 1)),
                     }).then(this.responseParser.parseDeclareContractResponse)];
             });
         });
     };
     SequencerProvider.prototype.getEstimateFee = function (invocation, invocationDetails, blockIdentifier) {
+        if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.getInvokeEstimateFee(invocation, invocationDetails, blockIdentifier)];
+            });
+        });
+    };
+    SequencerProvider.prototype.getInvokeEstimateFee = function (invocation, invocationDetails, blockIdentifier) {
         var _a;
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
         return __awaiter(this, void 0, void 0, function () {
@@ -376,6 +401,39 @@ var SequencerProvider = /** @class */ (function () {
             });
         });
     };
+    SequencerProvider.prototype.getDeclareEstimateFee = function (_a, details, blockIdentifier) {
+        var senderAddress = _a.senderAddress, contractDefinition = _a.contractDefinition, signature = _a.signature;
+        if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_b) {
+                return [2 /*return*/, this.fetchEndpoint('estimate_fee', { blockIdentifier: blockIdentifier }, {
+                        type: 'DECLARE',
+                        sender_address: senderAddress,
+                        contract_class: contractDefinition,
+                        signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(signature || []),
+                        version: (0, number_1.toHex)((0, number_1.toBN)((details === null || details === void 0 ? void 0 : details.version) || 1)),
+                        nonce: (0, number_1.toHex)((0, number_1.toBN)(details.nonce)),
+                    }).then(this.responseParser.parseFeeEstimateResponse)];
+            });
+        });
+    };
+    SequencerProvider.prototype.getDeployAccountEstimateFee = function (_a, details, blockIdentifier) {
+        var classHash = _a.classHash, addressSalt = _a.addressSalt, constructorCalldata = _a.constructorCalldata, signature = _a.signature;
+        if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_b) {
+                return [2 /*return*/, this.fetchEndpoint('estimate_fee', { blockIdentifier: blockIdentifier }, {
+                        type: 'DEPLOY_ACCOUNT',
+                        class_hash: (0, number_1.toHex)((0, number_1.toBN)(classHash)),
+                        constructor_calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(constructorCalldata || []),
+                        contract_address_salt: (0, number_1.toHex)((0, number_1.toBN)(addressSalt || 0)),
+                        signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(signature || []),
+                        version: (0, number_1.toHex)((0, number_1.toBN)((details === null || details === void 0 ? void 0 : details.version) || 0)),
+                        nonce: (0, number_1.toHex)((0, number_1.toBN)(details.nonce)),
+                    }).then(this.responseParser.parseFeeEstimateResponse)];
+            });
+        });
+    };
     SequencerProvider.prototype.getCode = function (contractAddress, blockIdentifier) {
         if (blockIdentifier === void 0) { blockIdentifier = 'pending'; }
         return __awaiter(this, void 0, void 0, function () {

package/signer/default.d.ts

@@ -1,4 +1,5 @@
-import { Abi, Call, InvocationsSignerDetails, KeyPair, Signature } from '../types';
+import { Abi, Call, DeclareSignerDetails, InvocationsSignerDetails, KeyPair, Signature } from '../types';
+import { DeployAccountSignerDetails } from '../types/signer';
 import { TypedData } from '../utils/typedData';
 import { SignerInterface } from './interface';
 export declare class Signer implements SignerInterface {
@@ -6,5 +7,7 @@ export declare class Signer implements SignerInterface {
     constructor(keyPair?: KeyPair);
     getPubKey(): Promise<string>;
     signTransaction(transactions: Call[], transactionsDetail: InvocationsSignerDetails, abis?: Abi[]): Promise<Signature>;
+    signDeclareTransaction({ classHash, senderAddress, chainId, maxFee, version, nonce }: DeclareSignerDetails): Promise<Signature>;
+    signDeployAccountTransaction({ classHash, contractAddress, constructorCalldata, addressSalt, maxFee, version, chainId, nonce, }: DeployAccountSignerDetails): Promise<Signature>;
     signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
 }

package/signer/default.js

@@ -66,6 +66,28 @@ var Signer = /** @class */ (function () {
             });
         });
     };
+    Signer.prototype.signDeclareTransaction = function (
+    // contractClass: ContractClass,  // Should be used once class hash is present in ContractClass
+    _a) {
+        var classHash = _a.classHash, senderAddress = _a.senderAddress, chainId = _a.chainId, maxFee = _a.maxFee, version = _a.version, nonce = _a.nonce;
+        return __awaiter(this, void 0, void 0, function () {
+            var msgHash;
+            return __generator(this, function (_b) {
+                msgHash = (0, hash_1.calculateDeclareTransactionHash)(classHash, senderAddress, version, maxFee, chainId, nonce);
+                return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
+            });
+        });
+    };
+    Signer.prototype.signDeployAccountTransaction = function (_a) {
+        var classHash = _a.classHash, contractAddress = _a.contractAddress, constructorCalldata = _a.constructorCalldata, addressSalt = _a.addressSalt, maxFee = _a.maxFee, version = _a.version, chainId = _a.chainId, nonce = _a.nonce;
+        return __awaiter(this, void 0, void 0, function () {
+            var msgHash;
+            return __generator(this, function (_b) {
+                msgHash = (0, hash_1.calculateDeployAccountTransactionHash)(contractAddress, classHash, constructorCalldata, addressSalt, version, maxFee, chainId, nonce);
+                return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
+            });
+        });
+    };
     Signer.prototype.signMessage = function (typedData, accountAddress) {
         return __awaiter(this, void 0, void 0, function () {
             var msgHash;

package/signer/interface.d.ts

@@ -1,4 +1,5 @@
-import { Abi, Call, InvocationsSignerDetails, Signature } from '../types';
+import { Abi, Call, DeclareSignerDetails, InvocationsSignerDetails, Signature } from '../types';
+import { DeployAccountSignerDetails } from '../types/signer';
 import { TypedData } from '../utils/typedData';
 export declare abstract class SignerInterface {
     /**
@@ -24,10 +25,34 @@ export declare abstract class SignerInterface {
      * - contractAddress - the address of the contract
      * - entrypoint - the entrypoint of the contract
      * - calldata - (defaults to []) the calldata
-     * - signature - (defaults to []) the signature
      * @param abi (optional) the abi of the contract for better displaying
      *
      * @returns signature
      */
     abstract signTransaction(transactions: Call[], transactionsDetail: InvocationsSignerDetails, abis?: Abi[]): Promise<Signature>;
+    /**
+     * 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
+     * - addressSalt - contract address salt
+     * - chainId - the chainId to declare contract on
+     * - maxFee - maxFee for the declare transaction
+     * - version - transaction version
+     * - nonce - Nonce of the declare transaction
+     * @returns signature
+     */
+    abstract signDeployAccountTransaction(transaction: DeployAccountSignerDetails): Promise<Signature>;
+    /**
+     * 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
+     * - chainId - the chainId to declare contract on
+     * - maxFee - maxFee for the declare transaction
+     * - version - transaction version
+     * - nonce - Nonce of the declare transaction
+     * @returns signature
+     */
+    abstract signDeclareTransaction(transaction: DeclareSignerDetails): Promise<Signature>;
 }