starknet 4.17.0 → 4.18.0

package/www/docs/API/signer.md

@@ -1,105 +0,0 @@
----
-sidebar_position: 3
----
-
-# Signer
-
-The **Signer** API allows you to sign transactions and messages, and also allows you to get the public key.
-
-## Creating an instance
-
-`new starknet.Signer(keyPair)`
-
-## Methods
-
-### getPubKey()
-
-signer.**getPubKey**() => _Promise < string >_
-
-Returns the public key of the signer.
-
----
-
-### signTransaction()
-
-signer.**signTransaction**(transactions, transactionsDetail [ , abi ]) => _Promise < Signature >_
-
-Signs a transaction with the starknet private key and returns the signature.
-
-The _transactions_ object for write methods may include any of:
-
-- transactions.**contractAddress** - the address of the contract
-- transactions.**entrypoint** - the entrypoint of the contract
-- transactions.**calldata** - (defaults to []) the calldata
-
-_abi_ - (optional) the abi of the contract for better displaying
-
-###### _Signature_
-
-```typescript
-string[]
-```
-
----
-
-### signMessage()
-
-signer.**signMessage**(typedData, accountAddress) => _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
-_accountAddress_ - calldata to be passed in deploy constructor
-
-###### _Signature_
-
-```typescript
-string[]
-```
-
----
-
-### signDeployAccountTransaction()
-
-signer.**signDeployAccountTransaction**(transaction) => _Promise < Signature >_
-
-Signs a DEPLOY_ACCOUNT transaction with the starknet private key and returns the signature.
-
-The _transactions_ object for write methods may include any of:
-
-- transactions.**contractAddress** - the address of the contract
-- transactions.**constructorCalldata** - calldata to be passed in deploy constructor
-- transactions.**addressSalt** - contract address salt
-- transactions.**chainId** - the chainId to declare contract on
-- transactions.**maxFee** - maxFee for the declare transaction
-- transactions.**version** - transaction version
-- transactions.**nonce** - Nonce of the declare transaction
-
-###### _Signature_
-
-```typescript
-string[]
-```
-
----
-
-### signDeclareTransaction()
-
-signer.**signDeclareTransaction**(transaction, transactionsDetail [ , abi ]) => _Promise < Signature >_
-
-Signs a DECLARE transaction with the starknet private key and returns the signature.
-
-The _transaction_ object for write methods may include any of:
-
-- transactions.**classHash** - computed class hash. Will be replaced by ContractClass in future once class hash is present in CompiledContract
-- transactions.**senderAddress** - the address of the sender
-- transactions.**chainId** - the chainId to declare contract on
-- transactions.**maxFee** - maxFee for the declare transaction
-- transactions.**version** - transaction version
-- transactions.**nonce** - Nonce of the declare transaction
-
-###### _Signature_
-
-```typescript
-string[]
-```

package/www/docs/API/utils.md

@@ -1,374 +0,0 @@
----
-sidebar_position: 6
----
-
-# Utils
-
-Util functions are provided so you can use various low level functions in your application.
-
-## **address**
-
-Helper functions for starknet addresses.
-
-### validateAndParseAddress
-
-`validateAndParseAddress(address: BigNumberish): string`
-
-Checks if the address is valid and, if it is, parses it to the correct format (0x prefix is added if not provided).
-
-### getChecksumAddress
-
-`getChecksumAddress(address: BigNumberish): string`
-
-This function accepts an address as a `BigNumberish` and returns the checksummed address as a string.
-An example:
-
-```js
-import { address } from 'starknet.js';
-
-const addressToCheck = '0x2fd23d9182193775423497fc0c472e156c57c69e4089a1967fb288a2d84e914';
-
-const checksummedAddress = address.getChecksumAddress(addressToCheck);
-
-console.log(checksummedAddress); // 0x02FD23D9182193775423497Fc0c472E156C57C69E4089a1967fb288a2D84e914
-```
-
-### validateChecksumAddress
-
-`validateChecksumAddress(address: string): boolean`
-
-This function validates the checksum address.
-
-Returns true if the address is valid, false otherwise.
-
----
-
-## **stark**
-
-Functions for stark specific manipulations.
-
-### compressProgram
-
-`compressProgram(jsonProgram: Program | string): CompressedProgram`
-
-Function to compress compiled cairo program. Accepts a json file representing the compiled cairo program and returns a compressed cairo program.
-
-### randomAddress
-
-`randomAddress(): string`
-
-Function that generates a random stark address.
-
-### makeAddress
-
-`makeAddress(input: string): string`
-
-Function that turns an incompatible address string into stark address format.
-
-Returns a string.
-
-Example: `0xdFD0F27FCe99b50909de0bDD328Aed6eAbe76BC5` -> `0xdfd0f27fce99b50909de0bdd328aed6eabe76bc5`
-
-### formatSignature
-
-`formatSignature(sig?: Signature): string[]`
-
-Function that formats a Signature to BigNum and then to string array.
-
-Returns a string array.
-
-### compileCalldata
-
-`compileCalldata(args: RawArgs): Calldata`
-
-Function that creates calldata that gets sent to the contract.
-
-```js
-await this.callContract({
-    contractAddress: this.address,
-    entrypoint: 'is_valid_signature',
-    calldata: compileCalldata({
-        hash: toBN(hash).toString(),
-        signature: signature.map((x) => toBN(x).toString()),
-    }),
-});
-```
-
-### estimatedFeeToMaxFee
-
-`estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead: number = 0.5): BN`
-
-Function that calculates and returns maximum fee based on the previously estimated one.
-
-Returns a BN.
-
----
-
-## **number**
-
-Various number formatting functions.
-
-`BN` is the `BigNum` representation imported from `bn.js` library.
-
-```js
-export type BigNumberish = string | number | BN;
-```
-
-### isHex
-
-`isHex(hex: string): boolean`
-
-Check if number is in hex format.
-
-### toBN
-
-`toBN(number: BigNumberish, base?: number | 'hex'): BN`
-
-Converts BigNumberish to BN.
-
-Returns a BN.
-
-### toHex
-
-`toHex(number: BN): string`
-
-Converts BN to hex.
-
-Returns a string.
-
-### cleanHex
-
-`cleanHex(hex: string): string`
-
-Remove leading zeroes and lowercase hex string after '0x'
-
-`0x01AFF` -> `0x1aff`
-
-### hexToDecimalString
-
-`hexToDecimalString(hex: string): string`
-
-Converts hex string to decimal string.
-
-### toFelt
-
-`toFelt(num: BigNumberish): string`
-
-Converts BN to Felt.
-
-Returns a string.
-
-### assertInRange
-
-`assertInRange(input: BigNumberish, lowerBound: BigNumberish, upperBound: BigNumberish, inputName = '')`
-
-Asserts input is equal to or greater then `lowerBound` and lower then `upperBound`. Assert message specifies inputName.
-`input`, `lowerBound`, and `upperBound` should be of type BN.
-`inputName` should be a string.
-
-### bigNumberishArrayToDecimalStringArray
-
-`bigNumberishArrayToDecimalStringArray(rawCalldata: BigNumberish[]): string[]`
-
-Convert BigNumberish array to decimal array. Used for signature conversion.
-
-```js
-const signature = await this.signer.signTransaction(transactions, signerDetails);
-
-{
-    contract_address: this.address,
-    entry_point_selector: getSelectorFromName('__execute__'),
-    calldata,
-    version: toHex(version),
-    signature: bigNumberishArrayToDecimalStringArray(signature),
-}
-```
-
-### bigNumberishArrayToHexadecimalStringArray
-
-`bigNumberishArrayToHexadecimalStringArray(rawCalldata: BigNumberish[]): string[]`
-
-Convert BigNumberish array to hexadecimal string array. Used for signature conversion.
-
----
-
-## **uint256**
-
-```js
-// Represents an integer in the range [0, 2^256).
-export interface Uint256 {
-  // The low 128 bits of the value.
-  low: BigNumberish;
-  // The high 128 bits of the value.
-  high: BigNumberish;
-}
-```
-
-### uint256ToBN
-
-`uint256ToBN(uint256: Uint256): BN`
-
-Function to convert `Uint256` to `BN` (big number), which uses the `bn.js` library.
-
-### isUint256
-
-`isUint256(bn: BigNumberish): boolean`
-
-Function to check if `BN` is smaller or equal to `2**256-1`.
-
-### bnToUint256
-
-`bnToUint256(bignumber: BigNumberish): Uint256`
-
-Function to convert `BN` to `Uint256`.
-
----
-
-## **hash**
-
-Various hashing helpers.
-
-### starknetKeccak
-
-`starknetKeccak(value: string): BN`
-
-Function to get the starknet keccak hash from a string. Returns starknet keccak hash as BigNumber.
-
-Returns starknet keccak hash as BigNumber.
-
-### getSelectorFromName
-
-`getSelectorFromName(funcName: string)`
-
-Function to get the hex selector from a given function name.
-
-Returns hex selector of given abi function name.
-
-### pedersen
-
-`pedersen(input: [BigNumberish, BigNumberish])`
-
-Function to get the Pedersen hash for two arguments.
-
-Returns a string.
-
-### computeHashOnElements
-
-`computeHashOnElements(data: BigNumberish[])`
-
-Function to compute a Pedersen hash on a array of elements.
-
-Returns a string.
-
-### calculateTransactionHashCommon
-
-`calculateTransactionHashCommon(txHashPrefix: TransactionHashPrefix, version: BigNumberish,contractAddress: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId, additionalData: BigNumberish[] = []): string`
-
-Calculates the transaction hash in the StarkNet network - a unique identifier of the transaction.
-
-Called internally in `calculateDeployTransactionHash` and `calculcateTransactionHash`.
-
-### calculateDeployTransactionHash
-
-`calculateDeployTransactionHash(contractAddress: BigNumberish, constructorCalldata: BigNumberish[], version: BigNumberish, chainId: StarknetChainId): string`
-
-Function that calculates the deployment transaction hash in the StarkNet network.
-
-Internally calls `calculateTransactionHashCommon` with `TransactionHashPrefix.DEPLOY`.
-
-### calculateTransactionHash
-
-`calculateTransactionHash(contractAddress: BigNumberish, version: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId, nonce: BigNumberish): string`
-
-Function that internally calls `calculateTransactionHashCommon`, with `TransactionHashPrefix.INVOKE`.
-
-```js
-const hashMsg = calculcateTransactionHash(
-  account,
-  transactionVersion,
-  getSelectorFromName('__execute__'),
-  calldata,
-  maxFee,
-  StarknetChainId.TESTNET
-);
-```
-
-### calculateContractAddressFromHash
-
-`calculateContractAddressFromHash(salt: BigNumberish, classHash: BigNumberish, constructorCalldata: RawCalldata, deployerAddress: BigNumberish)`
-
-Function that calculates contract address from hash.
-
-Returns a string.
-
----
-
-## **ellipticCurve**
-
-Wrapper around the javascript `elliptic` library with additional functionality.
-
-### genKeyPair
-
-`ec.genKeyPair()`
-
-Generate a random key pair.
-
-### getKeyPair
-
-`getKeyPair(pk: BigNumberish): KeyPair`
-
-Get a key pair from a private key.
-
-### getStarkKey
-
-`getStarkKey(keyPair: KeyPair): string`
-
-Public key defined over a Stark-friendly elliptic curve that is different from the standard Ethereum elliptic curve
-
-### getKeyPairFromPublicKey
-
-`getKeyPairFromPublicKey(publicKey: BigNumberish): KeyPair`
-
-Takes a public key and casts it into `elliptic` KeyPair format.
-
-Returns keyPair with public key only, which can be used to verify signatures, but can't sign anything.
-
-### sign
-
-`sign(keyPair: KeyPair, msgHash: string): Signature`
-
-Signs a message using the provided key.
-
-keyPair should be an KeyPair with a valid private key.
-
-Returns an Signature.
-
-### verify
-
-`verify(keyPair: KeyPair | KeyPair[], msgHash: string, sig: Signature): boolean`
-
-Verifies a message using the provided key.
-
-keyPair should be an KeyPair with a valid public key.
-
-sig should be an Signature.
-
-Returns true if the verification succeeds.
-
-<hr />
-
-## **calldata**
-
-Functions to compile and validate arguments passed in invoke, call and deploy functions.
-
-### compile
-
-`compileCalldata(args: Array<any>, inputs: AbiEntry[]): Calldata`
-
-Parse the calldata by using input fields from the abi for that method.
-
-### validate
-
-`validateMethodAndArgs(type: 'INVOKE' | 'CALL' | 'DEPLOY', method: string, args: Array<any> = [])`
-
-Validates if all arguments that are passed to the method are corresponding to the ones in the abi.

package/www/docusaurus.config.js

@@ -1,130 +0,0 @@
-// @ts-check
-// Note: type annotations allow type checking and IDEs autocompletion
-
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
-
-/** @type {import('@docusaurus/types').Config} */
-const config = {
-  title: 'Starknet.js',
-  tagline: 'JavaScript libray for StarkNet',
-  url: 'https://starknetjs.com',
-  baseUrl: '/',
-  onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
-  favicon: 'img/favicon.ico',
-  organizationName: '0xs34n', // Usually your GitHub org/user name.
-  projectName: 'starknet.js', // Usually your repo name.
-
-  plugins: [
-    [
-      '@docusaurus/plugin-content-docs',
-      {
-        id: 'guides',
-        path: 'guides',
-        routeBasePath: 'guides',
-        sidebarPath: require.resolve('./sidebars.js'),
-      },
-    ],
-  ],
-
-  presets: [
-    [
-      'classic',
-      /** @type {import('@docusaurus/preset-classic').Options} */
-      ({
-        docs: {
-          sidebarPath: require.resolve('./sidebars.js'),
-          // Please change this to your repo.
-          editUrl: 'https://github.com/0xs34n/starknet.js',
-        },
-        blog: {
-          showReadingTime: true,
-          // Please change this to your repo.
-          editUrl: 'https://github.com/0xs34n/starknet.js',
-        },
-        theme: {
-          customCss: require.resolve('./src/css/custom.css'),
-        },
-      }),
-    ],
-  ],
-
-  themeConfig:
-    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
-    ({
-      navbar: {
-        title: 'Home',
-        logo: {
-          alt: 'Starknet.js Logo',
-          src: 'img/logo.svg',
-        },
-        items: [
-          {
-            type: 'doc',
-            docId: 'API/index',
-            position: 'left',
-            label: 'API',
-          },
-          {
-            position: 'left',
-            label: 'Guides',
-            to: '/guides/intro',
-          },
-          // {to: '/blog', label: 'Blog', position: 'left'},
-          {
-            href: 'https://github.com/0xs34n/starknet.js',
-            label: 'GitHub',
-            position: 'right',
-          },
-        ],
-      },
-      footer: {
-        style: 'dark',
-        links: [
-          {
-            title: 'Docs',
-            items: [
-              {
-                label: 'API',
-                to: '/docs/API/',
-              },
-              {
-                label: 'Guides',
-                to: '/guides/intro',
-              },
-            ],
-          },
-          {
-            title: 'Community',
-            items: [
-              {
-                label: 'Twitter',
-                href: 'https://twitter.com/0xs34n',
-              },
-            ],
-          },
-          {
-            title: 'More',
-            items: [
-              // {
-              //   label: 'Blog',
-              //   to: '/blog',
-              // },
-              {
-                label: 'GitHub',
-                href: 'https://github.com/0xs34n/starknet.js',
-              },
-            ],
-          },
-        ],
-        copyright: `Copyright © ${new Date().getFullYear()} 0xs34n`,
-      },
-      prism: {
-        theme: lightCodeTheme,
-        darkTheme: darkCodeTheme,
-      },
-    }),
-};
-
-module.exports = config;