starknet 4.17.0 → 4.18.0

package/www/docs/API/account.md

@@ -1,463 +0,0 @@
----
-sidebar_position: 2
----
-
-# Account
-
-An Account extends <ins>[`Provider`](/docs/API/provider)</ins> and inherits all of its methods.
-
-It also introduces new methods that allow Accounts to create and verify signatures with a custom <ins>[`Signer`](/docs/API/signer)</ins>, declare and deploy Contract and deploy new Account
-
-This API is the primary way to interact with an account contract on StarkNet.
-
-## Creating an instance
-
-To create a new instance of the Account, first an account contract must be deployed. Also there needs to be a Provider instance that will be passed in the constructor and key pair for the account.
-
-`new starknet.Account(Provider, address, starkKeyPair)`
-
-## Properties
-
-account.**address** => _string_
-
-The address of the account contract.
-
-## Methods
-
-### getNonce()
-
-account.**getNonce(blockIdentifier)** => _Promise < BigNumberish >_
-
-Gets the nonce of the account with respect to a specific block.
-
-_blockIdentifier_ - optional blockIdentifier. Defaults to 'pending'.
-
-Returns the nonce of the account.
-
----
-
-### estimateInvokeFee()
-
-account.**estimateInvokeFee**(calls [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
-
-Estimate Fee for executing an INVOKE transaction on starknet.
-
-The _calls_ object structure:
-
-- calls.**contractAddress** - Address of the contract
-- calls.**entrypoint** - Entrypoint of the call (method name)
-- calls.**calldata** - Payload for the invoking method
-
-The _estimateFeeDetails_ object may include any of:
-
-- estimateFeeDetails.**blockIdentifier** - Block Identifier for the transaction
-- estimateFeeDetails.**nonce** - Nonce for the transaction
-
-###### _EstimateFeeResponse_
-
-```typescript
-{
-  overall_fee: BN;
-  gas_consumed?: BN;
-  gas_price?: BN;
-}
-```
-
----
-
-### estimateDeclareFee()
-
-account.**estimateDeclareFee**(contractPayload [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
-
-Estimate Fee for executing a DECLARE transaction on starknet.
-
-The _contractPayload_ object structure:
-
-- contractPayload.**contract** - The compiled contract
-- contractPayload.**classHash** - This can be obtained by using starknet-cli. Once the classHash is included in CompiledContract, this can be removed
-
-The _estimateFeeDetails_ object may include any of:
-
-- estimateFeeDetails.**blockIdentifier** - Block Identifier for the transaction
-- estimateFeeDetails.**nonce** - Nonce for the transaction
-
-###### _EstimateFeeResponse_
-
-```typescript
-{
-  overall_fee: BN;
-  gas_consumed?: BN;
-  gas_price?: BN;
-}
-```
-
----
-
-### estimateAccountDeployFee()
-
-account.**estimateAccountDeployFee**(contractPayload [ , estimateFeeDetails ]) => _Promise < EstimateFeeResponse >_
-
-Estimate Fee for executing a DEPLOY_ACCOUNT transaction on StarkNet
-
-The _contractPayload_ object structure:
-
-- contractPayload.**contract** - The compiled contract to be declared
-- contractPayload.**classHash** - This can be obtained by using starknet-cli. Once the classHash is included in CompiledContract, this can be removed
-
-The _estimateFeeDetails_ object may include any of:
-
-- estimateFeeDetails.**blockIdentifier** - Block Identifier for the transaction
-- estimateFeeDetails.**nonce** - Nonce for the transaction
-
-###### _EstimateFeeResponse_
-
-```typescript
-{
-  overall_fee: BN;
-  gas_consumed?: BN;
-  gas_price?: BN;
-}
-```
-
----
-
-### execute()
-
-account.**execute**(transactions [ , abi , transactionsDetail ]) => _Promise < InvokeFunctionResponse >_
-
-Executes one or multiple calls using the account contract.
-
-The _transactions_ object structure:
-
-- contractPayload.**contractAddress** - the address of the contract
-- contractPayload.**entrypoint** - the entrypoint of the contract
-- contractPayload.**calldata** - (defaults to []) the calldata
-- contractPayload.**signature** - (defaults to []) the signature
-
-_abi_ - (optional) the abi of the contract for better displaying
-
-The _transactionsDetail_ object may include any of:
-
-- transactionsDetail.**maxFee** - Max Fee that that will be used to execute the call(s)
-- transactionsDetail.**nonce** - Nonce for the transaction
-- transactionsDetail.**version** - Version for the transaction (default is 1)
-
-###### _InvokeFunctionResponse_
-
-```typescript
-{
-  transaction_hash: string;
-};
-```
-
----
-
-### declare()
-
-account.**declare**(contractPayload [ , transactionsDetail ]) => _Promise < DeclareContractResponse >_
-
-Declares a given compiled contract (json) to starknet.
-
-The _contractPayload_ object consists of:
-
-- contractPayload.**contract** - The compiled contract
-- contractPayload.**classHash** - Hash of the compiled contract
-
-The _transactionsDetail_ object may include any of:
-
-- transactionsDetail.**maxFee** - Max Fee that that will be used to execute the call(s)
-- transactionsDetail.**nonce** - Nonce for the transaction
-- transactionsDetail.**version** - Version for the transaction (default is 1)
-
-> _Note:_ Once the classHash is included in CompiledContract, this parameter can be removed. Currently it can be pre-computed from starknet-cli.
-
-Example:
-
-```typescript
-const declareTx = await account.declare({
-  contract: compiledErc20,
-  // classHash is pre-computed from starknet-cli
-  classHash: '0x54328a1075b8820eb43caf0caa233923148c983742402dcfc38541dd843d01a',
-});
-```
-
-###### _DeclareContractResponse_
-
-```typescript
-{
-  transaction_hash: string;
-  class_hash: string;
-};
-```
-
----
-
-### deploy()
-
-Deploys a given compiled contract (json) to starknet, wrapper around _execute_ invoke function
-
-account.**deploy**(deployContractPayload [ , transactionsDetail ]) => _Promise < InvokeFunctionResponse >_
-
-@param object **_deployContractPayload_**
-
-- **classHash**: computed class hash of compiled contract
-- optional constructorCalldata: constructor calldata
-- optional salt: address salt - default random
-- optional unique: bool if true ensure unique salt - default true
-
-@param object **transactionsDetail** Invocation Details
-
-- optional nonce
-- optional version
-- optional maxFee
-
-@returns **transaction_hash**
-
-Example:
-
-```typescript
-  const deployment = await account.deploy({
-    classHash: erc20ClassHash,
-    constructorCalldata: [
-      encodeShortString('Token'),
-      encodeShortString('ERC20'),
-      account.address,
-    ],
-    salt: randomAddress(),
-    unique: true, // Using true here so as not to clash with normal erc20 deploy in account and provider test
-  });
-
-  await provider.waitForTransaction(deployment.transaction_hash);
-```
-
-Example multi-call:
-
-```typescript
-TODO Example with multi-call
-```
-
----
-
-### deployContract()
-
-✅ NEW
-High level wrapper for deploy. Doesn't require waitForTransaction. Response similar to deprecated provider deployContract.
-
-account.**deployContract**(payload [ , details ]) => _Promise < DeployContractUDCResponse >_
-
-@param object **_payload_** UniversalDeployerContractPayload
-
-- **classHash**: computed class hash of compiled contract
-- **constructorCalldata**: constructor calldata
-- optional salt: address salt - default random
-- optional unique: bool if true ensure unique salt - default true
-
-@param object **details** InvocationsDetails
-
-- optional nonce
-- optional version
-- optional maxFee
-
-@returns Promise DeployContractUDCResponse
-
-- contract_address
-- transaction_hash
-- address
-- deployer
-- unique
-- classHash
-- calldata_len
-- calldata
-- salt
-
-Example:
-
-```typescript
-  const deployResponse = await account.deployContract({
-    classHash: erc20ClassHash,
-    constructorCalldata: [
-      encodeShortString('Token'),
-      encodeShortString('ERC20'),
-      account.address,
-    ],
-  });
-```
-
----
-
-### declareDeploy()
-
-✅ NEW
-High level wrapper for declare & deploy. Doesn't require waitForTransaction. Functionality similar to deprecated provider deployContract. Declare and Deploy contract using single function.
-
-account.**declareDeploy**(payload [ , details ]) => _Promise < DeclareDeployUDCResponse >_
-
-@param object **_payload_** DeclareDeployContractPayload
-
-- **contract**: compiled contract code
-- **classHash**: computed class hash of compiled contract
-- optional constructorCalldata: constructor calldata
-- optional salt: address salt - default random
-- optional unique: bool if true ensure unique salt - default true
-
-@param object **details** InvocationsDetails
-
-- optional nonce
-- optional version
-- optional maxFee
-
-@returns Promise DeclareDeployUDCResponse
-
-- declare: CommonTransactionReceiptResponse
-  - transaction_hash
-  - class_hash
-- deploy: DeployContractUDCResponse;
-  - contract_address
-  - transaction_hash
-  - address
-  - deployer
-  - unique
-  - classHash
-  - calldata_len
-  - calldata
-  - salt
-  ***
-
-Example:
-
-```typescript
-  const declareDeploy = await account.declareDeploy({
-    contract: compiledErc20,
-    classHash: '0x54328a1075b8820eb43caf0caa233923148c983742402dcfc38541dd843d01a',
-    constructorCalldata: [
-      encodeShortString('Token'),
-      encodeShortString('ERC20'),
-      account.address,
-    ],
-  });
-
-  const declareTransactionHash = declareDeploy.declare.transaction_hash
-  const erc20Address = declareDeploy.deploy.contract_address;
-```
-
----
-
-### deployAccount()
-
-account.**deployAccount**(contractPayload [ , transactionsDetail ]) => _Promise < DeployContractResponse >_
-
-Declares a given compiled contract (json) to starknet.
-
-The _contractPayload_ object consists of:
-
-- contractPayload.**classHash** - Hash of the compiled contract
-- contractPayload.**constructorCalldata** - optional
-- contractPayload.**addressSalt** - optional
-- contractPayload.**contractAddress** - optional
-
-The _transactionsDetail_ object may include any of:
-
-- transactionsDetail.**maxFee** - Max Fee that that will be used to execute the call(s)
-- transactionsDetail.**nonce** - Nonce for the transaction
-- transactionsDetail.**version** - Version for the transaction (default is 1)
-
-> _Note:_ Once the classHash is included in CompiledContract, this parameter can be removed. Currently it can be pre-computed from starknet-cli.
-
-###### _DeployContractResponse_
-
-```typescript
-{
-  contract_address: string;
-  transaction_hash: string;
-};
-```
-
----
-
-### signMessage()
-
-account.**signMessage**(typedData) => _Promise < Signature >_
-
-Sign an JSON object for off-chain usage with the starknet private key and return the signature. This adds a message prefix so it cant be interchanged with transactions.
-
-_typedData_ - JSON object to be signed
-
-###### _Signature_
-
-```typescript
-string[];
-```
-
----
-
-### hashMessage()
-
-account.**hashMessage**(typedData) => _Promise < string >_
-
-Hash a JSON object with pederson hash and return the hash. This adds a message prefix so it cant be interchanged with transactions.
-
-_typedData_ - JSON object to be signed
-
-Returns the hash of the JSON object.
-
----
-
-### verifyMessageHash()
-
-account.**verifyMessageHash**(hash, signature) => _Promise < boolean >_
-
-Verify a signature of a given hash.
-
-> **WARNING**
->
-> This method is not recommended, use `verifyMessage` instead
-
----
-
-### verifyMessage()
-
-account.**verifyMessage**(typedData, signature) => _Promise < boolean >_
-
-Verify a signature of a JSON object.
-
-_typedData_ - JSON object to be verified
-_signature_ - signature of the JSON object
-
-Returns true if the signature is valid, false otherwise
-
----
-
-### getSuggestedMaxFee()
-
-account.**getSuggestedMaxFee**(estimateFeeAction, details) => _Promise < BigNumberish >_
-
-Gets Suggested Max Fee based on the transaction type.
-
-The _details_ object may include any of:
-
-- details.**blockIdentifier**
-- details.**nonce**
-
----
-
-### getStarkName()
-
-account.**getStarkName**(StarknetIdContract) => _Promise<string | Error>_
-
-Gets starknet.id stark name with the address of the account
-
-The _StarknetIdContract_ argument can be undefined, if it is, the function will automatically use official starknet id contracts of your network (It currently supports TESTNET 1 only).
-
-Returns directly a string (Example: `vitalik.stark`).
-
----
-
-### getAddressFromStarkName()
-
-account.**getAddressFromStarkName**(name, StarknetIdContract) => _Promise<string | Error>_
-
-Gets account address with the starknet id stark name.
-
-The _StarknetIdContract_ argument can be undefined, if it is, the function will automatically use official starknet id contracts of your network (It currently supports TESTNET 1 only).
-
-Returns directly the address in a string (Example: `0xff...34`).

package/www/docs/API/changelog.md

@@ -1,15 +0,0 @@
----
-sidebar_position: 7
----
-
-# CHANGELOG
-
-### Release 3.10.2 (21.04.2022)
-
-- New hash formula for the new account contract version.
-
-  **NOTE**: Update your accounts, old ones will not be supported anymore. For updating with Argent X extension you can check this [link](https://github.com/argentlabs/argent-x/pull/522)
-
-- BUGFIX: [#165](https://github.com/0xs34n/starknet.js/issues/165)
-- BUGFIX: [#151](https://github.com/0xs34n/starknet.js/issues/151)
-- BUGFIX: [#158](https://github.com/0xs34n/starknet.js/issues/158)

package/www/docs/API/contract.md

@@ -1,135 +0,0 @@
----
-sidebar_position: 4
----
-
-# Contract
-
-Contracts can do data transformations in JavaScript based on an ABI. They can also call and invoke to StarkNet through a provided Signer.
-
-Contracts allow you to transform Cairo values, like `Uint256` to `BigNumber`. It could also allow users to pass their own transformers, similar to `JSON.parse`.
-
-## Creating an instance
-
-`new starknet.Contract(abi, address, providerOrAccount)`
-
-`contract.attach(address)` _for changing the address of the connected contract_
-
-`contract.connect(providerOrAccount)` _for changing the provider or account_
-
-## Properties
-
-contract.**abi** => _Abi_
-
-The ABI the contract was constructed with.
-
-contract.**address** => _string_
-
-The address the contract was constructed/connected with.
-
-contract.**providerOrAccount** => _ProviderInterface | AccountInterface_
-
-Provider or account that are used to interact with the network.
-
-contract.**deployTransactionHash** => _string | null_
-
-If the Contract object is the result of a ContractFactory deployment, this is the transaction which was used to deploy the contract.
-
-## Methods
-
-### attach()
-
-contract.**attach**(address) => void
-
-Saves the address of the contract deployed on network that will be used for interaction.
-
-_address_ - address of the contract.
-
----
-
-### connect()
-
-contract.**connect**(providerOrAccount) => void
-
-Attaches to new Provider or Account
-
----
-
-### deployed()
-
-contract.**deployed**() => _Promise < Contract >_
-
-If the Contract object is the result of a ContractFactory deployment, this method will wait for the transaction to be resolved.
-
----
-
-### call()
-
-contract.**call**(method, args, options) => _Promise < Result >_
-
-Calls a method on a contract.
-
----
-
-### invoke()
-
-contract.**invoke**(method, args, options) => _Promise < InvokeFunctionResponse >_
-
-Invokes a method on a contract.
-
----
-
-### estimate()
-
-contract.**estimate**(method, args, options) => _Promise < any >_
-
-Estimates a method on a contract.
-
----
-
-### populate()
-
-contract.**populate**(method, args, options) => _Invocation_
-
-## Meta-Class
-
-A Meta-Class is a Class which has any of its properties determined at run-time. The Contract object uses a Contract's ABI to determine what methods are available, so the following sections describe the generic ways to interact with the properties added at run-time during the Contract constructor.
-
-### Read-Only Methods(constant)
-
-A constant method (denoted view in Cairo) is read-only and evaluates a small amount of Cairo code against the current blockchain state. It is therefore free and does not require any fee, but cannot make changes to the blockchain state...
-
-contract.**METHOD_NAME**(...args [ , overrides ]) => _Promise < Result >_
-
-The type of the result depends on the ABI. Result object will be returned with each parameter available positionally and if the parameter is named, it will also be available by its name.
-
-The _overrides_ object for a read-only method may include:
-
-- overrides.**blockIdentifier**
-
-### Write Methods (non-constant)
-
-A non-constant method requires a transaction to be signed and requires payment in the form of a fee to be paid.
-
-contract.**METHOD_NAME**(...args [ , overrides ]) => _Promise < AddTransactionResponse >_
-
-Returns a _AddTransactionResponse_ for the transaction after it is sent to the network. This requires that Contract has a signer.
-
-The _overrides_ object for write methods may include any of:
-
-- overrides.**signature** - Signature that will be used for the transaction
-- overrides.**maxFee** - Max Fee for the transaction
-- overrides.**nonce** - Nonce for the transaction
-
-### Write Methods Analysis
-
-There are several options to analyze properties and results of a write method without actually executing it.
-
-contract.estimateGas.**METHOD_NAME**( ...args ) => _Promise < EstimateFeeResponse >_
-
-Returns the estimate units of gas that would be required to execute the METHOD_NAME with args and overrides.
-
-contract.populateTransaction.**METHOD_NAME**( ...args [ , overrides ] ) ⇒ _Call_
-
-Returns an _Call_ object which represents the transaction that would need to be signed and submitted to the network to execute METHOD_NAME with args and overrides.
-
-The overrides are identical to the overrides above for write methods.

package/www/docs/API/contractFactory.md

@@ -1,45 +0,0 @@
----
-sidebar_position: 5
----
-
-# Contract Factory
-
-Contract Factory allow you to deploy contracts to StarkNet. To deploy a Contract, additional information is needed that is not available on a Contract object itself.
-
-## Creating an instance
-
-`new starknet.ContractFactory( compiledContract, classHash, account, [ , abi ] )`
-
-Creates a new instance of a ContractFactory for the contract described by the _compiledContract_.
-
-`contractFactory.connect(account)` _for changing the provider or account_
-
-`contractFactory.attach(address)` _for changing the address of the connected contract factory_
-
-## Properties
-
-contractFactory.**compiledContract** => _CompiledContract_ (the compiled contract the contractFactory was constructed with)
-
-contractFactory.**classHash** => _string_ (contract classHash can be obtained using tool for compiling contract)
-
-contractFactory.**account** => _AccountInterface_ (account that are used to interact with the network)
-
-contractFactory.**abi** => _Abi_ (the ABI the contractFactory was constructed with)
-
-## Methods
-
-### attach()
-
-contractFactory.**attach**( address ) ⇒ _Contract_
-
-Return an instance of a _Contract_ attached to address. This is the same as using the _Contract_ constructor with address and this _compiledContract_ and _account_ passed in when creating the ContractFactory.
-
----
-
-### deploy()
-
-contractFactory.**deploy**( args, addressSalt ) ⇒ _Promise < Contract >_
-
-Uses the provider to deploy the Contract with _args_ passed into the constructor and returns a _Contract_ which is attached to the address where this contract will be deployed.
-
-The transaction hash can be found at _contract.deployTransactionHash_, and no interactions should be made until the transaction is resolved.

package/www/docs/API/index.md

@@ -1,3 +0,0 @@
-# StarkNet.js API
-
-This API is based on the <ins>[Starknet.js V3](https://github.com/0xs34n/starknet.js/discussions/102)</ins> Interface write up by <ins>[Janek](https://twitter.com/0xjanek)</ins> of <ins>[Argent](https://www.argent.xyz/)</ins>