@atomiqlabs/chain-starknet 8.1.10 → 8.1.11

package/dist/index.d.ts

@@ -2,6 +2,8 @@ export { StarknetBtcStoredHeader } from "./starknet/btcrelay/headers/StarknetBtc
 export { StarknetBtcHeader } from "./starknet/btcrelay/headers/StarknetBtcHeader";
 export * from "./starknet/btcrelay/StarknetBtcRelay";
 export * from "./starknet/chain/modules/StarknetFees";
+export { StarknetTx, SignedStarknetTx } from "./starknet/chain/modules/StarknetTransactions";
+export { StarknetAction } from "./starknet/chain/StarknetAction";
 export * from "./starknet/chain/StarknetChainInterface";
 export * from "./starknet/events/StarknetChainEventsBrowser";
 export * from "./starknet/provider/RpcProviderWithRetries";

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StarknetSwapData = exports.StarknetSpvVaultData = exports.StarknetBtcHeader = exports.StarknetBtcStoredHeader = void 0;
+exports.StarknetSwapData = exports.StarknetSpvVaultData = exports.StarknetAction = exports.StarknetBtcHeader = exports.StarknetBtcStoredHeader = void 0;
 const WebSocket = require("ws");
 if (global.window == null)
     global.WebSocket = WebSocket;
@@ -24,6 +24,8 @@ var StarknetBtcHeader_1 = require("./starknet/btcrelay/headers/StarknetBtcHeader
 Object.defineProperty(exports, "StarknetBtcHeader", { enumerable: true, get: function () { return StarknetBtcHeader_1.StarknetBtcHeader; } });
 __exportStar(require("./starknet/btcrelay/StarknetBtcRelay"), exports);
 __exportStar(require("./starknet/chain/modules/StarknetFees"), exports);
+var StarknetAction_1 = require("./starknet/chain/StarknetAction");
+Object.defineProperty(exports, "StarknetAction", { enumerable: true, get: function () { return StarknetAction_1.StarknetAction; } });
 __exportStar(require("./starknet/chain/StarknetChainInterface"), exports);
 __exportStar(require("./starknet/events/StarknetChainEventsBrowser"), exports);
 __exportStar(require("./starknet/provider/RpcProviderWithRetries"), exports);

package/dist/starknet/chain/StarknetAction.d.ts

@@ -2,18 +2,62 @@ import { Call } from "starknet";
 import { StarknetChainInterface } from "./StarknetChainInterface";
 import { StarknetTx } from "./modules/StarknetTransactions";
 import { StarknetGas } from "./modules/StarknetFees";
+/**
+ * An action which contains multiple underlying contract calls (invokes), tracks their total gas limits
+ *  and allows creating a transaction, which will execute all the contract calls
+ *
+ * @category Chain Interface
+ */
 export declare class StarknetAction {
+    /**
+     * Total gas limit of all the contract calls
+     */
     gas: StarknetGas;
+    /**
+     * Address of the signer for this transaction
+     */
     readonly mainSigner: string;
     private readonly root;
     private readonly instructions;
     private feeRate?;
     constructor(mainSigner: string, root: StarknetChainInterface, instructions?: Call[] | Call, gasLimit?: StarknetGas, feeRate?: string);
     private estimateFeeRate;
+    /**
+     * Adds a single invoke call to the action along with the gas limits
+     *
+     * @param instruction Instruction to add to the action
+     * @param gasLimit Gas limit required for the instruction
+     */
     addIx(instruction: Call, gasLimit?: StarknetGas): void;
+    /**
+     * Adds contract calls from another starknet action to this action, while also adding its gas limits
+     *
+     * @param action Calls from this action are added to current action
+     */
     add(action: StarknetAction): this;
+    /**
+     * Adds contract calls from another starknet action to this action, while also adding its gas limits. Adds
+     *  the contract calls at a given index provided (by default at the end of existing calls)
+     *
+     * @param action Calls from this action are added to current action
+     * @param index Index at which to add the calls (by defaults added at the end)
+     */
     addAction(action: StarknetAction, index?: number): this;
+    /**
+     * Creates an unsigned starknet transaction out of this action, which executes all the underlying contract calls
+     *
+     * @param feeRate Fee rate to use for the transaction
+     */
     tx(feeRate?: string): Promise<StarknetTx>;
+    /**
+     * Adds the generated transaction to an already existing array of transaction
+     *
+     * @param txs Transaction executing this action will be added to this transactions array
+     * @param feeRate Fee rate to use for this transaction
+     */
     addToTxs(txs: StarknetTx[], feeRate?: string): Promise<void>;
+    /**
+     * Number of individual contract calls in this action
+     */
     ixsLength(): number;
 }

package/dist/starknet/chain/StarknetAction.js

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StarknetAction = void 0;
 const StarknetFees_1 = require("./modules/StarknetFees");
+/**
+ * An action which contains multiple underlying contract calls (invokes), tracks their total gas limits
+ *  and allows creating a transaction, which will execute all the contract calls
+ *
+ * @category Chain Interface
+ */
 class StarknetAction {
     constructor(mainSigner, root, instructions = [], gasLimit, feeRate) {
         this.mainSigner = mainSigner;
@@ -17,14 +23,32 @@ class StarknetAction {
     estimateFeeRate() {
         return this.root.Fees.getFeeRate();
     }
+    /**
+     * Adds a single invoke call to the action along with the gas limits
+     *
+     * @param instruction Instruction to add to the action
+     * @param gasLimit Gas limit required for the instruction
+     */
     addIx(instruction, gasLimit) {
         this.instructions.push(instruction);
         if (gasLimit != null)
             this.gas = (0, StarknetFees_1.starknetGasAdd)(this.gas, gasLimit);
     }
+    /**
+     * Adds contract calls from another starknet action to this action, while also adding its gas limits
+     *
+     * @param action Calls from this action are added to current action
+     */
     add(action) {
         return this.addAction(action);
     }
+    /**
+     * Adds contract calls from another starknet action to this action, while also adding its gas limits. Adds
+     *  the contract calls at a given index provided (by default at the end of existing calls)
+     *
+     * @param action Calls from this action are added to current action
+     * @param index Index at which to add the calls (by defaults added at the end)
+     */
     addAction(action, index = this.instructions.length) {
         if (action.mainSigner !== this.mainSigner)
             throw new Error("Actions need to have the same signer!");
@@ -45,6 +69,11 @@ class StarknetAction {
             this.feeRate = action.feeRate;
         return this;
     }
+    /**
+     * Creates an unsigned starknet transaction out of this action, which executes all the underlying contract calls
+     *
+     * @param feeRate Fee rate to use for the transaction
+     */
     async tx(feeRate) {
         if (feeRate == null)
             feeRate = this.feeRate;
@@ -64,9 +93,18 @@ class StarknetAction {
             }
         };
     }
+    /**
+     * Adds the generated transaction to an already existing array of transaction
+     *
+     * @param txs Transaction executing this action will be added to this transactions array
+     * @param feeRate Fee rate to use for this transaction
+     */
     async addToTxs(txs, feeRate) {
         txs.push(await this.tx(feeRate));
     }
+    /**
+     * Number of individual contract calls in this action
+     */
     ixsLength() {
         return this.instructions.length;
     }

package/dist/starknet/chain/modules/StarknetTransactions.d.ts

@@ -19,7 +19,19 @@ export type StarknetTxDeployAccount = StarknetTxBase & {
     signed?: DeployAccountContractTransaction;
 };
 export declare function isStarknetTxDeployAccount(obj: any): obj is StarknetTxDeployAccount;
+/**
+ * Unsigned starknet transaction, either an invoke transaction calling contracts or account deploy transaction
+ *
+ * @category Chain Interface
+ */
 export type StarknetTx = StarknetTxInvoke | StarknetTxDeployAccount;
+/**
+ * Signed starknet transaction, either an invoke transaction calling contracts or account deploy transaction.
+ *
+ * @remarks Uses the same type as the unsinged tx for Starknet!
+ *
+ * @category Chain Interface
+ */
 export type SignedStarknetTx = StarknetTx;
 export type StarknetTraceCall = {
     calldata: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/chain-starknet",
-  "version": "8.1.10",
+  "version": "8.1.11",
   "description": "Starknet specific base implementation",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/src/index.ts

@@ -6,6 +6,8 @@ export {StarknetBtcHeader} from "./starknet/btcrelay/headers/StarknetBtcHeader";
 export * from "./starknet/btcrelay/StarknetBtcRelay";
 
 export * from "./starknet/chain/modules/StarknetFees";
+export {StarknetTx, SignedStarknetTx} from "./starknet/chain/modules/StarknetTransactions";
+export {StarknetAction} from "./starknet/chain/StarknetAction";
 export * from "./starknet/chain/StarknetChainInterface";
 
 export * from "./starknet/events/StarknetChainEventsBrowser";

package/src/starknet/chain/StarknetAction.ts

@@ -3,9 +3,21 @@ import {StarknetChainInterface} from "./StarknetChainInterface";
 import {StarknetTx} from "./modules/StarknetTransactions";
 import {StarknetGas, starknetGasAdd} from "./modules/StarknetFees";
 
+/**
+ * An action which contains multiple underlying contract calls (invokes), tracks their total gas limits
+ *  and allows creating a transaction, which will execute all the contract calls
+ *
+ * @category Chain Interface
+ */
 export class StarknetAction {
 
+    /**
+     * Total gas limit of all the contract calls
+     */
     gas: StarknetGas;
+    /**
+     * Address of the signer for this transaction
+     */
     readonly mainSigner: string;
 
     private readonly root: StarknetChainInterface;
@@ -34,15 +46,33 @@ export class StarknetAction {
         return this.root.Fees.getFeeRate();
     }
 
+    /**
+     * Adds a single invoke call to the action along with the gas limits
+     *
+     * @param instruction Instruction to add to the action
+     * @param gasLimit Gas limit required for the instruction
+     */
     public addIx(instruction: Call, gasLimit?: StarknetGas) {
         this.instructions.push(instruction);
         if(gasLimit!=null) this.gas = starknetGasAdd(this.gas, gasLimit);
     }
 
+    /**
+     * Adds contract calls from another starknet action to this action, while also adding its gas limits
+     *
+     * @param action Calls from this action are added to current action
+     */
     public add(action: StarknetAction): this {
         return this.addAction(action);
     }
 
+    /**
+     * Adds contract calls from another starknet action to this action, while also adding its gas limits. Adds
+     *  the contract calls at a given index provided (by default at the end of existing calls)
+     *
+     * @param action Calls from this action are added to current action
+     * @param index Index at which to add the calls (by defaults added at the end)
+     */
     public addAction(action: StarknetAction, index: number = this.instructions.length): this {
         if(action.mainSigner!==this.mainSigner) throw new Error("Actions need to have the same signer!");
         if(this.gas.l1Gas==null && action.gas.l1Gas!=null) this.gas.l1Gas = action.gas.l1Gas;
@@ -56,6 +86,11 @@ export class StarknetAction {
         return this;
     }
 
+    /**
+     * Creates an unsigned starknet transaction out of this action, which executes all the underlying contract calls
+     *
+     * @param feeRate Fee rate to use for the transaction
+     */
     public async tx(feeRate?: string): Promise<StarknetTx> {
         if(feeRate==null) feeRate = this.feeRate;
         if(feeRate==null) feeRate = await this.estimateFeeRate();
@@ -75,10 +110,19 @@ export class StarknetAction {
         };
     }
 
+    /**
+     * Adds the generated transaction to an already existing array of transaction
+     *
+     * @param txs Transaction executing this action will be added to this transactions array
+     * @param feeRate Fee rate to use for this transaction
+     */
     public async addToTxs(txs: StarknetTx[], feeRate?: string): Promise<void> {
         txs.push(await this.tx(feeRate));
     }
 
+    /**
+     * Number of individual contract calls in this action
+     */
     public ixsLength(): number {
         return this.instructions.length;
     }

package/src/starknet/chain/modules/StarknetTransactions.ts

@@ -62,7 +62,20 @@ export function isStarknetTxDeployAccount(obj: any): obj is StarknetTxDeployAcco
         (obj.signed==null || typeof(obj.signed)==="object");
 }
 
+/**
+ * Unsigned starknet transaction, either an invoke transaction calling contracts or account deploy transaction
+ *
+ * @category Chain Interface
+ */
 export type StarknetTx = StarknetTxInvoke | StarknetTxDeployAccount;
+
+/**
+ * Signed starknet transaction, either an invoke transaction calling contracts or account deploy transaction.
+ *
+ * @remarks Uses the same type as the unsinged tx for Starknet!
+ *
+ * @category Chain Interface
+ */
 export type SignedStarknetTx = StarknetTx;
 
 export type StarknetTraceCall = {