starknet 3.13.1 → 3.14.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [3.14.0](https://github.com/0xs34n/starknet.js/compare/v3.13.1...v3.14.0) (2022-06-15)
+
+### Bug Fixes
+
+- remove redundant \_abi from declareContract() ([53d6578](https://github.com/0xs34n/starknet.js/commit/53d6578b932ed6046b5e0df83d748673d7efc3d5))
+
+### Features
+
+- support contract declaration API introduced at SN 0.9.0 ([ca6203f](https://github.com/0xs34n/starknet.js/commit/ca6203f93471d7fb421d580e07d6de7c183e40f3))
+
 ## [3.13.1](https://github.com/0xs34n/starknet.js/compare/v3.13.0...v3.13.1) (2022-06-14)
 
 ### Bug Fixes

package/__tests__/provider.test.ts

@@ -1,6 +1,6 @@
 import { defaultProvider, stark } from '../src';
 import { toBN } from '../src/utils/number';
-import { compiledArgentAccount } from './fixtures';
+import { compiledArgentAccount, compiledErc20 } from './fixtures';
 
 const { compileCalldata } = stark;
 
@@ -123,6 +123,16 @@ describe('defaultProvider', () => {
   });
 
   describe('addTransaction()', () => {
+    test('declareContract()', async () => {
+      const response = await defaultProvider.declareContract({
+        contract: compiledErc20,
+      });
+
+      expect(response.code).toBe('TRANSACTION_RECEIVED');
+      expect(response.transaction_hash).toBeDefined();
+      expect(response.class_hash).toBeDefined();
+    });
+
     test('deployContract()', async () => {
       const response = await defaultProvider.deployContract({
         contract: compiledArgentAccount,

package/account/default.js

@@ -424,6 +424,7 @@ var Account = /** @class */ (function (_super) {
         switch (_a.label) {
           case 0:
             if (transaction.type === 'DEPLOY') throw new Error('No DEPLOYS');
+            if (transaction.type === 'DECLARE') throw new Error('No DECLARES');
             (0,
             minimalistic_assert_1.default)(!transaction.signature, "Adding signatures to a signer transaction currently isn't supported");
             if (!transaction.nonce) return [3 /*break*/, 1];

package/constants.d.ts

@@ -10,6 +10,7 @@ export declare enum StarknetChainId {
   TESTNET = '0x534e5f474f45524c49',
 }
 export declare enum TransactionHashPrefix {
+  DECLARE = '0x6465636c617265',
   DEPLOY = '0x6465706c6f79',
   INVOKE = '0x696e766f6b65',
   L1_HANDLER = '0x6c315f68616e646c6572',

package/constants.js

@@ -37,6 +37,7 @@ var StarknetChainId;
 })((StarknetChainId = exports.StarknetChainId || (exports.StarknetChainId = {})));
 var TransactionHashPrefix;
 (function (TransactionHashPrefix) {
+  TransactionHashPrefix['DECLARE'] = '0x6465636c617265';
   TransactionHashPrefix['DEPLOY'] = '0x6465706c6f79';
   TransactionHashPrefix['INVOKE'] = '0x696e766f6b65';
   TransactionHashPrefix['L1_HANDLER'] = '0x6c315f68616e646c6572';

package/dist/account/default.js

@@ -267,6 +267,8 @@ var Account = /** @class */ (function (_super) {
                     case 0:
                         if (transaction.type === 'DEPLOY')
                             throw new Error('No DEPLOYS');
+                        if (transaction.type === 'DECLARE')
+                            throw new Error('No DECLARES');
                         (0, minimalistic_assert_1.default)(!transaction.signature, "Adding signatures to a signer transaction currently isn't supported");
                         if (!transaction.nonce) return [3 /*break*/, 1];
                         nonceBn = (0, number_1.toBN)(transaction.nonce);

package/dist/constants.d.ts

@@ -10,6 +10,7 @@ export declare enum StarknetChainId {
     TESTNET = "0x534e5f474f45524c49"
 }
 export declare enum TransactionHashPrefix {
+    DECLARE = "0x6465636c617265",
     DEPLOY = "0x6465706c6f79",
     INVOKE = "0x696e766f6b65",
     L1_HANDLER = "0x6c315f68616e646c6572"

package/dist/constants.js

@@ -16,6 +16,7 @@ var StarknetChainId;
 })(StarknetChainId = exports.StarknetChainId || (exports.StarknetChainId = {}));
 var TransactionHashPrefix;
 (function (TransactionHashPrefix) {
+    TransactionHashPrefix["DECLARE"] = "0x6465636c617265";
     TransactionHashPrefix["DEPLOY"] = "0x6465706c6f79";
     TransactionHashPrefix["INVOKE"] = "0x696e766f6b65";
     TransactionHashPrefix["L1_HANDLER"] = "0x6c315f68616e646c6572";

package/dist/provider/default.d.ts

@@ -1,5 +1,5 @@
 import { StarknetChainId } from '../constants';
-import { Abi, AddTransactionResponse, Call, CallContractResponse, DeployContractPayload, Endpoints, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, Invocation, TransactionReceiptResponse } from '../types';
+import { Abi, AddTransactionResponse, Call, CallContractResponse, DeclareContractPayload, DeployContractPayload, Endpoints, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, Invocation, TransactionReceiptResponse } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
 import { BlockIdentifier } from './utils';
@@ -110,6 +110,13 @@ export declare class Provider implements ProviderInterface {
      * @returns the transaction trace
      */
     getTransactionTrace(txHash: BigNumberish): Promise<GetTransactionTraceResponse>;
+    /**
+     * Declare a given compiled contract (json) on starknet
+     *
+     * @param contract - a json object containing the compiled contract
+     * @returns a confirmation of sending a transaction on the starknet contract
+     */
+    declareContract(payload: DeclareContractPayload): Promise<AddTransactionResponse>;
     /**
      * Deploys a given compiled contract (json) to starknet
      *

package/dist/provider/default.js

@@ -370,6 +370,25 @@ var Provider = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Declare a given compiled contract (json) on starknet
+     *
+     * @param contract - a json object containing the compiled contract
+     * @returns a confirmation of sending a transaction on the starknet contract
+     */
+    Provider.prototype.declareContract = function (payload) {
+        var parsedContract = typeof payload.contract === 'string'
+            ? (0, json_1.parse)(payload.contract)
+            : payload.contract;
+        var contractDefinition = __assign(__assign({}, parsedContract), { program: (0, stark_1.compressProgram)(parsedContract.program) });
+        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),
+        });
+    };
     /**
      * Deploys a given compiled contract (json) to starknet
      *

package/dist/types/api.d.ts

@@ -84,6 +84,13 @@ export declare type GetContractAddressesResponse = {
     Starknet: string;
     GpsStatementVerifier: string;
 };
+export declare type DeclareTransaction = {
+    type: 'DECLARE';
+    contract_class: CompressedCompiledContract;
+    nonce: BigNumberish;
+    sender_address: BigNumberish;
+    signature: Signature;
+};
 export declare type DeployTransaction = {
     type: 'DEPLOY';
     contract_definition: CompressedCompiledContract;
@@ -127,7 +134,7 @@ export declare type ExecutionResources = {
     n_memory_holes: number;
 };
 export declare type CallContractTransaction = Omit<InvokeFunctionTransaction, 'type' | 'entry_point_type' | 'nonce'>;
-export declare type Transaction = DeployTransaction | InvokeFunctionTransaction;
+export declare type Transaction = DeclareTransaction | DeployTransaction | InvokeFunctionTransaction;
 export declare type CallContractResponse = {
     result: string[];
 };
@@ -196,6 +203,7 @@ export declare type AddTransactionResponse = {
     code: TransactionStatus;
     transaction_hash: string;
     address?: string;
+    class_hash?: string;
 };
 export declare type TransactionReceiptResponse = {
     status: Status;

package/dist/types/lib.d.ts

@@ -8,6 +8,9 @@ export declare type DeployContractPayload = {
     constructorCalldata?: RawCalldata;
     addressSalt?: BigNumberish;
 };
+export declare type DeclareContractPayload = {
+    contract: CompiledContract | string;
+};
 export declare type Invocation = {
     contractAddress: string;
     entrypoint: string;
@@ -22,7 +25,7 @@ export declare type InvocationsDetails = {
 };
 export declare type Status = 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
 export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
-export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
+export declare type Type = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION';
 export declare type EntryPointType = 'EXTERNAL';
 export declare type CompressedProgram = string;
 export declare type AbiEntry = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.13.1",
+  "version": "3.14.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/provider/default.d.ts

@@ -4,6 +4,7 @@ import {
   AddTransactionResponse,
   Call,
   CallContractResponse,
+  DeclareContractPayload,
   DeployContractPayload,
   Endpoints,
   GetBlockResponse,
@@ -147,6 +148,13 @@ export declare class Provider implements ProviderInterface {
    * @returns the transaction trace
    */
   getTransactionTrace(txHash: BigNumberish): Promise<GetTransactionTraceResponse>;
+  /**
+   * Declare a given compiled contract (json) on starknet
+   *
+   * @param contract - a json object containing the compiled contract
+   * @returns a confirmation of sending a transaction on the starknet contract
+   */
+  declareContract(payload: DeclareContractPayload): Promise<AddTransactionResponse>;
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/provider/default.js

@@ -536,6 +536,26 @@ var Provider = /** @class */ (function () {
       });
     });
   };
+  /**
+   * Declare a given compiled contract (json) on starknet
+   *
+   * @param contract - a json object containing the compiled contract
+   * @returns a confirmation of sending a transaction on the starknet contract
+   */
+  Provider.prototype.declareContract = function (payload) {
+    var parsedContract =
+      typeof payload.contract === 'string' ? (0, json_1.parse)(payload.contract) : payload.contract;
+    var contractDefinition = __assign(__assign({}, parsedContract), {
+      program: (0, stark_1.compressProgram)(parsedContract.program),
+    });
+    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),
+    });
+  };
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/src/account/default.ts

@@ -143,6 +143,7 @@ export class Account extends Provider implements AccountInterface {
    */
   public async LEGACY_addTransaction(transaction: Transaction): Promise<AddTransactionResponse> {
     if (transaction.type === 'DEPLOY') throw new Error('No DEPLOYS');
+    if (transaction.type === 'DECLARE') throw new Error('No DECLARES');
 
     assert(
       !transaction.signature,

package/src/constants.ts

@@ -13,6 +13,7 @@ export enum StarknetChainId {
   TESTNET = '0x534e5f474f45524c49', // encodeShortString('SN_GOERLI'),
 }
 export enum TransactionHashPrefix {
+  DECLARE = '0x6465636c617265', // encodeShortString('declare'),
   DEPLOY = '0x6465706c6f79', // encodeShortString('deploy'),
   INVOKE = '0x696e766f6b65', // encodeShortString('invoke'),
   L1_HANDLER = '0x6c315f68616e646c6572', // encodeShortString('l1_handler'),

package/src/provider/default.ts

@@ -1,13 +1,14 @@
 import fetch from 'cross-fetch';
 import urljoin from 'url-join';
 
-import { StarknetChainId } from '../constants';
+import { ONE, StarknetChainId, ZERO } from '../constants';
 import {
   Abi,
   AddTransactionResponse,
   Call,
   CallContractResponse,
   CompiledContract,
+  DeclareContractPayload,
   DeployContractPayload,
   Endpoints,
   GetBlockResponse,
@@ -309,6 +310,31 @@ export class Provider implements ProviderInterface {
     return this.fetchEndpoint('get_transaction_trace', { transactionHash: txHashHex });
   }
 
+  /**
+   * Declare a given compiled contract (json) on starknet
+   *
+   * @param contract - a json object containing the compiled contract
+   * @returns a confirmation of sending a transaction on the starknet contract
+   */
+  public declareContract(payload: DeclareContractPayload): Promise<AddTransactionResponse> {
+    const parsedContract =
+      typeof payload.contract === 'string'
+        ? (parse(payload.contract) as CompiledContract)
+        : payload.contract;
+    const contractDefinition = {
+      ...parsedContract,
+      program: compressProgram(parsedContract.program),
+    };
+
+    return this.fetchEndpoint('add_transaction', undefined, {
+      type: 'DECLARE',
+      contract_class: contractDefinition,
+      nonce: toHex(ZERO),
+      signature: [],
+      sender_address: toHex(ONE),
+    });
+  }
+
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/src/types/api.ts

@@ -97,6 +97,14 @@ export type GetContractAddressesResponse = {
   GpsStatementVerifier: string;
 };
 
+export type DeclareTransaction = {
+  type: 'DECLARE';
+  contract_class: CompressedCompiledContract;
+  nonce: BigNumberish;
+  sender_address: BigNumberish;
+  signature: Signature;
+};
+
 export type DeployTransaction = {
   type: 'DEPLOY';
   contract_definition: CompressedCompiledContract;
@@ -148,7 +156,7 @@ export type CallContractTransaction = Omit<
   'type' | 'entry_point_type' | 'nonce'
 >;
 
-export type Transaction = DeployTransaction | InvokeFunctionTransaction;
+export type Transaction = DeclareTransaction | DeployTransaction | InvokeFunctionTransaction;
 
 export type CallContractResponse = {
   result: string[];
@@ -224,6 +232,7 @@ export type AddTransactionResponse = {
   code: TransactionStatus;
   transaction_hash: string;
   address?: string;
+  class_hash?: string;
 };
 
 export type TransactionReceiptResponse = {

package/src/types/lib.ts

@@ -12,6 +12,10 @@ export type DeployContractPayload = {
   addressSalt?: BigNumberish;
 };
 
+export type DeclareContractPayload = {
+  contract: CompiledContract | string;
+};
+
 export type Invocation = {
   contractAddress: string;
   entrypoint: string;
@@ -35,7 +39,7 @@ export type Status =
   | 'ACCEPTED_ON_L1'
   | 'REJECTED';
 export type TransactionStatus = 'TRANSACTION_RECEIVED';
-export type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
+export type Type = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION';
 export type EntryPointType = 'EXTERNAL';
 export type CompressedProgram = string;
 

package/types/api.d.ts

@@ -94,6 +94,13 @@ export declare type GetContractAddressesResponse = {
   Starknet: string;
   GpsStatementVerifier: string;
 };
+export declare type DeclareTransaction = {
+  type: 'DECLARE';
+  contract_class: CompressedCompiledContract;
+  nonce: BigNumberish;
+  sender_address: BigNumberish;
+  signature: Signature;
+};
 export declare type DeployTransaction = {
   type: 'DEPLOY';
   contract_definition: CompressedCompiledContract;
@@ -140,7 +147,10 @@ export declare type CallContractTransaction = Omit<
   InvokeFunctionTransaction,
   'type' | 'entry_point_type' | 'nonce'
 >;
-export declare type Transaction = DeployTransaction | InvokeFunctionTransaction;
+export declare type Transaction =
+  | DeclareTransaction
+  | DeployTransaction
+  | InvokeFunctionTransaction;
 export declare type CallContractResponse = {
   result: string[];
 };
@@ -209,6 +219,7 @@ export declare type AddTransactionResponse = {
   code: TransactionStatus;
   transaction_hash: string;
   address?: string;
+  class_hash?: string;
 };
 export declare type TransactionReceiptResponse = {
   status: Status;

package/types/lib.d.ts

@@ -9,6 +9,9 @@ export declare type DeployContractPayload = {
   constructorCalldata?: RawCalldata;
   addressSalt?: BigNumberish;
 };
+export declare type DeclareContractPayload = {
+  contract: CompiledContract | string;
+};
 export declare type Invocation = {
   contractAddress: string;
   entrypoint: string;
@@ -29,7 +32,7 @@ export declare type Status =
   | 'ACCEPTED_ON_L1'
   | 'REJECTED';
 export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
-export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
+export declare type Type = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION';
 export declare type EntryPointType = 'EXTERNAL';
 export declare type CompressedProgram = string;
 export declare type AbiEntry = {

package/www/docs/API/provider.md

@@ -198,9 +198,26 @@ Gets the transaction trace from a tx hash.
 
 <hr/>
 
+provider.**declareContract**(payload) => _Promise < AddTransactionResponse >_
+
+Declares a contract on Starknet
+
+###### _AddTransactionResponse_
+
+```
+{
+  code: 'TRANSACTION_RECEIVED';
+  transaction_hash: string;
+  class_hash: string;
+};
+
+<hr/>
+
+```
+
 provider.**deployContract**(payload [ , abi ]) => _Promise < AddTransactionResponse >_
 
-Gets the transaction trace from a tx hash.
+Deploys a contract on Starknet
 
 ###### _AddTransactionResponse_