From f7fbad7f318b3c56bdbffa8a6b4a35370adaa20c Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Wed, 15 Mar 2023 12:07:59 -0300 Subject: [PATCH 01/23] switching docs engine --- .changeset/famous-spies-applaud.md | 11 + .github/workflows/release.yaml | 19 +- .prettierignore | 1 + apps/docs/.gitignore | 1 + apps/docs/.vitepress/config.ts | 311 ++++ .../.vitepress/plugins/codeInContextPlugin.ts | 51 + apps/docs/.vitepress/plugins/snippetPlugin.ts | 153 ++ .../theme/components/LogoComponent.vue | 52 + apps/docs/.vitepress/theme/index.ts | 11 + apps/docs/.vitepress/theme/styles/custom.css | 101 ++ apps/docs/package.json | 24 + {docs/_guide => apps/docs/src}/glossary.md | 0 .../generate-contract-types-from-abi.md | 20 + apps/docs/src/guide/abi-typegen/index.md | 51 + .../abi-typegen/using-generated-types.md | 16 + .../src/guide}/contracts/call-parameters.md | 11 +- .../contracts/calling-external-contracts.md | 4 +- .../contracts/calls-with-different-wallets.md | 6 +- .../src/guide}/contracts/cost-estimation.md | 6 +- .../guide/contracts/deploying-contracts.md | 29 + .../docs/src/guide}/contracts/index.md | 6 +- .../contracts/interacting-with-contracts.md | 6 +- .../docs/src/guide}/contracts/logs.md | 6 +- .../docs/src/guide}/contracts/multicalls.md | 11 +- .../src/guide}/contracts/read-only-calls.md | 8 +- .../contracts/the-fuelvm-binary-file.md | 8 +- .../contracts/transaction-parameters.md | 4 +- .../src/guide}/contracts/variable-outputs.md | 6 +- .../guide}/cookbook/deposit-and-withdraw.md | 16 +- .../docs/src/guide}/cookbook/index.md | 2 - .../guide}/cookbook/transfer-all-assets.md | 0 {docs/_guide => apps/docs/src/guide}/index.md | 9 +- .../messages/getting-a-message-proof.md | 2 +- .../guide}/messages/getting-all-resources.md | 2 +- .../src/guide}/messages/getting-messages.md | 2 +- .../docs/src/guide}/messages/index.md | 4 +- .../docs/src/guide}/predicates/index.md | 12 +- .../send-and-spend-funds-from-predicates.md | 16 +- .../connecting-to-an-external-node.md | 6 +- .../docs/src/guide}/providers/connection.md | 2 - .../docs/src/guide}/providers/index.md | 2 - .../guide}/providers/querying-the-chain.md | 16 +- .../src/guide}/scripts/calling-a-script.md | 6 +- apps/docs/src/guide/scripts/index.md | 13 + .../guide/scripts/instantiating-a-script.md | 15 + .../docs/src}/guide/testing/index.md | 17 +- .../src/guide}/testing/testing-with-jest.md | 6 +- apps/docs/src/guide/types/address.md | 23 + .../docs/src/guide}/types/arrays.md | 4 +- .../docs/src/guide}/types/asset-id.md | 0 .../docs/src/guide}/types/bech32.md | 5 +- .../docs/src/guide}/types/bits256.md | 4 +- .../docs/src/guide}/types/bytes32.md | 2 +- .../docs/src/guide}/types/contract-id.md | 0 .../docs/src/guide}/types/conversion.md | 2 +- .../src/guide}/types/enums-and-options.md | 20 +- .../docs/src/guide}/types/index.md | 2 - .../docs/src/guide}/types/string.md | 4 +- .../docs/src/guide}/types/structs.md | 5 +- .../docs/src/guide}/types/vectors.md | 11 +- .../docs/src}/guide/wallets/access.md | 50 +- .../wallets/checking-balances-and-coins.md | 29 +- .../wallets/encrypting-and-storing-wallets.md | 12 +- .../docs/src/guide}/wallets/index.md | 2 - .../src/guide}/wallets/mnemonic-wallet.md | 12 +- apps/docs/src/guide/wallets/private-keys.md | 40 + apps/docs/src/guide/wallets/signing.md | 38 + apps/docs/src/guide/wallets/test-wallets.md | 61 + .../src}/guide/wallets/transferring-assets.md | 14 +- {docs => apps/docs/src}/index.md | 29 +- apps/docs/src/public/favicon.ico | Bin 0 -> 15406 bytes apps/docs/src/public/fuel-logo.png | Bin 0 -> 3730 bytes .../docs/src/public}/my-fuel-dapp-preview.png | Bin apps/docs/src/versions.data.ts | 59 + apps/docs/src/vite.config.ts | 12 + apps/docs/tsconfig.json | 10 + apps/docs/types/index.d.ts | 1 + docs/.gitignore | 9 - docs/Gemfile | 35 - docs/README.md | 21 - docs/_config.yml | 30 - docs/_data/versions.yml | 5 - .../abi-typegen/generating-types-from-abi.md | 69 - docs/_guide/abi-typegen/index.md | 50 - .../abi-typegen/using-generated-types.md | 92 - docs/_guide/contracts/deploying-contracts.md | 25 - docs/_guide/local-docs.md | 49 - docs/_guide/scripts/index.md | 7 - docs/_guide/scripts/instantiating-a-script.md | 9 - docs/_guide/testing/index.md | 26 - docs/_guide/types/address.md | 23 - docs/_guide/wallets/access.md | 51 - .../wallets/checking-balances-and-coins.md | 9 - docs/_guide/wallets/private-keys.md | 12 - docs/_guide/wallets/signing.md | 9 - docs/_guide/wallets/test-wallets.md | 13 - docs/_guide/wallets/transferring-assets.md | 5 - docs/_includes/js/custom.js | 37 - docs/_sass/color_schemes/fuel-dark.scss | 22 - .../pygments-tomorrow-night.scss | 66 - docs/_sass/custom/custom.scss | 28 - docs/assets/fuels-ts-logo-dark.png | Bin 39513 -> 0 bytes docs/assets/fuels-ts-logo-light.png | Bin 40614 -> 0 bytes docs/assets/fuels-ts-logo.png | Bin 6955 -> 0 bytes docs/favicon.ico | Bin 15086 -> 0 bytes .../abi-typegen/generating-types-from-abi.md | 77 - docs/guide/abi-typegen/index.md | 59 - .../abi-typegen/using-generated-types.md | 119 -- docs/guide/contracts/call-parameters.md | 86 - .../contracts/calling-external-contracts.md | 31 - .../contracts/calls-with-different-wallets.md | 25 - docs/guide/contracts/cost-estimation.md | 43 - docs/guide/contracts/deploying-contracts.md | 59 - docs/guide/contracts/index.md | 46 - .../contracts/interacting-with-contracts.md | 37 - docs/guide/contracts/logs.md | 50 - docs/guide/contracts/multicalls.md | 75 - docs/guide/contracts/read-only-calls.md | 38 - .../guide/contracts/the-fuelvm-binary-file.md | 61 - .../guide/contracts/transaction-parameters.md | 39 - docs/guide/contracts/variable-outputs.md | 39 - docs/guide/cookbook/deposit-and-withdraw.md | 241 --- docs/guide/cookbook/index.md | 14 - docs/guide/cookbook/transfer-all-assets.md | 8 - docs/guide/glossary.md | 23 - docs/guide/index.md | 25 - docs/guide/local-docs.md | 57 - .../guide/messages/getting-a-message-proof.md | 24 - docs/guide/messages/getting-all-resources.md | 28 - docs/guide/messages/getting-messages.md | 57 - docs/guide/messages/index.md | 36 - docs/guide/predicates/index.md | 62 - .../send-and-spend-funds-from-predicates.md | 215 --- .../connecting-to-an-external-node.md | 65 - docs/guide/providers/connection.md | 23 - docs/guide/providers/index.md | 14 - docs/guide/providers/querying-the-chain.md | 105 -- docs/guide/scripts/calling-a-script.md | 44 - docs/guide/scripts/index.md | 16 - docs/guide/scripts/instantiating-a-script.md | 91 - docs/guide/testing/testing-with-jest.md | 68 - docs/guide/types/address.md | 103 -- docs/guide/types/arrays.md | 25 - docs/guide/types/asset-id.md | 10 - docs/guide/types/bech32.md | 38 - docs/guide/types/bits256.md | 49 - docs/guide/types/bytes32.md | 33 - docs/guide/types/contract-id.md | 10 - docs/guide/types/conversion.md | 37 - docs/guide/types/enums-and-options.md | 124 -- docs/guide/types/index.md | 14 - docs/guide/types/string.md | 32 - docs/guide/types/structs.md | 40 - docs/guide/types/vectors.md | 73 - .../wallets/encrypting-and-storing-wallets.md | 35 - docs/guide/wallets/index.md | 23 - docs/guide/wallets/mnemonic-wallet.md | 32 - docs/guide/wallets/private-keys.md | 51 - docs/guide/wallets/signing.md | 49 - docs/guide/wallets/test-wallets.md | 72 - docs/packages/README.md | 34 - .../packages/fuel-ts-abi-coder/classes/ABI.md | 146 -- .../fuel-ts-abi-coder/classes/AbiCoder.md | 84 - .../fuel-ts-abi-coder/classes/ArrayCoder.md | 224 --- .../fuel-ts-abi-coder/classes/B256Coder.md | 185 -- .../fuel-ts-abi-coder/classes/B512Coder.md | 185 -- .../fuel-ts-abi-coder/classes/BooleanCoder.md | 185 -- .../fuel-ts-abi-coder/classes/ByteCoder.md | 185 -- .../fuel-ts-abi-coder/classes/Coder.md | 195 -- .../fuel-ts-abi-coder/classes/EnumCoder.md | 234 --- .../fuel-ts-abi-coder/classes/Fragment.md | 103 -- .../classes/FunctionFragment.md | 145 -- .../fuel-ts-abi-coder/classes/Interface.md | 274 --- .../fuel-ts-abi-coder/classes/NumberCoder.md | 211 --- .../fuel-ts-abi-coder/classes/StringCoder.md | 223 --- .../fuel-ts-abi-coder/classes/StructCoder.md | 214 --- .../fuel-ts-abi-coder/classes/TupleCoder.md | 213 --- .../fuel-ts-abi-coder/classes/U64Coder.md | 185 -- .../fuel-ts-abi-coder/classes/VecCoder.md | 247 --- .../fuel-ts-abi-coder/classes/internal-BN.md | 814 --------- .../classes/internal-ParamType.md | 193 -- docs/packages/fuel-ts-abi-coder/index.md | 371 ---- .../interfaces/JsonAbiFragment.md | 61 - .../interfaces/JsonAbiFragmentType.md | 51 - .../JsonAbiFunctionAttributeType.md | 31 - .../interfaces/JsonAbiLogFragment.md | 41 - .../interfaces/JsonFlatAbi.md | 41 - .../JsonFlatAbiFragmentArgumentType.md | 41 - .../interfaces/JsonFlatAbiFragmentFunction.md | 51 - .../JsonFlatAbiFragmentLoggedType.md | 31 - .../interfaces/JsonFlatAbiFragmentType.md | 61 - .../interfaces/internal-AttributeType.md | 31 - .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- .../interfaces/internal-FragmentParams.md | 61 - .../interfaces/internal-JsonFragmentType.md | 51 - .../interfaces/internal-ParamTypeProps.md | 65 - .../fuel-ts-abi-coder/namespaces/internal.md | 270 --- .../fuel-ts-address/classes/Address.md | 360 ---- .../classes/internal-AbstractAccount.md | 98 - .../classes/internal-AbstractAddress.md | 127 -- .../classes/internal-AbstractContract.md | 88 - .../classes/internal-AbstractProgram.md | 62 - docs/packages/fuel-ts-address/index.md | 240 --- .../fuel-ts-address/namespaces/internal.md | 38 - docs/packages/fuel-ts-constants/index.md | 39 - .../classes/ContractFactory.md | 134 -- .../classes/internal-AbstractAccount.md | 104 -- .../classes/internal-AbstractAddress.md | 121 -- .../classes/internal-AbstractContract.md | 88 - .../classes/internal-AbstractProgram.md | 62 - .../classes/internal-AbstractScriptRequest.md | 63 - .../classes/internal-Account.md | 326 ---- .../fuel-ts-contract/classes/internal-BN.md | 814 --------- .../internal-BaseTransactionRequest.md | 526 ------ .../internal-CreateTransactionRequest.md | 703 -------- .../internal-ScriptTransactionRequest.md | 797 --------- .../classes/internal-TransactionResponse.md | 166 -- .../enums/internal-GqlCoinStatus.md | 31 - .../enums/internal-GqlMessageStatus.md | 31 - .../enums/internal-GqlReturnType.md | 41 - .../enums/internal-TransactionType.md | 41 - docs/packages/fuel-ts-contract/index.md | 18 - .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- .../internal-BaseTransactionRequestLike.md | 95 - .../internal-CreateTransactionRequestLike.md | 149 -- .../interfaces/internal-JsonAbiFragment.md | 61 - .../internal-JsonAbiFragmentType.md | 51 - .../internal-JsonAbiFunctionAttributeType.md | 31 - .../interfaces/internal-JsonFlatAbi.md | 41 - ...nternal-JsonFlatAbiFragmentArgumentType.md | 41 - .../internal-JsonFlatAbiFragmentFunction.md | 51 - .../internal-JsonFlatAbiFragmentLoggedType.md | 31 - .../internal-JsonFlatAbiFragmentType.md | 61 - .../internal-ScriptTransactionRequestLike.md | 137 -- .../namespaces/ContractUtils.md | 94 - .../fuel-ts-contract/namespaces/internal.md | 1481 ---------------- .../fuel-ts-hasher/classes/internal-BN.md | 814 --------- docs/packages/fuel-ts-hasher/index.md | 85 - .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- .../internal-BaseTransactionRequestLike.md | 91 - .../internal-CreateTransactionRequestLike.md | 149 -- .../internal-ScriptTransactionRequestLike.md | 137 -- .../fuel-ts-hasher/namespaces/internal.md | 405 ----- .../fuel-ts-hdwallet/classes/HDWallet.md | 231 --- docs/packages/fuel-ts-hdwallet/index.md | 17 - .../fuel-ts-hdwallet/namespaces/internal.md | 32 - .../classes/AbstractAccount.md | 98 - .../classes/AbstractAddress.md | 121 -- .../classes/AbstractContract.md | 88 - .../classes/AbstractPredicate.md | 57 - .../classes/AbstractProgram.md | 64 - .../classes/AbstractScript.md | 88 - .../classes/AbstractScriptRequest.md | 63 - docs/packages/fuel-ts-interfaces/index.md | 59 - docs/packages/fuel-ts-keystore/index.md | 162 -- .../fuel-ts-keystore/interfaces/Keystore.md | 41 - docs/packages/fuel-ts-math/classes/BN.md | 814 --------- docs/packages/fuel-ts-math/index.md | 284 --- .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- docs/packages/fuel-ts-math/namespaces/bn.md | 32 - .../fuel-ts-math/namespaces/internal.md | 28 - docs/packages/fuel-ts-merkle-shared/index.md | 62 - .../fuel-ts-merkle/classes/internal-Node.md | 92 - docs/packages/fuel-ts-merkle/index.md | 126 -- .../fuel-ts-merkle/namespaces/internal.md | 15 - .../classes/internal-Node.md | 103 -- .../classes/internal-Proof.md | 48 - docs/packages/fuel-ts-merklesum/index.md | 132 -- .../fuel-ts-merklesum/namespaces/internal.md | 16 - .../fuel-ts-mnemonic/classes/Mnemonic.md | 293 --- docs/packages/fuel-ts-mnemonic/index.md | 33 - .../fuel-ts-predicate/classes/Predicate.md | 457 ----- .../classes/internal-AbstractAccount.md | 104 -- .../classes/internal-AbstractAddress.md | 121 -- .../classes/internal-AbstractContract.md | 88 - .../classes/internal-AbstractProgram.md | 62 - .../classes/internal-AbstractScriptRequest.md | 63 - .../classes/internal-Account.md | 328 ---- .../fuel-ts-predicate/classes/internal-BN.md | 814 --------- .../internal-BaseTransactionRequest.md | 526 ------ .../internal-CreateTransactionRequest.md | 703 -------- .../internal-ScriptTransactionRequest.md | 797 --------- .../classes/internal-TransactionResponse.md | 166 -- .../enums/internal-GqlCoinStatus.md | 31 - .../enums/internal-GqlMessageStatus.md | 31 - .../enums/internal-GqlReturnType.md | 41 - .../enums/internal-TransactionType.md | 41 - docs/packages/fuel-ts-predicate/index.md | 17 - .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- .../internal-BaseTransactionRequestLike.md | 95 - .../internal-CreateTransactionRequestLike.md | 149 -- .../interfaces/internal-JsonAbiFragment.md | 61 - .../internal-JsonAbiFragmentType.md | 51 - .../internal-JsonAbiFunctionAttributeType.md | 31 - .../interfaces/internal-JsonFlatAbi.md | 41 - ...nternal-JsonFlatAbiFragmentArgumentType.md | 41 - .../internal-JsonFlatAbiFragmentFunction.md | 51 - .../internal-JsonFlatAbiFragmentLoggedType.md | 31 - .../internal-JsonFlatAbiFragmentType.md | 61 - .../internal-ScriptTransactionRequestLike.md | 137 -- .../fuel-ts-predicate/namespaces/internal.md | 1515 ---------------- .../fuel-ts-program/classes/Contract.md | 173 -- .../classes/FunctionInvocationResult.md | 239 --- .../classes/FunctionInvocationScope.md | 693 -------- .../classes/InvocationResult.md | 143 -- .../classes/MultiCallInvocationScope.md | 596 ------- .../fuel-ts-program/classes/ScriptRequest.md | 177 -- .../classes/ScriptResultDecoderError.md | 49 - .../classes/internal-AbstractAccount.md | 104 -- .../classes/internal-AbstractAddress.md | 121 -- .../classes/internal-AbstractContract.md | 92 - .../classes/internal-AbstractProgram.md | 62 - .../classes/internal-AbstractScriptRequest.md | 63 - .../classes/internal-Account.md | 326 ---- .../fuel-ts-program/classes/internal-BN.md | 814 --------- .../classes/internal-BaseInvocationScope.md | 498 ------ .../internal-BaseTransactionRequest.md | 526 ------ .../internal-CreateTransactionRequest.md | 703 -------- .../classes/internal-InvocationCallResult.md | 193 -- .../internal-ScriptTransactionRequest.md | 797 --------- .../classes/internal-TransactionResponse.md | 166 -- .../enums/internal-GqlCoinStatus.md | 31 - .../enums/internal-GqlMessageStatus.md | 31 - .../enums/internal-GqlReturnType.md | 41 - .../enums/internal-TransactionType.md | 41 - docs/packages/fuel-ts-program/index.md | 218 --- .../interfaces/InvokeFunctions.md | 15 - .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- .../internal-BaseTransactionRequestLike.md | 95 - .../internal-CreateTransactionRequestLike.md | 149 -- .../interfaces/internal-JsonAbiFragment.md | 61 - .../internal-JsonAbiFragmentType.md | 51 - .../internal-JsonAbiFunctionAttributeType.md | 31 - .../interfaces/internal-JsonFlatAbi.md | 41 - ...nternal-JsonFlatAbiFragmentArgumentType.md | 41 - .../internal-JsonFlatAbiFragmentFunction.md | 51 - .../internal-JsonFlatAbiFragmentLoggedType.md | 31 - .../internal-JsonFlatAbiFragmentType.md | 61 - .../internal-ScriptTransactionRequestLike.md | 137 -- .../fuel-ts-program/namespaces/internal.md | 1513 ---------------- .../classes/ChangeOutputCollisionError.md | 65 - .../classes/CreateTransactionRequest.md | 703 -------- .../classes/NoWitnessAtIndexError.md | 61 - .../classes/NoWitnessByOwnerError.md | 61 - .../fuel-ts-providers/classes/Provider.md | 634 ------- .../classes/ScriptTransactionRequest.md | 797 --------- .../classes/TransactionResponse.md | 166 -- .../classes/internal-AbstractAccount.md | 98 - .../classes/internal-AbstractAddress.md | 121 -- .../classes/internal-AbstractContract.md | 88 - .../classes/internal-AbstractProgram.md | 62 - .../classes/internal-AbstractScriptRequest.md | 63 - .../fuel-ts-providers/classes/internal-BN.md | 814 --------- .../internal-BaseTransactionRequest.md | 526 ------ .../fuel-ts-providers/enums/CoinStatus.md | 31 - .../fuel-ts-providers/enums/MessageStatus.md | 31 - .../enums/TransactionType.md | 41 - .../enums/internal-GqlReturnType.md | 41 - docs/packages/fuel-ts-providers/index.md | 1191 ------------- .../CreateTransactionRequestLike.md | 149 -- .../ScriptTransactionRequestLike.md | 137 -- .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- .../internal-BaseTransactionRequestLike.md | 95 - .../fuel-ts-providers/namespaces/internal.md | 1571 ----------------- .../packages/fuel-ts-signer/classes/Signer.md | 217 --- docs/packages/fuel-ts-signer/index.md | 29 - .../fuel-ts-sparsemerkle/classes/default.md | 251 --- .../internal-SparseCompactMerkleProof.md | 81 - .../classes/internal-SparseMerkleProof.md | 59 - docs/packages/fuel-ts-sparsemerkle/index.md | 17 - .../interfaces/internal-MapStore.md | 15 - .../namespaces/internal.md | 20 - .../classes/ByteArrayCoder.md | 211 --- .../classes/InputCoder.md | 185 -- .../classes/InputCoinCoder.md | 185 -- .../classes/InputContractCoder.md | 185 -- .../classes/InputMessageCoder.md | 225 --- .../classes/OutputChangeCoder.md | 185 -- .../classes/OutputCoder.md | 185 -- .../classes/OutputCoinCoder.md | 185 -- .../classes/OutputContractCoder.md | 185 -- .../classes/OutputContractCreatedCoder.md | 188 -- .../classes/OutputMessageCoder.md | 185 -- .../classes/OutputVariableCoder.md | 185 -- .../classes/ReceiptCallCoder.md | 185 -- .../classes/ReceiptCoder.md | 185 -- .../classes/ReceiptLogCoder.md | 185 -- .../classes/ReceiptLogDataCoder.md | 185 -- .../classes/ReceiptMessageOutCoder.md | 185 -- .../classes/ReceiptPanicCoder.md | 185 -- .../classes/ReceiptReturnCoder.md | 185 -- .../classes/ReceiptReturnDataCoder.md | 185 -- .../classes/ReceiptRevertCoder.md | 185 -- .../classes/ReceiptScriptResultCoder.md | 185 -- .../classes/ReceiptTransferCoder.md | 185 -- .../classes/ReceiptTransferOutCoder.md | 185 -- .../classes/StorageSlotCoder.md | 209 --- .../classes/TransactionCoder.md | 185 -- .../classes/TransactionCreateCoder.md | 185 -- .../classes/TransactionMintCoder.md | 185 -- .../classes/TransactionScriptCoder.md | 185 -- .../classes/TxPointerCoder.md | 209 --- .../classes/UtxoIdCoder.md | 209 --- .../classes/WitnessCoder.md | 185 -- .../classes/internal-BN.md | 814 --------- .../fuel-ts-transactions/enums/InputType.md | 41 - .../fuel-ts-transactions/enums/OutputType.md | 71 - .../fuel-ts-transactions/enums/ReceiptType.md | 121 -- .../enums/TransactionType.md | 41 - docs/packages/fuel-ts-transactions/index.md | 807 --------- .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- .../namespaces/internal.md | 127 -- .../classes/StorageAbstract.md | 92 - .../fuel-ts-wallet-manager/classes/Vault.md | 136 -- .../classes/WalletManager.md | 467 ----- .../classes/internal-AbstractAccount.md | 104 -- .../classes/internal-AbstractAddress.md | 121 -- .../classes/internal-AbstractContract.md | 88 - .../classes/internal-AbstractProgram.md | 62 - .../classes/internal-AbstractScriptRequest.md | 63 - .../classes/internal-Account.md | 330 ---- .../classes/internal-BN.md | 814 --------- .../internal-BaseTransactionRequest.md | 526 ------ .../classes/internal-BaseWalletUnlocked.md | 484 ----- .../internal-CreateTransactionRequest.md | 703 -------- .../classes/internal-MnemonicVault.md | 212 --- .../classes/internal-PrivateKeyVault.md | 190 -- .../internal-ScriptTransactionRequest.md | 797 --------- .../classes/internal-Signer.md | 217 --- .../classes/internal-TransactionResponse.md | 166 -- .../classes/internal-WalletLocked.md | 378 ---- .../classes/internal-WalletUnlocked.md | 620 ------- .../enums/internal-GqlCoinStatus.md | 31 - .../enums/internal-GqlMessageStatus.md | 31 - .../enums/internal-GqlReturnType.md | 41 - .../enums/internal-TransactionType.md | 41 - docs/packages/fuel-ts-wallet-manager/index.md | 85 - .../interfaces/WalletManagerState.md | 21 - .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- .../internal-BaseTransactionRequestLike.md | 95 - .../internal-CreateTransactionRequestLike.md | 149 -- .../interfaces/internal-GenerateOptions.md | 33 - .../internal-MnemonicVaultOptions.md | 41 - .../interfaces/internal-PkVaultOptions.md | 31 - .../internal-ScriptTransactionRequestLike.md | 137 -- .../namespaces/internal.md | 1460 --------------- .../fuel-ts-wallet/classes/Account.md | 330 ---- .../classes/BaseWalletUnlocked.md | 484 ----- .../packages/fuel-ts-wallet/classes/Wallet.md | 171 -- .../fuel-ts-wallet/classes/WalletLocked.md | 378 ---- .../fuel-ts-wallet/classes/WalletUnlocked.md | 620 ------- .../classes/internal-AbstractAccount.md | 104 -- .../classes/internal-AbstractAddress.md | 121 -- .../classes/internal-AbstractContract.md | 88 - .../classes/internal-AbstractProgram.md | 62 - .../classes/internal-AbstractScriptRequest.md | 63 - .../fuel-ts-wallet/classes/internal-BN.md | 814 --------- .../internal-BaseTransactionRequest.md | 526 ------ .../internal-CreateTransactionRequest.md | 703 -------- .../internal-ScriptTransactionRequest.md | 797 --------- .../fuel-ts-wallet/classes/internal-Signer.md | 217 --- .../classes/internal-TransactionResponse.md | 166 -- .../enums/internal-GqlCoinStatus.md | 31 - .../enums/internal-GqlMessageStatus.md | 31 - .../enums/internal-GqlReturnType.md | 41 - .../enums/internal-TransactionType.md | 41 - docs/packages/fuel-ts-wallet/index.md | 21 - .../interfaces/internal-BNHelper.md | 102 -- .../interfaces/internal-BNHiddenTypes.md | 71 - .../interfaces/internal-BNInputOverrides.md | 327 ---- .../interfaces/internal-BNOverrides.md | 117 -- .../internal-BaseTransactionRequestLike.md | 95 - .../internal-CreateTransactionRequestLike.md | 149 -- .../interfaces/internal-GenerateOptions.md | 33 - .../internal-ScriptTransactionRequestLike.md | 137 -- .../fuel-ts-wallet/namespaces/internal.md | 1452 --------------- .../fuel-ts-wordlists/enums/Language.md | 21 - docs/packages/fuel-ts-wordlists/index.md | 23 - package.json | 5 - .../src/example-contract.test.ts | 4 +- packages/example-contract/src/main.sw | 4 +- .../fuel-gauge/src/call-test-contract.test.ts | 4 +- .../fuel-gauge/src/contract-factory.test.ts | 4 +- packages/fuel-gauge/src/contract.test.ts | 40 +- .../fuel-gauge/src/coverage-contract.test.ts | 36 +- packages/fuel-gauge/src/doc-examples.test.ts | 104 +- .../fuel-gauge/src/script-main-args.test.ts | 4 +- .../src/storage-test-contract.test.ts | 4 +- .../src/token-test-contract.test.ts | 4 +- .../coverage-contract/src/main.sw | 20 +- .../test-projects/liquidity-pool/src/main.sw | 4 +- .../predicate-main-args-struct/src/main.sw | 4 +- .../predicate-triple-sig/src/main.sw | 4 +- .../script-main-args/src/main.sw | 4 +- .../test-projects/token_contract/src/main.sw | 6 +- packages/interfaces/src/index.ts | 8 +- packages/providers/src/message.ts | 4 +- packages/script/src/script.test.ts | 4 +- packages/versions/package.json | 4 +- packages/wallet/src/account.test.ts | 4 +- packages/wallet/src/transfer.test.ts | 4 +- pnpm-lock.yaml | 825 ++++++++- pnpm-workspace.yaml | 1 + 530 files changed, 2204 insertions(+), 76949 deletions(-) create mode 100644 .changeset/famous-spies-applaud.md create mode 100644 apps/docs/.gitignore create mode 100644 apps/docs/.vitepress/config.ts create mode 100644 apps/docs/.vitepress/plugins/codeInContextPlugin.ts create mode 100644 apps/docs/.vitepress/plugins/snippetPlugin.ts create mode 100644 apps/docs/.vitepress/theme/components/LogoComponent.vue create mode 100644 apps/docs/.vitepress/theme/index.ts create mode 100644 apps/docs/.vitepress/theme/styles/custom.css create mode 100644 apps/docs/package.json rename {docs/_guide => apps/docs/src}/glossary.md (100%) create mode 100644 apps/docs/src/guide/abi-typegen/generate-contract-types-from-abi.md create mode 100644 apps/docs/src/guide/abi-typegen/index.md create mode 100644 apps/docs/src/guide/abi-typegen/using-generated-types.md rename {docs/_guide => apps/docs/src/guide}/contracts/call-parameters.md (72%) rename {docs/_guide => apps/docs/src/guide}/contracts/calling-external-contracts.md (64%) rename {docs/_guide => apps/docs/src/guide}/contracts/calls-with-different-wallets.md (95%) rename {docs/_guide => apps/docs/src/guide}/contracts/cost-estimation.md (83%) create mode 100644 apps/docs/src/guide/contracts/deploying-contracts.md rename {docs/_guide => apps/docs/src/guide}/contracts/index.md (78%) rename {docs/_guide => apps/docs/src/guide}/contracts/interacting-with-contracts.md (88%) rename {docs/_guide => apps/docs/src/guide}/contracts/logs.md (68%) rename {docs/_guide => apps/docs/src/guide}/contracts/multicalls.md (67%) rename {docs/_guide => apps/docs/src/guide}/contracts/read-only-calls.md (81%) rename {docs/_guide => apps/docs/src/guide}/contracts/the-fuelvm-binary-file.md (97%) rename {docs/_guide => apps/docs/src/guide}/contracts/transaction-parameters.md (89%) rename {docs/_guide => apps/docs/src/guide}/contracts/variable-outputs.md (86%) rename {docs/_guide => apps/docs/src/guide}/cookbook/deposit-and-withdraw.md (65%) rename {docs/_guide => apps/docs/src/guide}/cookbook/index.md (93%) rename {docs/_guide => apps/docs/src/guide}/cookbook/transfer-all-assets.md (100%) rename {docs/_guide => apps/docs/src/guide}/index.md (69%) rename {docs/_guide => apps/docs/src/guide}/messages/getting-a-message-proof.md (70%) rename {docs/_guide => apps/docs/src/guide}/messages/getting-all-resources.md (63%) rename {docs/_guide => apps/docs/src/guide}/messages/getting-messages.md (51%) rename {docs/_guide => apps/docs/src/guide}/messages/index.md (80%) rename {docs/_guide => apps/docs/src/guide}/predicates/index.md (66%) rename {docs/_guide => apps/docs/src/guide}/predicates/send-and-spend-funds-from-predicates.md (66%) rename {docs/_guide => apps/docs/src/guide}/providers/connecting-to-an-external-node.md (81%) rename {docs/_guide => apps/docs/src/guide}/providers/connection.md (98%) rename {docs/_guide => apps/docs/src/guide}/providers/index.md (86%) rename {docs/_guide => apps/docs/src/guide}/providers/querying-the-chain.md (63%) rename {docs/_guide => apps/docs/src/guide}/scripts/calling-a-script.md (60%) create mode 100644 apps/docs/src/guide/scripts/index.md create mode 100644 apps/docs/src/guide/scripts/instantiating-a-script.md rename {docs => apps/docs/src}/guide/testing/index.md (77%) rename {docs/_guide => apps/docs/src/guide}/testing/testing-with-jest.md (68%) create mode 100644 apps/docs/src/guide/types/address.md rename {docs/_guide => apps/docs/src/guide}/types/arrays.md (92%) rename {docs/_guide => apps/docs/src/guide}/types/asset-id.md (100%) rename {docs/_guide => apps/docs/src/guide}/types/bech32.md (68%) rename {docs/_guide => apps/docs/src/guide}/types/bits256.md (68%) rename {docs/_guide => apps/docs/src/guide}/types/bytes32.md (79%) rename {docs/_guide => apps/docs/src/guide}/types/contract-id.md (100%) rename {docs/_guide => apps/docs/src/guide}/types/conversion.md (72%) rename {docs/_guide => apps/docs/src/guide}/types/enums-and-options.md (63%) rename {docs/_guide => apps/docs/src/guide}/types/index.md (91%) rename {docs/_guide => apps/docs/src/guide}/types/string.md (80%) rename {docs/_guide => apps/docs/src/guide}/types/structs.md (74%) rename {docs/_guide => apps/docs/src/guide}/types/vectors.md (68%) rename {docs => apps/docs/src}/guide/wallets/access.md (70%) rename {docs => apps/docs/src}/guide/wallets/checking-balances-and-coins.md (56%) rename {docs/_guide => apps/docs/src/guide}/wallets/encrypting-and-storing-wallets.md (67%) rename {docs/_guide => apps/docs/src/guide}/wallets/index.md (98%) rename {docs/_guide => apps/docs/src/guide}/wallets/mnemonic-wallet.md (73%) create mode 100644 apps/docs/src/guide/wallets/private-keys.md create mode 100644 apps/docs/src/guide/wallets/signing.md create mode 100644 apps/docs/src/guide/wallets/test-wallets.md rename {docs => apps/docs/src}/guide/wallets/transferring-assets.md (83%) rename {docs => apps/docs/src}/index.md (75%) create mode 100644 apps/docs/src/public/favicon.ico create mode 100644 apps/docs/src/public/fuel-logo.png rename {docs/assets => apps/docs/src/public}/my-fuel-dapp-preview.png (100%) create mode 100644 apps/docs/src/versions.data.ts create mode 100644 apps/docs/src/vite.config.ts create mode 100644 apps/docs/tsconfig.json create mode 100644 apps/docs/types/index.d.ts delete mode 100644 docs/.gitignore delete mode 100644 docs/Gemfile delete mode 100644 docs/README.md delete mode 100644 docs/_config.yml delete mode 100644 docs/_data/versions.yml delete mode 100644 docs/_guide/abi-typegen/generating-types-from-abi.md delete mode 100644 docs/_guide/abi-typegen/index.md delete mode 100644 docs/_guide/abi-typegen/using-generated-types.md delete mode 100644 docs/_guide/contracts/deploying-contracts.md delete mode 100644 docs/_guide/local-docs.md delete mode 100644 docs/_guide/scripts/index.md delete mode 100644 docs/_guide/scripts/instantiating-a-script.md delete mode 100644 docs/_guide/testing/index.md delete mode 100644 docs/_guide/types/address.md delete mode 100644 docs/_guide/wallets/access.md delete mode 100644 docs/_guide/wallets/checking-balances-and-coins.md delete mode 100644 docs/_guide/wallets/private-keys.md delete mode 100644 docs/_guide/wallets/signing.md delete mode 100644 docs/_guide/wallets/test-wallets.md delete mode 100644 docs/_guide/wallets/transferring-assets.md delete mode 100644 docs/_includes/js/custom.js delete mode 100644 docs/_sass/color_schemes/fuel-dark.scss delete mode 100644 docs/_sass/color_schemes/pygments-tomorrow-night.scss delete mode 100644 docs/_sass/custom/custom.scss delete mode 100644 docs/assets/fuels-ts-logo-dark.png delete mode 100644 docs/assets/fuels-ts-logo-light.png delete mode 100644 docs/assets/fuels-ts-logo.png delete mode 100644 docs/favicon.ico delete mode 100644 docs/guide/abi-typegen/generating-types-from-abi.md delete mode 100644 docs/guide/abi-typegen/index.md delete mode 100644 docs/guide/abi-typegen/using-generated-types.md delete mode 100644 docs/guide/contracts/call-parameters.md delete mode 100644 docs/guide/contracts/calling-external-contracts.md delete mode 100644 docs/guide/contracts/calls-with-different-wallets.md delete mode 100644 docs/guide/contracts/cost-estimation.md delete mode 100644 docs/guide/contracts/deploying-contracts.md delete mode 100644 docs/guide/contracts/index.md delete mode 100644 docs/guide/contracts/interacting-with-contracts.md delete mode 100644 docs/guide/contracts/logs.md delete mode 100644 docs/guide/contracts/multicalls.md delete mode 100644 docs/guide/contracts/read-only-calls.md delete mode 100644 docs/guide/contracts/the-fuelvm-binary-file.md delete mode 100644 docs/guide/contracts/transaction-parameters.md delete mode 100644 docs/guide/contracts/variable-outputs.md delete mode 100644 docs/guide/cookbook/deposit-and-withdraw.md delete mode 100644 docs/guide/cookbook/index.md delete mode 100644 docs/guide/cookbook/transfer-all-assets.md delete mode 100644 docs/guide/glossary.md delete mode 100644 docs/guide/index.md delete mode 100644 docs/guide/local-docs.md delete mode 100644 docs/guide/messages/getting-a-message-proof.md delete mode 100644 docs/guide/messages/getting-all-resources.md delete mode 100644 docs/guide/messages/getting-messages.md delete mode 100644 docs/guide/messages/index.md delete mode 100644 docs/guide/predicates/index.md delete mode 100644 docs/guide/predicates/send-and-spend-funds-from-predicates.md delete mode 100644 docs/guide/providers/connecting-to-an-external-node.md delete mode 100644 docs/guide/providers/connection.md delete mode 100644 docs/guide/providers/index.md delete mode 100644 docs/guide/providers/querying-the-chain.md delete mode 100644 docs/guide/scripts/calling-a-script.md delete mode 100644 docs/guide/scripts/index.md delete mode 100644 docs/guide/scripts/instantiating-a-script.md delete mode 100644 docs/guide/testing/testing-with-jest.md delete mode 100644 docs/guide/types/address.md delete mode 100644 docs/guide/types/arrays.md delete mode 100644 docs/guide/types/asset-id.md delete mode 100644 docs/guide/types/bech32.md delete mode 100644 docs/guide/types/bits256.md delete mode 100644 docs/guide/types/bytes32.md delete mode 100644 docs/guide/types/contract-id.md delete mode 100644 docs/guide/types/conversion.md delete mode 100644 docs/guide/types/enums-and-options.md delete mode 100644 docs/guide/types/index.md delete mode 100644 docs/guide/types/string.md delete mode 100644 docs/guide/types/structs.md delete mode 100644 docs/guide/types/vectors.md delete mode 100644 docs/guide/wallets/encrypting-and-storing-wallets.md delete mode 100644 docs/guide/wallets/index.md delete mode 100644 docs/guide/wallets/mnemonic-wallet.md delete mode 100644 docs/guide/wallets/private-keys.md delete mode 100644 docs/guide/wallets/signing.md delete mode 100644 docs/guide/wallets/test-wallets.md delete mode 100644 docs/packages/README.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/ABI.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/AbiCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/ArrayCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/B256Coder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/B512Coder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/BooleanCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/ByteCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/Coder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/EnumCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/Fragment.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/FunctionFragment.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/Interface.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/NumberCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/StringCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/StructCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/TupleCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/U64Coder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/VecCoder.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/internal-BN.md delete mode 100644 docs/packages/fuel-ts-abi-coder/classes/internal-ParamType.md delete mode 100644 docs/packages/fuel-ts-abi-coder/index.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFragment.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFragmentType.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFunctionAttributeType.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiLogFragment.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbi.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentArgumentType.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentFunction.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentLoggedType.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentType.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/internal-AttributeType.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/internal-FragmentParams.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/internal-JsonFragmentType.md delete mode 100644 docs/packages/fuel-ts-abi-coder/interfaces/internal-ParamTypeProps.md delete mode 100644 docs/packages/fuel-ts-abi-coder/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-address/classes/Address.md delete mode 100644 docs/packages/fuel-ts-address/classes/internal-AbstractAccount.md delete mode 100644 docs/packages/fuel-ts-address/classes/internal-AbstractAddress.md delete mode 100644 docs/packages/fuel-ts-address/classes/internal-AbstractContract.md delete mode 100644 docs/packages/fuel-ts-address/classes/internal-AbstractProgram.md delete mode 100644 docs/packages/fuel-ts-address/index.md delete mode 100644 docs/packages/fuel-ts-address/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-constants/index.md delete mode 100644 docs/packages/fuel-ts-contract/classes/ContractFactory.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-AbstractAccount.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-AbstractAddress.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-AbstractContract.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-AbstractProgram.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-AbstractScriptRequest.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-Account.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-BN.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-BaseTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-CreateTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-ScriptTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-contract/classes/internal-TransactionResponse.md delete mode 100644 docs/packages/fuel-ts-contract/enums/internal-GqlCoinStatus.md delete mode 100644 docs/packages/fuel-ts-contract/enums/internal-GqlMessageStatus.md delete mode 100644 docs/packages/fuel-ts-contract/enums/internal-GqlReturnType.md delete mode 100644 docs/packages/fuel-ts-contract/enums/internal-TransactionType.md delete mode 100644 docs/packages/fuel-ts-contract/index.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-BaseTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-CreateTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFragment.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFragmentType.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFunctionAttributeType.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbi.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentArgumentType.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentFunction.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentLoggedType.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentType.md delete mode 100644 docs/packages/fuel-ts-contract/interfaces/internal-ScriptTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-contract/namespaces/ContractUtils.md delete mode 100644 docs/packages/fuel-ts-contract/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-hasher/classes/internal-BN.md delete mode 100644 docs/packages/fuel-ts-hasher/index.md delete mode 100644 docs/packages/fuel-ts-hasher/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-hasher/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-hasher/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-hasher/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-hasher/interfaces/internal-BaseTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-hasher/interfaces/internal-CreateTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-hasher/interfaces/internal-ScriptTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-hasher/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-hdwallet/classes/HDWallet.md delete mode 100644 docs/packages/fuel-ts-hdwallet/index.md delete mode 100644 docs/packages/fuel-ts-hdwallet/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-interfaces/classes/AbstractAccount.md delete mode 100644 docs/packages/fuel-ts-interfaces/classes/AbstractAddress.md delete mode 100644 docs/packages/fuel-ts-interfaces/classes/AbstractContract.md delete mode 100644 docs/packages/fuel-ts-interfaces/classes/AbstractPredicate.md delete mode 100644 docs/packages/fuel-ts-interfaces/classes/AbstractProgram.md delete mode 100644 docs/packages/fuel-ts-interfaces/classes/AbstractScript.md delete mode 100644 docs/packages/fuel-ts-interfaces/classes/AbstractScriptRequest.md delete mode 100644 docs/packages/fuel-ts-interfaces/index.md delete mode 100644 docs/packages/fuel-ts-keystore/index.md delete mode 100644 docs/packages/fuel-ts-keystore/interfaces/Keystore.md delete mode 100644 docs/packages/fuel-ts-math/classes/BN.md delete mode 100644 docs/packages/fuel-ts-math/index.md delete mode 100644 docs/packages/fuel-ts-math/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-math/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-math/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-math/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-math/namespaces/bn.md delete mode 100644 docs/packages/fuel-ts-math/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-merkle-shared/index.md delete mode 100644 docs/packages/fuel-ts-merkle/classes/internal-Node.md delete mode 100644 docs/packages/fuel-ts-merkle/index.md delete mode 100644 docs/packages/fuel-ts-merkle/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-merklesum/classes/internal-Node.md delete mode 100644 docs/packages/fuel-ts-merklesum/classes/internal-Proof.md delete mode 100644 docs/packages/fuel-ts-merklesum/index.md delete mode 100644 docs/packages/fuel-ts-merklesum/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-mnemonic/classes/Mnemonic.md delete mode 100644 docs/packages/fuel-ts-mnemonic/index.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/Predicate.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-AbstractAccount.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-AbstractAddress.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-AbstractContract.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-AbstractProgram.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-AbstractScriptRequest.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-Account.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-BN.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-BaseTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-CreateTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-ScriptTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-predicate/classes/internal-TransactionResponse.md delete mode 100644 docs/packages/fuel-ts-predicate/enums/internal-GqlCoinStatus.md delete mode 100644 docs/packages/fuel-ts-predicate/enums/internal-GqlMessageStatus.md delete mode 100644 docs/packages/fuel-ts-predicate/enums/internal-GqlReturnType.md delete mode 100644 docs/packages/fuel-ts-predicate/enums/internal-TransactionType.md delete mode 100644 docs/packages/fuel-ts-predicate/index.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-BaseTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-CreateTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFragment.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFragmentType.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFunctionAttributeType.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbi.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentArgumentType.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentFunction.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentLoggedType.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentType.md delete mode 100644 docs/packages/fuel-ts-predicate/interfaces/internal-ScriptTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-predicate/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-program/classes/Contract.md delete mode 100644 docs/packages/fuel-ts-program/classes/FunctionInvocationResult.md delete mode 100644 docs/packages/fuel-ts-program/classes/FunctionInvocationScope.md delete mode 100644 docs/packages/fuel-ts-program/classes/InvocationResult.md delete mode 100644 docs/packages/fuel-ts-program/classes/MultiCallInvocationScope.md delete mode 100644 docs/packages/fuel-ts-program/classes/ScriptRequest.md delete mode 100644 docs/packages/fuel-ts-program/classes/ScriptResultDecoderError.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-AbstractAccount.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-AbstractAddress.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-AbstractContract.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-AbstractProgram.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-AbstractScriptRequest.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-Account.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-BN.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-BaseInvocationScope.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-BaseTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-CreateTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-InvocationCallResult.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-ScriptTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-program/classes/internal-TransactionResponse.md delete mode 100644 docs/packages/fuel-ts-program/enums/internal-GqlCoinStatus.md delete mode 100644 docs/packages/fuel-ts-program/enums/internal-GqlMessageStatus.md delete mode 100644 docs/packages/fuel-ts-program/enums/internal-GqlReturnType.md delete mode 100644 docs/packages/fuel-ts-program/enums/internal-TransactionType.md delete mode 100644 docs/packages/fuel-ts-program/index.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/InvokeFunctions.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-BaseTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-CreateTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFragment.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFragmentType.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFunctionAttributeType.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbi.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentArgumentType.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentFunction.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentLoggedType.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentType.md delete mode 100644 docs/packages/fuel-ts-program/interfaces/internal-ScriptTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-program/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-providers/classes/ChangeOutputCollisionError.md delete mode 100644 docs/packages/fuel-ts-providers/classes/CreateTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-providers/classes/NoWitnessAtIndexError.md delete mode 100644 docs/packages/fuel-ts-providers/classes/NoWitnessByOwnerError.md delete mode 100644 docs/packages/fuel-ts-providers/classes/Provider.md delete mode 100644 docs/packages/fuel-ts-providers/classes/ScriptTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-providers/classes/TransactionResponse.md delete mode 100644 docs/packages/fuel-ts-providers/classes/internal-AbstractAccount.md delete mode 100644 docs/packages/fuel-ts-providers/classes/internal-AbstractAddress.md delete mode 100644 docs/packages/fuel-ts-providers/classes/internal-AbstractContract.md delete mode 100644 docs/packages/fuel-ts-providers/classes/internal-AbstractProgram.md delete mode 100644 docs/packages/fuel-ts-providers/classes/internal-AbstractScriptRequest.md delete mode 100644 docs/packages/fuel-ts-providers/classes/internal-BN.md delete mode 100644 docs/packages/fuel-ts-providers/classes/internal-BaseTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-providers/enums/CoinStatus.md delete mode 100644 docs/packages/fuel-ts-providers/enums/MessageStatus.md delete mode 100644 docs/packages/fuel-ts-providers/enums/TransactionType.md delete mode 100644 docs/packages/fuel-ts-providers/enums/internal-GqlReturnType.md delete mode 100644 docs/packages/fuel-ts-providers/index.md delete mode 100644 docs/packages/fuel-ts-providers/interfaces/CreateTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-providers/interfaces/ScriptTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-providers/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-providers/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-providers/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-providers/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-providers/interfaces/internal-BaseTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-providers/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-signer/classes/Signer.md delete mode 100644 docs/packages/fuel-ts-signer/index.md delete mode 100644 docs/packages/fuel-ts-sparsemerkle/classes/default.md delete mode 100644 docs/packages/fuel-ts-sparsemerkle/classes/internal-SparseCompactMerkleProof.md delete mode 100644 docs/packages/fuel-ts-sparsemerkle/classes/internal-SparseMerkleProof.md delete mode 100644 docs/packages/fuel-ts-sparsemerkle/index.md delete mode 100644 docs/packages/fuel-ts-sparsemerkle/interfaces/internal-MapStore.md delete mode 100644 docs/packages/fuel-ts-sparsemerkle/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ByteArrayCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/InputCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/InputCoinCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/InputContractCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/InputMessageCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/OutputChangeCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/OutputCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/OutputCoinCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/OutputContractCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/OutputContractCreatedCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/OutputMessageCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/OutputVariableCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptCallCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptLogCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptLogDataCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptMessageOutCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptPanicCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptReturnCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptReturnDataCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptRevertCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptScriptResultCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptTransferCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/ReceiptTransferOutCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/StorageSlotCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/TransactionCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/TransactionCreateCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/TransactionMintCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/TransactionScriptCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/TxPointerCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/UtxoIdCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/WitnessCoder.md delete mode 100644 docs/packages/fuel-ts-transactions/classes/internal-BN.md delete mode 100644 docs/packages/fuel-ts-transactions/enums/InputType.md delete mode 100644 docs/packages/fuel-ts-transactions/enums/OutputType.md delete mode 100644 docs/packages/fuel-ts-transactions/enums/ReceiptType.md delete mode 100644 docs/packages/fuel-ts-transactions/enums/TransactionType.md delete mode 100644 docs/packages/fuel-ts-transactions/index.md delete mode 100644 docs/packages/fuel-ts-transactions/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-transactions/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-transactions/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-transactions/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-transactions/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/StorageAbstract.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/Vault.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/WalletManager.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractAccount.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractAddress.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractContract.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractProgram.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractScriptRequest.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-Account.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-BN.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-BaseTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-BaseWalletUnlocked.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-CreateTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-MnemonicVault.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-PrivateKeyVault.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-ScriptTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-Signer.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-TransactionResponse.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-WalletLocked.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/classes/internal-WalletUnlocked.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/enums/internal-GqlCoinStatus.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/enums/internal-GqlMessageStatus.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/enums/internal-GqlReturnType.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/enums/internal-TransactionType.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/index.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/WalletManagerState.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-BaseTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-CreateTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-GenerateOptions.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-MnemonicVaultOptions.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-PkVaultOptions.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/interfaces/internal-ScriptTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-wallet-manager/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/Account.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/BaseWalletUnlocked.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/Wallet.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/WalletLocked.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/WalletUnlocked.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-AbstractAccount.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-AbstractAddress.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-AbstractContract.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-AbstractProgram.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-AbstractScriptRequest.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-BN.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-BaseTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-CreateTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-ScriptTransactionRequest.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-Signer.md delete mode 100644 docs/packages/fuel-ts-wallet/classes/internal-TransactionResponse.md delete mode 100644 docs/packages/fuel-ts-wallet/enums/internal-GqlCoinStatus.md delete mode 100644 docs/packages/fuel-ts-wallet/enums/internal-GqlMessageStatus.md delete mode 100644 docs/packages/fuel-ts-wallet/enums/internal-GqlReturnType.md delete mode 100644 docs/packages/fuel-ts-wallet/enums/internal-TransactionType.md delete mode 100644 docs/packages/fuel-ts-wallet/index.md delete mode 100644 docs/packages/fuel-ts-wallet/interfaces/internal-BNHelper.md delete mode 100644 docs/packages/fuel-ts-wallet/interfaces/internal-BNHiddenTypes.md delete mode 100644 docs/packages/fuel-ts-wallet/interfaces/internal-BNInputOverrides.md delete mode 100644 docs/packages/fuel-ts-wallet/interfaces/internal-BNOverrides.md delete mode 100644 docs/packages/fuel-ts-wallet/interfaces/internal-BaseTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-wallet/interfaces/internal-CreateTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-wallet/interfaces/internal-GenerateOptions.md delete mode 100644 docs/packages/fuel-ts-wallet/interfaces/internal-ScriptTransactionRequestLike.md delete mode 100644 docs/packages/fuel-ts-wallet/namespaces/internal.md delete mode 100644 docs/packages/fuel-ts-wordlists/enums/Language.md delete mode 100644 docs/packages/fuel-ts-wordlists/index.md diff --git a/.changeset/famous-spies-applaud.md b/.changeset/famous-spies-applaud.md new file mode 100644 index 00000000000..42e2ac751c0 --- /dev/null +++ b/.changeset/famous-spies-applaud.md @@ -0,0 +1,11 @@ +--- +"@fuel-ts/docs": minor +"@fuel-ts/example-contract": minor +"@fuel-ts/interfaces": minor +"@fuel-ts/providers": minor +"@fuel-ts/script": minor +"@fuel-ts/versions": minor +"@fuel-ts/wallet": minor +--- + +switch docs engine from jekyll to vitepress diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 56adff29300..8c5c61b8742 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -11,6 +11,13 @@ jobs: release: name: "Release" runs-on: ubuntu-latest + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: - name: Checkout uses: actions/checkout@v3 @@ -45,7 +52,7 @@ jobs: uses: FuelLabs/changesets-action@main with: publish: pnpm changeset:publish - version: pnpm changeset:version-with-docs + version: pnpm changeset version commit: "ci(changesets): versioning packages" title: "ci(changesets): versioning packages" createGithubReleases: aggregate @@ -66,3 +73,13 @@ jobs: env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - uses: actions/configure-pages@v2 + - uses: actions/upload-pages-artifact@v1 + with: + path: apps/docs/dist + + - name: Deploy Docs + if: steps.changesets.outputs.published == 'true' + id: deployment + uses: actions/deploy-pages@v1 diff --git a/.prettierignore b/.prettierignore index e2a12a7ce9d..019d298e971 100644 --- a/.prettierignore +++ b/.prettierignore @@ -4,6 +4,7 @@ coverage node_modules docs/examples/ /packages/example-contract/src/example-contract-types/ +/packages/apps/docs/.vitepress/cache/ __generated__ out diff --git a/apps/docs/.gitignore b/apps/docs/.gitignore new file mode 100644 index 00000000000..4f2fc4ac0ef --- /dev/null +++ b/apps/docs/.gitignore @@ -0,0 +1 @@ +.vitepress/cache diff --git a/apps/docs/.vitepress/config.ts b/apps/docs/.vitepress/config.ts new file mode 100644 index 00000000000..2f47b5926f5 --- /dev/null +++ b/apps/docs/.vitepress/config.ts @@ -0,0 +1,311 @@ +import { defineConfig } from 'vitepress'; +import { codeInContextPlugin } from './plugins/codeInContextPlugin'; +import { snippetPlugin } from './plugins/snippetPlugin'; + +export default defineConfig({ + title: 'Fuels-ts', + description: 'FuelLabs Typescript SDK', + base: '/fuels-ts/', + srcDir: 'src', + outDir: 'dist', + lang: 'en-US', + appearance: 'dark', + markdown: { + config: (md) => { + md.use(snippetPlugin); + md.use(codeInContextPlugin); + md.block.ruler.disable('snippet'); + }, + }, + head: [ + ['link', { rel: 'icon', href: 'favicon.ico', type: 'image/png' }], + ['meta', { property: 'og:type', content: 'website' }], + ['meta', { property: 'og:url', content: 'https://fuellabs.github.io/fuels-ts/' }], + ], + themeConfig: { + logo: 'fuel-logo.png', + nav: [ + { + text: 'Home', + link: '/', + }, + ], + socialLinks: [ + { icon: 'github', link: 'https://github.com/FuelLabs/fuels-ts' }, + { icon: 'twitter', link: 'https://twitter.com/fuel_network' }, + { icon: 'discord', link: 'https://discord.com/invite/xfpK4Pe' }, + ], + sidebar: [ + { + text: 'Introduction', + link: '/', + items: [ + { + text: 'Glossary', + link: '/glossary', + }, + ], + }, + { + text: 'Guide', + link: '/guide/', + items: [ + { + text: 'Types', + link: '/guide/types/', + collapsed: true, + items: [ + { + text: 'Address', + link: '/guide/types/address', + }, + { + text: 'Arrays', + link: '/guide/types/arrays', + }, + { + text: 'Asset Id', + link: '/guide/types/asset-id', + }, + { + text: 'Bech32', + link: '/guide/types/bech32', + }, + { + text: 'Bits256', + link: '/guide/types/bits256', + }, + { + text: 'Bytes32', + link: '/guide/types/bytes32', + }, + { + text: 'Contract Id', + link: '/guide/types/contract-id', + }, + { + text: 'Conversion', + link: '/guide/types/conversion', + }, + { + text: 'Enums and Options', + link: '/guide/types/enums-and-options', + }, + { + text: 'String', + link: '/guide/types/string', + }, + { + text: 'Structs', + link: '/guide/types/structs', + }, + { + text: 'Vectors', + link: '/guide/types/vectors', + }, + ], + }, + { + text: 'Abi Typegen', + link: '/guide/abi-typegen/', + collapsed: true, + items: [ + { + text: 'Generate Contract Types', + link: '/guide/abi-typegen/generate-contract-types-from-abi', + }, + { + text: 'Using Generated Types', + link: '/guide/abi-typegen/using-generated-types', + }, + ], + }, + { + text: 'Wallets', + link: '/guide/wallets/', + collapsed: true, + items: [ + { + text: 'Access', + link: '/guide/wallets/access', + }, + { + text: 'Checking Balances And Coins', + link: '/guide/wallets/checking-balances-and-coins', + }, + { + text: 'Encrypting And Storing Wallets', + link: '/guide/wallets/encrypting-and-storing-wallets', + }, + { + text: 'Mnemonic Wallet', + link: '/guide/wallets/mnemonic-wallet', + }, + { + text: 'Private Keys', + link: '/guide/wallets/private-keys', + }, + { + text: 'Signing', + link: '/guide/wallets/signing', + }, + { + text: 'Test Wallets', + link: '/guide/wallets/test-wallets', + }, + { + text: 'Transferring Assets', + link: '/guide/wallets/transferring-assets', + }, + ], + }, + { + text: 'Providers', + link: '/guide/providers/', + collapsed: true, + items: [ + { + text: 'Connection', + link: '/guide/providers/connection', + }, + { + text: 'Connecting to an External Node', + link: '/guide/providers/connecting-to-an-external-node', + }, + { + text: 'Querying the Chain', + link: '/guide/providers/querying-the-chain', + }, + ], + }, + { + text: 'Contracts', + link: '/guide/contracts/', + collapsed: true, + items: [ + { + text: 'Interacting With Contracts', + link: '/guide/contracts/interacting-with-contracts', + }, + { + text: 'Read Only Calls', + link: '/guide/contracts/read-only-calls', + }, + { + text: 'Multicalls', + link: '/guide/contracts/multicalls', + }, + { + text: 'Cost Estimation', + link: '/guide/contracts/cost-estimation', + }, + { + text: 'Transaction Parameters', + link: '/guide/contracts/transaction-parameters', + }, + { + text: 'Call Parameters', + link: '/guide/contracts/call-parameters', + }, + { + text: 'Calling External Contracts', + link: '/guide/contracts/calling-external-contracts', + }, + { + text: 'Calls With Different Wallets', + link: '/guide/contracts/calls-with-different-wallets', + }, + { + text: 'Logs', + link: '/guide/contracts/logs', + }, + { + text: 'Variables Outputs', + link: '/guide/contracts/variable-outputs', + }, + { + text: 'The Fuelvm Binary File', + link: '/guide/contracts/the-fuelvm-binary-file', + }, + { + text: 'Deploying Contracts', + link: '/guide/contracts/deploying-contracts', + }, + ], + }, + { + text: 'Cookbook', + link: '/guide/cookbook/', + collapsed: true, + items: [ + { + text: 'Deposit And Withdraw', + link: '/guide/cookbook/deposit-and-withdraw', + }, + { + text: 'Transfer All Assets', + link: '/guide/cookbook/transfer-all-assets', + }, + ], + }, + { + text: 'Predicates', + link: '/guide/predicates/', + collapsed: true, + items: [ + { + text: 'Send And Spend Funds From Predicates', + link: '/guide/predicates/send-and-spend-funds-from-predicates', + }, + ], + }, + { + text: 'Scripts', + link: '/guide/scripts/', + collapsed: true, + items: [ + { + text: 'Instantiating A Script', + link: '/guide/scripts/instantiating-a-script', + }, + { + text: 'Calling A Script', + link: '/guide/scripts/calling-a-script', + }, + ], + }, + { + text: 'Testing', + link: '/guide/testing/', + collapsed: true, + items: [ + { + text: 'Testing with Jest', + link: '/guide/testing/testing-with-jest', + }, + ], + }, + { + text: 'Messages', + link: '/guide/messages/', + collapsed: true, + items: [ + { + text: 'Getting a Message Proof', + link: '/guide/messages/getting-a-message-proof', + }, + { + text: 'Getting All Resources', + link: '/guide/messages/getting-all-resources', + }, + { + text: 'Getting Messages', + link: '/guide/messages/getting-messages', + }, + ], + }, + ], + }, + ], + }, +}); diff --git a/apps/docs/.vitepress/plugins/codeInContextPlugin.ts b/apps/docs/.vitepress/plugins/codeInContextPlugin.ts new file mode 100644 index 00000000000..42df472d7c9 --- /dev/null +++ b/apps/docs/.vitepress/plugins/codeInContextPlugin.ts @@ -0,0 +1,51 @@ +import MarkdownIt from 'markdown-it'; +import Token from 'markdown-it/lib/token'; + +type CustomTokem = Token & { url?: string }; + +export function codeInContextPlugin(md: MarkdownIt) { + md.core.ruler.after('inline', 'add-anchor-link', (state) => { + let newTokens: CustomTokem[] = []; + + state.tokens.forEach((token: CustomTokem, index) => { + newTokens.push(token); + + if (token.type === 'fence' && token.tag === 'code' && token.url) { + const { url } = token; + + /** + * Extracting 'url' prop inserted by "snippetPlugin" and creating + * "See code in context" link after code snippet. + */ + const anchorToken = new Token('html_inline', '', 0); + anchorToken.content = `See code in context + `; + + newTokens.push(anchorToken); + + let shouldAddDivider = true; + + if (index + 1 >= state.tokens.length) { + shouldAddDivider = false; + } else { + const nextToken = state.tokens[index + 1]; + + if (nextToken && /h2/.test(nextToken.tag)) { + shouldAddDivider = false; + } + } + + if (shouldAddDivider) { + const divisorToken = new Token('hr', 'hr', 0); + divisorToken.markup = '---'; + newTokens.push(divisorToken); + } + } + }); + + state.tokens = newTokens; + }); +} diff --git a/apps/docs/.vitepress/plugins/snippetPlugin.ts b/apps/docs/.vitepress/plugins/snippetPlugin.ts new file mode 100644 index 00000000000..9b3114f9d7f --- /dev/null +++ b/apps/docs/.vitepress/plugins/snippetPlugin.ts @@ -0,0 +1,153 @@ +import MarkdownIt from 'markdown-it'; +import path from 'path'; +import fs from 'fs'; +import { RuleBlock } from 'markdown-it/lib/parser_block'; + +function dedent(text: string): string { + const lines = text.split('\n'); + + const minIndentLength = lines.reduce((acc, line) => { + for (let i = 0; i < line.length; i++) { + if (line[i] !== ' ' && line[i] !== '\t') return Math.min(i, acc); + } + return acc; + }, Infinity); + + if (minIndentLength < Infinity) { + return lines + .map((x) => { + if (/\/\/\s\#context\s/.test(x)) { + x = x.replace(/\/\/\s\#context\s/, ''); + } + + return x.slice(minIndentLength); + }) + .join('\n'); + } + + return text; +} + +function testLine(line: string, regexp: RegExp, regionName: string, end: boolean = false) { + const [full, tag, name] = regexp.exec(line.trim()) || []; + + return ( + full && tag && name === regionName && tag.match(end ? /^[Ee]nd ?[rR]egion$/ : /^[rR]egion$/) + ); +} + +function findRegion(lines: Array, regionName: string) { + const regexp = /^\/\/ ?#?((?:end)?region) ([\w*-]+)$/; + + let start = -1; + for (const [lineId, line] of lines.entries()) { + if (start === -1) { + if (testLine(line, regexp, regionName)) { + start = lineId + 1; + } + } else if (testLine(line, regexp, regionName, true)) { + return { start, end: lineId, regexp }; + } + } + + return null; +} + +export const snippetPlugin = (md: MarkdownIt, srcDir: string) => { + const parser: RuleBlock = (state, startLine, endLine, silent) => { + const CH = '<'.charCodeAt(0); + const pos = state.bMarks[startLine] + state.tShift[startLine]; + const max = state.eMarks[startLine]; + + // if it's indented more than 3 spaces, it should be a code block + if (state.sCount[startLine] - state.blkIndent >= 4) { + return false; + } + + for (let i = 0; i < 3; ++i) { + const ch = state.src.charCodeAt(pos + i); + if (ch !== CH || pos + i >= max) return false; + } + + if (silent) { + return true; + } + + try { + // Extracting code details snippet from import signature at markdown file + const start = pos + 3; + const end = state.skipSpacesBack(max, pos); + + const rawPathRegexp = + /^(.+(?:\.([a-z0-9]+)))(?:(#[\w-]+))?(?: ?(?:{(\d+(?:[,-]\d+)*)? ?(\S+)?}))? ?(?:\[(.+)\])?$/; + + const rawPath = state.src.slice(start, end).trim().replace(/^@/, srcDir).trim(); + + const [ + snippetFilename = '', + snippetExtension = '', + snippetRegion = '', + snippetLines = '', + snippetLang = '', + snippetRawTitle = '', + ] = (rawPathRegexp.exec(rawPath) || []).slice(1); + + // Reading actuall code snippet from file + const customSrc = path.resolve(snippetFilename) + snippetRegion; + + const [filepath, regionName] = customSrc.split('#'); + + const isAFile = fs.existsSync(filepath) && fs.lstatSync(filepath).isFile(); + + if (!isAFile) { + throw new Error(`File ${filepath} does not exist`); + } + + let content = fs.readFileSync(filepath, 'utf8'); + + const lines = content.split(/\r?\n/); + const region = findRegion(lines, regionName); + + if (!region) { + throw new Error(`Region ${regionName} does not exist in file ${filepath}`); + } + + content = dedent( + lines + .slice(region.start, region.end) + .filter((line: string) => !region.regexp.test(line.trim())) + .join('\n') + ); + + const [, partialPath] = filepath.split(/(packages\/.*)/); + + const url = 'https://github.com/FuelLabs/fuels-ts/blob/master/' + .concat(`${partialPath}`) + .concat(`#L${region.start}-L${++region.end}`); + + // Creating markdown token with code snippet content and adding to state + const title = snippetRawTitle || snippetFilename.split('/').pop() || ''; + + state.line = startLine + 1; + + const token = state.push('fence', 'code', 0); + + Object.assign(token, { + url, // Adding url to github file with code snippet + content, + customSrc: path.resolve(snippetFilename) + snippetRegion, + markup: '```', + map: [startLine, startLine + 1], + info: `${snippetLang || snippetExtension}${snippetLines ? `{${snippetLines}}` : ''}${ + title ? `[${title}]` : '' + }`, + }); + } catch (e) { + throw new Error(`Error while parsing snippet: ${e.message}`); + } + + return true; + }; + + md.block.ruler.before('fence', 'customSnippet', parser); +}; diff --git a/apps/docs/.vitepress/theme/components/LogoComponent.vue b/apps/docs/.vitepress/theme/components/LogoComponent.vue new file mode 100644 index 00000000000..e6afdd8a63a --- /dev/null +++ b/apps/docs/.vitepress/theme/components/LogoComponent.vue @@ -0,0 +1,52 @@ + + + + + diff --git a/apps/docs/.vitepress/theme/index.ts b/apps/docs/.vitepress/theme/index.ts new file mode 100644 index 00000000000..75901dc918c --- /dev/null +++ b/apps/docs/.vitepress/theme/index.ts @@ -0,0 +1,11 @@ +import DefaultTheme from 'vitepress/theme'; +// @ts-ignore +import LogoComponent from './components/LogoComponent.vue'; +import './styles/custom.css'; + +export default { + ...DefaultTheme, + enhanceApp({ app }) { + app.component('LogoComponent', LogoComponent); + }, +}; diff --git a/apps/docs/.vitepress/theme/styles/custom.css b/apps/docs/.vitepress/theme/styles/custom.css new file mode 100644 index 00000000000..d7bffa5e11f --- /dev/null +++ b/apps/docs/.vitepress/theme/styles/custom.css @@ -0,0 +1,101 @@ +.VPNavBarSearch { + margin-right: auto; +} + +.VPNavBarTitle .title { + font-size: 1.3rem !important; +} + +.vp-doc hr { + height: 1px; + padding: 0; + margin: 2rem 0; + background-color: var(--vp-c-divider); + border: 0; +} + +.anchor-link { + position: relative; +} + +.anchor-link::before { + content: "#"; + position: absolute; + left: -0.2rem; + opacity: 0; + transform: translateX(-100%); + transition: color 0.25s, opacity 0.25s; + color: var(--vp-c-brand); +} + +.anchor-link:hover::before { + opacity: 1; +} + +/* Search Plugin Custom CSS */ +.DocSearch { + border-radius: 8px; + display: flex; + gap: 16px; + align-items: center; +} + +.DocSearch-Button { + margin: 0; + height: 2.5rem; + padding: 0 0.75rem; + background: var(--vp-sidebar-bg-color); + border: 1px solid transparent; + transition: border 0.25s; +} + +.DocSearch-Button:hover { + background: var(--vp-sidebar-bg-color); + border: 1px solid var(--vp-c-brand); +} + +.DocSearch-Button-Placeholder { + margin: 0; + padding: 0; + color: var(--vp-c-text-1); +} + +.DocSearch-Button-Container { + margin: 0; + display: flex; + align-items: center; +} + +.DocSearch-Search-Icon { + margin: 0; +} + +.DocSearch-Button-Keys { + min-width: unset; + align-items: center; + border: 1px solid var(--vp-c-divider); + border-radius: 4px; +} + +.search-list > div { + margin-bottom: 1rem; +} + +.search-list div span { + font-size: 0.875rem; +} + +.flex-logo { + margin-top: 1rem; +} + +@media (max-width: 768px) { + .DocSearch { + gap: 0; + } + + .flex-logo { + max-width: 80%; + border-radius: inherit; + } +} diff --git a/apps/docs/package.json b/apps/docs/package.json new file mode 100644 index 00000000000..7ebdd1be481 --- /dev/null +++ b/apps/docs/package.json @@ -0,0 +1,24 @@ +{ + "name": "@fuel-ts/docs", + "version": "1.0.0", + "description": "", + "scripts": { + "dev": "vitepress dev", + "build": "vitepress build", + "preview": "vitepress preview" + }, + "keywords": [], + "author": "", + "license": "ISC", + "dependencies": { + "@fuel-ts/versions": "workspace:*" + }, + "devDependencies": { + "@types/markdown-it": "^12.2.3", + "flexsearch": "^0.7.31", + "markdown-it": "^13.0.1", + "vitepress": "1.0.0-alpha.51", + "vitepress-plugin-search": "1.0.4-alpha.19", + "vue": "^3.2.47" + } +} diff --git a/docs/_guide/glossary.md b/apps/docs/src/glossary.md similarity index 100% rename from docs/_guide/glossary.md rename to apps/docs/src/glossary.md diff --git a/apps/docs/src/guide/abi-typegen/generate-contract-types-from-abi.md b/apps/docs/src/guide/abi-typegen/generate-contract-types-from-abi.md new file mode 100644 index 00000000000..efebe4e48b0 --- /dev/null +++ b/apps/docs/src/guide/abi-typegen/generate-contract-types-from-abi.md @@ -0,0 +1,20 @@ +# Generate Contract Types from ABI + +See also [types](../types/). + +#### Dependencies + +```sh +yarn add fuels +``` + +#### Generate Types + +```sh +yarn exec fuels -i ./abis/*-abi.json -o ./types +``` + +Note: + +- `-i`: the relative path/global to the ABI JSON file(s) +- `-o`: the output directory for the generated types diff --git a/apps/docs/src/guide/abi-typegen/index.md b/apps/docs/src/guide/abi-typegen/index.md new file mode 100644 index 00000000000..ae46eafbac3 --- /dev/null +++ b/apps/docs/src/guide/abi-typegen/index.md @@ -0,0 +1,51 @@ + + +# ABI Typegen + +## The JSON ABI file + +Whether you want to deploy or connect to a pre-existing smart contract, the JSON ABI file is extremely important: it's what tells the SDK about the ABI methods in your smart contracts. + +For the same example Sway code as above: + +```rust:line-numbers +contract; + +abi MyContract { + fn test_function() -> bool; +} + +impl MyContract for Contract { + fn test_function() -> bool { + true + } +} +``` + +The JSON ABI file looks like this: + +```json +$ cat out/debug/my-test-abi.json +[ + { + "type": "function", + "inputs": [], + "name": "test_function", + "outputs": [ + { + "name": "", + "type": "bool", + "components": null + } + ] + } +] +``` + +The Fuel TypeScript SDK will take this file as input and generate equivalent methods (and custom types if applicable) that you can call from your TypeScript code. diff --git a/apps/docs/src/guide/abi-typegen/using-generated-types.md b/apps/docs/src/guide/abi-typegen/using-generated-types.md new file mode 100644 index 00000000000..b97da203115 --- /dev/null +++ b/apps/docs/src/guide/abi-typegen/using-generated-types.md @@ -0,0 +1,16 @@ +# Using Generated Types + +See also [Generate Contract Types from ABI](./generate-contract-types-from-abi.md). + +```ts:line-numbers +import { Wallet } from "fuels"; +import { MyContract__factory } from "./types"; + +const contractId = "0x..."; +const wallet = new Wallet("0x..."); +const contract = MyContract__factory.connect(contractId, wallet); + +// All contract methods are available under functions with the correct types +const { transactionId, value } = await contract.functions.my_fn(1n).call(); +console.log(transactionId, value); +``` diff --git a/docs/_guide/contracts/call-parameters.md b/apps/docs/src/guide/contracts/call-parameters.md similarity index 72% rename from docs/_guide/contracts/call-parameters.md rename to apps/docs/src/guide/contracts/call-parameters.md index d129f36910e..1bead880ede 100644 --- a/docs/_guide/contracts/call-parameters.md +++ b/apps/docs/src/guide/contracts/call-parameters.md @@ -1,5 +1,3 @@ -[nav_order: 6] - # Call parameters Call parameters are: @@ -11,14 +9,17 @@ Call parameters are: You can use these to forward coins to a contract. You can configure these parameters by creating an instance of `CallParams` and passing it to a chain method called `callParams`. At a basic level we can invoke the `callParams` method as part of the transaction flow to set these params: -[@code:typescript](./packages/fuel-gauge/src/call-test-contract.test.ts#typedoc:Contract-call-params) + +<<< @/../../../packages/fuel-gauge/src/call-test-contract.test.ts#Contract-call-params{ts:line-numbers} Here we set call params alongside [transaction parameters](./transaction-parameters.md): -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-call-params-with-tx-params) + +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-call-params-with-tx-params{ts:line-numbers} The `forward` parameter defines the limit for the actual contract call as opposed to the gas limit for the whole transaction. This means that it is constrained by the transaction limit. If it is set to an amount greater than the available gas, all available gas will be forwarded. ## Multicall with multiple call parameters Here we set call params as part of a [Multicall](./multicalls.md) -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-call-params-with-multicall) + +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-call-params-with-multicall{ts:line-numbers} diff --git a/docs/_guide/contracts/calling-external-contracts.md b/apps/docs/src/guide/contracts/calling-external-contracts.md similarity index 64% rename from docs/_guide/contracts/calling-external-contracts.md rename to apps/docs/src/guide/contracts/calling-external-contracts.md index a7cc8f388ac..9a9c20afdb4 100644 --- a/docs/_guide/contracts/calling-external-contracts.md +++ b/apps/docs/src/guide/contracts/calling-external-contracts.md @@ -1,7 +1,5 @@ -[nav_order: 7] - # Calling external contracts Your contract method might be calling other contracts. To do so, you must feed the external contract IDs that your contract depends on to the method you're calling. -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-call-others) +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-call-others{ts:line-numbers} diff --git a/docs/_guide/contracts/calls-with-different-wallets.md b/apps/docs/src/guide/contracts/calls-with-different-wallets.md similarity index 95% rename from docs/_guide/contracts/calls-with-different-wallets.md rename to apps/docs/src/guide/contracts/calls-with-different-wallets.md index 0c92f4ca05c..fa402c33708 100644 --- a/docs/_guide/contracts/calls-with-different-wallets.md +++ b/apps/docs/src/guide/contracts/calls-with-different-wallets.md @@ -1,16 +1,14 @@ -[nav_order: 8] - # Calls with different Wallets or Providers You can assign to a Contract's `wallet` property on an existing contract instance as a shorthand for creating a new instance connected to the provided wallet. This lets you make contracts calls with different wallets in a chain like fashion. -```typescript +```ts:line-numbers contract.wallet = Wallet.fromAddress(someAddress); ``` In a similar fashion, assigning a custom Provider allows you to utilize a Provider wrapper of your choosing or design. -```typescript +```ts:line-numbers contract.provider = customProvider; ``` diff --git a/docs/_guide/contracts/cost-estimation.md b/apps/docs/src/guide/contracts/cost-estimation.md similarity index 83% rename from docs/_guide/contracts/cost-estimation.md rename to apps/docs/src/guide/contracts/cost-estimation.md index 7fa855d7651..f9335c03526 100644 --- a/docs/_guide/contracts/cost-estimation.md +++ b/apps/docs/src/guide/contracts/cost-estimation.md @@ -1,10 +1,8 @@ -[nav_order: 4] - # Estimating contract call cost With the function `getTransactionCost` provided by the `provider`, you can get a cost estimation for a specific call. The return type, `TransactionCost`, is an object that contains relevant information for the estimation: -```typescript +```ts:line-numbers type TransactionCost = { minGasPrice: BN; gasPrice: BN; @@ -15,6 +13,6 @@ type TransactionCost = { Below are examples that show how to get the estimated transaction cost from single and multi call transactions. -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-cost) +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-cost{ts:line-numbers} The transaction cost estimation can be used to set the gas limit for an actual call, or to show the user the estimated cost. diff --git a/apps/docs/src/guide/contracts/deploying-contracts.md b/apps/docs/src/guide/contracts/deploying-contracts.md new file mode 100644 index 00000000000..5cd44926b90 --- /dev/null +++ b/apps/docs/src/guide/contracts/deploying-contracts.md @@ -0,0 +1,29 @@ + + +# Deploying contracts + +There are two main ways of working with contracts in the SDK: deploying a contract with SDK or using the SDK to interact with existing contracts. + +## Deploying a contract binary + +Once you've written a contract in Sway and compiled it with `forc build` (read here for more on how to work with Sway), you'll have in your hands two important artifacts: the compiled binary file and the JSON ABI file. + +Below is how you can deploy your contracts using the SDK. For more details about each component in this process, read about [the FuelVM binary file](./the-fuelvm-binary-file.md) and [the JSON ABI file](../abi-typegen/). + +### The deploy functions + +If you are only interested in a single instance of your contract, then use `deploy` + +<<< @/../../../packages/fuel-gauge/src/contract-factory.test.ts#contract-setup{ts:line-numbers} + +You can then use the contract methods very simply: + +```ts:line-numbers +const contact = await factory.deployContract(); +``` + +Also read about how to [generate-contract-types-from-abi](../abi-typegen/generate-contract-types-from-abi.md), allowing for rich TypeScript backed Fuel usage. diff --git a/docs/_guide/contracts/index.md b/apps/docs/src/guide/contracts/index.md similarity index 78% rename from docs/_guide/contracts/index.md rename to apps/docs/src/guide/contracts/index.md index 78404a14c35..78fe7f7d7e8 100644 --- a/docs/_guide/contracts/index.md +++ b/apps/docs/src/guide/contracts/index.md @@ -1,5 +1,3 @@ -[nav_order: 4] - # Calling contracts Once you've deployed your contract, as seen in the previous sections, you'll likely want to: @@ -11,9 +9,9 @@ Once you've deployed your contract, as seen in the previous sections, you'll lik Here's an example. Suppose your Sway contract has two ABI methods called `echo_str_8(str[8])` and `echo_u8(u8)`. Once you've deployed the contract, you can call the methods like this: -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:String-size8) +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#String-size8{ts:line-numbers} -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:U8) +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#U8{ts:line-numbers} The examples above uses all the default configurations and performs a simple contract call. diff --git a/docs/_guide/contracts/interacting-with-contracts.md b/apps/docs/src/guide/contracts/interacting-with-contracts.md similarity index 88% rename from docs/_guide/contracts/interacting-with-contracts.md rename to apps/docs/src/guide/contracts/interacting-with-contracts.md index 98206f52f76..b8b2778024c 100644 --- a/docs/_guide/contracts/interacting-with-contracts.md +++ b/apps/docs/src/guide/contracts/interacting-with-contracts.md @@ -1,14 +1,12 @@ -[nav_order: 1] - # Interacting with contracts If you already have a deployed contract and want to call its methods using the SDK, but without deploying it again, all you need is the contract ID of your deployed contract. You can skip the whole deployment setup and just start using it: -[@code:typescript](./packages/fuel-gauge/src/storage-test-contract.test.ts#typedoc:contract-with-id) +<<< @/../../../packages/fuel-gauge/src/storage-test-contract.test.ts#contract-with-id{ts:line-numbers} The above example assumes that your contract id string is encoded in the bech32m format. You can recognize it by the human-readable-part "fuel" followed by the separator "1". However, when using other Fuel tools, you might end up with a hex-encoded contract id string. A [Contract ID](../types/contract-id.md) can easily be converted to and from other Address formats, see the [conversion guide](../types/conversion.md) for more information. -```typescript +```ts:line-numbers const contract: Contract = new Contract(new Address(ADDRESS_BECH32), abiJSON); const contract: Contract = new Contract(Address.fromPublicKey(KEY), abiJSON); diff --git a/docs/_guide/contracts/logs.md b/apps/docs/src/guide/contracts/logs.md similarity index 68% rename from docs/_guide/contracts/logs.md rename to apps/docs/src/guide/contracts/logs.md index e560a7f19e1..37927e20024 100644 --- a/docs/_guide/contracts/logs.md +++ b/apps/docs/src/guide/contracts/logs.md @@ -1,13 +1,11 @@ -[nav_order: 9] - # Logs Whenever you log a value within a contract method, the resulting log entry is added to the log receipt and the variable type is recorded in the contract's ABI. The SDK lets you parse those values into TypeScript types. Consider the following contract method: -[@code:rust](./packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#typedoc:Log-demo) +<<< @/../../../packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#Log-demo{rust:line-numbers} You can access the logged values in TypeScript by using the `logs` property in the `FunctionInvocationResult` from a contract call result. The logs data will be in a `Array`: -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:Log-output) +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#Log-output{ts:line-numbers} diff --git a/docs/_guide/contracts/multicalls.md b/apps/docs/src/guide/contracts/multicalls.md similarity index 67% rename from docs/_guide/contracts/multicalls.md rename to apps/docs/src/guide/contracts/multicalls.md index 7b4edf8a943..41a9ab4f779 100644 --- a/docs/_guide/contracts/multicalls.md +++ b/apps/docs/src/guide/contracts/multicalls.md @@ -1,21 +1,20 @@ -[nav_order: 3] - # Multiple contract calls At a basic level, you can call the same contract function multiple times in the same transaction: -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-multicall) + +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-multicall{ts:line-numbers} ## Different contracts in multicalls You can execute multiple contract calls to distinct contracts within a single transaction. To achieve this, you first prepare all the contract calls that you want to bundle: -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-multicall-multiple-contracts) +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-multicall-multiple-contracts{ts:line-numbers} You can also set call parameters, variable outputs, or external contracts for every contract call, as long as you don't execute it with `call()` or `simulate()`. See also [call parameters](./call-parameters.md). Next, you provide the prepared calls to the `multiCall` method and optionally configure transaction parameters: -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-multicall-multiple-contracts-p2) +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-multicall-multiple-contracts-p2{ts:line-numbers} > **Note:** any transaction parameters configured on separate contract calls are disregarded in favor of the parameters provided to `multiCall`. @@ -23,4 +22,4 @@ Next, you provide the prepared calls to the `multiCall` method and optionally co To get the output values of the bundled calls, invoke of `call()` or `simulate()`: -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-multicall-multiple-contracts-p3) +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-multicall-multiple-contracts-p3{ts:line-numbers} diff --git a/docs/_guide/contracts/read-only-calls.md b/apps/docs/src/guide/contracts/read-only-calls.md similarity index 81% rename from docs/_guide/contracts/read-only-calls.md rename to apps/docs/src/guide/contracts/read-only-calls.md index 333d7c8e00b..2cc80be5bd6 100644 --- a/docs/_guide/contracts/read-only-calls.md +++ b/apps/docs/src/guide/contracts/read-only-calls.md @@ -1,5 +1,3 @@ -[nav_order: 2] - # Read-only calls Sometimes you want to call a contract method that does not change the state of the blockchain. For instance, a method that only _reads_ a value from storage and returns it without making any changes to storage. @@ -8,11 +6,11 @@ In this case, there is no need to create an actual blockchain transaction; you o You can do this with the SDK. Instead of `.call()`ing the method, use `.get()`: -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-read-only-call) +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-read-only-call{ts:line-numbers} -`get()` doesn't take funding, as it is a read-only call that doesn't alter the chain state. +`get()` doesn't take funding, as it is a read-only call that doesn't alter the chain state. -If you want to dry run a transaction call that takes funding without altering the chain state, use `dryRun()`. +If you want to dry run a transaction call that takes funding without altering the chain state, use `dryRun()`. ## When to use `get()` vs `call()` diff --git a/docs/_guide/contracts/the-fuelvm-binary-file.md b/apps/docs/src/guide/contracts/the-fuelvm-binary-file.md similarity index 97% rename from docs/_guide/contracts/the-fuelvm-binary-file.md rename to apps/docs/src/guide/contracts/the-fuelvm-binary-file.md index 9728dd4c2be..1050dad7aad 100644 --- a/docs/_guide/contracts/the-fuelvm-binary-file.md +++ b/apps/docs/src/guide/contracts/the-fuelvm-binary-file.md @@ -1,10 +1,8 @@ -[nav_order: 11] - # The FuelVM binary file The command `forc build` compiles your Sway code and generates the bytecode: the binary code that the Fuel Virtual Machine will interpret. For instance, the smart contract below: -```rust +```rust:line-numbers contract; abi MyContract { @@ -20,7 +18,7 @@ impl MyContract for Contract { After `forc build`, will have a binary file that contains: -```terminal +```sh $ cat out/debug/my-test.bin G4]�]D`I]C�As@ 6]C�$@!QK% @@ -28,7 +26,7 @@ G4]�]D`I]C�As@ This seems very unreadable! But, `forc` has a nice interpreter for this bytecode: `forc `parse-bytecode`, which will interpret that binary data and output the equivalent FuelVM assembly: -```terminal +```sh $ forc parse-bytecode out/debug/my-test.bin half-word byte op raw notes 0 0 JI(4) 90 00 00 04 jump to byte 16 diff --git a/docs/_guide/contracts/transaction-parameters.md b/apps/docs/src/guide/contracts/transaction-parameters.md similarity index 89% rename from docs/_guide/contracts/transaction-parameters.md rename to apps/docs/src/guide/contracts/transaction-parameters.md index 4df091e1bfc..368895f80ad 100644 --- a/docs/_guide/contracts/transaction-parameters.md +++ b/apps/docs/src/guide/contracts/transaction-parameters.md @@ -1,5 +1,3 @@ -[nav_order: 5] - # Transaction parameters Transaction parameters are: @@ -10,7 +8,7 @@ Transaction parameters are: You can configure these parameters by using the optional `TxParams` and passing it to a chain method called `txParams`: -[@code:typescript](./packages/fuel-gauge/src/contract.test.ts#typedoc:Contract-tx-params) +<<< @/../../../packages/fuel-gauge/src/contract.test.ts#Contract-tx-params{ts:line-numbers} If you do not pass the `TxParams`, the values default to those of the chainConfig provided to your Fuel node. diff --git a/docs/_guide/contracts/variable-outputs.md b/apps/docs/src/guide/contracts/variable-outputs.md similarity index 86% rename from docs/_guide/contracts/variable-outputs.md rename to apps/docs/src/guide/contracts/variable-outputs.md index 9f68551f49b..53894aac517 100644 --- a/docs/_guide/contracts/variable-outputs.md +++ b/apps/docs/src/guide/contracts/variable-outputs.md @@ -1,10 +1,8 @@ -[nav_order: 10] - # Variable outputs In some cases, you might want to send funds to the output of a transaction. Sway has a specific method for that: `transfer_to_address(coins, asset_id, recipient)`. So, if you have a contract that does something like this: -```rust +```rust:line-numbers fn transfer_coins_to_output(coins: u64, asset_id: ContractId, recipient: Address) { transfer_to_address(coins, asset_id, recipient); } @@ -12,7 +10,7 @@ In some cases, you might want to send funds to the output of a transaction. Sway With the SDK, you can call `transfer_coins_to_output` by chaining `append_variable_outputs(amount)` to your contract call. Like this: -[@code:typescript](./packages/fuel-gauge/src/token-test-contract.test.ts#typedoc:variable-outputs) +<<< @/../../../packages/fuel-gauge/src/token-test-contract.test.ts#variable-outputs{ts:line-numbers} In the TS-SDK, the Output variables are automatically added to the transaction's list of outputs. The output's amount and the owner may vary based on transaction execution. diff --git a/docs/_guide/cookbook/deposit-and-withdraw.md b/apps/docs/src/guide/cookbook/deposit-and-withdraw.md similarity index 65% rename from docs/_guide/cookbook/deposit-and-withdraw.md rename to apps/docs/src/guide/cookbook/deposit-and-withdraw.md index 041987c8e6c..8c627e8c454 100644 --- a/docs/_guide/cookbook/deposit-and-withdraw.md +++ b/apps/docs/src/guide/cookbook/deposit-and-withdraw.md @@ -1,8 +1,10 @@ +# Deposit And Withdraw + Consider the following contracts: -[@code:rust](./packages/fuel-gauge/test-projects/token_contract/src/main.sw#typedoc:token-contract) +<<< @/../../../packages/fuel-gauge/test-projects/token_contract/src/main.sw#token-contract{rust:line-numbers} -[@code:rust](./packages/fuel-gauge/test-projects/liquidity-pool/src/main.sw#typedoc:liquidity-pool-contract) +<<< @/../../../packages/fuel-gauge/test-projects/liquidity-pool/src/main.sw#liquidity-pool-contract{rust:line-numbers} The first contract is a contract that represents a simple token. @@ -16,20 +18,20 @@ $ npx fuels typegen -i ./contract/out/debug/*-abi.json -o ./contract-types Next, let's setup a [`Wallet`](../wallets/index.md) and seed it with some coins. We will need these coins to deploy the contracts and to interact with them. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:deposit-and-withdraw-cookbook-wallet-setup) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#deposit-and-withdraw-cookbook-wallet-setup{ts:line-numbers} Let's now deploy both the contracts and set them up. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:deposit-and-withdraw-cookbook-contract-deployments) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#deposit-and-withdraw-cookbook-contract-deployments{ts:line-numbers} Next, let's mint some tokens and transfer them to our wallet. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:deposit-and-withdraw-cookbook-mint-and-transfer) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#deposit-and-withdraw-cookbook-mint-and-transfer{ts:line-numbers} Now, let's deposit some tokens into the liquidity pool contract. Since we have to transfer assets to the contract, we create the appropriate [`callParams`](../contracts/call-parameters.md) and chain them to the method call. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:deposit-and-withdraw-cookbook-deposit) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#deposit-and-withdraw-cookbook-deposit{ts:line-numbers} As a final demonstration, let's use all our liquidity asset balance to withdraw from the pool and confirm we retrieved the initial amount. For this, we get our liquidity asset balance and supply it to the `withdraw()` function via `callParams`. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:deposit-and-withdraw-cookbook-withdraw) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#deposit-and-withdraw-cookbook-withdraw{ts:line-numbers} diff --git a/docs/_guide/cookbook/index.md b/apps/docs/src/guide/cookbook/index.md similarity index 93% rename from docs/_guide/cookbook/index.md rename to apps/docs/src/guide/cookbook/index.md index 01e6be4867b..4a3ce684102 100644 --- a/docs/_guide/cookbook/index.md +++ b/apps/docs/src/guide/cookbook/index.md @@ -1,5 +1,3 @@ -[nav_order: 5] - # Cookbook This section covers more advanced use cases that can be satisfied by combining various features of the SDK. As such, it assumes that you have already made yourself familiar with the previous chapters of this book. diff --git a/docs/_guide/cookbook/transfer-all-assets.md b/apps/docs/src/guide/cookbook/transfer-all-assets.md similarity index 100% rename from docs/_guide/cookbook/transfer-all-assets.md rename to apps/docs/src/guide/cookbook/transfer-all-assets.md diff --git a/docs/_guide/index.md b/apps/docs/src/guide/index.md similarity index 69% rename from docs/_guide/index.md rename to apps/docs/src/guide/index.md index dd178cc9ce5..c43db03c360 100644 --- a/docs/_guide/index.md +++ b/apps/docs/src/guide/index.md @@ -1,3 +1,8 @@ + + # The Fuel TypeScript SDK Guide TypeScript SDK for Fuel. It can be used for a variety of things, including but not limited to: @@ -10,8 +15,8 @@ TypeScript SDK for Fuel. It can be used for a variety of things, including but n This book is an overview of the different things one can achieve using the TypeScript SDK, and how to implement them. Keep in mind that both the SDK and the documentation are works-in-progress! -#### Version Notice: Docs generated using Fuels `v{{site.data.versions.fuels}}`, Fuel Core `v{{site.data.versions.fuel-core}}`, Sway `v{{site.data.versions.sway}}`, and Forc `v{{site.data.versions.forc}}`. +#### Version Notice: Docs generated using Fuels `v{{fuels}}`, Fuel Core `v{{fuelCore}}`, Sway `v{{sway}}`, and Forc `v{{forc}}`. [The Fuel TypeScript SDK](../index.md) -See also the main [The Fuel TypeScript SDK](../index.md) and [Contributing](../../CONTRIBUTING.md) pages for additional resources. +See also the main [The Fuel TypeScript SDK](../index.md) and [Contributing](https://github.com/FuelLabs/fuels-ts/blob/master/CONTRIBUTING.md) pages for additional resources. diff --git a/docs/_guide/messages/getting-a-message-proof.md b/apps/docs/src/guide/messages/getting-a-message-proof.md similarity index 70% rename from docs/_guide/messages/getting-a-message-proof.md rename to apps/docs/src/guide/messages/getting-a-message-proof.md index 42037dd6a23..1e94766de05 100644 --- a/docs/_guide/messages/getting-a-message-proof.md +++ b/apps/docs/src/guide/messages/getting-a-message-proof.md @@ -2,4 +2,4 @@ A message proof is a cryptographic proof that a message was included in a block. You can use the `getMessageProof` method to retrieve a message proof for a given transaction ID and message ID. -[@code:typescript](./packages/wallet/src/transfer.test.ts#typedoc:Message-getMessageProof) +<<< @/../../../packages/wallet/src/transfer.test.ts#Message-getMessageProof{ts:line-numbers} diff --git a/docs/_guide/messages/getting-all-resources.md b/apps/docs/src/guide/messages/getting-all-resources.md similarity index 63% rename from docs/_guide/messages/getting-all-resources.md rename to apps/docs/src/guide/messages/getting-all-resources.md index 740a586da0a..0eddff0a936 100644 --- a/docs/_guide/messages/getting-all-resources.md +++ b/apps/docs/src/guide/messages/getting-all-resources.md @@ -2,4 +2,4 @@ You can use the `getResourcesToSpend` method to retrieve a list of all the resources (coins + assets) that can be spent by a given address. -[@code:typescript](./packages/wallet/src/account.test.ts#typedoc:Message-getResourcesToSpend) +<<< @/../../../packages/wallet/src/account.test.ts#Message-getResourcesToSpend{ts:line-numbers} diff --git a/docs/_guide/messages/getting-messages.md b/apps/docs/src/guide/messages/getting-messages.md similarity index 51% rename from docs/_guide/messages/getting-messages.md rename to apps/docs/src/guide/messages/getting-messages.md index 82efbd04864..75901bcc1f7 100644 --- a/docs/_guide/messages/getting-messages.md +++ b/apps/docs/src/guide/messages/getting-messages.md @@ -2,4 +2,4 @@ You can use the `getMessages` method to retrieve a list of messages from the blockchain. -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:Message-getMessages) +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#Message-getMessages{ts:line-numbers} diff --git a/docs/_guide/messages/index.md b/apps/docs/src/guide/messages/index.md similarity index 80% rename from docs/_guide/messages/index.md rename to apps/docs/src/guide/messages/index.md index 7cc068a2a03..8c5d32c9dec 100644 --- a/docs/_guide/messages/index.md +++ b/apps/docs/src/guide/messages/index.md @@ -1,9 +1,7 @@ -[nav_order: 9] - # Messages A message is an object that contains some data that when broadcasted to the network, can change the state of the blockchain. This can include sending tokens, creating a new account, or deploying a smart contract. Messages are signed by a sender and broadcasted to the network. This message is then verified and included in a block. This is the general structure of a `Message` object: -[@code:typescript](./packages/providers/src/message.ts#typedoc:Message-shape) +<<< @/../../../packages/providers/src/message.ts#Message-shape{ts:line-numbers} diff --git a/docs/_guide/predicates/index.md b/apps/docs/src/guide/predicates/index.md similarity index 66% rename from docs/_guide/predicates/index.md rename to apps/docs/src/guide/predicates/index.md index 31c4da87176..b8590205590 100644 --- a/docs/_guide/predicates/index.md +++ b/apps/docs/src/guide/predicates/index.md @@ -1,4 +1,8 @@ -[nav_order: 6] + # Predicates @@ -6,9 +10,9 @@ Predicates, in Sway, are programs that return a Boolean value, and they do not h ## Instantiating predicates -Similar to contracts, once you've written a predicate in Sway and compiled it with `forc build` (read [here](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/index.html) for more on how to work with Sway), you'll get the predicate binary. Using the binary, you can instantiate a `predicate` as shown in the code snippet below: +Similar to contracts, once you've written a predicate in Sway and compiled it with `forc build` (read here for more on how to work with Sway), you'll get the predicate binary. Using the binary, you can instantiate a `predicate` as shown in the code snippet below: -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:predicate-basic) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#predicate-basic{ts:line-numbers} The created `predicate` instance has two fields. The predicate `bytes (byte code)` and the predicate `address`. This address is generated from the byte code and is the same as the `P2SH` address used in Bitcoin. Users can seamlessly send assets to the predicate address as they do for any other address on the chain. To spend the predicate funds, the user has to provide the original `byte code` of the predicate together with the `predicate data`. The `predicate data` will be used when executing the `byte code`, and if the predicate is validated successfully, the funds will be accessible. @@ -18,6 +22,6 @@ In the next section, we show how to interact with a predicate and explore an exa Suppose your Sway predicate `main` function is written using the arguments passed to the `main` function like so: -[@code:rust](./packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw#typedoc:Predicate-main-args) +<<< @/../../../packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw#Predicate-main-args{ts:line-numbers} You can still create a `Predicate` in the same way as above, but you can pass in a `JsonAbi` using the JSON generated from `forc`. diff --git a/docs/_guide/predicates/send-and-spend-funds-from-predicates.md b/apps/docs/src/guide/predicates/send-and-spend-funds-from-predicates.md similarity index 66% rename from docs/_guide/predicates/send-and-spend-funds-from-predicates.md rename to apps/docs/src/guide/predicates/send-and-spend-funds-from-predicates.md index b40814b3706..7a1aab036e4 100644 --- a/docs/_guide/predicates/send-and-spend-funds-from-predicates.md +++ b/apps/docs/src/guide/predicates/send-and-spend-funds-from-predicates.md @@ -2,34 +2,34 @@ Let's consider the following predicate example: -[@code:rust](./packages/fuel-gauge/test-projects/predicate-triple-sig/src/main.sw#typedoc:Predicate-triple) +<<< @/../../../packages/fuel-gauge/test-projects/predicate-triple-sig/src/main.sw#Predicate-triple{rust:line-numbers} This predicate accepts three signatures and matches them to three predefined public keys. The `ec_recover_address` function is used to recover the public key from the signatures. If two of three extracted public keys match the predefined public keys, the funds can be spent. Note that the signature order has to match the order of the predefined public keys. Let's use the SDK to interact with the predicate. First, let's create three wallets with specific keys. Their hashed public keys are already hard-coded in the predicate. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Predicate-triple-wallets) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Predicate-triple-wallets{ts:line-numbers} Next, let's add some coins to the wallets. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Predicate-triple-seed) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Predicate-triple-seed{ts:line-numbers} Now we can load the predicate binary, and prepare some transaction variables. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Predicate-triple) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Predicate-triple-2{ts:line-numbers} After the predicate address is generated we can send funds to it. Note that we are using the same `transfer` function as we used when sending funds to other wallets. We also make sure that the funds are indeed transferred. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Predicate-triple-transfer) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Predicate-triple-transfer{ts:line-numbers} Alternatively, you can use `Wallet.submitPredicate` to setup a `Predicate` and use funds from the `Wallet` you submitted from. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Predicate-triple-submit) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Predicate-triple-submit{ts:line-numbers} To spend the funds that are now locked in this example's Predicate, we have to provide two out of three signatures whose public keys match the ones we defined in the predicate. In this example, the signatures are generated using a zeroed B256 value. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Predicate-triple-sign) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Predicate-triple-sign{ts:line-numbers} After generating the signatures, we can send a transaction to spend the predicate funds. We use the `receiver` wallet as the recipient. We have to provide the predicate byte code and the required signatures. As we provide the correct data, we receive the funds and verify that the amount is correct. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Predicate-triple-spend) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Predicate-triple-spend{ts:line-numbers} diff --git a/docs/_guide/providers/connecting-to-an-external-node.md b/apps/docs/src/guide/providers/connecting-to-an-external-node.md similarity index 81% rename from docs/_guide/providers/connecting-to-an-external-node.md rename to apps/docs/src/guide/providers/connecting-to-an-external-node.md index dea30ae56b6..ef7c0110ea2 100644 --- a/docs/_guide/providers/connecting-to-an-external-node.md +++ b/apps/docs/src/guide/providers/connecting-to-an-external-node.md @@ -1,10 +1,8 @@ -[nav_order: 2] - # Connecting to the Testnet or an external node We can interact with the `Testnet` node by using the following example. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:provider-testnet) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#provider-testnet{ts:line-numbers} In the code example, we connected a new provider to the Testnet node and created a new wallet from a private key. @@ -20,4 +18,4 @@ In the code example, we connected a new provider to the Testnet node and created If you want to connect to another node just change the url or IP and port. For example, to connect to a local node that was created with `fuel-core` you can use: -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:provider-local) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#provider-local{ts:line-numbers} diff --git a/docs/_guide/providers/connection.md b/apps/docs/src/guide/providers/connection.md similarity index 98% rename from docs/_guide/providers/connection.md rename to apps/docs/src/guide/providers/connection.md index a67b61e1dfd..5cd5fdacd60 100644 --- a/docs/_guide/providers/connection.md +++ b/apps/docs/src/guide/providers/connection.md @@ -1,5 +1,3 @@ -[nav_order: 1] - # Connecting to a Fuel node At a high level, you can use the Fuel TypeScript SDK to build applications that can run computations on the Fuel Virtual Machine through interactions with smart contracts written in Sway. diff --git a/docs/_guide/providers/index.md b/apps/docs/src/guide/providers/index.md similarity index 86% rename from docs/_guide/providers/index.md rename to apps/docs/src/guide/providers/index.md index a83fad6caad..12d565fbc63 100644 --- a/docs/_guide/providers/index.md +++ b/apps/docs/src/guide/providers/index.md @@ -1,5 +1,3 @@ -[nav_order: 3] - # Providers This section gives some pointers for using the Fuel SDK for smart contract development. diff --git a/docs/_guide/providers/querying-the-chain.md b/apps/docs/src/guide/providers/querying-the-chain.md similarity index 63% rename from docs/_guide/providers/querying-the-chain.md rename to apps/docs/src/guide/providers/querying-the-chain.md index 0f8463de52a..25708433b90 100644 --- a/docs/_guide/providers/querying-the-chain.md +++ b/apps/docs/src/guide/providers/querying-the-chain.md @@ -1,35 +1,27 @@ -[nav_order: 3] - # Interacting with the blockchain Once you have set up a provider, you're ready to interact with the Fuel blockchain. Here are a few examples of what you can do with a provider; for a more in-depth overview of the API, check the [official provider API documentation](https://docs.rs/fuels/latest/fuels/signers/provider/struct.Provider.html). -- [Interacting with the blockchain](#interacting-with-the-blockchain) - - [Set up](#set-up) - - [Get all coins from an address](#get-all-coins-from-an-address) - - [Get spendable resources from an address](#get-spendable-resources-from-an-address) - - [Get balances from an address](#get-balances-from-an-address) - ## Set up You might need to set up a test blockchain first. You can skip this step if you're connecting to an external blockchain. -See [connecting](./connecting.md) +See [connection](./connection.md) ## Get all coins from an address This method returns all coins (of an optional given asset ID) from a wallet, including spent ones. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-query) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-query{ts:line-numbers} ## Get spendable resources from an address The last argument says how much you want to spend. This method returns only spendable, i.e., unspent coins (of a given asset ID). If you ask for more spendable than the amount of unspent coins you have, it returns an error. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-get-spendable-resources) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-get-spendable-resources{ts:line-numbers} ## Get balances from an address Get all the spendable balances of all assets for an address. This is different from getting the coins because we only return the numbers (the sum of UTXOs coins amount for each asset id) and not the UTXOs coins themselves. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-get-balances) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-get-balances{ts:line-numbers} diff --git a/docs/_guide/scripts/calling-a-script.md b/apps/docs/src/guide/scripts/calling-a-script.md similarity index 60% rename from docs/_guide/scripts/calling-a-script.md rename to apps/docs/src/guide/scripts/calling-a-script.md index bf41b94d344..046e1da7e97 100644 --- a/docs/_guide/scripts/calling-a-script.md +++ b/apps/docs/src/guide/scripts/calling-a-script.md @@ -1,11 +1,9 @@ -[nav_order: 2] - # Calling a script Suppose your Sway script `main` function is written using the arguments passed to the `main` function like so: -[@code:rust](./packages/fuel-gauge/test-projects/script-main-args/src/main.sw#typedoc:script-with-main-args) +<<< @/../../../packages/fuel-gauge/test-projects/script-main-args/src/main.sw#script-with-main-args{rust:line-numbers} You can still hand code out a solution wrapper using `callScript` utility to call your script with data. However, if you prefer to use the ABI generated from your script, you can use the `ScriptFactory` helper: -[@code:typescript](./packages/fuel-gauge/src/script-main-args.test.ts#typedoc:script-call-factory) +<<< @/../../../packages/fuel-gauge/src/script-main-args.test.ts#script-call-factory{ts:line-numbers} diff --git a/apps/docs/src/guide/scripts/index.md b/apps/docs/src/guide/scripts/index.md new file mode 100644 index 00000000000..7bdf97fe461 --- /dev/null +++ b/apps/docs/src/guide/scripts/index.md @@ -0,0 +1,13 @@ + + +# Scripts + +A Script, in Sway, is runnable bytecode on the chain which executes once to perform some task. A script can return a single value of any type. + +Learn more about Scripts here. diff --git a/apps/docs/src/guide/scripts/instantiating-a-script.md b/apps/docs/src/guide/scripts/instantiating-a-script.md new file mode 100644 index 00000000000..c116f48ce2e --- /dev/null +++ b/apps/docs/src/guide/scripts/instantiating-a-script.md @@ -0,0 +1,15 @@ + + +# Instantiating a script + +Similar to contracts and predicates, once you've written a script in Sway and compiled it with `forc build` (read here for more on how to work with Sway), you'll get the script binary. Using the binary, you can instantiate a `script` as shown in the code snippet below: + +<<< @/../../../packages/script/src/script.test.ts#script-init{ts:line-numbers} + +In the [next section](./calling-a-script.md), we show how to call a script. diff --git a/docs/guide/testing/index.md b/apps/docs/src/guide/testing/index.md similarity index 77% rename from docs/guide/testing/index.md rename to apps/docs/src/guide/testing/index.md index ef1090b6d9d..5b50c5c2e65 100644 --- a/docs/guide/testing/index.md +++ b/apps/docs/src/guide/testing/index.md @@ -1,20 +1,15 @@ ---- -title: "Testing" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 8 ---- - -[info]: this file is autogenerated - + # Testing In order to test your Sway and TS-SDK applications, you can test your code in a number of ways: 1. Testing with TS-SDK: Compiling you Sway code and connecting to the methods using TS-SDK and JS testing frameworks -2. Using `forc test` see [the Sway docs](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/forc/commands/forc_test.html) for more info +2. Using `forc test` see the Sway docs for more info 3. Using [the Rust SDK](https://fuellabs.github.io/fuels-rs/v0.31.1/testing/index.html) ### Testing with TS-SDK diff --git a/docs/_guide/testing/testing-with-jest.md b/apps/docs/src/guide/testing/testing-with-jest.md similarity index 68% rename from docs/_guide/testing/testing-with-jest.md rename to apps/docs/src/guide/testing/testing-with-jest.md index 5b3c45a333a..9c449dc2c2b 100644 --- a/docs/_guide/testing/testing-with-jest.md +++ b/apps/docs/src/guide/testing/testing-with-jest.md @@ -3,7 +3,9 @@ As noted in [the testing intro](./index.md), you are free to test your Sway and TS-SDK code with any JS framework available. Below we have an example of how to load and test a contract using Jest, but the general principles and steps are the same for any testing harness. Here is a simple Sway program that takes an input and then returns it: -[@code:rust](./packages/example-contract/src/main.sw#typedoc:Testing-with-jest-contract) + +<<< @/../../../packages/example-contract/src/main.sw#Testing-with-jest-rust{rust:line-numbers} Here is JavaScript code testing the above program using a conventional Jest setup: -[@code:typescript](./packages/example-contract/src/example-contract.test.ts#typedoc:Testing-with-jest) + +<<< @/../../../packages/example-contract/src/example-contract.test.ts#Testing-with-jest-ts{ts:line-numbers} diff --git a/apps/docs/src/guide/types/address.md b/apps/docs/src/guide/types/address.md new file mode 100644 index 00000000000..a1557996dd4 --- /dev/null +++ b/apps/docs/src/guide/types/address.md @@ -0,0 +1,23 @@ +# Address + +`Address` is a wrapper on `Bytes32` and `Bech32`. The available interface of the TS-SDK Address contains many useful functions to switch between Address formats: + +<<< @/../../../packages/interfaces/src/index.ts#AbstractAddress{ts:line-numbers} + +These are the main ways of creating an `Address` + +From a [Bech32](./bech32.md) Address: + +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Address-bech32{ts:line-numbers} + +From a Public Key: + +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Address-publicKey{ts:line-numbers} + +From a [256 Bit Address](./bits256.md) Address: + +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Address-b256{ts:line-numbers} + +You can also use a number of utilities as part of the Address Class: + +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Address-utils{ts:line-numbers} diff --git a/docs/_guide/types/arrays.md b/apps/docs/src/guide/types/arrays.md similarity index 92% rename from docs/_guide/types/arrays.md rename to apps/docs/src/guide/types/arrays.md index d46ee810ba8..01bf3bba8f8 100644 --- a/docs/_guide/types/arrays.md +++ b/apps/docs/src/guide/types/arrays.md @@ -6,7 +6,7 @@ You can pass a JavaScript `Array` into your contract method transparently, allow An Array is just a Typed Array: -```typescript +```ts:line-numbers // aka [u8; 2] let basicNumberArray = [1, 23]; // aka [bool; 4] @@ -15,4 +15,4 @@ let basicBooleanArray = [true, false, true, false]; ## Vectors -If your Array size is unknown until runtime, you can also use [Vectors](./vectors.md) +If your Array size is unknown until runtime, you can also use [Vectors](./vectors.md). diff --git a/docs/_guide/types/asset-id.md b/apps/docs/src/guide/types/asset-id.md similarity index 100% rename from docs/_guide/types/asset-id.md rename to apps/docs/src/guide/types/asset-id.md diff --git a/docs/_guide/types/bech32.md b/apps/docs/src/guide/types/bech32.md similarity index 68% rename from docs/_guide/types/bech32.md rename to apps/docs/src/guide/types/bech32.md index 76f0e8de76b..316637b758b 100644 --- a/docs/_guide/types/bech32.md +++ b/apps/docs/src/guide/types/bech32.md @@ -3,8 +3,9 @@ The `Bech32Address` enables the use of addresses and contract ids in the bech32 format (using bech32m). They can easily be converted to their counterparts using [Address](./address.md). Here are the main ways of creating a `Bech32Address` -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Address-bech32) + +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Address-bech32{ts:line-numbers} > **Note:** when using a `Bech32Address` with an `Address` the HRP (Human-Readable Part) is set to **"fuel"** per default: -[@code:typescript](./packages/interfaces/src/index.ts#typedoc:Bech32-HRP) +<<< @/../../../packages/interfaces/src/index.ts#Bech32-HRP{ts:line-numbers} diff --git a/docs/_guide/types/bits256.md b/apps/docs/src/guide/types/bits256.md similarity index 68% rename from docs/_guide/types/bits256.md rename to apps/docs/src/guide/types/bits256.md index 70df399669c..d88aa24317a 100644 --- a/docs/_guide/types/bits256.md +++ b/apps/docs/src/guide/types/bits256.md @@ -4,8 +4,8 @@ In Fuel, a type called `b256` represents hashes and holds a 256-bit value. The T Here are some example tools in the SDK: -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:b256) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#b256{ts:line-numbers} A Bit256 value is also supported as part of the [Address](./address.md) libraries. -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Address-b256) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#Address-b256{ts:line-numbers} diff --git a/docs/_guide/types/bytes32.md b/apps/docs/src/guide/types/bytes32.md similarity index 79% rename from docs/_guide/types/bytes32.md rename to apps/docs/src/guide/types/bytes32.md index 24da717887c..5bd93bf686a 100644 --- a/docs/_guide/types/bytes32.md +++ b/apps/docs/src/guide/types/bytes32.md @@ -4,6 +4,6 @@ In Sway and the FuelVM, `Bytes32` represents hashes. They hold a 256-bit (32-byt These are the main ways of creating a `Bytes32`: -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:byte32) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#byte32{ts:line-numbers} > **Note:** In Fuel, there's a special type called `b256`, which is similar to `Bytes32`; also used to represent hashes, and it holds a [256 Bit](./bits256.md) value. diff --git a/docs/_guide/types/contract-id.md b/apps/docs/src/guide/types/contract-id.md similarity index 100% rename from docs/_guide/types/contract-id.md rename to apps/docs/src/guide/types/contract-id.md diff --git a/docs/_guide/types/conversion.md b/apps/docs/src/guide/types/conversion.md similarity index 72% rename from docs/_guide/types/conversion.md rename to apps/docs/src/guide/types/conversion.md index d4a2bec9f5b..fef9f7c1a28 100644 --- a/docs/_guide/types/conversion.md +++ b/apps/docs/src/guide/types/conversion.md @@ -2,4 +2,4 @@ You might want to convert between the native types (`Bytes32`, `Address`, `ContractId`, and `AssetId`). Because these types are wrappers on `Bytes` converting is a matter of using helpers. Here's an example: -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:conversion) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#conversion{ts:line-numbers} diff --git a/docs/_guide/types/enums-and-options.md b/apps/docs/src/guide/types/enums-and-options.md similarity index 63% rename from docs/_guide/types/enums-and-options.md rename to apps/docs/src/guide/types/enums-and-options.md index 0ec853d2e2f..e05cfbdc5f7 100644 --- a/docs/_guide/types/enums-and-options.md +++ b/apps/docs/src/guide/types/enums-and-options.md @@ -1,15 +1,18 @@ # Enums Here are some examples of `Enums` in Sway: -[@code:rust](./packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#typedoc:Enum) + +<<< @/../../../packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#Enum{rust:line-numbers} And the same structures represented in TypeScript, note that an `Enum` is essentially an `Object` in TypeScript. Here is `SmallEnum` -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:Enum-small) + +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#Enum-small{ts:line-numbers} Here is `BigEnum` -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:Enum-big) + +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#Enum-big{ts:line-numbers} ## Options @@ -19,7 +22,7 @@ The `Option` is a special wrapper type of `Enum`. This example shows that an input param with type `OptionalStringInput` can either be a `string` value or `undefined` -```typescript +```ts:line-numbers type OptionalStringInput = Option; let someInput: OptionalStringInput = "dogs"; @@ -27,10 +30,13 @@ let noneInput: OptionalStringInput = undefined; ``` To help us understand how the TS-SDK handles Optional params, take this Sway method that expects three optional params which it attempts to add together. -[@code:rust](./packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#typedoc:Option-echo_option_three_u8) + +<<< @/../../../packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#Option-echo_option_three_u8{rust:line-numbers} Using this Contract, our Optional params can either be the values expected, like so: -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:Option-Some) + +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#Option-Some{ts:line-numbers} Or we can supply a partial list, where unsupplied values are converted to `Option` (or `undefined`): -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:Option-None) + +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#Option-None{ts:line-numbers} diff --git a/docs/_guide/types/index.md b/apps/docs/src/guide/types/index.md similarity index 91% rename from docs/_guide/types/index.md rename to apps/docs/src/guide/types/index.md index b0adab4f1a1..9966b7efa38 100644 --- a/docs/_guide/types/index.md +++ b/apps/docs/src/guide/types/index.md @@ -1,5 +1,3 @@ -[nav_order: 0] - # Types The FuelVM and Sway have many internal types. These types have equivalents in the SDK. This section discusses these types, how to use them, and how to convert them. diff --git a/docs/_guide/types/string.md b/apps/docs/src/guide/types/string.md similarity index 80% rename from docs/_guide/types/string.md rename to apps/docs/src/guide/types/string.md index 33a52d474fa..02c4f08fc6c 100644 --- a/docs/_guide/types/string.md +++ b/apps/docs/src/guide/types/string.md @@ -4,7 +4,7 @@ Currently, all strings in Fuel and Sway are statically-sized, i.e., you must kno Here's how you can create a simple string using `TypeScript`: -```typescript +```ts:line-numbers // aka str[2] let stringSize2 = "st"; // aka str[8] @@ -13,4 +13,4 @@ let stringSize8 = "fuel-sdk"; If your contract's method takes and returns, a `str[8]`, the SDK wrapper method will take and return a string of same length with validation. You can pass a string to it like this: -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:String-size8) +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#String-size8{ts:line-numbers} diff --git a/docs/_guide/types/structs.md b/apps/docs/src/guide/types/structs.md similarity index 74% rename from docs/_guide/types/structs.md rename to apps/docs/src/guide/types/structs.md index 641291a22bb..db6c8d1d375 100644 --- a/docs/_guide/types/structs.md +++ b/apps/docs/src/guide/types/structs.md @@ -3,11 +3,12 @@ A `struct` in Sway is equivalent to an `Object` in TypeScript, where the property names and types must match what is defined in Sway. Here is an example of the `struct` in Sway: -[@code:rust](./packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#typedoc:ComplexStruct) + +<<< @/../../../packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#ComplexStruct{rust:line-numbers} And the same structure represented in TypeScript: -```typescript +```ts:line-numbers type ComplexStruct { foo: u8, bar: u64, diff --git a/docs/_guide/types/vectors.md b/apps/docs/src/guide/types/vectors.md similarity index 68% rename from docs/_guide/types/vectors.md rename to apps/docs/src/guide/types/vectors.md index 54420665d9c..1a6ac564971 100644 --- a/docs/_guide/types/vectors.md +++ b/apps/docs/src/guide/types/vectors.md @@ -6,19 +6,22 @@ You can pass a JavaScript `Array` into your contract method transparently, allow A basic Vector is just a Typed Array: -```typescript +```ts:line-numbers // aka Vec let basicNumberVector = [1, 2, 3]; ``` Here is an example of a sample `struct` in Sway: -[@code:rust](./packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#typedoc:ComplexStruct) + +<<< @/../../../packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#ComplexStruct{rust:line-numbers} And the contract method using this `struct` in a `Vector`: -[@code:rust](./packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#typedoc:Vector-ComplexStruct) + +<<< @/../../../packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#Vector-ComplexStruct{rust:line-numbers} The following code calls this Sway contract method which accepts a `Vec`. -[@code:typescript](./packages/fuel-gauge/src/coverage-contract.test.ts#typedoc:Vector-Struct) + +<<< @/../../../packages/fuel-gauge/src/coverage-contract.test.ts#Vector-Struct{ts:line-numbers} You can use a vector just like you would use any other type -- e.g. a `[Vec; 2]` or a `SomeStruct>` etc. diff --git a/docs/guide/wallets/access.md b/apps/docs/src/guide/wallets/access.md similarity index 70% rename from docs/guide/wallets/access.md rename to apps/docs/src/guide/wallets/access.md index bdaabde5a49..927c2f58b28 100644 --- a/docs/guide/wallets/access.md +++ b/apps/docs/src/guide/wallets/access.md @@ -1,10 +1,3 @@ ---- -title: "Access" -parent: "Wallets" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated # Wallet Access The kinds of operations we can perform with a `Wallet` instance depend on @@ -32,48 +25,39 @@ provides greater access via its private key. ## Basic Example +```ts:line-numbers +import { Wallet, WalletLocked, WalletUnlocked } from "fuels"; -```typescript - import { Wallet, WalletLocked, WalletUnlocked } from 'fuels'; - - // use the `generate` helper to make an Unlocked Wallet - const myWallet: WalletUnlocked = Wallet.generate(); +// use the `generate` helper to make an Unlocked Wallet +const myWallet: WalletUnlocked = Wallet.generate(); - // or use an Address to create a wallet - const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); +// or use an Address to create a wallet +const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); ``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L155-L163) - ---- +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L155-L163) ## Transitioning States A `WalletLocked` instance can be unlocked by providing the private key: - -```typescript - const lockedWallet: WalletLocked = Wallet.fromAddress(myWallet.address); - // unlock an existing wallet - let unlockedWallet: WalletUnlocked = lockedWallet.unlock(PRIVATE_KEY); - // or directly from a private key - unlockedWallet = Wallet.fromPrivateKey(PRIVATE_KEY); +```ts:line-numbers +const lockedWallet: WalletLocked = Wallet.fromAddress(myWallet.address); +// unlock an existing wallet +let unlockedWallet: WalletUnlocked = lockedWallet.unlock(PRIVATE_KEY); +// or directly from a private key +unlockedWallet = Wallet.fromPrivateKey(PRIVATE_KEY); ``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L167-L175) - ---- +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L167-L175) A `WalletUnlocked` instance can be locked using the `lock` method: - -```typescript - const newlyLockedWallet = unlockedWallet.lock(); +```ts:line-numbers +const newlyLockedWallet = unlockedWallet.lock(); ``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L177-L179) - ---- +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L177-L179) Most wallet constructors that create or generate a new wallet are provided on the `WalletUnlocked` type. Consider `lock`ing the wallet after the new private diff --git a/docs/guide/wallets/checking-balances-and-coins.md b/apps/docs/src/guide/wallets/checking-balances-and-coins.md similarity index 56% rename from docs/guide/wallets/checking-balances-and-coins.md rename to apps/docs/src/guide/wallets/checking-balances-and-coins.md index 9e45c04d492..5c8d0c89def 100644 --- a/docs/guide/wallets/checking-balances-and-coins.md +++ b/apps/docs/src/guide/wallets/checking-balances-and-coins.md @@ -1,32 +1,21 @@ ---- -title: "Checking Balances And Coins" -parent: "Wallets" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated # Checking balances and coins First, one should remember that, with UTXOs, each _coin_ is unique. Each UTXO corresponds to a unique _coin_, and said _coin_ has a corresponding _amount_ (the same way a dollar bill has either 10$ or 5$ face value). So, when you want to query the balance for a given asset ID, you want to query the sum of the amount in each unspent coin. This querying is done very easily with a wallet: - -```typescript - import { Wallet, WalletUnlocked, BigNumberish} from 'fuels'; - const balance: BigNumberish = await myWallet.getBalance(NativeAssetId); +```ts:line-numbers +import { Wallet, WalletUnlocked, BigNumberish } from "fuels"; +const balance: BigNumberish = await myWallet.getBalance(NativeAssetId); ``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L181-L184) ---- +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L181-L184) +--- If you want to query all the balances (i.e., get the balance for each asset ID in that wallet), then it is as simple as: - -```typescript - import { Wallet, WalletUnlocked, CoinQuantity} from 'fuels'; - const balances: CoinQuantity[] = await myWallet.getBalances(); +```ts:line-numbers +import { Wallet, WalletUnlocked, CoinQuantity } from "fuels"; +const balances: CoinQuantity[] = await myWallet.getBalances(); ``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L186-L189) - ---- +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L186-L189) diff --git a/docs/_guide/wallets/encrypting-and-storing-wallets.md b/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md similarity index 67% rename from docs/_guide/wallets/encrypting-and-storing-wallets.md rename to apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md index 4b79a8828a8..016f9424459 100644 --- a/docs/_guide/wallets/encrypting-and-storing-wallets.md +++ b/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md @@ -6,12 +6,20 @@ You can also manage a wallet using [JSON wallets](https://cryptobook.nakov.com/s You can create a random wallet and, at the same time, encrypt and store it. Then, later, you can recover the wallet if you know the master password: -[@code:typescript](./packages/wallet-manager/src/wallet-manager.test.ts#typedoc:wallet-manager-create) +```ts:line-numbers +const walletManager = new WalletManager(); +const password = "0b540281-f87b-49ca-be37-2264c7f260f7"; +const wallet = Wallet.generate(); + +await walletManager.unlock(password); +``` + +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.test.ts#L123-L129) ## Encrypting and storing a wallet created from a mnemonic or private key If you have already created a wallet Manager using a mnemonic phrase or a private key, you can also encrypt it and save it to disk: -```typescript +```ts:line-numbers await walletManager.lock(); ``` diff --git a/docs/_guide/wallets/index.md b/apps/docs/src/guide/wallets/index.md similarity index 98% rename from docs/_guide/wallets/index.md rename to apps/docs/src/guide/wallets/index.md index 5ec0e573df6..ebce8240c62 100644 --- a/docs/_guide/wallets/index.md +++ b/apps/docs/src/guide/wallets/index.md @@ -1,5 +1,3 @@ -[nav_order: 2] - # Managing wallets You can use wallets for many important things, for instance: diff --git a/docs/_guide/wallets/mnemonic-wallet.md b/apps/docs/src/guide/wallets/mnemonic-wallet.md similarity index 73% rename from docs/_guide/wallets/mnemonic-wallet.md rename to apps/docs/src/guide/wallets/mnemonic-wallet.md index 39c36cc0dd3..33a9fb35f00 100644 --- a/docs/_guide/wallets/mnemonic-wallet.md +++ b/apps/docs/src/guide/wallets/mnemonic-wallet.md @@ -8,4 +8,14 @@ The SDK gives you two wallets from mnemonic instantiation methods: one that take Here's how you can create wallets with both mnemonic phrases and derivation paths: -[@code:typescript](./packages/wallet-manager/src/wallet-manager.test.ts#typedoc:wallet-manager-mnemonic) +```ts:line-numbers +const walletManager = new WalletManager(); +const password = "0b540281-f87b-49ca-be37-2264c7f260f7"; + +await walletManager.unlock(password); + +// Add a vault of type mnemonic +await walletManager.addVault(config); +``` + +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.test.ts#L13-L22) diff --git a/apps/docs/src/guide/wallets/private-keys.md b/apps/docs/src/guide/wallets/private-keys.md new file mode 100644 index 00000000000..97fae43e0ae --- /dev/null +++ b/apps/docs/src/guide/wallets/private-keys.md @@ -0,0 +1,40 @@ +# Creating a wallet from a private key + +A new wallet with a randomly generated private key can be created by supplying `Wallet.generate`. + +```ts:line-numbers +import { Wallet, WalletLocked, WalletUnlocked } from "fuels"; + +// use the `generate` helper to make an Unlocked Wallet +const myWallet: WalletUnlocked = Wallet.generate(); + +// or use an Address to create a wallet +const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); +``` + +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L155-L163) + +--- + +Alternatively, you can create a wallet from a Private Key: + +```ts:line-numbers +// unlock an existing wallet +let unlockedWallet: WalletUnlocked = lockedWallet.unlock(PRIVATE_KEY); +// or directly from a private key +unlockedWallet = Wallet.fromPrivateKey(PRIVATE_KEY); +``` + +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L169-L174) + +--- + +You can obtain an address to a private key using the `Signer` package + +```ts:line-numbers +const signer = new Signer(PRIVATE_KEY); +// validate address +expect(wallet.address).toEqual(signer.address); +``` + +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L259-L263) diff --git a/apps/docs/src/guide/wallets/signing.md b/apps/docs/src/guide/wallets/signing.md new file mode 100644 index 00000000000..11b1d284ff4 --- /dev/null +++ b/apps/docs/src/guide/wallets/signing.md @@ -0,0 +1,38 @@ +# Signing + +Once you've instantiated your wallet in an unlocked state using one of the previously discussed methods, you can sign a message with `wallet.sign_message`. Below is a full example of how to sign and recover a message. + +```ts:line-numbers +import { WalletUnlocked, hashMessage, Signer } from "fuels"; +const wallet = WalletUnlocked.generate(); +const message = "doc-test-message"; +const signedMessage = await wallet.signMessage(message); +const hashedMessage = hashMessage(message); +const recoveredAddress = Signer.recoverAddress(hashedMessage, signedMessage); + +expect(wallet.privateKey).toBeTruthy(); +expect(wallet.publicKey).toBeTruthy(); +expect(wallet.address).toEqual(recoveredAddress); +``` + +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L197-L208) + +--- + +You can also sign a _transaction_ by using `wallet.sign_transaction`. Below is a full example of how to sign and recover a transaction. + +```ts:line-numbers +import { WalletUnlocked, hashMessage, Signer } from "fuels"; +const wallet = new WalletUnlocked(signTransactionTest.privateKey); +const transactionRequest = signTransactionTest.transaction; +const signedTransaction = await wallet.signTransaction(transactionRequest); +const verifiedAddress = Signer.recoverAddress( + hashTransaction(transactionRequest), + signedTransaction +); + +expect(signedTransaction).toEqual(signTransactionTest.signedTransaction); +expect(verifiedAddress).toEqual(wallet.address); +``` + +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet-unlocked.test.ts#L38-L50) diff --git a/apps/docs/src/guide/wallets/test-wallets.md b/apps/docs/src/guide/wallets/test-wallets.md new file mode 100644 index 00000000000..7bc9dde15c8 --- /dev/null +++ b/apps/docs/src/guide/wallets/test-wallets.md @@ -0,0 +1,61 @@ +# Setting up test wallets + +You'll often want to create one or more test wallets when testing your contracts. Here's how to do it. + +## Create a single wallet + +```ts:line-numbers +import { Wallet, WalletLocked, WalletUnlocked } from "fuels"; + +// use the `generate` helper to make an Unlocked Wallet +const myWallet: WalletUnlocked = Wallet.generate(); + +// or use an Address to create a wallet +const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); +``` + +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L155-L163) + +## Setting up multiple test wallets + +If you need multiple test wallets, they can be set up as follows: + +```ts:line-numbers +import { Provider, bn } from "fuels"; +import { generateTestWallet } from "@fuel-ts/wallet/test-utils"; +const provider = new Provider("http://127.0.0.1:4000/graphql"); +const assetIdA = + "0x0101010101010101010101010101010101010101010101010101010101010101"; +const assetIdB = + "0x0202020202020202020202020202020202020202020202020202020202020202"; + +// single asset +const walletA = await generateTestWallet(provider, [[42, NativeAssetId]]); + +// multiple assets +const walletB = await generateTestWallet(provider, [ + // [Amount, AssetId] + [100, assetIdA], + [200, assetIdB], + [30, NativeAssetId], +]); + +// this wallet has no assets +const walletC = await generateTestWallet(provider); + +// retrieve balances of wallets +const walletABalances = await walletA.getBalances(); +const walletBBalances = await walletB.getBalances(); +const walletCBalances = await walletC.getBalances(); + +// validate balances +expect(walletABalances).toEqual([{ assetId: NativeAssetId, amount: bn(42) }]); +expect(walletBBalances).toEqual([ + { assetId: NativeAssetId, amount: bn(30) }, + { assetId: assetIdA, amount: bn(100) }, + { assetId: assetIdB, amount: bn(200) }, +]); +expect(walletCBalances).toEqual([]); +``` + +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L212-L246) diff --git a/docs/guide/wallets/transferring-assets.md b/apps/docs/src/guide/wallets/transferring-assets.md similarity index 83% rename from docs/guide/wallets/transferring-assets.md rename to apps/docs/src/guide/wallets/transferring-assets.md index 18d63d7ca21..6d1a3b85e0f 100644 --- a/docs/guide/wallets/transferring-assets.md +++ b/apps/docs/src/guide/wallets/transferring-assets.md @@ -1,16 +1,8 @@ ---- -title: "Transferring Assets" -parent: "Wallets" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated # Transferring assets With `wallet.transfer` you can initiate a transaction to transfer an asset from your wallet to a target address. - -```rust +```rust:line-numbers // setup a provider and two test wallets const provider = new Provider('http://127.0.0.1:4000/graphql'); const sender = await generateTestWallet(provider, [[100, NativeAssetId]]); @@ -27,7 +19,5 @@ With `wallet.transfer` you can initiate a transaction to transfer an asset from expect(senderBalances).toEqual([{ assetId: NativeAssetId, amount: bn(99) }]); expect(receiverBalances).toEqual([{ assetId: NativeAssetId, amount: bn(1) }]); ``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/transfer.test.ts#L13-L29) - ---- +###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/transfer.test.ts#L13-L29) diff --git a/docs/index.md b/apps/docs/src/index.md similarity index 75% rename from docs/index.md rename to apps/docs/src/index.md index 04e62ffcad7..2f4e0356191 100644 --- a/docs/index.md +++ b/apps/docs/src/index.md @@ -1,20 +1,19 @@ ---- -layout: default -title: Home -nav_order: -6 ---- - -![Fuels-ts SDK logo](./assets/fuels-ts-logo.png) + ## Version -This doc was generated using Fuels `v{{site.data.versions.fuels}}`, Fuel Core `v{{site.data.versions.fuel-core}}`, Sway `v{{site.data.versions.sway}}`, and Forc `v{{site.data.versions.forc}}`. +This doc was generated using Fuels `v{{fuels}}`, Fuel Core `v{{fuelCore}}`, Sway `v{{sway}}`, and Forc `v{{forc}}`. ## Developer Quickstart Guide We recommend starting with the [Developer Quickstart](https://fuellabs.github.io/fuel-docs/master/quickstart/developer-quickstart.html) for a walk through on building your first DApp on Fuel. -- [Guide](./guide) +- [Guide](./guide/) - [Sample Application](https://github.com/FuelLabs/beta2-quickstart) - [Other examples and projects](https://github.com/FuelLabs/sway-applications) @@ -23,7 +22,7 @@ We recommend starting with the [Developer Quickstart](https://fuellabs.github.io Learn more about the Fuel Ecosystem. - [🌴 Sway](https://fuellabs.github.io/sway/) the new language. Empowering everyone to build reliable and efficient smart contracts. -- [🧰 Forc](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/forc/index.html) the Fuel toolbox. Build, deploy and manage your sway projects. +- 🧰 Forc the Fuel toolbox. Build, deploy and manage your sway projects. - [⚙️ Fuel Core](https://github.com/FuelLabs/fuel-core) the new FuelVM, a blazingly fast blockchain VM. - [🔗 Fuel Specs](https://github.com/FuelLabs/fuel-specs) the Fuel protocol specifications. - [🦀 RUST SDK](https://github.com/FuelLabs/fuels-rs) a robust SDK in rust. @@ -45,7 +44,7 @@ npm install fuels --save ## Import -```ts +```ts:line-numbers import { Wallet } from "fuels"; // Random Wallet @@ -57,7 +56,7 @@ console.log(new Wallet("0x0000...0000")); ## Calling Contracts -```ts +```ts:line-numbers import { Wallet, Contract, BigNumberish, BN } from "fuels"; import abi from "./abi.json"; @@ -73,11 +72,11 @@ const { transactionId, value } = await contract.functions console.log(transactionId, value); ``` -[READ MORE](./guide/contracts) +[READ MORE](./guide/contracts/) ## Deploying Contracts -```ts +```ts:line-numbers import { Provider, Contract } from "fuels"; // Byte code generated using: forc build import bytecode from "./bytecode.bin"; @@ -90,4 +89,4 @@ console.log(contract.id); ## License -The primary license for this repo is `Apache 2.0`, see [`LICENSE`](./LICENSE). +The primary license for this repo is `Apache 2.0`, see [`LICENSE`](https://github.com/FuelLabs/fuels-ts/blob/master/LICENSE). diff --git a/apps/docs/src/public/favicon.ico b/apps/docs/src/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..a28086ce4eba83476988a5e75e4118d23b7de72e GIT binary patch literal 15406 zcmeHNTWl3o6kVl)3TbH-A5f56h}u-5RZNYVDke>g+M>a#5I*po3K9dAfQiJ4KI}GaV1Ko4TUWZqI=TT5qHR$X{&|_bMR&|2> zZ1L*1ZgR_uPLMiu{oTyDdR|^XNFBQVbq^Qnihij&bp3`Fki?)#mR!m{{Tg(|dj7u_ zq+(sySN;!kcl0OmVHh2~tmw0iu`bCoIhHjnlAmnX;5f$85VmiWaXuQDLYvM-w>zcZ z(}UCKR2)*m^ycFKI8+E<_)JS%c=0#9Y|ks+vaz4Xi~GpJ22jVobU1K78}-^yyM*&g zRXQA`-x={G$ECo*7e56KCGpG5ArO8UIRwTR4lGIci?H}fbBKbUWWO-sFJ9&PT5R=` zB-+A+|HLuSL+`M>T|&4_|5&^{X~OsBqjEk6!C&_b=&T%QZNF>lzF$EXw}WaIyK-I= z=*}0S`Johk?{Uz)1^GC*$Uo|{!qXnh9CU!rGNSLza%)=@DKd%#+Dy`QCsMK2-p@j{H|yHZP$5O{SbhI34h=Z zUgNC@jvvPlCj5=Bgu_<8h~ftm{_@sn_)+{|!oU6z&_bSr$~-izh~D~_@;R!d3skq% ztw-k7-nqRAznuBrTXz=lhbM8|%PXyCv7e=#*C7?*Aov`&|LaTkNqCFa*);XrC*hbF z$*OSt{KVWoAN&h@`o^&05b?&e=SnN4W8;kDtKkWBcx{MXZ}k0e@7|5?GjsokbIP#{ z>~s0@Ea}g2oD>^WJCrP+l7GYSkake96h<#AWhIt|xIYX|q0z?a{?|c$C!?)@Y;`96 zp6%$h)tS56-Pg#n4ID>DZ2V;%C}#(22eR7+Gvk9XAE!h5w%=EkZY){(%XdLdH-c8S zg_q`=-Lod%H!#kvY;&#%@2&g?{sis$5hQ0SQAEyzc#Tvs{tKt^T+1KQIb< z@J)9=c^7{(rpn3rz~*;BcRUa3dM+=r@4WqEkhG^No8Ub(|GQoUEm-89-z{4W>iN{= z#e1H#^?lHym7uw2=0(o=>Xw1lJzaVJdw&7dUr?Br8m|TI{36e7^Ly?&f#g$N%9NKv z`M+a-At%L8Z0OOxeeC8lZngeYW#lg3>LonJ1?Df`Sjw5Q&PV^*nY_wL!gmxt-uiKUr7 zEqTU?rRHKA5{jij{2zFOeSbzV2NQpJR}@R!ALN|QTV8C4IrlEfU-J5eHxy%gxp<$Q zSUQ@|OHM3_4IDdqS=keaG50RXU-m)g@HfsnX3*b7d5Qb9lb1X;$Ua}hyyVMY`j^b# zg7P($b7D!2aVjsFVu@{t5KF%N?|sewt%!-M?Oo$Fg=3swEQQQVR{r~c1IhR85}!6+ zVcr+Tk{aXU#gdi(j?X|f=O)8l*;$mAWQ>a!OIH5!y@SF{^6um%eZC}PoFy*>h$Sn3 zSwkhsTd&I$OY(i9jLUkt0C~yEf9nTs-j{rrxG>k%8$i3iotb-cUfOX4)V2k*^zuSH zIS0CrbGT*AVC8QqZ>y(L?`Qd2&Tmp`zmcIy{E!k>Ibv*t&mbRV8zxUt8%FvGHM~#L U!~9Rhb{OG&JA2J~AhHMk1s&{izW@LL literal 0 HcmV?d00001 diff --git a/apps/docs/src/public/fuel-logo.png b/apps/docs/src/public/fuel-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..ac7ca8c70b8ca501c7dec6c43e15495888923611 GIT binary patch literal 3730 zcmbtX_g@p)77v(MLJK8SX&VHVsv_%dkTMXeltd;1p(-K}3pNy4K!{`|vH=^2)Hp~S z20>Ou5f=1;iprusN#KE^D^C`U5=4pu0`E@z6W$N=x#!&PIp6O&XC`+h0%owU8rhIc zAQ062{TN#a1SK|pty~UvVpTI7z_MzeU&KKIK}8$ClnABe`e0M(;1*v`Lc^2Q?}0;1 zgn}Rf;g3RTzRWhXC@l8y4RyHfY zJ=Rz-J8RTAV$|N0_pZM~{)6cH{rJ}L3@5@Aw+WR8)r`|k7q#1MDhd4og|eF1Z`L1k zQ%($gdqB8*I=E1FfWGkG;k8S}ZJil}g46@>(!%w~&L(si|^&QbxA9 zYg14ldzDL{uMsI<`DYM)a1g!jbc_OLOQVgXLr2`@J@bSQx9M2Q;;=7|+}Li*5}sJt zmgPohya~*zbINhFZd4v!e$v#H6sO&dE~d=yQpy(ESGP1J1dtxa?HU&@Hhf*SL(@tc zxr`98n?L)pfZ(AU`R1>WnM&Dq!*m(FL^`96oOT=XeYA_phabn4|VOYutP%ZexBftjy2%DJJP|xv$-+ z9rwGHPNt40dNq&Hwyj?$(r}EiecINNHuUGdHE7N3r+Kfmw++m)x$3#c!+OIXG#skQ zHTlrOo5ap{ufkOgH8wS^-o#C-|G2{WRhU?gF2+xspPBqp7FgS<0}0nHNVUyhE-_rM zo;`WoP-?`6YAi#E)9qcdlgaQ=W;MOqP-FJalo3>;9={@WX2}|4 z*W2nVgvOFscY}@)llqjulPpkHCQEpXZ<Xp3hLd*q^V#Y>bz3%1R(Hk zy5wzbrX|^6OmxN^v0IX+?P@}8$%YDro0y``B!V0kvw99mAH7_z9G4CfuY*!6Ll^$p zqhv`#lj*8lcvQONc#MA60*GA(V!w00LHBzJYb`&xkvlZ!M#Wl!*VNSnK! zj%mv$z1)e;LXo_7UYq?TxUpX&Q&X~mH&@V7&E+Kc@k)J|SGO!BE(O)8Ld@QkGG|#K zmR$4_Pcf+#va!Irw?ClC#Od%o4CmmwtmfSTc$8o;B4qm2Q&M=DNUSLdZPI3|)Hgan zK{V8VkTd(*)AkA;#=UkEN&m7(%m$+~grfZ;Sxt6kwK#Rdl{Vp0U|qQnPR1F`2a;!3 z;xUnBk#O18Uryq*!W#xseaY4Ed!@_poV{0iP@f}1CUJ#0Xg4Ut?8EYKU}x`Mm=@VE z6@*J}-Qz30mc0OG%`1(5!4lf3{Kpip>v)noCYHA2BF2I9EMZ_>CI!UMQ8$Fk*;9p6 z{%cxO`tZh}qK)czR@lv`-cgOk9zH`Ki zNmmr}cr>NQ&JXY3j5l{_E}y%DQ?ID`(X;`(mm7`Otb6e(>LZrYaUOf0JFKRWfLXX4H@8apB=9W9irYw3+yv4n^FS*DPUsGRIyqo$UfFL8;pu+?%E(#4tj4A9!Yb znE6)N>Eu)nZq}J$^MQ4}c$XYC)=(nHSkWbxCxed6zmp~5a$9|24f?OwV_&Vq1?tbB zCWmi*saIFrye7u<+QkZeY0veY=0_ z+2i*Lx)3-tT=&xsypvWl>_cG16^6?Vo0vSF1#Q|^7g$)Gv_kx;msiS3R zL-qLtB@*c9KsMS?H|>2zVdnvRB$(_CSs(7jjNkM$D`WO$Nx+5Y z8DGlLVEg6MR~>Udy{zkgVRXK@uxs+_gsxTZ^^GA1b4D(De;SWHh?qP-;ntYpHazBJ znmQpkkO$s~`DhE1^nbq;C4GCblqmH#kMxSmWMkvgjM?GJ(D;<3mCKT8n8v2IX4j^b zvizLK_k!k4Zrgg;$_iw*`GTnr8Yh$MXO43>!iHN?;CQC{v8B(C<|y$5(th0WF$ik=JRkhy2>%ZfB%`j#*_Hmj#> zZWj$bByK?4hlgP{u}FRPqkAU>rmw-?TA_ym;YXX9@5|9Mg(4n$Mj+}iVI>^ok;f_Q zpJ?blDk~wANA9Pv`+#G?N=W6AyR_I_f%5}vO@*kVmQl2UNA_nF^{%q9&}Ii)qK#Ut zku)CJR-0V_99`B3hezI}&29jWCToNY@r44L%{+2Mo(+#|AmEM@sn@imm8)!aSYd5i zuzoH&h1bLZmJS00q|Pqca}NZ5xn5I>cuQxZOmmj}=z01()QaH$ldF zWY7@e`wO_6iBwAfP+)5wdeeh>Q6J&BKzt;R+e4(Dq+v~3u=N?V&yRUA9N_>BM8FLK zfECt6fl(gX2Qmy14$#2zxQ~cbjE2={!RQ&Z7-Vn|4$!~^Tz>#qVKo#uiH8=03iE)#Js?xh0T^iPWFLabk|%HAh+;AX0%D_JIQb z4Ne;yh!kvw)d5EbDGgxe5Rp<(W)1^MH-t!A%`huXIL;eMUk#D^%rIZz1R?1qB4u!R z94Au$a|)Gf!)D7^LL&7c113=)qT?vp=2XNT78Q;oWcsj~IXU3n1(B9Z!T_uv?v4Y* zOa=f>-!KJ$kK`~8^vb_&Z^g0Q^wI=JSlxm^X+^j#3?83XVUEiIhVx@Dqol zUGTVo);9xb{XQVKWKjNupB8ounAZP#(&~7xwWZny^;os@jpv_!)H_!;0=9G8k9;{Y zAKPaD6ax$27Cx;YQmwoDioBMRTqJM3wv%-%Vni+S zN|hC+*SwwYw(OiVHO)dB{HY@Si743@$JJSqOXS9a`de8UZ#$K;srKsg8c`GOez4Nk z$=%J1m6KhWp|H}Ho}G^T`lVOUt3`Wf89}5O7om+tuNRQwdbXG z9F-hrQ2%DUhlF4WuOm5Yv9oFQCKABd@J9@j#v(O8o>PFvWeU)>Yy}<@i0{3NY8QcT z@swQw{f|Cg8Ufp8A}-upu{eYf$^lS$fa(e8C(m;AbUl8MaJ8_rqJ z*6qzi$meLk9XhgjdEY|W9kuI|dR}}6wdCP25?XRc=btx@`B$q}^)G!WZ2E0VG`6;? qLWNL0aMZGV;CA>N>2m6V>AKIO&(#7>JqCXv3I5)}j0Vp*-v0mwxR;3l literal 0 HcmV?d00001 diff --git a/docs/assets/my-fuel-dapp-preview.png b/apps/docs/src/public/my-fuel-dapp-preview.png similarity index 100% rename from docs/assets/my-fuel-dapp-preview.png rename to apps/docs/src/public/my-fuel-dapp-preview.png diff --git a/apps/docs/src/versions.data.ts b/apps/docs/src/versions.data.ts new file mode 100644 index 00000000000..1eee2d15dac --- /dev/null +++ b/apps/docs/src/versions.data.ts @@ -0,0 +1,59 @@ +import { versions } from '@fuel-ts/versions'; +import fs from 'fs'; +import path from 'path'; + +type TVersions = { + FUELS: string; + FUEL_CORE: string; + FORC: string; +}; + +const normalizeVersions = (params: TVersions) => { + let { FORC, FUELS, FUEL_CORE } = params; + + const versionRegex = /0\.0\.0/; + + try { + if (versionRegex.test(FORC)) { + const forcBinPath = path.join(__dirname, '../../../packages/forc-bin/package.json'); + const forcFile = fs.readFileSync(forcBinPath, 'utf8'); + const { config } = JSON.parse(forcFile); + ({ forcVersion: FORC } = config); + } + + if (versionRegex.test(FUELS)) { + const fuelsPath = path.join(__dirname, '../../../packages/fuels/package.json'); + const fuelsFile = fs.readFileSync(fuelsPath, 'utf8'); + ({ version: FUELS } = JSON.parse(fuelsFile)); + } + + if (versionRegex.test(FUEL_CORE)) { + const dockerfilePath = path.join(__dirname, '../../../services/fuel-core/Dockerfile'); + const dockerfile = fs.readFileSync(dockerfilePath, 'utf8'); + const regexFuelcore = /FROM ghcr\.io\/fuellabs\/fuel-core:v(\d+\.\d+\.\d+)/; + const match = dockerfile.match(regexFuelcore); + FUEL_CORE = match?.[1] || FUEL_CORE; + } + } catch { + return params; + } + + return { + FORC, + FUELS, + FUEL_CORE, + }; +}; + +export default { + load() { + const { FORC, FUELS, FUEL_CORE } = normalizeVersions(versions); + + return { + forc: FORC, + sway: FORC, + fuels: FUELS, + fuelCore: FUEL_CORE, + }; + }, +}; diff --git a/apps/docs/src/vite.config.ts b/apps/docs/src/vite.config.ts new file mode 100644 index 00000000000..f05745ec1e6 --- /dev/null +++ b/apps/docs/src/vite.config.ts @@ -0,0 +1,12 @@ +import { SearchPlugin } from 'vitepress-plugin-search'; + +export default { + plugins: [ + SearchPlugin({ + tokenize: 'full', + previewLength: 20, + buttonLabel: 'Search', + placeholder: 'Search docs', + }), + ], +}; diff --git a/apps/docs/tsconfig.json b/apps/docs/tsconfig.json new file mode 100644 index 00000000000..25c252c28b9 --- /dev/null +++ b/apps/docs/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "./dist", + "rootDir": "./", + "baseUrl": "./" + }, + "include": ["./src", "./.vitepress", "./types"], + "exclude": ["./.vitepress/cache"] +} diff --git a/apps/docs/types/index.d.ts b/apps/docs/types/index.d.ts new file mode 100644 index 00000000000..9d071b95f94 --- /dev/null +++ b/apps/docs/types/index.d.ts @@ -0,0 +1 @@ +declare module 'vitepress-plugin-search'; diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 66ecc2bdc02..00000000000 --- a/docs/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -# Gem files -Gemfile.lock - -# Jekyll files -.jekyll-cache -_site - -# examples node_modules -node_modules \ No newline at end of file diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index 5cf11bc2861..00000000000 --- a/docs/Gemfile +++ /dev/null @@ -1,35 +0,0 @@ -source "https://rubygems.org" -# Hello! This is where you manage which Jekyll version is used to run. -# When you want to use a different version, change it below, save the -# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: -# -# bundle exec jekyll serve -# -# This will help ensure the proper Jekyll version is running. -# Happy Jekylling! -# gem "jekyll", "~> 4.2.2" -# This is the default theme for new Jekyll sites. You may change this to anything you like. -gem "minima", "~> 2.5" -# If you want to use GitHub Pages, remove the "gem "jekyll"" above and -# uncomment the line below. To upgrade, run `bundle update github-pages`. -gem "github-pages", "~> 227", group: :jekyll_plugins -# If you have any plugins, put them here! -group :jekyll_plugins do - gem "jekyll-feed", "~> 0.12" -end - -# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem -# and associated library. -platforms :mingw, :x64_mingw, :mswin, :jruby do - gem "tzinfo", "~> 1.2" - gem "tzinfo-data" -end - -# Performance-booster for watching directories on Windows -gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] - -# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem -# do not have a Java counterpart. -gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] - -gem "webrick", "~> 1.7" diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index ce6afef0cb3..00000000000 --- a/docs/README.md +++ /dev/null @@ -1,21 +0,0 @@ -## Docs - -To run locally follow: - -[Test site locally with Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll) - -Or: - -### Install dependencies - -```sh -bundle install -``` - -### Run serve - -```sh -JEKYLL_GITHUB_TOKEN= bundle exec jekyll serve -``` - -Replace the `GH_TOKEN` with a [GitHub Personal Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), with just `public_repo` selected. diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index d4dbcb09d46..00000000000 --- a/docs/_config.yml +++ /dev/null @@ -1,30 +0,0 @@ -#Configuration -remote_theme: pmarsceill/just-the-docs -exclude: ["README.md", "packages/README.md", "examples", "node_modules"] - -# Set a path/url to a logo that will be displayed instead of the title -title: "Fuels-ts" -logo: "./assets/fuels-ts-logo.png" - -# Features -search_enabled: true - -search: - heading_level: 6 - previews: 3 - preview_words_before: 5 - preview_words_after: 10 - tokenizer_separator: /[\s/]+/ - rel_url: false - button: false - -heading_anchors: true - -# Theme -color_scheme: "fuel-dark" - -aux_links: - "GitHub": - - "//github.com/FuelLabs/fuels-ts" - -footer_content: "" diff --git a/docs/_data/versions.yml b/docs/_data/versions.yml deleted file mode 100644 index 4179dfd199a..00000000000 --- a/docs/_data/versions.yml +++ /dev/null @@ -1,5 +0,0 @@ -# generated-file -fuels: 0.35.0 -fuel-core: 0.17.3 -sway: 0.35.3 -forc: 0.35.3 diff --git a/docs/_guide/abi-typegen/generating-types-from-abi.md b/docs/_guide/abi-typegen/generating-types-from-abi.md deleted file mode 100644 index d993d16453d..00000000000 --- a/docs/_guide/abi-typegen/generating-types-from-abi.md +++ /dev/null @@ -1,69 +0,0 @@ -[nav_order: 0] - -# Generating Types from ABI - -## Installation - -First we install `fuels` to our project: - -```sh -yarn add fuels -``` - -## Help - -A first glance at the docs: - -```console -$ yarn exec fuels typegen -h - -Usage: fuels typegen [options] - -generate typescript from contract abi json files - -Options: - -i, --inputs directory path for generated files - -c, --contract generate code for contracts [default] - -s, --script generate code for scripts - --silent omit output messages - -h, --help display help for command -``` - -## Generating Types for Contracts - -We can omit the `--contract` option here; its the default: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types -``` - -**Notes** - -- `-i`: the relative path/global to the ABI JSON file(s) -- `-o`: the output directory for the generated types -- `-c, --contract`: tells we want to generate types for contracts _(default, can be omitted)_ - -## Generating Types for Scripts - -Note how we make use of the option `--script` in this case: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types --script -``` - -## Generating Types for Predicates - -Note how we make use of the option `--predicate` in this case: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types --predicate -``` - ---- - -See also: - -- [Using Generated Contract Types](./using-generated-types.md#using-generated-contract-types) -- [Using Generated Script Types](./using-generated-types.md#using-generated-script-types) -- [Using Generated Predicate Types](./using-generated-types.md#using-generated-predicate-types) diff --git a/docs/_guide/abi-typegen/index.md b/docs/_guide/abi-typegen/index.md deleted file mode 100644 index 405a2859b90..00000000000 --- a/docs/_guide/abi-typegen/index.md +++ /dev/null @@ -1,50 +0,0 @@ -[nav_order: 1] - -# ABI Typegen - -## The JSON ABI file - -Whether you want to deploy or connect to a pre-existing smart contract, the [JSON ABI](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/sway_quickstart.html?highlight=abi#abi) file is what makes it possible. - -It tells the SDK about the [ABI methods](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/sway_quickstart.html?highlight=abi#abi) in your [Smart Contracts](https://fuellabs.github.io/sway/vv{{site.data.versions.sway}}/book/sway-program-types/smart_contracts.html) and [Scripts](https://fuellabs.github.io/sway/vv{{site.data.versions.sway}}/book/sway-program-types/scripts.html). - -Given the following Sway smart contract: - -```rust -contract; - -abi MyContract { - fn test_function() -> bool; -} - -impl MyContract for Contract { - fn test_function() -> bool { - true - } -} -``` - -The JSON ABI file would look something like this: - -```json -$ cat out/debug/my-test-abi.json -[ - { - "type": "function", - "inputs": [], - "name": "test_function", - "outputs": [ - { - "name": "", - "type": "bool", - "components": null - } - ] - } -] -``` - -See also: - -- [Generating Types](./generating-types-from-abi.md) -- [Using Generated Types](./using-generated-types.md) diff --git a/docs/_guide/abi-typegen/using-generated-types.md b/docs/_guide/abi-typegen/using-generated-types.md deleted file mode 100644 index 1d0266d6b46..00000000000 --- a/docs/_guide/abi-typegen/using-generated-types.md +++ /dev/null @@ -1,92 +0,0 @@ -[nav_order: 1] - - - -# Using Generated Types - -After generating types via: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types -``` - -We can use these files like so: - -```ts -import { Wallet } from "fuels"; -import { MyContract__factory } from "./types"; - -const contractId = "0x..."; -const wallet = Wallet.fromAddress("..."); -const contract = MyContract__factory.connect(contractId, wallet); - -// All contract methods are available under functions with the correct types -const { transactionId, value } = await contract.functions.my_fn(1).call(); - -console.log(transactionId, value); -``` - -# Using Generated Script Types - -After generating types via: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types --script -``` - -We can use these files like so: - -```ts -import { Wallet } from "fuels"; -import { MyScript__factory } from "./types"; - -const wallet = Wallet.fromAddress("..."); -const script = ScriptAbi__factory.createInstance(wallet); - -const { value, logs } = await script.functions.main(1).call(); - -console.log({ value, logs }); -``` - -# Using Generated Predicate Types - -Consider the following predicate: - -[@code:rust](./packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw#typedoc:Predicate-main-args) - -Now, after generating types via: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types --predicate -``` - -We can use these files like so: - -```ts -import { Wallet } from "fuels"; -import { MyPredicate__factory } from "./types"; - -const wallet = Wallet.fromAddress("..."); -const predicate = MyPredicate__factory.createInstance(); - -await predicate - .setData({ - has_account: true, - total_complete: 100, - }) - .transfer(wallet.address, ); - -const walletBalance = await wallet.getBalance(); -const predicateBalance = await predicate.getBalance(); - -console.log({ - walletBalance, - predicateBalance, -}); -``` - -See also: - -- [Generating Types for Contracts](./generating-types-from-abi.md#generating-types-for-contracts) -- [Generating Types for Scripts](./generating-types-from-abi.md#generating-types-for-scripts) -- [Generating Types for Predicates](./generating-types-from-abi.md#generating-types-for-predicates) diff --git a/docs/_guide/contracts/deploying-contracts.md b/docs/_guide/contracts/deploying-contracts.md deleted file mode 100644 index 6d8baf64938..00000000000 --- a/docs/_guide/contracts/deploying-contracts.md +++ /dev/null @@ -1,25 +0,0 @@ -[nav_order: 12] - -# Deploying contracts - -There are two main ways of working with contracts in the SDK: deploying a contract with SDK or using the SDK to interact with existing contracts. - -## Deploying a contract binary - -Once you've written a contract in Sway and compiled it with `forc build` (read [here](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/index.html) for more on how to work with Sway), you'll have in your hands two important artifacts: the compiled binary file and the JSON ABI file. - -Below is how you can deploy your contracts using the SDK. For more details about each component in this process, read about [the FuelVM binary file](./the-fuelvm-binary-file.md) and [the JSON ABI file](./the-json-abi-file.md). - -### The deploy functions - -If you are only interested in a single instance of your contract, then use `deploy` - -[@code:typescript](./packages/fuel-gauge/src/contract-factory.test.ts#typedoc:contract-setup) - -You can then use the contract methods very simply: - -```typescript -const contact = await factory.deployContract(); -``` - -Also read about how to [generate-contract-types-from-abi](./generate-contract-types-from-abi.md), allowing for rich TypeScript backed Fuel usage. diff --git a/docs/_guide/local-docs.md b/docs/_guide/local-docs.md deleted file mode 100644 index 00805b13dcb..00000000000 --- a/docs/_guide/local-docs.md +++ /dev/null @@ -1,49 +0,0 @@ -There are two parts to the fuels-ts repository documentation - -## Part One: Typedoc -[typedoc](https://typedoc.org/) gathers all types, functions, classes, etc., from our source code. It will read through the `packages` folder, collect all that information, and convert it into a markdown file, modifying the contents of [`docs/packages`](https://github.com/FuelLabs/fuels-ts/tree/master/docs/packages). - - -Furthermore, I've enhanced typedoc to also build out the [Guide documentation](https://fuellabs.github.io/fuels-ts/guide/) with a custom plugin called `typedoc-plugin-guide-builder` that's in our [repo here](https://github.com/FuelLabs/fuels-ts/tree/master/scripts/typedoc-plugin-guide-builder) (We should move this to a standalone plugin later on). This portion of the typedoc process takes source files from [`docs/_guide`](https://github.com/FuelLabs/fuels-ts/tree/master/docs/_guide), runs them through the plugins and renders code snippets pulled from source code. - -#### How does the `typedoc-plugin-guide-builder` plugin work? -See how this markdown document refers to [Sway](https://github.com/FuelLabs/fuels-ts/blob/master/docs/_guide/testing/testing-with-jest.md?plain=1#L6) and [TypeScript](https://github.com/FuelLabs/fuels-ts/blob/master/docs/_guide/testing/testing-with-jest.md?plain=1#L9) code (also note the language hints like `[@code:rust]`, and then see how [reference in the TypeScript code](https://github.com/FuelLabs/fuels-ts/blob/master/packages/example-contract/src/example-contract.test.ts#L1) is written - -It writes the final results to [`docs/guide`](https://github.com/FuelLabs/fuels-ts/tree/master/docs/guide). - -### Intermission: Repo -Once typedoc is done generating the markdown docs, the data inside `docs/packages` and `docs/guide` are highly useful. These are complete docs that are checked into the repo and can be found alongside the code for TS-SDK consumers. **One could view and use them just fine inside GitHub file browser or locally within their own filesystem.** - -## Part Two: Jekyll -[jekyll](https://jekyllrb.com/) does the work of rendering the docs in markdown into something the browser understands: HTML. There are currently some [open issues to possibly switch off Jekyll](https://github.com/FuelLabs/fuels-ts/issues/457). We shall see, but [GitHub pages uses Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll) so its the easy choice for now. - -Anyways, Jekyll is configured with the [just the docs](https://github.com/just-the-docs/just-the-docs) theme (actually a modified version of it [found here within Fuels org](https://github.com/FuelLabs/typedoc-just-the-docs-theme)). The only interesting thing to point out here is also that we [update this file _data/versions.yml](https://github.com/FuelLabs/fuels-ts/blob/master/docs/_data/versions.yml) on each successful build to master, so that the versions rendered in the docs are accurate relative to the repo's versions. - -## Finale: CI -Our build tools in CI automatically update the docs inside the repo after a successful new build hits the `master` branch. This is accomplished by the [GitHub action](https://github.com/FuelLabs/fuels-ts/blob/master/.github/workflows/release.yaml#L48) that calls `pnpm changeset:version-with-docs` which runs [this script to rebuild docs and commit](https://github.com/FuelLabs/fuels-ts/blob/master/scripts/changeset-version-with-docs.ts) them into the repo (see[ sample commit here](https://github.com/FuelLabs/fuels-ts/pull/669/commits/8fc3bb1eea57e73139965cf32f36b24537df4906)) as part of the [final update PR](https://github.com/FuelLabs/fuels-ts/pull/669). - -## TLDR: Local docs development -#### 1. The one-time local setup for the custom plugin `typedoc-plugin-guide-builder` is to compile the Typescript, do -```bash -# start in root of project -cd ./scripts/typedoc-plugin-guide-builder -tsc -``` - -#### 2. Next, you'll want to rebuild the generated typedoc files (see Part One above to understand why) -```bash -# start in root of project -pnpm typedoc - -# if you plan to make a lot of updates, use `watch` -pnpm typedoc --watch -``` - -#### 3. Finally, if you want to see how the docs will appear fully rendered as they do [on the docs website](https://fuellabs.github.io/fuels-ts/), you will need to run Jekyll (see Part Two above to understand why). [Setup Jekyll here](https://jekyllrb.com/docs/) if you haven't already. -```bash -# start in root of project -cd docs - -# this will automatically `watch`, note that the initial build and "updates" can take several seconds/minutes -bundle exec jekyll serve -``` \ No newline at end of file diff --git a/docs/_guide/scripts/index.md b/docs/_guide/scripts/index.md deleted file mode 100644 index 2fa584586f0..00000000000 --- a/docs/_guide/scripts/index.md +++ /dev/null @@ -1,7 +0,0 @@ -[nav_order: 7] - -# Scripts - -A Script, in Sway, is runnable bytecode on the chain which executes once to perform some task. A script can return a single value of any type. - -Learn more about Scripts [here](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/sway-program-types/scripts.html#scripts-and-the-sdks). diff --git a/docs/_guide/scripts/instantiating-a-script.md b/docs/_guide/scripts/instantiating-a-script.md deleted file mode 100644 index 4033364029d..00000000000 --- a/docs/_guide/scripts/instantiating-a-script.md +++ /dev/null @@ -1,9 +0,0 @@ -[nav_order: 1] - -# Instantiating a script - -Similar to contracts and predicates, once you've written a script in Sway and compiled it with `forc build` (read [here](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/index.html) for more on how to work with Sway), you'll get the script binary. Using the binary, you can instantiate a `script` as shown in the code snippet below: - -[@code:typescript](./packages/script/src/script.test.ts#typedoc:script-init) - -In the [next section](./calling-a-script.md), we show how to call a script. diff --git a/docs/_guide/testing/index.md b/docs/_guide/testing/index.md deleted file mode 100644 index f070c231253..00000000000 --- a/docs/_guide/testing/index.md +++ /dev/null @@ -1,26 +0,0 @@ -[nav_order: 8] - -# Testing - -In order to test your Sway and TS-SDK applications, you can test your code in a number of ways: - -1. Testing with TS-SDK: Compiling you Sway code and connecting to the methods using TS-SDK and JS testing frameworks -2. Using `forc test` see [the Sway docs](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/forc/commands/forc_test.html) for more info -3. Using [the Rust SDK](https://fuellabs.github.io/fuels-rs/v0.31.1/testing/index.html) - -### Testing with TS-SDK - -To test your Sway applications using the TS-SDK, you can pick whatever testing library or framework you feel comfortable with. There isn't any specific testing framework needed, it is entirely up to the user. That being said, the TS-SDK uses [Jest](https://jestjs.io/) for its tests. - -### Wallet Test Utilities - -You'll often want to create one or more test wallets when testing your contracts. - -For this, you can find two simple utilities on the wallet package: - -- [`@fuel-ts/wallet`](https://github.com/FuelLabs/fuels-ts/tree/master/packages/wallet#test-utilities) - -See also: - -1. [Setting up test wallets](../wallets/test-wallets.md) -2. [Testing with Jest](./testing-with-jest.md) diff --git a/docs/_guide/types/address.md b/docs/_guide/types/address.md deleted file mode 100644 index e890d3a3b3e..00000000000 --- a/docs/_guide/types/address.md +++ /dev/null @@ -1,23 +0,0 @@ -# Address - -`Address` is a wrapper on `Bytes32` and `Bech32` (see [Address documentation](../../packages/fuel-ts-address/)). The available interface of the TS-SDK Address contains many useful functions to switch between Address formats: - -[@code:typescript](./packages/interfaces/src/index.ts#typedoc:AbstractAddress) - -These are the main ways of creating an `Address` - -From a [Bech32](./bech32.md) Address: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Address-bech32) - -From a Public Key: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Address-publicKey) - -From a [256 Bit Address](./bits256.md) Address: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Address-b256) - -You can also use a number of utilities as part of the Address Class: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:Address-utils) diff --git a/docs/_guide/wallets/access.md b/docs/_guide/wallets/access.md deleted file mode 100644 index 518a2960cf7..00000000000 --- a/docs/_guide/wallets/access.md +++ /dev/null @@ -1,51 +0,0 @@ -# Wallet Access - -The kinds of operations we can perform with a `Wallet` instance depend on -whether or not we have access to the wallet's private key. - -In order to differentiate between `Wallet` instances that know their private key -and those that do not, we use the `WalletUnlocked` and `WalletLocked` types -respectively. - -## Wallet States - -The `WalletUnlocked` type represents a wallet whose private key is known and -stored internally in memory. A wallet must be of type `WalletUnlocked` in order -to perform operations that involve [signing messages or -transactions](./signing.md). - -The `WalletLocked` type represents a wallet whose private key is _not_ known or stored -in memory. Instead, `WalletLocked` only knows its public address. A `WalletLocked` cannot be -used to sign transactions, however it may still perform a whole suite of useful -operations including listing transactions, assets, querying balances, and so on. - -Note that the `WalletUnlocked` type implements most methods available on the `WalletLocked` -type. In other words, `WalletUnlocked` can be thought of as a thin wrapper around `WalletLocked` that -provides greater access via its private key. - -## Basic Example - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallets) - -## Transitioning States - -A `WalletLocked` instance can be unlocked by providing the private key: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-locked-to-unlocked) - -A `WalletUnlocked` instance can be locked using the `lock` method: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-unlocked-to-locked) - -Most wallet constructors that create or generate a new wallet are provided on -the `WalletUnlocked` type. Consider `lock`ing the wallet after the new private -key has been handled in order to reduce the scope in which the wallet's private -key is stored in memory. - -## Design Guidelines - -When designing APIs that accept a wallet as an input, we should think carefully -about the kind of access that we require. API developers should aim to minimise -their usage of `WalletUnlocked` in order to ensure private keys are stored in -memory no longer than necessary to reduce the surface area for attacks and -vulnerabilities in downstream libraries and applications. diff --git a/docs/_guide/wallets/checking-balances-and-coins.md b/docs/_guide/wallets/checking-balances-and-coins.md deleted file mode 100644 index cd439fb11c9..00000000000 --- a/docs/_guide/wallets/checking-balances-and-coins.md +++ /dev/null @@ -1,9 +0,0 @@ -# Checking balances and coins - -First, one should remember that, with UTXOs, each _coin_ is unique. Each UTXO corresponds to a unique _coin_, and said _coin_ has a corresponding _amount_ (the same way a dollar bill has either 10$ or 5$ face value). So, when you want to query the balance for a given asset ID, you want to query the sum of the amount in each unspent coin. This querying is done very easily with a wallet: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-check-balance) - -If you want to query all the balances (i.e., get the balance for each asset ID in that wallet), then it is as simple as: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-check-balances) diff --git a/docs/_guide/wallets/private-keys.md b/docs/_guide/wallets/private-keys.md deleted file mode 100644 index 5018180d2eb..00000000000 --- a/docs/_guide/wallets/private-keys.md +++ /dev/null @@ -1,12 +0,0 @@ -# Creating a wallet from a private key - -A new wallet with a randomly generated private key can be created by supplying `Wallet.generate`. - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallets) - -Alternatively, you can create a wallet from a Private Key: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-from-private-key) - -You can obtain an address to a private key using the `Signer` package -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:signer-address) diff --git a/docs/_guide/wallets/signing.md b/docs/_guide/wallets/signing.md deleted file mode 100644 index 4f58904f5e2..00000000000 --- a/docs/_guide/wallets/signing.md +++ /dev/null @@ -1,9 +0,0 @@ -# Signing - -Once you've instantiated your wallet in an unlocked state using one of the previously discussed methods, you can sign a message with `wallet.sign_message`. Below is a full example of how to sign and recover a message. - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-message-signing) - -You can also sign a _transaction_ by using `wallet.sign_transaction`. Below is a full example of how to sign and recover a transaction. - -[@code:typescript](./packages/wallet/src/wallet-unlocked.test.ts#typedoc:wallet-transaction-signing) diff --git a/docs/_guide/wallets/test-wallets.md b/docs/_guide/wallets/test-wallets.md deleted file mode 100644 index 9ab9c45b4d4..00000000000 --- a/docs/_guide/wallets/test-wallets.md +++ /dev/null @@ -1,13 +0,0 @@ -# Setting up test wallets - -You'll often want to create one or more test wallets when testing your contracts. Here's how to do it. - -## Create a single wallet - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallets) - -## Setting up multiple test wallets - -If you need multiple test wallets, they can be set up as follows: - -[@code:typescript](./packages/fuel-gauge/src/doc-examples.test.ts#typedoc:wallet-setup) diff --git a/docs/_guide/wallets/transferring-assets.md b/docs/_guide/wallets/transferring-assets.md deleted file mode 100644 index e3de9c9e7e9..00000000000 --- a/docs/_guide/wallets/transferring-assets.md +++ /dev/null @@ -1,5 +0,0 @@ -# Transferring assets - -With `wallet.transfer` you can initiate a transaction to transfer an asset from your wallet to a target address. - -[@code:rust](./packages/wallet/src/transfer.test.ts#typedoc:wallet-transfer) diff --git a/docs/_includes/js/custom.js b/docs/_includes/js/custom.js deleted file mode 100644 index 8c75d2929ae..00000000000 --- a/docs/_includes/js/custom.js +++ /dev/null @@ -1,37 +0,0 @@ -function ready(callback){ - // in case the document is already rendered - if (document.readyState!='loading') callback(); - // modern browsers - else if (document.addEventListener) document.addEventListener('DOMContentLoaded', callback); - // IE <= 8 - else document.attachEvent('onreadystatechange', function(){ - if (document.readyState=='complete') callback(); - }); -} - -ready(function(){ - let codeBlocks = document.querySelectorAll('pre.highlight'); - - codeBlocks.forEach(function (codeBlock) { - let copyButton = document.createElement('button'); - - copyButton.className = 'btn-copy-code fs-3 btn btn-green'; - copyButton.type = 'button'; - copyButton.ariaLabel = 'Copy code to clipboard'; - copyButton.innerText = 'Copy'; - - codeBlock.append(copyButton); - - copyButton.addEventListener('click', function () { - let code = codeBlock.querySelector('code').innerText.trim(); - window.navigator.clipboard.writeText(code); - - copyButton.innerText = 'Copied'; - let fourSeconds = 2000; - - setTimeout(function () { - copyButton.innerText = 'Copy'; - }, fourSeconds); - }); - }); -}); \ No newline at end of file diff --git a/docs/_sass/color_schemes/fuel-dark.scss b/docs/_sass/color_schemes/fuel-dark.scss deleted file mode 100644 index 4dd101c9468..00000000000 --- a/docs/_sass/color_schemes/fuel-dark.scss +++ /dev/null @@ -1,22 +0,0 @@ -$green-000: #58c09b; - -$body-background-color: $grey-dk-300; -$sidebar-color: $grey-dk-300; -$border-color: $grey-dk-200; - -$body-text-color: $grey-lt-300; -$body-heading-color: $grey-lt-000; -$nav-child-link-color: $grey-dk-000; -$search-result-preview-color: $grey-dk-000; - -$link-color: $green-000; -$btn-primary-color: $green-000; -$base-button-color: $grey-dk-250; - -$code-background-color: $grey-dk-250; -$search-background-color: $grey-dk-250; -$table-background-color: $grey-dk-250; -$feedback-color: darken($sidebar-color, 3%); - -@import "./pygments-tomorrow-night"; -$code-background-color: #1d1f21; diff --git a/docs/_sass/color_schemes/pygments-tomorrow-night.scss b/docs/_sass/color_schemes/pygments-tomorrow-night.scss deleted file mode 100644 index f56a191cf54..00000000000 --- a/docs/_sass/color_schemes/pygments-tomorrow-night.scss +++ /dev/null @@ -1,66 +0,0 @@ -/*! tomorrow night; https://github.com/MozMorris/tomorrow-pygments */ -.highlight, .highlight pre, .highlight table { background: #1d1f21 !important; color: #c5c8c6 !important; } -.highlight .hll { background-color: #373b41 !important; } -.highlight .c { color: #969896 !important; } /* Comment */ -.highlight .err { color: #cc6666 !important; } /* Error */ -.highlight .k { color: #b294bb !important; } /* Keyword */ -.highlight .l { color: #de935f !important; } /* Literal */ -.highlight .n, .highlight .h { color: #c5c8c6 !important; } /* Name */ -.highlight .o { color: #8abeb7 !important; } /* Operator */ -.highlight .p { color: #c5c8c6 !important; } /* Punctuation */ -.highlight .cm { color: #969896 !important; } /* Comment.Multiline */ -.highlight .cp { color: #969896 !important; } /* Comment.Preproc */ -.highlight .c1 { color: #969896 !important; } /* Comment.Single */ -.highlight .cs { color: #969896 !important; } /* Comment.Special */ -.highlight .gd { color: #cc6666 !important; } /* Generic.Deleted */ -.highlight .ge { font-style: italic !important; } /* Generic.Emph */ -.highlight .gh { color: #c5c8c6 !important; font-weight: bold !important; } /* Generic.Heading */ -.highlight .gi { color: #b5bd68 !important; } /* Generic.Inserted */ -.highlight .gp { color: #969896 !important; font-weight: bold !important; } /* Generic.Prompt */ -.highlight .gs { font-weight: bold !important; } /* Generic.Strong */ -.highlight .gu { color: #8abeb7 !important; font-weight: bold !important; } /* Generic.Subheading */ -.highlight .kc { color: #b294bb !important; } /* Keyword.Constant */ -.highlight .kd { color: #b294bb !important; } /* Keyword.Declaration */ -.highlight .kn { color: #8abeb7 !important; } /* Keyword.Namespace */ -.highlight .kp { color: #b294bb !important; } /* Keyword.Pseudo */ -.highlight .kr { color: #b294bb !important; } /* Keyword.Reserved */ -.highlight .kt { color: #f0c674 !important; } /* Keyword.Type */ -.highlight .ld { color: #b5bd68 !important; } /* Literal.Date */ -.highlight .m { color: #de935f !important; } /* Literal.Number */ -.highlight .s { color: #b5bd68 !important; } /* Literal.String */ -.highlight .na { color: #81a2be !important; } /* Name.Attribute */ -.highlight .nb { color: #c5c8c6 !important; } /* Name.Builtin */ -.highlight .nc { color: #f0c674 !important; } /* Name.Class */ -.highlight .no { color: #cc6666 !important; } /* Name.Constant */ -.highlight .nd { color: #8abeb7 !important; } /* Name.Decorator */ -.highlight .ni { color: #c5c8c6 !important; } /* Name.Entity */ -.highlight .ne { color: #cc6666 !important; } /* Name.Exception */ -.highlight .nf { color: #81a2be !important; } /* Name.Function */ -.highlight .nl { color: #c5c8c6 !important; } /* Name.Label */ -.highlight .nn { color: #f0c674 !important; } /* Name.Namespace */ -.highlight .nx { color: #81a2be !important; } /* Name.Other */ -.highlight .py { color: #c5c8c6 !important; } /* Name.Property */ -.highlight .nt { color: #8abeb7 !important; } /* Name.Tag */ -.highlight .nv { color: #cc6666 !important; } /* Name.Variable */ -.highlight .ow { color: #8abeb7 !important; } /* Operator.Word */ -.highlight .w { color: #c5c8c6 !important; } /* Text.Whitespace */ -.highlight .mf { color: #de935f !important; } /* Literal.Number.Float */ -.highlight .mh { color: #de935f !important; } /* Literal.Number.Hex */ -.highlight .mi { color: #de935f !important; } /* Literal.Number.Integer */ -.highlight .mo { color: #de935f !important; } /* Literal.Number.Oct */ -.highlight .sb { color: #b5bd68 !important; } /* Literal.String.Backtick */ -.highlight .sc { color: #c5c8c6 !important; } /* Literal.String.Char */ -.highlight .sd { color: #969896 !important; } /* Literal.String.Doc */ -.highlight .s2 { color: #b5bd68 !important; } /* Literal.String.Double */ -.highlight .se { color: #de935f !important; } /* Literal.String.Escape */ -.highlight .sh { color: #b5bd68 !important; } /* Literal.String.Heredoc */ -.highlight .si { color: #de935f !important; } /* Literal.String.Interpol */ -.highlight .sx { color: #b5bd68 !important; } /* Literal.String.Other */ -.highlight .sr { color: #b5bd68 !important; } /* Literal.String.Regex */ -.highlight .s1 { color: #b5bd68 !important; } /* Literal.String.Single */ -.highlight .ss { color: #b5bd68 !important; } /* Literal.String.Symbol */ -.highlight .bp { color: #c5c8c6 !important; } /* Name.Builtin.Pseudo */ -.highlight .vc { color: #cc6666 !important; } /* Name.Variable.Class */ -.highlight .vg { color: #cc6666 !important; } /* Name.Variable.Global */ -.highlight .vi { color: #cc6666 !important; } /* Name.Variable.Instance */ -.highlight .il { color: #de935f !important; } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss deleted file mode 100644 index 7796441385d..00000000000 --- a/docs/_sass/custom/custom.scss +++ /dev/null @@ -1,28 +0,0 @@ -.search-input { - color: $grey-lt-300; -} - -.nav-list .nav-list-item > .nav-list .nav-list-item .nav-list-link.active { - color: $grey-lt-300; -} - -pre.highlight { - position: relative; -} - -pre.highlight > .btn-copy-code { - opacity: 0; - position: absolute; - top: 0; - right: 0; - z-index: 9; -} - -pre.highlight:hover > button { - opacity: 1; -} - -pre.highlight > button:active, -pre.highlight > button:focus { - opacity: 1; -} \ No newline at end of file diff --git a/docs/assets/fuels-ts-logo-dark.png b/docs/assets/fuels-ts-logo-dark.png deleted file mode 100644 index f7e16ff3316cda583878e0b193ef7ea9d789097e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 39513 zcmY&=WmJ`2v^61J(%mfxNH@|Aa*$FQN$KtoIE18h=K%@n?gj~I={SURcltfP;=T7f zV=x%-W3%_#E9RPOZo=NE$YP+9pu)hwV93i!fnZ>sRlvZ&#vmgCziF#Y(FeYv*vsiS z!N3sE|M`NI2hkk^zl3!H$x6VK{UF-`et2dst}G4%QyGnRZ-f8?lX568CH~eO_FxIg z+hj9^_g-$c>{s@;x+NU7(F-Vz3!DyXPsBPuJT#9Rk`GlmN9{Z9cpUa4 z=Hfj^ewOZ7skD0rnvuf~F0Xn4$THK7B08=vo}*ectSv zG8-8B-ar`gFBKoOcV&tcn472Of=r~IKJhAaQiHL#{%;NVt;1`@iwqQ76^p^t1lUg> zV$|qQP4dO2Y~SNnj!i{2mr{jukHC9>jMgL1^$f%n?ru;=z-NNXW~> z(T3>iQeV&(y-404s(RVPC~I&36)gi-k|>=b#I^Fp;IO!|D|RBG#`kt7qxy^!Xm)D_ z0|ZmSM{!pRbg&;Q{dYO;b|OQy2^7_Z_b)HRKuO6q3tR%>g@TvsbD3u6%8>}&rD97_ z8%nM>Uk6@vfU7)pHEQvCaXy&Nl2>GSB=fwe#m%8oByGdu7@+z4Nu@-uU@8jgX3;Y` z{w?3C`eJRW)!&Z78LuKG1YRA8&>v)myxjpf==55rts~3{s@zO8CF#%qV ztqk4nZ-!&0)wByK0rUt74Hc!ZL#QQhzNEk>`TVdcJ1=O$P6b^{7LkK!$^ISQ+4axi zk*``Oj(43vn;f%#3v@NNzaGVMO>6l0arUflAe?kH#e-}erkl#z2Aa{k>1$j&37c_N zNlmi5g`g0+p3}f5fB1n6&#FLzW2nbWxDspisk2Q;SR~Aj+>>CzQ{=44>0^26M5(T> zek1ap!me790bHSt$|M?(c-ohF7MG-{Bf1_z%zqZ-Le&1?0d3QY1i2~df!_#~$Spw4 zGm}ncD`z;?&u9p^BVUXT_CxT|94tL>cTW|5Yz)cf13nr)Rf6-O_m>LJUyDJA{;Y$e zr18C13nKcVCeom*;_ez|?K`4Su_Nm7CBhc8>r`fg zpKI$D5(iS1_mSL1DI(_eVElWg@Caa$#2_tV#}lKXa`{aXn;C&u5q`@LM7IpGI8~B+ zS5wq)(Hz5166f(}wGU<5SiIN_iUX!2rf5MciSsXbhN(XPwe$7|^ooHmT|VV(5?_y| zaftRy)|Z(Vy{@H&ms|#Lgq#Yx!ypJ6?tbfn+#3mZrorRS1-m%o%vyzxQn(!XM!R~-B5nD*+Wpr}Q|ki(9Q11A ze(+TTd&kAaM?rh<$M$+O1ZMS<^IM({04t;Olh{lt|DkClJ^)1&b_Ufxcz96JwPi0xcLWt zkYH~)Lp{^l1@FyRtU93CizchJk_U2r{;9~4lBBf* zm#sW*uF-8pXRA%1G|*fKKjo7NbXh|+2?V$R@5bxYDI|y^txcZEx65>_8lx z-c+zD=^%;yU3f`eWCSW$Loi{SYvS{Y>tXlhBQLtDYWjG9Y5iPf?pKl{r*cVkUjb|0 zwDI~T1FLFX$~&Yd8xBbPsv#p$V+~5HTX}IoO%$Y6>{CP8F5JY$-^EPfJl!FUu&LHv zvRe1LLRK@*y4_=({(6Ys4jHT#z!h5I%>8q@6LZn&n%-G8D%q!GFP|;3KeGSjlMCZ# zBCAUT-RbMmUbumDWEL=#Radt%4=jjx!iMa{A1H`%bQ{kG?F*{NR7%;3x>r~ig3?HS z=Duit?nJ)vHLn3P+I5}qn-It58Hr5+^@D$0@*ZG=< znSTA=s7GG+%@v16J5X;*(`^=&)sw~oR~#L zoUaYMsUM&A>}UJZAIlQ@H^ZyV8~RH-;9{0PYVOj4z>?|j=sFtfZ=|cizh1>{4tMOX zk)UM$Dql}j79FfQwU4`l^R~QLuot&%9ajhxCz-d|5hP2OAU^r!e+DUj{p8~eKuOg7 zb7yoHuadcKu5KS1fM7W=fp=IDa4~!mPWZ-Zoj;(9e2fDwiI@BCak-nk=q69 z7>$G=lZPE^pHO>f@!!3B6UHhFhF;7!_}Y7Ru?|d{9imq}rHYpv9l6P042xlM+O)K2 zru^^EZ8p}&>(vg=USya-=?= zu^86(ZpB!T@AWsZpE}DcL-sL+P`RoiDF~N(D!PT9ELv>jFJ1ZO#f53nnbA~@o~Zu5 z=qJW#%GbF_I6H2mHO*tm1`M#8`+3|39npcbeY8K$AMpgL-y~`nI^*6#`mx{f$3EG1 zvl5A5q~tZ#8+yX5q$W5-pYnU0)fU0A0HmnHE+Dyw6|hkK{II2H7$5CUl$O%f2Bm1A z3kk{*{o!&(*)p;CyIQJz}fm4;aW72{)5y`%^5PacM#C#h?612H4XNjg%>K2-_!U zcpx&Ew_WhE7}CYkTFr%1`f~VXTn7{U$r#V8h_<3v0>{?aN6{m;SW$>hL}hA3x;_=e z|Ev@QOOR3fnkwccVZEYF;vnyQnQ1Kg9h6#KHN#RJ8MlVmrf^{g5p5Ae70H)GS zEBNGX0WG{D+KW$-n;83uqz$GXHZrBExZFpt^g;O=;yT zMAngB0Kre*e7AsoccN^rBAGAku{q#iN<#rIWE|uCi4`)w{i0D4?M%6l%j$QD`D{nV zU;muIfM*pXRfLGr*3Mc461QW$7sOl(`{8qpSejDLzmLhv#w6R~tQ?W;=18~ZLSi|$ z`N;acJjRc-4(DTnAP(m9u%~qpfputcGA-7)7HXF4f6wvFhV={S2d*52;9J7QL+!I) zm7||b@cxWu&SGCX@AO~H(=9}E5s;QKC^M*2wi+|5M);RyWq`A#%eyDA5K<<3CdG5D z@t%&0@qj7G=EB>UKh|5l7#tASv&CK$4{Z4rtA7pG7ohKVxt`$f$=!Ip`;g7xe~ zg123!(LUgkyoso2EMt4Ku44y>Idbh(1K5xeBWJFc$QK=d!?jdf#XFEqb_{wJ7toce(wc3Ca9I>FbNY0H9KuTKZso1!CO!qbjOc=9Q%#RG%z4x z;+rz};GtZM^v_2_X)6ZaxYr8RPibLW&D$oIwJh#+j=rnwv^zOgK%je7Ji_+c!&P+6 zXi6v;zI*9(_8I!2D$L;`PW9b-g6EuBwenM|_6Ii7a0!6w74%pVOl#DxdY)5QECoF7 zyrM&ppCvg{h=tlyQ-IAF8~~vEdILuB6EnA*KV%XaW1H{@_9=U&0>B?TxDeB7@-n)M zu4Olcq}L6zJ+!V;d?>mlHNn!&SjPx|4PsMDsTW5Jj#dRPW&ucwgJ`v&XvT;c>#xy6 zC-4B5Qf{!kLkOLyS=zgTp47FvyJVBgnn?*mXzUG5>h2avJ{^&2QK2pQGEDZ? zjF7~q(HF{Ar1t#pULeef+Rk6>S4uEIziDebESib4uv96Q4!9-_9bDp4niEXnKFM@n|7drX<^gAkJeqnSgXPXU!}2?`-k7 zQbqx)8_t)6V(g>dvWk`;X8bS zEW_KZwly^nV5UK78&!9y{;fs?z~MLUyQ}Z>dExsWW^0os+26Zmn;Y}*xKgy|%gs6L z`$6(rqoOXqLq?Au@k~GDG4$ID=Ka!dx?Sb?Ka0eIwFI*c1&i1f@riBtpc#GevTo4L zwmkVX@1L7^IovFSCmcH&ot?4EhN$?=*i!-lLukdZdz`u(4hmLj@r3`}F@m;YB0Wf} z39B@=NwT=pLI^06V$O&C>it*)DsjTf3#uD6LaRS!eAU@{x;v(bni#<7$ zoohu0$XCzBpJD}3dxurnrb2gj5>$d-A2-iskB(J;(6_DR$ObMHvjBI8(R<*VJrw*( zFs~u(K6Rf%KaA%6VmH9f(;Nm5()$NpozN>L-b1DgXs7N5?G3hxNRcmFNqCS=z65~n z=k1C`%lX;F0%wl8GdnS_;rl)#C7N#L=nne(LRE?!(nb=~C6}Mf^a};Plp7!UnKQ*w zmZFc+UsVY7<)9Nt<0enr8pKWeRm z-giD~J(&sEl3K&jbS>z&?4UhLivxgp~!ED4+ThDN@P_pFs!ubJlXfMf@~xcOxC({e`9bY9P5ke!PxhyIdks^_ULFde+= zP@sh#TZK&}VZZa>F!o$adiJZf6Z5{S8biH}m`;pzkn8MChI**`*rS%7u0PXHI-U%)qiwyRl0mUkf28rQIOjK(iK z5r+d!ctoFEQwf?@9N38>~w#w@ymAgk>l%KRt)lFiY?fLCB-l={V>7XXdPvwSdMl z^r@{xBE4@|Etl<_Djokq2OYi?kMPjTrES7Cr7V09$AN9ibrvAO(cD6<6*7kySIB<3l6?C zo&l=drt7V-`z~2{CIqqhx_Plh?zFGkY*uW)_}mL+fV*gUot6aq;=N z#*+=e?m*Lj9C2wp!H4T`9j_ayYfb>vi(y+CSp$qGbQk&FswAoD!tuwBFXcK16~23g(^&&lw;dRaSdRz32MV}1;x ztpG&?X^|)ZC0Vw}Gw+}Ur|Q1)j^lC6gJYKQ1^!MnBrk)L97r&$Q~d8_@6ctd1P)wT zUoi2#!%)i#f-TbOhNXLQ&|u(%A|&s8bOte`et?{d7fK!u+_$&clx_=R!_Sf21j)4H zfinJ5wE1TI1om86l?X{2C;#Oz3tw{>Z!7U-`;*xPi2+B*$#d;eUJ!e6Vb*=Hk>})% zEOutyJv;nC;j%R~0cxL1T~Eg*mZw50%)R&$ntk#js+U;j>&Q#)rg`>@;SDAGvt$;7EWslLSq^3gCV@nmDN^~rGz4w9y2~CK1_O-}0|<(`_x+yw z24}&j4h7$j`H#w020A+r@`pQlRRM!>(+w&L zZ(qNP-wBkkdCh_I`!pL(oRPK?clxbX)pPtlF@M9D2~LGt3526>`n`8Wu9XmIr0*E} zkMn5XkMsV_;?nKEvmZnhN{v61 zxHl7s%ib_yDv%>R`KC0GuD)BwO%dk50C=_A2lu)?4&Q}Fv2P%S$Q=c)>hZU4%zkqC zEW7)Nwg^t4B#jWfqM5P`#@F!}zjbJ(<9VVSXu<)E_(h58xi%GHR@^(Yx}~~D&HG#% z*?E!9$Ja0bzYOq|k?usPDgKQ7B9mtJe*U+MI2+AX5q}JI5TE+b;D7cbFV$7z*mzAC zBx499PiMRsphH{{xfYh8(+ztdqWf66V6CnH1|dmAwApoGmMSU|3!xB4#yIY-y0ijS zWql`t9K=54y7Q_(?yu>$Svfis;Ba&;F(DVCMSF&vjSC77+kgCcjlJtP4gVBE9ev=O=#?w zWb#AD3b<_(rNVEw2x#@A}dN_pn~Y_u4e*zH$PZ=0;5{2hz~GS-bct~BD(3LRHYLm&g2?c zAw89a0X$hl9c})Wi3G&oI#!Kyb>*1OtI*4(GH)D|mxJZVDzp(Hmto=nBPp}b zRghJ^aNy`SNE`J7^<$hM`oDAaVr&1@q`#0a`kYVW3Oh5d+24nF+%cX(l$!ZkaI(Wf z$4I)u!LxK{{gC)Dm~WM9kwNlP&Fvxxr5gQc)VE0V2@A(EM|D(v1yaG;4^jFHa}JM8 z0CydC)4qoiA1F8DBdO+>z$BV&r1B_bX$el)9N9Cb*9{O?^u0sdXnSkEm9{i|2FiQ# zaT;~>3Rbx;7Mrzm%%W%oQ&O8kpK>6R2WG$@R6zc~7uc{P633w!;>MM!7SeQz?#fE) z?y)ynkqN;X1KgQE_?c@lauSfA+Q)%s@T?!-v0Oxh1Y}5oye~ZG0W<2#SLovoai*J^ z_;lJ3DY2JIB)$@VvdWya6tF3sU^YoCl>ctSQ`Fz9@2Bo0do%ZA0OWG#T-Z{9eI9_4%t~p#OaL2D~;* z)+70Qis+rpoe^I$#aAb|qzx^qZrfz>-NC?xr=D2KsS9QZ4(J$j1ZSwHfCif=me+i&W(D6=#ipdcC}V^GGCb(`KH`QTmCNj-^|O+ zhhBlh3Lr&*K7d#$)pg_c>vt#q2qg1xfy0QeB4cBn=wQN(j?ntl{UF&NxWerJy5~+k zH8v7xy3DT3lHM{t`M8A&ks>^P6;hwBe>0OzKOP>4+e08qd91Ae6VzYAGJ0b7!z zdT#%{7XxGm{vIAUDauY^yF%Ofon!k02@QY(rZ(|t^_v*M9D-aJVl?&TgH=LmY40rn zT1#3MGXF0LIQ@Fos|WO--$1`%;tCG(mgN^$nsCd{$v1KF0}8|u%E-78?hJbS+n{Vp zcdhnB+!pNL2PGpNvJ1|{vMT4SP5#vbfpz3k{xgb1srX5T^M6l&onra74p$cp%OijgBmeMX@}Xj@ z{fCdP!i#l6{PQ6yg;?pLoB-z(b1)z!e6A9i>*PIqobB)*bivlee+5U*QSeZH`45Tx zKt{Uik$3ME&tSX00%;N1GENK5M`zWwpqB?}@xGzEc^s2_dt>OS?L?|Dx*v* zJ@#|oJ*cNU{+U*YOw+3DMlU@4sak?YC_*Fnp`80_o|@;`KMVzoFV?7pZxyu2?$MaL zZ)_zeaRHVcqa4H4aYKXq6ozLrfqEe}z?~?5tH3m$eb$WyC$g5{*U*Cl$#NEPksfcF z4dVaqDwv~>?szQb*c)hSr%7xI)u-yn#6q{4qMrd_BM>qY)r+uMF}H?$aiN61e%%ve zRIyzn@Ci2YWocupilWg zx@f4t4|LWqFf97-`ffRPGr;2y-$w_ed~CzUlRo;pyx!Gz&-$N>?0{jZt2s(2<98P@ z6lOUdkYfj6PZ;(QULocWwKf(~pn8WQWj%`s3Gq^r>6?3#sN)ahiM+J2x2HTsC}|^R zQ}CHjVS{duY83Gd4pv#~QDIjP1dfdLWRy8}8s+7+$)d%$_6~sAb^Hv_8G-I&%O7Mn zZ(hAS7-P9ImlqdsjJz|zP_Rizg?oY;|D7@5n7guGZV5B)*lKXAH_)cJ!f)H%LPsPO zp7b6B_}6Mxzo_4I!2$VtAOIF3+$$_bS$yh}Hnln|-H4VVgga*g$KFc(yG%*40G?3* z4$mk)RR6(?%l?#p+lz$Oi$4kuoCss0tpR5`U7!4|fLjG;Zdu-tH@zFUzX=tcTu-?Vsb~MpFvIjRr5>A=e1JZp6-Yh zq|t4EBks+lJN1N&XgC0Eki6U34eb7B{OT@j?Xwc?T}nt z^wk}hOWeJAImj*>z=C$dAuJM*IIiE_=y!Ymjj0qoG&{Y5D5GW0xRMY_kAM$mf&0Oj zvD;{VOjO{_1zv~;c#5KqW9FHgoCR#u%71IIIz0P%-ypSn1OY%}@|WXXxBg3L%3(K7 zM8(nc+_7Tz+mwvx;(dvp?)+z3<(MwSU{g=OKYo&#VCRfGf1?LqD*uEU#&v+~<%Ea) zY|-(=qX^=E(oy_JC?R)e3)b3tP1)Gjg0s=ciH)@sM{7Yz86UWDUZ^3Kr~EB(LyKl1 z#mE^q4-wptV!pK>@@XJyQFSy_F|%l5UY&T4aDD$7w$ zhUw*fYfu|?X)@0j_&VrO>y|j=Ka#L>2-!J~ttjx{Wde0^k5!%{ftJvZrB-Lq9$BTo zhst-V1;16Dmh8|q3K;FI{$P<59=`VB=bwP6I``~dO!lVCeH~%uY)<(G>i?JQw}Mgz zbpX0Ju-#4JAtByKvcNKn@T%6jKQq9@JA11W4&^f{T~9dDfuGBV8cN@1==Ba;2{a3) z$$BdCBJ4aE{~Vr?EWpK8Q_)AF_!%(kY4N25`catoULyYT$P!Mbl7Y`;Qd9`nj4V9i z^l&A?>Z0VXUiLgvX(#z(Kt~D)wX(ebu9WN41G9$?jJOdTPqIK;-Bc|Tneyxk_AY)4 zDjY3>Znsp5&x1@6671*KxDpSJ?fGQP3ovAVn99f0akMXP4_(O5ENgwMYM<@QSWSP0 zO!wca3U=rfKm3ER=a1!pA?6FyS@{+lXPD@^gFd3Px=}P`HUPzZeRaggV+XV>03eZI zk(sCY_S!-+lZ7;44nc-5$IU}#_k}$w)cbg_a)v!=3Hbt#)I9rdKNqi0WH=I#F8nb( zCt$ii{}G)5s?k47)#i5XQKJCUb!_E(4Ig0Wt^tUe+=;GK6#b{snqQuBZ3ArqQ#m?) ziU6>FUKv}`JhDAsG7^cVrD~;k5kV2*MzXgi8KXuR@UK|SU$%;;Pxie_R_jNE54!KIK~b&r2l0^wQys99=;@bAHBhfopE4T zr%L99q3TK=9~u}a{_8Vhz?=#r0sdPm3OZzzs7%s~l<;d-E5B+ol!+fKWr)2?)@-Ha z?-QV&@DgY*?lm);n>QVkrecD0eE)`)+F+=v>^>a>V{fnHiB3_1*+T2YLih^VLWu!P zsu=8dRt3(pH>QhrR{Fp^4WJF%{MpwoZqGH%w(^*0kvfa>J{Rh>#v$wtG-G)vc{ z-(NJ%^!-%_CpBZcVAr|YVXLm zyxSh8I|O)?%f~#jK>}Kp5ZuES5D?U$Wig+}d_0=2-$W2R*gW>hL(S7LAIX0D_;eZY zOGn0PGFiky&NB`U9tvn3Ja(JIYKYojTm+tgY$xnPoqlnX2<+|fs_mdclsnLFHjJZq1$@#pG5Aq|V(WpZ~PDP>M2q^GQArzT4C-Td?FgX7fSN zg20VeCW$x#9K#AFqd8xI*n@YS`k~jVYQ4)EQOWE4Be#hI1e)a^@(Y=sODF~(lTW3> z{NM_G#1@!;+qs&QuSCDTE_9hsXNq}VLS2qd7(ZpC{2gv%;P=9heR?G=HgD-&A1@p@M4E>3Yimg{vx}?j!L|Cm)t@V4leXRc_CKi&-vPIUZpW&+4ZM&v>(6 z-&y9<^H|AwJ#=^7KyI|$oF7wZtNzxR(lA)f@t$cqjO+aQ{6lf3 z0jtd#iN8r}&(J^E(7#rK&6lc{fWfEScV{jjWWlv_?ZU+xsdTLNg+LY7ExW=4PdLWZg(Ek2#v>U zfdMg?v4;cCp!0Os_IdWzpS&al!jiji;MOz-0EG@z4l9=n;H3ad{M?Wt`O>ad*xJzJV)0$0A`PH_TPcy9cU^BwJa9bSL&An& zisZTkcVR#<+!YTLP-+Hacaohl{d9NPiYOIpxq8AWqdEjx$ach?!GJ0uG;|qA6$h<`wv10CX2+52{c#l#)9J*;oBsi7$%$ zVw%*g$h}PdBKBVWcaa@ma7S1hud#|2@~a~27GC~sn}Po8dF+L$5a(EoR`}0K(FiZ| zjbNKYyG$g~wxM72fIz9vOn|LKH?*qszR|Zas_&Mth*BN{FsL;E9sfUr#`B6)Y}jGz znI3Z%T>;}|EWM&fm3b*|DCyO`m?mjwR*l1`%0{%M4_nBscn6ik(q_-xK4d40|^bc|lJ|qBZNy&GyWB=^> zXqC~Vt4QUv*$=F`1JtNxDw@5? z{IA?xgp|(Zk`6M5mNS-=EZ-mq39~Qyuhui}9K4M!RJv6p)v+EdC=a@^WbXb9s`mD@ zazyK&F;FKm=n77pg#rXm(-X)&qk+Je0!kKU!lR^He<<&1&SZq|coVsLTgv&am1=yC zE+*mfTm^w5T8UCU%lE-&kljzA2W~_iGzedlGe>(V8atCB?~#bWec~vf>9{&6k;2KNqv{K*(?+ zOA(g}!{7BX?XTq-viI1`Z9Fgh)NPAZ26F!+#=E@-M6^6CpQz*gqHI*0n@vm}u77o! zpR{(5=D9geS)ZX6Ma#c@BBe(@$CCvB`i#u+vbfv$KXSTtKu$N&Mv4TE;sX2>$G0dF zg3-|ANu2K5Pwexp>_r1dJK1K6hc->pA3V3-{vPhdN_v}b-w}q2?D?&?d%f37f(-(s zJF5%{u^jazyDu}jzgb`xxS!gX^!#1qQUs6zSbowKAOabqTESwjJl#V5aauGAEz&r` zOI7x?FRIZT>QFhW9CW6Qy^VV{uHUF{*WEkazdMM#0@-t$+xjfZB!Nqhj}6^&jrbSYQL3Zv<-}`@|ZS1 z&tV?<%i}m>f-Il?yaD~D(y*=Rj93Y|dshzyTAt8>TW;7d_9RL1d}~bzEYO<%M|#D; zlC(75wLHaT|KfePYh@5?D_=RLE0HqoRQVJ>3h7fQY|+tcQpe*iGBjSB2T7EMI(;sn zZ@E3FoH_Qs!Y<>Ni>HHgtkL|1x0V=8n8QI!dh!KoZ>;eh@XHoHXuqs}=TIxfENzSZ zcA+4n>=>iQ>R`BYt*>LslzR3D4x+!~vZ~~KtO|g$73K0{bP-T$Vi%inAp%4rW`ENB zx%Twf?ymw22aIx+w;Ad|X^S5#oU+M9+plW&TtX8@#R6k3yJZfWwLbml zdaR5^h0hh-A$g>aGP|P?R2o}aK(8!x68MX7t|o&ijGw%0b)e(|f+3fmx=$0Idft6{ zd;ceJRa_!oi|IU#6a*RNh2Rub2weR8AV3pgN(5-51j0iWE)Bc*;@&B;;Xs%~DqKuE z6o*JFb4n?A-y8QU&u`wD&qtE>f0Wq7xQ;CQDRlHi8)d}h4?6>Lf8Z3LOcX9K&Bf-4OhXDY`vm z*7_+zY}9fZGxeqyvv%_ay_C(-Fv$L)rK+;;fpKfM^2NtDG1+Zej1$ZQNZ@7;P7&;r zU>UKk3ZYLTP3SV=JBi{O5cr*M} zpGeX-N$=rUh=782B!u-Wkd;>Fhf+1e8HwRP75xu+5Kv%`6-IGZ7%q&05(}fhdNh!> z^EbhpEL*CO(<#7p%BW#7F6%eru!I-mE?+6!z{3hJKayNxQgA5^KHykSZv>^b$UfK2 zf3wTdZe$I{@PT)pha0`VJEaCB>J$c6H4LQN}~Xm zdc0lfsjtRUmH;zkS~YJVOir}h^&sn(3fA&m0c27Vw0$)Fo40x7h=AM(CuXJk7U`Iz zC+2><1p(#DuGmT=vKVh#*R=oG`bHn|mxb}q8ORw-BIJ)(1RlDG;_~vD>Pv*Y)HP!1 z7i|t*2Rp%xy3JilLU9+f@@~+FylwQh4W&8}Qrkw=H2X_LQ-ehmG?aGH=962820`zg zKAmuTvfa^^Nh>j-*w_!m0UBU{1?TI?w!Di-w-Ei=h6F$aI`c?h0QTH$x>=};3-Gcx z@e?8Hhy%lwL(zM<`M%q{h_xCc^-UT;Cq`tGy)$zJk$L^W$CKt1&zL2)n??O$ONbU4 z*Fu_K)^U&MRb5}Z6LbV&lqRtd>B;VzS3xci+rz@NDQ$-UZ^8f#}}h>!eTS zj$nlBya6z=gU8m%YWuC8nGyXyjSc-Ww(1k`Bw}&to@TxuQE61_qOF{@xNmxTXtjp8 zjDDQ?BIq8r12#u0-X7|9Di$>+!GGdCu7_I|J>+vtg$MG^V3hr7-{o6Lyv0$xPL{!s zdi=wF+k?;@N7<5wjN+p`+0o1vZiYMAr+#Xk1c(-OJbXVr;Ze*j7jrk;_mGgLlRrJ` zB_OrB~gSx&DG^%1{t~*l-B4J;m@s&!d{yGAz)hM*M7s9leZcldjdd(n9 zwRb&+^?MbpW`kuj=K6irTjd^`jXV=;m@D4)P?PmQ>v@%UI_Ig03zsdEIB7s8P|iZ$ zdt-4&G1;c|Vj(3Ai@U6UBKJl0OuBs0(dtD(ij&PY&6^iphI!e-K66*S#K2$^2aFZ60mdhGS>o2oB z?*JY=92?uA$pVcOir)1HBVU2#g$7Ikm5)LHO%CflSUeeJl^HRux^Gy3r!hde8@bgl zdH}jx=rn(5=o*tSy=q}D-TL=lvmliS-oRf8!Ucjh>Q|qY<$T=+Mkl)};=U-Ol84v^ zc}_c=v(g7`!m$cGuc^E@D8G!98y)>qpw= zbd8{NT_A89&LqDfe|#1zon+`@nL&T6uYA)AlodvRPJONKrS!=jrM%b)&Eeyu49fE9 zu)Y&RejEFRP1*=AEKM#yva0;}bS}tJA>@%&==$(+4o%EeaDE*zpMj4*A&m7fXx$zc z6i1pfv-@5gk5Q8}p!Usfxgm~zq*vjw#e!{wl7lOz8s}I?KO^-R=?g*=WlNFL4t7ef z+l7<6bsYUp;g+ho1NV<39`;*F(#<*|0rv(d<$!nq4+$Da>tpW61Bxci@$bSAq-ESE zw9Ri5nj-`>t0Pg}UPQ)fE!s3469oq##f>b3gm+khZCZho>kaic^ew!z#JT}7fceuh z%HvjdA0qc+%>xP!ZU-IgD@a$w?%`z2hmjNn$S_+Mkm;SSVter?tZ;-Zqsy0aUf zYoC5m;hAacupL<`ybJ~*7Y_)I{x=}(QCP-&wc4!#>2Fcx*M+tmV{8Cpva!d5%LQ&} zJ@e0(RtN#MI?jbAywN^8k5P7Kj8VZ)=29mm(0--DS;#Weh0)767C+z8oo8>)`&)r_ zbr&-0f!76W(UttB%=~N8TDt?AUU-}4jTPO5OeP(?hN|P7g2>M2L#Tjc{TL0UT%UB8 z+ispsBkBF8EBRxfBJwtWXD;%}r${&+M5D7mnfp`pgCBP(+N+l2F( zQ3iWpy^6SKdf>P9cAEoVC=Q)BS-~B*AfG!K2%Vm_12shJGvrayDt6ozn3i2bW0S@O zUOl5xzyuI|a4u;c9ckdS zd}As@c_d><1)g}h1o@PQGEsD~e6xYGG3!2z3#P>4v-p`oRwRp(O|Wgl=0oyq9fO$u4QdaJOaH0gj(pCz)KWL|K%B)H7)JK8iXLh_^b4RaH7=DjR4+8)~ zw45oB-$k8kJ6BxW2&`9sj01iA>xmK&%D3e${b)cQrbt!~=vfyR?rBm(nw7d)GJZ7_ ze?>g9Y=OBcW35h`5<`8|+lA$|Va(*zbkn?sNB_TA%xNc@VLCy)f<7nHH^vKqt zwM$);ae8MzX3=ebT@1-n=cV=)Wm~!1GrNkkps zvx>NjG62uT8%^^Gv1*U{^4-8te6=t3^W*@Jgv$D|xJqiJ#IhYr)s4LGFu>&W^FoWI zmxmdwZLvXMaVgwnn$$MksVq<+rA}}%1-E6qM+CCpK=m2<d{O z)TCAvBfx|JvT@@No?Z4rK5B!GW~<$w**bgi(V!fd%jXP~Nw=iT(f2gJzI;WYYL|WY zd_l}#1Y{ufMKHclAvdlARQVuUerbVX$`;0CiYJ7D6ax8 zAo;4yB0YL18Y-#^A1WeJIrFf#myG0~tIWl4hm?`Qe~;Pz5_@ub?OO0#f6imX8O~te z34e?1;h7CpD&q-RfClx2K#`*1^K>BNpPcK1HlPRv`a!+YWkZJ)b$TD0f(pcjXTnArFoAKx67+jJXOT z{roWof5>cpM-=rVuJI_Xi;4TQ{+6+0mCX8D(x%XrPSlWE0+DLob4=Cd~$VWg)g;ad)20v$gTdrP+C>XMcQAfy4#D zv;ndsfoJxi8x?qO0=#|B;=w3?`?{<(KbLv7Mr6{Kqy>Yz#(1|H9f)K7uA``alkk3m zqS`Z_CNs_JOYZz*s=5h}xm)*i{uSOV=rpTHNwrbk#cCO2S&MBu${VO zsfSpfYRmuvITJ#!aK{(14(Irp_YhIm1Y%3l_Gg;xa`qSJCzAUff4f@n)=?tNSDFP9 z7EG19*6WeVRzMUi73dX}t7z2ul>clK;VXh= zG2=PPE!5||iKLbI(d%QhgjuimdjvP~xN-KdwILu%@$HT%eyUtMN4#i?1s29Eb*kJA z;Gvw$?NacjEx(OJN*LL634H%?|9XhB7TFYGj#3EP%v*L@KqN9ZvJ+{sQer265g5wU zcKF)bV+~t>M3A~Cd|K!}tqWsh5(rQHp;#wB9E#0agi0u)nsp<#am1I1eqzpivA%E2Vc3R};WGizU zW@$mVRWO8Q;_Kd3ORtLsv22ic=Kb}tCJCvWG6XC5vxR=o2YiVe>Db^gN*qd#TZ*Q& z)$;i(!}kWH*18TcOw6+zdCcw4`1ovI$07iD-hEm~0G#DfhfqjGN`KnPFG(_Yta$Yt-q4<|4eKsW)L^4IDw$&gj?G(lq=(roJ+)s;=u=M7kSkY3Y(~kWxTE38hOwxDE`n>B?Y$NWb*uL7#jrYFiwPyKK{+wnPq=z1SG2qRYSaQ>3(^i7kD5%-Mv5(B{ z6&hs{ioBzlZ7?*FCO$(@fL!%~9Qrv~rz0{_7($^*JXFe@k5U}BZJoHV{sl-~2o2yN z1ktzaKW+Ot#b9-+N2gD_aKDna3>e?MfV&^r_Ro(`C3 zgz^=s>%c9$291K3zYkjl1hInx#aCTOcHeg7fzOX$Any?)iMDB_qn3@eEa-*8v_MJZC6HSe)kq(s61U2KyDlMEcun5XGi$s~(Wk=;GSeB+P?`cORZ$h8% zZu2!E-9^4mm<+KwzX~oR|E()WtIA=rk<=|#chm)Dw1KE}Y>ycXI%j3?3V{M2`uSMr z+E?XK4Fq-DuiNHrt#Pi6Z@Ut`9tiqw_VK>z|Ahu$MGqKDru<$96jjPOw`;BWeR9EY z5X1EPc?|gRUnkdm+IG})F{pwTyxc|i^{B5r!o$)KW0FS4+i5&2i<<}xgU^otjFs$v z_0bGRA>r}Bn~1TU=A87Wt_o#PV}5 z*0n)8$hduS`cHN1^}@bVk+q*T?jmXxo%+Yul1-0k=h7k}VQ($DzjVOffq z6Rak%0+cd8)y9r^rk!|Wl~|dWQmd3MYVLEy>P>)7n{SF6N7Dm1qfklu^y(BK0}_cJ zIx@S+>-mFEM{9(x0DKP$c=-$lTV(6K4iu$W6_ZJ8?c|R;CsX$#A^b`QUr0Pqg^Pz8?@z`&P zQpkF<4#0Sm?qTY1c>GFBbJW)%=R6KEwc4qtB|`zsXD}AOELk@$yI0THSPaUIZ^R}n zW{;!iAAzX|dS)MdWD}iN%u50!pF?JqVfKJS8$J$qHJq5n#{qGvK$FyK3_tHF^bK?|Vjl?adHuj;L8F}e# zW*2fi)G*QKU_?1;zy5A`9T5xvbX3X3y9V0Aci2ZPZgQchzC_%wDMc{ zM_x3$mNY(9Bozq+xRqoKNq@zuwH-u?Ycswb8RR*e^pC{a2U9KdL zB&)|b`}c=k;a^!D7?hNmxOik}k-K!mmE2VJk5gF+KPgAabgn_4lLg=^D#0?%JY!s6 zb@bhAlbZkCHew?qa??XT~1fyEF*#T^@EMM=H@alPM|q z$%0rCr=FH-54}Vz=I4c{q};RhF(LC+Oq-&tmex;|$y2DY#zoW!y66k60}T}Ztv%`)Up9ItcLgPq~&1yVhJW9OI3Oi0d3Nxv3!w&zLPv6NcvwZa_LG*KUq zQ41doVHMYtLN5Yx1W%T%JjeiUnXxSKz29VB-!@DR8BMqQwTmlae-0Kv4fKB9TMc!-fic_2{ z7f?|N0qSYI`QFwxVWSIQGb01C5o}X`Y=7W(*$#N8-M zYH?mQPKtOA2##{JJ7vmv8op_w1KmO=PWQC+^GptK%62qAS^I{s-qc}?x{a)j`;2!? zr9BC~9>gb$vzHnUGANle7D#g0dlwvJ!1V`aDB#k|-M<4b~nRVv&Gw;w(f>fZ=6A_L3K! z=T))PE@?peqftRbcy-&dZN7Ded_}pJB%5qt+vAe-rW}wEJHe~S*pfi|MRO&(#=qWB zgr$A17{1and9WS*inAeRxrc*iQMqj?)gb zAac8&IUe+_xW85v&TQA{;Z^MyVrd)el@(9Yqb zQ9j##udmPIJ)b#HQJys`m!6SzH#4*9xfx@FGk(HZVFPk#dB#tRpcXY1z@Rak3!>w{ zkoL&n6AJ@fwbnH}7^6L8I3eZx{)g7tk9e{cr97Eq6@HWtOa}!v#2KF|=32$xxFSe< zzNr9v{?Iib%5*9^O!W!VjA$#c>R~hobmihfn!p|{mnVqj(RVlXp;0Ay+lVlG47%jO zPR9B*$Ht51_rZR@HbyONMZ~j8dqgGU@*vMP%M(u$Z9A_815@9cqrOIplca;ZT)8QS zlYCB_7%p*e+`ZFeUvj2-LgeeX4;iwhbK|_K2eF@c*Kq0K^=1{b&=>c9ULc?t*zv}5 zmb!)>_zdeA8h4ykOCB8w?5eIM!7*mOu<(4h%c=Z%8cf$sx5-DysHHf#Iv0YbM{xou z!$mXHIYAZUJ3_pf{FN|8O2)KvnRniI zuqa@aS&DU4_kcO=4l?=OWnicvu0YYr$XBmtv$7Lg?nV}+hf9>hyD*%?O@(XN&0i%H zNi2zriyq5EWl!RYDS{fclVWQ9j&vvZIPp0krRE6mf^S*V5n)lIm1v7#ssovprpdKn z?Gc!OqJC(z0=V82D{^yn@?z6Q#a*m?s~>w~sDUQJ-BfK2FhMp5QN57BR7O!ltQCq^ z(q8j^SJt47#`ajFPRlBvj))ve1k1u(Ps3g-ezP(oaRdY48S8iF6}mGPK_X_bC&zMD zjE4dZupWScwRTJbqPb-QW}%$fpcS_B%U$y9aDWpjDb*oJH_@nASHhK7%HHUD^@*=P zxpwTzr&Dm|qQy$3m?u_>=yVPZTtA`!uQXS{VVCZFT_wKh63(sNe?-zyD`}sJ;d@uI zSsa429!-)6rs&-EBeJQ9SIsK9bMWiu8~p_|K)f-$=DmI;Q0#d>eHm=>yW7U0jg=yN z-S=Hnv%#e2K12$ZCC86NUg%NDP9)3eFIN+GVwHG+AOjtqDA zr>6%{@*hqVK_)ub^-JJA3bWMSJ1`bW(O(+aU8VatyCWA$-w#e;8&C;8wsKsuO}FLy zyb$NiYF7%=Fkj28>+?|#7GD^>w$B}+q+Wg)-#6vNPe-JC@b!H-4pIHy_d?B&v_P-! zwbWBFF-as!B?TK*OY3VbElZ>#-Jb$sI-8hgYd>Im&fZ(#1V)LHgiAE1G6%M51s*TK zxcPVw#low9$gzy+7dj3Gx@P^HcB3MEL>6WkSTv%d;R8D6!k)^-PcaBP2c2Co1C2MUp zwh%Xu=p)(GRAnrJFrM>jV#^wB|%KXaU9&%hfLGP7Hh5u`!xjS z5A1@RdJV;Dhd0TeRCTpXC90GRfEZ!AVX}nsW@mk%NlVua#(=;kXV;jisWQI>8=lmX zVCeKLF8cK4`N|-p}=BEl7Mn_ zm=9w1;l^su#zklad1<-|fVSaAY{+tz0N60hE4+v`+E{~?-&2Z;yt3BNVY|+gve6lE zJbR5UJu~SaW@On^?12Zk+s4W0vUddHSrS3?9yJudxw>3;HC1WGM4+8w2^VMczT;4b zE{`smpHl5Fv4yc9qe_-t3PnC5h0a9fIm7P+FT>;m@A@LNzDb@^)T|1*vQ7485FZPn z^H5!=96hCm@Kpv#^N_?eD4Jb&F>0aHJ(TP{P0CN|E(nywcbs#)Lz(91>&PZ%{NlDh zzc@&4r?O})|5zq5X1#Wk#Y&EX(tk{L3D*us`TDRPRDaC*>3zc=g;PQTH{Yc!Duo+H zzYV!Pc5}LtbX4e|Dmja|!S{7#=)OtaO+XSMaC&yZCECO}d2|wB<%yzyf9O%5NS=Zh zk*)$eq^@v|ihM+ToG{h^7h@t3C`4L~TdJ-80rT@QKl(zTqIwOSNQVYrtn;Z#QJX$bAq${S@^WFGwis>@caQwq$$Uvo8K zTPNzhE=wa)V>;5PDVW*|U#1y1m+*sfLZm5b?v9LiPK$01gaR{g1<-53iaFahLwPp^ zzck$t+Wyz;@NuaWTZ-M7oJ$@{Q6MWs&=~PVjqueujE1V2)^NKO^+zdnoyjjK1H{Z& z+HmUzN4f}PNAnS~NTs2NksgbtPAg$A2HvE8F!YFS6VA6f#dw|R8+?xJY`220Ca7S> z{7MJK;iXX5mX-~Vc-Hb^3j69E#G$*Vo8Wc#Fv!9y#?VT5S%%e8CGMz zOAPnsAnCP(fM2zKG|rgh?Ydlo;%ZB%F8sI64&>GWwWF^VF72x(S!P6rt}f-Tc*p0K ze5WC6Wp7xHl7`*+!mZf8+dqBwirsO{C2zkg(e{|#_qRHKar;ora7cP}6E=y1UV0~A zmAtTh!&itNN?O{i!j)s*Z^pA8qvdP?LxGK|X~%xGw5xg%_sQIQ^b|*8?#6>`>h1Bl zikZiBS~v}eo(|A3UJ!MoAcyI{t+H=;ZxWY_rzu6?^FCsiE?uV|CNiHPzHIQD*;Bmb zpWAWTKkr>zS4=N!W}YTISXcCK>38gRG?VHGp`vO|fGT+DORVWz%>EvwiO&QaCsk{c z?@{O-#=Fa$y{s}f{eFxeyaP0oo&Sn3Qz zN6>VWknv_jQk=AU52dT$mT?Va$4AnR3Ry`ChUeg4xUK%eUG1ehf0?o(Y*S!uozp&d z5STuvFGLiOiE^nfH;w$AcF5K64K^6e&F`=imhupe$L6>6!FTuOe~g)h-IE3^0n2E9 z)1XQ~hn|`$?l?Zy+ka}F4v{GeGeWCtvbBMJQbe~>K=%#JEKre1R4ElX=FE@}TTP8_ zU3Bc1;;yuyT<|_vw+OqpLa#OBye7)xW$M7^&f25&>@lvesgj0v4U>UstJY0gSN0Qi zlIPs_X9@X(EFFz|Q|gpW$bj8T(v1;e9!8|i2V{+(=XZYCctIuSJVA5Lsyqyqo-2Hv z!>%*vJC2}xKjfO!Q0H-3e5DDUF_Xsl0;7`$KIv}6F-Yp?IV|FZ>_n*M(s`fEn~U9g zi}Q4>__*ni%4VRQI`!YNS@e^jznJo6#A?qCScx?<_j<7-PH|Z2g0^DA`;p9FjZ24; z7Plh0G$tfnZYSq%e6Nwt|2PbGSbymaLT2+q!oknBVieXcF#gR-?NY{`otz79yb$qw zO8z;kTU^6Y7^Ev0g4h@DGfi(2oUlcNPLMsO>hI48{BcZ1s_9!vJnPR+Ox#PWOm95p z++TXM$YLfgBNkmD-e(AW8Mnm{hsfw(9JVt1vyL?=Qz?J+>;ARbE_it)=MUa8OqNKf zGiJTcf_Yn_42iqZGn*?RkD4J@k@72>ZQ%_LB`|1hV&_K?3LOayG>9x=ijUs?fNv@K z((zg5U3mJL!Wt0db#B>1G`REYti`=1ywY^QktLhICzPPqPg3^{MmMCdsRuz-@uKQid{9mM=_xs_CpfAYW+FW5qNF*s@4NDl&LHwmK z9y{qmwMOz(c$+) zHO!&;u9At+kS0k1e{p8XKVa5Tf0oCf!J>o_Cz(Jyu-fR{xIH;{#`EiSl(`*=q~QxE z3I}u9i+q%oFPq#W`G+e(Se^1XrXrb>-bJ&0H<|=E%X@Z)?Rd|`xFS#yl>5k^%wp^b z=ciL}DX(&Y^1~V+PCz^c)1vGgXe&NQB{p7%cML?TKL^xT5}?E%r;f)OYl8FL$ktp- ztq~g(E=9}RCgebV^w~=66kAEkftZtNw|G%Bv|q1DXIs9C689_lBPVa_3B;H6__(M@2fs#YbJKsIzX%RQUU2n7yWCrh2Sh%OT zrLfmTnXNy`R)c*cC-D#cVt+y?1!dYJpPw|D!z)Hv8aO*7&E+_H3ohHUyg~^eB2ypc zgHzYzq5QRUm59-}?$Sak$&UG=Eh<$JVQxS2Iyk0;#AbHndENqK5RzW9lP&n^S^EfG0*}?xDgiBD^Ul63-sU`L_1Ly2Aws+Ato#DY^2Zu zQHbR|#8JM;lkS|^MQaBEOGDfFOu0gV=JiHCifdFA+|Eu7)LxEXjMrM>GWsKiIMwMi z&d=*2LJn;&JKV*~s>>vVolgXHW-Q$!no_zu?ceFrK4iC0Pmq`V8&ijpv@pQnSwr$Z~}Mh z+>-Ycqw1jNZOj^E!+J$1Y|lnp7A^BCYy9K-c{bn=adjMJT8i2J(r4hgoQ$S^E+i|L zXKK)n0m04;g7k>VdQD#<84xd1rn-elF+* z1+Kz8EQdqK4?BK&x_R#r*-C_%*N0!KFCZ^$h2Q(SdzzlheufkuN%0mzc6iCMbD0tS)b@|Kq+L&#s`2wHqrN{SwfJG`Biok=(cUt`jYAGl zcO}W~l$lZ7CT0M`B(fprlBoTJXxn3QC^eDs~(7)bwdNQt8mB?vxf)qv*Tv0J7D<@R@ivn zb;@Iiw{Mbu%Qk9{lsm=O&4=0_4W0}uQgEU1PdH~!+E$AN=T(~3Pzmg?iFXRO`XDmm zFrbx}#AELH$P;_h?Tkw4@0fiQ;Rktgrh$s^>sJSdP>j{-b;L~RXhT}y?}5SEfVej> z|IkDLE?}1Q<#KuWR3`inBR;=6mz9^mxZp)H|MyZf5%KLOzDIqSIbWdUYuDlRvAM-N zdjoW1caq$KyHbizRGyVhgYRLK^qZZncwHhxmgt%D)Kq%)im+VFx&mT3NL#8@@EtG_ z;XST|`72#(U$YFJmkeDO@d;w@DdgwrvJLmK&~2!xv7#wFPZ^M5@@xxO`j0C(361HQ;Q2rL2;24`ewZOSuUQ)}FsXJ#|qDC~V%8m*m1tcd&-WK96`dF9! z;OS8wK!S10Tq2qAB}BRp<)QesWLSp)z74M-hw0vD`5&@9nDN+c`fcl=Ej2Nb{4PwB{AxD1bEWvu{!2+qLR;LrA1_3Py(uqnA>1@!|GWDq5>k* z*)LgticcuwjHujl8VZ%VmvB5lO^)8Hf*?wEL)TNd@ zc|J6}qhYC%)IFM{NsngMq}8ZMgjYXcC`H)pyq*SowQF`<%A& zV&I;cT0gr5*x*s}%_X#g!OCgEkuvC}>Pt$k8R=6}8%@PF)Hu-cbZ2={)WAU^xdZT`eW|N>mH_jtu>QVl_=9Bwmph{rr3;tP7kj8)pny#)?dr8-rKqyrc@Y zc;Z>*EZhwTVC9q5k-S}KkX08j6Gnf}Ln6rvU+o_M?m7QHzzk0_c_eVLA`p-!uvMS8 zL*JViR6A9SUNT}@+vXBZ77|h2N`zYG<{|R4=WVRam)n(>1k!smIY8*>?_`cD;M~BmR7DZQ4jw8%IzV#7D8-r!j?m849Bl?*;3y!P4j2%J1 zowy4o|Ii1l>p8u=cd+sm;n1@doJ)D0Atvkd8(BXU)pkI@Nl)wE6YRi}}O;^9*n3LOprlk)TR zV_0h_AFqLxhBcX`ZK-rzXOJYMHcsa&#jnH8VQEsdoic%A0^5C4$S-;ogjzXwb+dE@ zR(PyPFDUsY-HJdnpuQlj?&l=AUuGhfri-Gjo*S(MblhL~vO1modd<9Y*AX^ydL+EE zU_4x-1)4s%U~_nX*9s#|6ytT+@Uxf-JteRfwx%6$8f-?WPa_Hj-7UXo zquWh=xt!3GNyD()eou@IC;`=6Nl1PZsewm9u^7a|I1yXBIm4D+xN7@h_X=#i z-BI2W=hLlEuVZKaVL@`0Zo1PZq%`ev7`Mh;$Bbi9oXptdcKU^Fgk6Qu#AnggI-@hU z!}1EwhutsSb2*;Xw)eh+t{!fiwEC)NeXEDuy_ZH?oUOuo#|JnaX+c)W$k(CXlG^XYA>9BGu0FM9s*>cQiRjHNe=_MI=&0Pvzw>UQsK!ddZLHs6N z&A%QM5or7M)?x?~?=NHtRnZG`u?f<{tnwz;rblLm&gAq@kPiKrj?A~??ssoD$bXOp1Van3Yg?P*f^HVyG#DmJ)-!t=Hnm+W&3ENWJwG6om3 zZ@iP}``DO#ET@w!7_lk+KIn`#o`Gv@R~iSMV6lY`;*kUAwT@24dNM&uk zd<;kxADdL)nbiN?8*8)ea6dYTfLzDWP& zqT))hi&Vzp=%(u1vx*DZhIdkT75sSKlg`?JOAyzHmCzZ8hgP0;WZA=mA?)KWk(ztw zwmokGIr2a%pB5D1AH15xWo>KRoqEt8mxQc|clM^&n0GE$9T%iu|GZvr1$&*b24&Bu z-4>y=5?*Jm1Ha26z;ge87yaZa2bZLRwL{v{FeY;OwJxr{Y^>4N8sJ7+%TE9ioy_#x z8(0sd((pCluGCE~fT8DX93?g>c>3#(mun2RG@Y+ob9^&)nf4M6)OKEYXA0q~0n#;@ zpKa;;YJ{Klx$Eys39oZiyECgh z9ngj2wB5fgaA$SIAPJcj*Y>FedoYsaF3?;mhE~?|N@#G_pU+v6o#0YZT$~AQuq5`H zTl`tviu*_|gw=txUGcq+*wQ-vrg#Ou^VT?W+NNAOMZj%5OkBOD8vcWR0eFr`{-r_O zE6MGh(oUtX7fVx)!Pg+YH*i(EE&{|*{mjx)x2a$xHYUo^^P-&j@!6R*lr zCFz`V0aQbO4EZQ^G6pP!^Qf{02(-?F0mT0MoR**wF5N%u>&!Y?nK7Khp!0NPa`El# zX}0Jwwq>-~5NKkoRYymM+!Y^kAd{5SB7ldS^KKpw0Lu^{u7VNX6u6Rz1hLR^q+3+B zBLiKT=3@hh!QQv=rT+3pwP5+pzn@77Huqau1@F9#RrdVhSJl#U9%9-^zg=hWz>XQ^ z)nh?V+K{jA?8Avc$;4Ax)SX1~b9Bv+x>5(a23o1tTZlIsEv$?s?Q?rs+!j*?=L-2t z|NK5+u=%GH@^JdQ6?1;e^~0Xdczp+!a?){{{!ZLQu{ejQY`vM1jD0`5nNe6JEi7%U ziS#mo`bN5|c6)e>>Z#9%@KgYV%&%%kxT(d>#8D~h#9w>x+SC4dEWwSwJRwoh`W7Rn z*?{Y(Efs^w*m>A??obFVH%cxm`-a-S0S}9`Ev0BG@1%@YwD_(SKK?CNJF@+#57>3< zB0B_&_24+AzMBeo*c~!;#hAr|x^QD=ONiP1qc7 z6|!WOF1(2ly&A;tm zmnhoju1{P+aB7&r$}g2W_$xT9!p94QNFD%tSVf2j|zpI}vQ{TAr5LHJ6_`HwE+|V1TyTUkN3AXSiR*zJ*!=(JS)Q9wP(1(NFhV4C7oetpCSzw1sE*R(VW)u zm`ioX1dJL|XtDWzd`3k?brgAJJuam}Me3KOHy7~l>705|;qEda< zN*{zo4zxphnrtg~oNPFEl6y+$9M{_3#6Jn^;WVT1>FT((ZCYw3qtU20=E)a>Vq_mi zr&|&I4bk|9_3sd~BBRZ%C@`mK<4gNCQcv=8l=pIovh7WI(KZsA5+J>Mf?13}7H3p& z3?+csJz8wRi-YuOU5+Ug3xicC_Z-V|D~Q?`oNs_qj&I^8E@Z3i z(kZ9Mu9+hK`-8FeFmXu-qg244NZ)jACq9QGr)czB-)u$pZ!}=^G_}rlo!j$u$le^{ zUjc89>aP|={{6ea?MeoVpp7}J@vU~}fp>k}{1VSQ5S~l9X5|m#uJJn=|2(pahHTU_ z1zhw>9AED}J0mA3F;TurQaO9x2YT=mWdBD`;j&dEK|is%%`GUeXbV?KQu%l+vTF!SZoY zR!>T9R*!wGm=@y7!&>s6U;6>frN$(kufJU&eqfFzwIR;GI2H^2`MTZfEPBTpE^i6! zu-CqZTx>Na9lzcBy}ZpJVf#)A;C~Bc_!E3^;HzLn7k&=hKN0^NmB6Sc(z-eE9Qm>=06o=?~+&Ay~Dl|b+twquPAyu$E zw|$N~UvbvF=CAf177Z3~7BR|rON08j2snMIgG+1m~6CUv})i$`FVlCkWZ`3 zdu>hP!3iLA=rs|1Fp(A2GU{m{dzK z44e3P?I78QVm#Wx)eZteZ*C?len7-e73k~-AMvz)0bOiv)(Vhkos6AWBX!uKf`H9Q z;e4GqSEeR2xJ`uN!GmV|A=u_DjRB=h@Uy5i?dOJ9=jd5H90}{^d1bHVQTScVc9N zfsq3ST4{ma$h}!VkB?8MkdjaI+l(JWu@eJOum_+)*)%5Y?&L}QpnMPUDBY=XOeU@6 z)(Sig{*<+_P7WNW9B}_0KiLPr7*Pt$KGE;@?=nWYfs`n(Fgx{%3_ogXg`SZf4M@xQ zfQ_jxHUM;{rYq2zRkHkT-fy2eYARI|5)TlqR1t3u6KOlh+!c<)09lUz&RwQqFP8d_ zSTePR=y!}sQ~U1r%@s0KdByj-Ov?KJj$DD2Csz8Z7X~#mF(bLGw(Ko0_kbL5`89m2 zBIB7X1trJ1K)2M|H zIVm2kS^!%k?KN7{1OW5B-9}h12rhc;_RWU0e`CydNaVI<9ISr*&u$40sQ0>#?D&L9 zsi6=Yk)tBn;6rKq;taFU7 z<0pglyNH|?Fb4g5hUI_^b2pGZ3D7Kx>F1iw^)!2JCYaO7=t5GKQAHN7#_Zim>E5DE zy5B|~P98`E##g^B3*Luz`^5&X29A5a0;*nr9$pMk$<0?JuC;m+dis1=h7~xKeJ!w$ zZ9jd5zYI{NH_QG0cvTVSYmEr$FYnLl9$@AZXP1enWwRiKWT3~X`rl~-450rmId&4S z*z2kpmFUq}evW*jDzGX~o-Y$kYBA}d()qr=O3L{K2dCE!P$Oxp`t_YBb*#SWJCRj9 zlmQ5#zu1f5^&jagr2E@C#CQWs3pS)YE^-b3H#nDpQXgp_vOwd@+=;(55D!+5m6`BjA?cqyG3o_CJdlUSQc^>;Wk+7_E@GU=oO|wH_os{rTQu(E^|s4s z&whL8IOy4#d_>NAIM^WpC_IDaoA(HeK(_xF@Eorsw!D`6c&J>%xKli>I{AU80LUol z$)Ck{lYxT3KOe1^J$@csf8;;x(( z$d|P4EWn_I`Kpe1l#Y2|rDIT@*jh}Zc?MUa`A4d9y7>2dyub0FA9%#f+OGp|UoPu( zr~<-`4%}D$yHe^|QwI9p51)W;eB_murt}8~psCB#djX$ko@B|WII)4fe^Upb<DQ z1rDf5Wm+~i7{V+bv^+}OY)@7oXp-2)0$cC@T`}n3ov@^G*TKL;5Z>KPV}>h+Q^W#z z6riMF^**-Kzl$e#O3Cs;Q6T>2z5EUM@(Qk-ltB@o?coo2)+Djlx#PpsO-cVua*1@m z#5UMpFaP>t6Aa;)^?7c!Ye)giADLpMy_o^1P#+={UyNG{cYTy_mNJ%Al zh<@r=IFUeck0h1QyYn$*f5>m~b82F3L$)yCV-1=nvsh~=Xo>YrTsxpxlfyR~L#_F) zd@M{(K+{M`qHtLDpmxUm`J_YopP%g`0iU7+j5q|5>Le6R*Uc6C$0CfI7QV^vzBmA07@z-9y zYB>K+umtdGE2T_28`NF0R&$l_Q%1E5a+6sW%%o zFUaYEDi**`TwsY#UICt%@3AnTIXX}L%avT+&wcarl?pK7?@B>*84+L)&3>>Zk`-bp zR!0nAK5i_(Xy)e~_XFx`_^60s+c;5rPOH1SMqq@&j)M6DM&O~YxBS~_=di=8Kc^LR zhuS8DmYf0y1YK8-d}*Cx7VR$&6A_IeRP}Z&m)F&%pYO-N@2u@ce_DE5NpkdE#|V%j z%%XwK4$VdL-`Hp0`-t&;T`twiK1b(9C+wnw82aq#POuN$Q@*-#%NM~Mc6xBY75ng$ z3mou%1yf+;YT#=Ee00U)Isp+N0k}X}0L#h0*=^q|Hn<=s?x_|ZP|972Tr|n@WGZ~X zIqXV%qdMeXg;Ee-Dy*p;l<9zwO!%{{PM?kIfz_eQZ` zi{4@*KH-9l{#J9qDvjqC7WQ3>?rhI+`oYC2@5$CU=miveRyu5X%<&PItB`)Hq#{74 z%hlvN8I#?BQn!u7LV@lQBhIYg9#Z~&RJs-R-~T5ruunNRkLeGw_k(8v!t+4I z>=@>D|1M3PBOrV5Vz~J<0rMoJ!7k{8XDXNkT-DY<31wAXPd=+@WdqC2i5ES3cwo51*AKBQML18*f z({%Djlr1n&p%VlbiLJ@vI1Z9sJ9B$B-VOQmGebh3jVeBChjZm3hJ3%yxT~Ufe`s_B zpFikcAexoM9`*NpCZ5b>nW{2v9NM_e8ovh{JP3bo894U9s3IdOk~76MJj$ThOZUb5m#S zT@`F?hkwows5Z!Y$cQ|5C2{W&eUQ9;AUGz(#9yeMZesK+R@Q(3&;0C7`LDCaI#aU4 zc158%Ho+J88(8BL*zv0s{VzecSxfTux@o-dZ(w+Ef>D-^e#-|6>BW33RN25-)V0!n zK*5u^BLXVD9mxK5S2nlhlE5^KRollMBwvki)TXRM zH_f-BCSg!H?^e3m%T?gB?h}!k$bnRBsb$ZebTTl=ogC#Vx@(86jrKRS2W~!CkNM=% zqJ)-^BqvJtUQrbByR%KJ3uCsuG_o`=&^80=5#;%I5~)`Xz1ml|Ju4IDDz~2s;|*lR zUREW~)15o~OPi7({ede}$`cVH@sg+lFR}Z=xJVCsg>aeorh~_7VCoi?$uM8BO$ma# zE?ioqw%bjc9WW~3To^L0TV^QK#2C|;rHwy&nv`s`H>a^FSZl|%4(Z3Kd+izMWnja~f1(X(7iKUq9 zRA9>c?~ecco^t*+m{K~1Dkvsd?g5*Hs1qs8_cMfm$KbE36FK{-a;B*Mmg;Zu76mGrdE{*FHr?xQ ztjiC!F;^R7#*ui4KFwLSArIqZP|>#|U(@zNRfZXXYKAPm(Jk+eyN=RZpG&Z7;J{%3h+P(Q)tzugOUg)7r|9pS4i}P%Ok;8h-IzEfHAA zV#X>k?YoqjV`-X)=o4x0G?(`EcM9yOW${w=?$hRFdwlEu*F;F3`UsUp#S1&}yO#k| zV4%KDc&wnYDO)o`QfJvNXHIYTA@eBKUyarN#TrH`0y}BW5$N2xALd>!;qZ*nw$7!} zBCoAxjQ^zqE>_T$xa`=~l7Uoj|FXGRLd&`>4hnzRUMDS{4tnWTW|X0Tfx|C&=6eFc z>CW0-BFmg4D7ooVxd&jk$|s~h8LYFrCxF?u?_18l@5p4)`iUwwvLgAoi+RIiy)Ma@ z$x-A_cY-*WS%lrN4*-9y9Z)d?G*P%L)Kb?Zu1p8G&lI0x#EeNRGzMrXRX+jnx;Mmf zwyOEv?h@z(3c=FJpVY$KvwS}`#4^`hsS);!<}RGpN7?{@T%4*?U|}As(h@Hu zC!YykTk}zBv@T{SX-7jDk`4#chUSvrq!~N^Qa{%)uOFKWb7TQq!%3etD}Yq6$#jh5 zpmqj#L`+QdwUYm-$M!}XbOSsk5dUyu9d~Whk60-#)v6{D#6`*70PbXqCx0_4*AaM( zeD&EZQT-gV%Mm^N6*8j}fEtYeRF z#8C#5%en{ui-}76;NjUae0^_hzY+7~g>)|hb?R$P6Wp&y?qV9Gi*M>jIOOLpG01v> z&~pbdo0XDLEg!UJ*GT>C8&ibDR0HrYOK$|BBV9dNI7dw*=m&1&% zLsu^h{seZ``N7WGSCjT^(<*YXYJ&|t$K(x!(B?|wpu4lP8`jf+EKeSJEs#7|^Us(Z zS0zO}!HvsP!|Tm`VW7s((b1OgS)uy0n4-W34uiWyTEm#ENHh<95!f;HW^!4?TVuXL zE_}#0f8;o%c3ZQ_{`u#1lYp~KF0VRC#T5qSBAVQPy6X!uR_xm@ybU#f2qtL1jLN)a zf!W9B8gOLdzMEROYlBH4@f&&(pCER?-gbuof8>AJQ$HL8?1)@O;K<=dl9nbpw=Fu~ zsAH;*Up4~`ZRP?a$1GO)_$=L-s$BlA?EY+f3Qs8 zY5@2-MWKhX+CO3;x^p`<_}<%jmQ_xT*v;+$nU{H_N{E8I@g@Q&bqOqACM)Lsv^8A5 zZa6J(s1kk;xo8GBCiH(UOt?It&6WgjVmKP;>1|F=Q_#9;cYRRNehQdZv%n@56pNui zbKYQ_*y39Zn$>qrUocRLz}E&1yTJdmkD(6-A6k7~_T;m1g#XHp8-IS9?UPR9kR|Gl zlOi{_Z>B;84|G^qm9;C`fdO7#`+0kY9C_h5Jk^!EusuMUn*xmp%Q=pVCeAqNzc}S? z1HQS@NVUSS67b|iZ?3*la~`9V0);iG$E7Qf91j1yR4fBL1s(vmrtvwV>Z5n>EX%>G z$n;Z#D2qfj{BLX-i0uQT8U<=2O^S_h=jOM2CgiSpy_mJKZrCweTFt0?0}EwyMVLA; z!{=OUiHANXgbAhX2?zEoaXsfI96HQOR)!&flkEIIcSJcvVE)Kbm@P-CwQ_n>=2<7e z`}jGTQdFm9Z%>6(Q;s8zrmD#-8RBx;?X8IL2?y;uJ6kl^ZN8ZYWmY!Jd+0^Q_|mKD ze_sjqLs}nzQ?8FJA-t4d8p-z|L9GmRv_`NS_T6n zxhmVUm4%28+C3{PWT&GavDKNGzju7t9g>IxW7iyD)tNL7wAH#jWu^cAB0n%Orp7$< ze8*T#7??6@ABqN=Q{|JKNBTcDtXDw?UH1JOWeFoGQR2zxWA&Rt;1Hrm1Zqw_;CZtO zMg#Q2Txg46C0jAu%XKP*G8uPLyTCy z*k5d!_uw?s!dx`%=d`a{Wo<(Xn2>5vHz_kyH9Hr%vo;B@X?WB?J(tv*p8&E9RyR!k zeeCW(3t|nRSxbXJ>XL&t@8Gd)`urVWp3c(x>()M_#X&shR>PlIl?Y*x1ORl=H=Uy@5r~PR7(UzG!~krcOCPKxs#b|PTBrWTDC(UA}M`L0at@9F!j-1 zLe-~Xr6N8uQ#VNb&p`_)AANH#TC#7{g{o>YU%E4MkbvR^yp)!4{QtE#6=dKQqc=Rx zU`ZyhDI4|mRTI9#Lh-|X@BUr(v-Gay91CI9r#j)352)L>D=3Hy+-ffGVmVgzKC=KOi`;AAh*lKOK^{$Ek&;?MN{ z$MKvTno_Pm5|P`_%57Pj%Y#G?+gPmMBpD)d7jio_Qsh!ALZy>L4J((($(`IHP0EI% zv^mG6g{W4pIq#jU-}evL_Soa|{e0e^*ZcK;Jv(5HY{Erur5wJVK}(xz;B25Ts2$xL z08#1IZAyr9<5)$rZHos1eZql65#aM3Rl>avj&gH;o#;R&Ko!u4qxjEy(4&N&mw!kM5Q7yr!CWDBpJ24m=ppRC<+yI0o+g^2rXCD~zOUtg#-#X6+F7Rez0{Zry(p%Pk9WDFT zGyo?Ol#-&Yl24W(^ac$vY!t0oh*O6yuRP3c_xfpG4GFw9%j>@96JrZT*WlDVOtJg6 zsmBIKs=c)#J)Bx@@v27T+SA@pt9YgY-9j%?SYu?Nq4q%_Dwe~;n%N?Eg3;}DAuS6r z@oi!Y)$1ePzb|tFleWH~;1FaHJkI`gm$B(kGWdG7QZm~>3AtQG(5$JeDUi+qg17IY zouBM72vWNbDX(dbc>PTet`IJ;zj+!;5P&e~=H9p=^vDC5g|bN&V$ajC?m_6#0p4$3 zUcA5Si{?z=+e-s4-9eVWeS}=O?qivU#@=dH5DUQoztI1e)zf5v0B6klDCIl3^s2FY zk?Ja`VDs&dIoOkC;-EE^qu2tmLaieSL`0H|nK7<;_0DvCMbYZ@g|u_wSVHBe*#yuJ znEL2?9Q9_LCZ7_!tS#JuaGfIfozZW?I zaOhJ&t65U%ifu-4bOEYacL((W42>*Te2|J8sgxW!vtY^Sz6rLeIUg62i~pk>u{e;| z%n;>bLXaFz@ZQ?j#Ir&et5=nbhMjG_8mTP{E{DdiTIwuz-P;P#X4ATj^@~GikCGau zxAEE`jfR^H`^uTbK;X_i`82wd)pOUC{@peWvQ2+nIkZrLx>(!ex>6hbs`&?!cD)N4 zMj;C0hCWGv;n}0Tr$$y`$H-f_60Y|mwp^&Wq;jN3K`^#I%WWqRGHn0zSuIQ3# zdoL&mGr3kJwCDDt-v?ACQ)S#CBVAX&q@B;d-_yE_?l9bZ&XE=M^Gb|+j=|N_~EH*Y0$TC^&edmknHy?fSaZlrl<>Slmwx5z*k=fbU9JU@x60hBE z2a0xDys47~|77Zo!hvpTO(Zv|xJ%z~*d97!M|gY3P(Qi!TIK@&bTBE}E;!=`YS<9m z(|;%pa?PRN?i0PEZe0|=`maC4^EyTnz{2nN*&lCJH34=qmkEpc0{dWQnD40hOe7dG zQN#8hIhmwY4Q{{A+U-O~3q*&s4WhqHJne|bQ&M#_KAdE;GNCAp=>5u(YpIP=YZAZ5~oX8^KbX=5qOgbC2rCzV|f(Vj}H$zcbc@dv)!f zH-&#baw-!70wPF-pVw2O#4%*O4oUuf81XkMYI0eD((GkMX-pLrt9{zYSV87d{;6=$ z%T>*3`(O@!L94ayu9q|bVC3`~`ZD~Y1rbgEK2F`hS(MY@z6hwDzrpTL`Lz7|O5D_T zzs|-UgMvUWW8U-IjPy3&P8hJA3xRo5r^CnZ#KYuKhT+u0EsYk#XUwz$rRC{L2XKR- zhJ$4C<;COSDjKW)+m9c<9|sjL>7uA{y_7^mlp6cRn{-x4=g<|?)5qrMK;^@DbW7!< znX0qigu#6vcRU1BiVmgL$L}_&@9h*7`d6gs+E6Y!C0IV*p^&|S zpY(fu)_X&3hqy&;+gZ*_%DnerKF5wxYma0`)ts>DmvKATxT)X7<~&u+z5s%)zGg&TPC3%jcK!f{QxC4NQYq_Qfy zA@_xx4F_E5HH^7m{x*5YY@*xpWM$mUg^+2yKgf7DMO_w^2k|TMq(A6sQe&~InVf)A zADxz~_=1^@HcYZ2p&Bq;qm|&)cXmvLX(&hr1k*?hp>cbI=_~1*0h8F^p%81TJMues zInasIEkO)L*Igj3sz)jan-bD=IAQ(Ol)dED*$N+wNUcg$D{hF)&nDVl90+poF8$F+w`sZMrd{Q)w9cWw-N+!`{+ z#=1K6NO|e5rq{~fL(d#GAjqxLX^03KDD#ajsf{8>+fDK>Pk3CQ+Y~ws^T*@#_$WlV zt8gdwPk`2T#_Y*@Rl60qS-3U*w(Vhj%uCSPrt!u>o0;Tw5uhvG3m1g+_DJX=OD_J$ zeGh>upZ{H0xS zpXts!o^f{%SE=M9)0@YCwhi7Vi8$Z5B1N!$SDLX{#g@G8ozicDO3YJ<-CF)dHA(M8 z)Q*8EVi8O1-6Kz}kYbMu_Q|X%f?!S(y5Nb2GKH6OfLQIKCE0q(6R1QUhIur}YR~&z zSm)meDwfwoT_dJX`fLpKuQqYarX)sVOP)Ll$0}o3IVDOiuv@;^j-ENkI$TPTp*2h#?r>Dz?;*J2eD7?>tMohu4hg#}2|Fq?;+6DUvEz4O= zik>g?>{95@HU)T;7~m-CbypEPvc{9QHx=?W7M>%R() zsH=S~FTU4+e>?HeL7}>>PBN7t+`~iNuaAsZYx=UJl2wO#<0qu=rc55=NHE~w40WbEfzlML`Q u(eY^4d@<-RTBv-txQSWY=J)@1VO1n=kGd>wS8KvLcyKnv{bg33Xa5218)_>6 diff --git a/docs/assets/fuels-ts-logo-light.png b/docs/assets/fuels-ts-logo-light.png deleted file mode 100644 index 366cb0b4f65e12a804131209d3ea952c96006ab4..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 40614 zcmYIQ1yI%9)25M@?(RmqkuIrADqYguE!`!hq{Id3knRRSI;B&}OLu-hU-AFl8HbS> z4(IIIefHUB_YkS7EQ^LrgbW1*g(fd21%iTttAc`pPI!R;e5bwcvjOl0$x-gD3ltO{ z?Vo?p@*tXH;G57cAXy2hicyk1;6HE{;!5IBP}T7$_r~y0P}xHAQsNq((7%@vef73e zc#n6KCt|$W>sb_?2N3X430^=aLg5vtPJW|t`Uq+HnXo*PYK!zU+b(3;L6?`9qCgT$ z@J(==`7iUp6;~IMK@l&B^%kae?rpbzr5~yEPrSu1wkfYiNjD}TJM0QGZK-lut8CqDvjU`t*Jz4NEj2?pSH;TNOVg zc#BK0kUyKsvj0_QUM(H87Fh2dJbfhBN6LhY8h&zLEP1^O%T9rVuKXlVO8D7as=Ms= zo>Ncl=Z6$rw6DYL;_b{wzK7e%)A^v)j|;Rs-I#Bm&(0MNjR!8DF9{&h^OG<6Vcn9} zjIo{psWj;ni$YO~&HILmmh6LEU1Ea1B4C3_gv`92{dnG;Fl}7ypy(%Al0}L4_q-E7 zj6O(PDZ-QyZ*K&Ee^HLQXinuGo*3U>5EGBHucs_Q;WJ~IeMV3aHYj7s2_`>TL`l3sMw+DC4zdko<0tOPO`g+Uu8O&ETLI>2-Bej`iY-R_#DgN&?>&8 zOM0C2g&3IB zTnz|})ZRs2v^C4_tALp{?XXkzEEQD{+uhgTW8gkE9p_N4Ycjs0>7Aq~{h`jWOuWzC zZ2@j)sncW{{GYj}2B4xR!$PzdEcanSPmG!-b;}i9*wlql<{m;KA96w|UcA zO-fMD_QAmiRw|y43U&hp&|T~JCUu>+Gdk!N&8=XvQJlMm92w9u)#Z2s!| z4n|W~`+bL!*UEQz=eHLA{aIviM6VzAgKQ@BK#}!_!JY=~*}M^aqu&Nnjrkp=xAj^p zoxpJKQk*-~$xLqH5y0&f7YT4W*c4R%eexO{0~w@E@+(&YcT0k4@fO#T9dx=&wP{<4 zq^T@}ww#*Bbu=*d%r6pwh|(3oV9&B1a9Kv=AUf|O$HTiC?e?r|fF0;Zbn;t^)+|d(w1Yx0QPZ#pa~k-4vOAr_Rm!{n5lvN>mip3m;WcFquGVa*B^B1)A#9Nu<(w=5xR zVx@l7144ZLd?}by*@V*E>NKsBYv&%|!{n%pUm>*j6Eg@o0@YWo#3ecGY3r|D)HIi7 zV9{u;H5r012}^rw z_c-4N!o5ApcKN)-7O=p&Li*7RO*wAUhqO{Qed3^l)w1!5vY2?Q`hN)sSpBp&y}m)g z&!B_=FZfgQK=?^8^&-a_xoqAZ`n1 zhfhHt{qMq5KtRZ=Ghd{E(z^1FQh4oFJ#G064(%Fxo3W7vb28wGSf?ABQ}esi9~492G3<3T*KX-`=7l)l|ru%BO_r z#xdTR*2Q10^{Izbi*#&^XCAyS7I==dAt%5bxhAoL4vDv#jPWz>^z>m>?KVPmN#nH- zN*{?ey-?IrwLg4bbLMxlgZTQoe~)eSx};@r_n}tDDc?m7uRO2KU**GlvNlScru`i( z{dc=fanN|QZ&*B=WcCe>xjydBUsF8Vtg<@}@dXudqOve&g$nQ7sF2sTD&Bn3RE=^& zspx8BUI`5a*PWW9M%x8a=ljjC1Za?#dS>7#ltUL`V*Qsp)Z$D(NF!mQRJz))kSmTf zEU*!vZ+@rkVTvyxM7pYS?ZbR$4TT*5;siDpsozKWe0%RksbzZ5A zdR=$fIe+bVvY%o8PXr&8!h_*yU+ZeL9{eI?BW_|+e+J6& zSGwzSiZ!RmCYXweEa(3!lJQ71QS9KP1V?`o95?4=xvQaoH9ct7rvvMemUt~PUTN{h zlo;jq6Q?EJU+m57hl+mxv4Z>Bytq$`_*w$`zR?EJ-+zBCIafK)Qb*%+TKo;|j9eJ> z6M;-Hv<^fmyT`l%D{qt)HTbVp8N!{+5Jz52al4f)Iw&riG{yS1PW!!3Azw|aIo{{C zTQS%@r661wxP3)fZ@p>%MW?$~IGk%GCB1HsM6vYzA868Zbmm3Vt*4-q-+q`bGM=c_ zcZ)k;7s{$M=H?I7aF(;It!gA1z0RG8Nk@fuGP=eoqeCJJ3lx9{I|{ML8llPEJi}u0 zpSzJxJXSzdU#4-Z)Bw-8%MKtM2Ot`D51Lu`l*(zlrV#_dnSd(Nj!8mF9yDz7lC$VU zRDILn<8YW%rG@BagCDFV37*XMo!~Qcj1THB{<ekM6>wnZv-%YqdFdIEk)gK6`CJdIw|qy5*7pu738_v-L!S(o5~cZFqbf z?cB~33pe~_kk7w`Hu+(qM|Ew_XXp$3VR_eQPEN#ymmaN$?hLZzgG)ncdE}9%5aQzVyrIK!9Zt zWKX}pub*~vCl*=tdpV})nSw4-xuPJMkGw^wOq0&e9XVRWsZ z<7d6;WhO*k!Gt^6V|YC5d!h5;;c4qaqR|%@n0Q#`iv0Ivp5q*6^94)##}I8Ioi@pR zvSOH0NL(EH+ImmME6jAMW+cTJjlP9~$-b{7O znWp`-csw-T&yU9nIn<@#N7a%QYav614`>4(>*I15lbU|U0t%;CfcKCl4^Y00T76<- zLDG^G7f>koaY9poaG+Ad{eS+NHBnmJky~bVLt{y=5C6fDEzpiHb|m_OLd2qV52u^9 zZ^ls&Sc?eLB z4$KXighRDFCfMu#Rifu~2s-C@)$Q8M1&`7tv(_yqYc%cD>ofKKc5}(uewE4oT$EG2 zw6t!C#Xga|MCYcfju?7Q=;c#)HMIqFoZtzG77hGo%j_xvd$JWAJ8S@JLC?aLW*>=u znDdSwMA#!XU|bfmOJC8`Lkg!pQMt#AnZL zi&R?LQvwu$t&MLW@Zk_#rV)R4 zbZkUSS~prc;Lb|dRgIHCs%D9i|KmTX&;H|$4Fucr6`)3Rq?S}K*t4t+cnBHvbR}lj z+AsLih4+Li4(*o}{vKg4WT1#2DIVnR^2|hsjUKk%{u1re_DeVG|B0+a7gV%HKHx#D zRSOhmVH57oq5)Ekgi|GkB8%oGtIS)2CBKPrYaMHk-xd*#UqZFajB`w7q3sZ3* z{bTzs-NI8z5_Q$HTaETXF(b-*f~k+R6qZpkj;(3ddQ4^O*9R?saodS0sZ*d;q$f>3 zl~|a-`8}%XK%%uT&Bd$jo=TTNZT~7R7e{1c`x2R2t2^gXwC<0^_vhCJwug|x#$$!g zSV%KFX?fkc5oY|H3m5?mmQC$OpM}W3oeh`Slcjp=TVp*R%oQC$N1&fu$*%ic2-MKE zu~XTWe~FRZYpO3qmHUQ{6BYI>nt7cY>j?)VOp>3&TY+qmgT);IVDW0nJ9W*`lv3Ih z|5!xCXcrW7xSZ$qpFJJPzb$0cH+{HXm1OV1A6kMIXA8$xR5(aL6`VOewlt*q8a1%z zXyhc1c1n`U<&L393iBK$eSmFbdv6WOQ*L34L8XxXAb(+hGvc`TOKNqi7>%vVyy`D7 zk?)5FzMoK{zEK|RGV5JVGx?e3C9Ub$i_z$6HNaO8_OmnVnc9c~2YlVltfZVO4`?%8 z)-B&1Uy2DdV`uopQ!Ho;bL|PY5;;&Zokk~EF4!E5Te8FC8qxd^-0?0}P@&vMVZAeq zm2acl{uji5cE|T4_0~p8n=D2MmBBLX#P>?vHUWy+EG*%B_eZ9^h$5;q#7Mlo0G=gm zD{u1nOY977oyeM2n9>%0wu^LQg3k|Mu>YQw_9bi?3*hp+2Dhxm8Ac~(vx$<3Va?U+ z*Y;+NfyaZ_1K>a4<=vm9h+|5jSqOrp&-c$q?Sx7y%uFZ3~7bElSKiI36 z@FA&BHPbJigBDPE%2=q@QyzsKq`5m!-`Vluotr*PK==h-h1gQ9idnZwe?7;eCKQzM zp@l;2jjVJve7WbRNqc814qHYF`pI=4`|OkAz;2L`99%z*5lP({yk+Yu3LM4|YB13a z(4Kub=8;P`1i@BL#hT3vO~)n>%G~?CsxD|mxS4&ZR90v+CI~}%2Jjld8GX1F9wMh< zDEz0uUqV>NfLd2Y<#&9H))23K5jILxX(B3im%MA-P(+A~zkX~iZ8g)1EeX$DhL^Fjp#G2hvj4io0 z(eOl0uoSdA9(Rln37UnJT2tSFEZyo5v@4(KdPHF;v=&12MVoia^s2(!LR!frY%GJe zDEACThtF&bb&ZV(()JiwtS`}x$ByOsW3I#F(JRxn^_1Sjnc}HJ-m|TjQ6y?No{$)$1ijWWqxmtr& zg4_Fi4%SO>C*>VT9(UkbTIciZghsWfx* z1b2U=;n@NZTRlW->O+ZNEj~70d@c*{u6A1gi4P0(m&|gaLd@~n7i!EuD z{-moBCpEPfEGu(2E+$~?wT9Cy{7F~G*bSeuSey1f9qt+Ym561H%z;9*&G|$d#QMR_ z-zlwUP$*(fT?h2h0p1zk^xekQcqWwB>l@OPum_W$C*L@X`JMD%Y6~k(f`up zSvRH*;p^^F;U>?H>8vWN1%F@Pm+>S&)4A4D3O&WAdRz0XJ@vihY5{gA*nf-Za3j8) zmf&k3Yq;IQ5+Ef4y8DM6JAg-~Cmkz%OVkBF8kBTew*cimncy{NT-+tKwq;zh1%Gv! zuNH`?@#?nU(bo6H2^PykOb zwE>_Bt!mc?m%GPveVVdNtOhnI7s`30d&3%Mdz+dN9o5Zr^1b)3pberH1HFaD2k9OT ziT}3_6tmLj!nZ8=9kgyO$y|rL5n)WL2cBrgTrql^&iqulYMgK2=$(ve`8bt0$SlkZ zS$v%K;`eFt{?)?~yTY$J6(q3?ytX!iK{?4aBnI640%7E?_R{eVa7}}ouKC4ZvA&OQ zlJ^y#BsTV}ox2$POuOmRbnM4yfXQmz!QKeQP2yQ8ZslqqG$_64my`+NN4?_*SlDw0JQ_DMvr&+e1O7uTsErdV*8 zl8#Z@uD$+}mt-+AhisJ?LY5ue%`pKmrAC+rR*q*1Dv18xCgefy4=-Wo1iVJ1Qyc{{<+u$Q zBH|_<2d(2zb}jIM>WVbL@O)>Uwr-IlX30iF=I?^sus~8&lH=b1{>7&Mt_=lnYAcG_tNk`m z0CL80$rxXh1L;ak5_Zp^9fEah-&bY^an9QKa}yeVE5cMwA7tu>N|xQPrE>+&-=;*L z;SAO2Ly8HOffXC4%KkUdH=t9OLFeymi+_ps%YN#TYevy1`RIpa-rnYlz-)Yi70=yR zM2I##Tl|cE4D~{1))eBi7RUCo=w;ywRdL71cd*f~UootIM_CT9QiEZc`T-%4>Jfqn z)HN0$c**Yu@Q|HvcFJL7;!VN28RFqC9xAp>Q~tw6_{|q(H~=oHviYm*yE6{MnH`OP zms>5>!>G(d^~_}Z!CX>vAi!g)tQ7Ob!sHD)4)tg@K_cDhSv2dF^jWz+2-expo(*6A zpP7Mc1NJL;3*jpeWySS){LDxW6lT7gYs^@ARiPgz2MSm!U%Hg}D35%tsP>P6^G&QI zb}(c*JAGADwY2|Bym%x+nff`@@=$uAnBjpMdzJ2@1;7wdZh=7h=9SKq6KH-^_jZu+ z_e3I;Vb$GBDnj(QODfB-mjQ-vrty>W=e-TN8@*wF2RzHGu4?nJ%sgyKx3a}_6#gog z011tEvma2WzqH(dkD4TLke6r8jO(?i40L?af~X=R^N!Hzs;_f$vU!kO0^oWr{C)|4 zQDk=m01-|=s_UI`pe8bT%dN~=o&Q8&@LL46Cx*|9m2WS2+pYOkOBK#{4y;eFa{{>i zJ!!X{8dV+I*l$gR7-le@LA#j&wd$i>cd3a~PpL}Ruj*AHPb@=`YbqH!`qv!=k*akK z1m8}Rrk<>i#u;Pa9*zm(8YxXe8(w@vvAr{FGa?8h{}(BL&L$7EFudOLDK5ii9PcMP zz=;Xhp!Gby8rS`98i9ZmqX3lc3Pl)X1Oo64(w?|+kZ7f+Qt{${6gDrqABq{tWPL^x z==f+_)MbUyiR~^$EeF$gra~OR@!{xJ@AN>h@l&x<#2B|uo&{s4P!sisC{Z?4>O`C4 zKT1(1$o}=YToZvn>jJj(+dOa@ADpUdSERJacjdZva~S+0L$CJGHvL5tDf$og@;Gi4 z6>f;1n~BL_&C{pD9+RK=(KD16Ni7B5|F9oFmbwb7QVPiZM;}Hu+iZ^E$m~~t91jI4 zle3I5OZk1gH6$h5>(lAPzY;{NV>$(ZYP{wt#lGgPHQYb*Ob{5+sscm=2z$9EKxHnD zG%h=uZr9%Ya@~!o2?S zSGDg$Tj#UJ-#&Nq&I||d?bJ&~n%qesttD^cQcRrh0NM{t=4r}iY$VE1`wvzY*`|wj zR4M?Op40667qDf7I2nST8Pg)5RMK`Iy08b9n$6-(CL1kw3ECgFdJV(D2R|s|0``5NxGZFw= zS_c8_7_HLZ>6D`W+)c)tbz=J5xCEFls9uZ)>UCbI00tb7TO;YdK)ktQYk`|7K;?MVOnc_@$}H?u~-SvjaOA0w#Q_P zaM^$s~)001oJFb$C2)j z2QTGZ9F<9h1Ar?1MtUZ3_&;c}^@Y+B&sQeaQw5mhaT*$w~gv;}KvG zV@DjQ$L-werVSNlbnN&DkvHxjmHDQ%@#{0vpVU>uu>P=P*+ zDXX|tv`edLhy92CMu2_%(=qj(sxYV1YdR#UB(ZzDNC|e z4#)O)JC|l093m8~Q1T!(tBMPZy3!696mNnyQEQ)bCpUtQdP0&lsk=+YG(I46)C&O; z$&=7EmEg~-{X8obCbUXGn3fBZ>=8K*hjpq%8E&5jgf!lc-u+*K`}^L-rBIK%>_K6g z3yQXK`&HA5r^22FY#!7^*6;+Df5B{<4fq``Qu`PM`{lgjg%A}IKUhH1`E2w9N}a4v zx=-_%9~%(&i~Pt)_QVHK2eKpxQmxt2oefWoxH#iSquGR-pe8Ww{33V<0zmtSSe9;z z5xCD2J=-J|5|)z6pWI%Iiz(>CMo;hvN?2@G>tDaUdXyuOz?UUAOXFH_VIu5@5hWpl zq>#Jc?@mA*O`NQpFGH!6pD4KXDpQ)J_nARs3d`&RTbiK0zagBL2@p%XEgAtsHqo$M zxtB#V?mpqlYw}1{TL@o18-3}`iWfX!^x=|$9Z1^jAwaq|COEl-1A5A;2TJ$tf3ngs*MO>*hhC?5kyuB0mdVa*K)O~O6Q&S*M3+ru*iao zUPczS)w`pU#J?f0+NLkU$5)a!tmGcNB`wa8_fz)|J4$7WEQfk#cyFVqt468l zyVIpv6K`4a9y~XYLnW`}=ZFEhtMk}8%o2kMEs2PR`;;#CDMbvYHxb}!o2VU=V{o)< z)-0{Ze)3D7gxf4OV*==h`b55A`|9mhHC`#|GhR>^%Wlv6DX~e~UMm0RiphQiM!;~E z0c*;wO0oHWsq%hnSNZ;aS{&Ut!+0Ur$H|Em2J0n4cNd@7Q>xTP*;BOw^PAx(K58ye zAK!d_;RSjzN$SJ4T?;^zdPVlBmw?V`RGVk4P5Qpls(t%F_I(D?#A1flm66Bt=haBU zBj&7!mu+qxqs`xS$!XF*X7v*}L#F z;YM0R`*@D|^-qFv&whKtRjbk(K$&OPE$cq5vQz$?I0=-a_GiAhF&}gh4Dcei@DnL@ z9H_lH(v_sAwqMI%B=9_VXyeI?@>>x;)3R6@)@|S!yFvCm>*9j$^@A%TPi@e97_PL- zym)f=aQ|hB_n@pFhSG;+!h@^1ej0^PR`w}aqG20##gqF)_|L$jB&db(dGOC15kcn_ z)*G+wjk$tH115V|I+0gm{I1APwReQ5D$2)QiV0POx;W!>uLaJk`B+88NaGmoIi$l} z;y(K;Z!NgIAwNneaArf|s4TJVRr;3trKu4)w4(K_Eh9K0OlLJgkWyUhMUGUp@)nqaj4o9>WK14+T994+ zG_72Gr0A!+kHbxD9?$Y0tmeh^kRT*N9dI^X8y53uEyf_ypNQQB1dfQ1@;^BVNV!rf zWAwTZC<7IOjEtGSfdGEWO5R?(=iW$N-2yWRgKFW}FX4F@Q0@KqJt*ec+P2sG2cQPU zKD$P2)bQiY3clmu(ef9cDPO8t^P7rm9sCA2mNX;5vth*S#SS7X-W2dEJS0uKH!Z{c z#XJV;E$^&t`Exxt~2i*a`{m@Ot#UdE$YMt7q);sei-z}-OywujTN^mm} zsSyOXM_b01`C*xbiW9D<>N>Ph*Uuv;sdw(^uFlT#zMx94&(PJKqYU)a1ExImKUtM) z=EQE%$fc#;B~KsqP_=?cd)lt;@9<(2Jo|1^rHYGSE4tqk_#niYJ{>a(`#5*Ny*&e_ zA=!pbkqfz~N--xkA9;%%25q{owoV(D;(C~;GL6%(2q#2Cxs?nm8W=3bcXO%Hk!xdIuOyd{1L;;J^xV269V43XI zcK49P{^fni1|);8oP$b~7R8t^(C5#ge5!Xicu7{_fn9#?;_mtM;`Ze15Vq0bYV25U z0Pp;!|NK+VexV?dO~v#Mrhe?XzB4h#^DWwKX?&oi2Mdx&X4D5@;pLB=n|X|_ISG62 z(gI#4F7;VjeXr}gld$_any>MqsZM|yF~a>6a!oDvJsL2s+N@G<$duwjDfVBIQWG5d zob*j+wbTX^;$tq*ywThHvVE$ZcJe98qC#qK+t+)d$?SjLlF0R`VS1)|E#vRTKn!V|M0WG{4G|SaxL3lSKqIRG!!EAOw!aV}wFjQx?yEWV zZX{v*G?n?Ybf8+9b%}9(Ce1@M_U`H)6><9-U76Gjuvvqm2;GG?mWk$ogyUa^q7ax# z@Rou;+ne)t5tIfv74moaLjb%?cE*wZ+%g?Yq^6`At-s%d+x(;l9C6&COoPL2E0!l( zjR6GG8F@lkJImfvS9g|h^dn>cy(XxG5f%)}kJw}!oDfTB_$Ct|>FYV(v`rqb|7+!o2jZ8#oE3$SX^ofz~R6J_|26FPNfgg%J$%sRkyydYJRL zaZ+C#4DG)!E6Y6lwS&A&wgl?HDP?XJSdwePo4`6L{^-Y%rgRv=?k9mi_0c-|vg$J?1O}%)s3PE$&90 zV)hM9?eE)V_tkCppL4bFTSBAnk>G5Izj6sKp3i_VkXeK4LvBF(6 zv;U^;jaQbvo-P+gNAMPg-b_I851rHpL=cZNL981y6M@b%)XzjyR z<0?N79Cg(&bw(-eH6ctC2Wx6Al9Cd4&Y`!5L?)0+CHv#yXm6UHRYsMGdQ$3zVWUao zHu^jg-A~kbY?PGHHIh_Vh0X|O>Bt&AT($2wn$?c&^WH9a6=`4>Vf~%Vqcxa?)2U7x z3v`?J~hS9P5nCu;l)IBrFkl{j1oo1<@A|UNQK^qc$y?4?!KN0Ywq5};R z9KmbWVLIx}!d4!8?^9?QP}VRrI^ZCm;3n;6Y6jo4*9!BSP&n{GvZ$HYCaZdED6XiT zO5ZN12nIh(&>@Yv4!7OP>g&+IIgnX%cc`C`>TEI#t<15Xjf|afV@JShi+* zJ8expdL`_%RYKV59PLe5@Q!UhJ4bLAQYHbpRA>>$%1j?97Nq-{P{qFpl_>1hi~mAb zL5Pslh*I!&JsNbOMH~Zve_frKNk# zMt~llDOhxnieAmxV~l#uO5Ai{V+qf|EazEgH`O1@_jjCUQn_E5GTCFujlY*%&hI4< zN_7q+`B|0gKsi8QfC(msMGr^u;H~He;7u-tssSHOdOHpN2E!3B7GBTeyH zxY8y36O;wn+$%Abp12-3fEbGy-h8t3UGhc9&)O`8tW4!hZEbENCC#KbU-1%tGl$b6 zOCs`!)m{;Amrk_*j!LEQH3p>$sGDcy9}let@T! z^|3hE0y&-X9G;G)-)ShiAjAeFMvjli7f{w)`9IUq0-l(Gvwbgk^iO>ky6y4Q?1ek zH8#nLJ-SU+{c?>8cK);lBkGOl@?19@1)a1vw{<}8!d;IQ#*AH6P<0J*c3ktBR%=F5 z*!20~{&%Xkp{m`bFinlR`|6+-&qd3r%d~B?^J45f7Gh3pwf#m?wk1vQzC#?72@8MH1caybE%wK>J;HC-*lqTst19z9EOGR#b5buXP_y-L zAZ(B1$%$cz%0|4$iQ#x!m^N1-pvrJ#ob;lb3i*2ShE2Y>>60O?Po zoh&vLa2n4NtlL$gR7h8&gL_0$*Hir42O)h?Q38n%@sft#=oCaInC7*qsi~Z4b1hg% z=Rf*m?c@?|pB~x5M0ve#Zdhgbm#Cf=87zcu`FW%(P-V4^vaGXo{1i>>Y)Z2k?UKZn z5VreH1Rk!odZjXqBqveb&g>e>T|d2#7RE?7I$5eRPv?JdpUD_YwA}qkIcFE%Gl9uD zV)xnm_m-fazojSVGKA-a%2vq~(Z&N9il_p0oElyv8^Fb=2 zvm+e~)=UPV8%c3s(nSbpF|q%?-3r|*u_?)@{?fSMj9rWm{*k@i(a$!N=?huz%GVkTzyI{>HkO3)BPPlEvER6< zUvo@vyVOuyzyx7dxr?~Ox?_gkQUuP_oCTs|aC;oxCVvd~c>=}nb0>zxdC61$`V;;F z*OXa+#sDKg3Vu*{0R+HXm?Mw&xDh{6ioEkY#PZ?w?mHr_^_nOFIUb15h29mkEq^_6 zm*cqm;{H8VYlE@CX=dsaDbK5?ru!O;9uX=9pTtBhgCmRW_)?#(x+WH9&g2;XTq0}2 zFocMl6pzOX(x-tfw=-s80R@br9Q;#T9eiRdTw@x3TmB?pRuS>J*QL_giC0#;j2)Fn zJM!Gy$Y}AjUz;CB=5{`5kc6Y7jc$<(qciG*?LOdU2+mVoSQU3SE)EWiKAK*KW+os= z0QArsNioDt(~Ya5JPSiRDx<4RRdrd@Y;i-|fHnaCJ0c189mG0a(w8lVIh*P>Pd9VqrRU@Y#ZQ$u3BpX9RV+PLB;Gf(Mc_j8K& zGGAWNrCK8Ris`Gi{m%sbd>9V>#gUYY#|p#^tHM5vD+Udn_RKlcPYTryD41YyEjmN8 z@e<{oM|dVd-FF)Zy_ZQciPcjp|D2#epuqsPVSWJ$mStcOQALni?(?C*-`j*(r3R+)J^I#}&E!1h5O~603#UlX?5vEMfj_cNB$v$E#KzhAW%}J8!9d2bxwQMBs)d zJT62Gjxsh7Rl(#|Z$HJ6cm^sfvZdkXD9)V#VON)8=&vemoJ#;su zE;$HJfVbdIGIavFXA5nB>V7`RAlmMDvbe`H_wMB%wr<8x(r9Cq(NSeIt&PG9paa)7NaY6USwPTIlE0`E%Slnhx1 zmp|xVyARlWLIvI!?G?FQ(l+Kh(E=?25CoVme)M@dBgo3ELTg1?CM(PE;9+CUFmG56 znVthbzI}xH352R_#`$eX*{7h*UD&`PN`eT=ToY-!9(CO4z%t znJ2B567^gock}qslWJ_F;irD0gD;~$(z3#^AXV;fZ5)B^lcR)e^H;^ffJb+}1xVir z_p~IX_6q91z;)E^LY&`5X%M5`p0vfy9Rua|hmiwm9fcynl^IWg)=Qk&0xIab@P)f2Wq$VTk0D_TfEXDv+ zg(`o@K)mh1k|Jk4YAyvJBhZoo$0Nn;e(#Mx^-}5PO>gpfqvqGeNid3fnmdo zx#=Gbi*ICgAKvV*Zb>D^UPUl$JKtpa^?I9}^fI*nQJBm%sh?0N>Bmk#>>>B|rS`l&F6Dpq3JyT0Z$J$RJTp^GF^tgw zI>yx0m6xblRer`($NOQ;p;*nV;fvm2DYQz#0#SB1Knb*>aCcq_SpqYAFCz+u->;Zb zpM6c0`y`uemN-!@jGm9WiLSf{mXi1W0H&@iINi=6Pw{S;5xtfaw-v5OL6lVv)US+~ zj4l*{XJcPsrc_mTq6H}#s2@vQ8QTIc%KX~K9}HCWf){tnUMDWvc%&5-oYPn}7!!~@ z%1bfg>spn=*T$i>tTJ7CatBh8ggKGR?yJ>==2KUuzs4j%laKrug{dRBwXQ5xgx)W5 zHq)*xCguf|5eEq@(EpQFr{EoOT1e*R*g}RKsZ!2yO;%O;+NY}FfziK3yJ6wb>l80- z8Lc<9m;oS+5uoQ+x&e%5{&_Z_1H54w zc`0j%2_{5~0UkRez1znF_mzAJ4^vqORA+h5?S|zFV0dtOMBBvJDt7rjHVA`q;mR5n zxPsRi_0)BOqhIA-L-jBuC4o7;@?YIBD?ilCO~ej5Rb%(k(Ig^hoi096-iS16RGiGLhy_p1kkx0&7VWVqG0mPheqPh}0=2qrq-E>2$X$0!y1 zzLer(_^F?!hzVi*)@vP1o&WG3BSqo@fctz(RWAHq=*$&Py3NO8-T5;XumXCA#&KJ`G4@G2eQCUQ3)8&I#KI3-NrF^T2jZmQJmy+j@b|j7?x8V<#DH={+K~H+ zX{*fD7ddn^s#|Wu9Bjf>F>y4l6vh1LV>@;1<^#F+KW+q-xLB>AQ;Uygp#$jLu=A!~ zj7=O7_cSc<<-62kNF^I^FBgAj@1w^z2u4<+1lh6d4qPo74$MAM-@=%-K=y}ZT6HBF z7_}6p-$T6fJXIf|HkP)Rk|%nWb53L58bQ1fr1Ct`MnE-sAz`e6idub`Z$5QYPm{+6}UThoVZJjI~5{AE4 zJ+s#EveQ-|Nx8Ks#{YT6RJ4aI@p;Mh{LhKn6tf+StWq6erMsAK

lDYn8;dKOF|=?9&#BIv8(eXj8pud}txo}aR}Fdv=k1pE}snRnawqZGNf z%R`}$yJiTBarf@O4&nz@4?=C@P3Z;pdUL2%PAK%42`C?Ov*#hsYfy<` zMZTAl7?Uyes|1oKGs~?(76Ey84TaJ z_zm)HD0u6@AE5Z@Xv-HDhvC>Kp2wYkq8d0H>oL;Af@K1Rh4|F9J$;3sq#@{z^l4gV zxgn8+ZKvKs_N+0VXlF(Nojh6jBgbtCH6f7Ss}nZ*L)vCL~#?~!i)J%9N13%7evd?x@!A2SpkRZu((NRLD-UsGg-H{asq@-j2#|8>bTaJH3 ziv0GGP7c#U$6r}(B$}IJ4f>NFy0H`>yGPx8=nipZqLxL4U*G`sBo@%5T1Mzz0u|Yp z5N+d^m|#rmzM!DF1# z%Sl?Nn}FxAu&>odR3;C1MwN-O4Eu4-6jF_gn5OuUsA1P?cW<V~7uQKxh}wmJ%6A z+a!ZZfj=2h;Okld=t5yFCy-0l7oowaclnZEfd}^22_g2tB!at#0NsUO@zY1K$ALd= z*}mywR%k0epN=LXOpdGR#l5;nYt#We+q8^=1_XdkK8*+x+*oOPk}| z;cr9`yhuP%Bc2~J3SJI z?gmMb?(UNAe)qZ8`~1dx{<>q_G4RCx?!ER}bAD!kg+l|~DaCO{N~oaw#mkfHE*^&n zn*LWuLmxH#(AkUMWzP6~BuG42S`tYfVwpC+c3q0muHR2-d<(Mu_(RB#2&yd0{IkZ-LI0Gx zyki%&(btEghXP8L>U5bib$$~Wy-EhvpO~`3BE9}uGioy-^jxH&%@6i`+&MPS`)fgTHV$kX#&PL%U1d<%Pf>?{iur!ZiU{1Qkb zM`?R1-1V#I$Z^PBYoGJmKmcC6zDEgJSbyYWe7(x5;z8Q)wX->&+UbzBN#5eHD1bgF z?r-+$J}+znokXKVLN6iERoGQswVJw~qEEG*5<@SKIFJsgyU&a{GY=#Pgbxm!(5zY` z(w}>R?ky2UZG}C~o@EnOuFDh2%AqeL3la|=&kv8n15)xJhcp>w=lQ)RIWYeT>em_Im?fO=N%sY@Q%9Rkm zQ^1x`ux}*-yqB<+C?S9Q@BYPc$8_)>ClHk%t`rkRzU;`_hyoj*H2-Cd-QF|c4ipocrLRI?u@LfJm%V+_PMQIq7@K6ZSZwj%(>54&_#a#uw59N;n>g0l^-pjM7coS;L+2kYq$H8!v)4z>eHK7!6+Sq%XZ-@71*>w3Im_ zNs!}S;f^^z>{{iLAOOwEm$-yFJ*`(8z?$0@+Yp+3<!C2+8T$#w|1s97s4boiDbwtBG7{%(ERnZ&d|K}JPlz^4jF2!CrP+agHQ6mTNube#D)n+>1hm`d^c>=lut{6m9 zgIMRTPyrEYc&}OCIcg(ZbgMH)=nyx4e3AUPSQflJa&KgpMrTZkE+q4II@ChYO(UH6 zI8aW&lE)-06n$j}|2A2&$UjGr%0aMfZxokRaxCAWC7!r8FCShG?-*apSRq$Bv&v1q z;Y{TsLMW^b411>kUF_3Z!=pklhiO!OvzKUpTxK>fS}?i^VsEzk(vj}1p2&+GO(tUC0g zI`l%)YHMo6hVR><#L-&D#CvH@lyPzW;y)lXr@syxowp|~uMebuWPV3zt~;=xIi4(z zaaIJ*{OMI(mJLSi4^$8Y&4!OBnNloB*03AF#<}j6{o6m$5TbZo2nG}N;OoWLoOyY& zn2y|n8&3nO$sTP(64&O&b3cy=UyA^?F{w`10eD^4o1pXg;3SkYB`t-4)s@X`o^@ zvi+ef+XezX5v>haG`Et~kSyFc)9CU9O0bYHluuUpo%#wElO@EW5b69SsZBetq?5Kf zXJh(N>nm=9@3LEq?&3PilDDa&MJ=@(P55dSyE|>|yUA;p#0X$U5EcXbZrUc13={RH zLx+w7U-Z4e0fMVXd(})WA>++_MeI%Y9fe)c*?tY=;2Ih5-~Dtp2f_DqQUkvEarRA zr6^P-Vup{$%<+FFjjCv$0>PjTm8n_E-p6+^S+DOnoThTC4R$fv%FUXC2~FHlmazzg2+@!wj(0FKrkxqKkKOUxf`MdkdRb9XU+wUYcj3NjSwY#QG;=0_u`;@> zdRHuTX+K|y9htz&0#T5-=a<0fGaAS zf(Ufz3lr;D&4Q3oeNmsaIPf!nPtoVnlU2oYCmuQoW`av3jR!IM_D_qWv~$kMB}B!& z3pL$9@2+EO<^3I+=hNCY_I>>X*`OC(EdZ_XneH?IxV?Z`;pqZo;VUr-?hTnV7yhd; z7nuX-lZgy=*aK+Z>vJdGs>MZXuDorx%Df+#`<68*E@<&{M$;9y3c1sudS23~Jw_9t zjO2`&uh4B5;NigUW8NF;943{3~F$Pz8Z_pTJ*wgR$V$U*@U zdShrid86cQ4h0#ndJ`QwiAf#db7|8^Q$Rw=58rJaP#~_DlUITQKh>;&7pk;|R(-#` z^lk3w4){?-MGdUr4UuF{OY`5E*qaW7L1J6t;q6FvTigbLVnMd@UksCsYBk)&P4TQP z1#{&RX5@)mzzF7PvMw0Eu&kC?Le+iy3fA))_G4*Dt`QZMp)2*6C1%r%KoIVHKdTJy z?#mI4Zhc*dx(YIH#|3(XEJ!aD+k`0Srxt&VzwH)xsIOY}yem?m(V+VJrlfN$6RsDj z1K%>c#YFUwsvF<%zTv0KKIla{2_{=Hcbr7!+3o23&L?E2`?|6XvblLNwTrPSB3o zw`n|k-G&m;EP%LX0DUw?!KKn8BV$Ywa8zESnWk^p&3bfo^j1bjCV9~=%%~$7esqjo z=Xi>2r(E*6t~&$!;!b^)u6-1|ipv(GtgLC&eFEqZlDQ@$jzXT+1_VG~|EHac5DKG;t z(F-&;$OFeXAo&5$;Mn=Jc6{`Z=UF3Inn$>wbE}_{nAQ>61@}gp>W*~4QIPtJ3A;Of zd5ZCI6DtCC@iTs^+YzJbGP}kLbY#7XM3S>K3E}yimJPU~IKO#=ET0i{N|O^>4q-!h z6x0%1$wkI{&X3>!xh9u3`{V{MG#MBew3lhR>KNr(`RcvW?74JX0Yf9vq_sV@d*+ul$GUiqc|G?M8_G8VevVGi zV^iQ-w}BTNMY8R$Vw`4$V@ykFojzNIbJoEJ1ii=QwAc!H4hDF7nGZhXbyux05A2Mk z*`I&iB&%HwN)OnqXmui$Unuy;>{>W>iABjhoy@3zt zA`3nk>gwxAH-_>ga`v;rCJL6U2?EPxsfYrmS3*Wyw)D2}_WKp%$$pQv3NFwz&E36m zz16q=5;!a;qWi?tZpeY=_yy^hKSjmW_)`BQpZ)OJDVaIK#K7k-P8{?BGfNfIvKvEx zV!-XPoirSq2%vrh6=&Q&YQ|ADD1hf zB7MRg7GW#Zu);h}+9c+Q?TJ9^s?-&FM>L3-6_T-$$e<{8SUf7onM!^OFSp)%^P%s@ zVtgCwh4DmX(TNzK~*m5=JIg`%>N zMNe>C39lOGSHn8>gv65`x}Fg@5f6N^LLqN`a16$zdP#_&@@<VP5|qp63g5owV4V)hl91OZmQ*tL!~O_=#~ z$r3RIlv>`LoeDEG)8h83RSI^VmJ=En)BNbIedLKO>t0DvPz0Li;vX=N%-oXqtHuEO zCDGh!3~1g+h=ZSEs-OuMn(Vn-qOWDqsZ4&-p0nh3pW-gOn9%6?O!OY@4-;9CCB$M3 zHsOnc$r%b3LRw1B7n=TVZN&7)n7N_;YG@-jgi&9FSvBc3{SJIT{^Xeum1pO<3#QR@ z2A!<8D?cP(#hAXfnD(^&XRrRMd)=g3{;c*M1NfqNr5+~e1D-y7B3n}mzw z5?)1OI%`?2)~*FVsTcpFIIr_2dg2SKi^va#slHjWFHP|43GL_12%5y<3vToJwQ==o zJmkIj&FBed49&-=B~{XzU(4}paqAmwF?#Z4!`sNDIppjut<=If#`=$B7*AV|#+w*{ zIa|N?;0HbI!Ol8NSVY%v&L~?^JJK}<+&mS#mp0#G;d>TkF*y^s!2pVg`1>sZ9qDQz>@MM)nYeON!zp<#YVCQXD2!-*eV zT%VG8zt}7C19+5H0Q+q7^xJ1~$dwCfixrR*_VsS>?#VYdazgJ7f#gC@>Y|MW%nOg_t% zDu^=4Ys2n?a6OAO-J1EU%N&2?)MsS$V4^kS-K8FLr=|U{(puCpYFC3&Z%jEyCH8Lc zQ>Kvz(G{()ZB%!gIgov8=Ue5z(Rdc#j)sxTL*#JUFp4RvK(X*~^K3DytnRtsUZ9B) zFth2+eKq?KgC;jaO?}WW0$c1hN#EsWCaQMv=tn@FWAyIRtyj$A3>_urkPsGyj(Z!h zgu3b7LX9-&8+s=nh~(Q)R3sKd;u?9bXrI7acaaMu>2JSE9#j&4qK}B5@D{yVqiM{M zzBpOiG!g7I0?h&`)~&;e*O9B-C#xGUkupl&$L#$bT*3K;`NnZ>xoNGRK%bhdH8wU3 zm`?uqip7w*0No5A^va3F{-Xu@btvEr%_lN$)MyY>Q`~<-$>FR$vPLsdzU!7NgL~IF zN^s=bUfU}QjSGDl`1{7TrI8H}DDEpNi;4z}Y@JW3M%+(BMh$CY^k{UWgHh0 z3`UIlg0vXu$LScL1%8R(KVztWPcd=2Vn}6ly~euD`v#%9 z9H#MEkN^}Zb`0;bUJPPfj`Q@D)cs&N+W$CQW9p`jn-=wej$KT5A_{4AWG@LGG}Kad`?>_>pc8a=)HVwKiL^9^ZiHy9ebrxTR{6eCi!?RP zCmR&aGWPZ#v9Tx*TeUw&tgQ1;M1|iSI7gk$28Q;^+;o52&G@+UmWY zla0xTqc7K|!t}YBb@|9fm00w!c$CJ{pwbrf#v&Ty18!6-cb z$d!z5mq2PW_n~ZB*GRFj8kWj?*`)4)Hs(EvuVM%tm1g@gC-pb3_r$=VahEvgbYAXp zwFsG}Mh&8RnE$vBIeFV9Nsuc=Dq(orntS>!EoJ5n29~S@`n=_y`GwhXv!^;Fk+`v5ab8-C4r_@7zv!Ty#(?PxYRj(q%;=J2USI%G zP{nI#D0`T$VeRl4@J|lDEiFM#8Ua%EaNd8dCeJ7h%%sZv2BbaYwVdR?g2}ute_YAS zgS;wvd4mb5h_TEOkJZ%a-Sto2N#u1|(f*_i+y%8xRYM=tT(Ggz<=$CkxKU`-iOB0% z%8Evtp;GEU6vM_U5IMUSUVV^0Q7@N9;1lF&*?oAv2p)Zg1#p#8jd&2LGqNJpY4->l z8`~mdR9c*bb%Z`zh&{crw(`_Yf%@WF91VML)}I#*&u-V>@SQAd^-I(t2o>l(dRIN9EFAyOJ`I zO8EJcxPw|48uWjX=TDJE>Oy;JWp&tOliU+^D02Y zFO3jqLiJ$lU{={a83r5WocHky9yE1z2OOp6SaRVammcqVw~pt8q6gL}np!g!MC3yw zay#7ETB5LfBOpl&abAq?PQFdtuobsAEWdGIk0P*H*h^ntJb*%;2)Ll(KGWFS^hmJ@ zDZhWYyMH`RDH&GY^wnmZVc;gkrqeSG?^d)pav=2*LOw5mzs>|>`F(ShCqFK5?Z5Fy zeYG#8acJt^xZ}3hW}e&gn69}t7Lszy5mvr;7TUEqo9cS}d8H`bv#*K!_w+>h{{F8n zSN6sByQMvd0Mh2oYW)!febck}7IKELy=Lo5CJI$x&w;2bpI) zABp_^G;_epS8eT6hb~#geX-P|-9y)j{tg>wxZah$ZOJX_0?}vhUW7F1p_L0! zq&C&ny1pGt0=J)t z+|KpRb=^-}j;)QhD#AuttW{T}8}fB|fNWAx>e1+g+qcDgv?h$icP7=EP(G68%8OmK zPdpQQjHh#C9-5bImm;=UqPTD6e>gnW#>UG3N2^ZO)l=Vaj^BfK8m+uq8y%q?Y-ZJX zO6+k?1kI9jYF|Q29j1jX_$;v{^-1K}`?tGBsRgs;J5VJ<=9?iSV5}v&T1k~Da=RKd z%#WR&NLFB(r?-TFJkZ8FH@P%>%-ztDGxj!Q&B&^O% z0>3UnKdNh~04dP;Dn>iNmhM&G^o5-pW4KnCcDB@X7k;5fhC$ql!t=dy}1ua03q)k`AWn#d7@z0j-kf#H0SuX9- zJ#ErmvKjgDa3Z2;Byj-rS)GM%R@abE%>#%B;oVVbxYiMO4*g=u#Z8Ffz3-;txm70h zbl;ljwTE0m1lP}?synH2r-R49M)pJ`dL`o*7ybb-rISFlahcpUVNw2V&t~Tucp2IX zJb6?|fUOK0`z++=X2(dukK`d%v&gv`vD-68$y=XMWQ-5fBTd9caj2&g(C0>`Drza1 zW%udq1FtScn+<+hTjj}SDS1W`H#R3>2zcKcLJktIGRTbauZ>ZNSYrGMhcyMLqh_$4YG@VUfjQ z4X7(wIM{2~t`$KV3?9th=B29jAj6q(XY zyA-B-1W zj&l2^9VS!Rb8h4nAR41W<{hLv`;9(=K?yf)xwZKh))GB0hzv zR!S=ble*1}DYmr!ElHm$c;cPc2hs-Kt@3C%I#DAh1i`sJSAbZLwP@ca%Z781?NPx* zgkNREpUUg(vZjFyi_30_4fqI%0bc^po4>9ofqEnQV7s`Mt~4vF)v_ajD#aqOSa19} zS+C^ubGr6?F@v?Isi2po5uhO?Wy>wtbFf`R)j01atH~0@d*dmTZvkJ2MY-p(^G>KlP{cunoSBA=mEPLTCK zb_qENC*2hCQda47ugCc}`bt6&6KUnkpYV}tOiiOC2NC9FM``LLn=^ucKW5=XA-z>g zm_rD-;C?6Px|iO51>^vRRo$DpD5=s3{Yrs))KV7R!uUV7?WG6RO&0$!_iG5bj1OLQ zR#kDHJ(jWCx>yfPS(yD2^1^LJ!VTs?>SS?#?an|d9RV@KEX~~~i3Nb8Cg&O8kv!;m zqN@MNMIet?{}jxEZ${m z{XFW#_1oIvd+~hibxHDLxYR6iX>3$JoquD}zKv4=V&okAsbWCyvw#8+nSmBCp3z%I zAi%v9>^KOHT52%z>5%pvEpjTV9F0Ll5IpVAEq@p!c+wjE2 z4wOBgd#6YMI@wjoUjoa5!!Hs~oQLmn)b79hu52Q}AOD%RVo%CfxfQfHq9E9FCqI%y zJpdo-y-`=es?2^^94@{pWw$QX1%YY7oW#X-X$8>M`qPzpSQN*Z1*sSIdBM~S1$X%O zcaiOZ9LLx4fw}qB@iAjds<;{JN2o#Ri^V!cv(FuF zj^{-r>y^$Iq1Rk`4x!<+uqLvN2$v0RoLTUvx8+S)>`r=~J>pf)J^Lq64zB?>rgYdM zC#pe;P5)us@IrE=9~Z^q5M;1hkVrQ`|D`HHjsfrf1DWe-$=zr#PifQV%P2iVO@hy5 zOb;$|_hXpN&SEkpNC`t_Dcvs)j6zGh6sL#M7g{5=LLXBp5jPl+dE7_~Jh`~IDHw!L z;YK3A3GGdXYp3vZ$|di~=0nUP zqrYy}H=mOQYz1Zb3w**-tJsplY!3=?;+_2!_kpxj%S8L=+P#3xBZg)r6;rSB^_Z;P z6Rfw7hy!#Bqc-;SyAh0u0|<#^dK_7v_gaYAcl@MP`$dL#Qgdc6}nNoO!{FjP)=PYz^Q-cB!-mZi$LkmP<^F zxDpVR&`GHe`)E%w&c~b&!b+}D{Ct2Xh11;u_!>^W`3#Gsd&wdc3f3g(q;knQTP9XM zcIwxB_>H{M12&quM0~UFjmyFg@p50QJvt}|DQ^FYH8Uu;zxohhSb=nrM@&Mf8(G5c zk8k!PDSOw^m-+EOop?(k(&g;@AAg$O*p9w(cQtMIuSm&CLOm%BBPw@AnDa-$NOsK4 zG%x>iP3_WPTs@gg4t1Y1O@fN=shr69k96tg(N|&cpvfJ3g2w=j(dcoUzgnI9BD`jB z7&fi<&yv2G{%Xe3oP(2KOQ`UQ>6EZ@VvVA{i|d(mW48VyEWJZxo2H8D(Y07R8};_w z18yY}Eg}+4ISZpZi&Pj!z zRC9A;c5$AgQADie{#BQJ;P{RmHIAs@Q|aJIw}TbAWFxtyBi=dMP4e2s_K**bY%_9bPR;hX=-o?S z%1Mz_*r3z?Fczrrs~Hj4hu@o;=-)~JR+&P0gLg&`G<5`M=mEcRDGk_YHIS{9EC4j% zQGiw_T|SyjiIKpF!ufSl(&fcTo7o2g0f+ay5m$1^HChNCq6#f6#)g{YBngQ=*pqK& zRa8|KM>jvWjGu_caS5y0bSfjyjMX(6JRJOa(ohSnto(`0AM!YILtZ>osR=&0;eD6s zkk@YGqnpGwUE=)4_=Z0H_|ko6#NjHaVVt5OJsVMC%aM$x%Od2)A)`M}mEzjP1`)L= zZA9j*I%{OLc8UU*!S=l;0&>DKuAAmG)xd36oBvQ;?^YjZvh$!>zSX;*FSWbkc8~CW znVXGwtuKRihgEx_4_y#v?+7;AXt8mx_h3W&b|UWYl~~1RtYf&Q;huB(4A}d9q6ToE zEjP^x{S3cj96Whhb6jfKim#z6uweN@Nm15c1Wc=pDFR3DY*pN{8A>a9ZuS{#AD*6d z&6JFG<#KkPcPirsc1PW@5Puq@C2SH#h^DGFPa+!~CYJQEMJS@io;i)8E(^-0_P1@T z8h#p}&R!GIyr%M7bko@%O?07kA#EF5B&mslpXnpg33vQ?HOFYoTRVd5t-+7>uIUpy znt0<}lCpMwcUn9HEvNk(M1ozp!^_q8cohuQnt)Xe3`n+?E8@)(RB^2ZA z^3c%F7c)heR$30Al1dOhUKIl^8xBEo>M>x?AkW01R5 z3WR~ANLJ!15Ou;Yqb4nNa>@p|9S!f?Rl>_LbyZZ63D)!{#bV z!0E;Ug;%r@7a%26Is>7xiMFQS0 z|Bcy1*uYWUEXBsW;Rr9}Qgf7R!PT0~gyLN$=uH!cynt-f zK8m8DB1k}DUPpKwVx}mVMHz3t!}rx|`ZRR6g6)bj9}ZyQb@!Z->vmdu9m`I*cOJI1 zzcA?wiu^d;QewF}#bqKp)x|3RzC~7g^_8vYMG3|9Nd1GqgqOgm)vTnNbUAs`QW4B8GjkG%!S)bL`SzSE?z8~3$nRjdtSr?gbRVPCLTCMQY#5wJ%i8?wZ?X8a96!pNf>3#xtcu_}9627(;hFaoJp8W&!pC4wFcXmXyw?I7A+&7m-94 z%|1+-147S|TmZIUaf60SJ+GsJu5V*e^R#c#p)OJyoLH+J?{oH*&pS%i0^i&=%xtx} z;m7IQKvL&UG*L6tW3H%q;uQX-c+iMp32IQ_=;(bkaf6fkC-+%g`9gT`25~yLxQtv)vv&W{)<2tQ}An&=uC|8Q1ma$Bl!s+@~Ekn4xsEoO%=<-1?=Ov z@Zo&jrW!$5)f1NGEKnw?M&e{NpzeXcVpyfVxl(k0Cda*hy{J** zpk*n3a3k3@IKz|tVXfRN(5pv|gcv~v2WT~URz>m~=DE!O^8`(9e$l@8Qc0iOCUwdoC;AZKvmcW)@>A1~Qck*zLf|VmGa|EJkir9v^%I;0u9u z6@FFB`3$hk=!DM5uyc}9frPn#JOOXYKI=90l}$AusxV1=D7F>&{7dm5lg6g)@zEpa zs}MdR>0-3lxb3I?(E?+r!--e@B^D_6lU8{Zs=9h4`j7IJbj&_!x11VH(s|5~Kx@kp z?9wYl<#CgKs;2L^Nr0~F-*2Q&YU)d#T43%7@`RK{=Zn`WN*`VdR{tTYDX@9j@SDG6 z>?Nf-V2{ELl6`deCzl}~hx2xsQg{Q?3Flrf#oo3u!)owJ%<2%tEN5Z`+;Z)Qhj#NtBBHW-sT0f;2a znI0!}L*Vt==|+{}-K@0`(yf+(lg z(m`8kL$O-&6X(v5(qSFIhJ1%`sKjzDuFd~Ld#CAWCC3%<5hfb4YvU@+B%`@X_!YS^ zor((Av<}B2PB`tp4e(V}LQU8BH1#E}&aVU+b}}==aJsMf=)YfD3BoZ+#ffE>2Bds~ z^vcZrGp{kwUYq+1;)cqlmQ z{>12I4B6OM052z=3rc+?0n`v5x3{;A01Jdx!+%$|$jKgDW+r1a|NR28D&of<#s$mS z3}dP_GXmj?TkcH;-pjbv^#e(T9CQ^%y2I5K{eD$ltq;n*KKyd=K=txeXlLH4{!Nb7 zh?<6<(?IQuC&m2r^`n@o_Y|kk!2t80znmo-bq21(kz|TUYw7o-rz}vf=;3?xueYT} z9nLM^M94jke7olkRdp}t7g)?##y@h+z)v_4k$gC!4ycZFxn2+M*h_6XQUY-#7@>N|J&U1dN&8D zag5|TgXtyTj*#Mp6c(fVznkQ+$GWp-rk2o-b$(WAdB+hcs0if*$X2A(nS)~`r2K>h zGabmKxqAh$@6-x75~M|42|!irqN)xI(?&bS_SibbtW%?_-Nr8_3+4YsWEcXv?UaHK9csz)I#H(eQzUWM z)!x}{Pvv;+uiEO)L;wsHVS4u-Luh+Cyy#ZKyqXR55pa=9?4;yc^O~d2-2!ZI<$kEx zUuIq)D?G3ThrokF#*~pBp%6G-Bs!6n*ljnU@Bf@Fhx^ASXuf}z<2;+_ubS*Oa|i$q zkz*LUKsm8I2j1QYIC6oRBT`lUe?M{+Am`sQ#+MNq*#jAFV-qH+gt!h5%A;zjr}mn2 z?z`yzA7`c){H&_2B1!u^U-!GmBLP<@2Y&FIKb#|%0rym=M3?h5tknM=h=!=(PWU$AHxC-!P{S zIJVwpQ+iPR0y>3Dad;T)HlHwMk~jJFAbCmINAo9bYl=1_=-|{wJr@;!WXOhE2>dObrw$Y`9OCRzN-?ffd81?vHCReW>2vccH%8mQ1$@3ziB{MRuP>$JwThZeKk6`1b1Ab(hG3%WwPd1 zI;iGX+F^+9-0Z{8CE_@&Ck}qp)*zCkI=y_R;UZb--NVA~d|(JzYCvm#e(gUkR`Usg zzTH!Cj`>&B2|;MWymS_y71t|@~s@*2hcww{_%6b`7cd0*eMW!BGnBqYD@1v`CGh(>wby#I5BoD`Z&9{ z#_RE3Li_S->z{2eO5s5y0#$vnOTwHa!D2X-0Zb0a@6l!~x!~1mdNbk}fC9mfRxira z=l^@eG(fJzwFy?)^mcCqUie9K*>e@vuo-JT5GWgmg3-6VqN688-#22Q(X$)rmEL6n67A)+tvaTHv-7NpA^%O1#C-V(GhEkFH61B zS2`{*_X?Q)*Bc^o;m1^F|$f)e6^oYISHmP!Vs;_@BT0#v=kg3o^Pg+P)L^)}!-K;nMQS7%#9tH=4%nQ&U2*Gum#^l_+ z)?#=AZRIm&@b2>Ln52bzMNB{Y_fg0KNxO9QFF<~C$OAfzXL=KhHaXlowI+4fmI2sK zob+AFV{(!lN`hK(i`yWS`REmrdDSCOeY?B1a(wS&s;ut=6->;P_hY;NEn;qY@ZLBS zpX;)ClmL9p89+s^ZOdwUzi(zCTByjY!((s=As1G8192YX84e+FuxwWwwBm7iFQmPB zv?wB1Fr=no=oF8y<{`1YgQaEI^`7VNTMYpzm`=P)-A#m1Y2ELZm1BZm+Y4kbE0UdmOrp6NCbt;orzXlo%a4;a;E5uR!p@|ZR~Ql zpSDk0Z=5GU%ICC%E5(CnbrkX24^O9L>XK>HlN{c9z4omxV9chfr#HLdwC zA4lvV0PE?z-k~*voaov=44PD?OO@ZxaHi(gq@Y64i`zVZcY`5y=9XUKO2wo<9sT*8 z2%abMDCGKhh$}Wmq0jDVjd`_e2!6N8_{^Ag0S%{{3MD;!uh0Yr;RTtP5@gy62K_ zb5mPkakgFco@6gtS|jIU6dLO>0Q&2nb#{b94tQA609P;1Z)cmn+fA2>UQ=k!370t% z=g;ghev`SaeXKh0U)&izIEv8fC>9h8=s@_g)Pl7^jbLQ1s{iHLGD za@eqQ2i^A4)FZ2%SVD&%Izclb-}>vHam-`&)kot;Ug3)7qyNkG#Eb-G1)luZm;J7c z(IC|`&n}0gJsKMiTZJ=W}TQwuUGA{jDrSt3brd@fINmY6*RNcX+AbW7hBYv9wFd`cfR01QfWN=VW3azuyfqCQiv?j*jUsbT z1K9L$V$rAzj&PP$lVC0IW2WF$Dx=Hvp}JQ5TQSIv)@bWLpAz!Fbu_e1A|bq<$Jf%_=(q>|!2+0q!s z-v-BK14xfE>Wi*J7!u#xc=i0s#`+{CCuU2)3&8g+)UJq>(2b8qD)~iVbaOc>IL(#$BlAg^;4$- zbsrFXsmK7pCEbn<<1=_$-iF4IOL{nQm^fhfZ6_ntD{|WM{}SZvK~R?AceO|7RHAM= zKONl7F~D+z5NY$EQUlj0UYzP^{!i{wz`>dXvD@q?<d3+0uPoz*(?BzRpMC;Y za2#+mpab3cG{_^bB=~Qi8UpLZj)QFa5glmb`5b`YWUfeVxp$T59K~%}!}vKq@vdkq zKhs1&D@2|p1*GZm;j4;XX-^FnUjlqmyzZ;5If3-Q<*f)iKDNAeO1Z-R(n}^;Eurtxi9Dg3-BOp>ANr6mZ(og zXO{G=fE6m}c1N0Kdn1EN@8utY?W(!ouSxb(Jm4^?siO7o3-iZ{0Dbi0?{~+Z4Hn=l zkklrY$fRs&BLKpubtyJQ>ME=z?DMCUd;yz7I^@8Vo;ygc>rCf-(PpMg^4!e^!T=u+ zGX{)UvY{5;X>MbHnft%5ettx?M2YLTt!*Eh=!}xbYE~$zZ<$jB84^;k?%;q*73JSz zKej4*;}wY7^g$GWZLnc&K1RBhGXn@j{Rckb#Z(#eU#Iqi9ylCHONUgoCQq92pI?An zW@-jkS=!XE6N>d16JvQzka}K$|6s0ra2RowG@B% z0h-s~v!*?R%6z#fUy#4@x3RUQVDK#AC4_iNIpjQa1-4A+_&!N{^^Eq<#%%A6 zbE;)Q{|OrVlWV$mX2-w7f^e z`I?0oPt(i#|J$5tXu-oJOpv?I-rh)_*qMA+1MQlee44hV8VDG0giB_+m(y$ zrVSf|!UaeCY+deyG@kfn|2i?Huvc!Mw~qtQn*YAREDG?j{mROQNiS<+q6An=e#Mt~ z#wQO#5Ut(Xk1C$R+_6?~PdbS0!>0pOr?Jcc4XdHiGE)E5i9j#VH{0tau$ip0Vf z{a}6tRq31lpA(s#>gFC!Z($(V+al)R&40<^(r>^MBElEK8kSuiAqdw;+Ovi!Z)tK!`RlqU?;L$_x&N7fUwv5rfz!+b6uwa-cMQB0EF)t%lRUabU(QE zp`!p9 zS;N}KZoVj#`lvM%U(oy9;S1x8+*fOB690Fv4q6N-Zez`Ia&am8^`yWP9hJ> zEVw+niM8ym|73|EWixt*bM`F#@1532#>|KKFIbpr27Z%aL^^J&i#d&A$(wm!) zh14P+&9I!PQ@&dek0q2eVsW`9X)3a*@-{sHw8mjsgjd+wJ7{*@$g0C@a-Oz`)ROZE zi5NwLxPw>S1F|u(v>ae@KbOt*k2{Oz^8ANEwt2{#L2a(TR3v%J`*i|R)`t^ralcl{;&IoMTj|7h)vsnA8iC>5J_mTaKP`-fuEw+jZVgS=DoN7@FL^Az_ zf-vl1?VszPIZ&XsdIs{BK^`sdqD+~}olJ?DWl-pa zNG1NZx%u{n0cMm28EM+L@RT~!m9!nB zMOJBJcGiG#rYX%^Zzc}o)H&D}u|<+RAh~~kCs)eOKs;fopL5`!!D;Xa;tD}8Bq>Tp zzwGm6Lf>HoLW5qZlVRCUVr7%}$=3h2DDDsfF}j~O+`Vv8tki!zA{06kW=fj&CQRjz z$eo7w*Y>U3>guO($gQL#EBNe&xJ<6|_`R^wxpFe}z$Q%Y{G~S}E!`;ycWOAsb@# zX3Iu`m)137t**jN6$c)H&OOBI2TYZSgY$vGPGOr{;x_12H%w=8Ixeg9C^%DEt_fzJF^#{*l3 zp@YV_<#<*%Kg8eU{jEn@e*Ze~L>u@_^_9nxv4o@(wH4u_OdeGwT<>7lv@hNHMTVQ1 zqXf)HKj9ZcVL&`-`KjIrk7H@svlZtt<@OaZRTBa$PVG_n4|n3Bi+1Xprw|9IBm0Os zVNL`nxH;*fnSDGZ#ueLj$AfRT^&ab>`+j`W?ob_mjtMOB4^bUo6HlqON-L@M{f@SpJWo(dn%w2_fD6m7cOim` zMCh|?8p9e_MB|EO}7y9^q6rK5h>7i`)hULz!Qwp^k2s!=UQy3uR;SI*hGy3^mPBu|3&LVMQAw( z(WCZHjt!G~>OrbGtA1q*wN`-o<;6lr!K?`VR5v2qTm{2x#(GLF6k7Z3D~Kk8JbYYY zORs12I!~5hm-4^;RGqHbTbu})|HdADG>B}xbzpV0-{ZwhVdGQ2OPMY zq&2o>xo@vHLX`9Bx~fu5&1N(!B~#Lg?k*RDXLmmPXsNON;DS~%g4@Z8UH zJh%^PhFj%JKU7kq&`{#tpXyo=auL^g=!TV!()Yct7?$nO`6gae{+|;TP2qr#z*>u<`f(PsU%`oED3fSs zLY!I2WH!_6*Ye|ly6XYAH#Rj(JfM;HBY#k&3tEDXTAYWbZK1y1o?pU4RU2z(f&-G~ z+-hMmnO-Mx;mD^dOdn@Hy)8DYq&fAuT{nq2Ik+W!utqp5L{IRs@e{>I{K!$|c9YD~wt~(bFs7+gHT^x24%3Bk11q|i zClEI7fvwgVRua=%_S!yhV!^ZlQE+NoQG!?JM(WOpeFloe&$lgG8s!U%SXZ!`KY-?@Rl53kMn!BH@rDs-w?Fb+ozgWSjdC1$IR!7QIi3G(%cA_(Cuk4?WAnc=kF1& zmVrlqmi?|>sGRAo8#$lXrxA=#@);PX5x2 zJaI*e+JU@YywHbMDr%|dx4iG-B;h%0ATmdvU%P}WUT1s1S6AFUaSkrXq_;{n2YTy2 zl%WEB&oBpa_orc|CZsp)nhgbNS1)DT6jBnB%~%|H_pP3Rb^=Hb)BoghX}=M{+kWhc zMBWev2x}@epcxx|>#S?%I9kk$fdPOE?b>MvJ6YZr*$pL)D)YgB_StxeEaCS*j7BaW zT@wa1;`7HJ(Zt0J@IIubcvjS*F>ZC12A2jY)9O;et2C=^g#sGRk&ADfy$49nO>@?{ z;SMc@-kXUCtB(rNj#f7%`62_{TMSc~58q(M?~+HfL{PC7U6(DS+|THZJ@m#2t6Mrb zyx+^n(Kw9@Wb--lH{${wh&23+uF6uz*gbep?T78FzH)Nl7Csq(i^A8M*7z#Dg^|=A z-w~J2k%8!bS*lvg|B_-!>$f37j|ewHd_%3M69XGV=Auk_B@B+E8_1vFI<-T%j-r=K z{rG{Ln%rG~eQy~B?dENMD_&j`^gZ7xXM|Bd*wEZ#n|4zgJa%zNmEoOMACM0bI`fB6 z?44xD9EzE!6>yWDj2%7xSjVj<%G^h7*rsY{m6p?vsy>bWj1VN#TDJbT5^`rSZ<$|u zG*Zkd49P?hGZ{ne`*yjStgCUCFI*ZJ;Rf`4!;@-jnB^ZySB!T;LDNezgk!f~%4zuO zJ`8e^maTAPdJ`80pQ*7Q*z)@HP=k5vS@D>!hB@y@WNUlho^E1cl-2MJ9JiG;ZuiHJ zUkKX4eBS&j{L(7A+S}95$+_q^9xBgD*-4RmTY5a8JB1-Pv1Ln-A1_jQAxxFhsOvzZ z%!a*culdl_kS;@MJzTlu@6jr)ta@d}qx$@=x=PB0vf>(tKb1;o#u1K}&OPlbsA3v9 zA4P550_z6%j-q>gaT%*#66qB}-W{ij zbUbmVJ#MORejdCQQ9mQAC}ks;VARxxzsVd*4nSH3Z#JLB&^vmyO1j@~bxn!2Z7 zC3H5E8zYdZur$~bxQRQ781l^&@clKPE zH%{t^8=gz41_!0-L-5tMAxEbla22^+us(%RW}N%V*g=DJ6=G8o_J~nY)VDI!dAFKa zo?R_0aHZtj#@WK5O@jg~jbl`7>ZGz%uG%!?6ch0{E=|6%R)+X~JLa3XptaurA{Z30 zV17c2)*cRLLs(Akw=j(`DTxfhO^yxxN12Tg+&Jc&+RwCO_?M~ApY`HARjv-M-7)#) zBf22P007GH%Mv)^Y=b2n|6hfv8T}zF@5@@QO<)zVsXfK)qYnVsN$#i@3rvN?)O;op z7h|l!%g{%IU&ZJEpz9{DpIc*NtDcER-SsbDTdIDwA7WJ6ZvUq-!lUC?bKdUQ52a9i z+kJu8kSEsZNn)w-xr|@#tymL@{LhkBkU`_chW-BR3?Ts6hB-zLMwyDJ;;B224RQ+d z2Ur>n{LvFCZ6qbIKk~@86Vm)H4oJh_2{PSo(G^Bn1H4eUmT#`vm9?0ziz*SxUcyKi_LIGKdgd7Gup zUy0N30zj_j&E>JeX+)}K7X}pl0qTLguT%S|{zW(m-tsq);u)>@-pd#_XM>+?Udg8&8!x7l2Yi!A;w=g zCx~{Dw?d6x{f^ImP9{av+t%y;4h%D0dkO$lj75CYR;Bg(r zE!G;LKvH zAm%}XySxsYVcg-8WTL%h-OJ{8qRSJMN3~AS9z$RhtMwKz{=X$63;^_+cnRFm0th+IG(~uPGe?BwLrj`iwNcgS zbS&#d#fPV%Iqwz;8jCwli!_|ru4GG%&;G8t!h~kic`Z!x4GvJCIP!HIy}2ssF~U zqF78Y*z$4q!GO!mYKLNNM$=P4p2cZ1C~*-N+p8wwYKKZg=ZUPQvKt<1=9Y0g{2 zG$N@PavuMY?!$G)q&l}n-mK5oDAgssroK7RQQbpnMXF7+Ub<{iN6E^D*Q+vqNqU1R zR~QD!CpHp}Poen3Yp(;~;kurz>9uX)zTw3>JCip_im{JL$2pL@Qd0qijNmh27R}hQ zcObj^7#EspgEqUeuZoeeAS%9R>cN`qXVJE{wNJHe_T({@+~I9`h63wxgFAI^*J%Y84r1^T4TB+`zBi}Xrky(N9S5T#S=+;_H2Nxw9Gh4> z2ana3!fvQZ5H78IyObj!LSYKG8f+wG zX?u`EhqEFBJ=JUrka5rSDS0jTEUWY|zK(~08j}R&ie$y3JFhl=)xyxBN42Jyi!W`K1ST zA^R48?C^-ck;C@e(~V_2<)EhchTI0LhcVu*&~2vRYQ zD9?~4G}$7eUL0*5OC6hHg@j++Q*KmtO& zc+->+p>esG?KKwCjsdMk9vaao2xCCZrT%;{iTrVNXX?~xDncZdNhIbECAIvlGaAL$ zjNmJJT#$VP?t2E#`WN2M%N}(y_hvN&HC{`TP?*aY8&M~>Lys^Zc@K9L5r-K!CjAfk z(lf&azj^36M@v2RsUa)}IBsl=kMm?2z|I(lNwt{MNe<_YapH@Xox*!yHLMP*qFLDJ z41F}2J*_8=>q?fT3WK%R-b}K7xnJ6BN_gFp?>;dCqA^ard)u;?snwEcHom#dWPvXg z#3J&L;CE3edKWPo?2Em3Urm^-Pp5LYaW{ZFZIRpUQ z-d=lA=~Y%720`ikdT|>G^uxH*Top>XSKVaD zHmrNOqwuCx!pd0TMEDIE7A!wuZ+ug;z>NIBx(t;`bWPU`^q-UsysY_3CWl=8wg!mLz21KQEpZW-Rtv0##=Dyvf_E+i) zt~3~X-!1KcWV9!7(^5)G=v(IkMlgiO4jquN#wUL+kRTX2y>L_~!b zOK_z0E)VTIX`xNaF~DHJ4(ZZo?b}f|XVS{qO-f9*5|XpyG(MPCU+UUYk$r2+6M?OP zeT=*{(x7@Y{F?6^^%i~D8PzY$S!kG%&ilGEN|wvY-Tt=L*DJ-|KE8LQ$ylUs(WuzY zqmHR=1@5Kjxz)R`w9+gK$69QLlTH43SvDHhd!N0G)EV!!7{T4u;lXE`OxtH6@o(N` zJH_Yi{N8&s_&$9_+2eDkXl}57`RMC+Y}Vdha0dVC*N{kxITt30W!dkXSxbx>&MS$o zS0Fr*jAU$*cc4+$Niv=t^b?7e*J{~}|5syQ!h!*XrYX?A!C@$_77NDb)MT;K*(6Iv zBm-ixGKH+RZDezKaZAV{$PPVcKsDJ?Jmp0jZRqKBEGzfD)8!9@r~5b|c5h(qt07Mk zWu&;S({p7bEKw=pL<#5;jo3bZ-{tcAlPqH%uy&>(6&?N&&t6A+z!R{tv&uJ)lX{Uvz z|MN?btf_yw#5ZvBN-@prt_8G#WHTCVysyxM?Js8Ol^SXX%`&*mbMfdhUpooGHo-SV zT{T=Gq%WejKd?7ZmxE0Yl>5|s{A~q84bDt9dJAQHOYc=GHJ9x<^OP9X%Na`|AABFR zAiYnl9w z!WXls7L9-olLJ~yMeFhS2=n8D(7|d&)x!YM^`Y|Ul`TkFI6U70mUdfl|L1d|6=?eU zOQ90=mM>3sCcU1R6}8TIP)2%&(;`2h^_3i%uL~l@-wOu5`)yXlEn)AmivMUQITQDK zTvq!StnTD(8VD14&A!Gz43%u#C?Ou2JoMRM5#e^9{Wd>eHS4`+pk4BEHDtz&K4K|C zMwbUV55_LakJm18a=Y9@@&iaQshm%`fj{5XRQfyUqt0Tov_^|aQrNRKzw>1q*RA9J zi}q{}NMCf$pNxWELqe}(2eY~cn0xlMOopQ~k*I91VDfC@_XG1>MMI|~NCS+)(kkz< zP58Yms$O~e9O07M{POH>fn(cx8H=UO2zf7eXw|!!B$MMa>&4| z2?p2&7t1A^B6Nq~j*cqwfp1sTtiRqEm0hVKN5yKH>n8v07#%&kxITBf53A`v@eVt| zSFbb=60RYb!D|HZKtwd5xf<#7(UrEy)$glHWU*Xd)9Mi;krweG$1pIz)FA1EkVKXe zx$z3+W$%O9cHuSY7s%ay2_j-Z{yqDwN$=VUHxZ;e2Vt-9up-c(N4rL)Ah`^wm3FoE z!~7}%neVTEiY+Tx^NaS{3JqRSJZ9%0#VmvGUT3|pbbNJE+(tArl3~E7C2P?N7t3W6 zky^yo^tiK9=4)8n5&q)X7aUUGv0+lJWz&jr!eb`}lG=ZNxgYF3&&mhZtB(zVX@4)b zxbwV|iWTgdBTSd}Y%prlRls}F;9_umvyeV(WclB^FtJW$`kg2gH;Cf2FyhrF)O{IK0C2^r*)cD9|7asM4oUH#?;^ly7}Je}pCoBvq{ z^K{UZ4GU9q_X`h^j7nY~RlSi+C~|YId>zLxLz?2-)R-Td)wmV-nT9P0OXZd-d4EHp z89Vet?AhH?+T6d7iS?x{w#-BG(^b8d$g5 z-&R#ebiH$UyU|DV>p_nt7Ceksd6nwcW=j%hPeCjoCFAH-!KvX_FD(6`3twy;JzW?N z5wLk>5PxD;Nq*SVO{md&xq3Ja6|I0dJplQ_WP z!=xXf`}NsXs}ITP_SRQZZYVEVLRM8P8?sE+W>Zh9|0zH56?3XT0?U4|ori^><|9kB3e7%Tw#qc}spwD@L=^(ey0XgbukdC@*0XkQwl#=mjC9 zXl{U0`0!gseQFT&Nh~5aZcg#Y6l;}WHePLZay&wq~ znBE=XNRFJJo4`x8rRtU(Luh$*c64`Q)Aq@m7J3myru%!JCazNglb)x1;JEmd`kc~I z-)9L4skRSyuyub)3+zjMJ#@747M?_(J|S?b{Dte@7r@6W2feRfuKgy{(_*8Dza956 z)YW`b#6;MzF)k{{ilgj^V~d>Tg{$2wt(RvT>Y$XLm?C^NHQ%_ha=D)ISzlci^<4jQ zU-Xep^>R1Wb4#~T^mK;C1&JG7bnUXiceD;=)@x}eOiG46WS*2}L{0LQ9BXmBB_`?* z|Fpo4575HOzSn}J+=W=iJl#=kL|3>`NXU*Rw+u^K)b65B^UWu5xnCSi4FT>;-Rd6Q zaj(KAmK!Xkv<_qDz~A0I+u&c<&r}N{p2#+(7KK48k>M_)ad($?eR11css_&Q!oMin zFC`HJj~kPV!brC3fh29=WW2ysc(j|R2Y%$eF3&ZY`@SpBStVw)p#jlmn))Rhq(2i> z@Usr&Bp2UzQ~UK4u0Myt^Fw@mCJX$y4}8f=qk$Jb&}}UZM{RvP&MZngYyGewnB|Sy z?q~Zgz*;=Me?54+acvCM5uEtMe`u>wru*MyOO2{F_>Fs?VaO#;eVK}V+DqwT;3uaK zXt7*wJg#Pe`G;y0iAMKVkH2Enr7C9*)!%;VeSXv|^PN;=F3XtlZ`Lg|RCGZ5t>kN? znLmy<4xp`>%de7tELR}Lt`GAx2c66o>-_(t#@bvsn=f>xRg;!dl%i5NdZ%4pq($zNHFN_0q@n)i7%Osy1h=^F7oce zEU}^V7!XA*yol1%rg#0ITaxA%Xl~&9!f+~#9Ql_(43%P|$b~1INB9Ej*p)DMOWVSX zHoU2~H~GQ7XX;xR6%aY3fkHmrygBe`f^Uq3d2E#Q$CBhkH;Y9^-ZpcZia6V@D6FQ4 zp?}53928%$d}ZRivPaGG^&SO75#q%-y@Ooc40+zfL{fyUmry!hR}0@D3D=empUll# zkk{2EB>4gLKZ+k258k{QYf;s%8ZqFR!#srNk|kCZerS>b;6V*Vr>vU#s;Ew~GONJy zXMVqP@O0qDUA3wE)^S$kcA2S0gF{)0W{;=f3{^O?3lUwM;({xUT;*kkE?rUCIbqvO zGi-@$Mtn9-r_9b2ZIj;S=@&nOQ~7T!y2t+!287Dry39!!?2&+be@;=M=&Ml|y@r#? zy&3}AY^3j%nPBe*@D@VjADO9`+R%jN4jRls!k_nUK;@>PY^4aZe~ahEv4LV(+7V@E z4*^{uv$avVfiWkoiWmO|J<%ViOoo{O}zaWnhf z88z+sBRIRJ4h!Cnu;429Y$m+TrSvc=G^R#+UWT@qlh$wS%*%`GOs)vCz^1rzkaHfj zb(05U;?oql9vYCxq^OedBS4nBPQmGjtC#ubuzD#zb(S4x5}{g^}NY z&5;8&5DBH9cUx=t0f- zd35KVn4-<4)G0oB56@=}#DunwBKB(t{ZW5`oJ&q|gNy{ZV)%U5T%Kkg z&TQq15%ywN6OL zl!JC-$xS}kN71j=qkqIH9F{f3mTRUL8VxJi9Jb&N%JE|nwlJmbmkU!Rw77x*7aj9_ zB#45$ttGk4^b}HsyAyNrl6b7`7OI}KS2)<2;`0Bsi2kov)UkC=WrGy36u8_fkHpv$5g$Yo zQEBgPuLu&O{ZAw&gmSyvmWQz#F}_NIt&adEN(&`;g?j7n+nc#8cin3_Z_jOVn|$}} z%+BLCGv7D!%{Oz5jbLSL`g8_f$v(b@v6+mq%1Ry{%h=C|8w*a~SB_+CEfP#Y8f0Nh zKooC3lT)npTk3&Q50rYqtp_5yvLvd@&xhL=p6`~%kMSGzCFe#=WgTdCxMlI>5kq;~ zvM~J(gD2LeToE;teV{u8+;Ci(71hzYKgI#8QR;~ra&63%?-OCa z@>pEHiSQFaZnifyNo4{n!fV4j<*P;5kDTN@YN~&THfW~uioh9eUw$@p;@!>LYetDU zKXPFIMBoQcYKANcoY7`=9As&|pY=IvD$5=CNtSvearK6D8+7?r#62a#e&ZzL8ThmH zSyvZF40*oaunRnxe>yYUkg3nmlh^#J&%heX#LvU4MH@+-iCBV(Pyd$bNC|B zf4Ml)e&>Rp=A;hi`iymAX+#g)o2$J4`VIEvi_uoKwy`yM)u3c56QIM99QdgXpM|W@ zSppZW&rwsFB*KN{kvPicc0qx8TA!P~m(D@i8@#Z$wN_awFmCF9qNJv)4~o9ts7sfT z?JdHEI}oF#a(URuhTqHDD0vfZsVWyqz$?f67`7n*$aJcG}Ky8@I#-W3lEDn z(0&wa{7WKSNFFuRMsM1n9&2oorV>_K54@U>Li$}Ju||F4O&jE|B8IvOw$TggKc8P- z$bNU071q^DFjpKIqz!%eet^?o+_o0s16bF)uqXQ+-?8tMsjMUL8||UJnzJsi-eJ4U zKz*lBuiLzToYq#V-}a@%-_qiNIaD^SA&`rg^R36rd}zaFw>CKE z5Ttq4OC0%@ZTGD%yXdoOigHOW$*(BFe&Y7}O!}9t3w>grNVX1iCg>;JPAvAG%uuq{ z=SVzoKc%yMT)Mi(na6MM4b93j%!?WGk@}{O`sg${GL?3LmG+B%^_>We zq|dm7X$w@DMpMiy!P%58l%)$a5-nDRpcEBq)S@$P4iHq3;)+xm=k;QdX_ zk6w&D#2T@t`5C*w7Hd&gVSR%>%N>xLIvN-8ZMbmQV{^Uoj|`VSDB&#iK&c0^d%&_E zvaRSD3O~Wqb#s1*^WXGT{$DydM*=FZhkx&>sxSRL^$#^w<3VQd2N1Y;GPk0##FSUK?|=N7V4*a~rcf*TxPm%#a4DqUh0 z=T#}*&v}x!!y1>0w>ENaoe8IVT9u%?KCdypx`ybFW+f8`iXk{l8Sj0tQ(`FeWy`oTWs1JMWIhogG+c&gLh zLpshZyuv}_?WmvjsMAf$|L{ZbMwE!d;MWAyYftiG0JE{t%@PzWLcH4C=gCT)J*3 z^<}29bxc?O9-#aT|4UZ=^!*^6aZs7q*DcF;e$?8OAbikn_XP&SQ4o2I=xRfreUO$% znja&kT%Fm+LkYv)!QC@uSKb)7KPGHe--tQ#_Mz07nTEy>^&iR;L!W*2i#al81n$l( zd#GW;kGXyzd89K6Ixjg4>Vz+W{5rkR|KoxnLtE%>%~0!dOBbg5E!pyTD%Q5>0+M(5 zfUDf{7AhWdK{Rt5#GSEX_@B8ve&NI*&H{^3KlLN^H~QhA1H;!8k8{0+TlQ9urgyKO zSgU=f^#sRY`#|aLj~Dj?+}c9E*0enG`(MQx1Az&)Xvz*Tm3op5x&tP@6@%OI*rK$< zkGLOgUs}Jb=F(!+>#T$9o_bxWbjFq5hffc{sgV8jBC3y50z6S?S>&GRudu0~je+~4 z9IlTt&tAlSEaPWf7hJke`Cw5|yB|pJF5eMSR5mA)hL> zIR2kt)=biN1}pN(4;yP6=FK%^bLMjffHl7sYrTEP25aFhv_BsV2k9*4iy3q-iu(%- z_&nZ=J8IMDK0~hj>-Wwdjr6PS`IqKk5ayqwsWQ}`KEydT*(+{kH0_qoL)s2rXO^53fca-)(4c?9<(vHu^&cd3pjmn6aYJmFRt>4_@*X^qrh5SE&!ujNPZHHJcBG22t_sF_KndJdOjwNB-|LW;2w|ds0ini&QUCw| diff --git a/docs/guide/abi-typegen/generating-types-from-abi.md b/docs/guide/abi-typegen/generating-types-from-abi.md deleted file mode 100644 index 8bbe0fdc65e..00000000000 --- a/docs/guide/abi-typegen/generating-types-from-abi.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "Generating Types From Abi" -parent: "Abi Typegen" -grand_parent: "Guide" -nav_order: 0 ---- - -[info]: this file is autogenerated - - -# Generating Types from ABI - -## Installation - -First we install `fuels` to our project: - -```sh -yarn add fuels -``` - -## Help - -A first glance at the docs: - -```console -$ yarn exec fuels typegen -h - -Usage: fuels typegen [options] - -generate typescript from contract abi json files - -Options: - -i, --inputs directory path for generated files - -c, --contract generate code for contracts [default] - -s, --script generate code for scripts - --silent omit output messages - -h, --help display help for command -``` - -## Generating Types for Contracts - -We can omit the `--contract` option here; its the default: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types -``` - -**Notes** - -- `-i`: the relative path/global to the ABI JSON file(s) -- `-o`: the output directory for the generated types -- `-c, --contract`: tells we want to generate types for contracts _(default, can be omitted)_ - -## Generating Types for Scripts - -Note how we make use of the option `--script` in this case: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types --script -``` - -## Generating Types for Predicates - -Note how we make use of the option `--predicate` in this case: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types --predicate -``` - ---- - -See also: - -- [Using Generated Contract Types](./using-generated-types.md#using-generated-contract-types) -- [Using Generated Script Types](./using-generated-types.md#using-generated-script-types) -- [Using Generated Predicate Types](./using-generated-types.md#using-generated-predicate-types) diff --git a/docs/guide/abi-typegen/index.md b/docs/guide/abi-typegen/index.md deleted file mode 100644 index c6f127b90f2..00000000000 --- a/docs/guide/abi-typegen/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "Abi Typegen" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 1 ---- - -[info]: this file is autogenerated - - -# ABI Typegen - -## The JSON ABI file - -Whether you want to deploy or connect to a pre-existing smart contract, the [JSON ABI](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/sway_quickstart.html?highlight=abi#abi) file is what makes it possible. - -It tells the SDK about the [ABI methods](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/sway_quickstart.html?highlight=abi#abi) in your [Smart Contracts](https://fuellabs.github.io/sway/vv{{site.data.versions.sway}}/book/sway-program-types/smart_contracts.html) and [Scripts](https://fuellabs.github.io/sway/vv{{site.data.versions.sway}}/book/sway-program-types/scripts.html). - -Given the following Sway smart contract: - -```rust -contract; - -abi MyContract { - fn test_function() -> bool; -} - -impl MyContract for Contract { - fn test_function() -> bool { - true - } -} -``` - -The JSON ABI file would look something like this: - -```json -$ cat out/debug/my-test-abi.json -[ - { - "type": "function", - "inputs": [], - "name": "test_function", - "outputs": [ - { - "name": "", - "type": "bool", - "components": null - } - ] - } -] -``` - -See also: - -- [Generating Types](./generating-types-from-abi.md) -- [Using Generated Types](./using-generated-types.md) diff --git a/docs/guide/abi-typegen/using-generated-types.md b/docs/guide/abi-typegen/using-generated-types.md deleted file mode 100644 index dbd152516f6..00000000000 --- a/docs/guide/abi-typegen/using-generated-types.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: "Using Generated Types" -parent: "Abi Typegen" -grand_parent: "Guide" -nav_order: 1 ---- - -[info]: this file is autogenerated - - - - -# Using Generated Types - -After generating types via: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types -``` - -We can use these files like so: - -```ts -import { Wallet } from "fuels"; -import { MyContract__factory } from "./types"; - -const contractId = "0x..."; -const wallet = Wallet.fromAddress("..."); -const contract = MyContract__factory.connect(contractId, wallet); - -// All contract methods are available under functions with the correct types -const { transactionId, value } = await contract.functions.my_fn(1).call(); - -console.log(transactionId, value); -``` - -# Using Generated Script Types - -After generating types via: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types --script -``` - -We can use these files like so: - -```ts -import { Wallet } from "fuels"; -import { MyScript__factory } from "./types"; - -const wallet = Wallet.fromAddress("..."); -const script = ScriptAbi__factory.createInstance(wallet); - -const { value, logs } = await script.functions.main(1).call(); - -console.log({ value, logs }); -``` - -# Using Generated Predicate Types - -Consider the following predicate: - - -```rust -predicate; - -struct Validation { - has_account: bool, - total_complete: u64, -} - -fn main(received: Validation) -> bool { - let expected_has_account: bool = true; - let expected_total_complete: u64 = 100; - - received.has_account == expected_has_account && received.total_complete == expected_total_complete -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw#L1-L15) - ---- - - -Now, after generating types via: - -```console -yarn exec fuels -i ./abis/*-abi.json -o ./types --predicate -``` - -We can use these files like so: - -```ts -import { Wallet } from "fuels"; -import { MyPredicate__factory } from "./types"; - -const wallet = Wallet.fromAddress("..."); -const predicate = MyPredicate__factory.createInstance(); - -await predicate - .setData({ - has_account: true, - total_complete: 100, - }) - .transfer(wallet.address, ); - -const walletBalance = await wallet.getBalance(); -const predicateBalance = await predicate.getBalance(); - -console.log({ - walletBalance, - predicateBalance, -}); -``` - -See also: - -- [Generating Types for Contracts](./generating-types-from-abi.md#generating-types-for-contracts) -- [Generating Types for Scripts](./generating-types-from-abi.md#generating-types-for-scripts) -- [Generating Types for Predicates](./generating-types-from-abi.md#generating-types-for-predicates) diff --git a/docs/guide/contracts/call-parameters.md b/docs/guide/contracts/call-parameters.md deleted file mode 100644 index 2bfcdfc9360..00000000000 --- a/docs/guide/contracts/call-parameters.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "Call Parameters" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 6 ---- - -[info]: this file is autogenerated - - -# Call parameters - -Call parameters are: - -1. Amount; -2. Asset ID; -3. Gas forwarded. - -You can use these to forward coins to a contract. You can configure these parameters by creating an instance of `CallParams` and passing it to a chain method called `callParams`. - -At a basic level we can invoke the `callParams` method as part of the transaction flow to set these params: - -```typescript - const { value } = await contract.functions - .return_context_amount() - .callParams({ - forward: [1_000_000, NativeAssetId], - }) - .call(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/call-test-contract.test.ts#L176-L183) - ---- - - -Here we set call params alongside [transaction parameters](./transaction-parameters.md): - -```typescript - const { value } = await contract.functions - .return_context_amount() - .callParams({ - forward: [200, AltToken], - gasLimit: 1000000, - }) - .txParams({ - gasPrice: 1, - gasLimit: 2000000, - }) - .call(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L260-L272) - ---- - - -The `forward` parameter defines the limit for the actual contract call as opposed to the gas limit for the whole transaction. This means that it is constrained by the transaction limit. If it is set to an amount greater than the available gas, all available gas will be forwarded. - -## Multicall with multiple call parameters - -Here we set call params as part of a [Multicall](./multicalls.md) - -```typescript - const contract = await setupContract(); - - const { value } = await contract - .multiCall([ - contract.functions.return_context_amount().callParams({ - forward: [100, NativeAssetId], - }), - contract.functions.return_context_amount().callParams({ - forward: [200, AltToken], - }), - contract.functions.return_context_asset().callParams({ - forward: [0, AltToken], - }), - ]) - .txParams({ - gasPrice: 1, - gasLimit: 2000000, - }) - .call<[BN, BN, BN]>(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L277-L297) - ---- - diff --git a/docs/guide/contracts/calling-external-contracts.md b/docs/guide/contracts/calling-external-contracts.md deleted file mode 100644 index c5110ebf69c..00000000000 --- a/docs/guide/contracts/calling-external-contracts.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "Calling External Contracts" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 7 ---- - -[info]: this file is autogenerated - - -# Calling external contracts - -Your contract method might be calling other contracts. To do so, you must feed the external contract IDs that your contract depends on to the method you're calling. - - -```typescript - const contract = await setupContract(); - const otherContract = await setupContract({ - cache: false, - }); - - const scope = contract.functions.call_external_foo(1336, otherContract.id); - - const { value: results } = await scope.call(); - - expect(results.toHex()).toEqual(toHex(1338)); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L133-L144) - ---- - diff --git a/docs/guide/contracts/calls-with-different-wallets.md b/docs/guide/contracts/calls-with-different-wallets.md deleted file mode 100644 index 34f69b9c3df..00000000000 --- a/docs/guide/contracts/calls-with-different-wallets.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Calls With Different Wallets" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 8 ---- - -[info]: this file is autogenerated - - -# Calls with different Wallets or Providers - -You can assign to a Contract's `wallet` property on an existing contract instance as a shorthand for creating a new instance connected to the provided wallet. This lets you make contracts calls with different wallets in a chain like fashion. - -```typescript -contract.wallet = Wallet.fromAddress(someAddress); -``` - -In a similar fashion, assigning a custom Provider allows you to utilize a Provider wrapper of your choosing or design. - -```typescript -contract.provider = customProvider; -``` - -> **Note:** connecting a different wallet to an existing instance ignores its set provider in favor of the provider used to deploy the contract. If you have two wallets connected to separate providers (each communicating with a separate fuel-core), the one assigned to the deploying wallet will also be used for contract calls. This behavior is only relevant if multiple providers (i.e. fuel-core instances) are present and can otherwise be ignored. diff --git a/docs/guide/contracts/cost-estimation.md b/docs/guide/contracts/cost-estimation.md deleted file mode 100644 index a3c3cdd2b33..00000000000 --- a/docs/guide/contracts/cost-estimation.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "Cost Estimation" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 4 ---- - -[info]: this file is autogenerated - - -# Estimating contract call cost - -With the function `getTransactionCost` provided by the `provider`, you can get a cost estimation for a specific call. The return type, `TransactionCost`, is an object that contains relevant information for the estimation: - -```typescript -type TransactionCost = { - minGasPrice: BN; - gasPrice: BN; - gasUsed: BN; - fee: BN; -}; -``` - -Below are examples that show how to get the estimated transaction cost from single and multi call transactions. - - -```typescript - const invocationScope = contract.multiCall([ - contract.functions.return_context_amount().callParams({ - forward: [100, NativeAssetId], - }), - contract.functions.return_context_amount().callParams({ - forward: [200, AltToken], - }), - ]); - const transactionCost = await invocationScope.getTransactionCost(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L359-L369) - ---- - - -The transaction cost estimation can be used to set the gas limit for an actual call, or to show the user the estimated cost. diff --git a/docs/guide/contracts/deploying-contracts.md b/docs/guide/contracts/deploying-contracts.md deleted file mode 100644 index 1997cb720ee..00000000000 --- a/docs/guide/contracts/deploying-contracts.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "Deploying Contracts" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 12 ---- - -[info]: this file is autogenerated - - -# Deploying contracts - -There are two main ways of working with contracts in the SDK: deploying a contract with SDK or using the SDK to interact with existing contracts. - -## Deploying a contract binary - -Once you've written a contract in Sway and compiled it with `forc build` (read [here](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/index.html) for more on how to work with Sway), you'll have in your hands two important artifacts: the compiled binary file and the JSON ABI file. - -Below is how you can deploy your contracts using the SDK. For more details about each component in this process, read about [the FuelVM binary file](./the-fuelvm-binary-file.md) and [the JSON ABI file](./the-json-abi-file.md). - -### The deploy functions - -If you are only interested in a single instance of your contract, then use `deploy` - - -```typescript - import { Provider, ContractFactory } from 'fuels'; - import { generateTestWallet } from '@fuel-ts/wallet/test-utils'; - // basic setup - const provider = new Provider('http://127.0.0.1:4000/graphql'); - const wallet = await generateTestWallet(provider, [[5_000_000, NativeAssetId]]); - - // load the byteCode of the contract, generated from Sway source - const byteCode = readFileSync( - join(__dirname, '../test-projects/storage-test-contract/out/debug/storage-test.bin') - ); - - // load the JSON abi of the contract, generated from Sway source - const abi = JSON.parse( - readFileSync( - join(__dirname, '../test-projects/storage-test-contract/out/debug/storage-test-abi.json') - ).toString() - ); - - // send byteCode and ABI to ContractFactory to load - const factory = new ContractFactory(byteCode, abi, wallet); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract-factory.test.ts#L10-L31) - ---- - - -You can then use the contract methods very simply: - -```typescript -const contact = await factory.deployContract(); -``` - -Also read about how to [generate-contract-types-from-abi](./generate-contract-types-from-abi.md), allowing for rich TypeScript backed Fuel usage. diff --git a/docs/guide/contracts/index.md b/docs/guide/contracts/index.md deleted file mode 100644 index 472916403bc..00000000000 --- a/docs/guide/contracts/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "Contracts" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 4 ---- - -[info]: this file is autogenerated - - -# Calling contracts - -Once you've deployed your contract, as seen in the previous sections, you'll likely want to: - -1. Call contract methods; -2. Configure call and transaction parameters such as gas price, byte price, and gas limit; -3. Forward coins and gas in your contract calls; -4. Read and interpret returned values and logs. - -Here's an example. Suppose your Sway contract has two ABI methods called `echo_str_8(str[8])` and `echo_u8(u8)`. Once you've deployed the contract, you can call the methods like this: - - -```typescript - const { value } = await contractInstance.functions.echo_str_8('fuel-sdk').call(); - - expect(value).toBe('fuel-sdk'); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L107-L111) - ---- - - - -```typescript - const { value } = await contractInstance.functions.echo_u8(3).call(); - expect(value).toBe(3); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L54-L57) - ---- - - -The examples above uses all the default configurations and performs a simple contract call. - -Next, we'll see how we can further configure the many different parameters in a contract call diff --git a/docs/guide/contracts/interacting-with-contracts.md b/docs/guide/contracts/interacting-with-contracts.md deleted file mode 100644 index 731e47119bb..00000000000 --- a/docs/guide/contracts/interacting-with-contracts.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "Interacting With Contracts" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 1 ---- - -[info]: this file is autogenerated - - -# Interacting with contracts - -If you already have a deployed contract and want to call its methods using the SDK, but without deploying it again, all you need is the contract ID of your deployed contract. You can skip the whole deployment setup and just start using it: - - -```typescript - const provider = new Provider('http://127.0.0.1:4000/graphql'); - const providerContract = new Contract(contract.id, contract.interface, provider); - const { value } = await providerContract.functions.counter().get(); - expect(value.toHex()).toEqual(toHex(1300)); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/storage-test-contract.test.ts#L46-L51) - ---- - - -The above example assumes that your contract id string is encoded in the bech32m format. You can recognize it by the human-readable-part "fuel" followed by the separator "1". However, when using other Fuel tools, you might end up with a hex-encoded contract id string. A [Contract ID](../types/contract-id.md) can easily be converted to and from other Address formats, see the [conversion guide](../types/conversion.md) for more information. - -```typescript -const contract: Contract = new Contract(new Address(ADDRESS_BECH32), abiJSON); - -const contract: Contract = new Contract(Address.fromPublicKey(KEY), abiJSON); - -const contract: Contract = new Contract(Address.fromB256(hexedB256), abiJSON); -``` - -You can learn more about the Fuel SDK bech32 type [here](../types/bech32.md). diff --git a/docs/guide/contracts/logs.md b/docs/guide/contracts/logs.md deleted file mode 100644 index 14db8e75bb4..00000000000 --- a/docs/guide/contracts/logs.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "Logs" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 9 ---- - -[info]: this file is autogenerated - - -# Logs - -Whenever you log a value within a contract method, the resulting log entry is added to the log receipt and the variable type is recorded in the contract's ABI. The SDK lets you parse those values into TypeScript types. - -Consider the following contract method: - - -```rust - fn produce_logs_variables() -> () { - let f: u64 = 64; - let u: b256 = 0xef86afa9696cf0dc6385e2c407a6e159a1103cefb7e2ae0636fb33d3cb2a9e4a; - let e: str[4] = "Fuel"; - let l: [u8; 3] = [1u8, 2u8, 3u8]; - - log(f); - log(u); - log(e); - log(l); - } -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#L98-L110) - ---- - - -You can access the logged values in TypeScript by using the `logs` property in the `FunctionInvocationResult` from a contract call result. The logs data will be in a `Array`: - - -```typescript - const { logs } = await contractInstance.functions.produce_logs_variables().call(); - - expect(logs[0].toHex()).toEqual(bn(64).toHex()); - expect(logs[1]).toEqual('0xef86afa9696cf0dc6385e2c407a6e159a1103cefb7e2ae0636fb33d3cb2a9e4a'); - expect(logs[2]).toEqual('Fuel'); - expect([logs[3], logs[4], logs[5]]).toEqual([1, 2, 3]); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L442-L449) - ---- - diff --git a/docs/guide/contracts/multicalls.md b/docs/guide/contracts/multicalls.md deleted file mode 100644 index b804510f626..00000000000 --- a/docs/guide/contracts/multicalls.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Multicalls" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 3 ---- - -[info]: this file is autogenerated - - -# Multiple contract calls - -At a basic level, you can call the same contract function multiple times in the same transaction: - -```typescript - const contract = await setupContract(); - - const { value: results } = await contract - .multiCall([contract.functions.foo(1336), contract.functions.foo(1336)]) - .call(); - expect(JSON.stringify(results)).toEqual(JSON.stringify([bn(1337), bn(1337)])); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L180-L187) - ---- - - -## Different contracts in multicalls - -You can execute multiple contract calls to distinct contracts within a single transaction. To achieve this, you first prepare all the contract calls that you want to bundle: - - -```typescript - const contract = await setupContract(); - const otherContract = await setupContract({ - cache: false, - }); - const calls = [ - contract.functions.foo(1336), - contract.functions.call_external_foo(1336, otherContract.id), - ]; -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L148-L157) - ---- - - -You can also set call parameters, variable outputs, or external contracts for every contract call, as long as you don't execute it with `call()` or `simulate()`. See also [call parameters](./call-parameters.md). - -Next, you provide the prepared calls to the `multiCall` method and optionally configure transaction parameters: - - -```typescript - const scope = contract.multiCall(calls).addContracts([otherContract]); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L159-L161) - ---- - - -> **Note:** any transaction parameters configured on separate contract calls are disregarded in favor of the parameters provided to `multiCall`. - -## Output values - -To get the output values of the bundled calls, invoke of `call()` or `simulate()`: - - -```typescript - const { value: results } = await scope.call(); - expect(JSON.stringify(results)).toEqual(JSON.stringify([bn(1337), bn(1338)])); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L173-L176) - ---- - diff --git a/docs/guide/contracts/read-only-calls.md b/docs/guide/contracts/read-only-calls.md deleted file mode 100644 index 2f9e98423d8..00000000000 --- a/docs/guide/contracts/read-only-calls.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Read Only Calls" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 2 ---- - -[info]: this file is autogenerated - - -# Read-only calls - -Sometimes you want to call a contract method that does not change the state of the blockchain. For instance, a method that only _reads_ a value from storage and returns it without making any changes to storage. - -In this case, there is no need to create an actual blockchain transaction; you only want to read a value quickly. - -You can do this with the SDK. Instead of `.call()`ing the method, use `.get()`: - - -```typescript - const contract = await setupContract(); - const { value } = await contract.functions.echo_b256(contract.id.toB256()).get(); - expect(value).toEqual(contract.id.toB256()); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L702-L706) - ---- - - -`get()` doesn't take funding, as it is a read-only call that doesn't alter the chain state. - -If you want to dry run a transaction call that takes funding without altering the chain state, use `dryRun()`. - -## When to use `get()` vs `call()` - -Anytime you want to call a method that does _not_ change the state of the blockchain, use `get()`. If you want to call a method that _does_ change the state of the blockchain, use `call()`. - -`get()` is intended to be used only for read-only calls. diff --git a/docs/guide/contracts/the-fuelvm-binary-file.md b/docs/guide/contracts/the-fuelvm-binary-file.md deleted file mode 100644 index 1598f3bb660..00000000000 --- a/docs/guide/contracts/the-fuelvm-binary-file.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "The Fuelvm Binary File" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 11 ---- - -[info]: this file is autogenerated - - -# The FuelVM binary file - -The command `forc build` compiles your Sway code and generates the bytecode: the binary code that the Fuel Virtual Machine will interpret. For instance, the smart contract below: - -```rust -contract; - -abi MyContract { - fn test_function() -> bool; -} - -impl MyContract for Contract { - fn test_function() -> bool { - true - } -} -``` - -After `forc build`, will have a binary file that contains: - -```terminal -$ cat out/debug/my-test.bin -G4]�]D`I]C�As@ - 6]C�$@!QK% -``` - -This seems very unreadable! But, `forc` has a nice interpreter for this bytecode: `forc `parse-bytecode`, which will interpret that binary data and output the equivalent FuelVM assembly: - -```terminal -$ forc parse-bytecode out/debug/my-test.bin -half-word byte op raw notes - 0 0 JI(4) 90 00 00 04 jump to byte 16 - 1 4 NOOP 47 00 00 00 - 2 8 Undefined 00 00 00 00 data section offset lo (0) - 3 12 Undefined 00 00 00 34 data section offset hi (52) - 4 16 LW(63, 12, 1) 5d fc c0 01 - 5 20 ADD(63, 63, 12) 10 ff f3 00 - 6 24 LW(17, 6, 73) 5d 44 60 49 - 7 28 LW(16, 63, 1) 5d 43 f0 01 - 8 32 EQ(16, 17, 16) 13 41 14 00 - 9 36 JNZI(16, 11) 73 40 00 0b conditionally jump to byte 44 - 10 40 RVRT(0) 36 00 00 00 - 11 44 LW(16, 63, 0) 5d 43 f0 00 - 12 48 RET(16) 24 40 00 00 - 13 52 Undefined 00 00 00 00 - 14 56 Undefined 00 00 00 01 - 15 60 Undefined 00 00 00 00 - 16 64 XOR(20, 27, 53) 21 51 bd 4b -``` - -If you want to deploy your smart contract using the SDK, this binary file is important; it's what we'll be sending to the FuelVM in a transaction. diff --git a/docs/guide/contracts/transaction-parameters.md b/docs/guide/contracts/transaction-parameters.md deleted file mode 100644 index 71ed827b3e4..00000000000 --- a/docs/guide/contracts/transaction-parameters.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "Transaction Parameters" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 5 ---- - -[info]: this file is autogenerated - - -# Transaction parameters - -Transaction parameters are: - -1. Gas price; -2. Gas limit; -3. Maturity. - -You can configure these parameters by using the optional `TxParams` and passing it to a chain method called `txParams`: - - -```typescript - await contract.functions - .foo(1336) - .txParams({ - gasLimit: 1, - }) - .call(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/contract.test.ts#L117-L124) - ---- - - -If you do not pass the `TxParams`, the values default to those of the chainConfig provided to your Fuel node. - -As you might have noticed already, `TxParams` can also be specified when deploying contracts or transferring assets by passing it to the respective methods. - -> **Note:** whenever you perform an action that results in a transaction (contract deployment, contract call, asset transfer), the SDK will automatically estimate the fee based on the set gas limit and the transaction's byte size. This estimation is used when building the transaction. A side-effect of this is that your wallet must at least own a single coin of the base asset of any amount. diff --git a/docs/guide/contracts/variable-outputs.md b/docs/guide/contracts/variable-outputs.md deleted file mode 100644 index 1ab3608af73..00000000000 --- a/docs/guide/contracts/variable-outputs.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "Variable Outputs" -parent: "Contracts" -grand_parent: "Guide" -nav_order: 10 ---- - -[info]: this file is autogenerated - - -# Variable outputs - -In some cases, you might want to send funds to the output of a transaction. Sway has a specific method for that: `transfer_to_address(coins, asset_id, recipient)`. So, if you have a contract that does something like this: - -```rust - fn transfer_coins_to_output(coins: u64, asset_id: ContractId, recipient: Address) { - transfer_to_address(coins, asset_id, recipient); - } -``` - -With the SDK, you can call `transfer_coins_to_output` by chaining `append_variable_outputs(amount)` to your contract call. Like this: - - -```typescript - await token.functions - .transfer_coins_to_output(50, tokenId, addressId) - .txParams({ - variableOutputs: 1, - }) - .call(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/token-test-contract.test.ts#L46-L53) - ---- - - -In the TS-SDK, the Output variables are automatically added to the transaction's list of outputs. The output's amount and the owner may vary based on transaction execution. - -Note that the Sway `lib-std` function `mint_to_address` calls `transfer_to_address` under the hood. diff --git a/docs/guide/cookbook/deposit-and-withdraw.md b/docs/guide/cookbook/deposit-and-withdraw.md deleted file mode 100644 index 5ba2f580c10..00000000000 --- a/docs/guide/cookbook/deposit-and-withdraw.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -title: "Deposit And Withdraw" -parent: "Cookbook" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -Consider the following contracts: - - -```rust -contract; - -use std::{context::balance_of, context::msg_amount, token::*}; -use token_abi::Token; - -impl Token for Contract { - fn mint_coins(mint_amount: u64, a: u32) { - mint(mint_amount); - } - - fn mint_to_addresses(mint_amount: u64, addresses: [Address; 3]) { - let mut counter = 0; - while counter < 3 { - mint_to_address(mint_amount, addresses[counter]); - counter = counter + 1; - } - } - - fn burn_coins(burn_amount: u64, a: u32) { - burn(burn_amount); - } - - fn force_transfer_coins(coins: u64, asset_id: ContractId, target: ContractId) { - force_transfer_to_contract(coins, asset_id, target); - } - - fn transfer_coins_to_output(coins: u64, asset_id: ContractId, recipient: Address) { - transfer_to_address(coins, asset_id, recipient); - } - - fn get_balance(target: ContractId, asset_id: ContractId) -> u64 { - balance_of(target, asset_id) - } - - fn get_msg_amount() -> u64 { - msg_amount() - } -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/token_contract/src/main.sw#L1-L40) - ---- - - - -```rust -contract; - -use std::{ - call_frames::{ - contract_id, - msg_asset_id, - }, - context::msg_amount, - token::{ - mint_to_address, - transfer_to_address, - }, -}; - -abi LiquidityPool { - #[storage(write)] - fn set_base_token(base_token_id: b256) -> (); - - #[storage(read), payable] - fn deposit(recipient: Address); - - #[storage(read), payable] - fn withdraw(recipient: Address); -} - -storage { - base_token: b256 = 0x0000000000000000000000000000000000000000000000000000000000000000, -} - -impl LiquidityPool for Contract { - #[storage(write)] - fn set_base_token(base_token_id: b256) { - storage.base_token = base_token_id; - } - - #[storage(read), payable] - fn deposit(recipient: Address) { - assert(ContractId::from(storage.base_token) == msg_asset_id()); - assert(0 < msg_amount()); - - // Mint two times the amount. - let amount_to_mint = msg_amount() * 2; - - // Mint some LP token based upon the amount of the base token. - mint_to_address(amount_to_mint, recipient); - } - - #[storage(read), payable] - fn withdraw(recipient: Address) { - assert(contract_id() == msg_asset_id()); - assert(0 < msg_amount()); - - // Amount to withdraw. - let amount_to_transfer = msg_amount() / 2; - - // Transfer base token to recipient. - transfer_to_address(amount_to_transfer, ContractId::from(storage.base_token), recipient); - } -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/liquidity-pool/src/main.sw#L1-L61) - ---- - - -The first contract is a contract that represents a simple token. - -The second contract, as its name suggests, represents a simplified example of a liquidity pool contract. The method deposit() expects you to supply an arbitrary amount of the `base_token`. As a result, it mints double the amount of the liquidity asset to the calling address. Analogously, if you call `withdraw()` supplying it with the liquidity asset, it will transfer half that amount of the `base_token` back to the calling address except for deducting it from the contract balance instead of minting it. - -The first step towards interacting with any contract in the TypeScript SDK is using the `typegen` CLI utility to generate type-safe bindings for the contract methods: - -```sh -$ npx fuels typegen -i ./contract/out/debug/*-abi.json -o ./contract-types -``` - -Next, let's setup a [`Wallet`](../wallets/index.md) and seed it with some coins. We will need these coins to deploy the contracts and to interact with them. - - -```typescript - const provider = new Provider('http://127.0.0.1:4000/graphql'); - const PRIVATE_KEY = '0x862512a2363db2b3a375c0d4bbbd27172180d89f23f2e259bac850ab02619301'; - const wallet = Wallet.fromPrivateKey(PRIVATE_KEY, provider); - await seedTestWallet(wallet, [{ assetId: NativeAssetId, amount: bn(100_000) }]); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L465-L470) - ---- - - -Let's now deploy both the contracts and set them up. - - -```typescript - const tokenContractBytecode = readFileSync( - join(__dirname, '../test-projects/token_contract/out/debug/token_contract.bin') - ); - const tokenContractFactory = new ContractFactory(tokenContractBytecode, tokenContractABI, wallet); - const tokenContract = await tokenContractFactory.deployContract(); - const tokenContractID = tokenContract.id; - - const liquidityPoolContractBytecode = readFileSync( - join(__dirname, '../test-projects/liquidity-pool/out/debug/liquidity-pool.bin') - ); - const liquidityPoolContractFactory = new ContractFactory( - liquidityPoolContractBytecode, - liquidityPoolABI, - wallet - ); - const liquidityPoolContract = await liquidityPoolContractFactory.deployContract(); - const liquidityPoolContractID = liquidityPoolContract.id; - await liquidityPoolContract.functions.set_base_token(tokenContractID).call(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L472-L491) - ---- - - -Next, let's mint some tokens and transfer them to our wallet. - - -```typescript - await tokenContract.functions.mint_coins(500, 1).call(); - await tokenContract.functions - .transfer_coins_to_output( - 200, - { - value: tokenContract.id, - }, - { - value: wallet.address.toB256(), - } - ) - .txParams({ - variableOutputs: 1, - }) - .call(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L494-L510) - ---- - - -Now, let's deposit some tokens into the liquidity pool contract. Since we have to transfer assets to the contract, we create the appropriate [`callParams`](../contracts/call-parameters.md) and chain them to the method call. - - -```typescript - await liquidityPoolContract.functions - .deposit({ - value: wallet.address.toB256(), - }) - .callParams({ - forward: { - amount: bn(100), - assetId: tokenContractID.toB256(), - }, - }) - .call(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L513-L525) - ---- - - -As a final demonstration, let's use all our liquidity asset balance to withdraw from the pool and confirm we retrieved the initial amount. For this, we get our liquidity asset balance and supply it to the `withdraw()` function via `callParams`. - - -```typescript - const lpTokenBalance = await wallet.getBalance(liquidityPoolContractID.toB256()); - await liquidityPoolContract.functions - .withdraw({ - value: wallet.address.toB256(), - }) - .callParams({ - forward: { - amount: lpTokenBalance, - assetId: liquidityPoolContractID.toB256(), - }, - }) - .call(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L532-L545) - ---- - diff --git a/docs/guide/cookbook/index.md b/docs/guide/cookbook/index.md deleted file mode 100644 index 2da5f3c3f9e..00000000000 --- a/docs/guide/cookbook/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Cookbook" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 5 ---- - -[info]: this file is autogenerated - - -# Cookbook - -This section covers more advanced use cases that can be satisfied by combining various features of the SDK. As such, it assumes that you have already made yourself familiar with the previous chapters of this book. diff --git a/docs/guide/cookbook/transfer-all-assets.md b/docs/guide/cookbook/transfer-all-assets.md deleted file mode 100644 index a03a0058734..00000000000 --- a/docs/guide/cookbook/transfer-all-assets.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "Transfer All Assets" -parent: "Cookbook" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -Coming soon! diff --git a/docs/guide/glossary.md b/docs/guide/glossary.md deleted file mode 100644 index 6e5d46c7b45..00000000000 --- a/docs/guide/glossary.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Glossary" -has_children: false -has_toc: false -nav_order: -3 ---- - -[info]: this file is autogenerated -# Glossary - -These are the common terms you will find across this documentation and while using the SDK. - -## Contract - -A contract, in the SDK, is an abstraction that represents a connection to a specific smart contract deployed on the Fuel Network. This contract instance can be used as a regular JS object, with methods attached to it that reflect those in its smart contract equivalent. - -## Provider - -A Provider is a Class that provides an abstraction for a connection to a Fuel node. It provides read-only access to the node. You can use this provider as-is or through the wallet. - -## Wallet and signer - -A `Wallet` is a Class with direct or indirect access to a private key. You can use a `Wallet` to sign messages and transactions to authorize the network to charge your account to perform operations. The terms wallet and signer in the SDK are often used interchangeably, but, technically, a `Signer` enables the signing of transactions and messages; the `Wallet` implements the `Signer` functionality. diff --git a/docs/guide/index.md b/docs/guide/index.md deleted file mode 100644 index f6ebe34e2d9..00000000000 --- a/docs/guide/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Guide" -has_children: true -has_toc: true -nav_order: -4 ---- - -[info]: this file is autogenerated -# The Fuel TypeScript SDK Guide - -TypeScript SDK for Fuel. It can be used for a variety of things, including but not limited to: - -- Compiling, deploying, and testing [Sway](https://github.com/FuelLabs/sway) contracts; -- Use the [Testnet](./providers/connecting-to-an-external-node.md) or run a local Fuel node; -- Crafting and signing transactions with hand-crafted scripts or contract calls; -- Generating type-safe TypeScript bindings of contract ABI methods; -- And more. `fuels-ts` is still in active development. - -This book is an overview of the different things one can achieve using the TypeScript SDK, and how to implement them. Keep in mind that both the SDK and the documentation are works-in-progress! - -#### Version Notice: Docs generated using Fuels `v{{site.data.versions.fuels}}`, Fuel Core `v{{site.data.versions.fuel-core}}`, Sway `v{{site.data.versions.sway}}`, and Forc `v{{site.data.versions.forc}}`. - -[The Fuel TypeScript SDK](../index.md) - -See also the main [The Fuel TypeScript SDK](../index.md) and [Contributing](../../CONTRIBUTING.md) pages for additional resources. diff --git a/docs/guide/local-docs.md b/docs/guide/local-docs.md deleted file mode 100644 index eea610d2ef9..00000000000 --- a/docs/guide/local-docs.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "Local Docs" -has_children: false -has_toc: false -nav_order: -3 ---- - -[info]: this file is autogenerated -There are two parts to the fuels-ts repository documentation - -## Part One: Typedoc -[typedoc](https://typedoc.org/) gathers all types, functions, classes, etc., from our source code. It will read through the `packages` folder, collect all that information, and convert it into a markdown file, modifying the contents of [`docs/packages`](https://github.com/FuelLabs/fuels-ts/tree/master/docs/packages). - - -Furthermore, I've enhanced typedoc to also build out the [Guide documentation](https://fuellabs.github.io/fuels-ts/guide/) with a custom plugin called `typedoc-plugin-guide-builder` that's in our [repo here](https://github.com/FuelLabs/fuels-ts/tree/master/scripts/typedoc-plugin-guide-builder) (We should move this to a standalone plugin later on). This portion of the typedoc process takes source files from [`docs/_guide`](https://github.com/FuelLabs/fuels-ts/tree/master/docs/_guide), runs them through the plugins and renders code snippets pulled from source code. - -#### How does the `typedoc-plugin-guide-builder` plugin work? -See how this markdown document refers to [Sway](https://github.com/FuelLabs/fuels-ts/blob/master/docs/_guide/testing/testing-with-jest.md?plain=1#L6) and [TypeScript](https://github.com/FuelLabs/fuels-ts/blob/master/docs/_guide/testing/testing-with-jest.md?plain=1#L9) code (also note the language hints like `[@code:rust]`, and then see how [reference in the TypeScript code](https://github.com/FuelLabs/fuels-ts/blob/master/packages/example-contract/src/example-contract.test.ts#L1) is written - -It writes the final results to [`docs/guide`](https://github.com/FuelLabs/fuels-ts/tree/master/docs/guide). - -### Intermission: Repo -Once typedoc is done generating the markdown docs, the data inside `docs/packages` and `docs/guide` are highly useful. These are complete docs that are checked into the repo and can be found alongside the code for TS-SDK consumers. **One could view and use them just fine inside GitHub file browser or locally within their own filesystem.** - -## Part Two: Jekyll -[jekyll](https://jekyllrb.com/) does the work of rendering the docs in markdown into something the browser understands: HTML. There are currently some [open issues to possibly switch off Jekyll](https://github.com/FuelLabs/fuels-ts/issues/457). We shall see, but [GitHub pages uses Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll) so its the easy choice for now. - -Anyways, Jekyll is configured with the [just the docs](https://github.com/just-the-docs/just-the-docs) theme (actually a modified version of it [found here within Fuels org](https://github.com/FuelLabs/typedoc-just-the-docs-theme)). The only interesting thing to point out here is also that we [update this file _data/versions.yml](https://github.com/FuelLabs/fuels-ts/blob/master/docs/_data/versions.yml) on each successful build to master, so that the versions rendered in the docs are accurate relative to the repo's versions. - -## Finale: CI -Our build tools in CI automatically update the docs inside the repo after a successful new build hits the `master` branch. This is accomplished by the [GitHub action](https://github.com/FuelLabs/fuels-ts/blob/master/.github/workflows/release.yaml#L48) that calls `pnpm changeset:version-with-docs` which runs [this script to rebuild docs and commit](https://github.com/FuelLabs/fuels-ts/blob/master/scripts/changeset-version-with-docs.ts) them into the repo (see[ sample commit here](https://github.com/FuelLabs/fuels-ts/pull/669/commits/8fc3bb1eea57e73139965cf32f36b24537df4906)) as part of the [final update PR](https://github.com/FuelLabs/fuels-ts/pull/669). - -## TLDR: Local docs development -#### 1. The one-time local setup for the custom plugin `typedoc-plugin-guide-builder` is to compile the Typescript, do -```bash -# start in root of project -cd ./scripts/typedoc-plugin-guide-builder -tsc -``` - -#### 2. Next, you'll want to rebuild the generated typedoc files (see Part One above to understand why) -```bash -# start in root of project -pnpm typedoc - -# if you plan to make a lot of updates, use `watch` -pnpm typedoc --watch -``` - -#### 3. Finally, if you want to see how the docs will appear fully rendered as they do [on the docs website](https://fuellabs.github.io/fuels-ts/), you will need to run Jekyll (see Part Two above to understand why). [Setup Jekyll here](https://jekyllrb.com/docs/) if you haven't already. -```bash -# start in root of project -cd docs - -# this will automatically `watch`, note that the initial build and "updates" can take several seconds/minutes -bundle exec jekyll serve -``` \ No newline at end of file diff --git a/docs/guide/messages/getting-a-message-proof.md b/docs/guide/messages/getting-a-message-proof.md deleted file mode 100644 index adb124c4377..00000000000 --- a/docs/guide/messages/getting-a-message-proof.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Getting A Message Proof" -parent: "Messages" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Getting a Message Proof - -A message proof is a cryptographic proof that a message was included in a block. You can use the `getMessageProof` method to retrieve a message proof for a given transaction ID and message ID. - - -```typescript - const result = await tx.wait(); - const messageOutReceipt = result.receipts[0]; - const messageProof = await provider.getMessageProof( - TRANSACTION_ID, - messageOutReceipt.messageID - ); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/transfer.test.ts#L169-L176) - ---- - diff --git a/docs/guide/messages/getting-all-resources.md b/docs/guide/messages/getting-all-resources.md deleted file mode 100644 index 608c85d782b..00000000000 --- a/docs/guide/messages/getting-all-resources.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Getting All Resources" -parent: "Messages" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Getting All Resources - -You can use the `getResourcesToSpend` method to retrieve a list of all the resources (coins + assets) that can be spent by a given address. - - -```typescript - const account = new Account( - '0x09c0b2d1a486c439a87bcba6b46a7a1a23f3897cc83a94521a96da5c23bc58db' - ); - const resourcesToSpend = await account.getResourcesToSpend([ - { - amount: bn(2), - assetId: '0x0101010101010101010101010101010101010101010101010101010101010101', - }, - ]); - expect(resourcesToSpend[0].amount.gt(2)).toBeTruthy(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.test.ts#L91-L102) - ---- - diff --git a/docs/guide/messages/getting-messages.md b/docs/guide/messages/getting-messages.md deleted file mode 100644 index 28e40de57d0..00000000000 --- a/docs/guide/messages/getting-messages.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "Getting Messages" -parent: "Messages" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Getting Messages - -You can use the `getMessages` method to retrieve a list of messages from the blockchain. - - -```typescript - const WALLET_A = Wallet.fromPrivateKey( - '0x1ff16505df75735a5bcf4cb4cf839903120c181dd9be6781b82cda23543bd242', - provider - ); - const WALLET_B = Wallet.fromPrivateKey( - '0x30bb0bc68f5d2ec3b523cee5a65503031b40679d9c72280cd8088c2cfbc34e38', - provider - ); - - const EXPECTED_MESSAGES_A: Message[] = [ - { - sender: WALLET_B.address, - recipient: WALLET_A.address, - nonce: bn(1), - amount: bn(1), - data: arrayify( - '0x00000000000000080000000000000007000000000000000600000000000000050000000000000004' - ), - daHeight: bn(0), - status: MessageStatus.Unspent, - }, - ]; - const EXPECTED_MESSAGES_B: Message[] = [ - { - sender: WALLET_A.address, - recipient: WALLET_B.address, - nonce: bn('1017517292834129547'), - amount: bn('12704439083013451934'), - data: arrayify('0x0000000000000007'), - daHeight: bn('3684546456337077810'), - status: MessageStatus.Unspent, - }, - ]; - - const aMessages = await WALLET_A.getMessages(); - const bMessages = await WALLET_B.getMessages(); - - expect(aMessages).toStrictEqual(EXPECTED_MESSAGES_A); - expect(bMessages).toStrictEqual(EXPECTED_MESSAGES_B); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L367-L407) - ---- - diff --git a/docs/guide/messages/index.md b/docs/guide/messages/index.md deleted file mode 100644 index 981d6afe824..00000000000 --- a/docs/guide/messages/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "Messages" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 9 ---- - -[info]: this file is autogenerated - - -# Messages - -A message is an object that contains some data that when broadcasted to the network, can change the state of the blockchain. This can include sending tokens, creating a new account, or deploying a smart contract. Messages are signed by a sender and broadcasted to the network. This message is then verified and included in a block. - -This is the general structure of a `Message` object: - - -```typescript -/** - * A Fuel message - */ -export type Message = { - sender: AbstractAddress; - recipient: AbstractAddress; - nonce: BN; - amount: BN; - data: BytesLike; - status: MessageStatus; - daHeight: BN; -}; -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/message.ts#L7-L20) - ---- - diff --git a/docs/guide/predicates/index.md b/docs/guide/predicates/index.md deleted file mode 100644 index 92c689ce8cd..00000000000 --- a/docs/guide/predicates/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "Predicates" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 6 ---- - -[info]: this file is autogenerated - - -# Predicates - -Predicates, in Sway, are programs that return a Boolean value, and they do not have any side effects (they are pure). - -## Instantiating predicates - -Similar to contracts, once you've written a predicate in Sway and compiled it with `forc build` (read [here](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/index.html) for more on how to work with Sway), you'll get the predicate binary. Using the binary, you can instantiate a `predicate` as shown in the code snippet below: - - -```typescript - import { Predicate, arrayify } from 'fuels'; - const predicate = new Predicate(testPredicateTrue); - - expect(predicate.address).toBeTruthy(); - expect(predicate.bytes).toEqual(arrayify(testPredicateTrue)); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L339-L345) - ---- - - -The created `predicate` instance has two fields. The predicate `bytes (byte code)` and the predicate `address`. This address is generated from the byte code and is the same as the `P2SH` address used in Bitcoin. Users can seamlessly send assets to the predicate address as they do for any other address on the chain. To spend the predicate funds, the user has to provide the original `byte code` of the predicate together with the `predicate data`. The `predicate data` will be used when executing the `byte code`, and if the predicate is validated successfully, the funds will be accessible. - -In the next section, we show how to interact with a predicate and explore an example where specific signatures are needed to spend the predicate funds. - -## Calling a predicate with a `main` function that takes arguments - -Suppose your Sway predicate `main` function is written using the arguments passed to the `main` function like so: - - -```rust -predicate; - -struct Validation { - has_account: bool, - total_complete: u64, -} - -fn main(received: Validation) -> bool { - let expected_has_account: bool = true; - let expected_total_complete: u64 = 100; - - received.has_account == expected_has_account && received.total_complete == expected_total_complete -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw#L1-L15) - ---- - - -You can still create a `Predicate` in the same way as above, but you can pass in a `JsonAbi` using the JSON generated from `forc`. diff --git a/docs/guide/predicates/send-and-spend-funds-from-predicates.md b/docs/guide/predicates/send-and-spend-funds-from-predicates.md deleted file mode 100644 index b8067a61708..00000000000 --- a/docs/guide/predicates/send-and-spend-funds-from-predicates.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -title: "Send And Spend Funds From Predicates" -parent: "Predicates" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Send and spend funds from predicates - -Let's consider the following predicate example: - - -```rust -predicate; - -use std::{b512::B512, ecr::ec_recover_address, inputs::input_predicate_data}; - -fn extract_pulic_key_and_match(signature: B512, expected_public_key: b256) -> u64 { - let message_hash = 0x6aed34e6bddff5e1d872b5d7d5698a7b73abd6f3b33402732edc73ab9ffb9c70; - if let Result::Ok(pub_key_sig) = ec_recover_address(signature, message_hash) - { - if pub_key_sig.value == expected_public_key { - return 1; - } - } - 0 -} - -fn main() -> bool { - let signatures: [B512; 3] = input_predicate_data(0); - - let public_keys = [ - 0xe10f526b192593793b7a1559a391445faba82a1d669e3eb2dcd17f9c121b24b1, - 0x54944e5b8189827e470e5a8bacfc6c3667397dc4e1eef7ef3519d16d6d6c6610, - 0x577e424ee53a16e6a85291feabc8443862495f74ac39a706d2dd0b9fc16955eb, - ]; - - let mut matched_keys = 0; - - matched_keys = extract_pulic_key_and_match(signatures[0], public_keys[0]); - matched_keys = matched_keys + extract_pulic_key_and_match(signatures[1], public_keys[1]); - matched_keys = matched_keys + extract_pulic_key_and_match(signatures[2], public_keys[2]); - - matched_keys > 1 -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/predicate-triple-sig/src/main.sw#L1-L34) - ---- - - -This predicate accepts three signatures and matches them to three predefined public keys. The `ec_recover_address` function is used to recover the public key from the signatures. If two of three extracted public keys match the predefined public keys, the funds can be spent. Note that the signature order has to match the order of the predefined public keys. - -Let's use the SDK to interact with the predicate. First, let's create three wallets with specific keys. Their hashed public keys are already hard-coded in the predicate. - - -```typescript - import { Provider, Wallet } from 'fuels'; - import { seedTestWallet } from '@fuel-ts/wallet/test-utils'; - const provider = new Provider('http://127.0.0.1:4000/graphql'); - // Setup a private key - const PRIVATE_KEY_1 = '0x862512a2363db2b3a375c0d4bbbd27172180d89f23f2e259bac850ab02619301'; - const PRIVATE_KEY_2 = '0x37fa81c84ccd547c30c176b118d5cb892bdb113e8e80141f266519422ef9eefd'; - const PRIVATE_KEY_3 = '0x976e5c3fa620092c718d852ca703b6da9e3075b9f2ecb8ed42d9f746bf26aafb'; - - // Create the wallets, passing provider - const wallet1: WalletUnlocked = Wallet.fromPrivateKey(PRIVATE_KEY_1, provider); - const wallet2: WalletUnlocked = Wallet.fromPrivateKey(PRIVATE_KEY_2, provider); - const wallet3: WalletUnlocked = Wallet.fromPrivateKey(PRIVATE_KEY_3, provider); - const receiver = Wallet.generate({ provider }); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L349-L363) - ---- - - -Next, let's add some coins to the wallets. - - -```typescript - import { Provider, Wallet } from 'fuels'; - import { seedTestWallet } from '@fuel-ts/wallet/test-utils'; - await seedTestWallet(wallet1, [{ assetId: NativeAssetId, amount: bn(1_000_000) }]); - await seedTestWallet(wallet2, [{ assetId: NativeAssetId, amount: bn(2_000_000) }]); - await seedTestWallet(wallet3, [{ assetId: NativeAssetId, amount: bn(300_000) }]); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L365-L371) - ---- - - -Now we can load the predicate binary, and prepare some transaction variables. - - -```typescript - import { Predicate, NativeAssetId } from 'fuels'; - const AbiInputs = { - types: [ - { - typeId: 0, - type: 'bool', - }, - { - typeId: 1, - type: 'b512', - }, - { - typeId: 2, - type: '[_; 3]', - components: [ - { - name: '__array_element', - type: 1, - }, - ], - }, - ], - functions: [ - { - inputs: [ - { - name: 'data', - type: 2, - }, - ], - name: 'main', - output: { - name: '', - type: 0, - }, - }, - ], - loggedTypes: [], - }; - const predicate = new Predicate(predicateTriple, AbiInputs); - const amountToPredicate = 100_000; - const amountToReceiver = 100; - const initialPredicateBalance = await predicate.getBalance(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L373-L417) - ---- - - -After the predicate address is generated we can send funds to it. Note that we are using the same `transfer` function as we used when sending funds to other wallets. We also make sure that the funds are indeed transferred. - - -```typescript - const response = await wallet1.transfer(predicate.address, amountToPredicate); - await response.waitForResult(); - const predicateBalance = await predicate.getBalance(); - - // assert that predicate address now has the expected amount to predicate - expect(bn(predicateBalance)).toEqual(initialPredicateBalance.add(amountToPredicate)); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L419-L426) - ---- - - -Alternatively, you can use `Wallet.submitPredicate` to setup a `Predicate` and use funds from the `Wallet` you submitted from. - - -```typescript - const depositOnPredicate = await wallet1.transfer(predicate.address, 200); - // Wait for Transaction to succeed - await depositOnPredicate.waitForResult(); - const updatedPredicateBalance = await predicate.getBalance(); - - // assert that predicate address now has the updated expected amount to predicate - expect(bn(updatedPredicateBalance)).toEqual( - initialPredicateBalance.add(amountToPredicate).add(200) - ); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L428-L438) - ---- - - -To spend the funds that are now locked in this example's Predicate, we have to provide two out of three signatures whose public keys match the ones we defined in the predicate. In this example, the signatures are generated using a zeroed B256 value. - - -```typescript - const dataToSign = '0x0000000000000000000000000000000000000000000000000000000000000000'; - const signature1 = await wallet1.signMessage(dataToSign); - const signature2 = await wallet2.signMessage(dataToSign); - const signature3 = await wallet3.signMessage(dataToSign); - - const signatures = [signature1, signature2, signature3]; -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L440-L447) - ---- - - -After generating the signatures, we can send a transaction to spend the predicate funds. We use the `receiver` wallet as the recipient. We have to provide the predicate byte code and the required signatures. As we provide the correct data, we receive the funds and verify that the amount is correct. - - -```typescript - const tx = await predicate.setData(signatures).transfer(receiver.address, amountToReceiver); - await tx.waitForResult(); - - // check balances - const finalPredicateBalance = await predicate.getBalance(); - const receiverBalance = await receiver.getBalance(); - - // assert that predicate address now has a zero balance - expect(bn(initialPredicateBalance).lte(finalPredicateBalance)).toBeTruthy(); - // assert that predicate funds now belong to the receiver - expect(bn(receiverBalance).gte(bn(amountToReceiver))).toBeTruthy(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L449-L461) - ---- - diff --git a/docs/guide/providers/connecting-to-an-external-node.md b/docs/guide/providers/connecting-to-an-external-node.md deleted file mode 100644 index cbd7dfe680b..00000000000 --- a/docs/guide/providers/connecting-to-an-external-node.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "Connecting To An External Node" -parent: "Providers" -grand_parent: "Guide" -nav_order: 2 ---- - -[info]: this file is autogenerated - - -# Connecting to the Testnet or an external node - -We can interact with the `Testnet` node by using the following example. - - -```typescript - import { Provider, WalletUnlocked } from 'fuels'; - const provider = new Provider('node-beta-2.fuel.network'); - // Setup a private key - const PRIVATE_KEY = 'a1447cd75accc6b71a976fd3401a1f6ce318d27ba660b0315ee6ac347bf39568'; - - // Create the wallet, passing provider - const wallet: WalletUnlocked = Wallet.fromPrivateKey(PRIVATE_KEY, provider); - - const signer = new Signer(PRIVATE_KEY); - // validate address - expect(wallet.address).toEqual(signer.address); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L250-L264) - ---- - - -In the code example, we connected a new provider to the Testnet node and created a new wallet from a private key. - -> **Note:** New wallets on the Testnet will not have any assets! They can be obtained by providing the wallet address to the faucet at -> -> [faucet-beta-1.fuel.network](https://faucet-beta-1.fuel.network) -> -> Once the assets have been transferred to the wallet, you can reuse it in other tests by providing the private key! -> -> In addition to the faucet, there is a block explorer for the Tesnet at -> -> [block-explorer](https://fuellabs.github.io/block-explorer-v2) - -If you want to connect to another node just change the url or IP and port. For example, to connect to a local node that was created with `fuel-core` you can use: - - -```typescript - import { Provider, WalletUnlocked } from 'fuels'; - const localProvider = new Provider('http://127.0.0.1:4000/graphql'); - // Setup a private key - const PRIVATE_KEY = 'a1447cd75accc6b71a976fd3401a1f6ce318d27ba660b0315ee6ac347bf39568'; - - // Create the wallet, passing provider - const wallet: WalletUnlocked = Wallet.fromPrivateKey(PRIVATE_KEY, localProvider); - - const signer = new Signer(PRIVATE_KEY); - // validate address - expect(wallet.address).toEqual(signer.address); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L268-L280) - ---- - diff --git a/docs/guide/providers/connection.md b/docs/guide/providers/connection.md deleted file mode 100644 index ac379f88e7e..00000000000 --- a/docs/guide/providers/connection.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Connection" -parent: "Providers" -grand_parent: "Guide" -nav_order: 1 ---- - -[info]: this file is autogenerated - - -# Connecting to a Fuel node - -At a high level, you can use the Fuel TypeScript SDK to build applications that can run computations on the Fuel Virtual Machine through interactions with smart contracts written in Sway. - -For this interaction to work, the SDK must be able to communicate with a `fuel-core` node; you have two options at your disposal: - -1. Use the [Testnet](../providers/connecting-to-an-external-node.md) or run a Fuel node (using `fuel-core`) and instantiate a provider that points to that node's IP and port. -2. Use Docker - `pnpm services:run` -3. Use [fuelup](https://github.com/FuelLabs/fuelup) - -The second/third options are ideal for smart contract testing, as you can quickly spin up and tear down nodes between specific test cases. - -For application building, you should use the first option. diff --git a/docs/guide/providers/index.md b/docs/guide/providers/index.md deleted file mode 100644 index f97e7fe4e03..00000000000 --- a/docs/guide/providers/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Providers" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 3 ---- - -[info]: this file is autogenerated - - -# Providers - -This section gives some pointers for using the Fuel SDK for smart contract development. diff --git a/docs/guide/providers/querying-the-chain.md b/docs/guide/providers/querying-the-chain.md deleted file mode 100644 index 332e9ca5221..00000000000 --- a/docs/guide/providers/querying-the-chain.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "Querying The Chain" -parent: "Providers" -grand_parent: "Guide" -nav_order: 3 ---- - -[info]: this file is autogenerated - - -# Interacting with the blockchain - -Once you have set up a provider, you're ready to interact with the Fuel blockchain. Here are a few examples of what you can do with a provider; for a more in-depth overview of the API, check the [official provider API documentation](https://docs.rs/fuels/latest/fuels/signers/provider/struct.Provider.html). - -- [Interacting with the blockchain](#interacting-with-the-blockchain) - - [Set up](#set-up) - - [Get all coins from an address](#get-all-coins-from-an-address) - - [Get spendable resources from an address](#get-spendable-resources-from-an-address) - - [Get balances from an address](#get-balances-from-an-address) - -## Set up - -You might need to set up a test blockchain first. You can skip this step if you're connecting to an external blockchain. - -See [connecting](./connecting.md) - -## Get all coins from an address - -This method returns all coins (of an optional given asset ID) from a wallet, including spent ones. - - -```typescript - import { Provider } from 'fuels'; - import { generateTestWallet } from '@fuel-ts/wallet/test-utils'; - const provider = new Provider('http://127.0.0.1:4000/graphql'); - const assetIdA = '0x0101010101010101010101010101010101010101010101010101010101010101'; - - const wallet = await generateTestWallet(provider, [ - [42, NativeAssetId], - [100, assetIdA], - ]); - - // get single coin - const coin = await wallet.getCoins(NativeAssetId); - - // get all coins - const coins = await wallet.getCoins(); - - expect(coin.length).toEqual(1); - expect(coin).toEqual([ - expect.objectContaining({ - assetId: NativeAssetId, - amount: bn(42), - }), - ]); - expect(coins).toEqual([ - expect.objectContaining({ - assetId: NativeAssetId, - amount: bn(42), - }), - expect.objectContaining({ - assetId: assetIdA, - amount: bn(100), - }), - ]); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L284-L318) - ---- - - -## Get spendable resources from an address - -The last argument says how much you want to spend. This method returns only spendable, i.e., unspent coins (of a given asset ID). If you ask for more spendable than the amount of unspent coins you have, it returns an error. - - -```typescript - const spendableResources = await wallet.getResourcesToSpend([ - { amount: 32, assetId: NativeAssetId, max: 42 }, - { amount: 50, assetId: assetIdA }, - ]); - expect(spendableResources[0].amount).toEqual(bn(42)); - expect(spendableResources[1].amount).toEqual(bn(100)); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L328-L335) - ---- - - -## Get balances from an address - -Get all the spendable balances of all assets for an address. This is different from getting the coins because we only return the numbers (the sum of UTXOs coins amount for each asset id) and not the UTXOs coins themselves. - - -```typescript - const walletBalances = await wallet.getBalances(); - expect(walletBalances).toEqual([ - { assetId: NativeAssetId, amount: bn(42) }, - { assetId: assetIdA, amount: bn(100) }, - ]); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L320-L326) - ---- - diff --git a/docs/guide/scripts/calling-a-script.md b/docs/guide/scripts/calling-a-script.md deleted file mode 100644 index 29a8a0e65c0..00000000000 --- a/docs/guide/scripts/calling-a-script.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Calling A Script" -parent: "Scripts" -grand_parent: "Guide" -nav_order: 2 ---- - -[info]: this file is autogenerated - - -# Calling a script - -Suppose your Sway script `main` function is written using the arguments passed to the `main` function like so: - - -```rust -script; - -use std::logging::log; - -fn main(foo: u8) -> u8 { - log("u8 foo"); - log(foo); - foo -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/script-main-args/src/main.sw#L1-L11) - ---- - - -You can still hand code out a solution wrapper using `callScript` utility to call your script with data. However, if you prefer to use the ABI generated from your script, you can use the `ScriptFactory` helper: - - -```typescript - const foo = 33; - const scriptInstance = new Script(scriptBin, scriptAbi, wallet); - - const { value, logs } = await scriptInstance.functions.main(foo).call(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/script-main-args.test.ts#L31-L36) - ---- - diff --git a/docs/guide/scripts/index.md b/docs/guide/scripts/index.md deleted file mode 100644 index 370d57eb225..00000000000 --- a/docs/guide/scripts/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Scripts" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 7 ---- - -[info]: this file is autogenerated - - -# Scripts - -A Script, in Sway, is runnable bytecode on the chain which executes once to perform some task. A script can return a single value of any type. - -Learn more about Scripts [here](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/sway-program-types/scripts.html#scripts-and-the-sdks). diff --git a/docs/guide/scripts/instantiating-a-script.md b/docs/guide/scripts/instantiating-a-script.md deleted file mode 100644 index 4c9de663834..00000000000 --- a/docs/guide/scripts/instantiating-a-script.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: "Instantiating A Script" -parent: "Scripts" -grand_parent: "Guide" -nav_order: 1 ---- - -[info]: this file is autogenerated - - -# Instantiating a script - -Similar to contracts and predicates, once you've written a script in Sway and compiled it with `forc build` (read [here](https://fuellabs.github.io/sway/v{{site.data.versions.sway}}/book/introduction/index.html) for more on how to work with Sway), you'll get the script binary. Using the binary, you can instantiate a `script` as shown in the code snippet below: - - -```typescript -import { Script, AbiCoder, arrayify } from 'fuels'; -const scriptBin = readFileSync(join(__dirname, './path/to/script-binary.bin')); -const scriptAbi = [ - { - type: 'function', - name: 'main', - inputs: [ - { - name: 'my_struct', - type: 'struct MyStruct', - components: [ - { - name: 'arg_one', - type: 'bool', - }, - { - name: 'arg_two', - type: 'u64', - }, - ], - }, - ], - outputs: [ - { - name: 'my_struct', - type: 'struct MyStruct', - components: [ - { - name: 'arg_one', - type: 'bool', - }, - { - name: 'arg_two', - type: 'u64', - }, - ], - }, - ], - }, -]; - -type MyStruct = { - arg_one: boolean; - arg_two: BigNumberish; -}; - -describe('Script', () => { - let script: ScriptRequest; - beforeAll(async () => { - const abiCoder = new AbiCoder(); - script = new ScriptRequest( - scriptBin, - (myStruct: MyStruct) => { - const encoded = abiCoder.encode(scriptAbi[0].inputs, [myStruct]); - return arrayify(encoded); - }, - (scriptResult) => { - if (scriptResult.returnReceipt.type === ReceiptType.Revert) { - throw new Error('Reverted'); - } - if (scriptResult.returnReceipt.type !== ReceiptType.ReturnData) { - throw new Error('fail'); - } - const decoded = abiCoder.decode(scriptAbi[0].outputs, scriptResult.returnReceipt.data); - return (decoded as any)[0]; - } - ); - }); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/script/src/script.test.ts#L61-L130) - ---- - - -In the [next section](./calling-a-script.md), we show how to call a script. diff --git a/docs/guide/testing/testing-with-jest.md b/docs/guide/testing/testing-with-jest.md deleted file mode 100644 index 2cda067d9b9..00000000000 --- a/docs/guide/testing/testing-with-jest.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "Testing With Jest" -parent: "Testing" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Testing with Jest - -As noted in [the testing intro](./index.md), you are free to test your Sway and TS-SDK code with any JS framework available. Below we have an example of how to load and test a contract using Jest, but the general principles and steps are the same for any testing harness. - -Here is a simple Sway program that takes an input and then returns it: - -```rust -contract; - -abi ExampleContract { - fn return_input(input: u64) -> u64; -} - -impl ExampleContract for Contract { - fn return_input(input: u64) -> u64 { - input - } -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/example-contract/src/main.sw#L1-L13) - ---- - - -Here is JavaScript code testing the above program using a conventional Jest setup: - -```typescript -import { generateTestWallet } from '@fuel-ts/wallet/test-utils'; -import fs from 'fs'; -import { ContractFactory, NativeAssetId, Provider, toHex } from 'fuels'; -import path from 'path'; - -import { ExampleContractAbi__factory } from './example-contract-types'; - -describe('ExampleContract', () => { - it('should return the input', async () => { - const provider = new Provider('http://127.0.0.1:4000/graphql'); - const wallet = await generateTestWallet(provider, [[1_000, NativeAssetId]]); - - // Deploy - const bytecode = fs.readFileSync(path.join(__dirname, '../out/debug/example-contract.bin')); - const factory = new ContractFactory(bytecode, ExampleContractAbi__factory.abi, wallet); - const contract = await factory.deployContract(); - - // Call - const { value } = await contract.functions.return_input(1337).call(); - - // Assert - expect(value.toHex()).toEqual(toHex(1337)); - - // You can also make a call using the factory - const contractInstance = ExampleContractAbi__factory.connect(contract.id, wallet); - const { value: v2 } = await contractInstance.functions.return_input(1337).call(); - expect(v2.toHex()).toBe(toHex(1337)); - }); -}); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/example-contract/src/example-contract.test.ts#L1-L31) - ---- - diff --git a/docs/guide/types/address.md b/docs/guide/types/address.md deleted file mode 100644 index fe807e51a2e..00000000000 --- a/docs/guide/types/address.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "Address" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Address - -`Address` is a wrapper on `Bytes32` and `Bech32` (see [Address documentation](../../packages/fuel-ts-address/)). The available interface of the TS-SDK Address contains many useful functions to switch between Address formats: - - -```typescript -export abstract class AbstractAddress { - abstract toJSON(): string; - abstract toString(): string; - abstract toAddress(): Bech32Address; - abstract toB256(): B256Address; - abstract toHexString(): string; - abstract toBytes(): Uint8Array; - abstract equals(other: AbstractAddress): boolean; -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L13-L23) - ---- - - -These are the main ways of creating an `Address` - -From a [Bech32](./bech32.md) Address: - - -```typescript - import { Address } from 'fuels'; - - const address = new Address(ADDRESS_BECH32); - - expect(address.toB256()).toEqual(ADDRESS_B256); - expect(address.toBytes()).toEqual(ADDRESS_BYTES); - // Hex string values are equivalent to B256 - expect(address.toHexString()).toEqual(ADDRESS_B256); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L42-L51) - ---- - - -From a Public Key: - - -```typescript - const address = Address.fromPublicKey(PUBLIC_KEY); - - expect(address.toAddress()).toEqual(ADDRESS_BECH32); - expect(address.toB256()).toEqual(ADDRESS_B256); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L55-L60) - ---- - - -From a [256 Bit Address](./bits256.md) Address: - - -```typescript - import { Address } from 'fuels'; - const address = Address.fromB256(ADDRESS_B256); - - expect(address.toAddress()).toEqual(ADDRESS_BECH32); - expect(address.toB256()).toEqual(ADDRESS_B256); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L64-L70) - ---- - - -You can also use a number of utilities as part of the Address Class: - - -```typescript - // you can make a random address - useful for testing - const address = Address.fromRandom(); - - // you can it has a new Address from an ambiguous source that may be a Bech32 or B256 address - const addressCloneFromBech = Address.fromString(address.toString()); - const addressCloneFromB256 = Address.fromString(address.toB256()); - - // if you aren't sure where the address comes from, use fromDynamicInput - const dataFromInput: string = - '0xf1e92c42b90934aa6372e30bc568a326f6e66a1a0288595e6e3fbd392a4f3e6e'; - // if the input string can't be resolved this will throw an error - const someAddress = Address.fromDynamicInput(dataFromInput); - - // you can verify equality using the helper functions - expect(address.equals(addressCloneFromBech)).toBeTruthy(); - expect(addressCloneFromBech.toString()).toEqual(addressCloneFromB256.toString()); - expect(someAddress).toBeTruthy(); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L74-L92) - ---- - diff --git a/docs/guide/types/arrays.md b/docs/guide/types/arrays.md deleted file mode 100644 index a1dfc56fc06..00000000000 --- a/docs/guide/types/arrays.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Arrays" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Arrays - -## Passing in arrays - -You can pass a JavaScript `Array` into your contract method transparently, allowing passthrough of expected data via the type regardless of Array type. An Array in Sway is fixed in size, so maximum storage size is determined at time of program compile, not during runtime. - -An Array is just a Typed Array: - -```typescript -// aka [u8; 2] -let basicNumberArray = [1, 23]; -// aka [bool; 4] -let basicBooleanArray = [true, false, true, false]; -``` - -## Vectors - -If your Array size is unknown until runtime, you can also use [Vectors](./vectors.md) diff --git a/docs/guide/types/asset-id.md b/docs/guide/types/asset-id.md deleted file mode 100644 index 91c4f03d989..00000000000 --- a/docs/guide/types/asset-id.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Asset Id" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# AssetId - -`AssetId` is a similar type as `Bytes32`, read up on [Bytes32](./bytes32.md) and [converting between types](./conversion.md) for more information. diff --git a/docs/guide/types/bech32.md b/docs/guide/types/bech32.md deleted file mode 100644 index bf020eaf47f..00000000000 --- a/docs/guide/types/bech32.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Bech32" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Bech32 - -The `Bech32Address` enables the use of addresses and contract ids in the bech32 format (using bech32m). They can easily be converted to their counterparts using [Address](./address.md). - -Here are the main ways of creating a `Bech32Address` - -```typescript - import { Address } from 'fuels'; - - const address = new Address(ADDRESS_BECH32); - - expect(address.toB256()).toEqual(ADDRESS_B256); - expect(address.toBytes()).toEqual(ADDRESS_BYTES); - // Hex string values are equivalent to B256 - expect(address.toHexString()).toEqual(ADDRESS_B256); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L42-L51) - ---- - - -> **Note:** when using a `Bech32Address` with an `Address` the HRP (Human-Readable Part) is set to **"fuel"** per default: - - -```typescript -export type Bech32Address = `fuel${string}`; -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L3-L5) - ---- - diff --git a/docs/guide/types/bits256.md b/docs/guide/types/bits256.md deleted file mode 100644 index cee5545c79d..00000000000 --- a/docs/guide/types/bits256.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Bits256" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Bits256 - -In Fuel, a type called `b256` represents hashes and holds a 256-bit value. The TypeScript SDK represents `b256` as `string` value for portability and can convert to `Uint8Array` as needed when the [raw bytes](./bytes32.md) are required. - -Here are some example tools in the SDK: - - -```typescript - import { arrayify, hexlify, randomBytes, getRandomB256 } from 'fuels'; - - // here are some useful ways to generate random b256 values - const randomB256Bytes: Bytes = randomBytes(32); - const randomB256: string = getRandomB256(); - - // a [u8; 32] (Uint8Array) b256 can be converted to hex string - const hexedB256: string = hexlify(randomB256Bytes); - - // a string b256 can be converted to Uint8Array - expect(arrayify(randomB256Bytes)).toEqual(arrayify(hexedB256)); - - // a string b256 can be safely passed into hexlify without mangling - expect(randomB256).toEqual(hexlify(randomB256)); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L112-L127) - ---- - - -A Bit256 value is also supported as part of the [Address](./address.md) libraries. - - -```typescript - import { Address } from 'fuels'; - const address = Address.fromB256(ADDRESS_B256); - - expect(address.toAddress()).toEqual(ADDRESS_BECH32); - expect(address.toB256()).toEqual(ADDRESS_B256); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L64-L70) - ---- - diff --git a/docs/guide/types/bytes32.md b/docs/guide/types/bytes32.md deleted file mode 100644 index 1f3174df71f..00000000000 --- a/docs/guide/types/bytes32.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Bytes32" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Bytes32 - -In Sway and the FuelVM, `Bytes32` represents hashes. They hold a 256-bit (32-byte) value. - -These are the main ways of creating a `Bytes32`: - - -```typescript - import { ZeroBytes32, randomBytes } from 'fuels'; - - const random32Bytes: Bytes = randomBytes(32); - const random32BytesString: string = hexlify(random32Bytes); - const zeroed32Bytes: string = ZeroBytes32; - - // a byte32 array can be safely passed into arrayify more than once without mangling - expect(arrayify(random32Bytes)).toEqual(arrayify(random32BytesString)); - - // a byte32 string can be safely passed into hexlify more than once without mangling - expect(zeroed32Bytes).toEqual(hexlify(zeroed32Bytes)); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L96-L108) - ---- - - -> **Note:** In Fuel, there's a special type called `b256`, which is similar to `Bytes32`; also used to represent hashes, and it holds a [256 Bit](./bits256.md) value. diff --git a/docs/guide/types/contract-id.md b/docs/guide/types/contract-id.md deleted file mode 100644 index c4a234dd1c1..00000000000 --- a/docs/guide/types/contract-id.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Contract Id" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# ContractId - -`ContractId` is a similar type as `Bytes32`, read up on [Bytes32](./bytes32.md) and [converting between types](./conversion.md) for more information. diff --git a/docs/guide/types/conversion.md b/docs/guide/types/conversion.md deleted file mode 100644 index 8adc3a887e6..00000000000 --- a/docs/guide/types/conversion.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "Conversion" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Converting native types - -You might want to convert between the native types (`Bytes32`, `Address`, `ContractId`, and `AssetId`). Because these types are wrappers on `Bytes` converting is a matter of using helpers. Here's an example: - - -```typescript - import { arrayify, hexlify, randomBytes, Address, addressify, Contract, Wallet, WalletLocked } from 'fuels'; - - const assetId: string = ZeroBytes32; - const randomB256Bytes: Bytes = randomBytes(32); - const hexedB256: string = hexlify(randomB256Bytes); - const address = Address.fromB256(hexedB256); - const arrayB256: Uint8Array = arrayify(randomB256Bytes); - const walletLike: WalletLocked = Wallet.fromAddress(address); - const provider = new Provider('http://localhost:4000/graphql'); - const contractLike: Contract = new Contract(address, abiJSON, provider); - - expect(address.equals(addressify(walletLike) as Address)).toBeTruthy(); - expect(address.equals(contractLike.id as Address)).toBeTruthy(); - expect(address.toBytes()).toEqual(arrayB256); - expect(address.toB256()).toEqual(hexedB256); - expect(arrayify(address.toB256())).toEqual(arrayB256); - - // it's bytes all the way down - expect(arrayify(assetId)).toEqual(arrayify(Address.fromB256(assetId).toB256())); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L131-L151) - ---- - diff --git a/docs/guide/types/enums-and-options.md b/docs/guide/types/enums-and-options.md deleted file mode 100644 index 5d5d8cb59ac..00000000000 --- a/docs/guide/types/enums-and-options.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: "Enums And Options" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Enums - -Here are some examples of `Enums` in Sway: - -```rust -pub enum SmallEnum { - Empty: (), -} - -pub enum BigEnum { - AddressA: b256, - AddressB: b256, - AddressC: b256, -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#L37-L47) - ---- - - -And the same structures represented in TypeScript, note that an `Enum` is essentially an `Object` in TypeScript. - -Here is `SmallEnum` - -```typescript - const INPUT = { Empty: [] }; -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L173-L175) - ---- - - -Here is `BigEnum` - -```typescript - const INPUT = { AddressB: B256 }; -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L181-L183) - ---- - - -## Options - -Sway supports the concept of the `Option` container, which allows for a variable to be either set with an expected value or to be exclusively marked as "no-value" (with an `undefined` in the case of TypeScript). - -The `Option` is a special wrapper type of `Enum`. - -This example shows that an input param with type `OptionalStringInput` can either be a `string` value or `undefined` - -```typescript -type OptionalStringInput = Option; - -let someInput: OptionalStringInput = "dogs"; -let noneInput: OptionalStringInput = undefined; -``` - -To help us understand how the TS-SDK handles Optional params, take this Sway method that expects three optional params which it attempts to add together. - -```rust - fn echo_option_three_u8(inputA: Option, inputB: Option, inputC: Option) -> u8 { - let value1 = match inputA { - Option::Some(value) => value, - Option::None => 0, - }; - let value2 = match inputB { - Option::Some(value) => value, - Option::None => 0, - }; - let value3 = match inputC { - Option::Some(value) => value, - Option::None => 0, - }; - - value1 + value2 + value3 - } -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#L258-L275) - ---- - - -Using this Contract, our Optional params can either be the values expected, like so: - -```typescript - const INPUT_A = 1; - const INPUT_B = 4; - const INPUT_C = 5; - - // adds the three values (if Some value given) together - const { value: Some } = await contractInstance.functions - .echo_option_three_u8(INPUT_A, INPUT_B, INPUT_C) - .call(); - - // we receive the result of adding whatever was passed - expect(Some).toStrictEqual(10); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L214-L226) - ---- - - -Or we can supply a partial list, where unsupplied values are converted to `Option` (or `undefined`): - -```typescript - const INPUT = 1; - - // adds the three values together, but only first param value is supplied - const { value: Some } = await contractInstance.functions.echo_option_three_u8(INPUT).call(); - - // we receive the result of adding whatever was passed - expect(Some).toStrictEqual(1); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L230-L238) - ---- - diff --git a/docs/guide/types/index.md b/docs/guide/types/index.md deleted file mode 100644 index a2756b2f9b4..00000000000 --- a/docs/guide/types/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Types" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 0 ---- - -[info]: this file is autogenerated - - -# Types - -The FuelVM and Sway have many internal types. These types have equivalents in the SDK. This section discusses these types, how to use them, and how to convert them. diff --git a/docs/guide/types/string.md b/docs/guide/types/string.md deleted file mode 100644 index 9cde03ab5da..00000000000 --- a/docs/guide/types/string.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "String" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# String - -Currently, all strings in Fuel and Sway are statically-sized, i.e., you must know the size of the string beforehand. - -Here's how you can create a simple string using `TypeScript`: - -```typescript -// aka str[2] -let stringSize2 = "st"; -// aka str[8] -let stringSize8 = "fuel-sdk"; -``` - -If your contract's method takes and returns, a `str[8]`, the SDK wrapper method will take and return a string of same length with validation. You can pass a string to it like this: - - -```typescript - const { value } = await contractInstance.functions.echo_str_8('fuel-sdk').call(); - - expect(value).toBe('fuel-sdk'); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L107-L111) - ---- - diff --git a/docs/guide/types/structs.md b/docs/guide/types/structs.md deleted file mode 100644 index 66a1b7a2649..00000000000 --- a/docs/guide/types/structs.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "Structs" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Structs - -A `struct` in Sway is equivalent to an `Object` in TypeScript, where the property names and types must match what is defined in Sway. - -Here is an example of the `struct` in Sway: - -```rust -pub struct ComplexStruct { - foo: u8, - bar: u64, - baz: str[9], -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#L29-L35) - ---- - - -And the same structure represented in TypeScript: - -```typescript -type ComplexStruct { - foo: u8, - bar: u64, - baz: str[9], -} - -let myStruct: ComplexStruct = { - foo: 1, - bar: 11337n, - baz: "123456789", -}; -``` diff --git a/docs/guide/types/vectors.md b/docs/guide/types/vectors.md deleted file mode 100644 index 78270d65f86..00000000000 --- a/docs/guide/types/vectors.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "Vectors" -parent: "Types" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Vectors - -## Passing in vectors - -You can pass a JavaScript `Array` into your contract method transparently, allowing passthrough of expected data via the type regardless of Array type. - -A basic Vector is just a Typed Array: - -```typescript -// aka Vec -let basicNumberVector = [1, 2, 3]; -``` - -Here is an example of a sample `struct` in Sway: - -```rust -pub struct ComplexStruct { - foo: u8, - bar: u64, - baz: str[9], -} -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#L29-L35) - ---- - - -And the contract method using this `struct` in a `Vector`: - -```rust - fn echo_struct_vector_last(vector: Vec) -> ComplexStruct { - vector.get(vector.len() - 1).unwrap() - } -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw#L318-L322) - ---- - - -The following code calls this Sway contract method which accepts a `Vec`. - -```typescript - [ - { - foo: 1, - bar: 11337n, - baz: '123456789', - }, - { - foo: 2, - bar: 21337n, - baz: 'alphabet!', - }, - last, - ] -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/coverage-contract.test.ts#L339-L353) - ---- - - -You can use a vector just like you would use any other type -- e.g. a `[Vec; 2]` or a `SomeStruct>` etc. - -## Returning vectors - -This is currently not supported. If you try returning a type that is or contains a vector you will get a compile time error. diff --git a/docs/guide/wallets/encrypting-and-storing-wallets.md b/docs/guide/wallets/encrypting-and-storing-wallets.md deleted file mode 100644 index 8e6d1fb8949..00000000000 --- a/docs/guide/wallets/encrypting-and-storing-wallets.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Encrypting And Storing Wallets" -parent: "Wallets" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Encrypting and storing wallets - -## Creating a wallet and storing an encrypted JSON wallet on disk - -You can also manage a wallet using [JSON wallets](https://cryptobook.nakov.com/symmetric-key-ciphers/ethereum-wallet-encryption) that are securely encrypted and stored on the disk. This makes it easier to manage multiple wallets, especially for testing purposes. - -You can create a random wallet and, at the same time, encrypt and store it. Then, later, you can recover the wallet if you know the master password: - - -```typescript - const walletManager = new WalletManager(); - const password = '0b540281-f87b-49ca-be37-2264c7f260f7'; - const wallet = Wallet.generate(); - - await walletManager.unlock(password); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.test.ts#L123-L129) - ---- - - -## Encrypting and storing a wallet created from a mnemonic or private key - -If you have already created a wallet Manager using a mnemonic phrase or a private key, you can also encrypt it and save it to disk: - -```typescript -await walletManager.lock(); -``` diff --git a/docs/guide/wallets/index.md b/docs/guide/wallets/index.md deleted file mode 100644 index 13639c145a4..00000000000 --- a/docs/guide/wallets/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Wallets" -parent: "Guide" -has_children: true -has_toc: false -nav_order: 2 ---- - -[info]: this file is autogenerated - - -# Managing wallets - -You can use wallets for many important things, for instance: - -1. Checking your balance; -2. Transferring coins to a destination address or contract; -3. Signing messages and transactions; -4. Paying for network fees when sending transactions or deploying smart contracts. - -The SDK gives you many different ways to create and access wallets. Let's explore these different approaches in the following sub-chapters. - -> **Note:** Keep in mind that you should never share your private/secret key. And in the case of wallets that were derived from a mnemonic phrase, never share your mnemonic phrase. If you're planning on storing the wallet on disk, do not store the plain private/secret key and do not store the plain mnemonic phrase. Instead, use `WalletManager` to encrypt its content first before saving it to disk. diff --git a/docs/guide/wallets/mnemonic-wallet.md b/docs/guide/wallets/mnemonic-wallet.md deleted file mode 100644 index 2a472113dcc..00000000000 --- a/docs/guide/wallets/mnemonic-wallet.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Mnemonic Wallet" -parent: "Wallets" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Creating a wallet from mnemonic phrases - -A mnemonic phrase is a cryptographically-generated sequence of words that's used to derive a private key. For instance: `"oblige salon price punch saddle immune slogan rare snap desert retire surprise";` would generate the address `0xdf9d0e6c6c5f5da6e82e5e1a77974af6642bdb450a10c43f0c6910a212600185`. - -In addition to that, we also support [Hierarchical Deterministic Wallets](https://www.ledger.com/academy/crypto/what-are-hierarchical-deterministic-hd-wallets) and [derivation paths](https://learnmeabitcoin.com/technical/derivation-paths). You may recognize the string `"m/44'/60'/0'/0/0"` from somewhere; that's a derivation path. In simple terms, it's a way to derive many wallets from a single root wallet. - -The SDK gives you two wallets from mnemonic instantiation methods: one that takes a derivation path and one that uses the default derivation path, in case you don't want or don't need to configure that. - -Here's how you can create wallets with both mnemonic phrases and derivation paths: - - -```typescript - const walletManager = new WalletManager(); - const password = '0b540281-f87b-49ca-be37-2264c7f260f7'; - - await walletManager.unlock(password); - - // Add a vault of type mnemonic - await walletManager.addVault(config); - -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.test.ts#L13-L22) - ---- - diff --git a/docs/guide/wallets/private-keys.md b/docs/guide/wallets/private-keys.md deleted file mode 100644 index adf20bcde20..00000000000 --- a/docs/guide/wallets/private-keys.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "Private Keys" -parent: "Wallets" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Creating a wallet from a private key - -A new wallet with a randomly generated private key can be created by supplying `Wallet.generate`. - - -```typescript - import { Wallet, WalletLocked, WalletUnlocked } from 'fuels'; - - // use the `generate` helper to make an Unlocked Wallet - const myWallet: WalletUnlocked = Wallet.generate(); - - // or use an Address to create a wallet - const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L155-L163) - ---- - - -Alternatively, you can create a wallet from a Private Key: - - -```typescript - // unlock an existing wallet - let unlockedWallet: WalletUnlocked = lockedWallet.unlock(PRIVATE_KEY); - // or directly from a private key - unlockedWallet = Wallet.fromPrivateKey(PRIVATE_KEY); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L169-L174) - ---- - - -You can obtain an address to a private key using the `Signer` package - -```typescript - const signer = new Signer(PRIVATE_KEY); - // validate address - expect(wallet.address).toEqual(signer.address); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L259-L263) - ---- - diff --git a/docs/guide/wallets/signing.md b/docs/guide/wallets/signing.md deleted file mode 100644 index 6305a978b08..00000000000 --- a/docs/guide/wallets/signing.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Signing" -parent: "Wallets" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Signing - -Once you've instantiated your wallet in an unlocked state using one of the previously discussed methods, you can sign a message with `wallet.sign_message`. Below is a full example of how to sign and recover a message. - - -```typescript - import { WalletUnlocked, hashMessage, Signer} from 'fuels'; - const wallet = WalletUnlocked.generate(); - const message = 'doc-test-message'; - const signedMessage = await wallet.signMessage(message); - const hashedMessage = hashMessage(message); - const recoveredAddress = Signer.recoverAddress(hashedMessage, signedMessage); - - expect(wallet.privateKey).toBeTruthy(); - expect(wallet.publicKey).toBeTruthy(); - expect(wallet.address).toEqual(recoveredAddress); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L197-L208) - ---- - - -You can also sign a _transaction_ by using `wallet.sign_transaction`. Below is a full example of how to sign and recover a transaction. - - -```typescript - import { WalletUnlocked, hashMessage, Signer} from 'fuels'; - const wallet = new WalletUnlocked(signTransactionTest.privateKey); - const transactionRequest = signTransactionTest.transaction; - const signedTransaction = await wallet.signTransaction(transactionRequest); - const verifiedAddress = Signer.recoverAddress( - hashTransaction(transactionRequest), - signedTransaction - ); - - expect(signedTransaction).toEqual(signTransactionTest.signedTransaction); - expect(verifiedAddress).toEqual(wallet.address); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet-unlocked.test.ts#L51-L63) - ---- - diff --git a/docs/guide/wallets/test-wallets.md b/docs/guide/wallets/test-wallets.md deleted file mode 100644 index 51f4066fe66..00000000000 --- a/docs/guide/wallets/test-wallets.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "Test Wallets" -parent: "Wallets" -grand_parent: "Guide" ---- - -[info]: this file is autogenerated -# Setting up test wallets - -You'll often want to create one or more test wallets when testing your contracts. Here's how to do it. - -## Create a single wallet - - -```typescript - import { Wallet, WalletLocked, WalletUnlocked } from 'fuels'; - - // use the `generate` helper to make an Unlocked Wallet - const myWallet: WalletUnlocked = Wallet.generate(); - - // or use an Address to create a wallet - const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L155-L163) - ---- - - -## Setting up multiple test wallets - -If you need multiple test wallets, they can be set up as follows: - - -```typescript - import { Provider, bn } from 'fuels'; - import { generateTestWallet } from '@fuel-ts/wallet/test-utils'; - const provider = new Provider('http://127.0.0.1:4000/graphql'); - const assetIdA = '0x0101010101010101010101010101010101010101010101010101010101010101'; - const assetIdB = '0x0202020202020202020202020202020202020202020202020202020202020202'; - - // single asset - const walletA = await generateTestWallet(provider, [[42, NativeAssetId]]); - - // multiple assets - const walletB = await generateTestWallet(provider, [ - // [Amount, AssetId] - [100, assetIdA], - [200, assetIdB], - [30, NativeAssetId], - ]); - - // this wallet has no assets - const walletC = await generateTestWallet(provider); - - // retrieve balances of wallets - const walletABalances = await walletA.getBalances(); - const walletBBalances = await walletB.getBalances(); - const walletCBalances = await walletC.getBalances(); - - // validate balances - expect(walletABalances).toEqual([{ assetId: NativeAssetId, amount: bn(42) }]); - expect(walletBBalances).toEqual([ - { assetId: NativeAssetId, amount: bn(30) }, - { assetId: assetIdA, amount: bn(100) }, - { assetId: assetIdB, amount: bn(200) }, - ]); - expect(walletCBalances).toEqual([]); -``` -###### [see code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L212-L246) - ---- - diff --git a/docs/packages/README.md b/docs/packages/README.md deleted file mode 100644 index 864689162ee..00000000000 --- a/docs/packages/README.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default -title: "fuels-ts" -has_children: true -has_toc: false -nav_order: 1 ---- - -# fuels-ts - -## Modules - -- [@fuel-ts/abi-coder](fuel-ts-abi-coder/index.md) -- [@fuel-ts/address](fuel-ts-address/index.md) -- [@fuel-ts/constants](fuel-ts-constants/index.md) -- [@fuel-ts/contract](fuel-ts-contract/index.md) -- [@fuel-ts/hasher](fuel-ts-hasher/index.md) -- [@fuel-ts/hdwallet](fuel-ts-hdwallet/index.md) -- [@fuel-ts/interfaces](fuel-ts-interfaces/index.md) -- [@fuel-ts/keystore](fuel-ts-keystore/index.md) -- [@fuel-ts/math](fuel-ts-math/index.md) -- [@fuel-ts/merkle](fuel-ts-merkle/index.md) -- [@fuel-ts/merkle-shared](fuel-ts-merkle-shared/index.md) -- [@fuel-ts/merklesum](fuel-ts-merklesum/index.md) -- [@fuel-ts/mnemonic](fuel-ts-mnemonic/index.md) -- [@fuel-ts/predicate](fuel-ts-predicate/index.md) -- [@fuel-ts/program](fuel-ts-program/index.md) -- [@fuel-ts/providers](fuel-ts-providers/index.md) -- [@fuel-ts/signer](fuel-ts-signer/index.md) -- [@fuel-ts/sparsemerkle](fuel-ts-sparsemerkle/index.md) -- [@fuel-ts/transactions](fuel-ts-transactions/index.md) -- [@fuel-ts/wallet](fuel-ts-wallet/index.md) -- [@fuel-ts/wallet-manager](fuel-ts-wallet-manager/index.md) -- [@fuel-ts/wordlists](fuel-ts-wordlists/index.md) diff --git a/docs/packages/fuel-ts-abi-coder/classes/ABI.md b/docs/packages/fuel-ts-abi-coder/classes/ABI.md deleted file mode 100644 index cbacf102795..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/ABI.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -layout: default -title: ABI -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: ABI - -[@fuel-ts/abi-coder](../index.md).ABI - -## Constructors - -### constructor - -• **new ABI**(`jsonAbi`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `jsonAbi` | [`JsonFlatAbi`](../interfaces/JsonFlatAbi.md) | - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L85) - -## Properties - -### functions - -• `Readonly` **functions**: readonly [`JsonFlatAbiFragmentFunction`](../interfaces/JsonFlatAbiFragmentFunction.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L82) - -___ - -### loggedTypes - -• `Readonly` **loggedTypes**: readonly [`JsonFlatAbiFragmentLoggedType`](../interfaces/JsonFlatAbiFragmentLoggedType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L83) - -___ - -### types - -• `Readonly` **types**: readonly [`JsonFlatAbiFragmentType`](../interfaces/JsonFlatAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L81) - -## Methods - -### parseInput - -▸ **parseInput**(`input`, `typeArgumentsList?`): [`JsonAbiFragmentType`](../interfaces/JsonAbiFragmentType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`JsonFlatAbiFragmentArgumentType`](../interfaces/JsonFlatAbiFragmentArgumentType.md) | -| `typeArgumentsList` | `Map`<`number`, [`JsonAbiFragmentType`](../interfaces/JsonAbiFragmentType.md)\> | - -#### Returns - -[`JsonAbiFragmentType`](../interfaces/JsonAbiFragmentType.md) - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:95](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L95) - -___ - -### parseLoggedType - -▸ **parseLoggedType**(`loggedType`): [`JsonAbiFragmentType`](../interfaces/JsonAbiFragmentType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `loggedType` | [`JsonFlatAbiFragmentLoggedType`](../interfaces/JsonFlatAbiFragmentLoggedType.md) | - -#### Returns - -[`JsonAbiFragmentType`](../interfaces/JsonAbiFragmentType.md) - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L91) - -___ - -### unflatten - -▸ **unflatten**(): readonly [`JsonAbiFragment`](../interfaces/JsonAbiFragment.md)[] - -#### Returns - -readonly [`JsonAbiFragment`](../interfaces/JsonAbiFragment.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:157](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L157) - -___ - -### unflattenLoggedTypes - -▸ **unflattenLoggedTypes**(): readonly [`JsonAbiLogFragment`](../interfaces/JsonAbiLogFragment.md)[] - -#### Returns - -readonly [`JsonAbiLogFragment`](../interfaces/JsonAbiLogFragment.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:150](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L150) - -___ - -### unflatten - -▸ `Static` **unflatten**(`jsonAbi`): readonly [`JsonAbiFragment`](../interfaces/JsonAbiFragment.md)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `jsonAbi` | [`JsonAbi`](../index.md#jsonabi) | - -#### Returns - -readonly [`JsonAbiFragment`](../interfaces/JsonAbiFragment.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:141](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L141) diff --git a/docs/packages/fuel-ts-abi-coder/classes/AbiCoder.md b/docs/packages/fuel-ts-abi-coder/classes/AbiCoder.md deleted file mode 100644 index 78ec06d4867..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/AbiCoder.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -layout: default -title: AbiCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: AbiCoder - -[@fuel-ts/abi-coder](../index.md).AbiCoder - -## Constructors - -### constructor - -• **new AbiCoder**() - -#### Defined in - -[packages/abi-coder/src/abi-coder.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L37) - -## Methods - -### decode - -▸ **decode**(`types`, `data`): `undefined` \| [`DecodedValue`](../index.md#decodedvalue)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | readonly [`JsonAbiFragmentType`](../interfaces/JsonAbiFragmentType.md)[] | -| `data` | `BytesLike` | - -#### Returns - -`undefined` \| [`DecodedValue`](../index.md#decodedvalue)[] - -#### Defined in - -[packages/abi-coder/src/abi-coder.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L159) - -___ - -### encode - -▸ **encode**(`types`, `values`, `offset?`): `Uint8Array` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `types` | readonly [`JsonAbiFragmentType`](../interfaces/JsonAbiFragmentType.md)[] | `undefined` | -| `values` | [`InputValue`](../index.md#inputvalue)<`void`\>[] | `undefined` | -| `offset` | `number` | `0` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/abi-coder/src/abi-coder.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L122) - -___ - -### getCoder - -▸ **getCoder**(`param`): [`Coder`](Coder.md)<`unknown`, `unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`JsonAbiFragmentType`](../interfaces/JsonAbiFragmentType.md) | - -#### Returns - -[`Coder`](Coder.md)<`unknown`, `unknown`\> - -#### Defined in - -[packages/abi-coder/src/abi-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L41) diff --git a/docs/packages/fuel-ts-abi-coder/classes/ArrayCoder.md b/docs/packages/fuel-ts-abi-coder/classes/ArrayCoder.md deleted file mode 100644 index a9860d93d61..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/ArrayCoder.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -layout: default -title: ArrayCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: ArrayCoder - -[@fuel-ts/abi-coder](../index.md).ArrayCoder - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoder` | extends [`Coder`](Coder.md) | - -## Hierarchy - -- [`Coder`](Coder.md)<[`InputValueOf`](../namespaces/internal.md#inputvalueof)<`TCoder`\>, [`DecodedValueOf`](../namespaces/internal.md#decodedvalueof)<`TCoder`\>\> - - ↳ **`ArrayCoder`** - -## Constructors - -### constructor - -• **new ArrayCoder**<`TCoder`\>(`coder`, `length`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoder` | extends [`Coder`](Coder.md)<`unknown`, `unknown`, `TCoder`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coder` | `TCoder` | -| `length` | `number` | - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/array.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L16) - -## Properties - -### coder - -• **coder**: `TCoder` - -#### Defined in - -[packages/abi-coder/src/coders/array.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L13) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### length - -• **length**: `number` - -#### Defined in - -[packages/abi-coder/src/coders/array.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L14) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof)<`TCoder`\>, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof)<`TCoder`\>, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/array.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L34) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputValueOf`](../namespaces/internal.md#inputvalueof)<`TCoder`\> | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/array.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L22) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/B256Coder.md b/docs/packages/fuel-ts-abi-coder/classes/B256Coder.md deleted file mode 100644 index 957218acc54..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/B256Coder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: B256Coder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: B256Coder - -[@fuel-ts/abi-coder](../index.md).B256Coder - -## Hierarchy - -- [`Coder`](Coder.md)<`string`, `string`\> - - ↳ **`B256Coder`** - -## Constructors - -### constructor - -• **new B256Coder**() - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/b256.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b256.ts#L7) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [`string`, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[`string`, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/b256.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b256.ts#L24) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/b256.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b256.ts#L11) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/B512Coder.md b/docs/packages/fuel-ts-abi-coder/classes/B512Coder.md deleted file mode 100644 index fcf90431c85..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/B512Coder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: B512Coder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: B512Coder - -[@fuel-ts/abi-coder](../index.md).B512Coder - -## Hierarchy - -- [`Coder`](Coder.md)<`string`, `string`\> - - ↳ **`B512Coder`** - -## Constructors - -### constructor - -• **new B512Coder**() - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/b512.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b512.ts#L7) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [`string`, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[`string`, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/b512.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b512.ts#L24) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/b512.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b512.ts#L11) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/BooleanCoder.md b/docs/packages/fuel-ts-abi-coder/classes/BooleanCoder.md deleted file mode 100644 index badf04387ab..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/BooleanCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: BooleanCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: BooleanCoder - -[@fuel-ts/abi-coder](../index.md).BooleanCoder - -## Hierarchy - -- [`Coder`](Coder.md)<`boolean`, `boolean`\> - - ↳ **`BooleanCoder`** - -## Constructors - -### constructor - -• **new BooleanCoder**() - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/boolean.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/boolean.ts#L6) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [`boolean`, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[`boolean`, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/boolean.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/boolean.ts#L25) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/boolean.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/boolean.ts#L10) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/ByteCoder.md b/docs/packages/fuel-ts-abi-coder/classes/ByteCoder.md deleted file mode 100644 index daec9d01282..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/ByteCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ByteCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: ByteCoder - -[@fuel-ts/abi-coder](../index.md).ByteCoder - -## Hierarchy - -- [`Coder`](Coder.md)<`number`, `number`\> - - ↳ **`ByteCoder`** - -## Constructors - -### constructor - -• **new ByteCoder**() - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/byte.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/byte.ts#L6) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [`number`, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[`number`, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/byte.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/byte.ts#L22) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/byte.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/byte.ts#L10) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/Coder.md b/docs/packages/fuel-ts-abi-coder/classes/Coder.md deleted file mode 100644 index 76ae9fa7a56..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/Coder.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -layout: default -title: Coder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: Coder - -[@fuel-ts/abi-coder](../index.md).Coder - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TInput` | `unknown` | -| `TDecoded` | `unknown` | - -## Hierarchy - -- **`Coder`** - - ↳ [`ArrayCoder`](ArrayCoder.md) - - ↳ [`B256Coder`](B256Coder.md) - - ↳ [`B512Coder`](B512Coder.md) - - ↳ [`BooleanCoder`](BooleanCoder.md) - - ↳ [`ByteCoder`](ByteCoder.md) - - ↳ [`EnumCoder`](EnumCoder.md) - - ↳ [`NumberCoder`](NumberCoder.md) - - ↳ [`StringCoder`](StringCoder.md) - - ↳ [`StructCoder`](StructCoder.md) - - ↳ [`TupleCoder`](TupleCoder.md) - - ↳ [`U64Coder`](U64Coder.md) - - ↳ [`VecCoder`](VecCoder.md) - -## Constructors - -### constructor - -• **new Coder**<`TInput`, `TDecoded`\>(`name`, `type`, `encodedLength`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TInput` | `unknown` | -| `TDecoded` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `type` | `string` | -| `encodedLength` | `number` | - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L43) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ `Abstract` **decode**(`data`, `offset`, `length?`): [`TDecoded`, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | -| `length?` | `number` | - -#### Returns - -[`TDecoded`, `number`] - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L62) - -___ - -### encode - -▸ `Abstract` **encode**(`value`, `length?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `TInput` | -| `length?` | `number` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L60) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/EnumCoder.md b/docs/packages/fuel-ts-abi-coder/classes/EnumCoder.md deleted file mode 100644 index 6000b82ec3d..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/EnumCoder.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -layout: default -title: EnumCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: EnumCoder - -[@fuel-ts/abi-coder](../index.md).EnumCoder - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, [`Coder`](Coder.md)\> | - -## Hierarchy - -- [`Coder`](Coder.md)<[`InputValueOf`](../namespaces/internal.md#inputvalueof-1)<`TCoders`\>, [`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-1)<`TCoders`\>\> - - ↳ **`EnumCoder`** - -## Constructors - -### constructor - -• **new EnumCoder**<`TCoders`\>(`name`, `coders`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, [`Coder`](Coder.md)<`unknown`, `unknown`\>\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `coders` | `TCoders` | - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/enum.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/enum.ts#L25) - -## Properties - -### #caseIndexCoder - -• `Private` **#caseIndexCoder**: [`U64Coder`](U64Coder.md) - -#### Defined in - -[packages/abi-coder/src/coders/enum.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/enum.ts#L22) - -___ - -### #encodedValueSize - -• `Private` **#encodedValueSize**: `number` - -#### Defined in - -[packages/abi-coder/src/coders/enum.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/enum.ts#L23) - -___ - -### coders - -• **coders**: `TCoders` - -#### Defined in - -[packages/abi-coder/src/coders/enum.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/enum.ts#L21) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• **name**: `string` - -#### Overrides - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/enum.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/enum.ts#L20) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-1)<`TCoders`\>, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-1)<`TCoders`\>, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/enum.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/enum.ts#L54) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputValueOf`](../namespaces/internal.md#inputvalueof-1)<`TCoders`\> | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/enum.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/enum.ts#L38) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/Fragment.md b/docs/packages/fuel-ts-abi-coder/classes/Fragment.md deleted file mode 100644 index 13746952334..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/Fragment.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -layout: default -title: Fragment -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: Fragment - -[@fuel-ts/abi-coder](../index.md).Fragment - -## Hierarchy - -- **`Fragment`** - - ↳ [`FunctionFragment`](FunctionFragment.md) - -## Constructors - -### constructor - -• **new Fragment**(`params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`FragmentParams`](../interfaces/internal-FragmentParams.md) | - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L23) - -## Properties - -### attributes - -• `Readonly` **attributes**: readonly [`AttributeType`](../interfaces/internal-AttributeType.md)[] = `[]` - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L21) - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](internal-ParamType.md)[] = `[]` - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L19) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L18) - -___ - -### outputs - -• `Readonly` **outputs**: [`ParamType`](internal-ParamType.md)[] = `[]` - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L20) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L17) - -## Methods - -### getInputsSighash - -▸ `Abstract` **getInputsSighash**(`format?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `format?` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L31) diff --git a/docs/packages/fuel-ts-abi-coder/classes/FunctionFragment.md b/docs/packages/fuel-ts-abi-coder/classes/FunctionFragment.md deleted file mode 100644 index d4a48d213fc..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/FunctionFragment.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -layout: default -title: FunctionFragment -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: FunctionFragment - -[@fuel-ts/abi-coder](../index.md).FunctionFragment - -## Hierarchy - -- [`Fragment`](Fragment.md) - - ↳ **`FunctionFragment`** - -## Constructors - -### constructor - -• **new FunctionFragment**(`params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`FragmentParams`](../interfaces/internal-FragmentParams.md) | - -#### Inherited from - -[Fragment](Fragment.md).[constructor](Fragment.md#constructor) - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L23) - -## Properties - -### attributes - -• `Readonly` **attributes**: readonly [`AttributeType`](../interfaces/internal-AttributeType.md)[] = `[]` - -#### Inherited from - -[Fragment](Fragment.md).[attributes](Fragment.md#attributes) - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L21) - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](internal-ParamType.md)[] = `[]` - -#### Inherited from - -[Fragment](Fragment.md).[inputs](Fragment.md#inputs) - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L19) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Fragment](Fragment.md).[name](Fragment.md#name) - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L18) - -___ - -### outputs - -• `Readonly` **outputs**: [`ParamType`](internal-ParamType.md)[] = `[]` - -#### Inherited from - -[Fragment](Fragment.md).[outputs](Fragment.md#outputs) - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L20) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Fragment](Fragment.md).[type](Fragment.md#type) - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L17) - -## Methods - -### getInputsSighash - -▸ **getInputsSighash**(): `string` - -#### Returns - -`string` - -#### Overrides - -[Fragment](Fragment.md).[getInputsSighash](Fragment.md#getinputssighash) - -#### Defined in - -[packages/abi-coder/src/fragments/function-fragment.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/function-fragment.ts#L24) - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`FunctionFragment`](FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonAbiFragment`](../interfaces/JsonAbiFragment.md) | - -#### Returns - -[`FunctionFragment`](FunctionFragment.md) - -#### Defined in - -[packages/abi-coder/src/fragments/function-fragment.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/function-fragment.ts#L9) diff --git a/docs/packages/fuel-ts-abi-coder/classes/Interface.md b/docs/packages/fuel-ts-abi-coder/classes/Interface.md deleted file mode 100644 index 1ef401be817..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/Interface.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -layout: default -title: Interface -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: Interface - -[@fuel-ts/abi-coder](../index.md).Interface - -## Constructors - -### constructor - -• **new Interface**(`jsonAbi`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `jsonAbi` | [`JsonAbi`](../index.md#jsonabi) | - -#### Defined in - -[packages/abi-coder/src/interface.ts:53](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L53) - -## Properties - -### abi - -• `Readonly` **abi**: ``null`` \| [`ABI`](ABI.md) - -#### Defined in - -[packages/abi-coder/src/interface.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L42) - -___ - -### abiCoder - -• `Readonly` **abiCoder**: [`AbiCoder`](AbiCoder.md) - -#### Defined in - -[packages/abi-coder/src/interface.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L41) - -___ - -### externalLoggedTypes - -• `Private` **externalLoggedTypes**: `Object` - -#### Index signature - -▪ [id: `string`]: `ReadonlyArray`<[`JsonAbiLogFragment`](../interfaces/JsonAbiLogFragment.md)\> - -#### Defined in - -[packages/abi-coder/src/interface.ts:51](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L51) - -___ - -### fragments - -• `Readonly` **fragments**: [`Fragment`](Fragment.md)[] - -#### Defined in - -[packages/abi-coder/src/interface.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L39) - -___ - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`FunctionFragment`](FunctionFragment.md) - -#### Defined in - -[packages/abi-coder/src/interface.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L40) - -___ - -### loggedTypes - -• `Readonly` **loggedTypes**: readonly [`JsonAbiLogFragment`](../interfaces/JsonAbiLogFragment.md)[] - -#### Defined in - -[packages/abi-coder/src/interface.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L44) - -___ - -### types - -• `Readonly` **types**: readonly [`JsonFlatAbiFragmentType`](../interfaces/JsonFlatAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/interface.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L43) - -## Methods - -### decodeFunctionData - -▸ **decodeFunctionData**(`functionFragment`, `data`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | -| `data` | `BytesLike` | - -#### Returns - -`any` - -#### Defined in - -[packages/abi-coder/src/interface.ts:113](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L113) - -___ - -### decodeFunctionResult - -▸ **decodeFunctionResult**(`functionFragment`, `data`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | -| `data` | `BytesLike` | - -#### Returns - -`any` - -#### Defined in - -[packages/abi-coder/src/interface.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L159) - -___ - -### decodeLog - -▸ **decodeLog**(`data`, `logId`, `receiptId`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `BytesLike` | -| `logId` | `number` | -| `receiptId` | `string` | - -#### Returns - -`any` - -#### Defined in - -[packages/abi-coder/src/interface.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L168) - -___ - -### encodeFunctionData - -▸ **encodeFunctionData**(`functionFragment`, `values`, `offset?`, `isMainArgs?`): `Uint8Array` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | `undefined` | -| `values` | [`InputValue`](../index.md#inputvalue)<`void`\>[] | `undefined` | -| `offset` | `number` | `0` | -| `isMainArgs` | `boolean` | `false` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/abi-coder/src/interface.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L129) - -___ - -### encodeFunctionResult - -▸ **encodeFunctionResult**(`functionFragment`, `values`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `functionFragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | -| `values` | [`InputValue`](../index.md#inputvalue)<`void`\>[] | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/abi-coder/src/interface.ts:178](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L178) - -___ - -### getFunction - -▸ **getFunction**(`nameOrSignatureOrSighash`): [`FunctionFragment`](FunctionFragment.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nameOrSignatureOrSighash` | `string` | - -#### Returns - -[`FunctionFragment`](FunctionFragment.md) - -#### Defined in - -[packages/abi-coder/src/interface.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L90) - -___ - -### updateExternalLoggedTypes - -▸ **updateExternalLoggedTypes**(`id`, `loggedTypes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `loggedTypes` | [`JsonAbiLogFragment`](../interfaces/JsonAbiLogFragment.md)[] | - -#### Returns - -`void` - -#### Defined in - -[packages/abi-coder/src/interface.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L192) - -___ - -### getSighash - -▸ `Static` **getSighash**(`fragment`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/abi-coder/src/interface.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L81) diff --git a/docs/packages/fuel-ts-abi-coder/classes/NumberCoder.md b/docs/packages/fuel-ts-abi-coder/classes/NumberCoder.md deleted file mode 100644 index 25e8abaed58..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/NumberCoder.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -layout: default -title: NumberCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: NumberCoder - -[@fuel-ts/abi-coder](../index.md).NumberCoder - -## Hierarchy - -- [`Coder`](Coder.md)<`number`, `number`\> - - ↳ **`NumberCoder`** - -## Constructors - -### constructor - -• **new NumberCoder**(`baseType`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `baseType` | [`NumberCoderType`](../namespaces/internal.md#numbercodertype) | - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/number.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L13) - -## Properties - -### baseType - -• **baseType**: [`NumberCoderType`](../namespaces/internal.md#numbercodertype) - -#### Defined in - -[packages/abi-coder/src/coders/number.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L11) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### length - -• **length**: `number` - -#### Defined in - -[packages/abi-coder/src/coders/number.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L10) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [`number`, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[`number`, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/number.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L46) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` \| `number` | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/number.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L30) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/StringCoder.md b/docs/packages/fuel-ts-abi-coder/classes/StringCoder.md deleted file mode 100644 index e6eb0ee5074..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/StringCoder.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -layout: default -title: StringCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: StringCoder - -[@fuel-ts/abi-coder](../index.md).StringCoder - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TLength` | extends `number` = `number` | - -## Hierarchy - -- [`Coder`](Coder.md)<`string`, `string`\> - - ↳ **`StringCoder`** - -## Constructors - -### constructor - -• **new StringCoder**<`TLength`\>(`length`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TLength` | extends `number` = `number` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `length` | `TLength` | - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/string.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/string.ts#L10) - -## Properties - -### #paddingLength - -• `Private` **#paddingLength**: `number` - -#### Defined in - -[packages/abi-coder/src/coders/string.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/string.ts#L8) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### length - -• **length**: `TLength` - -#### Defined in - -[packages/abi-coder/src/coders/string.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/string.ts#L7) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [`string`, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[`string`, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/string.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/string.ts#L24) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/string.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/string.ts#L18) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/StructCoder.md b/docs/packages/fuel-ts-abi-coder/classes/StructCoder.md deleted file mode 100644 index a89e36519d8..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/StructCoder.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -layout: default -title: StructCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: StructCoder - -[@fuel-ts/abi-coder](../index.md).StructCoder - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, [`Coder`](Coder.md)\> | - -## Hierarchy - -- [`Coder`](Coder.md)<[`InputValueOf`](../namespaces/internal.md#inputvalueof-2)<`TCoders`\>, [`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-2)<`TCoders`\>\> - - ↳ **`StructCoder`** - -## Constructors - -### constructor - -• **new StructCoder**<`TCoders`\>(`name`, `coders`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, [`Coder`](Coder.md)<`unknown`, `unknown`\>\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `coders` | `TCoders` | - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L21) - -## Properties - -### coders - -• **coders**: `TCoders` - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L19) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• **name**: `string` - -#### Overrides - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L18) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-2)<`TCoders`\>, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-2)<`TCoders`\>, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L45) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputValueOf`](../namespaces/internal.md#inputvalueof-2)<`TCoders`\> | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L31) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/TupleCoder.md b/docs/packages/fuel-ts-abi-coder/classes/TupleCoder.md deleted file mode 100644 index 73de5f7cb00..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/TupleCoder.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -layout: default -title: TupleCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: TupleCoder - -[@fuel-ts/abi-coder](../index.md).TupleCoder - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends [`Coder`](Coder.md)[] | - -## Hierarchy - -- [`Coder`](Coder.md)<[`InputValueOf`](../namespaces/internal.md#inputvalueof-3)<`TCoders`\>, [`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-3)<`TCoders`\>\> - - ↳ **`TupleCoder`** - -## Constructors - -### constructor - -• **new TupleCoder**<`TCoders`\>(`coders`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends [`Coder`](Coder.md)<`unknown`, `unknown`\>[] | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coders` | `TCoders` | - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/tuple.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L19) - -## Properties - -### coders - -• **coders**: `TCoders` - -#### Defined in - -[packages/abi-coder/src/coders/tuple.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L17) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-3)<`TCoders`\>, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-3)<`TCoders`\>, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/tuple.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L33) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputValueOf`](../namespaces/internal.md#inputvalueof-3)<`TCoders`\> | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/tuple.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L25) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/U64Coder.md b/docs/packages/fuel-ts-abi-coder/classes/U64Coder.md deleted file mode 100644 index 1ccec6a4b4e..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/U64Coder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: U64Coder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: U64Coder - -[@fuel-ts/abi-coder](../index.md).U64Coder - -## Hierarchy - -- [`Coder`](Coder.md)<[`BNInput`](../namespaces/internal.md#bninput), [`BN`](internal-BN.md)\> - - ↳ **`U64Coder`** - -## Constructors - -### constructor - -• **new U64Coder**() - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/u64.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/u64.ts#L7) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`BN`](internal-BN.md), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`BN`](internal-BN.md), `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/u64.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/u64.ts#L23) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/u64.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/u64.ts#L11) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-abi-coder/classes/VecCoder.md b/docs/packages/fuel-ts-abi-coder/classes/VecCoder.md deleted file mode 100644 index 60255ed1ec3..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/VecCoder.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -layout: default -title: VecCoder -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: VecCoder - -[@fuel-ts/abi-coder](../index.md).VecCoder - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoder` | extends [`Coder`](Coder.md) | - -## Hierarchy - -- [`Coder`](Coder.md)<[`InputValueOf`](../namespaces/internal.md#inputvalueof-4)<`TCoder`\>, [`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-4)<`TCoder`\>\> - - ↳ **`VecCoder`** - -## Constructors - -### constructor - -• **new VecCoder**<`TCoder`\>(`coder`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoder` | extends [`Coder`](Coder.md)<`unknown`, `unknown`, `TCoder`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coder` | `TCoder` | - -#### Overrides - -[Coder](Coder.md).[constructor](Coder.md#constructor) - -#### Defined in - -[packages/abi-coder/src/coders/vec.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/vec.ts#L20) - -## Properties - -### coder - -• **coder**: `TCoder` - -#### Defined in - -[packages/abi-coder/src/coders/vec.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/vec.ts#L18) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -[Coder](Coder.md).[encodedLength](Coder.md#encodedlength) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[Coder](Coder.md).[name](Coder.md#name) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[Coder](Coder.md).[offset](Coder.md#offset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -[Coder](Coder.md).[type](Coder.md#type) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-4)<`TCoder`\>, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof-4)<`TCoder`\>, `number`] - -#### Overrides - -[Coder](Coder.md).[decode](Coder.md#decode) - -#### Defined in - -[packages/abi-coder/src/coders/vec.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/vec.ts#L55) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputValueOf`](../namespaces/internal.md#inputvalueof-4)<`TCoder`\> | - -#### Returns - -`Uint8Array` - -#### Overrides - -[Coder](Coder.md).[encode](Coder.md#encode) - -#### Defined in - -[packages/abi-coder/src/coders/vec.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/vec.ts#L38) - -___ - -### getEncodedVectorData - -▸ **getEncodedVectorData**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputValueOf`](../namespaces/internal.md#inputvalueof-4)<`TCoder`\> | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/abi-coder/src/coders/vec.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/vec.ts#L29) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -[Coder](Coder.md).[setOffset](Coder.md#setoffset) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -[Coder](Coder.md).[throwError](Coder.md#throwerror) - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) - -___ - -### getBaseOffset - -▸ `Static` **getBaseOffset**(): `number` - -#### Returns - -`number` - -#### Defined in - -[packages/abi-coder/src/coders/vec.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/vec.ts#L25) diff --git a/docs/packages/fuel-ts-abi-coder/classes/internal-BN.md b/docs/packages/fuel-ts-abi-coder/classes/internal-BN.md deleted file mode 100644 index 6067c5afe25..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/internal-BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../namespaces/internal.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](internal-BN.md) | -| `mod` | [`BN`](internal-BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](internal-BN.md) | -| `b` | [`BN`](internal-BN.md) | -| `gcd` | [`BN`](internal-BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../namespaces/internal.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](internal-BN.md) | -| `out` | [`BN`](internal-BN.md) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-abi-coder/classes/internal-ParamType.md b/docs/packages/fuel-ts-abi-coder/classes/internal-ParamType.md deleted file mode 100644 index 413cb84836a..00000000000 --- a/docs/packages/fuel-ts-abi-coder/classes/internal-ParamType.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -layout: default -title: ParamType -parent: "@fuel-ts/abi-coder" -nav_order: 1 - ---- - -# Class: ParamType - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).ParamType - -## Implements - -- [`ParamTypeProps`](../interfaces/internal-ParamTypeProps.md) - -## Constructors - -### constructor - -• **new ParamType**(`params`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`ParamTypeProps`](../interfaces/internal-ParamTypeProps.md) | - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L47) - -## Properties - -### components - -• `Optional` `Readonly` **components**: [`ParamType`](internal-ParamType.md)[] - -#### Implementation of - -[ParamTypeProps](../interfaces/internal-ParamTypeProps.md).[components](../interfaces/internal-ParamTypeProps.md#components) - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L43) - -___ - -### indexed - -• `Optional` `Readonly` **indexed**: `boolean` - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L42) - -___ - -### isParamType - -• `Optional` `Readonly` **isParamType**: `boolean` - -#### Implementation of - -[ParamTypeProps](../interfaces/internal-ParamTypeProps.md).[isParamType](../interfaces/internal-ParamTypeProps.md#isparamtype) - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L45) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Implementation of - -[ParamTypeProps](../interfaces/internal-ParamTypeProps.md).[name](../interfaces/internal-ParamTypeProps.md#name) - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L40) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Implementation of - -[ParamTypeProps](../interfaces/internal-ParamTypeProps.md).[type](../interfaces/internal-ParamTypeProps.md#type) - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L41) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: [`ParamType`](internal-ParamType.md)[] - -#### Implementation of - -[ParamTypeProps](../interfaces/internal-ParamTypeProps.md).[typeArguments](../interfaces/internal-ParamTypeProps.md#typearguments) - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L44) - -## Methods - -### getSighash - -▸ **getSighash**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:101](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L101) - -___ - -### getSignatureContent - -▸ **getSignatureContent**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:70](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L70) - -___ - -### getSignaturePrefix - -▸ **getSignaturePrefix**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L55) - -___ - -### fromObject - -▸ `Static` **fromObject**(`value`): [`ParamType`](internal-ParamType.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`JsonFragmentType`](../interfaces/internal-JsonFragmentType.md) \| [`ParamTypeProps`](../interfaces/internal-ParamTypeProps.md) | - -#### Returns - -[`ParamType`](internal-ParamType.md) - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:108](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L108) - -___ - -### isParamType - -▸ `Static` **isParamType**(`value?`): value is ParamType - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | [`JsonFragmentType`](../interfaces/internal-JsonFragmentType.md) \| [`ParamType`](internal-ParamType.md) | - -#### Returns - -value is ParamType - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L123) diff --git a/docs/packages/fuel-ts-abi-coder/index.md b/docs/packages/fuel-ts-abi-coder/index.md deleted file mode 100644 index f2122afa9a0..00000000000 --- a/docs/packages/fuel-ts-abi-coder/index.md +++ /dev/null @@ -1,371 +0,0 @@ ---- -layout: default -title: "@fuel-ts/abi-coder" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/abi-coder - -## Namespaces - -- [internal](namespaces/internal.md) - -## Classes - -- [ABI](classes/ABI.md) -- [AbiCoder](classes/AbiCoder.md) -- [ArrayCoder](classes/ArrayCoder.md) -- [B256Coder](classes/B256Coder.md) -- [B512Coder](classes/B512Coder.md) -- [BooleanCoder](classes/BooleanCoder.md) -- [ByteCoder](classes/ByteCoder.md) -- [Coder](classes/Coder.md) -- [EnumCoder](classes/EnumCoder.md) -- [Fragment](classes/Fragment.md) -- [FunctionFragment](classes/FunctionFragment.md) -- [Interface](classes/Interface.md) -- [NumberCoder](classes/NumberCoder.md) -- [StringCoder](classes/StringCoder.md) -- [StructCoder](classes/StructCoder.md) -- [TupleCoder](classes/TupleCoder.md) -- [U64Coder](classes/U64Coder.md) -- [VecCoder](classes/VecCoder.md) - -## Interfaces - -- [JsonAbiFragment](interfaces/JsonAbiFragment.md) -- [JsonAbiFragmentType](interfaces/JsonAbiFragmentType.md) -- [JsonAbiFunctionAttributeType](interfaces/JsonAbiFunctionAttributeType.md) -- [JsonAbiLogFragment](interfaces/JsonAbiLogFragment.md) -- [JsonFlatAbi](interfaces/JsonFlatAbi.md) -- [JsonFlatAbiFragmentArgumentType](interfaces/JsonFlatAbiFragmentArgumentType.md) -- [JsonFlatAbiFragmentFunction](interfaces/JsonFlatAbiFragmentFunction.md) -- [JsonFlatAbiFragmentLoggedType](interfaces/JsonFlatAbiFragmentLoggedType.md) -- [JsonFlatAbiFragmentType](interfaces/JsonFlatAbiFragmentType.md) - -## Type Aliases - -### DecodedValue - -Ƭ **DecodedValue**: [`Primitive`](namespaces/internal.md#primitive) \| [`DecodedValue`](index.md#decodedvalue)[] \| { `[key: string]`: [`DecodedValue`](index.md#decodedvalue); } \| `Record`<`string`, [`Primitive`](namespaces/internal.md#primitive)\> - -The type of value you can get from `Coder.decode` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L27) - -___ - -### InputValue - -Ƭ **InputValue**<`T`\>: [`Primitive`](namespaces/internal.md#primitive) \| [`BN`](classes/internal-BN.md) \| [`Option`](namespaces/internal.md#option)<`T`\> \| `BytesLike` \| [`InputValue`](index.md#inputvalue)[] \| { `[key: string]`: [`InputValue`](index.md#inputvalue); } \| `Record`<`string`, [`Primitive`](namespaces/internal.md#primitive) \| `BytesLike`\> - -The type of value you can provide to `Coder.encode` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `void` | - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L15) - -___ - -### JsonAbi - -Ƭ **JsonAbi**: `ReadonlyArray`<[`JsonAbiFragment`](interfaces/JsonAbiFragment.md)\> \| [`JsonFlatAbi`](interfaces/JsonFlatAbi.md) - -A JSON ABI object - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:78](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L78) - -___ - -### TypesOfCoder - -Ƭ **TypesOfCoder**<`TCoder`\>: `TCoder` extends [`Coder`](classes/Coder.md) ? { `Decoded`: `TDecoded` ; `Input`: `TInput` } : `never` - -#### Type parameters - -| Name | -| :------ | -| `TCoder` | - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L33) - -## Variables - -### ASSET\_ID\_LEN - -• `Const` **ASSET\_ID\_LEN**: ``32`` - -#### Defined in - -[packages/abi-coder/src/constants.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L13) - -___ - -### BYTES\_32 - -• `Const` **BYTES\_32**: ``32`` - -#### Defined in - -[packages/abi-coder/src/constants.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L11) - -___ - -### CONTRACT\_ID\_LEN - -• `Const` **CONTRACT\_ID\_LEN**: ``32`` - -#### Defined in - -[packages/abi-coder/src/constants.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L14) - -___ - -### MAX\_INPUTS - -• `Const` **MAX\_INPUTS**: ``255`` - -#### Defined in - -[packages/abi-coder/src/constants.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L12) - -___ - -### OPTION\_CODER\_TYPE - -• `Const` **OPTION\_CODER\_TYPE**: ``"enum Option"`` - -#### Defined in - -[packages/abi-coder/src/constants.ts:1](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L1) - -___ - -### TRANSACTION\_SCRIPT\_FIXED\_SIZE - -• `Const` **TRANSACTION\_SCRIPT\_FIXED\_SIZE**: `number` - -#### Defined in - -[packages/abi-coder/src/constants.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L24) - -___ - -### VEC\_CODER\_TYPE - -• `Const` **VEC\_CODER\_TYPE**: ``"struct Vec"`` - -#### Defined in - -[packages/abi-coder/src/constants.ts:2](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L2) - -___ - -### VM\_TX\_MEMORY - -• `Const` **VM\_TX\_MEMORY**: `number` - -#### Defined in - -[packages/abi-coder/src/constants.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L17) - -___ - -### WORD\_SIZE - -• `Const` **WORD\_SIZE**: ``8`` - -#### Defined in - -[packages/abi-coder/src/constants.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L10) - -___ - -### arrayRegEx - -• `Const` **arrayRegEx**: `RegExp` - -#### Defined in - -[packages/abi-coder/src/constants.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L4) - -___ - -### enumRegEx - -• `Const` **enumRegEx**: `RegExp` - -#### Defined in - -[packages/abi-coder/src/constants.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L6) - -___ - -### genericRegEx - -• `Const` **genericRegEx**: `RegExp` - -#### Defined in - -[packages/abi-coder/src/constants.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L8) - -___ - -### stringRegEx - -• `Const` **stringRegEx**: `RegExp` - -#### Defined in - -[packages/abi-coder/src/constants.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L3) - -___ - -### structRegEx - -• `Const` **structRegEx**: `RegExp` - -#### Defined in - -[packages/abi-coder/src/constants.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L5) - -___ - -### tupleRegEx - -• `Const` **tupleRegEx**: `RegExp` - -#### Defined in - -[packages/abi-coder/src/constants.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/constants.ts#L7) - -## Functions - -### filterEmptyParams - -▸ **filterEmptyParams**<`T`\>(`types`): `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | `T` | - -#### Returns - -`T` - -#### Defined in - -[packages/abi-coder/src/utilities.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/utilities.ts#L7) - -___ - -### getVectorAdjustments - -▸ **getVectorAdjustments**(`coders`, `values`, `offset?`): `Uint8Array`[] - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `coders` | [`Coder`](classes/Coder.md)<`unknown`, `unknown`\>[] | `undefined` | -| `values` | [`InputValue`](index.md#inputvalue)<`void`\>[] | `undefined` | -| `offset` | `number` | `0` | - -#### Returns - -`Uint8Array`[] - -#### Defined in - -[packages/abi-coder/src/utilities.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/utilities.ts#L18) - -___ - -### hasOptionTypes - -▸ **hasOptionTypes**<`T`\>(`types`): `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `types` | `T` | - -#### Returns - -`T` - -#### Defined in - -[packages/abi-coder/src/utilities.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/utilities.ts#L12) - -___ - -### isFlatJsonAbi - -▸ **isFlatJsonAbi**(`jsonAbi`): jsonAbi is JsonFlatAbi - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `jsonAbi` | [`JsonAbi`](index.md#jsonabi) | - -#### Returns - -jsonAbi is JsonFlatAbi - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L74) - -___ - -### isReferenceType - -▸ **isReferenceType**(`type`): `boolean` - -Checks if a given type is a reference type -See: https://github.com/FuelLabs/sway/issues/1368 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L172) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFragment.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFragment.md deleted file mode 100644 index a5f11fdb437..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFragment.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: JsonAbiFragment -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonAbiFragment - -[@fuel-ts/abi-coder](../index.md).JsonAbiFragment - -## Properties - -### attributes - -• `Optional` `Readonly` **attributes**: readonly [`JsonAbiFunctionAttributeType`](JsonAbiFunctionAttributeType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L33) - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonAbiFragmentType`](JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L31) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L30) - -___ - -### outputs - -• `Optional` `Readonly` **outputs**: readonly [`JsonAbiFragmentType`](JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L32) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L24) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFragmentType.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFragmentType.md deleted file mode 100644 index e4a532e3cda..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFragmentType.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: JsonAbiFragmentType -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonAbiFragmentType - -[@fuel-ts/abi-coder](../index.md).JsonAbiFragmentType - -## Properties - -### components - -• `Optional` `Readonly` **components**: ``null`` \| readonly [`JsonAbiFragmentType`](JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L14) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L12) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L11) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: ``null`` \| readonly [`JsonAbiFragmentType`](JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L15) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFunctionAttributeType.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFunctionAttributeType.md deleted file mode 100644 index 52ca76bcaea..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiFunctionAttributeType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: JsonAbiFunctionAttributeType -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonAbiFunctionAttributeType - -[@fuel-ts/abi-coder](../index.md).JsonAbiFunctionAttributeType - -## Properties - -### arguments - -• `Readonly` **arguments**: readonly `string`[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L20) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L19) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiLogFragment.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiLogFragment.md deleted file mode 100644 index 0c3fe70d8d6..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/JsonAbiLogFragment.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: JsonAbiLogFragment -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonAbiLogFragment - -[@fuel-ts/abi-coder](../index.md).JsonAbiLogFragment - -## Properties - -### abiFragmentType - -• `Optional` `Readonly` **abiFragmentType**: readonly [`JsonAbiFragmentType`](JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L39) - -___ - -### logId - -• `Readonly` **logId**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L37) - -___ - -### loggedType - -• `Readonly` **loggedType**: [`JsonFlatAbiFragmentArgumentType`](JsonFlatAbiFragmentArgumentType.md) - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L38) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbi.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbi.md deleted file mode 100644 index 1a4dee68f13..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbi.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: JsonFlatAbi -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonFlatAbi - -[@fuel-ts/abi-coder](../index.md).JsonFlatAbi - -## Properties - -### functions - -• `Readonly` **functions**: readonly [`JsonFlatAbiFragmentFunction`](JsonFlatAbiFragmentFunction.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L71) - -___ - -### loggedTypes - -• `Readonly` **loggedTypes**: readonly [`JsonFlatAbiFragmentLoggedType`](JsonFlatAbiFragmentLoggedType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:70](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L70) - -___ - -### types - -• `Readonly` **types**: readonly [`JsonFlatAbiFragmentType`](JsonFlatAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:69](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L69) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentArgumentType.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentArgumentType.md deleted file mode 100644 index c346ab3bb50..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentArgumentType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentArgumentType -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentArgumentType - -[@fuel-ts/abi-coder](../index.md).JsonFlatAbiFragmentArgumentType - -## Properties - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L57) - -___ - -### type - -• `Readonly` **type**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L56) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: ``null`` \| readonly [`JsonFlatAbiFragmentArgumentType`](JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:58](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L58) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentFunction.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentFunction.md deleted file mode 100644 index f099eb22780..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentFunction.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentFunction -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentFunction - -[@fuel-ts/abi-coder](../index.md).JsonFlatAbiFragmentFunction - -## Properties - -### attributes - -• `Optional` `Readonly` **attributes**: ``null`` \| readonly [`JsonAbiFunctionAttributeType`](JsonAbiFunctionAttributeType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L65) - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonFlatAbiFragmentArgumentType`](JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L63) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L62) - -___ - -### output - -• `Optional` `Readonly` **output**: `Readonly`<[`JsonFlatAbiFragmentArgumentType`](JsonFlatAbiFragmentArgumentType.md)\> - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L64) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentLoggedType.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentLoggedType.md deleted file mode 100644 index 74ef61ebaf3..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentLoggedType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentLoggedType -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentLoggedType - -[@fuel-ts/abi-coder](../index.md).JsonFlatAbiFragmentLoggedType - -## Properties - -### logId - -• `Readonly` **logId**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:51](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L51) - -___ - -### loggedType - -• `Readonly` **loggedType**: [`JsonFlatAbiFragmentArgumentType`](JsonFlatAbiFragmentArgumentType.md) - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:52](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L52) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentType.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentType.md deleted file mode 100644 index 0de7137a099..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFlatAbiFragmentType.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentType -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentType - -[@fuel-ts/abi-coder](../index.md).JsonFlatAbiFragmentType - -## Properties - -### components - -• `Optional` `Readonly` **components**: ``null`` \| readonly [`JsonFlatAbiFragmentArgumentType`](JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L46) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L45) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L44) - -___ - -### typeId - -• `Readonly` **typeId**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L43) - -___ - -### typeParameters - -• `Optional` `Readonly` **typeParameters**: ``null`` \| readonly `number`[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L47) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/internal-AttributeType.md b/docs/packages/fuel-ts-abi-coder/interfaces/internal-AttributeType.md deleted file mode 100644 index a4755bc9148..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/internal-AttributeType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: AttributeType -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: AttributeType - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).AttributeType - -## Properties - -### arguments - -• `Readonly` **arguments**: readonly `string`[] - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L5) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L4) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNHelper.md deleted file mode 100644 index 6209bbb189e..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index 29509b7c5c3..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../namespaces/internal.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/internal-BN.md) ; `mod`: [`BN`](../classes/internal-BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/internal-BN.md) | -| `mod` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/internal-BN.md), `out`: [`BN`](../classes/internal-BN.md)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/internal-BN.md) | -| `out` | [`BN`](../classes/internal-BN.md) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index e7a18b0e90f..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNOverrides.md deleted file mode 100644 index c4b40d70587..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/internal-FragmentParams.md b/docs/packages/fuel-ts-abi-coder/interfaces/internal-FragmentParams.md deleted file mode 100644 index af36e522b70..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/internal-FragmentParams.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: FragmentParams -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: FragmentParams - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).FragmentParams - -## Properties - -### attributes - -• `Readonly` **attributes**: readonly [`AttributeType`](internal-AttributeType.md)[] - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L13) - -___ - -### inputs - -• `Readonly` **inputs**: [`ParamType`](../classes/internal-ParamType.md)[] - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L11) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L10) - -___ - -### outputs - -• `Readonly` **outputs**: [`ParamType`](../classes/internal-ParamType.md)[] - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L12) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/fragments/fragment.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L9) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/internal-JsonFragmentType.md b/docs/packages/fuel-ts-abi-coder/interfaces/internal-JsonFragmentType.md deleted file mode 100644 index bffd45d31e3..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/internal-JsonFragmentType.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: JsonFragmentType -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: JsonFragmentType - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).JsonFragmentType - -## Properties - -### components - -• `Optional` `Readonly` **components**: readonly [`JsonFragmentType`](internal-JsonFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L8) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L6) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L7) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: readonly [`JsonFragmentType`](internal-JsonFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L9) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/internal-ParamTypeProps.md b/docs/packages/fuel-ts-abi-coder/interfaces/internal-ParamTypeProps.md deleted file mode 100644 index b2ac8cff2ff..00000000000 --- a/docs/packages/fuel-ts-abi-coder/interfaces/internal-ParamTypeProps.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: default -title: ParamTypeProps -parent: "@fuel-ts/abi-coder" -nav_order: 2 - ---- - -# Interface: ParamTypeProps - -[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).ParamTypeProps - -## Implemented by - -- [`ParamType`](../classes/internal-ParamType.md) - -## Properties - -### components - -• `Optional` `Readonly` **components**: [`ParamType`](../classes/internal-ParamType.md)[] - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L29) - -___ - -### isParamType - -• `Optional` `Readonly` **isParamType**: `boolean` - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L36) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L23) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L26) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: [`ParamType`](../classes/internal-ParamType.md)[] - -#### Defined in - -[packages/abi-coder/src/fragments/param-type.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/param-type.ts#L33) diff --git a/docs/packages/fuel-ts-abi-coder/namespaces/internal.md b/docs/packages/fuel-ts-abi-coder/namespaces/internal.md deleted file mode 100644 index e48deb62bb0..00000000000 --- a/docs/packages/fuel-ts-abi-coder/namespaces/internal.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/abi-coder" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/abi-coder](../index.md).internal - -## Classes - -- [BN](../classes/internal-BN.md) -- [ParamType](../classes/internal-ParamType.md) - -## Interfaces - -- [AttributeType](../interfaces/internal-AttributeType.md) -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) -- [FragmentParams](../interfaces/internal-FragmentParams.md) -- [JsonFragmentType](../interfaces/internal-JsonFragmentType.md) -- [ParamTypeProps](../interfaces/internal-ParamTypeProps.md) - -## Type Aliases - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) - -___ - -### DecodedValueOf - -Ƭ **DecodedValueOf**<`TCoder`\>: [`TypesOfCoder`](../index.md#typesofcoder)<`TCoder`\>[``"Decoded"``][] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoder` | extends [`Coder`](../classes/Coder.md) | - -#### Defined in - -[packages/abi-coder/src/coders/array.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L7) - -___ - -### DecodedValueOf - -Ƭ **DecodedValueOf**<`TCoders`\>: `RequireExactlyOne`<{ [P in keyof TCoders]: TypesOfCoder["Decoded"] }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, [`Coder`](../classes/Coder.md)\> | - -#### Defined in - -[packages/abi-coder/src/coders/enum.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/enum.ts#L12) - -___ - -### DecodedValueOf - -Ƭ **DecodedValueOf**<`TCoders`\>: { [P in keyof TCoders]: TypesOfCoder["Decoded"] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, [`Coder`](../classes/Coder.md)\> | - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L10) - -___ - -### DecodedValueOf - -Ƭ **DecodedValueOf**<`TCoders`\>: { [P in keyof TCoders]: TypesOfCoder["Decoded"] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends [`Coder`](../classes/Coder.md)[] | - -#### Defined in - -[packages/abi-coder/src/coders/tuple.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L9) - -___ - -### DecodedValueOf - -Ƭ **DecodedValueOf**<`TCoder`\>: [`TypesOfCoder`](../index.md#typesofcoder)<`TCoder`\>[``"Decoded"``][] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoder` | extends [`Coder`](../classes/Coder.md) | - -#### Defined in - -[packages/abi-coder/src/coders/vec.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/vec.ts#L12) - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](internal.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### InputValueOf - -Ƭ **InputValueOf**<`TCoder`\>: [`TypesOfCoder`](../index.md#typesofcoder)<`TCoder`\>[``"Input"``][] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoder` | extends [`Coder`](../classes/Coder.md) | - -#### Defined in - -[packages/abi-coder/src/coders/array.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L6) - -___ - -### InputValueOf - -Ƭ **InputValueOf**<`TCoders`\>: `RequireExactlyOne`<{ [P in keyof TCoders]: TypesOfCoder["Input"] }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, [`Coder`](../classes/Coder.md)\> | - -#### Defined in - -[packages/abi-coder/src/coders/enum.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/enum.ts#L9) - -___ - -### InputValueOf - -Ƭ **InputValueOf**<`TCoders`\>: { [P in keyof TCoders]: TypesOfCoder["Input"] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, [`Coder`](../classes/Coder.md)\> | - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L7) - -___ - -### InputValueOf - -Ƭ **InputValueOf**<`TCoders`\>: { [P in keyof TCoders]: TypesOfCoder["Input"] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends [`Coder`](../classes/Coder.md)[] | - -#### Defined in - -[packages/abi-coder/src/coders/tuple.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L6) - -___ - -### InputValueOf - -Ƭ **InputValueOf**<`TCoder`\>: [`TypesOfCoder`](../index.md#typesofcoder)<`TCoder`\>[``"Input"``][] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoder` | extends [`Coder`](../classes/Coder.md) | - -#### Defined in - -[packages/abi-coder/src/coders/vec.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/vec.ts#L11) - -___ - -### NumberCoderType - -Ƭ **NumberCoderType**: ``"u8"`` \| ``"u16"`` \| ``"u32"`` - -#### Defined in - -[packages/abi-coder/src/coders/number.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L5) - -___ - -### Option - -Ƭ **Option**<`T`\>: `T` \| `undefined` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[packages/abi-coder/src/coders/option.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/option.ts#L6) - -___ - -### Primitive - -Ƭ **Primitive**: `string` \| `number` \| `boolean` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L10) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) diff --git a/docs/packages/fuel-ts-address/classes/Address.md b/docs/packages/fuel-ts-address/classes/Address.md deleted file mode 100644 index c29fad59918..00000000000 --- a/docs/packages/fuel-ts-address/classes/Address.md +++ /dev/null @@ -1,360 +0,0 @@ ---- -layout: default -title: Address -parent: "@fuel-ts/address" -nav_order: 1 - ---- - -# Class: Address - -[@fuel-ts/address](../index.md).Address - -## Hierarchy - -- [`AbstractAddress`](internal-AbstractAddress.md) - - ↳ **`Address`** - -## Constructors - -### constructor - -• **new Address**(`address`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | \`fuel${string}\` | - -#### Overrides - -[AbstractAddress](internal-AbstractAddress.md).[constructor](internal-AbstractAddress.md#constructor) - -#### Defined in - -[packages/address/src/address.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L23) - -## Properties - -### bech32Address - -• `Readonly` **bech32Address**: \`fuel${string}\` - -#### Defined in - -[packages/address/src/address.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L21) - -## Methods - -### equals - -▸ **equals**(`other`): `boolean` - -Compare this Address value to another for direct equality - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `other` | [`Address`](Address.md) | the other address to compare against | - -#### Returns - -`boolean` - -true if addresses are equal - -#### Overrides - -[AbstractAddress](internal-AbstractAddress.md).[equals](internal-AbstractAddress.md#equals) - -#### Defined in - -[packages/address/src/address.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L90) - -___ - -### toAddress - -▸ **toAddress**(): \`fuel${string}\` - -#### Returns - -\`fuel${string}\` - -This address as a Bech32m string - -#### Overrides - -[AbstractAddress](internal-AbstractAddress.md).[toAddress](internal-AbstractAddress.md#toaddress) - -#### Defined in - -[packages/address/src/address.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L36) - -___ - -### toB256 - -▸ **toB256**(): `string` - -#### Returns - -`string` - -This address as 256 bit hash string - -#### Overrides - -[AbstractAddress](internal-AbstractAddress.md).[toB256](internal-AbstractAddress.md#tob256) - -#### Defined in - -[packages/address/src/address.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L43) - -___ - -### toBytes - -▸ **toBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -Returns this address as a byte array - -#### Overrides - -[AbstractAddress](internal-AbstractAddress.md).[toBytes](internal-AbstractAddress.md#tobytes) - -#### Defined in - -[packages/address/src/address.ts:50](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L50) - -___ - -### toHexString - -▸ **toHexString**(): `string` - -#### Returns - -`string` - -This address as hexed 256 bit hash string - -#### Overrides - -[AbstractAddress](internal-AbstractAddress.md).[toHexString](internal-AbstractAddress.md#tohexstring) - -#### Defined in - -[packages/address/src/address.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L57) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -Parses this Address value - -#### Returns - -`string` - -a string address in Bech32m Format - -#### Overrides - -[AbstractAddress](internal-AbstractAddress.md).[toJSON](internal-AbstractAddress.md#tojson) - -#### Defined in - -[packages/address/src/address.ts:73](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L73) - -___ - -### toString - -▸ **toString**(): `string` - -Prints this Address value - -#### Returns - -`string` - -a string address in Bech32m Format - -#### Overrides - -[AbstractAddress](internal-AbstractAddress.md).[toString](internal-AbstractAddress.md#tostring) - -#### Defined in - -[packages/address/src/address.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L65) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -Returns the value of this Address value - -#### Returns - -`string` - -a string address in Bech32m Format - -#### Defined in - -[packages/address/src/address.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L81) - -___ - -### fromAddressOrString - -▸ `Static` **fromAddressOrString**(`address`): [`AbstractAddress`](internal-AbstractAddress.md) - -Takes an ambiguous string or address and creates an address - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -[`AbstractAddress`](internal-AbstractAddress.md) - -a new `Address` instance - -#### Defined in - -[packages/address/src/address.ts:133](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L133) - -___ - -### fromB256 - -▸ `Static` **fromB256**(`b256Address`): [`Address`](Address.md) - -Takes a B256Address and creates an Address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `b256Address` | `string` | the b256 hash | - -#### Returns - -[`Address`](Address.md) - -a new `Address` instance - -#### Defined in - -[packages/address/src/address.ts:109](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L109) - -___ - -### fromDynamicInput - -▸ `Static` **fromDynamicInput**(`address`): [`Address`](Address.md) - -Takes an optional string and returns back an Address - -**`Throws`** - -Error -thrown if the input string is not nilsy and cannot be resolved to a valid address format - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -[`Address`](Address.md) - -a new `Address` instance - -#### Defined in - -[packages/address/src/address.ts:145](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L145) - -___ - -### fromPublicKey - -▸ `Static` **fromPublicKey**(`publicKey`): [`Address`](Address.md) - -Takes a Public Key, hashes it, and creates an Address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `publicKey` | `string` | the wallets public key | - -#### Returns - -[`Address`](Address.md) - -a new `Address` instance - -#### Defined in - -[packages/address/src/address.ts:99](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L99) - -___ - -### fromRandom - -▸ `Static` **fromRandom**(): [`Address`](Address.md) - -Creates a random address within an Address - -#### Returns - -[`Address`](Address.md) - -a new `Address` instance - -#### Defined in - -[packages/address/src/address.ts:117](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L117) - -___ - -### fromString - -▸ `Static` **fromString**(`address`): [`Address`](Address.md) - -Takes an ambiguous string and attempts to create an Address - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -[`Address`](Address.md) - -a new `Address` instance - -#### Defined in - -[packages/address/src/address.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/address.ts#L125) diff --git a/docs/packages/fuel-ts-address/classes/internal-AbstractAccount.md b/docs/packages/fuel-ts-address/classes/internal-AbstractAccount.md deleted file mode 100644 index 1f9dae1914b..00000000000 --- a/docs/packages/fuel-ts-address/classes/internal-AbstractAccount.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -layout: default -title: AbstractAccount -parent: "@fuel-ts/address" -nav_order: 1 - ---- - -# Class: AbstractAccount - -[@fuel-ts/address](../index.md).[internal](../namespaces/internal.md).AbstractAccount - -## Constructors - -### constructor - -• **new AbstractAccount**() - -## Properties - -### address - -• `Abstract` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L26) - -___ - -### provider - -• `Abstract` **provider**: `unknown` - -#### Defined in - -[packages/interfaces/src/index.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L27) - -## Methods - -### getResourcesToSpend - -▸ `Abstract` **getResourcesToSpend**(`quantities`, `options?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | `any`[] | -| `options?` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L28) - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L29) - -___ - -### simulateTransaction - -▸ `Abstract` **simulateTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L30) diff --git a/docs/packages/fuel-ts-address/classes/internal-AbstractAddress.md b/docs/packages/fuel-ts-address/classes/internal-AbstractAddress.md deleted file mode 100644 index 7fca5c79a37..00000000000 --- a/docs/packages/fuel-ts-address/classes/internal-AbstractAddress.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -layout: default -title: AbstractAddress -parent: "@fuel-ts/address" -nav_order: 1 - ---- - -# Class: AbstractAddress - -[@fuel-ts/address](../index.md).[internal](../namespaces/internal.md).AbstractAddress - -## Hierarchy - -- **`AbstractAddress`** - - ↳ [`Address`](Address.md) - -## Constructors - -### constructor - -• **new AbstractAddress**() - -## Methods - -### equals - -▸ `Abstract` **equals**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/interfaces/src/index.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L21) - -___ - -### toAddress - -▸ `Abstract` **toAddress**(): \`fuel${string}\` - -#### Returns - -\`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L17) - -___ - -### toB256 - -▸ `Abstract` **toB256**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L18) - -___ - -### toBytes - -▸ `Abstract` **toBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L20) - -___ - -### toHexString - -▸ `Abstract` **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L19) - -___ - -### toJSON - -▸ `Abstract` **toJSON**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L15) - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L16) diff --git a/docs/packages/fuel-ts-address/classes/internal-AbstractContract.md b/docs/packages/fuel-ts-address/classes/internal-AbstractContract.md deleted file mode 100644 index fcaf92f5f2b..00000000000 --- a/docs/packages/fuel-ts-address/classes/internal-AbstractContract.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: default -title: AbstractContract -parent: "@fuel-ts/address" -nav_order: 1 - ---- - -# Class: AbstractContract - -[@fuel-ts/address](../index.md).[internal](../namespaces/internal.md).AbstractContract - -## Hierarchy - -- [`AbstractProgram`](internal-AbstractProgram.md) - - ↳ **`AbstractContract`** - -## Constructors - -### constructor - -• **new AbstractContract**() - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[constructor](internal-AbstractProgram.md#constructor) - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[account](internal-AbstractProgram.md#account) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### id - -• `Abstract` **id**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L48) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[interface](internal-AbstractProgram.md#interface) - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[provider](internal-AbstractProgram.md#provider) - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-address/classes/internal-AbstractProgram.md b/docs/packages/fuel-ts-address/classes/internal-AbstractProgram.md deleted file mode 100644 index ef223856ff1..00000000000 --- a/docs/packages/fuel-ts-address/classes/internal-AbstractProgram.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: AbstractProgram -parent: "@fuel-ts/address" -nav_order: 1 - ---- - -# Class: AbstractProgram - -[@fuel-ts/address](../index.md).[internal](../namespaces/internal.md).AbstractProgram - -## Hierarchy - -- **`AbstractProgram`** - - ↳ [`AbstractContract`](internal-AbstractContract.md) - -## Constructors - -### constructor - -• **new AbstractProgram**() - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-address/index.md b/docs/packages/fuel-ts-address/index.md deleted file mode 100644 index 4e6cbcc0e30..00000000000 --- a/docs/packages/fuel-ts-address/index.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -layout: default -title: "@fuel-ts/address" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/address - -## Namespaces - -- [internal](namespaces/internal.md) - -## Classes - -- [Address](classes/Address.md) - -## Variables - -### FUEL\_BECH32\_HRP\_PREFIX - -• `Const` **FUEL\_BECH32\_HRP\_PREFIX**: ``"fuel"`` - -#### Defined in - -[packages/address/src/utils.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L20) - -## Functions - -### addressify - -▸ **addressify**(`addressLike`): [`AbstractAddress`](classes/internal-AbstractAddress.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addressLike` | [`AbstractAddress`](classes/internal-AbstractAddress.md) \| [`AbstractAccount`](classes/internal-AbstractAccount.md) \| [`AbstractContract`](classes/internal-AbstractContract.md) | - -#### Returns - -[`AbstractAddress`](classes/internal-AbstractAddress.md) - -#### Defined in - -[packages/address/src/utils.ts:93](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L93) - -___ - -### fromBech32 - -▸ **fromBech32**(`address`): `Decoded` - -Decodes a Bech32 address string into Decoded - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | \`fuel${string}\` | - -#### Returns - -`Decoded` - -#### Defined in - -[packages/address/src/utils.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L25) - -___ - -### getBytesFromBech32 - -▸ **getBytesFromBech32**(`address`): `Uint8Array` - -Takes a Bech32 address and returns the byte data - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | \`fuel${string}\` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/address/src/utils.ts:67](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L67) - -___ - -### getRandomB256 - -▸ **getRandomB256**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/address/src/utils.ts:105](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L105) - -___ - -### isB256 - -▸ **isB256**(`address`): `boolean` - -Determines if a given string is B256 format - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/address/src/utils.ts:53](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L53) - -___ - -### isBech32 - -▸ **isBech32**(`address`): `boolean` - -Determines if a given string is Bech32 format - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `BytesLike` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/address/src/utils.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L42) - -___ - -### isPublicKey - -▸ **isPublicKey**(`address`): `boolean` - -Determines if a given string is in Public Key format (512 bits) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/address/src/utils.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L60) - -___ - -### normalizeBech32 - -▸ **normalizeBech32**(`address`): [`Bech32Address`](namespaces/internal.md#bech32address) - -Takes a Bech32 address and returns a normalized (i.e. lower case) representation of it. - -The input is validated along the way, which makes this significantly safer than -using `address.toLowerCase()`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | \`fuel${string}\` | - -#### Returns - -[`Bech32Address`](namespaces/internal.md#bech32address) - -#### Defined in - -[packages/address/src/utils.ts:88](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L88) - -___ - -### toB256 - -▸ **toB256**(`address`): [`B256Address`](namespaces/internal.md#b256address) - -Converts a Bech32 address string into B256 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | \`fuel${string}\` | - -#### Returns - -[`B256Address`](namespaces/internal.md#b256address) - -#### Defined in - -[packages/address/src/utils.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L74) - -___ - -### toBech32 - -▸ **toBech32**(`address`): [`Bech32Address`](namespaces/internal.md#bech32address) - -Converts a B256 address string into Bech32 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -[`Bech32Address`](namespaces/internal.md#bech32address) - -#### Defined in - -[packages/address/src/utils.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/address/src/utils.ts#L32) diff --git a/docs/packages/fuel-ts-address/namespaces/internal.md b/docs/packages/fuel-ts-address/namespaces/internal.md deleted file mode 100644 index 53c2ed45afd..00000000000 --- a/docs/packages/fuel-ts-address/namespaces/internal.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/address" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/address](../index.md).internal - -## Classes - -- [AbstractAccount](../classes/internal-AbstractAccount.md) -- [AbstractAddress](../classes/internal-AbstractAddress.md) -- [AbstractContract](../classes/internal-AbstractContract.md) -- [AbstractProgram](../classes/internal-AbstractProgram.md) - -## Type Aliases - -### B256Address - -Ƭ **B256Address**: `string` - -#### Defined in - -[packages/interfaces/src/index.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L6) - -___ - -### Bech32Address - -Ƭ **Bech32Address**: \`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L4) diff --git a/docs/packages/fuel-ts-constants/index.md b/docs/packages/fuel-ts-constants/index.md deleted file mode 100644 index 60871720fbc..00000000000 --- a/docs/packages/fuel-ts-constants/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default -title: "@fuel-ts/constants" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/constants - -## Variables - -### EmptyRoot - -• `Const` **EmptyRoot**: ``"0xe3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"`` - -#### Defined in - -[packages/constants/src/index.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/constants/src/index.ts#L3) - -___ - -### NativeAssetId - -• `Const` **NativeAssetId**: ``"0x0000000000000000000000000000000000000000000000000000000000000000"`` - -#### Defined in - -[packages/constants/src/index.ts:2](https://github.com/FuelLabs/fuels-ts/blob/master/packages/constants/src/index.ts#L2) - -___ - -### ZeroBytes32 - -• `Const` **ZeroBytes32**: ``"0x0000000000000000000000000000000000000000000000000000000000000000"`` - -#### Defined in - -[packages/constants/src/index.ts:1](https://github.com/FuelLabs/fuels-ts/blob/master/packages/constants/src/index.ts#L1) diff --git a/docs/packages/fuel-ts-contract/classes/ContractFactory.md b/docs/packages/fuel-ts-contract/classes/ContractFactory.md deleted file mode 100644 index 853aad8686e..00000000000 --- a/docs/packages/fuel-ts-contract/classes/ContractFactory.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -layout: default -title: ContractFactory -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: ContractFactory - -[@fuel-ts/contract](../index.md).ContractFactory - -## Constructors - -### constructor - -• **new ContractFactory**(`bytecode`, `abi`, `accountOrProvider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `bytecode` | `BytesLike` | `undefined` | -| `abi` | [`JsonAbi`](../namespaces/internal.md#jsonabi) \| `default` | `undefined` | -| `accountOrProvider` | ``null`` \| `default` \| [`Account`](internal-Account.md) | `null` | - -#### Defined in - -[packages/contract/src/contract-factory.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L31) - -## Properties - -### account - -• **account**: ``null`` \| [`Account`](internal-Account.md) - -#### Defined in - -[packages/contract/src/contract-factory.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L29) - -___ - -### bytecode - -• **bytecode**: `BytesLike` - -#### Defined in - -[packages/contract/src/contract-factory.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L26) - -___ - -### interface - -• **interface**: `default` - -#### Defined in - -[packages/contract/src/contract-factory.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L27) - -___ - -### provider - -• **provider**: ``null`` \| `default` - -#### Defined in - -[packages/contract/src/contract-factory.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L28) - -## Methods - -### connect - -▸ **connect**(`provider`): [`ContractFactory`](ContractFactory.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | ``null`` \| `default` | - -#### Returns - -[`ContractFactory`](ContractFactory.md) - -#### Defined in - -[packages/contract/src/contract-factory.ts:67](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L67) - -___ - -### createTransactionRequest - -▸ **createTransactionRequest**(`deployContractOptions?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deployContractOptions?` | [`DeployContractOptions`](../namespaces/internal.md#deploycontractoptions) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `contractId` | `string` | -| `transactionRequest` | [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) | - -#### Defined in - -[packages/contract/src/contract-factory.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L71) - -___ - -### deployContract - -▸ **deployContract**(`deployContractOptions?`): `Promise`<`default`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `deployContractOptions?` | [`DeployContractOptions`](../namespaces/internal.md#deploycontractoptions) | - -#### Returns - -`Promise`<`default`\> - -#### Defined in - -[packages/contract/src/contract-factory.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L102) diff --git a/docs/packages/fuel-ts-contract/classes/internal-AbstractAccount.md b/docs/packages/fuel-ts-contract/classes/internal-AbstractAccount.md deleted file mode 100644 index 0adba826183..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-AbstractAccount.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -layout: default -title: AbstractAccount -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: AbstractAccount - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).AbstractAccount - -## Hierarchy - -- **`AbstractAccount`** - - ↳ [`Account`](internal-Account.md) - -## Constructors - -### constructor - -• **new AbstractAccount**() - -## Properties - -### address - -• `Abstract` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L26) - -___ - -### provider - -• `Abstract` **provider**: `unknown` - -#### Defined in - -[packages/interfaces/src/index.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L27) - -## Methods - -### getResourcesToSpend - -▸ `Abstract` **getResourcesToSpend**(`quantities`, `options?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | `any`[] | -| `options?` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L28) - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L29) - -___ - -### simulateTransaction - -▸ `Abstract` **simulateTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L30) diff --git a/docs/packages/fuel-ts-contract/classes/internal-AbstractAddress.md b/docs/packages/fuel-ts-contract/classes/internal-AbstractAddress.md deleted file mode 100644 index 5237ae84229..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-AbstractAddress.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: default -title: AbstractAddress -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: AbstractAddress - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).AbstractAddress - -## Constructors - -### constructor - -• **new AbstractAddress**() - -## Methods - -### equals - -▸ `Abstract` **equals**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/interfaces/src/index.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L21) - -___ - -### toAddress - -▸ `Abstract` **toAddress**(): \`fuel${string}\` - -#### Returns - -\`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L17) - -___ - -### toB256 - -▸ `Abstract` **toB256**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L18) - -___ - -### toBytes - -▸ `Abstract` **toBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L20) - -___ - -### toHexString - -▸ `Abstract` **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L19) - -___ - -### toJSON - -▸ `Abstract` **toJSON**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L15) - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L16) diff --git a/docs/packages/fuel-ts-contract/classes/internal-AbstractContract.md b/docs/packages/fuel-ts-contract/classes/internal-AbstractContract.md deleted file mode 100644 index f9ce5fc188a..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-AbstractContract.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: default -title: AbstractContract -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: AbstractContract - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).AbstractContract - -## Hierarchy - -- [`AbstractProgram`](internal-AbstractProgram.md) - - ↳ **`AbstractContract`** - -## Constructors - -### constructor - -• **new AbstractContract**() - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[constructor](internal-AbstractProgram.md#constructor) - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[account](internal-AbstractProgram.md#account) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### id - -• `Abstract` **id**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L48) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[interface](internal-AbstractProgram.md#interface) - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[provider](internal-AbstractProgram.md#provider) - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-contract/classes/internal-AbstractProgram.md b/docs/packages/fuel-ts-contract/classes/internal-AbstractProgram.md deleted file mode 100644 index abed342adfc..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-AbstractProgram.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: AbstractProgram -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: AbstractProgram - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).AbstractProgram - -## Hierarchy - -- **`AbstractProgram`** - - ↳ [`AbstractContract`](internal-AbstractContract.md) - -## Constructors - -### constructor - -• **new AbstractProgram**() - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-contract/classes/internal-AbstractScriptRequest.md b/docs/packages/fuel-ts-contract/classes/internal-AbstractScriptRequest.md deleted file mode 100644 index db2a33f13f5..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-AbstractScriptRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default -title: AbstractScriptRequest -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: AbstractScriptRequest - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).AbstractScriptRequest - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Constructors - -### constructor - -• **new AbstractScriptRequest**<`T`\>() - -#### Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### bytes - -• `Abstract` **bytes**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L9) - -___ - -### encodeScriptData - -• `Abstract` **encodeScriptData**: (`data`: `T`) => `Uint8Array` - -#### Type declaration - -▸ (`data`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L10) diff --git a/docs/packages/fuel-ts-contract/classes/internal-Account.md b/docs/packages/fuel-ts-contract/classes/internal-Account.md deleted file mode 100644 index 4d834ea10f1..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-Account.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -layout: default -title: Account -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: Account - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).Account - -Account - -## Hierarchy - -- [`AbstractAccount`](internal-AbstractAccount.md) - - ↳ **`Account`** - -## Constructors - -### constructor - -• **new Account**(`address`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[constructor](internal-AbstractAccount.md#constructor) - -#### Defined in - -[packages/wallet/src/account.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L39) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[address](internal-AbstractAccount.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[provider](internal-AbstractAccount.md#provider) - -#### Defined in - -[packages/wallet/src/account.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[getResourcesToSpend](internal-AbstractAccount.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[sendTransaction](internal-AbstractAccount.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/account.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L253) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[simulateTransaction](internal-AbstractAccount.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/account.ts:267](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L267) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-contract/classes/internal-BN.md b/docs/packages/fuel-ts-contract/classes/internal-BN.md deleted file mode 100644 index 727b792a937..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../namespaces/internal.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](internal-BN.md) | -| `mod` | [`BN`](internal-BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](internal-BN.md) | -| `b` | [`BN`](internal-BN.md) | -| `gcd` | [`BN`](internal-BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../namespaces/internal.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](internal-BN.md) | -| `out` | [`BN`](internal-BN.md) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-contract/classes/internal-BaseTransactionRequest.md b/docs/packages/fuel-ts-contract/classes/internal-BaseTransactionRequest.md deleted file mode 100644 index 33110023b43..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-BaseTransactionRequest.md +++ /dev/null @@ -1,526 +0,0 @@ ---- -layout: default -title: BaseTransactionRequest -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: BaseTransactionRequest - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequest - -## Hierarchy - -- **`BaseTransactionRequest`** - - ↳ [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - - ↳ [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -## Implements - -- [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) - -## Constructors - -### constructor - -• **new BaseTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) | - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L131) - -## Properties - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasLimit](../interfaces/internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasPrice](../interfaces/internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[inputs](../interfaces/internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[maturity](../interfaces/internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[outputs](../interfaces/internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### type - -• `Abstract` **type**: [`TransactionType`](../enums/internal-TransactionType.md) - -Type of the transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:117](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L117) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[witnesses](../interfaces/internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ `Abstract` **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:167](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L167) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) diff --git a/docs/packages/fuel-ts-contract/classes/internal-CreateTransactionRequest.md b/docs/packages/fuel-ts-contract/classes/internal-CreateTransactionRequest.md deleted file mode 100644 index c77289414c6..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-CreateTransactionRequest.md +++ /dev/null @@ -1,703 +0,0 @@ ---- -layout: default -title: CreateTransactionRequest -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: CreateTransactionRequest - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`CreateTransactionRequest`** - -## Constructors - -### constructor - -• **new CreateTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:528](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L528) - -## Properties - -### bytecodeWitnessIndex - -• **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:522](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L522) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### salt - -• **salt**: `string` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:524](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L524) - -___ - -### storageSlots - -• **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:526](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L526) - -___ - -### type - -• **type**: [`Create`](../namespaces/internal.md#create) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:520](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L520) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContractCreatedOutput - -▸ **addContractCreatedOutput**(`contractId`, `stateRoot`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:562](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L562) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractCreatedOutputs - -▸ **getContractCreatedOutputs**(): [`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Returns - -[`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:555](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L555) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:540](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L540) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Returns - -[`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:512](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L512) diff --git a/docs/packages/fuel-ts-contract/classes/internal-ScriptTransactionRequest.md b/docs/packages/fuel-ts-contract/classes/internal-ScriptTransactionRequest.md deleted file mode 100644 index 11604d15178..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-ScriptTransactionRequest.md +++ /dev/null @@ -1,797 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequest -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: ScriptTransactionRequest - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`ScriptTransactionRequest`** - -## Constructors - -### constructor - -• **new ScriptTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:406](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L406) - -## Properties - -### bytesOffset - -• **bytesOffset**: `undefined` \| `number` - -determined bytes offset for start of script data - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:404](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L404) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### script - -• **script**: `Uint8Array` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:400](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L400) - -___ - -### scriptData - -• **scriptData**: `Uint8Array` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:402](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L402) - -___ - -### type - -• **type**: [`Script`](../enums/internal-TransactionType.md#script) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:398](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L398) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContract - -▸ **addContract**(`contract`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | [`ContractIdLike`](../namespaces/internal.md#contractidlike) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:481](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L481) - -___ - -### addMessageOutputs - -▸ **addMessageOutputs**(`numberOfMessages?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfMessages` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:466](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L466) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### addVariableOutputs - -▸ **addVariableOutputs**(`numberOfVariables?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfVariables` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:453](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L453) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractInputs - -▸ **getContractInputs**(): [`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Returns - -[`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:426](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L426) - -___ - -### getContractOutputs - -▸ **getContractOutputs**(): [`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Returns - -[`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:432](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L432) - -___ - -### getVariableOutputs - -▸ **getVariableOutputs**(): [`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Returns - -[`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:438](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L438) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### setScript - -▸ **setScript**<`T`\>(`script`, `data`): `void` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `script` | [`AbstractScriptRequest`](internal-AbstractScriptRequest.md)<`T`\> | -| `data` | `T` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:444](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L444) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:412](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L412) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Returns - -[`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:390](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L390) diff --git a/docs/packages/fuel-ts-contract/classes/internal-TransactionResponse.md b/docs/packages/fuel-ts-contract/classes/internal-TransactionResponse.md deleted file mode 100644 index f9a18c34227..00000000000 --- a/docs/packages/fuel-ts-contract/classes/internal-TransactionResponse.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -layout: default -title: TransactionResponse -parent: "@fuel-ts/contract" -nav_order: 1 - ---- - -# Class: TransactionResponse - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).TransactionResponse - -## Constructors - -### constructor - -• **new TransactionResponse**(`id`, `provider`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `provider` | `default` | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L102) - -## Properties - -### attempts - -• **attempts**: `number` = `0` - -Number off attempts to get the committed tx - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L100) - -___ - -### gasUsed - -• **gasUsed**: [`BN`](internal-BN.md) - -Gas used on the transaction - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L98) - -___ - -### id - -• **id**: `string` - -Transaction ID - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L94) - -___ - -### provider - -• **provider**: `default` - -Current provider - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L96) - -## Methods - -### decodeTransaction - -▸ **decodeTransaction**<`TTransactionType`\>(`transactionWithReceipts`): [`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionWithReceipts` | `Object` | -| `transactionWithReceipts.__typename` | ``"Transaction"`` | -| `transactionWithReceipts.gasPrice?` | ``null`` \| `string` | -| `transactionWithReceipts.id` | `string` | -| `transactionWithReceipts.rawPayload` | `string` | -| `transactionWithReceipts.receipts?` | ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] | -| `transactionWithReceipts.status?` | ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } | - -#### Returns - -[`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:114](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L114) - -___ - -### fetch - -▸ **fetch**(): `Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Returns - -`Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L107) - -___ - -### wait - -▸ **wait**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -Waits for transaction to succeed and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:188](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L188) - -___ - -### waitForResult - -▸ **waitForResult**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -Waits for transaction to succeed or fail and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:124](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L124) diff --git a/docs/packages/fuel-ts-contract/enums/internal-GqlCoinStatus.md b/docs/packages/fuel-ts-contract/enums/internal-GqlCoinStatus.md deleted file mode 100644 index 522a547d2dc..00000000000 --- a/docs/packages/fuel-ts-contract/enums/internal-GqlCoinStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlCoinStatus -parent: "@fuel-ts/contract" -nav_order: 4 - ---- - -# Enumeration: GqlCoinStatus - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).GqlCoinStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:157 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:158 diff --git a/docs/packages/fuel-ts-contract/enums/internal-GqlMessageStatus.md b/docs/packages/fuel-ts-contract/enums/internal-GqlMessageStatus.md deleted file mode 100644 index 2b4ebdaecc7..00000000000 --- a/docs/packages/fuel-ts-contract/enums/internal-GqlMessageStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlMessageStatus -parent: "@fuel-ts/contract" -nav_order: 4 - ---- - -# Enumeration: GqlMessageStatus - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).GqlMessageStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:373 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:374 diff --git a/docs/packages/fuel-ts-contract/enums/internal-GqlReturnType.md b/docs/packages/fuel-ts-contract/enums/internal-GqlReturnType.md deleted file mode 100644 index f76f427e58c..00000000000 --- a/docs/packages/fuel-ts-contract/enums/internal-GqlReturnType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: GqlReturnType -parent: "@fuel-ts/contract" -nav_order: 4 - ---- - -# Enumeration: GqlReturnType - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).GqlReturnType - -## Enumeration Members - -### Return - -• **Return** = ``"RETURN"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:688 - -___ - -### ReturnData - -• **ReturnData** = ``"RETURN_DATA"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:689 - -___ - -### Revert - -• **Revert** = ``"REVERT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:690 diff --git a/docs/packages/fuel-ts-contract/enums/internal-TransactionType.md b/docs/packages/fuel-ts-contract/enums/internal-TransactionType.md deleted file mode 100644 index 0ab3898ca85..00000000000 --- a/docs/packages/fuel-ts-contract/enums/internal-TransactionType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: TransactionType -parent: "@fuel-ts/contract" -nav_order: 4 - ---- - -# Enumeration: TransactionType - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).TransactionType - -## Enumeration Members - -### Create - -• **Create** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Mint - -• **Mint** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L22) - -___ - -### Script - -• **Script** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) diff --git a/docs/packages/fuel-ts-contract/index.md b/docs/packages/fuel-ts-contract/index.md deleted file mode 100644 index ad5613f2b11..00000000000 --- a/docs/packages/fuel-ts-contract/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: default -title: "@fuel-ts/contract" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/contract - -## Namespaces - -- [ContractUtils](namespaces/ContractUtils.md) -- [internal](namespaces/internal.md) - -## Classes - -- [ContractFactory](classes/ContractFactory.md) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-contract/interfaces/internal-BNHelper.md deleted file mode 100644 index 163dfd5bbb9..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-contract/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index 93afae8b682..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../namespaces/internal.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/internal-BN.md) ; `mod`: [`BN`](../classes/internal-BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/internal-BN.md) | -| `mod` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/internal-BN.md), `out`: [`BN`](../classes/internal-BN.md)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/internal-BN.md) | -| `out` | [`BN`](../classes/internal-BN.md) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-contract/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index f6a8dc9b0c3..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-contract/interfaces/internal-BNOverrides.md deleted file mode 100644 index 34d7ed7af08..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-BaseTransactionRequestLike.md b/docs/packages/fuel-ts-contract/interfaces/internal-BaseTransactionRequestLike.md deleted file mode 100644 index f5fddce21a1..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-BaseTransactionRequestLike.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -layout: default -title: BaseTransactionRequestLike -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: BaseTransactionRequestLike - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequestLike - -## Hierarchy - -- **`BaseTransactionRequestLike`** - - ↳ [`CreateTransactionRequestLike`](internal-CreateTransactionRequestLike.md) - - ↳ [`ScriptTransactionRequestLike`](internal-ScriptTransactionRequestLike.md) - -## Implemented by - -- [`BaseTransactionRequest`](../classes/internal-BaseTransactionRequest.md) - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-CreateTransactionRequestLike.md b/docs/packages/fuel-ts-contract/interfaces/internal-CreateTransactionRequestLike.md deleted file mode 100644 index 106cb6d5e16..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-CreateTransactionRequestLike.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -layout: default -title: CreateTransactionRequestLike -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: CreateTransactionRequestLike - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`CreateTransactionRequestLike`** - -## Properties - -### bytecodeWitnessIndex - -• `Optional` **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:504](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L504) - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### salt - -• `Optional` **salt**: `BytesLike` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:506](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L506) - -___ - -### storageSlots - -• `Optional` **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:508](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L508) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFragment.md b/docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFragment.md deleted file mode 100644 index 15a1c4c5950..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFragment.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: JsonAbiFragment -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: JsonAbiFragment - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).JsonAbiFragment - -## Properties - -### attributes - -• `Optional` `Readonly` **attributes**: readonly [`JsonAbiFunctionAttributeType`](internal-JsonAbiFunctionAttributeType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L33) - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L31) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L30) - -___ - -### outputs - -• `Optional` `Readonly` **outputs**: readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L32) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L24) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFragmentType.md b/docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFragmentType.md deleted file mode 100644 index 0c3d18c0dcb..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFragmentType.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: JsonAbiFragmentType -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: JsonAbiFragmentType - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).JsonAbiFragmentType - -## Properties - -### components - -• `Optional` `Readonly` **components**: ``null`` \| readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L14) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L12) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L11) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: ``null`` \| readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L15) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFunctionAttributeType.md b/docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFunctionAttributeType.md deleted file mode 100644 index ac2dd63dbb2..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-JsonAbiFunctionAttributeType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: JsonAbiFunctionAttributeType -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: JsonAbiFunctionAttributeType - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).JsonAbiFunctionAttributeType - -## Properties - -### arguments - -• `Readonly` **arguments**: readonly `string`[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L20) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L19) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbi.md b/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbi.md deleted file mode 100644 index 181c30d5f97..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbi.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: JsonFlatAbi -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: JsonFlatAbi - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).JsonFlatAbi - -## Properties - -### functions - -• `Readonly` **functions**: readonly [`JsonFlatAbiFragmentFunction`](internal-JsonFlatAbiFragmentFunction.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L71) - -___ - -### loggedTypes - -• `Readonly` **loggedTypes**: readonly [`JsonFlatAbiFragmentLoggedType`](internal-JsonFlatAbiFragmentLoggedType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:70](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L70) - -___ - -### types - -• `Readonly` **types**: readonly [`JsonFlatAbiFragmentType`](internal-JsonFlatAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:69](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L69) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentArgumentType.md b/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentArgumentType.md deleted file mode 100644 index c1c727d2b61..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentArgumentType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentArgumentType -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentArgumentType - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentArgumentType - -## Properties - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L57) - -___ - -### type - -• `Readonly` **type**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L56) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: ``null`` \| readonly [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:58](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L58) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentFunction.md b/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentFunction.md deleted file mode 100644 index 161587d3561..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentFunction.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentFunction -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentFunction - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentFunction - -## Properties - -### attributes - -• `Optional` `Readonly` **attributes**: ``null`` \| readonly [`JsonAbiFunctionAttributeType`](internal-JsonAbiFunctionAttributeType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L65) - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L63) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L62) - -___ - -### output - -• `Optional` `Readonly` **output**: `Readonly`<[`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)\> - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L64) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentLoggedType.md b/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentLoggedType.md deleted file mode 100644 index a252509d5a0..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentLoggedType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentLoggedType -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentLoggedType - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentLoggedType - -## Properties - -### logId - -• `Readonly` **logId**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:51](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L51) - -___ - -### loggedType - -• `Readonly` **loggedType**: [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md) - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:52](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L52) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentType.md b/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentType.md deleted file mode 100644 index 753aea81108..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-JsonFlatAbiFragmentType.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentType -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentType - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentType - -## Properties - -### components - -• `Optional` `Readonly` **components**: ``null`` \| readonly [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L46) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L45) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L44) - -___ - -### typeId - -• `Readonly` **typeId**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L43) - -___ - -### typeParameters - -• `Optional` `Readonly` **typeParameters**: ``null`` \| readonly `number`[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L47) diff --git a/docs/packages/fuel-ts-contract/interfaces/internal-ScriptTransactionRequestLike.md b/docs/packages/fuel-ts-contract/interfaces/internal-ScriptTransactionRequestLike.md deleted file mode 100644 index 1a7d08a525f..00000000000 --- a/docs/packages/fuel-ts-contract/interfaces/internal-ScriptTransactionRequestLike.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequestLike -parent: "@fuel-ts/contract" -nav_order: 2 - ---- - -# Interface: ScriptTransactionRequestLike - -[@fuel-ts/contract](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`ScriptTransactionRequestLike`** - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### script - -• `Optional` **script**: `BytesLike` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:384](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L384) - -___ - -### scriptData - -• `Optional` **scriptData**: `BytesLike` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:386](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L386) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-contract/namespaces/ContractUtils.md b/docs/packages/fuel-ts-contract/namespaces/ContractUtils.md deleted file mode 100644 index 46b6a6f38f0..00000000000 --- a/docs/packages/fuel-ts-contract/namespaces/ContractUtils.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -layout: default -title: ContractUtils -parent: "@fuel-ts/contract" -nav_order: 3 - ---- - -# Namespace: ContractUtils - -[@fuel-ts/contract](../index.md).ContractUtils - -## Functions - -### getContractId - -▸ **getContractId**(`bytecode`, `salt`, `stateRoot`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytecode` | `BytesLike` | -| `salt` | `BytesLike` | -| `stateRoot` | `BytesLike` | - -#### Returns - -`string` - -#### Defined in - -[packages/contract/src/util.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/util.ts#L30) - -___ - -### getContractRoot - -▸ **getContractRoot**(`bytecode`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytecode` | `BytesLike` | - -#### Returns - -`string` - -#### Defined in - -[packages/contract/src/util.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/util.ts#L8) - -___ - -### getContractStorageRoot - -▸ **getContractStorageRoot**(`storageSlots`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `storageSlots` | [`StorageSlot`](internal.md#storageslot)[] | - -#### Returns - -`string` - -#### Defined in - -[packages/contract/src/util.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/util.ts#L22) - -___ - -### includeHexPrefix - -▸ **includeHexPrefix**(`value`, `options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | -| `options?` | `DataOptions` | - -#### Returns - -`string` - -#### Defined in - -[packages/contract/src/util.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/util.ts#L40) diff --git a/docs/packages/fuel-ts-contract/namespaces/internal.md b/docs/packages/fuel-ts-contract/namespaces/internal.md deleted file mode 100644 index 01e43fb82d2..00000000000 --- a/docs/packages/fuel-ts-contract/namespaces/internal.md +++ /dev/null @@ -1,1481 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/contract" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/contract](../index.md).internal - -## Enumerations - -- [GqlCoinStatus](../enums/internal-GqlCoinStatus.md) -- [GqlMessageStatus](../enums/internal-GqlMessageStatus.md) -- [GqlReturnType](../enums/internal-GqlReturnType.md) -- [TransactionType](../enums/internal-TransactionType.md) - -## Classes - -- [AbstractAccount](../classes/internal-AbstractAccount.md) -- [AbstractAddress](../classes/internal-AbstractAddress.md) -- [AbstractContract](../classes/internal-AbstractContract.md) -- [AbstractProgram](../classes/internal-AbstractProgram.md) -- [AbstractScriptRequest](../classes/internal-AbstractScriptRequest.md) -- [Account](../classes/internal-Account.md) -- [BN](../classes/internal-BN.md) -- [BaseTransactionRequest](../classes/internal-BaseTransactionRequest.md) -- [CreateTransactionRequest](../classes/internal-CreateTransactionRequest.md) -- [ScriptTransactionRequest](../classes/internal-ScriptTransactionRequest.md) -- [TransactionResponse](../classes/internal-TransactionResponse.md) - -## Interfaces - -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) -- [BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md) -- [CreateTransactionRequestLike](../interfaces/internal-CreateTransactionRequestLike.md) -- [JsonAbiFragment](../interfaces/internal-JsonAbiFragment.md) -- [JsonAbiFragmentType](../interfaces/internal-JsonAbiFragmentType.md) -- [JsonAbiFunctionAttributeType](../interfaces/internal-JsonAbiFunctionAttributeType.md) -- [JsonFlatAbi](../interfaces/internal-JsonFlatAbi.md) -- [JsonFlatAbiFragmentArgumentType](../interfaces/internal-JsonFlatAbiFragmentArgumentType.md) -- [JsonFlatAbiFragmentFunction](../interfaces/internal-JsonFlatAbiFragmentFunction.md) -- [JsonFlatAbiFragmentLoggedType](../interfaces/internal-JsonFlatAbiFragmentLoggedType.md) -- [JsonFlatAbiFragmentType](../interfaces/internal-JsonFlatAbiFragmentType.md) -- [ScriptTransactionRequestLike](../interfaces/internal-ScriptTransactionRequestLike.md) - -## Enumeration Members - -### Call - -• **Call**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L10) - -___ - -### Change - -• **Change**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L10) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L15) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L7) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L16) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L8) - -___ - -### ContractCreated - -• **ContractCreated**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L12) - -___ - -### Create - -• **Create**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Log - -• **Log**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L15) - -___ - -### LogData - -• **LogData**: ``6`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L17) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L9) - -___ - -### MessageOut - -• **MessageOut**: ``10`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L20) - -___ - -### Panic - -• **Panic**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L13) - -___ - -### Return - -• **Return**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L11) - -___ - -### ReturnData - -• **ReturnData**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L12) - -___ - -### Revert - -• **Revert**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L14) - -___ - -### Script - -• **Script**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) - -___ - -### ScriptResult - -• **ScriptResult**: ``9`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L19) - -___ - -### Transfer - -• **Transfer**: ``7`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L17) - -___ - -### TransferOut - -• **TransferOut**: ``8`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L18) - -___ - -### Variable - -• **Variable**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L11) - -## Type Aliases - -### AddressLike - -Ƭ **AddressLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractAccount`](../classes/internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L55) - -___ - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### BigNumberish - -Ƭ **BigNumberish**: `string` \| `number` \| [`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/types.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L3) - -___ - -### CallResult - -Ƭ **CallResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | - -#### Defined in - -[packages/providers/src/provider.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L42) - -___ - -### ChangeTransactionRequestOutput - -Ƭ **ChangeTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L30) - -___ - -### Coin - -Ƭ **Coin**: `Object` - -A Fuel coin - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `blockCreated` | [`BN`](../classes/internal-BN.md) | -| `id` | `string` | -| `maturity` | `number` | -| `owner` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlCoinStatus`](../enums/internal-GqlCoinStatus.md) | - -#### Defined in - -[packages/providers/src/coin.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin.ts#L9) - -___ - -### CoinQuantity - -Ƭ **CoinQuantity**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `max?` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/providers/src/coin-quantity.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L10) - -___ - -### CoinQuantityLike - -Ƭ **CoinQuantityLike**: [amount: BigNumberish, assetId?: BytesLike, max?: BigNumberish] \| { `amount`: [`BigNumberish`](internal.md#bignumberish) ; `assetId?`: `BytesLike` ; `max?`: [`BigNumberish`](internal.md#bignumberish) } - -#### Defined in - -[packages/providers/src/coin-quantity.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L7) - -___ - -### CoinTransactionRequestInput - -Ƭ **CoinTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `assetId` | `BytesLike` | Asset ID of the coins | -| `id` | `BytesLike` | UTXO ID | -| `maturity?` | `number` | UTXO being spent must have been created at least this many blocks ago | -| `owner` | `BytesLike` | Owning address or script hash | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L9) - -___ - -### CoinTransactionRequestOutput - -Ƭ **CoinTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins to send | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L9) - -___ - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) - -___ - -### ContractCreatedTransactionRequestOutput - -Ƭ **ContractCreatedTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L40) - -___ - -### ContractIdLike - -Ƭ **ContractIdLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractContract`](../classes/internal-AbstractContract.md) - -#### Defined in - -[packages/interfaces/src/index.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L57) - -___ - -### ContractTransactionRequestInput - -Ƭ **ContractTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L66) - -___ - -### ContractTransactionRequestOutput - -Ƭ **ContractTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `inputIndex` | `number` | Index of input contract | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L18) - -___ - -### DeployContractOptions - -Ƭ **DeployContractOptions**: { `salt?`: `BytesLike` ; `stateRoot?`: `BytesLike` ; `storageSlots?`: [`StorageSlot`](internal.md#storageslot)[] } & [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) - -#### Defined in - -[packages/contract/src/contract-factory.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L19) - -___ - -### ExcludeResourcesOption - -Ƭ **ExcludeResourcesOption**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `messages?` | `BytesLike`[] | -| `utxos?` | `BytesLike`[] | - -#### Defined in - -[packages/providers/src/resource.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L36) - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](internal.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### Input - -Ƭ **Input**: [`InputCoin`](internal.md#inputcoin) \| [`InputContract`](internal.md#inputcontract) \| [`InputMessage`](internal.md#inputmessage) - -#### Defined in - -[packages/transactions/src/coders/input.ts:324](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L324) - -___ - -### InputCoin - -Ƭ **InputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins (u64) | -| `assetId` | `string` | Asset ID of the coins (b256) | -| `maturity` | `number` | UTXO being spent must have been created at least this many blocks ago (u32) | -| `owner` | `string` | Owning address or script hash (b256) | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L20) - -___ - -### InputContract - -Ƭ **InputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract before transaction execution (b256) | -| `contractID` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract before transaction execution (b256) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L131) - -___ - -### InputMessage - -Ƭ **InputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins | -| `data` | `string` | data of message | -| `dataLength` | `number` | Length of predicate, in instructions (u16) | -| `nonce` | [`BN`](../classes/internal-BN.md) | Unique nonce of message | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `recipient` | `string` | Address of sender | -| `sender` | `string` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes message (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:196](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L196) - -___ - -### JsonAbi - -Ƭ **JsonAbi**: `ReadonlyArray`<[`JsonAbiFragment`](../interfaces/internal-JsonAbiFragment.md)\> \| [`JsonFlatAbi`](../interfaces/internal-JsonFlatAbi.md) - -A JSON ABI object - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:78](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L78) - -___ - -### Message - -Ƭ **Message**: `Object` - -A Fuel message - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `daHeight` | [`BN`](../classes/internal-BN.md) | -| `data` | `BytesLike` | -| `nonce` | [`BN`](../classes/internal-BN.md) | -| `recipient` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `sender` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlMessageStatus`](../enums/internal-GqlMessageStatus.md) | - -#### Defined in - -[packages/providers/src/message.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/message.ts#L11) - -___ - -### MessageTransactionRequestInput - -Ƭ **MessageTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `data` | `BytesLike` | data of message | -| `nonce` | [`BigNumberish`](internal.md#bignumberish) | Unique nonce of message | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `recipient` | `BytesLike` | Address of sender | -| `sender` | `BytesLike` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes the message | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L39) - -___ - -### MessageTransactionRequestOutput - -Ƭ **MessageTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins sent with message | -| `recipient` | `BytesLike` | Receiving address | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L23) - -___ - -### Output - -Ƭ **Output**: [`OutputCoin`](internal.md#outputcoin) \| [`OutputContract`](internal.md#outputcontract) \| [`OutputMessage`](internal.md#outputmessage) \| [`OutputChange`](internal.md#outputchange) \| [`OutputVariable`](internal.md#outputvariable) \| [`OutputContractCreated`](internal.md#outputcontractcreated) - -#### Defined in - -[packages/transactions/src/coders/output.ts:294](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L294) - -___ - -### OutputChange - -Ƭ **OutputChange**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:153](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L153) - -___ - -### OutputCoin - -Ƭ **OutputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L15) - -___ - -### OutputContract - -Ƭ **OutputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract after transaction execution (b256) | -| `inputIndex` | `number` | Index of input contract (u8) | -| `stateRoot` | `string` | State root of contract after transaction execution (b256) | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L63) - -___ - -### OutputContractCreated - -Ƭ **OutputContractCreated**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract (b256) | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:249](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L249) - -___ - -### OutputMessage - -Ƭ **OutputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send with message (u64) | -| `recipient` | `string` | Receiving address (b256) | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:111](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L111) - -___ - -### OutputVariable - -Ƭ **OutputVariable**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Variable`](internal.md#variable) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:201](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L201) - -___ - -### PossibleTransactions - -Ƭ **PossibleTransactions**: [`TransactionScript`](internal.md#transactionscript) \| [`TransactionCreate`](internal.md#transactioncreate) \| [`TransactionMint`](internal.md#transactionmint) - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:347](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L347) - -___ - -### ReceiptCall - -Ƭ **ReceiptCall**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to forward, i.e. $rB (u64) | -| `assetId` | `string` | Asset ID of coins to forward, i.e. MEM[$rC, 32] (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `gas` | [`BN`](../classes/internal-BN.md) | Gas to forward, i.e. $rD (u64) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `param1` | [`BN`](../classes/internal-BN.md) | First parameter (u64) | -| `param2` | [`BN`](../classes/internal-BN.md) | Second parameter (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of called contract (b256) | -| `type` | [`Call`](internal.md#call) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L23) - -___ - -### ReceiptLog - -Ƭ **ReceiptLog**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Log`](internal.md#log) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `val2` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `val3` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:341](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L341) - -___ - -### ReceiptLogData - -Ƭ **ReceiptLogData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rC, $rD] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `type` | [`LogData`](internal.md#logdata) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:413](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L413) - -___ - -### ReceiptMessageOut - -Ƭ **ReceiptMessageOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Hexadecimal string representation of a 64-bit unsigned integer; value of register $rD | -| `data` | `Uint8Array` | Hexadecimal string representation of the value of the memory range MEM[$rA + 32, $rB] | -| `digest` | `string` | Hexadecimal string representation of 256-bit (32-byte), hash of MEM[$rA + 32, $rB] | -| `messageID` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message ID | -| `nonce` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message nonce | -| `recipient` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message recipient: MEM[$rA, 32] | -| `sender` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message sender: MEM[$fp, 32] | -| `type` | [`MessageOut`](internal.md#messageout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:665](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L665) - -___ - -### ReceiptPanic - -Ƭ **ReceiptPanic**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Value of optional contract ID | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `reason` | [`BN`](../classes/internal-BN.md) | Panic reason (u64) | -| `type` | [`Panic`](internal.md#panic) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:227](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L227) - -___ - -### ReceiptReturn - -Ƭ **ReceiptReturn**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Return`](internal.md#return) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L107) - -___ - -### ReceiptReturnData - -Ƭ **ReceiptReturnData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rA, $rB] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `type` | [`ReturnData`](internal.md#returndata) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:161](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L161) - -___ - -### ReceiptRevert - -Ƭ **ReceiptRevert**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Revert`](internal.md#revert) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:287](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L287) - -___ - -### ReceiptScriptResult - -Ƭ **ReceiptScriptResult**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | Gas consumed by the script (u64) | -| `result` | [`BN`](../classes/internal-BN.md) | Result variant with embedded `PanicReason` in first 8 bits and `instr` (u64) | -| `type` | [`ScriptResult`](internal.md#scriptresult) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:623](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L623) - -___ - -### ReceiptTransfer - -Ƭ **ReceiptTransfer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of contract to transfer coins to (b256) | -| `type` | [`Transfer`](internal.md#transfer) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:491](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L491) - -___ - -### ReceiptTransferOut - -Ƭ **ReceiptTransferOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Address to transfer coins to (b256) | -| `type` | [`TransferOut`](internal.md#transferout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:557](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L557) - -___ - -### Resource - -Ƭ **Resource**: [`Coin`](internal.md#coin-2) \| [`Message`](internal.md#message-2) - -#### Defined in - -[packages/providers/src/resource.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L32) - -___ - -### StorageSlot - -Ƭ **StorageSlot**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Key (b256) | -| `value` | `string` | Value (b256) | - -#### Defined in - -[packages/transactions/src/coders/storage-slot.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/storage-slot.ts#L3) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) - -___ - -### Transaction - -Ƭ **Transaction**<`TTransactionType`\>: `TTransactionType` extends [`TransactionType`](../enums/internal-TransactionType.md) ? `Extract`<[`PossibleTransactions`](internal.md#possibletransactions), { `type`: `TTransactionType` }\> : `Partial`<`Omit`<[`TransactionScript`](internal.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](internal.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](internal.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/internal-TransactionType.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:348](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L348) - -___ - -### TransactionCreate - -Ƭ **TransactionCreate**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bytecodeLength` | `number` | Contract bytecode length, in instructions (u16) | -| `bytecodeWitnessIndex` | `number` | Witness index of contract bytecode to create (u8) | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `salt` | `string` | Salt (b256) | -| `storageSlots` | [`StorageSlot`](internal.md#storageslot)[] | List of inputs (StorageSlot[]) | -| `storageSlotsCount` | `number` | Number of storage slots to initialize (u16) | -| `type` | [`Create`](internal.md#create) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L159) - -___ - -### TransactionMint - -Ƭ **TransactionMint**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | The location of the Mint transaction in the block. | -| `type` | [`Mint`](../enums/internal-TransactionType.md#mint) | - | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:297](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L297) - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: [`ScriptTransactionRequest`](../classes/internal-ScriptTransactionRequest.md) \| [`CreateTransactionRequest`](../classes/internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:576](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L576) - -___ - -### TransactionRequestInput - -Ƭ **TransactionRequestInput**: [`CoinTransactionRequestInput`](internal.md#cointransactionrequestinput) \| [`ContractTransactionRequestInput`](internal.md#contracttransactionrequestinput) \| [`MessageTransactionRequestInput`](internal.md#messagetransactionrequestinput) - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:75](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L75) - -___ - -### TransactionRequestLike - -Ƭ **TransactionRequestLike**: { `type`: [`Script`](../enums/internal-TransactionType.md#script) } & [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) \| { `type`: [`Create`](internal.md#create) } & [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:577](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L577) - -___ - -### TransactionRequestOutput - -Ƭ **TransactionRequestOutput**: [`CoinTransactionRequestOutput`](internal.md#cointransactionrequestoutput) \| [`ContractTransactionRequestOutput`](internal.md#contracttransactionrequestoutput) \| [`MessageTransactionRequestOutput`](internal.md#messagetransactionrequestoutput) \| [`ChangeTransactionRequestOutput`](internal.md#changetransactionrequestoutput) \| [`VariableTransactionRequestOutput`](internal.md#variabletransactionrequestoutput) \| [`ContractCreatedTransactionRequestOutput`](internal.md#contractcreatedtransactionrequestoutput) - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L47) - -___ - -### TransactionRequestStorageSlot - -Ƭ **TransactionRequestStorageSlot**: { `key`: `BytesLike` ; `value`: `BytesLike` } \| [key: BytesLike, value: BytesLike] - -#### Defined in - -[packages/providers/src/transaction-request/storage-slot.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/storage-slot.ts#L5) - -___ - -### TransactionResult - -Ƭ **TransactionResult**<`TStatus`, `TTransactionType`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TStatus` | extends ``"success"`` \| ``"failure"`` | -| `TTransactionType` | `void` | - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockId` | `any` | - | -| `fee` | [`BN`](../classes/internal-BN.md) | - | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | - | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | Receipts produced during the execution of the transaction | -| `status` | `TStatus` extends ``"success"`` ? { `programState`: `any` ; `type`: ``"success"`` } : { `reason`: `any` ; `type`: ``"failure"`` } | - | -| `time` | `any` | - | -| `transaction` | [`Transaction`](internal.md#transaction)<`TTransactionType`\> | - | -| `transactionId` | `string` | - | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L54) - -___ - -### TransactionResultCallReceipt - -Ƭ **TransactionResultCallReceipt**: [`ReceiptCall`](internal.md#receiptcall) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L29) - -___ - -### TransactionResultLogDataReceipt - -Ƭ **TransactionResultLogDataReceipt**: [`ReceiptLogData`](internal.md#receiptlogdata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L35) - -___ - -### TransactionResultLogReceipt - -Ƭ **TransactionResultLogReceipt**: [`ReceiptLog`](internal.md#receiptlog) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L34) - -___ - -### TransactionResultMessageOutReceipt - -Ƭ **TransactionResultMessageOutReceipt**: [`ReceiptMessageOut`](internal.md#receiptmessageout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L39) - -___ - -### TransactionResultPanicReceipt - -Ƭ **TransactionResultPanicReceipt**: [`ReceiptPanic`](internal.md#receiptpanic) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L32) - -___ - -### TransactionResultReceipt - -Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](internal.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](internal.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](internal.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](internal.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](internal.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](internal.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](internal.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](internal.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](internal.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](internal.md#transactionresultscriptresultreceipt) \| [`TransactionResultMessageOutReceipt`](internal.md#transactionresultmessageoutreceipt) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L41) - -___ - -### TransactionResultReturnDataReceipt - -Ƭ **TransactionResultReturnDataReceipt**: [`ReceiptReturnData`](internal.md#receiptreturndata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L31) - -___ - -### TransactionResultReturnReceipt - -Ƭ **TransactionResultReturnReceipt**: [`ReceiptReturn`](internal.md#receiptreturn) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L30) - -___ - -### TransactionResultRevertReceipt - -Ƭ **TransactionResultRevertReceipt**: [`ReceiptRevert`](internal.md#receiptrevert) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L33) - -___ - -### TransactionResultScriptResultReceipt - -Ƭ **TransactionResultScriptResultReceipt**: [`ReceiptScriptResult`](internal.md#receiptscriptresult) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L38) - -___ - -### TransactionResultTransferOutReceipt - -Ƭ **TransactionResultTransferOutReceipt**: [`ReceiptTransferOut`](internal.md#receipttransferout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L37) - -___ - -### TransactionResultTransferReceipt - -Ƭ **TransactionResultTransferReceipt**: [`ReceiptTransfer`](internal.md#receipttransfer) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L36) - -___ - -### TransactionScript - -Ƭ **TransactionScript**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `receiptsRoot` | `string` | Merkle root of receipts (b256) | -| `script` | `string` | Script to execute (byte[]) | -| `scriptData` | `string` | Script input data (parameters) (byte[]) | -| `scriptDataLength` | `number` | Length of script input data, in bytes (u16) | -| `scriptLength` | `number` | Script length, in instructions (u16) | -| `type` | [`Script`](../enums/internal-TransactionType.md#script) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L25) - -___ - -### TxPointer - -Ƭ **TxPointer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockHeight` | `number` | Block height (u32) | -| `txIndex` | `number` | Transaction index (u16) | - -#### Defined in - -[packages/transactions/src/coders/tx-pointer.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/tx-pointer.ts#L3) - -___ - -### UtxoId - -Ƭ **UtxoId**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputIndex` | `number` | Output index (u8) | -| `transactionId` | `string` | Transaction ID (b256) | - -#### Defined in - -[packages/transactions/src/coders/utxo-id.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L3) - -___ - -### VariableTransactionRequestOutput - -Ƭ **VariableTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `type` | [`Variable`](internal.md#variable) | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L37) - -___ - -### Witness - -Ƭ **Witness**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `string` | Witness data (byte[]) | -| `dataLength` | `number` | Length of witness data, in bytes (u32) | - -#### Defined in - -[packages/transactions/src/coders/witness.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L6) diff --git a/docs/packages/fuel-ts-hasher/classes/internal-BN.md b/docs/packages/fuel-ts-hasher/classes/internal-BN.md deleted file mode 100644 index 09fc2538dcf..00000000000 --- a/docs/packages/fuel-ts-hasher/classes/internal-BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/hasher" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/hasher](../index.md).[internal](../namespaces/internal.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../namespaces/internal.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](internal-BN.md) | -| `mod` | [`BN`](internal-BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](internal-BN.md) | -| `b` | [`BN`](internal-BN.md) | -| `gcd` | [`BN`](internal-BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../namespaces/internal.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](internal-BN.md) | -| `out` | [`BN`](internal-BN.md) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-hasher/index.md b/docs/packages/fuel-ts-hasher/index.md deleted file mode 100644 index c069be2940d..00000000000 --- a/docs/packages/fuel-ts-hasher/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -layout: default -title: "@fuel-ts/hasher" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/hasher - -## Namespaces - -- [internal](namespaces/internal.md) - -## Functions - -### hash - -▸ **hash**(`data`): `string` - -wrap sha256 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | The data to be hash | - -#### Returns - -`string` - -A sha256 hash of the data - -#### Defined in - -[packages/hasher/src/hasher.ts:101](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hasher/src/hasher.ts#L101) - -___ - -### hashMessage - -▸ **hashMessage**(`msg`): `string` - -hash string messages with sha256 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `msg` | `string` | The string message to be hashed | - -#### Returns - -`string` - -A sha256 hash of the message - -#### Defined in - -[packages/hasher/src/hasher.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hasher/src/hasher.ts#L18) - -___ - -### hashTransaction - -▸ **hashTransaction**(`transactionRequestLike`): `string` - -Hash transaction request with sha256. [Read more](https://github.com/FuelLabs/fuel-specs/blob/master/specs/protocol/identifiers.md#transaction-id) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`string` - -sha256 hash of the transaction - -#### Defined in - -[packages/hasher/src/hasher.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hasher/src/hasher.ts#L28) diff --git a/docs/packages/fuel-ts-hasher/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-hasher/interfaces/internal-BNHelper.md deleted file mode 100644 index 032c4e17b8a..00000000000 --- a/docs/packages/fuel-ts-hasher/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/hasher" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/hasher](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-hasher/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-hasher/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index f2c9c790800..00000000000 --- a/docs/packages/fuel-ts-hasher/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/hasher" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/hasher](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../namespaces/internal.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/internal-BN.md) ; `mod`: [`BN`](../classes/internal-BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/internal-BN.md) | -| `mod` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/internal-BN.md), `out`: [`BN`](../classes/internal-BN.md)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/internal-BN.md) | -| `out` | [`BN`](../classes/internal-BN.md) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-hasher/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-hasher/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index b9ca6cb805f..00000000000 --- a/docs/packages/fuel-ts-hasher/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/hasher" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/hasher](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-hasher/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-hasher/interfaces/internal-BNOverrides.md deleted file mode 100644 index c84dcf6133b..00000000000 --- a/docs/packages/fuel-ts-hasher/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/hasher" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/hasher](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-hasher/interfaces/internal-BaseTransactionRequestLike.md b/docs/packages/fuel-ts-hasher/interfaces/internal-BaseTransactionRequestLike.md deleted file mode 100644 index 791e38622fd..00000000000 --- a/docs/packages/fuel-ts-hasher/interfaces/internal-BaseTransactionRequestLike.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -layout: default -title: BaseTransactionRequestLike -parent: "@fuel-ts/hasher" -nav_order: 2 - ---- - -# Interface: BaseTransactionRequestLike - -[@fuel-ts/hasher](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequestLike - -## Hierarchy - -- **`BaseTransactionRequestLike`** - - ↳ [`ScriptTransactionRequestLike`](internal-ScriptTransactionRequestLike.md) - - ↳ [`CreateTransactionRequestLike`](internal-CreateTransactionRequestLike.md) - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-hasher/interfaces/internal-CreateTransactionRequestLike.md b/docs/packages/fuel-ts-hasher/interfaces/internal-CreateTransactionRequestLike.md deleted file mode 100644 index 79ac6e34eb0..00000000000 --- a/docs/packages/fuel-ts-hasher/interfaces/internal-CreateTransactionRequestLike.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -layout: default -title: CreateTransactionRequestLike -parent: "@fuel-ts/hasher" -nav_order: 2 - ---- - -# Interface: CreateTransactionRequestLike - -[@fuel-ts/hasher](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`CreateTransactionRequestLike`** - -## Properties - -### bytecodeWitnessIndex - -• `Optional` **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:504](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L504) - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### salt - -• `Optional` **salt**: `BytesLike` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:506](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L506) - -___ - -### storageSlots - -• `Optional` **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:508](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L508) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-hasher/interfaces/internal-ScriptTransactionRequestLike.md b/docs/packages/fuel-ts-hasher/interfaces/internal-ScriptTransactionRequestLike.md deleted file mode 100644 index d945b04a013..00000000000 --- a/docs/packages/fuel-ts-hasher/interfaces/internal-ScriptTransactionRequestLike.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequestLike -parent: "@fuel-ts/hasher" -nav_order: 2 - ---- - -# Interface: ScriptTransactionRequestLike - -[@fuel-ts/hasher](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`ScriptTransactionRequestLike`** - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### script - -• `Optional` **script**: `BytesLike` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:384](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L384) - -___ - -### scriptData - -• `Optional` **scriptData**: `BytesLike` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:386](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L386) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-hasher/namespaces/internal.md b/docs/packages/fuel-ts-hasher/namespaces/internal.md deleted file mode 100644 index ea33cf57b4b..00000000000 --- a/docs/packages/fuel-ts-hasher/namespaces/internal.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/hasher" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/hasher](../index.md).internal - -## Classes - -- [BN](../classes/internal-BN.md) - -## Interfaces - -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) -- [BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md) -- [CreateTransactionRequestLike](../interfaces/internal-CreateTransactionRequestLike.md) -- [ScriptTransactionRequestLike](../interfaces/internal-ScriptTransactionRequestLike.md) - -## Enumeration Members - -### Change - -• **Change**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L10) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L15) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L7) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L16) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L8) - -___ - -### ContractCreated - -• **ContractCreated**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L12) - -___ - -### Create - -• **Create**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L17) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L9) - -___ - -### Script - -• **Script**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) - -___ - -### Variable - -• **Variable**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L11) - -## Type Aliases - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### BigNumberish - -Ƭ **BigNumberish**: `string` \| `number` \| [`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/types.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L3) - -___ - -### ChangeTransactionRequestOutput - -Ƭ **ChangeTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L30) - -___ - -### CoinTransactionRequestInput - -Ƭ **CoinTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `assetId` | `BytesLike` | Asset ID of the coins | -| `id` | `BytesLike` | UTXO ID | -| `maturity?` | `number` | UTXO being spent must have been created at least this many blocks ago | -| `owner` | `BytesLike` | Owning address or script hash | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L9) - -___ - -### CoinTransactionRequestOutput - -Ƭ **CoinTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins to send | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L9) - -___ - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) - -___ - -### ContractCreatedTransactionRequestOutput - -Ƭ **ContractCreatedTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L40) - -___ - -### ContractTransactionRequestInput - -Ƭ **ContractTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L66) - -___ - -### ContractTransactionRequestOutput - -Ƭ **ContractTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `inputIndex` | `number` | Index of input contract | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L18) - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](internal.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### MessageTransactionRequestInput - -Ƭ **MessageTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `data` | `BytesLike` | data of message | -| `nonce` | [`BigNumberish`](internal.md#bignumberish) | Unique nonce of message | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `recipient` | `BytesLike` | Address of sender | -| `sender` | `BytesLike` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes the message | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L39) - -___ - -### MessageTransactionRequestOutput - -Ƭ **MessageTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins sent with message | -| `recipient` | `BytesLike` | Receiving address | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L23) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) - -___ - -### TransactionRequestInput - -Ƭ **TransactionRequestInput**: [`CoinTransactionRequestInput`](internal.md#cointransactionrequestinput) \| [`ContractTransactionRequestInput`](internal.md#contracttransactionrequestinput) \| [`MessageTransactionRequestInput`](internal.md#messagetransactionrequestinput) - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:75](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L75) - -___ - -### TransactionRequestLike - -Ƭ **TransactionRequestLike**: { `type`: [`Script`](internal.md#script) } & [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) \| { `type`: [`Create`](internal.md#create) } & [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:577](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L577) - -___ - -### TransactionRequestOutput - -Ƭ **TransactionRequestOutput**: [`CoinTransactionRequestOutput`](internal.md#cointransactionrequestoutput) \| [`ContractTransactionRequestOutput`](internal.md#contracttransactionrequestoutput) \| [`MessageTransactionRequestOutput`](internal.md#messagetransactionrequestoutput) \| [`ChangeTransactionRequestOutput`](internal.md#changetransactionrequestoutput) \| [`VariableTransactionRequestOutput`](internal.md#variabletransactionrequestoutput) \| [`ContractCreatedTransactionRequestOutput`](internal.md#contractcreatedtransactionrequestoutput) - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L47) - -___ - -### TransactionRequestStorageSlot - -Ƭ **TransactionRequestStorageSlot**: { `key`: `BytesLike` ; `value`: `BytesLike` } \| [key: BytesLike, value: BytesLike] - -#### Defined in - -[packages/providers/src/transaction-request/storage-slot.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/storage-slot.ts#L5) - -___ - -### VariableTransactionRequestOutput - -Ƭ **VariableTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `type` | [`Variable`](internal.md#variable) | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L37) diff --git a/docs/packages/fuel-ts-hdwallet/classes/HDWallet.md b/docs/packages/fuel-ts-hdwallet/classes/HDWallet.md deleted file mode 100644 index 97f20624d68..00000000000 --- a/docs/packages/fuel-ts-hdwallet/classes/HDWallet.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -layout: default -title: HDWallet -parent: "@fuel-ts/hdwallet" -nav_order: 1 - ---- - -# Class: HDWallet - -[@fuel-ts/hdwallet](../index.md).HDWallet - -## Constructors - -### constructor - -• **new HDWallet**(`config`) - -HDWallet is a implementation of the BIP-0044 and BIP-0032, Multi-Account Hierarchy for Deterministic Wallets - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config` | [`HDWalletConfig`](../namespaces/internal.md#hdwalletconfig) | Wallet configurations | - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:78](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L78) - -## Properties - -### chainCode - -• **chainCode**: `BytesLike` - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L71) - -___ - -### depth - -• **depth**: `number` = `0` - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L65) - -___ - -### fingerprint - -• **fingerprint**: `string` - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:67](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L67) - -___ - -### index - -• **index**: `number` = `0` - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L66) - -___ - -### parentFingerprint - -• **parentFingerprint**: `string` - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L68) - -___ - -### privateKey - -• `Optional` **privateKey**: `string` - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:69](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L69) - -___ - -### publicKey - -• **publicKey**: `string` - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:70](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L70) - -## Accessors - -### extendedKey - -• `get` **extendedKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:99](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L99) - -## Methods - -### deriveIndex - -▸ **deriveIndex**(`index`): [`HDWallet`](HDWallet.md) - -Derive the current HDWallet instance navigating only on the index. -`Ex.: m/44'/0 -> Ex.: m/44'/1 -> m/44'/2`. [Learn more](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `index` | `number` | Index of the child HDWallet. | - -#### Returns - -[`HDWallet`](HDWallet.md) - -A new instance of HDWallet on the derived index - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:110](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L110) - -___ - -### derivePath - -▸ **derivePath**(`path`): [`HDWallet`](HDWallet.md) - -Derive the current HDWallet instance to the path. [Learn more](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `path` | `string` | The string representation of the child HDWallet. `Ex.: m/44'/0'/0'/0/0` | - -#### Returns - -[`HDWallet`](HDWallet.md) - -A new instance of HDWallet on the derived path - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:166](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L166) - -___ - -### toExtendedKey - -▸ **toExtendedKey**(`isPublic?`, `testnet?`): `string` - -Get the extendKey as defined on BIP-32 from the provided seed - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `isPublic` | `boolean` | `false` | enable to export public extendedKey, it not required when HDWallet didn't have the privateKey. | -| `testnet` | `boolean` | `false` | Inform if should use testnet or mainnet prefix, default value is true (`mainnet`). | - -#### Returns - -`string` - -BIP-32 extended private key - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L179) - -___ - -### fromExtendedKey - -▸ `Static` **fromExtendedKey**(`extendedKey`): [`HDWallet`](HDWallet.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `extendedKey` | `string` | - -#### Returns - -[`HDWallet`](HDWallet.md) - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L212) - -___ - -### fromSeed - -▸ `Static` **fromSeed**(`seed`): [`HDWallet`](HDWallet.md) - -Create HDWallet instance from seed - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `seed` | `string` | Seed | - -#### Returns - -[`HDWallet`](HDWallet.md) - -A new instance of HDWallet - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:203](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L203) diff --git a/docs/packages/fuel-ts-hdwallet/index.md b/docs/packages/fuel-ts-hdwallet/index.md deleted file mode 100644 index 742cef0363d..00000000000 --- a/docs/packages/fuel-ts-hdwallet/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default -title: "@fuel-ts/hdwallet" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/hdwallet - -## Namespaces - -- [internal](namespaces/internal.md) - -## Classes - -- [HDWallet](classes/HDWallet.md) diff --git a/docs/packages/fuel-ts-hdwallet/namespaces/internal.md b/docs/packages/fuel-ts-hdwallet/namespaces/internal.md deleted file mode 100644 index ba046394f1a..00000000000 --- a/docs/packages/fuel-ts-hdwallet/namespaces/internal.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/hdwallet" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/hdwallet](../index.md).internal - -## Type Aliases - -### HDWalletConfig - -Ƭ **HDWalletConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `chainCode` | `BytesLike` | -| `depth?` | `number` | -| `index?` | `number` | -| `parentFingerprint?` | `string` | -| `privateKey?` | `BytesLike` | -| `publicKey?` | `BytesLike` | - -#### Defined in - -[packages/hdwallet/src/hdwallet.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/hdwallet/src/hdwallet.ts#L55) diff --git a/docs/packages/fuel-ts-interfaces/classes/AbstractAccount.md b/docs/packages/fuel-ts-interfaces/classes/AbstractAccount.md deleted file mode 100644 index 76ecc9e6046..00000000000 --- a/docs/packages/fuel-ts-interfaces/classes/AbstractAccount.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -layout: default -title: AbstractAccount -parent: "@fuel-ts/interfaces" -nav_order: 1 - ---- - -# Class: AbstractAccount - -[@fuel-ts/interfaces](../index.md).AbstractAccount - -## Constructors - -### constructor - -• **new AbstractAccount**() - -## Properties - -### address - -• `Abstract` **address**: [`AbstractAddress`](AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L26) - -___ - -### provider - -• `Abstract` **provider**: `unknown` - -#### Defined in - -[packages/interfaces/src/index.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L27) - -## Methods - -### getResourcesToSpend - -▸ `Abstract` **getResourcesToSpend**(`quantities`, `options?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | `any`[] | -| `options?` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L28) - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L29) - -___ - -### simulateTransaction - -▸ `Abstract` **simulateTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L30) diff --git a/docs/packages/fuel-ts-interfaces/classes/AbstractAddress.md b/docs/packages/fuel-ts-interfaces/classes/AbstractAddress.md deleted file mode 100644 index da272a9b0ba..00000000000 --- a/docs/packages/fuel-ts-interfaces/classes/AbstractAddress.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: default -title: AbstractAddress -parent: "@fuel-ts/interfaces" -nav_order: 1 - ---- - -# Class: AbstractAddress - -[@fuel-ts/interfaces](../index.md).AbstractAddress - -## Constructors - -### constructor - -• **new AbstractAddress**() - -## Methods - -### equals - -▸ `Abstract` **equals**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`AbstractAddress`](AbstractAddress.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/interfaces/src/index.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L21) - -___ - -### toAddress - -▸ `Abstract` **toAddress**(): \`fuel${string}\` - -#### Returns - -\`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L17) - -___ - -### toB256 - -▸ `Abstract` **toB256**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L18) - -___ - -### toBytes - -▸ `Abstract` **toBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L20) - -___ - -### toHexString - -▸ `Abstract` **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L19) - -___ - -### toJSON - -▸ `Abstract` **toJSON**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L15) - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L16) diff --git a/docs/packages/fuel-ts-interfaces/classes/AbstractContract.md b/docs/packages/fuel-ts-interfaces/classes/AbstractContract.md deleted file mode 100644 index 108db3588c6..00000000000 --- a/docs/packages/fuel-ts-interfaces/classes/AbstractContract.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: default -title: AbstractContract -parent: "@fuel-ts/interfaces" -nav_order: 1 - ---- - -# Class: AbstractContract - -[@fuel-ts/interfaces](../index.md).AbstractContract - -## Hierarchy - -- [`AbstractProgram`](AbstractProgram.md) - - ↳ **`AbstractContract`** - -## Constructors - -### constructor - -• **new AbstractContract**() - -#### Inherited from - -[AbstractProgram](AbstractProgram.md).[constructor](AbstractProgram.md#constructor) - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](AbstractAccount.md) - -#### Inherited from - -[AbstractProgram](AbstractProgram.md).[account](AbstractProgram.md#account) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### id - -• `Abstract` **id**: [`AbstractAddress`](AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L48) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Inherited from - -[AbstractProgram](AbstractProgram.md).[interface](AbstractProgram.md#interface) - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Inherited from - -[AbstractProgram](AbstractProgram.md).[provider](AbstractProgram.md#provider) - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-interfaces/classes/AbstractPredicate.md b/docs/packages/fuel-ts-interfaces/classes/AbstractPredicate.md deleted file mode 100644 index c7884ddec4e..00000000000 --- a/docs/packages/fuel-ts-interfaces/classes/AbstractPredicate.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: default -title: AbstractPredicate -parent: "@fuel-ts/interfaces" -nav_order: 1 - ---- - -# Class: AbstractPredicate - -[@fuel-ts/interfaces](../index.md).AbstractPredicate - -## Constructors - -### constructor - -• **new AbstractPredicate**() - -## Properties - -### address - -• `Abstract` **address**: [`AbstractAddress`](AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:61](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L61) - -___ - -### bytes - -• `Abstract` **bytes**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L60) - -___ - -### predicateData - -• `Abstract` **predicateData**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L62) - -___ - -### types - -• `Optional` `Abstract` **types**: readonly `any`[] - -#### Defined in - -[packages/interfaces/src/index.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L64) diff --git a/docs/packages/fuel-ts-interfaces/classes/AbstractProgram.md b/docs/packages/fuel-ts-interfaces/classes/AbstractProgram.md deleted file mode 100644 index 2d685c180b5..00000000000 --- a/docs/packages/fuel-ts-interfaces/classes/AbstractProgram.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -layout: default -title: AbstractProgram -parent: "@fuel-ts/interfaces" -nav_order: 1 - ---- - -# Class: AbstractProgram - -[@fuel-ts/interfaces](../index.md).AbstractProgram - -## Hierarchy - -- **`AbstractProgram`** - - ↳ [`AbstractContract`](AbstractContract.md) - - ↳ [`AbstractScript`](AbstractScript.md) - -## Constructors - -### constructor - -• **new AbstractProgram**() - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-interfaces/classes/AbstractScript.md b/docs/packages/fuel-ts-interfaces/classes/AbstractScript.md deleted file mode 100644 index 8b6b16cb617..00000000000 --- a/docs/packages/fuel-ts-interfaces/classes/AbstractScript.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: default -title: AbstractScript -parent: "@fuel-ts/interfaces" -nav_order: 1 - ---- - -# Class: AbstractScript - -[@fuel-ts/interfaces](../index.md).AbstractScript - -## Hierarchy - -- [`AbstractProgram`](AbstractProgram.md) - - ↳ **`AbstractScript`** - -## Constructors - -### constructor - -• **new AbstractScript**() - -#### Inherited from - -[AbstractProgram](AbstractProgram.md).[constructor](AbstractProgram.md#constructor) - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](AbstractAccount.md) - -#### Inherited from - -[AbstractProgram](AbstractProgram.md).[account](AbstractProgram.md#account) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### bytes - -• `Abstract` **bytes**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:52](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L52) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Inherited from - -[AbstractProgram](AbstractProgram.md).[interface](AbstractProgram.md#interface) - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Inherited from - -[AbstractProgram](AbstractProgram.md).[provider](AbstractProgram.md#provider) - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-interfaces/classes/AbstractScriptRequest.md b/docs/packages/fuel-ts-interfaces/classes/AbstractScriptRequest.md deleted file mode 100644 index e133c4be59a..00000000000 --- a/docs/packages/fuel-ts-interfaces/classes/AbstractScriptRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default -title: AbstractScriptRequest -parent: "@fuel-ts/interfaces" -nav_order: 1 - ---- - -# Class: AbstractScriptRequest - -[@fuel-ts/interfaces](../index.md).AbstractScriptRequest - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Constructors - -### constructor - -• **new AbstractScriptRequest**<`T`\>() - -#### Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### bytes - -• `Abstract` **bytes**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L9) - -___ - -### encodeScriptData - -• `Abstract` **encodeScriptData**: (`data`: `T`) => `Uint8Array` - -#### Type declaration - -▸ (`data`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L10) diff --git a/docs/packages/fuel-ts-interfaces/index.md b/docs/packages/fuel-ts-interfaces/index.md deleted file mode 100644 index 3da3606e522..00000000000 --- a/docs/packages/fuel-ts-interfaces/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default -title: "@fuel-ts/interfaces" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/interfaces - -## Classes - -- [AbstractAccount](classes/AbstractAccount.md) -- [AbstractAddress](classes/AbstractAddress.md) -- [AbstractContract](classes/AbstractContract.md) -- [AbstractPredicate](classes/AbstractPredicate.md) -- [AbstractProgram](classes/AbstractProgram.md) -- [AbstractScript](classes/AbstractScript.md) -- [AbstractScriptRequest](classes/AbstractScriptRequest.md) - -## Type Aliases - -### AddressLike - -Ƭ **AddressLike**: [`AbstractAddress`](classes/AbstractAddress.md) \| [`AbstractAccount`](classes/AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L55) - -___ - -### B256Address - -Ƭ **B256Address**: `string` - -#### Defined in - -[packages/interfaces/src/index.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L6) - -___ - -### Bech32Address - -Ƭ **Bech32Address**: \`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L4) - -___ - -### ContractIdLike - -Ƭ **ContractIdLike**: [`AbstractAddress`](classes/AbstractAddress.md) \| [`AbstractContract`](classes/AbstractContract.md) - -#### Defined in - -[packages/interfaces/src/index.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L57) diff --git a/docs/packages/fuel-ts-keystore/index.md b/docs/packages/fuel-ts-keystore/index.md deleted file mode 100644 index 6baf07d65f8..00000000000 --- a/docs/packages/fuel-ts-keystore/index.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -layout: default -title: "@fuel-ts/keystore" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/keystore - -## Interfaces - -- [Keystore](interfaces/Keystore.md) - -## Functions - -### bufferFromString - -▸ **bufferFromString**(`string`, `encoding?`): `Uint8Array` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `string` | `string` | `undefined` | -| `encoding` | ``"utf-8"`` \| ``"base64"`` | `'base64'` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/keystore/src/aes-ctr.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/keystore/src/aes-ctr.ts#L12) - -___ - -### decrypt - -▸ **decrypt**<`T`\>(`password`, `keystore`): `Promise`<`T`\> - -Given a password and a keystore object, decrypts the text and returns -the resulting value - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `password` | `string` | -| `keystore` | [`Keystore`](interfaces/Keystore.md) | - -#### Returns - -`Promise`<`T`\> - -Promise T object - -#### Defined in - -[packages/keystore/src/keystore.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/keystore/src/keystore.ts#L26) - -___ - -### encrypt - -▸ **encrypt**<`T`\>(`password`, `data`): `Promise`<[`Keystore`](interfaces/Keystore.md)\> - -Encrypts a data object that can be any serializable value using -a provided password. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `password` | `string` | -| `data` | `T` | - -#### Returns - -`Promise`<[`Keystore`](interfaces/Keystore.md)\> - -Promise Keystore object - -#### Defined in - -[packages/keystore/src/keystore.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/keystore/src/keystore.ts#L16) - -___ - -### keyFromPassword - -▸ **keyFromPassword**(`password`, `saltBuffer`): `Uint8Array` - -Generate a pbkdf2 key from a password and random salt - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `password` | `string` | -| `saltBuffer` | `Uint8Array` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/keystore/src/aes-ctr.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/keystore/src/aes-ctr.ts#L44) - -___ - -### randomBytes - -▸ **randomBytes**(`length`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `length` | `number` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/keystore/src/randomBytes.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/keystore/src/randomBytes.ts#L3) - -___ - -### stringFromBuffer - -▸ **stringFromBuffer**(`buffer`, `encoding?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `buffer` | `Uint8Array` | `undefined` | -| `encoding` | ``"utf-8"`` \| ``"base64"`` | `'base64'` | - -#### Returns - -`string` - -#### Defined in - -[packages/keystore/src/aes-ctr.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/keystore/src/aes-ctr.ts#L30) diff --git a/docs/packages/fuel-ts-keystore/interfaces/Keystore.md b/docs/packages/fuel-ts-keystore/interfaces/Keystore.md deleted file mode 100644 index c6d4b964888..00000000000 --- a/docs/packages/fuel-ts-keystore/interfaces/Keystore.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: Keystore -parent: "@fuel-ts/keystore" -nav_order: 2 - ---- - -# Interface: Keystore - -[@fuel-ts/keystore](../index.md).Keystore - -## Properties - -### data - -• **data**: `string` - -#### Defined in - -[packages/keystore/src/aes-ctr.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/keystore/src/aes-ctr.ts#L7) - -___ - -### iv - -• **iv**: `string` - -#### Defined in - -[packages/keystore/src/aes-ctr.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/keystore/src/aes-ctr.ts#L8) - -___ - -### salt - -• **salt**: `string` - -#### Defined in - -[packages/keystore/src/aes-ctr.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/keystore/src/aes-ctr.ts#L9) diff --git a/docs/packages/fuel-ts-math/classes/BN.md b/docs/packages/fuel-ts-math/classes/BN.md deleted file mode 100644 index ca74fb250c9..00000000000 --- a/docs/packages/fuel-ts-math/classes/BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/math" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/math](../index.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../index.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](BN.md) - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](BN.md) - -#### Returns - -[`BN`](BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../index.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](BN.md) | -| `mod` | [`BN`](BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](BN.md) | -| `b` | [`BN`](BN.md) | -| `gcd` | [`BN`](BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../index.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](BN.md) | -| `out` | [`BN`](BN.md) | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](BN.md) - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](BN.md) - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-math/index.md b/docs/packages/fuel-ts-math/index.md deleted file mode 100644 index 53ea0c51fcd..00000000000 --- a/docs/packages/fuel-ts-math/index.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -layout: default -title: "@fuel-ts/math" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/math - -## Namespaces - -- [bn](namespaces/bn.md) -- [internal](namespaces/internal.md) - -## Classes - -- [BN](classes/BN.md) - -## Type Aliases - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### BigNumberish - -Ƭ **BigNumberish**: `string` \| `number` \| [`BN`](classes/BN.md) - -#### Defined in - -[packages/math/src/types.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L3) - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](index.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) - -## Variables - -### DECIMAL\_UNITS - -• `Const` **DECIMAL\_UNITS**: ``9`` - -#### Defined in - -[packages/math/src/constants.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/constants.ts#L3) - -___ - -### DEFAULT\_MIN\_PRECISION - -• `Const` **DEFAULT\_MIN\_PRECISION**: ``3`` - -#### Defined in - -[packages/math/src/constants.ts:2](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/constants.ts#L2) - -___ - -### DEFAULT\_PRECISION - -• `Const` **DEFAULT\_PRECISION**: ``9`` - -#### Defined in - -[packages/math/src/constants.ts:1](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/constants.ts#L1) - -## Functions - -### bn - -▸ **bn**(`value?`, `base?`, `endian?`): [`BN`](classes/BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](index.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Returns - -[`BN`](classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:258](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L258) - -___ - -### format - -▸ **format**(`value`, `options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BNInput`](index.md#bninput) | -| `options?` | [`FormatConfig`](index.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/functional.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/functional.ts#L30) - -___ - -### formatUnits - -▸ **formatUnits**(`value`, `units?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BNInput`](index.md#bninput) | -| `units?` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/functional.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/functional.ts#L25) - -___ - -### max - -▸ **max**(...`numbers`): [`BN`](classes/BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...numbers` | [`BigNumberish`](index.md#bignumberish)[] | - -#### Returns - -[`BN`](classes/BN.md) - -#### Defined in - -[packages/math/src/math.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/math.ts#L5) - -___ - -### multiply - -▸ **multiply**(...`numbers`): [`BN`](classes/BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...numbers` | [`BigNumberish`](index.md#bignumberish)[] | - -#### Returns - -[`BN`](classes/BN.md) - -#### Defined in - -[packages/math/src/math.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/math.ts#L9) - -___ - -### toBytes - -▸ **toBytes**(`value`, `bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BNInput`](index.md#bninput) | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/functional.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/functional.ts#L20) - -___ - -### toFixed - -▸ **toFixed**(`value?`, `options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `string` \| `number` | -| `options?` | [`ToFixedConfig`](index.md#tofixedconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/decimal.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/decimal.ts#L4) - -___ - -### toHex - -▸ **toHex**(`value`, `bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BNInput`](index.md#bninput) | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/functional.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/functional.ts#L15) - -___ - -### toNumber - -▸ **toNumber**(`value`): `number` - -Functional shortcuts - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`BNInput`](index.md#bninput) | - -#### Returns - -`number` - -#### Defined in - -[packages/math/src/functional.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/functional.ts#L10) diff --git a/docs/packages/fuel-ts-math/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-math/interfaces/internal-BNHelper.md deleted file mode 100644 index 8c760d96d3f..00000000000 --- a/docs/packages/fuel-ts-math/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/math" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/math](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-math/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-math/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index d2debcf1bc9..00000000000 --- a/docs/packages/fuel-ts-math/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/math" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/math](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../index.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/BN.md) ; `mod`: [`BN`](../classes/BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../index.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/BN.md) | -| `mod` | [`BN`](../classes/BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/BN.md), `out`: [`BN`](../classes/BN.md)) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/BN.md) | -| `out` | [`BN`](../classes/BN.md) | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-math/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-math/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index 3eaec4ec28e..00000000000 --- a/docs/packages/fuel-ts-math/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/math" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/math](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../index.md#bninput)) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../index.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../index.md#bninput)) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../index.md#bninput)) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../index.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../index.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../index.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../index.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../index.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../index.md#bninput)) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../index.md#bninput)) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../index.md#bninput)) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../index.md#bninput)) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../index.md#bninput) | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-math/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-math/interfaces/internal-BNOverrides.md deleted file mode 100644 index 568fedcb1b9..00000000000 --- a/docs/packages/fuel-ts-math/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/math" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/math](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/BN.md) - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/BN.md) - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/BN.md) - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-math/namespaces/bn.md b/docs/packages/fuel-ts-math/namespaces/bn.md deleted file mode 100644 index 766aaa8dcda..00000000000 --- a/docs/packages/fuel-ts-math/namespaces/bn.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default -title: bn -parent: "@fuel-ts/math" -nav_order: 3 - ---- - -# Namespace: bn - -[@fuel-ts/math](../index.md).bn - -## Functions - -### parseUnits - -▸ **parseUnits**(`value`, `units?`): [`BN`](../classes/BN.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `value` | `string` | `undefined` | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -[`BN`](../classes/BN.md) - -#### Defined in - -[packages/math/src/bn.ts:261](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L261) diff --git a/docs/packages/fuel-ts-math/namespaces/internal.md b/docs/packages/fuel-ts-math/namespaces/internal.md deleted file mode 100644 index 567b774ae7f..00000000000 --- a/docs/packages/fuel-ts-math/namespaces/internal.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/math" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/math](../index.md).internal - -## Interfaces - -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) - -## Type Aliases - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) diff --git a/docs/packages/fuel-ts-merkle-shared/index.md b/docs/packages/fuel-ts-merkle-shared/index.md deleted file mode 100644 index da5ac2d0626..00000000000 --- a/docs/packages/fuel-ts-merkle-shared/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: "@fuel-ts/merkle-shared" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/merkle-shared - -## Variables - -### EMPTY - -• `Const` **EMPTY**: ``"0xe3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"`` - -#### Defined in - -[packages/merkle-shared/src/common.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle-shared/src/common.ts#L4) - -___ - -### MAX\_HEIGHT - -• `Const` **MAX\_HEIGHT**: ``256`` - -#### Defined in - -[packages/merkle-shared/src/common.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle-shared/src/common.ts#L6) - -___ - -### ZERO - -• `Const` **ZERO**: ``"0x0000000000000000000000000000000000000000000000000000000000000000"`` - -#### Defined in - -[packages/merkle-shared/src/common.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle-shared/src/common.ts#L5) - -## Functions - -### hash - -▸ **hash**(`data`): `string` - -The primary hash function for Fuel -SHA-256 - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `BytesLike` | - -#### Returns - -`string` - -#### Defined in - -[packages/merkle-shared/src/cryptography.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle-shared/src/cryptography.ts#L8) diff --git a/docs/packages/fuel-ts-merkle/classes/internal-Node.md b/docs/packages/fuel-ts-merkle/classes/internal-Node.md deleted file mode 100644 index 09abdda4030..00000000000 --- a/docs/packages/fuel-ts-merkle/classes/internal-Node.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: default -title: Node -parent: "@fuel-ts/merkle" -nav_order: 1 - ---- - -# Class: Node - -[@fuel-ts/merkle](../index.md).[internal](../namespaces/internal.md).Node - -## Constructors - -### constructor - -• **new Node**(`left`, `right`, `parent`, `hash`, `data`, `index?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `left` | `number` | `undefined` | -| `right` | `number` | `undefined` | -| `parent` | `number` | `undefined` | -| `hash` | `string` | `undefined` | -| `data` | `string` | `undefined` | -| `index` | `number` | `0` | - -#### Defined in - -[packages/merkle/src/types/node.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/types/node.ts#L9) - -## Properties - -### data - -• **data**: `string` - -#### Defined in - -[packages/merkle/src/types/node.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/types/node.ts#L6) - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -[packages/merkle/src/types/node.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/types/node.ts#L5) - -___ - -### index - -• **index**: `number` - -#### Defined in - -[packages/merkle/src/types/node.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/types/node.ts#L7) - -___ - -### left - -• **left**: `number` - -#### Defined in - -[packages/merkle/src/types/node.ts:2](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/types/node.ts#L2) - -___ - -### parent - -• **parent**: `number` - -#### Defined in - -[packages/merkle/src/types/node.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/types/node.ts#L4) - -___ - -### right - -• **right**: `number` - -#### Defined in - -[packages/merkle/src/types/node.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/types/node.ts#L3) diff --git a/docs/packages/fuel-ts-merkle/index.md b/docs/packages/fuel-ts-merkle/index.md deleted file mode 100644 index 204acb517c1..00000000000 --- a/docs/packages/fuel-ts-merkle/index.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -layout: default -title: "@fuel-ts/merkle" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/merkle - -## Namespaces - -- [internal](namespaces/internal.md) - -## Functions - -### calcRoot - -▸ **calcRoot**(`data`): `string` - -Compute the merkle root - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string`[] | - -#### Returns - -`string` - -#### Defined in - -[packages/merkle/src/binaryMerkleTree.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/binaryMerkleTree.ts#L71) - -___ - -### constructTree - -▸ **constructTree**(`data`): [`Node`](classes/internal-Node.md)[] - -Construct tree - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string`[] | - -#### Returns - -[`Node`](classes/internal-Node.md)[] - -#### Defined in - -[packages/merkle/src/binaryMerkleTree.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/binaryMerkleTree.ts#L24) - -___ - -### getProof - -▸ **getProof**(`nodes`, `id`): `string`[] - -Get proof for the leaf - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodes` | [`Node`](classes/internal-Node.md)[] | -| `id` | `number` | - -#### Returns - -`string`[] - -#### Defined in - -[packages/merkle/src/binaryMerkleTree.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/binaryMerkleTree.ts#L107) - -___ - -### hashLeaf - -▸ **hashLeaf**(`data`): `string` - -Slice off the '0x' on each argument to simulate abi.encodePacked - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/merkle/src/binaryMerkleTree.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/binaryMerkleTree.ts#L9) - -___ - -### hashNode - -▸ **hashNode**(`left`, `right`): `string` - -Slice off the '0x' on each argument to simulate abi.encodePacked -hash(prefix + left + right) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `left` | `string` | -| `right` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/merkle/src/binaryMerkleTree.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merkle/src/binaryMerkleTree.ts#L17) diff --git a/docs/packages/fuel-ts-merkle/namespaces/internal.md b/docs/packages/fuel-ts-merkle/namespaces/internal.md deleted file mode 100644 index d9a886d104d..00000000000 --- a/docs/packages/fuel-ts-merkle/namespaces/internal.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/merkle" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/merkle](../index.md).internal - -## Classes - -- [Node](../classes/internal-Node.md) diff --git a/docs/packages/fuel-ts-merklesum/classes/internal-Node.md b/docs/packages/fuel-ts-merklesum/classes/internal-Node.md deleted file mode 100644 index 98bbe78cde0..00000000000 --- a/docs/packages/fuel-ts-merklesum/classes/internal-Node.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -layout: default -title: Node -parent: "@fuel-ts/merklesum" -nav_order: 1 - ---- - -# Class: Node - -[@fuel-ts/merklesum](../index.md).[internal](../namespaces/internal.md).Node - -## Constructors - -### constructor - -• **new Node**(`left`, `right`, `parent`, `hash`, `sum`, `data`, `index?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `left` | `number` | `undefined` | -| `right` | `number` | `undefined` | -| `parent` | `number` | `undefined` | -| `hash` | `string` | `undefined` | -| `sum` | `string` | `undefined` | -| `data` | `string` | `undefined` | -| `index` | `number` | `0` | - -#### Defined in - -[packages/merklesum/src/types/node.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/node.ts#L10) - -## Properties - -### data - -• **data**: `string` - -#### Defined in - -[packages/merklesum/src/types/node.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/node.ts#L6) - -___ - -### hash - -• **hash**: `string` - -#### Defined in - -[packages/merklesum/src/types/node.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/node.ts#L5) - -___ - -### index - -• **index**: `number` - -#### Defined in - -[packages/merklesum/src/types/node.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/node.ts#L8) - -___ - -### left - -• **left**: `number` - -#### Defined in - -[packages/merklesum/src/types/node.ts:2](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/node.ts#L2) - -___ - -### parent - -• **parent**: `number` - -#### Defined in - -[packages/merklesum/src/types/node.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/node.ts#L4) - -___ - -### right - -• **right**: `number` - -#### Defined in - -[packages/merklesum/src/types/node.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/node.ts#L3) - -___ - -### sum - -• **sum**: `string` - -#### Defined in - -[packages/merklesum/src/types/node.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/node.ts#L7) diff --git a/docs/packages/fuel-ts-merklesum/classes/internal-Proof.md b/docs/packages/fuel-ts-merklesum/classes/internal-Proof.md deleted file mode 100644 index 2f6a5952c82..00000000000 --- a/docs/packages/fuel-ts-merklesum/classes/internal-Proof.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: default -title: Proof -parent: "@fuel-ts/merklesum" -nav_order: 1 - ---- - -# Class: Proof - -[@fuel-ts/merklesum](../index.md).[internal](../namespaces/internal.md).Proof - -## Constructors - -### constructor - -• **new Proof**(`sideNodes`, `sums`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sideNodes` | `string`[] | -| `sums` | `string`[] | - -#### Defined in - -[packages/merklesum/src/types/proof.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/proof.ts#L6) - -## Properties - -### nodeSums - -• **nodeSums**: `string`[] - -#### Defined in - -[packages/merklesum/src/types/proof.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/proof.ts#L4) - -___ - -### sideNodes - -• **sideNodes**: `string`[] - -#### Defined in - -[packages/merklesum/src/types/proof.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/types/proof.ts#L3) diff --git a/docs/packages/fuel-ts-merklesum/index.md b/docs/packages/fuel-ts-merklesum/index.md deleted file mode 100644 index b427cffd2f6..00000000000 --- a/docs/packages/fuel-ts-merklesum/index.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -layout: default -title: "@fuel-ts/merklesum" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/merklesum - -## Namespaces - -- [internal](namespaces/internal.md) - -## Functions - -### calcRoot - -▸ **calcRoot**(`sums`, `data`): [`Node`](classes/internal-Node.md) - -Compute the merkle root - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sums` | `string`[] | -| `data` | `string`[] | - -#### Returns - -[`Node`](classes/internal-Node.md) - -#### Defined in - -[packages/merklesum/src/sumMerkleTree.ts:88](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/sumMerkleTree.ts#L88) - -___ - -### constructTree - -▸ **constructTree**(`sums`, `data`): [`Node`](classes/internal-Node.md)[] - -Construct tree - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sums` | `string`[] | -| `data` | `string`[] | - -#### Returns - -[`Node`](classes/internal-Node.md)[] - -#### Defined in - -[packages/merklesum/src/sumMerkleTree.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/sumMerkleTree.ts#L39) - -___ - -### getProof - -▸ **getProof**(`nodes`, `id`): [`Proof`](classes/internal-Proof.md) - -Get proof for the leaf - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `nodes` | [`Node`](classes/internal-Node.md)[] | -| `id` | `number` | - -#### Returns - -[`Proof`](classes/internal-Proof.md) - -#### Defined in - -[packages/merklesum/src/sumMerkleTree.ts:130](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/sumMerkleTree.ts#L130) - -___ - -### hashLeaf - -▸ **hashLeaf**(`value`, `data`): `string` - -Slice off the '0x' on each argument to simulate abi.encodePacked -hash(prefix + value + data) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | -| `data` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/merklesum/src/sumMerkleTree.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/sumMerkleTree.ts#L13) - -___ - -### hashNode - -▸ **hashNode**(`leftValue`, `left`, `rightValue`, `right`): `string` - -Slice off the '0x' on each argument to simulate abi.encodePacked -hash (prefix + leftSum + leftHash + rightSum + rightHash) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `leftValue` | `string` | -| `left` | `string` | -| `rightValue` | `string` | -| `right` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/merklesum/src/sumMerkleTree.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/merklesum/src/sumMerkleTree.ts#L21) diff --git a/docs/packages/fuel-ts-merklesum/namespaces/internal.md b/docs/packages/fuel-ts-merklesum/namespaces/internal.md deleted file mode 100644 index 7866fc35e6f..00000000000 --- a/docs/packages/fuel-ts-merklesum/namespaces/internal.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/merklesum" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/merklesum](../index.md).internal - -## Classes - -- [Node](../classes/internal-Node.md) -- [Proof](../classes/internal-Proof.md) diff --git a/docs/packages/fuel-ts-mnemonic/classes/Mnemonic.md b/docs/packages/fuel-ts-mnemonic/classes/Mnemonic.md deleted file mode 100644 index 828de4b7ec2..00000000000 --- a/docs/packages/fuel-ts-mnemonic/classes/Mnemonic.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -layout: default -title: Mnemonic -parent: "@fuel-ts/mnemonic" -nav_order: 1 - ---- - -# Class: Mnemonic - -[@fuel-ts/mnemonic](../index.md).Mnemonic - -## Constructors - -### constructor - -• **new Mnemonic**(`wordlist?`) - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `wordlist` | `string`[] | `english` | Provide a wordlist with the list of words used to generate the mnemonic phrase. The default value is the English list. | - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L54) - -## Properties - -### wordlist - -• **wordlist**: `string`[] - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L47) - -## Methods - -### entropyToMnemonic - -▸ **entropyToMnemonic**(`entropy`): `string` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `entropy` | `BytesLike` | Entropy source to the mnemonic phrase. | - -#### Returns - -`string` - -Mnemonic phrase - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L74) - -___ - -### mnemonicToEntropy - -▸ **mnemonicToEntropy**(`phrase`): `string` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `phrase` | [`MnemonicPhrase`](../index.md#mnemonicphrase) | Mnemonic phrase composed by words from the provided wordlist | - -#### Returns - -`string` - -Entropy hash - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L65) - -___ - -### binarySearch - -▸ `Static` **binarySearch**(`target`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `target` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:158](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L158) - -___ - -### entropyToMnemonic - -▸ `Static` **entropyToMnemonic**(`entropy`, `wordlist?`): `string` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `entropy` | `BytesLike` | `undefined` | Entropy source to the mnemonic phrase. | -| `wordlist` | `string`[] | `english` | - | - -#### Returns - -`string` - -64-byte array contains privateKey and chainCode as described on BIP39 - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:97](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L97) - -___ - -### generate - -▸ `Static` **generate**(`size?`, `extraEntropy?`): `string` - -Create a new mnemonic using a randomly generated number as entropy. - As defined in BIP39, the entropy must be a multiple of 32 bits, and its size must be between 128 and 256 bits. - Therefore, the possible values for `strength` are 128, 160, 192, 224, and 256. - If not provided, the default entropy length will be set to 256 bits. - The return is a list of words that encodes the generated entropy. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `size` | `number` | `32` | Number of bytes used as an entropy | -| `extraEntropy` | `BytesLike` | `''` | Optional extra entropy to increase randomness | - -#### Returns - -`string` - -A randomly generated mnemonic - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:231](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L231) - -___ - -### isMnemonicValid - -▸ `Static` **isMnemonicValid**(`phrase`): `boolean` - -Validates if given mnemonic is valid - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `phrase` | `string` | Mnemonic phrase composed by words from the provided wordlist | - -#### Returns - -`boolean` - -true if phrase is a valid mnemonic - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:139](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L139) - -___ - -### masterKeysFromSeed - -▸ `Static` **masterKeysFromSeed**(`seed`): `Uint8Array` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `seed` | `string` | BIP39 seed | - -#### Returns - -`Uint8Array` - -64-byte array contains privateKey and chainCode as described on BIP39 - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L179) - -___ - -### mnemonicToEntropy - -▸ `Static` **mnemonicToEntropy**(`phrase`, `wordlist?`): `string` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `phrase` | [`MnemonicPhrase`](../index.md#mnemonicphrase) | `undefined` | Mnemonic phrase composed by words from the provided wordlist | -| `wordlist` | `string`[] | `english` | Provide a wordlist with the list of words used to generate the mnemonic phrase. The default value is the English list. | - -#### Returns - -`string` - -Mnemonic phrase - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:84](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L84) - -___ - -### mnemonicToMasterKeys - -▸ `Static` **mnemonicToMasterKeys**(`phrase`, `passphrase?`): `Uint8Array` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `phrase` | [`MnemonicPhrase`](../index.md#mnemonicphrase) | `undefined` | Mnemonic phrase composed by words from the provided wordlist | -| `passphrase` | `BytesLike` | `''` | Add additional security to protect the generated seed with a memorized passphrase. `Note: if the owner forgot the passphrase, all wallets and accounts derive from the phrase will be lost.` | - -#### Returns - -`Uint8Array` - -64-byte array contains privateKey and chainCode as described on BIP39 - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L129) - -___ - -### mnemonicToSeed - -▸ `Static` **mnemonicToSeed**(`phrase`, `passphrase?`): `string` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `phrase` | [`MnemonicPhrase`](../index.md#mnemonicphrase) | `undefined` | Mnemonic phrase composed by words from the provided wordlist | -| `passphrase` | `BytesLike` | `''` | Add additional security to protect the generated seed with a memorized passphrase. `Note: if the owner forgot the passphrase, all wallets and accounts derive from the phrase will be lost.` | - -#### Returns - -`string` - -64-byte array contains privateKey and chainCode as described on BIP39 - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:115](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L115) - -___ - -### seedToExtendedKey - -▸ `Static` **seedToExtendedKey**(`seed`, `testnet?`): `string` - -Get the extendKey as defined on BIP-32 from the provided seed - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `seed` | `string` | `undefined` | BIP39 seed | -| `testnet` | `boolean` | `false` | Inform if should use testnet or mainnet prefix, default value is true (`mainnet`). | - -#### Returns - -`string` - -BIP-32 extended private key - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:196](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L196) diff --git a/docs/packages/fuel-ts-mnemonic/index.md b/docs/packages/fuel-ts-mnemonic/index.md deleted file mode 100644 index e32ab7ae574..00000000000 --- a/docs/packages/fuel-ts-mnemonic/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: "@fuel-ts/mnemonic" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/mnemonic - -## Classes - -- [Mnemonic](classes/Mnemonic.md) - -## Type Aliases - -### MnemonicPhrase - -Ƭ **MnemonicPhrase**: `string` \| `string`[] - -#### Defined in - -[packages/mnemonic/src/utils.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/utils.ts#L6) - -## Variables - -### MNEMONIC\_SIZES - -• `Const` **MNEMONIC\_SIZES**: `number`[] - -#### Defined in - -[packages/mnemonic/src/mnemonic.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/mnemonic/src/mnemonic.ts#L26) diff --git a/docs/packages/fuel-ts-predicate/classes/Predicate.md b/docs/packages/fuel-ts-predicate/classes/Predicate.md deleted file mode 100644 index 6bc58b0d434..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/Predicate.md +++ /dev/null @@ -1,457 +0,0 @@ ---- -layout: default -title: Predicate -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: Predicate - -[@fuel-ts/predicate](../index.md).Predicate - -Account - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `ARGS` | extends [`InputValue`](../namespaces/internal.md#inputvalue)[] | - -## Hierarchy - -- [`Account`](internal-Account.md) - - ↳ **`Predicate`** - -## Constructors - -### constructor - -• **new Predicate**<`ARGS`\>(`bytes`, `types?`, `provider?`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `ARGS` | extends [`InputValue`](../namespaces/internal.md#inputvalue)<`void`\>[] | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytes` | `BytesLike` | -| `types?` | [`JsonAbi`](../namespaces/internal.md#jsonabi) | -| `provider?` | `string` \| `default` | - -#### Overrides - -[Account](internal-Account.md).[constructor](internal-Account.md#constructor) - -#### Defined in - -[packages/predicate/src/predicate.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/predicate/src/predicate.ts#L28) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Inherited from - -[Account](internal-Account.md).[address](internal-Account.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### bytes - -• **bytes**: `Uint8Array` - -#### Defined in - -[packages/predicate/src/predicate.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/predicate/src/predicate.ts#L23) - -___ - -### interface - -• `Optional` **interface**: `default` - -#### Defined in - -[packages/predicate/src/predicate.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/predicate/src/predicate.ts#L26) - -___ - -### predicateData - -• **predicateData**: `Uint8Array` - -#### Defined in - -[packages/predicate/src/predicate.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/predicate/src/predicate.ts#L25) - -___ - -### provider - -• **provider**: `default` - -#### Inherited from - -[Account](internal-Account.md).[provider](internal-Account.md#provider) - -#### Defined in - -[packages/wallet/src/account.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L37) - -___ - -### types - -• `Optional` **types**: readonly [`JsonAbiFragmentType`](../interfaces/internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/predicate/src/predicate.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/predicate/src/predicate.ts#L24) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Inherited from - -[Account](internal-Account.md).[connect](internal-Account.md#connect) - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[Account](internal-Account.md).[fund](internal-Account.md#fund) - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Inherited from - -[Account](internal-Account.md).[getBalance](internal-Account.md#getbalance) - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getBalances](internal-Account.md#getbalances) - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getCoins](internal-Account.md#getcoins) - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getMessages](internal-Account.md#getmessages) - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getResourcesToSpend](internal-Account.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### populateTransactionPredicateData - -▸ **populateTransactionPredicateData**(`transactionRequestLike`): [`TransactionRequest`](../namespaces/internal.md#transactionrequest) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -[`TransactionRequest`](../namespaces/internal.md#transactionrequest) - -#### Defined in - -[packages/predicate/src/predicate.ts:50](https://github.com/FuelLabs/fuels-ts/blob/master/packages/predicate/src/predicate.ts#L50) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Overrides - -[Account](internal-Account.md).[sendTransaction](internal-Account.md#sendtransaction) - -#### Defined in - -[packages/predicate/src/predicate.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/predicate/src/predicate.ts#L65) - -___ - -### setData - -▸ **setData**<`T`\>(...`args`): [`Predicate`](Predicate.md)<`ARGS`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`InputValue`](../namespaces/internal.md#inputvalue)<`void`\>[] | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `T` | - -#### Returns - -[`Predicate`](Predicate.md)<`ARGS`\> - -#### Defined in - -[packages/predicate/src/predicate.ts:75](https://github.com/FuelLabs/fuels-ts/blob/master/packages/predicate/src/predicate.ts#L75) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Overrides - -[Account](internal-Account.md).[simulateTransaction](internal-Account.md#simulatetransaction) - -#### Defined in - -[packages/predicate/src/predicate.ts:70](https://github.com/FuelLabs/fuels-ts/blob/master/packages/predicate/src/predicate.ts#L70) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](internal-Account.md).[transfer](internal-Account.md#transfer) - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](internal-Account.md).[withdrawToBaseLayer](internal-Account.md#withdrawtobaselayer) - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-AbstractAccount.md b/docs/packages/fuel-ts-predicate/classes/internal-AbstractAccount.md deleted file mode 100644 index ad9964fd253..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-AbstractAccount.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -layout: default -title: AbstractAccount -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: AbstractAccount - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).AbstractAccount - -## Hierarchy - -- **`AbstractAccount`** - - ↳ [`Account`](internal-Account.md) - -## Constructors - -### constructor - -• **new AbstractAccount**() - -## Properties - -### address - -• `Abstract` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L26) - -___ - -### provider - -• `Abstract` **provider**: `unknown` - -#### Defined in - -[packages/interfaces/src/index.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L27) - -## Methods - -### getResourcesToSpend - -▸ `Abstract` **getResourcesToSpend**(`quantities`, `options?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | `any`[] | -| `options?` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L28) - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L29) - -___ - -### simulateTransaction - -▸ `Abstract` **simulateTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L30) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-AbstractAddress.md b/docs/packages/fuel-ts-predicate/classes/internal-AbstractAddress.md deleted file mode 100644 index 77f84ce598c..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-AbstractAddress.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: default -title: AbstractAddress -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: AbstractAddress - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).AbstractAddress - -## Constructors - -### constructor - -• **new AbstractAddress**() - -## Methods - -### equals - -▸ `Abstract` **equals**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/interfaces/src/index.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L21) - -___ - -### toAddress - -▸ `Abstract` **toAddress**(): \`fuel${string}\` - -#### Returns - -\`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L17) - -___ - -### toB256 - -▸ `Abstract` **toB256**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L18) - -___ - -### toBytes - -▸ `Abstract` **toBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L20) - -___ - -### toHexString - -▸ `Abstract` **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L19) - -___ - -### toJSON - -▸ `Abstract` **toJSON**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L15) - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L16) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-AbstractContract.md b/docs/packages/fuel-ts-predicate/classes/internal-AbstractContract.md deleted file mode 100644 index 3b5b224a65d..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-AbstractContract.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: default -title: AbstractContract -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: AbstractContract - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).AbstractContract - -## Hierarchy - -- [`AbstractProgram`](internal-AbstractProgram.md) - - ↳ **`AbstractContract`** - -## Constructors - -### constructor - -• **new AbstractContract**() - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[constructor](internal-AbstractProgram.md#constructor) - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[account](internal-AbstractProgram.md#account) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### id - -• `Abstract` **id**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L48) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[interface](internal-AbstractProgram.md#interface) - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[provider](internal-AbstractProgram.md#provider) - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-AbstractProgram.md b/docs/packages/fuel-ts-predicate/classes/internal-AbstractProgram.md deleted file mode 100644 index 2545c1ffa27..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-AbstractProgram.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: AbstractProgram -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: AbstractProgram - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).AbstractProgram - -## Hierarchy - -- **`AbstractProgram`** - - ↳ [`AbstractContract`](internal-AbstractContract.md) - -## Constructors - -### constructor - -• **new AbstractProgram**() - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-AbstractScriptRequest.md b/docs/packages/fuel-ts-predicate/classes/internal-AbstractScriptRequest.md deleted file mode 100644 index d4919e292c9..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-AbstractScriptRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default -title: AbstractScriptRequest -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: AbstractScriptRequest - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).AbstractScriptRequest - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Constructors - -### constructor - -• **new AbstractScriptRequest**<`T`\>() - -#### Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### bytes - -• `Abstract` **bytes**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L9) - -___ - -### encodeScriptData - -• `Abstract` **encodeScriptData**: (`data`: `T`) => `Uint8Array` - -#### Type declaration - -▸ (`data`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L10) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-Account.md b/docs/packages/fuel-ts-predicate/classes/internal-Account.md deleted file mode 100644 index f613bf4cb27..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-Account.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -layout: default -title: Account -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: Account - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).Account - -Account - -## Hierarchy - -- [`AbstractAccount`](internal-AbstractAccount.md) - - ↳ **`Account`** - - ↳↳ [`Predicate`](Predicate.md) - -## Constructors - -### constructor - -• **new Account**(`address`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[constructor](internal-AbstractAccount.md#constructor) - -#### Defined in - -[packages/wallet/src/account.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L39) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[address](internal-AbstractAccount.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[provider](internal-AbstractAccount.md#provider) - -#### Defined in - -[packages/wallet/src/account.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[getResourcesToSpend](internal-AbstractAccount.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[sendTransaction](internal-AbstractAccount.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/account.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L253) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[simulateTransaction](internal-AbstractAccount.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/account.ts:267](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L267) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-BN.md b/docs/packages/fuel-ts-predicate/classes/internal-BN.md deleted file mode 100644 index be94576a6e4..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../namespaces/internal.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](internal-BN.md) | -| `mod` | [`BN`](internal-BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](internal-BN.md) | -| `b` | [`BN`](internal-BN.md) | -| `gcd` | [`BN`](internal-BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../namespaces/internal.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](internal-BN.md) | -| `out` | [`BN`](internal-BN.md) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-BaseTransactionRequest.md b/docs/packages/fuel-ts-predicate/classes/internal-BaseTransactionRequest.md deleted file mode 100644 index e161b558257..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-BaseTransactionRequest.md +++ /dev/null @@ -1,526 +0,0 @@ ---- -layout: default -title: BaseTransactionRequest -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: BaseTransactionRequest - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequest - -## Hierarchy - -- **`BaseTransactionRequest`** - - ↳ [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - - ↳ [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -## Implements - -- [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) - -## Constructors - -### constructor - -• **new BaseTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) | - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L131) - -## Properties - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasLimit](../interfaces/internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasPrice](../interfaces/internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[inputs](../interfaces/internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[maturity](../interfaces/internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[outputs](../interfaces/internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### type - -• `Abstract` **type**: [`TransactionType`](../enums/internal-TransactionType.md) - -Type of the transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:117](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L117) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[witnesses](../interfaces/internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ `Abstract` **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:167](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L167) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-CreateTransactionRequest.md b/docs/packages/fuel-ts-predicate/classes/internal-CreateTransactionRequest.md deleted file mode 100644 index b2caaea4242..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-CreateTransactionRequest.md +++ /dev/null @@ -1,703 +0,0 @@ ---- -layout: default -title: CreateTransactionRequest -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: CreateTransactionRequest - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`CreateTransactionRequest`** - -## Constructors - -### constructor - -• **new CreateTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:528](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L528) - -## Properties - -### bytecodeWitnessIndex - -• **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:522](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L522) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### salt - -• **salt**: `string` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:524](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L524) - -___ - -### storageSlots - -• **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:526](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L526) - -___ - -### type - -• **type**: [`Create`](../namespaces/internal.md#create) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:520](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L520) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContractCreatedOutput - -▸ **addContractCreatedOutput**(`contractId`, `stateRoot`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:562](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L562) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractCreatedOutputs - -▸ **getContractCreatedOutputs**(): [`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Returns - -[`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:555](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L555) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:540](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L540) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Returns - -[`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:512](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L512) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-ScriptTransactionRequest.md b/docs/packages/fuel-ts-predicate/classes/internal-ScriptTransactionRequest.md deleted file mode 100644 index bf259a5802a..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-ScriptTransactionRequest.md +++ /dev/null @@ -1,797 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequest -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: ScriptTransactionRequest - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`ScriptTransactionRequest`** - -## Constructors - -### constructor - -• **new ScriptTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:406](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L406) - -## Properties - -### bytesOffset - -• **bytesOffset**: `undefined` \| `number` - -determined bytes offset for start of script data - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:404](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L404) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### script - -• **script**: `Uint8Array` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:400](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L400) - -___ - -### scriptData - -• **scriptData**: `Uint8Array` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:402](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L402) - -___ - -### type - -• **type**: [`Script`](../namespaces/internal.md#script) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:398](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L398) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContract - -▸ **addContract**(`contract`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | [`ContractIdLike`](../namespaces/internal.md#contractidlike) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:481](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L481) - -___ - -### addMessageOutputs - -▸ **addMessageOutputs**(`numberOfMessages?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfMessages` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:466](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L466) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### addVariableOutputs - -▸ **addVariableOutputs**(`numberOfVariables?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfVariables` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:453](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L453) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractInputs - -▸ **getContractInputs**(): [`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Returns - -[`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:426](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L426) - -___ - -### getContractOutputs - -▸ **getContractOutputs**(): [`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Returns - -[`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:432](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L432) - -___ - -### getVariableOutputs - -▸ **getVariableOutputs**(): [`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Returns - -[`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:438](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L438) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### setScript - -▸ **setScript**<`T`\>(`script`, `data`): `void` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `script` | [`AbstractScriptRequest`](internal-AbstractScriptRequest.md)<`T`\> | -| `data` | `T` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:444](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L444) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:412](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L412) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Returns - -[`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:390](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L390) diff --git a/docs/packages/fuel-ts-predicate/classes/internal-TransactionResponse.md b/docs/packages/fuel-ts-predicate/classes/internal-TransactionResponse.md deleted file mode 100644 index 153d3388a05..00000000000 --- a/docs/packages/fuel-ts-predicate/classes/internal-TransactionResponse.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -layout: default -title: TransactionResponse -parent: "@fuel-ts/predicate" -nav_order: 1 - ---- - -# Class: TransactionResponse - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).TransactionResponse - -## Constructors - -### constructor - -• **new TransactionResponse**(`id`, `provider`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `provider` | `default` | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L102) - -## Properties - -### attempts - -• **attempts**: `number` = `0` - -Number off attempts to get the committed tx - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L100) - -___ - -### gasUsed - -• **gasUsed**: [`BN`](internal-BN.md) - -Gas used on the transaction - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L98) - -___ - -### id - -• **id**: `string` - -Transaction ID - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L94) - -___ - -### provider - -• **provider**: `default` - -Current provider - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L96) - -## Methods - -### decodeTransaction - -▸ **decodeTransaction**<`TTransactionType`\>(`transactionWithReceipts`): [`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionWithReceipts` | `Object` | -| `transactionWithReceipts.__typename` | ``"Transaction"`` | -| `transactionWithReceipts.gasPrice?` | ``null`` \| `string` | -| `transactionWithReceipts.id` | `string` | -| `transactionWithReceipts.rawPayload` | `string` | -| `transactionWithReceipts.receipts?` | ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] | -| `transactionWithReceipts.status?` | ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } | - -#### Returns - -[`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:114](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L114) - -___ - -### fetch - -▸ **fetch**(): `Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Returns - -`Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L107) - -___ - -### wait - -▸ **wait**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -Waits for transaction to succeed and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:188](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L188) - -___ - -### waitForResult - -▸ **waitForResult**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -Waits for transaction to succeed or fail and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:124](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L124) diff --git a/docs/packages/fuel-ts-predicate/enums/internal-GqlCoinStatus.md b/docs/packages/fuel-ts-predicate/enums/internal-GqlCoinStatus.md deleted file mode 100644 index eec964d719d..00000000000 --- a/docs/packages/fuel-ts-predicate/enums/internal-GqlCoinStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlCoinStatus -parent: "@fuel-ts/predicate" -nav_order: 4 - ---- - -# Enumeration: GqlCoinStatus - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).GqlCoinStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:157 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:158 diff --git a/docs/packages/fuel-ts-predicate/enums/internal-GqlMessageStatus.md b/docs/packages/fuel-ts-predicate/enums/internal-GqlMessageStatus.md deleted file mode 100644 index 10f93bd13d0..00000000000 --- a/docs/packages/fuel-ts-predicate/enums/internal-GqlMessageStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlMessageStatus -parent: "@fuel-ts/predicate" -nav_order: 4 - ---- - -# Enumeration: GqlMessageStatus - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).GqlMessageStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:373 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:374 diff --git a/docs/packages/fuel-ts-predicate/enums/internal-GqlReturnType.md b/docs/packages/fuel-ts-predicate/enums/internal-GqlReturnType.md deleted file mode 100644 index e53e7262d2d..00000000000 --- a/docs/packages/fuel-ts-predicate/enums/internal-GqlReturnType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: GqlReturnType -parent: "@fuel-ts/predicate" -nav_order: 4 - ---- - -# Enumeration: GqlReturnType - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).GqlReturnType - -## Enumeration Members - -### Return - -• **Return** = ``"RETURN"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:688 - -___ - -### ReturnData - -• **ReturnData** = ``"RETURN_DATA"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:689 - -___ - -### Revert - -• **Revert** = ``"REVERT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:690 diff --git a/docs/packages/fuel-ts-predicate/enums/internal-TransactionType.md b/docs/packages/fuel-ts-predicate/enums/internal-TransactionType.md deleted file mode 100644 index 12f74cc3297..00000000000 --- a/docs/packages/fuel-ts-predicate/enums/internal-TransactionType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: TransactionType -parent: "@fuel-ts/predicate" -nav_order: 4 - ---- - -# Enumeration: TransactionType - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).TransactionType - -## Enumeration Members - -### Create - -• **Create** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Mint - -• **Mint** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L22) - -___ - -### Script - -• **Script** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) diff --git a/docs/packages/fuel-ts-predicate/index.md b/docs/packages/fuel-ts-predicate/index.md deleted file mode 100644 index fe9d595b260..00000000000 --- a/docs/packages/fuel-ts-predicate/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default -title: "@fuel-ts/predicate" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/predicate - -## Namespaces - -- [internal](namespaces/internal.md) - -## Classes - -- [Predicate](classes/Predicate.md) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-predicate/interfaces/internal-BNHelper.md deleted file mode 100644 index f3da5d00761..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-predicate/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index c14de02e094..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../namespaces/internal.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/internal-BN.md) ; `mod`: [`BN`](../classes/internal-BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/internal-BN.md) | -| `mod` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/internal-BN.md), `out`: [`BN`](../classes/internal-BN.md)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/internal-BN.md) | -| `out` | [`BN`](../classes/internal-BN.md) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-predicate/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index e027f0fbee4..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-predicate/interfaces/internal-BNOverrides.md deleted file mode 100644 index 76c0ffe3c60..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-BaseTransactionRequestLike.md b/docs/packages/fuel-ts-predicate/interfaces/internal-BaseTransactionRequestLike.md deleted file mode 100644 index 376ca16a342..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-BaseTransactionRequestLike.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -layout: default -title: BaseTransactionRequestLike -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: BaseTransactionRequestLike - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequestLike - -## Hierarchy - -- **`BaseTransactionRequestLike`** - - ↳ [`ScriptTransactionRequestLike`](internal-ScriptTransactionRequestLike.md) - - ↳ [`CreateTransactionRequestLike`](internal-CreateTransactionRequestLike.md) - -## Implemented by - -- [`BaseTransactionRequest`](../classes/internal-BaseTransactionRequest.md) - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-CreateTransactionRequestLike.md b/docs/packages/fuel-ts-predicate/interfaces/internal-CreateTransactionRequestLike.md deleted file mode 100644 index f00cd414d93..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-CreateTransactionRequestLike.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -layout: default -title: CreateTransactionRequestLike -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: CreateTransactionRequestLike - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`CreateTransactionRequestLike`** - -## Properties - -### bytecodeWitnessIndex - -• `Optional` **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:504](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L504) - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### salt - -• `Optional` **salt**: `BytesLike` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:506](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L506) - -___ - -### storageSlots - -• `Optional` **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:508](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L508) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFragment.md b/docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFragment.md deleted file mode 100644 index 50ff1266a77..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFragment.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: JsonAbiFragment -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: JsonAbiFragment - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).JsonAbiFragment - -## Properties - -### attributes - -• `Optional` `Readonly` **attributes**: readonly [`JsonAbiFunctionAttributeType`](internal-JsonAbiFunctionAttributeType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L33) - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L31) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L30) - -___ - -### outputs - -• `Optional` `Readonly` **outputs**: readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L32) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L24) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFragmentType.md b/docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFragmentType.md deleted file mode 100644 index 1b6c8e7967c..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFragmentType.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: JsonAbiFragmentType -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: JsonAbiFragmentType - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).JsonAbiFragmentType - -## Properties - -### components - -• `Optional` `Readonly` **components**: ``null`` \| readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L14) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L12) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L11) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: ``null`` \| readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L15) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFunctionAttributeType.md b/docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFunctionAttributeType.md deleted file mode 100644 index a9c76456543..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonAbiFunctionAttributeType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: JsonAbiFunctionAttributeType -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: JsonAbiFunctionAttributeType - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).JsonAbiFunctionAttributeType - -## Properties - -### arguments - -• `Readonly` **arguments**: readonly `string`[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L20) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L19) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbi.md b/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbi.md deleted file mode 100644 index c4aa6920daa..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbi.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: JsonFlatAbi -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: JsonFlatAbi - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).JsonFlatAbi - -## Properties - -### functions - -• `Readonly` **functions**: readonly [`JsonFlatAbiFragmentFunction`](internal-JsonFlatAbiFragmentFunction.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L71) - -___ - -### loggedTypes - -• `Readonly` **loggedTypes**: readonly [`JsonFlatAbiFragmentLoggedType`](internal-JsonFlatAbiFragmentLoggedType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:70](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L70) - -___ - -### types - -• `Readonly` **types**: readonly [`JsonFlatAbiFragmentType`](internal-JsonFlatAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:69](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L69) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentArgumentType.md b/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentArgumentType.md deleted file mode 100644 index 888f54fc279..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentArgumentType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentArgumentType -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentArgumentType - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentArgumentType - -## Properties - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L57) - -___ - -### type - -• `Readonly` **type**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L56) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: ``null`` \| readonly [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:58](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L58) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentFunction.md b/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentFunction.md deleted file mode 100644 index 2c699471642..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentFunction.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentFunction -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentFunction - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentFunction - -## Properties - -### attributes - -• `Optional` `Readonly` **attributes**: ``null`` \| readonly [`JsonAbiFunctionAttributeType`](internal-JsonAbiFunctionAttributeType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L65) - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L63) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L62) - -___ - -### output - -• `Optional` `Readonly` **output**: `Readonly`<[`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)\> - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L64) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentLoggedType.md b/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentLoggedType.md deleted file mode 100644 index c799dc39bcd..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentLoggedType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentLoggedType -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentLoggedType - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentLoggedType - -## Properties - -### logId - -• `Readonly` **logId**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:51](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L51) - -___ - -### loggedType - -• `Readonly` **loggedType**: [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md) - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:52](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L52) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentType.md b/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentType.md deleted file mode 100644 index 6f37f4b655a..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-JsonFlatAbiFragmentType.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentType -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentType - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentType - -## Properties - -### components - -• `Optional` `Readonly` **components**: ``null`` \| readonly [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L46) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L45) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L44) - -___ - -### typeId - -• `Readonly` **typeId**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L43) - -___ - -### typeParameters - -• `Optional` `Readonly` **typeParameters**: ``null`` \| readonly `number`[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L47) diff --git a/docs/packages/fuel-ts-predicate/interfaces/internal-ScriptTransactionRequestLike.md b/docs/packages/fuel-ts-predicate/interfaces/internal-ScriptTransactionRequestLike.md deleted file mode 100644 index d9fa0650314..00000000000 --- a/docs/packages/fuel-ts-predicate/interfaces/internal-ScriptTransactionRequestLike.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequestLike -parent: "@fuel-ts/predicate" -nav_order: 2 - ---- - -# Interface: ScriptTransactionRequestLike - -[@fuel-ts/predicate](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`ScriptTransactionRequestLike`** - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### script - -• `Optional` **script**: `BytesLike` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:384](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L384) - -___ - -### scriptData - -• `Optional` **scriptData**: `BytesLike` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:386](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L386) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-predicate/namespaces/internal.md b/docs/packages/fuel-ts-predicate/namespaces/internal.md deleted file mode 100644 index 85d0099101e..00000000000 --- a/docs/packages/fuel-ts-predicate/namespaces/internal.md +++ /dev/null @@ -1,1515 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/predicate" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/predicate](../index.md).internal - -## Enumerations - -- [GqlCoinStatus](../enums/internal-GqlCoinStatus.md) -- [GqlMessageStatus](../enums/internal-GqlMessageStatus.md) -- [GqlReturnType](../enums/internal-GqlReturnType.md) -- [TransactionType](../enums/internal-TransactionType.md) - -## Classes - -- [AbstractAccount](../classes/internal-AbstractAccount.md) -- [AbstractAddress](../classes/internal-AbstractAddress.md) -- [AbstractContract](../classes/internal-AbstractContract.md) -- [AbstractProgram](../classes/internal-AbstractProgram.md) -- [AbstractScriptRequest](../classes/internal-AbstractScriptRequest.md) -- [Account](../classes/internal-Account.md) -- [BN](../classes/internal-BN.md) -- [BaseTransactionRequest](../classes/internal-BaseTransactionRequest.md) -- [CreateTransactionRequest](../classes/internal-CreateTransactionRequest.md) -- [ScriptTransactionRequest](../classes/internal-ScriptTransactionRequest.md) -- [TransactionResponse](../classes/internal-TransactionResponse.md) - -## Interfaces - -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) -- [BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md) -- [CreateTransactionRequestLike](../interfaces/internal-CreateTransactionRequestLike.md) -- [JsonAbiFragment](../interfaces/internal-JsonAbiFragment.md) -- [JsonAbiFragmentType](../interfaces/internal-JsonAbiFragmentType.md) -- [JsonAbiFunctionAttributeType](../interfaces/internal-JsonAbiFunctionAttributeType.md) -- [JsonFlatAbi](../interfaces/internal-JsonFlatAbi.md) -- [JsonFlatAbiFragmentArgumentType](../interfaces/internal-JsonFlatAbiFragmentArgumentType.md) -- [JsonFlatAbiFragmentFunction](../interfaces/internal-JsonFlatAbiFragmentFunction.md) -- [JsonFlatAbiFragmentLoggedType](../interfaces/internal-JsonFlatAbiFragmentLoggedType.md) -- [JsonFlatAbiFragmentType](../interfaces/internal-JsonFlatAbiFragmentType.md) -- [ScriptTransactionRequestLike](../interfaces/internal-ScriptTransactionRequestLike.md) - -## Enumeration Members - -### Call - -• **Call**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L10) - -___ - -### Change - -• **Change**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L10) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L15) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L7) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L16) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L8) - -___ - -### ContractCreated - -• **ContractCreated**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L12) - -___ - -### Create - -• **Create**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Log - -• **Log**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L15) - -___ - -### LogData - -• **LogData**: ``6`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L17) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L9) - -___ - -### MessageOut - -• **MessageOut**: ``10`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L20) - -___ - -### Panic - -• **Panic**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L13) - -___ - -### Return - -• **Return**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L11) - -___ - -### ReturnData - -• **ReturnData**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L12) - -___ - -### Revert - -• **Revert**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L14) - -___ - -### Script - -• **Script**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) - -___ - -### ScriptResult - -• **ScriptResult**: ``9`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L19) - -___ - -### Transfer - -• **Transfer**: ``7`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L17) - -___ - -### TransferOut - -• **TransferOut**: ``8`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L18) - -___ - -### Variable - -• **Variable**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L11) - -## Type Aliases - -### AddressLike - -Ƭ **AddressLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractAccount`](../classes/internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L55) - -___ - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### BigNumberish - -Ƭ **BigNumberish**: `string` \| `number` \| [`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/types.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L3) - -___ - -### CallResult - -Ƭ **CallResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | - -#### Defined in - -[packages/providers/src/provider.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L42) - -___ - -### ChangeTransactionRequestOutput - -Ƭ **ChangeTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L30) - -___ - -### Coin - -Ƭ **Coin**: `Object` - -A Fuel coin - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `blockCreated` | [`BN`](../classes/internal-BN.md) | -| `id` | `string` | -| `maturity` | `number` | -| `owner` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlCoinStatus`](../enums/internal-GqlCoinStatus.md) | - -#### Defined in - -[packages/providers/src/coin.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin.ts#L9) - -___ - -### CoinQuantity - -Ƭ **CoinQuantity**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `max?` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/providers/src/coin-quantity.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L10) - -___ - -### CoinQuantityLike - -Ƭ **CoinQuantityLike**: [amount: BigNumberish, assetId?: BytesLike, max?: BigNumberish] \| { `amount`: [`BigNumberish`](internal.md#bignumberish) ; `assetId?`: `BytesLike` ; `max?`: [`BigNumberish`](internal.md#bignumberish) } - -#### Defined in - -[packages/providers/src/coin-quantity.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L7) - -___ - -### CoinTransactionRequestInput - -Ƭ **CoinTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `assetId` | `BytesLike` | Asset ID of the coins | -| `id` | `BytesLike` | UTXO ID | -| `maturity?` | `number` | UTXO being spent must have been created at least this many blocks ago | -| `owner` | `BytesLike` | Owning address or script hash | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L9) - -___ - -### CoinTransactionRequestOutput - -Ƭ **CoinTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins to send | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L9) - -___ - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) - -___ - -### ContractCreatedTransactionRequestOutput - -Ƭ **ContractCreatedTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L40) - -___ - -### ContractIdLike - -Ƭ **ContractIdLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractContract`](../classes/internal-AbstractContract.md) - -#### Defined in - -[packages/interfaces/src/index.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L57) - -___ - -### ContractTransactionRequestInput - -Ƭ **ContractTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L66) - -___ - -### ContractTransactionRequestOutput - -Ƭ **ContractTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `inputIndex` | `number` | Index of input contract | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L18) - -___ - -### ExcludeResourcesOption - -Ƭ **ExcludeResourcesOption**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `messages?` | `BytesLike`[] | -| `utxos?` | `BytesLike`[] | - -#### Defined in - -[packages/providers/src/resource.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L36) - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](internal.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### Input - -Ƭ **Input**: [`InputCoin`](internal.md#inputcoin) \| [`InputContract`](internal.md#inputcontract) \| [`InputMessage`](internal.md#inputmessage) - -#### Defined in - -[packages/transactions/src/coders/input.ts:324](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L324) - -___ - -### InputCoin - -Ƭ **InputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins (u64) | -| `assetId` | `string` | Asset ID of the coins (b256) | -| `maturity` | `number` | UTXO being spent must have been created at least this many blocks ago (u32) | -| `owner` | `string` | Owning address or script hash (b256) | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L20) - -___ - -### InputContract - -Ƭ **InputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract before transaction execution (b256) | -| `contractID` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract before transaction execution (b256) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L131) - -___ - -### InputMessage - -Ƭ **InputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins | -| `data` | `string` | data of message | -| `dataLength` | `number` | Length of predicate, in instructions (u16) | -| `nonce` | [`BN`](../classes/internal-BN.md) | Unique nonce of message | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `recipient` | `string` | Address of sender | -| `sender` | `string` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes message (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:196](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L196) - -___ - -### InputValue - -Ƭ **InputValue**<`T`\>: [`Primitive`](internal.md#primitive) \| [`BN`](../classes/internal-BN.md) \| [`Option`](internal.md#option)<`T`\> \| `BytesLike` \| [`InputValue`](internal.md#inputvalue)[] \| { `[key: string]`: [`InputValue`](internal.md#inputvalue); } \| `Record`<`string`, [`Primitive`](internal.md#primitive) \| `BytesLike`\> - -The type of value you can provide to `Coder.encode` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `void` | - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L15) - -___ - -### JsonAbi - -Ƭ **JsonAbi**: `ReadonlyArray`<[`JsonAbiFragment`](../interfaces/internal-JsonAbiFragment.md)\> \| [`JsonFlatAbi`](../interfaces/internal-JsonFlatAbi.md) - -A JSON ABI object - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:78](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L78) - -___ - -### Message - -Ƭ **Message**: `Object` - -A Fuel message - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `daHeight` | [`BN`](../classes/internal-BN.md) | -| `data` | `BytesLike` | -| `nonce` | [`BN`](../classes/internal-BN.md) | -| `recipient` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `sender` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlMessageStatus`](../enums/internal-GqlMessageStatus.md) | - -#### Defined in - -[packages/providers/src/message.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/message.ts#L11) - -___ - -### MessageTransactionRequestInput - -Ƭ **MessageTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `data` | `BytesLike` | data of message | -| `nonce` | [`BigNumberish`](internal.md#bignumberish) | Unique nonce of message | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `recipient` | `BytesLike` | Address of sender | -| `sender` | `BytesLike` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes the message | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L39) - -___ - -### MessageTransactionRequestOutput - -Ƭ **MessageTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins sent with message | -| `recipient` | `BytesLike` | Receiving address | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L23) - -___ - -### Option - -Ƭ **Option**<`T`\>: `T` \| `undefined` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[packages/abi-coder/src/coders/option.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/option.ts#L6) - -___ - -### Output - -Ƭ **Output**: [`OutputCoin`](internal.md#outputcoin) \| [`OutputContract`](internal.md#outputcontract) \| [`OutputMessage`](internal.md#outputmessage) \| [`OutputChange`](internal.md#outputchange) \| [`OutputVariable`](internal.md#outputvariable) \| [`OutputContractCreated`](internal.md#outputcontractcreated) - -#### Defined in - -[packages/transactions/src/coders/output.ts:294](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L294) - -___ - -### OutputChange - -Ƭ **OutputChange**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:153](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L153) - -___ - -### OutputCoin - -Ƭ **OutputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L15) - -___ - -### OutputContract - -Ƭ **OutputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract after transaction execution (b256) | -| `inputIndex` | `number` | Index of input contract (u8) | -| `stateRoot` | `string` | State root of contract after transaction execution (b256) | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L63) - -___ - -### OutputContractCreated - -Ƭ **OutputContractCreated**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract (b256) | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:249](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L249) - -___ - -### OutputMessage - -Ƭ **OutputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send with message (u64) | -| `recipient` | `string` | Receiving address (b256) | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:111](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L111) - -___ - -### OutputVariable - -Ƭ **OutputVariable**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Variable`](internal.md#variable) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:201](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L201) - -___ - -### PossibleTransactions - -Ƭ **PossibleTransactions**: [`TransactionScript`](internal.md#transactionscript) \| [`TransactionCreate`](internal.md#transactioncreate) \| [`TransactionMint`](internal.md#transactionmint) - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:347](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L347) - -___ - -### Primitive - -Ƭ **Primitive**: `string` \| `number` \| `boolean` - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L10) - -___ - -### ReceiptCall - -Ƭ **ReceiptCall**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to forward, i.e. $rB (u64) | -| `assetId` | `string` | Asset ID of coins to forward, i.e. MEM[$rC, 32] (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `gas` | [`BN`](../classes/internal-BN.md) | Gas to forward, i.e. $rD (u64) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `param1` | [`BN`](../classes/internal-BN.md) | First parameter (u64) | -| `param2` | [`BN`](../classes/internal-BN.md) | Second parameter (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of called contract (b256) | -| `type` | [`Call`](internal.md#call) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L23) - -___ - -### ReceiptLog - -Ƭ **ReceiptLog**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Log`](internal.md#log) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `val2` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `val3` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:341](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L341) - -___ - -### ReceiptLogData - -Ƭ **ReceiptLogData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rC, $rD] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `type` | [`LogData`](internal.md#logdata) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:413](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L413) - -___ - -### ReceiptMessageOut - -Ƭ **ReceiptMessageOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Hexadecimal string representation of a 64-bit unsigned integer; value of register $rD | -| `data` | `Uint8Array` | Hexadecimal string representation of the value of the memory range MEM[$rA + 32, $rB] | -| `digest` | `string` | Hexadecimal string representation of 256-bit (32-byte), hash of MEM[$rA + 32, $rB] | -| `messageID` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message ID | -| `nonce` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message nonce | -| `recipient` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message recipient: MEM[$rA, 32] | -| `sender` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message sender: MEM[$fp, 32] | -| `type` | [`MessageOut`](internal.md#messageout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:665](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L665) - -___ - -### ReceiptPanic - -Ƭ **ReceiptPanic**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Value of optional contract ID | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `reason` | [`BN`](../classes/internal-BN.md) | Panic reason (u64) | -| `type` | [`Panic`](internal.md#panic) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:227](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L227) - -___ - -### ReceiptReturn - -Ƭ **ReceiptReturn**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Return`](internal.md#return) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L107) - -___ - -### ReceiptReturnData - -Ƭ **ReceiptReturnData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rA, $rB] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `type` | [`ReturnData`](internal.md#returndata) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:161](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L161) - -___ - -### ReceiptRevert - -Ƭ **ReceiptRevert**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Revert`](internal.md#revert) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:287](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L287) - -___ - -### ReceiptScriptResult - -Ƭ **ReceiptScriptResult**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | Gas consumed by the script (u64) | -| `result` | [`BN`](../classes/internal-BN.md) | Result variant with embedded `PanicReason` in first 8 bits and `instr` (u64) | -| `type` | [`ScriptResult`](internal.md#scriptresult) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:623](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L623) - -___ - -### ReceiptTransfer - -Ƭ **ReceiptTransfer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of contract to transfer coins to (b256) | -| `type` | [`Transfer`](internal.md#transfer) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:491](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L491) - -___ - -### ReceiptTransferOut - -Ƭ **ReceiptTransferOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Address to transfer coins to (b256) | -| `type` | [`TransferOut`](internal.md#transferout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:557](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L557) - -___ - -### Resource - -Ƭ **Resource**: [`Coin`](internal.md#coin-2) \| [`Message`](internal.md#message-2) - -#### Defined in - -[packages/providers/src/resource.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L32) - -___ - -### StorageSlot - -Ƭ **StorageSlot**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Key (b256) | -| `value` | `string` | Value (b256) | - -#### Defined in - -[packages/transactions/src/coders/storage-slot.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/storage-slot.ts#L3) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) - -___ - -### Transaction - -Ƭ **Transaction**<`TTransactionType`\>: `TTransactionType` extends [`TransactionType`](../enums/internal-TransactionType.md) ? `Extract`<[`PossibleTransactions`](internal.md#possibletransactions), { `type`: `TTransactionType` }\> : `Partial`<`Omit`<[`TransactionScript`](internal.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](internal.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](internal.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/internal-TransactionType.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:348](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L348) - -___ - -### TransactionCreate - -Ƭ **TransactionCreate**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bytecodeLength` | `number` | Contract bytecode length, in instructions (u16) | -| `bytecodeWitnessIndex` | `number` | Witness index of contract bytecode to create (u8) | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `salt` | `string` | Salt (b256) | -| `storageSlots` | [`StorageSlot`](internal.md#storageslot)[] | List of inputs (StorageSlot[]) | -| `storageSlotsCount` | `number` | Number of storage slots to initialize (u16) | -| `type` | [`Create`](internal.md#create) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L159) - -___ - -### TransactionMint - -Ƭ **TransactionMint**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | The location of the Mint transaction in the block. | -| `type` | [`Mint`](../enums/internal-TransactionType.md#mint) | - | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:297](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L297) - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: [`ScriptTransactionRequest`](../classes/internal-ScriptTransactionRequest.md) \| [`CreateTransactionRequest`](../classes/internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:576](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L576) - -___ - -### TransactionRequestInput - -Ƭ **TransactionRequestInput**: [`CoinTransactionRequestInput`](internal.md#cointransactionrequestinput) \| [`ContractTransactionRequestInput`](internal.md#contracttransactionrequestinput) \| [`MessageTransactionRequestInput`](internal.md#messagetransactionrequestinput) - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:75](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L75) - -___ - -### TransactionRequestLike - -Ƭ **TransactionRequestLike**: { `type`: [`Script`](internal.md#script) } & [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) \| { `type`: [`Create`](internal.md#create) } & [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:577](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L577) - -___ - -### TransactionRequestOutput - -Ƭ **TransactionRequestOutput**: [`CoinTransactionRequestOutput`](internal.md#cointransactionrequestoutput) \| [`ContractTransactionRequestOutput`](internal.md#contracttransactionrequestoutput) \| [`MessageTransactionRequestOutput`](internal.md#messagetransactionrequestoutput) \| [`ChangeTransactionRequestOutput`](internal.md#changetransactionrequestoutput) \| [`VariableTransactionRequestOutput`](internal.md#variabletransactionrequestoutput) \| [`ContractCreatedTransactionRequestOutput`](internal.md#contractcreatedtransactionrequestoutput) - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L47) - -___ - -### TransactionRequestStorageSlot - -Ƭ **TransactionRequestStorageSlot**: { `key`: `BytesLike` ; `value`: `BytesLike` } \| [key: BytesLike, value: BytesLike] - -#### Defined in - -[packages/providers/src/transaction-request/storage-slot.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/storage-slot.ts#L5) - -___ - -### TransactionResult - -Ƭ **TransactionResult**<`TStatus`, `TTransactionType`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TStatus` | extends ``"success"`` \| ``"failure"`` | -| `TTransactionType` | `void` | - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockId` | `any` | - | -| `fee` | [`BN`](../classes/internal-BN.md) | - | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | - | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | Receipts produced during the execution of the transaction | -| `status` | `TStatus` extends ``"success"`` ? { `programState`: `any` ; `type`: ``"success"`` } : { `reason`: `any` ; `type`: ``"failure"`` } | - | -| `time` | `any` | - | -| `transaction` | [`Transaction`](internal.md#transaction)<`TTransactionType`\> | - | -| `transactionId` | `string` | - | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L54) - -___ - -### TransactionResultCallReceipt - -Ƭ **TransactionResultCallReceipt**: [`ReceiptCall`](internal.md#receiptcall) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L29) - -___ - -### TransactionResultLogDataReceipt - -Ƭ **TransactionResultLogDataReceipt**: [`ReceiptLogData`](internal.md#receiptlogdata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L35) - -___ - -### TransactionResultLogReceipt - -Ƭ **TransactionResultLogReceipt**: [`ReceiptLog`](internal.md#receiptlog) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L34) - -___ - -### TransactionResultMessageOutReceipt - -Ƭ **TransactionResultMessageOutReceipt**: [`ReceiptMessageOut`](internal.md#receiptmessageout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L39) - -___ - -### TransactionResultPanicReceipt - -Ƭ **TransactionResultPanicReceipt**: [`ReceiptPanic`](internal.md#receiptpanic) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L32) - -___ - -### TransactionResultReceipt - -Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](internal.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](internal.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](internal.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](internal.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](internal.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](internal.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](internal.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](internal.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](internal.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](internal.md#transactionresultscriptresultreceipt) \| [`TransactionResultMessageOutReceipt`](internal.md#transactionresultmessageoutreceipt) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L41) - -___ - -### TransactionResultReturnDataReceipt - -Ƭ **TransactionResultReturnDataReceipt**: [`ReceiptReturnData`](internal.md#receiptreturndata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L31) - -___ - -### TransactionResultReturnReceipt - -Ƭ **TransactionResultReturnReceipt**: [`ReceiptReturn`](internal.md#receiptreturn) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L30) - -___ - -### TransactionResultRevertReceipt - -Ƭ **TransactionResultRevertReceipt**: [`ReceiptRevert`](internal.md#receiptrevert) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L33) - -___ - -### TransactionResultScriptResultReceipt - -Ƭ **TransactionResultScriptResultReceipt**: [`ReceiptScriptResult`](internal.md#receiptscriptresult) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L38) - -___ - -### TransactionResultTransferOutReceipt - -Ƭ **TransactionResultTransferOutReceipt**: [`ReceiptTransferOut`](internal.md#receipttransferout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L37) - -___ - -### TransactionResultTransferReceipt - -Ƭ **TransactionResultTransferReceipt**: [`ReceiptTransfer`](internal.md#receipttransfer) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L36) - -___ - -### TransactionScript - -Ƭ **TransactionScript**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `receiptsRoot` | `string` | Merkle root of receipts (b256) | -| `script` | `string` | Script to execute (byte[]) | -| `scriptData` | `string` | Script input data (parameters) (byte[]) | -| `scriptDataLength` | `number` | Length of script input data, in bytes (u16) | -| `scriptLength` | `number` | Script length, in instructions (u16) | -| `type` | [`Script`](internal.md#script) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L25) - -___ - -### TxPointer - -Ƭ **TxPointer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockHeight` | `number` | Block height (u32) | -| `txIndex` | `number` | Transaction index (u16) | - -#### Defined in - -[packages/transactions/src/coders/tx-pointer.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/tx-pointer.ts#L3) - -___ - -### UtxoId - -Ƭ **UtxoId**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputIndex` | `number` | Output index (u8) | -| `transactionId` | `string` | Transaction ID (b256) | - -#### Defined in - -[packages/transactions/src/coders/utxo-id.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L3) - -___ - -### VariableTransactionRequestOutput - -Ƭ **VariableTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `type` | [`Variable`](internal.md#variable) | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L37) - -___ - -### Witness - -Ƭ **Witness**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `string` | Witness data (byte[]) | -| `dataLength` | `number` | Length of witness data, in bytes (u32) | - -#### Defined in - -[packages/transactions/src/coders/witness.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L6) diff --git a/docs/packages/fuel-ts-program/classes/Contract.md b/docs/packages/fuel-ts-program/classes/Contract.md deleted file mode 100644 index 77065747f69..00000000000 --- a/docs/packages/fuel-ts-program/classes/Contract.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -layout: default -title: Contract -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: Contract - -[@fuel-ts/program](../index.md).Contract - -## Implements - -- [`AbstractContract`](internal-AbstractContract.md) - -## Constructors - -### constructor - -• **new Contract**(`id`, `abi`, `accountOrProvider`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | -| `abi` | [`JsonAbi`](../namespaces/internal.md#jsonabi) \| `default` | -| `accountOrProvider` | `default` \| [`Account`](internal-Account.md) | - -#### Defined in - -[packages/program/src/contract.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/contract.ts#L20) - -## Properties - -### account - -• **account**: ``null`` \| [`Account`](internal-Account.md) - -#### Implementation of - -[AbstractContract](internal-AbstractContract.md).[account](internal-AbstractContract.md#account) - -#### Defined in - -[packages/program/src/contract.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/contract.ts#L17) - -___ - -### functions - -• **functions**: [`InvokeFunctions`](../interfaces/InvokeFunctions.md) = `{}` - -#### Defined in - -[packages/program/src/contract.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/contract.ts#L18) - -___ - -### id - -• **id**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Implementation of - -[AbstractContract](internal-AbstractContract.md).[id](internal-AbstractContract.md#id) - -#### Defined in - -[packages/program/src/contract.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/contract.ts#L14) - -___ - -### interface - -• **interface**: `default` - -#### Implementation of - -[AbstractContract](internal-AbstractContract.md).[interface](internal-AbstractContract.md#interface) - -#### Defined in - -[packages/program/src/contract.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/contract.ts#L16) - -___ - -### provider - -• **provider**: ``null`` \| `default` - -#### Implementation of - -[AbstractContract](internal-AbstractContract.md).[provider](internal-AbstractContract.md#provider) - -#### Defined in - -[packages/program/src/contract.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/contract.ts#L15) - -## Methods - -### buildFunction - -▸ **buildFunction**(`func`): (...`args`: `unknown`[]) => [`FunctionInvocationScope`](FunctionInvocationScope.md)<`unknown`[], `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `func` | `default` | - -#### Returns - -`fn` - -▸ (...`args`): [`FunctionInvocationScope`](FunctionInvocationScope.md)<`unknown`[], `any`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -##### Returns - -[`FunctionInvocationScope`](FunctionInvocationScope.md)<`unknown`[], `any`\> - -#### Defined in - -[packages/program/src/contract.ts:58](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/contract.ts#L58) - -___ - -### getBalance - -▸ **getBalance**(`assetId`): `Promise`<[`BN`](internal-BN.md)\> - -Get the balance for a given assset ID for this contract - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId` | `BytesLike` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Defined in - -[packages/program/src/contract.ts:69](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/contract.ts#L69) - -___ - -### multiCall - -▸ **multiCall**(`calls`): [`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `calls` | [`FunctionInvocationScope`](FunctionInvocationScope.md)<`any`[], `any`\>[] | - -#### Returns - -[`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`any`\> - -#### Defined in - -[packages/program/src/contract.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/contract.ts#L62) diff --git a/docs/packages/fuel-ts-program/classes/FunctionInvocationResult.md b/docs/packages/fuel-ts-program/classes/FunctionInvocationResult.md deleted file mode 100644 index feb173b4d15..00000000000 --- a/docs/packages/fuel-ts-program/classes/FunctionInvocationResult.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -layout: default -title: FunctionInvocationResult -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: FunctionInvocationResult - -[@fuel-ts/program](../index.md).FunctionInvocationResult - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `TTransactionType` | `void` | - -## Hierarchy - -- [`InvocationResult`](InvocationResult.md)<`T`\> - - ↳ **`FunctionInvocationResult`** - -## Constructors - -### constructor - -• **new FunctionInvocationResult**<`T`, `TTransactionType`\>(`funcScopes`, `transactionResponse`, `transactionResult`, `program`, `isMultiCall`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `TTransactionType` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScopes` | [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\> \| [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] | -| `transactionResponse` | [`TransactionResponse`](internal-TransactionResponse.md) | -| `transactionResult` | [`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\> | -| `program` | [`AbstractProgram`](internal-AbstractProgram.md) | -| `isMultiCall` | `boolean` | - -#### Overrides - -[InvocationResult](InvocationResult.md).[constructor](InvocationResult.md#constructor) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L89) - -## Properties - -### functionScopes - -• `Readonly` **functionScopes**: [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] - -#### Inherited from - -[InvocationResult](InvocationResult.md).[functionScopes](InvocationResult.md#functionscopes) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L29) - -___ - -### gasUsed - -• `Readonly` **gasUsed**: [`BN`](internal-BN.md) - -#### Inherited from - -[InvocationResult](InvocationResult.md).[gasUsed](InvocationResult.md#gasused) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L31) - -___ - -### isMultiCall - -• `Readonly` **isMultiCall**: `boolean` - -#### Inherited from - -[InvocationResult](InvocationResult.md).[isMultiCall](InvocationResult.md#ismulticall) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L30) - -___ - -### logs - -• `Readonly` **logs**: `any`[] - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L87) - -___ - -### program - -• `Readonly` **program**: [`AbstractProgram`](internal-AbstractProgram.md) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:86](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L86) - -___ - -### transactionId - -• `Readonly` **transactionId**: `string` - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L83) - -___ - -### transactionResponse - -• `Readonly` **transactionResponse**: [`TransactionResponse`](internal-TransactionResponse.md) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:84](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L84) - -___ - -### transactionResult - -• `Readonly` **transactionResult**: [`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\> - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L85) - -___ - -### value - -• `Readonly` **value**: `T` - -#### Inherited from - -[InvocationResult](InvocationResult.md).[value](InvocationResult.md#value) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L32) - -## Methods - -### getDecodedLogs - -▸ `Protected` **getDecodedLogs**(`receipts`): `unknown`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](../namespaces/internal.md#transactionresultreceipt)[] | - -#### Returns - -`unknown`[] - -#### Inherited from - -[InvocationResult](InvocationResult.md).[getDecodedLogs](InvocationResult.md#getdecodedlogs) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L68) - -___ - -### getDecodedValue - -▸ `Protected` **getDecodedValue**(`callResult`): `T` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callResult` | [`CallResult`](../namespaces/internal.md#callresult) | - -#### Returns - -`T` - -#### Inherited from - -[InvocationResult](InvocationResult.md).[getDecodedValue](InvocationResult.md#getdecodedvalue) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:53](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L53) - -___ - -### build - -▸ `Static` **build**<`T`, `TTransactionType`\>(`funcScope`, `transactionResponse`, `isMultiCall`, `program`): `Promise`<[`FunctionInvocationResult`](FunctionInvocationResult.md)<`T`, `TTransactionType`\>\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TTransactionType` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScope` | [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\> \| [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] | -| `transactionResponse` | [`TransactionResponse`](internal-TransactionResponse.md) | -| `isMultiCall` | `boolean` | -| `program` | [`AbstractProgram`](internal-AbstractProgram.md) | - -#### Returns - -`Promise`<[`FunctionInvocationResult`](FunctionInvocationResult.md)<`T`, `TTransactionType`\>\> - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:104](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L104) diff --git a/docs/packages/fuel-ts-program/classes/FunctionInvocationScope.md b/docs/packages/fuel-ts-program/classes/FunctionInvocationScope.md deleted file mode 100644 index b814395c4bb..00000000000 --- a/docs/packages/fuel-ts-program/classes/FunctionInvocationScope.md +++ /dev/null @@ -1,693 +0,0 @@ ---- -layout: default -title: FunctionInvocationScope -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: FunctionInvocationScope - -[@fuel-ts/program](../index.md).FunctionInvocationScope - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TArgs` | extends `any`[] = `any`[] | -| `TReturn` | `any` | - -## Hierarchy - -- [`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - - ↳ **`FunctionInvocationScope`** - -## Constructors - -### constructor - -• **new FunctionInvocationScope**<`TArgs`, `TReturn`\>(`program`, `func`, `args`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TArgs` | extends `any`[] = `any`[] | -| `TReturn` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `program` | [`AbstractProgram`](internal-AbstractProgram.md) | -| `func` | `default` | -| `args` | `TArgs` | - -#### Overrides - -[BaseInvocationScope](internal-BaseInvocationScope.md).[constructor](internal-BaseInvocationScope.md#constructor) - -#### Defined in - -[packages/program/src/functions/invocation-scope.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-scope.ts#L20) - -## Properties - -### args - -• `Protected` **args**: `TArgs` - -#### Defined in - -[packages/program/src/functions/invocation-scope.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-scope.ts#L18) - -___ - -### callParameters - -• `Private` `Optional` **callParameters**: `Partial`<{ `forward`: [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike) ; `gasLimit`: [`BigNumberish`](../namespaces/internal.md#bignumberish) }\> - -#### Defined in - -[packages/program/src/functions/invocation-scope.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-scope.ts#L16) - -___ - -### forward - -• `Private` `Optional` **forward**: [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Defined in - -[packages/program/src/functions/invocation-scope.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-scope.ts#L17) - -___ - -### func - -• `Protected` **func**: `default` - -#### Defined in - -[packages/program/src/functions/invocation-scope.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-scope.ts#L15) - -___ - -### functionInvocationScopes - -• `Protected` **functionInvocationScopes**: [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] = `[]` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[functionInvocationScopes](internal-BaseInvocationScope.md#functioninvocationscopes) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L42) - -___ - -### isMultiCall - -• `Protected` **isMultiCall**: `boolean` = `false` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[isMultiCall](internal-BaseInvocationScope.md#ismulticall) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L45) - -___ - -### program - -• `Protected` **program**: [`AbstractProgram`](internal-AbstractProgram.md) - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[program](internal-BaseInvocationScope.md#program) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L41) - -___ - -### requiredCoins - -• `Protected` **requiredCoins**: [`CoinQuantity`](../namespaces/internal.md#coinquantity)[] = `[]` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[requiredCoins](internal-BaseInvocationScope.md#requiredcoins) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L44) - -___ - -### transactionRequest - -• **transactionRequest**: [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[transactionRequest](internal-BaseInvocationScope.md#transactionrequest) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L40) - -___ - -### txParameters - -• `Protected` `Optional` **txParameters**: `Partial`<{ `gasLimit`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `gasPrice`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `variableOutputs`: `number` }\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[txParameters](internal-BaseInvocationScope.md#txparameters) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L43) - -## Accessors - -### calls - -• `Protected` `get` **calls**(): [`ContractCall`](../index.md#contractcall)[] - -#### Returns - -[`ContractCall`](../index.md#contractcall)[] - -#### Inherited from - -BaseInvocationScope.calls - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L55) - -## Methods - -### addCall - -▸ `Protected` **addCall**(`funcScope`): [`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScope` | [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\> | - -#### Returns - -[`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[addCall](internal-BaseInvocationScope.md#addcall) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L100) - -___ - -### addCalls - -▸ `Protected` **addCalls**(`funcScopes`): [`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScopes` | [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] | - -#### Returns - -[`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[addCalls](internal-BaseInvocationScope.md#addcalls) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:105](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L105) - -___ - -### addContracts - -▸ **addContracts**(`contracts`): [`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contracts` | [`AbstractContract`](internal-AbstractContract.md)[] | - -#### Returns - -[`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[addContracts](internal-BaseInvocationScope.md#addcontracts) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:181](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L181) - -___ - -### call - -▸ **call**<`T`\>(`options?`): `Promise`<[`FunctionInvocationResult`](FunctionInvocationResult.md)<`T`, `void`\>\> - -Submits a transaction to the blockchain. - -This is a final action and will spend the coins and change the state of the contract. -It also means that invalid transactions will throw an error, and consume gas. To avoid this -running invalid tx and consuming gas try to `simulate` first when possible. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`FunctionInvocationResult`](FunctionInvocationResult.md)<`T`, `void`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[call](internal-BaseInvocationScope.md#call) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:210](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L210) - -___ - -### callParams - -▸ **callParams**(`callParams`): [`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callParams` | `Partial`<{ `forward`: [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike) ; `gasLimit`: [`BigNumberish`](../namespaces/internal.md#bignumberish) }\> | - -#### Returns - -[`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Defined in - -[packages/program/src/functions/invocation-scope.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-scope.ts#L46) - -___ - -### checkGasLimitTotal - -▸ `Protected` **checkGasLimitTotal**(): `void` - -#### Returns - -`void` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[checkGasLimitTotal](internal-BaseInvocationScope.md#checkgaslimittotal) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:130](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L130) - -___ - -### dryRun - -▸ **dryRun**<`T`\>(`options?`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -Executes a transaction in dry run mode, without UTXO validations. - -A transaction in dry run mode can't change the state of the blockchain. It can be useful to access readonly -methods or just ust get. -The UTXO validation disable in this case, enables to send invalid inputs to emulate different conditions, of a -transaction - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[dryRun](internal-BaseInvocationScope.md#dryrun) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:248](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L248) - -___ - -### fundWithRequiredCoins - -▸ **fundWithRequiredCoins**(): `Promise`<[`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\>\> - -Add to the transaction scope the required amount of unspent UTXO's. - -Required Amount = forward coins + transfers + gas fee. - -#### Returns - -`Promise`<[`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[fundWithRequiredCoins](internal-BaseInvocationScope.md#fundwithrequiredcoins) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L160) - -___ - -### get - -▸ **get**<`T`\>(`options?`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -Executes a readonly contract method call. - -Under the hood it uses the `dryRun` method but don't fund the transaction -with coins by default, for emulating executions with forward coins use `dryRun` -or pass the options.fundTransaction as true - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[get](internal-BaseInvocationScope.md#get) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:273](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L273) - -___ - -### getCallConfig - -▸ **getCallConfig**(): [`CallConfig`](../index.md#callconfig)<`TArgs`\> - -#### Returns - -[`CallConfig`](../index.md#callconfig)<`TArgs`\> - -#### Defined in - -[packages/program/src/functions/invocation-scope.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-scope.ts#L28) - -___ - -### getRequiredCoins - -▸ `Protected` **getRequiredCoins**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity)[] - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity)[] - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[getRequiredCoins](internal-BaseInvocationScope.md#getrequiredcoins) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L71) - -___ - -### getTransactionCost - -▸ **getTransactionCost**(`options?`): `Promise`<[`TransactionCost`](../namespaces/internal.md#transactioncost)\> - -Run a valid transaction in dryRun mode and returns useful details about -gasUsed, gasPrice and transaction estimate fee in native coins. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` ; `gasPrice`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `tolerance`: `number` }\> | - -#### Returns - -`Promise`<[`TransactionCost`](../namespaces/internal.md#transactioncost)\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[getTransactionCost](internal-BaseInvocationScope.md#gettransactioncost) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:143](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L143) - -___ - -### getTransactionRequest - -▸ **getTransactionRequest**(`options?`): `Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -Prepare transaction request object, adding Inputs, Outputs, coins, check gas costs -and transaction validity. - -It's possible to get the transaction without adding coins, by passing `fundTransaction` -as false. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[getTransactionRequest](internal-BaseInvocationScope.md#gettransactionrequest) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L198) - -___ - -### prepareTransaction - -▸ `Protected` **prepareTransaction**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[prepareTransaction](internal-BaseInvocationScope.md#preparetransaction) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:112](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L112) - -___ - -### setArguments - -▸ **setArguments**(...`args`): [`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `TArgs` | - -#### Returns - -[`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Defined in - -[packages/program/src/functions/invocation-scope.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-scope.ts#L40) - -___ - -### simulate - -▸ **simulate**<`T`\>(`options?`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -Run a valid transaction and return the result without change the chain state. -This means, all signatures are validated but no UTXO is spent. - -This method is useful for validate propose to avoid spending coins on invalid TXs, also -to estimate the amount of gas that will be required to run the transaction. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[simulate](internal-BaseInvocationScope.md#simulate) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:231](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L231) - -___ - -### txParams - -▸ **txParams**(`txParams`): [`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `txParams` | `Partial`<{ `gasLimit`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `gasPrice`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `variableOutputs`: `number` }\> | - -#### Returns - -[`FunctionInvocationScope`](FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[txParams](internal-BaseInvocationScope.md#txparams) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:170](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L170) - -___ - -### updateRequiredCoins - -▸ `Protected` **updateRequiredCoins**(): `void` - -#### Returns - -`void` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[updateRequiredCoins](internal-BaseInvocationScope.md#updaterequiredcoins) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L82) - -___ - -### updateScriptRequest - -▸ `Protected` **updateScriptRequest**(): `void` - -#### Returns - -`void` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[updateScriptRequest](internal-BaseInvocationScope.md#updatescriptrequest) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L63) - -___ - -### getCallOptions - -▸ `Static` `Protected` **getCallOptions**(`options?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `fundTransaction` | `boolean` | - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[getCallOptions](internal-BaseInvocationScope.md#getcalloptions) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:59](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L59) diff --git a/docs/packages/fuel-ts-program/classes/InvocationResult.md b/docs/packages/fuel-ts-program/classes/InvocationResult.md deleted file mode 100644 index 711ae36a54d..00000000000 --- a/docs/packages/fuel-ts-program/classes/InvocationResult.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -layout: default -title: InvocationResult -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: InvocationResult - -[@fuel-ts/program](../index.md).InvocationResult - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- **`InvocationResult`** - - ↳ [`FunctionInvocationResult`](FunctionInvocationResult.md) - - ↳ [`InvocationCallResult`](internal-InvocationCallResult.md) - -## Constructors - -### constructor - -• **new InvocationResult**<`T`\>(`funcScopes`, `callResult`, `isMultiCall`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScopes` | [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\> \| [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] | -| `callResult` | [`CallResult`](../namespaces/internal.md#callresult) | -| `isMultiCall` | `boolean` | - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L34) - -## Properties - -### functionScopes - -• `Readonly` **functionScopes**: [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L29) - -___ - -### gasUsed - -• `Readonly` **gasUsed**: [`BN`](internal-BN.md) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L31) - -___ - -### isMultiCall - -• `Readonly` **isMultiCall**: `boolean` - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L30) - -___ - -### value - -• `Readonly` **value**: `T` - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L32) - -## Methods - -### getDecodedLogs - -▸ `Protected` **getDecodedLogs**(`receipts`): `unknown`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](../namespaces/internal.md#transactionresultreceipt)[] | - -#### Returns - -`unknown`[] - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L68) - -___ - -### getDecodedValue - -▸ `Protected` **getDecodedValue**(`callResult`): `T` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callResult` | [`CallResult`](../namespaces/internal.md#callresult) | - -#### Returns - -`T` - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:53](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L53) - -___ - -### getFirstCallConfig - -▸ `Private` **getFirstCallConfig**(): `undefined` \| [`CallConfig`](../index.md#callconfig)<`unknown`\> - -#### Returns - -`undefined` \| [`CallConfig`](../index.md#callconfig)<`unknown`\> - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L45) diff --git a/docs/packages/fuel-ts-program/classes/MultiCallInvocationScope.md b/docs/packages/fuel-ts-program/classes/MultiCallInvocationScope.md deleted file mode 100644 index 5cbd081204e..00000000000 --- a/docs/packages/fuel-ts-program/classes/MultiCallInvocationScope.md +++ /dev/null @@ -1,596 +0,0 @@ ---- -layout: default -title: MultiCallInvocationScope -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: MultiCallInvocationScope - -[@fuel-ts/program](../index.md).MultiCallInvocationScope - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TReturn` | `any` | - -## Hierarchy - -- [`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - - ↳ **`MultiCallInvocationScope`** - -## Constructors - -### constructor - -• **new MultiCallInvocationScope**<`TReturn`\>(`contract`, `funcScopes`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TReturn` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | [`AbstractContract`](internal-AbstractContract.md) | -| `funcScopes` | [`FunctionInvocationScope`](FunctionInvocationScope.md)<`any`[], `any`\>[] | - -#### Overrides - -[BaseInvocationScope](internal-BaseInvocationScope.md).[constructor](internal-BaseInvocationScope.md#constructor) - -#### Defined in - -[packages/program/src/functions/multicall-scope.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/multicall-scope.ts#L8) - -## Properties - -### functionInvocationScopes - -• `Protected` **functionInvocationScopes**: [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] = `[]` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[functionInvocationScopes](internal-BaseInvocationScope.md#functioninvocationscopes) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L42) - -___ - -### isMultiCall - -• `Protected` **isMultiCall**: `boolean` = `false` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[isMultiCall](internal-BaseInvocationScope.md#ismulticall) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L45) - -___ - -### program - -• `Protected` **program**: [`AbstractProgram`](internal-AbstractProgram.md) - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[program](internal-BaseInvocationScope.md#program) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L41) - -___ - -### requiredCoins - -• `Protected` **requiredCoins**: [`CoinQuantity`](../namespaces/internal.md#coinquantity)[] = `[]` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[requiredCoins](internal-BaseInvocationScope.md#requiredcoins) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L44) - -___ - -### transactionRequest - -• **transactionRequest**: [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[transactionRequest](internal-BaseInvocationScope.md#transactionrequest) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L40) - -___ - -### txParameters - -• `Protected` `Optional` **txParameters**: `Partial`<{ `gasLimit`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `gasPrice`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `variableOutputs`: `number` }\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[txParameters](internal-BaseInvocationScope.md#txparameters) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L43) - -## Accessors - -### calls - -• `Protected` `get` **calls**(): [`ContractCall`](../index.md#contractcall)[] - -#### Returns - -[`ContractCall`](../index.md#contractcall)[] - -#### Inherited from - -BaseInvocationScope.calls - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L55) - -## Methods - -### addCall - -▸ **addCall**(`funcScope`): [`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScope` | [`FunctionInvocationScope`](FunctionInvocationScope.md)<`any`[], `any`\> | - -#### Returns - -[`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\> - -#### Overrides - -[BaseInvocationScope](internal-BaseInvocationScope.md).[addCall](internal-BaseInvocationScope.md#addcall) - -#### Defined in - -[packages/program/src/functions/multicall-scope.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/multicall-scope.ts#L13) - -___ - -### addCalls - -▸ **addCalls**(`funcScopes`): [`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScopes` | [`FunctionInvocationScope`](FunctionInvocationScope.md)<`any`[], `any`\>[] | - -#### Returns - -[`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\> - -#### Overrides - -[BaseInvocationScope](internal-BaseInvocationScope.md).[addCalls](internal-BaseInvocationScope.md#addcalls) - -#### Defined in - -[packages/program/src/functions/multicall-scope.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/multicall-scope.ts#L17) - -___ - -### addContracts - -▸ **addContracts**(`contracts`): [`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contracts` | [`AbstractContract`](internal-AbstractContract.md)[] | - -#### Returns - -[`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[addContracts](internal-BaseInvocationScope.md#addcontracts) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:181](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L181) - -___ - -### call - -▸ **call**<`T`\>(`options?`): `Promise`<[`FunctionInvocationResult`](FunctionInvocationResult.md)<`T`, `void`\>\> - -Submits a transaction to the blockchain. - -This is a final action and will spend the coins and change the state of the contract. -It also means that invalid transactions will throw an error, and consume gas. To avoid this -running invalid tx and consuming gas try to `simulate` first when possible. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`FunctionInvocationResult`](FunctionInvocationResult.md)<`T`, `void`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[call](internal-BaseInvocationScope.md#call) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:210](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L210) - -___ - -### checkGasLimitTotal - -▸ `Protected` **checkGasLimitTotal**(): `void` - -#### Returns - -`void` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[checkGasLimitTotal](internal-BaseInvocationScope.md#checkgaslimittotal) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:130](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L130) - -___ - -### dryRun - -▸ **dryRun**<`T`\>(`options?`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -Executes a transaction in dry run mode, without UTXO validations. - -A transaction in dry run mode can't change the state of the blockchain. It can be useful to access readonly -methods or just ust get. -The UTXO validation disable in this case, enables to send invalid inputs to emulate different conditions, of a -transaction - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[dryRun](internal-BaseInvocationScope.md#dryrun) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:248](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L248) - -___ - -### fundWithRequiredCoins - -▸ **fundWithRequiredCoins**(): `Promise`<[`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\>\> - -Add to the transaction scope the required amount of unspent UTXO's. - -Required Amount = forward coins + transfers + gas fee. - -#### Returns - -`Promise`<[`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[fundWithRequiredCoins](internal-BaseInvocationScope.md#fundwithrequiredcoins) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L160) - -___ - -### get - -▸ **get**<`T`\>(`options?`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -Executes a readonly contract method call. - -Under the hood it uses the `dryRun` method but don't fund the transaction -with coins by default, for emulating executions with forward coins use `dryRun` -or pass the options.fundTransaction as true - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[get](internal-BaseInvocationScope.md#get) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:273](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L273) - -___ - -### getRequiredCoins - -▸ `Protected` **getRequiredCoins**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity)[] - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity)[] - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[getRequiredCoins](internal-BaseInvocationScope.md#getrequiredcoins) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L71) - -___ - -### getTransactionCost - -▸ **getTransactionCost**(`options?`): `Promise`<[`TransactionCost`](../namespaces/internal.md#transactioncost)\> - -Run a valid transaction in dryRun mode and returns useful details about -gasUsed, gasPrice and transaction estimate fee in native coins. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` ; `gasPrice`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `tolerance`: `number` }\> | - -#### Returns - -`Promise`<[`TransactionCost`](../namespaces/internal.md#transactioncost)\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[getTransactionCost](internal-BaseInvocationScope.md#gettransactioncost) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:143](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L143) - -___ - -### getTransactionRequest - -▸ **getTransactionRequest**(`options?`): `Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -Prepare transaction request object, adding Inputs, Outputs, coins, check gas costs -and transaction validity. - -It's possible to get the transaction without adding coins, by passing `fundTransaction` -as false. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[getTransactionRequest](internal-BaseInvocationScope.md#gettransactionrequest) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L198) - -___ - -### prepareTransaction - -▸ `Protected` **prepareTransaction**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[prepareTransaction](internal-BaseInvocationScope.md#preparetransaction) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:112](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L112) - -___ - -### simulate - -▸ **simulate**<`T`\>(`options?`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -Run a valid transaction and return the result without change the chain state. -This means, all signatures are validated but no UTXO is spent. - -This method is useful for validate propose to avoid spending coins on invalid TXs, also -to estimate the amount of gas that will be required to run the transaction. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[simulate](internal-BaseInvocationScope.md#simulate) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:231](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L231) - -___ - -### txParams - -▸ **txParams**(`txParams`): [`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `txParams` | `Partial`<{ `gasLimit`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `gasPrice`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `variableOutputs`: `number` }\> | - -#### Returns - -[`MultiCallInvocationScope`](MultiCallInvocationScope.md)<`TReturn`\> - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[txParams](internal-BaseInvocationScope.md#txparams) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:170](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L170) - -___ - -### updateRequiredCoins - -▸ `Protected` **updateRequiredCoins**(): `void` - -#### Returns - -`void` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[updateRequiredCoins](internal-BaseInvocationScope.md#updaterequiredcoins) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L82) - -___ - -### updateScriptRequest - -▸ `Protected` **updateScriptRequest**(): `void` - -#### Returns - -`void` - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[updateScriptRequest](internal-BaseInvocationScope.md#updatescriptrequest) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L63) - -___ - -### getCallOptions - -▸ `Static` `Protected` **getCallOptions**(`options?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `fundTransaction` | `boolean` | - -#### Inherited from - -[BaseInvocationScope](internal-BaseInvocationScope.md).[getCallOptions](internal-BaseInvocationScope.md#getcalloptions) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:59](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L59) diff --git a/docs/packages/fuel-ts-program/classes/ScriptRequest.md b/docs/packages/fuel-ts-program/classes/ScriptRequest.md deleted file mode 100644 index 5ea2b847c73..00000000000 --- a/docs/packages/fuel-ts-program/classes/ScriptRequest.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -layout: default -title: ScriptRequest -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: ScriptRequest - -[@fuel-ts/program](../index.md).ScriptRequest - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TData` | `void` | -| `TResult` | `void` | - -## Constructors - -### constructor - -• **new ScriptRequest**<`TData`, `TResult`\>(`bytes`, `scriptDataEncoder`, `scriptResultDecoder`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TData` | `void` | -| `TResult` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytes` | `BytesLike` | -| `scriptDataEncoder` | (`data`: `TData`) => `Uint8Array` | -| `scriptResultDecoder` | (`scriptResult`: [`ScriptResult`](../namespaces/internal.md#scriptresult-1)) => `TResult` | - -#### Defined in - -[packages/program/src/script-request.ts:151](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/script-request.ts#L151) - -## Properties - -### bytes - -• **bytes**: `Uint8Array` - -#### Defined in - -[packages/program/src/script-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/script-request.ts#L147) - -___ - -### scriptDataEncoder - -• **scriptDataEncoder**: (`data`: `TData`) => `Uint8Array` - -#### Type declaration - -▸ (`data`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `TData` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/program/src/script-request.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/script-request.ts#L148) - -___ - -### scriptResultDecoder - -• **scriptResultDecoder**: (`scriptResult`: [`ScriptResult`](../namespaces/internal.md#scriptresult-1)) => `TResult` - -#### Type declaration - -▸ (`scriptResult`): `TResult` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `scriptResult` | [`ScriptResult`](../namespaces/internal.md#scriptresult-1) | - -##### Returns - -`TResult` - -#### Defined in - -[packages/program/src/script-request.ts:149](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/script-request.ts#L149) - -## Methods - -### decodeCallResult - -▸ **decodeCallResult**(`callResult`, `logs?`): `TResult` - -Decodes the result of a script call - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `callResult` | [`CallResult`](../namespaces/internal.md#callresult) | `undefined` | -| `logs` | `any`[] | `[]` | - -#### Returns - -`TResult` - -#### Defined in - -[packages/program/src/script-request.ts:188](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/script-request.ts#L188) - -___ - -### encodeScriptData - -▸ **encodeScriptData**(`data`): `Uint8Array` - -Encodes the data for a script call - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `TData` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/program/src/script-request.ts:181](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/script-request.ts#L181) - -___ - -### getArgOffset - -▸ **getArgOffset**(): `number` - -Returns the memory offset for the contract call argument -Used for struct inputs - -#### Returns - -`number` - -#### Defined in - -[packages/program/src/script-request.ts:173](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/script-request.ts#L173) - -___ - -### getScriptDataOffset - -▸ **getScriptDataOffset**(): `number` - -#### Returns - -`number` - -#### Defined in - -[packages/program/src/script-request.ts:161](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/script-request.ts#L161) diff --git a/docs/packages/fuel-ts-program/classes/ScriptResultDecoderError.md b/docs/packages/fuel-ts-program/classes/ScriptResultDecoderError.md deleted file mode 100644 index 79d47bef5c9..00000000000 --- a/docs/packages/fuel-ts-program/classes/ScriptResultDecoderError.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default -title: ScriptResultDecoderError -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: ScriptResultDecoderError - -[@fuel-ts/program](../index.md).ScriptResultDecoderError - -## Hierarchy - -- `Error` - - ↳ **`ScriptResultDecoderError`** - -## Constructors - -### constructor - -• **new ScriptResultDecoderError**(`result`, `message`, `logs`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `result` | [`TransactionResult`](../namespaces/internal.md#transactionresult)<``"failure"``, `void`\> | -| `message` | `string` | -| `logs` | `any`[] | - -#### Overrides - -Error.constructor - -#### Defined in - -[packages/program/src/errors.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/errors.ts#L16) - -## Properties - -### logs - -• **logs**: `any`[] - -#### Defined in - -[packages/program/src/errors.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/errors.ts#L15) diff --git a/docs/packages/fuel-ts-program/classes/internal-AbstractAccount.md b/docs/packages/fuel-ts-program/classes/internal-AbstractAccount.md deleted file mode 100644 index 15c1e031d34..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-AbstractAccount.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -layout: default -title: AbstractAccount -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: AbstractAccount - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).AbstractAccount - -## Hierarchy - -- **`AbstractAccount`** - - ↳ [`Account`](internal-Account.md) - -## Constructors - -### constructor - -• **new AbstractAccount**() - -## Properties - -### address - -• `Abstract` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L26) - -___ - -### provider - -• `Abstract` **provider**: `unknown` - -#### Defined in - -[packages/interfaces/src/index.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L27) - -## Methods - -### getResourcesToSpend - -▸ `Abstract` **getResourcesToSpend**(`quantities`, `options?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | `any`[] | -| `options?` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L28) - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L29) - -___ - -### simulateTransaction - -▸ `Abstract` **simulateTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L30) diff --git a/docs/packages/fuel-ts-program/classes/internal-AbstractAddress.md b/docs/packages/fuel-ts-program/classes/internal-AbstractAddress.md deleted file mode 100644 index 0aba4446fb0..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-AbstractAddress.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: default -title: AbstractAddress -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: AbstractAddress - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).AbstractAddress - -## Constructors - -### constructor - -• **new AbstractAddress**() - -## Methods - -### equals - -▸ `Abstract` **equals**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/interfaces/src/index.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L21) - -___ - -### toAddress - -▸ `Abstract` **toAddress**(): \`fuel${string}\` - -#### Returns - -\`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L17) - -___ - -### toB256 - -▸ `Abstract` **toB256**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L18) - -___ - -### toBytes - -▸ `Abstract` **toBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L20) - -___ - -### toHexString - -▸ `Abstract` **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L19) - -___ - -### toJSON - -▸ `Abstract` **toJSON**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L15) - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L16) diff --git a/docs/packages/fuel-ts-program/classes/internal-AbstractContract.md b/docs/packages/fuel-ts-program/classes/internal-AbstractContract.md deleted file mode 100644 index 544b0e2c0ab..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-AbstractContract.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: default -title: AbstractContract -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: AbstractContract - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).AbstractContract - -## Hierarchy - -- [`AbstractProgram`](internal-AbstractProgram.md) - - ↳ **`AbstractContract`** - -## Implemented by - -- [`Contract`](Contract.md) - -## Constructors - -### constructor - -• **new AbstractContract**() - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[constructor](internal-AbstractProgram.md#constructor) - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[account](internal-AbstractProgram.md#account) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### id - -• `Abstract` **id**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L48) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[interface](internal-AbstractProgram.md#interface) - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[provider](internal-AbstractProgram.md#provider) - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-program/classes/internal-AbstractProgram.md b/docs/packages/fuel-ts-program/classes/internal-AbstractProgram.md deleted file mode 100644 index 6fb4fd266db..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-AbstractProgram.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: AbstractProgram -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: AbstractProgram - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).AbstractProgram - -## Hierarchy - -- **`AbstractProgram`** - - ↳ [`AbstractContract`](internal-AbstractContract.md) - -## Constructors - -### constructor - -• **new AbstractProgram**() - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-program/classes/internal-AbstractScriptRequest.md b/docs/packages/fuel-ts-program/classes/internal-AbstractScriptRequest.md deleted file mode 100644 index ab6d57df611..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-AbstractScriptRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default -title: AbstractScriptRequest -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: AbstractScriptRequest - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).AbstractScriptRequest - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Constructors - -### constructor - -• **new AbstractScriptRequest**<`T`\>() - -#### Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### bytes - -• `Abstract` **bytes**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L9) - -___ - -### encodeScriptData - -• `Abstract` **encodeScriptData**: (`data`: `T`) => `Uint8Array` - -#### Type declaration - -▸ (`data`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L10) diff --git a/docs/packages/fuel-ts-program/classes/internal-Account.md b/docs/packages/fuel-ts-program/classes/internal-Account.md deleted file mode 100644 index 38b07ae82e7..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-Account.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -layout: default -title: Account -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: Account - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).Account - -Account - -## Hierarchy - -- [`AbstractAccount`](internal-AbstractAccount.md) - - ↳ **`Account`** - -## Constructors - -### constructor - -• **new Account**(`address`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[constructor](internal-AbstractAccount.md#constructor) - -#### Defined in - -[packages/wallet/src/account.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L39) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[address](internal-AbstractAccount.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[provider](internal-AbstractAccount.md#provider) - -#### Defined in - -[packages/wallet/src/account.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[getResourcesToSpend](internal-AbstractAccount.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[sendTransaction](internal-AbstractAccount.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/account.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L253) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[simulateTransaction](internal-AbstractAccount.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/account.ts:267](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L267) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-program/classes/internal-BN.md b/docs/packages/fuel-ts-program/classes/internal-BN.md deleted file mode 100644 index f319b556ed0..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../namespaces/internal.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](internal-BN.md) | -| `mod` | [`BN`](internal-BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](internal-BN.md) | -| `b` | [`BN`](internal-BN.md) | -| `gcd` | [`BN`](internal-BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../namespaces/internal.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](internal-BN.md) | -| `out` | [`BN`](internal-BN.md) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-program/classes/internal-BaseInvocationScope.md b/docs/packages/fuel-ts-program/classes/internal-BaseInvocationScope.md deleted file mode 100644 index 0af11918783..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-BaseInvocationScope.md +++ /dev/null @@ -1,498 +0,0 @@ ---- -layout: default -title: BaseInvocationScope -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: BaseInvocationScope - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).BaseInvocationScope - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TReturn` | `any` | - -## Hierarchy - -- **`BaseInvocationScope`** - - ↳ [`FunctionInvocationScope`](FunctionInvocationScope.md) - - ↳ [`MultiCallInvocationScope`](MultiCallInvocationScope.md) - -## Constructors - -### constructor - -• **new BaseInvocationScope**<`TReturn`\>(`program`, `isMultiCall`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TReturn` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `program` | [`AbstractProgram`](internal-AbstractProgram.md) | -| `isMultiCall` | `boolean` | - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L47) - -## Properties - -### functionInvocationScopes - -• `Protected` **functionInvocationScopes**: [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] = `[]` - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L42) - -___ - -### isMultiCall - -• `Protected` **isMultiCall**: `boolean` = `false` - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L45) - -___ - -### program - -• `Protected` **program**: [`AbstractProgram`](internal-AbstractProgram.md) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L41) - -___ - -### requiredCoins - -• `Protected` **requiredCoins**: [`CoinQuantity`](../namespaces/internal.md#coinquantity)[] = `[]` - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L44) - -___ - -### transactionRequest - -• **transactionRequest**: [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L40) - -___ - -### txParameters - -• `Protected` `Optional` **txParameters**: `Partial`<{ `gasLimit`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `gasPrice`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `variableOutputs`: `number` }\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L43) - -## Accessors - -### calls - -• `Protected` `get` **calls**(): [`ContractCall`](../index.md#contractcall)[] - -#### Returns - -[`ContractCall`](../index.md#contractcall)[] - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L55) - -## Methods - -### addCall - -▸ `Protected` **addCall**(`funcScope`): [`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScope` | [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\> | - -#### Returns - -[`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L100) - -___ - -### addCalls - -▸ `Protected` **addCalls**(`funcScopes`): [`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScopes` | [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] | - -#### Returns - -[`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:105](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L105) - -___ - -### addContracts - -▸ **addContracts**(`contracts`): [`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contracts` | [`AbstractContract`](internal-AbstractContract.md)[] | - -#### Returns - -[`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:181](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L181) - -___ - -### call - -▸ **call**<`T`\>(`options?`): `Promise`<[`FunctionInvocationResult`](FunctionInvocationResult.md)<`T`, `void`\>\> - -Submits a transaction to the blockchain. - -This is a final action and will spend the coins and change the state of the contract. -It also means that invalid transactions will throw an error, and consume gas. To avoid this -running invalid tx and consuming gas try to `simulate` first when possible. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`FunctionInvocationResult`](FunctionInvocationResult.md)<`T`, `void`\>\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:210](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L210) - -___ - -### checkGasLimitTotal - -▸ `Protected` **checkGasLimitTotal**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:130](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L130) - -___ - -### dryRun - -▸ **dryRun**<`T`\>(`options?`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -Executes a transaction in dry run mode, without UTXO validations. - -A transaction in dry run mode can't change the state of the blockchain. It can be useful to access readonly -methods or just ust get. -The UTXO validation disable in this case, enables to send invalid inputs to emulate different conditions, of a -transaction - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:248](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L248) - -___ - -### fundWithRequiredCoins - -▸ **fundWithRequiredCoins**(): `Promise`<[`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\>\> - -Add to the transaction scope the required amount of unspent UTXO's. - -Required Amount = forward coins + transfers + gas fee. - -#### Returns - -`Promise`<[`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\>\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L160) - -___ - -### get - -▸ **get**<`T`\>(`options?`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -Executes a readonly contract method call. - -Under the hood it uses the `dryRun` method but don't fund the transaction -with coins by default, for emulating executions with forward coins use `dryRun` -or pass the options.fundTransaction as true - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:273](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L273) - -___ - -### getRequiredCoins - -▸ `Protected` **getRequiredCoins**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity)[] - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity)[] - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L71) - -___ - -### getTransactionCost - -▸ **getTransactionCost**(`options?`): `Promise`<[`TransactionCost`](../namespaces/internal.md#transactioncost)\> - -Run a valid transaction in dryRun mode and returns useful details about -gasUsed, gasPrice and transaction estimate fee in native coins. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` ; `gasPrice`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `tolerance`: `number` }\> | - -#### Returns - -`Promise`<[`TransactionCost`](../namespaces/internal.md#transactioncost)\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:143](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L143) - -___ - -### getTransactionRequest - -▸ **getTransactionRequest**(`options?`): `Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -Prepare transaction request object, adding Inputs, Outputs, coins, check gas costs -and transaction validity. - -It's possible to get the transaction without adding coins, by passing `fundTransaction` -as false. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L198) - -___ - -### prepareTransaction - -▸ `Protected` **prepareTransaction**(`options?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:112](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L112) - -___ - -### simulate - -▸ **simulate**<`T`\>(`options?`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -Run a valid transaction and return the result without change the chain state. -This means, all signatures are validated but no UTXO is spent. - -This method is useful for validate propose to avoid spending coins on invalid TXs, also -to estimate the amount of gas that will be required to run the transaction. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `TReturn` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:231](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L231) - -___ - -### txParams - -▸ **txParams**(`txParams`): [`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `txParams` | `Partial`<{ `gasLimit`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `gasPrice`: [`BigNumberish`](../namespaces/internal.md#bignumberish) ; `variableOutputs`: `number` }\> | - -#### Returns - -[`BaseInvocationScope`](internal-BaseInvocationScope.md)<`TReturn`\> - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:170](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L170) - -___ - -### updateRequiredCoins - -▸ `Protected` **updateRequiredCoins**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L82) - -___ - -### updateScriptRequest - -▸ `Protected` **updateScriptRequest**(): `void` - -#### Returns - -`void` - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L63) - -___ - -### getCallOptions - -▸ `Static` `Protected` **getCallOptions**(`options?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Partial`<{ `fundTransaction`: `boolean` }\> | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `fundTransaction` | `boolean` | - -#### Defined in - -[packages/program/src/functions/base-invocation-scope.ts:59](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/base-invocation-scope.ts#L59) diff --git a/docs/packages/fuel-ts-program/classes/internal-BaseTransactionRequest.md b/docs/packages/fuel-ts-program/classes/internal-BaseTransactionRequest.md deleted file mode 100644 index a08b090c654..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-BaseTransactionRequest.md +++ /dev/null @@ -1,526 +0,0 @@ ---- -layout: default -title: BaseTransactionRequest -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: BaseTransactionRequest - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequest - -## Hierarchy - -- **`BaseTransactionRequest`** - - ↳ [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - - ↳ [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -## Implements - -- [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) - -## Constructors - -### constructor - -• **new BaseTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) | - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L131) - -## Properties - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasLimit](../interfaces/internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasPrice](../interfaces/internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[inputs](../interfaces/internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[maturity](../interfaces/internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[outputs](../interfaces/internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### type - -• `Abstract` **type**: [`TransactionType`](../enums/internal-TransactionType.md) - -Type of the transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:117](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L117) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[witnesses](../interfaces/internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ `Abstract` **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:167](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L167) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) diff --git a/docs/packages/fuel-ts-program/classes/internal-CreateTransactionRequest.md b/docs/packages/fuel-ts-program/classes/internal-CreateTransactionRequest.md deleted file mode 100644 index 817722b896a..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-CreateTransactionRequest.md +++ /dev/null @@ -1,703 +0,0 @@ ---- -layout: default -title: CreateTransactionRequest -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: CreateTransactionRequest - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`CreateTransactionRequest`** - -## Constructors - -### constructor - -• **new CreateTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:528](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L528) - -## Properties - -### bytecodeWitnessIndex - -• **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:522](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L522) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### salt - -• **salt**: `string` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:524](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L524) - -___ - -### storageSlots - -• **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:526](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L526) - -___ - -### type - -• **type**: [`Create`](../enums/internal-TransactionType.md#create) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:520](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L520) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContractCreatedOutput - -▸ **addContractCreatedOutput**(`contractId`, `stateRoot`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:562](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L562) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractCreatedOutputs - -▸ **getContractCreatedOutputs**(): [`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Returns - -[`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:555](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L555) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:540](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L540) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Returns - -[`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:512](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L512) diff --git a/docs/packages/fuel-ts-program/classes/internal-InvocationCallResult.md b/docs/packages/fuel-ts-program/classes/internal-InvocationCallResult.md deleted file mode 100644 index ceaf80fe117..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-InvocationCallResult.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -layout: default -title: InvocationCallResult -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: InvocationCallResult - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).InvocationCallResult - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- [`InvocationResult`](InvocationResult.md)<`T`\> - - ↳ **`InvocationCallResult`** - -## Constructors - -### constructor - -• **new InvocationCallResult**<`T`\>(`funcScopes`, `callResult`, `isMultiCall`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScopes` | [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\> \| [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] | -| `callResult` | [`CallResult`](../namespaces/internal.md#callresult) | -| `isMultiCall` | `boolean` | - -#### Overrides - -[InvocationResult](InvocationResult.md).[constructor](InvocationResult.md#constructor) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L125) - -## Properties - -### callResult - -• `Readonly` **callResult**: [`CallResult`](../namespaces/internal.md#callresult) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L123) - -___ - -### functionScopes - -• `Readonly` **functionScopes**: [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] - -#### Inherited from - -[InvocationResult](InvocationResult.md).[functionScopes](InvocationResult.md#functionscopes) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L29) - -___ - -### gasUsed - -• `Readonly` **gasUsed**: [`BN`](internal-BN.md) - -#### Inherited from - -[InvocationResult](InvocationResult.md).[gasUsed](InvocationResult.md#gasused) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L31) - -___ - -### isMultiCall - -• `Readonly` **isMultiCall**: `boolean` - -#### Inherited from - -[InvocationResult](InvocationResult.md).[isMultiCall](InvocationResult.md#ismulticall) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L30) - -___ - -### value - -• `Readonly` **value**: `T` - -#### Inherited from - -[InvocationResult](InvocationResult.md).[value](InvocationResult.md#value) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L32) - -## Methods - -### getDecodedLogs - -▸ `Protected` **getDecodedLogs**(`receipts`): `unknown`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](../namespaces/internal.md#transactionresultreceipt)[] | - -#### Returns - -`unknown`[] - -#### Inherited from - -[InvocationResult](InvocationResult.md).[getDecodedLogs](InvocationResult.md#getdecodedlogs) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L68) - -___ - -### getDecodedValue - -▸ `Protected` **getDecodedValue**(`callResult`): `T` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `callResult` | [`CallResult`](../namespaces/internal.md#callresult) | - -#### Returns - -`T` - -#### Inherited from - -[InvocationResult](InvocationResult.md).[getDecodedValue](InvocationResult.md#getdecodedvalue) - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:53](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L53) - -___ - -### build - -▸ `Static` **build**<`T`\>(`funcScopes`, `callResult`, `isMultiCall`): `Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `funcScopes` | [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\> \| [`InvocationScopeLike`](../index.md#invocationscopelike)<`unknown`\>[] | -| `callResult` | [`CallResult`](../namespaces/internal.md#callresult) | -| `isMultiCall` | `boolean` | - -#### Returns - -`Promise`<[`InvocationCallResult`](internal-InvocationCallResult.md)<`T`\>\> - -#### Defined in - -[packages/program/src/functions/invocation-results.ts:134](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/functions/invocation-results.ts#L134) diff --git a/docs/packages/fuel-ts-program/classes/internal-ScriptTransactionRequest.md b/docs/packages/fuel-ts-program/classes/internal-ScriptTransactionRequest.md deleted file mode 100644 index dca24b9d514..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-ScriptTransactionRequest.md +++ /dev/null @@ -1,797 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequest -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: ScriptTransactionRequest - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`ScriptTransactionRequest`** - -## Constructors - -### constructor - -• **new ScriptTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:406](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L406) - -## Properties - -### bytesOffset - -• **bytesOffset**: `undefined` \| `number` - -determined bytes offset for start of script data - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:404](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L404) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### script - -• **script**: `Uint8Array` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:400](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L400) - -___ - -### scriptData - -• **scriptData**: `Uint8Array` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:402](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L402) - -___ - -### type - -• **type**: [`Script`](../namespaces/internal.md#script) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:398](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L398) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContract - -▸ **addContract**(`contract`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | [`ContractIdLike`](../namespaces/internal.md#contractidlike) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:481](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L481) - -___ - -### addMessageOutputs - -▸ **addMessageOutputs**(`numberOfMessages?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfMessages` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:466](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L466) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### addVariableOutputs - -▸ **addVariableOutputs**(`numberOfVariables?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfVariables` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:453](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L453) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractInputs - -▸ **getContractInputs**(): [`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Returns - -[`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:426](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L426) - -___ - -### getContractOutputs - -▸ **getContractOutputs**(): [`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Returns - -[`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:432](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L432) - -___ - -### getVariableOutputs - -▸ **getVariableOutputs**(): [`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Returns - -[`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:438](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L438) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### setScript - -▸ **setScript**<`T`\>(`script`, `data`): `void` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `script` | [`AbstractScriptRequest`](internal-AbstractScriptRequest.md)<`T`\> | -| `data` | `T` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:444](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L444) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:412](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L412) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Returns - -[`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:390](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L390) diff --git a/docs/packages/fuel-ts-program/classes/internal-TransactionResponse.md b/docs/packages/fuel-ts-program/classes/internal-TransactionResponse.md deleted file mode 100644 index 05f3ba8b896..00000000000 --- a/docs/packages/fuel-ts-program/classes/internal-TransactionResponse.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -layout: default -title: TransactionResponse -parent: "@fuel-ts/program" -nav_order: 1 - ---- - -# Class: TransactionResponse - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).TransactionResponse - -## Constructors - -### constructor - -• **new TransactionResponse**(`id`, `provider`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `provider` | `default` | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L102) - -## Properties - -### attempts - -• **attempts**: `number` = `0` - -Number off attempts to get the committed tx - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L100) - -___ - -### gasUsed - -• **gasUsed**: [`BN`](internal-BN.md) - -Gas used on the transaction - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L98) - -___ - -### id - -• **id**: `string` - -Transaction ID - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L94) - -___ - -### provider - -• **provider**: `default` - -Current provider - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L96) - -## Methods - -### decodeTransaction - -▸ **decodeTransaction**<`TTransactionType`\>(`transactionWithReceipts`): [`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionWithReceipts` | `Object` | -| `transactionWithReceipts.__typename` | ``"Transaction"`` | -| `transactionWithReceipts.gasPrice?` | ``null`` \| `string` | -| `transactionWithReceipts.id` | `string` | -| `transactionWithReceipts.rawPayload` | `string` | -| `transactionWithReceipts.receipts?` | ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] | -| `transactionWithReceipts.status?` | ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } | - -#### Returns - -[`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:114](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L114) - -___ - -### fetch - -▸ **fetch**(): `Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Returns - -`Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L107) - -___ - -### wait - -▸ **wait**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -Waits for transaction to succeed and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:188](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L188) - -___ - -### waitForResult - -▸ **waitForResult**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -Waits for transaction to succeed or fail and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:124](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L124) diff --git a/docs/packages/fuel-ts-program/enums/internal-GqlCoinStatus.md b/docs/packages/fuel-ts-program/enums/internal-GqlCoinStatus.md deleted file mode 100644 index 6a8f5d03a19..00000000000 --- a/docs/packages/fuel-ts-program/enums/internal-GqlCoinStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlCoinStatus -parent: "@fuel-ts/program" -nav_order: 4 - ---- - -# Enumeration: GqlCoinStatus - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).GqlCoinStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:157 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:158 diff --git a/docs/packages/fuel-ts-program/enums/internal-GqlMessageStatus.md b/docs/packages/fuel-ts-program/enums/internal-GqlMessageStatus.md deleted file mode 100644 index 4db28e1108d..00000000000 --- a/docs/packages/fuel-ts-program/enums/internal-GqlMessageStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlMessageStatus -parent: "@fuel-ts/program" -nav_order: 4 - ---- - -# Enumeration: GqlMessageStatus - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).GqlMessageStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:373 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:374 diff --git a/docs/packages/fuel-ts-program/enums/internal-GqlReturnType.md b/docs/packages/fuel-ts-program/enums/internal-GqlReturnType.md deleted file mode 100644 index 046ea0dc7d6..00000000000 --- a/docs/packages/fuel-ts-program/enums/internal-GqlReturnType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: GqlReturnType -parent: "@fuel-ts/program" -nav_order: 4 - ---- - -# Enumeration: GqlReturnType - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).GqlReturnType - -## Enumeration Members - -### Return - -• **Return** = ``"RETURN"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:688 - -___ - -### ReturnData - -• **ReturnData** = ``"RETURN_DATA"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:689 - -___ - -### Revert - -• **Revert** = ``"REVERT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:690 diff --git a/docs/packages/fuel-ts-program/enums/internal-TransactionType.md b/docs/packages/fuel-ts-program/enums/internal-TransactionType.md deleted file mode 100644 index 5d4d4555763..00000000000 --- a/docs/packages/fuel-ts-program/enums/internal-TransactionType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: TransactionType -parent: "@fuel-ts/program" -nav_order: 4 - ---- - -# Enumeration: TransactionType - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).TransactionType - -## Enumeration Members - -### Create - -• **Create** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Mint - -• **Mint** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L22) - -___ - -### Script - -• **Script** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) diff --git a/docs/packages/fuel-ts-program/index.md b/docs/packages/fuel-ts-program/index.md deleted file mode 100644 index 93b041ed348..00000000000 --- a/docs/packages/fuel-ts-program/index.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -layout: default -title: "@fuel-ts/program" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/program - -## Namespaces - -- [internal](namespaces/internal.md) - -## Classes - -- [Contract](classes/Contract.md) -- [FunctionInvocationResult](classes/FunctionInvocationResult.md) -- [FunctionInvocationScope](classes/FunctionInvocationScope.md) -- [InvocationResult](classes/InvocationResult.md) -- [MultiCallInvocationScope](classes/MultiCallInvocationScope.md) -- [ScriptRequest](classes/ScriptRequest.md) -- [ScriptResultDecoderError](classes/ScriptResultDecoderError.md) - -## Interfaces - -- [InvokeFunctions](interfaces/InvokeFunctions.md) - -## Type Aliases - -### CallConfig - -Ƭ **CallConfig**<`T`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `args` | `T` | -| `bytesOffset` | `number` | -| `callParameters?` | [`CallParams`](index.md#callparams) | -| `forward?` | [`CoinQuantity`](namespaces/internal.md#coinquantity) | -| `func` | `FunctionFragment` | -| `program` | [`AbstractProgram`](classes/internal-AbstractProgram.md) | -| `txParameters?` | [`TxParams`](index.md#txparams) | - -#### Defined in - -[packages/program/src/types.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/types.ts#L32) - -___ - -### CallOptions - -Ƭ **CallOptions**: `Partial`<{ `fundTransaction`: `boolean` }\> - -#### Defined in - -[packages/program/src/types.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/types.ts#L28) - -___ - -### CallParams - -Ƭ **CallParams**: `Partial`<{ `forward`: [`CoinQuantityLike`](namespaces/internal.md#coinquantitylike) ; `gasLimit`: [`BigNumberish`](namespaces/internal.md#bignumberish) }\> - -#### Defined in - -[packages/program/src/types.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/types.ts#L17) - -___ - -### ContractCall - -Ƭ **ContractCall**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount?` | [`BigNumberish`](namespaces/internal.md#bignumberish) | -| `assetId?` | `BytesLike` | -| `contractId` | [`AbstractAddress`](classes/internal-AbstractAddress.md) | -| `data` | `BytesLike` | -| `gas?` | [`BigNumberish`](namespaces/internal.md#bignumberish) | - -#### Defined in - -[packages/program/src/types.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/types.ts#L9) - -___ - -### InvocationScopeLike - -Ƭ **InvocationScopeLike**<`T`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `getCallConfig` | () => [`CallConfig`](index.md#callconfig)<`T`\> | - -#### Defined in - -[packages/program/src/types.ts:51](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/types.ts#L51) - -___ - -### InvokeFunction - -Ƭ **InvokeFunction**<`TArgs`, `TReturn`\>: (...`args`: `TArgs`) => [`FunctionInvocationScope`](classes/FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TArgs` | extends `any`[] = `any`[] | -| `TReturn` | `any` | - -#### Type declaration - -▸ (...`args`): [`FunctionInvocationScope`](classes/FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `TArgs` | - -##### Returns - -[`FunctionInvocationScope`](classes/FunctionInvocationScope.md)<`TArgs`, `TReturn`\> - -#### Defined in - -[packages/program/src/types.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/types.ts#L43) - -___ - -### TransactionCostOptions - -Ƭ **TransactionCostOptions**: `Partial`<{ `fundTransaction`: `boolean` ; `gasPrice`: [`BigNumberish`](namespaces/internal.md#bignumberish) ; `tolerance`: `number` }\> - -#### Defined in - -[packages/program/src/types.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/types.ts#L55) - -___ - -### TxParams - -Ƭ **TxParams**: `Partial`<{ `gasLimit`: [`BigNumberish`](namespaces/internal.md#bignumberish) ; `gasPrice`: [`BigNumberish`](namespaces/internal.md#bignumberish) ; `variableOutputs`: `number` }\> - -#### Defined in - -[packages/program/src/types.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/types.ts#L22) - -## Functions - -### assert - -▸ **assert**(`condition`, `message`): asserts condition - -Generic assert function to avoid undesirable errors - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `condition` | `unknown` | -| `message` | `string` | - -#### Returns - -asserts condition - -#### Defined in - -[packages/program/src/utils.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/utils.ts#L24) - -___ - -### getDocs - -▸ **getDocs**(`status`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `status` | `Object` | -| `status.reason` | `any` | -| `status.type` | ``"failure"`` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `doc` | `string` | -| `reason` | `string` | - -#### Defined in - -[packages/program/src/utils.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/utils.ts#L8) diff --git a/docs/packages/fuel-ts-program/interfaces/InvokeFunctions.md b/docs/packages/fuel-ts-program/interfaces/InvokeFunctions.md deleted file mode 100644 index 734afcab82a..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/InvokeFunctions.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: default -title: InvokeFunctions -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: InvokeFunctions - -[@fuel-ts/program](../index.md).InvokeFunctions - -## Indexable - -▪ [key: `string`]: [`InvokeFunction`](../index.md#invokefunction) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-program/interfaces/internal-BNHelper.md deleted file mode 100644 index eec2e53dc59..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-program/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index 5b4baab11b0..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../namespaces/internal.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/internal-BN.md) ; `mod`: [`BN`](../classes/internal-BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/internal-BN.md) | -| `mod` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/internal-BN.md), `out`: [`BN`](../classes/internal-BN.md)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/internal-BN.md) | -| `out` | [`BN`](../classes/internal-BN.md) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-program/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index 8c0c4130bc4..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-program/interfaces/internal-BNOverrides.md deleted file mode 100644 index 26154e4f139..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-BaseTransactionRequestLike.md b/docs/packages/fuel-ts-program/interfaces/internal-BaseTransactionRequestLike.md deleted file mode 100644 index 316c81c3d5e..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-BaseTransactionRequestLike.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -layout: default -title: BaseTransactionRequestLike -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: BaseTransactionRequestLike - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequestLike - -## Hierarchy - -- **`BaseTransactionRequestLike`** - - ↳ [`ScriptTransactionRequestLike`](internal-ScriptTransactionRequestLike.md) - - ↳ [`CreateTransactionRequestLike`](internal-CreateTransactionRequestLike.md) - -## Implemented by - -- [`BaseTransactionRequest`](../classes/internal-BaseTransactionRequest.md) - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-CreateTransactionRequestLike.md b/docs/packages/fuel-ts-program/interfaces/internal-CreateTransactionRequestLike.md deleted file mode 100644 index 9b052449552..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-CreateTransactionRequestLike.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -layout: default -title: CreateTransactionRequestLike -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: CreateTransactionRequestLike - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`CreateTransactionRequestLike`** - -## Properties - -### bytecodeWitnessIndex - -• `Optional` **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:504](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L504) - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### salt - -• `Optional` **salt**: `BytesLike` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:506](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L506) - -___ - -### storageSlots - -• `Optional` **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:508](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L508) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFragment.md b/docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFragment.md deleted file mode 100644 index b6fe35f8bb5..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFragment.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: JsonAbiFragment -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: JsonAbiFragment - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).JsonAbiFragment - -## Properties - -### attributes - -• `Optional` `Readonly` **attributes**: readonly [`JsonAbiFunctionAttributeType`](internal-JsonAbiFunctionAttributeType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L33) - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L31) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L30) - -___ - -### outputs - -• `Optional` `Readonly` **outputs**: readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L32) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L24) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFragmentType.md b/docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFragmentType.md deleted file mode 100644 index 03c0bfcfba7..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFragmentType.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: JsonAbiFragmentType -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: JsonAbiFragmentType - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).JsonAbiFragmentType - -## Properties - -### components - -• `Optional` `Readonly` **components**: ``null`` \| readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L14) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L12) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L11) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: ``null`` \| readonly [`JsonAbiFragmentType`](internal-JsonAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L15) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFunctionAttributeType.md b/docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFunctionAttributeType.md deleted file mode 100644 index e75f4ba7d0a..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-JsonAbiFunctionAttributeType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: JsonAbiFunctionAttributeType -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: JsonAbiFunctionAttributeType - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).JsonAbiFunctionAttributeType - -## Properties - -### arguments - -• `Readonly` **arguments**: readonly `string`[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L20) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L19) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbi.md b/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbi.md deleted file mode 100644 index 05d250d1571..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbi.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: JsonFlatAbi -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: JsonFlatAbi - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).JsonFlatAbi - -## Properties - -### functions - -• `Readonly` **functions**: readonly [`JsonFlatAbiFragmentFunction`](internal-JsonFlatAbiFragmentFunction.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L71) - -___ - -### loggedTypes - -• `Readonly` **loggedTypes**: readonly [`JsonFlatAbiFragmentLoggedType`](internal-JsonFlatAbiFragmentLoggedType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:70](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L70) - -___ - -### types - -• `Readonly` **types**: readonly [`JsonFlatAbiFragmentType`](internal-JsonFlatAbiFragmentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:69](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L69) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentArgumentType.md b/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentArgumentType.md deleted file mode 100644 index 265fa8d6462..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentArgumentType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentArgumentType -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentArgumentType - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentArgumentType - -## Properties - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L57) - -___ - -### type - -• `Readonly` **type**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L56) - -___ - -### typeArguments - -• `Optional` `Readonly` **typeArguments**: ``null`` \| readonly [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:58](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L58) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentFunction.md b/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentFunction.md deleted file mode 100644 index a9c1fe2929d..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentFunction.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentFunction -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentFunction - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentFunction - -## Properties - -### attributes - -• `Optional` `Readonly` **attributes**: ``null`` \| readonly [`JsonAbiFunctionAttributeType`](internal-JsonAbiFunctionAttributeType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L65) - -___ - -### inputs - -• `Optional` `Readonly` **inputs**: readonly [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L63) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L62) - -___ - -### output - -• `Optional` `Readonly` **output**: `Readonly`<[`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)\> - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L64) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentLoggedType.md b/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentLoggedType.md deleted file mode 100644 index 6d72cb9831f..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentLoggedType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentLoggedType -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentLoggedType - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentLoggedType - -## Properties - -### logId - -• `Readonly` **logId**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:51](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L51) - -___ - -### loggedType - -• `Readonly` **loggedType**: [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md) - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:52](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L52) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentType.md b/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentType.md deleted file mode 100644 index 21513924966..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-JsonFlatAbiFragmentType.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: JsonFlatAbiFragmentType -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: JsonFlatAbiFragmentType - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).JsonFlatAbiFragmentType - -## Properties - -### components - -• `Optional` `Readonly` **components**: ``null`` \| readonly [`JsonFlatAbiFragmentArgumentType`](internal-JsonFlatAbiFragmentArgumentType.md)[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L46) - -___ - -### name - -• `Optional` `Readonly` **name**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L45) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L44) - -___ - -### typeId - -• `Readonly` **typeId**: `number` - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L43) - -___ - -### typeParameters - -• `Optional` `Readonly` **typeParameters**: ``null`` \| readonly `number`[] - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L47) diff --git a/docs/packages/fuel-ts-program/interfaces/internal-ScriptTransactionRequestLike.md b/docs/packages/fuel-ts-program/interfaces/internal-ScriptTransactionRequestLike.md deleted file mode 100644 index 3f19a46afd4..00000000000 --- a/docs/packages/fuel-ts-program/interfaces/internal-ScriptTransactionRequestLike.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequestLike -parent: "@fuel-ts/program" -nav_order: 2 - ---- - -# Interface: ScriptTransactionRequestLike - -[@fuel-ts/program](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`ScriptTransactionRequestLike`** - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### script - -• `Optional` **script**: `BytesLike` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:384](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L384) - -___ - -### scriptData - -• `Optional` **scriptData**: `BytesLike` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:386](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L386) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-program/namespaces/internal.md b/docs/packages/fuel-ts-program/namespaces/internal.md deleted file mode 100644 index 1e7bcfe4b9f..00000000000 --- a/docs/packages/fuel-ts-program/namespaces/internal.md +++ /dev/null @@ -1,1513 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/program" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/program](../index.md).internal - -## Enumerations - -- [GqlCoinStatus](../enums/internal-GqlCoinStatus.md) -- [GqlMessageStatus](../enums/internal-GqlMessageStatus.md) -- [GqlReturnType](../enums/internal-GqlReturnType.md) -- [TransactionType](../enums/internal-TransactionType.md) - -## Classes - -- [AbstractAccount](../classes/internal-AbstractAccount.md) -- [AbstractAddress](../classes/internal-AbstractAddress.md) -- [AbstractContract](../classes/internal-AbstractContract.md) -- [AbstractProgram](../classes/internal-AbstractProgram.md) -- [AbstractScriptRequest](../classes/internal-AbstractScriptRequest.md) -- [Account](../classes/internal-Account.md) -- [BN](../classes/internal-BN.md) -- [BaseInvocationScope](../classes/internal-BaseInvocationScope.md) -- [BaseTransactionRequest](../classes/internal-BaseTransactionRequest.md) -- [CreateTransactionRequest](../classes/internal-CreateTransactionRequest.md) -- [InvocationCallResult](../classes/internal-InvocationCallResult.md) -- [ScriptTransactionRequest](../classes/internal-ScriptTransactionRequest.md) -- [TransactionResponse](../classes/internal-TransactionResponse.md) - -## Interfaces - -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) -- [BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md) -- [CreateTransactionRequestLike](../interfaces/internal-CreateTransactionRequestLike.md) -- [JsonAbiFragment](../interfaces/internal-JsonAbiFragment.md) -- [JsonAbiFragmentType](../interfaces/internal-JsonAbiFragmentType.md) -- [JsonAbiFunctionAttributeType](../interfaces/internal-JsonAbiFunctionAttributeType.md) -- [JsonFlatAbi](../interfaces/internal-JsonFlatAbi.md) -- [JsonFlatAbiFragmentArgumentType](../interfaces/internal-JsonFlatAbiFragmentArgumentType.md) -- [JsonFlatAbiFragmentFunction](../interfaces/internal-JsonFlatAbiFragmentFunction.md) -- [JsonFlatAbiFragmentLoggedType](../interfaces/internal-JsonFlatAbiFragmentLoggedType.md) -- [JsonFlatAbiFragmentType](../interfaces/internal-JsonFlatAbiFragmentType.md) -- [ScriptTransactionRequestLike](../interfaces/internal-ScriptTransactionRequestLike.md) - -## Enumeration Members - -### Call - -• **Call**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L10) - -___ - -### Change - -• **Change**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L10) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L15) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L7) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L16) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L8) - -___ - -### ContractCreated - -• **ContractCreated**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L12) - -___ - -### Create - -• **Create**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Log - -• **Log**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L15) - -___ - -### LogData - -• **LogData**: ``6`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L17) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L9) - -___ - -### MessageOut - -• **MessageOut**: ``10`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L20) - -___ - -### Panic - -• **Panic**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L13) - -___ - -### Return - -• **Return**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L11) - -___ - -### ReturnData - -• **ReturnData**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L12) - -___ - -### Revert - -• **Revert**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L14) - -___ - -### Script - -• **Script**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) - -___ - -### ScriptResult - -• **ScriptResult**: ``9`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L19) - -___ - -### Transfer - -• **Transfer**: ``7`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L17) - -___ - -### TransferOut - -• **TransferOut**: ``8`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L18) - -___ - -### Variable - -• **Variable**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L11) - -## Type Aliases - -### AddressLike - -Ƭ **AddressLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractAccount`](../classes/internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L55) - -___ - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### BigNumberish - -Ƭ **BigNumberish**: `string` \| `number` \| [`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/types.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L3) - -___ - -### CallResult - -Ƭ **CallResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | - -#### Defined in - -[packages/providers/src/provider.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L42) - -___ - -### ChangeTransactionRequestOutput - -Ƭ **ChangeTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L30) - -___ - -### Coin - -Ƭ **Coin**: `Object` - -A Fuel coin - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `blockCreated` | [`BN`](../classes/internal-BN.md) | -| `id` | `string` | -| `maturity` | `number` | -| `owner` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlCoinStatus`](../enums/internal-GqlCoinStatus.md) | - -#### Defined in - -[packages/providers/src/coin.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin.ts#L9) - -___ - -### CoinQuantity - -Ƭ **CoinQuantity**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `max?` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/providers/src/coin-quantity.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L10) - -___ - -### CoinQuantityLike - -Ƭ **CoinQuantityLike**: [amount: BigNumberish, assetId?: BytesLike, max?: BigNumberish] \| { `amount`: [`BigNumberish`](internal.md#bignumberish) ; `assetId?`: `BytesLike` ; `max?`: [`BigNumberish`](internal.md#bignumberish) } - -#### Defined in - -[packages/providers/src/coin-quantity.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L7) - -___ - -### CoinTransactionRequestInput - -Ƭ **CoinTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `assetId` | `BytesLike` | Asset ID of the coins | -| `id` | `BytesLike` | UTXO ID | -| `maturity?` | `number` | UTXO being spent must have been created at least this many blocks ago | -| `owner` | `BytesLike` | Owning address or script hash | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L9) - -___ - -### CoinTransactionRequestOutput - -Ƭ **CoinTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins to send | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L9) - -___ - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) - -___ - -### ContractCreatedTransactionRequestOutput - -Ƭ **ContractCreatedTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L40) - -___ - -### ContractIdLike - -Ƭ **ContractIdLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractContract`](../classes/internal-AbstractContract.md) - -#### Defined in - -[packages/interfaces/src/index.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L57) - -___ - -### ContractTransactionRequestInput - -Ƭ **ContractTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L66) - -___ - -### ContractTransactionRequestOutput - -Ƭ **ContractTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `inputIndex` | `number` | Index of input contract | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L18) - -___ - -### ExcludeResourcesOption - -Ƭ **ExcludeResourcesOption**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `messages?` | `BytesLike`[] | -| `utxos?` | `BytesLike`[] | - -#### Defined in - -[packages/providers/src/resource.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L36) - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](internal.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### Input - -Ƭ **Input**: [`InputCoin`](internal.md#inputcoin) \| [`InputContract`](internal.md#inputcontract) \| [`InputMessage`](internal.md#inputmessage) - -#### Defined in - -[packages/transactions/src/coders/input.ts:324](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L324) - -___ - -### InputCoin - -Ƭ **InputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins (u64) | -| `assetId` | `string` | Asset ID of the coins (b256) | -| `maturity` | `number` | UTXO being spent must have been created at least this many blocks ago (u32) | -| `owner` | `string` | Owning address or script hash (b256) | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L20) - -___ - -### InputContract - -Ƭ **InputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract before transaction execution (b256) | -| `contractID` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract before transaction execution (b256) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L131) - -___ - -### InputMessage - -Ƭ **InputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins | -| `data` | `string` | data of message | -| `dataLength` | `number` | Length of predicate, in instructions (u16) | -| `nonce` | [`BN`](../classes/internal-BN.md) | Unique nonce of message | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `recipient` | `string` | Address of sender | -| `sender` | `string` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes message (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:196](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L196) - -___ - -### JsonAbi - -Ƭ **JsonAbi**: `ReadonlyArray`<[`JsonAbiFragment`](../interfaces/internal-JsonAbiFragment.md)\> \| [`JsonFlatAbi`](../interfaces/internal-JsonFlatAbi.md) - -A JSON ABI object - -#### Defined in - -[packages/abi-coder/src/json-abi.ts:78](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/json-abi.ts#L78) - -___ - -### Message - -Ƭ **Message**: `Object` - -A Fuel message - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `daHeight` | [`BN`](../classes/internal-BN.md) | -| `data` | `BytesLike` | -| `nonce` | [`BN`](../classes/internal-BN.md) | -| `recipient` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `sender` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlMessageStatus`](../enums/internal-GqlMessageStatus.md) | - -#### Defined in - -[packages/providers/src/message.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/message.ts#L11) - -___ - -### MessageTransactionRequestInput - -Ƭ **MessageTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `data` | `BytesLike` | data of message | -| `nonce` | [`BigNumberish`](internal.md#bignumberish) | Unique nonce of message | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `recipient` | `BytesLike` | Address of sender | -| `sender` | `BytesLike` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes the message | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L39) - -___ - -### MessageTransactionRequestOutput - -Ƭ **MessageTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins sent with message | -| `recipient` | `BytesLike` | Receiving address | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L23) - -___ - -### Output - -Ƭ **Output**: [`OutputCoin`](internal.md#outputcoin) \| [`OutputContract`](internal.md#outputcontract) \| [`OutputMessage`](internal.md#outputmessage) \| [`OutputChange`](internal.md#outputchange) \| [`OutputVariable`](internal.md#outputvariable) \| [`OutputContractCreated`](internal.md#outputcontractcreated) - -#### Defined in - -[packages/transactions/src/coders/output.ts:294](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L294) - -___ - -### OutputChange - -Ƭ **OutputChange**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:153](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L153) - -___ - -### OutputCoin - -Ƭ **OutputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L15) - -___ - -### OutputContract - -Ƭ **OutputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract after transaction execution (b256) | -| `inputIndex` | `number` | Index of input contract (u8) | -| `stateRoot` | `string` | State root of contract after transaction execution (b256) | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L63) - -___ - -### OutputContractCreated - -Ƭ **OutputContractCreated**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract (b256) | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:249](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L249) - -___ - -### OutputMessage - -Ƭ **OutputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send with message (u64) | -| `recipient` | `string` | Receiving address (b256) | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:111](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L111) - -___ - -### OutputVariable - -Ƭ **OutputVariable**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Variable`](internal.md#variable) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:201](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L201) - -___ - -### PossibleTransactions - -Ƭ **PossibleTransactions**: [`TransactionScript`](internal.md#transactionscript) \| [`TransactionCreate`](internal.md#transactioncreate) \| [`TransactionMint`](internal.md#transactionmint) - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:347](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L347) - -___ - -### ReceiptCall - -Ƭ **ReceiptCall**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to forward, i.e. $rB (u64) | -| `assetId` | `string` | Asset ID of coins to forward, i.e. MEM[$rC, 32] (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `gas` | [`BN`](../classes/internal-BN.md) | Gas to forward, i.e. $rD (u64) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `param1` | [`BN`](../classes/internal-BN.md) | First parameter (u64) | -| `param2` | [`BN`](../classes/internal-BN.md) | Second parameter (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of called contract (b256) | -| `type` | [`Call`](internal.md#call) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L23) - -___ - -### ReceiptLog - -Ƭ **ReceiptLog**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Log`](internal.md#log) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `val2` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `val3` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:341](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L341) - -___ - -### ReceiptLogData - -Ƭ **ReceiptLogData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rC, $rD] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `type` | [`LogData`](internal.md#logdata) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:413](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L413) - -___ - -### ReceiptMessageOut - -Ƭ **ReceiptMessageOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Hexadecimal string representation of a 64-bit unsigned integer; value of register $rD | -| `data` | `Uint8Array` | Hexadecimal string representation of the value of the memory range MEM[$rA + 32, $rB] | -| `digest` | `string` | Hexadecimal string representation of 256-bit (32-byte), hash of MEM[$rA + 32, $rB] | -| `messageID` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message ID | -| `nonce` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message nonce | -| `recipient` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message recipient: MEM[$rA, 32] | -| `sender` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message sender: MEM[$fp, 32] | -| `type` | [`MessageOut`](internal.md#messageout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:665](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L665) - -___ - -### ReceiptPanic - -Ƭ **ReceiptPanic**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Value of optional contract ID | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `reason` | [`BN`](../classes/internal-BN.md) | Panic reason (u64) | -| `type` | [`Panic`](internal.md#panic) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:227](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L227) - -___ - -### ReceiptReturn - -Ƭ **ReceiptReturn**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Return`](internal.md#return) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L107) - -___ - -### ReceiptReturnData - -Ƭ **ReceiptReturnData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rA, $rB] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `type` | [`ReturnData`](internal.md#returndata) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:161](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L161) - -___ - -### ReceiptRevert - -Ƭ **ReceiptRevert**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Revert`](internal.md#revert) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:287](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L287) - -___ - -### ReceiptScriptResult - -Ƭ **ReceiptScriptResult**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | Gas consumed by the script (u64) | -| `result` | [`BN`](../classes/internal-BN.md) | Result variant with embedded `PanicReason` in first 8 bits and `instr` (u64) | -| `type` | [`ScriptResult`](internal.md#scriptresult) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:623](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L623) - -___ - -### ReceiptTransfer - -Ƭ **ReceiptTransfer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of contract to transfer coins to (b256) | -| `type` | [`Transfer`](internal.md#transfer) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:491](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L491) - -___ - -### ReceiptTransferOut - -Ƭ **ReceiptTransferOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Address to transfer coins to (b256) | -| `type` | [`TransferOut`](internal.md#transferout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:557](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L557) - -___ - -### Resource - -Ƭ **Resource**: [`Coin`](internal.md#coin-2) \| [`Message`](internal.md#message-2) - -#### Defined in - -[packages/providers/src/resource.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L32) - -___ - -### ScriptResult - -Ƭ **ScriptResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `callResult` | [`CallResult`](internal.md#callresult) | -| `code` | [`BN`](../classes/internal-BN.md) | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | -| `returnReceipt` | [`TransactionResultReturnReceipt`](internal.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](internal.md#transactionresultreturndatareceipt) \| [`TransactionResultRevertReceipt`](internal.md#transactionresultrevertreceipt) | -| `scriptResultReceipt` | [`TransactionResultScriptResultReceipt`](internal.md#transactionresultscriptresultreceipt) | - -#### Defined in - -[packages/program/src/script-request.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/program/src/script-request.ts#L31) - -___ - -### StorageSlot - -Ƭ **StorageSlot**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Key (b256) | -| `value` | `string` | Value (b256) | - -#### Defined in - -[packages/transactions/src/coders/storage-slot.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/storage-slot.ts#L3) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) - -___ - -### Transaction - -Ƭ **Transaction**<`TTransactionType`\>: `TTransactionType` extends [`TransactionType`](../enums/internal-TransactionType.md) ? `Extract`<[`PossibleTransactions`](internal.md#possibletransactions), { `type`: `TTransactionType` }\> : `Partial`<`Omit`<[`TransactionScript`](internal.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](internal.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](internal.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/internal-TransactionType.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:348](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L348) - -___ - -### TransactionCost - -Ƭ **TransactionCost**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `fee` | [`BN`](../classes/internal-BN.md) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | -| `minGasPrice` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/providers/src/provider.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L102) - -___ - -### TransactionCreate - -Ƭ **TransactionCreate**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bytecodeLength` | `number` | Contract bytecode length, in instructions (u16) | -| `bytecodeWitnessIndex` | `number` | Witness index of contract bytecode to create (u8) | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `salt` | `string` | Salt (b256) | -| `storageSlots` | [`StorageSlot`](internal.md#storageslot)[] | List of inputs (StorageSlot[]) | -| `storageSlotsCount` | `number` | Number of storage slots to initialize (u16) | -| `type` | [`Create`](../enums/internal-TransactionType.md#create) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L159) - -___ - -### TransactionMint - -Ƭ **TransactionMint**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | The location of the Mint transaction in the block. | -| `type` | [`Mint`](../enums/internal-TransactionType.md#mint) | - | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:297](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L297) - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: [`ScriptTransactionRequest`](../classes/internal-ScriptTransactionRequest.md) \| [`CreateTransactionRequest`](../classes/internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:576](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L576) - -___ - -### TransactionRequestInput - -Ƭ **TransactionRequestInput**: [`CoinTransactionRequestInput`](internal.md#cointransactionrequestinput) \| [`ContractTransactionRequestInput`](internal.md#contracttransactionrequestinput) \| [`MessageTransactionRequestInput`](internal.md#messagetransactionrequestinput) - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:75](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L75) - -___ - -### TransactionRequestLike - -Ƭ **TransactionRequestLike**: { `type`: [`Script`](internal.md#script) } & [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) \| { `type`: [`Create`](../enums/internal-TransactionType.md#create) } & [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:577](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L577) - -___ - -### TransactionRequestOutput - -Ƭ **TransactionRequestOutput**: [`CoinTransactionRequestOutput`](internal.md#cointransactionrequestoutput) \| [`ContractTransactionRequestOutput`](internal.md#contracttransactionrequestoutput) \| [`MessageTransactionRequestOutput`](internal.md#messagetransactionrequestoutput) \| [`ChangeTransactionRequestOutput`](internal.md#changetransactionrequestoutput) \| [`VariableTransactionRequestOutput`](internal.md#variabletransactionrequestoutput) \| [`ContractCreatedTransactionRequestOutput`](internal.md#contractcreatedtransactionrequestoutput) - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L47) - -___ - -### TransactionRequestStorageSlot - -Ƭ **TransactionRequestStorageSlot**: { `key`: `BytesLike` ; `value`: `BytesLike` } \| [key: BytesLike, value: BytesLike] - -#### Defined in - -[packages/providers/src/transaction-request/storage-slot.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/storage-slot.ts#L5) - -___ - -### TransactionResult - -Ƭ **TransactionResult**<`TStatus`, `TTransactionType`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TStatus` | extends ``"success"`` \| ``"failure"`` | -| `TTransactionType` | `void` | - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockId` | `any` | - | -| `fee` | [`BN`](../classes/internal-BN.md) | - | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | - | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | Receipts produced during the execution of the transaction | -| `status` | `TStatus` extends ``"success"`` ? { `programState`: `any` ; `type`: ``"success"`` } : { `reason`: `any` ; `type`: ``"failure"`` } | - | -| `time` | `any` | - | -| `transaction` | [`Transaction`](internal.md#transaction)<`TTransactionType`\> | - | -| `transactionId` | `string` | - | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L54) - -___ - -### TransactionResultCallReceipt - -Ƭ **TransactionResultCallReceipt**: [`ReceiptCall`](internal.md#receiptcall) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L29) - -___ - -### TransactionResultLogDataReceipt - -Ƭ **TransactionResultLogDataReceipt**: [`ReceiptLogData`](internal.md#receiptlogdata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L35) - -___ - -### TransactionResultLogReceipt - -Ƭ **TransactionResultLogReceipt**: [`ReceiptLog`](internal.md#receiptlog) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L34) - -___ - -### TransactionResultMessageOutReceipt - -Ƭ **TransactionResultMessageOutReceipt**: [`ReceiptMessageOut`](internal.md#receiptmessageout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L39) - -___ - -### TransactionResultPanicReceipt - -Ƭ **TransactionResultPanicReceipt**: [`ReceiptPanic`](internal.md#receiptpanic) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L32) - -___ - -### TransactionResultReceipt - -Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](internal.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](internal.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](internal.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](internal.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](internal.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](internal.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](internal.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](internal.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](internal.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](internal.md#transactionresultscriptresultreceipt) \| [`TransactionResultMessageOutReceipt`](internal.md#transactionresultmessageoutreceipt) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L41) - -___ - -### TransactionResultReturnDataReceipt - -Ƭ **TransactionResultReturnDataReceipt**: [`ReceiptReturnData`](internal.md#receiptreturndata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L31) - -___ - -### TransactionResultReturnReceipt - -Ƭ **TransactionResultReturnReceipt**: [`ReceiptReturn`](internal.md#receiptreturn) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L30) - -___ - -### TransactionResultRevertReceipt - -Ƭ **TransactionResultRevertReceipt**: [`ReceiptRevert`](internal.md#receiptrevert) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L33) - -___ - -### TransactionResultScriptResultReceipt - -Ƭ **TransactionResultScriptResultReceipt**: [`ReceiptScriptResult`](internal.md#receiptscriptresult) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L38) - -___ - -### TransactionResultTransferOutReceipt - -Ƭ **TransactionResultTransferOutReceipt**: [`ReceiptTransferOut`](internal.md#receipttransferout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L37) - -___ - -### TransactionResultTransferReceipt - -Ƭ **TransactionResultTransferReceipt**: [`ReceiptTransfer`](internal.md#receipttransfer) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L36) - -___ - -### TransactionScript - -Ƭ **TransactionScript**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `receiptsRoot` | `string` | Merkle root of receipts (b256) | -| `script` | `string` | Script to execute (byte[]) | -| `scriptData` | `string` | Script input data (parameters) (byte[]) | -| `scriptDataLength` | `number` | Length of script input data, in bytes (u16) | -| `scriptLength` | `number` | Script length, in instructions (u16) | -| `type` | [`Script`](internal.md#script) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L25) - -___ - -### TxPointer - -Ƭ **TxPointer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockHeight` | `number` | Block height (u32) | -| `txIndex` | `number` | Transaction index (u16) | - -#### Defined in - -[packages/transactions/src/coders/tx-pointer.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/tx-pointer.ts#L3) - -___ - -### UtxoId - -Ƭ **UtxoId**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputIndex` | `number` | Output index (u8) | -| `transactionId` | `string` | Transaction ID (b256) | - -#### Defined in - -[packages/transactions/src/coders/utxo-id.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L3) - -___ - -### VariableTransactionRequestOutput - -Ƭ **VariableTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `type` | [`Variable`](internal.md#variable) | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L37) - -___ - -### Witness - -Ƭ **Witness**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `string` | Witness data (byte[]) | -| `dataLength` | `number` | Length of witness data, in bytes (u32) | - -#### Defined in - -[packages/transactions/src/coders/witness.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L6) diff --git a/docs/packages/fuel-ts-providers/classes/ChangeOutputCollisionError.md b/docs/packages/fuel-ts-providers/classes/ChangeOutputCollisionError.md deleted file mode 100644 index c47fcc48909..00000000000 --- a/docs/packages/fuel-ts-providers/classes/ChangeOutputCollisionError.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: default -title: ChangeOutputCollisionError -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: ChangeOutputCollisionError - -[@fuel-ts/providers](../index.md).ChangeOutputCollisionError - -## Hierarchy - -- `Error` - - ↳ **`ChangeOutputCollisionError`** - -## Constructors - -### constructor - -• **new ChangeOutputCollisionError**(`message?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message?` | `string` | - -#### Inherited from - -Error.constructor - -#### Defined in - -node_modules/.pnpm/typescript@4.9.3/node_modules/typescript/lib/lib.es5.d.ts:1059 - -## Properties - -### message - -• **message**: `string` = `'A ChangeOutput with the same "assetId" already exists for a different "to" address'` - -#### Overrides - -Error.message - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L96) - -___ - -### name - -• **name**: `string` = `'ChangeOutputCollisionError'` - -#### Overrides - -Error.name - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:95](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L95) diff --git a/docs/packages/fuel-ts-providers/classes/CreateTransactionRequest.md b/docs/packages/fuel-ts-providers/classes/CreateTransactionRequest.md deleted file mode 100644 index fff1eb7e86e..00000000000 --- a/docs/packages/fuel-ts-providers/classes/CreateTransactionRequest.md +++ /dev/null @@ -1,703 +0,0 @@ ---- -layout: default -title: CreateTransactionRequest -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: CreateTransactionRequest - -[@fuel-ts/providers](../index.md).CreateTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`CreateTransactionRequest`** - -## Constructors - -### constructor - -• **new CreateTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateTransactionRequestLike`](../interfaces/CreateTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:528](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L528) - -## Properties - -### bytecodeWitnessIndex - -• **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:522](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L522) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../index.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../index.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### salt - -• **salt**: `string` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:524](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L524) - -___ - -### storageSlots - -• **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:526](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L526) - -___ - -### type - -• **type**: [`Create`](../enums/TransactionType.md#create) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:520](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L520) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../index.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContractCreatedOutput - -▸ **addContractCreatedOutput**(`contractId`, `stateRoot`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:562](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L562) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../index.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../index.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../index.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../index.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../index.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../index.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../index.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../index.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../index.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../index.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractCreatedOutputs - -▸ **getContractCreatedOutputs**(): [`ContractCreatedTransactionRequestOutput`](../index.md#contractcreatedtransactionrequestoutput)[] - -#### Returns - -[`ContractCreatedTransactionRequestOutput`](../index.md#contractcreatedtransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:555](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L555) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../index.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../index.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:540](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L540) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`CreateTransactionRequest`](CreateTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`CreateTransactionRequestLike`](../interfaces/CreateTransactionRequestLike.md) | - -#### Returns - -[`CreateTransactionRequest`](CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:512](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L512) diff --git a/docs/packages/fuel-ts-providers/classes/NoWitnessAtIndexError.md b/docs/packages/fuel-ts-providers/classes/NoWitnessAtIndexError.md deleted file mode 100644 index 8a329774bc4..00000000000 --- a/docs/packages/fuel-ts-providers/classes/NoWitnessAtIndexError.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: NoWitnessAtIndexError -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: NoWitnessAtIndexError - -[@fuel-ts/providers](../index.md).NoWitnessAtIndexError - -## Hierarchy - -- `Error` - - ↳ **`NoWitnessAtIndexError`** - -## Constructors - -### constructor - -• **new NoWitnessAtIndexError**(`index`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | - -#### Overrides - -Error.constructor - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:101](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L101) - -## Properties - -### index - -• `Readonly` **index**: `number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:101](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L101) - -___ - -### name - -• **name**: `string` = `'NoWitnessAtIndexError'` - -#### Overrides - -Error.name - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L100) diff --git a/docs/packages/fuel-ts-providers/classes/NoWitnessByOwnerError.md b/docs/packages/fuel-ts-providers/classes/NoWitnessByOwnerError.md deleted file mode 100644 index 5ef77e90af9..00000000000 --- a/docs/packages/fuel-ts-providers/classes/NoWitnessByOwnerError.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: NoWitnessByOwnerError -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: NoWitnessByOwnerError - -[@fuel-ts/providers](../index.md).NoWitnessByOwnerError - -## Hierarchy - -- `Error` - - ↳ **`NoWitnessByOwnerError`** - -## Constructors - -### constructor - -• **new NoWitnessByOwnerError**(`owner`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Overrides - -Error.constructor - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:109](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L109) - -## Properties - -### name - -• **name**: `string` = `'NoWitnessByOwnerError'` - -#### Overrides - -Error.name - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:108](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L108) - -___ - -### owner - -• `Readonly` **owner**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:109](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L109) diff --git a/docs/packages/fuel-ts-providers/classes/Provider.md b/docs/packages/fuel-ts-providers/classes/Provider.md deleted file mode 100644 index 7934e2d4bd0..00000000000 --- a/docs/packages/fuel-ts-providers/classes/Provider.md +++ /dev/null @@ -1,634 +0,0 @@ ---- -layout: default -title: Provider -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: Provider - -[@fuel-ts/providers](../index.md).Provider - -A provider for connecting to a Fuel node - -## Constructors - -### constructor - -• **new Provider**(`url`, `options?`) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `url` | `string` | GraphQL endpoint of the Fuel node | -| `options` | [`ProviderOptions`](../index.md#provideroptions) | - | - -#### Defined in - -[packages/providers/src/provider.ts:213](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L213) - -## Properties - -### operations - -• **operations**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `dryRun` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `encodedTransaction`: `string` ; `utxoValidation?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`boolean`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlDryRunMutation`](../namespaces/internal.md#gqldryrunmutation)\> | -| `endSession` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `sessionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlEndSessionMutation`](../namespaces/internal.md#gqlendsessionmutation)\> | -| `execute` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `op`: `string` ; `sessionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlExecuteMutation`](../namespaces/internal.md#gqlexecutemutation)\> | -| `getBalance` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `assetId`: `string` ; `owner`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBalanceQuery`](../namespaces/internal.md#gqlgetbalancequery)\> | -| `getBalances` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `filter`: [`GqlBalanceFilterInput`](../namespaces/internal.md#gqlbalancefilterinput) ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBalancesQuery`](../namespaces/internal.md#gqlgetbalancesquery)\> | -| `getBlock` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `blockHeight?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `blockId?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBlockQuery`](../namespaces/internal.md#gqlgetblockquery)\> | -| `getBlockWithTransactions` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `blockHeight?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `blockId?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBlockWithTransactionsQuery`](../namespaces/internal.md#gqlgetblockwithtransactionsquery)\> | -| `getBlocks` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBlocksQuery`](../namespaces/internal.md#gqlgetblocksquery)\> | -| `getChain` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `[key: string]`: `never`; }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetChainQuery`](../namespaces/internal.md#gqlgetchainquery)\> | -| `getCoin` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `coinId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetCoinQuery`](../namespaces/internal.md#gqlgetcoinquery)\> | -| `getCoins` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `filter`: [`GqlCoinFilterInput`](../namespaces/internal.md#gqlcoinfilterinput) ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetCoinsQuery`](../namespaces/internal.md#gqlgetcoinsquery)\> | -| `getContract` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `contractId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetContractQuery`](../namespaces/internal.md#gqlgetcontractquery)\> | -| `getContractBalance` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `asset`: `string` ; `contract`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetContractBalanceQuery`](../namespaces/internal.md#gqlgetcontractbalancequery)\> | -| `getInfo` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `[key: string]`: `never`; }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetInfoQuery`](../namespaces/internal.md#gqlgetinfoquery)\> | -| `getMessageProof` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `messageId`: `any` ; `transactionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetMessageProofQuery`](../namespaces/internal.md#gqlgetmessageproofquery)\> | -| `getMessages` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `owner`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetMessagesQuery`](../namespaces/internal.md#gqlgetmessagesquery)\> | -| `getResourcesToSpend` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `excludedIds?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<[`GqlExcludeInput`](../namespaces/internal.md#gqlexcludeinput)\> ; `owner`: `string` ; `queryPerAsset`: [`GqlSpendQueryElementInput`](../namespaces/internal.md#gqlspendqueryelementinput) \| [`GqlSpendQueryElementInput`](../namespaces/internal.md#gqlspendqueryelementinput)[] }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetResourcesToSpendQuery`](../namespaces/internal.md#gqlgetresourcestospendquery)\> | -| `getTransaction` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `transactionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetTransactionQuery`](../namespaces/internal.md#gqlgettransactionquery)\> | -| `getTransactionWithReceipts` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `transactionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetTransactionWithReceiptsQuery`](../namespaces/internal.md#gqlgettransactionwithreceiptsquery)\> | -| `getTransactions` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetTransactionsQuery`](../namespaces/internal.md#gqlgettransactionsquery)\> | -| `getTransactionsByOwner` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `owner`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetTransactionsByOwnerQuery`](../namespaces/internal.md#gqlgettransactionsbyownerquery)\> | -| `getVersion` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `[key: string]`: `never`; }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetVersionQuery`](../namespaces/internal.md#gqlgetversionquery)\> | -| `reset` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `sessionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlResetMutation`](../namespaces/internal.md#gqlresetmutation)\> | -| `startSession` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `[key: string]`: `never`; }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlStartSessionMutation`](../namespaces/internal.md#gqlstartsessionmutation)\> | -| `submit` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `encodedTransaction`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlSubmitMutation`](../namespaces/internal.md#gqlsubmitmutation)\> | - -#### Defined in - -[packages/providers/src/provider.ts:211](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L211) - -___ - -### options - -• **options**: [`ProviderOptions`](../index.md#provideroptions) = `{}` - -#### Defined in - -[packages/providers/src/provider.ts:216](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L216) - -___ - -### url - -• **url**: `string` - -GraphQL endpoint of the Fuel node - -#### Defined in - -[packages/providers/src/provider.ts:215](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L215) - -## Methods - -### addMissingVariables - -▸ **addMissingVariables**(`transactionRequest`): `Promise`<`void`\> - -Will dryRun a transaction and check for missing VariableOutputs - -If there are missing VariableOutputs -`addVariableOutputs` is called on the transaction. -This process is done at most 10 times - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | [`TransactionRequest`](../index.md#transactionrequest) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/providers/src/provider.ts:344](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L344) - -___ - -### call - -▸ **call**(`transactionRequestLike`, `__namedParameters?`): `Promise`<[`CallResult`](../index.md#callresult)\> - -Executes a transaction without actually submitting it to the chain -If the transaction is missing VariableOuputs -the transaction will be mutate and VariableOuputs will be added - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../index.md#transactionrequestlike) | -| `__namedParameters` | [`ProviderCallParams`](../index.md#providercallparams) | - -#### Returns - -`Promise`<[`CallResult`](../index.md#callresult)\> - -#### Defined in - -[packages/providers/src/provider.ts:320](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L320) - -___ - -### connect - -▸ **connect**(`url`): `void` - -Connect provider to a different Fuel node url - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/provider.ts:233](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L233) - -___ - -### createOperations - -▸ `Private` **createOperations**(`url`, `options?`): `Object` - -Create GraphQL client and set operations - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `options` | [`ProviderOptions`](../index.md#provideroptions) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `dryRun` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `encodedTransaction`: `string` ; `utxoValidation?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`boolean`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlDryRunMutation`](../namespaces/internal.md#gqldryrunmutation)\> | -| `endSession` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `sessionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlEndSessionMutation`](../namespaces/internal.md#gqlendsessionmutation)\> | -| `execute` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `op`: `string` ; `sessionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlExecuteMutation`](../namespaces/internal.md#gqlexecutemutation)\> | -| `getBalance` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `assetId`: `string` ; `owner`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBalanceQuery`](../namespaces/internal.md#gqlgetbalancequery)\> | -| `getBalances` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `filter`: [`GqlBalanceFilterInput`](../namespaces/internal.md#gqlbalancefilterinput) ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBalancesQuery`](../namespaces/internal.md#gqlgetbalancesquery)\> | -| `getBlock` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `blockHeight?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `blockId?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBlockQuery`](../namespaces/internal.md#gqlgetblockquery)\> | -| `getBlockWithTransactions` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `blockHeight?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `blockId?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBlockWithTransactionsQuery`](../namespaces/internal.md#gqlgetblockwithtransactionsquery)\> | -| `getBlocks` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetBlocksQuery`](../namespaces/internal.md#gqlgetblocksquery)\> | -| `getChain` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `[key: string]`: `never`; }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetChainQuery`](../namespaces/internal.md#gqlgetchainquery)\> | -| `getCoin` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `coinId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetCoinQuery`](../namespaces/internal.md#gqlgetcoinquery)\> | -| `getCoins` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `filter`: [`GqlCoinFilterInput`](../namespaces/internal.md#gqlcoinfilterinput) ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetCoinsQuery`](../namespaces/internal.md#gqlgetcoinsquery)\> | -| `getContract` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `contractId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetContractQuery`](../namespaces/internal.md#gqlgetcontractquery)\> | -| `getContractBalance` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `asset`: `string` ; `contract`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetContractBalanceQuery`](../namespaces/internal.md#gqlgetcontractbalancequery)\> | -| `getInfo` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `[key: string]`: `never`; }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetInfoQuery`](../namespaces/internal.md#gqlgetinfoquery)\> | -| `getMessageProof` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `messageId`: `any` ; `transactionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetMessageProofQuery`](../namespaces/internal.md#gqlgetmessageproofquery)\> | -| `getMessages` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `owner`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetMessagesQuery`](../namespaces/internal.md#gqlgetmessagesquery)\> | -| `getResourcesToSpend` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `excludedIds?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<[`GqlExcludeInput`](../namespaces/internal.md#gqlexcludeinput)\> ; `owner`: `string` ; `queryPerAsset`: [`GqlSpendQueryElementInput`](../namespaces/internal.md#gqlspendqueryelementinput) \| [`GqlSpendQueryElementInput`](../namespaces/internal.md#gqlspendqueryelementinput)[] }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetResourcesToSpendQuery`](../namespaces/internal.md#gqlgetresourcestospendquery)\> | -| `getTransaction` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `transactionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetTransactionQuery`](../namespaces/internal.md#gqlgettransactionquery)\> | -| `getTransactionWithReceipts` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `transactionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetTransactionWithReceiptsQuery`](../namespaces/internal.md#gqlgettransactionwithreceiptsquery)\> | -| `getTransactions` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetTransactionsQuery`](../namespaces/internal.md#gqlgettransactionsquery)\> | -| `getTransactionsByOwner` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `after?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `before?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`string`\> ; `first?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `last?`: [`InputMaybe`](../namespaces/internal.md#inputmaybe)<`number`\> ; `owner`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetTransactionsByOwnerQuery`](../namespaces/internal.md#gqlgettransactionsbyownerquery)\> | -| `getVersion` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `[key: string]`: `never`; }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlGetVersionQuery`](../namespaces/internal.md#gqlgetversionquery)\> | -| `reset` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `sessionId`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlResetMutation`](../namespaces/internal.md#gqlresetmutation)\> | -| `startSession` | (`variables?`: [`Exact`](../namespaces/internal.md#exact)<{ `[key: string]`: `never`; }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlStartSessionMutation`](../namespaces/internal.md#gqlstartsessionmutation)\> | -| `submit` | (`variables`: [`Exact`](../namespaces/internal.md#exact)<{ `encodedTransaction`: `string` }\>, `requestHeaders?`: `HeadersInit`) => `Promise`<[`GqlSubmitMutation`](../namespaces/internal.md#gqlsubmitmutation)\> | - -#### Defined in - -[packages/providers/src/provider.ts:224](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L224) - -___ - -### getBalance - -▸ **getBalance**(`owner`, `assetId`): `Promise`<[`BN`](internal-BN.md)\> - -Returns the balance for the given owner for the given asset ID - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `owner` | [`AbstractAddress`](internal-AbstractAddress.md) | The address to get coins for | -| `assetId` | `BytesLike` | The asset ID of coins to get | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Defined in - -[packages/providers/src/provider.ts:633](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L633) - -___ - -### getBalances - -▸ **getBalances**(`owner`, `paginationArgs?`): `Promise`<[`CoinQuantity`](../index.md#coinquantity)[]\> - -Returns balances for the given owner - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `owner` | [`AbstractAddress`](internal-AbstractAddress.md) | The address to get coins for | -| `paginationArgs?` | [`CursorPaginationArgs`](../index.md#cursorpaginationargs) | Pagination arguments | - -#### Returns - -`Promise`<[`CoinQuantity`](../index.md#coinquantity)[]\> - -#### Defined in - -[packages/providers/src/provider.ts:649](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L649) - -___ - -### getBlock - -▸ **getBlock**(`idOrHeight`): `Promise`<``null`` \| [`Block`](../index.md#block)\> - -Returns block matching the given ID or type - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `idOrHeight` | `string` \| `number` | ID or height of the block | - -#### Returns - -`Promise`<``null`` \| [`Block`](../index.md#block)\> - -#### Defined in - -[packages/providers/src/provider.ts:525](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L525) - -___ - -### getBlockNumber - -▸ **getBlockNumber**(): `Promise`<[`BN`](internal-BN.md)\> - -Returns the current block number - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Defined in - -[packages/providers/src/provider.ts:260](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L260) - -___ - -### getBlockWithTransactions - -▸ **getBlockWithTransactions**(`idOrHeight`): `Promise`<``null`` \| [`Block`](../index.md#block) & { `transactions`: `Partial`<`Omit`<[`TransactionScript`](../namespaces/internal.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](../namespaces/internal.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/TransactionType.md) }[] }\> - -Returns block matching the given ID or type, including transaction data - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `idOrHeight` | `string` \| `number` | ID or height of the block | - -#### Returns - -`Promise`<``null`` \| [`Block`](../index.md#block) & { `transactions`: `Partial`<`Omit`<[`TransactionScript`](../namespaces/internal.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](../namespaces/internal.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/TransactionType.md) }[] }\> - -#### Defined in - -[packages/providers/src/provider.ts:555](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L555) - -___ - -### getChain - -▸ **getChain**(): `Promise`<[`ChainInfo`](../index.md#chaininfo)\> - -Returns chain information - -#### Returns - -`Promise`<[`ChainInfo`](../index.md#chaininfo)\> - -#### Defined in - -[packages/providers/src/provider.ts:276](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L276) - -___ - -### getCoins - -▸ **getCoins**(`owner`, `assetId?`, `paginationArgs?`): `Promise`<[`Coin`](../index.md#coin)[]\> - -Returns coins for the given owner - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `owner` | [`AbstractAddress`](internal-AbstractAddress.md) | The address to get coins for | -| `assetId?` | `BytesLike` | The asset ID of coins to get | -| `paginationArgs?` | [`CursorPaginationArgs`](../index.md#cursorpaginationargs) | Pagination arguments | - -#### Returns - -`Promise`<[`Coin`](../index.md#coin)[]\> - -#### Defined in - -[packages/providers/src/provider.ts:443](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L443) - -___ - -### getContract - -▸ **getContract**(`contractId`): `Promise`<``null`` \| [`ContractResult`](../index.md#contractresult)\> - -Get deployed contract with the given ID - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contractId` | `string` | - -#### Returns - -`Promise`<``null`` \| [`ContractResult`](../index.md#contractresult)\> - -contract bytecode and contract id - -#### Defined in - -[packages/providers/src/provider.ts:606](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L606) - -___ - -### getContractBalance - -▸ **getContractBalance**(`contractId`, `assetId`): `Promise`<[`BN`](internal-BN.md)\> - -Returns the balance for the given contract for the given asset ID - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | [`AbstractAddress`](internal-AbstractAddress.md) | The contract ID to get the balance for | -| `assetId` | `BytesLike` | The asset ID of coins to get | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Defined in - -[packages/providers/src/provider.ts:617](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L617) - -___ - -### getMessageProof - -▸ **getMessageProof**(`transactionId`, `messageId`): `Promise`<``null`` \| [`MessageProof`](../index.md#messageproof)\> - -Returns Message Proof for given transaction id and the message id from MessageOut receipt - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transactionId` | `string` | The transaction to get message from | -| `messageId` | `string` | The message id from MessageOut receipt | - -#### Returns - -`Promise`<``null`` \| [`MessageProof`](../index.md#messageproof)\> - -#### Defined in - -[packages/providers/src/provider.ts:700](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L700) - -___ - -### getMessages - -▸ **getMessages**(`address`, `paginationArgs?`): `Promise`<[`Message`](../index.md#message)[]\> - -Returns message for the given address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | The address to get message from | -| `paginationArgs?` | [`CursorPaginationArgs`](../index.md#cursorpaginationargs) | Pagination arguments | - -#### Returns - -`Promise`<[`Message`](../index.md#message)[]\> - -#### Defined in - -[packages/providers/src/provider.ts:672](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L672) - -___ - -### getNetwork - -▸ **getNetwork**(): `Promise`<`Network`\> - -Returns the network configuration of the connected Fuel node - -#### Returns - -`Promise`<`Network`\> - -#### Defined in - -[packages/providers/src/provider.ts:250](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L250) - -___ - -### getNodeInfo - -▸ **getNodeInfo**(): `Promise`<[`NodeInfo`](../index.md#nodeinfo)\> - -Returns node information - -#### Returns - -`Promise`<[`NodeInfo`](../index.md#nodeinfo)\> - -#### Defined in - -[packages/providers/src/provider.ts:268](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L268) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`owner`, `quantities`, `excludedIds?`): `Promise`<[`Resource`](../index.md#resource)[]\> - -Returns resources for the given owner satisfying the spend query - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `owner` | [`AbstractAddress`](internal-AbstractAddress.md) | The address to get coins for | -| `quantities` | [`CoinQuantityLike`](../index.md#coinquantitylike)[] | The quantities to get | -| `excludedIds?` | [`ExcludeResourcesOption`](../index.md#excluderesourcesoption) | IDs of excluded resources from the selection. | - -#### Returns - -`Promise`<[`Resource`](../index.md#resource)[]\> - -#### Defined in - -[packages/providers/src/provider.ts:473](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L473) - -___ - -### getTransaction - -▸ **getTransaction**<`TTransactionType`\>(`transactionId`): `Promise`<``null`` \| [`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\>\> - -Get transaction with the given ID - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionId` | `string` | - -#### Returns - -`Promise`<``null`` \| [`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/provider.ts:588](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L588) - -___ - -### getTransactionCost - -▸ **getTransactionCost**(`transactionRequestLike`, `tolerance?`): `Promise`<[`TransactionCost`](../index.md#transactioncost)\> - -Returns a transaction cost to enable user -to set gasLimit and also reserve balance amounts -on the the transaction. - -The tolerance is add on top of the gasUsed calculated -from the node, this create a safe margin costs like -change states on transfer that don't occur on the dryRun -transaction. The default value is 0.2 or 20% - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../index.md#transactionrequestlike) | `undefined` | -| `tolerance` | `number` | `0.2` | - -#### Returns - -`Promise`<[`TransactionCost`](../index.md#transactioncost)\> - -#### Defined in - -[packages/providers/src/provider.ts:409](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L409) - -___ - -### getVersion - -▸ **getVersion**(): `Promise`<`string`\> - -Returns the version of the connected Fuel node - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[packages/providers/src/provider.ts:240](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L240) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](TransactionResponse.md)\> - -Submits a transaction to the chain to be executed -If the transaction is missing VariableOuputs -the transaction will be mutate and VariableOuputs will be added - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../index.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](TransactionResponse.md)\> - -#### Defined in - -[packages/providers/src/provider.ts:286](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L286) - -___ - -### simulate - -▸ **simulate**(`transactionRequestLike`): `Promise`<[`CallResult`](../index.md#callresult)\> - -Executes a signed transaction without applying the states changes -on the chain. -If the transaction is missing VariableOuputs -the transaction will be mutate and VariableOuputs will be added - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../index.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../index.md#callresult)\> - -#### Defined in - -[packages/providers/src/provider.ts:385](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L385) diff --git a/docs/packages/fuel-ts-providers/classes/ScriptTransactionRequest.md b/docs/packages/fuel-ts-providers/classes/ScriptTransactionRequest.md deleted file mode 100644 index d4965d5832b..00000000000 --- a/docs/packages/fuel-ts-providers/classes/ScriptTransactionRequest.md +++ /dev/null @@ -1,797 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequest -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: ScriptTransactionRequest - -[@fuel-ts/providers](../index.md).ScriptTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`ScriptTransactionRequest`** - -## Constructors - -### constructor - -• **new ScriptTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ScriptTransactionRequestLike`](../interfaces/ScriptTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:406](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L406) - -## Properties - -### bytesOffset - -• **bytesOffset**: `undefined` \| `number` - -determined bytes offset for start of script data - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:404](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L404) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../index.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../index.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### script - -• **script**: `Uint8Array` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:400](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L400) - -___ - -### scriptData - -• **scriptData**: `Uint8Array` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:402](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L402) - -___ - -### type - -• **type**: [`Script`](../enums/TransactionType.md#script) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:398](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L398) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../index.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContract - -▸ **addContract**(`contract`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | [`ContractIdLike`](../namespaces/internal.md#contractidlike) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:481](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L481) - -___ - -### addMessageOutputs - -▸ **addMessageOutputs**(`numberOfMessages?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfMessages` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:466](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L466) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../index.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../index.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### addVariableOutputs - -▸ **addVariableOutputs**(`numberOfVariables?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfVariables` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:453](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L453) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../index.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../index.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../index.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../index.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../index.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../index.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../index.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../index.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractInputs - -▸ **getContractInputs**(): [`ContractTransactionRequestInput`](../index.md#contracttransactionrequestinput)[] - -#### Returns - -[`ContractTransactionRequestInput`](../index.md#contracttransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:426](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L426) - -___ - -### getContractOutputs - -▸ **getContractOutputs**(): [`ContractTransactionRequestOutput`](../index.md#contracttransactionrequestoutput)[] - -#### Returns - -[`ContractTransactionRequestOutput`](../index.md#contracttransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:432](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L432) - -___ - -### getVariableOutputs - -▸ **getVariableOutputs**(): [`VariableTransactionRequestOutput`](../index.md#variabletransactionrequestoutput)[] - -#### Returns - -[`VariableTransactionRequestOutput`](../index.md#variabletransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:438](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L438) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../index.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../index.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### setScript - -▸ **setScript**<`T`\>(`script`, `data`): `void` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `script` | [`AbstractScriptRequest`](internal-AbstractScriptRequest.md)<`T`\> | -| `data` | `T` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:444](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L444) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:412](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L412) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`ScriptTransactionRequest`](ScriptTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`ScriptTransactionRequestLike`](../interfaces/ScriptTransactionRequestLike.md) | - -#### Returns - -[`ScriptTransactionRequest`](ScriptTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:390](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L390) diff --git a/docs/packages/fuel-ts-providers/classes/TransactionResponse.md b/docs/packages/fuel-ts-providers/classes/TransactionResponse.md deleted file mode 100644 index 727bad66d9a..00000000000 --- a/docs/packages/fuel-ts-providers/classes/TransactionResponse.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -layout: default -title: TransactionResponse -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: TransactionResponse - -[@fuel-ts/providers](../index.md).TransactionResponse - -## Constructors - -### constructor - -• **new TransactionResponse**(`id`, `provider`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `provider` | [`Provider`](Provider.md) | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L102) - -## Properties - -### attempts - -• **attempts**: `number` = `0` - -Number off attempts to get the committed tx - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L100) - -___ - -### gasUsed - -• **gasUsed**: [`BN`](internal-BN.md) - -Gas used on the transaction - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L98) - -___ - -### id - -• **id**: `string` - -Transaction ID - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L94) - -___ - -### provider - -• **provider**: [`Provider`](Provider.md) - -Current provider - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L96) - -## Methods - -### decodeTransaction - -▸ **decodeTransaction**<`TTransactionType`\>(`transactionWithReceipts`): [`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionWithReceipts` | `Object` | -| `transactionWithReceipts.__typename` | ``"Transaction"`` | -| `transactionWithReceipts.gasPrice?` | ``null`` \| `string` | -| `transactionWithReceipts.id` | `string` | -| `transactionWithReceipts.rawPayload` | `string` | -| `transactionWithReceipts.receipts?` | ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] | -| `transactionWithReceipts.status?` | ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } | - -#### Returns - -[`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:114](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L114) - -___ - -### fetch - -▸ **fetch**(): `Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Returns - -`Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L107) - -___ - -### wait - -▸ **wait**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../index.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -Waits for transaction to succeed and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../index.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:188](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L188) - -___ - -### waitForResult - -▸ **waitForResult**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../index.md#transactionresult)<`any`, `TTransactionType`\>\> - -Waits for transaction to succeed or fail and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../index.md#transactionresult)<`any`, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:124](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L124) diff --git a/docs/packages/fuel-ts-providers/classes/internal-AbstractAccount.md b/docs/packages/fuel-ts-providers/classes/internal-AbstractAccount.md deleted file mode 100644 index dfb5d89d5f7..00000000000 --- a/docs/packages/fuel-ts-providers/classes/internal-AbstractAccount.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -layout: default -title: AbstractAccount -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: AbstractAccount - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).AbstractAccount - -## Constructors - -### constructor - -• **new AbstractAccount**() - -## Properties - -### address - -• `Abstract` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L26) - -___ - -### provider - -• `Abstract` **provider**: `unknown` - -#### Defined in - -[packages/interfaces/src/index.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L27) - -## Methods - -### getResourcesToSpend - -▸ `Abstract` **getResourcesToSpend**(`quantities`, `options?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | `any`[] | -| `options?` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L28) - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L29) - -___ - -### simulateTransaction - -▸ `Abstract` **simulateTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L30) diff --git a/docs/packages/fuel-ts-providers/classes/internal-AbstractAddress.md b/docs/packages/fuel-ts-providers/classes/internal-AbstractAddress.md deleted file mode 100644 index 6b3e932e3f4..00000000000 --- a/docs/packages/fuel-ts-providers/classes/internal-AbstractAddress.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: default -title: AbstractAddress -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: AbstractAddress - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).AbstractAddress - -## Constructors - -### constructor - -• **new AbstractAddress**() - -## Methods - -### equals - -▸ `Abstract` **equals**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/interfaces/src/index.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L21) - -___ - -### toAddress - -▸ `Abstract` **toAddress**(): \`fuel${string}\` - -#### Returns - -\`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L17) - -___ - -### toB256 - -▸ `Abstract` **toB256**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L18) - -___ - -### toBytes - -▸ `Abstract` **toBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L20) - -___ - -### toHexString - -▸ `Abstract` **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L19) - -___ - -### toJSON - -▸ `Abstract` **toJSON**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L15) - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L16) diff --git a/docs/packages/fuel-ts-providers/classes/internal-AbstractContract.md b/docs/packages/fuel-ts-providers/classes/internal-AbstractContract.md deleted file mode 100644 index 149dc5ebbc9..00000000000 --- a/docs/packages/fuel-ts-providers/classes/internal-AbstractContract.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: default -title: AbstractContract -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: AbstractContract - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).AbstractContract - -## Hierarchy - -- [`AbstractProgram`](internal-AbstractProgram.md) - - ↳ **`AbstractContract`** - -## Constructors - -### constructor - -• **new AbstractContract**() - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[constructor](internal-AbstractProgram.md#constructor) - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[account](internal-AbstractProgram.md#account) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### id - -• `Abstract` **id**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L48) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[interface](internal-AbstractProgram.md#interface) - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[provider](internal-AbstractProgram.md#provider) - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-providers/classes/internal-AbstractProgram.md b/docs/packages/fuel-ts-providers/classes/internal-AbstractProgram.md deleted file mode 100644 index 771f545e8e2..00000000000 --- a/docs/packages/fuel-ts-providers/classes/internal-AbstractProgram.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: AbstractProgram -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: AbstractProgram - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).AbstractProgram - -## Hierarchy - -- **`AbstractProgram`** - - ↳ [`AbstractContract`](internal-AbstractContract.md) - -## Constructors - -### constructor - -• **new AbstractProgram**() - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-providers/classes/internal-AbstractScriptRequest.md b/docs/packages/fuel-ts-providers/classes/internal-AbstractScriptRequest.md deleted file mode 100644 index a5434296973..00000000000 --- a/docs/packages/fuel-ts-providers/classes/internal-AbstractScriptRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default -title: AbstractScriptRequest -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: AbstractScriptRequest - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).AbstractScriptRequest - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Constructors - -### constructor - -• **new AbstractScriptRequest**<`T`\>() - -#### Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### bytes - -• `Abstract` **bytes**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L9) - -___ - -### encodeScriptData - -• `Abstract` **encodeScriptData**: (`data`: `T`) => `Uint8Array` - -#### Type declaration - -▸ (`data`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L10) diff --git a/docs/packages/fuel-ts-providers/classes/internal-BN.md b/docs/packages/fuel-ts-providers/classes/internal-BN.md deleted file mode 100644 index 89ab055f63e..00000000000 --- a/docs/packages/fuel-ts-providers/classes/internal-BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../namespaces/internal.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](internal-BN.md) | -| `mod` | [`BN`](internal-BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](internal-BN.md) | -| `b` | [`BN`](internal-BN.md) | -| `gcd` | [`BN`](internal-BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../namespaces/internal.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](internal-BN.md) | -| `out` | [`BN`](internal-BN.md) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-providers/classes/internal-BaseTransactionRequest.md b/docs/packages/fuel-ts-providers/classes/internal-BaseTransactionRequest.md deleted file mode 100644 index 2eb892de8c5..00000000000 --- a/docs/packages/fuel-ts-providers/classes/internal-BaseTransactionRequest.md +++ /dev/null @@ -1,526 +0,0 @@ ---- -layout: default -title: BaseTransactionRequest -parent: "@fuel-ts/providers" -nav_order: 1 - ---- - -# Class: BaseTransactionRequest - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequest - -## Hierarchy - -- **`BaseTransactionRequest`** - - ↳ [`ScriptTransactionRequest`](ScriptTransactionRequest.md) - - ↳ [`CreateTransactionRequest`](CreateTransactionRequest.md) - -## Implements - -- [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) - -## Constructors - -### constructor - -• **new BaseTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) | - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L131) - -## Properties - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasLimit](../interfaces/internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasPrice](../interfaces/internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../index.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[inputs](../interfaces/internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[maturity](../interfaces/internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../index.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[outputs](../interfaces/internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### type - -• `Abstract` **type**: [`TransactionType`](../enums/TransactionType.md) - -Type of the transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:117](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L117) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[witnesses](../interfaces/internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../index.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../index.md#resource) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../index.md#resource)[] | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../index.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../index.md#coinquantity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../index.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../index.md#changetransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../index.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../index.md#cointransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../index.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../index.md#cointransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../index.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../index.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ `Abstract` **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:167](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L167) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) diff --git a/docs/packages/fuel-ts-providers/enums/CoinStatus.md b/docs/packages/fuel-ts-providers/enums/CoinStatus.md deleted file mode 100644 index b9854a4eb5e..00000000000 --- a/docs/packages/fuel-ts-providers/enums/CoinStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: CoinStatus -parent: "@fuel-ts/providers" -nav_order: 4 - ---- - -# Enumeration: CoinStatus - -[@fuel-ts/providers](../index.md).CoinStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:157 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:158 diff --git a/docs/packages/fuel-ts-providers/enums/MessageStatus.md b/docs/packages/fuel-ts-providers/enums/MessageStatus.md deleted file mode 100644 index 2123359f371..00000000000 --- a/docs/packages/fuel-ts-providers/enums/MessageStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: MessageStatus -parent: "@fuel-ts/providers" -nav_order: 4 - ---- - -# Enumeration: MessageStatus - -[@fuel-ts/providers](../index.md).MessageStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:373 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:374 diff --git a/docs/packages/fuel-ts-providers/enums/TransactionType.md b/docs/packages/fuel-ts-providers/enums/TransactionType.md deleted file mode 100644 index 9316c341eed..00000000000 --- a/docs/packages/fuel-ts-providers/enums/TransactionType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: TransactionType -parent: "@fuel-ts/providers" -nav_order: 4 - ---- - -# Enumeration: TransactionType - -[@fuel-ts/providers](../index.md).TransactionType - -## Enumeration Members - -### Create - -• **Create** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Mint - -• **Mint** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L22) - -___ - -### Script - -• **Script** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) diff --git a/docs/packages/fuel-ts-providers/enums/internal-GqlReturnType.md b/docs/packages/fuel-ts-providers/enums/internal-GqlReturnType.md deleted file mode 100644 index 23a3358564d..00000000000 --- a/docs/packages/fuel-ts-providers/enums/internal-GqlReturnType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: GqlReturnType -parent: "@fuel-ts/providers" -nav_order: 4 - ---- - -# Enumeration: GqlReturnType - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).GqlReturnType - -## Enumeration Members - -### Return - -• **Return** = ``"RETURN"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:688 - -___ - -### ReturnData - -• **ReturnData** = ``"RETURN_DATA"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:689 - -___ - -### Revert - -• **Revert** = ``"REVERT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:690 diff --git a/docs/packages/fuel-ts-providers/index.md b/docs/packages/fuel-ts-providers/index.md deleted file mode 100644 index a63d2ad7060..00000000000 --- a/docs/packages/fuel-ts-providers/index.md +++ /dev/null @@ -1,1191 +0,0 @@ ---- -layout: default -title: "@fuel-ts/providers" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/providers - -## Namespaces - -- [internal](namespaces/internal.md) - -## Enumerations - -- [CoinStatus](enums/CoinStatus.md) -- [MessageStatus](enums/MessageStatus.md) -- [TransactionType](enums/TransactionType.md) - -## Classes - -- [ChangeOutputCollisionError](classes/ChangeOutputCollisionError.md) -- [CreateTransactionRequest](classes/CreateTransactionRequest.md) -- [NoWitnessAtIndexError](classes/NoWitnessAtIndexError.md) -- [NoWitnessByOwnerError](classes/NoWitnessByOwnerError.md) -- [Provider](classes/Provider.md) -- [ScriptTransactionRequest](classes/ScriptTransactionRequest.md) -- [TransactionResponse](classes/TransactionResponse.md) - -## Interfaces - -- [CreateTransactionRequestLike](interfaces/CreateTransactionRequestLike.md) -- [ScriptTransactionRequestLike](interfaces/ScriptTransactionRequestLike.md) - -## Type Aliases - -### Block - -Ƭ **Block**: `Object` - -A Fuel block - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `height` | [`BN`](classes/internal-BN.md) | -| `id` | `string` | -| `time` | `string` | -| `transactionIds` | `string`[] | - -#### Defined in - -[packages/providers/src/provider.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L49) - -___ - -### BuildPredicateOptions - -Ƭ **BuildPredicateOptions**: { `fundTransaction?`: `boolean` } & `Pick`<[`TransactionRequestLike`](index.md#transactionrequestlike), ``"gasLimit"`` \| ``"gasPrice"`` \| ``"maturity"``\> - -#### Defined in - -[packages/providers/src/provider.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L184) - -___ - -### CallResult - -Ƭ **CallResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](index.md#transactionresultreceipt)[] | - -#### Defined in - -[packages/providers/src/provider.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L42) - -___ - -### ChainInfo - -Ƭ **ChainInfo**: `Object` - -Chain information - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `baseChainHeight` | [`BN`](classes/internal-BN.md) | -| `consensusParameters` | { `contractMaxSize`: [`BN`](classes/internal-BN.md) ; `gasPerByte`: [`BN`](classes/internal-BN.md) ; `gasPriceFactor`: [`BN`](classes/internal-BN.md) ; `maxGasPerTx`: [`BN`](classes/internal-BN.md) ; `maxInputs`: [`BN`](classes/internal-BN.md) ; `maxMessageDataLength`: [`BN`](classes/internal-BN.md) ; `maxOutputs`: [`BN`](classes/internal-BN.md) ; `maxPredicateDataLength`: [`BN`](classes/internal-BN.md) ; `maxPredicateLength`: [`BN`](classes/internal-BN.md) ; `maxScriptDataLength`: [`BN`](classes/internal-BN.md) ; `maxScriptLength`: [`BN`](classes/internal-BN.md) ; `maxStorageSlots`: [`BN`](classes/internal-BN.md) ; `maxWitnesses`: [`BN`](classes/internal-BN.md) } | -| `consensusParameters.contractMaxSize` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.gasPerByte` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.gasPriceFactor` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxGasPerTx` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxInputs` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxMessageDataLength` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxOutputs` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxPredicateDataLength` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxPredicateLength` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxScriptDataLength` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxScriptLength` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxStorageSlots` | [`BN`](classes/internal-BN.md) | -| `consensusParameters.maxWitnesses` | [`BN`](classes/internal-BN.md) | -| `latestBlock` | { `height`: [`BN`](classes/internal-BN.md) ; `id`: `string` ; `time`: `string` ; `transactions`: { `id`: `string` }[] } | -| `latestBlock.height` | [`BN`](classes/internal-BN.md) | -| `latestBlock.id` | `string` | -| `latestBlock.time` | `string` | -| `latestBlock.transactions` | { `id`: `string` }[] | -| `name` | `string` | -| `peerCount` | `number` | - -#### Defined in - -[packages/providers/src/provider.ts:67](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L67) - -___ - -### ChangeTransactionRequestOutput - -Ƭ **ChangeTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Change`](namespaces/internal.md#change) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L30) - -___ - -### Coin - -Ƭ **Coin**: `Object` - -A Fuel coin - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | -| `assetId` | `string` | -| `blockCreated` | [`BN`](classes/internal-BN.md) | -| `id` | `string` | -| `maturity` | `number` | -| `owner` | [`AbstractAddress`](classes/internal-AbstractAddress.md) | -| `status` | [`CoinStatus`](enums/CoinStatus.md) | - -#### Defined in - -[packages/providers/src/coin.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin.ts#L9) - -___ - -### CoinQuantity - -Ƭ **CoinQuantity**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | -| `assetId` | `string` | -| `max?` | [`BN`](classes/internal-BN.md) | - -#### Defined in - -[packages/providers/src/coin-quantity.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L10) - -___ - -### CoinQuantityLike - -Ƭ **CoinQuantityLike**: [amount: BigNumberish, assetId?: BytesLike, max?: BigNumberish] \| { `amount`: [`BigNumberish`](namespaces/internal.md#bignumberish) ; `assetId?`: `BytesLike` ; `max?`: [`BigNumberish`](namespaces/internal.md#bignumberish) } - -#### Defined in - -[packages/providers/src/coin-quantity.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L7) - -___ - -### CoinTransactionRequestInput - -Ƭ **CoinTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](namespaces/internal.md#bignumberish) | Amount of coins | -| `assetId` | `BytesLike` | Asset ID of the coins | -| `id` | `BytesLike` | UTXO ID | -| `maturity?` | `number` | UTXO being spent must have been created at least this many blocks ago | -| `owner` | `BytesLike` | Owning address or script hash | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](namespaces/internal.md#coin) | - | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L9) - -___ - -### CoinTransactionRequestOutput - -Ƭ **CoinTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](namespaces/internal.md#bignumberish) | Amount of coins to send | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Coin`](namespaces/internal.md#coin-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L9) - -___ - -### ContractCreatedTransactionRequestOutput - -Ƭ **ContractCreatedTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | -| `type` | [`ContractCreated`](namespaces/internal.md#contractcreated) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L40) - -___ - -### ContractResult - -Ƭ **ContractResult**: `Object` - -Deployed Contract bytecode and contract id - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `bytecode` | `string` | -| `id` | `string` | - -#### Defined in - -[packages/providers/src/provider.ts:59](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L59) - -___ - -### ContractTransactionRequestInput - -Ƭ **ContractTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](namespaces/internal.md#contract) | - | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L66) - -___ - -### ContractTransactionRequestOutput - -Ƭ **ContractTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `inputIndex` | `number` | Index of input contract | -| `type` | [`Contract`](namespaces/internal.md#contract-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L18) - -___ - -### CursorPaginationArgs - -Ƭ **CursorPaginationArgs**: `Object` - -Cursor pagination arguments - -https://relay.dev/graphql/connections.htm#sec-Arguments - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `after?` | `string` \| ``null`` | Forward pagination cursor | -| `before?` | `string` \| ``null`` | Backward pagination cursor | -| `first?` | `number` \| ``null`` | Forward pagination limit | -| `last?` | `number` \| ``null`` | Backward pagination limit | - -#### Defined in - -[packages/providers/src/provider.ts:173](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L173) - -___ - -### ExcludeResourcesOption - -Ƭ **ExcludeResourcesOption**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `messages?` | `BytesLike`[] | -| `utxos?` | `BytesLike`[] | - -#### Defined in - -[packages/providers/src/resource.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L36) - -___ - -### FetchRequestOptions - -Ƭ **FetchRequestOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `body` | `string` | -| `headers` | { `[key: string]`: `string`; } | -| `method` | ``"POST"`` | - -#### Defined in - -[packages/providers/src/provider.ts:188](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L188) - -___ - -### Message - -Ƭ **Message**: `Object` - -A Fuel message - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | -| `daHeight` | [`BN`](classes/internal-BN.md) | -| `data` | `BytesLike` | -| `nonce` | [`BN`](classes/internal-BN.md) | -| `recipient` | [`AbstractAddress`](classes/internal-AbstractAddress.md) | -| `sender` | [`AbstractAddress`](classes/internal-AbstractAddress.md) | -| `status` | [`MessageStatus`](enums/MessageStatus.md) | - -#### Defined in - -[packages/providers/src/message.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/message.ts#L11) - -___ - -### MessageProof - -Ƭ **MessageProof**: `Object` - -Message Proof - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | -| `data` | `string` | -| `header` | { `applicationHash`: `string` ; `daHeight`: [`BN`](classes/internal-BN.md) ; `height`: [`BN`](classes/internal-BN.md) ; `id`: `string` ; `outputMessagesCount`: [`BN`](classes/internal-BN.md) ; `outputMessagesRoot`: `string` ; `prevRoot`: `string` ; `time`: `string` ; `transactionsCount`: [`BN`](classes/internal-BN.md) ; `transactionsRoot`: `string` } | -| `header.applicationHash` | `string` | -| `header.daHeight` | [`BN`](classes/internal-BN.md) | -| `header.height` | [`BN`](classes/internal-BN.md) | -| `header.id` | `string` | -| `header.outputMessagesCount` | [`BN`](classes/internal-BN.md) | -| `header.outputMessagesRoot` | `string` | -| `header.prevRoot` | `string` | -| `header.time` | `string` | -| `header.transactionsCount` | [`BN`](classes/internal-BN.md) | -| `header.transactionsRoot` | `string` | -| `nonce` | `string` | -| `proofIndex` | [`BN`](classes/internal-BN.md) | -| `proofSet` | `string`[] | -| `recipient` | [`AbstractAddress`](classes/internal-AbstractAddress.md) | -| `sender` | [`AbstractAddress`](classes/internal-AbstractAddress.md) | -| `signature` | `string` | - -#### Defined in - -[packages/providers/src/message.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/message.ts#L25) - -___ - -### MessageTransactionRequestInput - -Ƭ **MessageTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](namespaces/internal.md#bignumberish) | Amount of coins | -| `data` | `BytesLike` | data of message | -| `nonce` | [`BigNumberish`](namespaces/internal.md#bignumberish) | Unique nonce of message | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `recipient` | `BytesLike` | Address of sender | -| `sender` | `BytesLike` | Address of sender | -| `type` | [`Message`](namespaces/internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes the message | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L39) - -___ - -### MessageTransactionRequestOutput - -Ƭ **MessageTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](namespaces/internal.md#bignumberish) | Amount of coins sent with message | -| `recipient` | `BytesLike` | Receiving address | -| `type` | [`Message`](namespaces/internal.md#message-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L23) - -___ - -### NodeInfo - -Ƭ **NodeInfo**: `Object` - -Node information - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minGasPrice` | [`BN`](classes/internal-BN.md) | -| `nodeVersion` | `string` | - -#### Defined in - -[packages/providers/src/provider.ts:97](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L97) - -___ - -### ProviderCallParams - -Ƭ **ProviderCallParams**: `Object` - -Provider Call transaction params - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `utxoValidation?` | `boolean` | - -#### Defined in - -[packages/providers/src/provider.ts:204](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L204) - -___ - -### ProviderOptions - -Ƭ **ProviderOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `fetch?` | (`url`: `string`, `options`: [`FetchRequestOptions`](index.md#fetchrequestoptions)) => `Promise`<`any`\> | - -#### Defined in - -[packages/providers/src/provider.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L197) - -___ - -### RawCoin - -Ƭ **RawCoin**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | `string` | -| `assetId` | `string` | -| `blockCreated` | `string` | -| `coinStatus` | [`CoinStatus`](enums/CoinStatus.md) | -| `maturity` | `string` | -| `owner` | `string` | -| `utxoId` | `string` | - -#### Defined in - -[packages/providers/src/resource.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L11) - -___ - -### RawMessage - -Ƭ **RawMessage**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | `string` | -| `daHeight` | `string` | -| `data` | `string` | -| `messageStatus` | [`MessageStatus`](enums/MessageStatus.md) | -| `nonce` | `string` | -| `recipient` | `string` | -| `sender` | `string` | - -#### Defined in - -[packages/providers/src/resource.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L21) - -___ - -### RawResource - -Ƭ **RawResource**: [`RawCoin`](index.md#rawcoin) \| [`RawMessage`](index.md#rawmessage) - -#### Defined in - -[packages/providers/src/resource.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L31) - -___ - -### Resource - -Ƭ **Resource**: [`Coin`](index.md#coin) \| [`Message`](index.md#message) - -#### Defined in - -[packages/providers/src/resource.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L32) - -___ - -### Resources - -Ƭ **Resources**: [`GqlGetResourcesToSpendQuery`](namespaces/internal.md#gqlgetresourcestospendquery)[``"resourcesToSpend"``] - -#### Defined in - -[packages/providers/src/resource.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L34) - -___ - -### TransactionCost - -Ƭ **TransactionCost**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `fee` | [`BN`](classes/internal-BN.md) | -| `gasPrice` | [`BN`](classes/internal-BN.md) | -| `gasUsed` | [`BN`](classes/internal-BN.md) | -| `minGasPrice` | [`BN`](classes/internal-BN.md) | - -#### Defined in - -[packages/providers/src/provider.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L102) - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: [`ScriptTransactionRequest`](classes/ScriptTransactionRequest.md) \| [`CreateTransactionRequest`](classes/CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:576](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L576) - -___ - -### TransactionRequestInput - -Ƭ **TransactionRequestInput**: [`CoinTransactionRequestInput`](index.md#cointransactionrequestinput) \| [`ContractTransactionRequestInput`](index.md#contracttransactionrequestinput) \| [`MessageTransactionRequestInput`](index.md#messagetransactionrequestinput) - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:75](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L75) - -___ - -### TransactionRequestLike - -Ƭ **TransactionRequestLike**: { `type`: [`Script`](enums/TransactionType.md#script) } & [`ScriptTransactionRequestLike`](interfaces/ScriptTransactionRequestLike.md) \| { `type`: [`Create`](enums/TransactionType.md#create) } & [`CreateTransactionRequestLike`](interfaces/CreateTransactionRequestLike.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:577](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L577) - -___ - -### TransactionRequestOutput - -Ƭ **TransactionRequestOutput**: [`CoinTransactionRequestOutput`](index.md#cointransactionrequestoutput) \| [`ContractTransactionRequestOutput`](index.md#contracttransactionrequestoutput) \| [`MessageTransactionRequestOutput`](index.md#messagetransactionrequestoutput) \| [`ChangeTransactionRequestOutput`](index.md#changetransactionrequestoutput) \| [`VariableTransactionRequestOutput`](index.md#variabletransactionrequestoutput) \| [`ContractCreatedTransactionRequestOutput`](index.md#contractcreatedtransactionrequestoutput) - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L47) - -___ - -### TransactionResult - -Ƭ **TransactionResult**<`TStatus`, `TTransactionType`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TStatus` | extends ``"success"`` \| ``"failure"`` | -| `TTransactionType` | `void` | - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockId` | `any` | - | -| `fee` | [`BN`](classes/internal-BN.md) | - | -| `gasUsed` | [`BN`](classes/internal-BN.md) | - | -| `receipts` | [`TransactionResultReceipt`](index.md#transactionresultreceipt)[] | Receipts produced during the execution of the transaction | -| `status` | `TStatus` extends ``"success"`` ? { `programState`: `any` ; `type`: ``"success"`` } : { `reason`: `any` ; `type`: ``"failure"`` } | - | -| `time` | `any` | - | -| `transaction` | [`Transaction`](namespaces/internal.md#transaction)<`TTransactionType`\> | - | -| `transactionId` | `string` | - | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L54) - -___ - -### TransactionResultCallReceipt - -Ƭ **TransactionResultCallReceipt**: [`ReceiptCall`](namespaces/internal.md#receiptcall) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L29) - -___ - -### TransactionResultLogDataReceipt - -Ƭ **TransactionResultLogDataReceipt**: [`ReceiptLogData`](namespaces/internal.md#receiptlogdata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L35) - -___ - -### TransactionResultLogReceipt - -Ƭ **TransactionResultLogReceipt**: [`ReceiptLog`](namespaces/internal.md#receiptlog) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L34) - -___ - -### TransactionResultMessageOutReceipt - -Ƭ **TransactionResultMessageOutReceipt**: [`ReceiptMessageOut`](namespaces/internal.md#receiptmessageout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L39) - -___ - -### TransactionResultPanicReceipt - -Ƭ **TransactionResultPanicReceipt**: [`ReceiptPanic`](namespaces/internal.md#receiptpanic) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L32) - -___ - -### TransactionResultReceipt - -Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](index.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](index.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](index.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](index.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](index.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](index.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](index.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](index.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](index.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](index.md#transactionresultscriptresultreceipt) \| [`TransactionResultMessageOutReceipt`](index.md#transactionresultmessageoutreceipt) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L41) - -___ - -### TransactionResultReturnDataReceipt - -Ƭ **TransactionResultReturnDataReceipt**: [`ReceiptReturnData`](namespaces/internal.md#receiptreturndata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L31) - -___ - -### TransactionResultReturnReceipt - -Ƭ **TransactionResultReturnReceipt**: [`ReceiptReturn`](namespaces/internal.md#receiptreturn) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L30) - -___ - -### TransactionResultRevertReceipt - -Ƭ **TransactionResultRevertReceipt**: [`ReceiptRevert`](namespaces/internal.md#receiptrevert) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L33) - -___ - -### TransactionResultScriptResultReceipt - -Ƭ **TransactionResultScriptResultReceipt**: [`ReceiptScriptResult`](namespaces/internal.md#receiptscriptresult) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L38) - -___ - -### TransactionResultTransferOutReceipt - -Ƭ **TransactionResultTransferOutReceipt**: [`ReceiptTransferOut`](namespaces/internal.md#receipttransferout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L37) - -___ - -### TransactionResultTransferReceipt - -Ƭ **TransactionResultTransferReceipt**: [`ReceiptTransfer`](namespaces/internal.md#receipttransfer) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L36) - -___ - -### VariableTransactionRequestOutput - -Ƭ **VariableTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `type` | [`Variable`](namespaces/internal.md#variable) | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L37) - -## Variables - -### returnZeroScript - -• `Const` **returnZeroScript**: [`AbstractScriptRequest`](classes/internal-AbstractScriptRequest.md)<`void`\> - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:53](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L53) - -___ - -### withdrawScript - -• `Const` **withdrawScript**: [`AbstractScriptRequest`](classes/internal-AbstractScriptRequest.md)<`void`\> - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L63) - -## Functions - -### buildBlockExplorerUrl - -▸ **buildBlockExplorerUrl**(`options?`): `string` - -Builds a block explorer url based on and the given path, block explorer URL and provider URL - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Object` | -| `options.address?` | `string` | -| `options.blockExplorerUrl?` | `string` | -| `options.blockNumber?` | `number` | -| `options.path?` | `string` | -| `options.providerUrl?` | `string` | -| `options.txId?` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/providers/src/utils/block-explorer.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/utils/block-explorer.ts#L21) - -___ - -### calculatePriceWithFactor - -▸ **calculatePriceWithFactor**(`gasUsed`, `gasPrice`, `priceFactor`): [`BN`](classes/internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `gasUsed` | [`BN`](classes/internal-BN.md) | -| `gasPrice` | [`BN`](classes/internal-BN.md) | -| `priceFactor` | [`BN`](classes/internal-BN.md) | - -#### Returns - -[`BN`](classes/internal-BN.md) - -#### Defined in - -[packages/providers/src/utils/fee.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/utils/fee.ts#L7) - -___ - -### calculateTransactionFee - -▸ **calculateTransactionFee**(`__namedParameters`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `Object` | -| `__namedParameters.gasPrice` | [`BN`](classes/internal-BN.md) | -| `__namedParameters.margin?` | `number` | -| `__namedParameters.receipts` | [`TransactionResultReceipt`](index.md#transactionresultreceipt)[] | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `fee` | [`BN`](classes/internal-BN.md) | -| `gasUsed` | [`BN`](classes/internal-BN.md) | - -#### Defined in - -[packages/providers/src/utils/fee.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/utils/fee.ts#L20) - -___ - -### coinQuantityfy - -▸ **coinQuantityfy**(`coinQuantityLike`): [`CoinQuantity`](index.md#coinquantity) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `coinQuantityLike` | [`CoinQuantityLike`](index.md#coinquantitylike) | - -#### Returns - -[`CoinQuantity`](index.md#coinquantity) - -#### Defined in - -[packages/providers/src/coin-quantity.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L12) - -___ - -### getDecodedLogs - -▸ **getDecodedLogs**<`T`\>(`receipts`, `abiInterface`): `T`[] - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](index.md#transactionresultreceipt)[] | -| `abiInterface` | `default` | - -#### Returns - -`T`[] - -#### Defined in - -[packages/providers/src/transaction-response/getDecodedLogs.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/getDecodedLogs.ts#L7) - -___ - -### getGasUsedFromReceipts - -▸ **getGasUsedFromReceipts**(`receipts`): [`BN`](classes/internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](index.md#transactionresultreceipt)[] | - -#### Returns - -[`BN`](classes/internal-BN.md) - -#### Defined in - -[packages/providers/src/utils/fee.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/utils/fee.ts#L10) - -___ - -### getReceiptsWithMissingData - -▸ **getReceiptsWithMissingData**(`receipts`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](index.md#transactionresultreceipt)[] | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `missingOutputContractIds` | [`ReceiptPanic`](namespaces/internal.md#receiptpanic)[] | -| `missingOutputVariables` | [`ReceiptRevert`](namespaces/internal.md#receiptrevert)[] | - -#### Defined in - -[packages/providers/src/utils/receipts.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/utils/receipts.ts#L18) - -___ - -### inputify - -▸ **inputify**(`value`): [`Input`](namespaces/internal.md#input) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`TransactionRequestInput`](index.md#transactionrequestinput) | - -#### Returns - -[`Input`](namespaces/internal.md#input) - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:80](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L80) - -___ - -### isCoin - -▸ **isCoin**(`resource`): resource is Coin - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](index.md#resource) | - -#### Returns - -resource is Coin - -#### Defined in - -[packages/providers/src/resource.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L45) - -___ - -### isMessage - -▸ **isMessage**(`resource`): resource is Message - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](index.md#resource) | - -#### Returns - -resource is Message - -#### Defined in - -[packages/providers/src/resource.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L46) - -___ - -### isRawCoin - -▸ **isRawCoin**(`resource`): resource is RawCoin - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`RawResource`](index.md#rawresource) | - -#### Returns - -resource is RawCoin - -#### Defined in - -[packages/providers/src/resource.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L41) - -___ - -### isRawMessage - -▸ **isRawMessage**(`resource`): resource is RawMessage - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`RawResource`](index.md#rawresource) | - -#### Returns - -resource is RawMessage - -#### Defined in - -[packages/providers/src/resource.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L42) - -___ - -### normalizeJSON - -▸ **normalizeJSON**(`root`): `any` - -Stringify Transaction to a JSON object -compatible with the Transaction class constructor. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `root` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/providers/src/utils/json.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/utils/json.ts#L39) - -___ - -### outputify - -▸ **outputify**(`value`): [`Output`](namespaces/internal.md#output) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`TransactionRequestOutput`](index.md#transactionrequestoutput) | - -#### Returns - -[`Output`](namespaces/internal.md#output) - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L55) - -___ - -### sleep - -▸ **sleep**(`time`): `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `time` | `number` | - -#### Returns - -`Promise`<`unknown`\> - -#### Defined in - -[packages/providers/src/utils/sleep.ts:1](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/utils/sleep.ts#L1) - -___ - -### transactionRequestify - -▸ **transactionRequestify**(`obj`): [`TransactionRequest`](index.md#transactionrequest) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`TransactionRequestLike`](index.md#transactionrequestlike) | - -#### Returns - -[`TransactionRequest`](index.md#transactionrequest) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:581](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L581) diff --git a/docs/packages/fuel-ts-providers/interfaces/CreateTransactionRequestLike.md b/docs/packages/fuel-ts-providers/interfaces/CreateTransactionRequestLike.md deleted file mode 100644 index 3902c7d6558..00000000000 --- a/docs/packages/fuel-ts-providers/interfaces/CreateTransactionRequestLike.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -layout: default -title: CreateTransactionRequestLike -parent: "@fuel-ts/providers" -nav_order: 2 - ---- - -# Interface: CreateTransactionRequestLike - -[@fuel-ts/providers](../index.md).CreateTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`CreateTransactionRequestLike`** - -## Properties - -### bytecodeWitnessIndex - -• `Optional` **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:504](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L504) - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../index.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../index.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### salt - -• `Optional` **salt**: `BytesLike` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:506](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L506) - -___ - -### storageSlots - -• `Optional` **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:508](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L508) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-providers/interfaces/ScriptTransactionRequestLike.md b/docs/packages/fuel-ts-providers/interfaces/ScriptTransactionRequestLike.md deleted file mode 100644 index c35fa6e611b..00000000000 --- a/docs/packages/fuel-ts-providers/interfaces/ScriptTransactionRequestLike.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequestLike -parent: "@fuel-ts/providers" -nav_order: 2 - ---- - -# Interface: ScriptTransactionRequestLike - -[@fuel-ts/providers](../index.md).ScriptTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`ScriptTransactionRequestLike`** - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../index.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../index.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### script - -• `Optional` **script**: `BytesLike` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:384](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L384) - -___ - -### scriptData - -• `Optional` **scriptData**: `BytesLike` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:386](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L386) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-providers/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-providers/interfaces/internal-BNHelper.md deleted file mode 100644 index 988033de159..00000000000 --- a/docs/packages/fuel-ts-providers/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/providers" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-providers/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-providers/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index ad4e7e7501a..00000000000 --- a/docs/packages/fuel-ts-providers/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/providers" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../namespaces/internal.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/internal-BN.md) ; `mod`: [`BN`](../classes/internal-BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/internal-BN.md) | -| `mod` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/internal-BN.md), `out`: [`BN`](../classes/internal-BN.md)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/internal-BN.md) | -| `out` | [`BN`](../classes/internal-BN.md) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-providers/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-providers/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index 20cc7aaaaf2..00000000000 --- a/docs/packages/fuel-ts-providers/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/providers" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-providers/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-providers/interfaces/internal-BNOverrides.md deleted file mode 100644 index 8f985c08050..00000000000 --- a/docs/packages/fuel-ts-providers/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/providers" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-providers/interfaces/internal-BaseTransactionRequestLike.md b/docs/packages/fuel-ts-providers/interfaces/internal-BaseTransactionRequestLike.md deleted file mode 100644 index 898167449f4..00000000000 --- a/docs/packages/fuel-ts-providers/interfaces/internal-BaseTransactionRequestLike.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -layout: default -title: BaseTransactionRequestLike -parent: "@fuel-ts/providers" -nav_order: 2 - ---- - -# Interface: BaseTransactionRequestLike - -[@fuel-ts/providers](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequestLike - -## Hierarchy - -- **`BaseTransactionRequestLike`** - - ↳ [`ScriptTransactionRequestLike`](ScriptTransactionRequestLike.md) - - ↳ [`CreateTransactionRequestLike`](CreateTransactionRequestLike.md) - -## Implemented by - -- [`BaseTransactionRequest`](../classes/internal-BaseTransactionRequest.md) - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../index.md#transactionrequestinput)[] - -List of inputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../index.md#transactionrequestoutput)[] - -List of outputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-providers/namespaces/internal.md b/docs/packages/fuel-ts-providers/namespaces/internal.md deleted file mode 100644 index d2bf1c1f1d3..00000000000 --- a/docs/packages/fuel-ts-providers/namespaces/internal.md +++ /dev/null @@ -1,1571 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/providers" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/providers](../index.md).internal - -## Enumerations - -- [GqlReturnType](../enums/internal-GqlReturnType.md) - -## Classes - -- [AbstractAccount](../classes/internal-AbstractAccount.md) -- [AbstractAddress](../classes/internal-AbstractAddress.md) -- [AbstractContract](../classes/internal-AbstractContract.md) -- [AbstractProgram](../classes/internal-AbstractProgram.md) -- [AbstractScriptRequest](../classes/internal-AbstractScriptRequest.md) -- [BN](../classes/internal-BN.md) -- [BaseTransactionRequest](../classes/internal-BaseTransactionRequest.md) - -## Interfaces - -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) -- [BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md) - -## Enumeration Members - -### Call - -• **Call**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L10) - -___ - -### Change - -• **Change**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L10) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L15) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L7) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L16) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L8) - -___ - -### ContractCreated - -• **ContractCreated**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L12) - -___ - -### Log - -• **Log**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L15) - -___ - -### LogData - -• **LogData**: ``6`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L17) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L9) - -___ - -### MessageOut - -• **MessageOut**: ``10`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L20) - -___ - -### Panic - -• **Panic**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L13) - -___ - -### Return - -• **Return**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L11) - -___ - -### ReturnData - -• **ReturnData**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L12) - -___ - -### Revert - -• **Revert**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L14) - -___ - -### ScriptResult - -• **ScriptResult**: ``9`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L19) - -___ - -### Transfer - -• **Transfer**: ``7`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L17) - -___ - -### TransferOut - -• **TransferOut**: ``8`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L18) - -___ - -### Variable - -• **Variable**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L11) - -## Type Aliases - -### AddressLike - -Ƭ **AddressLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractAccount`](../classes/internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L55) - -___ - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### BigNumberish - -Ƭ **BigNumberish**: `string` \| `number` \| [`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/types.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L3) - -___ - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) - -___ - -### ContractIdLike - -Ƭ **ContractIdLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractContract`](../classes/internal-AbstractContract.md) - -#### Defined in - -[packages/interfaces/src/index.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L57) - -___ - -### Exact - -Ƭ **Exact**<`T`\>: { [K in keyof T]: T[K] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Object` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:7 - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](internal.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### GqlBalanceFilterInput - -Ƭ **GqlBalanceFilterInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `owner` | [`Scalars`](internal.md#scalars)[``"Address"``] | Filter coins based on the `owner` field | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:59 - -___ - -### GqlCoinFilterInput - -Ƭ **GqlCoinFilterInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId?` | [`InputMaybe`](internal.md#inputmaybe)<[`Scalars`](internal.md#scalars)[``"AssetId"``]\> | Returns coins only with `asset_id`. | -| `owner` | [`Scalars`](internal.md#scalars)[``"Address"``] | Returns coins owned by the `owner`. | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:142 - -___ - -### GqlDryRunMutation - -Ƭ **GqlDryRunMutation**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Mutation"`` | -| `dryRun` | { `__typename`: ``"Receipt"`` ; `data?`: `string` \| ``null`` ; `rawPayload`: `string` }[] | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1463 - -___ - -### GqlEndSessionMutation - -Ƭ **GqlEndSessionMutation**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Mutation"`` | -| `endSession` | `boolean` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1485 - -___ - -### GqlExcludeInput - -Ƭ **GqlExcludeInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `messages` | [`Scalars`](internal.md#scalars)[``"MessageId"``][] | Messages to exclude from the selection. | -| `utxos` | [`Scalars`](internal.md#scalars)[``"UtxoId"``][] | Utxos to exclude from the selection. | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:231 - -___ - -### GqlExecuteMutation - -Ƭ **GqlExecuteMutation**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Mutation"`` | -| `execute` | `boolean` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1492 - -___ - -### GqlGetBalanceQuery - -Ƭ **GqlGetBalanceQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `balance` | { `__typename`: ``"Balance"`` ; `amount`: `string` ; `assetId`: `string` ; `owner`: `string` } | -| `balance.__typename` | ``"Balance"`` | -| `balance.amount` | `string` | -| `balance.assetId` | `string` | -| `balance.owner` | `string` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1373 - -___ - -### GqlGetBalancesQuery - -Ƭ **GqlGetBalancesQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `balances` | { `__typename`: ``"BalanceConnection"`` ; `edges`: { `__typename`: ``"BalanceEdge"`` ; `node`: { `__typename`: ``"Balance"`` ; `amount`: `string` ; `assetId`: `string` ; `owner`: `string` } }[] } | -| `balances.__typename` | ``"BalanceConnection"`` | -| `balances.edges` | { `__typename`: ``"BalanceEdge"`` ; `node`: { `__typename`: ``"Balance"`` ; `amount`: `string` ; `assetId`: `string` ; `owner`: `string` } }[] | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1386 - -___ - -### GqlGetBlockQuery - -Ƭ **GqlGetBlockQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `block?` | { `__typename`: ``"Block"`` ; `header`: { `__typename`: ``"Header"`` ; `height`: `string` ; `time`: `any` } ; `id`: `string` ; `transactions`: { `__typename`: ``"Transaction"`` ; `id`: `string` }[] } \| ``null`` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1189 - -___ - -### GqlGetBlockWithTransactionsQuery - -Ƭ **GqlGetBlockWithTransactionsQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `block?` | { `__typename`: ``"Block"`` ; `header`: { `__typename`: ``"Header"`` ; `height`: `string` ; `time`: `any` } ; `id`: `string` ; `transactions`: { `__typename`: ``"Transaction"`` ; `gasPrice?`: `string` \| ``null`` ; `id`: `string` ; `rawPayload`: `string` ; `status?`: { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } \| ``null`` ; `time`: `any` ; `type`: ``"SuccessStatus"`` } \| ``null`` }[] } \| ``null`` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1204 - -___ - -### GqlGetBlocksQuery - -Ƭ **GqlGetBlocksQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `blocks` | { `__typename`: ``"BlockConnection"`` ; `edges`: { `__typename`: ``"BlockEdge"`` ; `node`: { `__typename`: ``"Block"`` ; `header`: { `__typename`: ``"Header"`` ; `height`: `string` ; `time`: `any` } ; `id`: `string` ; `transactions`: { `__typename`: ``"Transaction"`` ; `id`: `string` }[] } }[] } | -| `blocks.__typename` | ``"BlockConnection"`` | -| `blocks.edges` | { `__typename`: ``"BlockEdge"`` ; `node`: { `__typename`: ``"Block"`` ; `header`: { `__typename`: ``"Header"`` ; `height`: `string` ; `time`: `any` } ; `id`: `string` ; `transactions`: { `__typename`: ``"Transaction"`` ; `id`: `string` }[] } }[] | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1248 - -___ - -### GqlGetChainQuery - -Ƭ **GqlGetChainQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `chain` | { `__typename`: ``"ChainInfo"`` ; `baseChainHeight`: `string` ; `consensusParameters`: { `__typename`: ``"ConsensusParameters"`` ; `contractMaxSize`: `string` ; `gasPerByte`: `string` ; `gasPriceFactor`: `string` ; `maxGasPerTx`: `string` ; `maxInputs`: `string` ; `maxMessageDataLength`: `string` ; `maxOutputs`: `string` ; `maxPredicateDataLength`: `string` ; `maxPredicateLength`: `string` ; `maxScriptDataLength`: `string` ; `maxScriptLength`: `string` ; `maxStorageSlots`: `string` ; `maxWitnesses`: `string` } ; `latestBlock`: { `__typename`: ``"Block"`` ; `header`: { `__typename`: ``"Header"`` ; `height`: `string` ; `time`: `any` } ; `id`: `string` ; `transactions`: { `__typename`: ``"Transaction"`` ; `id`: `string` }[] } ; `name`: `string` ; `peerCount`: `number` } | -| `chain.__typename` | ``"ChainInfo"`` | -| `chain.baseChainHeight` | `string` | -| `chain.consensusParameters` | { `__typename`: ``"ConsensusParameters"`` ; `contractMaxSize`: `string` ; `gasPerByte`: `string` ; `gasPriceFactor`: `string` ; `maxGasPerTx`: `string` ; `maxInputs`: `string` ; `maxMessageDataLength`: `string` ; `maxOutputs`: `string` ; `maxPredicateDataLength`: `string` ; `maxPredicateLength`: `string` ; `maxScriptDataLength`: `string` ; `maxScriptLength`: `string` ; `maxStorageSlots`: `string` ; `maxWitnesses`: `string` } | -| `chain.consensusParameters.__typename` | ``"ConsensusParameters"`` | -| `chain.consensusParameters.contractMaxSize` | `string` | -| `chain.consensusParameters.gasPerByte` | `string` | -| `chain.consensusParameters.gasPriceFactor` | `string` | -| `chain.consensusParameters.maxGasPerTx` | `string` | -| `chain.consensusParameters.maxInputs` | `string` | -| `chain.consensusParameters.maxMessageDataLength` | `string` | -| `chain.consensusParameters.maxOutputs` | `string` | -| `chain.consensusParameters.maxPredicateDataLength` | `string` | -| `chain.consensusParameters.maxPredicateLength` | `string` | -| `chain.consensusParameters.maxScriptDataLength` | `string` | -| `chain.consensusParameters.maxScriptLength` | `string` | -| `chain.consensusParameters.maxStorageSlots` | `string` | -| `chain.consensusParameters.maxWitnesses` | `string` | -| `chain.latestBlock` | { `__typename`: ``"Block"`` ; `header`: { `__typename`: ``"Header"`` ; `height`: `string` ; `time`: `any` } ; `id`: `string` ; `transactions`: { `__typename`: ``"Transaction"`` ; `id`: `string` }[] } | -| `chain.latestBlock.__typename` | ``"Block"`` | -| `chain.latestBlock.header` | { `__typename`: ``"Header"`` ; `height`: `string` ; `time`: `any` } | -| `chain.latestBlock.header.__typename` | ``"Header"`` | -| `chain.latestBlock.header.height` | `string` | -| `chain.latestBlock.header.time` | `any` | -| `chain.latestBlock.id` | `string` | -| `chain.latestBlock.transactions` | { `__typename`: ``"Transaction"`` ; `id`: `string` }[] | -| `chain.name` | `string` | -| `chain.peerCount` | `number` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:988 - -___ - -### GqlGetCoinQuery - -Ƭ **GqlGetCoinQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `coin?` | { `__typename`: ``"Coin"`` ; `amount`: `string` ; `assetId`: `string` ; `blockCreated`: `string` ; `coinStatus`: [`CoinStatus`](../enums/CoinStatus.md) ; `maturity`: `string` ; `owner`: `string` ; `utxoId`: `string` } \| ``null`` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1268 - -___ - -### GqlGetCoinsQuery - -Ƭ **GqlGetCoinsQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `coins` | { `__typename`: ``"CoinConnection"`` ; `edges`: { `__typename`: ``"CoinEdge"`` ; `node`: { `__typename`: ``"Coin"`` ; `amount`: `string` ; `assetId`: `string` ; `blockCreated`: `string` ; `coinStatus`: [`CoinStatus`](../enums/CoinStatus.md) ; `maturity`: `string` ; `owner`: `string` ; `utxoId`: `string` } }[] } | -| `coins.__typename` | ``"CoinConnection"`` | -| `coins.edges` | { `__typename`: ``"CoinEdge"`` ; `node`: { `__typename`: ``"Coin"`` ; `amount`: `string` ; `assetId`: `string` ; `blockCreated`: `string` ; `coinStatus`: [`CoinStatus`](../enums/CoinStatus.md) ; `maturity`: `string` ; `owner`: `string` ; `utxoId`: `string` } }[] | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1290 - -___ - -### GqlGetContractBalanceQuery - -Ƭ **GqlGetContractBalanceQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `contractBalance` | { `__typename`: ``"ContractBalance"`` ; `amount`: `string` ; `assetId`: `string` ; `contract`: `string` } | -| `contractBalance.__typename` | ``"ContractBalance"`` | -| `contractBalance.amount` | `string` | -| `contractBalance.assetId` | `string` | -| `contractBalance.contract` | `string` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1358 - -___ - -### GqlGetContractQuery - -Ƭ **GqlGetContractQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `contract?` | { `__typename`: ``"Contract"`` ; `bytecode`: `string` ; `id`: `string` } \| ``null`` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1348 - -___ - -### GqlGetInfoQuery - -Ƭ **GqlGetInfoQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `nodeInfo` | { `__typename`: ``"NodeInfo"`` ; `minGasPrice`: `string` ; `nodeVersion`: `string` } | -| `nodeInfo.__typename` | ``"NodeInfo"`` | -| `nodeInfo.minGasPrice` | `string` | -| `nodeInfo.nodeVersion` | `string` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:981 - -___ - -### GqlGetMessageProofQuery - -Ƭ **GqlGetMessageProofQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `messageProof?` | { `__typename`: ``"MessageProof"`` ; `amount`: `string` ; `data`: `string` ; `header`: { `__typename`: ``"Header"`` ; `applicationHash`: `string` ; `daHeight`: `string` ; `height`: `string` ; `id`: `string` ; `outputMessagesCount`: `string` ; `outputMessagesRoot`: `string` ; `prevRoot`: `string` ; `time`: `any` ; `transactionsCount`: `string` ; `transactionsRoot`: `string` } ; `nonce`: `string` ; `proofIndex`: `string` ; `proofSet`: `string`[] ; `recipient`: `string` ; `sender`: `string` ; `signature`: `any` } \| ``null`` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1430 - -___ - -### GqlGetMessagesQuery - -Ƭ **GqlGetMessagesQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `messages` | { `__typename`: ``"MessageConnection"`` ; `edges`: { `__typename`: ``"MessageEdge"`` ; `node`: { `__typename`: ``"Message"`` ; `amount`: `string` ; `daHeight`: `string` ; `data`: `string` ; `messageStatus`: [`MessageStatus`](../enums/MessageStatus.md) ; `nonce`: `string` ; `recipient`: `string` ; `sender`: `string` } }[] } | -| `messages.__typename` | ``"MessageConnection"`` | -| `messages.edges` | { `__typename`: ``"MessageEdge"`` ; `node`: { `__typename`: ``"Message"`` ; `amount`: `string` ; `daHeight`: `string` ; `data`: `string` ; `messageStatus`: [`MessageStatus`](../enums/MessageStatus.md) ; `nonce`: `string` ; `recipient`: `string` ; `sender`: `string` } }[] | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1405 - -___ - -### GqlGetResourcesToSpendQuery - -Ƭ **GqlGetResourcesToSpendQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `resourcesToSpend` | ({ `__typename`: ``"Coin"`` ; `amount`: `string` ; `assetId`: `string` ; `blockCreated`: `string` ; `coinStatus`: [`CoinStatus`](../enums/CoinStatus.md) ; `maturity`: `string` ; `owner`: `string` ; `utxoId`: `string` } \| { `__typename`: ``"Message"`` ; `amount`: `string` ; `daHeight`: `string` ; `data`: `string` ; `messageStatus`: [`MessageStatus`](../enums/MessageStatus.md) ; `nonce`: `string` ; `recipient`: `string` ; `sender`: `string` })[][] | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1316 - -___ - -### GqlGetTransactionQuery - -Ƭ **GqlGetTransactionQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `transaction?` | { `__typename`: ``"Transaction"`` ; `gasPrice?`: `string` \| ``null`` ; `id`: `string` ; `rawPayload`: `string` ; `status?`: { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } \| ``null`` ; `time`: `any` ; `type`: ``"SuccessStatus"`` } \| ``null`` } \| ``null`` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1024 - -___ - -### GqlGetTransactionWithReceiptsQuery - -Ƭ **GqlGetTransactionWithReceiptsQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `transaction?` | { `__typename`: ``"Transaction"`` ; `gasPrice?`: `string` \| ``null`` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: { `__typename`: ``"Receipt"`` ; `data?`: `string` \| ``null`` ; `rawPayload`: `string` }[] \| ``null`` ; `status?`: { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } \| ``null`` ; `time`: `any` ; `type`: ``"SuccessStatus"`` } \| ``null`` } \| ``null`` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1060 - -___ - -### GqlGetTransactionsByOwnerQuery - -Ƭ **GqlGetTransactionsByOwnerQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `transactionsByOwner` | { `__typename`: ``"TransactionConnection"`` ; `edges`: { `__typename`: ``"TransactionEdge"`` ; `node`: { `__typename`: ``"Transaction"`` ; `gasPrice?`: `string` \| ``null`` ; `id`: `string` ; `rawPayload`: `string` ; `status?`: { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } \| ``null`` ; `time`: `any` ; `type`: ``"SuccessStatus"`` } \| ``null`` } }[] } | -| `transactionsByOwner.__typename` | ``"TransactionConnection"`` | -| `transactionsByOwner.edges` | { `__typename`: ``"TransactionEdge"`` ; `node`: { `__typename`: ``"Transaction"`` ; `gasPrice?`: `string` \| ``null`` ; `id`: `string` ; `rawPayload`: `string` ; `status?`: { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } \| ``null`` ; `time`: `any` ; `type`: ``"SuccessStatus"`` } \| ``null`` } }[] | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1146 - -___ - -### GqlGetTransactionsQuery - -Ƭ **GqlGetTransactionsQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `transactions` | { `__typename`: ``"TransactionConnection"`` ; `edges`: { `__typename`: ``"TransactionEdge"`` ; `node`: { `__typename`: ``"Transaction"`` ; `gasPrice?`: `string` \| ``null`` ; `id`: `string` ; `rawPayload`: `string` ; `status?`: { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } \| ``null`` ; `time`: `any` ; `type`: ``"SuccessStatus"`` } \| ``null`` } }[] } | -| `transactions.__typename` | ``"TransactionConnection"`` | -| `transactions.edges` | { `__typename`: ``"TransactionEdge"`` ; `node`: { `__typename`: ``"Transaction"`` ; `gasPrice?`: `string` \| ``null`` ; `id`: `string` ; `rawPayload`: `string` ; `status?`: { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } \| ``null`` ; `time`: `any` ; `type`: ``"SuccessStatus"`` } \| ``null`` } }[] | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1100 - -___ - -### GqlGetVersionQuery - -Ƭ **GqlGetVersionQuery**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Query"`` | -| `nodeInfo` | { `__typename`: ``"NodeInfo"`` ; `nodeVersion`: `string` } | -| `nodeInfo.__typename` | ``"NodeInfo"`` | -| `nodeInfo.nodeVersion` | `string` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:974 - -___ - -### GqlResetMutation - -Ƭ **GqlResetMutation**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Mutation"`` | -| `reset` | `boolean` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1498 - -___ - -### GqlSpendQueryElementInput - -Ƭ **GqlSpendQueryElementInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`Scalars`](internal.md#scalars)[``"U64"``] | Target amount for the query. | -| `assetId` | [`Scalars`](internal.md#scalars)[``"AssetId"``] | Identifier of the asset to spend. | -| `max?` | [`InputMaybe`](internal.md#inputmaybe)<[`Scalars`](internal.md#scalars)[``"U64"``]\> | The maximum number of currencies for selection. | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:707 - -___ - -### GqlStartSessionMutation - -Ƭ **GqlStartSessionMutation**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Mutation"`` | -| `startSession` | `string` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1479 - -___ - -### GqlSubmitMutation - -Ƭ **GqlSubmitMutation**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `__typename` | ``"Mutation"`` | -| `submit` | { `__typename`: ``"Transaction"`` ; `id`: `string` } | -| `submit.__typename` | ``"Transaction"`` | -| `submit.id` | `string` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:1472 - -___ - -### Input - -Ƭ **Input**: [`InputCoin`](internal.md#inputcoin) \| [`InputContract`](internal.md#inputcontract) \| [`InputMessage`](internal.md#inputmessage) - -#### Defined in - -[packages/transactions/src/coders/input.ts:324](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L324) - -___ - -### InputCoin - -Ƭ **InputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins (u64) | -| `assetId` | `string` | Asset ID of the coins (b256) | -| `maturity` | `number` | UTXO being spent must have been created at least this many blocks ago (u32) | -| `owner` | `string` | Owning address or script hash (b256) | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L20) - -___ - -### InputContract - -Ƭ **InputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract before transaction execution (b256) | -| `contractID` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract before transaction execution (b256) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L131) - -___ - -### InputMaybe - -Ƭ **InputMaybe**<`T`\>: [`Maybe`](internal.md#maybe)<`T`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:6 - -___ - -### InputMessage - -Ƭ **InputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins | -| `data` | `string` | data of message | -| `dataLength` | `number` | Length of predicate, in instructions (u16) | -| `nonce` | [`BN`](../classes/internal-BN.md) | Unique nonce of message | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `recipient` | `string` | Address of sender | -| `sender` | `string` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes message (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:196](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L196) - -___ - -### Maybe - -Ƭ **Maybe**<`T`\>: `T` \| ``null`` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:5 - -___ - -### Output - -Ƭ **Output**: [`OutputCoin`](internal.md#outputcoin) \| [`OutputContract`](internal.md#outputcontract) \| [`OutputMessage`](internal.md#outputmessage) \| [`OutputChange`](internal.md#outputchange) \| [`OutputVariable`](internal.md#outputvariable) \| [`OutputContractCreated`](internal.md#outputcontractcreated) - -#### Defined in - -[packages/transactions/src/coders/output.ts:294](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L294) - -___ - -### OutputChange - -Ƭ **OutputChange**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:153](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L153) - -___ - -### OutputCoin - -Ƭ **OutputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L15) - -___ - -### OutputContract - -Ƭ **OutputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract after transaction execution (b256) | -| `inputIndex` | `number` | Index of input contract (u8) | -| `stateRoot` | `string` | State root of contract after transaction execution (b256) | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L63) - -___ - -### OutputContractCreated - -Ƭ **OutputContractCreated**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract (b256) | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:249](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L249) - -___ - -### OutputMessage - -Ƭ **OutputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send with message (u64) | -| `recipient` | `string` | Receiving address (b256) | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:111](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L111) - -___ - -### OutputVariable - -Ƭ **OutputVariable**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Variable`](internal.md#variable) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:201](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L201) - -___ - -### PossibleTransactions - -Ƭ **PossibleTransactions**: [`TransactionScript`](internal.md#transactionscript) \| [`TransactionCreate`](internal.md#transactioncreate) \| [`TransactionMint`](internal.md#transactionmint) - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:347](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L347) - -___ - -### ReceiptCall - -Ƭ **ReceiptCall**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to forward, i.e. $rB (u64) | -| `assetId` | `string` | Asset ID of coins to forward, i.e. MEM[$rC, 32] (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `gas` | [`BN`](../classes/internal-BN.md) | Gas to forward, i.e. $rD (u64) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `param1` | [`BN`](../classes/internal-BN.md) | First parameter (u64) | -| `param2` | [`BN`](../classes/internal-BN.md) | Second parameter (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of called contract (b256) | -| `type` | [`Call`](internal.md#call) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L23) - -___ - -### ReceiptLog - -Ƭ **ReceiptLog**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Log`](internal.md#log) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `val2` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `val3` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:341](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L341) - -___ - -### ReceiptLogData - -Ƭ **ReceiptLogData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rC, $rD] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `type` | [`LogData`](internal.md#logdata) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:413](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L413) - -___ - -### ReceiptMessageOut - -Ƭ **ReceiptMessageOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Hexadecimal string representation of a 64-bit unsigned integer; value of register $rD | -| `data` | `Uint8Array` | Hexadecimal string representation of the value of the memory range MEM[$rA + 32, $rB] | -| `digest` | `string` | Hexadecimal string representation of 256-bit (32-byte), hash of MEM[$rA + 32, $rB] | -| `messageID` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message ID | -| `nonce` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message nonce | -| `recipient` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message recipient: MEM[$rA, 32] | -| `sender` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message sender: MEM[$fp, 32] | -| `type` | [`MessageOut`](internal.md#messageout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:665](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L665) - -___ - -### ReceiptPanic - -Ƭ **ReceiptPanic**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Value of optional contract ID | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `reason` | [`BN`](../classes/internal-BN.md) | Panic reason (u64) | -| `type` | [`Panic`](internal.md#panic) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:227](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L227) - -___ - -### ReceiptReturn - -Ƭ **ReceiptReturn**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Return`](internal.md#return) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L107) - -___ - -### ReceiptReturnData - -Ƭ **ReceiptReturnData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rA, $rB] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `type` | [`ReturnData`](internal.md#returndata) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:161](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L161) - -___ - -### ReceiptRevert - -Ƭ **ReceiptRevert**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Revert`](internal.md#revert) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:287](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L287) - -___ - -### ReceiptScriptResult - -Ƭ **ReceiptScriptResult**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | Gas consumed by the script (u64) | -| `result` | [`BN`](../classes/internal-BN.md) | Result variant with embedded `PanicReason` in first 8 bits and `instr` (u64) | -| `type` | [`ScriptResult`](internal.md#scriptresult) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:623](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L623) - -___ - -### ReceiptTransfer - -Ƭ **ReceiptTransfer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of contract to transfer coins to (b256) | -| `type` | [`Transfer`](internal.md#transfer) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:491](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L491) - -___ - -### ReceiptTransferOut - -Ƭ **ReceiptTransferOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Address to transfer coins to (b256) | -| `type` | [`TransferOut`](internal.md#transferout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:557](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L557) - -___ - -### Scalars - -Ƭ **Scalars**: `Object` - -All built-in and custom scalars, mapped to their actual values - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `Address` | `string` | -| `AssetId` | `string` | -| `BlockId` | `string` | -| `Boolean` | `boolean` | -| `Bytes32` | `string` | -| `ContractId` | `string` | -| `Float` | `number` | -| `HexString` | `string` | -| `ID` | `string` | -| `Int` | `number` | -| `MessageId` | `any` | -| `Salt` | `string` | -| `Signature` | `any` | -| `String` | `string` | -| `Tai64Timestamp` | `any` | -| `TransactionId` | `string` | -| `TxPointer` | `any` | -| `U64` | `string` | -| `UtxoId` | `string` | - -#### Defined in - -packages/providers/src/__generated__/operations.ts:11 - -___ - -### StorageSlot - -Ƭ **StorageSlot**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Key (b256) | -| `value` | `string` | Value (b256) | - -#### Defined in - -[packages/transactions/src/coders/storage-slot.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/storage-slot.ts#L3) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) - -___ - -### Transaction - -Ƭ **Transaction**<`TTransactionType`\>: `TTransactionType` extends [`TransactionType`](../enums/TransactionType.md) ? `Extract`<[`PossibleTransactions`](internal.md#possibletransactions), { `type`: `TTransactionType` }\> : `Partial`<`Omit`<[`TransactionScript`](internal.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](internal.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](internal.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/TransactionType.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:348](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L348) - -___ - -### TransactionCreate - -Ƭ **TransactionCreate**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bytecodeLength` | `number` | Contract bytecode length, in instructions (u16) | -| `bytecodeWitnessIndex` | `number` | Witness index of contract bytecode to create (u8) | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `salt` | `string` | Salt (b256) | -| `storageSlots` | [`StorageSlot`](internal.md#storageslot)[] | List of inputs (StorageSlot[]) | -| `storageSlotsCount` | `number` | Number of storage slots to initialize (u16) | -| `type` | [`Create`](../enums/TransactionType.md#create) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L159) - -___ - -### TransactionMint - -Ƭ **TransactionMint**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | The location of the Mint transaction in the block. | -| `type` | [`Mint`](../enums/TransactionType.md#mint) | - | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:297](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L297) - -___ - -### TransactionRequestStorageSlot - -Ƭ **TransactionRequestStorageSlot**: { `key`: `BytesLike` ; `value`: `BytesLike` } \| [key: BytesLike, value: BytesLike] - -#### Defined in - -[packages/providers/src/transaction-request/storage-slot.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/storage-slot.ts#L5) - -___ - -### TransactionScript - -Ƭ **TransactionScript**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `receiptsRoot` | `string` | Merkle root of receipts (b256) | -| `script` | `string` | Script to execute (byte[]) | -| `scriptData` | `string` | Script input data (parameters) (byte[]) | -| `scriptDataLength` | `number` | Length of script input data, in bytes (u16) | -| `scriptLength` | `number` | Script length, in instructions (u16) | -| `type` | [`Script`](../enums/TransactionType.md#script) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L25) - -___ - -### TxPointer - -Ƭ **TxPointer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockHeight` | `number` | Block height (u32) | -| `txIndex` | `number` | Transaction index (u16) | - -#### Defined in - -[packages/transactions/src/coders/tx-pointer.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/tx-pointer.ts#L3) - -___ - -### UtxoId - -Ƭ **UtxoId**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputIndex` | `number` | Output index (u8) | -| `transactionId` | `string` | Transaction ID (b256) | - -#### Defined in - -[packages/transactions/src/coders/utxo-id.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L3) - -___ - -### Witness - -Ƭ **Witness**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `string` | Witness data (byte[]) | -| `dataLength` | `number` | Length of witness data, in bytes (u32) | - -#### Defined in - -[packages/transactions/src/coders/witness.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L6) diff --git a/docs/packages/fuel-ts-signer/classes/Signer.md b/docs/packages/fuel-ts-signer/classes/Signer.md deleted file mode 100644 index eae5aa20255..00000000000 --- a/docs/packages/fuel-ts-signer/classes/Signer.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -layout: default -title: Signer -parent: "@fuel-ts/signer" -nav_order: 1 - ---- - -# Class: Signer - -[@fuel-ts/signer](../index.md).Signer - -## Constructors - -### constructor - -• **new Signer**(`privateKey`) - -Create a Signer instance from a given private key - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `privateKey` | `BytesLike` | The private key to use for signing | - -#### Defined in - -[packages/signer/src/signer.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L31) - -## Properties - -### address - -• `Readonly` **address**: `default` - -#### Defined in - -[packages/signer/src/signer.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L17) - -___ - -### compressedPublicKey - -• `Readonly` **compressedPublicKey**: `string` - -#### Defined in - -[packages/signer/src/signer.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L21) - -___ - -### privateKey - -• `Readonly` **privateKey**: `string` - -#### Defined in - -[packages/signer/src/signer.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L23) - -___ - -### publicKey - -• `Readonly` **publicKey**: `string` - -#### Defined in - -[packages/signer/src/signer.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L19) - -## Methods - -### addPoint - -▸ **addPoint**(`point`): `string` - -Add point on the current elliptic curve - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `point` | `BytesLike` | Point to add on the curve | - -#### Returns - -`string` - -compressed point on the curve - -#### Defined in - -[packages/signer/src/signer.ts:80](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L80) - -___ - -### sign - -▸ **sign**(`data`): `string` - -Sign data using the Signer instance - -Signature is a 64 byte array of the concatenated r and s values with the compressed recoveryParam byte. [Read more](FuelLabs/fuel-specs/specs/protocol/cryptographic_primitives.md#public-key-cryptography) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | The data to be sign | - -#### Returns - -`string` - -hashed signature - -#### Defined in - -[packages/signer/src/signer.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L60) - -___ - -### extendPublicKey - -▸ `Static` **extendPublicKey**(`publicKey`): `string` - -Extended publicKey from a compact publicKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `publicKey` | `BytesLike` | Compact publicKey | - -#### Returns - -`string` - -extended publicKey - -#### Defined in - -[packages/signer/src/signer.ts:139](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L139) - -___ - -### generatePrivateKey - -▸ `Static` **generatePrivateKey**(`entropy?`): `string` \| `Uint8Array` - -Generate a random privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `entropy?` | `BytesLike` | Adds extra entropy to generate the privateKey | - -#### Returns - -`string` \| `Uint8Array` - -random 32-byte hashed - -#### Defined in - -[packages/signer/src/signer.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L129) - -___ - -### recoverAddress - -▸ `Static` **recoverAddress**(`data`, `signature`): `default` - -Recover the address from a signature performed with [`sign`](#sign). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | Data | -| `signature` | `BytesLike` | Signature | - -#### Returns - -`default` - -Address from signature - -#### Defined in - -[packages/signer/src/signer.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L119) - -___ - -### recoverPublicKey - -▸ `Static` **recoverPublicKey**(`data`, `signature`): `any` - -Recover the public key from a signature performed with [`sign`](#sign). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | Data | -| `signature` | `BytesLike` | hashed signature | - -#### Returns - -`any` - -public key from signature from the - -#### Defined in - -[packages/signer/src/signer.ts:95](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L95) diff --git a/docs/packages/fuel-ts-signer/index.md b/docs/packages/fuel-ts-signer/index.md deleted file mode 100644 index 362ddc2a0fe..00000000000 --- a/docs/packages/fuel-ts-signer/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: "@fuel-ts/signer" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/signer - -## Classes - -- [Signer](classes/Signer.md) - -## Functions - -### getCurve - -▸ **getCurve**(): `ec` - -Return elliptic instance with curve secp256k1 - -#### Returns - -`ec` - -#### Defined in - -[packages/signer/src/signer.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L12) diff --git a/docs/packages/fuel-ts-sparsemerkle/classes/default.md b/docs/packages/fuel-ts-sparsemerkle/classes/default.md deleted file mode 100644 index 505700f6331..00000000000 --- a/docs/packages/fuel-ts-sparsemerkle/classes/default.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -layout: default -title: default -parent: "@fuel-ts/sparsemerkle" -nav_order: 1 - ---- - -# Class: default - -[@fuel-ts/sparsemerkle](../index.md).default - -## Constructors - -### constructor - -• **new default**() - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L17) - -## Properties - -### ms - -• **ms**: [`MapStore`](../interfaces/internal-MapStore.md) - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L13) - -___ - -### root - -• **root**: `string` - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L15) - -## Methods - -### delete - -▸ **delete**(`key`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:257](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L257) - -___ - -### deleteWithSideNodes - -▸ **deleteWithSideNodes**(`key`, `sideNodes`, `oldLeafHash`, `oldLeafData`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `sideNodes` | `string`[] | -| `oldLeafHash` | `string` | -| `oldLeafData` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L90) - -___ - -### get - -▸ **get**(`key`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L24) - -___ - -### prove - -▸ **prove**(`key`): [`SparseMerkleProof`](internal-SparseMerkleProof.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -[`SparseMerkleProof`](internal-SparseMerkleProof.md) - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:261](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L261) - -___ - -### proveCompacted - -▸ **proveCompacted**(`key`): [`SparseCompactMerkleProof`](internal-SparseCompactMerkleProof.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -[`SparseCompactMerkleProof`](internal-SparseCompactMerkleProof.md) - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:288](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L288) - -___ - -### set - -▸ **set**(`key`, `value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L28) - -___ - -### setRoot - -▸ **setRoot**(`root`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `root` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L32) - -___ - -### sideNodesForRoot - -▸ **sideNodesForRoot**(`key`, `root`): [`string`[], `string`, `string`, `string`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `root` | `string` | - -#### Returns - -[`string`[], `string`, `string`, `string`] - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L36) - -___ - -### update - -▸ **update**(`key`, `value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:244](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L244) - -___ - -### updateWithSideNodes - -▸ **updateWithSideNodes**(`key`, `value`, `sideNodes`, `oldLeafHash`, `oldLeafData`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `string` | -| `sideNodes` | `string`[] | -| `oldLeafHash` | `string` | -| `oldLeafData` | `string` | - -#### Returns - -`string` - -#### Defined in - -[packages/sparsemerkle/src/sparseMerkleTree.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/sparseMerkleTree.ts#L168) diff --git a/docs/packages/fuel-ts-sparsemerkle/classes/internal-SparseCompactMerkleProof.md b/docs/packages/fuel-ts-sparsemerkle/classes/internal-SparseCompactMerkleProof.md deleted file mode 100644 index dfcad95ce99..00000000000 --- a/docs/packages/fuel-ts-sparsemerkle/classes/internal-SparseCompactMerkleProof.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -layout: default -title: SparseCompactMerkleProof -parent: "@fuel-ts/sparsemerkle" -nav_order: 1 - ---- - -# Class: SparseCompactMerkleProof - -[@fuel-ts/sparsemerkle](../index.md).[internal](../namespaces/internal.md).SparseCompactMerkleProof - -## Constructors - -### constructor - -• **new SparseCompactMerkleProof**(`SideNodes`, `NonMembershipLeafData`, `Bitmask`, `NumSideNodes`, `SiblingData`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `SideNodes` | `string`[] | -| `NonMembershipLeafData` | `string` | -| `Bitmask` | `number`[] | -| `NumSideNodes` | `number` | -| `SiblingData` | `string` | - -#### Defined in - -[packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts#L8) - -## Properties - -### BitMask - -• **BitMask**: `number`[] - -#### Defined in - -[packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts#L4) - -___ - -### NonMembershipLeafData - -• **NonMembershipLeafData**: `string` - -#### Defined in - -[packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts#L3) - -___ - -### NumSideNodes - -• **NumSideNodes**: `number` - -#### Defined in - -[packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts#L5) - -___ - -### SiblingData - -• **SiblingData**: `string` - -#### Defined in - -[packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts#L6) - -___ - -### SideNodes - -• **SideNodes**: `string`[] - -#### Defined in - -[packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts:2](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseCompactMerkleProof.ts#L2) diff --git a/docs/packages/fuel-ts-sparsemerkle/classes/internal-SparseMerkleProof.md b/docs/packages/fuel-ts-sparsemerkle/classes/internal-SparseMerkleProof.md deleted file mode 100644 index 8630b298f49..00000000000 --- a/docs/packages/fuel-ts-sparsemerkle/classes/internal-SparseMerkleProof.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default -title: SparseMerkleProof -parent: "@fuel-ts/sparsemerkle" -nav_order: 1 - ---- - -# Class: SparseMerkleProof - -[@fuel-ts/sparsemerkle](../index.md).[internal](../namespaces/internal.md).SparseMerkleProof - -## Constructors - -### constructor - -• **new SparseMerkleProof**(`sideNodes`, `NonMembershipLeafData`, `SiblingData`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sideNodes` | `string`[] | -| `NonMembershipLeafData` | `string` | -| `SiblingData` | `string` | - -#### Defined in - -[packages/sparsemerkle/src/types/sparseMerkleProof.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseMerkleProof.ts#L7) - -## Properties - -### NonMembershipLeafData - -• **NonMembershipLeafData**: `string` - -#### Defined in - -[packages/sparsemerkle/src/types/sparseMerkleProof.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseMerkleProof.ts#L4) - -___ - -### SiblingData - -• **SiblingData**: `string` - -#### Defined in - -[packages/sparsemerkle/src/types/sparseMerkleProof.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseMerkleProof.ts#L5) - -___ - -### SideNodes - -• **SideNodes**: `string`[] - -#### Defined in - -[packages/sparsemerkle/src/types/sparseMerkleProof.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/sparsemerkle/src/types/sparseMerkleProof.ts#L3) diff --git a/docs/packages/fuel-ts-sparsemerkle/index.md b/docs/packages/fuel-ts-sparsemerkle/index.md deleted file mode 100644 index 50a8394eb3d..00000000000 --- a/docs/packages/fuel-ts-sparsemerkle/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default -title: "@fuel-ts/sparsemerkle" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/sparsemerkle - -## Namespaces - -- [internal](namespaces/internal.md) - -## Classes - -- [default](classes/default.md) diff --git a/docs/packages/fuel-ts-sparsemerkle/interfaces/internal-MapStore.md b/docs/packages/fuel-ts-sparsemerkle/interfaces/internal-MapStore.md deleted file mode 100644 index f4aee92c74a..00000000000 --- a/docs/packages/fuel-ts-sparsemerkle/interfaces/internal-MapStore.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: default -title: MapStore -parent: "@fuel-ts/sparsemerkle" -nav_order: 2 - ---- - -# Interface: MapStore - -[@fuel-ts/sparsemerkle](../index.md).[internal](../namespaces/internal.md).MapStore - -## Indexable - -▪ [key: `string`]: `string` diff --git a/docs/packages/fuel-ts-sparsemerkle/namespaces/internal.md b/docs/packages/fuel-ts-sparsemerkle/namespaces/internal.md deleted file mode 100644 index ce78175573b..00000000000 --- a/docs/packages/fuel-ts-sparsemerkle/namespaces/internal.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/sparsemerkle" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/sparsemerkle](../index.md).internal - -## Classes - -- [SparseCompactMerkleProof](../classes/internal-SparseCompactMerkleProof.md) -- [SparseMerkleProof](../classes/internal-SparseMerkleProof.md) - -## Interfaces - -- [MapStore](../interfaces/internal-MapStore.md) diff --git a/docs/packages/fuel-ts-transactions/classes/ByteArrayCoder.md b/docs/packages/fuel-ts-transactions/classes/ByteArrayCoder.md deleted file mode 100644 index bdc04e66b6a..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ByteArrayCoder.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -layout: default -title: ByteArrayCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ByteArrayCoder - -[@fuel-ts/transactions](../index.md).ByteArrayCoder - -## Hierarchy - -- `default`<`BytesLike`, `string`\> - - ↳ **`ByteArrayCoder`** - -## Constructors - -### constructor - -• **new ByteArrayCoder**(`length`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `length` | `number` | - -#### Overrides - -Coder<BytesLike, string\>.constructor - -#### Defined in - -[packages/transactions/src/coders/byte-array.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/byte-array.ts#L9) - -## Properties - -### #paddingLength - -• `Private` **#paddingLength**: `number` - -#### Defined in - -[packages/transactions/src/coders/byte-array.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/byte-array.ts#L7) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### length - -• **length**: `number` - -#### Defined in - -[packages/transactions/src/coders/byte-array.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/byte-array.ts#L6) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [`string`, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[`string`, `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/byte-array.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/byte-array.ts#L38) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `BytesLike` | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/byte-array.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/byte-array.ts#L25) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/InputCoder.md b/docs/packages/fuel-ts-transactions/classes/InputCoder.md deleted file mode 100644 index b082c92776f..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/InputCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: InputCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: InputCoder - -[@fuel-ts/transactions](../index.md).InputCoder - -## Hierarchy - -- `default`<[`Input`](../index.md#input), [`Input`](../index.md#input)\> - - ↳ **`InputCoder`** - -## Constructors - -### constructor - -• **new InputCoder**() - -#### Overrides - -Coder<Input, Input\>.constructor - -#### Defined in - -[packages/transactions/src/coders/input.ts:327](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L327) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`Input`](../index.md#input), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`Input`](../index.md#input), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/input.ts:356](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L356) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`Input`](../index.md#input) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/input.ts:331](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L331) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/InputCoinCoder.md b/docs/packages/fuel-ts-transactions/classes/InputCoinCoder.md deleted file mode 100644 index 242ad866a9a..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/InputCoinCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: InputCoinCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: InputCoinCoder - -[@fuel-ts/transactions](../index.md).InputCoinCoder - -## Hierarchy - -- `default`<[`InputCoin`](../index.md#inputcoin), [`InputCoin`](../index.md#inputcoin)\> - - ↳ **`InputCoinCoder`** - -## Constructors - -### constructor - -• **new InputCoinCoder**() - -#### Overrides - -Coder<InputCoin, InputCoin\>.constructor - -#### Defined in - -[packages/transactions/src/coders/input.ts:58](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L58) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`InputCoin`](../index.md#inputcoin), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`InputCoin`](../index.md#inputcoin), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/input.ts:80](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L80) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputCoin`](../index.md#inputcoin) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/input.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L62) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/InputContractCoder.md b/docs/packages/fuel-ts-transactions/classes/InputContractCoder.md deleted file mode 100644 index 1836d71cad4..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/InputContractCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: InputContractCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: InputContractCoder - -[@fuel-ts/transactions](../index.md).InputContractCoder - -## Hierarchy - -- `default`<[`InputContract`](../index.md#inputcontract), [`InputContract`](../index.md#inputcontract)\> - - ↳ **`InputContractCoder`** - -## Constructors - -### constructor - -• **new InputContractCoder**() - -#### Overrides - -Coder<InputContract, InputContract\>.constructor - -#### Defined in - -[packages/transactions/src/coders/input.ts:151](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L151) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`InputContract`](../index.md#inputcontract), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`InputContract`](../index.md#inputcontract), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/input.ts:167](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L167) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputContract`](../index.md#inputcontract) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/input.ts:155](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L155) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/InputMessageCoder.md b/docs/packages/fuel-ts-transactions/classes/InputMessageCoder.md deleted file mode 100644 index f01665b7786..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/InputMessageCoder.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -layout: default -title: InputMessageCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: InputMessageCoder - -[@fuel-ts/transactions](../index.md).InputMessageCoder - -## Hierarchy - -- `default`<[`InputMessage`](../index.md#inputmessage), [`InputMessage`](../index.md#inputmessage)\> - - ↳ **`InputMessageCoder`** - -## Constructors - -### constructor - -• **new InputMessageCoder**() - -#### Overrides - -Coder<InputMessage, InputMessage\>.constructor - -#### Defined in - -[packages/transactions/src/coders/input.ts:234](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L234) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`InputMessage`](../index.md#inputmessage), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`InputMessage`](../index.md#inputmessage), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/input.ts:277](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L277) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputMessage`](../index.md#inputmessage) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/input.ts:249](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L249) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) - -___ - -### decodeData - -▸ `Static` **decodeData**(`messageData`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `messageData` | `BytesLike` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/transactions/src/coders/input.ts:269](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L269) - -___ - -### getMessageId - -▸ `Static` **getMessageId**(`value`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputMessage`](../index.md#inputmessage) | - -#### Returns - -`string` - -#### Defined in - -[packages/transactions/src/coders/input.ts:238](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L238) diff --git a/docs/packages/fuel-ts-transactions/classes/OutputChangeCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputChangeCoder.md deleted file mode 100644 index 2b8dc62e5a8..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/OutputChangeCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: OutputChangeCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: OutputChangeCoder - -[@fuel-ts/transactions](../index.md).OutputChangeCoder - -## Hierarchy - -- `default`<[`OutputChange`](../index.md#outputchange), [`OutputChange`](../index.md#outputchange)\> - - ↳ **`OutputChangeCoder`** - -## Constructors - -### constructor - -• **new OutputChangeCoder**() - -#### Overrides - -Coder<OutputChange, OutputChange\>.constructor - -#### Defined in - -[packages/transactions/src/coders/output.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L164) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`OutputChange`](../index.md#outputchange), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`OutputChange`](../index.md#outputchange), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/output.ts:178](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L178) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`OutputChange`](../index.md#outputchange) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/output.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L168) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/OutputCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputCoder.md deleted file mode 100644 index d100baefc4c..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/OutputCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: OutputCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: OutputCoder - -[@fuel-ts/transactions](../index.md).OutputCoder - -## Hierarchy - -- `default`<[`Output`](../index.md#output), [`Output`](../index.md#output)\> - - ↳ **`OutputCoder`** - -## Constructors - -### constructor - -• **new OutputCoder**() - -#### Overrides - -Coder<Output, Output\>.constructor - -#### Defined in - -[packages/transactions/src/coders/output.ts:303](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L303) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`Output`](../index.md#output), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`Output`](../index.md#output), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/output.ts:344](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L344) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`Output`](../index.md#output) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/output.ts:307](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L307) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/OutputCoinCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputCoinCoder.md deleted file mode 100644 index acb405c768c..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/OutputCoinCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: OutputCoinCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: OutputCoinCoder - -[@fuel-ts/transactions](../index.md).OutputCoinCoder - -## Hierarchy - -- `default`<[`OutputCoin`](../index.md#outputcoin), [`OutputCoin`](../index.md#outputcoin)\> - - ↳ **`OutputCoinCoder`** - -## Constructors - -### constructor - -• **new OutputCoinCoder**() - -#### Overrides - -Coder<OutputCoin, OutputCoin\>.constructor - -#### Defined in - -[packages/transactions/src/coders/output.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L26) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`OutputCoin`](../index.md#outputcoin), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`OutputCoin`](../index.md#outputcoin), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/output.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L40) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`OutputCoin`](../index.md#outputcoin) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/output.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L30) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/OutputContractCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputContractCoder.md deleted file mode 100644 index fbfa80a0e87..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/OutputContractCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: OutputContractCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: OutputContractCoder - -[@fuel-ts/transactions](../index.md).OutputContractCoder - -## Hierarchy - -- `default`<[`OutputContract`](../index.md#outputcontract), [`OutputContract`](../index.md#outputcontract)\> - - ↳ **`OutputContractCoder`** - -## Constructors - -### constructor - -• **new OutputContractCoder**() - -#### Overrides - -Coder<OutputContract, OutputContract\>.constructor - -#### Defined in - -[packages/transactions/src/coders/output.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L74) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`OutputContract`](../index.md#outputcontract), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`OutputContract`](../index.md#outputcontract), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/output.ts:88](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L88) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`OutputContract`](../index.md#outputcontract) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/output.ts:78](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L78) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/OutputContractCreatedCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputContractCreatedCoder.md deleted file mode 100644 index 670fbc4258c..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/OutputContractCreatedCoder.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -layout: default -title: OutputContractCreatedCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: OutputContractCreatedCoder - -[@fuel-ts/transactions](../index.md).OutputContractCreatedCoder - -## Hierarchy - -- `default`<[`OutputContractCreated`](../index.md#outputcontractcreated), [`OutputContractCreated`](../index.md#outputcontractcreated)\> - - ↳ **`OutputContractCreatedCoder`** - -## Constructors - -### constructor - -• **new OutputContractCreatedCoder**() - -#### Overrides - -Coder< - OutputContractCreated, - OutputContractCreated -\>.constructor - -#### Defined in - -[packages/transactions/src/coders/output.ts:261](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L261) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`OutputContractCreated`](../index.md#outputcontractcreated), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`OutputContractCreated`](../index.md#outputcontractcreated), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/output.ts:274](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L274) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`OutputContractCreated`](../index.md#outputcontractcreated) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/output.ts:265](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L265) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/OutputMessageCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputMessageCoder.md deleted file mode 100644 index f51d3fe3cdd..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/OutputMessageCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: OutputMessageCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: OutputMessageCoder - -[@fuel-ts/transactions](../index.md).OutputMessageCoder - -## Hierarchy - -- `default`<[`OutputMessage`](../index.md#outputmessage), [`OutputMessage`](../index.md#outputmessage)\> - - ↳ **`OutputMessageCoder`** - -## Constructors - -### constructor - -• **new OutputMessageCoder**() - -#### Overrides - -Coder<OutputMessage, OutputMessage\>.constructor - -#### Defined in - -[packages/transactions/src/coders/output.ts:120](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L120) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`OutputMessage`](../index.md#outputmessage), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`OutputMessage`](../index.md#outputmessage), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/output.ts:133](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L133) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`OutputMessage`](../index.md#outputmessage) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/output.ts:124](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L124) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/OutputVariableCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputVariableCoder.md deleted file mode 100644 index b1a320efa50..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/OutputVariableCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: OutputVariableCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: OutputVariableCoder - -[@fuel-ts/transactions](../index.md).OutputVariableCoder - -## Hierarchy - -- `default`<[`OutputVariable`](../index.md#outputvariable), [`OutputVariable`](../index.md#outputvariable)\> - - ↳ **`OutputVariableCoder`** - -## Constructors - -### constructor - -• **new OutputVariableCoder**() - -#### Overrides - -Coder<OutputVariable, OutputVariable\>.constructor - -#### Defined in - -[packages/transactions/src/coders/output.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L212) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`OutputVariable`](../index.md#outputvariable), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`OutputVariable`](../index.md#outputvariable), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/output.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L226) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`OutputVariable`](../index.md#outputvariable) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/output.ts:216](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L216) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptCallCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptCallCoder.md deleted file mode 100644 index c5ba08b6eab..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptCallCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptCallCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptCallCoder - -[@fuel-ts/transactions](../index.md).ReceiptCallCoder - -## Hierarchy - -- `default`<[`ReceiptCall`](../index.md#receiptcall), [`ReceiptCall`](../index.md#receiptcall)\> - - ↳ **`ReceiptCallCoder`** - -## Constructors - -### constructor - -• **new ReceiptCallCoder**() - -#### Overrides - -Coder<ReceiptCall, ReceiptCall\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L46) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptCall`](../index.md#receiptcall), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptCall`](../index.md#receiptcall), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L66) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptCall`](../index.md#receiptcall) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:50](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L50) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptCoder.md deleted file mode 100644 index 6c4a1f32174..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptCoder - -[@fuel-ts/transactions](../index.md).ReceiptCoder - -## Hierarchy - -- `default`<[`Receipt`](../index.md#receipt), [`Receipt`](../index.md#receipt)\> - - ↳ **`ReceiptCoder`** - -## Constructors - -### constructor - -• **new ReceiptCoder**() - -#### Overrides - -Coder<Receipt, Receipt\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:754](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L754) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`Receipt`](../index.md#receipt), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`Receipt`](../index.md#receipt), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:815](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L815) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`Receipt`](../index.md#receipt) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:758](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L758) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptLogCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptLogCoder.md deleted file mode 100644 index c92207034aa..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptLogCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptLogCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptLogCoder - -[@fuel-ts/transactions](../index.md).ReceiptLogCoder - -## Hierarchy - -- `default`<[`ReceiptLog`](../index.md#receiptlog), [`ReceiptLog`](../index.md#receiptlog)\> - - ↳ **`ReceiptLogCoder`** - -## Constructors - -### constructor - -• **new ReceiptLogCoder**() - -#### Overrides - -Coder<ReceiptLog, ReceiptLog\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:360](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L360) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptLog`](../index.md#receiptlog), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptLog`](../index.md#receiptlog), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:378](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L378) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptLog`](../index.md#receiptlog) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:364](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L364) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptLogDataCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptLogDataCoder.md deleted file mode 100644 index fd220730674..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptLogDataCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptLogDataCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptLogDataCoder - -[@fuel-ts/transactions](../index.md).ReceiptLogDataCoder - -## Hierarchy - -- `default`<[`ReceiptLogData`](../index.md#receiptlogdata), [`ReceiptLogData`](../index.md#receiptlogdata)\> - - ↳ **`ReceiptLogDataCoder`** - -## Constructors - -### constructor - -• **new ReceiptLogDataCoder**() - -#### Overrides - -Coder<ReceiptLogData, ReceiptLogData\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:434](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L434) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptLogData`](../index.md#receiptlogdata), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptLogData`](../index.md#receiptlogdata), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:453](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L453) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptLogData`](../index.md#receiptlogdata) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:438](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L438) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptMessageOutCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptMessageOutCoder.md deleted file mode 100644 index fdb597a4ece..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptMessageOutCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptMessageOutCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptMessageOutCoder - -[@fuel-ts/transactions](../index.md).ReceiptMessageOutCoder - -## Hierarchy - -- `default`<[`ReceiptMessageOut`](../index.md#receiptmessageout), [`ReceiptMessageOut`](../index.md#receiptmessageout)\> - - ↳ **`ReceiptMessageOutCoder`** - -## Constructors - -### constructor - -• **new ReceiptMessageOutCoder**() - -#### Overrides - -Coder<ReceiptMessageOut, ReceiptMessageOut\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:684](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L684) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptMessageOut`](../index.md#receiptmessageout), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptMessageOut`](../index.md#receiptmessageout), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:703](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L703) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptMessageOut`](../index.md#receiptmessageout) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:688](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L688) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptPanicCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptPanicCoder.md deleted file mode 100644 index 6e81cb648e1..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptPanicCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptPanicCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptPanicCoder - -[@fuel-ts/transactions](../index.md).ReceiptPanicCoder - -## Hierarchy - -- `default`<[`ReceiptPanic`](../index.md#receiptpanic), [`ReceiptPanic`](../index.md#receiptpanic)\> - - ↳ **`ReceiptPanicCoder`** - -## Constructors - -### constructor - -• **new ReceiptPanicCoder**() - -#### Overrides - -Coder<ReceiptPanic, ReceiptPanic\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:242](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L242) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptPanic`](../index.md#receiptpanic), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptPanic`](../index.md#receiptpanic), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:258](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L258) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptPanic`](../index.md#receiptpanic) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L246) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptReturnCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptReturnCoder.md deleted file mode 100644 index 05d72ad6f6e..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptReturnCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptReturnCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptReturnCoder - -[@fuel-ts/transactions](../index.md).ReceiptReturnCoder - -## Hierarchy - -- `default`<[`ReceiptReturn`](../index.md#receiptreturn), [`ReceiptReturn`](../index.md#receiptreturn)\> - - ↳ **`ReceiptReturnCoder`** - -## Constructors - -### constructor - -• **new ReceiptReturnCoder**() - -#### Overrides - -Coder<ReceiptReturn, ReceiptReturn\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:120](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L120) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptReturn`](../index.md#receiptreturn), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptReturn`](../index.md#receiptreturn), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:135](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L135) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptReturn`](../index.md#receiptreturn) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:124](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L124) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptReturnDataCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptReturnDataCoder.md deleted file mode 100644 index e206059fa18..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptReturnDataCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptReturnDataCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptReturnDataCoder - -[@fuel-ts/transactions](../index.md).ReceiptReturnDataCoder - -## Hierarchy - -- `default`<[`ReceiptReturnData`](../index.md#receiptreturndata), [`ReceiptReturnData`](../index.md#receiptreturndata)\> - - ↳ **`ReceiptReturnDataCoder`** - -## Constructors - -### constructor - -• **new ReceiptReturnDataCoder**() - -#### Overrides - -Coder<ReceiptReturnData, ReceiptReturnData\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:178](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L178) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptReturnData`](../index.md#receiptreturndata), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptReturnData`](../index.md#receiptreturndata), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:195](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L195) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptReturnData`](../index.md#receiptreturndata) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:182](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L182) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptRevertCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptRevertCoder.md deleted file mode 100644 index b3c4fbe1a2b..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptRevertCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptRevertCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptRevertCoder - -[@fuel-ts/transactions](../index.md).ReceiptRevertCoder - -## Hierarchy - -- `default`<[`ReceiptRevert`](../index.md#receiptrevert), [`ReceiptRevert`](../index.md#receiptrevert)\> - - ↳ **`ReceiptRevertCoder`** - -## Constructors - -### constructor - -• **new ReceiptRevertCoder**() - -#### Overrides - -Coder<ReceiptRevert, ReceiptRevert\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:300](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L300) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptRevert`](../index.md#receiptrevert), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptRevert`](../index.md#receiptrevert), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:315](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L315) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptRevert`](../index.md#receiptrevert) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:304](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L304) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptScriptResultCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptScriptResultCoder.md deleted file mode 100644 index 157a8336918..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptScriptResultCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptScriptResultCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptScriptResultCoder - -[@fuel-ts/transactions](../index.md).ReceiptScriptResultCoder - -## Hierarchy - -- `default`<[`ReceiptScriptResult`](../index.md#receiptscriptresult), [`ReceiptScriptResult`](../index.md#receiptscriptresult)\> - - ↳ **`ReceiptScriptResultCoder`** - -## Constructors - -### constructor - -• **new ReceiptScriptResultCoder**() - -#### Overrides - -Coder<ReceiptScriptResult, ReceiptScriptResult\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:632](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L632) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptScriptResult`](../index.md#receiptscriptresult), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptScriptResult`](../index.md#receiptscriptresult), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:645](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L645) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptScriptResult`](../index.md#receiptscriptresult) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:636](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L636) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptTransferCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptTransferCoder.md deleted file mode 100644 index 9c56759bc35..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptTransferCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptTransferCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptTransferCoder - -[@fuel-ts/transactions](../index.md).ReceiptTransferCoder - -## Hierarchy - -- `default`<[`ReceiptTransfer`](../index.md#receipttransfer), [`ReceiptTransfer`](../index.md#receipttransfer)\> - - ↳ **`ReceiptTransferCoder`** - -## Constructors - -### constructor - -• **new ReceiptTransferCoder**() - -#### Overrides - -Coder<ReceiptTransfer, ReceiptTransfer\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:508](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L508) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptTransfer`](../index.md#receipttransfer), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptTransfer`](../index.md#receipttransfer), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:525](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L525) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptTransfer`](../index.md#receipttransfer) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:512](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L512) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptTransferOutCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptTransferOutCoder.md deleted file mode 100644 index 73b34c114b1..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/ReceiptTransferOutCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: ReceiptTransferOutCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: ReceiptTransferOutCoder - -[@fuel-ts/transactions](../index.md).ReceiptTransferOutCoder - -## Hierarchy - -- `default`<[`ReceiptTransferOut`](../index.md#receipttransferout), [`ReceiptTransferOut`](../index.md#receipttransferout)\> - - ↳ **`ReceiptTransferOutCoder`** - -## Constructors - -### constructor - -• **new ReceiptTransferOutCoder**() - -#### Overrides - -Coder<ReceiptTransferOut, ReceiptTransferOut\>.constructor - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:574](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L574) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`ReceiptTransferOut`](../index.md#receipttransferout), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`ReceiptTransferOut`](../index.md#receipttransferout), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:591](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L591) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`ReceiptTransferOut`](../index.md#receipttransferout) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:578](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L578) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/StorageSlotCoder.md b/docs/packages/fuel-ts-transactions/classes/StorageSlotCoder.md deleted file mode 100644 index 16331672e62..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/StorageSlotCoder.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -layout: default -title: StorageSlotCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: StorageSlotCoder - -[@fuel-ts/transactions](../index.md).StorageSlotCoder - -## Hierarchy - -- `default`<{ `key`: `B256Coder` ; `value`: `B256Coder` }\> - - ↳ **`StorageSlotCoder`** - -## Constructors - -### constructor - -• **new StorageSlotCoder**() - -#### Overrides - -StructCoder<{ - key: B256Coder; - value: B256Coder; -}\>.constructor - -#### Defined in - -[packages/transactions/src/coders/storage-slot.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/storage-slot.ts#L14) - -## Properties - -### coders - -• **coders**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `key` | `default` | -| `value` | `default` | - -#### Inherited from - -StructCoder.coders - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L19) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -StructCoder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• **name**: `string` - -#### Inherited from - -StructCoder.name - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L18) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -StructCoder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -StructCoder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof)<{ `key`: `default` ; `value`: `default` }\>, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof)<{ `key`: `default` ; `value`: `default` }\>, `number`] - -#### Inherited from - -StructCoder.decode - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L45) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputValueOf`](../namespaces/internal.md#inputvalueof)<{ `key`: `default` ; `value`: `default` }\> | - -#### Returns - -`Uint8Array` - -#### Inherited from - -StructCoder.encode - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L31) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -StructCoder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -StructCoder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/TransactionCoder.md b/docs/packages/fuel-ts-transactions/classes/TransactionCoder.md deleted file mode 100644 index 4aefec6f459..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/TransactionCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: TransactionCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: TransactionCoder - -[@fuel-ts/transactions](../index.md).TransactionCoder - -## Hierarchy - -- `default`<[`Transaction`](../index.md#transaction), [`Transaction`](../index.md#transaction)\> - - ↳ **`TransactionCoder`** - -## Constructors - -### constructor - -• **new TransactionCoder**() - -#### Overrides - -Coder<Transaction, Transaction\>.constructor - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L357) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [`Partial`<`Omit`<[`TransactionScript`](../index.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](../index.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](../index.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/TransactionType.md) }, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[`Partial`<`Omit`<[`TransactionScript`](../index.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](../index.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](../index.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/TransactionType.md) }, `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:390](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L390) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `Partial`<`Omit`<[`TransactionScript`](../index.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](../index.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](../index.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/TransactionType.md) } | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:361](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L361) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/TransactionCreateCoder.md b/docs/packages/fuel-ts-transactions/classes/TransactionCreateCoder.md deleted file mode 100644 index d76e5029c35..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/TransactionCreateCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: TransactionCreateCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: TransactionCreateCoder - -[@fuel-ts/transactions](../index.md).TransactionCreateCoder - -## Hierarchy - -- `default`<[`TransactionCreate`](../index.md#transactioncreate), [`TransactionCreate`](../index.md#transactioncreate)\> - - ↳ **`TransactionCreateCoder`** - -## Constructors - -### constructor - -• **new TransactionCreateCoder**() - -#### Overrides - -Coder<TransactionCreate, TransactionCreate\>.constructor - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L206) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`TransactionCreate`](../index.md#transactioncreate), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`TransactionCreate`](../index.md#transactioncreate), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:233](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L233) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`TransactionCreate`](../index.md#transactioncreate) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:210](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L210) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/TransactionMintCoder.md b/docs/packages/fuel-ts-transactions/classes/TransactionMintCoder.md deleted file mode 100644 index 89c463f0e7c..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/TransactionMintCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: TransactionMintCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: TransactionMintCoder - -[@fuel-ts/transactions](../index.md).TransactionMintCoder - -## Hierarchy - -- `default`<[`TransactionMint`](../index.md#transactionmint), [`TransactionMint`](../index.md#transactionmint)\> - - ↳ **`TransactionMintCoder`** - -## Constructors - -### constructor - -• **new TransactionMintCoder**() - -#### Overrides - -Coder<TransactionMint, TransactionMint\>.constructor - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:311](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L311) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`TransactionMint`](../index.md#transactionmint), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`TransactionMint`](../index.md#transactionmint), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:325](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L325) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`TransactionMint`](../index.md#transactionmint) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:315](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L315) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/TransactionScriptCoder.md b/docs/packages/fuel-ts-transactions/classes/TransactionScriptCoder.md deleted file mode 100644 index ab4d00261a7..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/TransactionScriptCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: TransactionScriptCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: TransactionScriptCoder - -[@fuel-ts/transactions](../index.md).TransactionScriptCoder - -## Hierarchy - -- `default`<[`TransactionScript`](../index.md#transactionscript), [`TransactionScript`](../index.md#transactionscript)\> - - ↳ **`TransactionScriptCoder`** - -## Constructors - -### constructor - -• **new TransactionScriptCoder**() - -#### Overrides - -Coder<TransactionScript, TransactionScript\>.constructor - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:72](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L72) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`TransactionScript`](../index.md#transactionscript), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`TransactionScript`](../index.md#transactionscript), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:97](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L97) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`TransactionScript`](../index.md#transactionscript) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:76](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L76) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/TxPointerCoder.md b/docs/packages/fuel-ts-transactions/classes/TxPointerCoder.md deleted file mode 100644 index 92ee9bfe23a..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/TxPointerCoder.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -layout: default -title: TxPointerCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: TxPointerCoder - -[@fuel-ts/transactions](../index.md).TxPointerCoder - -## Hierarchy - -- `default`<{ `blockHeight`: `NumberCoder` ; `txIndex`: `NumberCoder` }\> - - ↳ **`TxPointerCoder`** - -## Constructors - -### constructor - -• **new TxPointerCoder**() - -#### Overrides - -StructCoder<{ - blockHeight: NumberCoder; - txIndex: NumberCoder; -}\>.constructor - -#### Defined in - -[packages/transactions/src/coders/tx-pointer.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/tx-pointer.ts#L15) - -## Properties - -### coders - -• **coders**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `blockHeight` | `default` | -| `txIndex` | `default` | - -#### Inherited from - -StructCoder.coders - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L19) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -StructCoder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• **name**: `string` - -#### Inherited from - -StructCoder.name - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L18) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -StructCoder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -StructCoder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof)<{ `blockHeight`: `default` ; `txIndex`: `default` }\>, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof)<{ `blockHeight`: `default` ; `txIndex`: `default` }\>, `number`] - -#### Inherited from - -StructCoder.decode - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L45) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputValueOf`](../namespaces/internal.md#inputvalueof)<{ `blockHeight`: `default` ; `txIndex`: `default` }\> | - -#### Returns - -`Uint8Array` - -#### Inherited from - -StructCoder.encode - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L31) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -StructCoder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -StructCoder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/UtxoIdCoder.md b/docs/packages/fuel-ts-transactions/classes/UtxoIdCoder.md deleted file mode 100644 index e1c534edf2f..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/UtxoIdCoder.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -layout: default -title: UtxoIdCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: UtxoIdCoder - -[@fuel-ts/transactions](../index.md).UtxoIdCoder - -## Hierarchy - -- `default`<{ `outputIndex`: `NumberCoder` ; `transactionId`: `B256Coder` }\> - - ↳ **`UtxoIdCoder`** - -## Constructors - -### constructor - -• **new UtxoIdCoder**() - -#### Overrides - -StructCoder<{ - transactionId: B256Coder; - outputIndex: NumberCoder; -}\>.constructor - -#### Defined in - -[packages/transactions/src/coders/utxo-id.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L14) - -## Properties - -### coders - -• **coders**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `outputIndex` | `default` | -| `transactionId` | `default` | - -#### Inherited from - -StructCoder.coders - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L19) - -___ - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -StructCoder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• **name**: `string` - -#### Inherited from - -StructCoder.name - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L18) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -StructCoder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -StructCoder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof)<{ `outputIndex`: `default` ; `transactionId`: `default` }\>, `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`DecodedValueOf`](../namespaces/internal.md#decodedvalueof)<{ `outputIndex`: `default` ; `transactionId`: `default` }\>, `number`] - -#### Inherited from - -StructCoder.decode - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L45) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`InputValueOf`](../namespaces/internal.md#inputvalueof)<{ `outputIndex`: `default` ; `transactionId`: `default` }\> | - -#### Returns - -`Uint8Array` - -#### Inherited from - -StructCoder.encode - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L31) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -StructCoder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -StructCoder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/WitnessCoder.md b/docs/packages/fuel-ts-transactions/classes/WitnessCoder.md deleted file mode 100644 index ea49268829c..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/WitnessCoder.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -layout: default -title: WitnessCoder -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: WitnessCoder - -[@fuel-ts/transactions](../index.md).WitnessCoder - -## Hierarchy - -- `default`<[`Witness`](../index.md#witness), [`Witness`](../index.md#witness)\> - - ↳ **`WitnessCoder`** - -## Constructors - -### constructor - -• **new WitnessCoder**() - -#### Overrides - -Coder<Witness, Witness\>.constructor - -#### Defined in - -[packages/transactions/src/coders/witness.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L14) - -## Properties - -### encodedLength - -• `Readonly` **encodedLength**: `number` - -#### Inherited from - -Coder.encodedLength - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L40) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -Coder.name - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -Coder.offset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L41) - -___ - -### type - -• `Readonly` **type**: `string` - -#### Inherited from - -Coder.type - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L39) - -## Methods - -### decode - -▸ **decode**(`data`, `offset`): [[`Witness`](../index.md#witness), `number`] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `offset` | `number` | - -#### Returns - -[[`Witness`](../index.md#witness), `number`] - -#### Overrides - -Coder.decode - -#### Defined in - -[packages/transactions/src/coders/witness.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L32) - -___ - -### encode - -▸ **encode**(`value`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | [`Witness`](../index.md#witness) | - -#### Returns - -`Uint8Array` - -#### Overrides - -Coder.encode - -#### Defined in - -[packages/transactions/src/coders/witness.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L23) - -___ - -### setOffset - -▸ **setOffset**(`offset`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `offset` | `number` | - -#### Returns - -`void` - -#### Inherited from - -Coder.setOffset - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L56) - -___ - -### throwError - -▸ **throwError**(`message`, `value`): `never` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `value` | `unknown` | - -#### Returns - -`never` - -#### Inherited from - -Coder.throwError - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) diff --git a/docs/packages/fuel-ts-transactions/classes/internal-BN.md b/docs/packages/fuel-ts-transactions/classes/internal-BN.md deleted file mode 100644 index af440286cd8..00000000000 --- a/docs/packages/fuel-ts-transactions/classes/internal-BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/transactions" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/transactions](../index.md).[internal](../namespaces/internal.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../namespaces/internal.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](internal-BN.md) | -| `mod` | [`BN`](internal-BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](internal-BN.md) | -| `b` | [`BN`](internal-BN.md) | -| `gcd` | [`BN`](internal-BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../namespaces/internal.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](internal-BN.md) | -| `out` | [`BN`](internal-BN.md) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-transactions/enums/InputType.md b/docs/packages/fuel-ts-transactions/enums/InputType.md deleted file mode 100644 index 76848953893..00000000000 --- a/docs/packages/fuel-ts-transactions/enums/InputType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: InputType -parent: "@fuel-ts/transactions" -nav_order: 4 - ---- - -# Enumeration: InputType - -[@fuel-ts/transactions](../index.md).InputType - -## Enumeration Members - -### Coin - -• **Coin** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L15) - -___ - -### Contract - -• **Contract** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L16) - -___ - -### Message - -• **Message** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L17) diff --git a/docs/packages/fuel-ts-transactions/enums/OutputType.md b/docs/packages/fuel-ts-transactions/enums/OutputType.md deleted file mode 100644 index 613a50016b8..00000000000 --- a/docs/packages/fuel-ts-transactions/enums/OutputType.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: OutputType -parent: "@fuel-ts/transactions" -nav_order: 4 - ---- - -# Enumeration: OutputType - -[@fuel-ts/transactions](../index.md).OutputType - -## Enumeration Members - -### Change - -• **Change** = ``3`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L10) - -___ - -### Coin - -• **Coin** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L7) - -___ - -### Contract - -• **Contract** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L8) - -___ - -### ContractCreated - -• **ContractCreated** = ``5`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L12) - -___ - -### Message - -• **Message** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L9) - -___ - -### Variable - -• **Variable** = ``4`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L11) diff --git a/docs/packages/fuel-ts-transactions/enums/ReceiptType.md b/docs/packages/fuel-ts-transactions/enums/ReceiptType.md deleted file mode 100644 index e59c43b5e17..00000000000 --- a/docs/packages/fuel-ts-transactions/enums/ReceiptType.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: default -title: ReceiptType -parent: "@fuel-ts/transactions" -nav_order: 4 - ---- - -# Enumeration: ReceiptType - -[@fuel-ts/transactions](../index.md).ReceiptType - -## Enumeration Members - -### Call - -• **Call** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L10) - -___ - -### Log - -• **Log** = ``5`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L15) - -___ - -### LogData - -• **LogData** = ``6`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16) - -___ - -### MessageOut - -• **MessageOut** = ``10`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L20) - -___ - -### Panic - -• **Panic** = ``3`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L13) - -___ - -### Return - -• **Return** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L11) - -___ - -### ReturnData - -• **ReturnData** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L12) - -___ - -### Revert - -• **Revert** = ``4`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L14) - -___ - -### ScriptResult - -• **ScriptResult** = ``9`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L19) - -___ - -### Transfer - -• **Transfer** = ``7`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L17) - -___ - -### TransferOut - -• **TransferOut** = ``8`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L18) diff --git a/docs/packages/fuel-ts-transactions/enums/TransactionType.md b/docs/packages/fuel-ts-transactions/enums/TransactionType.md deleted file mode 100644 index 5e7f2876add..00000000000 --- a/docs/packages/fuel-ts-transactions/enums/TransactionType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: TransactionType -parent: "@fuel-ts/transactions" -nav_order: 4 - ---- - -# Enumeration: TransactionType - -[@fuel-ts/transactions](../index.md).TransactionType - -## Enumeration Members - -### Create - -• **Create** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Mint - -• **Mint** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L22) - -___ - -### Script - -• **Script** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) diff --git a/docs/packages/fuel-ts-transactions/index.md b/docs/packages/fuel-ts-transactions/index.md deleted file mode 100644 index 21a060f0a9f..00000000000 --- a/docs/packages/fuel-ts-transactions/index.md +++ /dev/null @@ -1,807 +0,0 @@ ---- -layout: default -title: "@fuel-ts/transactions" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/transactions - -## Namespaces - -- [internal](namespaces/internal.md) - -## Enumerations - -- [InputType](enums/InputType.md) -- [OutputType](enums/OutputType.md) -- [ReceiptType](enums/ReceiptType.md) -- [TransactionType](enums/TransactionType.md) - -## Classes - -- [ByteArrayCoder](classes/ByteArrayCoder.md) -- [InputCoder](classes/InputCoder.md) -- [InputCoinCoder](classes/InputCoinCoder.md) -- [InputContractCoder](classes/InputContractCoder.md) -- [InputMessageCoder](classes/InputMessageCoder.md) -- [OutputChangeCoder](classes/OutputChangeCoder.md) -- [OutputCoder](classes/OutputCoder.md) -- [OutputCoinCoder](classes/OutputCoinCoder.md) -- [OutputContractCoder](classes/OutputContractCoder.md) -- [OutputContractCreatedCoder](classes/OutputContractCreatedCoder.md) -- [OutputMessageCoder](classes/OutputMessageCoder.md) -- [OutputVariableCoder](classes/OutputVariableCoder.md) -- [ReceiptCallCoder](classes/ReceiptCallCoder.md) -- [ReceiptCoder](classes/ReceiptCoder.md) -- [ReceiptLogCoder](classes/ReceiptLogCoder.md) -- [ReceiptLogDataCoder](classes/ReceiptLogDataCoder.md) -- [ReceiptMessageOutCoder](classes/ReceiptMessageOutCoder.md) -- [ReceiptPanicCoder](classes/ReceiptPanicCoder.md) -- [ReceiptReturnCoder](classes/ReceiptReturnCoder.md) -- [ReceiptReturnDataCoder](classes/ReceiptReturnDataCoder.md) -- [ReceiptRevertCoder](classes/ReceiptRevertCoder.md) -- [ReceiptScriptResultCoder](classes/ReceiptScriptResultCoder.md) -- [ReceiptTransferCoder](classes/ReceiptTransferCoder.md) -- [ReceiptTransferOutCoder](classes/ReceiptTransferOutCoder.md) -- [StorageSlotCoder](classes/StorageSlotCoder.md) -- [TransactionCoder](classes/TransactionCoder.md) -- [TransactionCreateCoder](classes/TransactionCreateCoder.md) -- [TransactionMintCoder](classes/TransactionMintCoder.md) -- [TransactionScriptCoder](classes/TransactionScriptCoder.md) -- [TxPointerCoder](classes/TxPointerCoder.md) -- [UtxoIdCoder](classes/UtxoIdCoder.md) -- [WitnessCoder](classes/WitnessCoder.md) - -## Type Aliases - -### Input - -Ƭ **Input**: [`InputCoin`](index.md#inputcoin) \| [`InputContract`](index.md#inputcontract) \| [`InputMessage`](index.md#inputmessage) - -#### Defined in - -[packages/transactions/src/coders/input.ts:324](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L324) - -___ - -### InputCoin - -Ƭ **InputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Amount of coins (u64) | -| `assetId` | `string` | Asset ID of the coins (b256) | -| `maturity` | `number` | UTXO being spent must have been created at least this many blocks ago (u32) | -| `owner` | `string` | Owning address or script hash (b256) | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `txPointer` | [`TxPointer`](index.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](enums/InputType.md#coin) | - | -| `utxoID` | [`UtxoId`](index.md#utxoid) | UTXO ID (UtxoId) | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L20) - -___ - -### InputContract - -Ƭ **InputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract before transaction execution (b256) | -| `contractID` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract before transaction execution (b256) | -| `txPointer` | [`TxPointer`](index.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](enums/InputType.md#contract) | - | -| `utxoID` | [`UtxoId`](index.md#utxoid) | UTXO ID (UtxoId) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L131) - -___ - -### InputMessage - -Ƭ **InputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Amount of coins | -| `data` | `string` | data of message | -| `dataLength` | `number` | Length of predicate, in instructions (u16) | -| `nonce` | [`BN`](classes/internal-BN.md) | Unique nonce of message | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `recipient` | `string` | Address of sender | -| `sender` | `string` | Address of sender | -| `type` | [`Message`](enums/InputType.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes message (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:196](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L196) - -___ - -### Output - -Ƭ **Output**: [`OutputCoin`](index.md#outputcoin) \| [`OutputContract`](index.md#outputcontract) \| [`OutputMessage`](index.md#outputmessage) \| [`OutputChange`](index.md#outputchange) \| [`OutputVariable`](index.md#outputvariable) \| [`OutputContractCreated`](index.md#outputcontractcreated) - -#### Defined in - -[packages/transactions/src/coders/output.ts:294](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L294) - -___ - -### OutputChange - -Ƭ **OutputChange**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Change`](enums/OutputType.md#change) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:153](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L153) - -___ - -### OutputCoin - -Ƭ **OutputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Coin`](enums/OutputType.md#coin) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L15) - -___ - -### OutputContract - -Ƭ **OutputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract after transaction execution (b256) | -| `inputIndex` | `number` | Index of input contract (u8) | -| `stateRoot` | `string` | State root of contract after transaction execution (b256) | -| `type` | [`Contract`](enums/OutputType.md#contract) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L63) - -___ - -### OutputContractCreated - -Ƭ **OutputContractCreated**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract (b256) | -| `type` | [`ContractCreated`](enums/OutputType.md#contractcreated) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:249](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L249) - -___ - -### OutputMessage - -Ƭ **OutputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Amount of coins to send with message (u64) | -| `recipient` | `string` | Receiving address (b256) | -| `type` | [`Message`](enums/OutputType.md#message) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:111](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L111) - -___ - -### OutputVariable - -Ƭ **OutputVariable**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Variable`](enums/OutputType.md#variable) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:201](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L201) - -___ - -### Receipt - -Ƭ **Receipt**: [`ReceiptCall`](index.md#receiptcall) \| [`ReceiptReturn`](index.md#receiptreturn) \| [`ReceiptReturnData`](index.md#receiptreturndata) \| [`ReceiptPanic`](index.md#receiptpanic) \| [`ReceiptRevert`](index.md#receiptrevert) \| [`ReceiptLog`](index.md#receiptlog) \| [`ReceiptLogData`](index.md#receiptlogdata) \| [`ReceiptTransfer`](index.md#receipttransfer) \| [`ReceiptTransferOut`](index.md#receipttransferout) \| [`ReceiptScriptResult`](index.md#receiptscriptresult) \| [`ReceiptMessageOut`](index.md#receiptmessageout) - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:740](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L740) - -___ - -### ReceiptCall - -Ƭ **ReceiptCall**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Amount of coins to forward, i.e. $rB (u64) | -| `assetId` | `string` | Asset ID of coins to forward, i.e. MEM[$rC, 32] (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `gas` | [`BN`](classes/internal-BN.md) | Gas to forward, i.e. $rD (u64) | -| `is` | [`BN`](classes/internal-BN.md) | Value of register $is (u64) | -| `param1` | [`BN`](classes/internal-BN.md) | First parameter (u64) | -| `param2` | [`BN`](classes/internal-BN.md) | Second parameter (u64) | -| `pc` | [`BN`](classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of called contract (b256) | -| `type` | [`Call`](enums/ReceiptType.md#call) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L23) - -___ - -### ReceiptLog - -Ƭ **ReceiptLog**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Log`](enums/ReceiptType.md#log) | - | -| `val0` | [`BN`](classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](classes/internal-BN.md) | Value of register $rB (u64) | -| `val2` | [`BN`](classes/internal-BN.md) | Value of register $rC (u64) | -| `val3` | [`BN`](classes/internal-BN.md) | Value of register $rD (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:341](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L341) - -___ - -### ReceiptLogData - -Ƭ **ReceiptLogData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rC, $rD] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](classes/internal-BN.md) | Value of register $rD (u64) | -| `pc` | [`BN`](classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](classes/internal-BN.md) | Value of register $rC (u64) | -| `type` | [`LogData`](enums/ReceiptType.md#logdata) | - | -| `val0` | [`BN`](classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](classes/internal-BN.md) | Value of register $rB (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:413](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L413) - -___ - -### ReceiptMessageOut - -Ƭ **ReceiptMessageOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Hexadecimal string representation of a 64-bit unsigned integer; value of register $rD | -| `data` | `Uint8Array` | Hexadecimal string representation of the value of the memory range MEM[$rA + 32, $rB] | -| `digest` | `string` | Hexadecimal string representation of 256-bit (32-byte), hash of MEM[$rA + 32, $rB] | -| `messageID` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message ID | -| `nonce` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message nonce | -| `recipient` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message recipient: MEM[$rA, 32] | -| `sender` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message sender: MEM[$fp, 32] | -| `type` | [`MessageOut`](enums/ReceiptType.md#messageout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:665](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L665) - -___ - -### ReceiptPanic - -Ƭ **ReceiptPanic**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Value of optional contract ID | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](classes/internal-BN.md) | Value of register $pc (u64) | -| `reason` | [`BN`](classes/internal-BN.md) | Panic reason (u64) | -| `type` | [`Panic`](enums/ReceiptType.md#panic) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:227](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L227) - -___ - -### ReceiptReturn - -Ƭ **ReceiptReturn**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Return`](enums/ReceiptType.md#return) | - | -| `val` | [`BN`](classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L107) - -___ - -### ReceiptReturnData - -Ƭ **ReceiptReturnData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rA, $rB] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](classes/internal-BN.md) | Value of register $rB (u64) | -| `pc` | [`BN`](classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](classes/internal-BN.md) | Value of register $rA (u64) | -| `type` | [`ReturnData`](enums/ReceiptType.md#returndata) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:161](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L161) - -___ - -### ReceiptRevert - -Ƭ **ReceiptRevert**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Revert`](enums/ReceiptType.md#revert) | - | -| `val` | [`BN`](classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:287](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L287) - -___ - -### ReceiptScriptResult - -Ƭ **ReceiptScriptResult**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasUsed` | [`BN`](classes/internal-BN.md) | Gas consumed by the script (u64) | -| `result` | [`BN`](classes/internal-BN.md) | Result variant with embedded `PanicReason` in first 8 bits and `instr` (u64) | -| `type` | [`ScriptResult`](enums/ReceiptType.md#scriptresult) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:623](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L623) - -___ - -### ReceiptTransfer - -Ƭ **ReceiptTransfer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of contract to transfer coins to (b256) | -| `type` | [`Transfer`](enums/ReceiptType.md#transfer) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:491](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L491) - -___ - -### ReceiptTransferOut - -Ƭ **ReceiptTransferOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Address to transfer coins to (b256) | -| `type` | [`TransferOut`](enums/ReceiptType.md#transferout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:557](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L557) - -___ - -### StorageSlot - -Ƭ **StorageSlot**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Key (b256) | -| `value` | `string` | Value (b256) | - -#### Defined in - -[packages/transactions/src/coders/storage-slot.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/storage-slot.ts#L3) - -___ - -### Transaction - -Ƭ **Transaction**<`TTransactionType`\>: `TTransactionType` extends [`TransactionType`](enums/TransactionType.md) ? `Extract`<[`PossibleTransactions`](namespaces/internal.md#possibletransactions), { `type`: `TTransactionType` }\> : `Partial`<`Omit`<[`TransactionScript`](index.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](index.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](index.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](enums/TransactionType.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:348](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L348) - -___ - -### TransactionCreate - -Ƭ **TransactionCreate**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bytecodeLength` | `number` | Contract bytecode length, in instructions (u16) | -| `bytecodeWitnessIndex` | `number` | Witness index of contract bytecode to create (u8) | -| `gasLimit` | [`BN`](classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](index.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](index.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `salt` | `string` | Salt (b256) | -| `storageSlots` | [`StorageSlot`](index.md#storageslot)[] | List of inputs (StorageSlot[]) | -| `storageSlotsCount` | `number` | Number of storage slots to initialize (u16) | -| `type` | [`Create`](enums/TransactionType.md#create) | - | -| `witnesses` | [`Witness`](index.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L159) - -___ - -### TransactionMint - -Ƭ **TransactionMint**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputs` | [`Output`](index.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `txPointer` | [`TxPointer`](index.md#txpointer) | The location of the Mint transaction in the block. | -| `type` | [`Mint`](enums/TransactionType.md#mint) | - | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:297](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L297) - -___ - -### TransactionScript - -Ƭ **TransactionScript**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasLimit` | [`BN`](classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](index.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](index.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `receiptsRoot` | `string` | Merkle root of receipts (b256) | -| `script` | `string` | Script to execute (byte[]) | -| `scriptData` | `string` | Script input data (parameters) (byte[]) | -| `scriptDataLength` | `number` | Length of script input data, in bytes (u16) | -| `scriptLength` | `number` | Script length, in instructions (u16) | -| `type` | [`Script`](enums/TransactionType.md#script) | - | -| `witnesses` | [`Witness`](index.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L25) - -___ - -### TxPointer - -Ƭ **TxPointer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockHeight` | `number` | Block height (u32) | -| `txIndex` | `number` | Transaction index (u16) | - -#### Defined in - -[packages/transactions/src/coders/tx-pointer.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/tx-pointer.ts#L3) - -___ - -### UtxoId - -Ƭ **UtxoId**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputIndex` | `number` | Output index (u8) | -| `transactionId` | `string` | Transaction ID (b256) | - -#### Defined in - -[packages/transactions/src/coders/utxo-id.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L3) - -___ - -### Witness - -Ƭ **Witness**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `string` | Witness data (byte[]) | -| `dataLength` | `number` | Length of witness data, in bytes (u32) | - -#### Defined in - -[packages/transactions/src/coders/witness.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L6) - -## Variables - -### CONTRACT\_MAX\_SIZE - -• `Const` **CONTRACT\_MAX\_SIZE**: `number` - -Maximum contract size, in bytes. - -#### Defined in - -[packages/transactions/src/consts.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L4) - -___ - -### FAILED\_TRANSFER\_TO\_ADDRESS\_SIGNAL - -• `Const` **FAILED\_TRANSFER\_TO\_ADDRESS\_SIGNAL**: ``"0xffffffffffff0001"`` - -#### Defined in - -[packages/transactions/src/consts.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L41) - -___ - -### GAS\_PER\_BYTE - -• `Const` **GAS\_PER\_BYTE**: [`BN`](classes/internal-BN.md) - -Gas charged per byte of the transaction. - -#### Defined in - -[packages/transactions/src/consts.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L20) - -___ - -### GAS\_PRICE\_FACTOR - -• `Const` **GAS\_PRICE\_FACTOR**: [`BN`](classes/internal-BN.md) - -Gas Price factor this is used to calculate -This is used to calculate the gas fee in Native Coins. -Ex.: transactionFee = Math.ceil( / MAX_GAS_PER_TX); - -#### Defined in - -[packages/transactions/src/consts.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L17) - -___ - -### MAX\_GAS\_PER\_TX - -• `Const` **MAX\_GAS\_PER\_TX**: [`BN`](classes/internal-BN.md) - -Maximum gas per transaction. - -#### Defined in - -[packages/transactions/src/consts.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L10) - -___ - -### MAX\_PREDICATE\_DATA\_LENGTH - -• `Const` **MAX\_PREDICATE\_DATA\_LENGTH**: `number` - -Maximum length of predicate data, in bytes. - -#### Defined in - -[packages/transactions/src/consts.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L39) - -___ - -### MAX\_PREDICATE\_LENGTH - -• `Const` **MAX\_PREDICATE\_LENGTH**: `number` - -Maximum length of predicate, in instructions. - -#### Defined in - -[packages/transactions/src/consts.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L35) - -___ - -### MAX\_SCRIPT\_DATA\_LENGTH - -• `Const` **MAX\_SCRIPT\_DATA\_LENGTH**: `number` - -Maximum length of script data, in bytes. - -#### Defined in - -[packages/transactions/src/consts.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L28) - -___ - -### MAX\_SCRIPT\_LENGTH - -• `Const` **MAX\_SCRIPT\_LENGTH**: `number` - -Maximum length of script, in instructions. - -#### Defined in - -[packages/transactions/src/consts.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L24) - -___ - -### MAX\_STATIC\_CONTRACTS - -• `Const` **MAX\_STATIC\_CONTRACTS**: ``255`` - -Maximum number of static contracts. - -#### Defined in - -[packages/transactions/src/consts.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L31) - -___ - -### MAX\_WITNESSES - -• `Const` **MAX\_WITNESSES**: ``16`` - -Maximum number of witnesses. - -#### Defined in - -[packages/transactions/src/consts.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L7) diff --git a/docs/packages/fuel-ts-transactions/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-transactions/interfaces/internal-BNHelper.md deleted file mode 100644 index 85c7246a072..00000000000 --- a/docs/packages/fuel-ts-transactions/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/transactions" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/transactions](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-transactions/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-transactions/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index f26679b6f52..00000000000 --- a/docs/packages/fuel-ts-transactions/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/transactions" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/transactions](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../namespaces/internal.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/internal-BN.md) ; `mod`: [`BN`](../classes/internal-BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/internal-BN.md) | -| `mod` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/internal-BN.md), `out`: [`BN`](../classes/internal-BN.md)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/internal-BN.md) | -| `out` | [`BN`](../classes/internal-BN.md) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-transactions/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-transactions/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index 7ec527d7129..00000000000 --- a/docs/packages/fuel-ts-transactions/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/transactions" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/transactions](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-transactions/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-transactions/interfaces/internal-BNOverrides.md deleted file mode 100644 index 7b3115133ed..00000000000 --- a/docs/packages/fuel-ts-transactions/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/transactions" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/transactions](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-transactions/namespaces/internal.md b/docs/packages/fuel-ts-transactions/namespaces/internal.md deleted file mode 100644 index eb6f37b329b..00000000000 --- a/docs/packages/fuel-ts-transactions/namespaces/internal.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/transactions" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/transactions](../index.md).internal - -## Classes - -- [BN](../classes/internal-BN.md) - -## Interfaces - -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) - -## Type Aliases - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) - -___ - -### DecodedValueOf - -Ƭ **DecodedValueOf**<`TCoders`\>: { [P in keyof TCoders]: TypesOfCoder["Decoded"] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, `Coder`\> | - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L10) - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](internal.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### InputValueOf - -Ƭ **InputValueOf**<`TCoders`\>: { [P in keyof TCoders]: TypesOfCoder["Input"] } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TCoders` | extends `Record`<`string`, `Coder`\> | - -#### Defined in - -[packages/abi-coder/src/coders/struct.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/struct.ts#L7) - -___ - -### PossibleTransactions - -Ƭ **PossibleTransactions**: [`TransactionScript`](../index.md#transactionscript) \| [`TransactionCreate`](../index.md#transactioncreate) \| [`TransactionMint`](../index.md#transactionmint) - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:347](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L347) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) - -___ - -### TypesOfCoder - -Ƭ **TypesOfCoder**<`TCoder`\>: `TCoder` extends `Coder` ? { `Decoded`: `TDecoded` ; `Input`: `TInput` } : `never` - -#### Type parameters - -| Name | -| :------ | -| `TCoder` | - -#### Defined in - -[packages/abi-coder/src/coders/abstract-coder.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L33) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/StorageAbstract.md b/docs/packages/fuel-ts-wallet-manager/classes/StorageAbstract.md deleted file mode 100644 index 700f7fb0631..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/StorageAbstract.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: default -title: StorageAbstract -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: StorageAbstract - -[@fuel-ts/wallet-manager](../index.md).StorageAbstract - -## Constructors - -### constructor - -• **new StorageAbstract**() - -## Methods - -### clear - -▸ `Abstract` **clear**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/types.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L64) - -___ - -### getItem - -▸ `Abstract` **getItem**(`key`): `Promise`<`undefined` \| ``null`` \| `string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`Promise`<`undefined` \| ``null`` \| `string`\> - -#### Defined in - -[packages/wallet-manager/src/types.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L62) - -___ - -### removeItem - -▸ `Abstract` **removeItem**(`key`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/types.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L63) - -___ - -### setItem - -▸ `Abstract` **setItem**(`key`, `value`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/types.ts:61](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L61) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/Vault.md b/docs/packages/fuel-ts-wallet-manager/classes/Vault.md deleted file mode 100644 index 9d0bf7fc23a..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/Vault.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -layout: default -title: Vault -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: Vault - -[@fuel-ts/wallet-manager](../index.md).Vault - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `TOptions` | { `secret?`: `string` } | - -## Implemented by - -- [`MnemonicVault`](internal-MnemonicVault.md) -- [`PrivateKeyVault`](internal-PrivateKeyVault.md) - -## Constructors - -### constructor - -• **new Vault**<`TOptions`\>(`_options`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TOptions` | { `secret?`: `string` } | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_options` | `TOptions` | - -#### Defined in - -[packages/wallet-manager/src/types.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L35) - -## Properties - -### type - -▪ `Static` `Readonly` **type**: `string` - -#### Defined in - -[packages/wallet-manager/src/types.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L33) - -## Methods - -### addAccount - -▸ **addAccount**(): [`Account`](../index.md#account) - -#### Returns - -[`Account`](../index.md#account) - -#### Defined in - -[packages/wallet-manager/src/types.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L47) - -___ - -### exportAccount - -▸ **exportAccount**(`_address`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_address` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`string` - -#### Defined in - -[packages/wallet-manager/src/types.ts:51](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L51) - -___ - -### getAccounts - -▸ **getAccounts**(): [`Account`](../index.md#account)[] - -#### Returns - -[`Account`](../index.md#account)[] - -#### Defined in - -[packages/wallet-manager/src/types.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L43) - -___ - -### getWallet - -▸ **getWallet**(`_address`): [`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_address` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -[`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Defined in - -[packages/wallet-manager/src/types.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L55) - -___ - -### serialize - -▸ **serialize**(): `TOptions` - -#### Returns - -`TOptions` - -#### Defined in - -[packages/wallet-manager/src/types.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L39) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/WalletManager.md b/docs/packages/fuel-ts-wallet-manager/classes/WalletManager.md deleted file mode 100644 index 8e02e8b22bb..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/WalletManager.md +++ /dev/null @@ -1,467 +0,0 @@ ---- -layout: default -title: WalletManager -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: WalletManager - -[@fuel-ts/wallet-manager](../index.md).WalletManager - -WalletManager is a upper package to manage multiple vaults like mnemonic and privateKeys. - -- VaultTypes can be add to `WalletManager.Vaults` enabling to add custom Vault types. -- Storage can be instantiate when initializing enabling custom storage types. - -## Hierarchy - -- `EventEmitter` - - ↳ **`WalletManager`** - -## Constructors - -### constructor - -• **new WalletManager**(`options?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`WalletManagerOptions`](../index.md#walletmanageroptions) | - -#### Overrides - -EventEmitter.constructor - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L68) - -## Properties - -### #isLocked - -• `Private` **#isLocked**: `boolean` = `true` - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L66) - -___ - -### #passphrase - -• `Private` **#passphrase**: `string` = `''` - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L65) - -___ - -### #vaults - -• `Private` **#vaults**: [`VaultsState`](../index.md#vaultsstate) = `[]` - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L64) - -___ - -### STORAGE\_KEY - -• `Readonly` **STORAGE\_KEY**: `string` = `'WalletManager'` - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:61](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L61) - -___ - -### storage - -• `Readonly` **storage**: [`StorageAbstract`](StorageAbstract.md) - -Storage - -Persistent encrypted data. `The default storage works only on memory`. - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:59](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L59) - -___ - -### Vaults - -▪ `Static` **Vaults**: (typeof [`MnemonicVault`](internal-MnemonicVault.md) \| typeof [`PrivateKeyVault`](internal-PrivateKeyVault.md))[] - -Vaults - -Vaults are responsible to store secret keys and return an `Wallet` instance, -to interact with the network. - -Each vault has access to its own state - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:53](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L53) - -## Accessors - -### isLocked - -• `get` **isLocked**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:73](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L73) - -## Methods - -### #deserializeVaults - -▸ `Private` **#deserializeVaults**(`vaults`): { `title`: `undefined` \| `string` ; `type`: `string` ; `vault`: [`MnemonicVault`](internal-MnemonicVault.md) \| [`PrivateKeyVault`](internal-PrivateKeyVault.md) }[] - -Deserialize all vaults to state - -`This is only accessible from inside the class` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `vaults` | [`VaultsState`](../index.md#vaultsstate) | - -#### Returns - -{ `title`: `undefined` \| `string` ; `type`: `string` ; `vault`: [`MnemonicVault`](internal-MnemonicVault.md) \| [`PrivateKeyVault`](internal-PrivateKeyVault.md) }[] - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:282](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L282) - -___ - -### #serializeVaults - -▸ `Private` **#serializeVaults**(`vaults`): { `data`: { `secret?`: `string` } ; `title`: `undefined` \| `string` ; `type`: `string` }[] - -Serialize all vaults to store - -`This is only accessible from inside the class` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `vaults` | [`VaultsState`](../index.md#vaultsstate) | - -#### Returns - -{ `data`: { `secret?`: `string` } ; `title`: `undefined` \| `string` ; `type`: `string` }[] - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:269](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L269) - -___ - -### addAccount - -▸ **addAccount**(`options?`): `Promise`<[`Account`](../index.md#account)\> - -Add account to a selected vault or on the first vault as default. -If not vaults are adds it will return error - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Object` | -| `options.vaultId` | `number` | - -#### Returns - -`Promise`<[`Account`](../index.md#account)\> - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:138](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L138) - -___ - -### addVault - -▸ **addVault**(`vaultConfig`): `Promise`<`void`\> - -Add Vault, the `vaultConfig.type` will look for the Vaults supported if -didn't found it will throw. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `vaultConfig` | [`VaultConfig`](../index.md#vaultconfig) | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:165](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L165) - -___ - -### exportPrivateKey - -▸ **exportPrivateKey**(`address`): `string` - -Export specific account privateKey - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`string` - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:124](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L124) - -___ - -### exportVault - -▸ **exportVault**<`T`\>(`vaultId`): `ReturnType`<`T`[``"serialize"``]\> - -Return the vault serialized object containing all the privateKeys, -the format of the return depends on the Vault type. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`Vault`](Vault.md)<{ `secret?`: `string` }, `T`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `vaultId` | `number` | - -#### Returns - -`ReturnType`<`T`[``"serialize"``]\> - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L81) - -___ - -### getAccounts - -▸ **getAccounts**(): [`Account`](../index.md#account)[] - -List all accounts on the Wallet Manager not vault information is revealed - -#### Returns - -[`Account`](../index.md#account)[] - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L102) - -___ - -### getVaultClass - -▸ `Private` **getVaultClass**(`type`): typeof [`MnemonicVault`](internal-MnemonicVault.md) \| typeof [`PrivateKeyVault`](internal-PrivateKeyVault.md) - -Return a instantiable Class reference from `WalletManager.Vaults` supported list. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `string` | - -#### Returns - -typeof [`MnemonicVault`](internal-MnemonicVault.md) \| typeof [`PrivateKeyVault`](internal-PrivateKeyVault.md) - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:296](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L296) - -___ - -### getVaults - -▸ **getVaults**(): { `title?`: `string` ; `type`: `string` ; `vaultId`: `number` }[] - -List all vaults on the Wallet Manager, this function not return secret's - -#### Returns - -{ `title?`: `string` ; `type`: `string` ; `vaultId`: `number` }[] - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L91) - -___ - -### getWallet - -▸ **getWallet**(`address`): [`WalletUnlocked`](internal-WalletUnlocked.md) - -Create a Wallet instance for the specific account - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -[`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:112](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L112) - -___ - -### loadState - -▸ **loadState**(): `Promise`<`void`\> - -Retrieve and decrypt WalletManager state from storage - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:241](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L241) - -___ - -### lock - -▸ **lock**(): `Promise`<`void`\> - -Lock wallet. It removes passphrase from class instance, encrypt and hide all address and -secrets. - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:186](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L186) - -___ - -### removeVault - -▸ **removeVault**(`index`): `Promise`<`void`\> - -Remove vault by index, by remove the vault you also remove all accounts -created by the vault. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L156) - -___ - -### saveState - -▸ `Private` **saveState**(): `Promise`<`void`\> - -Store encrypted WalletManager state on storage - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:254](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L254) - -___ - -### unlock - -▸ **unlock**(`passphrase`): `Promise`<`void`\> - -Unlock wallet. It sets passphrase on WalletManger instance load all address from configured vaults. -Vaults with secrets are not unlocked or instantiated on this moment. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `passphrase` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:200](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L200) - -___ - -### updatePassphrase - -▸ **updatePassphrase**(`oldpass`, `newpass`): `Promise`<`void`\> - -Update WalletManager encryption passphrase - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `oldpass` | `string` | -| `newpass` | `string` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet-manager/src/wallet-manager.ts:222](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.ts#L222) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractAccount.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractAccount.md deleted file mode 100644 index e6187f6979b..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractAccount.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -layout: default -title: AbstractAccount -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: AbstractAccount - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).AbstractAccount - -## Hierarchy - -- **`AbstractAccount`** - - ↳ [`Account`](internal-Account.md) - -## Constructors - -### constructor - -• **new AbstractAccount**() - -## Properties - -### address - -• `Abstract` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L26) - -___ - -### provider - -• `Abstract` **provider**: `unknown` - -#### Defined in - -[packages/interfaces/src/index.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L27) - -## Methods - -### getResourcesToSpend - -▸ `Abstract` **getResourcesToSpend**(`quantities`, `options?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | `any`[] | -| `options?` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L28) - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L29) - -___ - -### simulateTransaction - -▸ `Abstract` **simulateTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L30) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractAddress.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractAddress.md deleted file mode 100644 index e4e1a2f5a44..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractAddress.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: default -title: AbstractAddress -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: AbstractAddress - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).AbstractAddress - -## Constructors - -### constructor - -• **new AbstractAddress**() - -## Methods - -### equals - -▸ `Abstract` **equals**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/interfaces/src/index.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L21) - -___ - -### toAddress - -▸ `Abstract` **toAddress**(): \`fuel${string}\` - -#### Returns - -\`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L17) - -___ - -### toB256 - -▸ `Abstract` **toB256**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L18) - -___ - -### toBytes - -▸ `Abstract` **toBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L20) - -___ - -### toHexString - -▸ `Abstract` **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L19) - -___ - -### toJSON - -▸ `Abstract` **toJSON**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L15) - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L16) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractContract.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractContract.md deleted file mode 100644 index 6313849226a..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractContract.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: default -title: AbstractContract -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: AbstractContract - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).AbstractContract - -## Hierarchy - -- [`AbstractProgram`](internal-AbstractProgram.md) - - ↳ **`AbstractContract`** - -## Constructors - -### constructor - -• **new AbstractContract**() - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[constructor](internal-AbstractProgram.md#constructor) - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[account](internal-AbstractProgram.md#account) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### id - -• `Abstract` **id**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L48) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[interface](internal-AbstractProgram.md#interface) - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[provider](internal-AbstractProgram.md#provider) - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractProgram.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractProgram.md deleted file mode 100644 index 98dd88086f9..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractProgram.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: AbstractProgram -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: AbstractProgram - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).AbstractProgram - -## Hierarchy - -- **`AbstractProgram`** - - ↳ [`AbstractContract`](internal-AbstractContract.md) - -## Constructors - -### constructor - -• **new AbstractProgram**() - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractScriptRequest.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractScriptRequest.md deleted file mode 100644 index 9a2b76d443b..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-AbstractScriptRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default -title: AbstractScriptRequest -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: AbstractScriptRequest - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).AbstractScriptRequest - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Constructors - -### constructor - -• **new AbstractScriptRequest**<`T`\>() - -#### Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### bytes - -• `Abstract` **bytes**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L9) - -___ - -### encodeScriptData - -• `Abstract` **encodeScriptData**: (`data`: `T`) => `Uint8Array` - -#### Type declaration - -▸ (`data`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L10) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-Account.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-Account.md deleted file mode 100644 index 1cca6479b45..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-Account.md +++ /dev/null @@ -1,330 +0,0 @@ ---- -layout: default -title: Account -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: Account - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).Account - -Account - -## Hierarchy - -- [`AbstractAccount`](internal-AbstractAccount.md) - - ↳ **`Account`** - - ↳↳ [`BaseWalletUnlocked`](internal-BaseWalletUnlocked.md) - - ↳↳ [`WalletLocked`](internal-WalletLocked.md) - -## Constructors - -### constructor - -• **new Account**(`address`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[constructor](internal-AbstractAccount.md#constructor) - -#### Defined in - -[packages/wallet/src/account.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L39) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[address](internal-AbstractAccount.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[provider](internal-AbstractAccount.md#provider) - -#### Defined in - -[packages/wallet/src/account.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[getResourcesToSpend](internal-AbstractAccount.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[sendTransaction](internal-AbstractAccount.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/account.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L253) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[simulateTransaction](internal-AbstractAccount.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/account.ts:267](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L267) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-BN.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-BN.md deleted file mode 100644 index 3630a667b2a..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../namespaces/internal.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](internal-BN.md) | -| `mod` | [`BN`](internal-BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](internal-BN.md) | -| `b` | [`BN`](internal-BN.md) | -| `gcd` | [`BN`](internal-BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../namespaces/internal.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](internal-BN.md) | -| `out` | [`BN`](internal-BN.md) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-BaseTransactionRequest.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-BaseTransactionRequest.md deleted file mode 100644 index 34f5f6da047..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-BaseTransactionRequest.md +++ /dev/null @@ -1,526 +0,0 @@ ---- -layout: default -title: BaseTransactionRequest -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: BaseTransactionRequest - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequest - -## Hierarchy - -- **`BaseTransactionRequest`** - - ↳ [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - - ↳ [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -## Implements - -- [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) - -## Constructors - -### constructor - -• **new BaseTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) | - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L131) - -## Properties - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasLimit](../interfaces/internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasPrice](../interfaces/internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[inputs](../interfaces/internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[maturity](../interfaces/internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[outputs](../interfaces/internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### type - -• `Abstract` **type**: [`TransactionType`](../enums/internal-TransactionType.md) - -Type of the transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:117](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L117) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[witnesses](../interfaces/internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ `Abstract` **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:167](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L167) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-BaseWalletUnlocked.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-BaseWalletUnlocked.md deleted file mode 100644 index a3dec08861d..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-BaseWalletUnlocked.md +++ /dev/null @@ -1,484 +0,0 @@ ---- -layout: default -title: BaseWalletUnlocked -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: BaseWalletUnlocked - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).BaseWalletUnlocked - -BaseWalletUnlocked - -## Hierarchy - -- [`Account`](internal-Account.md) - - ↳ **`BaseWalletUnlocked`** - - ↳↳ [`WalletUnlocked`](internal-WalletUnlocked.md) - -## Constructors - -### constructor - -• **new BaseWalletUnlocked**(`privateKey`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `privateKey` | `BytesLike` | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Overrides - -[Account](internal-Account.md).[constructor](internal-Account.md#constructor) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L26) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Inherited from - -[Account](internal-Account.md).[address](internal-Account.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Overrides - -[Account](internal-Account.md).[provider](internal-Account.md#provider) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L22) - -___ - -### signer - -• **signer**: () => [`Signer`](internal-Signer.md) - -#### Type declaration - -▸ (): [`Signer`](internal-Signer.md) - -##### Returns - -[`Signer`](internal-Signer.md) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L24) - -___ - -### defaultPath - -▪ `Static` **defaultPath**: `string` = `"m/44'/1179993420'/0'/0/0"` - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L20) - -## Accessors - -### privateKey - -• `get` **privateKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L33) - -___ - -### publicKey - -• `get` **publicKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Inherited from - -[Account](internal-Account.md).[connect](internal-Account.md#connect) - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[Account](internal-Account.md).[fund](internal-Account.md#fund) - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Inherited from - -[Account](internal-Account.md).[getBalance](internal-Account.md#getbalance) - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getBalances](internal-Account.md#getbalances) - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getCoins](internal-Account.md#getcoins) - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getMessages](internal-Account.md#getmessages) - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getResourcesToSpend](internal-Account.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### populateTransactionWitnessesSignature - -▸ **populateTransactionWitnessesSignature**(`transactionRequestLike`): `Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L65) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Overrides - -[Account](internal-Account.md).[sendTransaction](internal-Account.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:80](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L80) - -___ - -### signMessage - -▸ **signMessage**(`message`): `Promise`<`string`\> - -Sign message with wallet instance privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `message` | `string` | Message | - -#### Returns - -`Promise`<`string`\> - -Promise - Signature a ECDSA 64 bytes - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L47) - -___ - -### signTransaction - -▸ **signTransaction**(`transactionRequestLike`): `Promise`<`string`\> - -Sign transaction with wallet instance privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | TransactionRequestLike | - -#### Returns - -`Promise`<`string`\> - -string - Signature a ECDSA 64 bytes - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L57) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Overrides - -[Account](internal-Account.md).[simulateTransaction](internal-Account.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L96) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](internal-Account.md).[transfer](internal-Account.md#transfer) - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](internal-Account.md).[withdrawToBaseLayer](internal-Account.md#withdrawtobaselayer) - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-CreateTransactionRequest.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-CreateTransactionRequest.md deleted file mode 100644 index 17d7e593ba7..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-CreateTransactionRequest.md +++ /dev/null @@ -1,703 +0,0 @@ ---- -layout: default -title: CreateTransactionRequest -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: CreateTransactionRequest - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`CreateTransactionRequest`** - -## Constructors - -### constructor - -• **new CreateTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:528](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L528) - -## Properties - -### bytecodeWitnessIndex - -• **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:522](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L522) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### salt - -• **salt**: `string` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:524](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L524) - -___ - -### storageSlots - -• **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:526](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L526) - -___ - -### type - -• **type**: [`Create`](../namespaces/internal.md#create) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:520](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L520) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContractCreatedOutput - -▸ **addContractCreatedOutput**(`contractId`, `stateRoot`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:562](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L562) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractCreatedOutputs - -▸ **getContractCreatedOutputs**(): [`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Returns - -[`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:555](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L555) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:540](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L540) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Returns - -[`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:512](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L512) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-MnemonicVault.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-MnemonicVault.md deleted file mode 100644 index 7aa90e4dd2e..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-MnemonicVault.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -layout: default -title: MnemonicVault -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: MnemonicVault - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).MnemonicVault - -## Implements - -- [`Vault`](Vault.md)<[`MnemonicVaultOptions`](../interfaces/internal-MnemonicVaultOptions.md)\> - -## Constructors - -### constructor - -• **new MnemonicVault**(`options`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`MnemonicVaultOptions`](../interfaces/internal-MnemonicVaultOptions.md) | - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L22) - -## Properties - -### #secret - -• `Private` `Readonly` **#secret**: `string` - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L16) - -___ - -### numberOfAccounts - -• **numberOfAccounts**: `number` = `0` - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L20) - -___ - -### pathKey - -• **pathKey**: `string` = `'{}'` - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L18) - -___ - -### rootPath - -• **rootPath**: `string` - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L19) - -___ - -### type - -▪ `Static` `Readonly` **type**: ``"mnemonic"`` - -#### Implementation of - -[Vault](Vault.md).[type](Vault.md#type) - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L15) - -## Methods - -### addAccount - -▸ **addAccount**(): `Object` - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `publicKey` | `string` | - -#### Implementation of - -[Vault](Vault.md).[addAccount](Vault.md#addaccount) - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:61](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L61) - -___ - -### exportAccount - -▸ **exportAccount**(`address`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`string` - -#### Implementation of - -[Vault](Vault.md).[exportAccount](Vault.md#exportaccount) - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:71](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L71) - -___ - -### getAccounts - -▸ **getAccounts**(): { `address`: [`AbstractAddress`](internal-AbstractAddress.md) = wallet.address; `publicKey`: `string` = wallet.publicKey }[] - -#### Returns - -{ `address`: [`AbstractAddress`](internal-AbstractAddress.md) = wallet.address; `publicKey`: `string` = wallet.publicKey }[] - -#### Implementation of - -[Vault](Vault.md).[getAccounts](Vault.md#getaccounts) - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L44) - -___ - -### getDerivePath - -▸ **getDerivePath**(`index`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | - -#### Returns - -`string` - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L29) - -___ - -### getWallet - -▸ **getWallet**(`address`): [`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -[`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Implementation of - -[Vault](Vault.md).[getWallet](Vault.md#getwallet) - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:86](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L86) - -___ - -### serialize - -▸ **serialize**(): [`MnemonicVaultOptions`](../interfaces/internal-MnemonicVaultOptions.md) - -#### Returns - -[`MnemonicVaultOptions`](../interfaces/internal-MnemonicVaultOptions.md) - -#### Implementation of - -[Vault](Vault.md).[serialize](Vault.md#serialize) - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L36) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-PrivateKeyVault.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-PrivateKeyVault.md deleted file mode 100644 index c06a49fa809..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-PrivateKeyVault.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -layout: default -title: PrivateKeyVault -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: PrivateKeyVault - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).PrivateKeyVault - -## Implements - -- [`Vault`](Vault.md)<[`PkVaultOptions`](../interfaces/internal-PkVaultOptions.md)\> - -## Constructors - -### constructor - -• **new PrivateKeyVault**(`options`) - -If privateKey vault is initialized with a secretKey, it creates -one account with the fallowing secret - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`PkVaultOptions`](../interfaces/internal-PkVaultOptions.md) | - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L21) - -## Properties - -### #privateKeys - -• `Private` **#privateKeys**: `string`[] = `[]` - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L15) - -___ - -### type - -▪ `Static` `Readonly` **type**: ``"privateKey"`` - -#### Implementation of - -[Vault](Vault.md).[type](Vault.md#type) - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L13) - -## Methods - -### addAccount - -▸ **addAccount**(): `Object` - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `publicKey` | `string` | - -#### Implementation of - -[Vault](Vault.md).[addAccount](Vault.md#addaccount) - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L47) - -___ - -### exportAccount - -▸ **exportAccount**(`address`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`string` - -#### Implementation of - -[Vault](Vault.md).[exportAccount](Vault.md#exportaccount) - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L55) - -___ - -### getAccounts - -▸ **getAccounts**(): [`Account`](../index.md#account)[] - -#### Returns - -[`Account`](../index.md#account)[] - -#### Implementation of - -[Vault](Vault.md).[getAccounts](Vault.md#getaccounts) - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L43) - -___ - -### getPublicAccount - -▸ **getPublicAccount**(`privateKey`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `string` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `publicKey` | `string` | - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L35) - -___ - -### getWallet - -▸ **getWallet**(`address`): [`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -[`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Implementation of - -[Vault](Vault.md).[getWallet](Vault.md#getwallet) - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:67](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L67) - -___ - -### serialize - -▸ **serialize**(): [`PkVaultOptions`](../interfaces/internal-PkVaultOptions.md) - -#### Returns - -[`PkVaultOptions`](../interfaces/internal-PkVaultOptions.md) - -#### Implementation of - -[Vault](Vault.md).[serialize](Vault.md#serialize) - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L29) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-ScriptTransactionRequest.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-ScriptTransactionRequest.md deleted file mode 100644 index 8a43c632794..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-ScriptTransactionRequest.md +++ /dev/null @@ -1,797 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequest -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: ScriptTransactionRequest - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`ScriptTransactionRequest`** - -## Constructors - -### constructor - -• **new ScriptTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:406](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L406) - -## Properties - -### bytesOffset - -• **bytesOffset**: `undefined` \| `number` - -determined bytes offset for start of script data - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:404](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L404) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### script - -• **script**: `Uint8Array` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:400](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L400) - -___ - -### scriptData - -• **scriptData**: `Uint8Array` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:402](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L402) - -___ - -### type - -• **type**: [`Script`](../namespaces/internal.md#script) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:398](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L398) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContract - -▸ **addContract**(`contract`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | [`ContractIdLike`](../namespaces/internal.md#contractidlike) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:481](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L481) - -___ - -### addMessageOutputs - -▸ **addMessageOutputs**(`numberOfMessages?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfMessages` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:466](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L466) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### addVariableOutputs - -▸ **addVariableOutputs**(`numberOfVariables?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfVariables` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:453](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L453) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractInputs - -▸ **getContractInputs**(): [`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Returns - -[`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:426](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L426) - -___ - -### getContractOutputs - -▸ **getContractOutputs**(): [`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Returns - -[`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:432](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L432) - -___ - -### getVariableOutputs - -▸ **getVariableOutputs**(): [`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Returns - -[`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:438](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L438) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### setScript - -▸ **setScript**<`T`\>(`script`, `data`): `void` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `script` | [`AbstractScriptRequest`](internal-AbstractScriptRequest.md)<`T`\> | -| `data` | `T` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:444](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L444) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:412](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L412) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Returns - -[`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:390](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L390) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-Signer.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-Signer.md deleted file mode 100644 index 3ab416f8486..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-Signer.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -layout: default -title: Signer -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: Signer - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).Signer - -## Constructors - -### constructor - -• **new Signer**(`privateKey`) - -Create a Signer instance from a given private key - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `privateKey` | `BytesLike` | The private key to use for signing | - -#### Defined in - -[packages/signer/src/signer.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L31) - -## Properties - -### address - -• `Readonly` **address**: `default` - -#### Defined in - -[packages/signer/src/signer.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L17) - -___ - -### compressedPublicKey - -• `Readonly` **compressedPublicKey**: `string` - -#### Defined in - -[packages/signer/src/signer.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L21) - -___ - -### privateKey - -• `Readonly` **privateKey**: `string` - -#### Defined in - -[packages/signer/src/signer.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L23) - -___ - -### publicKey - -• `Readonly` **publicKey**: `string` - -#### Defined in - -[packages/signer/src/signer.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L19) - -## Methods - -### addPoint - -▸ **addPoint**(`point`): `string` - -Add point on the current elliptic curve - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `point` | `BytesLike` | Point to add on the curve | - -#### Returns - -`string` - -compressed point on the curve - -#### Defined in - -[packages/signer/src/signer.ts:80](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L80) - -___ - -### sign - -▸ **sign**(`data`): `string` - -Sign data using the Signer instance - -Signature is a 64 byte array of the concatenated r and s values with the compressed recoveryParam byte. [Read more](FuelLabs/fuel-specs/specs/protocol/cryptographic_primitives.md#public-key-cryptography) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | The data to be sign | - -#### Returns - -`string` - -hashed signature - -#### Defined in - -[packages/signer/src/signer.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L60) - -___ - -### extendPublicKey - -▸ `Static` **extendPublicKey**(`publicKey`): `string` - -Extended publicKey from a compact publicKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `publicKey` | `BytesLike` | Compact publicKey | - -#### Returns - -`string` - -extended publicKey - -#### Defined in - -[packages/signer/src/signer.ts:139](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L139) - -___ - -### generatePrivateKey - -▸ `Static` **generatePrivateKey**(`entropy?`): `string` \| `Uint8Array` - -Generate a random privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `entropy?` | `BytesLike` | Adds extra entropy to generate the privateKey | - -#### Returns - -`string` \| `Uint8Array` - -random 32-byte hashed - -#### Defined in - -[packages/signer/src/signer.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L129) - -___ - -### recoverAddress - -▸ `Static` **recoverAddress**(`data`, `signature`): `default` - -Recover the address from a signature performed with [`sign`](#sign). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | Data | -| `signature` | `BytesLike` | Signature | - -#### Returns - -`default` - -Address from signature - -#### Defined in - -[packages/signer/src/signer.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L119) - -___ - -### recoverPublicKey - -▸ `Static` **recoverPublicKey**(`data`, `signature`): `any` - -Recover the public key from a signature performed with [`sign`](#sign). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | Data | -| `signature` | `BytesLike` | hashed signature | - -#### Returns - -`any` - -public key from signature from the - -#### Defined in - -[packages/signer/src/signer.ts:95](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L95) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-TransactionResponse.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-TransactionResponse.md deleted file mode 100644 index 84d73ede578..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-TransactionResponse.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -layout: default -title: TransactionResponse -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: TransactionResponse - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).TransactionResponse - -## Constructors - -### constructor - -• **new TransactionResponse**(`id`, `provider`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `provider` | `default` | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L102) - -## Properties - -### attempts - -• **attempts**: `number` = `0` - -Number off attempts to get the committed tx - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L100) - -___ - -### gasUsed - -• **gasUsed**: [`BN`](internal-BN.md) - -Gas used on the transaction - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L98) - -___ - -### id - -• **id**: `string` - -Transaction ID - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L94) - -___ - -### provider - -• **provider**: `default` - -Current provider - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L96) - -## Methods - -### decodeTransaction - -▸ **decodeTransaction**<`TTransactionType`\>(`transactionWithReceipts`): [`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionWithReceipts` | `Object` | -| `transactionWithReceipts.__typename` | ``"Transaction"`` | -| `transactionWithReceipts.gasPrice?` | ``null`` \| `string` | -| `transactionWithReceipts.id` | `string` | -| `transactionWithReceipts.rawPayload` | `string` | -| `transactionWithReceipts.receipts?` | ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] | -| `transactionWithReceipts.status?` | ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } | - -#### Returns - -[`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:114](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L114) - -___ - -### fetch - -▸ **fetch**(): `Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Returns - -`Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L107) - -___ - -### wait - -▸ **wait**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -Waits for transaction to succeed and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:188](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L188) - -___ - -### waitForResult - -▸ **waitForResult**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -Waits for transaction to succeed or fail and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:124](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L124) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-WalletLocked.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-WalletLocked.md deleted file mode 100644 index b4a38f6a74a..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-WalletLocked.md +++ /dev/null @@ -1,378 +0,0 @@ ---- -layout: default -title: WalletLocked -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: WalletLocked - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).WalletLocked - -WalletLocked - -## Hierarchy - -- [`Account`](internal-Account.md) - - ↳ **`WalletLocked`** - -## Constructors - -### constructor - -• **new WalletLocked**(`address`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Inherited from - -[Account](internal-Account.md).[constructor](internal-Account.md#constructor) - -#### Defined in - -[packages/wallet/src/account.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L39) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Inherited from - -[Account](internal-Account.md).[address](internal-Account.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Inherited from - -[Account](internal-Account.md).[provider](internal-Account.md#provider) - -#### Defined in - -[packages/wallet/src/account.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Inherited from - -[Account](internal-Account.md).[connect](internal-Account.md#connect) - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[Account](internal-Account.md).[fund](internal-Account.md#fund) - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Inherited from - -[Account](internal-Account.md).[getBalance](internal-Account.md#getbalance) - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getBalances](internal-Account.md#getbalances) - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getCoins](internal-Account.md#getcoins) - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getMessages](internal-Account.md#getmessages) - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Inherited from - -[Account](internal-Account.md).[getResourcesToSpend](internal-Account.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Inherited from - -[Account](internal-Account.md).[sendTransaction](internal-Account.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/account.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L253) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Inherited from - -[Account](internal-Account.md).[simulateTransaction](internal-Account.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/account.ts:267](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L267) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](internal-Account.md).[transfer](internal-Account.md#transfer) - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### unlock - -▸ **unlock**(`privateKey`): [`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `BytesLike` | - -#### Returns - -[`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L20) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](internal-Account.md).[withdrawToBaseLayer](internal-Account.md#withdrawtobaselayer) - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-wallet-manager/classes/internal-WalletUnlocked.md b/docs/packages/fuel-ts-wallet-manager/classes/internal-WalletUnlocked.md deleted file mode 100644 index b39367c93c0..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/classes/internal-WalletUnlocked.md +++ /dev/null @@ -1,620 +0,0 @@ ---- -layout: default -title: WalletUnlocked -parent: "@fuel-ts/wallet-manager" -nav_order: 1 - ---- - -# Class: WalletUnlocked - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).WalletUnlocked - -WalletUnlocked - -## Hierarchy - -- [`BaseWalletUnlocked`](internal-BaseWalletUnlocked.md) - - ↳ **`WalletUnlocked`** - -## Constructors - -### constructor - -• **new WalletUnlocked**(`privateKey`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `privateKey` | `BytesLike` | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[constructor](internal-BaseWalletUnlocked.md#constructor) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L26) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[address](internal-BaseWalletUnlocked.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[provider](internal-BaseWalletUnlocked.md#provider) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L22) - -___ - -### signer - -• **signer**: () => [`Signer`](internal-Signer.md) - -#### Type declaration - -▸ (): [`Signer`](internal-Signer.md) - -##### Returns - -[`Signer`](internal-Signer.md) - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[signer](internal-BaseWalletUnlocked.md#signer) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L24) - -___ - -### defaultPath - -▪ `Static` **defaultPath**: `string` = `"m/44'/1179993420'/0'/0/0"` - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[defaultPath](internal-BaseWalletUnlocked.md#defaultpath) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L20) - -## Accessors - -### privateKey - -• `get` **privateKey**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseWalletUnlocked.privateKey - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L33) - -___ - -### publicKey - -• `get` **publicKey**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseWalletUnlocked.publicKey - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[connect](internal-BaseWalletUnlocked.md#connect) - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[fund](internal-BaseWalletUnlocked.md#fund) - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[getBalance](internal-BaseWalletUnlocked.md#getbalance) - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[getBalances](internal-BaseWalletUnlocked.md#getbalances) - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[getCoins](internal-BaseWalletUnlocked.md#getcoins) - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[getMessages](internal-BaseWalletUnlocked.md#getmessages) - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[getResourcesToSpend](internal-BaseWalletUnlocked.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### lock - -▸ **lock**(): [`WalletLocked`](internal-WalletLocked.md) - -#### Returns - -[`WalletLocked`](internal-WalletLocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L30) - -___ - -### populateTransactionWitnessesSignature - -▸ **populateTransactionWitnessesSignature**(`transactionRequestLike`): `Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[populateTransactionWitnessesSignature](internal-BaseWalletUnlocked.md#populatetransactionwitnessessignature) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L65) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[sendTransaction](internal-BaseWalletUnlocked.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:80](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L80) - -___ - -### signMessage - -▸ **signMessage**(`message`): `Promise`<`string`\> - -Sign message with wallet instance privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `message` | `string` | Message | - -#### Returns - -`Promise`<`string`\> - -Promise - Signature a ECDSA 64 bytes - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[signMessage](internal-BaseWalletUnlocked.md#signmessage) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L47) - -___ - -### signTransaction - -▸ **signTransaction**(`transactionRequestLike`): `Promise`<`string`\> - -Sign transaction with wallet instance privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | TransactionRequestLike | - -#### Returns - -`Promise`<`string`\> - -string - Signature a ECDSA 64 bytes - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[signTransaction](internal-BaseWalletUnlocked.md#signtransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L57) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[simulateTransaction](internal-BaseWalletUnlocked.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L96) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[transfer](internal-BaseWalletUnlocked.md#transfer) - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[BaseWalletUnlocked](internal-BaseWalletUnlocked.md).[withdrawToBaseLayer](internal-BaseWalletUnlocked.md#withdrawtobaselayer) - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) - -___ - -### fromExtendedKey - -▸ `Static` **fromExtendedKey**(`extendedKey`, `provider?`): [`WalletUnlocked`](internal-WalletUnlocked.md) - -Create Wallet Unlocked from extended key - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `extendedKey` | `string` | -| `provider?` | `default` | - -#### Returns - -[`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:76](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L76) - -___ - -### fromMnemonic - -▸ `Static` **fromMnemonic**(`mnemonic`, `path?`, `passphrase?`, `provider?`): [`WalletUnlocked`](internal-WalletUnlocked.md) - -Create Wallet Unlocked from mnemonic phrase - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `mnemonic` | `string` | -| `path?` | `string` | -| `passphrase?` | `BytesLike` | -| `provider?` | `default` | - -#### Returns - -[`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L60) - -___ - -### fromSeed - -▸ `Static` **fromSeed**(`seed`, `path?`, `provider?`): [`WalletUnlocked`](internal-WalletUnlocked.md) - -Create Wallet Unlocked from a seed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | -| `path?` | `string` | -| `provider?` | `default` | - -#### Returns - -[`WalletUnlocked`](internal-WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:50](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L50) - -___ - -### generate - -▸ `Static` **generate**(`generateOptions?`): [`WalletUnlocked`](internal-WalletUnlocked.md) - -Generate a new Wallet Unlocked with a random keyPair - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `generateOptions?` | [`GenerateOptions`](../interfaces/internal-GenerateOptions.md) | - -#### Returns - -[`WalletUnlocked`](internal-WalletUnlocked.md) - -wallet - Wallet instance - -#### Defined in - -[packages/wallet/src/wallets.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L41) diff --git a/docs/packages/fuel-ts-wallet-manager/enums/internal-GqlCoinStatus.md b/docs/packages/fuel-ts-wallet-manager/enums/internal-GqlCoinStatus.md deleted file mode 100644 index cb54c6f10a4..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/enums/internal-GqlCoinStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlCoinStatus -parent: "@fuel-ts/wallet-manager" -nav_order: 4 - ---- - -# Enumeration: GqlCoinStatus - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).GqlCoinStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:157 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:158 diff --git a/docs/packages/fuel-ts-wallet-manager/enums/internal-GqlMessageStatus.md b/docs/packages/fuel-ts-wallet-manager/enums/internal-GqlMessageStatus.md deleted file mode 100644 index f59565f3415..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/enums/internal-GqlMessageStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlMessageStatus -parent: "@fuel-ts/wallet-manager" -nav_order: 4 - ---- - -# Enumeration: GqlMessageStatus - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).GqlMessageStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:373 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:374 diff --git a/docs/packages/fuel-ts-wallet-manager/enums/internal-GqlReturnType.md b/docs/packages/fuel-ts-wallet-manager/enums/internal-GqlReturnType.md deleted file mode 100644 index dc6e74c6714..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/enums/internal-GqlReturnType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: GqlReturnType -parent: "@fuel-ts/wallet-manager" -nav_order: 4 - ---- - -# Enumeration: GqlReturnType - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).GqlReturnType - -## Enumeration Members - -### Return - -• **Return** = ``"RETURN"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:688 - -___ - -### ReturnData - -• **ReturnData** = ``"RETURN_DATA"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:689 - -___ - -### Revert - -• **Revert** = ``"REVERT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:690 diff --git a/docs/packages/fuel-ts-wallet-manager/enums/internal-TransactionType.md b/docs/packages/fuel-ts-wallet-manager/enums/internal-TransactionType.md deleted file mode 100644 index 1593b143410..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/enums/internal-TransactionType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: TransactionType -parent: "@fuel-ts/wallet-manager" -nav_order: 4 - ---- - -# Enumeration: TransactionType - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).TransactionType - -## Enumeration Members - -### Create - -• **Create** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Mint - -• **Mint** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L22) - -___ - -### Script - -• **Script** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) diff --git a/docs/packages/fuel-ts-wallet-manager/index.md b/docs/packages/fuel-ts-wallet-manager/index.md deleted file mode 100644 index 172f2c616dc..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -layout: default -title: "@fuel-ts/wallet-manager" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/wallet-manager - -## Namespaces - -- [internal](namespaces/internal.md) - -## Classes - -- [StorageAbstract](classes/StorageAbstract.md) -- [Vault](classes/Vault.md) -- [WalletManager](classes/WalletManager.md) - -## Interfaces - -- [WalletManagerState](interfaces/WalletManagerState.md) - -## Type Aliases - -### Account - -Ƭ **Account**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](classes/internal-AbstractAddress.md) | -| `publicKey` | `string` | -| `vaultId?` | `number` | - -#### Defined in - -[packages/wallet-manager/src/types.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L5) - -___ - -### VaultConfig - -Ƭ **VaultConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `secret?` | `string` | -| `title?` | `string` | -| `type` | `string` | - -#### Defined in - -[packages/wallet-manager/src/types.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L15) - -___ - -### VaultsState - -Ƭ **VaultsState**: { `data?`: [`VaultConfig`](index.md#vaultconfig) ; `title?`: `string` ; `type`: `string` ; `vault`: [`Vault`](classes/Vault.md) }[] - -#### Defined in - -[packages/wallet-manager/src/types.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L21) - -___ - -### WalletManagerOptions - -Ƭ **WalletManagerOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `storage` | [`StorageAbstract`](classes/StorageAbstract.md) | - -#### Defined in - -[packages/wallet-manager/src/types.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L11) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/WalletManagerState.md b/docs/packages/fuel-ts-wallet-manager/interfaces/WalletManagerState.md deleted file mode 100644 index 83bfbfa09ab..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/WalletManagerState.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: default -title: WalletManagerState -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: WalletManagerState - -[@fuel-ts/wallet-manager](../index.md).WalletManagerState - -## Properties - -### vaults - -• **vaults**: [`VaultsState`](../index.md#vaultsstate) - -#### Defined in - -[packages/wallet-manager/src/types.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/types.ts#L29) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNHelper.md deleted file mode 100644 index 331decfddb9..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index d6531ee91ff..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../namespaces/internal.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/internal-BN.md) ; `mod`: [`BN`](../classes/internal-BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/internal-BN.md) | -| `mod` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/internal-BN.md), `out`: [`BN`](../classes/internal-BN.md)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/internal-BN.md) | -| `out` | [`BN`](../classes/internal-BN.md) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index 9304d043ae8..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNOverrides.md deleted file mode 100644 index 84c421e6222..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BaseTransactionRequestLike.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BaseTransactionRequestLike.md deleted file mode 100644 index ef0b6ac4176..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-BaseTransactionRequestLike.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -layout: default -title: BaseTransactionRequestLike -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: BaseTransactionRequestLike - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequestLike - -## Hierarchy - -- **`BaseTransactionRequestLike`** - - ↳ [`ScriptTransactionRequestLike`](internal-ScriptTransactionRequestLike.md) - - ↳ [`CreateTransactionRequestLike`](internal-CreateTransactionRequestLike.md) - -## Implemented by - -- [`BaseTransactionRequest`](../classes/internal-BaseTransactionRequest.md) - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-CreateTransactionRequestLike.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-CreateTransactionRequestLike.md deleted file mode 100644 index 5ead2b9e7db..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-CreateTransactionRequestLike.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -layout: default -title: CreateTransactionRequestLike -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: CreateTransactionRequestLike - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`CreateTransactionRequestLike`** - -## Properties - -### bytecodeWitnessIndex - -• `Optional` **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:504](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L504) - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### salt - -• `Optional` **salt**: `BytesLike` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:506](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L506) - -___ - -### storageSlots - -• `Optional` **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:508](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L508) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-GenerateOptions.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-GenerateOptions.md deleted file mode 100644 index 15deb11a3bb..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-GenerateOptions.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: GenerateOptions -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: GenerateOptions - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).GenerateOptions - -## Properties - -### entropy - -• `Optional` **entropy**: `BytesLike` - -Additional entropy for the random bytes - -#### Defined in - -[packages/wallet/src/types/GenerateOptions.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/types/GenerateOptions.ts#L6) - -___ - -### provider - -• `Optional` **provider**: `string` \| `default` - -#### Defined in - -[packages/wallet/src/types/GenerateOptions.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/types/GenerateOptions.ts#L7) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-MnemonicVaultOptions.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-MnemonicVaultOptions.md deleted file mode 100644 index a1a5e19cfd7..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-MnemonicVaultOptions.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: MnemonicVaultOptions -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: MnemonicVaultOptions - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).MnemonicVaultOptions - -## Properties - -### numberOfAccounts - -• `Optional` **numberOfAccounts**: ``null`` \| `number` - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L11) - -___ - -### rootPath - -• `Optional` **rootPath**: `string` - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L10) - -___ - -### secret - -• `Optional` **secret**: `string` - -#### Defined in - -[packages/wallet-manager/src/vaults/mnemonic-vault.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/mnemonic-vault.ts#L9) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-PkVaultOptions.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-PkVaultOptions.md deleted file mode 100644 index 3f3d052b858..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-PkVaultOptions.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: PkVaultOptions -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: PkVaultOptions - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).PkVaultOptions - -## Properties - -### accounts - -• `Optional` **accounts**: `string`[] - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L9) - -___ - -### secret - -• `Optional` **secret**: `string` - -#### Defined in - -[packages/wallet-manager/src/vaults/privatekey-vault.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/vaults/privatekey-vault.ts#L8) diff --git a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-ScriptTransactionRequestLike.md b/docs/packages/fuel-ts-wallet-manager/interfaces/internal-ScriptTransactionRequestLike.md deleted file mode 100644 index ffafd0e05a5..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/interfaces/internal-ScriptTransactionRequestLike.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequestLike -parent: "@fuel-ts/wallet-manager" -nav_order: 2 - ---- - -# Interface: ScriptTransactionRequestLike - -[@fuel-ts/wallet-manager](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`ScriptTransactionRequestLike`** - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### script - -• `Optional` **script**: `BytesLike` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:384](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L384) - -___ - -### scriptData - -• `Optional` **scriptData**: `BytesLike` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:386](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L386) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-wallet-manager/namespaces/internal.md b/docs/packages/fuel-ts-wallet-manager/namespaces/internal.md deleted file mode 100644 index bdc840622ee..00000000000 --- a/docs/packages/fuel-ts-wallet-manager/namespaces/internal.md +++ /dev/null @@ -1,1460 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/wallet-manager" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/wallet-manager](../index.md).internal - -## Enumerations - -- [GqlCoinStatus](../enums/internal-GqlCoinStatus.md) -- [GqlMessageStatus](../enums/internal-GqlMessageStatus.md) -- [GqlReturnType](../enums/internal-GqlReturnType.md) -- [TransactionType](../enums/internal-TransactionType.md) - -## Classes - -- [AbstractAccount](../classes/internal-AbstractAccount.md) -- [AbstractAddress](../classes/internal-AbstractAddress.md) -- [AbstractContract](../classes/internal-AbstractContract.md) -- [AbstractProgram](../classes/internal-AbstractProgram.md) -- [AbstractScriptRequest](../classes/internal-AbstractScriptRequest.md) -- [Account](../classes/internal-Account.md) -- [BN](../classes/internal-BN.md) -- [BaseTransactionRequest](../classes/internal-BaseTransactionRequest.md) -- [BaseWalletUnlocked](../classes/internal-BaseWalletUnlocked.md) -- [CreateTransactionRequest](../classes/internal-CreateTransactionRequest.md) -- [MnemonicVault](../classes/internal-MnemonicVault.md) -- [PrivateKeyVault](../classes/internal-PrivateKeyVault.md) -- [ScriptTransactionRequest](../classes/internal-ScriptTransactionRequest.md) -- [Signer](../classes/internal-Signer.md) -- [TransactionResponse](../classes/internal-TransactionResponse.md) -- [WalletLocked](../classes/internal-WalletLocked.md) -- [WalletUnlocked](../classes/internal-WalletUnlocked.md) - -## Interfaces - -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) -- [BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md) -- [CreateTransactionRequestLike](../interfaces/internal-CreateTransactionRequestLike.md) -- [GenerateOptions](../interfaces/internal-GenerateOptions.md) -- [MnemonicVaultOptions](../interfaces/internal-MnemonicVaultOptions.md) -- [PkVaultOptions](../interfaces/internal-PkVaultOptions.md) -- [ScriptTransactionRequestLike](../interfaces/internal-ScriptTransactionRequestLike.md) - -## Enumeration Members - -### Call - -• **Call**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L10) - -___ - -### Change - -• **Change**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L10) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L15) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L7) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L16) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L8) - -___ - -### ContractCreated - -• **ContractCreated**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L12) - -___ - -### Create - -• **Create**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Log - -• **Log**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L15) - -___ - -### LogData - -• **LogData**: ``6`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L17) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L9) - -___ - -### MessageOut - -• **MessageOut**: ``10`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L20) - -___ - -### Panic - -• **Panic**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L13) - -___ - -### Return - -• **Return**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L11) - -___ - -### ReturnData - -• **ReturnData**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L12) - -___ - -### Revert - -• **Revert**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L14) - -___ - -### Script - -• **Script**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) - -___ - -### ScriptResult - -• **ScriptResult**: ``9`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L19) - -___ - -### Transfer - -• **Transfer**: ``7`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L17) - -___ - -### TransferOut - -• **TransferOut**: ``8`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L18) - -___ - -### Variable - -• **Variable**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L11) - -## Type Aliases - -### AddressLike - -Ƭ **AddressLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractAccount`](../classes/internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L55) - -___ - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### BigNumberish - -Ƭ **BigNumberish**: `string` \| `number` \| [`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/types.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L3) - -___ - -### CallResult - -Ƭ **CallResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | - -#### Defined in - -[packages/providers/src/provider.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L42) - -___ - -### ChangeTransactionRequestOutput - -Ƭ **ChangeTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L30) - -___ - -### Coin - -Ƭ **Coin**: `Object` - -A Fuel coin - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `blockCreated` | [`BN`](../classes/internal-BN.md) | -| `id` | `string` | -| `maturity` | `number` | -| `owner` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlCoinStatus`](../enums/internal-GqlCoinStatus.md) | - -#### Defined in - -[packages/providers/src/coin.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin.ts#L9) - -___ - -### CoinQuantity - -Ƭ **CoinQuantity**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `max?` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/providers/src/coin-quantity.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L10) - -___ - -### CoinQuantityLike - -Ƭ **CoinQuantityLike**: [amount: BigNumberish, assetId?: BytesLike, max?: BigNumberish] \| { `amount`: [`BigNumberish`](internal.md#bignumberish) ; `assetId?`: `BytesLike` ; `max?`: [`BigNumberish`](internal.md#bignumberish) } - -#### Defined in - -[packages/providers/src/coin-quantity.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L7) - -___ - -### CoinTransactionRequestInput - -Ƭ **CoinTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `assetId` | `BytesLike` | Asset ID of the coins | -| `id` | `BytesLike` | UTXO ID | -| `maturity?` | `number` | UTXO being spent must have been created at least this many blocks ago | -| `owner` | `BytesLike` | Owning address or script hash | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L9) - -___ - -### CoinTransactionRequestOutput - -Ƭ **CoinTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins to send | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L9) - -___ - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) - -___ - -### ContractCreatedTransactionRequestOutput - -Ƭ **ContractCreatedTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L40) - -___ - -### ContractIdLike - -Ƭ **ContractIdLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractContract`](../classes/internal-AbstractContract.md) - -#### Defined in - -[packages/interfaces/src/index.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L57) - -___ - -### ContractTransactionRequestInput - -Ƭ **ContractTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L66) - -___ - -### ContractTransactionRequestOutput - -Ƭ **ContractTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `inputIndex` | `number` | Index of input contract | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L18) - -___ - -### ExcludeResourcesOption - -Ƭ **ExcludeResourcesOption**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `messages?` | `BytesLike`[] | -| `utxos?` | `BytesLike`[] | - -#### Defined in - -[packages/providers/src/resource.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L36) - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](internal.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### Input - -Ƭ **Input**: [`InputCoin`](internal.md#inputcoin) \| [`InputContract`](internal.md#inputcontract) \| [`InputMessage`](internal.md#inputmessage) - -#### Defined in - -[packages/transactions/src/coders/input.ts:324](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L324) - -___ - -### InputCoin - -Ƭ **InputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins (u64) | -| `assetId` | `string` | Asset ID of the coins (b256) | -| `maturity` | `number` | UTXO being spent must have been created at least this many blocks ago (u32) | -| `owner` | `string` | Owning address or script hash (b256) | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L20) - -___ - -### InputContract - -Ƭ **InputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract before transaction execution (b256) | -| `contractID` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract before transaction execution (b256) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L131) - -___ - -### InputMessage - -Ƭ **InputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins | -| `data` | `string` | data of message | -| `dataLength` | `number` | Length of predicate, in instructions (u16) | -| `nonce` | [`BN`](../classes/internal-BN.md) | Unique nonce of message | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `recipient` | `string` | Address of sender | -| `sender` | `string` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes message (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:196](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L196) - -___ - -### Message - -Ƭ **Message**: `Object` - -A Fuel message - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `daHeight` | [`BN`](../classes/internal-BN.md) | -| `data` | `BytesLike` | -| `nonce` | [`BN`](../classes/internal-BN.md) | -| `recipient` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `sender` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlMessageStatus`](../enums/internal-GqlMessageStatus.md) | - -#### Defined in - -[packages/providers/src/message.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/message.ts#L11) - -___ - -### MessageTransactionRequestInput - -Ƭ **MessageTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `data` | `BytesLike` | data of message | -| `nonce` | [`BigNumberish`](internal.md#bignumberish) | Unique nonce of message | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `recipient` | `BytesLike` | Address of sender | -| `sender` | `BytesLike` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes the message | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L39) - -___ - -### MessageTransactionRequestOutput - -Ƭ **MessageTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins sent with message | -| `recipient` | `BytesLike` | Receiving address | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L23) - -___ - -### Output - -Ƭ **Output**: [`OutputCoin`](internal.md#outputcoin) \| [`OutputContract`](internal.md#outputcontract) \| [`OutputMessage`](internal.md#outputmessage) \| [`OutputChange`](internal.md#outputchange) \| [`OutputVariable`](internal.md#outputvariable) \| [`OutputContractCreated`](internal.md#outputcontractcreated) - -#### Defined in - -[packages/transactions/src/coders/output.ts:294](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L294) - -___ - -### OutputChange - -Ƭ **OutputChange**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:153](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L153) - -___ - -### OutputCoin - -Ƭ **OutputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L15) - -___ - -### OutputContract - -Ƭ **OutputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract after transaction execution (b256) | -| `inputIndex` | `number` | Index of input contract (u8) | -| `stateRoot` | `string` | State root of contract after transaction execution (b256) | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L63) - -___ - -### OutputContractCreated - -Ƭ **OutputContractCreated**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract (b256) | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:249](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L249) - -___ - -### OutputMessage - -Ƭ **OutputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send with message (u64) | -| `recipient` | `string` | Receiving address (b256) | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:111](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L111) - -___ - -### OutputVariable - -Ƭ **OutputVariable**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Variable`](internal.md#variable) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:201](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L201) - -___ - -### PossibleTransactions - -Ƭ **PossibleTransactions**: [`TransactionScript`](internal.md#transactionscript) \| [`TransactionCreate`](internal.md#transactioncreate) \| [`TransactionMint`](internal.md#transactionmint) - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:347](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L347) - -___ - -### ReceiptCall - -Ƭ **ReceiptCall**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to forward, i.e. $rB (u64) | -| `assetId` | `string` | Asset ID of coins to forward, i.e. MEM[$rC, 32] (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `gas` | [`BN`](../classes/internal-BN.md) | Gas to forward, i.e. $rD (u64) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `param1` | [`BN`](../classes/internal-BN.md) | First parameter (u64) | -| `param2` | [`BN`](../classes/internal-BN.md) | Second parameter (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of called contract (b256) | -| `type` | [`Call`](internal.md#call) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L23) - -___ - -### ReceiptLog - -Ƭ **ReceiptLog**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Log`](internal.md#log) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `val2` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `val3` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:341](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L341) - -___ - -### ReceiptLogData - -Ƭ **ReceiptLogData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rC, $rD] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `type` | [`LogData`](internal.md#logdata) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:413](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L413) - -___ - -### ReceiptMessageOut - -Ƭ **ReceiptMessageOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Hexadecimal string representation of a 64-bit unsigned integer; value of register $rD | -| `data` | `Uint8Array` | Hexadecimal string representation of the value of the memory range MEM[$rA + 32, $rB] | -| `digest` | `string` | Hexadecimal string representation of 256-bit (32-byte), hash of MEM[$rA + 32, $rB] | -| `messageID` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message ID | -| `nonce` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message nonce | -| `recipient` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message recipient: MEM[$rA, 32] | -| `sender` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message sender: MEM[$fp, 32] | -| `type` | [`MessageOut`](internal.md#messageout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:665](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L665) - -___ - -### ReceiptPanic - -Ƭ **ReceiptPanic**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Value of optional contract ID | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `reason` | [`BN`](../classes/internal-BN.md) | Panic reason (u64) | -| `type` | [`Panic`](internal.md#panic) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:227](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L227) - -___ - -### ReceiptReturn - -Ƭ **ReceiptReturn**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Return`](internal.md#return) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L107) - -___ - -### ReceiptReturnData - -Ƭ **ReceiptReturnData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rA, $rB] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `type` | [`ReturnData`](internal.md#returndata) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:161](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L161) - -___ - -### ReceiptRevert - -Ƭ **ReceiptRevert**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Revert`](internal.md#revert) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:287](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L287) - -___ - -### ReceiptScriptResult - -Ƭ **ReceiptScriptResult**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | Gas consumed by the script (u64) | -| `result` | [`BN`](../classes/internal-BN.md) | Result variant with embedded `PanicReason` in first 8 bits and `instr` (u64) | -| `type` | [`ScriptResult`](internal.md#scriptresult) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:623](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L623) - -___ - -### ReceiptTransfer - -Ƭ **ReceiptTransfer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of contract to transfer coins to (b256) | -| `type` | [`Transfer`](internal.md#transfer) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:491](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L491) - -___ - -### ReceiptTransferOut - -Ƭ **ReceiptTransferOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Address to transfer coins to (b256) | -| `type` | [`TransferOut`](internal.md#transferout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:557](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L557) - -___ - -### Resource - -Ƭ **Resource**: [`Coin`](internal.md#coin-2) \| [`Message`](internal.md#message-2) - -#### Defined in - -[packages/providers/src/resource.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L32) - -___ - -### StorageSlot - -Ƭ **StorageSlot**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Key (b256) | -| `value` | `string` | Value (b256) | - -#### Defined in - -[packages/transactions/src/coders/storage-slot.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/storage-slot.ts#L3) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) - -___ - -### Transaction - -Ƭ **Transaction**<`TTransactionType`\>: `TTransactionType` extends [`TransactionType`](../enums/internal-TransactionType.md) ? `Extract`<[`PossibleTransactions`](internal.md#possibletransactions), { `type`: `TTransactionType` }\> : `Partial`<`Omit`<[`TransactionScript`](internal.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](internal.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](internal.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/internal-TransactionType.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:348](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L348) - -___ - -### TransactionCreate - -Ƭ **TransactionCreate**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bytecodeLength` | `number` | Contract bytecode length, in instructions (u16) | -| `bytecodeWitnessIndex` | `number` | Witness index of contract bytecode to create (u8) | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `salt` | `string` | Salt (b256) | -| `storageSlots` | [`StorageSlot`](internal.md#storageslot)[] | List of inputs (StorageSlot[]) | -| `storageSlotsCount` | `number` | Number of storage slots to initialize (u16) | -| `type` | [`Create`](internal.md#create) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L159) - -___ - -### TransactionMint - -Ƭ **TransactionMint**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | The location of the Mint transaction in the block. | -| `type` | [`Mint`](../enums/internal-TransactionType.md#mint) | - | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:297](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L297) - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: [`ScriptTransactionRequest`](../classes/internal-ScriptTransactionRequest.md) \| [`CreateTransactionRequest`](../classes/internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:576](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L576) - -___ - -### TransactionRequestInput - -Ƭ **TransactionRequestInput**: [`CoinTransactionRequestInput`](internal.md#cointransactionrequestinput) \| [`ContractTransactionRequestInput`](internal.md#contracttransactionrequestinput) \| [`MessageTransactionRequestInput`](internal.md#messagetransactionrequestinput) - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:75](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L75) - -___ - -### TransactionRequestLike - -Ƭ **TransactionRequestLike**: { `type`: [`Script`](internal.md#script) } & [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) \| { `type`: [`Create`](internal.md#create) } & [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:577](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L577) - -___ - -### TransactionRequestOutput - -Ƭ **TransactionRequestOutput**: [`CoinTransactionRequestOutput`](internal.md#cointransactionrequestoutput) \| [`ContractTransactionRequestOutput`](internal.md#contracttransactionrequestoutput) \| [`MessageTransactionRequestOutput`](internal.md#messagetransactionrequestoutput) \| [`ChangeTransactionRequestOutput`](internal.md#changetransactionrequestoutput) \| [`VariableTransactionRequestOutput`](internal.md#variabletransactionrequestoutput) \| [`ContractCreatedTransactionRequestOutput`](internal.md#contractcreatedtransactionrequestoutput) - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L47) - -___ - -### TransactionRequestStorageSlot - -Ƭ **TransactionRequestStorageSlot**: { `key`: `BytesLike` ; `value`: `BytesLike` } \| [key: BytesLike, value: BytesLike] - -#### Defined in - -[packages/providers/src/transaction-request/storage-slot.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/storage-slot.ts#L5) - -___ - -### TransactionResult - -Ƭ **TransactionResult**<`TStatus`, `TTransactionType`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TStatus` | extends ``"success"`` \| ``"failure"`` | -| `TTransactionType` | `void` | - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockId` | `any` | - | -| `fee` | [`BN`](../classes/internal-BN.md) | - | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | - | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | Receipts produced during the execution of the transaction | -| `status` | `TStatus` extends ``"success"`` ? { `programState`: `any` ; `type`: ``"success"`` } : { `reason`: `any` ; `type`: ``"failure"`` } | - | -| `time` | `any` | - | -| `transaction` | [`Transaction`](internal.md#transaction)<`TTransactionType`\> | - | -| `transactionId` | `string` | - | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L54) - -___ - -### TransactionResultCallReceipt - -Ƭ **TransactionResultCallReceipt**: [`ReceiptCall`](internal.md#receiptcall) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L29) - -___ - -### TransactionResultLogDataReceipt - -Ƭ **TransactionResultLogDataReceipt**: [`ReceiptLogData`](internal.md#receiptlogdata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L35) - -___ - -### TransactionResultLogReceipt - -Ƭ **TransactionResultLogReceipt**: [`ReceiptLog`](internal.md#receiptlog) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L34) - -___ - -### TransactionResultMessageOutReceipt - -Ƭ **TransactionResultMessageOutReceipt**: [`ReceiptMessageOut`](internal.md#receiptmessageout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L39) - -___ - -### TransactionResultPanicReceipt - -Ƭ **TransactionResultPanicReceipt**: [`ReceiptPanic`](internal.md#receiptpanic) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L32) - -___ - -### TransactionResultReceipt - -Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](internal.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](internal.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](internal.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](internal.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](internal.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](internal.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](internal.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](internal.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](internal.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](internal.md#transactionresultscriptresultreceipt) \| [`TransactionResultMessageOutReceipt`](internal.md#transactionresultmessageoutreceipt) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L41) - -___ - -### TransactionResultReturnDataReceipt - -Ƭ **TransactionResultReturnDataReceipt**: [`ReceiptReturnData`](internal.md#receiptreturndata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L31) - -___ - -### TransactionResultReturnReceipt - -Ƭ **TransactionResultReturnReceipt**: [`ReceiptReturn`](internal.md#receiptreturn) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L30) - -___ - -### TransactionResultRevertReceipt - -Ƭ **TransactionResultRevertReceipt**: [`ReceiptRevert`](internal.md#receiptrevert) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L33) - -___ - -### TransactionResultScriptResultReceipt - -Ƭ **TransactionResultScriptResultReceipt**: [`ReceiptScriptResult`](internal.md#receiptscriptresult) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L38) - -___ - -### TransactionResultTransferOutReceipt - -Ƭ **TransactionResultTransferOutReceipt**: [`ReceiptTransferOut`](internal.md#receipttransferout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L37) - -___ - -### TransactionResultTransferReceipt - -Ƭ **TransactionResultTransferReceipt**: [`ReceiptTransfer`](internal.md#receipttransfer) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L36) - -___ - -### TransactionScript - -Ƭ **TransactionScript**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `receiptsRoot` | `string` | Merkle root of receipts (b256) | -| `script` | `string` | Script to execute (byte[]) | -| `scriptData` | `string` | Script input data (parameters) (byte[]) | -| `scriptDataLength` | `number` | Length of script input data, in bytes (u16) | -| `scriptLength` | `number` | Script length, in instructions (u16) | -| `type` | [`Script`](internal.md#script) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L25) - -___ - -### TxPointer - -Ƭ **TxPointer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockHeight` | `number` | Block height (u32) | -| `txIndex` | `number` | Transaction index (u16) | - -#### Defined in - -[packages/transactions/src/coders/tx-pointer.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/tx-pointer.ts#L3) - -___ - -### UtxoId - -Ƭ **UtxoId**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputIndex` | `number` | Output index (u8) | -| `transactionId` | `string` | Transaction ID (b256) | - -#### Defined in - -[packages/transactions/src/coders/utxo-id.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L3) - -___ - -### VariableTransactionRequestOutput - -Ƭ **VariableTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `type` | [`Variable`](internal.md#variable) | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L37) - -___ - -### Witness - -Ƭ **Witness**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `string` | Witness data (byte[]) | -| `dataLength` | `number` | Length of witness data, in bytes (u32) | - -#### Defined in - -[packages/transactions/src/coders/witness.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L6) diff --git a/docs/packages/fuel-ts-wallet/classes/Account.md b/docs/packages/fuel-ts-wallet/classes/Account.md deleted file mode 100644 index fdfb49dfc43..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/Account.md +++ /dev/null @@ -1,330 +0,0 @@ ---- -layout: default -title: Account -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: Account - -[@fuel-ts/wallet](../index.md).Account - -Account - -## Hierarchy - -- [`AbstractAccount`](internal-AbstractAccount.md) - - ↳ **`Account`** - - ↳↳ [`BaseWalletUnlocked`](BaseWalletUnlocked.md) - - ↳↳ [`WalletLocked`](WalletLocked.md) - -## Constructors - -### constructor - -• **new Account**(`address`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[constructor](internal-AbstractAccount.md#constructor) - -#### Defined in - -[packages/wallet/src/account.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L39) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[address](internal-AbstractAccount.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[provider](internal-AbstractAccount.md#provider) - -#### Defined in - -[packages/wallet/src/account.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[getResourcesToSpend](internal-AbstractAccount.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[sendTransaction](internal-AbstractAccount.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/account.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L253) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Overrides - -[AbstractAccount](internal-AbstractAccount.md).[simulateTransaction](internal-AbstractAccount.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/account.ts:267](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L267) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-wallet/classes/BaseWalletUnlocked.md b/docs/packages/fuel-ts-wallet/classes/BaseWalletUnlocked.md deleted file mode 100644 index c663125d101..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/BaseWalletUnlocked.md +++ /dev/null @@ -1,484 +0,0 @@ ---- -layout: default -title: BaseWalletUnlocked -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: BaseWalletUnlocked - -[@fuel-ts/wallet](../index.md).BaseWalletUnlocked - -BaseWalletUnlocked - -## Hierarchy - -- [`Account`](Account.md) - - ↳ **`BaseWalletUnlocked`** - - ↳↳ [`WalletUnlocked`](WalletUnlocked.md) - -## Constructors - -### constructor - -• **new BaseWalletUnlocked**(`privateKey`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `privateKey` | `BytesLike` | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Overrides - -[Account](Account.md).[constructor](Account.md#constructor) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L26) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Inherited from - -[Account](Account.md).[address](Account.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Overrides - -[Account](Account.md).[provider](Account.md#provider) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L22) - -___ - -### signer - -• **signer**: () => [`Signer`](internal-Signer.md) - -#### Type declaration - -▸ (): [`Signer`](internal-Signer.md) - -##### Returns - -[`Signer`](internal-Signer.md) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L24) - -___ - -### defaultPath - -▪ `Static` **defaultPath**: `string` = `"m/44'/1179993420'/0'/0/0"` - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L20) - -## Accessors - -### privateKey - -• `get` **privateKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L33) - -___ - -### publicKey - -• `get` **publicKey**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Inherited from - -[Account](Account.md).[connect](Account.md#connect) - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[Account](Account.md).[fund](Account.md#fund) - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Inherited from - -[Account](Account.md).[getBalance](Account.md#getbalance) - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Inherited from - -[Account](Account.md).[getBalances](Account.md#getbalances) - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Inherited from - -[Account](Account.md).[getCoins](Account.md#getcoins) - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Inherited from - -[Account](Account.md).[getMessages](Account.md#getmessages) - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Inherited from - -[Account](Account.md).[getResourcesToSpend](Account.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### populateTransactionWitnessesSignature - -▸ **populateTransactionWitnessesSignature**(`transactionRequestLike`): `Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L65) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Overrides - -[Account](Account.md).[sendTransaction](Account.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:80](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L80) - -___ - -### signMessage - -▸ **signMessage**(`message`): `Promise`<`string`\> - -Sign message with wallet instance privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `message` | `string` | Message | - -#### Returns - -`Promise`<`string`\> - -Promise - Signature a ECDSA 64 bytes - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L47) - -___ - -### signTransaction - -▸ **signTransaction**(`transactionRequestLike`): `Promise`<`string`\> - -Sign transaction with wallet instance privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | TransactionRequestLike | - -#### Returns - -`Promise`<`string`\> - -string - Signature a ECDSA 64 bytes - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L57) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Overrides - -[Account](Account.md).[simulateTransaction](Account.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L96) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](Account.md).[transfer](Account.md#transfer) - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](Account.md).[withdrawToBaseLayer](Account.md#withdrawtobaselayer) - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-wallet/classes/Wallet.md b/docs/packages/fuel-ts-wallet/classes/Wallet.md deleted file mode 100644 index 4b5f40cef77..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/Wallet.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -layout: default -title: Wallet -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: Wallet - -[@fuel-ts/wallet](../index.md).Wallet - -## Constructors - -### constructor - -• **new Wallet**() - -## Properties - -### fromExtendedKey - -▪ `Static` **fromExtendedKey**: (`extendedKey`: `string`, `provider?`: `default`) => [`WalletUnlocked`](WalletUnlocked.md) = `WalletUnlocked.fromExtendedKey` - -#### Type declaration - -▸ (`extendedKey`, `provider?`): [`WalletUnlocked`](WalletUnlocked.md) - -Create Wallet Unlocked from extended key - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `extendedKey` | `string` | -| `provider?` | `default` | - -##### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallet.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L23) - -___ - -### fromMnemonic - -▪ `Static` **fromMnemonic**: (`mnemonic`: `string`, `path?`: `string`, `passphrase?`: `BytesLike`, `provider?`: `default`) => [`WalletUnlocked`](WalletUnlocked.md) = `WalletUnlocked.fromMnemonic` - -#### Type declaration - -▸ (`mnemonic`, `path?`, `passphrase?`, `provider?`): [`WalletUnlocked`](WalletUnlocked.md) - -Create Wallet Unlocked from mnemonic phrase - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `mnemonic` | `string` | -| `path?` | `string` | -| `passphrase?` | `BytesLike` | -| `provider?` | `default` | - -##### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallet.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L22) - -___ - -### fromSeed - -▪ `Static` **fromSeed**: (`seed`: `string`, `path?`: `string`, `provider?`: `default`) => [`WalletUnlocked`](WalletUnlocked.md) = `WalletUnlocked.fromSeed` - -#### Type declaration - -▸ (`seed`, `path?`, `provider?`): [`WalletUnlocked`](WalletUnlocked.md) - -Create Wallet Unlocked from a seed - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | -| `path?` | `string` | -| `provider?` | `default` | - -##### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallet.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L21) - -___ - -### generate - -▪ `Static` **generate**: (`generateOptions?`: [`GenerateOptions`](../interfaces/internal-GenerateOptions.md)) => [`WalletUnlocked`](WalletUnlocked.md) = `WalletUnlocked.generate` - -#### Type declaration - -▸ (`generateOptions?`): [`WalletUnlocked`](WalletUnlocked.md) - -Generate a new Wallet Unlocked with a random keyPair - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `generateOptions?` | [`GenerateOptions`](../interfaces/internal-GenerateOptions.md) | - -##### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -wallet - Wallet instance - -#### Defined in - -[packages/wallet/src/wallet.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L20) - -## Methods - -### fromAddress - -▸ `Static` **fromAddress**(`address`, `provider?`): [`WalletLocked`](WalletLocked.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Returns - -[`WalletLocked`](WalletLocked.md) - -#### Defined in - -[packages/wallet/src/wallet.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L9) - -___ - -### fromPrivateKey - -▸ `Static` **fromPrivateKey**(`privateKey`, `provider?`): [`WalletUnlocked`](WalletUnlocked.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `privateKey` | `BytesLike` | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallet.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L16) diff --git a/docs/packages/fuel-ts-wallet/classes/WalletLocked.md b/docs/packages/fuel-ts-wallet/classes/WalletLocked.md deleted file mode 100644 index 56ec3f9f78d..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/WalletLocked.md +++ /dev/null @@ -1,378 +0,0 @@ ---- -layout: default -title: WalletLocked -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: WalletLocked - -[@fuel-ts/wallet](../index.md).WalletLocked - -WalletLocked - -## Hierarchy - -- [`Account`](Account.md) - - ↳ **`WalletLocked`** - -## Constructors - -### constructor - -• **new WalletLocked**(`address`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `address` | `string` \| [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Inherited from - -[Account](Account.md).[constructor](Account.md#constructor) - -#### Defined in - -[packages/wallet/src/account.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L39) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Inherited from - -[Account](Account.md).[address](Account.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Inherited from - -[Account](Account.md).[provider](Account.md#provider) - -#### Defined in - -[packages/wallet/src/account.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Inherited from - -[Account](Account.md).[connect](Account.md#connect) - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[Account](Account.md).[fund](Account.md#fund) - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Inherited from - -[Account](Account.md).[getBalance](Account.md#getbalance) - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Inherited from - -[Account](Account.md).[getBalances](Account.md#getbalances) - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Inherited from - -[Account](Account.md).[getCoins](Account.md#getcoins) - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Inherited from - -[Account](Account.md).[getMessages](Account.md#getmessages) - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Inherited from - -[Account](Account.md).[getResourcesToSpend](Account.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Inherited from - -[Account](Account.md).[sendTransaction](Account.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/account.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L253) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Inherited from - -[Account](Account.md).[simulateTransaction](Account.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/account.ts:267](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L267) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](Account.md).[transfer](Account.md#transfer) - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### unlock - -▸ **unlock**(`privateKey`): [`WalletUnlocked`](WalletUnlocked.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `privateKey` | `BytesLike` | - -#### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L20) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[Account](Account.md).[withdrawToBaseLayer](Account.md#withdrawtobaselayer) - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) diff --git a/docs/packages/fuel-ts-wallet/classes/WalletUnlocked.md b/docs/packages/fuel-ts-wallet/classes/WalletUnlocked.md deleted file mode 100644 index 5db362fb7a0..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/WalletUnlocked.md +++ /dev/null @@ -1,620 +0,0 @@ ---- -layout: default -title: WalletUnlocked -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: WalletUnlocked - -[@fuel-ts/wallet](../index.md).WalletUnlocked - -WalletUnlocked - -## Hierarchy - -- [`BaseWalletUnlocked`](BaseWalletUnlocked.md) - - ↳ **`WalletUnlocked`** - -## Constructors - -### constructor - -• **new WalletUnlocked**(`privateKey`, `provider?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `privateKey` | `BytesLike` | `undefined` | -| `provider` | `string` \| `default` | `FUEL_NETWORK_URL` | - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[constructor](BaseWalletUnlocked.md#constructor) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L26) - -## Properties - -### address - -• `Readonly` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[address](BaseWalletUnlocked.md#address) - -#### Defined in - -[packages/wallet/src/account.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L35) - -___ - -### provider - -• **provider**: `default` - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[provider](BaseWalletUnlocked.md#provider) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L22) - -___ - -### signer - -• **signer**: () => [`Signer`](internal-Signer.md) - -#### Type declaration - -▸ (): [`Signer`](internal-Signer.md) - -##### Returns - -[`Signer`](internal-Signer.md) - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[signer](BaseWalletUnlocked.md#signer) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L24) - -___ - -### defaultPath - -▪ `Static` **defaultPath**: `string` = `"m/44'/1179993420'/0'/0/0"` - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[defaultPath](BaseWalletUnlocked.md#defaultpath) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L20) - -## Accessors - -### privateKey - -• `get` **privateKey**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseWalletUnlocked.privateKey - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L33) - -___ - -### publicKey - -• `get` **publicKey**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseWalletUnlocked.publicKey - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L37) - -## Methods - -### connect - -▸ **connect**(`provider`): `default` - -Change provider connection - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `provider` | `string` \| `default` | - -#### Returns - -`default` - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[connect](BaseWalletUnlocked.md#connect) - -#### Defined in - -[packages/wallet/src/account.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L48) - -___ - -### fund - -▸ **fund**<`T`\>(`request`): `Promise`<`void`\> - -Adds resources to the transaction enough to fund it. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`TransactionRequest`](../namespaces/internal.md#transactionrequest) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `request` | `T` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[fund](BaseWalletUnlocked.md#fund) - -#### Defined in - -[packages/wallet/src/account.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L169) - -___ - -### getBalance - -▸ **getBalance**(`assetId?`): `Promise`<[`BN`](internal-BN.md)\> - -Gets balance for the given asset. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | `NativeAssetId` | - -#### Returns - -`Promise`<[`BN`](internal-BN.md)\> - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[getBalance](BaseWalletUnlocked.md#getbalance) - -#### Defined in - -[packages/wallet/src/account.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L132) - -___ - -### getBalances - -▸ **getBalances**(): `Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -Gets balances. - -#### Returns - -`Promise`<[`CoinQuantity`](../namespaces/internal.md#coinquantity)[]\> - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[getBalances](BaseWalletUnlocked.md#getbalances) - -#### Defined in - -[packages/wallet/src/account.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L140) - -___ - -### getCoins - -▸ **getCoins**(`assetId?`): `Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -Gets coins owned by the wallet address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `assetId?` | `BytesLike` | - -#### Returns - -`Promise`<[`Coin`](../namespaces/internal.md#coin-2)[]\> - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[getCoins](BaseWalletUnlocked.md#getcoins) - -#### Defined in - -[packages/wallet/src/account.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L74) - -___ - -### getMessages - -▸ **getMessages**(): `Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -Gets messages owned by the wallet address. - -#### Returns - -`Promise`<[`Message`](../namespaces/internal.md#message-2)[]\> - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[getMessages](BaseWalletUnlocked.md#getmessages) - -#### Defined in - -[packages/wallet/src/account.ts:103](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L103) - -___ - -### getResourcesToSpend - -▸ **getResourcesToSpend**(`quantities`, `excludedIds?`): `Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -Returns resources satisfying the spend query. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | -| `excludedIds?` | [`ExcludeResourcesOption`](../namespaces/internal.md#excluderesourcesoption) | - -#### Returns - -`Promise`<[`Resource`](../namespaces/internal.md#resource)[]\> - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[getResourcesToSpend](BaseWalletUnlocked.md#getresourcestospend) - -#### Defined in - -[packages/wallet/src/account.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L64) - -___ - -### lock - -▸ **lock**(): [`WalletLocked`](WalletLocked.md) - -#### Returns - -[`WalletLocked`](WalletLocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L30) - -___ - -### populateTransactionWitnessesSignature - -▸ **populateTransactionWitnessesSignature**(`transactionRequestLike`): `Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionRequest`](../namespaces/internal.md#transactionrequest)\> - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[populateTransactionWitnessesSignature](BaseWalletUnlocked.md#populatetransactionwitnessessignature) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:65](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L65) - -___ - -### sendTransaction - -▸ **sendTransaction**(`transactionRequestLike`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Populates witnesses signature and send it to the network using `provider.sendTransaction`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -TransactionResponse - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[sendTransaction](BaseWalletUnlocked.md#sendtransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:80](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L80) - -___ - -### signMessage - -▸ **signMessage**(`message`): `Promise`<`string`\> - -Sign message with wallet instance privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `message` | `string` | Message | - -#### Returns - -`Promise`<`string`\> - -Promise - Signature a ECDSA 64 bytes - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[signMessage](BaseWalletUnlocked.md#signmessage) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L47) - -___ - -### signTransaction - -▸ **signTransaction**(`transactionRequestLike`): `Promise`<`string`\> - -Sign transaction with wallet instance privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | TransactionRequestLike | - -#### Returns - -`Promise`<`string`\> - -string - Signature a ECDSA 64 bytes - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[signTransaction](BaseWalletUnlocked.md#signtransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L57) - -___ - -### simulateTransaction - -▸ **simulateTransaction**(`transactionRequestLike`): `Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -Populates witnesses signature and send a call it to the network using `provider.call`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequestLike` | [`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike) | - -#### Returns - -`Promise`<[`CallResult`](../namespaces/internal.md#callresult)\> - -CallResult - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[simulateTransaction](BaseWalletUnlocked.md#simulatetransaction) - -#### Defined in - -[packages/wallet/src/base-unlocked-wallet.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/base-unlocked-wallet.ts#L96) - -___ - -### transfer - -▸ **transfer**(`destination`, `amount`, `assetId?`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Returns coins satisfying the spend query. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `destination` | [`AbstractAddress`](internal-AbstractAddress.md) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | `{}` | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[transfer](BaseWalletUnlocked.md#transfer) - -#### Defined in - -[packages/wallet/src/account.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L179) - -___ - -### withdrawToBaseLayer - -▸ **withdrawToBaseLayer**(`recipient`, `amount`, `txParams?`): `Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -Withdraws an amount of the base asset to the base chain. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `recipient` | [`AbstractAddress`](internal-AbstractAddress.md) | Address of the recipient on the base chain | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | Amount of base asset | -| `txParams` | `Pick`<[`TransactionRequestLike`](../namespaces/internal.md#transactionrequestlike), ``"gasPrice"`` \| ``"gasLimit"`` \| ``"maturity"``\> | Tx Params | - -#### Returns - -`Promise`<[`TransactionResponse`](internal-TransactionResponse.md)\> - -#### Inherited from - -[BaseWalletUnlocked](BaseWalletUnlocked.md).[withdrawToBaseLayer](BaseWalletUnlocked.md#withdrawtobaselayer) - -#### Defined in - -[packages/wallet/src/account.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/account.ts#L212) - -___ - -### fromExtendedKey - -▸ `Static` **fromExtendedKey**(`extendedKey`, `provider?`): [`WalletUnlocked`](WalletUnlocked.md) - -Create Wallet Unlocked from extended key - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `extendedKey` | `string` | -| `provider?` | `default` | - -#### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:76](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L76) - -___ - -### fromMnemonic - -▸ `Static` **fromMnemonic**(`mnemonic`, `path?`, `passphrase?`, `provider?`): [`WalletUnlocked`](WalletUnlocked.md) - -Create Wallet Unlocked from mnemonic phrase - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `mnemonic` | `string` | -| `path?` | `string` | -| `passphrase?` | `BytesLike` | -| `provider?` | `default` | - -#### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L60) - -___ - -### fromSeed - -▸ `Static` **fromSeed**(`seed`, `path?`, `provider?`): [`WalletUnlocked`](WalletUnlocked.md) - -Create Wallet Unlocked from a seed - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `seed` | `string` | -| `path?` | `string` | -| `provider?` | `default` | - -#### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -#### Defined in - -[packages/wallet/src/wallets.ts:50](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L50) - -___ - -### generate - -▸ `Static` **generate**(`generateOptions?`): [`WalletUnlocked`](WalletUnlocked.md) - -Generate a new Wallet Unlocked with a random keyPair - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `generateOptions?` | [`GenerateOptions`](../interfaces/internal-GenerateOptions.md) | - -#### Returns - -[`WalletUnlocked`](WalletUnlocked.md) - -wallet - Wallet instance - -#### Defined in - -[packages/wallet/src/wallets.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallets.ts#L41) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-AbstractAccount.md b/docs/packages/fuel-ts-wallet/classes/internal-AbstractAccount.md deleted file mode 100644 index c0a3d215929..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-AbstractAccount.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -layout: default -title: AbstractAccount -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: AbstractAccount - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).AbstractAccount - -## Hierarchy - -- **`AbstractAccount`** - - ↳ [`Account`](Account.md) - -## Constructors - -### constructor - -• **new AbstractAccount**() - -## Properties - -### address - -• `Abstract` **address**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L26) - -___ - -### provider - -• `Abstract` **provider**: `unknown` - -#### Defined in - -[packages/interfaces/src/index.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L27) - -## Methods - -### getResourcesToSpend - -▸ `Abstract` **getResourcesToSpend**(`quantities`, `options?`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `quantities` | `any`[] | -| `options?` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L28) - -___ - -### sendTransaction - -▸ `Abstract` **sendTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L29) - -___ - -### simulateTransaction - -▸ `Abstract` **simulateTransaction**(`transactionRequest`): `any` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionRequest` | `any` | - -#### Returns - -`any` - -#### Defined in - -[packages/interfaces/src/index.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L30) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-AbstractAddress.md b/docs/packages/fuel-ts-wallet/classes/internal-AbstractAddress.md deleted file mode 100644 index c76ce8fde55..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-AbstractAddress.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -layout: default -title: AbstractAddress -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: AbstractAddress - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).AbstractAddress - -## Constructors - -### constructor - -• **new AbstractAddress**() - -## Methods - -### equals - -▸ `Abstract` **equals**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `other` | [`AbstractAddress`](internal-AbstractAddress.md) | - -#### Returns - -`boolean` - -#### Defined in - -[packages/interfaces/src/index.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L21) - -___ - -### toAddress - -▸ `Abstract` **toAddress**(): \`fuel${string}\` - -#### Returns - -\`fuel${string}\` - -#### Defined in - -[packages/interfaces/src/index.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L17) - -___ - -### toB256 - -▸ `Abstract` **toB256**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L18) - -___ - -### toBytes - -▸ `Abstract` **toBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L20) - -___ - -### toHexString - -▸ `Abstract` **toHexString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L19) - -___ - -### toJSON - -▸ `Abstract` **toJSON**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L15) - -___ - -### toString - -▸ `Abstract` **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/interfaces/src/index.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L16) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-AbstractContract.md b/docs/packages/fuel-ts-wallet/classes/internal-AbstractContract.md deleted file mode 100644 index ddf7f160a79..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-AbstractContract.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: default -title: AbstractContract -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: AbstractContract - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).AbstractContract - -## Hierarchy - -- [`AbstractProgram`](internal-AbstractProgram.md) - - ↳ **`AbstractContract`** - -## Constructors - -### constructor - -• **new AbstractContract**() - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[constructor](internal-AbstractProgram.md#constructor) - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[account](internal-AbstractProgram.md#account) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### id - -• `Abstract` **id**: [`AbstractAddress`](internal-AbstractAddress.md) - -#### Defined in - -[packages/interfaces/src/index.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L48) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[interface](internal-AbstractProgram.md#interface) - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Inherited from - -[AbstractProgram](internal-AbstractProgram.md).[provider](internal-AbstractProgram.md#provider) - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-AbstractProgram.md b/docs/packages/fuel-ts-wallet/classes/internal-AbstractProgram.md deleted file mode 100644 index 4811a267be6..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-AbstractProgram.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: AbstractProgram -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: AbstractProgram - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).AbstractProgram - -## Hierarchy - -- **`AbstractProgram`** - - ↳ [`AbstractContract`](internal-AbstractContract.md) - -## Constructors - -### constructor - -• **new AbstractProgram**() - -## Properties - -### account - -• `Abstract` **account**: ``null`` \| [`AbstractAccount`](internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L34) - -___ - -### interface - -• `Abstract` **interface**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `decodeFunctionResult` | (`func`: `any`, `result`: `string` \| `Uint8Array`) => `any` | -| `encodeFunctionData` | (`func`: `any`, `args`: `any`[], `offset`: `number`, `isMainArgs?`: `boolean`) => `any` | -| `loggedTypes` | `any` | -| `updateExternalLoggedTypes` | (`id`: `string`, `loggedTypes`: `any`[]) => `any` | - -#### Defined in - -[packages/interfaces/src/index.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L35) - -___ - -### provider - -• `Abstract` **provider**: ``null`` \| { `sendTransaction`: (`transactionRequest`: `any`) => `any` } - -#### Defined in - -[packages/interfaces/src/index.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L42) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-AbstractScriptRequest.md b/docs/packages/fuel-ts-wallet/classes/internal-AbstractScriptRequest.md deleted file mode 100644 index cd1879f574f..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-AbstractScriptRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default -title: AbstractScriptRequest -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: AbstractScriptRequest - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).AbstractScriptRequest - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Constructors - -### constructor - -• **new AbstractScriptRequest**<`T`\>() - -#### Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### bytes - -• `Abstract` **bytes**: `Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L9) - -___ - -### encodeScriptData - -• `Abstract` **encodeScriptData**: (`data`: `T`) => `Uint8Array` - -#### Type declaration - -▸ (`data`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `T` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/interfaces/src/index.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L10) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-BN.md b/docs/packages/fuel-ts-wallet/classes/internal-BN.md deleted file mode 100644 index f1deadf9826..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-BN.md +++ /dev/null @@ -1,814 +0,0 @@ ---- -layout: default -title: BN -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: BN - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).BN - -## Hierarchy - -- `BN` - - ↳ **`BN`** - -## Implements - -- [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) -- [`BNHiddenTypes`](../interfaces/internal-BNHiddenTypes.md) -- [`BNHelper`](../interfaces/internal-BNHelper.md) -- [`BNOverrides`](../interfaces/internal-BNOverrides.md) - -## Constructors - -### constructor - -• **new BN**(`value?`, `base?`, `endian?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | ``null`` \| [`BNInput`](../namespaces/internal.md#bninput) | -| `base?` | `number` \| ``"hex"`` | -| `endian?` | `Endianness` | - -#### Overrides - -BnJs.constructor - -#### Defined in - -[packages/math/src/bn.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L44) - -## Methods - -### abs - -▸ **abs**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.abs - -#### Overrides - -BnJs.abs - -#### Defined in - -[packages/math/src/bn.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L198) - -___ - -### add - -▸ **add**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.add - -#### Overrides - -BnJs.add - -#### Defined in - -[packages/math/src/bn.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L136) - -___ - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | keyof [`BNInputOverrides`](../interfaces/internal-BNInputOverrides.md) | - -#### Returns - -`boolean` \| [`BN`](internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -[BNHelper](../interfaces/internal-BNHelper.md).[caller](../interfaces/internal-BNHelper.md#caller) - -#### Defined in - -[packages/math/src/bn.ts:212](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L212) - -___ - -### clone - -▸ **clone**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Overrides - -BnJs.clone - -#### Defined in - -[packages/math/src/bn.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L226) - -___ - -### cmp - -▸ **cmp**(`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Implementation of - -BNInputOverrides.cmp - -#### Overrides - -BnJs.cmp - -#### Defined in - -[packages/math/src/bn.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L184) - -___ - -### div - -▸ **div**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.div - -#### Overrides - -BnJs.div - -#### Defined in - -[packages/math/src/bn.ts:148](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L148) - -___ - -### divRound - -▸ **divRound**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.divRound - -#### Overrides - -BnJs.divRound - -#### Defined in - -[packages/math/src/bn.ts:160](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L160) - -___ - -### divmod - -▸ **divmod**(`num`, `mode?`, `positive?`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](internal-BN.md) | -| `mod` | [`BN`](internal-BN.md) | - -#### Implementation of - -BNHiddenTypes.divmod - -#### Overrides - -BnJs.divmod - -#### Defined in - -[packages/math/src/bn.ts:246](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L246) - -___ - -### egcd - -▸ **egcd**(`p`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `p` | `BN` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `a` | [`BN`](internal-BN.md) | -| `b` | [`BN`](internal-BN.md) | -| `gcd` | [`BN`](internal-BN.md) | - -#### Overrides - -BnJs.egcd - -#### Defined in - -[packages/math/src/bn.ts:236](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L236) - -___ - -### eq - -▸ **eq**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.eq - -#### Overrides - -BnJs.eq - -#### Defined in - -[packages/math/src/bn.ts:180](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L180) - -___ - -### format - -▸ **format**(`options?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`FormatConfig`](../namespaces/internal.md#formatconfig) | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L98) - -___ - -### formatUnits - -▸ **formatUnits**(`units?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `units` | `number` | `DECIMAL_UNITS` | - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L122) - -___ - -### fromTwos - -▸ **fromTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.fromTwos - -#### Overrides - -BnJs.fromTwos - -#### Defined in - -[packages/math/src/bn.ts:206](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L206) - -___ - -### gt - -▸ **gt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gt - -#### Overrides - -BnJs.gt - -#### Defined in - -[packages/math/src/bn.ts:172](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L172) - -___ - -### gte - -▸ **gte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.gte - -#### Overrides - -BnJs.gte - -#### Defined in - -[packages/math/src/bn.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L176) - -___ - -### lt - -▸ **lt**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lt - -#### Overrides - -BnJs.lt - -#### Defined in - -[packages/math/src/bn.ts:164](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L164) - -___ - -### lte - -▸ **lte**(`v`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -`boolean` - -#### Implementation of - -BNInputOverrides.lte - -#### Overrides - -BnJs.lte - -#### Defined in - -[packages/math/src/bn.ts:168](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L168) - -___ - -### mod - -▸ **mod**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mod - -#### Overrides - -BnJs.mod - -#### Defined in - -[packages/math/src/bn.ts:156](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L156) - -___ - -### mul - -▸ **mul**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.mul - -#### Overrides - -BnJs.mul - -#### Defined in - -[packages/math/src/bn.ts:152](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L152) - -___ - -### mulTo - -▸ **mulTo**(`num`, `out`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](internal-BN.md) | -| `out` | [`BN`](internal-BN.md) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNHiddenTypes.mulTo - -#### Defined in - -[packages/math/src/bn.ts:230](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L230) - -___ - -### neg - -▸ **neg**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.neg - -#### Overrides - -BnJs.neg - -#### Defined in - -[packages/math/src/bn.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L194) - -___ - -### pow - -▸ **pow**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.pow - -#### Overrides - -BnJs.pow - -#### Defined in - -[packages/math/src/bn.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L140) - -___ - -### sqr - -▸ **sqr**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.sqr - -#### Overrides - -BnJs.sqr - -#### Defined in - -[packages/math/src/bn.ts:190](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L190) - -___ - -### sub - -▸ **sub**(`v`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNInputOverrides.sub - -#### Overrides - -BnJs.sub - -#### Defined in - -[packages/math/src/bn.ts:144](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L144) - -___ - -### toBytes - -▸ **toBytes**(`bytesPadding?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`Uint8Array` - -#### Implementation of - -BNHelper.toBytes - -#### Defined in - -[packages/math/src/bn.ts:82](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L82) - -___ - -### toHex - -▸ **toHex**(`bytesPadding?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toHex - -#### Defined in - -[packages/math/src/bn.ts:68](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L68) - -___ - -### toJSON - -▸ **toJSON**(): `string` - -#### Returns - -`string` - -#### Implementation of - -BNHelper.toJSON - -#### Overrides - -BnJs.toJSON - -#### Defined in - -[packages/math/src/bn.ts:90](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L90) - -___ - -### toString - -▸ **toString**(`base?`, `length?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `base?` | `number` \| ``"hex"`` | -| `length?` | `number` | - -#### Returns - -`string` - -#### Overrides - -BnJs.toString - -#### Defined in - -[packages/math/src/bn.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L60) - -___ - -### toTwos - -▸ **toTwos**(`width`): [`BN`](internal-BN.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -#### Returns - -[`BN`](internal-BN.md) - -#### Implementation of - -BNOverrides.toTwos - -#### Overrides - -BnJs.toTwos - -#### Defined in - -[packages/math/src/bn.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L202) - -___ - -### valueOf - -▸ **valueOf**(): `string` - -#### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L94) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-BaseTransactionRequest.md b/docs/packages/fuel-ts-wallet/classes/internal-BaseTransactionRequest.md deleted file mode 100644 index 6e238edd8e8..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-BaseTransactionRequest.md +++ /dev/null @@ -1,526 +0,0 @@ ---- -layout: default -title: BaseTransactionRequest -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: BaseTransactionRequest - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequest - -## Hierarchy - -- **`BaseTransactionRequest`** - - ↳ [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - - ↳ [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -## Implements - -- [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) - -## Constructors - -### constructor - -• **new BaseTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md) | - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L131) - -## Properties - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasLimit](../interfaces/internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[gasPrice](../interfaces/internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[inputs](../interfaces/internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[maturity](../interfaces/internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[outputs](../interfaces/internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### type - -• `Abstract` **type**: [`TransactionType`](../enums/internal-TransactionType.md) - -Type of the transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:117](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L117) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Implementation of - -[BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md).[witnesses](../interfaces/internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ `Abstract` **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:167](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L167) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-CreateTransactionRequest.md b/docs/packages/fuel-ts-wallet/classes/internal-CreateTransactionRequest.md deleted file mode 100644 index dc2c8fdcbeb..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-CreateTransactionRequest.md +++ /dev/null @@ -1,703 +0,0 @@ ---- -layout: default -title: CreateTransactionRequest -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: CreateTransactionRequest - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`CreateTransactionRequest`** - -## Constructors - -### constructor - -• **new CreateTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:528](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L528) - -## Properties - -### bytecodeWitnessIndex - -• **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:522](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L522) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### salt - -• **salt**: `string` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:524](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L524) - -___ - -### storageSlots - -• **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:526](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L526) - -___ - -### type - -• **type**: [`Create`](../namespaces/internal.md#create) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:520](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L520) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContractCreatedOutput - -▸ **addContractCreatedOutput**(`contractId`, `stateRoot`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:562](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L562) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractCreatedOutputs - -▸ **getContractCreatedOutputs**(): [`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Returns - -[`ContractCreatedTransactionRequestOutput`](../namespaces/internal.md#contractcreatedtransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:555](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L555) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Returns - -[`TransactionCreate`](../namespaces/internal.md#transactioncreate) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:540](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L540) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) | - -#### Returns - -[`CreateTransactionRequest`](internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:512](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L512) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-ScriptTransactionRequest.md b/docs/packages/fuel-ts-wallet/classes/internal-ScriptTransactionRequest.md deleted file mode 100644 index 6960e77867d..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-ScriptTransactionRequest.md +++ /dev/null @@ -1,797 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequest -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: ScriptTransactionRequest - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequest - -## Hierarchy - -- [`BaseTransactionRequest`](internal-BaseTransactionRequest.md) - - ↳ **`ScriptTransactionRequest`** - -## Constructors - -### constructor - -• **new ScriptTransactionRequest**(`__namedParameters?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[constructor](internal-BaseTransactionRequest.md#constructor) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:406](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L406) - -## Properties - -### bytesOffset - -• **bytesOffset**: `undefined` \| `number` - -determined bytes offset for start of script data - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:404](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L404) - -___ - -### gasLimit - -• **gasLimit**: [`BN`](internal-BN.md) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasLimit](internal-BaseTransactionRequest.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L121) - -___ - -### gasPrice - -• **gasPrice**: [`BN`](internal-BN.md) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[gasPrice](internal-BaseTransactionRequest.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L119) - -___ - -### inputs - -• **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] = `[]` - -List of inputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[inputs](internal-BaseTransactionRequest.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L125) - -___ - -### maturity - -• **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[maturity](internal-BaseTransactionRequest.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:123](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L123) - -___ - -### outputs - -• **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] = `[]` - -List of outputs - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[outputs](internal-BaseTransactionRequest.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:127](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L127) - -___ - -### script - -• **script**: `Uint8Array` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:400](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L400) - -___ - -### scriptData - -• **scriptData**: `Uint8Array` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:402](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L402) - -___ - -### type - -• **type**: [`Script`](../namespaces/internal.md#script) - -Type of the transaction - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[type](internal-BaseTransactionRequest.md#type) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:398](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L398) - -___ - -### witnesses - -• **witnesses**: `BytesLike`[] = `[]` - -List of witnesses - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[witnesses](internal-BaseTransactionRequest.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L129) - -## Methods - -### addCoinOutput - -▸ **addCoinOutput**(`to`, `amount`, `assetId?`): `void` - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | `undefined` | Address of the destination | -| `amount` | [`BigNumberish`](../namespaces/internal.md#bignumberish) | `undefined` | Amount of coins | -| `assetId` | `BytesLike` | `NativeAssetId` | Asset ID of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutput](internal-BaseTransactionRequest.md#addcoinoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:321](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L321) - -___ - -### addCoinOutputs - -▸ **addCoinOutputs**(`to`, `quantities`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `to` | [`AddressLike`](../namespaces/internal.md#addresslike) | Address of the destination | -| `quantities` | [`CoinQuantityLike`](../namespaces/internal.md#coinquantitylike)[] | Quantities of coins | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addCoinOutputs](internal-BaseTransactionRequest.md#addcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:337](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L337) - -___ - -### addContract - -▸ **addContract**(`contract`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `contract` | [`ContractIdLike`](../namespaces/internal.md#contractidlike) | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:481](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L481) - -___ - -### addMessageOutputs - -▸ **addMessageOutputs**(`numberOfMessages?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfMessages` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:466](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L466) - -___ - -### addResource - -▸ **addResource**(`resource`): `void` - -Converts the given Resource to a ResourceInput with the appropriate witnessIndex and pushes it - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resource` | [`Resource`](../namespaces/internal.md#resource) | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResource](internal-BaseTransactionRequest.md#addresource) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L266) - -___ - -### addResources - -▸ **addResources**(`resources`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `resources` | readonly [`Resource`](../namespaces/internal.md#resource)[] | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[addResources](internal-BaseTransactionRequest.md#addresources) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:317](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L317) - -___ - -### addVariableOutputs - -▸ **addVariableOutputs**(`numberOfVariables?`): `number` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `numberOfVariables` | `number` | `1` | - -#### Returns - -`number` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:453](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L453) - -___ - -### byteSize - -▸ **byteSize**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[byteSize](internal-BaseTransactionRequest.md#bytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:353](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L353) - -___ - -### calculateFee - -▸ **calculateFee**(): [`CoinQuantity`](../namespaces/internal.md#coinquantity) - -Return the minimum amount in native coins required to create -a transaction. - -Note: this is required even gasPrice = 0 - -#### Returns - -[`CoinQuantity`](../namespaces/internal.md#coinquantity) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[calculateFee](internal-BaseTransactionRequest.md#calculatefee) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:368](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L368) - -___ - -### chargeableByteSize - -▸ **chargeableByteSize**(): [`BN`](internal-BN.md) - -#### Returns - -[`BN`](internal-BN.md) - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[chargeableByteSize](internal-BaseTransactionRequest.md#chargeablebytesize) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:357](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L357) - -___ - -### createWitness - -▸ `Protected` **createWitness**(): `number` - -Creates an empty witness without any side effects and returns the index - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[createWitness](internal-BaseTransactionRequest.md#createwitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L192) - -___ - -### getBaseTransaction - -▸ `Protected` **getBaseTransaction**(): `Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Returns - -`Pick`<[`TransactionScript`](../namespaces/internal.md#transactionscript) \| [`TransactionCreate`](../namespaces/internal.md#transactioncreate), ``"inputsCount"`` \| ``"outputsCount"`` \| ``"witnessesCount"`` \| keyof [`BaseTransactionRequestLike`](../interfaces/internal-BaseTransactionRequestLike.md)\> - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getBaseTransaction](internal-BaseTransactionRequest.md#getbasetransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L147) - -___ - -### getChangeOutputs - -▸ **getChangeOutputs**(): [`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Returns - -[`ChangeTransactionRequestOutput`](../namespaces/internal.md#changetransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getChangeOutputs](internal-BaseTransactionRequest.md#getchangeoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:226](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L226) - -___ - -### getCoinInputWitnessIndexByOwner - -▸ **getCoinInputWitnessIndexByOwner**(`owner`): ``null`` \| `number` - -Returns the witnessIndex of the found CoinInput - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | - -#### Returns - -``null`` \| `number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputWitnessIndexByOwner](internal-BaseTransactionRequest.md#getcoininputwitnessindexbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:235](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L235) - -___ - -### getCoinInputs - -▸ **getCoinInputs**(): [`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Returns - -[`CoinTransactionRequestInput`](../namespaces/internal.md#cointransactionrequestinput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinInputs](internal-BaseTransactionRequest.md#getcoininputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:214](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L214) - -___ - -### getCoinOutputs - -▸ **getCoinOutputs**(): [`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Returns - -[`CoinTransactionRequestOutput`](../namespaces/internal.md#cointransactionrequestoutput)[] - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[getCoinOutputs](internal-BaseTransactionRequest.md#getcoinoutputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:220](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L220) - -___ - -### getContractInputs - -▸ **getContractInputs**(): [`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Returns - -[`ContractTransactionRequestInput`](../namespaces/internal.md#contracttransactionrequestinput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:426](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L426) - -___ - -### getContractOutputs - -▸ **getContractOutputs**(): [`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Returns - -[`ContractTransactionRequestOutput`](../namespaces/internal.md#contracttransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:432](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L432) - -___ - -### getVariableOutputs - -▸ **getVariableOutputs**(): [`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Returns - -[`VariableTransactionRequestOutput`](../namespaces/internal.md#variabletransactionrequestoutput)[] - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:438](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L438) - -___ - -### pushInput - -▸ `Protected` **pushInput**(`input`): `number` - -Pushes an input to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushInput](internal-BaseTransactionRequest.md#pushinput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L176) - -___ - -### pushOutput - -▸ `Protected` **pushOutput**(`output`): `number` - -Pushes an output to the list without any side effects and returns the index - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `output` | [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput) | - -#### Returns - -`number` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[pushOutput](internal-BaseTransactionRequest.md#pushoutput) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L184) - -___ - -### setScript - -▸ **setScript**<`T`\>(`script`, `data`): `void` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `script` | [`AbstractScriptRequest`](internal-AbstractScriptRequest.md)<`T`\> | -| `data` | `T` | - -#### Returns - -`void` - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:444](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L444) - -___ - -### toJSON - -▸ **toJSON**(): `any` - -#### Returns - -`any` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toJSON](internal-BaseTransactionRequest.md#tojson) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:377](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L377) - -___ - -### toTransaction - -▸ **toTransaction**(): [`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Returns - -[`TransactionScript`](../namespaces/internal.md#transactionscript) - -#### Overrides - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransaction](internal-BaseTransactionRequest.md#totransaction) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:412](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L412) - -___ - -### toTransactionBytes - -▸ **toTransactionBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[toTransactionBytes](internal-BaseTransactionRequest.md#totransactionbytes) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L169) - -___ - -### updateWitness - -▸ **updateWitness**(`index`, `witness`): `void` - -Updates an existing witness without any side effects - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | `number` | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitness](internal-BaseTransactionRequest.md#updatewitness) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L207) - -___ - -### updateWitnessByCoinInputOwner - -▸ **updateWitnessByCoinInputOwner**(`owner`, `witness`): `void` - -Updates the witness for the given CoinInput owner - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | [`AddressLike`](../namespaces/internal.md#addresslike) | -| `witness` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByCoinInputOwner](internal-BaseTransactionRequest.md#updatewitnessbycoininputowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:253](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L253) - -___ - -### updateWitnessByOwner - -▸ **updateWitnessByOwner**(`address`, `signature`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`AbstractAddress`](internal-AbstractAddress.md) | -| `signature` | `BytesLike` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTransactionRequest](internal-BaseTransactionRequest.md).[updateWitnessByOwner](internal-BaseTransactionRequest.md#updatewitnessbyowner) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:197](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L197) - -___ - -### from - -▸ `Static` **from**(`obj`): [`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) | - -#### Returns - -[`ScriptTransactionRequest`](internal-ScriptTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:390](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L390) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-Signer.md b/docs/packages/fuel-ts-wallet/classes/internal-Signer.md deleted file mode 100644 index 5b1acddafd3..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-Signer.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -layout: default -title: Signer -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: Signer - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).Signer - -## Constructors - -### constructor - -• **new Signer**(`privateKey`) - -Create a Signer instance from a given private key - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `privateKey` | `BytesLike` | The private key to use for signing | - -#### Defined in - -[packages/signer/src/signer.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L31) - -## Properties - -### address - -• `Readonly` **address**: `default` - -#### Defined in - -[packages/signer/src/signer.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L17) - -___ - -### compressedPublicKey - -• `Readonly` **compressedPublicKey**: `string` - -#### Defined in - -[packages/signer/src/signer.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L21) - -___ - -### privateKey - -• `Readonly` **privateKey**: `string` - -#### Defined in - -[packages/signer/src/signer.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L23) - -___ - -### publicKey - -• `Readonly` **publicKey**: `string` - -#### Defined in - -[packages/signer/src/signer.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L19) - -## Methods - -### addPoint - -▸ **addPoint**(`point`): `string` - -Add point on the current elliptic curve - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `point` | `BytesLike` | Point to add on the curve | - -#### Returns - -`string` - -compressed point on the curve - -#### Defined in - -[packages/signer/src/signer.ts:80](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L80) - -___ - -### sign - -▸ **sign**(`data`): `string` - -Sign data using the Signer instance - -Signature is a 64 byte array of the concatenated r and s values with the compressed recoveryParam byte. [Read more](FuelLabs/fuel-specs/specs/protocol/cryptographic_primitives.md#public-key-cryptography) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | The data to be sign | - -#### Returns - -`string` - -hashed signature - -#### Defined in - -[packages/signer/src/signer.ts:60](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L60) - -___ - -### extendPublicKey - -▸ `Static` **extendPublicKey**(`publicKey`): `string` - -Extended publicKey from a compact publicKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `publicKey` | `BytesLike` | Compact publicKey | - -#### Returns - -`string` - -extended publicKey - -#### Defined in - -[packages/signer/src/signer.ts:139](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L139) - -___ - -### generatePrivateKey - -▸ `Static` **generatePrivateKey**(`entropy?`): `string` \| `Uint8Array` - -Generate a random privateKey - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `entropy?` | `BytesLike` | Adds extra entropy to generate the privateKey | - -#### Returns - -`string` \| `Uint8Array` - -random 32-byte hashed - -#### Defined in - -[packages/signer/src/signer.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L129) - -___ - -### recoverAddress - -▸ `Static` **recoverAddress**(`data`, `signature`): `default` - -Recover the address from a signature performed with [`sign`](#sign). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | Data | -| `signature` | `BytesLike` | Signature | - -#### Returns - -`default` - -Address from signature - -#### Defined in - -[packages/signer/src/signer.ts:119](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L119) - -___ - -### recoverPublicKey - -▸ `Static` **recoverPublicKey**(`data`, `signature`): `any` - -Recover the public key from a signature performed with [`sign`](#sign). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `BytesLike` | Data | -| `signature` | `BytesLike` | hashed signature | - -#### Returns - -`any` - -public key from signature from the - -#### Defined in - -[packages/signer/src/signer.ts:95](https://github.com/FuelLabs/fuels-ts/blob/master/packages/signer/src/signer.ts#L95) diff --git a/docs/packages/fuel-ts-wallet/classes/internal-TransactionResponse.md b/docs/packages/fuel-ts-wallet/classes/internal-TransactionResponse.md deleted file mode 100644 index dae1677a834..00000000000 --- a/docs/packages/fuel-ts-wallet/classes/internal-TransactionResponse.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -layout: default -title: TransactionResponse -parent: "@fuel-ts/wallet" -nav_order: 1 - ---- - -# Class: TransactionResponse - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).TransactionResponse - -## Constructors - -### constructor - -• **new TransactionResponse**(`id`, `provider`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `provider` | `default` | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:102](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L102) - -## Properties - -### attempts - -• **attempts**: `number` = `0` - -Number off attempts to get the committed tx - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L100) - -___ - -### gasUsed - -• **gasUsed**: [`BN`](internal-BN.md) - -Gas used on the transaction - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L98) - -___ - -### id - -• **id**: `string` - -Transaction ID - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:94](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L94) - -___ - -### provider - -• **provider**: `default` - -Current provider - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:96](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L96) - -## Methods - -### decodeTransaction - -▸ **decodeTransaction**<`TTransactionType`\>(`transactionWithReceipts`): [`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionWithReceipts` | `Object` | -| `transactionWithReceipts.__typename` | ``"Transaction"`` | -| `transactionWithReceipts.gasPrice?` | ``null`` \| `string` | -| `transactionWithReceipts.id` | `string` | -| `transactionWithReceipts.rawPayload` | `string` | -| `transactionWithReceipts.receipts?` | ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] | -| `transactionWithReceipts.status?` | ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } | - -#### Returns - -[`Transaction`](../namespaces/internal.md#transaction)<`TTransactionType`\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:114](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L114) - -___ - -### fetch - -▸ **fetch**(): `Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Returns - -`Promise`<`undefined` \| ``null`` \| { `__typename`: ``"Transaction"`` ; `gasPrice?`: ``null`` \| `string` ; `id`: `string` ; `rawPayload`: `string` ; `receipts?`: ``null`` \| { `__typename`: ``"Receipt"`` ; `data?`: ``null`` \| `string` ; `rawPayload`: `string` }[] ; `status?`: ``null`` \| { `__typename`: ``"FailureStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `reason`: `string` ; `time`: `any` ; `type`: ``"FailureStatus"`` } \| { `__typename`: ``"SqueezedOutStatus"`` ; `type`: ``"SqueezedOutStatus"`` } \| { `__typename`: ``"SubmittedStatus"`` ; `time`: `any` ; `type`: ``"SubmittedStatus"`` } \| { `__typename`: ``"SuccessStatus"`` ; `block`: { `__typename`: ``"Block"`` ; `id`: `string` } ; `programState?`: ``null`` \| { `__typename`: ``"ProgramState"`` ; `data`: `string` ; `returnType`: [`GqlReturnType`](../enums/internal-GqlReturnType.md) } ; `time`: `any` ; `type`: ``"SuccessStatus"`` } }\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L107) - -___ - -### wait - -▸ **wait**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -Waits for transaction to succeed and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<``"success"``, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:188](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L188) - -___ - -### waitForResult - -▸ **waitForResult**<`TTransactionType`\>(): `Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -Waits for transaction to succeed or fail and returns the result - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Returns - -`Promise`<[`TransactionResult`](../namespaces/internal.md#transactionresult)<`any`, `TTransactionType`\>\> - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:124](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L124) diff --git a/docs/packages/fuel-ts-wallet/enums/internal-GqlCoinStatus.md b/docs/packages/fuel-ts-wallet/enums/internal-GqlCoinStatus.md deleted file mode 100644 index fc2d04a156e..00000000000 --- a/docs/packages/fuel-ts-wallet/enums/internal-GqlCoinStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlCoinStatus -parent: "@fuel-ts/wallet" -nav_order: 4 - ---- - -# Enumeration: GqlCoinStatus - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).GqlCoinStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:157 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:158 diff --git a/docs/packages/fuel-ts-wallet/enums/internal-GqlMessageStatus.md b/docs/packages/fuel-ts-wallet/enums/internal-GqlMessageStatus.md deleted file mode 100644 index 89db68b61ac..00000000000 --- a/docs/packages/fuel-ts-wallet/enums/internal-GqlMessageStatus.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: GqlMessageStatus -parent: "@fuel-ts/wallet" -nav_order: 4 - ---- - -# Enumeration: GqlMessageStatus - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).GqlMessageStatus - -## Enumeration Members - -### Spent - -• **Spent** = ``"SPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:373 - -___ - -### Unspent - -• **Unspent** = ``"UNSPENT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:374 diff --git a/docs/packages/fuel-ts-wallet/enums/internal-GqlReturnType.md b/docs/packages/fuel-ts-wallet/enums/internal-GqlReturnType.md deleted file mode 100644 index fad8cf53bea..00000000000 --- a/docs/packages/fuel-ts-wallet/enums/internal-GqlReturnType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: GqlReturnType -parent: "@fuel-ts/wallet" -nav_order: 4 - ---- - -# Enumeration: GqlReturnType - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).GqlReturnType - -## Enumeration Members - -### Return - -• **Return** = ``"RETURN"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:688 - -___ - -### ReturnData - -• **ReturnData** = ``"RETURN_DATA"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:689 - -___ - -### Revert - -• **Revert** = ``"REVERT"`` - -#### Defined in - -packages/providers/src/__generated__/operations.ts:690 diff --git a/docs/packages/fuel-ts-wallet/enums/internal-TransactionType.md b/docs/packages/fuel-ts-wallet/enums/internal-TransactionType.md deleted file mode 100644 index 59c0ac345f8..00000000000 --- a/docs/packages/fuel-ts-wallet/enums/internal-TransactionType.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: TransactionType -parent: "@fuel-ts/wallet" -nav_order: 4 - ---- - -# Enumeration: TransactionType - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).TransactionType - -## Enumeration Members - -### Create - -• **Create** = ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Mint - -• **Mint** = ``2`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L22) - -___ - -### Script - -• **Script** = ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) diff --git a/docs/packages/fuel-ts-wallet/index.md b/docs/packages/fuel-ts-wallet/index.md deleted file mode 100644 index f79e2a302b6..00000000000 --- a/docs/packages/fuel-ts-wallet/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: default -title: "@fuel-ts/wallet" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/wallet - -## Namespaces - -- [internal](namespaces/internal.md) - -## Classes - -- [Account](classes/Account.md) -- [BaseWalletUnlocked](classes/BaseWalletUnlocked.md) -- [Wallet](classes/Wallet.md) -- [WalletLocked](classes/WalletLocked.md) -- [WalletUnlocked](classes/WalletUnlocked.md) diff --git a/docs/packages/fuel-ts-wallet/interfaces/internal-BNHelper.md b/docs/packages/fuel-ts-wallet/interfaces/internal-BNHelper.md deleted file mode 100644 index 1dcb5a70347..00000000000 --- a/docs/packages/fuel-ts-wallet/interfaces/internal-BNHelper.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -title: BNHelper -parent: "@fuel-ts/wallet" -nav_order: 2 - ---- - -# Interface: BNHelper - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).BNHelper - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### toBytes - -• **toBytes**: (`bytesPadding?`: `number`) => `Uint8Array` - -#### Type declaration - -▸ (`bytesPadding?`): `Uint8Array` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`Uint8Array` - -#### Defined in - -[packages/math/src/bn.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L12) - -___ - -### toHex - -• **toHex**: (`bytesPadding?`: `number`) => `string` - -#### Type declaration - -▸ (`bytesPadding?`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `bytesPadding?` | `number` | - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L11) - -___ - -### toJSON - -• **toJSON**: () => `string` - -#### Type declaration - -▸ (): `string` - -##### Returns - -`string` - -#### Defined in - -[packages/math/src/bn.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L13) - -## Methods - -### caller - -▸ **caller**(`v`, `methodName`): `boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | -| `methodName` | `string` | - -#### Returns - -`boolean` \| [`BN`](../classes/internal-BN.md) \| [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L10) diff --git a/docs/packages/fuel-ts-wallet/interfaces/internal-BNHiddenTypes.md b/docs/packages/fuel-ts-wallet/interfaces/internal-BNHiddenTypes.md deleted file mode 100644 index 6b648d262ec..00000000000 --- a/docs/packages/fuel-ts-wallet/interfaces/internal-BNHiddenTypes.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: BNHiddenTypes -parent: "@fuel-ts/wallet" -nav_order: 2 - ---- - -# Interface: BNHiddenTypes - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).BNHiddenTypes - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### divmod - -• **divmod**: (`num`: [`BNInput`](../namespaces/internal.md#bninput), `mode?`: `string`, `positive?`: `boolean`) => { `div`: [`BN`](../classes/internal-BN.md) ; `mod`: [`BN`](../classes/internal-BN.md) } - -#### Type declaration - -▸ (`num`, `mode?`, `positive?`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BNInput`](../namespaces/internal.md#bninput) | -| `mode?` | `string` | -| `positive?` | `boolean` | - -##### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `div` | [`BN`](../classes/internal-BN.md) | -| `mod` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/math/src/bn.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L39) - -___ - -### mulTo - -• **mulTo**: (`num`: [`BN`](../classes/internal-BN.md), `out`: [`BN`](../classes/internal-BN.md)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`num`, `out`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `num` | [`BN`](../classes/internal-BN.md) | -| `out` | [`BN`](../classes/internal-BN.md) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L38) diff --git a/docs/packages/fuel-ts-wallet/interfaces/internal-BNInputOverrides.md b/docs/packages/fuel-ts-wallet/interfaces/internal-BNInputOverrides.md deleted file mode 100644 index 94b4dda0097..00000000000 --- a/docs/packages/fuel-ts-wallet/interfaces/internal-BNInputOverrides.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: default -title: BNInputOverrides -parent: "@fuel-ts/wallet" -nav_order: 2 - ---- - -# Interface: BNInputOverrides - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).BNInputOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### add - -• **add**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L16) - -___ - -### cmp - -• **cmp**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`CompareResult`](../namespaces/internal.md#compareresult) - -#### Type declaration - -▸ (`v`): [`CompareResult`](../namespaces/internal.md#compareresult) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`CompareResult`](../namespaces/internal.md#compareresult) - -#### Defined in - -[packages/math/src/bn.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L28) - -___ - -### div - -• **div**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L19) - -___ - -### divRound - -• **divRound**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L22) - -___ - -### eq - -• **eq**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L27) - -___ - -### gt - -• **gt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L25) - -___ - -### gte - -• **gte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L26) - -___ - -### lt - -• **lt**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L23) - -___ - -### lte - -• **lte**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => `boolean` - -#### Type declaration - -▸ (`v`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -`boolean` - -#### Defined in - -[packages/math/src/bn.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L24) - -___ - -### mod - -• **mod**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L21) - -___ - -### mul - -• **mul**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L20) - -___ - -### pow - -• **pow**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L17) - -___ - -### sub - -• **sub**: (`v`: [`BNInput`](../namespaces/internal.md#bninput)) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`v`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `v` | [`BNInput`](../namespaces/internal.md#bninput) | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L18) diff --git a/docs/packages/fuel-ts-wallet/interfaces/internal-BNOverrides.md b/docs/packages/fuel-ts-wallet/interfaces/internal-BNOverrides.md deleted file mode 100644 index ae2073421cd..00000000000 --- a/docs/packages/fuel-ts-wallet/interfaces/internal-BNOverrides.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -layout: default -title: BNOverrides -parent: "@fuel-ts/wallet" -nav_order: 2 - ---- - -# Interface: BNOverrides - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).BNOverrides - -## Implemented by - -- [`BN`](../classes/internal-BN.md) - -## Properties - -### abs - -• **abs**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L33) - -___ - -### fromTwos - -• **fromTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L35) - -___ - -### neg - -• **neg**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L32) - -___ - -### sqr - -• **sqr**: () => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (): [`BN`](../classes/internal-BN.md) - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L31) - -___ - -### toTwos - -• **toTwos**: (`width`: `number`) => [`BN`](../classes/internal-BN.md) - -#### Type declaration - -▸ (`width`): [`BN`](../classes/internal-BN.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `width` | `number` | - -##### Returns - -[`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/bn.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L34) diff --git a/docs/packages/fuel-ts-wallet/interfaces/internal-BaseTransactionRequestLike.md b/docs/packages/fuel-ts-wallet/interfaces/internal-BaseTransactionRequestLike.md deleted file mode 100644 index 591c453df70..00000000000 --- a/docs/packages/fuel-ts-wallet/interfaces/internal-BaseTransactionRequestLike.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -layout: default -title: BaseTransactionRequestLike -parent: "@fuel-ts/wallet" -nav_order: 2 - ---- - -# Interface: BaseTransactionRequestLike - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).BaseTransactionRequestLike - -## Hierarchy - -- **`BaseTransactionRequestLike`** - - ↳ [`ScriptTransactionRequestLike`](internal-ScriptTransactionRequestLike.md) - - ↳ [`CreateTransactionRequestLike`](internal-CreateTransactionRequestLike.md) - -## Implemented by - -- [`BaseTransactionRequest`](../classes/internal-BaseTransactionRequest.md) - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-wallet/interfaces/internal-CreateTransactionRequestLike.md b/docs/packages/fuel-ts-wallet/interfaces/internal-CreateTransactionRequestLike.md deleted file mode 100644 index 37177bd6f32..00000000000 --- a/docs/packages/fuel-ts-wallet/interfaces/internal-CreateTransactionRequestLike.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -layout: default -title: CreateTransactionRequestLike -parent: "@fuel-ts/wallet" -nav_order: 2 - ---- - -# Interface: CreateTransactionRequestLike - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).CreateTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`CreateTransactionRequestLike`** - -## Properties - -### bytecodeWitnessIndex - -• `Optional` **bytecodeWitnessIndex**: `number` - -Witness index of contract bytecode to create - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:504](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L504) - -___ - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### salt - -• `Optional` **salt**: `BytesLike` - -Salt - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:506](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L506) - -___ - -### storageSlots - -• `Optional` **storageSlots**: [`TransactionRequestStorageSlot`](../namespaces/internal.md#transactionrequeststorageslot)[] - -List of storage slots to initialize - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:508](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L508) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-wallet/interfaces/internal-GenerateOptions.md b/docs/packages/fuel-ts-wallet/interfaces/internal-GenerateOptions.md deleted file mode 100644 index 88157dff2ca..00000000000 --- a/docs/packages/fuel-ts-wallet/interfaces/internal-GenerateOptions.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: GenerateOptions -parent: "@fuel-ts/wallet" -nav_order: 2 - ---- - -# Interface: GenerateOptions - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).GenerateOptions - -## Properties - -### entropy - -• `Optional` **entropy**: `BytesLike` - -Additional entropy for the random bytes - -#### Defined in - -[packages/wallet/src/types/GenerateOptions.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/types/GenerateOptions.ts#L6) - -___ - -### provider - -• `Optional` **provider**: `string` \| `default` - -#### Defined in - -[packages/wallet/src/types/GenerateOptions.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/types/GenerateOptions.ts#L7) diff --git a/docs/packages/fuel-ts-wallet/interfaces/internal-ScriptTransactionRequestLike.md b/docs/packages/fuel-ts-wallet/interfaces/internal-ScriptTransactionRequestLike.md deleted file mode 100644 index b482c2a5a56..00000000000 --- a/docs/packages/fuel-ts-wallet/interfaces/internal-ScriptTransactionRequestLike.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -layout: default -title: ScriptTransactionRequestLike -parent: "@fuel-ts/wallet" -nav_order: 2 - ---- - -# Interface: ScriptTransactionRequestLike - -[@fuel-ts/wallet](../index.md).[internal](../namespaces/internal.md).ScriptTransactionRequestLike - -## Hierarchy - -- [`BaseTransactionRequestLike`](internal-BaseTransactionRequestLike.md) - - ↳ **`ScriptTransactionRequestLike`** - -## Properties - -### gasLimit - -• `Optional` **gasLimit**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas limit for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasLimit](internal-BaseTransactionRequestLike.md#gaslimit) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:83](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L83) - -___ - -### gasPrice - -• `Optional` **gasPrice**: [`BigNumberish`](../namespaces/internal.md#bignumberish) - -Gas price for transaction - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[gasPrice](internal-BaseTransactionRequestLike.md#gasprice) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:81](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L81) - -___ - -### inputs - -• `Optional` **inputs**: [`TransactionRequestInput`](../namespaces/internal.md#transactionrequestinput)[] - -List of inputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[inputs](internal-BaseTransactionRequestLike.md#inputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L87) - -___ - -### maturity - -• `Optional` **maturity**: `number` - -Block until which tx cannot be included - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[maturity](internal-BaseTransactionRequestLike.md#maturity) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L85) - -___ - -### outputs - -• `Optional` **outputs**: [`TransactionRequestOutput`](../namespaces/internal.md#transactionrequestoutput)[] - -List of outputs - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[outputs](internal-BaseTransactionRequestLike.md#outputs) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:89](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L89) - -___ - -### script - -• `Optional` **script**: `BytesLike` - -Script to execute - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:384](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L384) - -___ - -### scriptData - -• `Optional` **scriptData**: `BytesLike` - -Script input data (parameters) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:386](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L386) - -___ - -### witnesses - -• `Optional` **witnesses**: `BytesLike`[] - -List of witnesses - -#### Inherited from - -[BaseTransactionRequestLike](internal-BaseTransactionRequestLike.md).[witnesses](internal-BaseTransactionRequestLike.md#witnesses) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:91](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L91) diff --git a/docs/packages/fuel-ts-wallet/namespaces/internal.md b/docs/packages/fuel-ts-wallet/namespaces/internal.md deleted file mode 100644 index 237ccab0e2e..00000000000 --- a/docs/packages/fuel-ts-wallet/namespaces/internal.md +++ /dev/null @@ -1,1452 +0,0 @@ ---- -layout: default -title: internal -parent: "@fuel-ts/wallet" -nav_order: 3 - ---- - -# Namespace: internal - -[@fuel-ts/wallet](../index.md).internal - -## Enumerations - -- [GqlCoinStatus](../enums/internal-GqlCoinStatus.md) -- [GqlMessageStatus](../enums/internal-GqlMessageStatus.md) -- [GqlReturnType](../enums/internal-GqlReturnType.md) -- [TransactionType](../enums/internal-TransactionType.md) - -## Classes - -- [AbstractAccount](../classes/internal-AbstractAccount.md) -- [AbstractAddress](../classes/internal-AbstractAddress.md) -- [AbstractContract](../classes/internal-AbstractContract.md) -- [AbstractProgram](../classes/internal-AbstractProgram.md) -- [AbstractScriptRequest](../classes/internal-AbstractScriptRequest.md) -- [BN](../classes/internal-BN.md) -- [BaseTransactionRequest](../classes/internal-BaseTransactionRequest.md) -- [CreateTransactionRequest](../classes/internal-CreateTransactionRequest.md) -- [ScriptTransactionRequest](../classes/internal-ScriptTransactionRequest.md) -- [Signer](../classes/internal-Signer.md) -- [TransactionResponse](../classes/internal-TransactionResponse.md) - -## Interfaces - -- [BNHelper](../interfaces/internal-BNHelper.md) -- [BNHiddenTypes](../interfaces/internal-BNHiddenTypes.md) -- [BNInputOverrides](../interfaces/internal-BNInputOverrides.md) -- [BNOverrides](../interfaces/internal-BNOverrides.md) -- [BaseTransactionRequestLike](../interfaces/internal-BaseTransactionRequestLike.md) -- [CreateTransactionRequestLike](../interfaces/internal-CreateTransactionRequestLike.md) -- [GenerateOptions](../interfaces/internal-GenerateOptions.md) -- [ScriptTransactionRequestLike](../interfaces/internal-ScriptTransactionRequestLike.md) - -## Enumeration Members - -### Call - -• **Call**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L10) - -___ - -### Change - -• **Change**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L10) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L15) - -___ - -### Coin - -• **Coin**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L7) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L16) - -___ - -### Contract - -• **Contract**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L8) - -___ - -### ContractCreated - -• **ContractCreated**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L12) - -___ - -### Create - -• **Create**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:21](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L21) - -___ - -### Log - -• **Log**: ``5`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L15) - -___ - -### LogData - -• **LogData**: ``6`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/input.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L17) - -___ - -### Message - -• **Message**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L9) - -___ - -### MessageOut - -• **MessageOut**: ``10`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L20) - -___ - -### Panic - -• **Panic**: ``3`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L13) - -___ - -### Return - -• **Return**: ``1`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L11) - -___ - -### ReturnData - -• **ReturnData**: ``2`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L12) - -___ - -### Revert - -• **Revert**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L14) - -___ - -### Script - -• **Script**: ``0`` - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) - -___ - -### ScriptResult - -• **ScriptResult**: ``9`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L19) - -___ - -### Transfer - -• **Transfer**: ``7`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L17) - -___ - -### TransferOut - -• **TransferOut**: ``8`` - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L18) - -___ - -### Variable - -• **Variable**: ``4`` - -#### Defined in - -[packages/transactions/src/coders/output.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L11) - -## Type Aliases - -### AddressLike - -Ƭ **AddressLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractAccount`](../classes/internal-AbstractAccount.md) - -#### Defined in - -[packages/interfaces/src/index.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L55) - -___ - -### BNInput - -Ƭ **BNInput**: `number` \| `string` \| `number`[] \| `Uint8Array` \| `Buffer` \| `BnJs` - -#### Defined in - -[packages/math/src/bn.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L8) - -___ - -### BigNumberish - -Ƭ **BigNumberish**: `string` \| `number` \| [`BN`](../classes/internal-BN.md) - -#### Defined in - -[packages/math/src/types.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L3) - -___ - -### CallResult - -Ƭ **CallResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | - -#### Defined in - -[packages/providers/src/provider.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L42) - -___ - -### ChangeTransactionRequestOutput - -Ƭ **ChangeTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L30) - -___ - -### Coin - -Ƭ **Coin**: `Object` - -A Fuel coin - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `blockCreated` | [`BN`](../classes/internal-BN.md) | -| `id` | `string` | -| `maturity` | `number` | -| `owner` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlCoinStatus`](../enums/internal-GqlCoinStatus.md) | - -#### Defined in - -[packages/providers/src/coin.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin.ts#L9) - -___ - -### CoinQuantity - -Ƭ **CoinQuantity**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `assetId` | `string` | -| `max?` | [`BN`](../classes/internal-BN.md) | - -#### Defined in - -[packages/providers/src/coin-quantity.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L10) - -___ - -### CoinQuantityLike - -Ƭ **CoinQuantityLike**: [amount: BigNumberish, assetId?: BytesLike, max?: BigNumberish] \| { `amount`: [`BigNumberish`](internal.md#bignumberish) ; `assetId?`: `BytesLike` ; `max?`: [`BigNumberish`](internal.md#bignumberish) } - -#### Defined in - -[packages/providers/src/coin-quantity.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/coin-quantity.ts#L7) - -___ - -### CoinTransactionRequestInput - -Ƭ **CoinTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `assetId` | `BytesLike` | Asset ID of the coins | -| `id` | `BytesLike` | UTXO ID | -| `maturity?` | `number` | UTXO being spent must have been created at least this many blocks ago | -| `owner` | `BytesLike` | Owning address or script hash | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L9) - -___ - -### CoinTransactionRequestOutput - -Ƭ **CoinTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins to send | -| `assetId` | `BytesLike` | Asset ID of coins | -| `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L9) - -___ - -### CompareResult - -Ƭ **CompareResult**: ``-1`` \| ``0`` \| ``1`` - -#### Defined in - -[packages/math/src/bn.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/bn.ts#L7) - -___ - -### ContractCreatedTransactionRequestOutput - -Ƭ **ContractCreatedTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `stateRoot` | `BytesLike` | State Root | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L40) - -___ - -### ContractIdLike - -Ƭ **ContractIdLike**: [`AbstractAddress`](../classes/internal-AbstractAddress.md) \| [`AbstractContract`](../classes/internal-AbstractContract.md) - -#### Defined in - -[packages/interfaces/src/index.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/interfaces/src/index.ts#L57) - -___ - -### ContractTransactionRequestInput - -Ƭ **ContractTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `BytesLike` | Contract ID | -| `txPointer` | `BytesLike` | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:66](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L66) - -___ - -### ContractTransactionRequestOutput - -Ƭ **ContractTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `inputIndex` | `number` | Index of input contract | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L18) - -___ - -### ExcludeResourcesOption - -Ƭ **ExcludeResourcesOption**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `messages?` | `BytesLike`[] | -| `utxos?` | `BytesLike`[] | - -#### Defined in - -[packages/providers/src/resource.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L36) - -___ - -### FormatConfig - -Ƭ **FormatConfig**: { `units?`: `number` } & [`ToFixedConfig`](internal.md#tofixedconfig) - -#### Defined in - -[packages/math/src/types.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L8) - -___ - -### Input - -Ƭ **Input**: [`InputCoin`](internal.md#inputcoin) \| [`InputContract`](internal.md#inputcontract) \| [`InputMessage`](internal.md#inputmessage) - -#### Defined in - -[packages/transactions/src/coders/input.ts:324](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L324) - -___ - -### InputCoin - -Ƭ **InputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins (u64) | -| `assetId` | `string` | Asset ID of the coins (b256) | -| `maturity` | `number` | UTXO being spent must have been created at least this many blocks ago (u32) | -| `owner` | `string` | Owning address or script hash (b256) | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Coin`](internal.md#coin) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | -| `witnessIndex` | `number` | Index of witness that authorizes spending the coin (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L20) - -___ - -### InputContract - -Ƭ **InputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract before transaction execution (b256) | -| `contractID` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract before transaction execution (b256) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | Points to the TX whose output is being spent. (TxPointer) | -| `type` | [`Contract`](internal.md#contract) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:131](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L131) - -___ - -### InputMessage - -Ƭ **InputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins | -| `data` | `string` | data of message | -| `dataLength` | `number` | Length of predicate, in instructions (u16) | -| `nonce` | [`BN`](../classes/internal-BN.md) | Unique nonce of message | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `number` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `number` | Length of predicate, in instructions (u16) | -| `recipient` | `string` | Address of sender | -| `sender` | `string` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes message (u8) | - -#### Defined in - -[packages/transactions/src/coders/input.ts:196](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L196) - -___ - -### Message - -Ƭ **Message**: `Object` - -A Fuel message - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | -| `daHeight` | [`BN`](../classes/internal-BN.md) | -| `data` | `BytesLike` | -| `nonce` | [`BN`](../classes/internal-BN.md) | -| `recipient` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `sender` | [`AbstractAddress`](../classes/internal-AbstractAddress.md) | -| `status` | [`GqlMessageStatus`](../enums/internal-GqlMessageStatus.md) | - -#### Defined in - -[packages/providers/src/message.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/message.ts#L11) - -___ - -### MessageTransactionRequestInput - -Ƭ **MessageTransactionRequestInput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins | -| `data` | `BytesLike` | data of message | -| `nonce` | [`BigNumberish`](internal.md#bignumberish) | Unique nonce of message | -| `predicate?` | `BytesLike` | Predicate bytecode | -| `predicateData?` | `BytesLike` | Predicate input data (parameters) | -| `recipient` | `BytesLike` | Address of sender | -| `sender` | `BytesLike` | Address of sender | -| `type` | [`Message`](internal.md#message) | - | -| `witnessIndex` | `number` | Index of witness that authorizes the message | - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L39) - -___ - -### MessageTransactionRequestOutput - -Ƭ **MessageTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BigNumberish`](internal.md#bignumberish) | Amount of coins sent with message | -| `recipient` | `BytesLike` | Receiving address | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L23) - -___ - -### Output - -Ƭ **Output**: [`OutputCoin`](internal.md#outputcoin) \| [`OutputContract`](internal.md#outputcontract) \| [`OutputMessage`](internal.md#outputmessage) \| [`OutputChange`](internal.md#outputchange) \| [`OutputVariable`](internal.md#outputvariable) \| [`OutputContractCreated`](internal.md#outputcontractcreated) - -#### Defined in - -[packages/transactions/src/coders/output.ts:294](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L294) - -___ - -### OutputChange - -Ƭ **OutputChange**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:153](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L153) - -___ - -### OutputCoin - -Ƭ **OutputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Coin`](internal.md#coin-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L15) - -___ - -### OutputContract - -Ƭ **OutputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract after transaction execution (b256) | -| `inputIndex` | `number` | Index of input contract (u8) | -| `stateRoot` | `string` | State root of contract after transaction execution (b256) | -| `type` | [`Contract`](internal.md#contract-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L63) - -___ - -### OutputContractCreated - -Ƭ **OutputContractCreated**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract (b256) | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:249](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L249) - -___ - -### OutputMessage - -Ƭ **OutputMessage**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send with message (u64) | -| `recipient` | `string` | Receiving address (b256) | -| `type` | [`Message`](internal.md#message-1) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:111](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L111) - -___ - -### OutputVariable - -Ƭ **OutputVariable**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to send (u64) | -| `assetId` | `string` | Asset ID of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Variable`](internal.md#variable) | - | - -#### Defined in - -[packages/transactions/src/coders/output.ts:201](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L201) - -___ - -### PossibleTransactions - -Ƭ **PossibleTransactions**: [`TransactionScript`](internal.md#transactionscript) \| [`TransactionCreate`](internal.md#transactioncreate) \| [`TransactionMint`](internal.md#transactionmint) - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:347](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L347) - -___ - -### ReceiptCall - -Ƭ **ReceiptCall**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins to forward, i.e. $rB (u64) | -| `assetId` | `string` | Asset ID of coins to forward, i.e. MEM[$rC, 32] (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `gas` | [`BN`](../classes/internal-BN.md) | Gas to forward, i.e. $rD (u64) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `param1` | [`BN`](../classes/internal-BN.md) | First parameter (u64) | -| `param2` | [`BN`](../classes/internal-BN.md) | Second parameter (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of called contract (b256) | -| `type` | [`Call`](internal.md#call) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:23](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L23) - -___ - -### ReceiptLog - -Ƭ **ReceiptLog**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Log`](internal.md#log) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `val2` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `val3` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:341](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L341) - -___ - -### ReceiptLogData - -Ƭ **ReceiptLogData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rC, $rD] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rD (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rC (u64) | -| `type` | [`LogData`](internal.md#logdata) | - | -| `val0` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `val1` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:413](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L413) - -___ - -### ReceiptMessageOut - -Ƭ **ReceiptMessageOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Hexadecimal string representation of a 64-bit unsigned integer; value of register $rD | -| `data` | `Uint8Array` | Hexadecimal string representation of the value of the memory range MEM[$rA + 32, $rB] | -| `digest` | `string` | Hexadecimal string representation of 256-bit (32-byte), hash of MEM[$rA + 32, $rB] | -| `messageID` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message ID | -| `nonce` | `string` | Hexadecimal string representation of the 256-bit (32-byte) message nonce | -| `recipient` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message recipient: MEM[$rA, 32] | -| `sender` | `string` | Hexadecimal string representation of the 256-bit (32-byte) address of the message sender: MEM[$fp, 32] | -| `type` | [`MessageOut`](internal.md#messageout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:665](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L665) - -___ - -### ReceiptPanic - -Ƭ **ReceiptPanic**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Value of optional contract ID | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `reason` | [`BN`](../classes/internal-BN.md) | Panic reason (u64) | -| `type` | [`Panic`](internal.md#panic) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:227](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L227) - -___ - -### ReceiptReturn - -Ƭ **ReceiptReturn**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Return`](internal.md#return) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:107](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L107) - -___ - -### ReceiptReturnData - -Ƭ **ReceiptReturnData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rA, $rB] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `len` | [`BN`](../classes/internal-BN.md) | Value of register $rB (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `ptr` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | -| `type` | [`ReturnData`](internal.md#returndata) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:161](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L161) - -___ - -### ReceiptRevert - -Ƭ **ReceiptRevert**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `type` | [`Revert`](internal.md#revert) | - | -| `val` | [`BN`](../classes/internal-BN.md) | Value of register $rA (u64) | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:287](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L287) - -___ - -### ReceiptScriptResult - -Ƭ **ReceiptScriptResult**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | Gas consumed by the script (u64) | -| `result` | [`BN`](../classes/internal-BN.md) | Result variant with embedded `PanicReason` in first 8 bits and `instr` (u64) | -| `type` | [`ScriptResult`](internal.md#scriptresult) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:623](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L623) - -___ - -### ReceiptTransfer - -Ƭ **ReceiptTransfer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Contract ID of contract to transfer coins to (b256) | -| `type` | [`Transfer`](internal.md#transfer) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:491](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L491) - -___ - -### ReceiptTransferOut - -Ƭ **ReceiptTransferOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | [`BN`](../classes/internal-BN.md) | Amount of coins transferred (u64) | -| `assetId` | `string` | Asset ID of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | [`BN`](../classes/internal-BN.md) | Value of register $is (u64) | -| `pc` | [`BN`](../classes/internal-BN.md) | Value of register $pc (u64) | -| `to` | `string` | Address to transfer coins to (b256) | -| `type` | [`TransferOut`](internal.md#transferout) | - | - -#### Defined in - -[packages/transactions/src/coders/receipt.ts:557](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L557) - -___ - -### Resource - -Ƭ **Resource**: [`Coin`](internal.md#coin-2) \| [`Message`](internal.md#message-2) - -#### Defined in - -[packages/providers/src/resource.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/resource.ts#L32) - -___ - -### StorageSlot - -Ƭ **StorageSlot**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `key` | `string` | Key (b256) | -| `value` | `string` | Value (b256) | - -#### Defined in - -[packages/transactions/src/coders/storage-slot.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/storage-slot.ts#L3) - -___ - -### ToFixedConfig - -Ƭ **ToFixedConfig**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `minPrecision?` | `number` | -| `precision?` | `number` | - -#### Defined in - -[packages/math/src/types.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/math/src/types.ts#L4) - -___ - -### Transaction - -Ƭ **Transaction**<`TTransactionType`\>: `TTransactionType` extends [`TransactionType`](../enums/internal-TransactionType.md) ? `Extract`<[`PossibleTransactions`](internal.md#possibletransactions), { `type`: `TTransactionType` }\> : `Partial`<`Omit`<[`TransactionScript`](internal.md#transactionscript), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionCreate`](internal.md#transactioncreate), ``"type"``\>\> & `Partial`<`Omit`<[`TransactionMint`](internal.md#transactionmint), ``"type"``\>\> & { `type`: [`TransactionType`](../enums/internal-TransactionType.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TTransactionType` | `void` | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:348](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L348) - -___ - -### TransactionCreate - -Ƭ **TransactionCreate**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bytecodeLength` | `number` | Contract bytecode length, in instructions (u16) | -| `bytecodeWitnessIndex` | `number` | Witness index of contract bytecode to create (u8) | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `salt` | `string` | Salt (b256) | -| `storageSlots` | [`StorageSlot`](internal.md#storageslot)[] | List of inputs (StorageSlot[]) | -| `storageSlotsCount` | `number` | Number of storage slots to initialize (u16) | -| `type` | [`Create`](internal.md#create) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L159) - -___ - -### TransactionMint - -Ƭ **TransactionMint**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `txPointer` | [`TxPointer`](internal.md#txpointer) | The location of the Mint transaction in the block. | -| `type` | [`Mint`](../enums/internal-TransactionType.md#mint) | - | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:297](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L297) - -___ - -### TransactionRequest - -Ƭ **TransactionRequest**: [`ScriptTransactionRequest`](../classes/internal-ScriptTransactionRequest.md) \| [`CreateTransactionRequest`](../classes/internal-CreateTransactionRequest.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:576](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L576) - -___ - -### TransactionRequestInput - -Ƭ **TransactionRequestInput**: [`CoinTransactionRequestInput`](internal.md#cointransactionrequestinput) \| [`ContractTransactionRequestInput`](internal.md#contracttransactionrequestinput) \| [`MessageTransactionRequestInput`](internal.md#messagetransactionrequestinput) - -#### Defined in - -[packages/providers/src/transaction-request/input.ts:75](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L75) - -___ - -### TransactionRequestLike - -Ƭ **TransactionRequestLike**: { `type`: [`Script`](internal.md#script) } & [`ScriptTransactionRequestLike`](../interfaces/internal-ScriptTransactionRequestLike.md) \| { `type`: [`Create`](internal.md#create) } & [`CreateTransactionRequestLike`](../interfaces/internal-CreateTransactionRequestLike.md) - -#### Defined in - -[packages/providers/src/transaction-request/transaction-request.ts:577](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L577) - -___ - -### TransactionRequestOutput - -Ƭ **TransactionRequestOutput**: [`CoinTransactionRequestOutput`](internal.md#cointransactionrequestoutput) \| [`ContractTransactionRequestOutput`](internal.md#contracttransactionrequestoutput) \| [`MessageTransactionRequestOutput`](internal.md#messagetransactionrequestoutput) \| [`ChangeTransactionRequestOutput`](internal.md#changetransactionrequestoutput) \| [`VariableTransactionRequestOutput`](internal.md#variabletransactionrequestoutput) \| [`ContractCreatedTransactionRequestOutput`](internal.md#contractcreatedtransactionrequestoutput) - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L47) - -___ - -### TransactionRequestStorageSlot - -Ƭ **TransactionRequestStorageSlot**: { `key`: `BytesLike` ; `value`: `BytesLike` } \| [key: BytesLike, value: BytesLike] - -#### Defined in - -[packages/providers/src/transaction-request/storage-slot.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/storage-slot.ts#L5) - -___ - -### TransactionResult - -Ƭ **TransactionResult**<`TStatus`, `TTransactionType`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TStatus` | extends ``"success"`` \| ``"failure"`` | -| `TTransactionType` | `void` | - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockId` | `any` | - | -| `fee` | [`BN`](../classes/internal-BN.md) | - | -| `gasUsed` | [`BN`](../classes/internal-BN.md) | - | -| `receipts` | [`TransactionResultReceipt`](internal.md#transactionresultreceipt)[] | Receipts produced during the execution of the transaction | -| `status` | `TStatus` extends ``"success"`` ? { `programState`: `any` ; `type`: ``"success"`` } : { `reason`: `any` ; `type`: ``"failure"`` } | - | -| `time` | `any` | - | -| `transaction` | [`Transaction`](internal.md#transaction)<`TTransactionType`\> | - | -| `transactionId` | `string` | - | - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L54) - -___ - -### TransactionResultCallReceipt - -Ƭ **TransactionResultCallReceipt**: [`ReceiptCall`](internal.md#receiptcall) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L29) - -___ - -### TransactionResultLogDataReceipt - -Ƭ **TransactionResultLogDataReceipt**: [`ReceiptLogData`](internal.md#receiptlogdata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L35) - -___ - -### TransactionResultLogReceipt - -Ƭ **TransactionResultLogReceipt**: [`ReceiptLog`](internal.md#receiptlog) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L34) - -___ - -### TransactionResultMessageOutReceipt - -Ƭ **TransactionResultMessageOutReceipt**: [`ReceiptMessageOut`](internal.md#receiptmessageout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:39](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L39) - -___ - -### TransactionResultPanicReceipt - -Ƭ **TransactionResultPanicReceipt**: [`ReceiptPanic`](internal.md#receiptpanic) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L32) - -___ - -### TransactionResultReceipt - -Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](internal.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](internal.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](internal.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](internal.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](internal.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](internal.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](internal.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](internal.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](internal.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](internal.md#transactionresultscriptresultreceipt) \| [`TransactionResultMessageOutReceipt`](internal.md#transactionresultmessageoutreceipt) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L41) - -___ - -### TransactionResultReturnDataReceipt - -Ƭ **TransactionResultReturnDataReceipt**: [`ReceiptReturnData`](internal.md#receiptreturndata) & { `data`: `string` } - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L31) - -___ - -### TransactionResultReturnReceipt - -Ƭ **TransactionResultReturnReceipt**: [`ReceiptReturn`](internal.md#receiptreturn) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L30) - -___ - -### TransactionResultRevertReceipt - -Ƭ **TransactionResultRevertReceipt**: [`ReceiptRevert`](internal.md#receiptrevert) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L33) - -___ - -### TransactionResultScriptResultReceipt - -Ƭ **TransactionResultScriptResultReceipt**: [`ReceiptScriptResult`](internal.md#receiptscriptresult) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L38) - -___ - -### TransactionResultTransferOutReceipt - -Ƭ **TransactionResultTransferOutReceipt**: [`ReceiptTransferOut`](internal.md#receipttransferout) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L37) - -___ - -### TransactionResultTransferReceipt - -Ƭ **TransactionResultTransferReceipt**: [`ReceiptTransfer`](internal.md#receipttransfer) - -#### Defined in - -[packages/providers/src/transaction-response/transaction-response.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L36) - -___ - -### TransactionScript - -Ƭ **TransactionScript**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasLimit` | [`BN`](../classes/internal-BN.md) | Gas limit for transaction (u64) | -| `gasPrice` | [`BN`](../classes/internal-BN.md) | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `number` | Number of inputs (u8) | -| `maturity` | `number` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `number` | Number of outputs (u8) | -| `receiptsRoot` | `string` | Merkle root of receipts (b256) | -| `script` | `string` | Script to execute (byte[]) | -| `scriptData` | `string` | Script input data (parameters) (byte[]) | -| `scriptDataLength` | `number` | Length of script input data, in bytes (u16) | -| `scriptLength` | `number` | Script length, in instructions (u16) | -| `type` | [`Script`](internal.md#script) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `number` | Number of witnesses (u8) | - -#### Defined in - -[packages/transactions/src/coders/transaction.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L25) - -___ - -### TxPointer - -Ƭ **TxPointer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `blockHeight` | `number` | Block height (u32) | -| `txIndex` | `number` | Transaction index (u16) | - -#### Defined in - -[packages/transactions/src/coders/tx-pointer.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/tx-pointer.ts#L3) - -___ - -### UtxoId - -Ƭ **UtxoId**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputIndex` | `number` | Output index (u8) | -| `transactionId` | `string` | Transaction ID (b256) | - -#### Defined in - -[packages/transactions/src/coders/utxo-id.ts:3](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L3) - -___ - -### VariableTransactionRequestOutput - -Ƭ **VariableTransactionRequestOutput**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `type` | [`Variable`](internal.md#variable) | - -#### Defined in - -[packages/providers/src/transaction-request/output.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L37) - -___ - -### Witness - -Ƭ **Witness**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `string` | Witness data (byte[]) | -| `dataLength` | `number` | Length of witness data, in bytes (u32) | - -#### Defined in - -[packages/transactions/src/coders/witness.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L6) diff --git a/docs/packages/fuel-ts-wordlists/enums/Language.md b/docs/packages/fuel-ts-wordlists/enums/Language.md deleted file mode 100644 index df6c138440d..00000000000 --- a/docs/packages/fuel-ts-wordlists/enums/Language.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: default -title: Language -parent: "@fuel-ts/wordlists" -nav_order: 4 - ---- - -# Enumeration: Language - -[@fuel-ts/wordlists](../index.md).Language - -## Enumeration Members - -### english - -• **english** = ``"english"`` - -#### Defined in - -[packages/wordlists/src/index.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wordlists/src/index.ts#L4) diff --git a/docs/packages/fuel-ts-wordlists/index.md b/docs/packages/fuel-ts-wordlists/index.md deleted file mode 100644 index b2fd3842f42..00000000000 --- a/docs/packages/fuel-ts-wordlists/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: default -title: "@fuel-ts/wordlists" -has_children: true -has_toc: false -nav_order: 1 ---- - -# Module: @fuel-ts/wordlists - -## Enumerations - -- [Language](enums/Language.md) - -## Variables - -### english - -• `Const` **english**: `string`[] - -#### Defined in - -[packages/wordlists/src/words/english.ts:1](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wordlists/src/words/english.ts#L1) diff --git a/package.json b/package.json index c6bc2721958..311f5a60d5c 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,6 @@ "services:clean": "make services-clean", "services:restart": "run-s services:clean services:run", "changeset:publish": "changeset publish --no-git-tag", - "changeset:version-with-docs": "ts-node ./scripts/changeset-version-with-docs", "changeset:next": "ts-node ./scripts/changeset-next", "forc:update": "ts-node ./scripts/forc-update", "forc:check": "./scripts/forc-check.sh", @@ -82,10 +81,6 @@ "ts-node": "^10.9.1", "tsup": "^5.12.9", "turbo": "^1.6.1", - "typedoc": "^0.23.0", - "typedoc-just-the-docs-theme": "^0.0.1", - "typedoc-monorepo-link-types": "^0.0.4", - "typedoc-plugin-markdown": "^3.11.12", "typescript": "^4.8.4" } } diff --git a/packages/example-contract/src/example-contract.test.ts b/packages/example-contract/src/example-contract.test.ts index 09af8d989db..0ffe43b914a 100644 --- a/packages/example-contract/src/example-contract.test.ts +++ b/packages/example-contract/src/example-contract.test.ts @@ -1,4 +1,4 @@ -// #region typedoc:Testing-with-jest +// #region Testing-with-jest-ts import { generateTestWallet } from '@fuel-ts/wallet/test-utils'; import fs from 'fs'; import { ContractFactory, NativeAssetId, Provider, toHex } from 'fuels'; @@ -28,4 +28,4 @@ describe('ExampleContract', () => { expect(v2.toHex()).toBe(toHex(1337)); }); }); -// #endregion +// #endregion Testing-with-jest-ts diff --git a/packages/example-contract/src/main.sw b/packages/example-contract/src/main.sw index 1cbbcafd1be..eae32bceff6 100644 --- a/packages/example-contract/src/main.sw +++ b/packages/example-contract/src/main.sw @@ -1,4 +1,4 @@ -// #region typedoc:Testing-with-jest-contract +// #region Testing-with-jest-rust contract; abi ExampleContract { @@ -10,4 +10,4 @@ impl ExampleContract for Contract { input } } -// #endregion +// #endregion Testing-with-jest-rust diff --git a/packages/fuel-gauge/src/call-test-contract.test.ts b/packages/fuel-gauge/src/call-test-contract.test.ts index bde8a52ccfa..7316b5fc3cc 100644 --- a/packages/fuel-gauge/src/call-test-contract.test.ts +++ b/packages/fuel-gauge/src/call-test-contract.test.ts @@ -173,14 +173,14 @@ describe('CallTestContract', () => { }, ], }); - // #region typedoc:Contract-call-params + // #region Contract-call-params const { value } = await contract.functions .return_context_amount() .callParams({ forward: [1_000_000, NativeAssetId], }) .call(); - // #endregion + // #endregion Contract-call-params expect(value.toHex()).toBe(bn(1_000_000).toHex()); }); diff --git a/packages/fuel-gauge/src/contract-factory.test.ts b/packages/fuel-gauge/src/contract-factory.test.ts index 7e03003e4d7..9cb02b39e08 100644 --- a/packages/fuel-gauge/src/contract-factory.test.ts +++ b/packages/fuel-gauge/src/contract-factory.test.ts @@ -7,7 +7,7 @@ import storageSlots from '../test-projects/storage-test-contract/out/debug/stora describe('Contract Factory', () => { const createContractFactory = async () => { - // #region typedoc:contract-setup + // #region contract-setup // #context import { Provider, ContractFactory } from 'fuels'; // #context import { generateTestWallet } from '@fuel-ts/wallet/test-utils'; // basic setup @@ -28,7 +28,7 @@ describe('Contract Factory', () => { // send byteCode and ABI to ContractFactory to load const factory = new ContractFactory(byteCode, abi, wallet); - // #endregion + // #endregion contract-setup return factory; }; diff --git a/packages/fuel-gauge/src/contract.test.ts b/packages/fuel-gauge/src/contract.test.ts index 7cd48f4b06a..bed38868d8e 100644 --- a/packages/fuel-gauge/src/contract.test.ts +++ b/packages/fuel-gauge/src/contract.test.ts @@ -114,14 +114,14 @@ describe('Contract', () => { let failed; try { - // #region typedoc:Contract-tx-params + // #region Contract-tx-params await contract.functions .foo(1336) .txParams({ gasLimit: 1, }) .call(); - // #endregion + // #endregion Contract-tx-params } catch (e) { failed = true; } @@ -130,7 +130,7 @@ describe('Contract', () => { }); it('adds multiple contracts on invocation', async () => { - // #region typedoc:Contract-call-others + // #region Contract-call-others const contract = await setupContract(); const otherContract = await setupContract({ cache: false, @@ -141,11 +141,11 @@ describe('Contract', () => { const { value: results } = await scope.call(); expect(results.toHex()).toEqual(toHex(1338)); - // #endregion + // #endregion Contract-call-others }); it('adds multiple contracts on multicalls', async () => { - // #region typedoc:Contract-multicall-multiple-contracts + // #region Contract-multicall-multiple-contracts const contract = await setupContract(); const otherContract = await setupContract({ cache: false, @@ -154,11 +154,11 @@ describe('Contract', () => { contract.functions.foo(1336), contract.functions.call_external_foo(1336, otherContract.id), ]; - // #endregion + // #endregion Contract-multicall-multiple-contracts - // #region typedoc:Contract-multicall-multiple-contracts-p2 + // #region Contract-multicall-multiple-contracts-p2 const scope = contract.multiCall(calls).addContracts([otherContract]); - // #endregion + // #endregion Contract-multicall-multiple-contracts-p2 expect(scope.transactionRequest.getContractInputs()).toEqual([ { contractId: contract.id.toB256(), type: 1, txPointer }, @@ -170,21 +170,21 @@ describe('Contract', () => { { type: 1, inputIndex: 1 }, ]); - // #region typedoc:Contract-multicall-multiple-contracts-p3 + // #region Contract-multicall-multiple-contracts-p3 const { value: results } = await scope.call(); expect(JSON.stringify(results)).toEqual(JSON.stringify([bn(1337), bn(1338)])); - // #endregion + // #endregion Contract-multicall-multiple-contracts-p3 }); it('submits multiple calls', async () => { - // #region typedoc:Contract-multicall + // #region Contract-multicall const contract = await setupContract(); const { value: results } = await contract .multiCall([contract.functions.foo(1336), contract.functions.foo(1336)]) .call(); expect(JSON.stringify(results)).toEqual(JSON.stringify([bn(1337), bn(1337)])); - // #endregion + // #endregion Contract-multicall }); it('should fail to execute multiple calls if gasLimit is too low', async () => { @@ -257,7 +257,7 @@ describe('Contract', () => { it('Single call with forwarding a alt token', async () => { const contract = await setupContract(); - // #region typedoc:Contract-call-params-with-tx-params + // #region Contract-call-params-with-tx-params const { value } = await contract.functions .return_context_amount() .callParams({ @@ -269,12 +269,12 @@ describe('Contract', () => { gasLimit: 2000000, }) .call(); - // #endregion + // #endregion Contract-call-params-with-tx-params expect(value.toHex()).toEqual(toHex(200)); }); it('MultiCall with multiple forwarding', async () => { - // #region typedoc:Contract-call-params-with-multicall + // #region Contract-call-params-with-multicall const contract = await setupContract(); const { value } = await contract @@ -294,7 +294,7 @@ describe('Contract', () => { gasLimit: 2000000, }) .call<[BN, BN, BN]>(); - // #endregion + // #endregion Contract-call-params-with-multicall expect(JSON.stringify(value)).toEqual(JSON.stringify([bn(100), bn(200), AltToken])); }); @@ -356,7 +356,7 @@ describe('Contract', () => { it('Get transaction cost', async () => { const contract = await setupContract(); - // #region typedoc:Contract-cost + // #region Contract-cost const invocationScope = contract.multiCall([ contract.functions.return_context_amount().callParams({ forward: [100, NativeAssetId], @@ -366,7 +366,7 @@ describe('Contract', () => { }), ]); const transactionCost = await invocationScope.getTransactionCost(); - // #endregion + // #endregion Contract-cost expect(toNumber(transactionCost.gasPrice)).toBe(0); expect(toNumber(transactionCost.fee)).toBeGreaterThanOrEqual(0); @@ -699,10 +699,10 @@ describe('Contract', () => { }); test('Read only call', async () => { - // #region typedoc:Contract-read-only-call + // #region Contract-read-only-call const contract = await setupContract(); const { value } = await contract.functions.echo_b256(contract.id.toB256()).get(); expect(value).toEqual(contract.id.toB256()); - // #endregion + // #endregion Contract-read-only-call }); }); diff --git a/packages/fuel-gauge/src/coverage-contract.test.ts b/packages/fuel-gauge/src/coverage-contract.test.ts index 4d2c2535192..52e5c5f38c1 100644 --- a/packages/fuel-gauge/src/coverage-contract.test.ts +++ b/packages/fuel-gauge/src/coverage-contract.test.ts @@ -51,10 +51,10 @@ describe('Coverage Contract', () => { }); it('should test u8 variable type', async () => { - // #region typedoc:U8 + // #region U8 const { value } = await contractInstance.functions.echo_u8(3).call(); expect(value).toBe(3); - // #endregion + // #endregion U8 }); it('should test u8 variable type multiple params', async () => { @@ -104,11 +104,11 @@ describe('Coverage Contract', () => { }); it('should test str[8] variable type', async () => { - // #region typedoc:String-size8 + // #region String-size8 const { value } = await contractInstance.functions.echo_str_8('fuel-sdk').call(); expect(value).toBe('fuel-sdk'); - // #endregion + // #endregion String-size8 }); it('should test str[9] variable type', async () => { @@ -170,17 +170,17 @@ describe('Coverage Contract', () => { }); it('should test enum < 8 byte variable type', async () => { - // #region typedoc:Enum-small + // #region Enum-small const INPUT = { Empty: [] }; - // #endregion + // #endregion Enum-small const { value } = await contractInstance.functions.echo_enum_small(INPUT).call(); expect(value).toStrictEqual(INPUT); }); it('should test enum > 8 bytes variable type', async () => { - // #region typedoc:Enum-big + // #region Enum-big const INPUT = { AddressB: B256 }; - // #endregion + // #endregion Enum-big const { value } = await contractInstance.functions.echo_enum_big(INPUT).call(); expect(value).toStrictEqual(INPUT); }); @@ -211,7 +211,7 @@ describe('Coverage Contract', () => { }); it('should test multiple Option params [Some]', async () => { - // #region typedoc:Option-Some + // #region Option-Some const INPUT_A = 1; const INPUT_B = 4; const INPUT_C = 5; @@ -223,11 +223,11 @@ describe('Coverage Contract', () => { // we receive the result of adding whatever was passed expect(Some).toStrictEqual(10); - // #endregion + // #endregion Option-Some }); it('should test multiple Option params [None]', async () => { - // #region typedoc:Option-None + // #region Option-None const INPUT = 1; // adds the three values together, but only first param value is supplied @@ -235,7 +235,7 @@ describe('Coverage Contract', () => { // we receive the result of adding whatever was passed expect(Some).toStrictEqual(1); - // #endregion + // #endregion Option-None }); it('should test u8 empty vector input', async () => { @@ -336,7 +336,7 @@ describe('Coverage Contract', () => { }; const { value } = await contractInstance.functions .echo_struct_vector_last( - // #region typedoc:Vector-Struct + // #region Vector-Struct [ { foo: 1, @@ -350,7 +350,7 @@ describe('Coverage Contract', () => { }, last, ] - // #endregion + // #endregion Vector-Struct ) .call(); const unhexed = { @@ -364,7 +364,7 @@ describe('Coverage Contract', () => { it('should get initial state messages from node', async () => { const provider = new Provider('http://127.0.0.1:4000/graphql'); - // #region typedoc:Message-getMessages + // #region Message-getMessages const WALLET_A = Wallet.fromPrivateKey( '0x1ff16505df75735a5bcf4cb4cf839903120c181dd9be6781b82cda23543bd242', provider @@ -404,7 +404,7 @@ describe('Coverage Contract', () => { expect(aMessages).toStrictEqual(EXPECTED_MESSAGES_A); expect(bMessages).toStrictEqual(EXPECTED_MESSAGES_B); - // #endregion + // #endregion Message-getMessages }); it('should test spending input messages', async () => { @@ -439,14 +439,14 @@ describe('Coverage Contract', () => { }); it('can read from produce_logs_variables', async () => { - // #region typedoc:Log-output + // #region Log-output const { logs } = await contractInstance.functions.produce_logs_variables().call(); expect(logs[0].toHex()).toEqual(bn(64).toHex()); expect(logs[1]).toEqual('0xef86afa9696cf0dc6385e2c407a6e159a1103cefb7e2ae0636fb33d3cb2a9e4a'); expect(logs[2]).toEqual('Fuel'); expect([logs[3], logs[4], logs[5]]).toEqual([1, 2, 3]); - // #endregion + // #endregion Log-output }); it('should get raw_slice output [u8]', async () => { diff --git a/packages/fuel-gauge/src/doc-examples.test.ts b/packages/fuel-gauge/src/doc-examples.test.ts index cd65a528cc2..52dce4ac1b8 100644 --- a/packages/fuel-gauge/src/doc-examples.test.ts +++ b/packages/fuel-gauge/src/doc-examples.test.ts @@ -39,7 +39,7 @@ const ADDRESS_BYTES = new Uint8Array([ ]); test('it has an Address class using bech32Address', () => { - // #region typedoc:Address-bech32 + // #region Address-bech32 // #context import { Address } from 'fuels'; const address = new Address(ADDRESS_BECH32); @@ -48,30 +48,30 @@ test('it has an Address class using bech32Address', () => { expect(address.toBytes()).toEqual(ADDRESS_BYTES); // Hex string values are equivalent to B256 expect(address.toHexString()).toEqual(ADDRESS_B256); - // #endregion + // #endregion Address-bech32 }); test('it has an Address class using public key', async () => { - // #region typedoc:Address-publicKey + // #region Address-publicKey const address = Address.fromPublicKey(PUBLIC_KEY); expect(address.toAddress()).toEqual(ADDRESS_BECH32); expect(address.toB256()).toEqual(ADDRESS_B256); - // #endregion + // #endregion Address-publicKey }); test('it has an Address class using b256Address', async () => { - // #region typedoc:Address-b256 + // #region Address-b256 // #context import { Address } from 'fuels'; const address = Address.fromB256(ADDRESS_B256); expect(address.toAddress()).toEqual(ADDRESS_BECH32); expect(address.toB256()).toEqual(ADDRESS_B256); - // #endregion + // #endregion Address-b256 }); test('it has Address tools', async () => { - // #region typedoc:Address-utils + // #region Address-utils // you can make a random address - useful for testing const address = Address.fromRandom(); @@ -89,11 +89,11 @@ test('it has Address tools', async () => { expect(address.equals(addressCloneFromBech)).toBeTruthy(); expect(addressCloneFromBech.toString()).toEqual(addressCloneFromB256.toString()); expect(someAddress).toBeTruthy(); - // #endregion + // #endregion Address-utils }); test('it has Bytes tools', async () => { - // #region typedoc:byte32 + // #region byte32 // #context import { ZeroBytes32, randomBytes } from 'fuels'; const random32Bytes: Bytes = randomBytes(32); @@ -105,11 +105,11 @@ test('it has Bytes tools', async () => { // a byte32 string can be safely passed into hexlify more than once without mangling expect(zeroed32Bytes).toEqual(hexlify(zeroed32Bytes)); - // #endregion + // #endregion byte32 }); test('it has b256 tools', async () => { - // #region typedoc:b256 + // #region b256 // #context import { arrayify, hexlify, randomBytes, getRandomB256 } from 'fuels'; // here are some useful ways to generate random b256 values @@ -124,11 +124,11 @@ test('it has b256 tools', async () => { // a string b256 can be safely passed into hexlify without mangling expect(randomB256).toEqual(hexlify(randomB256)); - // #endregion + // #endregion b256 }); test('it has conversion tools', async () => { - // #region typedoc:conversion + // #region conversion // #context import { arrayify, hexlify, randomBytes, Address, addressify, Contract, Wallet, WalletLocked } from 'fuels'; const assetId: string = ZeroBytes32; @@ -148,7 +148,7 @@ test('it has conversion tools', async () => { // it's bytes all the way down expect(arrayify(assetId)).toEqual(arrayify(Address.fromB256(assetId).toB256())); - // #endregion + // #endregion conversion }); test('it can work with wallets', async () => { @@ -247,7 +247,7 @@ it('can create wallets', async () => { }); it('can connect to testnet', async () => { - // #region typedoc:provider-testnet + // #region provider-testnet // #context import { Provider, WalletUnlocked } from 'fuels'; const provider = new Provider('node-beta-2.fuel.network'); // Setup a private key @@ -256,16 +256,16 @@ it('can connect to testnet', async () => { // Create the wallet, passing provider const wallet: WalletUnlocked = Wallet.fromPrivateKey(PRIVATE_KEY, provider); - // #region typedoc:signer-address + // #region signer-address const signer = new Signer(PRIVATE_KEY); // validate address expect(wallet.address).toEqual(signer.address); - // #endregion - // #endregion + // #endregion provider-testnet + // #endregion signer-address }); it('can connect to a local provider', async () => { - // #region typedoc:provider-local + // #region provider-local // #context import { Provider, WalletUnlocked } from 'fuels'; const localProvider = new Provider('http://127.0.0.1:4000/graphql'); // Setup a private key @@ -277,11 +277,11 @@ it('can connect to a local provider', async () => { const signer = new Signer(PRIVATE_KEY); // validate address expect(wallet.address).toEqual(signer.address); - // #endregion + // #endregion provider-local }); it('can query address with wallets', async () => { - // #region typedoc:wallet-query + // #region wallet-query // #context import { Provider } from 'fuels'; // #context import { generateTestWallet } from '@fuel-ts/wallet/test-utils'; const provider = new Provider('http://127.0.0.1:4000/graphql'); @@ -315,38 +315,38 @@ it('can query address with wallets', async () => { amount: bn(100), }), ]); - // #endregion + // #endregion wallet-query - // #region typedoc:wallet-get-balances + // #region wallet-get-balances const walletBalances = await wallet.getBalances(); expect(walletBalances).toEqual([ { assetId: NativeAssetId, amount: bn(42) }, { assetId: assetIdA, amount: bn(100) }, ]); - // #endregion + // #endregion wallet-get-balances - // #region typedoc:wallet-get-spendable-resources + // #region wallet-get-spendable-resources const spendableResources = await wallet.getResourcesToSpend([ { amount: 32, assetId: NativeAssetId, max: 42 }, { amount: 50, assetId: assetIdA }, ]); expect(spendableResources[0].amount).toEqual(bn(42)); expect(spendableResources[1].amount).toEqual(bn(100)); - // #endregion + // #endregion wallet-get-spendable-resources }); it('can create a predicate', async () => { - // #region typedoc:predicate-basic + // #region predicate-basic // #context import { Predicate, arrayify } from 'fuels'; const predicate = new Predicate(testPredicateTrue); expect(predicate.address).toBeTruthy(); expect(predicate.bytes).toEqual(arrayify(testPredicateTrue)); - // #endregion + // #endregion predicate-basic }); it('can create a predicate and use', async () => { - // #region typedoc:Predicate-triple-wallets + // #region Predicate-triple-wallets // #context import { Provider, Wallet } from 'fuels'; // #context import { seedTestWallet } from '@fuel-ts/wallet/test-utils'; const provider = new Provider('http://127.0.0.1:4000/graphql'); @@ -360,17 +360,17 @@ it('can create a predicate and use', async () => { const wallet2: WalletUnlocked = Wallet.fromPrivateKey(PRIVATE_KEY_2, provider); const wallet3: WalletUnlocked = Wallet.fromPrivateKey(PRIVATE_KEY_3, provider); const receiver = Wallet.generate({ provider }); - // #endregion + // #endregion Predicate-triple-wallets - // #region typedoc:Predicate-triple-seed + // #region Predicate-triple-seed // #context import { Provider, Wallet } from 'fuels'; // #context import { seedTestWallet } from '@fuel-ts/wallet/test-utils'; await seedTestWallet(wallet1, [{ assetId: NativeAssetId, amount: bn(1_000_000) }]); await seedTestWallet(wallet2, [{ assetId: NativeAssetId, amount: bn(2_000_000) }]); await seedTestWallet(wallet3, [{ assetId: NativeAssetId, amount: bn(300_000) }]); - // #endregion + // #endregion Predicate-triple-seed - // #region typedoc:Predicate-triple + // #region Predicate-triple-2 // #context import { Predicate, NativeAssetId } from 'fuels'; const AbiInputs = { types: [ @@ -414,18 +414,18 @@ it('can create a predicate and use', async () => { const amountToPredicate = 100_000; const amountToReceiver = 100; const initialPredicateBalance = await predicate.getBalance(); - // #endregion + // #endregion Predicate-triple-2 - // #region typedoc:Predicate-triple-transfer + // #region Predicate-triple-transfer const response = await wallet1.transfer(predicate.address, amountToPredicate); await response.waitForResult(); const predicateBalance = await predicate.getBalance(); // assert that predicate address now has the expected amount to predicate expect(bn(predicateBalance)).toEqual(initialPredicateBalance.add(amountToPredicate)); - // #endregion + // #endregion Predicate-triple-transfer - // #region typedoc:Predicate-triple-submit + // #region Predicate-triple-submit const depositOnPredicate = await wallet1.transfer(predicate.address, 200); // Wait for Transaction to succeed await depositOnPredicate.waitForResult(); @@ -435,18 +435,18 @@ it('can create a predicate and use', async () => { expect(bn(updatedPredicateBalance)).toEqual( initialPredicateBalance.add(amountToPredicate).add(200) ); - // #endregion + // #endregion Predicate-triple-submit - // #region typedoc:Predicate-triple-sign + // #region Predicate-triple-sign const dataToSign = '0x0000000000000000000000000000000000000000000000000000000000000000'; const signature1 = await wallet1.signMessage(dataToSign); const signature2 = await wallet2.signMessage(dataToSign); const signature3 = await wallet3.signMessage(dataToSign); const signatures = [signature1, signature2, signature3]; - // #endregion + // #endregion Predicate-triple-sign - // #region typedoc:Predicate-triple-spend + // #region Predicate-triple-spend const tx = await predicate.setData(signatures).transfer(receiver.address, amountToReceiver); await tx.waitForResult(); @@ -458,18 +458,18 @@ it('can create a predicate and use', async () => { expect(bn(initialPredicateBalance).lte(finalPredicateBalance)).toBeTruthy(); // assert that predicate funds now belong to the receiver expect(bn(receiverBalance).gte(bn(amountToReceiver))).toBeTruthy(); - // #endregion + // #endregion Predicate-triple-spend }); test('deposit and withdraw cookbook guide', async () => { - // #region typedoc:deposit-and-withdraw-cookbook-wallet-setup + // #region deposit-and-withdraw-cookbook-wallet-setup const provider = new Provider('http://127.0.0.1:4000/graphql'); const PRIVATE_KEY = '0x862512a2363db2b3a375c0d4bbbd27172180d89f23f2e259bac850ab02619301'; const wallet = Wallet.fromPrivateKey(PRIVATE_KEY, provider); await seedTestWallet(wallet, [{ assetId: NativeAssetId, amount: bn(100_000) }]); - // #endregion + // #endregion deposit-and-withdraw-cookbook-wallet-setup - // #region typedoc:deposit-and-withdraw-cookbook-contract-deployments + // #region deposit-and-withdraw-cookbook-contract-deployments const tokenContractBytecode = readFileSync( join(__dirname, '../test-projects/token_contract/out/debug/token_contract.bin') ); @@ -488,10 +488,10 @@ test('deposit and withdraw cookbook guide', async () => { const liquidityPoolContract = await liquidityPoolContractFactory.deployContract(); const liquidityPoolContractID = liquidityPoolContract.id; await liquidityPoolContract.functions.set_base_token(tokenContractID).call(); - // #endregion + // #endregion deposit-and-withdraw-cookbook-contract-deployments // mint some base tokens to the current wallet - // #region typedoc:deposit-and-withdraw-cookbook-mint-and-transfer + // #region deposit-and-withdraw-cookbook-mint-and-transfer await tokenContract.functions.mint_coins(500, 1).call(); await tokenContract.functions .transfer_coins_to_output( @@ -507,10 +507,10 @@ test('deposit and withdraw cookbook guide', async () => { variableOutputs: 1, }) .call(); - // #endregion + // #endregion deposit-and-withdraw-cookbook-mint-and-transfer // deposit base tokens into the liquidity pool - // #region typedoc:deposit-and-withdraw-cookbook-deposit + // #region deposit-and-withdraw-cookbook-deposit await liquidityPoolContract.functions .deposit({ value: wallet.address.toB256(), @@ -522,14 +522,14 @@ test('deposit and withdraw cookbook guide', async () => { }, }) .call(); - // #endregion + // #endregion deposit-and-withdraw-cookbook-deposit // verify balances expect(await wallet.getBalance(tokenContractID.toB256())).toEqual(bn(100)); expect(await wallet.getBalance(liquidityPoolContractID.toB256())).toEqual(bn(200)); // withdraw base tokens from the liquidity pool - // #region typedoc:deposit-and-withdraw-cookbook-withdraw + // #region deposit-and-withdraw-cookbook-withdraw const lpTokenBalance = await wallet.getBalance(liquidityPoolContractID.toB256()); await liquidityPoolContract.functions .withdraw({ @@ -542,7 +542,7 @@ test('deposit and withdraw cookbook guide', async () => { }, }) .call(); - // #endregion + // #endregion deposit-and-withdraw-cookbook-withdraw // verify balances again expect(await wallet.getBalance(tokenContractID.toB256())).toEqual(bn(200)); diff --git a/packages/fuel-gauge/src/script-main-args.test.ts b/packages/fuel-gauge/src/script-main-args.test.ts index d3247203108..e492f4ea51c 100644 --- a/packages/fuel-gauge/src/script-main-args.test.ts +++ b/packages/fuel-gauge/src/script-main-args.test.ts @@ -28,12 +28,12 @@ type Baz = { describe('Script Coverage', () => { it('can call script and use main arguments', async () => { const wallet = await setup(); - // #region typedoc:script-call-factory + // #region script-call-factory const foo = 33; const scriptInstance = new Script(scriptBin, scriptAbi, wallet); const { value, logs } = await scriptInstance.functions.main(foo).call(); - // #endregion + // #endregion script-call-factory expect(value?.toString()).toEqual(bn(foo).toString()); expect(logs).toEqual(['u8 foo', 33]); diff --git a/packages/fuel-gauge/src/storage-test-contract.test.ts b/packages/fuel-gauge/src/storage-test-contract.test.ts index 4642c39db50..d46546cf7d8 100644 --- a/packages/fuel-gauge/src/storage-test-contract.test.ts +++ b/packages/fuel-gauge/src/storage-test-contract.test.ts @@ -43,11 +43,11 @@ describe('StorageTestContract', () => { // Call contract await contract.functions.initialize_counter(1300).call(); - // #region typedoc:contract-with-id + // #region contract-with-id const provider = new Provider('http://127.0.0.1:4000/graphql'); const providerContract = new Contract(contract.id, contract.interface, provider); const { value } = await providerContract.functions.counter().get(); expect(value.toHex()).toEqual(toHex(1300)); - // #endregion + // #endregion contract-with-id }); }); diff --git a/packages/fuel-gauge/src/token-test-contract.test.ts b/packages/fuel-gauge/src/token-test-contract.test.ts index 9ff2f85870f..3271f05b4c4 100644 --- a/packages/fuel-gauge/src/token-test-contract.test.ts +++ b/packages/fuel-gauge/src/token-test-contract.test.ts @@ -43,14 +43,14 @@ describe('TokenTestContract', () => { // Check balance is correct expect((await getBalance()).toHex()).toEqual(toHex(100)); // Transfer some coins - // #region typedoc:variable-outputs + // #region variable-outputs await token.functions .transfer_coins_to_output(50, tokenId, addressId) .txParams({ variableOutputs: 1, }) .call(); - // #endregion + // #endregion variable-outputs // Check new wallet received the coins from the token contract const balances = await userWallet.getBalances(); const tokenBalance = balances.find((b) => b.assetId === token.id.toB256()); diff --git a/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw b/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw index b8f2d37cbd9..3d1da891986 100644 --- a/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw +++ b/packages/fuel-gauge/test-projects/coverage-contract/src/main.sw @@ -26,15 +26,15 @@ pub struct BigStruct { bar: u8, } -// #region typedoc:ComplexStruct +// #region ComplexStruct pub struct ComplexStruct { foo: u8, bar: u64, baz: str[9], } -// #endregion +// #endregion ComplexStruct -// #region typedoc:Enum +// #region Enum pub enum SmallEnum { Empty: (), } @@ -44,7 +44,7 @@ pub enum BigEnum { AddressB: b256, AddressC: b256, } -// #endregion +// #endregion Enum abi CoverageContract { fn produce_logs_variables(); @@ -97,7 +97,7 @@ abi CoverageContract { } impl CoverageContract for Contract { - // #region typedoc:Log-demo + // #region Log-demo fn produce_logs_variables() -> () { let f: u64 = 64; let u: b256 = 0xef86afa9696cf0dc6385e2c407a6e159a1103cefb7e2ae0636fb33d3cb2a9e4a; @@ -109,7 +109,7 @@ impl CoverageContract for Contract { log(e); log(l); } - // #endregion + // #endregion Log-demo fn get_id() -> b256 { 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF @@ -257,7 +257,7 @@ impl CoverageContract for Contract { Option::None => 500u32, } } - // #region typedoc:Option-echo_option_three_u8 + // #region Option-echo_option_three_u8 fn echo_option_three_u8(inputA: Option, inputB: Option, inputC: Option) -> u8 { let value1 = match inputA { Option::Some(value) => value, @@ -274,7 +274,7 @@ impl CoverageContract for Contract { value1 + value2 + value3 } - // #endregion + // #endregion Option-echo_option_three_u8 fn echo_u8_vector_first(vector: Vec) -> u8 { match vector.get(0) { @@ -314,11 +314,11 @@ impl CoverageContract for Contract { vector.get(0).unwrap() } - // #region typedoc:Vector-ComplexStruct + // #region Vector-ComplexStruct fn echo_struct_vector_last(vector: Vec) -> ComplexStruct { vector.get(vector.len() - 1).unwrap() } - // #endregion + // #endregion Vector-ComplexStruct fn get_u64_vector() -> raw_slice { // Convert to a vector diff --git a/packages/fuel-gauge/test-projects/liquidity-pool/src/main.sw b/packages/fuel-gauge/test-projects/liquidity-pool/src/main.sw index e95498336fe..3a7964727bc 100644 --- a/packages/fuel-gauge/test-projects/liquidity-pool/src/main.sw +++ b/packages/fuel-gauge/test-projects/liquidity-pool/src/main.sw @@ -1,4 +1,4 @@ -// #region typedoc:liquidity-pool-contract +// #region liquidity-pool-contract contract; use std::{ @@ -58,4 +58,4 @@ impl LiquidityPool for Contract { transfer_to_address(amount_to_transfer, ContractId::from(storage.base_token), recipient); } } -// #endregion +// #endregion liquidity-pool-contract diff --git a/packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw b/packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw index 5674c5c8160..de96bf45cf5 100644 --- a/packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw +++ b/packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw @@ -1,4 +1,4 @@ - // #region typedoc:Predicate-main-args + // #region Predicate-main-args predicate; struct Validation { @@ -12,4 +12,4 @@ fn main(received: Validation) -> bool { received.has_account == expected_has_account && received.total_complete == expected_total_complete } - // #endregion \ No newline at end of file + // #endregion Predicate-main-args diff --git a/packages/fuel-gauge/test-projects/predicate-triple-sig/src/main.sw b/packages/fuel-gauge/test-projects/predicate-triple-sig/src/main.sw index f3dd807b68a..284973b2fc3 100644 --- a/packages/fuel-gauge/test-projects/predicate-triple-sig/src/main.sw +++ b/packages/fuel-gauge/test-projects/predicate-triple-sig/src/main.sw @@ -1,4 +1,4 @@ - // #region typedoc:Predicate-triple + // #region Predicate-triple predicate; use std::{b512::B512, ecr::ec_recover_address, inputs::input_predicate_data}; @@ -31,4 +31,4 @@ fn main() -> bool { matched_keys > 1 } - // #endregion \ No newline at end of file + // #endregion Predicate-triple diff --git a/packages/fuel-gauge/test-projects/script-main-args/src/main.sw b/packages/fuel-gauge/test-projects/script-main-args/src/main.sw index 956d760344c..f49d0e4d83f 100644 --- a/packages/fuel-gauge/test-projects/script-main-args/src/main.sw +++ b/packages/fuel-gauge/test-projects/script-main-args/src/main.sw @@ -1,4 +1,4 @@ -// #region typedoc:script-with-main-args +// #region script-with-main-args script; use std::logging::log; @@ -8,4 +8,4 @@ fn main(foo: u8) -> u8 { log(foo); foo } -// #endregion \ No newline at end of file +// #endregion script-with-main-args diff --git a/packages/fuel-gauge/test-projects/token_contract/src/main.sw b/packages/fuel-gauge/test-projects/token_contract/src/main.sw index 3a8a60aa3f6..be3a876e5d5 100644 --- a/packages/fuel-gauge/test-projects/token_contract/src/main.sw +++ b/packages/fuel-gauge/test-projects/token_contract/src/main.sw @@ -1,4 +1,4 @@ -// #region typedoc:token-contract +// #region token-contract contract; use std::{context::balance_of, context::msg_amount, token::*}; @@ -32,9 +32,9 @@ impl Token for Contract { fn get_balance(target: ContractId, asset_id: ContractId) -> u64 { balance_of(target, asset_id) } - + fn get_msg_amount() -> u64 { msg_amount() } } -// #endregion +// #endregion token-contract diff --git a/packages/interfaces/src/index.ts b/packages/interfaces/src/index.ts index 6f879bc6310..d59acc03a64 100644 --- a/packages/interfaces/src/index.ts +++ b/packages/interfaces/src/index.ts @@ -1,8 +1,8 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ /* eslint-disable max-classes-per-file */ -// #region typedoc:Bech32-HRP +// #region Bech32-HRP export type Bech32Address = `fuel${string}`; -// #endregion +// #endregion Bech32-HRP export type B256Address = string; export abstract class AbstractScriptRequest { @@ -10,7 +10,7 @@ export abstract class AbstractScriptRequest { abstract encodeScriptData: (data: T) => Uint8Array; } -// #region typedoc:AbstractAddress +// #region AbstractAddress export abstract class AbstractAddress { abstract toJSON(): string; abstract toString(): string; @@ -20,7 +20,7 @@ export abstract class AbstractAddress { abstract toBytes(): Uint8Array; abstract equals(other: AbstractAddress): boolean; } -// #endregion +// #endregion AbstractAddress export abstract class AbstractAccount { abstract address: AbstractAddress; diff --git a/packages/providers/src/message.ts b/packages/providers/src/message.ts index 78c5179176d..383d866646c 100644 --- a/packages/providers/src/message.ts +++ b/packages/providers/src/message.ts @@ -4,7 +4,7 @@ import type { BN } from '@fuel-ts/math'; import { GqlMessageStatus as MessageStatus } from './__generated__/operations'; -// #region typedoc:Message-shape +// #region Message-shape /** * A Fuel message */ @@ -17,7 +17,7 @@ export type Message = { status: MessageStatus; daHeight: BN; }; -// #endregion +// #endregion Message-shape /** * Message Proof diff --git a/packages/script/src/script.test.ts b/packages/script/src/script.test.ts index 30d64beb2c8..1cb99794203 100644 --- a/packages/script/src/script.test.ts +++ b/packages/script/src/script.test.ts @@ -58,7 +58,7 @@ const callScript = async ( return { transactionResult, result, response }; }; -// #region typedoc:script-init +// #region script-init // #context import { Script, AbiCoder, arrayify } from 'fuels'; // #context const scriptBin = readFileSync(join(__dirname, './path/to/script-binary.bin')); const scriptAbi = [ @@ -127,7 +127,7 @@ describe('Script', () => { } ); }); - // #endregion + // #endregion script-init it('can call a script', async () => { const wallet = await setup(); diff --git a/packages/versions/package.json b/packages/versions/package.json index 9f73e5e3623..b793d2de21a 100644 --- a/packages/versions/package.json +++ b/packages/versions/package.json @@ -10,8 +10,8 @@ "fuels-versions": "dist/bin.global.js" }, "exports": { - ".": "./src/index.ts", - "./cli": "./src/cli.ts" + ".": "./dist/index.js", + "./cli": "./dist/cli.js" }, "publishConfig": { "main": "dist/index.js", diff --git a/packages/wallet/src/account.test.ts b/packages/wallet/src/account.test.ts index 20bf61ff12f..2a3f118c4f7 100644 --- a/packages/wallet/src/account.test.ts +++ b/packages/wallet/src/account.test.ts @@ -88,7 +88,7 @@ describe('Account', () => { }); it('should execute getResourcesToSpend just fine', async () => { - // #region typedoc:Message-getResourcesToSpend + // #region Message-getResourcesToSpend const account = new Account( '0x09c0b2d1a486c439a87bcba6b46a7a1a23f3897cc83a94521a96da5c23bc58db' ); @@ -99,7 +99,7 @@ describe('Account', () => { }, ]); expect(resourcesToSpend[0].amount.gt(2)).toBeTruthy(); - // #endregion + // #endregion Message-getResourcesToSpend }); it('should get messages just fine', async () => { diff --git a/packages/wallet/src/transfer.test.ts b/packages/wallet/src/transfer.test.ts index 285a11d7967..9dab85dbada 100644 --- a/packages/wallet/src/transfer.test.ts +++ b/packages/wallet/src/transfer.test.ts @@ -166,14 +166,14 @@ describe('Wallet', () => { const tx = await sender.withdrawToBaseLayer(recipient, AMOUNT); const TRANSACTION_ID = tx.id; - // #region typedoc:Message-getMessageProof + // #region Message-getMessageProof const result = await tx.wait(); const messageOutReceipt = result.receipts[0]; const messageProof = await provider.getMessageProof( TRANSACTION_ID, messageOutReceipt.messageID ); - // #endregion + // #endregion Message-getMessageProof expect(messageProof).toEqual( expect.objectContaining({ diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f4d885d7f2c..058b18a0d15 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -45,10 +45,6 @@ importers: ts-node: ^10.9.1 tsup: ^5.12.9 turbo: ^1.6.1 - typedoc: ^0.23.0 - typedoc-just-the-docs-theme: ^0.0.1 - typedoc-monorepo-link-types: ^0.0.4 - typedoc-plugin-markdown: ^3.11.12 typescript: ^4.8.4 devDependencies: '@changesets/changelog-github': 0.4.7 @@ -92,12 +88,27 @@ importers: ts-node: 10.9.1_kluoused5zacjtflizwvdqgpom tsup: 5.12.9_2dtigtkb225m7ii7q45utxqwgi turbo: 1.6.3 - typedoc: 0.23.21_typescript@4.9.3 - typedoc-just-the-docs-theme: 0.0.1_vw2i6qmpkoeqkz2lubusygb56a - typedoc-monorepo-link-types: 0.0.4_typedoc@0.23.21 - typedoc-plugin-markdown: 3.13.6_typedoc@0.23.21 typescript: 4.9.3 + apps/docs: + specifiers: + '@fuel-ts/versions': workspace:* + '@types/markdown-it': ^12.2.3 + flexsearch: ^0.7.31 + markdown-it: ^13.0.1 + vitepress: 1.0.0-alpha.51 + vitepress-plugin-search: 1.0.4-alpha.19 + vue: ^3.2.47 + dependencies: + '@fuel-ts/versions': link:../../packages/versions + devDependencies: + '@types/markdown-it': 12.2.3 + flexsearch: 0.7.31 + markdown-it: 13.0.1 + vitepress: 1.0.0-alpha.51_2xdflmy6sc2qhwxavtux3g5lt4 + vitepress-plugin-search: 1.0.4-alpha.19_wa76uzoxa7sjxpgthdjgz7ruma + vue: 3.2.47 + packages/abi-coder: specifiers: '@ethersproject/abi': ^5.7.0 @@ -660,6 +671,117 @@ importers: packages: + /@algolia/autocomplete-core/1.7.4: + resolution: {integrity: sha512-daoLpQ3ps/VTMRZDEBfU8ixXd+amZcNJ4QSP3IERGyzqnL5Ch8uSRFt/4G8pUvW9c3o6GA4vtVv4I4lmnkdXyg==} + dependencies: + '@algolia/autocomplete-shared': 1.7.4 + dev: true + + /@algolia/autocomplete-preset-algolia/1.7.4_54vqn5ucj5r6a67cmv5tg3mbje: + resolution: {integrity: sha512-s37hrvLEIfcmKY8VU9LsAXgm2yfmkdHT3DnA3SgHaY93yjZ2qL57wzb5QweVkYuEBZkT2PIREvRoLXC2sxTbpQ==} + peerDependencies: + '@algolia/client-search': '>= 4.9.1 < 6' + algoliasearch: '>= 4.9.1 < 6' + dependencies: + '@algolia/autocomplete-shared': 1.7.4 + '@algolia/client-search': 4.15.0 + algoliasearch: 4.15.0 + dev: true + + /@algolia/autocomplete-shared/1.7.4: + resolution: {integrity: sha512-2VGCk7I9tA9Ge73Km99+Qg87w0wzW4tgUruvWAn/gfey1ZXgmxZtyIRBebk35R1O8TbK77wujVtCnpsGpRy1kg==} + dev: true + + /@algolia/cache-browser-local-storage/4.15.0: + resolution: {integrity: sha512-uxxFhTWh4JJDb2+FFSmNMfEQ8p9o2vjSpU7iW007QX3OvqljPPN68lk3bpZVaG8pwr5MU1DqpkZ71FcQdVTjgQ==} + dependencies: + '@algolia/cache-common': 4.15.0 + dev: true + + /@algolia/cache-common/4.15.0: + resolution: {integrity: sha512-Me3PbI4QurAM+3D+htIE0l1xt6+bl/18SG6Wc7bPQEZAtN7DTGz22HqhKNyLF2lR/cOfpaH7umXZlZEhIHf7gQ==} + dev: true + + /@algolia/cache-in-memory/4.15.0: + resolution: {integrity: sha512-B9mg1wd7CKMfpkbiTQ8KlcKkH6ut/goVaI6XmDCUczOOqeuZlV34tuEi7o3Xo1j66KWr/d9pMjjGYcoVPCVeOA==} + dependencies: + '@algolia/cache-common': 4.15.0 + dev: true + + /@algolia/client-account/4.15.0: + resolution: {integrity: sha512-8wqI33HRZy5ydfFt6F5vMhtkOiAUhVfSCYXx4U3Go5RALqWLgVUp6wzOo0mr1z08POCkHDpbQMQvyayb1CZ/kw==} + dependencies: + '@algolia/client-common': 4.15.0 + '@algolia/client-search': 4.15.0 + '@algolia/transporter': 4.15.0 + dev: true + + /@algolia/client-analytics/4.15.0: + resolution: {integrity: sha512-jrPjEeNEIIQKeA1XCZXx3f3aybtwF7wjYlnfHbLARuZ9AuHzimOKjX0ZwqvMmvTsHivpcZ2rqY+j1E8HoH1ELA==} + dependencies: + '@algolia/client-common': 4.15.0 + '@algolia/client-search': 4.15.0 + '@algolia/requester-common': 4.15.0 + '@algolia/transporter': 4.15.0 + dev: true + + /@algolia/client-common/4.15.0: + resolution: {integrity: sha512-PlsJMObZuYw4JlG5EhYv1PHDOv7n5mD5PzqFyoNfSOYaEPRZepa3W579ya29yOu3FZ0VGMNJmB7Q5v/+/fwvIw==} + dependencies: + '@algolia/requester-common': 4.15.0 + '@algolia/transporter': 4.15.0 + dev: true + + /@algolia/client-personalization/4.15.0: + resolution: {integrity: sha512-Bf0bhRAiNL9LWurzyHRH8UBi4fDt3VbCNkInxVngKQT1uCZWXecwoPWGhcSSpdanBqFJA/1WBt+BWx7a50Bhlg==} + dependencies: + '@algolia/client-common': 4.15.0 + '@algolia/requester-common': 4.15.0 + '@algolia/transporter': 4.15.0 + dev: true + + /@algolia/client-search/4.15.0: + resolution: {integrity: sha512-dTwZD4u53WdmexnMcoO2Qd/+YCP3ESXKOtD2MryQ1a9dHwB2Y3Qob0kyS1PG82idwM3enbznvscI9Sf4o9PUWQ==} + dependencies: + '@algolia/client-common': 4.15.0 + '@algolia/requester-common': 4.15.0 + '@algolia/transporter': 4.15.0 + dev: true + + /@algolia/logger-common/4.15.0: + resolution: {integrity: sha512-D8OFwn/HpvQz66goIcjxOKsYBMuxiruxJ3cA/bnc0EiDvSA2P2z6bNQWgS5gbstuTZIJmbhr+53NyOxFkmMNAA==} + dev: true + + /@algolia/logger-console/4.15.0: + resolution: {integrity: sha512-pQOvVaRSEJQJRXKTnxEA6nN1hipSQadJJ4einw0nIlfMOGZh/kps1ybh8vRUlUGyfEuN/3dyFs0W3Ac7hIItlg==} + dependencies: + '@algolia/logger-common': 4.15.0 + dev: true + + /@algolia/requester-browser-xhr/4.15.0: + resolution: {integrity: sha512-va186EfALF+6msYZXaoBSxcnFCg3SoWJ+uv1yMyhQRJRe7cZSHWSVT3s40vmar90gxlBu80KMVwVlsvJhJv6ew==} + dependencies: + '@algolia/requester-common': 4.15.0 + dev: true + + /@algolia/requester-common/4.15.0: + resolution: {integrity: sha512-w0UUzxElbo4hrKg4QP/jiXDNbIJuAthxdlkos9nS8KAPK2XI3R9BlUjLz/ZVs4F9TDGI0mhjrNHhZ12KXcoyhg==} + dev: true + + /@algolia/requester-node-http/4.15.0: + resolution: {integrity: sha512-eeEOhFtgwKcgAlKAZpgBRZJ0ILSEBCXxZ9uwfVWPD24W1b6z08gVoTJ6J7lCeCnJmudg+tMElDnGzHkjup9CJA==} + dependencies: + '@algolia/requester-common': 4.15.0 + dev: true + + /@algolia/transporter/4.15.0: + resolution: {integrity: sha512-JoWR+ixG3EmA0UPntQFN/FV5TasYcYu93d5+oKzHFeZ6Z7rtW5Im9iy/Oh/ggk1AAN5fTdqKewtbBpdaYDbKsQ==} + dependencies: + '@algolia/cache-common': 4.15.0 + '@algolia/logger-common': 4.15.0 + '@algolia/requester-common': 4.15.0 + dev: true + /@ampproject/remapping/2.2.0: resolution: {integrity: sha512-qRmjj8nj9qmLTQXXmaR1cck3UXSRMPrbsLJAasZpF+t3riI71BXed5ebIOYwQntykeZuhjsdweEc9BxH5Jc26w==} engines: {node: '>=6.0.0'} @@ -1592,6 +1714,44 @@ packages: '@jridgewell/trace-mapping': 0.3.9 dev: true + /@docsearch/css/3.3.3: + resolution: {integrity: sha512-6SCwI7P8ao+se1TUsdZ7B4XzL+gqeQZnBc+2EONZlcVa0dVrk0NjETxozFKgMv0eEGH8QzP1fkN+A1rH61l4eg==} + dev: true + + /@docsearch/js/3.3.3_2xdflmy6sc2qhwxavtux3g5lt4: + resolution: {integrity: sha512-2xAv2GFuHzzmG0SSZgf8wHX0qZX8n9Y1ZirKUk5Wrdc+vH9CL837x2hZIUdwcPZI9caBA+/CzxsS68O4waYjUQ==} + dependencies: + '@docsearch/react': 3.3.3_2xdflmy6sc2qhwxavtux3g5lt4 + preact: 10.13.0 + transitivePeerDependencies: + - '@algolia/client-search' + - '@types/react' + - react + - react-dom + dev: true + + /@docsearch/react/3.3.3_2xdflmy6sc2qhwxavtux3g5lt4: + resolution: {integrity: sha512-pLa0cxnl+G0FuIDuYlW+EBK6Rw2jwLw9B1RHIeS4N4s2VhsfJ/wzeCi3CWcs5yVfxLd5ZK50t//TMA5e79YT7Q==} + peerDependencies: + '@types/react': '>= 16.8.0 < 19.0.0' + react: '>= 16.8.0 < 19.0.0' + react-dom: '>= 16.8.0 < 19.0.0' + peerDependenciesMeta: + '@types/react': + optional: true + react: + optional: true + react-dom: + optional: true + dependencies: + '@algolia/autocomplete-core': 1.7.4 + '@algolia/autocomplete-preset-algolia': 1.7.4_54vqn5ucj5r6a67cmv5tg3mbje + '@docsearch/css': 3.3.3 + algoliasearch: 4.15.0 + transitivePeerDependencies: + - '@algolia/client-search' + dev: true + /@es-joy/jsdoccomment/0.20.1: resolution: {integrity: sha512-oeJK41dcdqkvdZy/HctKklJNkt/jh+av3PZARrZEl+fs/8HaHeeYoAvEwOV0u5I6bArTF17JEsTZMY359e/nfQ==} engines: {node: ^12 || ^14 || ^16 || ^17} @@ -1601,6 +1761,96 @@ packages: jsdoc-type-pratt-parser: 2.2.5 dev: true + /@esbuild/android-arm/0.16.17: + resolution: {integrity: sha512-N9x1CMXVhtWEAMS7pNNONyA14f71VPQN9Cnavj1XQh6T7bskqiLLrSca4O0Vr8Wdcga943eThxnVp3JLnBMYtw==} + engines: {node: '>=12'} + cpu: [arm] + os: [android] + requiresBuild: true + dev: true + optional: true + + /@esbuild/android-arm64/0.16.17: + resolution: {integrity: sha512-MIGl6p5sc3RDTLLkYL1MyL8BMRN4tLMRCn+yRJJmEDvYZ2M7tmAf80hx1kbNEUX2KJ50RRtxZ4JHLvCfuB6kBg==} + engines: {node: '>=12'} + cpu: [arm64] + os: [android] + requiresBuild: true + dev: true + optional: true + + /@esbuild/android-x64/0.16.17: + resolution: {integrity: sha512-a3kTv3m0Ghh4z1DaFEuEDfz3OLONKuFvI4Xqczqx4BqLyuFaFkuaG4j2MtA6fuWEFeC5x9IvqnX7drmRq/fyAQ==} + engines: {node: '>=12'} + cpu: [x64] + os: [android] + requiresBuild: true + dev: true + optional: true + + /@esbuild/darwin-arm64/0.16.17: + resolution: {integrity: sha512-/2agbUEfmxWHi9ARTX6OQ/KgXnOWfsNlTeLcoV7HSuSTv63E4DqtAc+2XqGw1KHxKMHGZgbVCZge7HXWX9Vn+w==} + engines: {node: '>=12'} + cpu: [arm64] + os: [darwin] + requiresBuild: true + dev: true + optional: true + + /@esbuild/darwin-x64/0.16.17: + resolution: {integrity: sha512-2By45OBHulkd9Svy5IOCZt376Aa2oOkiE9QWUK9fe6Tb+WDr8hXL3dpqi+DeLiMed8tVXspzsTAvd0jUl96wmg==} + engines: {node: '>=12'} + cpu: [x64] + os: [darwin] + requiresBuild: true + dev: true + optional: true + + /@esbuild/freebsd-arm64/0.16.17: + resolution: {integrity: sha512-mt+cxZe1tVx489VTb4mBAOo2aKSnJ33L9fr25JXpqQqzbUIw/yzIzi+NHwAXK2qYV1lEFp4OoVeThGjUbmWmdw==} + engines: {node: '>=12'} + cpu: [arm64] + os: [freebsd] + requiresBuild: true + dev: true + optional: true + + /@esbuild/freebsd-x64/0.16.17: + resolution: {integrity: sha512-8ScTdNJl5idAKjH8zGAsN7RuWcyHG3BAvMNpKOBaqqR7EbUhhVHOqXRdL7oZvz8WNHL2pr5+eIT5c65kA6NHug==} + engines: {node: '>=12'} + cpu: [x64] + os: [freebsd] + requiresBuild: true + dev: true + optional: true + + /@esbuild/linux-arm/0.16.17: + resolution: {integrity: sha512-iihzrWbD4gIT7j3caMzKb/RsFFHCwqqbrbH9SqUSRrdXkXaygSZCZg1FybsZz57Ju7N/SHEgPyaR0LZ8Zbe9gQ==} + engines: {node: '>=12'} + cpu: [arm] + os: [linux] + requiresBuild: true + dev: true + optional: true + + /@esbuild/linux-arm64/0.16.17: + resolution: {integrity: sha512-7S8gJnSlqKGVJunnMCrXHU9Q8Q/tQIxk/xL8BqAP64wchPCTzuM6W3Ra8cIa1HIflAvDnNOt2jaL17vaW+1V0g==} + engines: {node: '>=12'} + cpu: [arm64] + os: [linux] + requiresBuild: true + dev: true + optional: true + + /@esbuild/linux-ia32/0.16.17: + resolution: {integrity: sha512-kiX69+wcPAdgl3Lonh1VI7MBr16nktEvOfViszBSxygRQqSpzv7BffMKRPMFwzeJGPxcio0pdD3kYQGpqQ2SSg==} + engines: {node: '>=12'} + cpu: [ia32] + os: [linux] + requiresBuild: true + dev: true + optional: true + /@esbuild/linux-loong64/0.14.54: resolution: {integrity: sha512-bZBrLAIX1kpWelV0XemxBZllyRmM6vgFQQG2GdNb+r3Fkp0FOh1NJSvekXDs7jq70k4euu1cryLMfU+mTXlEpw==} engines: {node: '>=12'} @@ -1610,6 +1860,114 @@ packages: dev: true optional: true + /@esbuild/linux-loong64/0.16.17: + resolution: {integrity: sha512-dTzNnQwembNDhd654cA4QhbS9uDdXC3TKqMJjgOWsC0yNCbpzfWoXdZvp0mY7HU6nzk5E0zpRGGx3qoQg8T2DQ==} + engines: {node: '>=12'} + cpu: [loong64] + os: [linux] + requiresBuild: true + dev: true + optional: true + + /@esbuild/linux-mips64el/0.16.17: + resolution: {integrity: sha512-ezbDkp2nDl0PfIUn0CsQ30kxfcLTlcx4Foz2kYv8qdC6ia2oX5Q3E/8m6lq84Dj/6b0FrkgD582fJMIfHhJfSw==} + engines: {node: '>=12'} + cpu: [mips64el] + os: [linux] + requiresBuild: true + dev: true + optional: true + + /@esbuild/linux-ppc64/0.16.17: + resolution: {integrity: sha512-dzS678gYD1lJsW73zrFhDApLVdM3cUF2MvAa1D8K8KtcSKdLBPP4zZSLy6LFZ0jYqQdQ29bjAHJDgz0rVbLB3g==} + engines: {node: '>=12'} + cpu: [ppc64] + os: [linux] + requiresBuild: true + dev: true + optional: true + + /@esbuild/linux-riscv64/0.16.17: + resolution: {integrity: sha512-ylNlVsxuFjZK8DQtNUwiMskh6nT0vI7kYl/4fZgV1llP5d6+HIeL/vmmm3jpuoo8+NuXjQVZxmKuhDApK0/cKw==} + engines: {node: '>=12'} + cpu: [riscv64] + os: [linux] + requiresBuild: true + dev: true + optional: true + + /@esbuild/linux-s390x/0.16.17: + resolution: {integrity: sha512-gzy7nUTO4UA4oZ2wAMXPNBGTzZFP7mss3aKR2hH+/4UUkCOyqmjXiKpzGrY2TlEUhbbejzXVKKGazYcQTZWA/w==} + engines: {node: '>=12'} + cpu: [s390x] + os: [linux] + requiresBuild: true + dev: true + optional: true + + /@esbuild/linux-x64/0.16.17: + resolution: {integrity: sha512-mdPjPxfnmoqhgpiEArqi4egmBAMYvaObgn4poorpUaqmvzzbvqbowRllQ+ZgzGVMGKaPkqUmPDOOFQRUFDmeUw==} + engines: {node: '>=12'} + cpu: [x64] + os: [linux] + requiresBuild: true + dev: true + optional: true + + /@esbuild/netbsd-x64/0.16.17: + resolution: {integrity: sha512-/PzmzD/zyAeTUsduZa32bn0ORug+Jd1EGGAUJvqfeixoEISYpGnAezN6lnJoskauoai0Jrs+XSyvDhppCPoKOA==} + engines: {node: '>=12'} + cpu: [x64] + os: [netbsd] + requiresBuild: true + dev: true + optional: true + + /@esbuild/openbsd-x64/0.16.17: + resolution: {integrity: sha512-2yaWJhvxGEz2RiftSk0UObqJa/b+rIAjnODJgv2GbGGpRwAfpgzyrg1WLK8rqA24mfZa9GvpjLcBBg8JHkoodg==} + engines: {node: '>=12'} + cpu: [x64] + os: [openbsd] + requiresBuild: true + dev: true + optional: true + + /@esbuild/sunos-x64/0.16.17: + resolution: {integrity: sha512-xtVUiev38tN0R3g8VhRfN7Zl42YCJvyBhRKw1RJjwE1d2emWTVToPLNEQj/5Qxc6lVFATDiy6LjVHYhIPrLxzw==} + engines: {node: '>=12'} + cpu: [x64] + os: [sunos] + requiresBuild: true + dev: true + optional: true + + /@esbuild/win32-arm64/0.16.17: + resolution: {integrity: sha512-ga8+JqBDHY4b6fQAmOgtJJue36scANy4l/rL97W+0wYmijhxKetzZdKOJI7olaBaMhWt8Pac2McJdZLxXWUEQw==} + engines: {node: '>=12'} + cpu: [arm64] + os: [win32] + requiresBuild: true + dev: true + optional: true + + /@esbuild/win32-ia32/0.16.17: + resolution: {integrity: sha512-WnsKaf46uSSF/sZhwnqE4L/F89AYNMiD4YtEcYekBt9Q7nj0DiId2XH2Ng2PHM54qi5oPrQ8luuzGszqi/veig==} + engines: {node: '>=12'} + cpu: [ia32] + os: [win32] + requiresBuild: true + dev: true + optional: true + + /@esbuild/win32-x64/0.16.17: + resolution: {integrity: sha512-y+EHuSchhL7FjHgvQL/0fnnFmO4T1bhvWANX6gcnqTjtnKWbTvUMCpGnv2+t+31d7RzyEAYAd4u2fnIhHL6N/Q==} + engines: {node: '>=12'} + cpu: [x64] + os: [win32] + requiresBuild: true + dev: true + optional: true + /@eslint/eslintrc/1.3.3: resolution: {integrity: sha512-uj3pT6Mg+3t39fvLrj8iuCIJ38zKO9FpGtJ4BBJebJhEwjoT+KLVNCcHT5QC9NGRIEi7fZ0ZR8YRb884auB4Lg==} engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} @@ -2977,6 +3335,10 @@ packages: '@types/bn.js': 5.1.1 dev: true + /@types/flexsearch/0.7.3: + resolution: {integrity: sha512-HXwADeHEP4exXkCIwy2n1+i0f1ilP1ETQOH5KDOugjkTFZPntWo0Gr8stZOaebkxsdx+k0X/K6obU/+it07ocg==} + dev: true + /@types/glob/8.0.0: resolution: {integrity: sha512-l6NQsDDyQUVeoTynNpC9uRvCUint/gSUXQA2euwmTuWGvPY5LSDUu6tkCtJB2SvGQlJQzLaKqcGZP4//7EDveA==} dependencies: @@ -3041,6 +3403,10 @@ packages: '@types/node': 18.11.9 dev: true + /@types/linkify-it/3.0.2: + resolution: {integrity: sha512-HZQYqbiFVWufzCwexrvh694SOim8z2d+xJl5UNamcvQFejLY/2YUtzXHYi3cHdI7PMlS8ejH2slRAOJQ32aNbA==} + dev: true + /@types/lodash.clonedeep/4.5.7: resolution: {integrity: sha512-ccNqkPptFIXrpVqUECi60/DFxjNKsfoQxSQsgcBJCX/fuX1wgyQieojkcWH/KpE3xzLoWN/2k+ZeGqIN3paSvw==} dependencies: @@ -3063,6 +3429,17 @@ packages: resolution: {integrity: sha512-5iJ3FBJBvQHQ8sFhEhJfjUP+G+LalhavTkYyrAYqz5MEJG+erSv0k9KJLb6q7++17Lafk1scaTIFXcMJlwK8Mw==} dev: true + /@types/markdown-it/12.2.3: + resolution: {integrity: sha512-GKMHFfv3458yYy+v/N8gjufHO6MSZKCOXpZc5GXIWWy8uldwfmPn98vp81gZ5f9SVw8YYBctgfJ22a2d7AOMeQ==} + dependencies: + '@types/linkify-it': 3.0.2 + '@types/mdurl': 1.0.2 + dev: true + + /@types/mdurl/1.0.2: + resolution: {integrity: sha512-eC4U9MlIcu2q0KQmXszyn5Akca/0jrQmwDRgpAMJai7qBWq4amIQhZyNau4VYGtCeALvW1/NtjzJJ567aZxfKA==} + dev: true + /@types/minimatch/5.1.2: resolution: {integrity: sha512-K0VQKziLUWkVKiRVrx4a40iPaxTUefQmjtkQofBkYRcoaaL/8rhwDWww9qWbrgicNOgnpIsMxyNIUM4+n6dUIA==} dev: true @@ -3145,6 +3522,10 @@ packages: resolution: {integrity: sha512-Hl219/BT5fLAaz6NDkSuhzasy49dwQS/DSdu4MdggFB8zcXv7vflBI3xp7FEmkmdDkBUI2bPUNeMttp2knYdxw==} dev: true + /@types/web-bluetooth/0.0.16: + resolution: {integrity: sha512-oh8q2Zc32S6gd/j50GowEjKLoOVOwHP/bWVjKJInBwQqdOYMdPrf1oVlelTlyfFK3CKxL1uahMDAr+vy8T7yMQ==} + dev: true + /@types/web/0.0.65: resolution: {integrity: sha512-dl7VRSYBhxhOVxHA/ec8e7EzGXSQJrrGvRgLQWxusaJk1oT4I9nLpWiqsxekYI2eAEuet05toEm+rByL0G8x2Q==} dev: true @@ -3294,6 +3675,129 @@ packages: eslint-visitor-keys: 3.3.0 dev: true + /@vitejs/plugin-vue/4.0.0_vite@4.1.4+vue@3.2.47: + resolution: {integrity: sha512-e0X4jErIxAB5oLtDqbHvHpJe/uWNkdpYV83AOG2xo2tEVSzCzewgJMtREZM30wXnM5ls90hxiOtAuVU6H5JgbA==} + engines: {node: ^14.18.0 || >=16.0.0} + peerDependencies: + vite: ^4.0.0 + vue: ^3.2.25 + dependencies: + vite: 4.1.4 + vue: 3.2.47 + dev: true + + /@vue/compiler-core/3.2.47: + resolution: {integrity: sha512-p4D7FDnQb7+YJmO2iPEv0SQNeNzcbHdGByJDsT4lynf63AFkOTFN07HsiRSvjGo0QrxR/o3d0hUyNCUnBU2Tig==} + dependencies: + '@babel/parser': 7.20.3 + '@vue/shared': 3.2.47 + estree-walker: 2.0.2 + source-map: 0.6.1 + dev: true + + /@vue/compiler-dom/3.2.47: + resolution: {integrity: sha512-dBBnEHEPoftUiS03a4ggEig74J2YBZ2UIeyfpcRM2tavgMWo4bsEfgCGsu+uJIL/vax9S+JztH8NmQerUo7shQ==} + dependencies: + '@vue/compiler-core': 3.2.47 + '@vue/shared': 3.2.47 + dev: true + + /@vue/compiler-sfc/3.2.47: + resolution: {integrity: sha512-rog05W+2IFfxjMcFw10tM9+f7i/+FFpZJJ5XHX72NP9eC2uRD+42M3pYcQqDXVYoj74kHMSEdQ/WmCjt8JFksQ==} + dependencies: + '@babel/parser': 7.20.3 + '@vue/compiler-core': 3.2.47 + '@vue/compiler-dom': 3.2.47 + '@vue/compiler-ssr': 3.2.47 + '@vue/reactivity-transform': 3.2.47 + '@vue/shared': 3.2.47 + estree-walker: 2.0.2 + magic-string: 0.25.9 + postcss: 8.4.21 + source-map: 0.6.1 + dev: true + + /@vue/compiler-ssr/3.2.47: + resolution: {integrity: sha512-wVXC+gszhulcMD8wpxMsqSOpvDZ6xKXSVWkf50Guf/S+28hTAXPDYRTbLQ3EDkOP5Xz/+SY37YiwDquKbJOgZw==} + dependencies: + '@vue/compiler-dom': 3.2.47 + '@vue/shared': 3.2.47 + dev: true + + /@vue/devtools-api/6.5.0: + resolution: {integrity: sha512-o9KfBeaBmCKl10usN4crU53fYtC1r7jJwdGKjPT24t348rHxgfpZ0xL3Xm/gLUYnc0oTp8LAmrxOeLyu6tbk2Q==} + dev: true + + /@vue/reactivity-transform/3.2.47: + resolution: {integrity: sha512-m8lGXw8rdnPVVIdIFhf0LeQ/ixyHkH5plYuS83yop5n7ggVJU+z5v0zecwEnX7fa7HNLBhh2qngJJkxpwEEmYA==} + dependencies: + '@babel/parser': 7.20.3 + '@vue/compiler-core': 3.2.47 + '@vue/shared': 3.2.47 + estree-walker: 2.0.2 + magic-string: 0.25.9 + dev: true + + /@vue/reactivity/3.2.47: + resolution: {integrity: sha512-7khqQ/75oyyg+N/e+iwV6lpy1f5wq759NdlS1fpAhFXa8VeAIKGgk2E/C4VF59lx5b+Ezs5fpp/5WsRYXQiKxQ==} + dependencies: + '@vue/shared': 3.2.47 + dev: true + + /@vue/runtime-core/3.2.47: + resolution: {integrity: sha512-RZxbLQIRB/K0ev0K9FXhNbBzT32H9iRtYbaXb0ZIz2usLms/D55dJR2t6cIEUn6vyhS3ALNvNthI+Q95C+NOpA==} + dependencies: + '@vue/reactivity': 3.2.47 + '@vue/shared': 3.2.47 + dev: true + + /@vue/runtime-dom/3.2.47: + resolution: {integrity: sha512-ArXrFTjS6TsDei4qwNvgrdmHtD930KgSKGhS5M+j8QxXrDJYLqYw4RRcDy1bz1m1wMmb6j+zGLifdVHtkXA7gA==} + dependencies: + '@vue/runtime-core': 3.2.47 + '@vue/shared': 3.2.47 + csstype: 2.6.21 + dev: true + + /@vue/server-renderer/3.2.47_vue@3.2.47: + resolution: {integrity: sha512-dN9gc1i8EvmP9RCzvneONXsKfBRgqFeFZLurmHOveL7oH6HiFXJw5OGu294n1nHc/HMgTy6LulU/tv5/A7f/LA==} + peerDependencies: + vue: 3.2.47 + dependencies: + '@vue/compiler-ssr': 3.2.47 + '@vue/shared': 3.2.47 + vue: 3.2.47 + dev: true + + /@vue/shared/3.2.47: + resolution: {integrity: sha512-BHGyyGN3Q97EZx0taMQ+OLNuZcW3d37ZEVmEAyeoA9ERdGvm9Irc/0Fua8SNyOtV1w6BS4q25wbMzJujO9HIfQ==} + dev: true + + /@vueuse/core/9.13.0_vue@3.2.47: + resolution: {integrity: sha512-pujnclbeHWxxPRqXWmdkKV5OX4Wk4YeK7wusHqRwU0Q7EFusHoqNA/aPhB6KCh9hEqJkLAJo7bb0Lh9b+OIVzw==} + dependencies: + '@types/web-bluetooth': 0.0.16 + '@vueuse/metadata': 9.13.0 + '@vueuse/shared': 9.13.0_vue@3.2.47 + vue-demi: 0.13.11_vue@3.2.47 + transitivePeerDependencies: + - '@vue/composition-api' + - vue + dev: true + + /@vueuse/metadata/9.13.0: + resolution: {integrity: sha512-gdU7TKNAUVlXXLbaF+ZCfte8BjRJQWPCa2J55+7/h+yDtzw3vOoGQDRXzI6pyKyo6bXFT5/QoPE4hAknExjRLQ==} + dev: true + + /@vueuse/shared/9.13.0_vue@3.2.47: + resolution: {integrity: sha512-UrnhU+Cnufu4S6JLCPZnkWh0WwZGUp72ktOF2DFptMlOs3TOdVv8xJN53zhHGARmVOsz5KqOls09+J1NR6sBKw==} + dependencies: + vue-demi: 0.13.11_vue@3.2.47 + transitivePeerDependencies: + - '@vue/composition-api' + - vue + dev: true + /@whatwg-node/fetch/0.3.2: resolution: {integrity: sha512-Bs5zAWQs0tXsLa4mRmLw7Psps1EN78vPtgcLpw3qPY8s6UYPUM67zFZ9cy+7tZ64PXhfwzxJn+m7RH2Lq48RNQ==} dependencies: @@ -3396,6 +3900,25 @@ packages: uri-js: 4.4.1 dev: true + /algoliasearch/4.15.0: + resolution: {integrity: sha512-+vgKQF5944dYsz9zhKk07JbOYeNdKisoD5GeG0woBL3nLzbn2a+nGwki60DXg7CXvaFXBcTXyJG4C+VaBVd44g==} + dependencies: + '@algolia/cache-browser-local-storage': 4.15.0 + '@algolia/cache-common': 4.15.0 + '@algolia/cache-in-memory': 4.15.0 + '@algolia/client-account': 4.15.0 + '@algolia/client-analytics': 4.15.0 + '@algolia/client-common': 4.15.0 + '@algolia/client-personalization': 4.15.0 + '@algolia/client-search': 4.15.0 + '@algolia/logger-common': 4.15.0 + '@algolia/logger-console': 4.15.0 + '@algolia/requester-browser-xhr': 4.15.0 + '@algolia/requester-common': 4.15.0 + '@algolia/requester-node-http': 4.15.0 + '@algolia/transporter': 4.15.0 + dev: true + /ansi-colors/4.1.3: resolution: {integrity: sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==} engines: {node: '>=6'} @@ -3413,6 +3936,10 @@ packages: engines: {node: '>=8'} dev: true + /ansi-sequence-parser/1.1.0: + resolution: {integrity: sha512-lEm8mt52to2fT8GhciPCGeCXACSz2UwIN4X2e2LJSnZ5uAbn2/dsYdOmUXq0AtWS5cpAupysIneExOgH0Vd2TQ==} + dev: true + /ansi-styles/3.2.1: resolution: {integrity: sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==} engines: {node: '>=4'} @@ -3713,6 +4240,10 @@ packages: /bn.js/5.2.1: resolution: {integrity: sha512-eXRvHzWyYPBuB4NBy0cmYQjGitUrtqwbvlzP3G6VFnNRbsZQIxQ10PbKKHt8gZ/HW/D/747aDl+QkDqg3KQLMQ==} + /body-scroll-lock/4.0.0-beta.0: + resolution: {integrity: sha512-a7tP5+0Mw3YlUJcGAKUqIBkYYGlYxk2fnCasq/FUph1hadxlTRjF+gAcZksxANnaMnALjxEddmSi/H3OR8ugcQ==} + dev: true + /brace-expansion/1.1.11: resolution: {integrity: sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==} dependencies: @@ -3723,6 +4254,7 @@ packages: resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==} dependencies: balanced-match: 1.0.2 + dev: false /braces/3.0.2: resolution: {integrity: sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==} @@ -4199,6 +4731,10 @@ packages: which: 2.0.2 dev: true + /csstype/2.6.21: + resolution: {integrity: sha512-Z1PhmomIfypOpoMjRQB70jfvy/wxT50qW08YXO5lMIJkrdq4yOTR+AW7FqutScmB9NkLwxo+jU+kZLbofZZq/w==} + dev: true + /csv-generate/3.4.3: resolution: {integrity: sha512-w/T+rqR0vwvHqWs/1ZyMDWtHHSJaN06klRqJXBEpDJaM/+dZkso0OKh1VcuuYvK3XM53KysVNq8Ko/epCK8wOw==} dev: true @@ -4450,6 +4986,11 @@ packages: resolution: {integrity: sha512-hCx1oky9PFrJ611mf0ifBLBRW8lUUVRlFolb5gWRfIELabBlbp9xZvrqZLZAs+NxFnbfQoeGd8wDkygjg7U85w==} dev: true + /entities/3.0.1: + resolution: {integrity: sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==} + engines: {node: '>=0.12'} + dev: true + /error-ex/1.3.2: resolution: {integrity: sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==} dependencies: @@ -4710,6 +5251,36 @@ packages: esbuild-windows-arm64: 0.14.54 dev: true + /esbuild/0.16.17: + resolution: {integrity: sha512-G8LEkV0XzDMNwXKgM0Jwu3nY3lSTwSGY6XbxM9cr9+s0T/qSV1q1JVPBGzm3dcjhCic9+emZDmMffkwgPeOeLg==} + engines: {node: '>=12'} + hasBin: true + requiresBuild: true + optionalDependencies: + '@esbuild/android-arm': 0.16.17 + '@esbuild/android-arm64': 0.16.17 + '@esbuild/android-x64': 0.16.17 + '@esbuild/darwin-arm64': 0.16.17 + '@esbuild/darwin-x64': 0.16.17 + '@esbuild/freebsd-arm64': 0.16.17 + '@esbuild/freebsd-x64': 0.16.17 + '@esbuild/linux-arm': 0.16.17 + '@esbuild/linux-arm64': 0.16.17 + '@esbuild/linux-ia32': 0.16.17 + '@esbuild/linux-loong64': 0.16.17 + '@esbuild/linux-mips64el': 0.16.17 + '@esbuild/linux-ppc64': 0.16.17 + '@esbuild/linux-riscv64': 0.16.17 + '@esbuild/linux-s390x': 0.16.17 + '@esbuild/linux-x64': 0.16.17 + '@esbuild/netbsd-x64': 0.16.17 + '@esbuild/openbsd-x64': 0.16.17 + '@esbuild/sunos-x64': 0.16.17 + '@esbuild/win32-arm64': 0.16.17 + '@esbuild/win32-ia32': 0.16.17 + '@esbuild/win32-x64': 0.16.17 + dev: true + /escalade/3.1.1: resolution: {integrity: sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==} engines: {node: '>=6'} @@ -5070,6 +5641,10 @@ packages: engines: {node: '>=4.0'} dev: true + /estree-walker/2.0.2: + resolution: {integrity: sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==} + dev: true + /esutils/2.0.3: resolution: {integrity: sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==} engines: {node: '>=0.10.0'} @@ -5293,6 +5868,10 @@ packages: resolution: {integrity: sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ==} dev: true + /flexsearch/0.7.31: + resolution: {integrity: sha512-XGozTsMPYkm+6b5QL3Z9wQcJjNYxp0CYn3U1gO7dwD6PAqU1SVWZxI9CCg3z+ml3YfqdPnrBehaBrnH2AGKbNA==} + dev: true + /form-data-encoder/1.7.2: resolution: {integrity: sha512-qfqtYan3rxrnCk1VYaA4H+Ms9xdpPqvLZa6xmMgFvhO32x7/3J/ExcTd6qpxM0vH2GdMI+poehyBZvqfMTto8A==} dev: true @@ -5584,6 +6163,7 @@ packages: wordwrap: 1.0.0 optionalDependencies: uglify-js: 3.17.4 + dev: false /hard-rejection/2.1.0: resolution: {integrity: sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==} @@ -6740,6 +7320,12 @@ packages: uc.micro: 1.0.6 dev: true + /linkify-it/4.0.1: + resolution: {integrity: sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==} + dependencies: + uc.micro: 1.0.6 + dev: true + /listr2/4.0.5: resolution: {integrity: sha512-juGHV1doQdpNT3GSTs9IUN43QJb7KHdF9uqg7Vufs/tG9VTzpFphqF4pm/ICdAABGQxsyNn9CiYA3StkI6jpwA==} engines: {node: '>=12'} @@ -6916,8 +7502,10 @@ packages: dependencies: yallist: 4.0.0 - /lunr/2.3.9: - resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} + /magic-string/0.25.9: + resolution: {integrity: sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==} + dependencies: + sourcemap-codec: 1.4.8 dev: true /make-dir/3.1.0: @@ -6963,6 +7551,17 @@ packages: uc.micro: 1.0.6 dev: true + /markdown-it/13.0.1: + resolution: {integrity: sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q==} + hasBin: true + dependencies: + argparse: 2.0.1 + entities: 3.0.1 + linkify-it: 4.0.1 + mdurl: 1.0.1 + uc.micro: 1.0.6 + dev: true + /markdownlint-cli/0.27.1: resolution: {integrity: sha512-p1VV6aSbGrDlpUWzHizAnSNEQAweVR3qUI/AIUubxW7BGPXziSXkIED+uRtSohUlRS/jmqp3Wi4es5j6fIrdeQ==} engines: {node: '>=10'} @@ -6995,12 +7594,6 @@ packages: markdown-it: 12.0.4 dev: true - /marked/4.2.3: - resolution: {integrity: sha512-slWRdJkbTZ+PjkyJnE30Uid64eHwbwa1Q25INCAYfZlK4o6ylagBy/Le9eWntqJFoFT93ikUKMv47GZ4gTwHkw==} - engines: {node: '>= 12'} - hasBin: true - dev: true - /mdurl/1.0.1: resolution: {integrity: sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==} dev: true @@ -7105,6 +7698,7 @@ packages: engines: {node: '>=10'} dependencies: brace-expansion: 2.0.1 + dev: false /minimist-options/4.1.0: resolution: {integrity: sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A==} @@ -7159,6 +7753,12 @@ packages: thenify-all: 1.6.0 dev: true + /nanoid/3.3.4: + resolution: {integrity: sha512-MqBkQh/OHTS2egovRtLk45wEyNXwF+cokD+1YPf9u5VfJiRdAiRwB2froX5Co9Rh20xs4siNPm8naNotSD6RBw==} + engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} + hasBin: true + dev: true + /natural-compare-lite/1.4.0: resolution: {integrity: sha512-Tj+HTDSJJKaZnfiuw+iaF9skdPpTo2GtEly5JHnWV/hfv2Qj/9RKsGISQtLh2ox3l5EAGw487hnBee0sIJ6v2g==} dev: true @@ -7169,6 +7769,7 @@ packages: /neo-async/2.6.2: resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==} + dev: false /nice-try/1.0.5: resolution: {integrity: sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==} @@ -7575,6 +8176,19 @@ packages: yaml: 1.10.2 dev: true + /postcss/8.4.21: + resolution: {integrity: sha512-tP7u/Sn/dVxK2NnruI4H9BG+x+Wxz6oeZ1cJ8P6G/PZY0IKk4k/63TDsQf2kQq3+qoJeLm2kIBUNlZe3zgb4Zg==} + engines: {node: ^10 || ^12 || >=14} + dependencies: + nanoid: 3.3.4 + picocolors: 1.0.0 + source-map-js: 1.0.2 + dev: true + + /preact/10.13.0: + resolution: {integrity: sha512-ERdIdUpR6doqdaSIh80hvzebHB7O6JxycOhyzAeLEchqOq/4yueslQbfnPwXaNhAYacFTyCclhwkEbOumT0tHw==} + dev: true + /preferred-pm/3.0.3: resolution: {integrity: sha512-+wZgbxNES/KlJs9q40F/1sfOd/j7f1O9JaHcW5Dsn3aUUOZg3L2bjpVUcKV2jvtElYfoTuQiNeMfQJ4kwUAhCQ==} engines: {node: '>=10'} @@ -7885,6 +8499,14 @@ packages: fsevents: 2.3.2 dev: true + /rollup/3.18.0: + resolution: {integrity: sha512-J8C6VfEBjkvYPESMQYxKHxNOh4A5a3FlP+0BETGo34HEcE4eTlgCrO2+eWzlu2a/sHs2QUkZco+wscH7jhhgWg==} + engines: {node: '>=14.18.0', npm: '>=8.0.0'} + hasBin: true + optionalDependencies: + fsevents: 2.3.2 + dev: true + /run-async/2.4.1: resolution: {integrity: sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==} engines: {node: '>=0.12.0'} @@ -7996,12 +8618,13 @@ packages: interpret: 1.4.0 rechoir: 0.6.2 - /shiki/0.11.1: - resolution: {integrity: sha512-EugY9VASFuDqOexOgXR18ZV+TbFrQHeCpEYaXamO+SZlsnT/2LxuLBX25GGtIrwaEVFXUAbUQ601SWE2rMwWHA==} + /shiki/0.14.1: + resolution: {integrity: sha512-+Jz4nBkCBe0mEDqo1eKRcCdjRtrCjozmcbTUjbPTX7OOJfEbTZzlUWlZtGe3Gb5oV1/jnojhG//YZc3rs9zSEw==} dependencies: + ansi-sequence-parser: 1.1.0 jsonc-parser: 3.2.0 - vscode-oniguruma: 1.6.2 - vscode-textmate: 6.0.0 + vscode-oniguruma: 1.7.0 + vscode-textmate: 8.0.0 dev: true /side-channel/1.0.4: @@ -8067,6 +8690,11 @@ packages: tslib: 2.4.1 dev: true + /source-map-js/1.0.2: + resolution: {integrity: sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==} + engines: {node: '>=0.10.0'} + dev: true + /source-map-support/0.5.13: resolution: {integrity: sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w==} dependencies: @@ -8085,6 +8713,11 @@ packages: whatwg-url: 7.1.0 dev: true + /sourcemap-codec/1.4.8: + resolution: {integrity: sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==} + deprecated: Please use @jridgewell/sourcemap-codec instead + dev: true + /spawndamnit/2.0.0: resolution: {integrity: sha512-j4JKEcncSjFlqIwU5L/rp2N5SIPsdxaRsIv678+TZxZ0SRDJTm8JrxJMjE/XuiEZNEir3S8l0Fa3Ke339WI4qA==} dependencies: @@ -8675,47 +9308,6 @@ packages: engines: {node: '>=14.16'} dev: false - /typedoc-just-the-docs-theme/0.0.1_vw2i6qmpkoeqkz2lubusygb56a: - resolution: {integrity: sha512-EetAAT5XwVifc26eldY1SLv9Ey7wQQa1GV9wkNeVlZMPjPuGQIoIy4z7bT6u4ZOZANDeF5J0fdjxKQeJN1ejOg==} - peerDependencies: - typedoc: '>=0.22.9' - typedoc-plugin-markdown: '>=3.11.10' - dependencies: - typedoc: 0.23.21_typescript@4.9.3 - typedoc-plugin-markdown: 3.13.6_typedoc@0.23.21 - dev: true - - /typedoc-monorepo-link-types/0.0.4_typedoc@0.23.21: - resolution: {integrity: sha512-fAxmfoJSp6cvT+I9/pN9pS2R8EoKUHaKU095E6H7FwN4tZUXPri5CZkxi9JLRlM5SV+pQwIlYnx9b+hnVP0nHA==} - peerDependencies: - typedoc: 0.23.x - dependencies: - typedoc: 0.23.21_typescript@4.9.3 - dev: true - - /typedoc-plugin-markdown/3.13.6_typedoc@0.23.21: - resolution: {integrity: sha512-ISSc9v3BK7HkokxSBuJPttXox4tJ6hP0N9wfSIk0fmLN67+eqtAxbk97gs2nDiuha+RTO5eW9gdeAb+RPP0mgg==} - peerDependencies: - typedoc: '>=0.23.0' - dependencies: - handlebars: 4.7.7 - typedoc: 0.23.21_typescript@4.9.3 - dev: true - - /typedoc/0.23.21_typescript@4.9.3: - resolution: {integrity: sha512-VNE9Jv7BgclvyH9moi2mluneSviD43dCE9pY8RWkO88/DrEgJZk9KpUk7WO468c9WWs/+aG6dOnoH7ccjnErhg==} - engines: {node: '>= 14.14'} - hasBin: true - peerDependencies: - typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x - dependencies: - lunr: 2.3.9 - marked: 4.2.3 - minimatch: 5.1.0 - shiki: 0.11.1 - typescript: 4.9.3 - dev: true - /typescript/4.9.3: resolution: {integrity: sha512-CIfGzTelbKNEnLpLdGFgdyKhG23CKdKgQPOBc+OUNrkJ2vr+KSzsSV5kq5iWhEQbok+quxgGzrAtGWCyU7tHnA==} engines: {node: '>=4.2.0'} @@ -8735,6 +9327,7 @@ packages: engines: {node: '>=0.8.0'} hasBin: true requiresBuild: true + dev: false optional: true /unbox-primitive/1.0.2: @@ -8834,12 +9427,113 @@ packages: engines: {node: '>=12'} dev: true - /vscode-oniguruma/1.6.2: - resolution: {integrity: sha512-KH8+KKov5eS/9WhofZR8M8dMHWN2gTxjMsG4jd04YhpbPR91fUj7rYQ2/XjeHCJWbg7X++ApRIU9NUwM2vTvLA==} + /vite/4.1.4: + resolution: {integrity: sha512-3knk/HsbSTKEin43zHu7jTwYWv81f8kgAL99G5NWBcA1LKvtvcVAC4JjBH1arBunO9kQka+1oGbrMKOjk4ZrBg==} + engines: {node: ^14.18.0 || >=16.0.0} + hasBin: true + peerDependencies: + '@types/node': '>= 14' + less: '*' + sass: '*' + stylus: '*' + sugarss: '*' + terser: ^5.4.0 + peerDependenciesMeta: + '@types/node': + optional: true + less: + optional: true + sass: + optional: true + stylus: + optional: true + sugarss: + optional: true + terser: + optional: true + dependencies: + esbuild: 0.16.17 + postcss: 8.4.21 + resolve: 1.22.1 + rollup: 3.18.0 + optionalDependencies: + fsevents: 2.3.2 + dev: true + + /vitepress-plugin-search/1.0.4-alpha.19_wa76uzoxa7sjxpgthdjgz7ruma: + resolution: {integrity: sha512-WFOPn5dStyMINd+rVjNxbEmGa7U+qGHLxLnda56EG+ATil1i0yOauGhJEh5LPMvuCUVIA9tInJnFXklOBb39dA==} + engines: {node: ^14.13.1 || ^16.7.0 || >=18} + peerDependencies: + flexsearch: ^0.7.31 + vitepress: ^1.0.0-alpha.13 + vue: '3' + dependencies: + '@types/flexsearch': 0.7.3 + '@types/markdown-it': 12.2.3 + flexsearch: 0.7.31 + markdown-it: 13.0.1 + vitepress: 1.0.0-alpha.51_2xdflmy6sc2qhwxavtux3g5lt4 + vue: 3.2.47 dev: true - /vscode-textmate/6.0.0: - resolution: {integrity: sha512-gu73tuZfJgu+mvCSy4UZwd2JXykjK9zAZsfmDeut5dx/1a7FeTk0XwJsSuqQn+cuMCGVbIBfl+s53X4T19DnzQ==} + /vitepress/1.0.0-alpha.51_2xdflmy6sc2qhwxavtux3g5lt4: + resolution: {integrity: sha512-euZpjXeIaNUadLAQtd7NYbKhJJoDyZ6z8YK77qlM2c6NvUB5wmLPU6moP4rfcKUqpBDrsrxjJS6fdPk6azS5qQ==} + hasBin: true + dependencies: + '@docsearch/css': 3.3.3 + '@docsearch/js': 3.3.3_2xdflmy6sc2qhwxavtux3g5lt4 + '@vitejs/plugin-vue': 4.0.0_vite@4.1.4+vue@3.2.47 + '@vue/devtools-api': 6.5.0 + '@vueuse/core': 9.13.0_vue@3.2.47 + body-scroll-lock: 4.0.0-beta.0 + shiki: 0.14.1 + vite: 4.1.4 + vue: 3.2.47 + transitivePeerDependencies: + - '@algolia/client-search' + - '@types/node' + - '@types/react' + - '@vue/composition-api' + - less + - react + - react-dom + - sass + - stylus + - sugarss + - terser + dev: true + + /vscode-oniguruma/1.7.0: + resolution: {integrity: sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==} + dev: true + + /vscode-textmate/8.0.0: + resolution: {integrity: sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==} + dev: true + + /vue-demi/0.13.11_vue@3.2.47: + resolution: {integrity: sha512-IR8HoEEGM65YY3ZJYAjMlKygDQn25D5ajNFNoKh9RSDMQtlzCxtfQjdQgv9jjK+m3377SsJXY8ysq8kLCZL25A==} + engines: {node: '>=12'} + hasBin: true + requiresBuild: true + peerDependencies: + '@vue/composition-api': ^1.0.0-rc.1 + vue: ^3.0.0-0 || ^2.6.0 + peerDependenciesMeta: + '@vue/composition-api': + optional: true + dependencies: + vue: 3.2.47 + dev: true + + /vue/3.2.47: + resolution: {integrity: sha512-60188y/9Dc9WVrAZeUVSDxRQOZ+z+y5nO2ts9jWXSTkMvayiWxCWOWtBQoYjLeccfXkiiPZWAHcV+WTPhkqJHQ==} + dependencies: + '@vue/compiler-dom': 3.2.47 + '@vue/compiler-sfc': 3.2.47 + '@vue/runtime-dom': 3.2.47 + '@vue/server-renderer': 3.2.47_vue@3.2.47 + '@vue/shared': 3.2.47 dev: true /walker/1.0.8: @@ -8943,6 +9637,7 @@ packages: /wordwrap/1.0.0: resolution: {integrity: sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==} + dev: false /wrap-ansi/6.2.0: resolution: {integrity: sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==} diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index dee51e928d8..0e5a0737c3d 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -1,2 +1,3 @@ packages: - "packages/*" + - "apps/*" From 7727e6011eed8eb933c4fc090a5c7bcfb2cb9a91 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 10:55:29 -0300 Subject: [PATCH 02/23] using imported snippets instead of hardcoded (Wallet Access docs) --- apps/docs/src/guide/wallets/access.md | 28 +++----------------- packages/fuel-gauge/src/doc-examples.test.ts | 16 +++++------ 2 files changed, 11 insertions(+), 33 deletions(-) diff --git a/apps/docs/src/guide/wallets/access.md b/apps/docs/src/guide/wallets/access.md index 927c2f58b28..bd2981ef837 100644 --- a/apps/docs/src/guide/wallets/access.md +++ b/apps/docs/src/guide/wallets/access.md @@ -25,39 +25,17 @@ provides greater access via its private key. ## Basic Example -```ts:line-numbers -import { Wallet, WalletLocked, WalletUnlocked } from "fuels"; - -// use the `generate` helper to make an Unlocked Wallet -const myWallet: WalletUnlocked = Wallet.generate(); - -// or use an Address to create a wallet -const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L155-L163) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallets{ts:line-numbers} ## Transitioning States A `WalletLocked` instance can be unlocked by providing the private key: -```ts:line-numbers -const lockedWallet: WalletLocked = Wallet.fromAddress(myWallet.address); -// unlock an existing wallet -let unlockedWallet: WalletUnlocked = lockedWallet.unlock(PRIVATE_KEY); -// or directly from a private key -unlockedWallet = Wallet.fromPrivateKey(PRIVATE_KEY); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L167-L175) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-locked-to-unlocked{ts:line-numbers} A `WalletUnlocked` instance can be locked using the `lock` method: -```ts:line-numbers -const newlyLockedWallet = unlockedWallet.lock(); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L177-L179) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-unlocked-to-locked{ts:line-numbers} Most wallet constructors that create or generate a new wallet are provided on the `WalletUnlocked` type. Consider `lock`ing the wallet after the new private diff --git a/packages/fuel-gauge/src/doc-examples.test.ts b/packages/fuel-gauge/src/doc-examples.test.ts index 52dce4ac1b8..e9764546128 100644 --- a/packages/fuel-gauge/src/doc-examples.test.ts +++ b/packages/fuel-gauge/src/doc-examples.test.ts @@ -152,7 +152,7 @@ test('it has conversion tools', async () => { }); test('it can work with wallets', async () => { - // #region typedoc:wallets + // #region wallets // #context import { Wallet, WalletLocked, WalletUnlocked } from 'fuels'; // use the `generate` helper to make an Unlocked Wallet @@ -160,23 +160,23 @@ test('it can work with wallets', async () => { // or use an Address to create a wallet const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); - // #endregion + // #endregion wallets const PRIVATE_KEY = myWallet.privateKey; - // #region typedoc:wallet-locked-to-unlocked + // #region wallet-locked-to-unlocked const lockedWallet: WalletLocked = Wallet.fromAddress(myWallet.address); - // #region typedoc:wallet-from-private-key + // #region wallet-from-private-key // unlock an existing wallet let unlockedWallet: WalletUnlocked = lockedWallet.unlock(PRIVATE_KEY); // or directly from a private key unlockedWallet = Wallet.fromPrivateKey(PRIVATE_KEY); - // #endregion - // #endregion + // #endregion wallet-locked-to-unlocked + // #endregion wallet-from-private-key - // #region typedoc:wallet-unlocked-to-locked + // #region wallet-unlocked-to-locked const newlyLockedWallet = unlockedWallet.lock(); - // #endregion + // #endregion wallet-unlocked-to-locked // #region typedoc:wallet-check-balance // #context import { Wallet, WalletUnlocked, BigNumberish} from 'fuels'; From 24f7c98ac2c8ec9cda4de488a6d02f174dd6e5db Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 11:00:28 -0300 Subject: [PATCH 03/23] using imported snippets instead of hardcoded (Checking balances and coins docs) --- .../guide/wallets/checking-balances-and-coins.md | 16 ++-------------- packages/fuel-gauge/src/doc-examples.test.ts | 8 ++++---- 2 files changed, 6 insertions(+), 18 deletions(-) diff --git a/apps/docs/src/guide/wallets/checking-balances-and-coins.md b/apps/docs/src/guide/wallets/checking-balances-and-coins.md index 5c8d0c89def..d181ccae3a8 100644 --- a/apps/docs/src/guide/wallets/checking-balances-and-coins.md +++ b/apps/docs/src/guide/wallets/checking-balances-and-coins.md @@ -2,20 +2,8 @@ First, one should remember that, with UTXOs, each _coin_ is unique. Each UTXO corresponds to a unique _coin_, and said _coin_ has a corresponding _amount_ (the same way a dollar bill has either 10$ or 5$ face value). So, when you want to query the balance for a given asset ID, you want to query the sum of the amount in each unspent coin. This querying is done very easily with a wallet: -```ts:line-numbers -import { Wallet, WalletUnlocked, BigNumberish } from "fuels"; -const balance: BigNumberish = await myWallet.getBalance(NativeAssetId); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L181-L184) - ---- +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-check-balance{ts:line-numbers} If you want to query all the balances (i.e., get the balance for each asset ID in that wallet), then it is as simple as: -```ts:line-numbers -import { Wallet, WalletUnlocked, CoinQuantity } from "fuels"; -const balances: CoinQuantity[] = await myWallet.getBalances(); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L186-L189) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-check-balances{ts:line-numbers} diff --git a/packages/fuel-gauge/src/doc-examples.test.ts b/packages/fuel-gauge/src/doc-examples.test.ts index e9764546128..cf942a3ae0e 100644 --- a/packages/fuel-gauge/src/doc-examples.test.ts +++ b/packages/fuel-gauge/src/doc-examples.test.ts @@ -178,15 +178,15 @@ test('it can work with wallets', async () => { const newlyLockedWallet = unlockedWallet.lock(); // #endregion wallet-unlocked-to-locked - // #region typedoc:wallet-check-balance + // #region wallet-check-balance // #context import { Wallet, WalletUnlocked, BigNumberish} from 'fuels'; const balance: BigNumberish = await myWallet.getBalance(NativeAssetId); - // #endregion + // #endregion wallet-check-balance - // #region typedoc:wallet-check-balances + // #region wallet-check-balances // #context import { Wallet, WalletUnlocked, CoinQuantity} from 'fuels'; const balances: CoinQuantity[] = await myWallet.getBalances(); - // #endregion + // #endregion wallet-check-balances expect(newlyLockedWallet.address).toEqual(someWallet.address); expect(balance).toBeTruthy(); From bde8f67378aeaa2bb61a8e2fb0232f46e02b17f4 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 11:03:54 -0300 Subject: [PATCH 04/23] using imported snippets instead of hardcoded (Encrypting and storing wallets docs) --- .../guide/wallets/encrypting-and-storing-wallets.md | 10 +--------- packages/wallet-manager/src/wallet-manager.test.ts | 4 ++-- 2 files changed, 3 insertions(+), 11 deletions(-) diff --git a/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md b/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md index 016f9424459..3b570037f8a 100644 --- a/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md +++ b/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md @@ -6,15 +6,7 @@ You can also manage a wallet using [JSON wallets](https://cryptobook.nakov.com/s You can create a random wallet and, at the same time, encrypt and store it. Then, later, you can recover the wallet if you know the master password: -```ts:line-numbers -const walletManager = new WalletManager(); -const password = "0b540281-f87b-49ca-be37-2264c7f260f7"; -const wallet = Wallet.generate(); - -await walletManager.unlock(password); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.test.ts#L123-L129) +<<< @/../../../packages/wallet-manager/src/wallet-manager.test.ts#wallet-manager-create{ts:line-numbers} ## Encrypting and storing a wallet created from a mnemonic or private key diff --git a/packages/wallet-manager/src/wallet-manager.test.ts b/packages/wallet-manager/src/wallet-manager.test.ts index 4cd0b11c6c9..2c12aa72fc2 100644 --- a/packages/wallet-manager/src/wallet-manager.test.ts +++ b/packages/wallet-manager/src/wallet-manager.test.ts @@ -120,13 +120,13 @@ describe('Wallet Manager', () => { }); it('Export privateKey from address from a privateKey vault', async () => { - // #region typedoc:wallet-manager-create + // #region wallet-manager-create const walletManager = new WalletManager(); const password = '0b540281-f87b-49ca-be37-2264c7f260f7'; const wallet = Wallet.generate(); await walletManager.unlock(password); - // #endregion + // #endregion wallet-manager-create // Add a vault of type privateKey await walletManager.addVault({ From 5702272aa2c222334f90b49dd14be4a4c996df67 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 11:10:32 -0300 Subject: [PATCH 05/23] using imported snippets instead of hardcoded (Creating a wallet from mnemonic phrases docs) --- apps/docs/src/guide/wallets/mnemonic-wallet.md | 12 +----------- packages/wallet-manager/src/wallet-manager.test.ts | 4 ++-- 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/apps/docs/src/guide/wallets/mnemonic-wallet.md b/apps/docs/src/guide/wallets/mnemonic-wallet.md index 33a9fb35f00..a2e558e64aa 100644 --- a/apps/docs/src/guide/wallets/mnemonic-wallet.md +++ b/apps/docs/src/guide/wallets/mnemonic-wallet.md @@ -8,14 +8,4 @@ The SDK gives you two wallets from mnemonic instantiation methods: one that take Here's how you can create wallets with both mnemonic phrases and derivation paths: -```ts:line-numbers -const walletManager = new WalletManager(); -const password = "0b540281-f87b-49ca-be37-2264c7f260f7"; - -await walletManager.unlock(password); - -// Add a vault of type mnemonic -await walletManager.addVault(config); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet-manager/src/wallet-manager.test.ts#L13-L22) +<<< @/../../../packages/wallet-manager/src/wallet-manager.test.ts#wallet-manager-mnemonic{ts:line-numbers} diff --git a/packages/wallet-manager/src/wallet-manager.test.ts b/packages/wallet-manager/src/wallet-manager.test.ts index 2c12aa72fc2..a515b642eb0 100644 --- a/packages/wallet-manager/src/wallet-manager.test.ts +++ b/packages/wallet-manager/src/wallet-manager.test.ts @@ -10,7 +10,7 @@ import WalletManagerSpec from './wallet-manager-spec'; describe('Wallet Manager', () => { const setupWallet = async (config: VaultConfig) => { - // #region typedoc:wallet-manager-mnemonic + // #region wallet-manager-mnemonic const walletManager = new WalletManager(); const password = '0b540281-f87b-49ca-be37-2264c7f260f7'; @@ -19,7 +19,7 @@ describe('Wallet Manager', () => { // Add a vault of type mnemonic await walletManager.addVault(config); - // #endregion + // #endregion wallet-manager-mnemonic return { walletManager, From 3b012a938b9fbea98d3032bb60740134096f0738 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 11:15:56 -0300 Subject: [PATCH 06/23] using imported snippets instead of hardcoded (private keys docs) --- apps/docs/src/guide/wallets/private-keys.md | 33 ++------------------- 1 file changed, 3 insertions(+), 30 deletions(-) diff --git a/apps/docs/src/guide/wallets/private-keys.md b/apps/docs/src/guide/wallets/private-keys.md index 97fae43e0ae..63fa788c87e 100644 --- a/apps/docs/src/guide/wallets/private-keys.md +++ b/apps/docs/src/guide/wallets/private-keys.md @@ -2,39 +2,12 @@ A new wallet with a randomly generated private key can be created by supplying `Wallet.generate`. -```ts:line-numbers -import { Wallet, WalletLocked, WalletUnlocked } from "fuels"; - -// use the `generate` helper to make an Unlocked Wallet -const myWallet: WalletUnlocked = Wallet.generate(); - -// or use an Address to create a wallet -const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L155-L163) - ---- +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallets{ts:line-numbers} Alternatively, you can create a wallet from a Private Key: -```ts:line-numbers -// unlock an existing wallet -let unlockedWallet: WalletUnlocked = lockedWallet.unlock(PRIVATE_KEY); -// or directly from a private key -unlockedWallet = Wallet.fromPrivateKey(PRIVATE_KEY); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L169-L174) - ---- +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-from-private-key{ts:line-numbers} You can obtain an address to a private key using the `Signer` package -```ts:line-numbers -const signer = new Signer(PRIVATE_KEY); -// validate address -expect(wallet.address).toEqual(signer.address); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L259-L263) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#signer-address{ts:line-numbers} From 3b55e61263be94b5a097b95e0f17e7a26508b1ed Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 11:21:42 -0300 Subject: [PATCH 07/23] using imported snippets instead of hardcoded (signing docs) --- apps/docs/src/guide/wallets/signing.md | 33 ++------------------ packages/fuel-gauge/src/doc-examples.test.ts | 4 +-- packages/wallet/src/wallet-unlocked.test.ts | 4 +-- 3 files changed, 6 insertions(+), 35 deletions(-) diff --git a/apps/docs/src/guide/wallets/signing.md b/apps/docs/src/guide/wallets/signing.md index 11b1d284ff4..e4c9cb595c6 100644 --- a/apps/docs/src/guide/wallets/signing.md +++ b/apps/docs/src/guide/wallets/signing.md @@ -2,37 +2,8 @@ Once you've instantiated your wallet in an unlocked state using one of the previously discussed methods, you can sign a message with `wallet.sign_message`. Below is a full example of how to sign and recover a message. -```ts:line-numbers -import { WalletUnlocked, hashMessage, Signer } from "fuels"; -const wallet = WalletUnlocked.generate(); -const message = "doc-test-message"; -const signedMessage = await wallet.signMessage(message); -const hashedMessage = hashMessage(message); -const recoveredAddress = Signer.recoverAddress(hashedMessage, signedMessage); - -expect(wallet.privateKey).toBeTruthy(); -expect(wallet.publicKey).toBeTruthy(); -expect(wallet.address).toEqual(recoveredAddress); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L197-L208) - ---- +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-message-signing{ts:line-numbers} You can also sign a _transaction_ by using `wallet.sign_transaction`. Below is a full example of how to sign and recover a transaction. -```ts:line-numbers -import { WalletUnlocked, hashMessage, Signer } from "fuels"; -const wallet = new WalletUnlocked(signTransactionTest.privateKey); -const transactionRequest = signTransactionTest.transaction; -const signedTransaction = await wallet.signTransaction(transactionRequest); -const verifiedAddress = Signer.recoverAddress( - hashTransaction(transactionRequest), - signedTransaction -); - -expect(signedTransaction).toEqual(signTransactionTest.signedTransaction); -expect(verifiedAddress).toEqual(wallet.address); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet-unlocked.test.ts#L38-L50) +<<< @/../../../packages/wallet/src/wallet-unlocked.test.ts#wallet-transaction-signing{ts:line-numbers} diff --git a/packages/fuel-gauge/src/doc-examples.test.ts b/packages/fuel-gauge/src/doc-examples.test.ts index cf942a3ae0e..f9a09b50d2f 100644 --- a/packages/fuel-gauge/src/doc-examples.test.ts +++ b/packages/fuel-gauge/src/doc-examples.test.ts @@ -194,7 +194,7 @@ test('it can work with wallets', async () => { }); it('it can work sign messages with wallets', async () => { - // #region typedoc:wallet-message-signing + // #region wallet-message-signing // #context import { WalletUnlocked, hashMessage, Signer} from 'fuels'; const wallet = WalletUnlocked.generate(); const message = 'doc-test-message'; @@ -205,7 +205,7 @@ it('it can work sign messages with wallets', async () => { expect(wallet.privateKey).toBeTruthy(); expect(wallet.publicKey).toBeTruthy(); expect(wallet.address).toEqual(recoveredAddress); - // #endregion + // #endregion wallet-message-signing }); it('can create wallets', async () => { diff --git a/packages/wallet/src/wallet-unlocked.test.ts b/packages/wallet/src/wallet-unlocked.test.ts index a81ff2b071e..63742b1f35e 100644 --- a/packages/wallet/src/wallet-unlocked.test.ts +++ b/packages/wallet/src/wallet-unlocked.test.ts @@ -48,7 +48,7 @@ describe('WalletUnlocked', () => { }); it('Sign a transaction using wallet instance', async () => { - // #region typedoc:wallet-transaction-signing + // #region wallet-transaction-signing // #context import { WalletUnlocked, hashMessage, Signer} from 'fuels'; const wallet = new WalletUnlocked(signTransactionTest.privateKey); const transactionRequest = signTransactionTest.transaction; @@ -60,7 +60,7 @@ describe('WalletUnlocked', () => { expect(signedTransaction).toEqual(signTransactionTest.signedTransaction); expect(verifiedAddress).toEqual(wallet.address); - // #endregion + // #endregion wallet-transaction-signing }); it('Populate transaction witnesses signature using wallet instance', async () => { From 5d51570db924da05070939df207151a7cd0eb55a Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 11:24:56 -0300 Subject: [PATCH 08/23] using imported snippets instead of hardcoded (test wallets docs) --- apps/docs/src/guide/wallets/test-wallets.md | 52 +------------------- packages/fuel-gauge/src/doc-examples.test.ts | 4 +- 2 files changed, 4 insertions(+), 52 deletions(-) diff --git a/apps/docs/src/guide/wallets/test-wallets.md b/apps/docs/src/guide/wallets/test-wallets.md index 7bc9dde15c8..e90712f45b4 100644 --- a/apps/docs/src/guide/wallets/test-wallets.md +++ b/apps/docs/src/guide/wallets/test-wallets.md @@ -4,58 +4,10 @@ You'll often want to create one or more test wallets when testing your contracts ## Create a single wallet -```ts:line-numbers -import { Wallet, WalletLocked, WalletUnlocked } from "fuels"; - -// use the `generate` helper to make an Unlocked Wallet -const myWallet: WalletUnlocked = Wallet.generate(); - -// or use an Address to create a wallet -const someWallet: WalletLocked = Wallet.fromAddress(myWallet.address); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L155-L163) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallets{ts:line-numbers} ## Setting up multiple test wallets If you need multiple test wallets, they can be set up as follows: -```ts:line-numbers -import { Provider, bn } from "fuels"; -import { generateTestWallet } from "@fuel-ts/wallet/test-utils"; -const provider = new Provider("http://127.0.0.1:4000/graphql"); -const assetIdA = - "0x0101010101010101010101010101010101010101010101010101010101010101"; -const assetIdB = - "0x0202020202020202020202020202020202020202020202020202020202020202"; - -// single asset -const walletA = await generateTestWallet(provider, [[42, NativeAssetId]]); - -// multiple assets -const walletB = await generateTestWallet(provider, [ - // [Amount, AssetId] - [100, assetIdA], - [200, assetIdB], - [30, NativeAssetId], -]); - -// this wallet has no assets -const walletC = await generateTestWallet(provider); - -// retrieve balances of wallets -const walletABalances = await walletA.getBalances(); -const walletBBalances = await walletB.getBalances(); -const walletCBalances = await walletC.getBalances(); - -// validate balances -expect(walletABalances).toEqual([{ assetId: NativeAssetId, amount: bn(42) }]); -expect(walletBBalances).toEqual([ - { assetId: NativeAssetId, amount: bn(30) }, - { assetId: assetIdA, amount: bn(100) }, - { assetId: assetIdB, amount: bn(200) }, -]); -expect(walletCBalances).toEqual([]); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/fuel-gauge/src/doc-examples.test.ts#L212-L246) +<<< @/../../../packages/fuel-gauge/src/doc-examples.test.ts#wallet-setup{ts:line-numbers} diff --git a/packages/fuel-gauge/src/doc-examples.test.ts b/packages/fuel-gauge/src/doc-examples.test.ts index f9a09b50d2f..1600b7effd2 100644 --- a/packages/fuel-gauge/src/doc-examples.test.ts +++ b/packages/fuel-gauge/src/doc-examples.test.ts @@ -209,7 +209,7 @@ it('it can work sign messages with wallets', async () => { }); it('can create wallets', async () => { - // #region typedoc:wallet-setup + // #region wallet-setup // #context import { Provider, bn } from 'fuels'; // #context import { generateTestWallet } from '@fuel-ts/wallet/test-utils'; const provider = new Provider('http://127.0.0.1:4000/graphql'); @@ -243,7 +243,7 @@ it('can create wallets', async () => { { assetId: assetIdB, amount: bn(200) }, ]); expect(walletCBalances).toEqual([]); - // #endregion + // #endregion wallet-setup }); it('can connect to testnet', async () => { From 645f6617fbbeacd49d081330714c1a65bd833dff Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 11:28:18 -0300 Subject: [PATCH 09/23] using imported snippets instead of hardcoded (transferring assets wallets docs) --- .../src/guide/wallets/transferring-assets.md | 20 +------------------ packages/wallet/src/transfer.test.ts | 4 ++-- 2 files changed, 3 insertions(+), 21 deletions(-) diff --git a/apps/docs/src/guide/wallets/transferring-assets.md b/apps/docs/src/guide/wallets/transferring-assets.md index 6d1a3b85e0f..620aec18cbc 100644 --- a/apps/docs/src/guide/wallets/transferring-assets.md +++ b/apps/docs/src/guide/wallets/transferring-assets.md @@ -2,22 +2,4 @@ With `wallet.transfer` you can initiate a transaction to transfer an asset from your wallet to a target address. -```rust:line-numbers - // setup a provider and two test wallets - const provider = new Provider('http://127.0.0.1:4000/graphql'); - const sender = await generateTestWallet(provider, [[100, NativeAssetId]]); - const receiver = await generateTestWallet(provider); - - // transfer 1 unit of the base asset - const response = await sender.transfer(receiver.address, 1, NativeAssetId); - await response.wait(); - - // retrieve balances of both wallets - const senderBalances = await sender.getBalances(); - const receiverBalances = await receiver.getBalances(); - // validate new balances - expect(senderBalances).toEqual([{ assetId: NativeAssetId, amount: bn(99) }]); - expect(receiverBalances).toEqual([{ assetId: NativeAssetId, amount: bn(1) }]); -``` - -###### [See code in context](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/transfer.test.ts#L13-L29) +<<< @/../../../packages/wallet/src/transfer.test.ts#wallet-transfer{ts:line-numbers} diff --git a/packages/wallet/src/transfer.test.ts b/packages/wallet/src/transfer.test.ts index 9dab85dbada..210d98a1fba 100644 --- a/packages/wallet/src/transfer.test.ts +++ b/packages/wallet/src/transfer.test.ts @@ -10,7 +10,7 @@ import { Wallet } from '.'; describe('Wallet', () => { it('can transfer a single type of coin to a single destination', async () => { - // #region typedoc:wallet-transfer + // #region wallet-transfer // setup a provider and two test wallets const provider = new Provider('http://127.0.0.1:4000/graphql'); const sender = await generateTestWallet(provider, [[100, NativeAssetId]]); @@ -26,7 +26,7 @@ describe('Wallet', () => { // validate new balances expect(senderBalances).toEqual([{ assetId: NativeAssetId, amount: bn(99) }]); expect(receiverBalances).toEqual([{ assetId: NativeAssetId, amount: bn(1) }]); - // #endregion + // #endregion wallet-transfer }); it('can transfer with custom TX Params', async () => { From f79b3fdab3cd35426e4f432c8110fd0a99ae422c Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 12:22:22 -0300 Subject: [PATCH 10/23] remove use of versions package on docs --- apps/docs/package.json | 3 -- apps/docs/src/versions.data.ts | 61 +++++++++++++--------------------- pnpm-lock.yaml | 3 -- 3 files changed, 23 insertions(+), 44 deletions(-) diff --git a/apps/docs/package.json b/apps/docs/package.json index 7ebdd1be481..113ce6a3f34 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -10,9 +10,6 @@ "keywords": [], "author": "", "license": "ISC", - "dependencies": { - "@fuel-ts/versions": "workspace:*" - }, "devDependencies": { "@types/markdown-it": "^12.2.3", "flexsearch": "^0.7.31", diff --git a/apps/docs/src/versions.data.ts b/apps/docs/src/versions.data.ts index 1eee2d15dac..ccd9461cb00 100644 --- a/apps/docs/src/versions.data.ts +++ b/apps/docs/src/versions.data.ts @@ -1,53 +1,38 @@ -import { versions } from '@fuel-ts/versions'; import fs from 'fs'; import path from 'path'; -type TVersions = { - FUELS: string; - FUEL_CORE: string; - FORC: string; -}; - -const normalizeVersions = (params: TVersions) => { - let { FORC, FUELS, FUEL_CORE } = params; - - const versionRegex = /0\.0\.0/; +const readVersionsFromFiles = () => { + const versions = { + FORC: '0.0.0', + FUELS: '0.0.0', + FUEL_CORE: '0.0.0', + }; try { - if (versionRegex.test(FORC)) { - const forcBinPath = path.join(__dirname, '../../../packages/forc-bin/package.json'); - const forcFile = fs.readFileSync(forcBinPath, 'utf8'); - const { config } = JSON.parse(forcFile); - ({ forcVersion: FORC } = config); - } - - if (versionRegex.test(FUELS)) { - const fuelsPath = path.join(__dirname, '../../../packages/fuels/package.json'); - const fuelsFile = fs.readFileSync(fuelsPath, 'utf8'); - ({ version: FUELS } = JSON.parse(fuelsFile)); - } - - if (versionRegex.test(FUEL_CORE)) { - const dockerfilePath = path.join(__dirname, '../../../services/fuel-core/Dockerfile'); - const dockerfile = fs.readFileSync(dockerfilePath, 'utf8'); - const regexFuelcore = /FROM ghcr\.io\/fuellabs\/fuel-core:v(\d+\.\d+\.\d+)/; - const match = dockerfile.match(regexFuelcore); - FUEL_CORE = match?.[1] || FUEL_CORE; - } + const forcBinPath = path.join(__dirname, '../../../packages/forc-bin/package.json'); + const forcFile = fs.readFileSync(forcBinPath, 'utf8'); + const { config } = JSON.parse(forcFile); + ({ forcVersion: versions.FORC } = config); + + const fuelsPath = path.join(__dirname, '../../../packages/fuels/package.json'); + const fuelsFile = fs.readFileSync(fuelsPath, 'utf8'); + ({ version: versions.FUELS } = JSON.parse(fuelsFile)); + + const dockerfilePath = path.join(__dirname, '../../../services/fuel-core/Dockerfile'); + const dockerfile = fs.readFileSync(dockerfilePath, 'utf8'); + const regexFuelcore = /FROM ghcr\.io\/fuellabs\/fuel-core:v(\d+\.\d+\.\d+)/; + const match = dockerfile.match(regexFuelcore); + versions.FUEL_CORE = match?.[1] || versions.FUEL_CORE; } catch { - return params; + return versions; } - return { - FORC, - FUELS, - FUEL_CORE, - }; + return versions; }; export default { load() { - const { FORC, FUELS, FUEL_CORE } = normalizeVersions(versions); + const { FORC, FUELS, FUEL_CORE } = readVersionsFromFiles(); return { forc: FORC, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 058b18a0d15..8af32f1141c 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -92,15 +92,12 @@ importers: apps/docs: specifiers: - '@fuel-ts/versions': workspace:* '@types/markdown-it': ^12.2.3 flexsearch: ^0.7.31 markdown-it: ^13.0.1 vitepress: 1.0.0-alpha.51 vitepress-plugin-search: 1.0.4-alpha.19 vue: ^3.2.47 - dependencies: - '@fuel-ts/versions': link:../../packages/versions devDependencies: '@types/markdown-it': 12.2.3 flexsearch: 0.7.31 From 4ade280df5488e494a0b7e4cdf326b6f3c73de80 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 12:22:50 -0300 Subject: [PATCH 11/23] rollback exports changes on versions package.json file --- packages/versions/package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/versions/package.json b/packages/versions/package.json index b793d2de21a..9f73e5e3623 100644 --- a/packages/versions/package.json +++ b/packages/versions/package.json @@ -10,8 +10,8 @@ "fuels-versions": "dist/bin.global.js" }, "exports": { - ".": "./dist/index.js", - "./cli": "./dist/cli.js" + ".": "./src/index.ts", + "./cli": "./src/cli.ts" }, "publishConfig": { "main": "dist/index.js", From 549a58b18970f2824018cea9f556bd61390a16c2 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 12:26:59 -0300 Subject: [PATCH 12/23] remove sway version from vitepress data in favor of forc --- apps/docs/src/guide/abi-typegen/index.md | 4 ++-- apps/docs/src/guide/contracts/deploying-contracts.md | 4 ++-- apps/docs/src/guide/index.md | 4 ++-- apps/docs/src/guide/predicates/index.md | 4 ++-- apps/docs/src/guide/scripts/index.md | 4 ++-- apps/docs/src/guide/scripts/instantiating-a-script.md | 4 ++-- apps/docs/src/guide/testing/index.md | 4 ++-- apps/docs/src/index.md | 6 +++--- apps/docs/src/versions.data.ts | 1 - 9 files changed, 17 insertions(+), 18 deletions(-) diff --git a/apps/docs/src/guide/abi-typegen/index.md b/apps/docs/src/guide/abi-typegen/index.md index ae46eafbac3..2736394f8c5 100644 --- a/apps/docs/src/guide/abi-typegen/index.md +++ b/apps/docs/src/guide/abi-typegen/index.md @@ -1,8 +1,8 @@ diff --git a/apps/docs/src/guide/contracts/deploying-contracts.md b/apps/docs/src/guide/contracts/deploying-contracts.md index 5cd44926b90..548c970490d 100644 --- a/apps/docs/src/guide/contracts/deploying-contracts.md +++ b/apps/docs/src/guide/contracts/deploying-contracts.md @@ -1,7 +1,7 @@ # Deploying contracts diff --git a/apps/docs/src/guide/index.md b/apps/docs/src/guide/index.md index c43db03c360..38b7290a1be 100644 --- a/apps/docs/src/guide/index.md +++ b/apps/docs/src/guide/index.md @@ -1,6 +1,6 @@ # The Fuel TypeScript SDK Guide @@ -15,7 +15,7 @@ TypeScript SDK for Fuel. It can be used for a variety of things, including but n This book is an overview of the different things one can achieve using the TypeScript SDK, and how to implement them. Keep in mind that both the SDK and the documentation are works-in-progress! -#### Version Notice: Docs generated using Fuels `v{{fuels}}`, Fuel Core `v{{fuelCore}}`, Sway `v{{sway}}`, and Forc `v{{forc}}`. +#### Version Notice: Docs generated using Fuels `v{{fuels}}`, Fuel Core `v{{fuelCore}}`, Sway `v{{forc}}`, and Forc `v{{forc}}`. [The Fuel TypeScript SDK](../index.md) diff --git a/apps/docs/src/guide/predicates/index.md b/apps/docs/src/guide/predicates/index.md index b8590205590..2bc1e128710 100644 --- a/apps/docs/src/guide/predicates/index.md +++ b/apps/docs/src/guide/predicates/index.md @@ -1,7 +1,7 @@ # Predicates diff --git a/apps/docs/src/guide/scripts/index.md b/apps/docs/src/guide/scripts/index.md index 7bdf97fe461..21d1fd5c3eb 100644 --- a/apps/docs/src/guide/scripts/index.md +++ b/apps/docs/src/guide/scripts/index.md @@ -1,8 +1,8 @@ diff --git a/apps/docs/src/guide/scripts/instantiating-a-script.md b/apps/docs/src/guide/scripts/instantiating-a-script.md index c116f48ce2e..952762707e6 100644 --- a/apps/docs/src/guide/scripts/instantiating-a-script.md +++ b/apps/docs/src/guide/scripts/instantiating-a-script.md @@ -1,8 +1,8 @@ diff --git a/apps/docs/src/guide/testing/index.md b/apps/docs/src/guide/testing/index.md index 5b50c5c2e65..74802d5966c 100644 --- a/apps/docs/src/guide/testing/index.md +++ b/apps/docs/src/guide/testing/index.md @@ -1,7 +1,7 @@ # Testing diff --git a/apps/docs/src/index.md b/apps/docs/src/index.md index 2f4e0356191..7696190f15f 100644 --- a/apps/docs/src/index.md +++ b/apps/docs/src/index.md @@ -1,13 +1,13 @@ ## Version -This doc was generated using Fuels `v{{fuels}}`, Fuel Core `v{{fuelCore}}`, Sway `v{{sway}}`, and Forc `v{{forc}}`. +This doc was generated using Fuels `v{{fuels}}`, Fuel Core `v{{fuelCore}}`, Sway `v{{forc}}`, and Forc `v{{forc}}`. ## Developer Quickstart Guide diff --git a/apps/docs/src/versions.data.ts b/apps/docs/src/versions.data.ts index ccd9461cb00..4dc1c51cc6c 100644 --- a/apps/docs/src/versions.data.ts +++ b/apps/docs/src/versions.data.ts @@ -36,7 +36,6 @@ export default { return { forc: FORC, - sway: FORC, fuels: FUELS, fuelCore: FUEL_CORE, }; From 5621d921708208beb1eea46d141f40ada2c46d9b Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 16 Mar 2023 19:24:23 -0300 Subject: [PATCH 13/23] completely remove typedoc --- package.json | 1 - packages/abi-coder/package.json | 3 - packages/abi-typegen/package.json | 3 - packages/address/package.json | 3 - packages/constants/package.json | 3 - packages/contract/package.json | 3 - packages/fuels/package.json | 3 - packages/hasher/package.json | 3 - packages/hdwallet/package.json | 3 - packages/interfaces/package.json | 3 - packages/keystore/package.json | 3 - packages/math/package.json | 3 - packages/merkle-shared/package.json | 3 - packages/merkle/package.json | 3 - packages/merklesum/package.json | 3 - packages/mnemonic/package.json | 3 - packages/predicate/package.json | 3 - packages/program/package.json | 3 - packages/providers/package.json | 3 - packages/script/package.json | 3 - packages/signer/package.json | 3 - packages/sparsemerkle/package.json | 3 - packages/transactions/package.json | 3 - packages/versions/package.json | 3 - packages/wallet-manager/package.json | 3 - packages/wallet/package.json | 3 - packages/wordlists/package.json | 3 - scripts/changeset-version-with-docs.ts | 32 --- .../typedoc-plugin-guide-builder/package.json | 19 -- .../src/code-sample-file.ts | 147 ----------- .../src/guide-builder-options.ts | 37 --- .../src/guide-builder.ts | 231 ------------------ .../typedoc-plugin-guide-builder/src/index.ts | 23 -- .../tsconfig.json | 36 --- typedoc.json | 48 ---- 35 files changed, 652 deletions(-) delete mode 100644 scripts/changeset-version-with-docs.ts delete mode 100644 scripts/typedoc-plugin-guide-builder/package.json delete mode 100644 scripts/typedoc-plugin-guide-builder/src/code-sample-file.ts delete mode 100644 scripts/typedoc-plugin-guide-builder/src/guide-builder-options.ts delete mode 100644 scripts/typedoc-plugin-guide-builder/src/guide-builder.ts delete mode 100644 scripts/typedoc-plugin-guide-builder/src/index.ts delete mode 100644 scripts/typedoc-plugin-guide-builder/tsconfig.json delete mode 100644 typedoc.json diff --git a/package.json b/package.json index 311f5a60d5c..ee043856f4b 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,6 @@ "forc:update": "ts-node ./scripts/forc-update", "forc:check": "./scripts/forc-check.sh", "forc:format": "./scripts/forc-format.sh", - "docs": "typedoc", "prepare": "husky install" }, "repository": { diff --git a/packages/abi-coder/package.json b/packages/abi-coder/package.json index a279be4542b..cd319b8d528 100644 --- a/packages/abi-coder/package.json +++ b/packages/abi-coder/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/abi-typegen/package.json b/packages/abi-typegen/package.json index 740e09897c3..fd4346a54c3 100644 --- a/packages/abi-typegen/package.json +++ b/packages/abi-typegen/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "Generates Typescript definitions from Sway ABI Json files", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "bin": { "fuels-typegen": "dist/bin.global.js" }, diff --git a/packages/address/package.json b/packages/address/package.json index 6c1957f3e31..6bcb05a41f4 100644 --- a/packages/address/package.json +++ b/packages/address/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "Utilities for encoding and decoding addresses", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/constants/package.json b/packages/constants/package.json index 5c51b4a4a8b..8ce1cbb664a 100644 --- a/packages/constants/package.json +++ b/packages/constants/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/contract/package.json b/packages/contract/package.json index 7ab4889df35..2f1a745a0cf 100644 --- a/packages/contract/package.json +++ b/packages/contract/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/fuels/package.json b/packages/fuels/package.json index dac5fdc9085..ce02c9b53e0 100644 --- a/packages/fuels/package.json +++ b/packages/fuels/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "Fuel TS SDK", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "bin": { "fuels": "dist/bin.global.js" }, diff --git a/packages/hasher/package.json b/packages/hasher/package.json index 4a43545e5b5..9aabaf80092 100644 --- a/packages/hasher/package.json +++ b/packages/hasher/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "Sha256 hash utility for Fuel", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/hdwallet/package.json b/packages/hdwallet/package.json index aa95bef6afa..01e8d5bea73 100644 --- a/packages/hdwallet/package.json +++ b/packages/hdwallet/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "The Hierarchal Desterministic (HD) Wallet", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/interfaces/package.json b/packages/interfaces/package.json index 975d6132c2d..951e473a4f6 100644 --- a/packages/interfaces/package.json +++ b/packages/interfaces/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/keystore/package.json b/packages/keystore/package.json index 72611469004..a015f847bd5 100644 --- a/packages/keystore/package.json +++ b/packages/keystore/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "Utilities for encrypting and decrypting data", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/math/package.json b/packages/math/package.json index 68b5ffc0ed8..b018fbf7181 100644 --- a/packages/math/package.json +++ b/packages/math/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/merkle-shared/package.json b/packages/merkle-shared/package.json index 5b7f51857fa..737ab4f0862 100644 --- a/packages/merkle-shared/package.json +++ b/packages/merkle-shared/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/merkle/package.json b/packages/merkle/package.json index af1a8fde179..ed6fc1cca44 100644 --- a/packages/merkle/package.json +++ b/packages/merkle/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/merklesum/package.json b/packages/merklesum/package.json index dbfd6e4b1fe..6d12dbc4a84 100644 --- a/packages/merklesum/package.json +++ b/packages/merklesum/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/mnemonic/package.json b/packages/mnemonic/package.json index 6c5ad2aa88e..83d141c2bcb 100644 --- a/packages/mnemonic/package.json +++ b/packages/mnemonic/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "Mnemonic implementation from BIP39", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/predicate/package.json b/packages/predicate/package.json index b6100e46066..5753e128b54 100644 --- a/packages/predicate/package.json +++ b/packages/predicate/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/program/package.json b/packages/program/package.json index fbc19e6a17b..4e53a16cfa4 100644 --- a/packages/program/package.json +++ b/packages/program/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/providers/package.json b/packages/providers/package.json index 774a28ebbde..a40688dac13 100644 --- a/packages/providers/package.json +++ b/packages/providers/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/script/package.json b/packages/script/package.json index 4920f44b97a..579fb865f6b 100644 --- a/packages/script/package.json +++ b/packages/script/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/signer/package.json b/packages/signer/package.json index 34c1d2d136b..4e315189ce2 100644 --- a/packages/signer/package.json +++ b/packages/signer/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "Secp256k1 signer for the Fuel Network", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/sparsemerkle/package.json b/packages/sparsemerkle/package.json index 8eff6e8abc6..d0c487e6b2e 100644 --- a/packages/sparsemerkle/package.json +++ b/packages/sparsemerkle/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/transactions/package.json b/packages/transactions/package.json index 5c8d9a4b8e4..e6c2329c0b0 100644 --- a/packages/transactions/package.json +++ b/packages/transactions/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/versions/package.json b/packages/versions/package.json index 9f73e5e3623..09f7802595e 100644 --- a/packages/versions/package.json +++ b/packages/versions/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "Validates supported versions of the Fuel toolchain", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "bin": { "fuels-versions": "dist/bin.global.js" }, diff --git a/packages/wallet-manager/package.json b/packages/wallet-manager/package.json index 19f15772f12..e0be1e35e80 100644 --- a/packages/wallet-manager/package.json +++ b/packages/wallet-manager/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/packages/wallet/package.json b/packages/wallet/package.json index 7363946da5f..65f7fd1ef9d 100644 --- a/packages/wallet/package.json +++ b/packages/wallet/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "./src/index.ts" - }, "exports": { ".": "./src/index.ts", "./test-utils": "./test/utils/index.ts" diff --git a/packages/wordlists/package.json b/packages/wordlists/package.json index faadfebb5ab..f8e5a682c38 100644 --- a/packages/wordlists/package.json +++ b/packages/wordlists/package.json @@ -3,9 +3,6 @@ "version": "0.35.0", "description": "", "author": "Fuel Labs (https://fuel.network/)", - "typedoc": { - "entryPoint": "src/index.ts" - }, "exports": { ".": "./src/index.ts" }, diff --git a/scripts/changeset-version-with-docs.ts b/scripts/changeset-version-with-docs.ts deleted file mode 100644 index 451432059d6..00000000000 --- a/scripts/changeset-version-with-docs.ts +++ /dev/null @@ -1,32 +0,0 @@ -#!/usr/bin/env node - -import sh from 'shelljs'; - -(async () => { - // Force exit on error - sh.set(`-e`); - - // Update doc version references - sh.exec( - `echo "# generated-file\nfuels: $BUILD_VERSION\nfuel-core: $FUEL_CORE_VERSION\nsway: $FORC_VERSION\nforc: $FORC_VERSION" > docs/_data/versions.yml` - ); - - // Update doc helper - sh.exec(`pnpm -C ./scripts/typedoc-plugin-guide-builder build`); - - // clean guide - sh.exec(`rm -rf docs/guide`); - - // Update docs - sh.exec(`pnpm typedoc`); - - // rollback exit on error - sh.set(`+e`); - - // commit doc changes - sh.exec(`git add docs/*`); - sh.exec(`git commit -m"ci(scripts): update docs"`); - - // run changeset version - sh.exec(`changeset version`); -})(); diff --git a/scripts/typedoc-plugin-guide-builder/package.json b/scripts/typedoc-plugin-guide-builder/package.json deleted file mode 100644 index cf32563d102..00000000000 --- a/scripts/typedoc-plugin-guide-builder/package.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "name": "typedoc-plugin-guide-builder", - "version": "0.0.1", - "scripts": { - "build": "tsc", - "watch": "tsc -w" - }, - "peerDependencies": { - "typedoc": "^0.23.19" - }, - "devDependencies": { - "@types/node": "^18.14.1" - }, - "main": "dist/index.js", - "types": "dist/index.d.ts", - "publishConfig": { - "registry": "https://registry.npmjs.org/" - } -} diff --git a/scripts/typedoc-plugin-guide-builder/src/code-sample-file.ts b/scripts/typedoc-plugin-guide-builder/src/code-sample-file.ts deleted file mode 100644 index 8f6d2e5e195..00000000000 --- a/scripts/typedoc-plugin-guide-builder/src/code-sample-file.ts +++ /dev/null @@ -1,147 +0,0 @@ -import assert = require('assert'); -import fs = require('fs'); - -export const DEFAULT_BLOCK_NAME = '__DEFAULT__'; -const REGION_REGEX = /^[\t ]*\/\/[\t ]*#((?:end)?region)(?:[\t ]+(.*?))?$/gm; - -export const getCoordinates = ( - content: string, - position: number -): { line: number; column: number } => { - const beforeContent = content.slice(0, position); - const lines = beforeContent.split('\n'); - return { line: lines.length, column: lines[lines.length - 1].length + 1 }; -}; - -export interface ICodeSample { - region: string; - file: string; - code: string; - startLine: number; - endLine: number; -} - -interface IRegionMarkerBase { - fullMatch: string; - line: number; - type: 'start' | 'end'; - name?: string; -} -interface IStartRegionMarker extends IRegionMarkerBase { - type: 'start'; - name: string; -} -interface IEndRegionMarker extends IRegionMarkerBase { - type: 'end'; -} -type RegionMarker = IStartRegionMarker | IEndRegionMarker; - -const parseRegionMarker = - (fileContent: string) => - (match: RegExpMatchArray): RegionMarker => { - assert(typeof match.index === 'number', new Error('Missing index')); - const type = match[1].toLocaleLowerCase() === 'region' ? 'start' : 'end'; - const name = match[2]; - assert(type !== 'start' || name, new Error('Missing name of start `#region`')); - const location = getCoordinates(fileContent, match.index); - return { ...location, type, name, fullMatch: match[0] }; - }; - -const assembleStartEndMarkers = ( - prevMarkers: Array<{ open?: IStartRegionMarker; close?: IEndRegionMarker; name: string }>, - marker: RegionMarker -) => { - if (marker.type === 'start') { - assert( - !prevMarkers.find((r) => r.name === marker.name), - new Error(`Region ${marker.name} already exists`) - ); - prevMarkers.push({ - open: marker, - name: marker.name, - }); - } else { - // End marker - // eslint-disable-next-line no-lonely-if - if (marker.name) { - const openRegion = prevMarkers.find((r) => r.name === marker.name); - assert(openRegion, new Error(`Missing region ${marker.name} explicitly closed`)); - assert(!openRegion.close, new Error(`Region ${marker.name} already closed`)); - openRegion.close = marker; - } else { - const lastNotClosed = prevMarkers - .concat() - .reverse() - .find((r) => !r.close); - assert(lastNotClosed, new Error('Missing implicitly closed region')); - assert(!lastNotClosed.close, new Error(`Region ${lastNotClosed.name} already closed`)); - lastNotClosed.close = marker; - } - } - return prevMarkers; -}; - -interface IRegion { - open: IStartRegionMarker; - close: IEndRegionMarker; - name: string; -} - -const addRegionInSet = - (file: string, contentLines: string[]) => - (regionsMap: Map, { open, close, name }: IRegion) => { - const code = contentLines - .slice(open.line, close.line) - .filter((l) => !l.match(REGION_REGEX)) - .join('\n'); - regionsMap.set(name, { - file, - region: name, - endLine: close.line, - startLine: open.line, - code, - }); - return regionsMap; - }; - -export const readCodeSample = (file: string): Map => { - const content = fs.readFileSync(file, 'utf-8'); - const lines = content.split('\n'); - const regionMarkers = [...content.matchAll(REGION_REGEX)]; - - if (regionMarkers.length === 0) { - return new Map([ - [ - DEFAULT_BLOCK_NAME, - { - file, - region: DEFAULT_BLOCK_NAME, - code: content, - endLine: lines.length, - startLine: 1, - }, - ], - ]); - } - - return ( - regionMarkers - .map(parseRegionMarker(content)) - .reduce(assembleStartEndMarkers, []) - // Check validity of regions - .map((r) => { - assert( - r.open && r.close, - new SyntaxError(`Region ${r.name} is not properly opened & closed`) - ); - assert( - r.open.line < r.close.line, - new SyntaxError( - `Region ${r.name} is closed before being opened. Opened at line ${r.open.line}, closed at line ${r.close.line}` - ) - ); - return r as IRegion; - }) - .reduce(addRegionInSet(file, lines), new Map()) - ); -}; diff --git a/scripts/typedoc-plugin-guide-builder/src/guide-builder-options.ts b/scripts/typedoc-plugin-guide-builder/src/guide-builder-options.ts deleted file mode 100644 index 6cc2530de26..00000000000 --- a/scripts/typedoc-plugin-guide-builder/src/guide-builder-options.ts +++ /dev/null @@ -1,37 +0,0 @@ -/** - * Options for the guide builder plugin. - */ -export interface GuideBuilderOptions { - /** - * Should the plugin process code blocks? - */ - isProcessingCodeBlocks: boolean; - /** - * Should the plugin throw an error if a code sample is not found - */ - shouldThrowOnNotFound: boolean; - /** - * Folder relative to the root of the project to copy guide markdown from - */ - guideSource: string; - /** - * Folder relative to the root of the docs `out` folder to copy guide markdown to - */ - guideOutput: string; - /** - * Codeblock source url - */ - codeBlockSourceUrl: string; -} - -/** Default option values. */ -export const defaultOptions: GuideBuilderOptions = { - isProcessingCodeBlocks: true, - shouldThrowOnNotFound: true, - guideSource: 'docs/_guide', - guideOutput: 'docs/guide', - codeBlockSourceUrl: 'https://github.com/FuelLabs/fuels-ts/blob/master', -}; - -/** Key of the options in the options file. */ -export const optionsKey: string = 'guideBuilder'; diff --git a/scripts/typedoc-plugin-guide-builder/src/guide-builder.ts b/scripts/typedoc-plugin-guide-builder/src/guide-builder.ts deleted file mode 100644 index c119409205c..00000000000 --- a/scripts/typedoc-plugin-guide-builder/src/guide-builder.ts +++ /dev/null @@ -1,231 +0,0 @@ -/* eslint-disable @typescript-eslint/no-non-null-assertion */ -/* eslint-disable no-console */ -import fs = require('fs'); -import fsPromises = require('node:fs/promises'); -import path = require('path'); -import type { Application } from 'typedoc'; -import { Renderer } from 'typedoc'; - -import type { ICodeSample } from './code-sample-file'; -import { readCodeSample } from './code-sample-file'; -import type { GuideBuilderOptions } from './guide-builder-options'; -import { defaultOptions, optionsKey } from './guide-builder-options'; - -const CODE_TAG = '@code:'; -const REGEX_CODE_LINK = /\[([^[]+)\](\(.*\))/gm; -const REGEX_NAV_ORDER = /(\[nav_order: \d+\])/g; -const FILE_CACHE = new Map>(); - -const toNiceName = (str: string) => - str - .toLowerCase() - .split(/[^a-z0-9]/i) - .map((word) => word.charAt(0).toUpperCase() + word.substring(1)) - .join(' '); - -const getCodeSample = (file: string, tag: string): ICodeSample | undefined => { - const resolvedFile = path.resolve(file); - if (!resolvedFile) { - throw new Error(`Could not resolve file ${file}`); - } - - if (!FILE_CACHE.has(resolvedFile)) { - FILE_CACHE.set(resolvedFile, readCodeSample(resolvedFile)); - } - - const allFileSamples = FILE_CACHE.get(resolvedFile)!; - return allFileSamples.get(tag); -}; - -const getSuggestedNavOrder = (text: string): [string, string] | undefined => { - const matchedNavOrder = text.match(REGEX_NAV_ORDER); - if (matchedNavOrder?.length && matchedNavOrder.length === 1) { - const orderMatch = matchedNavOrder[0].match(/(\d+)/g); - if (orderMatch) { - return [matchedNavOrder[0], orderMatch[0]]; - } - } - - return undefined; -}; - -/** - * Copies directory and processes markdown into the output folder - */ -export class GuideBuilder { - /** The current application. */ - private _typedoc?: Readonly; - /** Path for output. */ - private _outFolder?: string; - /** Path to output guide. */ - private _outGuideFolder?: string; - /** Path to source medias. */ - private _sourceGuideFolder?: string; - - private _options: GuideBuilderOptions = defaultOptions; - - /** - * Create a new RelativeIncludesConverterComponent instance. - * - * @param typedoc - The application. - */ - public initialize(typedoc: Readonly): void { - this._typedoc = typedoc; - - typedoc.renderer.on(Renderer.EVENT_END, async () => { - this._outFolder = this._typedoc?.options.getValue('out'); - this._options = - this._typedoc?.options.getValue(optionsKey) ?? defaultOptions; - - if (!this._outFolder) return; - this._sourceGuideFolder = path.resolve(this._options.guideSource); - this._outGuideFolder = path.resolve(this._options.guideOutput); - if (!fs.existsSync(this._outGuideFolder)) { - fs.mkdirSync(this._outGuideFolder, { recursive: true }); - } - - try { - const files: string[] = []; - // copy all files - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore: Unknown function exists - await fsPromises.cp(this._sourceGuideFolder, this._outGuideFolder, { - recursive: true, - force: true, - filter: this._options.isProcessingCodeBlocks - ? (fileName) => { - const newFilePath = fileName.replace(this._sourceGuideFolder, ''); - - if (newFilePath && newFilePath.endsWith('.md')) { - files.push(newFilePath); - } - - return true; - } - : undefined, - }); - if (this._options.isProcessingCodeBlocks) { - // eslint-disable-next-line no-plusplus - for (let i = 0; i < files.length; i++) { - const file = files[i]; - const filePath = path.join(this._outGuideFolder!, file); - const { text, navOrder } = this.replaceCodeBlock( - await fsPromises.readFile(filePath, { encoding: 'utf8' }) - ); - const namespace = file.replace('/', '').split('/'); - const guideName = toNiceName(namespace[namespace.length - 1].split('.')[0]); - const parentName = toNiceName(namespace[0]); - let header: string; - const isIndex = guideName === 'Index'; - - if (namespace.length === 1) { - // top level file - header = [ - `---`, - `title: "${isIndex ? 'Guide' : guideName}"`, - `has_children: ${isIndex}`, - `has_toc: ${isIndex}`, - `nav_order: ${isIndex ? -4 : navOrder || -3}`, - `---`, - ].join('\n'); - } else if (isIndex) { - // folder index - header = [ - `---`, - `title: "${parentName}"`, - `parent: "Guide"`, - `has_children: true`, - `has_toc: false`, - `nav_order: ${navOrder || -2}`, - `---`, - ].join('\n'); - } else { - // folder file - const rows = [ - `---`, - `title: "${guideName}"`, - `parent: "${parentName}"`, - `grand_parent: "Guide"`, - ]; - if (navOrder) { - rows.push(`nav_order: ${navOrder}`); - } - rows.push(`---`); - header = rows.join('\n'); - } - - const finalText = `${header}\n\n[info]: this file is autogenerated\n${text}`; - await fsPromises.writeFile(filePath, finalText, { encoding: 'utf8' }); - } - } - } catch (error) { - console.warn('failed to copy files:', error); - throw new Error('Failed to generate Guide'); - } - - console.log(`Documentation generated at ${this._options.guideOutput}`); - }); - } - - prettyPrint(sample: ICodeSample | undefined, match: string, language: string): string { - if (!sample) { - if (this._options.shouldThrowOnNotFound) { - throw new Error(`Could not find sample code for ${match}`); - } - - return match; - } - - const sourceLink = `[see code in context](${ - this._options.codeBlockSourceUrl + sample.file.replace(process.cwd(), '') - }#L${sample.startLine}-L${sample.endLine})`; - - return ` -\`\`\`${language} -${sample.code.replaceAll('// #context ', '')} -\`\`\` -###### ${sourceLink} - ---- -`; - } - - replaceCodeBlock(text: string): { text: string; navOrder?: string } { - const navOrderMatch = getSuggestedNavOrder(text); - let updated = text; - let navOrder; - if (navOrderMatch?.length) { - updated = updated.replace(navOrderMatch[0], ''); - navOrder = navOrderMatch[1]; - } - - if (!text.includes(CODE_TAG)) { - return { text: updated, navOrder }; - } - - const matches = text.match(REGEX_CODE_LINK); - if (!matches || !matches.length) { - return { text: updated, navOrder }; - } - - const singleMatch = /\[([^[]+)\]\((.*)\)/; - // eslint-disable-next-line no-plusplus - for (let i = 0; i < matches.length; i++) { - const link = singleMatch.exec(matches[i]) || ''; - const [matched, code, source] = link; - if (!code.includes(CODE_TAG)) { - // eslint-disable-next-line no-continue - continue; - } - - const language = code.split(':').pop() || ''; - const [filePath, tag] = source.split('#'); - updated = updated.replace( - matched, - this.prettyPrint(getCodeSample(filePath, tag), matched, language) - ); - } - - return { text: updated, navOrder }; - } -} diff --git a/scripts/typedoc-plugin-guide-builder/src/index.ts b/scripts/typedoc-plugin-guide-builder/src/index.ts deleted file mode 100644 index 21a9efd74ee..00000000000 --- a/scripts/typedoc-plugin-guide-builder/src/index.ts +++ /dev/null @@ -1,23 +0,0 @@ -import type { Application } from 'typedoc'; -import { ParameterType } from 'typedoc'; - -import { GuideBuilder } from './guide-builder'; -import { defaultOptions, optionsKey } from './guide-builder-options'; - -/** - * Load the plugin. - * - * @param pluginHost - Plugin host to load to. - */ -export function load(pluginHost: Application): void { - const app = pluginHost.owner; - - pluginHost.options.addDeclaration({ - name: optionsKey, - help: 'Guide builder plugin options.', - type: ParameterType.Object, - defaultValue: defaultOptions, - }); - - new GuideBuilder().initialize(app); -} diff --git a/scripts/typedoc-plugin-guide-builder/tsconfig.json b/scripts/typedoc-plugin-guide-builder/tsconfig.json deleted file mode 100644 index d7405d4b65a..00000000000 --- a/scripts/typedoc-plugin-guide-builder/tsconfig.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "$schema": "https://json.schemastore.org/tsconfig", - "compileOnSave": false, - "compilerOptions": { - "allowSyntheticDefaultImports": true, - "alwaysStrict": true, - "declaration": true, - "downlevelIteration": true, - "emitDecoratorMetadata": true, - "experimentalDecorators": true, - "forceConsistentCasingInFileNames": true, - "importHelpers": true, - "noFallthroughCasesInSwitch": true, - "noImplicitAny": false, - "noImplicitOverride": true, - "noImplicitReturns": true, - "noImplicitThis": true, - "noPropertyAccessFromIndexSignature": false, - "removeComments": false, - "sourceMap": true, - "strict": true, - "strictFunctionTypes": false, - "strictNullChecks": true, - "strictPropertyInitialization": true, - "stripInternal": true, - - "lib": ["ES2021"], - "module": "CommonJS", - "target": "ES2020", - - "baseUrl": "./", - "outDir": "./dist", - "types": ["node"] - }, - "include": ["src/**/*"] -} diff --git a/typedoc.json b/typedoc.json deleted file mode 100644 index 905997ecee5..00000000000 --- a/typedoc.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "$schema": "https://typedoc.org/schema.json", - "theme": "just-the-docs", - "out": "docs/packages", - "entryPoints": [ - "packages/abi-coder", - "packages/address", - "packages/constants", - "packages/contract", - "packages/hasher", - "packages/hdwallet", - "packages/interfaces", - "packages/keystore", - "packages/math", - "packages/merkle", - "packages/merkle-shared", - "packages/merklesum", - "packages/mnemonic", - "packages/predicate", - "packages/program", - "packages/providers", - "packages/signer", - "packages/sparsemerkle", - "packages/testcases", - "packages/transactions", - "packages/wallet", - "packages/wallet-manager", - "packages/wordlists", - "packages/account" - ], - "entryPointStrategy": "packages", - "githubPages": false, - "hideInPageTOC": true, - "readme": "none", - "excludeExternals": true, - "excludeInternal": false, - "hideBreadcrumbs": true, - "categorizeByGroup": true, - "filenameSeparator": "-", - "entryDocument": "README.md", - "gitRevision": "master", - "plugin": [ - "typedoc-monorepo-link-types", - "typedoc-plugin-markdown", - "typedoc-just-the-docs-theme", - "./scripts/typedoc-plugin-guide-builder" - ] -} From e2b5b9c36555df2108b08094d1c6991405df0812 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Tue, 21 Mar 2023 09:25:46 -0300 Subject: [PATCH 14/23] update ABI Typegen docs section to reflect master --- apps/docs/.vitepress/config.ts | 2 +- .../generate-contract-types-from-abi.md | 20 ----- .../abi-typegen/generating-types-from-abi.md | 67 +++++++++++++++ apps/docs/src/guide/abi-typegen/index.md | 21 +++-- .../abi-typegen/using-generated-types.md | 82 ++++++++++++++++++- 5 files changed, 162 insertions(+), 30 deletions(-) delete mode 100644 apps/docs/src/guide/abi-typegen/generate-contract-types-from-abi.md create mode 100644 apps/docs/src/guide/abi-typegen/generating-types-from-abi.md diff --git a/apps/docs/.vitepress/config.ts b/apps/docs/.vitepress/config.ts index 2f47b5926f5..2a3d5ac0c91 100644 --- a/apps/docs/.vitepress/config.ts +++ b/apps/docs/.vitepress/config.ts @@ -112,7 +112,7 @@ export default defineConfig({ items: [ { text: 'Generate Contract Types', - link: '/guide/abi-typegen/generate-contract-types-from-abi', + link: '/guide/abi-typegen/generating-types-from-abi', }, { text: 'Using Generated Types', diff --git a/apps/docs/src/guide/abi-typegen/generate-contract-types-from-abi.md b/apps/docs/src/guide/abi-typegen/generate-contract-types-from-abi.md deleted file mode 100644 index efebe4e48b0..00000000000 --- a/apps/docs/src/guide/abi-typegen/generate-contract-types-from-abi.md +++ /dev/null @@ -1,20 +0,0 @@ -# Generate Contract Types from ABI - -See also [types](../types/). - -#### Dependencies - -```sh -yarn add fuels -``` - -#### Generate Types - -```sh -yarn exec fuels -i ./abis/*-abi.json -o ./types -``` - -Note: - -- `-i`: the relative path/global to the ABI JSON file(s) -- `-o`: the output directory for the generated types diff --git a/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md b/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md new file mode 100644 index 00000000000..05305a8a897 --- /dev/null +++ b/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md @@ -0,0 +1,67 @@ +# Generating Types from ABI + +## Installation + +First we install `fuels` to our project: + +```sh +yarn add fuels +``` + +## Help + +A first glance at the docs: + +```console +$ yarn exec fuels typegen -h + +Usage: fuels typegen [options] + +generate typescript from contract abi json files + +Options: + -i, --inputs directory path for generated files + -c, --contract generate code for contracts [default] + -s, --script generate code for scripts + --silent omit output messages + -h, --help display help for command +``` + +## Generating Types for Contracts + +We can omit the `--contract` option here; its the default: + +```console +yarn exec fuels typegen -i ./abis/*-abi.json -o ./types +``` + +**Notes** + +- `-i`: the relative path/global to the ABI JSON file(s) +- `-o`: the output directory for the generated types +- `-c, --contract`: tells we want to generate types for contracts _(default, can be omitted)_ + +## Generating Types for Scripts + +Note how we make use of the option `--script` in this case: + +```console +yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script +``` + +## Generating Types for Predicates + +Note how we make use of the option `--predicate` in this case: + +```console +yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --predicate +``` + +--- + +See also: + +- [Using Generated Contract Types](./using-generated-types.md#using-generated-contract-types) +- [Using Generated Script Types](./using-generated-types.md#using-generated-script-types) +- [Using Generated Predicate Types](./using-generated-types.md#using-generated-predicate-types) diff --git a/apps/docs/src/guide/abi-typegen/index.md b/apps/docs/src/guide/abi-typegen/index.md index 2736394f8c5..db15c6339e1 100644 --- a/apps/docs/src/guide/abi-typegen/index.md +++ b/apps/docs/src/guide/abi-typegen/index.md @@ -1,18 +1,26 @@ # ABI Typegen ## The JSON ABI file -Whether you want to deploy or connect to a pre-existing smart contract, the JSON ABI file is extremely important: it's what tells the SDK about the ABI methods in your smart contracts. +Whether you want to deploy or connect to a pre-existing smart contract, the JSON ABI file is what makes it possible. -For the same example Sway code as above: +It tells the SDK about the ABI methods in your Smart Contracts and Scripts + +Given the following Sway smart contract: ```rust:line-numbers contract; @@ -28,7 +36,7 @@ impl MyContract for Contract { } ``` -The JSON ABI file looks like this: +The JSON ABI file would look something like this: ```json $ cat out/debug/my-test-abi.json @@ -48,4 +56,7 @@ $ cat out/debug/my-test-abi.json ] ``` -The Fuel TypeScript SDK will take this file as input and generate equivalent methods (and custom types if applicable) that you can call from your TypeScript code. +See also: + +- [Generating Types](./generating-types-from-abi.md) +- [Using Generated Types](./using-generated-types.md) diff --git a/apps/docs/src/guide/abi-typegen/using-generated-types.md b/apps/docs/src/guide/abi-typegen/using-generated-types.md index b97da203115..61bd98caa4e 100644 --- a/apps/docs/src/guide/abi-typegen/using-generated-types.md +++ b/apps/docs/src/guide/abi-typegen/using-generated-types.md @@ -1,16 +1,90 @@ + + # Using Generated Types -See also [Generate Contract Types from ABI](./generate-contract-types-from-abi.md). +After generating types via: + +```console +yarn exec fuels typegen -i ./abis/*-abi.json -o ./types +``` + +We can use these files like so: -```ts:line-numbers +```ts import { Wallet } from "fuels"; import { MyContract__factory } from "./types"; const contractId = "0x..."; -const wallet = new Wallet("0x..."); +const wallet = Wallet.fromAddress("..."); const contract = MyContract__factory.connect(contractId, wallet); // All contract methods are available under functions with the correct types -const { transactionId, value } = await contract.functions.my_fn(1n).call(); +const { transactionId, value } = await contract.functions.my_fn(1).call(); + console.log(transactionId, value); ``` + +## Using Generated Script Types + +After generating types via: + +```console +yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script +``` + +We can use these files like so: + +```ts +import { Wallet } from "fuels"; +import { MyScript__factory } from "./types"; + +const wallet = Wallet.fromAddress("..."); +const script = ScriptAbi__factory.createInstance(wallet); + +const { value, logs } = await script.functions.main(1).call(); + +console.log({ value, logs }); +``` + +## Using Generated Predicate Types + +Consider the following predicate: + +<<< @/../../../packages/fuel-gauge/test-projects/predicate-main-args-struct/src/main.sw#Predicate-main-args{ts:line-numbers} + +Now, after generating types via: + +```console +yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --predicate +``` + +We can use these files like so: + +```ts +import { Wallet } from "fuels"; +import { MyPredicate__factory } from "./types"; + +const wallet = Wallet.fromAddress("..."); +const predicate = MyPredicate__factory.createInstance(); + +await predicate + .setData({ + has_account: true, + total_complete: 100, + }) + .transfer(wallet.address, ); + +const walletBalance = await wallet.getBalance(); +const predicateBalance = await predicate.getBalance(); + +console.log({ + walletBalance, + predicateBalance, +}); +``` + +See also: + +- [Generating Types for Contracts](./generating-types-from-abi.md#generating-types-for-contracts) +- [Generating Types for Scripts](./generating-types-from-abi.md#generating-types-for-scripts) +- [Generating Types for Predicates](./generating-types-from-abi.md#generating-types-for-predicates) From 65534e758693694671a742145cb9e3e016bab892 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Tue, 21 Mar 2023 09:25:55 -0300 Subject: [PATCH 15/23] update link --- apps/docs/src/guide/contracts/deploying-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/docs/src/guide/contracts/deploying-contracts.md b/apps/docs/src/guide/contracts/deploying-contracts.md index 548c970490d..6231d0adb7f 100644 --- a/apps/docs/src/guide/contracts/deploying-contracts.md +++ b/apps/docs/src/guide/contracts/deploying-contracts.md @@ -26,4 +26,4 @@ You can then use the contract methods very simply: const contact = await factory.deployContract(); ``` -Also read about how to [generate-contract-types-from-abi](../abi-typegen/generate-contract-types-from-abi.md), allowing for rich TypeScript backed Fuel usage. +Also read about how to [generating-types-from-abi](../abi-typegen/generating-types-from-abi.md), allowing for rich TypeScript backed Fuel usage. From 1a0c0f11855972b0fd2e297d92c66e7e2869114a Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Tue, 21 Mar 2023 09:42:14 -0300 Subject: [PATCH 16/23] add turbo.json file to docs workspace --- apps/docs/turbo.json | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 apps/docs/turbo.json diff --git a/apps/docs/turbo.json b/apps/docs/turbo.json new file mode 100644 index 00000000000..805f7ce0e07 --- /dev/null +++ b/apps/docs/turbo.json @@ -0,0 +1,10 @@ +{ + "extends": ["//"], + "pipeline": { + "build": { + "dependsOn": ["^build", "prebuild"], + "outputs": ["dist/**"], + "inputs": ["src/**", ".vitepress/**", "types/**"] + } + } +} From 62066a48f0bccecefd4c6d4c5a7722971440ce0d Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Fri, 24 Mar 2023 11:44:13 -0300 Subject: [PATCH 17/23] fix some hardcoded snippets --- apps/docs/src/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/apps/docs/src/index.md b/apps/docs/src/index.md index 7696190f15f..aa9acea4ea0 100644 --- a/apps/docs/src/index.md +++ b/apps/docs/src/index.md @@ -51,7 +51,7 @@ import { Wallet } from "fuels"; console.log(Wallet.generate()); // Using privateKey Wallet -console.log(new Wallet("0x0000...0000")); +console.log(Wallet.fromPrivateKey(PRIVATE_KEY)); ``` ## Calling Contracts @@ -60,7 +60,7 @@ console.log(new Wallet("0x0000...0000")); import { Wallet, Contract, BigNumberish, BN } from "fuels"; import abi from "./abi.json"; -const wallet = new Wallet("0x..."); // private key with coins +const wallet = Wallet.fromPrivateKey(PRIVATE_KEY); // private key with coins const contractId = "0x..."; const contract = new Contract(contractId, abi, wallet); @@ -77,12 +77,12 @@ console.log(transactionId, value); ## Deploying Contracts ```ts:line-numbers -import { Provider, Contract } from "fuels"; +import { Provider, ContractFactory } from "fuels"; // Byte code generated using: forc build import bytecode from "./bytecode.bin"; const factory = new ContractFactory(bytecode, [], wallet); -const contract = await factory.deployContract(factory); +const contract = await factory.deployContract(); console.log(contract.id); ``` From f06d31f5dbfe7a314117abb7b46b26cc27b29326 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Fri, 24 Mar 2023 14:11:35 -0300 Subject: [PATCH 18/23] adding some TODOs --- .../docs/src/guide/abi-typegen/generating-types-from-abi.md | 2 +- apps/docs/src/guide/abi-typegen/index.md | 2 ++ apps/docs/src/guide/abi-typegen/using-generated-types.md | 6 ++++++ .../src/guide/contracts/calls-with-different-wallets.md | 4 ++++ apps/docs/src/guide/contracts/cost-estimation.md | 2 ++ apps/docs/src/guide/contracts/deploying-contracts.md | 2 ++ apps/docs/src/guide/contracts/interacting-with-contracts.md | 2 ++ apps/docs/src/guide/contracts/the-fuelvm-binary-file.md | 2 ++ apps/docs/src/guide/contracts/variable-outputs.md | 2 ++ apps/docs/src/guide/types/arrays.md | 2 ++ apps/docs/src/guide/types/enums-and-options.md | 2 ++ apps/docs/src/guide/types/string.md | 2 ++ apps/docs/src/guide/types/structs.md | 2 ++ apps/docs/src/guide/types/vectors.md | 2 ++ .../src/guide/wallets/encrypting-and-storing-wallets.md | 2 ++ apps/docs/src/index.md | 6 ++++++ 16 files changed, 41 insertions(+), 1 deletion(-) diff --git a/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md b/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md index 05305a8a897..4c54b9c2f2c 100644 --- a/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md +++ b/apps/docs/src/guide/abi-typegen/generating-types-from-abi.md @@ -4,7 +4,7 @@ First we install `fuels` to our project: -```sh +```console yarn add fuels ``` diff --git a/apps/docs/src/guide/abi-typegen/index.md b/apps/docs/src/guide/abi-typegen/index.md index db15c6339e1..014bf03e8d9 100644 --- a/apps/docs/src/guide/abi-typegen/index.md +++ b/apps/docs/src/guide/abi-typegen/index.md @@ -22,6 +22,8 @@ It tells the SDK about the AB Given the following Sway smart contract: + + ```rust:line-numbers contract; diff --git a/apps/docs/src/guide/abi-typegen/using-generated-types.md b/apps/docs/src/guide/abi-typegen/using-generated-types.md index 61bd98caa4e..a45fe01fff6 100644 --- a/apps/docs/src/guide/abi-typegen/using-generated-types.md +++ b/apps/docs/src/guide/abi-typegen/using-generated-types.md @@ -10,6 +10,8 @@ yarn exec fuels typegen -i ./abis/*-abi.json -o ./types We can use these files like so: + + ```ts import { Wallet } from "fuels"; import { MyContract__factory } from "./types"; @@ -34,6 +36,8 @@ yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --script We can use these files like so: + + ```ts import { Wallet } from "fuels"; import { MyScript__factory } from "./types"; @@ -60,6 +64,8 @@ yarn exec fuels typegen -i ./abis/*-abi.json -o ./types --predicate We can use these files like so: + + ```ts import { Wallet } from "fuels"; import { MyPredicate__factory } from "./types"; diff --git a/apps/docs/src/guide/contracts/calls-with-different-wallets.md b/apps/docs/src/guide/contracts/calls-with-different-wallets.md index fa402c33708..b79bc8421e9 100644 --- a/apps/docs/src/guide/contracts/calls-with-different-wallets.md +++ b/apps/docs/src/guide/contracts/calls-with-different-wallets.md @@ -2,12 +2,16 @@ You can assign to a Contract's `wallet` property on an existing contract instance as a shorthand for creating a new instance connected to the provided wallet. This lets you make contracts calls with different wallets in a chain like fashion. + + ```ts:line-numbers contract.wallet = Wallet.fromAddress(someAddress); ``` In a similar fashion, assigning a custom Provider allows you to utilize a Provider wrapper of your choosing or design. + + ```ts:line-numbers contract.provider = customProvider; ``` diff --git a/apps/docs/src/guide/contracts/cost-estimation.md b/apps/docs/src/guide/contracts/cost-estimation.md index f9335c03526..8727fccafe8 100644 --- a/apps/docs/src/guide/contracts/cost-estimation.md +++ b/apps/docs/src/guide/contracts/cost-estimation.md @@ -2,6 +2,8 @@ With the function `getTransactionCost` provided by the `provider`, you can get a cost estimation for a specific call. The return type, `TransactionCost`, is an object that contains relevant information for the estimation: + + ```ts:line-numbers type TransactionCost = { minGasPrice: BN; diff --git a/apps/docs/src/guide/contracts/deploying-contracts.md b/apps/docs/src/guide/contracts/deploying-contracts.md index 6231d0adb7f..6fe15260311 100644 --- a/apps/docs/src/guide/contracts/deploying-contracts.md +++ b/apps/docs/src/guide/contracts/deploying-contracts.md @@ -22,6 +22,8 @@ If you are only interested in a single instance of your contract, then use `depl You can then use the contract methods very simply: + + ```ts:line-numbers const contact = await factory.deployContract(); ``` diff --git a/apps/docs/src/guide/contracts/interacting-with-contracts.md b/apps/docs/src/guide/contracts/interacting-with-contracts.md index b8b2778024c..a6d84fc7fe2 100644 --- a/apps/docs/src/guide/contracts/interacting-with-contracts.md +++ b/apps/docs/src/guide/contracts/interacting-with-contracts.md @@ -6,6 +6,8 @@ If you already have a deployed contract and want to call its methods using the S The above example assumes that your contract id string is encoded in the bech32m format. You can recognize it by the human-readable-part "fuel" followed by the separator "1". However, when using other Fuel tools, you might end up with a hex-encoded contract id string. A [Contract ID](../types/contract-id.md) can easily be converted to and from other Address formats, see the [conversion guide](../types/conversion.md) for more information. + + ```ts:line-numbers const contract: Contract = new Contract(new Address(ADDRESS_BECH32), abiJSON); diff --git a/apps/docs/src/guide/contracts/the-fuelvm-binary-file.md b/apps/docs/src/guide/contracts/the-fuelvm-binary-file.md index 1050dad7aad..6dbc97a6607 100644 --- a/apps/docs/src/guide/contracts/the-fuelvm-binary-file.md +++ b/apps/docs/src/guide/contracts/the-fuelvm-binary-file.md @@ -2,6 +2,8 @@ The command `forc build` compiles your Sway code and generates the bytecode: the binary code that the Fuel Virtual Machine will interpret. For instance, the smart contract below: + + ```rust:line-numbers contract; diff --git a/apps/docs/src/guide/contracts/variable-outputs.md b/apps/docs/src/guide/contracts/variable-outputs.md index 53894aac517..a0909195112 100644 --- a/apps/docs/src/guide/contracts/variable-outputs.md +++ b/apps/docs/src/guide/contracts/variable-outputs.md @@ -2,6 +2,8 @@ In some cases, you might want to send funds to the output of a transaction. Sway has a specific method for that: `transfer_to_address(coins, asset_id, recipient)`. So, if you have a contract that does something like this: + + ```rust:line-numbers fn transfer_coins_to_output(coins: u64, asset_id: ContractId, recipient: Address) { transfer_to_address(coins, asset_id, recipient); diff --git a/apps/docs/src/guide/types/arrays.md b/apps/docs/src/guide/types/arrays.md index 01bf3bba8f8..4f6b4cd018c 100644 --- a/apps/docs/src/guide/types/arrays.md +++ b/apps/docs/src/guide/types/arrays.md @@ -6,6 +6,8 @@ You can pass a JavaScript `Array` into your contract method transparently, allow An Array is just a Typed Array: + + ```ts:line-numbers // aka [u8; 2] let basicNumberArray = [1, 23]; diff --git a/apps/docs/src/guide/types/enums-and-options.md b/apps/docs/src/guide/types/enums-and-options.md index e05cfbdc5f7..6bea0db78c9 100644 --- a/apps/docs/src/guide/types/enums-and-options.md +++ b/apps/docs/src/guide/types/enums-and-options.md @@ -22,6 +22,8 @@ The `Option` is a special wrapper type of `Enum`. This example shows that an input param with type `OptionalStringInput` can either be a `string` value or `undefined` + + ```ts:line-numbers type OptionalStringInput = Option; diff --git a/apps/docs/src/guide/types/string.md b/apps/docs/src/guide/types/string.md index 02c4f08fc6c..c62b3b5d334 100644 --- a/apps/docs/src/guide/types/string.md +++ b/apps/docs/src/guide/types/string.md @@ -4,6 +4,8 @@ Currently, all strings in Fuel and Sway are statically-sized, i.e., you must kno Here's how you can create a simple string using `TypeScript`: + + ```ts:line-numbers // aka str[2] let stringSize2 = "st"; diff --git a/apps/docs/src/guide/types/structs.md b/apps/docs/src/guide/types/structs.md index db6c8d1d375..290339393eb 100644 --- a/apps/docs/src/guide/types/structs.md +++ b/apps/docs/src/guide/types/structs.md @@ -8,6 +8,8 @@ Here is an example of the `struct` in Sway: And the same structure represented in TypeScript: + + ```ts:line-numbers type ComplexStruct { foo: u8, diff --git a/apps/docs/src/guide/types/vectors.md b/apps/docs/src/guide/types/vectors.md index 1a6ac564971..28d97f689bc 100644 --- a/apps/docs/src/guide/types/vectors.md +++ b/apps/docs/src/guide/types/vectors.md @@ -6,6 +6,8 @@ You can pass a JavaScript `Array` into your contract method transparently, allow A basic Vector is just a Typed Array: + + ```ts:line-numbers // aka Vec let basicNumberVector = [1, 2, 3]; diff --git a/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md b/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md index 3b570037f8a..ce89aec07c0 100644 --- a/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md +++ b/apps/docs/src/guide/wallets/encrypting-and-storing-wallets.md @@ -12,6 +12,8 @@ You can create a random wallet and, at the same time, encrypt and store it. Then If you have already created a wallet Manager using a mnemonic phrase or a private key, you can also encrypt it and save it to disk: + + ```ts:line-numbers await walletManager.lock(); ``` diff --git a/apps/docs/src/index.md b/apps/docs/src/index.md index aa9acea4ea0..7be19d15e9f 100644 --- a/apps/docs/src/index.md +++ b/apps/docs/src/index.md @@ -44,6 +44,8 @@ npm install fuels --save ## Import + + ```ts:line-numbers import { Wallet } from "fuels"; @@ -56,6 +58,8 @@ console.log(Wallet.fromPrivateKey(PRIVATE_KEY)); ## Calling Contracts + + ```ts:line-numbers import { Wallet, Contract, BigNumberish, BN } from "fuels"; import abi from "./abi.json"; @@ -76,6 +80,8 @@ console.log(transactionId, value); ## Deploying Contracts + + ```ts:line-numbers import { Provider, ContractFactory } from "fuels"; // Byte code generated using: forc build From 3062a2f7e9435e3523a9ac3bcd0599a4a639bc34 Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Tue, 28 Mar 2023 13:21:37 -0300 Subject: [PATCH 19/23] Merge branch 'master' into torres/docs/new-docs-engine --- .changeset/heavy-clouds-arrive.md | 2 + .changeset/modern-chicken-accept.md | 2 + .changeset/popular-gorillas-double.md | 2 + .changeset/quick-fireants-sleep.md | 5 + .changeset/seven-readers-poke.md | 5 + .github/workflows/release.yaml | 2 +- package.json | 7 +- .../src/templates/common/common.test.ts | 14 +- .../abi-typegen/test/utils/mockVersions.ts | 8 +- packages/forc-bin/package.json | 6 +- packages/fuel-gauge/package.json | 5 +- packages/fuel-gauge/scripts/build.sh | 13 - .../fuel-gauge/scripts/process-predicate.ts | 12 - .../fuel-gauge/scripts/process-predicates.ts | 22 + packages/fuel-gauge/test-projects/Forc.toml | 27 + packages/versions/package.json | 3 +- .../versions/scripts/rewriteVersions.test.ts | 75 ++ packages/versions/scripts/rewriteVersions.ts | 66 ++ packages/versions/src/index.ts | 36 +- .../src/lib/getSupportedVersions.test.ts | 36 +- .../versions/src/lib/getSupportedVersions.ts | 16 +- packages/versions/tsconfig.json | 2 +- pnpm-lock.yaml | 675 +++++++++--------- scripts/changeset-version-with-docs.ts | 12 + 24 files changed, 640 insertions(+), 413 deletions(-) create mode 100644 .changeset/heavy-clouds-arrive.md create mode 100644 .changeset/modern-chicken-accept.md create mode 100644 .changeset/popular-gorillas-double.md create mode 100644 .changeset/quick-fireants-sleep.md create mode 100644 .changeset/seven-readers-poke.md delete mode 100755 packages/fuel-gauge/scripts/build.sh delete mode 100644 packages/fuel-gauge/scripts/process-predicate.ts create mode 100644 packages/fuel-gauge/scripts/process-predicates.ts create mode 100644 packages/fuel-gauge/test-projects/Forc.toml create mode 100644 packages/versions/scripts/rewriteVersions.test.ts create mode 100644 packages/versions/scripts/rewriteVersions.ts create mode 100644 scripts/changeset-version-with-docs.ts diff --git a/.changeset/heavy-clouds-arrive.md b/.changeset/heavy-clouds-arrive.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/heavy-clouds-arrive.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/.changeset/modern-chicken-accept.md b/.changeset/modern-chicken-accept.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/modern-chicken-accept.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/.changeset/popular-gorillas-double.md b/.changeset/popular-gorillas-double.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/popular-gorillas-double.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/.changeset/quick-fireants-sleep.md b/.changeset/quick-fireants-sleep.md new file mode 100644 index 00000000000..a2a436e690a --- /dev/null +++ b/.changeset/quick-fireants-sleep.md @@ -0,0 +1,5 @@ +--- +"@fuel-ts/versions": patch +--- + +Refactoring `versions` packages so that it can be used locally, providing accurate versions for all relevant parts of the stack diff --git a/.changeset/seven-readers-poke.md b/.changeset/seven-readers-poke.md new file mode 100644 index 00000000000..c8bd64e8f99 --- /dev/null +++ b/.changeset/seven-readers-poke.md @@ -0,0 +1,5 @@ +--- +"forc-bin": minor +--- + +Upgrading Forc from `0.35.3` to `0.35.5` diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 8c5c61b8742..02807dfa50a 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -52,7 +52,7 @@ jobs: uses: FuelLabs/changesets-action@main with: publish: pnpm changeset:publish - version: pnpm changeset version + version: pnpm changeset:version-with-docs commit: "ci(changesets): versioning packages" title: "ci(changesets): versioning packages" createGithubReleases: aggregate diff --git a/package.json b/package.json index c2146979092..6f4eeb679c4 100644 --- a/package.json +++ b/package.json @@ -25,6 +25,7 @@ "services:restart": "run-s services:clean services:run", "changeset:publish": "changeset publish --no-git-tag", "changeset:next": "ts-node ./scripts/changeset-next", + "changeset:version-with-docs": "ts-node ./scripts/changeset-version-with-docs", "forc:update": "ts-node ./scripts/forc-update", "forc:check": "./scripts/forc-check.sh", "forc:format": "./scripts/forc-format.sh", @@ -43,8 +44,8 @@ "@changesets/changelog-github": "^0.4.7", "@changesets/cli": "^2.25.0", "@ethersproject/bytes": "^5.7.0", - "@jest/types": "29.4.3", - "@types/jest": "^29.2.3", + "@jest/types": "^29.5.0", + "@types/jest": "^29.5.0", "@types/node": "^14.18.32", "@types/node-fetch": "^2.6.2", "@types/shelljs": "^0.8.11", @@ -68,7 +69,7 @@ "ethers": "^5.7.2", "forc-bin": "workspace:*", "husky": "^8.0.3", - "jest": "^29.3.1", + "jest": "^29.5.0", "jest-text-transformer": "^1.0.4", "markdownlint": "^0.23.1", "markdownlint-cli": "^0.27.1", diff --git a/packages/abi-typegen/src/templates/common/common.test.ts b/packages/abi-typegen/src/templates/common/common.test.ts index 2bb2004044a..601981e6a63 100644 --- a/packages/abi-typegen/src/templates/common/common.test.ts +++ b/packages/abi-typegen/src/templates/common/common.test.ts @@ -5,14 +5,22 @@ import { renderCommonTemplate } from './common'; describe('templates/common', () => { test('should render common template', () => { // mocking - const { restore } = mockVersions(); + const { versions, restore } = mockVersions(); // executing - const expectedVersion = /(Fuels|Forc|Fuel-Core) version: 0.0.0/; + const rendered = renderCommonTemplate(); // validating restore(); - expect(renderCommonTemplate()).toMatch(expectedVersion); + const { FORC, FUELS, FUEL_CORE } = versions; + + const expectedFuelsVersion = new RegExp(`Fuels version: ${FUELS}`); + const expectedForcVersion = new RegExp(`Forc version: ${FORC}`); + const expectedFuelCoreVersion = new RegExp(`Fuel-Core version: ${FUEL_CORE}`); + + expect(rendered).toMatch(expectedFuelsVersion); + expect(rendered).toMatch(expectedForcVersion); + expect(rendered).toMatch(expectedFuelCoreVersion); }); }); diff --git a/packages/abi-typegen/test/utils/mockVersions.ts b/packages/abi-typegen/test/utils/mockVersions.ts index 82d03cf8c8d..8f0351fd05d 100644 --- a/packages/abi-typegen/test/utils/mockVersions.ts +++ b/packages/abi-typegen/test/utils/mockVersions.ts @@ -1,4 +1,4 @@ -import { versions } from '@fuel-ts/versions'; +import * as versionsMod from '@fuel-ts/versions'; export function mockVersions( values: { @@ -11,14 +11,12 @@ export function mockVersions( FUEL_CORE: '33.33.33', } ) { - const original = { ...versions }; - - Object.assign(versions, values); + const mock = jest.replaceProperty(versionsMod, 'versions', values); return { versions: values, restore() { - Object.assign(versions, original); + mock.restore(); }, }; } diff --git a/packages/forc-bin/package.json b/packages/forc-bin/package.json index 0013e2c1660..f1af88cea97 100644 --- a/packages/forc-bin/package.json +++ b/packages/forc-bin/package.json @@ -12,14 +12,14 @@ "license": "Apache-2.0", "scripts": { "preinstall": "tsup --dts", - "install": "./dist/install.js", - "update": "./dist/update.js && ./dist/install.js" + "install": "node ./dist/install.js", + "update": "node ./dist/update.js && node ./dist/install.js" }, "bin": { "forc": "./forc.js" }, "config": { - "forcVersion": "0.35.3" + "forcVersion": "0.35.5" }, "dependencies": { "node-fetch": "^2.6.7", diff --git a/packages/fuel-gauge/package.json b/packages/fuel-gauge/package.json index 7ae772d5510..8e28a6dc9a0 100644 --- a/packages/fuel-gauge/package.json +++ b/packages/fuel-gauge/package.json @@ -5,8 +5,9 @@ "description": "", "author": "Fuel Labs (https://fuel.network/)", "scripts": { - "build": "pnpm build-projects", - "build-projects": "./scripts/build.sh" + "build": "run-p build:forc-projects build:process-predicates", + "build:forc-projects": "pnpm forc build -p test-projects", + "build:process-predicates": "ts-node ./scripts/process-predicates.ts" }, "license": "Apache-2.0", "dependencies": { diff --git a/packages/fuel-gauge/scripts/build.sh b/packages/fuel-gauge/scripts/build.sh deleted file mode 100755 index 9c1793cc924..00000000000 --- a/packages/fuel-gauge/scripts/build.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash - -set -euo pipefail - -for PROJECT_DIR in ./test-projects/* ; -do - BIN_DIR="$PROJECT_DIR/out/debug" - - pnpm forc build -p $PROJECT_DIR - if [[ $PROJECT_DIR == *"predicate-"* ]]; then - pnpm exec ts-node scripts/process-predicate.ts $PROJECT_DIR - fi -done \ No newline at end of file diff --git a/packages/fuel-gauge/scripts/process-predicate.ts b/packages/fuel-gauge/scripts/process-predicate.ts deleted file mode 100644 index 8911bd2f121..00000000000 --- a/packages/fuel-gauge/scripts/process-predicate.ts +++ /dev/null @@ -1,12 +0,0 @@ -import fs from 'fs'; -import { hexlify } from 'fuels'; -import path from 'path'; - -const predicatePath = process.argv[2].replace('/test-projects', ''); -const testProjectsPath = path.join(__dirname, '../test-projects'); - -// Put hexlified binary in a TS file so it can be imported -const binPath = path.join(testProjectsPath, `./${predicatePath}/out/debug/${predicatePath}.bin`); -const bytes = fs.readFileSync(binPath); -const predicateTs = `export default '${hexlify(bytes)}';\n`; -fs.writeFileSync(path.join(testProjectsPath, `./${predicatePath}/index.ts`), predicateTs); diff --git a/packages/fuel-gauge/scripts/process-predicates.ts b/packages/fuel-gauge/scripts/process-predicates.ts new file mode 100644 index 00000000000..e904a863073 --- /dev/null +++ b/packages/fuel-gauge/scripts/process-predicates.ts @@ -0,0 +1,22 @@ +import { readFileSync, readdirSync, writeFileSync } from 'fs'; +import { hexlify } from 'fuels'; +import { join } from 'path'; + +const projectsDir = join(__dirname, '../test-projects'); + +const files = readdirSync(projectsDir).filter((file) => file.includes('predicate-')); + +const { log } = console; + +files.forEach(async (filePath) => { + log('Process predicate: ', filePath); + + const basePath = join(projectsDir, filePath); + const binaryPath = join(basePath, '/out/debug/', `${filePath}.bin`); + const binaryTSPath = join(basePath, 'index.ts'); + const bytes = await readFileSync(binaryPath); + + // Put hexlified binary in a TS file so it can be imported + const predicateTs = `export default '${hexlify(bytes)}';\n`; + writeFileSync(binaryTSPath, predicateTs); +}); diff --git a/packages/fuel-gauge/test-projects/Forc.toml b/packages/fuel-gauge/test-projects/Forc.toml new file mode 100644 index 00000000000..fdceea8c8e2 --- /dev/null +++ b/packages/fuel-gauge/test-projects/Forc.toml @@ -0,0 +1,27 @@ +[workspace] +members = [ + "advanced-logging", + "advanced-logging-other-contract", + "advanced-logging-other-contract-abi", + "auth_testing_abi", + "auth_testing_contract", + "call-test-contract", + "collision_in_fn_names", + "coverage-contract", + "generic-types-contract", + "liquidity-pool", + "payable-annotation", + "predicate-address", + "predicate-false", + "predicate-main-args-struct", + "predicate-struct", + "predicate-triple-sig", + "predicate-true", + "predicate-u32", + "script-main-args", + "script-main-return-struct", + "script-main-two-args", + "storage-test-contract", + "token_abi", + "token_contract" +] diff --git a/packages/versions/package.json b/packages/versions/package.json index 9024ac2f228..0977f3b9560 100644 --- a/packages/versions/package.json +++ b/packages/versions/package.json @@ -54,6 +54,7 @@ "@types/semver": "^7.3.13" }, "scripts": { - "build": "tsup --dts --env.BUILD_VERSION $BUILD_VERSION --env.FORC_VERSION $FORC_VERSION --env.FUEL_CORE_VERSION $FUEL_CORE_VERSION" + "prebuild": "ts-node ./scripts/rewriteVersions.ts", + "build": "tsup --dts" } } diff --git a/packages/versions/scripts/rewriteVersions.test.ts b/packages/versions/scripts/rewriteVersions.test.ts new file mode 100644 index 00000000000..3f68bf624db --- /dev/null +++ b/packages/versions/scripts/rewriteVersions.test.ts @@ -0,0 +1,75 @@ +import { readVersions, readVersionsFromEnv, readVersionsFromFiles } from './rewriteVersions'; + +describe('getSupportedVersions.js', () => { + function modifyEnv() { + const envBackup = { ...process.env }; + + const BUILD_VERSION = '9.9.9'; + const FORC_VERSION = '8.8.8'; + const FUEL_CORE_VERSION = '7.7.7'; + + process.env.BUILD_VERSION = BUILD_VERSION; + process.env.FORC_VERSION = FORC_VERSION; + process.env.FUEL_CORE_VERSION = FUEL_CORE_VERSION; + + return { + BUILD_VERSION, + FORC_VERSION, + FUEL_CORE_VERSION, + restoreEnv() { + process.env = envBackup; + }, + }; + } + + test('should read versions from files', async () => { + const versionsFromFiles = readVersionsFromFiles(); + + expect(versionsFromFiles.FORC).toBeTruthy(); + expect(versionsFromFiles.FUEL_CORE).toBeTruthy(); + expect(versionsFromFiles.FUELS).toBeTruthy(); + }); + + test('should read versions from env', async () => { + // mocking + const { BUILD_VERSION, FORC_VERSION, FUEL_CORE_VERSION, restoreEnv } = modifyEnv(); + + // executing + const versions = readVersionsFromEnv(); + + // restoring + restoreEnv(); + + // validating + expect(versions.FORC).toEqual(FORC_VERSION); + expect(versions.FUEL_CORE).toEqual(FUEL_CORE_VERSION); + expect(versions.FUELS).toEqual(BUILD_VERSION); + }); + + test('should prioritize versions from env', async () => { + // mocking + const { BUILD_VERSION, FORC_VERSION, FUEL_CORE_VERSION, restoreEnv } = modifyEnv(); + + // executing + const versions = readVersions(); + + // restoring + restoreEnv(); + + // validating + expect(versions.FORC).toEqual(FORC_VERSION); + expect(versions.FUEL_CORE).toEqual(FUEL_CORE_VERSION); + expect(versions.FUELS).toEqual(BUILD_VERSION); + }); + + test('should fallback to versions from files', async () => { + // executing + const versions = readVersions(); + const versionsFromFiles = readVersionsFromFiles(); + + // validating + expect(versions.FORC).toEqual(versionsFromFiles.FORC); + expect(versions.FUEL_CORE).toEqual(versionsFromFiles.FUEL_CORE); + expect(versions.FUELS).toEqual(versionsFromFiles.FUELS); + }); +}); diff --git a/packages/versions/scripts/rewriteVersions.ts b/packages/versions/scripts/rewriteVersions.ts new file mode 100644 index 00000000000..5cdce3abebe --- /dev/null +++ b/packages/versions/scripts/rewriteVersions.ts @@ -0,0 +1,66 @@ +import { readFileSync, writeFileSync } from 'fs'; +import { join } from 'path'; + +export const readVersionsFromFiles = () => { + const rootDir = join(__dirname, '../../..'); + const packagesDir = join(rootDir, 'packages'); + const servicesDir = join(rootDir, 'services'); + + // forc-bin + const forcPath = join(packagesDir, 'forc-bin', 'package.json'); + const forcPkgJson = JSON.parse(readFileSync(forcPath, 'utf8')); + + // fuel-core + const dockerFilePath = join(servicesDir, 'fuel-core', 'Dockerfile'); + const dockerFileContents = readFileSync(dockerFilePath, 'utf8'); + const regexFuelcore = /FROM ghcr\.io\/fuellabs\/fuel-core:v(\d+\.\d+\.\d+)/; + const match = dockerFileContents.match(regexFuelcore); + + // fuels + const fuelsPath = join(packagesDir, 'fuels', 'package.json'); + const fuelsPkgJson = JSON.parse(readFileSync(fuelsPath, 'utf8')); + + const versions = { + FORC: forcPkgJson.config.forcVersion, + FUELS: fuelsPkgJson.version, + FUEL_CORE: match?.[1], + }; + + return versions; +}; + +export const readVersionsFromEnv = () => { + const versions = { + FORC: process.env.FORC_VERSION, + FUEL_CORE: process.env.FUEL_CORE_VERSION, + FUELS: process.env.BUILD_VERSION, + }; + return versions; +}; + +export const readVersions = () => { + const fromFiles = readVersionsFromFiles(); + const fromEnv = readVersionsFromEnv(); + + const FUELS = fromEnv.FUELS || fromFiles.FUELS; + const FORC = fromEnv.FORC || fromFiles.FORC; + const FUEL_CORE = fromEnv.FUEL_CORE || fromFiles.FUEL_CORE; + + return { FUELS, FORC, FUEL_CORE }; +}; + +export const rewriteVersions = () => { + const { FUELS, FORC, FUEL_CORE } = readVersions(); + + const filepath = join(__dirname, '..', 'src', 'lib', 'getSupportedVersions.ts'); + + let contents = readFileSync(filepath, 'utf8'); + + contents = contents.replace(/FUELS: '[\d.]+'/, `FUELS: '${FUELS}'`); + contents = contents.replace(/FORC: '[\d.]+'/, `FORC: '${FORC}'`); + contents = contents.replace(/FUEL_CORE: '[\d.]+'/, `FUEL_CORE: '${FUEL_CORE}'`); + + writeFileSync(filepath, contents); +}; + +rewriteVersions(); diff --git a/packages/versions/src/index.ts b/packages/versions/src/index.ts index 1e0902a0b38..3d0ed204664 100644 --- a/packages/versions/src/index.ts +++ b/packages/versions/src/index.ts @@ -1,20 +1,38 @@ /* - Variables: + 1) Variables + ------------ `FUELS` — comes from `/packages/fuels/package.json` `FUEL_CORE` — comes from `/services/fuel-core/Dockerfile` `FORC` — comes from `/packages/forc-bin/package.json` - The CI release routine reads the aforementioned files, - and set all the variables prior to building the packages. + 3) Pre Build + ------------ + There's a `prebuild` script in: + - packages/versions/package.json - Take a look at the /.github/workflows/release` file. + Before build, it will call this file: + - packages/versions/scripts/replaceVersions.ts - The TSUP build then replaces all `process.env.` - entries bellow with their respective values from the env. + Which will replace static versions at: + - packages/versions/src/lib/getSupportedVersions.ts - If no env variables are set, the expression `!0` seems to be - used by TSUP, which then results to `true`. For this reason, - we check for it and use default values instead. + If no env variables are set, it uses the current versions + from the original locations mentioned in the 1st step. + + 3) CI + ------------ + As part of the CI release (1) routine, the changes made + to the versions package by the `prebuild` routine will + be committed by the same script (2) that handles the + docs versioning. + + - (1) /.github/workflows/release.yaml + - (2) /changeset-version-with-docs.ts + + 4) Build + ------------ + By the time we get to the `build` step, everything is in + place already and ready to be built and released. */ import { getSupportedVersions } from './lib/getSupportedVersions'; diff --git a/packages/versions/src/lib/getSupportedVersions.test.ts b/packages/versions/src/lib/getSupportedVersions.test.ts index f166c77bd04..847a227ea7c 100644 --- a/packages/versions/src/lib/getSupportedVersions.test.ts +++ b/packages/versions/src/lib/getSupportedVersions.test.ts @@ -1,34 +1,14 @@ -import { getSupportedVersions, thisVersionOrDefault } from './getSupportedVersions'; +import { readVersionsFromFiles } from '../../scripts/rewriteVersions'; + +import { getSupportedVersions } from './getSupportedVersions'; describe('getSupportedVersions.js', () => { test('should return received version of default', async () => { - expect(thisVersionOrDefault()).toEqual('0.0.0'); - expect(thisVersionOrDefault('true')).toEqual('0.0.0'); - expect(thisVersionOrDefault(undefined)).toEqual('0.0.0'); - expect(thisVersionOrDefault('1.1.1')).toEqual('1.1.1'); - }); - - test('should get versions just fine', async () => { - // mocking - const envBackup = { ...process.env }; - - const BUILD_VERSION = '9.9.9'; - const FORC_VERSION = '8.8.8'; - const FUEL_CORE_VERSION = '7.7.7'; - - process.env.BUILD_VERSION = BUILD_VERSION; - process.env.FORC_VERSION = FORC_VERSION; - process.env.FUEL_CORE_VERSION = FUEL_CORE_VERSION; - - // executing - const env = getSupportedVersions(); - - // restoring - process.env = envBackup; + const versions = getSupportedVersions(); + const versionsFromFiles = readVersionsFromFiles(); - // validating - expect(env.FUELS).toEqual(BUILD_VERSION); - expect(env.FORC).toEqual(FORC_VERSION); - expect(env.FUEL_CORE).toEqual(FUEL_CORE_VERSION); + expect(versions.FORC).toEqual(versionsFromFiles.FORC); + expect(versions.FUEL_CORE).toEqual(versionsFromFiles.FUEL_CORE); + expect(versions.FUELS).toEqual(versionsFromFiles.FUELS); }); }); diff --git a/packages/versions/src/lib/getSupportedVersions.ts b/packages/versions/src/lib/getSupportedVersions.ts index 8e72fc3a694..66b0db95a43 100644 --- a/packages/versions/src/lib/getSupportedVersions.ts +++ b/packages/versions/src/lib/getSupportedVersions.ts @@ -1,17 +1,7 @@ -export function thisVersionOrDefault(version?: string | boolean) { - if (version !== undefined) { - const versionStr = version.toString(); - if (versionStr !== 'true') { - return versionStr; - } - } - return '0.0.0'; -} - export function getSupportedVersions() { return { - FUELS: thisVersionOrDefault(process.env.BUILD_VERSION), - FUEL_CORE: thisVersionOrDefault(process.env.FUEL_CORE_VERSION), - FORC: thisVersionOrDefault(process.env.FORC_VERSION), + FORC: '0.35.5', + FUEL_CORE: '0.17.3', + FUELS: '0.37.0', }; } diff --git a/packages/versions/tsconfig.json b/packages/versions/tsconfig.json index a35b78ccee4..99117c0a9fe 100644 --- a/packages/versions/tsconfig.json +++ b/packages/versions/tsconfig.json @@ -5,5 +5,5 @@ "rootDir": "./", "baseUrl": "./" }, - "include": ["src"] + "include": ["src", "scripts"] } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index d8dbf0ec034..296bb7cb418 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -7,8 +7,8 @@ importers: '@changesets/changelog-github': ^0.4.7 '@changesets/cli': ^2.25.0 '@ethersproject/bytes': ^5.7.0 - '@jest/types': 29.4.3 - '@types/jest': ^29.2.3 + '@jest/types': ^29.5.0 + '@types/jest': ^29.5.0 '@types/node': ^14.18.32 '@types/node-fetch': ^2.6.2 '@types/shelljs': ^0.8.11 @@ -32,7 +32,7 @@ importers: ethers: ^5.7.2 forc-bin: workspace:* husky: ^8.0.3 - jest: ^29.3.1 + jest: ^29.5.0 jest-text-transformer: ^1.0.4 markdownlint: ^0.23.1 markdownlint-cli: ^0.27.1 @@ -50,8 +50,8 @@ importers: '@changesets/changelog-github': 0.4.7 '@changesets/cli': 2.25.2 '@ethersproject/bytes': 5.7.0 - '@jest/types': 29.4.3 - '@types/jest': 29.2.4 + '@jest/types': 29.5.0 + '@types/jest': 29.5.0 '@types/node': 14.18.33 '@types/node-fetch': 2.6.2 '@types/shelljs': 0.8.11 @@ -75,7 +75,7 @@ importers: ethers: 5.7.2 forc-bin: link:packages/forc-bin husky: 8.0.3 - jest: 29.3.1_t5wpzltkkzdw6ng6jmtbqvsf2q + jest: 29.5.0_t5wpzltkkzdw6ng6jmtbqvsf2q jest-text-transformer: 1.0.4 markdownlint: 0.23.1 markdownlint-cli: 0.27.1 @@ -84,7 +84,7 @@ importers: prettier: 2.8.0 shelljs: 0.8.5 ts-generator: 0.1.1 - ts-jest: 29.0.3_n3m7ogz6hldwfud56c755ycyaq + ts-jest: 29.0.3_m6msr2njuqvkwjdpknr4wbhwmm ts-node: 10.9.1_kluoused5zacjtflizwvdqgpom tsup: 5.12.9_2dtigtkb225m7ii7q45utxqwgi turbo: 1.6.3 @@ -2887,20 +2887,20 @@ packages: engines: {node: '>=8'} dev: true - /@jest/console/29.3.1: - resolution: {integrity: sha512-IRE6GD47KwcqA09RIWrabKdHPiKDGgtAL31xDxbi/RjQMsr+lY+ppxmHwY0dUEV3qvvxZzoe5Hl0RXZJOjQNUg==} + /@jest/console/29.5.0: + resolution: {integrity: sha512-NEpkObxPwyw/XxZVLPmAGKE89IQRp4puc6IQRPru6JKd1M3fW9v1xM1AnzIJE65hbCkzQAdnL8P47e9hzhiYLQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/types': 29.4.3 - '@types/node': 18.11.9 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 chalk: 4.1.2 - jest-message-util: 29.3.1 - jest-util: 29.3.1 + jest-message-util: 29.5.0 + jest-util: 29.5.0 slash: 3.0.0 dev: true - /@jest/core/29.3.1_ts-node@10.9.1: - resolution: {integrity: sha512-0ohVjjRex985w5MmO5L3u5GR1O30DexhBSpuwx2P+9ftyqHdJXnk7IUWiP80oHMvt7ubHCJHxV0a0vlKVuZirw==} + /@jest/core/29.5.0_ts-node@10.9.1: + resolution: {integrity: sha512-28UzQc7ulUrOQw1IsN/kv1QES3q2kkbl/wGslyhAclqZ/8cMdB5M68BffkIdSJgKBUt50d3hbwJ92XESlE7LiQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} peerDependencies: node-notifier: ^8.0.1 || ^9.0.0 || ^10.0.0 @@ -2908,32 +2908,32 @@ packages: node-notifier: optional: true dependencies: - '@jest/console': 29.3.1 - '@jest/reporters': 29.3.1 - '@jest/test-result': 29.3.1 - '@jest/transform': 29.3.1 - '@jest/types': 29.4.3 - '@types/node': 18.11.9 + '@jest/console': 29.5.0 + '@jest/reporters': 29.5.0 + '@jest/test-result': 29.5.0 + '@jest/transform': 29.5.0 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 ansi-escapes: 4.3.2 chalk: 4.1.2 ci-info: 3.7.0 exit: 0.1.2 graceful-fs: 4.2.10 - jest-changed-files: 29.2.0 - jest-config: 29.3.1_odkjkoia5xunhxkdrka32ib6vi - jest-haste-map: 29.3.1 - jest-message-util: 29.3.1 - jest-regex-util: 29.2.0 - jest-resolve: 29.3.1 - jest-resolve-dependencies: 29.3.1 - jest-runner: 29.3.1 - jest-runtime: 29.3.1 - jest-snapshot: 29.3.1 - jest-util: 29.3.1 - jest-validate: 29.3.1 - jest-watcher: 29.3.1 + jest-changed-files: 29.5.0 + jest-config: 29.5.0_t5wpzltkkzdw6ng6jmtbqvsf2q + jest-haste-map: 29.5.0 + jest-message-util: 29.5.0 + jest-regex-util: 29.4.3 + jest-resolve: 29.5.0 + jest-resolve-dependencies: 29.5.0 + jest-runner: 29.5.0 + jest-runtime: 29.5.0 + jest-snapshot: 29.5.0 + jest-util: 29.5.0 + jest-validate: 29.5.0 + jest-watcher: 29.5.0 micromatch: 4.0.5 - pretty-format: 29.3.1 + pretty-format: 29.5.0 slash: 3.0.0 strip-ansi: 6.0.1 transitivePeerDependencies: @@ -2941,14 +2941,14 @@ packages: - ts-node dev: true - /@jest/environment/29.3.1: - resolution: {integrity: sha512-pMmvfOPmoa1c1QpfFW0nXYtNLpofqo4BrCIk6f2kW4JFeNlHV2t3vd+3iDLf31e2ot2Mec0uqZfmI+U0K2CFag==} + /@jest/environment/29.5.0: + resolution: {integrity: sha512-5FXw2+wD29YU1d4I2htpRX7jYnAyTRjP2CsXQdo9SAM8g3ifxWPSV0HnClSn71xwctr0U3oZIIH+dtbfmnbXVQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/fake-timers': 29.3.1 - '@jest/types': 29.4.3 - '@types/node': 18.11.9 - jest-mock: 29.3.1 + '@jest/fake-timers': 29.5.0 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 + jest-mock: 29.5.0 dev: true /@jest/expect-utils/29.3.1: @@ -2958,42 +2958,49 @@ packages: jest-get-type: 29.2.0 dev: true - /@jest/expect/29.3.1: - resolution: {integrity: sha512-QivM7GlSHSsIAWzgfyP8dgeExPRZ9BIe2LsdPyEhCGkZkoyA+kGsoIzbKAfZCvvRzfZioKwPtCZIt5SaoxYCvg==} + /@jest/expect-utils/29.5.0: + resolution: {integrity: sha512-fmKzsidoXQT2KwnrwE0SQq3uj8Z763vzR8LnLBwC2qYWEFpjX8daRsk6rHUM1QvNlEW/UJXNXm59ztmJJWs2Mg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - expect: 29.3.1 - jest-snapshot: 29.3.1 + jest-get-type: 29.4.3 + dev: true + + /@jest/expect/29.5.0: + resolution: {integrity: sha512-PueDR2HGihN3ciUNGr4uelropW7rqUfTiOn+8u0leg/42UhblPxHkfoh0Ruu3I9Y1962P3u2DY4+h7GVTSVU6g==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + expect: 29.5.0 + jest-snapshot: 29.5.0 transitivePeerDependencies: - supports-color dev: true - /@jest/fake-timers/29.3.1: - resolution: {integrity: sha512-iHTL/XpnDlFki9Tq0Q1GGuVeQ8BHZGIYsvCO5eN/O/oJaRzofG9Xndd9HuSDBI/0ZS79pg0iwn07OMTQ7ngF2A==} + /@jest/fake-timers/29.5.0: + resolution: {integrity: sha512-9ARvuAAQcBwDAqOnglWq2zwNIRUDtk/SCkp/ToGEhFv5r86K21l+VEs0qNTaXtyiY0lEePl3kylijSYJQqdbDg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/types': 29.4.3 - '@sinonjs/fake-timers': 9.1.2 - '@types/node': 18.11.9 - jest-message-util: 29.3.1 - jest-mock: 29.3.1 - jest-util: 29.3.1 + '@jest/types': 29.5.0 + '@sinonjs/fake-timers': 10.0.2 + '@types/node': 14.18.33 + jest-message-util: 29.5.0 + jest-mock: 29.5.0 + jest-util: 29.5.0 dev: true - /@jest/globals/29.3.1: - resolution: {integrity: sha512-cTicd134vOcwO59OPaB6AmdHQMCtWOe+/DitpTZVxWgMJ+YvXL1HNAmPyiGbSHmF/mXVBkvlm8YYtQhyHPnV6Q==} + /@jest/globals/29.5.0: + resolution: {integrity: sha512-S02y0qMWGihdzNbUiqSAiKSpSozSuHX5UYc7QbnHP+D9Lyw8DgGGCinrN9uSuHPeKgSSzvPom2q1nAtBvUsvPQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/environment': 29.3.1 - '@jest/expect': 29.3.1 - '@jest/types': 29.4.3 - jest-mock: 29.3.1 + '@jest/environment': 29.5.0 + '@jest/expect': 29.5.0 + '@jest/types': 29.5.0 + jest-mock: 29.5.0 transitivePeerDependencies: - supports-color dev: true - /@jest/reporters/29.3.1: - resolution: {integrity: sha512-GhBu3YFuDrcAYW/UESz1JphEAbvUjaY2vShRZRoRY1mxpCMB3yGSJ4j9n0GxVlEOdCf7qjvUfBCrTUUqhVfbRA==} + /@jest/reporters/29.5.0: + resolution: {integrity: sha512-D05STXqj/M8bP9hQNSICtPqz97u7ffGzZu+9XLucXhkOFBqKcXe04JLZOgIekOxdb73MAoBUFnqvf7MCpKk5OA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} peerDependencies: node-notifier: ^8.0.1 || ^9.0.0 || ^10.0.0 @@ -3002,12 +3009,12 @@ packages: optional: true dependencies: '@bcoe/v8-coverage': 0.2.3 - '@jest/console': 29.3.1 - '@jest/test-result': 29.3.1 - '@jest/transform': 29.3.1 - '@jest/types': 29.4.3 + '@jest/console': 29.5.0 + '@jest/test-result': 29.5.0 + '@jest/transform': 29.5.0 + '@jest/types': 29.5.0 '@jridgewell/trace-mapping': 0.3.17 - '@types/node': 18.11.9 + '@types/node': 14.18.33 chalk: 4.1.2 collect-v8-coverage: 1.0.1 exit: 0.1.2 @@ -3018,9 +3025,9 @@ packages: istanbul-lib-report: 3.0.0 istanbul-lib-source-maps: 4.0.1 istanbul-reports: 3.1.5 - jest-message-util: 29.3.1 - jest-util: 29.3.1 - jest-worker: 29.3.1 + jest-message-util: 29.5.0 + jest-util: 29.5.0 + jest-worker: 29.5.0 slash: 3.0.0 string-length: 4.0.2 strip-ansi: 6.0.1 @@ -3029,13 +3036,6 @@ packages: - supports-color dev: true - /@jest/schemas/29.0.0: - resolution: {integrity: sha512-3Ab5HgYIIAnS0HjqJHQYZS+zXc4tUmTmBH3z83ajI6afXp8X3ZtdLX+nXx+I7LNkJD7uN9LAVhgnjDgZa2z0kA==} - engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} - dependencies: - '@sinclair/typebox': 0.24.51 - dev: true - /@jest/schemas/29.4.3: resolution: {integrity: sha512-VLYKXQmtmuEz6IxJsrZwzG9NvtkQsWNnWMsKxqWNu3+CnfzJQhp0WDDKWLVV9hLKr0l3SLLFRqcYHjhtyuDVxg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} @@ -3043,8 +3043,8 @@ packages: '@sinclair/typebox': 0.25.23 dev: true - /@jest/source-map/29.2.0: - resolution: {integrity: sha512-1NX9/7zzI0nqa6+kgpSdKPK+WU1p+SJk3TloWZf5MzPbxri9UEeXX5bWZAPCzbQcyuAzubcdUHA7hcNznmRqWQ==} + /@jest/source-map/29.4.3: + resolution: {integrity: sha512-qyt/mb6rLyd9j1jUts4EQncvS6Yy3PM9HghnNv86QBlV+zdL2inCdK1tuVlL+J+lpiw2BI67qXOrX3UurBqQ1w==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@jridgewell/trace-mapping': 0.3.17 @@ -3052,41 +3052,41 @@ packages: graceful-fs: 4.2.10 dev: true - /@jest/test-result/29.3.1: - resolution: {integrity: sha512-qeLa6qc0ddB0kuOZyZIhfN5q0e2htngokyTWsGriedsDhItisW7SDYZ7ceOe57Ii03sL988/03wAcBh3TChMGw==} + /@jest/test-result/29.5.0: + resolution: {integrity: sha512-fGl4rfitnbfLsrfx1uUpDEESS7zM8JdgZgOCQuxQvL1Sn/I6ijeAVQWGfXI9zb1i9Mzo495cIpVZhA0yr60PkQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/console': 29.3.1 - '@jest/types': 29.4.3 + '@jest/console': 29.5.0 + '@jest/types': 29.5.0 '@types/istanbul-lib-coverage': 2.0.4 collect-v8-coverage: 1.0.1 dev: true - /@jest/test-sequencer/29.3.1: - resolution: {integrity: sha512-IqYvLbieTv20ArgKoAMyhLHNrVHJfzO6ARZAbQRlY4UGWfdDnLlZEF0BvKOMd77uIiIjSZRwq3Jb3Fa3I8+2UA==} + /@jest/test-sequencer/29.5.0: + resolution: {integrity: sha512-yPafQEcKjkSfDXyvtgiV4pevSeyuA6MQr6ZIdVkWJly9vkqjnFfcfhRQqpD5whjoU8EORki752xQmjaqoFjzMQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/test-result': 29.3.1 + '@jest/test-result': 29.5.0 graceful-fs: 4.2.10 - jest-haste-map: 29.3.1 + jest-haste-map: 29.5.0 slash: 3.0.0 dev: true - /@jest/transform/29.3.1: - resolution: {integrity: sha512-8wmCFBTVGYqFNLWfcOWoVuMuKYPUBTnTMDkdvFtAYELwDOl9RGwOsvQWGPFxDJ8AWY9xM/8xCXdqmPK3+Q5Lug==} + /@jest/transform/29.5.0: + resolution: {integrity: sha512-8vbeZWqLJOvHaDfeMuoHITGKSz5qWc9u04lnWrQE3VyuSw604PzQM824ZeX9XSjUCeDiE3GuxZe5UKa8J61NQw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@babel/core': 7.20.2 - '@jest/types': 29.4.3 + '@jest/types': 29.5.0 '@jridgewell/trace-mapping': 0.3.17 babel-plugin-istanbul: 6.1.1 chalk: 4.1.2 convert-source-map: 2.0.0 fast-json-stable-stringify: 2.1.0 graceful-fs: 4.2.10 - jest-haste-map: 29.3.1 - jest-regex-util: 29.2.0 - jest-util: 29.3.1 + jest-haste-map: 29.5.0 + jest-regex-util: 29.4.3 + jest-util: 29.5.0 micromatch: 4.0.5 pirates: 4.0.5 slash: 3.0.0 @@ -3095,14 +3095,14 @@ packages: - supports-color dev: true - /@jest/types/29.4.3: - resolution: {integrity: sha512-bPYfw8V65v17m2Od1cv44FH+SiKW7w2Xu7trhcdTLUmSv85rfKsP+qXSjO4KGJr4dtPSzl/gvslZBXctf1qGEA==} + /@jest/types/29.5.0: + resolution: {integrity: sha512-qbu7kN6czmVRc3xWFQcAN03RAUamgppVUdXrvl1Wr3jlNF93o9mJbGcDWrwGB6ht44u7efB1qCFgVQmca24Uog==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@jest/schemas': 29.4.3 '@types/istanbul-lib-coverage': 2.0.4 '@types/istanbul-reports': 3.0.1 - '@types/node': 18.11.9 + '@types/node': 14.18.33 '@types/yargs': 17.0.14 chalk: 4.1.2 dev: true @@ -3236,24 +3236,20 @@ packages: resolution: {integrity: sha512-AW8PKd6iX3vAZ0vA43nOUOnbq/X5ihgU+mSXXqunMkeQADGiqw/PY0JNeYtD5sr0PAy51YPgAPbDoeapv9r8WA==} dev: true - /@sinclair/typebox/0.24.51: - resolution: {integrity: sha512-1P1OROm/rdubP5aFDSZQILU0vrLCJ4fvHt6EoqHEM+2D/G5MK3bIaymUKLit8Js9gbns5UyJnkP/TZROLw4tUA==} - dev: true - /@sinclair/typebox/0.25.23: resolution: {integrity: sha512-VEB8ygeP42CFLWyAJhN5OklpxUliqdNEUcXb4xZ/CINqtYGTjL5ukluKdKzQ0iWdUxyQ7B0539PAUhHKrCNWSQ==} dev: true - /@sinonjs/commons/1.8.5: - resolution: {integrity: sha512-rTpCA0wG1wUxglBSFdMMY0oTrKYvgf4fNgv/sXbfCVAdf+FnPBdKJR/7XbpTCwbCrvCbdPYnlWaUUYz4V2fPDA==} + /@sinonjs/commons/2.0.0: + resolution: {integrity: sha512-uLa0j859mMrg2slwQYdO/AkrOfmH+X6LTVmNTS9CqexuE2IvVORIkSpJLqePAbEnKJ77aMmCwr1NUZ57120Xcg==} dependencies: type-detect: 4.0.8 dev: true - /@sinonjs/fake-timers/9.1.2: - resolution: {integrity: sha512-BPS4ynJW/o92PUR4wgriz2Ud5gpST5vz6GQfMixEDK0Z8ZCUv2M7SkBLykH56T++Xs+8ln9zTGbOvNGIe02/jw==} + /@sinonjs/fake-timers/10.0.2: + resolution: {integrity: sha512-SwUDyjWnah1AaNl7kxsa7cfLhlTYoiyhDAIgyh+El30YvXs/o7OLXpYH88Zdhyx9JExKrmHDJ+10bwIcY80Jmw==} dependencies: - '@sinonjs/commons': 1.8.5 + '@sinonjs/commons': 2.0.0 dev: true /@tootallnate/once/2.0.0: @@ -3335,7 +3331,7 @@ packages: /@types/graceful-fs/4.1.5: resolution: {integrity: sha512-anKkLmZZ+xm4p8JWBf4hElkM4XR+EZeA2M9BAkkTldmcyDY4mbdIJnRghDJH3Ov5ooY7/UAoENtmdMSkaAd7Cw==} dependencies: - '@types/node': 18.11.9 + '@types/node': 14.18.33 dev: true /@types/is-ci/3.0.0: @@ -3360,8 +3356,8 @@ packages: '@types/istanbul-lib-report': 3.0.0 dev: true - /@types/jest/29.2.4: - resolution: {integrity: sha512-PipFB04k2qTRPePduVLTRiPzQfvMeLwUN3Z21hsAKaB/W9IIzgB2pizCL466ftJlcyZqnHoC9ZHpxLGl3fS86A==} + /@types/jest/29.5.0: + resolution: {integrity: sha512-3Emr5VOl/aoBwnWcH/EFQvlSAmjV+XtV9GGu5mwdYew5vhQh0IUZx/60x0TzHDu09Bi7HMx10t/namdJw5QIcg==} dependencies: expect: 29.3.1 pretty-format: 29.3.1 @@ -3437,7 +3433,7 @@ packages: /@types/mkdirp/0.5.2: resolution: {integrity: sha512-U5icWpv7YnZYGsN4/cmh3WD2onMY0aJIiTE6+51TwJCttdHvtCYmkBNOobHlXwrJRL0nkH9jH4kD+1FAdMN4Tg==} dependencies: - '@types/node': 18.11.9 + '@types/node': 14.18.33 dev: true /@types/mkdirp/1.0.2: @@ -3479,7 +3475,7 @@ packages: /@types/resolve/0.0.8: resolution: {integrity: sha512-auApPaJf3NPfe18hSoJkp8EbZzer2ISk7o8mCC3M9he/a04+gbMF97NkpD2S8riMGvm4BMRI59/SZQSaLTKpsQ==} dependencies: - '@types/node': 18.11.9 + '@types/node': 14.18.33 dev: true /@types/rimraf/3.0.2: @@ -4072,17 +4068,17 @@ packages: resolution: {integrity: sha512-Td525n+iPOOyUQIeBfcASuG6uJsDOITl7Mds5gFyerkWiX7qhUTdYUBlSgNMyVqtSJqwpt1kXGLdUt6SykLMRA==} dev: true - /babel-jest/29.3.1_@babel+core@7.20.2: - resolution: {integrity: sha512-aard+xnMoxgjwV70t0L6wkW/3HQQtV+O0PEimxKgzNqCJnbYmroPojdP2tqKSOAt8QAKV/uSZU8851M7B5+fcA==} + /babel-jest/29.5.0_@babel+core@7.20.2: + resolution: {integrity: sha512-mA4eCDh5mSo2EcA9xQjVTpmbbNk32Zb3Q3QFQsNhaK56Q+yoXowzFodLux30HRgyOho5rsQ6B0P9QpMkvvnJ0Q==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} peerDependencies: '@babel/core': ^7.8.0 dependencies: '@babel/core': 7.20.2 - '@jest/transform': 29.3.1 + '@jest/transform': 29.5.0 '@types/babel__core': 7.1.20 babel-plugin-istanbul: 6.1.1 - babel-preset-jest: 29.2.0_@babel+core@7.20.2 + babel-preset-jest: 29.5.0_@babel+core@7.20.2 chalk: 4.1.2 graceful-fs: 4.2.10 slash: 3.0.0 @@ -4103,8 +4099,8 @@ packages: - supports-color dev: true - /babel-plugin-jest-hoist/29.2.0: - resolution: {integrity: sha512-TnspP2WNiR3GLfCsUNHqeXw0RoQ2f9U5hQ5L3XFpwuO8htQmSrhh8qsB6vi5Yi8+kuynN1yjDjQsPfkebmB6ZA==} + /babel-plugin-jest-hoist/29.5.0: + resolution: {integrity: sha512-zSuuuAlTMT4mzLj2nPnUm6fsE6270vdOfnpbJ+RmruU75UhLFvL0N2NgI7xpeS7NaB6hGqmd5pVpGTDYvi4Q3w==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@babel/template': 7.18.10 @@ -4174,14 +4170,14 @@ packages: - supports-color dev: true - /babel-preset-jest/29.2.0_@babel+core@7.20.2: - resolution: {integrity: sha512-z9JmMJppMxNv8N7fNRHvhMg9cvIkMxQBXgFkane3yKVEvEOP+kB50lk8DFRvF9PGqbyXxlmebKWhuDORO8RgdA==} + /babel-preset-jest/29.5.0_@babel+core@7.20.2: + resolution: {integrity: sha512-JOMloxOqdiBSxMAzjRaH023/vvcaSaec49zvg+2LmNsktC7ei39LTJGw02J+9uUtTZUq6xbLyJ4dxe9sSmIuAg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} peerDependencies: '@babel/core': ^7.0.0 dependencies: '@babel/core': 7.20.2 - babel-plugin-jest-hoist: 29.2.0 + babel-plugin-jest-hoist: 29.5.0 babel-preset-current-node-syntax: 1.0.1_@babel+core@7.20.2 dev: true @@ -4867,6 +4863,11 @@ packages: engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dev: true + /diff-sequences/29.4.3: + resolution: {integrity: sha512-ofrBgwpPhCD85kMKtE9RYFFq6OC1A89oW2vvgWZNCwxrUpRUILopY7lsYyMDSjc8g6U6aiO0Qubg6r4Wgt5ZnA==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dev: true + /diff/4.0.2: resolution: {integrity: sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==} engines: {node: '>=0.3.1'} @@ -5719,6 +5720,17 @@ packages: jest-util: 29.3.1 dev: true + /expect/29.5.0: + resolution: {integrity: sha512-yM7xqUrCO2JdpFo4XpM82t+PJBFybdqoQuJLDGeDX2ij8NZzqRHyu3Hp188/JX7SWqud+7t4MUdvcgGBICMHZg==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + '@jest/expect-utils': 29.5.0 + jest-get-type: 29.4.3 + jest-matcher-utils: 29.5.0 + jest-message-util: 29.5.0 + jest-util: 29.5.0 + dev: true + /extendable-error/0.1.7: resolution: {integrity: sha512-UOiS2in6/Q0FK0R0q6UY9vYpQ21mr/Qn1KOnte7vsACuNJf514WvCCUHSRCPcgjPT2bAhNIJdlE6bVap1GKmeg==} dev: true @@ -6650,43 +6662,44 @@ packages: resolution: {integrity: sha512-QZ9qOMdF+QLHxy1QIpUHUU1D5pS2CG2P69LF6L6CPjPYA/XMOmKV3PZpawHoAjHNyB0swdVTRxdYT4tbBbxqwg==} dev: true - /jest-changed-files/29.2.0: - resolution: {integrity: sha512-qPVmLLyBmvF5HJrY7krDisx6Voi8DmlV3GZYX0aFNbaQsZeoz1hfxcCMbqDGuQCxU1dJy9eYc2xscE8QrCCYaA==} + /jest-changed-files/29.5.0: + resolution: {integrity: sha512-IFG34IUMUaNBIxjQXF/iu7g6EcdMrGRRxaUSw92I/2g2YC6vCdTltl4nHvt7Ci5nSJwXIkCu8Ka1DKF+X7Z1Ag==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: execa: 5.1.1 p-limit: 3.1.0 dev: true - /jest-circus/29.3.1: - resolution: {integrity: sha512-wpr26sEvwb3qQQbdlmei+gzp6yoSSoSL6GsLPxnuayZSMrSd5Ka7IjAvatpIernBvT2+Ic6RLTg+jSebScmasg==} + /jest-circus/29.5.0: + resolution: {integrity: sha512-gq/ongqeQKAplVxqJmbeUOJJKkW3dDNPY8PjhJ5G0lBRvu0e3EWGxGy5cI4LAGA7gV2UHCtWBI4EMXK8c9nQKA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/environment': 29.3.1 - '@jest/expect': 29.3.1 - '@jest/test-result': 29.3.1 - '@jest/types': 29.4.3 - '@types/node': 18.11.9 + '@jest/environment': 29.5.0 + '@jest/expect': 29.5.0 + '@jest/test-result': 29.5.0 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 chalk: 4.1.2 co: 4.6.0 dedent: 0.7.0 is-generator-fn: 2.1.0 - jest-each: 29.3.1 - jest-matcher-utils: 29.3.1 - jest-message-util: 29.3.1 - jest-runtime: 29.3.1 - jest-snapshot: 29.3.1 - jest-util: 29.3.1 + jest-each: 29.5.0 + jest-matcher-utils: 29.5.0 + jest-message-util: 29.5.0 + jest-runtime: 29.5.0 + jest-snapshot: 29.5.0 + jest-util: 29.5.0 p-limit: 3.1.0 - pretty-format: 29.3.1 + pretty-format: 29.5.0 + pure-rand: 6.0.1 slash: 3.0.0 stack-utils: 2.0.6 transitivePeerDependencies: - supports-color dev: true - /jest-cli/29.3.1_t5wpzltkkzdw6ng6jmtbqvsf2q: - resolution: {integrity: sha512-TO/ewvwyvPOiBBuWZ0gm04z3WWP8TIK8acgPzE4IxgsLKQgb377NYGrQLc3Wl/7ndWzIH2CDNNsUjGxwLL43VQ==} + /jest-cli/29.5.0_t5wpzltkkzdw6ng6jmtbqvsf2q: + resolution: {integrity: sha512-L1KcP1l4HtfwdxXNFCL5bmUbLQiKrakMUriBEcc1Vfz6gx31ORKdreuWvmQVBit+1ss9NNR3yxjwfwzZNdQXJw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} hasBin: true peerDependencies: @@ -6695,16 +6708,16 @@ packages: node-notifier: optional: true dependencies: - '@jest/core': 29.3.1_ts-node@10.9.1 - '@jest/test-result': 29.3.1 - '@jest/types': 29.4.3 + '@jest/core': 29.5.0_ts-node@10.9.1 + '@jest/test-result': 29.5.0 + '@jest/types': 29.5.0 chalk: 4.1.2 exit: 0.1.2 graceful-fs: 4.2.10 import-local: 3.1.0 - jest-config: 29.3.1_t5wpzltkkzdw6ng6jmtbqvsf2q - jest-util: 29.3.1 - jest-validate: 29.3.1 + jest-config: 29.5.0_t5wpzltkkzdw6ng6jmtbqvsf2q + jest-util: 29.5.0 + jest-validate: 29.5.0 prompts: 2.4.2 yargs: 17.6.2 transitivePeerDependencies: @@ -6713,8 +6726,8 @@ packages: - ts-node dev: true - /jest-config/29.3.1_odkjkoia5xunhxkdrka32ib6vi: - resolution: {integrity: sha512-y0tFHdj2WnTEhxmGUK1T7fgLen7YK4RtfvpLFBXfQkh2eMJAQq24Vx9472lvn5wg0MAO6B+iPfJfzdR9hJYalg==} + /jest-config/29.5.0_t5wpzltkkzdw6ng6jmtbqvsf2q: + resolution: {integrity: sha512-kvDUKBnNJPNBmFFOhDbm59iu1Fii1Q6SxyhXfvylq3UTHbg6o7j/g8k2dZyXWLvfdKB1vAPxNZnMgtKJcmu3kA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} peerDependencies: '@types/node': '*' @@ -6726,26 +6739,26 @@ packages: optional: true dependencies: '@babel/core': 7.20.2 - '@jest/test-sequencer': 29.3.1 - '@jest/types': 29.4.3 - '@types/node': 18.11.9 - babel-jest: 29.3.1_@babel+core@7.20.2 + '@jest/test-sequencer': 29.5.0 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 + babel-jest: 29.5.0_@babel+core@7.20.2 chalk: 4.1.2 ci-info: 3.7.0 deepmerge: 4.2.2 glob: 7.2.3 graceful-fs: 4.2.10 - jest-circus: 29.3.1 - jest-environment-node: 29.3.1 - jest-get-type: 29.2.0 - jest-regex-util: 29.2.0 - jest-resolve: 29.3.1 - jest-runner: 29.3.1 - jest-util: 29.3.1 - jest-validate: 29.3.1 + jest-circus: 29.5.0 + jest-environment-node: 29.5.0 + jest-get-type: 29.4.3 + jest-regex-util: 29.4.3 + jest-resolve: 29.5.0 + jest-runner: 29.5.0 + jest-util: 29.5.0 + jest-validate: 29.5.0 micromatch: 4.0.5 parse-json: 5.2.0 - pretty-format: 29.3.1 + pretty-format: 29.5.0 slash: 3.0.0 strip-json-comments: 3.1.1 ts-node: 10.9.1_kluoused5zacjtflizwvdqgpom @@ -6753,84 +6766,54 @@ packages: - supports-color dev: true - /jest-config/29.3.1_t5wpzltkkzdw6ng6jmtbqvsf2q: - resolution: {integrity: sha512-y0tFHdj2WnTEhxmGUK1T7fgLen7YK4RtfvpLFBXfQkh2eMJAQq24Vx9472lvn5wg0MAO6B+iPfJfzdR9hJYalg==} + /jest-diff/29.3.1: + resolution: {integrity: sha512-vU8vyiO7568tmin2lA3r2DP8oRvzhvRcD4DjpXc6uGveQodyk7CKLhQlCSiwgx3g0pFaE88/KLZ0yaTWMc4Uiw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} - peerDependencies: - '@types/node': '*' - ts-node: '>=9.0.0' - peerDependenciesMeta: - '@types/node': - optional: true - ts-node: - optional: true dependencies: - '@babel/core': 7.20.2 - '@jest/test-sequencer': 29.3.1 - '@jest/types': 29.4.3 - '@types/node': 14.18.33 - babel-jest: 29.3.1_@babel+core@7.20.2 chalk: 4.1.2 - ci-info: 3.7.0 - deepmerge: 4.2.2 - glob: 7.2.3 - graceful-fs: 4.2.10 - jest-circus: 29.3.1 - jest-environment-node: 29.3.1 + diff-sequences: 29.3.1 jest-get-type: 29.2.0 - jest-regex-util: 29.2.0 - jest-resolve: 29.3.1 - jest-runner: 29.3.1 - jest-util: 29.3.1 - jest-validate: 29.3.1 - micromatch: 4.0.5 - parse-json: 5.2.0 pretty-format: 29.3.1 - slash: 3.0.0 - strip-json-comments: 3.1.1 - ts-node: 10.9.1_kluoused5zacjtflizwvdqgpom - transitivePeerDependencies: - - supports-color dev: true - /jest-diff/29.3.1: - resolution: {integrity: sha512-vU8vyiO7568tmin2lA3r2DP8oRvzhvRcD4DjpXc6uGveQodyk7CKLhQlCSiwgx3g0pFaE88/KLZ0yaTWMc4Uiw==} + /jest-diff/29.5.0: + resolution: {integrity: sha512-LtxijLLZBduXnHSniy0WMdaHjmQnt3g5sa16W4p0HqukYTTsyTW3GD1q41TyGl5YFXj/5B2U6dlh5FM1LIMgxw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: chalk: 4.1.2 - diff-sequences: 29.3.1 - jest-get-type: 29.2.0 - pretty-format: 29.3.1 + diff-sequences: 29.4.3 + jest-get-type: 29.4.3 + pretty-format: 29.5.0 dev: true - /jest-docblock/29.2.0: - resolution: {integrity: sha512-bkxUsxTgWQGbXV5IENmfiIuqZhJcyvF7tU4zJ/7ioTutdz4ToB5Yx6JOFBpgI+TphRY4lhOyCWGNH/QFQh5T6A==} + /jest-docblock/29.4.3: + resolution: {integrity: sha512-fzdTftThczeSD9nZ3fzA/4KkHtnmllawWrXO69vtI+L9WjEIuXWs4AmyME7lN5hU7dB0sHhuPfcKofRsUb/2Fg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: detect-newline: 3.1.0 dev: true - /jest-each/29.3.1: - resolution: {integrity: sha512-qrZH7PmFB9rEzCSl00BWjZYuS1BSOH8lLuC0azQE9lQrAx3PWGKHTDudQiOSwIy5dGAJh7KA0ScYlCP7JxvFYA==} + /jest-each/29.5.0: + resolution: {integrity: sha512-HM5kIJ1BTnVt+DQZ2ALp3rzXEl+g726csObrW/jpEGl+CDSSQpOJJX2KE/vEg8cxcMXdyEPu6U4QX5eruQv5hA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/types': 29.4.3 + '@jest/types': 29.5.0 chalk: 4.1.2 - jest-get-type: 29.2.0 - jest-util: 29.3.1 - pretty-format: 29.3.1 + jest-get-type: 29.4.3 + jest-util: 29.5.0 + pretty-format: 29.5.0 dev: true - /jest-environment-node/29.3.1: - resolution: {integrity: sha512-xm2THL18Xf5sIHoU7OThBPtuH6Lerd+Y1NLYiZJlkE3hbE+7N7r8uvHIl/FkZ5ymKXJe/11SQuf3fv4v6rUMag==} + /jest-environment-node/29.5.0: + resolution: {integrity: sha512-ExxuIK/+yQ+6PRGaHkKewYtg6hto2uGCgvKdb2nfJfKXgZ17DfXjvbZ+jA1Qt9A8EQSfPnt5FKIfnOO3u1h9qw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/environment': 29.3.1 - '@jest/fake-timers': 29.3.1 - '@jest/types': 29.4.3 - '@types/node': 18.11.9 - jest-mock: 29.3.1 - jest-util: 29.3.1 + '@jest/environment': 29.5.0 + '@jest/fake-timers': 29.5.0 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 + jest-mock: 29.5.0 + jest-util: 29.5.0 dev: true /jest-get-type/29.2.0: @@ -6838,31 +6821,36 @@ packages: engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dev: true - /jest-haste-map/29.3.1: - resolution: {integrity: sha512-/FFtvoG1xjbbPXQLFef+WSU4yrc0fc0Dds6aRPBojUid7qlPqZvxdUBA03HW0fnVHXVCnCdkuoghYItKNzc/0A==} + /jest-get-type/29.4.3: + resolution: {integrity: sha512-J5Xez4nRRMjk8emnTpWrlkyb9pfRQQanDrvWHhsR1+VUfbwxi30eVcZFlcdGInRibU4G5LwHXpI7IRHU0CY+gg==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dev: true + + /jest-haste-map/29.5.0: + resolution: {integrity: sha512-IspOPnnBro8YfVYSw6yDRKh/TiCdRngjxeacCps1cQ9cgVN6+10JUcuJ1EabrgYLOATsIAigxA0rLR9x/YlrSA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/types': 29.4.3 + '@jest/types': 29.5.0 '@types/graceful-fs': 4.1.5 - '@types/node': 18.11.9 + '@types/node': 14.18.33 anymatch: 3.1.3 fb-watchman: 2.0.2 graceful-fs: 4.2.10 - jest-regex-util: 29.2.0 - jest-util: 29.3.1 - jest-worker: 29.3.1 + jest-regex-util: 29.4.3 + jest-util: 29.5.0 + jest-worker: 29.5.0 micromatch: 4.0.5 walker: 1.0.8 optionalDependencies: fsevents: 2.3.2 dev: true - /jest-leak-detector/29.3.1: - resolution: {integrity: sha512-3DA/VVXj4zFOPagGkuqHnSQf1GZBmmlagpguxEERO6Pla2g84Q1MaVIB3YMxgUaFIaYag8ZnTyQgiZ35YEqAQA==} + /jest-leak-detector/29.5.0: + resolution: {integrity: sha512-u9YdeeVnghBUtpN5mVxjID7KbkKE1QU4f6uUwuxiY0vYRi9BUCLKlPEZfDGR67ofdFmDz9oPAy2G92Ujrntmow==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - jest-get-type: 29.2.0 - pretty-format: 29.3.1 + jest-get-type: 29.4.3 + pretty-format: 29.5.0 dev: true /jest-matcher-utils/29.3.1: @@ -6875,12 +6863,22 @@ packages: pretty-format: 29.3.1 dev: true + /jest-matcher-utils/29.5.0: + resolution: {integrity: sha512-lecRtgm/rjIK0CQ7LPQwzCs2VwW6WAahA55YBuI+xqmhm7LAaxokSB8C97yJeYyT+HvQkH741StzpU41wohhWw==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + chalk: 4.1.2 + jest-diff: 29.5.0 + jest-get-type: 29.4.3 + pretty-format: 29.5.0 + dev: true + /jest-message-util/29.3.1: resolution: {integrity: sha512-lMJTbgNcDm5z+6KDxWtqOFWlGQxD6XaYwBqHR8kmpkP+WWWG90I35kdtQHY67Ay5CSuydkTBbJG+tH9JShFCyA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@babel/code-frame': 7.18.6 - '@jest/types': 29.4.3 + '@jest/types': 29.5.0 '@types/stack-utils': 2.0.1 chalk: 4.1.2 graceful-fs: 4.2.10 @@ -6890,16 +6888,31 @@ packages: stack-utils: 2.0.6 dev: true - /jest-mock/29.3.1: - resolution: {integrity: sha512-H8/qFDtDVMFvFP4X8NuOT3XRDzOUTz+FeACjufHzsOIBAxivLqkB1PoLCaJx9iPPQ8dZThHPp/G3WRWyMgA3JA==} + /jest-message-util/29.5.0: + resolution: {integrity: sha512-Kijeg9Dag6CKtIDA7O21zNTACqD5MD/8HfIV8pdD94vFyFuer52SigdC3IQMhab3vACxXMiFk+yMHNdbqtyTGA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/types': 29.4.3 - '@types/node': 18.11.9 - jest-util: 29.3.1 + '@babel/code-frame': 7.18.6 + '@jest/types': 29.5.0 + '@types/stack-utils': 2.0.1 + chalk: 4.1.2 + graceful-fs: 4.2.10 + micromatch: 4.0.5 + pretty-format: 29.5.0 + slash: 3.0.0 + stack-utils: 2.0.6 dev: true - /jest-pnp-resolver/1.2.3_jest-resolve@29.3.1: + /jest-mock/29.5.0: + resolution: {integrity: sha512-GqOzvdWDE4fAV2bWQLQCkujxYWL7RxjCnj71b5VhDAGOevB3qj3Ovg26A5NI84ZpODxyzaozXLOh2NCgkbvyaw==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + '@jest/types': 29.5.0 + '@types/node': 14.18.33 + jest-util: 29.5.0 + dev: true + + /jest-pnp-resolver/1.2.3_jest-resolve@29.5.0: resolution: {integrity: sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w==} engines: {node: '>=6'} peerDependencies: @@ -6908,100 +6921,100 @@ packages: jest-resolve: optional: true dependencies: - jest-resolve: 29.3.1 + jest-resolve: 29.5.0 dev: true - /jest-regex-util/29.2.0: - resolution: {integrity: sha512-6yXn0kg2JXzH30cr2NlThF+70iuO/3irbaB4mh5WyqNIvLLP+B6sFdluO1/1RJmslyh/f9osnefECflHvTbwVA==} + /jest-regex-util/29.4.3: + resolution: {integrity: sha512-O4FglZaMmWXbGHSQInfXewIsd1LMn9p3ZXB/6r4FOkyhX2/iP/soMG98jGvk/A3HAN78+5VWcBGO0BJAPRh4kg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dev: true - /jest-resolve-dependencies/29.3.1: - resolution: {integrity: sha512-Vk0cYq0byRw2WluNmNWGqPeRnZ3p3hHmjJMp2dyyZeYIfiBskwq4rpiuGFR6QGAdbj58WC7HN4hQHjf2mpvrLA==} + /jest-resolve-dependencies/29.5.0: + resolution: {integrity: sha512-sjV3GFr0hDJMBpYeUuGduP+YeCRbd7S/ck6IvL3kQ9cpySYKqcqhdLLC2rFwrcL7tz5vYibomBrsFYWkIGGjOg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - jest-regex-util: 29.2.0 - jest-snapshot: 29.3.1 + jest-regex-util: 29.4.3 + jest-snapshot: 29.5.0 transitivePeerDependencies: - supports-color dev: true - /jest-resolve/29.3.1: - resolution: {integrity: sha512-amXJgH/Ng712w3Uz5gqzFBBjxV8WFLSmNjoreBGMqxgCz5cH7swmBZzgBaCIOsvb0NbpJ0vgaSFdJqMdT+rADw==} + /jest-resolve/29.5.0: + resolution: {integrity: sha512-1TzxJ37FQq7J10jPtQjcc+MkCkE3GBpBecsSUWJ0qZNJpmg6m0D9/7II03yJulm3H/fvVjgqLh/k2eYg+ui52w==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: chalk: 4.1.2 graceful-fs: 4.2.10 - jest-haste-map: 29.3.1 - jest-pnp-resolver: 1.2.3_jest-resolve@29.3.1 - jest-util: 29.3.1 - jest-validate: 29.3.1 + jest-haste-map: 29.5.0 + jest-pnp-resolver: 1.2.3_jest-resolve@29.5.0 + jest-util: 29.5.0 + jest-validate: 29.5.0 resolve: 1.22.1 - resolve.exports: 1.1.0 + resolve.exports: 2.0.2 slash: 3.0.0 dev: true - /jest-runner/29.3.1: - resolution: {integrity: sha512-oFvcwRNrKMtE6u9+AQPMATxFcTySyKfLhvso7Sdk/rNpbhg4g2GAGCopiInk1OP4q6gz3n6MajW4+fnHWlU3bA==} + /jest-runner/29.5.0: + resolution: {integrity: sha512-m7b6ypERhFghJsslMLhydaXBiLf7+jXy8FwGRHO3BGV1mcQpPbwiqiKUR2zU2NJuNeMenJmlFZCsIqzJCTeGLQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/console': 29.3.1 - '@jest/environment': 29.3.1 - '@jest/test-result': 29.3.1 - '@jest/transform': 29.3.1 - '@jest/types': 29.4.3 - '@types/node': 18.11.9 + '@jest/console': 29.5.0 + '@jest/environment': 29.5.0 + '@jest/test-result': 29.5.0 + '@jest/transform': 29.5.0 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 chalk: 4.1.2 emittery: 0.13.1 graceful-fs: 4.2.10 - jest-docblock: 29.2.0 - jest-environment-node: 29.3.1 - jest-haste-map: 29.3.1 - jest-leak-detector: 29.3.1 - jest-message-util: 29.3.1 - jest-resolve: 29.3.1 - jest-runtime: 29.3.1 - jest-util: 29.3.1 - jest-watcher: 29.3.1 - jest-worker: 29.3.1 + jest-docblock: 29.4.3 + jest-environment-node: 29.5.0 + jest-haste-map: 29.5.0 + jest-leak-detector: 29.5.0 + jest-message-util: 29.5.0 + jest-resolve: 29.5.0 + jest-runtime: 29.5.0 + jest-util: 29.5.0 + jest-watcher: 29.5.0 + jest-worker: 29.5.0 p-limit: 3.1.0 source-map-support: 0.5.13 transitivePeerDependencies: - supports-color dev: true - /jest-runtime/29.3.1: - resolution: {integrity: sha512-jLzkIxIqXwBEOZx7wx9OO9sxoZmgT2NhmQKzHQm1xwR1kNW/dn0OjxR424VwHHf1SPN6Qwlb5pp1oGCeFTQ62A==} + /jest-runtime/29.5.0: + resolution: {integrity: sha512-1Hr6Hh7bAgXQP+pln3homOiEZtCDZFqwmle7Ew2j8OlbkIu6uE3Y/etJQG8MLQs3Zy90xrp2C0BRrtPHG4zryw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/environment': 29.3.1 - '@jest/fake-timers': 29.3.1 - '@jest/globals': 29.3.1 - '@jest/source-map': 29.2.0 - '@jest/test-result': 29.3.1 - '@jest/transform': 29.3.1 - '@jest/types': 29.4.3 - '@types/node': 18.11.9 + '@jest/environment': 29.5.0 + '@jest/fake-timers': 29.5.0 + '@jest/globals': 29.5.0 + '@jest/source-map': 29.4.3 + '@jest/test-result': 29.5.0 + '@jest/transform': 29.5.0 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 chalk: 4.1.2 cjs-module-lexer: 1.2.2 collect-v8-coverage: 1.0.1 glob: 7.2.3 graceful-fs: 4.2.10 - jest-haste-map: 29.3.1 - jest-message-util: 29.3.1 - jest-mock: 29.3.1 - jest-regex-util: 29.2.0 - jest-resolve: 29.3.1 - jest-snapshot: 29.3.1 - jest-util: 29.3.1 + jest-haste-map: 29.5.0 + jest-message-util: 29.5.0 + jest-mock: 29.5.0 + jest-regex-util: 29.4.3 + jest-resolve: 29.5.0 + jest-snapshot: 29.5.0 + jest-util: 29.5.0 slash: 3.0.0 strip-bom: 4.0.0 transitivePeerDependencies: - supports-color dev: true - /jest-snapshot/29.3.1: - resolution: {integrity: sha512-+3JOc+s28upYLI2OJM4PWRGK9AgpsMs/ekNryUV0yMBClT9B1DF2u2qay8YxcQd338PPYSFNb0lsar1B49sLDA==} + /jest-snapshot/29.5.0: + resolution: {integrity: sha512-x7Wolra5V0tt3wRs3/ts3S6ciSQVypgGQlJpz2rsdQYoUKxMxPNaoHMGJN6qAuPJqS+2iQ1ZUn5kl7HCyls84g==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@babel/core': 7.20.2 @@ -7010,23 +7023,22 @@ packages: '@babel/plugin-syntax-typescript': 7.20.0_@babel+core@7.20.2 '@babel/traverse': 7.20.1 '@babel/types': 7.20.2 - '@jest/expect-utils': 29.3.1 - '@jest/transform': 29.3.1 - '@jest/types': 29.4.3 + '@jest/expect-utils': 29.5.0 + '@jest/transform': 29.5.0 + '@jest/types': 29.5.0 '@types/babel__traverse': 7.18.2 '@types/prettier': 2.7.1 babel-preset-current-node-syntax: 1.0.1_@babel+core@7.20.2 chalk: 4.1.2 - expect: 29.3.1 + expect: 29.5.0 graceful-fs: 4.2.10 - jest-diff: 29.3.1 - jest-get-type: 29.2.0 - jest-haste-map: 29.3.1 - jest-matcher-utils: 29.3.1 - jest-message-util: 29.3.1 - jest-util: 29.3.1 + jest-diff: 29.5.0 + jest-get-type: 29.4.3 + jest-matcher-utils: 29.5.0 + jest-message-util: 29.5.0 + jest-util: 29.5.0 natural-compare: 1.4.0 - pretty-format: 29.3.1 + pretty-format: 29.5.0 semver: 7.3.8 transitivePeerDependencies: - supports-color @@ -7043,52 +7055,64 @@ packages: resolution: {integrity: sha512-7YOVZaiX7RJLv76ZfHt4nbNEzzTRiMW/IiOG7ZOKmTXmoGBxUDefgMAxQubu6WPVqP5zSzAdZG0FfLcC7HOIFQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/types': 29.4.3 - '@types/node': 18.11.9 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 chalk: 4.1.2 ci-info: 3.7.0 graceful-fs: 4.2.10 picomatch: 2.3.1 dev: true - /jest-validate/29.3.1: - resolution: {integrity: sha512-N9Lr3oYR2Mpzuelp1F8negJR3YE+L1ebk1rYA5qYo9TTY3f9OWdptLoNSPP9itOCBIRBqjt/S5XHlzYglLN67g==} + /jest-util/29.5.0: + resolution: {integrity: sha512-RYMgG/MTadOr5t8KdhejfvUU82MxsCu5MF6KuDUHl+NuwzUt+Sm6jJWxTJVrDR1j5M/gJVCPKQEpWXY+yIQ6lQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/types': 29.4.3 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 + chalk: 4.1.2 + ci-info: 3.7.0 + graceful-fs: 4.2.10 + picomatch: 2.3.1 + dev: true + + /jest-validate/29.5.0: + resolution: {integrity: sha512-pC26etNIi+y3HV8A+tUGr/lph9B18GnzSRAkPaaZJIE1eFdiYm6/CewuiJQ8/RlfHd1u/8Ioi8/sJ+CmbA+zAQ==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + '@jest/types': 29.5.0 camelcase: 6.3.0 chalk: 4.1.2 - jest-get-type: 29.2.0 + jest-get-type: 29.4.3 leven: 3.1.0 - pretty-format: 29.3.1 + pretty-format: 29.5.0 dev: true - /jest-watcher/29.3.1: - resolution: {integrity: sha512-RspXG2BQFDsZSRKGCT/NiNa8RkQ1iKAjrO0//soTMWx/QUt+OcxMqMSBxz23PYGqUuWm2+m2mNNsmj0eIoOaFg==} + /jest-watcher/29.5.0: + resolution: {integrity: sha512-KmTojKcapuqYrKDpRwfqcQ3zjMlwu27SYext9pt4GlF5FUgB+7XE1mcCnSm6a4uUpFyQIkb6ZhzZvHl+jiBCiA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/test-result': 29.3.1 - '@jest/types': 29.4.3 - '@types/node': 18.11.9 + '@jest/test-result': 29.5.0 + '@jest/types': 29.5.0 + '@types/node': 14.18.33 ansi-escapes: 4.3.2 chalk: 4.1.2 emittery: 0.13.1 - jest-util: 29.3.1 + jest-util: 29.5.0 string-length: 4.0.2 dev: true - /jest-worker/29.3.1: - resolution: {integrity: sha512-lY4AnnmsEWeiXirAIA0c9SDPbuCBq8IYuDVL8PMm0MZ2PEs2yPvRA/J64QBXuZp7CYKrDM/rmNrc9/i3KJQncw==} + /jest-worker/29.5.0: + resolution: {integrity: sha512-NcrQnevGoSp4b5kg+akIpthoAFHxPBcb5P6mYPY0fUNT+sSvmtu6jlkEle3anczUKIKEbMxFimk9oTP/tpIPgA==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@types/node': 18.11.9 - jest-util: 29.3.1 + '@types/node': 14.18.33 + jest-util: 29.5.0 merge-stream: 2.0.0 supports-color: 8.1.1 dev: true - /jest/29.3.1_t5wpzltkkzdw6ng6jmtbqvsf2q: - resolution: {integrity: sha512-6iWfL5DTT0Np6UYs/y5Niu7WIfNv/wRTtN5RSXt2DIEft3dx3zPuw/3WJQBCJfmEzvDiEKwoqMbGD9n49+qLSA==} + /jest/29.5.0_t5wpzltkkzdw6ng6jmtbqvsf2q: + resolution: {integrity: sha512-juMg3he2uru1QoXX078zTa7pO85QyB9xajZc6bU+d9yEGwrKX6+vGmJQ3UdVZsvTEUARIdObzH68QItim6OSSQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} hasBin: true peerDependencies: @@ -7097,10 +7121,10 @@ packages: node-notifier: optional: true dependencies: - '@jest/core': 29.3.1_ts-node@10.9.1 - '@jest/types': 29.4.3 + '@jest/core': 29.5.0_ts-node@10.9.1 + '@jest/types': 29.5.0 import-local: 3.1.0 - jest-cli: 29.3.1_t5wpzltkkzdw6ng6jmtbqvsf2q + jest-cli: 29.5.0_t5wpzltkkzdw6ng6jmtbqvsf2q transitivePeerDependencies: - '@types/node' - supports-color @@ -8207,7 +8231,16 @@ packages: resolution: {integrity: sha512-FyLnmb1cYJV8biEIiRyzRFvs2lry7PPIvOqKVe1GCUEYg4YGmlx1qG9EJNMxArYm7piII4qb8UV1Pncq5dxmcg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@jest/schemas': 29.0.0 + '@jest/schemas': 29.4.3 + ansi-styles: 5.2.0 + react-is: 18.2.0 + dev: true + + /pretty-format/29.5.0: + resolution: {integrity: sha512-V2mGkI31qdttvTFX7Mt4efOqHXqJWMu4/r66Xh3Z3BwZaPfPJgp6/gbwoujRpPUtfEF6AUUWx3Jim3GCw5g/Qw==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + '@jest/schemas': 29.4.3 ansi-styles: 5.2.0 react-is: 18.2.0 dev: true @@ -8243,6 +8276,10 @@ packages: engines: {node: '>=6'} dev: true + /pure-rand/6.0.1: + resolution: {integrity: sha512-t+x1zEHDjBwkDGY5v5ApnZ/utcd4XYDiJsaQQoptTXgUXX95sDg1elCdJghzicm7n2mbCBJ3uYWr6M22SO19rg==} + dev: true + /pvtsutils/1.3.2: resolution: {integrity: sha512-+Ipe2iNUyrZz+8K/2IOo+kKikdtfhRKzNpQbruF2URmqPtoqAs8g3xS7TJvFF2GcPXjh7DkqMnpVveRFq4PgEQ==} dependencies: @@ -8425,8 +8462,8 @@ packages: engines: {node: '>=8'} dev: true - /resolve.exports/1.1.0: - resolution: {integrity: sha512-J1l+Zxxp4XK3LUDZ9m60LRJF/mAe4z6a4xyabPHk7pvK5t35dACV32iIjJDFeWZFfZlO29w6SZ67knR0tHzJtQ==} + /resolve.exports/2.0.2: + resolution: {integrity: sha512-X2UW6Nw3n/aMgDVy+0rSqgHlv39WZAlZrXCdnbyEiKm17DSqHX4MmQMaST3FbeWR5FTuRcUwYAziZajji0Y7mg==} engines: {node: '>=10'} dev: true @@ -9014,7 +9051,7 @@ packages: resolution: {integrity: sha512-Y/arvbn+rrz3JCKl9C4kVNfTfSm2/mEp5FSz5EsZSANGPSlQrpRI5M4PKF+mJnE52jOO90PnPSc3Ur3bTQw0gA==} dev: true - /ts-jest/29.0.3_n3m7ogz6hldwfud56c755ycyaq: + /ts-jest/29.0.3_m6msr2njuqvkwjdpknr4wbhwmm: resolution: {integrity: sha512-Ibygvmuyq1qp/z3yTh9QTwVVAbFdDy/+4BtIQR2sp6baF2SJU/8CKK/hhnGIDY2L90Az2jIqTwZPnN2p+BweiQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} hasBin: true @@ -9036,11 +9073,11 @@ packages: optional: true dependencies: '@babel/core': 7.20.2 - '@jest/types': 29.4.3 + '@jest/types': 29.5.0 bs-logger: 0.2.6 esbuild: 0.14.54 fast-json-stable-stringify: 2.1.0 - jest: 29.3.1_t5wpzltkkzdw6ng6jmtbqvsf2q + jest: 29.5.0_t5wpzltkkzdw6ng6jmtbqvsf2q jest-util: 29.3.1 json5: 2.2.1 lodash.memoize: 4.1.2 diff --git a/scripts/changeset-version-with-docs.ts b/scripts/changeset-version-with-docs.ts new file mode 100644 index 00000000000..4434505d02c --- /dev/null +++ b/scripts/changeset-version-with-docs.ts @@ -0,0 +1,12 @@ +#!/usr/bin/env node + +import sh from 'shelljs'; + +(async () => { + // Commit versions generated at pre-build step + sh.exec(`pnpm -C packages/versions prebuild`); + sh.exec(`git add packages/versions/src/lib/getSupportedVersions.ts`); + sh.exec(`git commit -m"ci(scripts): update versions"`); + + sh.exec(`changeset version`); +})(); From f70af4120def0a2823c598feef6e7107412e2fce Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Wed, 29 Mar 2023 15:44:39 -0300 Subject: [PATCH 20/23] add new logos --- apps/docs/src/public/fuels-ts-logo-dark.png | Bin 0 -> 18932 bytes apps/docs/src/public/fuels-ts-logo-light.png | Bin 0 -> 20114 bytes 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 apps/docs/src/public/fuels-ts-logo-dark.png create mode 100644 apps/docs/src/public/fuels-ts-logo-light.png diff --git a/apps/docs/src/public/fuels-ts-logo-dark.png b/apps/docs/src/public/fuels-ts-logo-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..ab9605432b798bbfa36e32a53b31002553c0c705 GIT binary patch literal 18932 zcmeIabyU<}_b)z#fJiusbfX~B4MQr80s_*4)F9nMmm;Bnpdu(Oh@cE5-AH$LcXvp` z?+obYd7kyV|9scFcisEPgUiLte(&?zd%w;;`+Z7ZKUR{($0f&wKp^yO=^XgR4Gy3pD=*qWMK!D*e`?BKL;S94Pc#C5ptv$g|6F*IPp z9+w8KvDTgPb|lV3Rl|Oiw1SN}FTsARUkY&(WBTLQPtQ_F+bhr9YQztk-WxZj?7=KT zPiEf*KGNSkIQraS{N~Wj)0EM-SWVz zTs%9ACS(ASylZ={oZ~C?yGsa<`!xxM@D9GuTa-XL~=!z~x~PQ=bXVx7Gd@4b}} z`gK2b;yi(3XvBXdt+DItJJ~)L$g&T))Aj?mN0d@k!>(-6ZcnH-}nvtedakwy@}t|Fev+%T_)!p+mfaM)k1xp7OF!vBP?T_4eK=(FRMB?a+Ru zhf8Hg{7_x%$0q~(-^24p+<7ZdbaWQV9a3{A53SSE5b@^vq#SmZ^~|%pMwtA$LThsO5x}DJ4QjX9*sm zojA$b=Z-k{CB?xjTZqKu34mtEQMDH7t=s2QbfqZp(>W~ zTVw`idOva`yVxw@qoy_@zi&Xxv85m1d$nX_-DB0Q`^!fqvANzJCGnZohv|Cw0uv4^ z)`b)H3(xz;;ioklwoll~(;1ahPO5%u^Nm}t8NZ&jQ!O(kdh|f)NtxSK%AqpToYdGl zmIc0GjDsF}OzkpLVYj+812Oq#MVkC;+dtAY*KPaQ@=j80wl!Hu%A6{-i^cobQh!*d ze%X7n%I6>7oA!t%fyVOr*vDpQjwPStVS&2C+NKU0JVY;g(NI$dtN3=;9dd0shHW8Z z#QO4%()jB~*m=0WZ~Nw&yiCWX&S=3=q*!~?`hHt~XPC-5tKYHo;VLBf6*+uRbRX7n zICJmLq2ug<`pfZ{8D!Ll&yUW1=|mg8vd*ioP^%s*72J$Px;?Xm|2!Kz)c&UT(jrpQ zS`S$hwi5qwL}-nAJpJ5*HS2LTjgfgF^^BA1#K#`xSohzVHDR5)L53e}!;*efYSt?r z2c$17T6gIFcqk(JsRx=3kN8 zpMEN%#Ux^`w5mMEH&wrPGjT*3H%1F#lX+CJxYu0Ex43uvv$nX$6PjUfE9A}3+*@2P zr^&B2^Q|o`H?%YBm*!iJw6>4ydO_5v3peF*QFBi8Y=L_yklt5 zSjThaY5CqqhDNrTu`Ap6KGgY^otfo3a+%3I2OD8r683JF8$R7lukpXxYFWrIabA(A zdQ;9ICLuRGaF;N{PV?hO<yhJ2TiEn9r$c86|n1cCMg7YC(+ z{EnaI>Nd7`gqu!gXficX=qZx}yHY%6T(B62RtvpYD2(Lx*k0=u|DZ2by%N<=G?@g+ z-v__v5ZBU?yuU z5xh*)DtpMixY?ayn~!k~Id{Vgopkf&s$@EZx#ntzU{mbbr-{u@#(|barmyec&JP(B zk)@ehM?SJvU$oWvP)K%HL6hl-dFwmX!ydd}6->)=pR8sZ?*}DT`AQY=GzCE+GkQ}b z-I+?fW%NVFIVw_phA$=LxS@;?p#r-{SPugtWY9N>8nu++=AGO;S)ci5&`Hd^Ow{&@ zI`|(Ob5F>LC#RPR)hA)Psgn7d=IAIFtnT0&bvriZ2?}=BQIx;PF!=$kwrZG@a=ovR zuE5b5<J|t;~9EJo{`x{JGjaS3-aE2DwVLJO=sQyM7hl(n&@h9am9Ve^WAydt*1g z!Yjq7a7KWkITLwx^;Q*u=#x^UMgd)YA+_?Jy}V!)x0;X$4yzsA9$muP=JMC|2;bj# z3SwQHhy0|f_Z4|LKD-iN?5KORRiwpu4T}zPWJTi^Xo;JjPuKXZM$n%hOWvuF+XZPgzo$w;H?rswg^-g*Gr4)m zJ;_E#TvLZUT%MD73}s74N5+ zeMeytgVkHg4@2yRe~;Wa9zxWPW^1{eS~VN=j7QKM=(C3jlUXq59==YyVuwXpN{>tS zx_mSD^AqcRIXCI(t6d3IXasNgW`0~BA(6iskLN!B0{i#OVH{sneRdpkRaI?9Pa12G z>T~Dy2RZ15d*-*IM@!%PzjtIl`ms~xtUl9chu=s%b($N=WpQP4B|~Ia`*P_eYWB*T;Yq$& z9e!SEfQ(1UjA2$Vjd9zz2*Do0QK>O%d;Wd-P3TWzC6^S^t$rH zc${#qwQu8*h9(&XwDrDC=<-968u%BF00t^61EB|4aN36O@7ebv(T2B$IUSiqs5q{( zue>xZ7sJL15Oaq2&=&h1Q?xC$ZQqDEsnS`t}>&F3)u8dSm~<5FRcAbA*WiRIKE{QSiVmk3k~ zBiSBPfQLT+wNJv!W$E|m4iapEj6c7DA#M|B#~D3?&Uf>J;E2dvRfn8xauZt8PsuvV z0-+OK411F%xoc^W*EC`Ad>=Hs{h8EYmhHI2IPx!~2u13kbX$z6c%?=GW`O zzE0dSRN2!fESYI5H__$`vactFm6t@$T+yw)P{sJ$bMh!~2s|H~f3b zx`{N`ZZThh16rMZip$F!1E}2ZXx3$Adah4txyv>mphI0_`@U%+@8x4?dt*h^AUomZ zdG99%(qiS=m;C3jsH(kZnTaEsYhF_kBR*Irc7I>jUVKtXcwL#6xn&X3Z)dww7!l4g#%MH=7rrzQQ7y zq5maN8)x#gGRA9siJmI0(!Vb$v#N+wxadY<11<|gw(74eUq>_2F*=?1SYwcT&*JjG z3%~9AY|S`PKGyf7F@WW{)b;f3XJwCFeCl>TAZMT95gm~kzp_sf`epJKy~;5z5lc;4 z{23A7Zw&ZH6^vFsN5MBm4MbNPMci@euB6e2%ItMj^kqxDhcfqSGiH0ARy=S@xRPdY zL*o33bKI`PWQgJ6KG2-z&9>GssQP}Fw1uyfhRfljSIV2rEKEgUk)&c=hzoAK9p zcTHoyAGBee?N>Bx&*yH=jkiy@p82rPN>Lae2oS#?>2MvU0-FtJugoPSAInQh{@q&u zI|{L0??mNlBq-~ispZq(!VV4+G)Yq;mXfB-$CXaIZsD&%^@#oSB_qE4o8aV09lK5A zoaM=BWV&BEEsnQuQHdaPiQMb+hq!D;B7*A;r5<6WF20XBc-odpv3bY%)m|5UYRY`` zMH3S$gNd>D{xiH)UiC)B%nCJH#dw`-GkWcpMN$SuBE8$i7EKymLORD z=BI+El89;dmDe=InXV`G#gjj)co z=k8gKf2ib)?a_=ZR&pf0%4&4=hSc4(q*vTlwPtV$W0z8R@)5?lBk!J(A|2*i zVLdrrlEUm!HAldCVAA+)RpEa012Mv~gf0R2i!MC4e}(0 zR>U^eZ8p{>c-qdqA%toUJ{-b{zrh|5xjESD(NcT_Gq$y6H#D&|g0s6?+kw3x2t-8O z)y~k^67EE61b=RBBTBzfT1ii9ZX!yr$*0JvXeS9bGnaFBfUCJHJu!B-G!`P!220o+29Q3poDo&Q7^jeCKX(eqP;IzE#yzHE8(yr#t z-1K6&v?2~BrZ810nLiNVn<%}Rlan2cgTuweh24dR-PYkb2bYkL5CL z;c95d!NtzWVQtOv?=2jiq@4lCABX;zEgYYKEi(>PxT7t?!5A*>47YJ&_;&~sfvO|0%Jm;6W#ttg|I-3R!Ed8eo z|LzEA{txbdX#b7mxqvb;hRN7ESQ~=wG`BW<4(G75d4BN#ML6vK zV|h_}Zg$RpNgi7nI+=n7qV$iidho>D8m{JKh+>nAUqFzbkDDK`0iqV-{+E&l z+`$oKA_|j>lbz=h7u78=5DXyJ5S6C@;GzYH1t#eLH*~Ufcw%d7B}$KSi5AuJBE4xv zE;~ie+!1KFp)&qY&a1)gFTY(50W0&1N3^sTX$vznzBJ-!=nOZxFa+9NJ~B2lw0RB( zlFFK2#o70$A0M5fEz{dv|1_84f3h@fCnFs;qjd%^Y;QWUFiSB4?>f~bR z0KfknL<*t-33L$+?cED1ng3JU#SD((iIba$jgyCsi~9+e0F0X#20D_H2gb=s&+#W< z4%Ddr8?gw-|Bn-q3x$6x1EAfd43rm8tvLQESARG|(fEJx=TBe!AG83V|7+xb#P5IU z`Y&DoBL@CQ%Ky!-|I+n8V&H$I{NL>Q-$obizZN`j8!!uU0m~WEtdwG~6v8rkC@Tdy zNBv1GPyGNSSMB7q9U&0nJE*^C@~XEtfe_nCUQrr*0RxYSlsyb>xDf)Og~&_Yf8sj4 zHl~bxI^adKIq~sx)hjBy*%aa_oYl{|Fwi=pF%UiYV7X;(CHsz%oe9XQHg^T8bTUhZg9Dd#eU-P-fsC}= z8%yhaH#ziRm&GNcL``Qx;C{=@lxWt%XDFq=$YF? z*DFAWll}B+Huc%j7|MI_9a5h{gVvvQHXFTp;Z5u|VK()N9r-)wr}w~9U;Ae9s-xWj z=ckOQZ(Gg6mvHu7@Cy&J$}o`UE>L_L_141 z|5Ix42?FG*_TzJC;3Mq>WQC>fY7{p3>>I0Tps07D!7YZ-g0_y*o%IS5M*YSCcRe7G z#u&&o@XHr@_3~@<|K+b#JeX`pn=?VjgpuOm$+qR!?WbM!`EEkDy2R)Cl$hRfGyo=i zHE^<{f3F`y#Sf)xeU9B~r*F>OugI(*xBvabCG32v0qS!Y98`G>uPr^_baVX}^Pxlb zq;J2C1T-bSnjO8})c~#BA!&hJb8y+~3pzirI1ckT{}4oT?n$=&`-_IgRA19V8`&T2 z%}Q^wEnOeex?886(yj=gCw{73n{bL0N6?pnPFf6sq}x=p9DNPmTqZm(dG<^F6{_PC zjnR=XuU-4v%5t`{B${D@ERDS_m&(-v!K+z-aTrt8j~<#c-U+|dslhPpdHg&*)scn!A`2b=EtE1eM=q_{8&!^phW>Rfd-OxQtaV7Wk2*2E<(}2 zVbHhsQe7)g?yu1SpeF2bZ+cFx{>A)1Mu2lyHJ|Ze@rpOR(hR(bVg~OekZBlp-TrIy z*L4HFx_hkA(VEriH5bHVN&EH@rDvzbZ2llejp(XLkW41Gh!O2~ruwEXSn<1EWzjvP zMsD8!mrPDAbmTX^)3;m(p@$4*Kcr9ubDE)Kf;a7_i|i*CUupK?p!yX{*|#r1pq(7! zt;`?q4TvzctcyJR@3H>4`G+!6KpBM+Wg%`b=!VO7GQch3^lZV9ziut!WDgtNB31_G zF8Y&G0UgP&?O!*8^QXH)A|dIDfaH_kWHVI@|KKS4_7!YYTH$Hk_-jlQO@pNE;7WS7 zjIyhGx&B3n$xKzt)&8~=eq4WjO1upuLuyct1a1Q3+kcE!p`jx)pL+F?hHOP&%OYSx zCB-BZ$h7?V*#9PxNB|`Lp@w1T0_-1^tC(7PKXEM&{(9w#i>5JvtS0}Re@mZA3B_I& z9Z(VWP?!;u`it{~wyOD8-v+7QeLdwV^*g9sfZV%bFgIEKIS8a>&Go;L+hL+3pMu;X z-HrRh7DV=TRdd~3u7=^>=f9#33Ez*wHybjlms$Q~10?<(goO#{g#FdAylya8dk^XT zH{lHw(UGHC{(Xdhed+}uF*h3+ypKcd8~=gkgBr{&9&=FmJ^h=Ej~UQ3GTY8w&Qt6g zLpOgMo!mmD->?TDrMxcfpMg;0s9B{^`Lx=twb;Xry`4e^L)s?T#i(Cy0ph z?*A1<0@3t#OMRmJU!R;LeEUd9+NELzZ78Gv@ktg_%L^3WT8j4SAOFxy1vABQpWPk` z6893AKEp6p!M<>h`<*I`26~gh{Rae~zLQz7<(xc{^RDV&}@!G-m)LBUo1HL70uJ_6w`&+c5Lbs*^G1mz3vxDl<_ zcL)148N7cl)K8huFqFY!fxa(RO2jvO@!F)jZ~Wf{7~VA48yZq;QP&dpn9vddn5Y`) zJ3kg0WbRjat}3-kZc56pi*vlboL)a^Z%ls)0`ZN%Zm>6Iaf|rjUy65wAeK1D>LX9e zzm=+!2OUY5jr-75{o{q7)He+9>-H-|#|PN|W`*+A?11U&&-Pe1|AF}gv6N%46v-T5 z`K#0clx8mmNW+$n|DR$)3PI}+j}@fesvnxFRQgK~)&pNY-lz@&k6V#{^B=>Z^*Uaw z#VrjQ$*7tOa)0IOM2LgQg(;?%q|>2QZ9)Zw{rN9D{SOySkj9mF-#7+<)ZR9}Hgz3; zjg|EubOm3&CsEip4E_!YP6Kr07nr>W2*JA&>mM~GUp^Df%AT185a&f5t-`^{4p_bD zqUDJlVtw_>ii<9ik?`en(tNfyvGY&O2%_Y{#BllD>u{^TW4zG`fci7T&h~=- z;ez)w%Z3vV@hT*>A#3Cv^^Ykfu<3_7D3Dn$0AFpFuM~G{xD(q+l5DD?&o}GM!;UVNQDW}DV)77ml<`fziotuL*_Ih#P~_l>&;p|BE9sVGB4E4L-gB~ z6qYaynU=G8dbHxzpYO580oU5*a-mFbU3LclX|0n{vg|0y6&f_coI)`-HH{QtVq{J! zq@OmOMHDDe?aXHK^e(DUjZ+y=*+e3WrtbAHqV*46j=0}6niqw_H{IRrZRw+4z&^T>YRGc)^m|Pk+Q5_tb4qX~zcq+jWh6cO@`Wkr?&u^yuSA%~ z^-~&N?#306Q#$pOwbyXL*+#@>_IPTHPtnDTh z^|rC9%O=?N>7PF=7?Nl}2>!NqQbWjn03ErXL9(oewwpZgN>lmNY_D(b;G|W5eSU{7JT4>=T}203_HXY(!t!h@%}9ITo| zdSWBvJL_t$`M8;9XX0#{X^IsV<7jpf^NTuo`x>jVIdfI(9BrX%q%PTqX%rgET`z){ zH?JY9lb{WFXwaNdnS+F9!3Sq8P@mnNpvn{J+UXB9=cQ4~(w-Y5P?Gk%W6$I3`id3g zTVp=?loaV15LcPGFGa#K(>w#J3gB(niZ3lC^>pcAi)60j*9zC`piBbC_*w_yl;|%R z`-|pMR)`bcd29=NIQf{rMNdSxh6+)sDGuU>!Im^rLfAppxeb~AX_!yYLFqGgpLKDq zv*Vi$QQ{Nsbkn61tMi*%2`BW^WBXB4+DhI#6fIkVhn}^SXCwrs*oo}6@J`YUZw<6x z%c;TPMu`3{p-{)+<;44XQnhhGgTXo$c~i_$7L%@J(w4nfEji3vz~UQTO(a-= zQ?+wv)>wjT&+dVnN1p3b^;<4`MVH(f63cydYVY6%Szh#|(SMV5ezp!FKO`hSgNTF$t(2c$ z^9qF@!6BfEE@(Oly0{-6HOtKS#Zn|Uh%97id9R3B&m0m<+h@M8w>{!n3`SV_uy(i| z75UriN9;_ShVGPvmYVZ(i#Pt>*nFsGrD?h4<*rguUmo8#WurnA^#p>*LB9rx{MNN0 zDeIzF{R{YPZ*lEzGnPZ4h}MY?t7bJXd^J6rU)MFnO{z>kb23d@g=id1eq-!4{GBSla zDaS&BqNdGsL*nZ`+3HTn%y@op-(0Rb(IS%Gau+&}b`nd}j$sq2FJ`pSQ8{aO%o)`m zj9|B2tb(A{?c2FM)yAXDZ>FEBx$Lm`Y&^slkd2um?&7j2VIH+MM2xI-Sv7vQ|7M=5 zn^seA@%1U$o;%V7YtRt0saMAL3MBkpq{g!`<~K&^O9QI>vI|K=;nU4>sm)E_7UUl8 zBscBY>u)`lTUDx>k`Vt-n~%+CFo&Zd>B4?gf^s{iKi2LF4&Zb>)VIlH@hS;Cvjf zi*fOtV|#@2d6js&B<#W)*$;tZ?JE@{lRQP#ZJ1gVYy$4a+1mVhp)3>=3;5txWI0=O zrEV(htAG_9CZw^!68~&{MX$1GTO^9{!8iFlN8#gGUaEe*CvQ88EdwB8OsEhg6wG;| zg$K;^sk>wRbn#Ee+ukXD{)T}B4i_|IB5;bcQJFv(1F*DZvK)!qkoR2SCOdHIwh8!# zi~=+Fp!;w!nArr7yl)>VX&I|p$zCd5)qBX?7Mx^93Ii)RU_|l*TI&c|dHZRA_r_rR zucPdghGH-or=l8%(B6!J+ItvenG?JDk9aw8L=$F%s;!~0WGXf4panBFy+#L-5W{y+ z`|arV4qny!1cRTd%hP-(+D5t-n>l489Utz??D?<85dKifFp7H2juagsb7f}v~RuM?6@kY(~DP_r5KG-8jb*N78S z3j!IlpM@HTTHJWRh9v_Q>&FRFWyge28gEMb z^A}r-!4oGkwf;QyXukZhoS6Ba-Y(SZJ)s}8h1Xl=wBK*v2LJ-m!`JFB;Lx>_KF32?_HS5&AZP$C~(F7Q2 zrV2ebZDndbM7<|GpHfxagnBH8$AXQB&C9K+m+2K?GS8GCK+MS=yp3JL$%mQGXOyf; zJ@3sDkgMo~;M~(F<~HG=A7_7K)UnGrgPLk?HdifgHot%o-RluT(-;#w5}YnPvntjL zKZEN3`m{zOZQst>SrE}(d$(6OURovOUI=K+l(MU^YkaLoLm2>U01(SdhO9IaLl@cPTq|M#b9K38XK#mf#q9VdU z6>DL^XfVAv6>6_b)qM+1BkpW7wK~1x23QQA+Qcs~n8j-rG-Dk_vxLD`^9VM6NDkkw z`q5Il!9i%9>H{_=oGdMH(sJCqnFGpitR%)obYpA02-l`sZ*YBp{0{pHR_7%r2MhIy zVL-PkJ9@!wNTfq{`+ce*AMs(|ly?ZrBmKUqf^=mtjX)eWO;GqQC^at9-$NuHfb2v#W@MQz;+%jjiaOlM%xZp0Irb^SRmITx~(-6 zT9@ru0(?IB`#HbT;+6JQ4-BIm9cKYl7>MBSBJaK-k?obR)qX7Lr5Jud=)B+nUb(~;h?&o{e=ziBv+bW74oKlK!+iLMl zYTI_ddQ$Uf;v)w2sJ=z;TQ9)%&{+dyU9W^Ehc2!Y=z9s`xl~To8ya1~rQ+|2$ti0Y zHkDOw<9|@E9~c8a)eBj#=!M?SEm*)q^8>xn*q2w+AU5W=HDr6RZyWv6sqYaO6S-hP z3*9nua+GcD$;4#Hs?k;<5|&meBZYDxo&=sz8(9OJpu;wi!&;wvZne-_R@Mc^lY1Q?3HAwlr^@OAiErof0~%<{(6wYK(E1PG>W?UeW!4CT zf~fh(k=r710T>~I7V5Y+epdNPbrpzR5y-{z**8^? z-;uDv-*wJ&VpJ+7zjmGzNC zQDA$-RG6&91Shel0}>qMnwwG?l`0d9D7r>>3OXpQhd%n;*(o<;#4L*Dy^DLl)M{!( zbQu9yBnmhdQ5Y(iuT+)kiYB;8v5vCkV}+aKVDDYeF(+KdBhPVpNQ4Sy*SC z9G0s#b^g5XKrzg9&GzHMJ^Vi2_#0<^PZB=R@qec3aML*`O{r@bwkjg%NR1c=)89Uv zAxA9YQ;;;I)z|}T+nzs$KTfIJVuU!1$bAT0QX;o0BPbOE@7J7PfrDzPmK|a2%c)Ci zEgD{U6HCN2mi-Sztq`06ih;hz-ea7$1q&ik%~(X3m{$X`k*NI4sXRW_F}|w!PnxbZEQ3FQb}iUDgh2RNXh4 zudx)?R_1YTQ5&PD#MCni3g0twvrRF6)R^bpjQlRyKY!h2o3RYttY@Ta6>VBM_ZC!_ zImL~&GNqj489^^&4&HtKPgKBJO`!udh`)Su>+T-y6kPZc>evW&JPJi1zA%F~_iw>+u@hxOz_DJez3yZF-w17N>pV;yzpI7KpX`r09kd zYhmU%%bV#Fp8hHCyj;YojKY$X)aVaK_QHcJHOo6!P@_B^q^=%seQty*1&eUnw+wYH z7TuhuR|JBCgrQu*3T7(aA1ZG_v!ss~-s#Z{jhgXTjlY@ubv_UVW1{Af{WiBVZsUer z950(|h>^+XknDH!DIcHq7*jetdn!w16T#=2Q@3I-d-X9k8u1}G-*Nh$p)O9DbP{mx z&RY0A&)l&u;v);*e9mZhaS(?MMsx)J^y@`u-GvOs0&!C@0aJMApvI0!=r-~PcqOqG zQlO@3K61$-ujlSXg)TA4SOMuJ*WO@6@|xyKk6jevsfYa1v7D%o9Lj zuvYIt(X>_}x|MX-=37LGnV^P-qH?A#Y+){zDtU#fEqEvWFkDqf&rdeyT;7w~&RJAu zc1xe1qeC#(^kA32rIIN?BM?-aCxN^1kYG=M>tM#Mv9R)#va@CRxZnRFbW4A5_;9e^ z%ql&Lpx0s~T|C}|+%4dS#Ncm8y*icmcbby%@iVOUnW`aImE1SU8f% zY|E^CL$!BZSf;`Y*~_SB@N?KdjxZk@Ww7&haD~k^ zi#&h1m-v>)Qz@(WN#KHve&Bx6F~%AhCmJz0T0qT|npl6Yb3Q=&<-S)bo zf>1UiGX1q5%}njVhe0t59)`N+3G>UW+s6(jl2rYwfiVwEqHk9v>4CB*<}P}aE4tLL z)n3V5c=PQPWW$ZM=CxjmRao6>`(1CrB zx4Zew`nzA5D|iYV1)8(hyL~BAv{`Fd7KEw3xUs*P2LG=>oK(WRy9!YO{_p*bkD~?U zHoe+`&@I&vI?LzTVZ^xy6!)V(_7^|4qkR z2ak4)gaasS+KtJq){DB!+Olj_&dPU9SqtwI<`6t{D7+7*tVwPF?F%mj zAVWW_tRREU=x}YLy)mn;OoYS|=S3aT>W%Z0vEdz~LOh&+pSUI}73XD7;*)D3z_JK@fg}((G2oA*<){@nZf^=ouFAPLON)Q$z~$ z4=&ofnlE-w+5Jo5*-OqHOme3NT*Z#g@A$#Ks-d$+gHu~lhZ-(Wdg^{o znH|?0SoD2dgDcxa6wpuCEy{-T1;U%6b!%mUOQxkknNG=n#D+Uu!f#`2|uK9*q^@7SMFu)1Ds_S=djBT-nq=)XyMj0_WBQ=*T-$w@i*+ zEBi`E(zI3{yr>l@FXjvSfDt;?wB6D40?PuLFhP9geb}+H-QhLh7`|hqqkq2i!bi-$ zaWn|S@R!BgR=y@)PH|1goy5N5P9q%0^>_OVOD{@QH1> z8@-tL#LcJA=kVgt7y@Ig znr;GbJaDvxg{dV1sw(){_zDutacQ0m3U)j%kZ5_(S;a0Jao?^olD{xyqTuU)*(4fb zxq68+5B7?|L;~QrgQFsiOE;K+@b;xp%9oG-QurJQQOhx)Dd)>ad?`!?LhwdF2_J!z zrc2=hIQF{4!~&R4E`$cOKzNCX1u%Ipg$6))iHQX;i7thSKzNCX^~kr+&QZ)-L(=+=saGiq_59|@(WcebAO6^Yw=j%a`q<{k|C2uemOn$H190Mzylnr?I z@x9gTu9$oc(xyEB)hYpyBn__+S9KCCm7oF%sKsUVz0d4CbKvud3|yu%kV96XllGP# ziR*fS%*V^>)kAf=?26(847pYM%31Ea#y<_kc zCA>(DdRZW(xDdvogn%1xBSCAK}0iIr_h7`E##SJDT5C}M2Lo)#j zXb8kE9CD2owS@ukl?8jqKj~19T`AFsC5SJ2UYWiMeGzpe4w*CuKyep2MhSL{JIPRH zByIsSN*6a?e%vrX%eyESc0@p^abf$d0?@p?Uz2+sJb!?)xrqcwp%>#Fi3;s53aP3D zCA_FHy;Gm)AZ8K@w)F!(c0Ce+NTjmwmB;BuP(qpt>dGy@&pAMr7RdGrf?zfx?l|3f zcoBfR_KPdo1xC=Nsl9_}HdIo8i4PhwIY^u6+>`n3`L9s}AmarlH(B3&s!LreS$hct zZGd%3|49&HA_6#GL&OCx2d*6qXE`SiYLi|E%s2yPDiXD%zPf#NWl99T)?9PWXBsFE7r%Y;{!KJAwA+#rqKar}m<4EP z=x?uI10yxXv07l<%?+Cij>vOgzC!c3GPmn}>N#G!FR7T*rkKs6+$CpK z-q;zvl$`7}<=eG)a*FMJR(Mux>AX5?KF7Hcn?$Od-1X<{iO}>cr$bFkwBM44bI7{D zsJ$lna=72*tw+Ihn}(jE+boeYh16BIwvi=OC2BPjqh7*OTghC1>~=HyrXJi_pG-bO zKHdFblSnWNr*xfEa=Rk2E5+hi^KkMC7Q}|ZLvCe>p4O9^lCrk74~Y}#)cmxgR&YUG zS-AEj>%-6ZwB&)-4WWl865qVMPVFjhZ7yez_j{My(H5AJ0MTWxsF@-53%Iyk=0sQH8Ufo`vKLw#{cl94HocR%r?pF}zQr>-9ve0b0P zjbs4SiujhcUIP0>D0kHGjEqXHMeTIMdo{JsiY=~fNlM2dkH*`0L?)`$ez!8(m|!!B zQ6Hb?A5GwQejR_KQ%+D`PL+3;dE~WjRH5^oG^*(;$*A~W;Zw;XDnp`I8^2lLnm%+A zl*Yc{&Gw|i4^BeoQ8TA7ScyhI)BBW-QUN`i=so7`ng+yEig!^Mj!(nso1a{LC82?N z&t6K((yU0@Uh2kPH{H9Au+_KsqTYV`m8{?(4?Fmp}{$5HY9y{qaqb-jJClUJH-v>X- z9aSF`IXM*@_@Q3x!f1%~p)31qab)?@HI|h4~+I33p#YY|4Pk1R88**@2Hez-3VBS(&K zMpw6uSoECc@~?G+968i{|RZYcO!3j5enA}OFt>fAfI7+Fc5 z9?Qr3lRoMXFLO=OpQDLd{rue*>A9pY%H1VP*7BGP1l&X(wZ-^OZhJ<~J@BJwc=1>~ zju3lg;s@S`w-uC4p$J^5Ny(x$-0^$4=g)298iRJspd_UBZy^?{udj0@yI{qwtA0BR7bd-}z1eZ4mGN3hYOD$sxvW*_hXy+_ z<14)T&soKLY^7_}_&W+_8{(c^w_6`I=5?n~y0+dUe>2{vx4ol*6d6;F@rOg~4y@AO z;1}=bp@H|Ic6f90^AEWn>kyA*uDm9K_m*DCN3^tF6 zX%QRQuFt6i->>AtWsL1>iVl0gA?92^x5Y4PCk1POT)@T6PC?Q2hmYH>^C zGVXD3Q;8)aXz5X4RbYIYwCq3kRNhL}~oi~Cg z{bawOD!fraq@_xH5%J-;mPx&6(;b*T(C;lka#$+f5!^Bht8ek?SGdPWej-LV@Mpli&6c=u^zfy<;TU zV!EHMD~DV)s+8g4rJ}bRu6nW^Gj420+}mbjVo|Dk&+n8q@=zy-jjJ(D_vJpO_aGVW zwIGPu9ems${wBS4eRYIKNoMpfbiY(R7^$o47@wg)ufFpj{ih-MLbsmRm8X0dGc9}` zO;mlSY&V@VL^Xb1$;G3+$1HJ=j`oI6bR|iMHinn}8XA5oyM(d2B$x|<(B&z7fB79yNtLdyg z6?D;%w;5fW#?~+!Qyq^`0|KX}WNg7(k0}}rd`X!Tw61xE48v5qNhx0oP2X>LrN*?B zEmQ{SW{bm}2*2rVCrU&4xaZA~!SnEwc~}$`UW$X>Gnd1RU`F5XugV{XnqPxs7U;3D zGuq@HjM&%R7>Q=$XQRHdtFP*@yEobWo1T*B z&U*>N!=7u^D$+C%r5KLtGe3SFQJxsmp=*#Xq-*^)yl5NGEijst0P@CH<=G0`8bM%5 zy;z;N0atvO)%{A$HDWTqd;UZm)1^Wm^(54=X0Azo?e|XVHf%)u_zG_N{qD6g6h2>>`N+hXIjwM!({Qn$4kVU?SD1d{4!@9^RVPmksdQxpV{7jog zOkc+RkMb@1reESL_HouwJIgjlW`|mp`$??hwWD>d$0kfQnxaHJrZlwLp321o$91FK zBe@xbjnA@PwP1cG`R?Mv$x7{(%NW*w%kx!7-tZgQt_#x$YxZjHj2^)Wnx zeVUt22j=P1j5)4DGDe^bAQNj@#d%Q9o9RT zsaeyhzX)QR9zMV6FE}Z`m>e#jSo1aG*DCvJ{S~~ApJZRkGnY+Mt7IQht8lxu@!0a& zY(nO(D}FK!lm5E89HN8MWE&hqjtCw8AjI%1OU=mWsVJO_Tc-Kt%$u+1_TudKVOQ7$ zT-kbTjN{JfotKMlJA9_>&h{jb?r^Q zC{S}cQmk*Sv(9n>JWvr`(JKFG|p)bDVyK6GvkDzZ-9&kaU-m8J+<#{g0P36D7 z)p1fA@pH?OP!ip;%q?PPjJv-bTSA}ehjO_6-5X4L zH}FL1vQl4jSTvXnNPc~rdQukd{c}fpPVuKQ26ZzALpMdG*B_Dni7!#f34h-Iuua)& zv=tWf>1OH9f_CnGo#lf2{Nl7pFFlUpXWNo=`;ra|_o=b`HB*sJ?_T%&4%@!L&x{qR zCvi`OajKGgcnx2ks;3xtEPp8v@57>y)qG^_ zt3b*w$b#>if-D#zE5omEZONi*V6A7!;$mq7vSc(gK@k@lU43&y2MRqyV^b?3s`biR zDhg8rAu3gFSvFalXND%G5^i>eN^bDy`fld>Py;Fv;hTak`~ZQap@S}ki=~B?J->?( z)j3{%@QfN}rJ^_oaWEI6LdeQfJhQelq~K!VVqs&3xtKa}Pzm3p5VSKe;#U+E`-=j+ z2~n9iIN0#BvN}6Evp93ISlb!1vO}RzRyGb+4i07j!EEnp<)G`rY-LZ4LUDmZ)X-kv z&eX=i)Y^&yg;Q70+R;IXiVDnAT+(N0BP;t4dMo?CQULN`b=St zyR!esmg17K^8c(riNM&@(&l^>5cYpSI+z;$OIZIw8*1j9oqs0;EdK}Ze?VXIehv(v zWM%n9t@RyIHQ+ygWaHH3G2nvgF|+A$a58hT^Fo=STt)`WTt*!1 zoP0d&>^z+8|AtD^%HBcOO5YHL3Ls}O1$dx52Kwx522f^BD4P*87oV;nv#u_?5i=*Z zz7Z#s2Wq6xXZUX@N;54J-4>D5TZhnM1fj)Zr&7v7fO*ZwFeNcD2xAV z^Gb%c7jG9wz{2!=ih|Z^R5W;^tuH;^gII=400b8e`Mr=HlZt0=m>aXX792_SQxY&boGnPmBSlfE!>y z=iE@xor{wGKcSsX3{i4o1IEP0$;{62oSm1SlY^fN3SRly*r-_lGR%rP)t4L#vi|>M zB6tq)Z*BmryBGuR1$Zmgf85nynW4n^fAIHL7yk!$0I2`F$^S^c{}tDN#q~du!2byN zzt;6%as7`Z@IM0nuXX)z6W7guB|L^!APRB@=}dh}$ zFh$?GWJZgw{=y9s^>HM$*#dpjijELH*fIXk<88BR0c8E-?K(_XK9Mz{CmDU8r($n% z!TIFFd&4N5=ok7o`&&1L2l}rdg0NhIF>M$lN`t506Ke^VvPlj{*7Fx;rHU?*2d`9= zu2t_Gpox;GFRk(KCFvzwC%Ri>0{Z?R_;p|ZT%5ns8SZYo{yEr|Au&+WLhMs$z_|U- zmr)V4(KCBz21Ablow7U6D~U`69@rjZMeE~@vA0x9K-drFyd8?r!R-AkQuO6>B<2De ztQ&FiSHWO6O9u|Z`LuqZj98WG_icYrZa_=%jC)X!QJJ@^_r9xW9}d3zqMc z2@QDj8BkvLaYQy(OKil|qZCt6u|!&My7Sr6|2k@M@qmDiBfpb2iq+h*!)v+Thbsw&~|PkpqdUYsK+epI{qlQfFSC*-xW)xYZ|pQrD?Cu?us*NaLE(@ z{9jz~861G~qTd4l_^9DuymJ3vesyofeZEjXCFbE^e2BHQFg6vySFM!~#fNMxpQ+{B z@>dI!qSV4bsS~w|tPR=E@ebIpJ>!{K7QCmIKiJCq;krmxQI%)J^w*{z@lZqcV*9Puy)tYt+Lh=F32eCReu8km?7h+Y1 zed--IRUtEkXlQlsZyxl=xtJSlWM9D@BuYhP(xw0VZ?Iq}B&mL%8#6;Snf8}2A4KtS^Q7e3(7f4SSNblSb5T+O^ z173ep*>$8Y;WjaI4Vjv>i*K3#2JCbZqijLv_YFkbpC#vz?+ll6U;_qIKZ2yv^62Et zrTV)o8V+v3hu(02EGF+cW2MiYjwa- zhOGm~P$8{4eA=++INN>g5|GT-N0}HUxw*SP3dSrB(A zi#mJ&)xeTFe`(=17#J#v!+rxymzd!ab=eQVic9OR!?=!cvvN*dvR`X{dEUlz63*&x2f4{ zr%1`yL&eglsnNIG%jrrwq|vf)&~xauJaz923Rmbe5y_&Y0F(Wcke?Zl^e#rbbc_`C z+K)r<4ZLA&{t;UL(z?<8>20?LoQYfJ)0g(l^v-ACVSaMr8z!P>mr?{iQdW<6a35){Le$~yu<&rPw4QhG-Z+{1JS7dDb4PCO7(kOSu9hq~a; zRMamG$^?R*W4X5e!;JcJXJ%@hVuc6Jy8l1`0}CB3xg~um1L+$G%N;jqj1QLvPlR7E zx&+K2hn4Gy`%={=<(b$|f~%nc`-@ZD+s1%ZDlK&RR4;|?n!!bjPYLc&WGL&Qv0Vcn z)r>ZEQ`)qRMZe1O_|J$Iv7iOd5s_#`{d_P$^&W-3=6%iHq1_E z8MV-Zk6~p~Q!d$K6HHs~$C=YMb2|fD!y?r+lX4M~B2-DCkvy}fdL|sPEIwo#+;CV! z3LTXqe@H^OUBl74-sxuNwGfo)+#8f()h;U-X(=am^*f~HB@uD zGfBI}md;rSEh}*4lU!uuPpscF+Z~-Q1iE+M@@SYkh822gZ7lUPFs6iP->jJEP=b_7 zpYpUU=lHJ^!Oos{5~uaK(%VgjBv2E5EogVO=fOSs2_3AMxNBia+GMbKS{=FjI_MB9 z5Z-z6^B^i=%cz2!mgoU#M(}#%;U4iI63aI&vRC)hwpFXEwTZt3wF6DWGNdQ@jP%=h z=}!XNo#zb$v?qJ(vNUM{e5(F?NO*%ZeX4e&;EJfI3{7%-y<~$xCY9JcW$}^b0B+Iv z2r{nluL;!QFYO&YkaMn#rbaT->rpEP{VYGW1{8cMa%Gs=OrdLfw*@-39uSG|@Utp5 z>{?_FSbWjY440+1Y~XU+wQtz@J~%l25LwEU`hpN8_*j|5(8<#-r_w>6kAct|V#8B1m@Z8}hHgHk=d)gv1L- zU<%vUV78S{kd4I5Dc+7Xbb0)7G5*qt{-s#z>Z&BN*)%#|f{rQ+mM$*#I(-y7LlqO+ zqMfoD8WzZaF;?Qn66$hVDL4plcad_0NOD6gsPT|L2l* zYLC2+6AzF7UT0*+w%dz&IW(+vZixY5>=UlR##nQL0P)?wMx z1}P0rT@YyH(jy~kTqWwP_X;cXoc`e_D;~>m9g#CPK)eKbdg002O`RlLb)PwFdVY<} z%XO@*{j+%5(ivQAwMYD}xA8+wLy~l?NxPuM_qAr$c>g_`2yFt`MqHZg2xhMG*3$cb zP_ddqRI@rR(sCRfNX;a9qNpJFpDkq5SJp3o`v za|ctGpjBg|Ywsiy#lsrr22Iy46KzaA$oUjND)5yJCtA88)dFKM`@+o)cxzvHEqk|v zAATJU>yxV=CggrgtH4}mwK~@dIsAb*zM2KkV|7L>uLZ(LbM>kY4en<+)Vp&VLJCwA z1}Y0Km=NMXwsmf$nsp^i@XS5oE$bizs+f4Rk83D?*A$g@G zB}Qc5YykOgzy*}nDxB`&=98_CP2uLF#dv!PYbNZexasz~zNDo+jbar=kr0Rjt zALFWqY2sZg1k$w!x?&V7#@F|(JqEh21>3QvPJQ;;8{mUg;X~3YI_pOs zMOAj<5gcz=lPT}UN3`!o=NsPQ>| zWN7Bl&=KS-QuEU%%CLPlp~*YRTIK$N;<#|gk=53wTWqOF&o~&QAch}Y z)!tPcx0$@1a5sj|aBUrq7rfUSkyIdsg5=l8uXc^Sb}8-&-JkU4C5>mOC$pK+E{dy~ zIH{ht8KSg^9#O(_ULv8RqB07OP!QFi57HBm6LDORI;roh>1t&OIV5JaYS^%?-L?fG zf+PRXo!vd_gt=vG|9V?d3u4$;rN%z4zU^Kq^qhyKZ|a*5kL=_LY8kd-kdc#R#jk6z zjMw|3+Upk_SSCiNrp$W<6IKuJ$Fe6x`ZU%jdD6_B9VTahwDzDmp!Td|yGz_TvYy4}{( z*WT&Qy2>_ZUkPj%tFJcY$iXYBtJ4DZPk~Do53E$J8C=!EwoSG}O4Pnux3wyy7Q2`5YS z=n4E0IMsC<9qsW+J6Vg?(pnC|M&}>)b=|E`!D-<`gPpLzcT{rgjzzC(JDii4k4Qex z97{l=rH+YMUBy2dRA+S6qr~}XTg;V}D$zF1W~O!%8-?w8!I7B;tg6DAh`uvw_l9?7 z-#WPSbDUFUq%`@+!B1s_gUsdn<9kRk))bBEoAcs?TQDp>W=ySJN~o%iyDlJFw5L8`PTX4u8M27H`99KSu(fRUe)xv>>3k5(tf&H zKboZxY*AmFadP+M$FZLbP7t~siEj_eT0U{m+G0m`yS1pn8~lmp!8N)^RVbUr4w{Lg zo6Ts3*5W~U6P^Ss5y0}>-PZ*jwC1aLTMo>m78fF}+H{JuAD!7Z_|vDSZ7;IaY*fRM z3;hOm1njpzh26D${yTz808$x|!0J6M*nW_f(EHBy=eO$!G&D!0wGOLhtfM38P(k_` zH5O`}^r9EPpIQ@+$CG7FFw_iLOdo|P`1>m#V2W(L<+r~I~Dw;ea2qL`#_qgwOS@l+W&{r!r zMJLM8oG9~ala;k+GM#{UiI5Y&Mq`9>MDR6zG%f~OzeHw;^s+E_cF!_NR8h{abV32c zCWTG>ZYt!m@0Tx#-SkXHc>>tFR=ItVU1o-^J3+#)+g~`t65704CkM9F)o0a@j;!8v zw&H=xpxLMPOdKboy~t90fi)+bp|Ei2yLAH2o-rgF8(Sl)kEZ#>G2H);M{BvwNKPBwhHS7e{t~!Mcll?0uK8=v>M(ENb z>orzOSA_U*>^s-ts4&)&RtFue-x$)*xEd@+Gh0zT`HjU}+HeX#TkK8!w2M5!ETYN0 z)0IZ1KQXQp&$)k)+0XYyRVlj-dAXo`dhdvKp{#JbnwxK;kp0@`S+- znVhZkp&idgMNxDIb68^}^fn!&4u2k4mR*#YYg|{CfOO^co8oW48IW)G!*j^#cLX4i z2+07o-1q&9RrpZtyf#4@s5Tth%#=$Sq*nA2WfR1Gq|An%J6f_-&A$1iMMD)*nH|j& zYoW!nvpL)+8)QLhM14gAD|VA@#Yg2Cl|Mw8)t;aT=z2O^q<{#RWT+nQnVjr7NOhrw zRSo*sAHNG;gm?NU6^QkL8=xnJPE29Om#_VqN+N1Ea-nAhZwE%2va9Fd4V@2>s)|>% zkBo`?pj6k?)&1XXO;-mvkH^Gi#5nL&il5t<+c(j!ulp97Cc zvJ02VfGS_34t3nOU>hp^s~kPFB5&f^tJ!yUEsTF^!51fh>AAygmX@mHd2v99Y&|fi zg$R!IFT~;=PxepcXnP3CX=$?o$!Gcvs9Ntr*oH|ExIh9_wb||z=qXD1W7SVXshZ6HZ_+F+ ztc{L#j&5u)_I$&6xYkv#1R3*9y(>qRml$+678PSN^vRvEfLgmLK zcd^hI`h1Vn4azbutz(!%B4;T}zN3x8POfwtG(>9gVBihL0pO zz#fWJ4safW&Zr`TXR@i~Cgyd89nGTVr!B#1P~E77gwwm#cN}k8_T+zt%O{ z)21V-^{Q^>^TJkuKU9S<V7a_6-s%adcDMC5ecB8?v>$ zUO|Gd2rg6&e5v-XZw9Kmb8CSpKdFy!Z|3_&I)SbW~yx2=Hq5oy7K;TZ*l&g@mkZ$WRhn?hFA<_{!kvsg~#p)Sk|s3{F)-oz7_) z=WlLqu1Y;~TRc7jw*bKmiqAVdVVh3hL#%K63%rSe68BU~O2wOUEQ(7R+jYj@p1k)> zlb}(ca0qLDn&Xp0`qa91;jLiQT2io!YK&<0qn#jx7>hFX|+#fZx*AS zpIEFKT;FqEIjs}an3<}l*Sv!sjE`GjBC>Hag$E=9%u7bC;U~fNoEUId{k|U$uIRH1 zl_v03Osp9V`}w(+^}8YnU{k-VPt>spjI-UEcxS$-s5jIaorT(<7&*OiZR3PsLyc+iS)$;HP@UjhpaVAgmq%LY{hbDZ zl_`o+#%5>1FFO4Vy-s#^c4`XW8Zu|#fZ%`x+aIaez#F|O+J3DH>v1el^}?V{nLQhc zmwoS|U~Qx;U+lhn0PUGj3vRd63}M}D{wjasrt|z*4U>PyrG`8MbqIfEwOM-;DR^4oSY!3(@Pl+KM1AWNlx|$G2fDtemOZcC~NnC zFA$HbJFI@G?UY(7mPsadW;L)*ff$Skr@s}1rcqf7NqmJ9F?CnO+}*{=ohwxtMj)|; zwZ1NT7(}a-TIdN9%5qrk5Y-$HP2fh%xJ;0Z57QNiH$mA(HDR@1HmJ;iK*treI5A-= zYsURXiy*xm3(D@`0Exo0F-cQuWK~b#UFDOQBM@zp z5j4_$*na(#4JVV=RRo;b7^xcVnT?IFd(KG#KCmtDc_FxOF(mEP15adRo_NDnx_5HG zn5-c7=RQ|jyBdwol)2CmmfS?cnx+>T9`3uGjh{!ny&0%d$AI@8$H^AAJ-b#9C5K6g zLucwoHc0dJj#2e0?PVuc;j-aGW}oD0?-1(r#bi0wp~VhcE77>HW$CZ4o5zs>dl5c< zt}fnW!j&PeccI?6kn~fsUsrA>Mf$)B0a>9(jgGsXJg72@udi<}iz=waX@)1b1KQ}3 z)g-p%XXAmMXlM{5su!RrKe_jJDxFhKg~fKT43$%Fns+C-jrI+CqBG8#PP|z=h}@Hd zwSB*%&glXOHy(eI2Kb-06&kM@r1&Oj_JLI>5*jKJ)f=39BDF=O*FJ99mbz1S zt*t(vkxDPpw9$4-uxrqYJb3nVZ*2K?Dc|pL`wF2X~>NcQV0O&b!!o(I@oYpyY;Fb`pmuEM*>9)_VMj7>cz& z$mdLFgeg?19L}xp@xqmDB+WDX?zu*5=Ot{3|4uGh-1NIe%ur6Ok~c%MOxRJMimK!F z>c23)$D5JKJ>HNw4@yG}YWFgorQIt_{?DP}}kga7cJI=wWBDV;t-}_q#lH74t)r})_uJo6i zDz|^WTmFvP2?SwXBrEGvbhFEQM<=1h#l;Mrp=I{SFu$$MGcWoxVFRf3cyQT?okG=y zR?9k8?XuHeQjI;*?ZLe6Vx_)uvv*moHQ8nZCKLFqhLL6E2{MsC^Zmh*ZuB#HhsQGp zhGC5$9$N5Fs3IivU?783kFb-^Od;`avZF%OG+j`KjcArc*+wP z6FF)Lx_Gq{br>_a++Hu)_#AYbD{roH4)_umcXr;Pl0&7M9-_8NP{-L)(BCVGF<3@tD=3aw4ee zNkg5Nv77a`i}F85C(u9mKq6>ke*l+yz#h9zmELE2_N~)!<$c@1m+9}{U7|WefwKh( z7G1Wx&6D%+GvK>U0k7oZ#Dc?}DR5sgTDOAA8E?{(6R(`Cb43+kkT98=(caW_0z|?C zb~u)u55Q4QdU&1Nk*vv}H{T_)+0y$d({KEOEY^*iI;O&FPS&}kr+9G(m zBniZn4U!xMs}Yqmf(^JL86k7>bKDGP!Mi%_&X zvF7qH>8aZ;{s5P~P_(X~frVg(J+~u&XE1BbUQPvP{ycJ-ZmH}6PkKj0XFaZ&ut;uV znCs6U*Ae~xzzYgE4-Gn{evh8$SSeX-`U>I@TKD&T+e#+^_C#VzpeVtcK#Y?};SMI6 zANM~e6(MPHo&Di=E1ovdUm;xj#xh5Sbw?8>(bKwAGT_?OP{BC&@wWh#weE6m607`U zs?U9>u85Uc5DdZ>yCoX-*Cr}ikl9~f^k+>RpMY%JwKw0kbnL{7>&!P9w*L$Kf^>C0 zdha~I_y7lIy%7C2f?(2Xj)l}WD21NNzV{S62+XEzf z<;oQn7EU9-9?2CR+5ujxegq?NG*m{j?2Em~!xDZ;zMh}X-1@V&VXG~gfsH`~I#STN zT0v#)D70LV9$BjL`;-@za1fTiJK#&^cLY5J-WyeV(fDC&WaN8|Id4v?zm=4Le1$6= zb>V*f>3Wxu;HzQ-umnTA0>mAlPS>1zQ1t^PHM3eeIAlF{)RPw|xO2rWp@bz;jDBVu zx$D`-5kudx92X0)!`e#UsY1@6Xd$1jaYqCcoUY!P zGH8+}N7<|d?_qV0ia?Z|RDAHUTN)rwy?)vW)bcvZLv4)(7afxJik@Us=qNA)`Zvx+ ziG?+l-)CqJMW&5p)-qPVB?Wn%@AMxH=~s;=AR174#Bd^kWwVT%0E9_iHRGA_(cwNqno;@9;gK6;Jy;JLI z?(N+LVQK~kta>D&n&5W%xP#NkfK|}`{C69d77yza_o2@BQ>AXf74MEztC}W`whHKR z)Ip33>$HybXX;aWh{%ppCDThR+}DeH-9_q{iAUPykP*??h| zAU#^DL+FfIY%|g}+%V`aIPiA#h~LOYP`D<7^~8&=d@uG~?Ns%yzav_yfg6B3IP;o;%V9nU_<)}?BI+#{Qr&xuMelP+jA zVT%!(nykpbK|2DJ71=wva>JK8?WCa@8PTYSoUC3QU#yC>o6Oxry8J@ac<-%E2;E9` zd;KaPAeHVgB4AZwQDy+y=o|c-V8cr^L{!!YS-0>K?MyAwCU9!SbCFHa&G~)rLdr~A zv~jew2p3K?Ng=3&XbODEig-Sjypnw8Y1K}5dK?XD)aHv9macl`_A^3yNAlB@mv;O5~L5y{hM&>J4vIhVjo3?U^K zOkzL5JOdRq>b+thA_uEEkGl}^jL2QkzkzdAmJB4Z)(({u9g?CV;2L-4uWrW9OHOd^ zSqxb|u6YjXZSpFE7Ui>nG!JZx(!;G!eP}sK@ z32qT$`M#sKq#dVQ;?VRoc!SIPUIpX(WTagm5{b1z9nw9MCL%OoL6*wR)J-_yv=#hk zLc0e4y)N(>YTx;6lT|<1K+0umG@xr;?Y_7u38;7%PbawlIf25q?K&UWchq-PiO2hM zz4Ix)jxku@z?emh>a8^4lcO~FifRf&)A^3cM0DPn&zG~qyoWE z!9Sm_y9p_X6Fa9zB?L4pov$u{>K_HzmyHo78$5o$00j&`$D$Xr`gI4W;iXS8=%$n>j%X1$ zpT7cHJ3+4s9A16~47vLbXbBBaef;Iq1metDe->awt+?KG`Vk;qnV9$uHht_aXn39I zSNLnj6fwmRy%TZjD`2N0KT-smWyB^oimakQ@bcxolm3bKgL_zjY*|qJHyNlrY(8&_ zUR7VZi{Vr9b4bt?7tlzJek+AkIAH3iCrlSC9+d#F6_HIn2NSS!%uzm9yB+puqBZz| z1dC$9o5_LN@%M1CCKQL9VD;Bc?!9VY^(vsm-YtPrVF5oTlTQ;$g+2pRI_O+MC>7?C z0a$jFigdVdAkadATtVZvbR9;P5K5T{OAMmNU(QVmJXoGTK){pi`O_X)QGDKAD+mb8 z0$M^t`&9^b89leMngE}x^0!c1*F{4L&`?1X8rnVs22q{j`SNf;1yd-B3N{?{TRQY8 zDtuf4&ZzTqNahcg)1TwCMGc-CU(#zZc;kE!jTZb~k03ETnHY66h}!Nj z`QS^7zoQ+R+0#H7sQfkbTfZJEhEREW&<~zX4C?@>$Y*sJE_n1}wyfIrOcVQ|sBr#i3xKLBZ{n*aa+ literal 0 HcmV?d00001 From 7f3050e902d96f59cce3750ded7c73a54e1388ef Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Wed, 29 Mar 2023 15:51:41 -0300 Subject: [PATCH 21/23] use new logo on README file --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 97ebfdd63d2..3711beb660b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ - - Fuels-ts SDK logo + + Fuels-ts SDK logo **fuels-ts** is a library for interacting with **Fuel v2**. From 121a2495ff8fd1b235908a8fc828e1877edd95b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9rgio=20Torres?= <30977845+Torres-ssf@users.noreply.github.com> Date: Thu, 30 Mar 2023 13:24:24 -0300 Subject: [PATCH 22/23] fix typo Co-authored-by: Dhaiwat --- apps/docs/.vitepress/config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/docs/.vitepress/config.ts b/apps/docs/.vitepress/config.ts index 2a3d5ac0c91..8fbeb21af1d 100644 --- a/apps/docs/.vitepress/config.ts +++ b/apps/docs/.vitepress/config.ts @@ -4,7 +4,7 @@ import { snippetPlugin } from './plugins/snippetPlugin'; export default defineConfig({ title: 'Fuels-ts', - description: 'FuelLabs Typescript SDK', + description: 'Fuel Labs Typescript SDK', base: '/fuels-ts/', srcDir: 'src', outDir: 'dist', From 69831efc7980043da57fd7f78f436f334d25521c Mon Sep 17 00:00:00 2001 From: Torres-ssf Date: Thu, 30 Mar 2023 13:30:12 -0300 Subject: [PATCH 23/23] remove residual changesets --- .changeset/heavy-clouds-arrive.md | 2 -- .changeset/modern-chicken-accept.md | 2 -- .changeset/popular-gorillas-double.md | 2 -- .changeset/quick-fireants-sleep.md | 5 ----- .changeset/seven-readers-poke.md | 5 ----- 5 files changed, 16 deletions(-) delete mode 100644 .changeset/heavy-clouds-arrive.md delete mode 100644 .changeset/modern-chicken-accept.md delete mode 100644 .changeset/popular-gorillas-double.md delete mode 100644 .changeset/quick-fireants-sleep.md delete mode 100644 .changeset/seven-readers-poke.md diff --git a/.changeset/heavy-clouds-arrive.md b/.changeset/heavy-clouds-arrive.md deleted file mode 100644 index a845151cc84..00000000000 --- a/.changeset/heavy-clouds-arrive.md +++ /dev/null @@ -1,2 +0,0 @@ ---- ---- diff --git a/.changeset/modern-chicken-accept.md b/.changeset/modern-chicken-accept.md deleted file mode 100644 index a845151cc84..00000000000 --- a/.changeset/modern-chicken-accept.md +++ /dev/null @@ -1,2 +0,0 @@ ---- ---- diff --git a/.changeset/popular-gorillas-double.md b/.changeset/popular-gorillas-double.md deleted file mode 100644 index a845151cc84..00000000000 --- a/.changeset/popular-gorillas-double.md +++ /dev/null @@ -1,2 +0,0 @@ ---- ---- diff --git a/.changeset/quick-fireants-sleep.md b/.changeset/quick-fireants-sleep.md deleted file mode 100644 index a2a436e690a..00000000000 --- a/.changeset/quick-fireants-sleep.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@fuel-ts/versions": patch ---- - -Refactoring `versions` packages so that it can be used locally, providing accurate versions for all relevant parts of the stack diff --git a/.changeset/seven-readers-poke.md b/.changeset/seven-readers-poke.md deleted file mode 100644 index c8bd64e8f99..00000000000 --- a/.changeset/seven-readers-poke.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"forc-bin": minor ---- - -Upgrading Forc from `0.35.3` to `0.35.5`